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"
40 #include "blockinput.h"
52 #include <sys/ioctl.h>
54 #endif /* not MSDOS */
56 #include "syssignal.h"
59 #include <sys/types.h>
64 /* This is to get the definitions of the XK_ symbols. */
71 #endif /* HAVE_NTGUI */
77 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
84 /* Variables for blockinput.h: */
86 /* Non-zero if interrupt input is blocked right now. */
87 int interrupt_input_blocked
;
89 /* Nonzero means an input interrupt has arrived
90 during the current critical section. */
91 int interrupt_input_pending
;
94 /* File descriptor to use for input. */
97 #ifdef HAVE_WINDOW_SYSTEM
98 /* Make all keyboard buffers much bigger when using X windows. */
100 /* But not too big (local data > 32K error) if on macintosh. */
101 #define KBD_BUFFER_SIZE 512
103 #define KBD_BUFFER_SIZE 4096
105 #else /* No X-windows, character input */
106 #define KBD_BUFFER_SIZE 256
107 #endif /* No X-windows */
109 /* Following definition copied from eval.c */
113 struct backtrace
*next
;
114 Lisp_Object
*function
;
115 Lisp_Object
*args
; /* Points to vector of args. */
116 int nargs
; /* length of vector. If nargs is UNEVALLED,
117 args points to slot holding list of
123 KBOARD
*initial_kboard
;
124 KBOARD
*current_kboard
;
128 KBOARD the_only_kboard
;
131 /* Non-nil disable property on a command means
132 do not execute it; call disabled-command-hook's value instead. */
133 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
135 #define NUM_RECENT_KEYS (100)
136 int recent_keys_index
; /* Index for storing next element into recent_keys */
137 int total_keys
; /* Total number of elements stored into recent_keys */
138 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
140 /* Vector holding the key sequence that invoked the current command.
141 It is reused for each command, and it may be longer than the current
142 sequence; this_command_key_count indicates how many elements
143 actually mean something.
144 It's easier to staticpro a single Lisp_Object than an array. */
145 Lisp_Object this_command_keys
;
146 int this_command_key_count
;
148 /* This vector is used as a buffer to record the events that were actually read
149 by read_key_sequence. */
150 Lisp_Object raw_keybuf
;
151 int raw_keybuf_count
;
153 #define GROW_RAW_KEYBUF \
154 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
156 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
158 new = Fmake_vector (make_number (newsize), Qnil); \
159 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
160 raw_keybuf_count * sizeof (Lisp_Object)); \
164 /* Number of elements of this_command_keys
165 that precede this key sequence. */
166 int this_single_command_key_start
;
168 /* Record values of this_command_key_count and echo_length ()
169 before this command was read. */
170 static int before_command_key_count
;
171 static int before_command_echo_length
;
172 /* Values of before_command_key_count and before_command_echo_length
173 saved by reset-this-command-lengths. */
174 static int before_command_key_count_1
;
175 static int before_command_echo_length_1
;
176 /* Flag set by reset-this-command-lengths,
177 saying to reset the lengths when add_command_key is called. */
178 static int before_command_restore_flag
;
180 extern int minbuf_level
;
182 extern int message_enable_multibyte
;
184 extern struct backtrace
*backtrace_list
;
186 /* If non-nil, the function that implements the display of help.
187 It's called with one argument, the help string to display. */
189 Lisp_Object Vshow_help_function
;
191 /* Nonzero means do menu prompting. */
192 static int menu_prompting
;
194 /* Character to see next line of menu prompt. */
195 static Lisp_Object menu_prompt_more_char
;
197 /* For longjmp to where kbd input is being done. */
198 static jmp_buf getcjmp
;
200 /* True while doing kbd input. */
201 int waiting_for_input
;
203 /* True while displaying for echoing. Delays C-g throwing. */
207 /* Non-null means we can start echoing at the next input pause even
208 though there is something in the echo area. */
210 static struct kboard
*ok_to_echo_at_next_pause
;
212 /* The kboard last echoing, or null for none. Reset to 0 in
213 cancel_echoing. If non-null, and a current echo area message
214 exists, and echo_message_buffer is eq to the current message
215 buffer, we know that the message comes from echo_kboard. */
217 static struct kboard
*echo_kboard
;
219 /* The buffer used for echoing. Set in echo_now, reset in
222 Lisp_Object echo_message_buffer
;
224 /* Nonzero means disregard local maps for the menu bar. */
225 static int inhibit_local_menu_bar_menus
;
227 /* Nonzero means C-g should cause immediate error-signal. */
230 /* The user's ERASE setting. */
231 Lisp_Object Vtty_erase_char
;
233 /* Character to recognize as the help char. */
234 Lisp_Object Vhelp_char
;
236 /* List of other event types to recognize as meaning "help". */
237 Lisp_Object Vhelp_event_list
;
239 /* Form to execute when help char is typed. */
240 Lisp_Object Vhelp_form
;
242 /* Command to run when the help character follows a prefix key. */
243 Lisp_Object Vprefix_help_command
;
245 /* List of items that should move to the end of the menu bar. */
246 Lisp_Object Vmenu_bar_final_items
;
248 /* Non-nil means show the equivalent key-binding for
249 any M-x command that has one.
250 The value can be a length of time to show the message for.
251 If the value is non-nil and not a number, we wait 2 seconds. */
252 Lisp_Object Vsuggest_key_bindings
;
254 /* How long to display an echo-area message when the minibuffer is active.
255 If the value is not a number, such messages don't time out. */
256 Lisp_Object Vminibuffer_message_timeout
;
258 /* Character that causes a quit. Normally C-g.
260 If we are running on an ordinary terminal, this must be an ordinary
261 ASCII char, since we want to make it our interrupt character.
263 If we are not running on an ordinary terminal, it still needs to be
264 an ordinary ASCII char. This character needs to be recognized in
265 the input interrupt handler. At this point, the keystroke is
266 represented as a struct input_event, while the desired quit
267 character is specified as a lispy event. The mapping from struct
268 input_events to lispy events cannot run in an interrupt handler,
269 and the reverse mapping is difficult for anything but ASCII
272 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
276 extern Lisp_Object current_global_map
;
277 extern int minibuf_level
;
279 /* If non-nil, this is a map that overrides all other local maps. */
280 Lisp_Object Voverriding_local_map
;
282 /* If non-nil, Voverriding_local_map applies to the menu bar. */
283 Lisp_Object Voverriding_local_map_menu_flag
;
285 /* Keymap that defines special misc events that should
286 be processed immediately at a low level. */
287 Lisp_Object Vspecial_event_map
;
289 /* Current depth in recursive edits. */
290 int command_loop_level
;
292 /* Total number of times command_loop has read a key sequence. */
295 /* Last input character read as a command. */
296 Lisp_Object last_command_char
;
298 /* Last input character read as a command, not counting menus
299 reached by the mouse. */
300 Lisp_Object last_nonmenu_event
;
302 /* Last input character read for any purpose. */
303 Lisp_Object last_input_char
;
305 /* If not Qnil, a list of objects to be read as subsequent command input. */
306 Lisp_Object Vunread_command_events
;
308 /* If not Qnil, a list of objects to be read as subsequent command input
309 including input method processing. */
310 Lisp_Object Vunread_input_method_events
;
312 /* If not Qnil, a list of objects to be read as subsequent command input
313 but NOT including input method processing. */
314 Lisp_Object Vunread_post_input_method_events
;
316 /* If not -1, an event to be read as subsequent command input. */
317 int unread_command_char
;
319 /* If not Qnil, this is a switch-frame event which we decided to put
320 off until the end of a key sequence. This should be read as the
321 next command input, after any unread_command_events.
323 read_key_sequence uses this to delay switch-frame events until the
324 end of the key sequence; Fread_char uses it to put off switch-frame
325 events until a non-ASCII event is acceptable as input. */
326 Lisp_Object unread_switch_frame
;
328 /* A mask of extra modifier bits to put into every keyboard char. */
329 int extra_keyboard_modifiers
;
331 /* Char to use as prefix when a meta character is typed in.
332 This is bound on entry to minibuffer in case ESC is changed there. */
334 Lisp_Object meta_prefix_char
;
336 /* Last size recorded for a current buffer which is not a minibuffer. */
337 static int last_non_minibuf_size
;
339 /* Number of idle seconds before an auto-save and garbage collection. */
340 static Lisp_Object Vauto_save_timeout
;
342 /* Total number of times read_char has returned. */
343 int num_input_events
;
345 /* Total number of times read_char has returned, outside of macros. */
346 int num_nonmacro_input_events
;
348 /* Auto-save automatically when this many characters have been typed
349 since the last time. */
351 static int auto_save_interval
;
353 /* Value of num_nonmacro_input_events as of last auto save. */
357 /* The command being executed by the command loop.
358 Commands may set this, and the value set will be copied into
359 current_kboard->Vlast_command instead of the actual command. */
360 Lisp_Object Vthis_command
;
362 /* This is like Vthis_command, except that commands never set it. */
363 Lisp_Object real_this_command
;
365 /* The value of point when the last command was executed. */
366 int last_point_position
;
368 /* The buffer that was current when the last command was started. */
369 Lisp_Object last_point_position_buffer
;
371 /* The frame in which the last input event occurred, or Qmacro if the
372 last event came from a macro. We use this to determine when to
373 generate switch-frame events. This may be cleared by functions
374 like Fselect_frame, to make sure that a switch-frame event is
375 generated by the next character. */
376 Lisp_Object internal_last_event_frame
;
378 /* A user-visible version of the above, intended to allow users to
379 figure out where the last event came from, if the event doesn't
380 carry that information itself (i.e. if it was a character). */
381 Lisp_Object Vlast_event_frame
;
383 /* The timestamp of the last input event we received from the X server.
384 X Windows wants this for selection ownership. */
385 unsigned long last_event_timestamp
;
387 Lisp_Object Qself_insert_command
;
388 Lisp_Object Qforward_char
;
389 Lisp_Object Qbackward_char
;
390 Lisp_Object Qundefined
;
391 Lisp_Object Qtimer_event_handler
;
393 /* read_key_sequence stores here the command definition of the
394 key sequence that it reads. */
395 Lisp_Object read_key_sequence_cmd
;
397 /* Echo unfinished commands after this many seconds of pause. */
398 Lisp_Object Vecho_keystrokes
;
400 /* Form to evaluate (if non-nil) when Emacs is started. */
401 Lisp_Object Vtop_level
;
403 /* User-supplied string to translate input characters through. */
404 Lisp_Object Vkeyboard_translate_table
;
406 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
407 extern Lisp_Object Vfunction_key_map
;
409 /* Another keymap that maps key sequences into key sequences.
410 This one takes precedence over ordinary definitions. */
411 extern Lisp_Object Vkey_translation_map
;
413 /* If non-nil, this implements the current input method. */
414 Lisp_Object Vinput_method_function
;
415 Lisp_Object Qinput_method_function
;
417 /* When we call Vinput_method_function,
418 this holds the echo area message that was just erased. */
419 Lisp_Object Vinput_method_previous_message
;
421 /* Non-nil means deactivate the mark at end of this command. */
422 Lisp_Object Vdeactivate_mark
;
424 /* Menu bar specified in Lucid Emacs fashion. */
426 Lisp_Object Vlucid_menu_bar_dirty_flag
;
427 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
429 Lisp_Object Qecho_area_clear_hook
;
431 /* Hooks to run before and after each command. */
432 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
433 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
434 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
435 /* Hook run after a command if there's no more input soon. */
436 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
438 /* Delay time in microseconds before running post-command-idle-hook. */
439 int post_command_idle_delay
;
441 /* List of deferred actions to be performed at a later time.
442 The precise format isn't relevant here; we just check whether it is nil. */
443 Lisp_Object Vdeferred_action_list
;
445 /* Function to call to handle deferred actions, when there are any. */
446 Lisp_Object Vdeferred_action_function
;
447 Lisp_Object Qdeferred_action_function
;
449 Lisp_Object Qinput_method_exit_on_first_char
;
450 Lisp_Object Qinput_method_use_echo_area
;
452 /* File in which we write all commands we read. */
455 /* Nonzero if input is available. */
458 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
459 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
463 /* Non-zero means force key bindings update in parse_menu_item. */
465 int update_menu_bindings
;
467 extern char *pending_malloc_warning
;
469 /* Circular buffer for pre-read keyboard input. */
471 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
473 /* Vector to GCPRO the Lisp objects referenced from kbd_buffer.
475 The interrupt-level event handlers will never enqueue an event on a
476 frame which is not in Vframe_list, and once an event is dequeued,
477 internal_last_event_frame or the event itself points to the frame.
480 But while the event is sitting in the queue, it's completely
481 unprotected. Suppose the user types one command which will run for
482 a while and then delete a frame, and then types another event at
483 the frame that will be deleted, before the command gets around to
484 it. Suppose there are no references to this frame elsewhere in
485 Emacs, and a GC occurs before the second event is dequeued. Now we
486 have an event referring to a freed frame, which will crash Emacs
489 Similar things happen when an event on a scroll bar is enqueued; the
490 window may be deleted while the event is in the queue.
492 So, we use this vector to protect the Lisp_Objects in the event
493 queue. That way, they'll be dequeued as dead frames or windows,
494 but still valid Lisp objects.
496 If kbd_buffer[i].kind != no_event, then
498 AREF (kbd_buffer_gcpro, 2 * i) == kbd_buffer[i].frame_or_window.
499 AREF (kbd_buffer_gcpro, 2 * i + 1) == kbd_buffer[i].arg. */
501 static Lisp_Object kbd_buffer_gcpro
;
503 /* Pointer to next available character in kbd_buffer.
504 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
505 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the the
506 next available char is in kbd_buffer[0]. */
507 static struct input_event
*kbd_fetch_ptr
;
509 /* Pointer to next place to store character in kbd_buffer. This
510 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
511 character should go in kbd_buffer[0]. */
512 static struct input_event
* volatile kbd_store_ptr
;
514 /* The above pair of variables forms a "queue empty" flag. When we
515 enqueue a non-hook event, we increment kbd_store_ptr. When we
516 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
517 there is input available iff the two pointers are not equal.
519 Why not just have a flag set and cleared by the enqueuing and
520 dequeuing functions? Such a flag could be screwed up by interrupts
521 at inopportune times. */
523 /* If this flag is non-nil, we check mouse_moved to see when the
524 mouse moves, and motion events will appear in the input stream.
525 Otherwise, mouse motion is ignored. */
526 Lisp_Object do_mouse_tracking
;
528 /* Symbols to head events. */
529 Lisp_Object Qmouse_movement
;
530 Lisp_Object Qscroll_bar_movement
;
531 Lisp_Object Qswitch_frame
;
532 Lisp_Object Qdelete_frame
;
533 Lisp_Object Qiconify_frame
;
534 Lisp_Object Qmake_frame_visible
;
535 Lisp_Object Qhelp_echo
;
537 /* Symbols to denote kinds of events. */
538 Lisp_Object Qfunction_key
;
539 Lisp_Object Qmouse_click
;
541 Lisp_Object Qmouse_wheel
;
542 Lisp_Object Qlanguage_change
;
544 Lisp_Object Qdrag_n_drop
;
545 /* Lisp_Object Qmouse_movement; - also an event header */
547 /* Properties of event headers. */
548 Lisp_Object Qevent_kind
;
549 Lisp_Object Qevent_symbol_elements
;
551 /* menu item parts */
552 Lisp_Object Qmenu_alias
;
553 Lisp_Object Qmenu_enable
;
554 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
555 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
556 extern Lisp_Object Vdefine_key_rebound_commands
;
557 extern Lisp_Object Qmenu_item
;
559 /* An event header symbol HEAD may have a property named
560 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
561 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
562 mask of modifiers applied to it. If present, this is used to help
563 speed up parse_modifiers. */
564 Lisp_Object Qevent_symbol_element_mask
;
566 /* An unmodified event header BASE may have a property named
567 Qmodifier_cache, which is an alist mapping modifier masks onto
568 modified versions of BASE. If present, this helps speed up
570 Lisp_Object Qmodifier_cache
;
572 /* Symbols to use for parts of windows. */
573 Lisp_Object Qmode_line
;
574 Lisp_Object Qvertical_line
;
575 Lisp_Object Qvertical_scroll_bar
;
576 Lisp_Object Qmenu_bar
;
578 Lisp_Object
recursive_edit_unwind (), command_loop ();
579 Lisp_Object
Fthis_command_keys ();
580 Lisp_Object Qextended_command_history
;
581 EMACS_TIME
timer_check ();
583 extern Lisp_Object Vhistory_length
;
585 extern char *x_get_keysym_name ();
587 static void record_menu_key ();
589 Lisp_Object Qpolling_period
;
591 /* List of absolute timers. Appears in order of next scheduled event. */
592 Lisp_Object Vtimer_list
;
594 /* List of idle time timers. Appears in order of next scheduled event. */
595 Lisp_Object Vtimer_idle_list
;
597 /* Incremented whenever a timer is run. */
600 extern Lisp_Object Vprint_level
, Vprint_length
;
602 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
604 EMACS_TIME
*input_available_clear_time
;
606 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
607 Default is 1 if INTERRUPT_INPUT is defined. */
610 /* Nonzero while interrupts are temporarily deferred during redisplay. */
611 int interrupts_deferred
;
613 /* Nonzero means use ^S/^Q for flow control. */
616 /* Allow m- file to inhibit use of FIONREAD. */
617 #ifdef BROKEN_FIONREAD
621 /* We are unable to use interrupts if FIONREAD is not available,
622 so flush SIGIO so we won't try. */
629 /* If we support a window system, turn on the code to poll periodically
630 to detect C-g. It isn't actually used when doing interrupt input. */
631 #ifdef HAVE_WINDOW_SYSTEM
632 #define POLL_FOR_INPUT
635 /* After a command is executed, if point is moved into a region that
636 has specific properties (e.g. composition, display), we adjust
637 point to the boundary of the region. But, if a command sets this
638 valiable to non-nil, we suppress this point adjustment. This
639 variable is set to nil before reading a command. */
641 Lisp_Object Vdisable_point_adjustment
;
643 /* If non-nil, always disable point adjustment. */
645 Lisp_Object Vglobal_disable_point_adjustment
;
648 /* Global variable declarations. */
650 /* Function for init_keyboard to call with no args (if nonzero). */
651 void (*keyboard_init_hook
) ();
653 static int read_avail_input
P_ ((int));
654 static void get_input_pending
P_ ((int *, int));
655 static int readable_events
P_ ((int));
656 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
657 Lisp_Object
, int *));
658 static Lisp_Object
read_char_x_menu_prompt ();
659 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
661 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
663 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
664 enum scroll_bar_part
,
665 Lisp_Object
, Lisp_Object
,
668 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
669 Lisp_Object
, char **,
670 Lisp_Object
*, unsigned));
671 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
672 static int parse_solitary_modifier
P_ ((Lisp_Object
));
673 static int parse_solitary_modifier ();
674 static void save_getcjmp
P_ ((jmp_buf));
675 static void save_getcjmp ();
676 static void restore_getcjmp
P_ ((jmp_buf));
677 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
678 static void clear_event
P_ ((struct input_event
*));
680 /* Nonzero means don't try to suspend even if the operating system seems
682 static int cannot_suspend
;
684 #define min(a,b) ((a)<(b)?(a):(b))
685 #define max(a,b) ((a)>(b)?(a):(b))
687 /* Install the string STR as the beginning of the string of echoing,
688 so that it serves as a prompt for the next character.
689 Also start echoing. */
695 int nbytes
= STRING_BYTES (XSTRING (str
));
696 int multibyte_p
= STRING_MULTIBYTE (str
);
698 if (nbytes
> ECHOBUFSIZE
- 4)
702 /* Have to find the last character that fit's into the
704 unsigned char *p
= XSTRING (str
)->data
;
705 unsigned char *pend
= p
+ ECHOBUFSIZE
- 4;
710 PARSE_MULTIBYTE_SEQ (p
, pend
- p
, char_len
);
715 nbytes
= p
- XSTRING (str
)->data
- char_len
;
718 nbytes
= ECHOBUFSIZE
- 4;
721 nbytes
= copy_text (XSTRING (str
)->data
, current_kboard
->echobuf
, nbytes
,
722 STRING_MULTIBYTE (str
), 1);
723 current_kboard
->echoptr
= current_kboard
->echobuf
+ nbytes
;
724 *current_kboard
->echoptr
= '\0';
725 current_kboard
->echo_after_prompt
= nbytes
;
730 /* Add C to the echo string, if echoing is going on.
731 C can be a character, which is printed prettily ("M-C-x" and all that
732 jazz), or a symbol, whose name is printed. */
738 if (current_kboard
->immediate_echo
)
740 char *ptr
= current_kboard
->echoptr
;
742 if (ptr
!= current_kboard
->echobuf
)
745 /* If someone has passed us a composite event, use its head symbol. */
752 if (ptr
- current_kboard
->echobuf
753 > ECHOBUFSIZE
- KEY_DESCRIPTION_SIZE
)
756 ptr
= push_key_description (ch
, ptr
, 1);
758 else if (SYMBOLP (c
))
760 struct Lisp_String
*name
= XSYMBOL (c
)->name
;
761 if ((ptr
- current_kboard
->echobuf
) + STRING_BYTES (name
) + 4
764 ptr
+= copy_text (name
->data
, ptr
, STRING_BYTES (name
),
765 name
->size_byte
>= 0, 1);
768 if (current_kboard
->echoptr
== current_kboard
->echobuf
771 strcpy (ptr
, " (Type ? for further options)");
776 current_kboard
->echoptr
= ptr
;
782 /* Temporarily add a dash to the end of the echo string if it's not
783 empty, so that it serves as a mini-prompt for the very next character. */
788 if (!current_kboard
->immediate_echo
789 && current_kboard
->echoptr
== current_kboard
->echobuf
)
791 /* Do nothing if we just printed a prompt. */
792 if (current_kboard
->echo_after_prompt
793 == current_kboard
->echoptr
- current_kboard
->echobuf
)
795 /* Do nothing if not echoing at all. */
796 if (current_kboard
->echoptr
== 0)
799 /* Put a dash at the end of the buffer temporarily,
800 but make it go away when the next character is added. */
801 current_kboard
->echoptr
[0] = '-';
802 current_kboard
->echoptr
[1] = 0;
807 /* Display the current echo string, and begin echoing if not already
813 if (!current_kboard
->immediate_echo
)
816 current_kboard
->immediate_echo
= 1;
818 for (i
= 0; i
< this_command_key_count
; i
++)
821 c
= XVECTOR (this_command_keys
)->contents
[i
];
822 if (! (EVENT_HAS_PARAMETERS (c
)
823 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
830 message2_nolog (current_kboard
->echobuf
, strlen (current_kboard
->echobuf
),
834 /* Record in what buffer we echoed, and from which kboard. */
835 echo_message_buffer
= echo_area_buffer
[0];
836 echo_kboard
= current_kboard
;
838 if (waiting_for_input
&& !NILP (Vquit_flag
))
839 quit_throw_to_read_char ();
842 /* Turn off echoing, for the start of a new command. */
847 current_kboard
->immediate_echo
= 0;
848 current_kboard
->echoptr
= current_kboard
->echobuf
;
849 current_kboard
->echo_after_prompt
= -1;
850 ok_to_echo_at_next_pause
= NULL
;
852 echo_message_buffer
= Qnil
;
855 /* Return the length of the current echo string. */
860 return current_kboard
->echoptr
- current_kboard
->echobuf
;
863 /* Truncate the current echo message to its first LEN chars.
864 This and echo_char get used by read_key_sequence when the user
865 switches frames while entering a key sequence. */
871 current_kboard
->echobuf
[len
] = '\0';
872 current_kboard
->echoptr
= current_kboard
->echobuf
+ len
;
873 truncate_echo_area (len
);
877 /* Functions for manipulating this_command_keys. */
879 add_command_key (key
)
882 int size
= XVECTOR (this_command_keys
)->size
;
884 /* If reset-this-command-length was called recently, obey it now.
885 See the doc string of that function for an explanation of why. */
886 if (before_command_restore_flag
)
888 this_command_key_count
= before_command_key_count_1
;
889 if (this_command_key_count
< this_single_command_key_start
)
890 this_single_command_key_start
= this_command_key_count
;
891 echo_truncate (before_command_echo_length_1
);
892 before_command_restore_flag
= 0;
895 if (this_command_key_count
>= size
)
897 Lisp_Object new_keys
;
899 new_keys
= Fmake_vector (make_number (size
* 2), Qnil
);
900 bcopy (XVECTOR (this_command_keys
)->contents
,
901 XVECTOR (new_keys
)->contents
,
902 size
* sizeof (Lisp_Object
));
904 this_command_keys
= new_keys
;
907 XVECTOR (this_command_keys
)->contents
[this_command_key_count
++] = key
;
913 int count
= specpdl_ptr
- specpdl
;
916 if (command_loop_level
> 0)
918 specbind (Qstandard_output
, Qt
);
919 specbind (Qstandard_input
, Qt
);
922 #ifdef HAVE_X_WINDOWS
923 /* The command loop has started an hourglass timer, so we have to
924 cancel it here, otherwise it will fire because the recursive edit
925 can take some time. */
926 if (display_hourglass_p
)
930 /* This function may have been called from a debugger called from
931 within redisplay, for instance by Edebugging a function called
932 from fontification-functions. We want to allow redisplay in
933 the debugging session.
935 The recursive edit is left with a `(throw exit ...)'. The `exit'
936 tag is not caught anywhere in redisplay, i.e. when we leave the
937 recursive edit, the original redisplay leading to the recursive
938 edit will be unwound. The outcome should therefore be safe. */
939 specbind (Qinhibit_redisplay
, Qnil
);
942 val
= command_loop ();
944 Fsignal (Qquit
, Qnil
);
945 /* Handle throw from read_minibuf when using minibuffer
946 while it's active but we're in another window. */
948 Fsignal (Qerror
, Fcons (val
, Qnil
));
950 return unbind_to (count
, Qnil
);
953 /* When an auto-save happens, record the "time", and don't do again soon. */
958 last_auto_save
= num_nonmacro_input_events
;
961 /* Make an auto save happen as soon as possible at command level. */
964 force_auto_save_soon ()
966 last_auto_save
= - auto_save_interval
- 1;
968 record_asynch_buffer_change ();
971 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
972 "Invoke the editor command loop recursively.\n\
973 To get out of the recursive edit, a command can do `(throw 'exit nil)';\n\
974 that tells this function to return.\n\
975 Alternately, `(throw 'exit t)' makes this function signal an error.\n\
976 This function is called by the editor initialization to begin editing.")
979 int count
= specpdl_ptr
- specpdl
;
981 command_loop_level
++;
982 update_mode_lines
= 1;
984 record_unwind_protect (recursive_edit_unwind
,
986 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
990 return unbind_to (count
, Qnil
);
994 recursive_edit_unwind (buffer
)
998 Fset_buffer (buffer
);
1000 command_loop_level
--;
1001 update_mode_lines
= 1;
1009 #if 0 /* Theory: if there's anything in Vunread_command_events,
1010 it will right away be read by read_key_sequence,
1011 and then if we do switch KBOARDS, it will go into the side
1012 queue then. So we don't need to do anything special here -- rms. */
1013 if (CONSP (Vunread_command_events
))
1015 current_kboard
->kbd_queue
1016 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1017 current_kboard
->kbd_queue_has_data
= 1;
1019 Vunread_command_events
= Qnil
;
1025 /* Switch to the single-kboard state, making current_kboard
1026 the only KBOARD from which further input is accepted. */
1029 single_kboard_state ()
1036 /* Maintain a stack of kboards, so other parts of Emacs
1037 can switch temporarily to the kboard of a given frame
1038 and then revert to the previous status. */
1043 struct kboard_stack
*next
;
1046 static struct kboard_stack
*kboard_stack
;
1049 push_frame_kboard (f
)
1053 struct kboard_stack
*p
1054 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1056 p
->next
= kboard_stack
;
1057 p
->kboard
= current_kboard
;
1060 current_kboard
= FRAME_KBOARD (f
);
1068 struct kboard_stack
*p
= kboard_stack
;
1069 current_kboard
= p
->kboard
;
1070 kboard_stack
= p
->next
;
1075 /* Handle errors that are not handled at inner levels
1076 by printing an error message and returning to the editor command loop. */
1082 Lisp_Object old_level
, old_length
;
1083 char macroerror
[50];
1085 if (!NILP (executing_macro
))
1087 if (executing_macro_iterations
== 1)
1088 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1090 sprintf (macroerror
, "After %d kbd macro iterations: ",
1091 executing_macro_iterations
);
1096 Vstandard_output
= Qt
;
1097 Vstandard_input
= Qt
;
1098 Vexecuting_macro
= Qnil
;
1099 executing_macro
= Qnil
;
1100 current_kboard
->Vprefix_arg
= Qnil
;
1101 current_kboard
->Vlast_prefix_arg
= Qnil
;
1104 /* Avoid unquittable loop if data contains a circular list. */
1105 old_level
= Vprint_level
;
1106 old_length
= Vprint_length
;
1107 XSETFASTINT (Vprint_level
, 10);
1108 XSETFASTINT (Vprint_length
, 10);
1109 cmd_error_internal (data
, macroerror
);
1110 Vprint_level
= old_level
;
1111 Vprint_length
= old_length
;
1115 Vinhibit_quit
= Qnil
;
1117 any_kboard_state ();
1120 return make_number (0);
1123 /* Take actions on handling an error. DATA is the data that describes
1126 CONTEXT is a C-string containing ASCII characters only which
1127 describes the context in which the error happened. If we need to
1128 generalize CONTEXT to allow multibyte characters, make it a Lisp
1132 cmd_error_internal (data
, context
)
1137 int kill_emacs_p
= 0;
1138 struct frame
*sf
= SELECTED_FRAME ();
1142 clear_message (1, 0);
1144 /* If the window system or terminal frame hasn't been initialized
1145 yet, or we're not interactive, it's best to dump this message out
1146 to stderr and exit. */
1147 if (!sf
->glyphs_initialized_p
1148 /* This is the case of the frame dumped with Emacs, when we're
1149 running under a window system. */
1150 || (!NILP (Vwindow_system
)
1151 && !inhibit_window_system
1152 && FRAME_TERMCAP_P (sf
))
1155 stream
= Qexternal_debugging_output
;
1166 write_string_1 (context
, -1, stream
);
1168 print_error_message (data
, stream
);
1170 /* If the window system or terminal frame hasn't been initialized
1171 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1175 Fkill_emacs (make_number (-1));
1179 Lisp_Object
command_loop_1 ();
1180 Lisp_Object
command_loop_2 ();
1181 Lisp_Object
top_level_1 ();
1183 /* Entry to editor-command-loop.
1184 This level has the catches for exiting/returning to editor command loop.
1185 It returns nil to exit recursive edit, t to abort it. */
1190 if (command_loop_level
> 0 || minibuf_level
> 0)
1193 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1194 executing_macro
= Qnil
;
1200 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1201 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1202 executing_macro
= Qnil
;
1204 /* End of file in -batch run causes exit here. */
1210 /* Here we catch errors in execution of commands within the
1211 editing loop, and reenter the editing loop.
1212 When there is an error, cmd_error runs and returns a non-nil
1213 value to us. A value of nil means that cmd_loop_1 itself
1214 returned due to end of file (or end of kbd macro). */
1219 register Lisp_Object val
;
1222 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1223 while (!NILP (val
));
1231 return Feval (Vtop_level
);
1237 /* On entry to the outer level, run the startup file */
1238 if (!NILP (Vtop_level
))
1239 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1240 else if (!NILP (Vpurify_flag
))
1241 message ("Bare impure Emacs (standard Lisp code not loaded)");
1243 message ("Bare Emacs (standard Lisp code not loaded)");
1247 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1248 "Exit all recursive editing levels.")
1251 #ifdef HAVE_X_WINDOWS
1252 if (display_hourglass_p
)
1253 cancel_hourglass ();
1255 return Fthrow (Qtop_level
, Qnil
);
1258 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1259 "Exit from the innermost recursive edit or minibuffer.")
1262 if (command_loop_level
> 0 || minibuf_level
> 0)
1263 Fthrow (Qexit
, Qnil
);
1265 error ("No recursive edit is in progress");
1269 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1270 "Abort the command that requested this recursive edit or minibuffer input.")
1273 if (command_loop_level
> 0 || minibuf_level
> 0)
1276 error ("No recursive edit is in progress");
1280 /* This is the actual command reading loop,
1281 sans error-handling encapsulation. */
1283 EXFUN (Fcommand_execute
, 4);
1284 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1286 void safe_run_hooks
P_ ((Lisp_Object
));
1287 static void adjust_point_for_property
P_ ((int));
1295 Lisp_Object keybuf
[30];
1299 struct buffer
*prev_buffer
= NULL
;
1301 int was_locked
= single_kboard
;
1304 current_kboard
->Vprefix_arg
= Qnil
;
1305 current_kboard
->Vlast_prefix_arg
= Qnil
;
1306 Vdeactivate_mark
= Qnil
;
1307 waiting_for_input
= 0;
1311 this_command_key_count
= 0;
1312 this_single_command_key_start
= 0;
1314 /* Make sure this hook runs after commands that get errors and
1315 throw to top level. */
1316 /* Note that the value cell will never directly contain nil
1317 if the symbol is a local variable. */
1318 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1319 safe_run_hooks (Qpost_command_hook
);
1321 /* If displaying a message, resize the echo area window to fit
1322 that message's size exactly. */
1323 if (!NILP (echo_area_buffer
[0]))
1324 resize_echo_area_axactly ();
1326 if (!NILP (Vdeferred_action_list
))
1327 call0 (Vdeferred_action_function
);
1329 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1331 if (NILP (Vunread_command_events
)
1332 && NILP (Vunread_input_method_events
)
1333 && NILP (Vunread_post_input_method_events
)
1334 && NILP (Vexecuting_macro
)
1335 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1336 safe_run_hooks (Qpost_command_idle_hook
);
1339 /* Do this after running Vpost_command_hook, for consistency. */
1340 current_kboard
->Vlast_command
= Vthis_command
;
1341 current_kboard
->Vreal_last_command
= real_this_command
;
1345 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1348 /* Make sure the current window's buffer is selected. */
1349 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1350 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1352 /* Display any malloc warning that just came out. Use while because
1353 displaying one warning can cause another. */
1355 while (pending_malloc_warning
)
1356 display_malloc_warning ();
1360 Vdeactivate_mark
= Qnil
;
1362 /* If minibuffer on and echo area in use,
1363 wait a short time and redraw minibuffer. */
1366 && !NILP (echo_area_buffer
[0])
1367 && EQ (minibuf_window
, echo_area_window
)
1368 && NUMBERP (Vminibuffer_message_timeout
))
1370 /* Bind inhibit-quit to t so that C-g gets read in
1371 rather than quitting back to the minibuffer. */
1372 int count
= specpdl_ptr
- specpdl
;
1373 specbind (Qinhibit_quit
, Qt
);
1375 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1376 /* Clear the echo area. */
1378 safe_run_hooks (Qecho_area_clear_hook
);
1380 unbind_to (count
, Qnil
);
1382 /* If a C-g came in before, treat it as input now. */
1383 if (!NILP (Vquit_flag
))
1386 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1391 alloca (0); /* Cause a garbage collection now */
1392 /* Since we can free the most stuff here. */
1393 #endif /* C_ALLOCA */
1396 /* Select the frame that the last event came from. Usually,
1397 switch-frame events will take care of this, but if some lisp
1398 code swallows a switch-frame event, we'll fix things up here.
1399 Is this a good idea? */
1400 if (FRAMEP (internal_last_event_frame
)
1401 && !EQ (internal_last_event_frame
, selected_frame
))
1402 Fselect_frame (internal_last_event_frame
, Qnil
);
1404 /* If it has changed current-menubar from previous value,
1405 really recompute the menubar from the value. */
1406 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1407 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1408 call0 (Qrecompute_lucid_menubar
);
1410 before_command_key_count
= this_command_key_count
;
1411 before_command_echo_length
= echo_length ();
1413 Vthis_command
= Qnil
;
1414 real_this_command
= Qnil
;
1416 /* Read next key sequence; i gets its length. */
1417 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1420 /* A filter may have run while we were reading the input. */
1421 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1423 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1424 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1428 /* Now we have read a key sequence of length I,
1429 or else I is 0 and we found end of file. */
1431 if (i
== 0) /* End of file -- happens only in */
1432 return Qnil
; /* a kbd macro, at the end. */
1433 /* -1 means read_key_sequence got a menu that was rejected.
1434 Just loop around and read another command. */
1438 this_command_key_count
= 0;
1439 this_single_command_key_start
= 0;
1443 last_command_char
= keybuf
[i
- 1];
1445 /* If the previous command tried to force a specific window-start,
1446 forget about that, in case this command moves point far away
1447 from that position. But also throw away beg_unchanged and
1448 end_unchanged information in that case, so that redisplay will
1449 update the whole window properly. */
1450 if (!NILP (XWINDOW (selected_window
)->force_start
))
1453 XWINDOW (selected_window
)->force_start
= Qnil
;
1454 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1455 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1458 cmd
= read_key_sequence_cmd
;
1459 if (!NILP (Vexecuting_macro
))
1461 if (!NILP (Vquit_flag
))
1463 Vexecuting_macro
= Qt
;
1464 QUIT
; /* Make some noise. */
1465 /* Will return since macro now empty. */
1469 /* Do redisplay processing after this command except in special
1470 cases identified below. */
1471 prev_buffer
= current_buffer
;
1472 prev_modiff
= MODIFF
;
1473 last_point_position
= PT
;
1474 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1476 /* By default, we adjust point to a boundary of a region that
1477 has such a property that should be treated intangible
1478 (e.g. composition, display). But, some commands will set
1479 this variable differently. */
1480 Vdisable_point_adjustment
= Qnil
;
1482 /* Process filters and timers may have messed with deactivate-mark.
1483 reset it before we execute the command. */
1484 Vdeactivate_mark
= Qnil
;
1486 /* Execute the command. */
1488 Vthis_command
= cmd
;
1489 real_this_command
= cmd
;
1490 /* Note that the value cell will never directly contain nil
1491 if the symbol is a local variable. */
1492 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1493 safe_run_hooks (Qpre_command_hook
);
1495 if (NILP (Vthis_command
))
1497 /* nil means key is undefined. */
1499 current_kboard
->defining_kbd_macro
= Qnil
;
1500 update_mode_lines
= 1;
1501 current_kboard
->Vprefix_arg
= Qnil
;
1505 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1507 /* In case we jump to directly_done. */
1508 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1510 /* Recognize some common commands in common situations and
1511 do them directly. */
1512 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1514 struct Lisp_Char_Table
*dp
1515 = window_display_table (XWINDOW (selected_window
));
1516 lose
= FETCH_CHAR (PT_BYTE
);
1519 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1520 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1521 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1522 && (lose
>= 0x20 && lose
< 0x7f)))
1523 : (lose
>= 0x20 && lose
< 0x7f))
1524 /* To extract the case of continuation on
1525 wide-column characters. */
1526 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1527 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1529 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1531 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1533 && !windows_or_buffers_changed
1534 && EQ (current_buffer
->selective_display
, Qnil
)
1535 && !detect_input_pending ()
1536 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1537 && NILP (Vexecuting_macro
))
1538 direct_output_forward_char (1);
1541 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1543 struct Lisp_Char_Table
*dp
1544 = window_display_table (XWINDOW (selected_window
));
1546 lose
= FETCH_CHAR (PT_BYTE
);
1548 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1549 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1550 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1551 && (lose
>= 0x20 && lose
< 0x7f)))
1552 : (lose
>= 0x20 && lose
< 0x7f))
1553 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1555 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1557 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1559 && !windows_or_buffers_changed
1560 && EQ (current_buffer
->selective_display
, Qnil
)
1561 && !detect_input_pending ()
1562 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1563 && NILP (Vexecuting_macro
))
1564 direct_output_forward_char (-1);
1567 else if (EQ (Vthis_command
, Qself_insert_command
)
1568 /* Try this optimization only on ascii keystrokes. */
1569 && INTEGERP (last_command_char
))
1571 unsigned int c
= XINT (last_command_char
);
1573 if (NILP (Vexecuting_macro
)
1574 && !EQ (minibuf_window
, selected_window
))
1576 if (!nonundocount
|| nonundocount
>= 20)
1584 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1586 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1588 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1590 || MODIFF
<= SAVE_MODIFF
1591 || windows_or_buffers_changed
1592 || !EQ (current_buffer
->selective_display
, Qnil
)
1593 || detect_input_pending ()
1594 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1595 || !NILP (Vexecuting_macro
));
1597 value
= internal_self_insert (c
, 0);
1602 /* VALUE == 1 when AFTER-CHANGE functions are
1603 installed which is the case most of the time
1604 because FONT-LOCK installs one. */
1605 if (!lose
&& !value
)
1606 direct_output_for_insert (c
);
1611 /* Here for a command that isn't executed directly */
1613 #ifdef HAVE_X_WINDOWS
1614 if (display_hourglass_p
)
1619 if (NILP (current_kboard
->Vprefix_arg
))
1621 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1623 #ifdef HAVE_X_WINDOWS
1624 if (display_hourglass_p
)
1625 cancel_hourglass ();
1629 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1631 /* Note that the value cell will never directly contain nil
1632 if the symbol is a local variable. */
1633 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1634 safe_run_hooks (Qpost_command_hook
);
1636 /* If displaying a message, resize the echo area window to fit
1637 that message's size exactly. */
1638 if (!NILP (echo_area_buffer
[0]))
1639 resize_echo_area_axactly ();
1641 if (!NILP (Vdeferred_action_list
))
1642 safe_run_hooks (Qdeferred_action_function
);
1644 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1646 if (NILP (Vunread_command_events
)
1647 && NILP (Vunread_input_method_events
)
1648 && NILP (Vunread_post_input_method_events
)
1649 && NILP (Vexecuting_macro
)
1650 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1651 safe_run_hooks (Qpost_command_idle_hook
);
1654 /* If there is a prefix argument,
1655 1) We don't want Vlast_command to be ``universal-argument''
1656 (that would be dumb), so don't set Vlast_command,
1657 2) we want to leave echoing on so that the prefix will be
1658 echoed as part of this key sequence, so don't call
1660 3) we want to leave this_command_key_count non-zero, so that
1661 read_char will realize that it is re-reading a character, and
1662 not echo it a second time.
1664 If the command didn't actually create a prefix arg,
1665 but is merely a frame event that is transparent to prefix args,
1666 then the above doesn't apply. */
1667 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1669 current_kboard
->Vlast_command
= Vthis_command
;
1670 current_kboard
->Vreal_last_command
= real_this_command
;
1672 this_command_key_count
= 0;
1673 this_single_command_key_start
= 0;
1676 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1678 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1680 current_buffer
->mark_active
= Qnil
;
1681 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1683 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1684 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1689 if (current_buffer
== prev_buffer
1690 && last_point_position
!= PT
1691 && NILP (Vdisable_point_adjustment
)
1692 && NILP (Vglobal_disable_point_adjustment
))
1693 adjust_point_for_property (last_point_position
);
1695 /* Install chars successfully executed in kbd macro. */
1697 if (!NILP (current_kboard
->defining_kbd_macro
)
1698 && NILP (current_kboard
->Vprefix_arg
))
1699 finalize_kbd_macro_chars ();
1703 any_kboard_state ();
1708 extern Lisp_Object Qcomposition
, Qdisplay
;
1710 /* Adjust point to a boundary of a region that has such a property
1711 that should be treated intangible. For the moment, we check
1712 `composition' and `display' property. LAST_PT is the last position
1716 adjust_point_for_property (last_pt
)
1721 int check_composition
= 1, check_display
= 1;
1723 while (check_composition
|| check_display
)
1725 if (check_composition
1726 && PT
> BEGV
&& PT
< ZV
1727 && get_property_and_range (PT
, Qcomposition
, &val
, &start
, &end
, Qnil
)
1728 && COMPOSITION_VALID_P (start
, end
, val
)
1729 && start
< PT
&& end
> PT
1730 && (last_pt
<= start
|| last_pt
>= end
))
1738 check_composition
= 0;
1740 && PT
> BEGV
&& PT
< ZV
1741 && get_property_and_range (PT
, Qdisplay
, &val
, &start
, &end
, Qnil
)
1742 && display_prop_intangible_p (val
)
1743 && start
< PT
&& end
> PT
1744 && (last_pt
<= start
|| last_pt
>= end
))
1750 check_composition
= 1;
1756 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1759 safe_run_hooks_1 (hook
)
1762 return call1 (Vrun_hooks
, Vinhibit_quit
);
1765 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1768 safe_run_hooks_error (data
)
1771 return Fset (Vinhibit_quit
, Qnil
);
1774 /* If we get an error while running the hook, cause the hook variable
1775 to be nil. Also inhibit quits, so that C-g won't cause the hook
1776 to mysteriously evaporate. */
1779 safe_run_hooks (hook
)
1782 int count
= specpdl_ptr
- specpdl
;
1783 specbind (Qinhibit_quit
, hook
);
1785 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1787 unbind_to (count
, Qnil
);
1791 /* Number of seconds between polling for input. This is a Lisp
1792 variable that can be bound. */
1796 /* Nonzero means polling for input is temporarily suppressed. */
1798 int poll_suppress_count
;
1800 /* Asynchronous timer for polling. */
1802 struct atimer
*poll_timer
;
1805 #ifdef POLL_FOR_INPUT
1807 /* Poll for input, so what we catch a C-g if it comes in. This
1808 function is called from x_make_frame_visible, see comment
1814 if (interrupt_input_blocked
== 0
1815 && !waiting_for_input
)
1816 read_avail_input (0);
1819 /* Timer callback function for poll_timer. TIMER is equal to
1823 poll_for_input (timer
)
1824 struct atimer
*timer
;
1826 if (poll_suppress_count
== 0)
1827 poll_for_input_1 ();
1830 #endif /* POLL_FOR_INPUT */
1832 /* Begin signals to poll for input, if they are appropriate.
1833 This function is called unconditionally from various places. */
1838 #ifdef POLL_FOR_INPUT
1839 if (read_socket_hook
&& !interrupt_input
)
1841 /* Turn alarm handling on unconditionally. It might have
1842 been turned off in process.c. */
1843 turn_on_atimers (1);
1845 /* If poll timer doesn't exist, are we need one with
1846 a different interval, start a new one. */
1847 if (poll_timer
== NULL
1848 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
1850 EMACS_TIME interval
;
1853 cancel_atimer (poll_timer
);
1855 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
1856 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1857 poll_for_input
, NULL
);
1860 /* Let the timer's callback function poll for input
1861 if this becomes zero. */
1862 --poll_suppress_count
;
1867 /* Nonzero if we are using polling to handle input asynchronously. */
1870 input_polling_used ()
1872 #ifdef POLL_FOR_INPUT
1873 return read_socket_hook
&& !interrupt_input
;
1879 /* Turn off polling. */
1884 #ifdef POLL_FOR_INPUT
1885 if (read_socket_hook
&& !interrupt_input
)
1886 ++poll_suppress_count
;
1890 /* Set the value of poll_suppress_count to COUNT
1891 and start or stop polling accordingly. */
1894 set_poll_suppress_count (count
)
1897 #ifdef POLL_FOR_INPUT
1898 if (count
== 0 && poll_suppress_count
!= 0)
1900 poll_suppress_count
= 1;
1903 else if (count
!= 0 && poll_suppress_count
== 0)
1907 poll_suppress_count
= count
;
1911 /* Bind polling_period to a value at least N.
1912 But don't decrease it. */
1915 bind_polling_period (n
)
1918 #ifdef POLL_FOR_INPUT
1919 int new = polling_period
;
1924 stop_other_atimers (poll_timer
);
1926 specbind (Qpolling_period
, make_number (new));
1927 /* Start a new alarm with the new period. */
1932 /* Apply the control modifier to CHARACTER. */
1938 /* Save the upper bits here. */
1939 int upper
= c
& ~0177;
1943 /* Everything in the columns containing the upper-case letters
1944 denotes a control character. */
1945 if (c
>= 0100 && c
< 0140)
1949 /* Set the shift modifier for a control char
1950 made from a shifted letter. But only for letters! */
1951 if (oc
>= 'A' && oc
<= 'Z')
1952 c
|= shift_modifier
;
1955 /* The lower-case letters denote control characters too. */
1956 else if (c
>= 'a' && c
<= 'z')
1959 /* Include the bits for control and shift
1960 only if the basic ASCII code can't indicate them. */
1964 /* Replace the high bits. */
1965 c
|= (upper
& ~ctrl_modifier
);
1970 /* Display help echo in the echo area.
1972 HELP a string means display that string, HELP nil means clear the
1973 help echo. If HELP is a function, call it with OBJECT and POS as
1974 arguments; the function should return a help string or nil for
1975 none. For all other types of HELP evaluate it to obtain a string.
1977 WINDOW is the window in which the help was generated, if any.
1978 It is nil if not in a window.
1980 If OBJECT is a buffer, POS is the position in the buffer where the
1981 `help-echo' text property was found.
1983 If OBJECT is an overlay, that overlay has a `help-echo' property,
1984 and POS is the position in the overlay's buffer under the mouse.
1986 If OBJECT is a string (an overlay string or a string displayed with
1987 the `display' property). POS is the position in that string under
1990 OK_TO_IVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
1991 echo overwrites a keystroke echo currently displayed in the echo
1994 Note: this function may only be called with HELP nil or a string
1995 from X code running asynchronously. */
1998 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
1999 Lisp_Object help
, window
, object
, pos
;
2000 int ok_to_overwrite_keystroke_echo
;
2002 if (!NILP (help
) && !STRINGP (help
))
2004 if (FUNCTIONP (help
))
2006 Lisp_Object args
[4];
2011 help
= safe_call (4, args
);
2014 help
= safe_eval (help
);
2016 if (!STRINGP (help
))
2020 if (STRINGP (help
) || NILP (help
))
2022 if (!NILP (Vshow_help_function
))
2023 call1 (Vshow_help_function
, help
);
2024 else if (/* Don't overwrite minibuffer contents. */
2025 !MINI_WINDOW_P (XWINDOW (selected_window
))
2026 /* Don't overwrite a keystroke echo. */
2027 && (NILP (echo_message_buffer
)
2028 || ok_to_overwrite_keystroke_echo
)
2029 /* Don't overwrite a prompt. */
2030 && !cursor_in_echo_area
)
2034 int count
= specpdl_ptr
- specpdl
;
2035 specbind (Qmessage_truncate_lines
, Qt
);
2036 message3_nolog (help
, STRING_BYTES (XSTRING (help
)),
2037 STRING_MULTIBYTE (help
));
2038 unbind_to (count
, Qnil
);
2044 help_echo_showing_p
= STRINGP (help
);
2050 /* Input of single characters from keyboard */
2052 Lisp_Object
print_help ();
2053 static Lisp_Object
kbd_buffer_get_event ();
2054 static void record_char ();
2057 static jmp_buf wrong_kboard_jmpbuf
;
2060 /* read a character from the keyboard; call the redisplay if needed */
2061 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2062 -1 means do not do redisplay, but do do autosaving.
2065 /* The arguments MAPS and NMAPS are for menu prompting.
2066 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2068 PREV_EVENT is the previous input event, or nil if we are reading
2069 the first event of a key sequence (or not reading a key sequence).
2070 If PREV_EVENT is t, that is a "magic" value that says
2071 not to run input methods, but in other respects to act as if
2072 not reading a key sequence.
2074 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2075 if we used a mouse menu to read the input, or zero otherwise. If
2076 USED_MOUSE_MENU is null, we don't dereference it.
2078 Value is t if we showed a menu and the user rejected it. */
2081 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2085 Lisp_Object prev_event
;
2086 int *used_mouse_menu
;
2088 volatile Lisp_Object c
;
2090 jmp_buf local_getcjmp
;
2092 volatile int key_already_recorded
= 0;
2093 Lisp_Object tem
, save
;
2094 volatile Lisp_Object previous_echo_area_message
;
2095 volatile Lisp_Object also_record
;
2096 volatile int reread
;
2097 struct gcpro gcpro1
, gcpro2
;
2101 before_command_key_count
= this_command_key_count
;
2102 before_command_echo_length
= echo_length ();
2104 previous_echo_area_message
= Qnil
;
2106 GCPRO2 (c
, previous_echo_area_message
);
2111 if (CONSP (Vunread_post_input_method_events
))
2113 c
= XCAR (Vunread_post_input_method_events
);
2114 Vunread_post_input_method_events
2115 = XCDR (Vunread_post_input_method_events
);
2117 /* Undo what read_char_x_menu_prompt did when it unread
2118 additional keys returned by Fx_popup_menu. */
2120 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2128 if (unread_command_char
!= -1)
2130 XSETINT (c
, unread_command_char
);
2131 unread_command_char
= -1;
2137 if (CONSP (Vunread_command_events
))
2139 c
= XCAR (Vunread_command_events
);
2140 Vunread_command_events
= XCDR (Vunread_command_events
);
2142 /* Undo what read_char_x_menu_prompt did when it unread
2143 additional keys returned by Fx_popup_menu. */
2145 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2149 /* If the queued event is something that used the mouse,
2150 set used_mouse_menu accordingly. */
2152 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2153 *used_mouse_menu
= 1;
2156 goto reread_for_input_method
;
2159 if (CONSP (Vunread_input_method_events
))
2161 c
= XCAR (Vunread_input_method_events
);
2162 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2164 /* Undo what read_char_x_menu_prompt did when it unread
2165 additional keys returned by Fx_popup_menu. */
2167 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2171 goto reread_for_input_method
;
2174 /* If there is no function key translated before
2175 reset-this-command-lengths takes effect, forget about it. */
2176 before_command_restore_flag
= 0;
2178 if (!NILP (Vexecuting_macro
))
2180 /* We set this to Qmacro; since that's not a frame, nobody will
2181 try to switch frames on us, and the selected window will
2184 Since this event came from a macro, it would be misleading to
2185 leave internal_last_event_frame set to wherever the last
2186 real event came from. Normally, a switch-frame event selects
2187 internal_last_event_frame after each command is read, but
2188 events read from a macro should never cause a new frame to be
2190 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2192 /* Exit the macro if we are at the end.
2193 Also, some things replace the macro with t
2194 to force an early exit. */
2195 if (EQ (Vexecuting_macro
, Qt
)
2196 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2202 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2203 if (STRINGP (Vexecuting_macro
)
2204 && (XINT (c
) & 0x80))
2205 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2207 executing_macro_index
++;
2212 if (!NILP (unread_switch_frame
))
2214 c
= unread_switch_frame
;
2215 unread_switch_frame
= Qnil
;
2217 /* This event should make it into this_command_keys, and get echoed
2218 again, so we do not set `reread'. */
2222 /* if redisplay was requested */
2223 if (commandflag
>= 0)
2225 /* If there is pending input, process any events which are not
2226 user-visible, such as X selection_request events. */
2228 || detect_input_pending_run_timers (0))
2229 swallow_events (0); /* may clear input_pending */
2231 /* Redisplay if no pending input. */
2232 while (!input_pending
)
2234 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2235 redisplay_preserve_echo_area (5);
2240 /* Normal case: no input arrived during redisplay. */
2243 /* Input arrived and pre-empted redisplay.
2244 Process any events which are not user-visible. */
2246 /* If that cleared input_pending, try again to redisplay. */
2250 /* Message turns off echoing unless more keystrokes turn it on again.
2252 The code in 20.x for the condition was
2254 1. echo_area_glyphs && *echo_area_glyphs
2255 2. && echo_area_glyphs != current_kboard->echobuf
2256 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2258 (1) means there's a current message displayed
2260 (2) means it's not the message from echoing from the current
2263 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2264 is set to a non-null value. This is done in read_char and it is
2265 set to echo_area_glyphs after a call to echo_char. That means
2266 ok_to_echo_at_next_pause is either null or
2267 current_kboard->echobuf with the appropriate current_kboard at
2270 So, condition (3) means in clear text ok_to_echo_at_next_pause
2271 must be either null, or the current message isn't from echoing at
2272 all, or it's from echoing from a different kboard than the
2275 if (/* There currently something in the echo area */
2276 !NILP (echo_area_buffer
[0])
2277 && (/* And it's either not from echoing. */
2278 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2279 /* Or it's an echo from a different kboard. */
2280 || echo_kboard
!= current_kboard
2281 /* Or we explicitly allow overwriting whatever there is. */
2282 || ok_to_echo_at_next_pause
== NULL
))
2287 /* Try reading a character via menu prompting in the minibuf.
2288 Try this before the sit-for, because the sit-for
2289 would do the wrong thing if we are supposed to do
2290 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2291 after a mouse event so don't try a minibuf menu. */
2293 if (nmaps
> 0 && INTERACTIVE
2294 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2295 /* Don't bring up a menu if we already have another event. */
2296 && NILP (Vunread_command_events
)
2297 && unread_command_char
< 0
2298 && !detect_input_pending_run_timers (0))
2300 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2303 key_already_recorded
= 1;
2308 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2309 We will do that below, temporarily for short sections of code,
2310 when appropriate. local_getcjmp must be in effect
2311 around any call to sit_for or kbd_buffer_get_event;
2312 it *must not* be in effect when we call redisplay. */
2314 if (_setjmp (local_getcjmp
))
2316 XSETINT (c
, quit_char
);
2317 internal_last_event_frame
= selected_frame
;
2318 Vlast_event_frame
= internal_last_event_frame
;
2319 /* If we report the quit char as an event,
2320 don't do so more than once. */
2321 if (!NILP (Vinhibit_quit
))
2326 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2327 if (kb
!= current_kboard
)
2329 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2330 /* We shouldn't get here if we were in single-kboard mode! */
2333 while (CONSP (*tailp
))
2334 tailp
= &XCDR (*tailp
);
2337 *tailp
= Fcons (c
, Qnil
);
2338 kb
->kbd_queue_has_data
= 1;
2339 current_kboard
= kb
;
2340 /* This is going to exit from read_char
2341 so we had better get rid of this frame's stuff. */
2343 longjmp (wrong_kboard_jmpbuf
, 1);
2350 timer_start_idle ();
2352 /* If in middle of key sequence and minibuffer not active,
2353 start echoing if enough time elapses. */
2355 if (minibuf_level
== 0
2356 && !current_kboard
->immediate_echo
2357 && this_command_key_count
> 0
2359 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2360 && NILP (Fzerop (Vecho_keystrokes
))
2361 && (/* No message. */
2362 NILP (echo_area_buffer
[0])
2363 /* Or empty message. */
2364 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2365 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2366 /* Or already echoing from same kboard. */
2367 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2368 /* Or not echoing before and echoing allowed. */
2369 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2373 /* After a mouse event, start echoing right away.
2374 This is because we are probably about to display a menu,
2375 and we don't want to delay before doing so. */
2376 if (EVENT_HAS_PARAMETERS (prev_event
))
2381 double duration
= extract_float (Vecho_keystrokes
);
2382 sec
= (int) duration
;
2383 usec
= (duration
- sec
) * 1000000;
2384 save_getcjmp (save_jump
);
2385 restore_getcjmp (local_getcjmp
);
2386 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2387 restore_getcjmp (save_jump
);
2389 && ! CONSP (Vunread_command_events
))
2394 /* Maybe auto save due to number of keystrokes. */
2396 if (commandflag
!= 0
2397 && auto_save_interval
> 0
2398 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2399 && !detect_input_pending_run_timers (0))
2401 Fdo_auto_save (Qnil
, Qnil
);
2402 /* Hooks can actually change some buffers in auto save. */
2406 /* Try reading using an X menu.
2407 This is never confused with reading using the minibuf
2408 because the recursive call of read_char in read_char_minibuf_menu_prompt
2409 does not pass on any keymaps. */
2411 if (nmaps
> 0 && INTERACTIVE
2412 && !NILP (prev_event
)
2413 && EVENT_HAS_PARAMETERS (prev_event
)
2414 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2415 && !EQ (XCAR (prev_event
), Qtool_bar
)
2416 /* Don't bring up a menu if we already have another event. */
2417 && NILP (Vunread_command_events
)
2418 && unread_command_char
< 0)
2420 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2422 /* Now that we have read an event, Emacs is not idle. */
2428 /* Maybe autosave and/or garbage collect due to idleness. */
2430 if (INTERACTIVE
&& NILP (c
))
2432 int delay_level
, buffer_size
;
2434 /* Slow down auto saves logarithmically in size of current buffer,
2435 and garbage collect while we're at it. */
2436 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2437 last_non_minibuf_size
= Z
- BEG
;
2438 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2440 while (buffer_size
> 64)
2441 delay_level
++, buffer_size
-= buffer_size
>> 2;
2442 if (delay_level
< 4) delay_level
= 4;
2443 /* delay_level is 4 for files under around 50k, 7 at 100k,
2444 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2446 /* Auto save if enough time goes by without input. */
2447 if (commandflag
!= 0
2448 && num_nonmacro_input_events
> last_auto_save
2449 && INTEGERP (Vauto_save_timeout
)
2450 && XINT (Vauto_save_timeout
) > 0)
2454 save_getcjmp (save_jump
);
2455 restore_getcjmp (local_getcjmp
);
2456 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2458 restore_getcjmp (save_jump
);
2461 && ! CONSP (Vunread_command_events
))
2463 Fdo_auto_save (Qnil
, Qnil
);
2465 /* If we have auto-saved and there is still no input
2466 available, garbage collect if there has been enough
2467 consing going on to make it worthwhile. */
2468 if (!detect_input_pending_run_timers (0)
2469 && consing_since_gc
> gc_cons_threshold
/ 2)
2470 Fgarbage_collect ();
2477 /* If this has become non-nil here, it has been set by a timer
2478 or sentinel or filter. */
2479 if (CONSP (Vunread_command_events
))
2481 c
= XCAR (Vunread_command_events
);
2482 Vunread_command_events
= XCDR (Vunread_command_events
);
2485 /* Read something from current KBOARD's side queue, if possible. */
2489 if (current_kboard
->kbd_queue_has_data
)
2491 if (!CONSP (current_kboard
->kbd_queue
))
2493 c
= XCAR (current_kboard
->kbd_queue
);
2494 current_kboard
->kbd_queue
2495 = XCDR (current_kboard
->kbd_queue
);
2496 if (NILP (current_kboard
->kbd_queue
))
2497 current_kboard
->kbd_queue_has_data
= 0;
2498 input_pending
= readable_events (0);
2499 if (EVENT_HAS_PARAMETERS (c
)
2500 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2501 internal_last_event_frame
= XCAR (XCDR (c
));
2502 Vlast_event_frame
= internal_last_event_frame
;
2507 /* If current_kboard's side queue is empty check the other kboards.
2508 If one of them has data that we have not yet seen here,
2509 switch to it and process the data waiting for it.
2511 Note: if the events queued up for another kboard
2512 have already been seen here, and therefore are not a complete command,
2513 the kbd_queue_has_data field is 0, so we skip that kboard here.
2514 That's to avoid an infinite loop switching between kboards here. */
2515 if (NILP (c
) && !single_kboard
)
2518 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2519 if (kb
->kbd_queue_has_data
)
2521 current_kboard
= kb
;
2522 /* This is going to exit from read_char
2523 so we had better get rid of this frame's stuff. */
2525 longjmp (wrong_kboard_jmpbuf
, 1);
2534 /* Finally, we read from the main queue,
2535 and if that gives us something we can't use yet, we put it on the
2536 appropriate side queue and try again. */
2542 /* Actually read a character, waiting if necessary. */
2543 save_getcjmp (save_jump
);
2544 restore_getcjmp (local_getcjmp
);
2545 timer_start_idle ();
2546 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2547 restore_getcjmp (save_jump
);
2550 if (! NILP (c
) && (kb
!= current_kboard
))
2552 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2553 while (CONSP (*tailp
))
2554 tailp
= &XCDR (*tailp
);
2557 *tailp
= Fcons (c
, Qnil
);
2558 kb
->kbd_queue_has_data
= 1;
2562 current_kboard
= kb
;
2563 /* This is going to exit from read_char
2564 so we had better get rid of this frame's stuff. */
2566 longjmp (wrong_kboard_jmpbuf
, 1);
2571 /* Terminate Emacs in batch mode if at eof. */
2572 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2573 Fkill_emacs (make_number (1));
2577 /* Add in any extra modifiers, where appropriate. */
2578 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2579 || ((extra_keyboard_modifiers
& 0177) < ' '
2580 && (extra_keyboard_modifiers
& 0177) != 0))
2581 XSETINT (c
, make_ctrl_char (XINT (c
)));
2583 /* Transfer any other modifier bits directly from
2584 extra_keyboard_modifiers to c. Ignore the actual character code
2585 in the low 16 bits of extra_keyboard_modifiers. */
2586 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2596 if (commandflag
>= 0
2597 && !input_pending
&& !detect_input_pending_run_timers (0))
2605 /* Buffer switch events are only for internal wakeups
2606 so don't show them to the user.
2607 Also, don't record a key if we already did. */
2608 if (BUFFERP (c
) || key_already_recorded
)
2611 /* Process special events within read_char
2612 and loop around to read another event. */
2615 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2620 int was_locked
= single_kboard
;
2622 last_input_char
= c
;
2623 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2625 /* Resume allowing input from any kboard, if that was true before. */
2627 any_kboard_state ();
2632 /* Handle things that only apply to characters. */
2635 /* If kbd_buffer_get_event gave us an EOF, return that. */
2639 if ((STRINGP (Vkeyboard_translate_table
)
2640 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2641 || (VECTORP (Vkeyboard_translate_table
)
2642 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2643 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2644 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2647 d
= Faref (Vkeyboard_translate_table
, c
);
2648 /* nil in keyboard-translate-table means no translation. */
2654 /* If this event is a mouse click in the menu bar,
2655 return just menu-bar for now. Modify the mouse click event
2656 so we won't do this twice, then queue it up. */
2657 if (EVENT_HAS_PARAMETERS (c
)
2659 && CONSP (EVENT_START (c
))
2660 && CONSP (XCDR (EVENT_START (c
))))
2664 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2665 /* Handle menu-bar events:
2666 insert the dummy prefix event `menu-bar'. */
2667 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2669 /* Change menu-bar to (menu-bar) as the event "position". */
2670 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2673 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2678 /* Store these characters into recent_keys, the dribble file if any,
2679 and the keyboard macro being defined, if any. */
2681 if (! NILP (also_record
))
2682 record_char (also_record
);
2684 /* Wipe the echo area.
2685 But first, if we are about to use an input method,
2686 save the echo area contents for it to refer to. */
2688 && ! NILP (Vinput_method_function
)
2689 && (unsigned) XINT (c
) >= ' '
2690 && (unsigned) XINT (c
) != 127
2691 && (unsigned) XINT (c
) < 256)
2693 previous_echo_area_message
= Fcurrent_message ();
2694 Vinput_method_previous_message
= previous_echo_area_message
;
2697 /* Now wipe the echo area, except for help events which do their
2698 own stuff with the echo area. */
2699 if (!CONSP (c
) || !(EQ (Qhelp_echo
, XCAR (c
))))
2701 if (!NILP (echo_area_buffer
[0]))
2702 safe_run_hooks (Qecho_area_clear_hook
);
2703 clear_message (1, 0);
2706 reread_for_input_method
:
2708 /* Pass this to the input method, if appropriate. */
2710 && ! NILP (Vinput_method_function
)
2711 /* Don't run the input method within a key sequence,
2712 after the first event of the key sequence. */
2713 && NILP (prev_event
)
2714 && (unsigned) XINT (c
) >= ' '
2715 && (unsigned) XINT (c
) != 127
2716 && (unsigned) XINT (c
) < 256)
2720 struct gcpro gcpro1
;
2721 int count
= specpdl_ptr
- specpdl
;
2723 /* Save the echo status. */
2724 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2725 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2726 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2728 if (before_command_restore_flag
)
2730 this_command_key_count
= before_command_key_count_1
;
2731 if (this_command_key_count
< this_single_command_key_start
)
2732 this_single_command_key_start
= this_command_key_count
;
2733 echo_truncate (before_command_echo_length_1
);
2734 before_command_restore_flag
= 0;
2737 /* Save the this_command_keys status. */
2738 key_count
= this_command_key_count
;
2741 keys
= Fcopy_sequence (this_command_keys
);
2746 /* Clear out this_command_keys. */
2747 this_command_key_count
= 0;
2749 /* Now wipe the echo area. */
2750 if (!NILP (echo_area_buffer
[0]))
2751 safe_run_hooks (Qecho_area_clear_hook
);
2752 clear_message (1, 0);
2755 /* If we are not reading a key sequence,
2756 never use the echo area. */
2759 specbind (Qinput_method_use_echo_area
, Qt
);
2762 /* Call the input method. */
2763 tem
= call1 (Vinput_method_function
, c
);
2765 tem
= unbind_to (count
, tem
);
2767 /* Restore the saved echoing state
2768 and this_command_keys state. */
2769 this_command_key_count
= key_count
;
2771 this_command_keys
= keys
;
2774 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
2775 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
2776 if (saved_immediate_echo
)
2781 /* The input method can return no events. */
2784 /* Bring back the previous message, if any. */
2785 if (! NILP (previous_echo_area_message
))
2786 message_with_string ("%s", previous_echo_area_message
, 0);
2789 /* It returned one event or more. */
2791 Vunread_post_input_method_events
2792 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
2797 /* Display help if not echoing. */
2798 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
2800 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
2801 Lisp_Object help
, object
, position
, window
;
2802 help
= Fnth (make_number (2), c
);
2803 window
= Fnth (make_number (3), c
);
2804 object
= Fnth (make_number (4), c
);
2805 position
= Fnth (make_number (5), c
);
2806 show_help_echo (help
, window
, object
, position
, 0);
2810 if (this_command_key_count
== 0 || ! reread
)
2812 before_command_key_count
= this_command_key_count
;
2813 before_command_echo_length
= echo_length ();
2815 /* Don't echo mouse motion events. */
2816 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2817 && NILP (Fzerop (Vecho_keystrokes
))
2818 && ! (EVENT_HAS_PARAMETERS (c
)
2819 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2822 if (! NILP (also_record
))
2823 echo_char (also_record
);
2824 /* Once we reread a character, echoing can happen
2825 the next time we pause to read a new one. */
2826 ok_to_echo_at_next_pause
= current_kboard
;
2829 /* Record this character as part of the current key. */
2830 add_command_key (c
);
2831 if (! NILP (also_record
))
2832 add_command_key (also_record
);
2835 last_input_char
= c
;
2838 /* Process the help character specially if enabled */
2839 if (!NILP (Vhelp_form
) && help_char_p (c
))
2842 count
= specpdl_ptr
- specpdl
;
2844 record_unwind_protect (Fset_window_configuration
,
2845 Fcurrent_window_configuration (Qnil
));
2847 tem0
= Feval (Vhelp_form
);
2849 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2853 c
= read_char (0, 0, 0, Qnil
, 0);
2854 while (BUFFERP (c
));
2855 /* Remove the help from the frame */
2856 unbind_to (count
, Qnil
);
2859 if (EQ (c
, make_number (040)))
2863 c
= read_char (0, 0, 0, Qnil
, 0);
2864 while (BUFFERP (c
));
2871 /* Record a key that came from a mouse menu.
2872 Record it for echoing, for this-command-keys, and so on. */
2878 /* Wipe the echo area. */
2879 clear_message (1, 0);
2883 before_command_key_count
= this_command_key_count
;
2884 before_command_echo_length
= echo_length ();
2886 /* Don't echo mouse motion events. */
2887 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2888 && NILP (Fzerop (Vecho_keystrokes
)))
2892 /* Once we reread a character, echoing can happen
2893 the next time we pause to read a new one. */
2894 ok_to_echo_at_next_pause
= 0;
2897 /* Record this character as part of the current key. */
2898 add_command_key (c
);
2900 /* Re-reading in the middle of a command */
2901 last_input_char
= c
;
2905 /* Return 1 if should recognize C as "the help character". */
2913 if (EQ (c
, Vhelp_char
))
2915 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
2916 if (EQ (c
, XCAR (tail
)))
2921 /* Record the input event C in various ways. */
2927 /* Don't record `help-echo' in recent_keys unless it shows some help
2928 message, and a different help than the previoiusly recorded
2930 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
2934 help
= Fnth (make_number (2), c
);
2938 Lisp_Object last_c
, last_help
;
2940 last_idx
= recent_keys_index
- 1;
2942 last_idx
= NUM_RECENT_KEYS
- 1;
2943 last_c
= AREF (recent_keys
, last_idx
);
2946 || !EQ (XCAR (last_c
), Qhelp_echo
)
2947 || (last_help
= Fnth (make_number (2), last_c
),
2948 !EQ (last_help
, help
)))
2951 ASET (recent_keys
, recent_keys_index
, c
);
2952 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2953 recent_keys_index
= 0;
2960 ASET (recent_keys
, recent_keys_index
, c
);
2961 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2962 recent_keys_index
= 0;
2965 /* Write c to the dribble file. If c is a lispy event, write
2966 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2967 If you, dear reader, have a better idea, you've got the source. :-) */
2972 if (XUINT (c
) < 0x100)
2973 putc (XINT (c
), dribble
);
2975 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2979 Lisp_Object dribblee
;
2981 /* If it's a structured event, take the event header. */
2982 dribblee
= EVENT_HEAD (c
);
2984 if (SYMBOLP (dribblee
))
2986 putc ('<', dribble
);
2987 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2988 STRING_BYTES (XSYMBOL (dribblee
)->name
),
2990 putc ('>', dribble
);
2997 if (!CONSP (c
) || !EQ (Qhelp_echo
, XCAR (c
)))
2998 store_kbd_macro_char (c
);
3000 num_nonmacro_input_events
++;
3007 struct buffer
*old
= current_buffer
;
3008 Fprinc (object
, Qnil
);
3009 set_buffer_internal (XBUFFER (Vstandard_output
));
3010 call0 (intern ("help-mode"));
3011 set_buffer_internal (old
);
3015 /* Copy out or in the info on where C-g should throw to.
3016 This is used when running Lisp code from within get_char,
3017 in case get_char is called recursively.
3018 See read_process_output. */
3024 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3028 restore_getcjmp (temp
)
3031 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3036 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3037 of this function. */
3040 tracking_off (old_value
)
3041 Lisp_Object old_value
;
3043 do_mouse_tracking
= old_value
;
3044 if (NILP (old_value
))
3046 /* Redisplay may have been preempted because there was input
3047 available, and it assumes it will be called again after the
3048 input has been processed. If the only input available was
3049 the sort that we have just disabled, then we need to call
3051 if (!readable_events (1))
3053 redisplay_preserve_echo_area (6);
3054 get_input_pending (&input_pending
, 1);
3060 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3061 "Evaluate BODY with mouse movement events enabled.\n\
3062 Within a `track-mouse' form, mouse motion generates input events that\n\
3063 you can read with `read-event'.\n\
3064 Normally, mouse motion is ignored.")
3068 int count
= specpdl_ptr
- specpdl
;
3071 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3073 do_mouse_tracking
= Qt
;
3075 val
= Fprogn (args
);
3076 return unbind_to (count
, val
);
3079 /* If mouse has moved on some frame, return one of those frames.
3080 Return 0 otherwise. */
3085 Lisp_Object tail
, frame
;
3087 FOR_EACH_FRAME (tail
, frame
)
3089 if (XFRAME (frame
)->mouse_moved
)
3090 return XFRAME (frame
);
3096 #endif /* HAVE_MOUSE */
3098 /* Low level keyboard/mouse input.
3099 kbd_buffer_store_event places events in kbd_buffer, and
3100 kbd_buffer_get_event retrieves them. */
3102 /* Return true iff there are any events in the queue that read-char
3103 would return. If this returns false, a read-char would block. */
3105 readable_events (do_timers_now
)
3109 timer_check (do_timers_now
);
3111 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3114 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3119 if (current_kboard
->kbd_queue_has_data
)
3125 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3126 if (kb
->kbd_queue_has_data
)
3132 /* Set this for debugging, to have a way to get out */
3137 event_to_kboard (event
)
3138 struct input_event
*event
;
3141 frame
= event
->frame_or_window
;
3143 frame
= XCAR (frame
);
3144 else if (WINDOWP (frame
))
3145 frame
= WINDOW_FRAME (XWINDOW (frame
));
3147 /* There are still some events that don't set this field.
3148 For now, just ignore the problem.
3149 Also ignore dead frames here. */
3150 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3153 return FRAME_KBOARD (XFRAME (frame
));
3157 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3160 kbd_buffer_store_event (event
)
3161 register struct input_event
*event
;
3163 if (event
->kind
== no_event
)
3166 if (event
->kind
== ascii_keystroke
)
3168 register int c
= event
->code
& 0377;
3170 if (event
->modifiers
& ctrl_modifier
)
3171 c
= make_ctrl_char (c
);
3173 c
|= (event
->modifiers
3174 & (meta_modifier
| alt_modifier
3175 | hyper_modifier
| super_modifier
));
3179 extern SIGTYPE
interrupt_signal ();
3182 struct input_event
*sp
;
3185 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3186 kb
!= current_kboard
))
3189 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3190 Fcons (make_number (c
), Qnil
));
3191 kb
->kbd_queue_has_data
= 1;
3192 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3194 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3197 if (event_to_kboard (sp
) == kb
)
3199 sp
->kind
= no_event
;
3200 sp
->frame_or_window
= Qnil
;
3208 /* If this results in a quit_char being returned to Emacs as
3209 input, set Vlast_event_frame properly. If this doesn't
3210 get returned to Emacs as an event, the next event read
3211 will set Vlast_event_frame again, so this is safe to do. */
3215 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3217 focus
= event
->frame_or_window
;
3218 internal_last_event_frame
= focus
;
3219 Vlast_event_frame
= focus
;
3222 last_event_timestamp
= event
->timestamp
;
3223 interrupt_signal ();
3227 if (c
&& c
== stop_character
)
3233 /* Don't insert two buffer_switch_event's in a row.
3234 Just ignore the second one. */
3235 else if (event
->kind
== buffer_switch_event
3236 && kbd_fetch_ptr
!= kbd_store_ptr
3237 && kbd_store_ptr
->kind
== buffer_switch_event
)
3240 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3241 kbd_store_ptr
= kbd_buffer
;
3243 /* Don't let the very last slot in the buffer become full,
3244 since that would make the two pointers equal,
3245 and that is indistinguishable from an empty buffer.
3246 Discard the event if it would fill the last slot. */
3247 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3251 #if 0 /* The selection_request_event case looks bogus, and it's error
3252 prone to assign individual members for other events, in case
3253 the input_event structure is changed. --2000-07-13, gerd. */
3254 struct input_event
*sp
= kbd_store_ptr
;
3255 sp
->kind
= event
->kind
;
3256 if (event
->kind
== selection_request_event
)
3258 /* We must not use the ordinary copying code for this case,
3259 since `part' is an enum and copying it might not copy enough
3261 bcopy (event
, (char *) sp
, sizeof (*event
));
3266 sp
->code
= event
->code
;
3267 sp
->part
= event
->part
;
3268 sp
->frame_or_window
= event
->frame_or_window
;
3269 sp
->arg
= event
->arg
;
3270 sp
->modifiers
= event
->modifiers
;
3273 sp
->timestamp
= event
->timestamp
;
3276 *kbd_store_ptr
= *event
;
3279 idx
= 2 * (kbd_store_ptr
- kbd_buffer
);
3280 ASET (kbd_buffer_gcpro
, idx
, event
->frame_or_window
);
3281 ASET (kbd_buffer_gcpro
, idx
+ 1, event
->arg
);
3287 /* Generate HELP_EVENT input_events in BUFP which has room for
3288 SIZE events. If there's not enough room in BUFP, ignore this
3291 HELP is the help form.
3293 FRAME is the frame on which the help is generated. OBJECT is the
3294 Lisp object where the help was found (a buffer, a string, an
3295 overlay, or nil if neither from a string nor from a buffer. POS is
3296 the position within OBJECT where the help was found.
3298 Value is the number of input_events generated. */
3301 gen_help_event (bufp
, size
, help
, frame
, window
, object
, pos
)
3302 struct input_event
*bufp
;
3304 Lisp_Object help
, frame
, object
, window
;
3307 int nevents_stored
= 0;
3311 bufp
->kind
= HELP_EVENT
;
3312 bufp
->frame_or_window
= frame
;
3314 bufp
->x
= make_number (pos
);
3318 bufp
->kind
= HELP_EVENT
;
3319 bufp
->frame_or_window
= WINDOWP (window
) ? window
: frame
;
3325 return nevents_stored
;
3329 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3332 kbd_buffer_store_help_event (frame
, help
)
3333 Lisp_Object frame
, help
;
3335 struct input_event event
;
3337 event
.kind
= HELP_EVENT
;
3338 event
.frame_or_window
= frame
;
3340 event
.x
= make_number (0);
3342 kbd_buffer_store_event (&event
);
3344 event
.kind
= HELP_EVENT
;
3345 event
.frame_or_window
= frame
;
3347 event
.x
= make_number (0);
3349 kbd_buffer_store_event (&event
);
3353 /* Discard any mouse events in the event buffer by setting them to
3356 discard_mouse_events ()
3358 struct input_event
*sp
;
3359 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3361 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3364 if (sp
->kind
== mouse_click
3366 || sp
->kind
== w32_scroll_bar_click
3368 || sp
->kind
== scroll_bar_click
)
3370 sp
->kind
= no_event
;
3376 /* Return non-zero if there are any real events waiting in the event
3377 buffer, not counting `no_event's.
3379 If DISCARD is non-zero, discard no_event events at the front of
3380 the input queue, possibly leaving the input queue empty if there
3381 are no real input events. */
3384 kbd_buffer_events_waiting (discard
)
3387 struct input_event
*sp
;
3389 for (sp
= kbd_fetch_ptr
;
3390 sp
!= kbd_store_ptr
&& sp
->kind
== no_event
;
3393 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3400 return sp
!= kbd_store_ptr
&& sp
->kind
!= no_event
;
3404 /* Clear input event EVENT. */
3408 struct input_event
*event
;
3410 int idx
= 2 * (event
- kbd_buffer
);
3411 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
3412 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
3413 event
->kind
= no_event
;
3417 /* Read one event from the event buffer, waiting if necessary.
3418 The value is a Lisp object representing the event.
3419 The value is nil for an event that should be ignored,
3420 or that was handled here.
3421 We always read and discard one event. */
3424 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3426 int *used_mouse_menu
;
3435 *kbp
= current_kboard
;
3439 /* Wait until there is input available. */
3442 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3445 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3449 /* If the quit flag is set, then read_char will return
3450 quit_char, so that counts as "available input." */
3451 if (!NILP (Vquit_flag
))
3452 quit_throw_to_read_char ();
3454 /* One way or another, wait until input is available; then, if
3455 interrupt handlers have not read it, read it now. */
3458 wait_for_kbd_input ();
3460 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3464 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3467 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3471 Lisp_Object minus_one
;
3473 XSETINT (minus_one
, -1);
3474 wait_reading_process_input (0, 0, minus_one
, 1);
3476 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3477 /* Pass 1 for EXPECT since we just waited to have input. */
3478 read_avail_input (1);
3480 #endif /* not VMS */
3483 if (CONSP (Vunread_command_events
))
3486 first
= XCAR (Vunread_command_events
);
3487 Vunread_command_events
= XCDR (Vunread_command_events
);
3488 *kbp
= current_kboard
;
3492 /* At this point, we know that there is a readable event available
3493 somewhere. If the event queue is empty, then there must be a
3494 mouse movement enabled and available. */
3495 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3497 struct input_event
*event
;
3499 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3503 last_event_timestamp
= event
->timestamp
;
3506 *kbp
= event_to_kboard (event
);
3508 *kbp
= current_kboard
; /* Better than returning null ptr? */
3510 *kbp
= &the_only_kboard
;
3515 /* These two kinds of events get special handling
3516 and don't actually appear to the command loop.
3517 We return nil for them. */
3518 if (event
->kind
== selection_request_event
)
3521 struct input_event copy
;
3523 /* Remove it from the buffer before processing it,
3524 since otherwise swallow_events will see it
3525 and process it again. */
3527 kbd_fetch_ptr
= event
+ 1;
3528 input_pending
= readable_events (0);
3529 x_handle_selection_request (©
);
3531 /* We're getting selection request events, but we don't have
3537 else if (event
->kind
== selection_clear_event
)
3540 struct input_event copy
;
3542 /* Remove it from the buffer before processing it. */
3544 kbd_fetch_ptr
= event
+ 1;
3545 input_pending
= readable_events (0);
3546 x_handle_selection_clear (©
);
3548 /* We're getting selection request events, but we don't have
3553 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (macintosh)
3554 else if (event
->kind
== delete_window_event
)
3556 /* Make an event (delete-frame (FRAME)). */
3557 obj
= Fcons (event
->frame_or_window
, Qnil
);
3558 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3559 kbd_fetch_ptr
= event
+ 1;
3562 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3563 else if (event
->kind
== iconify_event
)
3565 /* Make an event (iconify-frame (FRAME)). */
3566 obj
= Fcons (event
->frame_or_window
, Qnil
);
3567 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3568 kbd_fetch_ptr
= event
+ 1;
3570 else if (event
->kind
== deiconify_event
)
3572 /* Make an event (make-frame-visible (FRAME)). */
3573 obj
= Fcons (event
->frame_or_window
, Qnil
);
3574 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3575 kbd_fetch_ptr
= event
+ 1;
3578 else if (event
->kind
== buffer_switch_event
)
3580 /* The value doesn't matter here; only the type is tested. */
3581 XSETBUFFER (obj
, current_buffer
);
3582 kbd_fetch_ptr
= event
+ 1;
3584 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
3585 else if (event
->kind
== menu_bar_activate_event
)
3587 kbd_fetch_ptr
= event
+ 1;
3588 input_pending
= readable_events (0);
3589 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3590 x_activate_menubar (XFRAME (event
->frame_or_window
));
3594 else if (event
->kind
== language_change_event
)
3596 /* Make an event (language-change (FRAME CHARSET LCID)). */
3597 obj
= Fcons (event
->modifiers
, Qnil
);
3598 obj
= Fcons (event
->code
, Qnil
);
3599 obj
= Fcons (event
->frame_or_window
, obj
);
3600 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3601 kbd_fetch_ptr
= event
+ 1;
3604 /* Just discard these, by returning nil.
3605 With MULTI_KBOARD, these events are used as placeholders
3606 when we need to randomly delete events from the queue.
3607 (They shouldn't otherwise be found in the buffer,
3608 but on some machines it appears they do show up
3609 even without MULTI_KBOARD.) */
3610 /* On Windows NT/9X, no_event is used to delete extraneous
3611 mouse events during a popup-menu call. */
3612 else if (event
->kind
== no_event
)
3613 kbd_fetch_ptr
= event
+ 1;
3614 else if (event
->kind
== HELP_EVENT
)
3616 /* There are always two HELP_EVENTs in the input queue. */
3617 Lisp_Object object
, position
, help
, frame
, window
;
3619 xassert (event
->code
== 0);
3620 frame
= event
->frame_or_window
;
3621 object
= event
->arg
;
3622 position
= event
->x
;
3623 clear_event (event
);
3625 kbd_fetch_ptr
= event
+ 1;
3626 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3629 xassert (event
->code
== 1);
3631 window
= event
->frame_or_window
;
3632 if (!WINDOWP (window
))
3634 obj
= Fcons (Qhelp_echo
,
3635 list5 (frame
, help
, window
, object
, position
));
3636 clear_event (event
);
3637 kbd_fetch_ptr
= event
+ 1;
3639 else if (event
->kind
== FOCUS_IN_EVENT
)
3641 /* Notification of a FocusIn event. The frame receiving the
3642 focus is in event->frame_or_window. Generate a
3643 switch-frame event if necessary. */
3644 Lisp_Object frame
, focus
;
3646 frame
= event
->frame_or_window
;
3647 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3651 if (!EQ (frame
, internal_last_event_frame
)
3652 && !EQ (frame
, selected_frame
))
3653 obj
= make_lispy_switch_frame (frame
);
3654 internal_last_event_frame
= frame
;
3655 kbd_fetch_ptr
= event
+ 1;
3659 /* If this event is on a different frame, return a switch-frame this
3660 time, and leave the event in the queue for next time. */
3664 frame
= event
->frame_or_window
;
3666 frame
= XCAR (frame
);
3667 else if (WINDOWP (frame
))
3668 frame
= WINDOW_FRAME (XWINDOW (frame
));
3670 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3674 if (! EQ (frame
, internal_last_event_frame
)
3675 && !EQ (frame
, selected_frame
))
3676 obj
= make_lispy_switch_frame (frame
);
3677 internal_last_event_frame
= frame
;
3679 /* If we didn't decide to make a switch-frame event, go ahead
3680 and build a real event from the queue entry. */
3684 obj
= make_lispy_event (event
);
3686 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
3687 /* If this was a menu selection, then set the flag to inhibit
3688 writing to last_nonmenu_event. Don't do this if the event
3689 we're returning is (menu-bar), though; that indicates the
3690 beginning of the menu sequence, and we might as well leave
3691 that as the `event with parameters' for this selection. */
3693 && !EQ (event
->frame_or_window
, event
->arg
)
3694 && (event
->kind
== MENU_BAR_EVENT
3695 || event
->kind
== TOOL_BAR_EVENT
))
3696 *used_mouse_menu
= 1;
3699 /* Wipe out this event, to catch bugs. */
3700 clear_event (event
);
3701 kbd_fetch_ptr
= event
+ 1;
3706 /* Try generating a mouse motion event. */
3707 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3709 FRAME_PTR f
= some_mouse_moved ();
3710 Lisp_Object bar_window
;
3711 enum scroll_bar_part part
;
3715 *kbp
= current_kboard
;
3716 /* Note that this uses F to determine which display to look at.
3717 If there is no valid info, it does not store anything
3718 so x remains nil. */
3720 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
3724 /* Decide if we should generate a switch-frame event. Don't
3725 generate switch-frame events for motion outside of all Emacs
3731 frame
= FRAME_FOCUS_FRAME (f
);
3733 XSETFRAME (frame
, f
);
3735 if (! EQ (frame
, internal_last_event_frame
)
3736 && !EQ (frame
, selected_frame
))
3737 obj
= make_lispy_switch_frame (frame
);
3738 internal_last_event_frame
= frame
;
3741 /* If we didn't decide to make a switch-frame event, go ahead and
3742 return a mouse-motion event. */
3743 if (!NILP (x
) && NILP (obj
))
3744 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
3746 #endif /* HAVE_MOUSE */
3748 /* We were promised by the above while loop that there was
3749 something for us to read! */
3752 input_pending
= readable_events (0);
3754 Vlast_event_frame
= internal_last_event_frame
;
3759 /* Process any events that are not user-visible,
3760 then return, without reading any user-visible events. */
3763 swallow_events (do_display
)
3768 while (kbd_fetch_ptr
!= kbd_store_ptr
)
3770 struct input_event
*event
;
3772 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3776 last_event_timestamp
= event
->timestamp
;
3778 /* These two kinds of events get special handling
3779 and don't actually appear to the command loop. */
3780 if (event
->kind
== selection_request_event
)
3783 struct input_event copy
;
3785 /* Remove it from the buffer before processing it,
3786 since otherwise swallow_events called recursively could see it
3787 and process it again. */
3789 kbd_fetch_ptr
= event
+ 1;
3790 input_pending
= readable_events (0);
3791 x_handle_selection_request (©
);
3793 /* We're getting selection request events, but we don't have
3799 else if (event
->kind
== selection_clear_event
)
3802 struct input_event copy
;
3804 /* Remove it from the buffer before processing it, */
3807 kbd_fetch_ptr
= event
+ 1;
3808 input_pending
= readable_events (0);
3809 x_handle_selection_clear (©
);
3811 /* We're getting selection request events, but we don't have
3820 old_timers_run
= timers_run
;
3821 get_input_pending (&input_pending
, 1);
3823 if (timers_run
!= old_timers_run
&& do_display
)
3824 redisplay_preserve_echo_area (7);
3827 static EMACS_TIME timer_idleness_start_time
;
3829 /* Record the start of when Emacs is idle,
3830 for the sake of running idle-time timers. */
3837 /* If we are already in the idle state, do nothing. */
3838 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3841 EMACS_GET_TIME (timer_idleness_start_time
);
3843 /* Mark all idle-time timers as once again candidates for running. */
3844 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
3848 timer
= XCAR (timers
);
3850 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3852 XVECTOR (timer
)->contents
[0] = Qnil
;
3856 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
3861 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
3864 /* This is only for debugging. */
3865 struct input_event last_timer_event
;
3867 /* Check whether a timer has fired. To prevent larger problems we simply
3868 disregard elements that are not proper timers. Do not make a circular
3869 timer list for the time being.
3871 Returns the number of seconds to wait until the next timer fires. If a
3872 timer is triggering now, return zero seconds.
3873 If no timer is active, return -1 seconds.
3875 If a timer is ripe, we run it, with quitting turned off.
3877 DO_IT_NOW is now ignored. It used to mean that we should
3878 run the timer directly instead of queueing a timer-event.
3879 Now we always run timers directly. */
3882 timer_check (do_it_now
)
3885 EMACS_TIME nexttime
;
3886 EMACS_TIME now
, idleness_now
;
3887 Lisp_Object timers
, idle_timers
, chosen_timer
;
3888 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3890 EMACS_SET_SECS (nexttime
, -1);
3891 EMACS_SET_USECS (nexttime
, -1);
3893 /* Always consider the ordinary timers. */
3894 timers
= Vtimer_list
;
3895 /* Consider the idle timers only if Emacs is idle. */
3896 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3897 idle_timers
= Vtimer_idle_list
;
3900 chosen_timer
= Qnil
;
3901 GCPRO3 (timers
, idle_timers
, chosen_timer
);
3903 if (CONSP (timers
) || CONSP (idle_timers
))
3905 EMACS_GET_TIME (now
);
3906 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3907 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
3910 while (CONSP (timers
) || CONSP (idle_timers
))
3912 Lisp_Object
*vector
;
3913 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
3914 EMACS_TIME timer_time
, idle_timer_time
;
3915 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
3917 /* Skip past invalid timers and timers already handled. */
3920 timer
= XCAR (timers
);
3921 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3923 timers
= XCDR (timers
);
3926 vector
= XVECTOR (timer
)->contents
;
3928 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3929 || !INTEGERP (vector
[3])
3930 || ! NILP (vector
[0]))
3932 timers
= XCDR (timers
);
3936 if (!NILP (idle_timers
))
3938 timer
= XCAR (idle_timers
);
3939 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3941 idle_timers
= XCDR (idle_timers
);
3944 vector
= XVECTOR (timer
)->contents
;
3946 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3947 || !INTEGERP (vector
[3])
3948 || ! NILP (vector
[0]))
3950 idle_timers
= XCDR (idle_timers
);
3955 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
3956 based on the next ordinary timer.
3957 TIMER_DIFFERENCE is the distance in time from NOW to when
3958 this timer becomes ripe (negative if it's already ripe). */
3961 timer
= XCAR (timers
);
3962 vector
= XVECTOR (timer
)->contents
;
3963 EMACS_SET_SECS (timer_time
,
3964 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3965 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
3966 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
3969 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
3970 based on the next idle timer. */
3971 if (!NILP (idle_timers
))
3973 idle_timer
= XCAR (idle_timers
);
3974 vector
= XVECTOR (idle_timer
)->contents
;
3975 EMACS_SET_SECS (idle_timer_time
,
3976 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3977 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
3978 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
3981 /* Decide which timer is the next timer,
3982 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
3983 Also step down the list where we found that timer. */
3985 if (! NILP (timers
) && ! NILP (idle_timers
))
3988 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
3989 if (EMACS_TIME_NEG_P (temp
))
3991 chosen_timer
= timer
;
3992 timers
= XCDR (timers
);
3993 difference
= timer_difference
;
3997 chosen_timer
= idle_timer
;
3998 idle_timers
= XCDR (idle_timers
);
3999 difference
= idle_timer_difference
;
4002 else if (! NILP (timers
))
4004 chosen_timer
= timer
;
4005 timers
= XCDR (timers
);
4006 difference
= timer_difference
;
4010 chosen_timer
= idle_timer
;
4011 idle_timers
= XCDR (idle_timers
);
4012 difference
= idle_timer_difference
;
4014 vector
= XVECTOR (chosen_timer
)->contents
;
4016 /* If timer is ripe, run it if it hasn't been run. */
4017 if (EMACS_TIME_NEG_P (difference
)
4018 || (EMACS_SECS (difference
) == 0
4019 && EMACS_USECS (difference
) == 0))
4021 if (NILP (vector
[0]))
4023 int was_locked
= single_kboard
;
4024 int count
= BINDING_STACK_SIZE ();
4025 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4027 /* Mark the timer as triggered to prevent problems if the lisp
4028 code fails to reschedule it right. */
4031 specbind (Qinhibit_quit
, Qt
);
4033 call1 (Qtimer_event_handler
, chosen_timer
);
4034 Vdeactivate_mark
= old_deactivate_mark
;
4036 unbind_to (count
, Qnil
);
4038 /* Resume allowing input from any kboard, if that was true before. */
4040 any_kboard_state ();
4042 /* Since we have handled the event,
4043 we don't need to tell the caller to wake up and do it. */
4047 /* When we encounter a timer that is still waiting,
4048 return the amount of time to wait before it is ripe. */
4055 /* No timers are pending in the future. */
4056 /* Return 0 if we generated an event, and -1 if not. */
4061 /* Caches for modify_event_symbol. */
4062 static Lisp_Object accent_key_syms
;
4063 static Lisp_Object func_key_syms
;
4064 static Lisp_Object mouse_syms
;
4066 static Lisp_Object mouse_wheel_syms
;
4068 static Lisp_Object drag_n_drop_syms
;
4070 /* This is a list of keysym codes for special "accent" characters.
4071 It parallels lispy_accent_keys. */
4073 static int lispy_accent_codes
[] =
4075 #ifdef XK_dead_circumflex
4080 #ifdef XK_dead_grave
4085 #ifdef XK_dead_tilde
4090 #ifdef XK_dead_diaeresis
4095 #ifdef XK_dead_macron
4100 #ifdef XK_dead_degree
4105 #ifdef XK_dead_acute
4110 #ifdef XK_dead_cedilla
4115 #ifdef XK_dead_breve
4120 #ifdef XK_dead_ogonek
4125 #ifdef XK_dead_caron
4130 #ifdef XK_dead_doubleacute
4131 XK_dead_doubleacute
,
4135 #ifdef XK_dead_abovedot
4142 /* This is a list of Lisp names for special "accent" characters.
4143 It parallels lispy_accent_codes. */
4145 static char *lispy_accent_keys
[] =
4163 #define FUNCTION_KEY_OFFSET 0x0
4165 char *lispy_function_keys
[] =
4169 0, /* VK_LBUTTON 0x01 */
4170 0, /* VK_RBUTTON 0x02 */
4171 "cancel", /* VK_CANCEL 0x03 */
4172 0, /* VK_MBUTTON 0x04 */
4174 0, 0, 0, /* 0x05 .. 0x07 */
4176 "backspace", /* VK_BACK 0x08 */
4177 "tab", /* VK_TAB 0x09 */
4179 0, 0, /* 0x0A .. 0x0B */
4181 "clear", /* VK_CLEAR 0x0C */
4182 "return", /* VK_RETURN 0x0D */
4184 0, 0, /* 0x0E .. 0x0F */
4186 0, /* VK_SHIFT 0x10 */
4187 0, /* VK_CONTROL 0x11 */
4188 0, /* VK_MENU 0x12 */
4189 "pause", /* VK_PAUSE 0x13 */
4190 "capslock", /* VK_CAPITAL 0x14 */
4192 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4194 "escape", /* VK_ESCAPE 0x1B */
4196 0, 0, 0, 0, /* 0x1C .. 0x1F */
4198 0, /* VK_SPACE 0x20 */
4199 "prior", /* VK_PRIOR 0x21 */
4200 "next", /* VK_NEXT 0x22 */
4201 "end", /* VK_END 0x23 */
4202 "home", /* VK_HOME 0x24 */
4203 "left", /* VK_LEFT 0x25 */
4204 "up", /* VK_UP 0x26 */
4205 "right", /* VK_RIGHT 0x27 */
4206 "down", /* VK_DOWN 0x28 */
4207 "select", /* VK_SELECT 0x29 */
4208 "print", /* VK_PRINT 0x2A */
4209 "execute", /* VK_EXECUTE 0x2B */
4210 "snapshot", /* VK_SNAPSHOT 0x2C */
4211 "insert", /* VK_INSERT 0x2D */
4212 "delete", /* VK_DELETE 0x2E */
4213 "help", /* VK_HELP 0x2F */
4215 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4217 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4219 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4221 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4223 0, 0, 0, 0, 0, 0, 0, 0, 0,
4224 0, 0, 0, 0, 0, 0, 0, 0, 0,
4225 0, 0, 0, 0, 0, 0, 0, 0,
4227 "lwindow", /* VK_LWIN 0x5B */
4228 "rwindow", /* VK_RWIN 0x5C */
4229 "apps", /* VK_APPS 0x5D */
4231 0, 0, /* 0x5E .. 0x5F */
4233 "kp-0", /* VK_NUMPAD0 0x60 */
4234 "kp-1", /* VK_NUMPAD1 0x61 */
4235 "kp-2", /* VK_NUMPAD2 0x62 */
4236 "kp-3", /* VK_NUMPAD3 0x63 */
4237 "kp-4", /* VK_NUMPAD4 0x64 */
4238 "kp-5", /* VK_NUMPAD5 0x65 */
4239 "kp-6", /* VK_NUMPAD6 0x66 */
4240 "kp-7", /* VK_NUMPAD7 0x67 */
4241 "kp-8", /* VK_NUMPAD8 0x68 */
4242 "kp-9", /* VK_NUMPAD9 0x69 */
4243 "kp-multiply", /* VK_MULTIPLY 0x6A */
4244 "kp-add", /* VK_ADD 0x6B */
4245 "kp-separator", /* VK_SEPARATOR 0x6C */
4246 "kp-subtract", /* VK_SUBTRACT 0x6D */
4247 "kp-decimal", /* VK_DECIMAL 0x6E */
4248 "kp-divide", /* VK_DIVIDE 0x6F */
4249 "f1", /* VK_F1 0x70 */
4250 "f2", /* VK_F2 0x71 */
4251 "f3", /* VK_F3 0x72 */
4252 "f4", /* VK_F4 0x73 */
4253 "f5", /* VK_F5 0x74 */
4254 "f6", /* VK_F6 0x75 */
4255 "f7", /* VK_F7 0x76 */
4256 "f8", /* VK_F8 0x77 */
4257 "f9", /* VK_F9 0x78 */
4258 "f10", /* VK_F10 0x79 */
4259 "f11", /* VK_F11 0x7A */
4260 "f12", /* VK_F12 0x7B */
4261 "f13", /* VK_F13 0x7C */
4262 "f14", /* VK_F14 0x7D */
4263 "f15", /* VK_F15 0x7E */
4264 "f16", /* VK_F16 0x7F */
4265 "f17", /* VK_F17 0x80 */
4266 "f18", /* VK_F18 0x81 */
4267 "f19", /* VK_F19 0x82 */
4268 "f20", /* VK_F20 0x83 */
4269 "f21", /* VK_F21 0x84 */
4270 "f22", /* VK_F22 0x85 */
4271 "f23", /* VK_F23 0x86 */
4272 "f24", /* VK_F24 0x87 */
4274 0, 0, 0, 0, /* 0x88 .. 0x8B */
4275 0, 0, 0, 0, /* 0x8C .. 0x8F */
4277 "kp-numlock", /* VK_NUMLOCK 0x90 */
4278 "scroll", /* VK_SCROLL 0x91 */
4280 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4281 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4282 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4283 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4284 "kp-end", /* VK_NUMPAD_END 0x96 */
4285 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4286 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4287 "kp-up", /* VK_NUMPAD_UP 0x99 */
4288 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4289 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4290 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4291 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4293 0, 0, /* 0x9E .. 0x9F */
4296 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4297 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4298 * No other API or message will distinguish left and right keys this way.
4302 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4303 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4304 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4305 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4306 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4312 "attn", /* VK_ATTN 0xF6 */
4313 "crsel", /* VK_CRSEL 0xF7 */
4314 "exsel", /* VK_EXSEL 0xF8 */
4315 "ereof", /* VK_EREOF 0xF9 */
4316 "play", /* VK_PLAY 0xFA */
4317 "zoom", /* VK_ZOOM 0xFB */
4318 "noname", /* VK_NONAME 0xFC */
4319 "pa1", /* VK_PA1 0xFD */
4320 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4324 #else /* not HAVE_NTGUI */
4327 static char *lispy_kana_keys
[] =
4329 /* X Keysym value */
4330 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4331 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4332 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4333 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4334 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4335 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4336 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4337 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4338 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4339 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4340 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4341 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4342 "kana-i", "kana-u", "kana-e", "kana-o",
4343 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4344 "prolongedsound", "kana-A", "kana-I", "kana-U",
4345 "kana-E", "kana-O", "kana-KA", "kana-KI",
4346 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4347 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4348 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4349 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4350 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4351 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4352 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4353 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4354 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4355 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4356 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4357 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4359 #endif /* XK_kana_A */
4361 #define FUNCTION_KEY_OFFSET 0xff00
4363 /* You'll notice that this table is arranged to be conveniently
4364 indexed by X Windows keysym values. */
4365 static char *lispy_function_keys
[] =
4367 /* X Keysym value */
4369 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4370 "backspace", "tab", "linefeed", "clear",
4372 0, 0, 0, "pause", /* 0xff10...1f */
4373 0, 0, 0, 0, 0, 0, 0, "escape",
4375 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4376 "romaji", "hiragana", "katakana", "hiragana-katakana",
4377 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4378 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4379 "eisu-toggle", /* 0xff30...3f */
4380 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4381 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4383 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4384 "down", "prior", "next", "end",
4385 "begin", 0, 0, 0, 0, 0, 0, 0,
4386 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4397 "break", /* 0xff6b */
4400 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4401 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4402 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4403 0, 0, 0, 0, 0, 0, 0, 0,
4404 "kp-tab", /* 0xff89 */
4406 "kp-enter", /* 0xff8d */
4408 "kp-f1", /* 0xff91 */
4412 "kp-home", /* 0xff95 */
4417 "kp-prior", /* kp-page-up */
4418 "kp-next", /* kp-page-down */
4424 0, 0, 0, 0, 0, 0, 0, 0, 0,
4425 "kp-multiply", /* 0xffaa */
4430 "kp-divide", /* 0xffaf */
4431 "kp-0", /* 0xffb0 */
4432 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4435 "kp-equal", /* 0xffbd */
4436 "f1", /* 0xffbe */ /* IsFunctionKey */
4438 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4439 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4440 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4441 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4442 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4443 0, 0, 0, 0, 0, 0, 0, 0,
4444 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4445 0, 0, 0, 0, 0, 0, 0, "delete"
4448 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4449 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4451 static char *iso_lispy_function_keys
[] =
4453 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4454 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4455 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4456 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4457 "iso-lefttab", /* 0xfe20 */
4458 "iso-move-line-up", "iso-move-line-down",
4459 "iso-partial-line-up", "iso-partial-line-down",
4460 "iso-partial-space-left", "iso-partial-space-right",
4461 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4462 "iso-release-margin-left", "iso-release-margin-right",
4463 "iso-release-both-margins",
4464 "iso-fast-cursor-left", "iso-fast-cursor-right",
4465 "iso-fast-cursor-up", "iso-fast-cursor-down",
4466 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4467 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4470 #endif /* not HAVE_NTGUI */
4472 Lisp_Object Vlispy_mouse_stem
;
4475 /* mouse-wheel events are generated by the wheel on devices such as
4476 the MS Intellimouse. The wheel sits in between the left and right
4477 mouse buttons, and is typically used to scroll or zoom the window
4478 underneath the pointer. mouse-wheel events specify the object on
4479 which they operate, and a delta corresponding to the amount and
4480 direction that the wheel is rotated. Clicking the mouse-wheel
4481 generates a mouse-2 event. */
4482 static char *lispy_mouse_wheel_names
[] =
4487 #endif /* WINDOWSNT */
4489 /* drag-n-drop events are generated when a set of selected files are
4490 dragged from another application and dropped onto an Emacs window. */
4491 static char *lispy_drag_n_drop_names
[] =
4496 /* Scroll bar parts. */
4497 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4498 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4499 Lisp_Object Qtop
, Qratio
;
4501 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4502 Lisp_Object
*scroll_bar_parts
[] = {
4503 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4504 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4507 /* User signal events. */
4508 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4510 Lisp_Object
*lispy_user_signals
[] =
4512 &Qusr1_signal
, &Qusr2_signal
4516 /* A vector, indexed by button number, giving the down-going location
4517 of currently depressed buttons, both scroll bar and non-scroll bar.
4519 The elements have the form
4520 (BUTTON-NUMBER MODIFIER-MASK . REST)
4521 where REST is the cdr of a position as it would be reported in the event.
4523 The make_lispy_event function stores positions here to tell the
4524 difference between click and drag events, and to store the starting
4525 location to be included in drag events. */
4527 static Lisp_Object button_down_location
;
4529 /* Information about the most recent up-going button event: Which
4530 button, what location, and what time. */
4532 static int last_mouse_button
;
4533 static int last_mouse_x
;
4534 static int last_mouse_y
;
4535 static unsigned long button_down_time
;
4537 /* The maximum time between clicks to make a double-click,
4538 or Qnil to disable double-click detection,
4539 or Qt for no time limit. */
4540 Lisp_Object Vdouble_click_time
;
4542 /* The number of clicks in this multiple-click. */
4544 int double_click_count
;
4546 /* Given a struct input_event, build the lisp event which represents
4547 it. If EVENT is 0, build a mouse movement event from the mouse
4548 movement buffer, which should have a movement event in it.
4550 Note that events must be passed to this function in the order they
4551 are received; this function stores the location of button presses
4552 in order to build drag events when the button is released. */
4555 make_lispy_event (event
)
4556 struct input_event
*event
;
4560 switch (SWITCH_ENUM_CAST (event
->kind
))
4562 /* A simple keystroke. */
4563 case ascii_keystroke
:
4565 Lisp_Object lispy_c
;
4566 int c
= event
->code
& 0377;
4567 /* Turn ASCII characters into control characters
4569 if (event
->modifiers
& ctrl_modifier
)
4570 c
= make_ctrl_char (c
);
4572 /* Add in the other modifier bits. We took care of ctrl_modifier
4573 just above, and the shift key was taken care of by the X code,
4574 and applied to control characters by make_ctrl_char. */
4575 c
|= (event
->modifiers
4576 & (meta_modifier
| alt_modifier
4577 | hyper_modifier
| super_modifier
));
4578 /* Distinguish Shift-SPC from SPC. */
4579 if ((event
->code
& 0377) == 040
4580 && event
->modifiers
& shift_modifier
)
4581 c
|= shift_modifier
;
4582 button_down_time
= 0;
4583 XSETFASTINT (lispy_c
, c
);
4587 case multibyte_char_keystroke
:
4589 Lisp_Object lispy_c
;
4591 XSETFASTINT (lispy_c
, event
->code
);
4595 /* A function key. The symbol may need to have modifier prefixes
4597 case non_ascii_keystroke
:
4598 button_down_time
= 0;
4600 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
4601 if (event
->code
== lispy_accent_codes
[i
])
4602 return modify_event_symbol (i
,
4604 Qfunction_key
, Qnil
,
4605 lispy_accent_keys
, &accent_key_syms
,
4606 (sizeof (lispy_accent_keys
)
4607 / sizeof (lispy_accent_keys
[0])));
4609 /* Handle system-specific keysyms. */
4610 if (event
->code
& (1 << 28))
4612 /* We need to use an alist rather than a vector as the cache
4613 since we can't make a vector long enuf. */
4614 if (NILP (current_kboard
->system_key_syms
))
4615 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
4616 return modify_event_symbol (event
->code
,
4619 current_kboard
->Vsystem_key_alist
,
4620 0, ¤t_kboard
->system_key_syms
,
4625 if (event
->code
>= 0x400 && event
->code
< 0x500)
4626 return modify_event_symbol (event
->code
- 0x400,
4627 event
->modifiers
& ~shift_modifier
,
4628 Qfunction_key
, Qnil
,
4629 lispy_kana_keys
, &func_key_syms
,
4630 (sizeof (lispy_kana_keys
)
4631 / sizeof (lispy_kana_keys
[0])));
4632 #endif /* XK_kana_A */
4634 #ifdef ISO_FUNCTION_KEY_OFFSET
4635 if (event
->code
< FUNCTION_KEY_OFFSET
4636 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
4637 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
4639 Qfunction_key
, Qnil
,
4640 iso_lispy_function_keys
, &func_key_syms
,
4641 (sizeof (iso_lispy_function_keys
)
4642 / sizeof (iso_lispy_function_keys
[0])));
4645 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
4647 Qfunction_key
, Qnil
,
4648 lispy_function_keys
, &func_key_syms
,
4649 (sizeof (lispy_function_keys
)
4650 / sizeof (lispy_function_keys
[0])));
4653 /* A mouse click. Figure out where it is, decide whether it's
4654 a press, click or drag, and build the appropriate structure. */
4656 #ifndef USE_TOOLKIT_SCROLL_BARS
4657 case scroll_bar_click
:
4660 int button
= event
->code
;
4662 Lisp_Object position
;
4663 Lisp_Object
*start_pos_ptr
;
4664 Lisp_Object start_pos
;
4668 /* Build the position as appropriate for this mouse click. */
4669 if (event
->kind
== mouse_click
)
4672 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
4675 Lisp_Object string_info
= Qnil
;
4678 /* Ignore mouse events that were made on frame that
4679 have been deleted. */
4680 if (! FRAME_LIVE_P (f
))
4683 /* EVENT->x and EVENT->y are frame-relative pixel
4684 coordinates at this place. Under old redisplay, COLUMN
4685 and ROW are set to frame relative glyph coordinates
4686 which are then used to determine whether this click is
4687 in a menu (non-toolkit version). */
4688 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4689 &column
, &row
, NULL
, 1);
4691 #ifndef USE_X_TOOLKIT
4692 /* In the non-toolkit version, clicks on the menu bar
4693 are ordinary button events in the event buffer.
4694 Distinguish them, and invoke the menu.
4696 (In the toolkit version, the toolkit handles the menu bar
4697 and Emacs doesn't know about it until after the user
4698 makes a selection.) */
4699 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
4700 && (event
->modifiers
& down_modifier
))
4702 Lisp_Object items
, item
;
4707 /* Activate the menu bar on the down event. If the
4708 up event comes in before the menu code can deal with it,
4710 if (! (event
->modifiers
& down_modifier
))
4714 /* Find the menu bar item under `column'. */
4716 items
= FRAME_MENU_BAR_ITEMS (f
);
4717 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
4719 Lisp_Object pos
, string
;
4720 string
= AREF (items
, i
+ 1);
4721 pos
= AREF (items
, i
+ 3);
4724 if (column
>= XINT (pos
)
4725 && column
< XINT (pos
) + XSTRING (string
)->size
)
4727 item
= AREF (items
, i
);
4732 /* ELisp manual 2.4b says (x y) are window relative but
4733 code says they are frame-relative. */
4735 = Fcons (event
->frame_or_window
,
4737 Fcons (Fcons (event
->x
, event
->y
),
4738 Fcons (make_number (event
->timestamp
),
4741 return Fcons (item
, Fcons (position
, Qnil
));
4743 #endif /* not USE_X_TOOLKIT */
4745 /* Set `window' to the window under frame pixel coordinates
4746 event->x/event->y. */
4747 window
= window_from_coordinates (f
, XINT (event
->x
),
4748 XINT (event
->y
), &part
, 0);
4750 if (!WINDOWP (window
))
4752 window
= event
->frame_or_window
;
4757 /* It's a click in window window at frame coordinates
4758 event->x/ event->y. */
4759 struct window
*w
= XWINDOW (window
);
4761 /* Get window relative coordinates. Original code
4762 `rounded' this to glyph boundaries. */
4763 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
4764 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
4766 /* Set event coordinates to window-relative coordinates
4767 for constructing the Lisp event below. */
4768 XSETINT (event
->x
, wx
);
4769 XSETINT (event
->y
, wy
);
4771 if (part
== 1 || part
== 3)
4773 /* Mode line or header line. Look for a string under
4774 the mouse that may have a `local-map' property. */
4778 posn
= part
== 1 ? Qmode_line
: Qheader_line
;
4779 string
= mode_line_string (w
, wx
, wy
, part
== 1, &charpos
);
4780 if (STRINGP (string
))
4781 string_info
= Fcons (string
, make_number (charpos
));
4784 posn
= Qvertical_line
;
4788 struct display_pos p
;
4789 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
4790 posn
= make_number (CHARPOS (p
.pos
));
4791 if (STRINGP (object
))
4794 make_number (CHARPOS (p
.string_pos
)));
4801 Fcons (Fcons (event
->x
, event
->y
),
4802 Fcons (make_number (event
->timestamp
),
4805 : Fcons (string_info
, Qnil
))))));
4807 #ifndef USE_TOOLKIT_SCROLL_BARS
4810 /* It's a scrollbar click. */
4812 Lisp_Object portion_whole
;
4815 window
= event
->frame_or_window
;
4816 portion_whole
= Fcons (event
->x
, event
->y
);
4817 part
= *scroll_bar_parts
[(int) event
->part
];
4821 Fcons (Qvertical_scroll_bar
,
4822 Fcons (portion_whole
,
4823 Fcons (make_number (event
->timestamp
),
4824 Fcons (part
, Qnil
)))));
4826 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4828 if (button
>= ASIZE (button_down_location
))
4830 button_down_location
= larger_vector (button_down_location
,
4832 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
4835 start_pos_ptr
= &AREF (button_down_location
, button
);
4836 start_pos
= *start_pos_ptr
;
4837 *start_pos_ptr
= Qnil
;
4839 is_double
= (button
== last_mouse_button
4840 && XINT (event
->x
) == last_mouse_x
4841 && XINT (event
->y
) == last_mouse_y
4842 && button_down_time
!= 0
4843 && (EQ (Vdouble_click_time
, Qt
)
4844 || (INTEGERP (Vdouble_click_time
)
4845 && ((int)(event
->timestamp
- button_down_time
)
4846 < XINT (Vdouble_click_time
)))));
4847 last_mouse_button
= button
;
4848 last_mouse_x
= XINT (event
->x
);
4849 last_mouse_y
= XINT (event
->y
);
4851 /* If this is a button press, squirrel away the location, so
4852 we can decide later whether it was a click or a drag. */
4853 if (event
->modifiers
& down_modifier
)
4857 double_click_count
++;
4858 event
->modifiers
|= ((double_click_count
> 2)
4863 double_click_count
= 1;
4864 button_down_time
= event
->timestamp
;
4865 *start_pos_ptr
= Fcopy_alist (position
);
4868 /* Now we're releasing a button - check the co-ordinates to
4869 see if this was a click or a drag. */
4870 else if (event
->modifiers
& up_modifier
)
4872 /* If we did not see a down before this up, ignore the up.
4873 Probably this happened because the down event chose a
4874 menu item. It would be an annoyance to treat the
4875 release of the button that chose the menu item as a
4878 if (!CONSP (start_pos
))
4881 event
->modifiers
&= ~up_modifier
;
4882 #if 0 /* Formerly we treated an up with no down as a click event. */
4883 if (!CONSP (start_pos
))
4884 event
->modifiers
|= click_modifier
;
4888 /* The third element of every position should be the (x,y)
4892 down
= Fnth (make_number (2), start_pos
);
4893 if (EQ (event
->x
, XCAR (down
)) && EQ (event
->y
, XCDR (down
)))
4894 /* Mouse hasn't moved. */
4895 event
->modifiers
|= click_modifier
;
4898 Lisp_Object window1
, window2
, posn1
, posn2
;
4900 /* Avoid generating a drag event if the mouse
4901 hasn't actually moved off the buffer position. */
4902 window1
= Fnth (make_number (0), position
);
4903 posn1
= Fnth (make_number (1), position
);
4904 window2
= Fnth (make_number (0), start_pos
);
4905 posn2
= Fnth (make_number (1), start_pos
);
4907 if (EQ (window1
, window2
) && EQ (posn1
, posn2
))
4908 event
->modifiers
|= click_modifier
;
4911 button_down_time
= 0;
4912 event
->modifiers
|= drag_modifier
;
4916 /* Don't check is_double; treat this as multiple
4917 if the down-event was multiple. */
4918 if (double_click_count
> 1)
4919 event
->modifiers
|= ((double_click_count
> 2)
4925 /* Every mouse event should either have the down_modifier or
4926 the up_modifier set. */
4930 /* Get the symbol we should use for the mouse click. */
4933 head
= modify_event_symbol (button
,
4935 Qmouse_click
, Vlispy_mouse_stem
,
4938 XVECTOR (mouse_syms
)->size
);
4939 if (event
->modifiers
& drag_modifier
)
4944 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
4947 Fcons (make_number (double_click_count
),
4956 #if USE_TOOLKIT_SCROLL_BARS
4958 /* We don't have down and up events if using toolkit scroll bars,
4959 so make this always a click event. Store in the `part' of
4960 the Lisp event a symbol which maps to the following actions:
4962 `above_handle' page up
4963 `below_handle' page down
4967 `bottom' bottom of buffer
4968 `handle' thumb has been dragged.
4969 `end-scroll' end of interaction with scroll bar
4971 The incoming input_event contains in its `part' member an
4972 index of type `enum scroll_bar_part' which we can use as an
4973 index in scroll_bar_parts to get the appropriate symbol. */
4975 case scroll_bar_click
:
4977 Lisp_Object position
, head
, window
, portion_whole
, part
;
4979 window
= event
->frame_or_window
;
4980 portion_whole
= Fcons (event
->x
, event
->y
);
4981 part
= *scroll_bar_parts
[(int) event
->part
];
4985 Fcons (Qvertical_scroll_bar
,
4986 Fcons (portion_whole
,
4987 Fcons (make_number (event
->timestamp
),
4988 Fcons (part
, Qnil
)))));
4990 /* Always treat scroll bar events as clicks. */
4991 event
->modifiers
|= click_modifier
;
4993 /* Get the symbol we should use for the mouse click. */
4994 head
= modify_event_symbol (event
->code
,
4999 XVECTOR (mouse_syms
)->size
);
5000 return Fcons (head
, Fcons (position
, Qnil
));
5003 #endif /* USE_TOOLKIT_SCROLL_BARS */
5006 case w32_scroll_bar_click
:
5008 int button
= event
->code
;
5010 Lisp_Object position
;
5011 Lisp_Object
*start_pos_ptr
;
5012 Lisp_Object start_pos
;
5016 Lisp_Object portion_whole
;
5019 window
= event
->frame_or_window
;
5020 portion_whole
= Fcons (event
->x
, event
->y
);
5021 part
= *scroll_bar_parts
[(int) event
->part
];
5025 Fcons (Qvertical_scroll_bar
,
5026 Fcons (portion_whole
,
5027 Fcons (make_number (event
->timestamp
),
5028 Fcons (part
, Qnil
)))));
5031 /* Always treat W32 scroll bar events as clicks. */
5032 event
->modifiers
|= click_modifier
;
5035 /* Get the symbol we should use for the mouse click. */
5038 head
= modify_event_symbol (button
,
5043 XVECTOR (mouse_syms
)->size
);
5052 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5055 Lisp_Object head
, position
;
5058 /* Ignore mouse events that were made on frame that
5059 have been deleted. */
5060 if (! FRAME_LIVE_P (f
))
5062 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5063 &column
, &row
, NULL
, 1);
5064 window
= window_from_coordinates (f
, XINT (event
->x
),
5065 XINT (event
->y
), &part
, 0);
5067 if (!WINDOWP (window
))
5069 window
= event
->frame_or_window
;
5074 int pixcolumn
, pixrow
;
5075 column
-= XINT (XWINDOW (window
)->left
);
5076 row
-= XINT (XWINDOW (window
)->top
);
5077 glyph_to_pixel_coords (XWINDOW(window
), column
, row
,
5078 &pixcolumn
, &pixrow
);
5079 XSETINT (event
->x
, pixcolumn
);
5080 XSETINT (event
->y
, pixrow
);
5085 posn
= Qvertical_line
;
5087 posn
= Qheader_line
;
5091 struct display_pos p
;
5092 buffer_posn_from_coords (XWINDOW (window
), &column
, &row
,
5094 posn
= make_number (CHARPOS (p
.pos
));
5099 Lisp_Object head
, position
;
5104 Fcons (Fcons (event
->x
, event
->y
),
5105 Fcons (make_number (event
->timestamp
),
5108 head
= modify_event_symbol (0, event
->modifiers
,
5110 lispy_mouse_wheel_names
,
5111 &mouse_wheel_syms
, 1);
5114 Fcons (make_number (event
->code
),
5118 #endif /* WINDOWSNT */
5128 /* The frame_or_window field should be a cons of the frame in
5129 which the event occurred and a list of the filenames
5131 if (! CONSP (event
->frame_or_window
))
5134 f
= XFRAME (XCAR (event
->frame_or_window
));
5135 files
= XCDR (event
->frame_or_window
);
5137 /* Ignore mouse events that were made on frames that
5138 have been deleted. */
5139 if (! FRAME_LIVE_P (f
))
5142 window
= window_from_coordinates (f
, XINT (event
->x
),
5143 XINT (event
->y
), &part
, 0);
5145 if (!WINDOWP (window
))
5147 window
= XCAR (event
->frame_or_window
);
5152 /* It's an event in window `window' at frame coordinates
5153 event->x/ event->y. */
5154 struct window
*w
= XWINDOW (window
);
5156 /* Get window relative coordinates. */
5157 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
5158 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
5160 /* Set event coordinates to window-relative coordinates
5161 for constructing the Lisp event below. */
5162 XSETINT (event
->x
, wx
);
5163 XSETINT (event
->y
, wy
);
5168 posn
= Qvertical_line
;
5170 posn
= Qheader_line
;
5174 struct display_pos p
;
5175 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5176 posn
= make_number (CHARPOS (p
.pos
));
5181 Lisp_Object head
, position
;
5186 Fcons (Fcons (event
->x
, event
->y
),
5187 Fcons (make_number (event
->timestamp
),
5190 head
= modify_event_symbol (0, event
->modifiers
,
5192 lispy_drag_n_drop_names
,
5193 &drag_n_drop_syms
, 1);
5200 #endif /* HAVE_MOUSE */
5202 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
5203 case MENU_BAR_EVENT
:
5204 if (EQ (event
->arg
, event
->frame_or_window
))
5205 /* This is the prefix key. We translate this to
5206 `(menu_bar)' because the code in keyboard.c for menu
5207 events, which we use, relies on this. */
5208 return Fcons (Qmenu_bar
, Qnil
);
5212 case TOOL_BAR_EVENT
:
5213 if (EQ (event
->arg
, event
->frame_or_window
))
5214 /* This is the prefix key. We translate this to
5215 `(tool_bar)' because the code in keyboard.c for menu
5216 events, which we use, relies on this. */
5217 return Fcons (Qtool_bar
, Qnil
);
5218 else if (SYMBOLP (event
->arg
))
5219 return apply_modifiers (event
->modifiers
, event
->arg
);
5222 case USER_SIGNAL_EVENT
:
5223 /* A user signal. */
5224 return *lispy_user_signals
[event
->code
];
5226 /* The 'kind' field of the event is something we don't recognize. */
5235 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5237 Lisp_Object bar_window
;
5238 enum scroll_bar_part part
;
5242 /* Is it a scroll bar movement? */
5243 if (frame
&& ! NILP (bar_window
))
5245 Lisp_Object part_sym
;
5247 part_sym
= *scroll_bar_parts
[(int) part
];
5248 return Fcons (Qscroll_bar_movement
,
5249 (Fcons (Fcons (bar_window
,
5250 Fcons (Qvertical_scroll_bar
,
5251 Fcons (Fcons (x
, y
),
5252 Fcons (make_number (time
),
5258 /* Or is it an ordinary mouse movement? */
5266 /* It's in a frame; which window on that frame? */
5267 window
= window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
, 0);
5271 if (WINDOWP (window
))
5273 struct window
*w
= XWINDOW (window
);
5276 /* Get window relative coordinates. */
5277 wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (x
));
5278 wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (y
));
5285 posn
= Qvertical_line
;
5287 posn
= Qheader_line
;
5291 struct display_pos p
;
5292 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5293 posn
= make_number (CHARPOS (p
.pos
));
5296 else if (frame
!= 0)
5298 XSETFRAME (window
, frame
);
5309 return Fcons (Qmouse_movement
,
5310 Fcons (Fcons (window
,
5312 Fcons (Fcons (x
, y
),
5313 Fcons (make_number (time
),
5319 #endif /* HAVE_MOUSE */
5321 /* Construct a switch frame event. */
5323 make_lispy_switch_frame (frame
)
5326 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5329 /* Manipulating modifiers. */
5331 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5333 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5334 SYMBOL's name of the end of the modifiers; the string from this
5335 position is the unmodified symbol name.
5337 This doesn't use any caches. */
5340 parse_modifiers_uncached (symbol
, modifier_end
)
5344 struct Lisp_String
*name
;
5348 CHECK_SYMBOL (symbol
, 1);
5351 name
= XSYMBOL (symbol
)->name
;
5353 for (i
= 0; i
+2 <= STRING_BYTES (name
); )
5355 int this_mod_end
= 0;
5358 /* See if the name continues with a modifier word.
5359 Check that the word appears, but don't check what follows it.
5360 Set this_mod and this_mod_end to record what we find. */
5362 switch (name
->data
[i
])
5364 #define SINGLE_LETTER_MOD(BIT) \
5365 (this_mod_end = i + 1, this_mod = BIT)
5368 SINGLE_LETTER_MOD (alt_modifier
);
5372 SINGLE_LETTER_MOD (ctrl_modifier
);
5376 SINGLE_LETTER_MOD (hyper_modifier
);
5380 SINGLE_LETTER_MOD (meta_modifier
);
5384 SINGLE_LETTER_MOD (shift_modifier
);
5388 SINGLE_LETTER_MOD (super_modifier
);
5391 #undef SINGLE_LETTER_MOD
5394 /* If we found no modifier, stop looking for them. */
5395 if (this_mod_end
== 0)
5398 /* Check there is a dash after the modifier, so that it
5399 really is a modifier. */
5400 if (this_mod_end
>= STRING_BYTES (name
)
5401 || name
->data
[this_mod_end
] != '-')
5404 /* This modifier is real; look for another. */
5405 modifiers
|= this_mod
;
5406 i
= this_mod_end
+ 1;
5409 /* Should we include the `click' modifier? */
5410 if (! (modifiers
& (down_modifier
| drag_modifier
5411 | double_modifier
| triple_modifier
))
5412 && i
+ 7 == STRING_BYTES (name
)
5413 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
5414 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
5415 modifiers
|= click_modifier
;
5423 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5424 prepended to the string BASE[0..BASE_LEN-1].
5425 This doesn't use any caches. */
5427 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5430 int base_len
, base_len_byte
;
5432 /* Since BASE could contain nulls, we can't use intern here; we have
5433 to use Fintern, which expects a genuine Lisp_String, and keeps a
5436 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5442 /* Only the event queue may use the `up' modifier; it should always
5443 be turned into a click or drag event before presented to lisp code. */
5444 if (modifiers
& up_modifier
)
5447 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5448 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5449 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5450 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5451 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5452 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5453 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5454 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5455 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5456 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5457 /* The click modifier is denoted by the absence of other modifiers. */
5461 mod_len
= p
- new_mods
;
5465 Lisp_Object new_name
;
5467 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5468 mod_len
+ base_len_byte
);
5469 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
5470 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len_byte
);
5472 return Fintern (new_name
, Qnil
);
5477 static char *modifier_names
[] =
5479 "up", "down", "drag", "click", "double", "triple", 0, 0,
5480 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5481 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5483 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5485 static Lisp_Object modifier_symbols
;
5487 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5489 lispy_modifier_list (modifiers
)
5492 Lisp_Object modifier_list
;
5495 modifier_list
= Qnil
;
5496 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
5497 if (modifiers
& (1<<i
))
5498 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
5501 return modifier_list
;
5505 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
5506 where UNMODIFIED is the unmodified form of SYMBOL,
5507 MASK is the set of modifiers present in SYMBOL's name.
5508 This is similar to parse_modifiers_uncached, but uses the cache in
5509 SYMBOL's Qevent_symbol_element_mask property, and maintains the
5510 Qevent_symbol_elements property. */
5513 parse_modifiers (symbol
)
5516 Lisp_Object elements
;
5518 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
5519 if (CONSP (elements
))
5524 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
5525 Lisp_Object unmodified
;
5528 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
5529 STRING_BYTES (XSYMBOL (symbol
)->name
) - end
),
5532 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
5534 XSETFASTINT (mask
, modifiers
);
5535 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
5537 /* Cache the parsing results on SYMBOL. */
5538 Fput (symbol
, Qevent_symbol_element_mask
,
5540 Fput (symbol
, Qevent_symbol_elements
,
5541 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
5543 /* Since we know that SYMBOL is modifiers applied to unmodified,
5544 it would be nice to put that in unmodified's cache.
5545 But we can't, since we're not sure that parse_modifiers is
5552 /* Apply the modifiers MODIFIERS to the symbol BASE.
5553 BASE must be unmodified.
5555 This is like apply_modifiers_uncached, but uses BASE's
5556 Qmodifier_cache property, if present. It also builds
5557 Qevent_symbol_elements properties, since it has that info anyway.
5559 apply_modifiers copies the value of BASE's Qevent_kind property to
5560 the modified symbol. */
5562 apply_modifiers (modifiers
, base
)
5566 Lisp_Object cache
, index
, entry
, new_symbol
;
5568 /* Mask out upper bits. We don't know where this value's been. */
5569 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
5571 /* The click modifier never figures into cache indices. */
5572 cache
= Fget (base
, Qmodifier_cache
);
5573 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
5574 entry
= assq_no_quit (index
, cache
);
5577 new_symbol
= XCDR (entry
);
5580 /* We have to create the symbol ourselves. */
5581 new_symbol
= apply_modifiers_uncached (modifiers
,
5582 XSYMBOL (base
)->name
->data
,
5583 XSYMBOL (base
)->name
->size
,
5584 STRING_BYTES (XSYMBOL (base
)->name
));
5586 /* Add the new symbol to the base's cache. */
5587 entry
= Fcons (index
, new_symbol
);
5588 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
5590 /* We have the parsing info now for free, so add it to the caches. */
5591 XSETFASTINT (index
, modifiers
);
5592 Fput (new_symbol
, Qevent_symbol_element_mask
,
5593 Fcons (base
, Fcons (index
, Qnil
)));
5594 Fput (new_symbol
, Qevent_symbol_elements
,
5595 Fcons (base
, lispy_modifier_list (modifiers
)));
5598 /* Make sure this symbol is of the same kind as BASE.
5600 You'd think we could just set this once and for all when we
5601 intern the symbol above, but reorder_modifiers may call us when
5602 BASE's property isn't set right; we can't assume that just
5603 because it has a Qmodifier_cache property it must have its
5604 Qevent_kind set right as well. */
5605 if (NILP (Fget (new_symbol
, Qevent_kind
)))
5609 kind
= Fget (base
, Qevent_kind
);
5611 Fput (new_symbol
, Qevent_kind
, kind
);
5618 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
5619 return a symbol with the modifiers placed in the canonical order.
5620 Canonical order is alphabetical, except for down and drag, which
5621 always come last. The 'click' modifier is never written out.
5623 Fdefine_key calls this to make sure that (for example) C-M-foo
5624 and M-C-foo end up being equivalent in the keymap. */
5627 reorder_modifiers (symbol
)
5630 /* It's hopefully okay to write the code this way, since everything
5631 will soon be in caches, and no consing will be done at all. */
5634 parsed
= parse_modifiers (symbol
);
5635 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
5640 /* For handling events, we often want to produce a symbol whose name
5641 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
5642 to some base, like the name of a function key or mouse button.
5643 modify_event_symbol produces symbols of this sort.
5645 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
5646 is the name of the i'th symbol. TABLE_SIZE is the number of elements
5649 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
5650 into symbol names, or a string specifying a name stem used to
5651 construct a symbol name or the form `STEM-N', where N is the decimal
5652 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
5653 non-nil; otherwise NAME_TABLE is used.
5655 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
5656 persist between calls to modify_event_symbol that it can use to
5657 store a cache of the symbols it's generated for this NAME_TABLE
5658 before. The object stored there may be a vector or an alist.
5660 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
5662 MODIFIERS is a set of modifier bits (as given in struct input_events)
5663 whose prefixes should be applied to the symbol name.
5665 SYMBOL_KIND is the value to be placed in the event_kind property of
5666 the returned symbol.
5668 The symbols we create are supposed to have an
5669 `event-symbol-elements' property, which lists the modifiers present
5670 in the symbol's name. */
5673 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
5674 name_table
, symbol_table
, table_size
)
5677 Lisp_Object symbol_kind
;
5678 Lisp_Object name_alist_or_stem
;
5680 Lisp_Object
*symbol_table
;
5681 unsigned int table_size
;
5684 Lisp_Object symbol_int
;
5686 /* Get rid of the "vendor-specific" bit here. */
5687 XSETINT (symbol_int
, symbol_num
& 0xffffff);
5689 /* Is this a request for a valid symbol? */
5690 if (symbol_num
< 0 || symbol_num
>= table_size
)
5693 if (CONSP (*symbol_table
))
5694 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
5696 /* If *symbol_table doesn't seem to be initialized properly, fix that.
5697 *symbol_table should be a lisp vector TABLE_SIZE elements long,
5698 where the Nth element is the symbol for NAME_TABLE[N], or nil if
5699 we've never used that symbol before. */
5702 if (! VECTORP (*symbol_table
)
5703 || XVECTOR (*symbol_table
)->size
!= table_size
)
5707 XSETFASTINT (size
, table_size
);
5708 *symbol_table
= Fmake_vector (size
, Qnil
);
5711 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
5714 /* Have we already used this symbol before? */
5717 /* No; let's create it. */
5718 if (CONSP (name_alist_or_stem
))
5719 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
5720 else if (STRINGP (name_alist_or_stem
))
5722 int len
= STRING_BYTES (XSTRING (name_alist_or_stem
));
5723 char *buf
= (char *) alloca (len
+ 50);
5724 sprintf (buf
, "%s-%d", XSTRING (name_alist_or_stem
)->data
,
5725 XINT (symbol_int
) + 1);
5726 value
= intern (buf
);
5728 else if (name_table
!= 0 && name_table
[symbol_num
])
5729 value
= intern (name_table
[symbol_num
]);
5731 #ifdef HAVE_WINDOW_SYSTEM
5734 char *name
= x_get_keysym_name (symbol_num
);
5736 value
= intern (name
);
5743 sprintf (buf
, "key-%d", symbol_num
);
5744 value
= intern (buf
);
5747 if (CONSP (*symbol_table
))
5748 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
5750 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
5752 /* Fill in the cache entries for this symbol; this also
5753 builds the Qevent_symbol_elements property, which the user
5755 apply_modifiers (modifiers
& click_modifier
, value
);
5756 Fput (value
, Qevent_kind
, symbol_kind
);
5759 /* Apply modifiers to that symbol. */
5760 return apply_modifiers (modifiers
, value
);
5763 /* Convert a list that represents an event type,
5764 such as (ctrl meta backspace), into the usual representation of that
5765 event type as a number or a symbol. */
5767 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
5768 "Convert the event description list EVENT-DESC to an event type.\n\
5769 EVENT-DESC should contain one base event type (a character or symbol)\n\
5770 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
5771 drag, down, double or triple). The base must be last.\n\
5772 The return value is an event type (a character or symbol) which\n\
5773 has the same base event type and all the specified modifiers.")
5775 Lisp_Object event_desc
;
5783 while (CONSP (rest
))
5791 /* Given a symbol, see if it is a modifier name. */
5792 if (SYMBOLP (elt
) && CONSP (rest
))
5793 this = parse_solitary_modifier (elt
);
5797 else if (!NILP (base
))
5798 error ("Two bases given in one event");
5804 /* Let the symbol A refer to the character A. */
5805 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
5806 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
5808 if (INTEGERP (base
))
5810 /* Turn (shift a) into A. */
5811 if ((modifiers
& shift_modifier
) != 0
5812 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
5814 XSETINT (base
, XINT (base
) - ('a' - 'A'));
5815 modifiers
&= ~shift_modifier
;
5818 /* Turn (control a) into C-a. */
5819 if (modifiers
& ctrl_modifier
)
5820 return make_number ((modifiers
& ~ctrl_modifier
)
5821 | make_ctrl_char (XINT (base
)));
5823 return make_number (modifiers
| XINT (base
));
5825 else if (SYMBOLP (base
))
5826 return apply_modifiers (modifiers
, base
);
5829 error ("Invalid base event");
5834 /* Try to recognize SYMBOL as a modifier name.
5835 Return the modifier flag bit, or 0 if not recognized. */
5838 parse_solitary_modifier (symbol
)
5841 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
5843 switch (name
->data
[0])
5845 #define SINGLE_LETTER_MOD(BIT) \
5846 if (STRING_BYTES (name) == 1) \
5849 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5850 if (LEN == STRING_BYTES (name) \
5851 && ! strncmp (name->data, NAME, LEN)) \
5855 SINGLE_LETTER_MOD (alt_modifier
);
5859 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
5863 SINGLE_LETTER_MOD (ctrl_modifier
);
5867 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
5868 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
5872 SINGLE_LETTER_MOD (hyper_modifier
);
5876 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
5880 SINGLE_LETTER_MOD (meta_modifier
);
5884 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
5888 SINGLE_LETTER_MOD (shift_modifier
);
5892 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
5893 MULTI_LETTER_MOD (super_modifier
, "super", 5);
5894 SINGLE_LETTER_MOD (super_modifier
);
5898 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5899 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5900 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5904 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5907 #undef SINGLE_LETTER_MOD
5908 #undef MULTI_LETTER_MOD
5914 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
5915 Such a list is not valid as an event,
5916 but it can be a Lucid-style event type list. */
5919 lucid_event_type_list_p (object
)
5924 if (! CONSP (object
))
5927 if (EQ (XCAR (object
), Qhelp_echo
)
5928 || EQ (XCAR (object
), Qvertical_line
)
5929 || EQ (XCAR (object
), Qmode_line
)
5930 || EQ (XCAR (object
), Qheader_line
))
5933 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
5937 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
5944 /* Store into *addr a value nonzero if terminal input chars are available.
5945 Serves the purpose of ioctl (0, FIONREAD, addr)
5946 but works even if FIONREAD does not exist.
5947 (In fact, this may actually read some input.)
5949 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
5952 get_input_pending (addr
, do_timers_now
)
5956 /* First of all, have we already counted some input? */
5957 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
5959 /* If input is being read as it arrives, and we have none, there is none. */
5960 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
5963 /* Try to read some input and see how much we get. */
5965 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
5968 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
5971 gobble_input (expected
)
5976 if (interrupt_input
)
5979 mask
= sigblock (sigmask (SIGIO
));
5980 read_avail_input (expected
);
5984 #ifdef POLL_FOR_INPUT
5985 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
5988 mask
= sigblock (sigmask (SIGALRM
));
5989 read_avail_input (expected
);
5995 read_avail_input (expected
);
5999 /* Put a buffer_switch_event in the buffer
6000 so that read_key_sequence will notice the new current buffer. */
6003 record_asynch_buffer_change ()
6005 struct input_event event
;
6008 event
.kind
= buffer_switch_event
;
6009 event
.frame_or_window
= Qnil
;
6013 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6014 The purpose of the event is to make read_key_sequence look up the
6015 keymaps again. If we aren't in read_key_sequence, we don't need one,
6016 and the event could cause trouble by messing up (input-pending-p). */
6017 tem
= Fwaiting_for_user_input_p ();
6021 /* We never need these events if we have no asynchronous subprocesses. */
6025 /* Make sure no interrupt happens while storing the event. */
6027 if (interrupt_input
)
6030 mask
= sigblock (sigmask (SIGIO
));
6031 kbd_buffer_store_event (&event
);
6038 kbd_buffer_store_event (&event
);
6045 /* Read any terminal input already buffered up by the system
6046 into the kbd_buffer, but do not wait.
6048 EXPECTED should be nonzero if the caller knows there is some input.
6050 Except on VMS, all input is read by this function.
6051 If interrupt_input is nonzero, this function MUST be called
6052 only when SIGIO is blocked.
6054 Returns the number of keyboard chars read, or -1 meaning
6055 this is a bad time to try to read input. */
6058 read_avail_input (expected
)
6061 struct input_event buf
[KBD_BUFFER_SIZE
];
6065 if (read_socket_hook
)
6066 /* No need for FIONREAD or fcntl; just say don't wait. */
6067 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
6070 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6071 the kbd_buffer can really hold. That may prevent loss
6072 of characters on some systems when input is stuffed at us. */
6073 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6076 /* Determine how many characters we should *try* to read. */
6079 #else /* not WINDOWSNT */
6081 n_to_read
= dos_keysns ();
6084 #else /* not MSDOS */
6086 /* Find out how much input is available. */
6087 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6088 /* Formerly simply reported no input, but that sometimes led to
6089 a failure of Emacs to terminate.
6090 SIGHUP seems appropriate if we can't reach the terminal. */
6091 /* ??? Is it really right to send the signal just to this process
6092 rather than to the whole process group?
6093 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6094 kill (getpid (), SIGHUP
);
6097 if (n_to_read
> sizeof cbuf
)
6098 n_to_read
= sizeof cbuf
;
6099 #else /* no FIONREAD */
6100 #if defined (USG) || defined (DGUX)
6101 /* Read some input if available, but don't wait. */
6102 n_to_read
= sizeof cbuf
;
6103 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6108 #endif /* not MSDOS */
6109 #endif /* not WINDOWSNT */
6111 /* Now read; for one reason or another, this will not block.
6112 NREAD is set to the number of chars read. */
6116 cbuf
[0] = dos_keyread ();
6119 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6121 /* POSIX infers that processes which are not in the session leader's
6122 process group won't get SIGHUP's at logout time. BSDI adheres to
6123 this part standard and returns -1 from read (0) with errno==EIO
6124 when the control tty is taken away.
6125 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6126 if (nread
== -1 && errno
== EIO
)
6128 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6129 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6130 This looks incorrect, but it isn't, because _BSD causes
6131 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6132 and that causes a value other than 0 when there is no input. */
6138 /* We used to retry the read if it was interrupted.
6139 But this does the wrong thing when O_NDELAY causes
6140 an EAGAIN error. Does anybody know of a situation
6141 where a retry is actually needed? */
6143 nread
< 0 && (errno
== EAGAIN
6157 #if defined (USG) || defined (DGUX)
6158 fcntl (input_fd
, F_SETFL
, 0);
6159 #endif /* USG or DGUX */
6160 #endif /* no FIONREAD */
6161 for (i
= 0; i
< nread
; i
++)
6163 buf
[i
].kind
= ascii_keystroke
;
6164 buf
[i
].modifiers
= 0;
6165 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6166 buf
[i
].modifiers
= meta_modifier
;
6170 buf
[i
].code
= cbuf
[i
];
6171 buf
[i
].frame_or_window
= selected_frame
;
6176 /* Scan the chars for C-g and store them in kbd_buffer. */
6177 for (i
= 0; i
< nread
; i
++)
6179 kbd_buffer_store_event (&buf
[i
]);
6180 /* Don't look at input that follows a C-g too closely.
6181 This reduces lossage due to autorepeat on C-g. */
6182 if (buf
[i
].kind
== ascii_keystroke
6183 && buf
[i
].code
== quit_char
)
6189 #endif /* not VMS */
6191 #ifdef SIGIO /* for entire page */
6192 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6195 input_available_signal (signo
)
6198 /* Must preserve main program's value of errno. */
6199 int old_errno
= errno
;
6201 extern int select_alarmed
;
6204 #if defined (USG) && !defined (POSIX_SIGNALS)
6205 /* USG systems forget handlers when they are used;
6206 must reestablish each time */
6207 signal (signo
, input_available_signal
);
6214 if (input_available_clear_time
)
6215 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6220 nread
= read_avail_input (1);
6221 /* -1 means it's not ok to read the input now.
6222 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6223 0 means there was no keyboard input available. */
6228 select_alarmed
= 1; /* Force the select emulator back to life */
6239 /* Send ourselves a SIGIO.
6241 This function exists so that the UNBLOCK_INPUT macro in
6242 blockinput.h can have some way to take care of input we put off
6243 dealing with, without assuming that every file which uses
6244 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6246 reinvoke_input_signal ()
6249 kill (getpid (), SIGIO
);
6255 /* Return the prompt-string of a sparse keymap.
6256 This is the first element which is a string.
6257 Return nil if there is none. */
6265 register Lisp_Object tem
;
6274 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6275 static void menu_bar_one_keymap
P_ ((Lisp_Object
));
6277 /* These variables hold the vector under construction within
6278 menu_bar_items and its subroutines, and the current index
6279 for storing into that vector. */
6280 static Lisp_Object menu_bar_items_vector
;
6281 static int menu_bar_items_index
;
6283 /* Return a vector of menu items for a menu bar, appropriate
6284 to the current buffer. Each item has three elements in the vector:
6287 OLD is an old vector we can optionally reuse, or nil. */
6290 menu_bar_items (old
)
6293 /* The number of keymaps we're scanning right now, and the number of
6294 keymaps we have allocated space for. */
6297 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6298 in the current keymaps, or nil where it is not a prefix. */
6301 Lisp_Object def
, tail
;
6310 struct gcpro gcpro1
;
6312 /* In order to build the menus, we need to call the keymap
6313 accessors. They all call QUIT. But this function is called
6314 during redisplay, during which a quit is fatal. So inhibit
6315 quitting while building the menus.
6316 We do this instead of specbind because (1) errors will clear it anyway
6317 and (2) this avoids risk of specpdl overflow. */
6318 oquit
= Vinhibit_quit
;
6322 menu_bar_items_vector
= old
;
6324 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6325 menu_bar_items_index
= 0;
6327 GCPRO1 (menu_bar_items_vector
);
6329 /* Build our list of keymaps.
6330 If we recognize a function key and replace its escape sequence in
6331 keybuf with its symbol, or if the sequence starts with a mouse
6332 click and we need to switch buffers, we jump back here to rebuild
6333 the initial keymaps from the current buffer. */
6337 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6338 if (!NILP (Voverriding_local_map_menu_flag
))
6340 /* Yes, use them (if non-nil) as well as the global map. */
6341 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6343 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6344 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6345 if (!NILP (Voverriding_local_map
))
6346 maps
[nmaps
++] = Voverriding_local_map
;
6350 /* No, so use major and minor mode keymaps and keymap property. */
6352 Lisp_Object map
= get_local_map (PT
, current_buffer
, Qkeymap
);
6355 nmaps
= current_minor_maps (NULL
, &tmaps
);
6356 maps
= (Lisp_Object
*) alloca ((nmaps
+ extra_maps
)
6357 * sizeof (maps
[0]));
6358 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
6360 maps
[nmaps
++] = map
;
6361 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6363 maps
[nmaps
++] = current_global_map
;
6366 /* Look up in each map the dummy prefix key `menu-bar'. */
6370 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6371 if (!NILP (maps
[mapno
]))
6373 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6376 menu_bar_one_keymap (def
);
6379 /* Move to the end those items that should be at the end. */
6381 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6384 int end
= menu_bar_items_index
;
6386 for (i
= 0; i
< end
; i
+= 4)
6387 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6389 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6390 /* Move the item at index I to the end,
6391 shifting all the others forward. */
6392 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6393 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6394 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6395 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6397 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6398 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6399 (end
- i
- 4) * sizeof (Lisp_Object
));
6400 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6401 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6402 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6403 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6408 /* Add nil, nil, nil, nil at the end. */
6409 i
= menu_bar_items_index
;
6410 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6413 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6414 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6415 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6416 menu_bar_items_vector
= tem
;
6418 /* Add this item. */
6419 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6420 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6421 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6422 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6423 menu_bar_items_index
= i
;
6425 Vinhibit_quit
= oquit
;
6427 return menu_bar_items_vector
;
6430 /* Scan one map KEYMAP, accumulating any menu items it defines
6431 in menu_bar_items_vector. */
6433 static Lisp_Object menu_bar_one_keymap_changed_items
;
6436 menu_bar_one_keymap (keymap
)
6439 Lisp_Object tail
, item
;
6441 menu_bar_one_keymap_changed_items
= Qnil
;
6443 /* Loop over all keymap entries that have menu strings. */
6444 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
6448 menu_bar_item (XCAR (item
), XCDR (item
));
6449 else if (VECTORP (item
))
6451 /* Loop over the char values represented in the vector. */
6452 int len
= XVECTOR (item
)->size
;
6454 for (c
= 0; c
< len
; c
++)
6456 Lisp_Object character
;
6457 XSETFASTINT (character
, c
);
6458 menu_bar_item (character
, XVECTOR (item
)->contents
[c
]);
6464 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
6465 If there's already an item for KEY, add this DEF to it. */
6467 Lisp_Object item_properties
;
6470 menu_bar_item (key
, item
)
6471 Lisp_Object key
, item
;
6473 struct gcpro gcpro1
;
6477 if (EQ (item
, Qundefined
))
6479 /* If a map has an explicit `undefined' as definition,
6480 discard any previously made menu bar item. */
6482 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6483 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6485 if (menu_bar_items_index
> i
+ 4)
6486 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6487 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6488 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
6489 menu_bar_items_index
-= 4;
6493 /* If this keymap has already contributed to this KEY,
6494 don't contribute to it a second time. */
6495 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
6496 if (!NILP (tem
) || NILP (item
))
6499 menu_bar_one_keymap_changed_items
6500 = Fcons (key
, menu_bar_one_keymap_changed_items
);
6502 /* We add to menu_bar_one_keymap_changed_items before doing the
6503 parse_menu_item, so that if it turns out it wasn't a menu item,
6504 it still correctly hides any further menu item. */
6506 i
= parse_menu_item (item
, 0, 1);
6511 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6513 /* Find any existing item for this KEY. */
6514 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6515 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6518 /* If we did not find this KEY, add it at the end. */
6519 if (i
== menu_bar_items_index
)
6521 /* If vector is too small, get a bigger one. */
6522 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6525 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6526 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6527 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6528 menu_bar_items_vector
= tem
;
6531 /* Add this item. */
6532 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
6533 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
6534 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6535 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
6536 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
6537 menu_bar_items_index
= i
;
6539 /* We did find an item for this KEY. Add ITEM to its list of maps. */
6543 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6544 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (item
, old
);
6548 /* This is used as the handler when calling menu_item_eval_property. */
6550 menu_item_eval_property_1 (arg
)
6553 /* If we got a quit from within the menu computation,
6554 quit all the way out of it. This takes care of C-] in the debugger. */
6555 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
6556 Fsignal (Qquit
, Qnil
);
6561 /* Evaluate an expression and return the result (or nil if something
6562 went wrong). Used to evaluate dynamic parts of menu items. */
6564 menu_item_eval_property (sexpr
)
6567 int count
= specpdl_ptr
- specpdl
;
6569 specbind (Qinhibit_redisplay
, Qt
);
6570 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
6571 menu_item_eval_property_1
);
6572 return unbind_to (count
, val
);
6575 /* This function parses a menu item and leaves the result in the
6576 vector item_properties.
6577 ITEM is a key binding, a possible menu item.
6578 If NOTREAL is nonzero, only check for equivalent key bindings, don't
6579 evaluate dynamic expressions in the menu item.
6580 INMENUBAR is > 0 when this is considered for an entry in a menu bar
6582 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
6583 parse_menu_item returns true if the item is a menu item and false
6587 parse_menu_item (item
, notreal
, inmenubar
)
6589 int notreal
, inmenubar
;
6591 Lisp_Object def
, tem
, item_string
, start
;
6592 Lisp_Object cachelist
;
6594 Lisp_Object keyhint
;
6605 /* Create item_properties vector if necessary. */
6606 if (NILP (item_properties
))
6608 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
6610 /* Initialize optional entries. */
6611 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
6612 AREF (item_properties
, i
) = Qnil
;
6613 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
6615 /* Save the item here to protect it from GC. */
6616 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
6618 item_string
= XCAR (item
);
6622 if (STRINGP (item_string
))
6624 /* Old format menu item. */
6625 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
6627 /* Maybe help string. */
6628 if (CONSP (item
) && STRINGP (XCAR (item
)))
6630 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
6635 /* Maybe key binding cache. */
6636 if (CONSP (item
) && CONSP (XCAR (item
))
6637 && (NILP (XCAR (XCAR (item
)))
6638 || VECTORP (XCAR (XCAR (item
)))))
6640 cachelist
= XCAR (item
);
6644 /* This is the real definition--the function to run. */
6645 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
6647 /* Get enable property, if any. */
6650 tem
= Fget (item
, Qmenu_enable
);
6652 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
6655 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
6657 /* New format menu item. */
6658 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
6659 start
= XCDR (item
);
6662 /* We have a real binding. */
6663 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
6665 item
= XCDR (start
);
6666 /* Is there a cache list with key equivalences. */
6667 if (CONSP (item
) && CONSP (XCAR (item
)))
6669 cachelist
= XCAR (item
);
6673 /* Parse properties. */
6674 while (CONSP (item
) && CONSP (XCDR (item
)))
6679 if (EQ (tem
, QCenable
))
6680 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
6681 else if (EQ (tem
, QCvisible
) && !notreal
)
6683 /* If got a visible property and that evaluates to nil
6684 then ignore this item. */
6685 tem
= menu_item_eval_property (XCAR (item
));
6689 else if (EQ (tem
, QChelp
))
6690 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
6691 else if (EQ (tem
, QCfilter
))
6693 else if (EQ (tem
, QCkey_sequence
))
6696 if (NILP (cachelist
)
6697 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
6698 /* Be GC protected. Set keyhint to item instead of tem. */
6701 else if (EQ (tem
, QCkeys
))
6704 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
6705 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
6707 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
6712 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
6714 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
6716 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
6723 else if (inmenubar
|| !NILP (start
))
6727 return 0; /* not a menu item */
6729 /* If item string is not a string, evaluate it to get string.
6730 If we don't get a string, skip this item. */
6731 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
6732 if (!(STRINGP (item_string
) || notreal
))
6734 item_string
= menu_item_eval_property (item_string
);
6735 if (!STRINGP (item_string
))
6737 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
6740 /* If got a filter apply it on definition. */
6741 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
6744 def
= menu_item_eval_property (list2 (XCAR (filter
),
6745 list2 (Qquote
, def
)));
6747 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
6750 /* If we got no definition, this item is just unselectable text which
6751 is OK in a submenu but not in the menubar. */
6753 return (inmenubar
? 0 : 1);
6755 /* Enable or disable selection of item. */
6756 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
6762 tem
= menu_item_eval_property (tem
);
6763 if (inmenubar
&& NILP (tem
))
6764 return 0; /* Ignore disabled items in menu bar. */
6765 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
6768 /* See if this is a separate pane or a submenu. */
6769 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
6770 tem
= get_keymap (def
, 0, 1);
6771 /* For a subkeymap, just record its details and exit. */
6774 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
6775 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
6779 /* At the top level in the menu bar, do likewise for commands also.
6780 The menu bar does not display equivalent key bindings anyway.
6781 ITEM_PROPERTY_DEF is already set up properly. */
6785 /* This is a command. See if there is an equivalent key binding. */
6786 if (NILP (cachelist
))
6788 /* We have to create a cachelist. */
6789 CHECK_IMPURE (start
);
6790 XCDR (start
) = Fcons (Fcons (Qnil
, Qnil
), XCDR (start
));
6791 cachelist
= XCAR (XCDR (start
));
6793 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
6794 if (!NILP (keyhint
))
6796 XCAR (cachelist
) = XCAR (keyhint
);
6799 else if (STRINGP (tem
))
6801 XCDR (cachelist
) = Fsubstitute_command_keys (tem
);
6802 XCAR (cachelist
) = Qt
;
6806 tem
= XCAR (cachelist
);
6813 tem
= Fkey_binding (tem
, Qnil
);
6815 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
6818 def
= XCAR (prefix
);
6819 prefix
= XCDR (prefix
);
6822 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
6824 if (!update_menu_bindings
)
6826 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
6828 if (newcache
/* Always check first time. */
6829 /* Should we check everything when precomputing key
6831 /* If something had no key binding before, don't recheck it
6832 because that is too slow--except if we have a list of
6833 rebound commands in Vdefine_key_rebound_commands, do
6834 recheck any command that appears in that list. */
6835 || (CONSP (Vdefine_key_rebound_commands
)
6836 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
6839 /* We had a saved key. Is it still bound to the command? */
6842 /* If the command is an alias for another
6843 (such as lmenu.el set it up), check if the
6844 original command matches the cached command. */
6845 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
6846 chkcache
= 1; /* Need to recompute key binding. */
6850 /* Recompute equivalent key binding. If the command is an alias
6851 for another (such as lmenu.el set it up), see if the original
6852 command name has equivalent keys. Otherwise look up the
6853 specified command itself. We don't try both, because that
6854 makes lmenu menus slow. */
6856 && SYMBOLP (XSYMBOL (def
)->function
)
6857 && ! NILP (Fget (def
, Qmenu_alias
)))
6858 def
= XSYMBOL (def
)->function
;
6859 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
);
6860 XCAR (cachelist
) = tem
;
6863 XCDR (cachelist
) = Qnil
;
6867 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
6869 tem
= XCAR (cachelist
);
6873 newcache
= chkcache
;
6876 tem
= Fkey_description (tem
);
6879 if (STRINGP (XCAR (prefix
)))
6880 tem
= concat2 (XCAR (prefix
), tem
);
6881 if (STRINGP (XCDR (prefix
)))
6882 tem
= concat2 (tem
, XCDR (prefix
));
6884 XCDR (cachelist
) = tem
;
6888 tem
= XCDR (cachelist
);
6889 if (newcache
&& !NILP (tem
))
6891 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
6892 XCDR (cachelist
) = tem
;
6895 /* If we only want to precompute equivalent key bindings, stop here. */
6899 /* If we have an equivalent key binding, use that. */
6900 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
6902 /* Include this when menu help is implemented.
6903 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
6904 if (!(NILP (tem) || STRINGP (tem)))
6906 tem = menu_item_eval_property (tem);
6909 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
6913 /* Handle radio buttons or toggle boxes. */
6914 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
6916 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
6917 = menu_item_eval_property (tem
);
6924 /***********************************************************************
6926 ***********************************************************************/
6928 /* A vector holding tool bar items while they are parsed in function
6929 tool_bar_items runs Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
6932 static Lisp_Object tool_bar_items_vector
;
6934 /* A vector holding the result of parse_tool_bar_item. Layout is like
6935 the one for a single item in tool_bar_items_vector. */
6937 static Lisp_Object tool_bar_item_properties
;
6939 /* Next free index in tool_bar_items_vector. */
6941 static int ntool_bar_items
;
6943 /* The symbols `tool-bar', and `:image'. */
6945 extern Lisp_Object Qtool_bar
;
6946 Lisp_Object QCimage
;
6948 /* Function prototypes. */
6950 static void init_tool_bar_items
P_ ((Lisp_Object
));
6951 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6952 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6953 static void append_tool_bar_item
P_ ((void));
6956 /* Return a vector of tool bar items for keymaps currently in effect.
6957 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
6958 tool bar items found. */
6961 tool_bar_items (reuse
, nitems
)
6969 extern Lisp_Object Voverriding_local_map_menu_flag
;
6970 extern Lisp_Object Voverriding_local_map
;
6974 /* In order to build the menus, we need to call the keymap
6975 accessors. They all call QUIT. But this function is called
6976 during redisplay, during which a quit is fatal. So inhibit
6977 quitting while building the menus. We do this instead of
6978 specbind because (1) errors will clear it anyway and (2) this
6979 avoids risk of specpdl overflow. */
6980 oquit
= Vinhibit_quit
;
6983 /* Initialize tool_bar_items_vector and protect it from GC. */
6984 init_tool_bar_items (reuse
);
6986 /* Build list of keymaps in maps. Set nmaps to the number of maps
6989 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6990 if (!NILP (Voverriding_local_map_menu_flag
))
6992 /* Yes, use them (if non-nil) as well as the global map. */
6993 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6995 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6996 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6997 if (!NILP (Voverriding_local_map
))
6998 maps
[nmaps
++] = Voverriding_local_map
;
7002 /* No, so use major and minor mode keymaps and keymap property. */
7004 Lisp_Object map
= get_local_map (PT
, current_buffer
, Qkeymap
);
7007 nmaps
= current_minor_maps (NULL
, &tmaps
);
7008 maps
= (Lisp_Object
*) alloca ((nmaps
+ extra_maps
)
7009 * sizeof (maps
[0]));
7010 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
7012 maps
[nmaps
++] = map
;
7013 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7016 /* Add global keymap at the end. */
7017 maps
[nmaps
++] = current_global_map
;
7019 /* Process maps in reverse order and look up in each map the prefix
7021 for (i
= nmaps
- 1; i
>= 0; --i
)
7022 if (!NILP (maps
[i
]))
7026 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7031 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7032 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7034 Lisp_Object keydef
= XCAR (tail
);
7036 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7041 Vinhibit_quit
= oquit
;
7042 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7043 return tool_bar_items_vector
;
7047 /* Process the definition of KEY which is DEF. */
7050 process_tool_bar_item (key
, def
)
7051 Lisp_Object key
, def
;
7054 extern Lisp_Object Qundefined
;
7055 struct gcpro gcpro1
, gcpro2
;
7057 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7061 if (EQ (def
, Qundefined
))
7063 /* If a map has an explicit `undefined' as definition,
7064 discard any previously made item. */
7065 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7067 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7069 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7071 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7072 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7073 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7074 * sizeof (Lisp_Object
)));
7075 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7080 else if (parse_tool_bar_item (key
, def
))
7081 /* Append a new tool bar item to tool_bar_items_vector. Accept
7082 more than one definition for the same key. */
7083 append_tool_bar_item ();
7089 /* Parse a tool bar item specification ITEM for key KEY and return the
7090 result in tool_bar_item_properties. Value is zero if ITEM is
7093 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7095 CAPTION is the caption of the item, If it's not a string, it is
7096 evaluated to get a string.
7098 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7099 as binding are currently ignored.
7101 The following properties are recognized:
7105 FORM is evaluated and specifies whether the tool bar item is
7106 enabled or disabled.
7110 FORM is evaluated and specifies whether the tool bar item is visible.
7112 - `:filter FUNCTION'
7114 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7115 result is stored as the new binding.
7117 - `:button (TYPE SELECTED)'
7119 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7120 and specifies whether the button is selected (pressed) or not.
7124 IMAGES is either a single image specification or a vector of four
7125 image specifications. See enum tool_bar_item_images.
7127 - `:help HELP-STRING'.
7129 Gives a help string to display for the tool bar item. */
7132 parse_tool_bar_item (key
, item
)
7133 Lisp_Object key
, item
;
7135 /* Access slot with index IDX of vector tool_bar_item_properties. */
7136 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7138 Lisp_Object filter
= Qnil
;
7139 Lisp_Object caption
;
7140 extern Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
;
7141 extern Lisp_Object QCbutton
, QCtoggle
, QCradio
;
7144 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7145 Rule out items that aren't lists, don't start with
7146 `menu-item' or whose rest following `tool-bar-item' is not a
7149 || !EQ (XCAR (item
), Qmenu_item
)
7150 || (item
= XCDR (item
),
7154 /* Create tool_bar_item_properties vector if necessary. Reset it to
7156 if (VECTORP (tool_bar_item_properties
))
7158 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7162 tool_bar_item_properties
7163 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7166 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7167 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7169 /* Get the caption of the item. If the caption is not a string,
7170 evaluate it to get a string. If we don't get a string, skip this
7172 caption
= XCAR (item
);
7173 if (!STRINGP (caption
))
7175 caption
= menu_item_eval_property (caption
);
7176 if (!STRINGP (caption
))
7179 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7181 /* Give up if rest following the caption is not a list. */
7186 /* Store the binding. */
7187 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7190 /* Ignore cached key binding, if any. */
7191 if (CONSP (item
) && CONSP (XCAR (item
)))
7194 /* Process the rest of the properties. */
7195 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7197 Lisp_Object key
, value
;
7200 value
= XCAR (XCDR (item
));
7202 if (EQ (key
, QCenable
))
7203 /* `:enable FORM'. */
7204 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7205 else if (EQ (key
, QCvisible
))
7207 /* `:visible FORM'. If got a visible property and that
7208 evaluates to nil then ignore this item. */
7209 if (NILP (menu_item_eval_property (value
)))
7212 else if (EQ (key
, QChelp
))
7213 /* `:help HELP-STRING'. */
7214 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7215 else if (EQ (key
, QCfilter
))
7216 /* ':filter FORM'. */
7218 else if (EQ (key
, QCbutton
) && CONSP (value
))
7220 /* `:button (TYPE . SELECTED)'. */
7221 Lisp_Object type
, selected
;
7223 type
= XCAR (value
);
7224 selected
= XCDR (value
);
7225 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7227 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7228 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7231 else if (EQ (key
, QCimage
)
7233 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7234 /* Value is either a single image specification or a vector
7235 of 4 such specifications for the different buttion states. */
7236 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7239 /* If got a filter apply it on binding. */
7241 PROP (TOOL_BAR_ITEM_BINDING
)
7242 = menu_item_eval_property (list2 (filter
,
7244 PROP (TOOL_BAR_ITEM_BINDING
))));
7246 /* See if the binding is a keymap. Give up if it is. */
7247 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7250 /* Enable or disable selection of item. */
7251 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7252 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7253 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7255 /* Handle radio buttons or toggle boxes. */
7256 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7257 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7258 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7266 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7267 that can be reused. */
7270 init_tool_bar_items (reuse
)
7273 if (VECTORP (reuse
))
7274 tool_bar_items_vector
= reuse
;
7276 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7277 ntool_bar_items
= 0;
7281 /* Append parsed tool bar item properties from
7282 tool_bar_item_properties */
7285 append_tool_bar_item ()
7287 Lisp_Object
*to
, *from
;
7289 /* Enlarge tool_bar_items_vector if necessary. */
7290 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7291 >= XVECTOR (tool_bar_items_vector
)->size
)
7293 Lisp_Object new_vector
;
7294 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7296 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7297 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7298 XVECTOR (new_vector
)->contents
,
7299 old_size
* sizeof (Lisp_Object
));
7300 tool_bar_items_vector
= new_vector
;
7303 /* Append entries from tool_bar_item_properties to the end of
7304 tool_bar_items_vector. */
7305 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7306 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7307 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7308 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7315 /* Read a character using menus based on maps in the array MAPS.
7316 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7317 Return t if we displayed a menu but the user rejected it.
7319 PREV_EVENT is the previous input event, or nil if we are reading
7320 the first event of a key sequence.
7322 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7323 if we used a mouse menu to read the input, or zero otherwise. If
7324 USED_MOUSE_MENU is null, we don't dereference it.
7326 The prompting is done based on the prompt-string of the map
7327 and the strings associated with various map elements.
7329 This can be done with X menus or with menus put in the minibuf.
7330 These are done in different ways, depending on how the input will be read.
7331 Menus using X are done after auto-saving in read-char, getting the input
7332 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7333 and do auto-saving in the inner call of read_char. */
7336 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7339 Lisp_Object prev_event
;
7340 int *used_mouse_menu
;
7343 register Lisp_Object name
;
7345 if (used_mouse_menu
)
7346 *used_mouse_menu
= 0;
7348 /* Use local over global Menu maps */
7350 if (! menu_prompting
)
7353 /* Optionally disregard all but the global map. */
7354 if (inhibit_local_menu_bar_menus
)
7356 maps
+= (nmaps
- 1);
7360 /* Get the menu name from the first map that has one (a prompt string). */
7361 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7363 name
= map_prompt (maps
[mapno
]);
7368 /* If we don't have any menus, just read a character normally. */
7373 /* If we got to this point via a mouse click,
7374 use a real menu for mouse selection. */
7375 if (EVENT_HAS_PARAMETERS (prev_event
)
7376 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7377 && !EQ (XCAR (prev_event
), Qtool_bar
))
7379 /* Display the menu and get the selection. */
7380 Lisp_Object
*realmaps
7381 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7385 /* Use the maps that are not nil. */
7386 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7387 if (!NILP (maps
[mapno
]))
7388 realmaps
[nmaps1
++] = maps
[mapno
];
7390 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7395 record_menu_key (XCAR (value
));
7397 /* If we got multiple events, unread all but
7399 There is no way to prevent those unread events
7400 from showing up later in last_nonmenu_event.
7401 So turn symbol and integer events into lists,
7402 to indicate that they came from a mouse menu,
7403 so that when present in last_nonmenu_event
7404 they won't confuse things. */
7405 for (tem
= XCDR (value
); !NILP (tem
);
7408 record_menu_key (XCAR (tem
));
7409 if (SYMBOLP (XCAR (tem
))
7410 || INTEGERP (XCAR (tem
)))
7412 = Fcons (XCAR (tem
), Qnil
);
7415 /* If we got more than one event, put all but the first
7416 onto this list to be read later.
7417 Return just the first event now. */
7418 Vunread_command_events
7419 = nconc2 (XCDR (value
), Vunread_command_events
);
7420 value
= XCAR (value
);
7422 else if (NILP (value
))
7424 if (used_mouse_menu
)
7425 *used_mouse_menu
= 1;
7428 #endif /* HAVE_MENUS */
7432 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7433 We make this bigger when necessary, and never free it. */
7434 static char *read_char_minibuf_menu_text
;
7435 /* Size of that buffer. */
7436 static int read_char_minibuf_menu_width
;
7439 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7445 register Lisp_Object name
;
7447 int width
= FRAME_WIDTH (SELECTED_FRAME ()) - 4;
7450 Lisp_Object rest
, vector
;
7455 if (! menu_prompting
)
7458 /* Make sure we have a big enough buffer for the menu text. */
7459 if (read_char_minibuf_menu_text
== 0)
7461 read_char_minibuf_menu_width
= width
+ 4;
7462 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
7464 else if (width
+ 4 > read_char_minibuf_menu_width
)
7466 read_char_minibuf_menu_width
= width
+ 4;
7467 read_char_minibuf_menu_text
7468 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
7470 menu
= read_char_minibuf_menu_text
;
7472 /* Get the menu name from the first map that has one (a prompt string). */
7473 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7475 name
= map_prompt (maps
[mapno
]);
7480 /* If we don't have any menus, just read a character normally. */
7484 /* Prompt string always starts with map's prompt, and a space. */
7485 strcpy (menu
, XSTRING (name
)->data
);
7486 nlength
= STRING_BYTES (XSTRING (name
));
7487 menu
[nlength
++] = ':';
7488 menu
[nlength
++] = ' ';
7491 /* Start prompting at start of first map. */
7495 /* Present the documented bindings, a line at a time. */
7502 Lisp_Object orig_defn_macro
;
7504 /* Loop over elements of map. */
7509 /* If reached end of map, start at beginning of next map. */
7513 /* At end of last map, wrap around to first map if just starting,
7514 or end this line if already have something on it. */
7518 if (notfirst
|| nobindings
) break;
7523 /* Look at the next element of the map. */
7525 elt
= XVECTOR (vector
)->contents
[idx
];
7527 elt
= Fcar_safe (rest
);
7529 if (idx
< 0 && VECTORP (elt
))
7531 /* If we found a dense table in the keymap,
7532 advanced past it, but start scanning its contents. */
7533 rest
= Fcdr_safe (rest
);
7539 /* An ordinary element. */
7540 Lisp_Object event
, tem
;
7544 event
= Fcar_safe (elt
); /* alist */
7545 elt
= Fcdr_safe (elt
);
7549 XSETINT (event
, idx
); /* vector */
7552 /* Ignore the element if it has no prompt string. */
7553 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
7555 /* 1 if the char to type matches the string. */
7557 Lisp_Object upcased_event
, downcased_event
;
7558 Lisp_Object desc
= Qnil
;
7560 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7562 upcased_event
= Fupcase (event
);
7563 downcased_event
= Fdowncase (event
);
7564 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
7565 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
7567 desc
= Fsingle_key_description (event
, Qnil
);
7570 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
7572 /* Insert equivalent keybinding. */
7573 s
= concat2 (s
, tem
);
7576 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
7577 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
7579 /* Insert button prefix. */
7580 Lisp_Object selected
7581 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
7582 if (EQ (tem
, QCradio
))
7583 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
7585 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
7586 s
= concat2 (tem
, s
);
7590 /* If we have room for the prompt string, add it to this line.
7591 If this is the first on the line, always add it. */
7592 if ((XSTRING (s
)->size
+ i
+ 2
7593 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
7599 /* Punctuate between strings. */
7602 strcpy (menu
+ i
, ", ");
7608 /* If the char to type doesn't match the string's
7609 first char, explicitly show what char to type. */
7612 /* Add as much of string as fits. */
7613 thiswidth
= XSTRING (desc
)->size
;
7614 if (thiswidth
+ i
> width
)
7615 thiswidth
= width
- i
;
7616 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
7618 strcpy (menu
+ i
, " = ");
7622 /* Add as much of string as fits. */
7623 thiswidth
= XSTRING (s
)->size
;
7624 if (thiswidth
+ i
> width
)
7625 thiswidth
= width
- i
;
7626 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
7632 /* If this element does not fit, end the line now,
7633 and save the element for the next line. */
7634 strcpy (menu
+ i
, "...");
7639 /* Move past this element. */
7640 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
7641 /* Handle reaching end of dense table. */
7646 rest
= Fcdr_safe (rest
);
7650 /* Prompt with that and read response. */
7651 message2_nolog (menu
, strlen (menu
),
7652 ! NILP (current_buffer
->enable_multibyte_characters
));
7654 /* Make believe its not a keyboard macro in case the help char
7655 is pressed. Help characters are not recorded because menu prompting
7656 is not used on replay.
7658 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
7659 current_kboard
->defining_kbd_macro
= Qnil
;
7661 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
7662 while (BUFFERP (obj
));
7663 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
7665 if (!INTEGERP (obj
))
7670 if (! EQ (obj
, menu_prompt_more_char
)
7671 && (!INTEGERP (menu_prompt_more_char
)
7672 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
7674 if (!NILP (current_kboard
->defining_kbd_macro
))
7675 store_kbd_macro_char (obj
);
7678 /* Help char - go round again */
7682 /* Reading key sequences. */
7684 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
7685 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
7686 keymap, or nil otherwise. Return the index of the first keymap in
7687 which KEY has any binding, or NMAPS if no map has a binding.
7689 If KEY is a meta ASCII character, treat it like meta-prefix-char
7690 followed by the corresponding non-meta character. Keymaps in
7691 CURRENT with non-prefix bindings for meta-prefix-char become nil in
7694 If KEY has no bindings in any of the CURRENT maps, NEXT is left
7697 NEXT may be the same array as CURRENT. */
7700 follow_key (key
, nmaps
, current
, defs
, next
)
7702 Lisp_Object
*current
, *defs
, *next
;
7705 int i
, first_binding
;
7708 first_binding
= nmaps
;
7709 for (i
= nmaps
- 1; i
>= 0; i
--)
7711 if (! NILP (current
[i
]))
7719 defs
[i
] = access_keymap (map
, key
, 1, 0, 1);
7720 if (! NILP (defs
[i
]))
7727 /* Given the set of bindings we've found, produce the next set of maps. */
7728 if (first_binding
< nmaps
)
7729 for (i
= 0; i
< nmaps
; i
++)
7730 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
7732 return first_binding
;
7735 /* Read a sequence of keys that ends with a non prefix character,
7736 storing it in KEYBUF, a buffer of size BUFSIZE.
7738 Return the length of the key sequence stored.
7739 Return -1 if the user rejected a command menu.
7741 Echo starting immediately unless `prompt' is 0.
7743 Where a key sequence ends depends on the currently active keymaps.
7744 These include any minor mode keymaps active in the current buffer,
7745 the current buffer's local map, and the global map.
7747 If a key sequence has no other bindings, we check Vfunction_key_map
7748 to see if some trailing subsequence might be the beginning of a
7749 function key's sequence. If so, we try to read the whole function
7750 key, and substitute its symbolic name into the key sequence.
7752 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
7753 `double-' events into similar click events, if that would make them
7754 bound. We try to turn `triple-' events first into `double-' events,
7757 If we get a mouse click in a mode line, vertical divider, or other
7758 non-text area, we treat the click as if it were prefixed by the
7759 symbol denoting that area - `mode-line', `vertical-line', or
7762 If the sequence starts with a mouse click, we read the key sequence
7763 with respect to the buffer clicked on, not the current buffer.
7765 If the user switches frames in the midst of a key sequence, we put
7766 off the switch-frame event until later; the next call to
7767 read_char will return it.
7769 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
7770 from the selected window's buffer. */
7773 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
7774 can_return_switch_frame
, fix_current_buffer
)
7775 Lisp_Object
*keybuf
;
7778 int dont_downcase_last
;
7779 int can_return_switch_frame
;
7780 int fix_current_buffer
;
7782 volatile Lisp_Object from_string
;
7783 volatile int count
= specpdl_ptr
- specpdl
;
7785 /* How many keys there are in the current key sequence. */
7788 /* The length of the echo buffer when we started reading, and
7789 the length of this_command_keys when we started reading. */
7790 volatile int echo_start
;
7791 volatile int keys_start
;
7793 /* The number of keymaps we're scanning right now, and the number of
7794 keymaps we have allocated space for. */
7796 volatile int nmaps_allocated
= 0;
7798 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
7799 the current keymaps. */
7800 Lisp_Object
*volatile defs
= NULL
;
7802 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7803 in the current keymaps, or nil where it is not a prefix. */
7804 Lisp_Object
*volatile submaps
= NULL
;
7806 /* The local map to start out with at start of key sequence. */
7807 volatile Lisp_Object orig_local_map
;
7809 /* The map from the `keymap' property to start out with at start of
7811 volatile Lisp_Object orig_keymap
;
7813 /* 1 if we have already considered switching to the local-map property
7814 of the place where a mouse click occurred. */
7815 volatile int localized_local_map
= 0;
7817 /* The index in defs[] of the first keymap that has a binding for
7818 this key sequence. In other words, the lowest i such that
7819 defs[i] is non-nil. */
7820 volatile int first_binding
;
7822 /* If t < mock_input, then KEYBUF[t] should be read as the next
7825 We use this to recover after recognizing a function key. Once we
7826 realize that a suffix of the current key sequence is actually a
7827 function key's escape sequence, we replace the suffix with the
7828 function key's binding from Vfunction_key_map. Now keybuf
7829 contains a new and different key sequence, so the echo area,
7830 this_command_keys, and the submaps and defs arrays are wrong. In
7831 this situation, we set mock_input to t, set t to 0, and jump to
7832 restart_sequence; the loop will read keys from keybuf up until
7833 mock_input, thus rebuilding the state; and then it will resume
7834 reading characters from the keyboard. */
7835 volatile int mock_input
= 0;
7837 /* If the sequence is unbound in submaps[], then
7838 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
7839 and fkey_map is its binding.
7841 These might be > t, indicating that all function key scanning
7842 should hold off until t reaches them. We do this when we've just
7843 recognized a function key, to avoid searching for the function
7844 key's again in Vfunction_key_map. */
7845 volatile int fkey_start
= 0, fkey_end
= 0;
7846 volatile Lisp_Object fkey_map
;
7848 /* Likewise, for key_translation_map. */
7849 volatile int keytran_start
= 0, keytran_end
= 0;
7850 volatile Lisp_Object keytran_map
;
7852 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
7853 we put it off for later. While we're reading, we keep the event here. */
7854 volatile Lisp_Object delayed_switch_frame
;
7856 /* See the comment below... */
7857 #if defined (GOBBLE_FIRST_EVENT)
7858 Lisp_Object first_event
;
7861 volatile Lisp_Object original_uppercase
;
7862 volatile int original_uppercase_position
= -1;
7864 /* Gets around Microsoft compiler limitations. */
7867 struct buffer
*starting_buffer
;
7869 /* Nonzero if we seem to have got the beginning of a binding
7870 in function_key_map. */
7871 volatile int function_key_possible
= 0;
7872 volatile int key_translation_possible
= 0;
7874 /* Save the status of key translation before each step,
7875 so that we can restore this after downcasing. */
7876 Lisp_Object prev_fkey_map
;
7877 int prev_fkey_start
;
7880 Lisp_Object prev_keytran_map
;
7881 int prev_keytran_start
;
7882 int prev_keytran_end
;
7884 #if defined (GOBBLE_FIRST_EVENT)
7888 raw_keybuf_count
= 0;
7890 last_nonmenu_event
= Qnil
;
7892 delayed_switch_frame
= Qnil
;
7893 fkey_map
= Vfunction_key_map
;
7894 keytran_map
= Vkey_translation_map
;
7896 /* If there is no function-key-map, turn off function key scanning. */
7897 if (!KEYMAPP (Vfunction_key_map
))
7898 fkey_start
= fkey_end
= bufsize
+ 1;
7900 /* If there is no key-translation-map, turn off scanning. */
7901 if (!KEYMAPP (Vkey_translation_map
))
7902 keytran_start
= keytran_end
= bufsize
+ 1;
7907 echo_prompt (prompt
);
7908 else if (cursor_in_echo_area
7909 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
7910 && NILP (Fzerop (Vecho_keystrokes
)))
7911 /* This doesn't put in a dash if the echo buffer is empty, so
7912 you don't always see a dash hanging out in the minibuffer. */
7916 /* Record the initial state of the echo area and this_command_keys;
7917 we will need to restore them if we replay a key sequence. */
7919 echo_start
= echo_length ();
7920 keys_start
= this_command_key_count
;
7921 this_single_command_key_start
= keys_start
;
7923 #if defined (GOBBLE_FIRST_EVENT)
7924 /* This doesn't quite work, because some of the things that read_char
7925 does cannot safely be bypassed. It seems too risky to try to make
7928 /* Read the first char of the sequence specially, before setting
7929 up any keymaps, in case a filter runs and switches buffers on us. */
7930 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
7932 #endif /* GOBBLE_FIRST_EVENT */
7934 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
7935 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
7938 /* We jump here when the key sequence has been thoroughly changed, and
7939 we need to rescan it starting from the beginning. When we jump here,
7940 keybuf[0..mock_input] holds the sequence we should reread. */
7943 starting_buffer
= current_buffer
;
7944 function_key_possible
= 0;
7945 key_translation_possible
= 0;
7947 /* Build our list of keymaps.
7948 If we recognize a function key and replace its escape sequence in
7949 keybuf with its symbol, or if the sequence starts with a mouse
7950 click and we need to switch buffers, we jump back here to rebuild
7951 the initial keymaps from the current buffer. */
7955 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
7956 || !NILP (Voverriding_local_map
))
7958 if (3 > nmaps_allocated
)
7960 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
7961 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
7962 nmaps_allocated
= 3;
7965 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7966 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7967 if (!NILP (Voverriding_local_map
))
7968 submaps
[nmaps
++] = Voverriding_local_map
;
7973 nmaps
= current_minor_maps (0, &maps
);
7974 if (!NILP (orig_keymap
))
7976 if (nmaps
+ extra_maps
> nmaps_allocated
)
7978 submaps
= (Lisp_Object
*) alloca ((nmaps
+extra_maps
)
7979 * sizeof (submaps
[0]));
7980 defs
= (Lisp_Object
*) alloca ((nmaps
+extra_maps
)
7981 * sizeof (defs
[0]));
7982 nmaps_allocated
= nmaps
+ extra_maps
;
7984 bcopy (maps
, (void *) submaps
, nmaps
* sizeof (submaps
[0]));
7985 if (!NILP (orig_keymap
))
7986 submaps
[nmaps
++] = orig_keymap
;
7987 submaps
[nmaps
++] = orig_local_map
;
7989 submaps
[nmaps
++] = current_global_map
;
7992 /* Find an accurate initial value for first_binding. */
7993 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
7994 if (! NILP (submaps
[first_binding
]))
7997 /* Start from the beginning in keybuf. */
8000 /* These are no-ops the first time through, but if we restart, they
8001 revert the echo area and this_command_keys to their original state. */
8002 this_command_key_count
= keys_start
;
8003 if (INTERACTIVE
&& t
< mock_input
)
8004 echo_truncate (echo_start
);
8006 /* If the best binding for the current key sequence is a keymap, or
8007 we may be looking at a function key's escape sequence, keep on
8009 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
8010 || (first_binding
>= nmaps
8012 /* mock input is never part of a function key's sequence. */
8013 && mock_input
<= fkey_start
)
8014 || (first_binding
>= nmaps
8015 && keytran_start
< t
&& key_translation_possible
)
8016 /* Don't return in the middle of a possible function key sequence,
8017 if the only bindings we found were via case conversion.
8018 Thus, if ESC O a has a function-key-map translation
8019 and ESC o has a binding, don't return after ESC O,
8020 so that we can translate ESC O plus the next character. */
8024 int used_mouse_menu
= 0;
8026 /* Where the last real key started. If we need to throw away a
8027 key that has expanded into more than one element of keybuf
8028 (say, a mouse click on the mode line which is being treated
8029 as [mode-line (mouse-...)], then we backtrack to this point
8031 volatile int last_real_key_start
;
8033 /* These variables are analogous to echo_start and keys_start;
8034 while those allow us to restart the entire key sequence,
8035 echo_local_start and keys_local_start allow us to throw away
8037 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8040 error ("Key sequence too long");
8043 echo_local_start
= echo_length ();
8044 keys_local_start
= this_command_key_count
;
8045 local_first_binding
= first_binding
;
8048 /* These are no-ops, unless we throw away a keystroke below and
8049 jumped back up to replay_key; in that case, these restore the
8050 variables to their original state, allowing us to replay the
8052 if (INTERACTIVE
&& t
< mock_input
)
8053 echo_truncate (echo_local_start
);
8054 this_command_key_count
= keys_local_start
;
8055 first_binding
= local_first_binding
;
8057 /* By default, assume each event is "real". */
8058 last_real_key_start
= t
;
8060 /* Does mock_input indicate that we are re-reading a key sequence? */
8064 add_command_key (key
);
8065 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8066 && NILP (Fzerop (Vecho_keystrokes
)))
8070 /* If not, we should actually read a character. */
8075 KBOARD
*interrupted_kboard
= current_kboard
;
8076 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8077 if (setjmp (wrong_kboard_jmpbuf
))
8079 if (!NILP (delayed_switch_frame
))
8081 interrupted_kboard
->kbd_queue
8082 = Fcons (delayed_switch_frame
,
8083 interrupted_kboard
->kbd_queue
);
8084 delayed_switch_frame
= Qnil
;
8087 interrupted_kboard
->kbd_queue
8088 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8090 /* If the side queue is non-empty, ensure it begins with a
8091 switch-frame, so we'll replay it in the right context. */
8092 if (CONSP (interrupted_kboard
->kbd_queue
)
8093 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8094 !(EVENT_HAS_PARAMETERS (key
)
8095 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8099 XSETFRAME (frame
, interrupted_frame
);
8100 interrupted_kboard
->kbd_queue
8101 = Fcons (make_lispy_switch_frame (frame
),
8102 interrupted_kboard
->kbd_queue
);
8105 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8106 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8107 goto replay_sequence
;
8110 key
= read_char (NILP (prompt
), nmaps
,
8111 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8115 /* read_char returns t when it shows a menu and the user rejects it.
8119 unbind_to (count
, Qnil
);
8123 /* read_char returns -1 at the end of a macro.
8124 Emacs 18 handles this by returning immediately with a
8125 zero, so that's what we'll do. */
8126 if (INTEGERP (key
) && XINT (key
) == -1)
8129 /* The Microsoft C compiler can't handle the goto that
8135 /* If the current buffer has been changed from under us, the
8136 keymap may have changed, so replay the sequence. */
8140 /* Reset the current buffer from the selected window
8141 in case something changed the former and not the latter.
8142 This is to be more consistent with the behavior
8143 of the command_loop_1. */
8144 if (fix_current_buffer
)
8146 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8148 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8149 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8152 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8153 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8154 goto replay_sequence
;
8157 /* If we have a quit that was typed in another frame, and
8158 quit_throw_to_read_char switched buffers,
8159 replay to get the right keymap. */
8160 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
8163 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8167 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8168 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8169 goto replay_sequence
;
8174 if (EVENT_HAS_PARAMETERS (key
)
8175 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8177 /* If we're at the beginning of a key sequence, and the caller
8178 says it's okay, go ahead and return this event. If we're
8179 in the midst of a key sequence, delay it until the end. */
8180 if (t
> 0 || !can_return_switch_frame
)
8182 delayed_switch_frame
= key
;
8188 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8191 /* Clicks in non-text areas get prefixed by the symbol
8192 in their CHAR-ADDRESS field. For example, a click on
8193 the mode line is prefixed by the symbol `mode-line'.
8195 Furthermore, key sequences beginning with mouse clicks
8196 are read using the keymaps of the buffer clicked on, not
8197 the current buffer. So we may have to switch the buffer
8200 When we turn one event into two events, we must make sure
8201 that neither of the two looks like the original--so that,
8202 if we replay the events, they won't be expanded again.
8203 If not for this, such reexpansion could happen either here
8204 or when user programs play with this-command-keys. */
8205 if (EVENT_HAS_PARAMETERS (key
))
8209 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8210 if (EQ (kind
, Qmouse_click
))
8212 Lisp_Object window
, posn
;
8214 window
= POSN_WINDOW (EVENT_START (key
));
8215 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8219 /* We're looking at the second event of a
8220 sequence which we expanded before. Set
8221 last_real_key_start appropriately. */
8223 last_real_key_start
= t
- 1;
8226 /* Key sequences beginning with mouse clicks are
8227 read using the keymaps in the buffer clicked on,
8228 not the current buffer. If we're at the
8229 beginning of a key sequence, switch buffers. */
8230 if (last_real_key_start
== 0
8232 && BUFFERP (XWINDOW (window
)->buffer
)
8233 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8235 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8239 /* Arrange to go back to the original buffer once we're
8240 done reading the key sequence. Note that we can't
8241 use save_excursion_{save,restore} here, because they
8242 save point as well as the current buffer; we don't
8243 want to save point, because redisplay may change it,
8244 to accommodate a Fset_window_start or something. We
8245 don't want to do this at the top of the function,
8246 because we may get input from a subprocess which
8247 wants to change the selected window and stuff (say,
8249 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8251 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8253 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8254 orig_local_map
= get_local_map (PT
, current_buffer
,
8256 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8257 goto replay_sequence
;
8260 /* For a mouse click, get the local text-property keymap
8261 of the place clicked on, rather than point. */
8262 if (last_real_key_start
== 0
8263 && CONSP (XCDR (key
))
8264 && ! localized_local_map
)
8266 Lisp_Object map_here
, start
, pos
;
8268 localized_local_map
= 1;
8269 start
= EVENT_START (key
);
8271 if (CONSP (start
) && CONSP (XCDR (start
)))
8273 pos
= POSN_BUFFER_POSN (start
);
8275 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8277 map_here
= get_local_map (XINT (pos
),
8278 current_buffer
, Qlocal_map
);
8279 if (!EQ (map_here
, orig_local_map
))
8281 orig_local_map
= map_here
;
8285 goto replay_sequence
;
8287 map_here
= get_local_map (XINT (pos
),
8288 current_buffer
, Qkeymap
);
8289 if (!EQ (map_here
, orig_keymap
))
8291 orig_keymap
= map_here
;
8295 goto replay_sequence
;
8301 /* Expand mode-line and scroll-bar events into two events:
8302 use posn as a fake prefix key. */
8305 if (t
+ 1 >= bufsize
)
8306 error ("Key sequence too long");
8311 /* Zap the position in key, so we know that we've
8312 expanded it, and don't try to do so again. */
8313 POSN_BUFFER_POSN (EVENT_START (key
))
8314 = Fcons (posn
, Qnil
);
8316 /* If on a mode line string with a local keymap,
8317 reconsider the key sequence with that keymap. */
8318 if (CONSP (POSN_STRING (EVENT_START (key
))))
8320 Lisp_Object string
, pos
, map
, map2
;
8322 string
= POSN_STRING (EVENT_START (key
));
8323 pos
= XCDR (string
);
8324 string
= XCAR (string
);
8326 && XINT (pos
) < XSTRING (string
)->size
)
8328 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8330 orig_local_map
= map
;
8331 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8334 if (!NILP (map
) || !NILP (map2
))
8335 goto replay_sequence
;
8341 else if (CONSP (POSN_STRING (EVENT_START (key
)))
8342 && NILP (from_string
))
8344 /* For a click on a string, i.e. overlay string or a
8345 string displayed via the `display' property,
8346 consider `local-map' and `keymap' properties of
8348 Lisp_Object string
, pos
, map
, map2
;
8350 string
= POSN_STRING (EVENT_START (key
));
8351 pos
= XCDR (string
);
8352 string
= XCAR (string
);
8354 && XINT (pos
) < XSTRING (string
)->size
)
8356 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8358 orig_local_map
= map
;
8359 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8363 if (!NILP (map
) || !NILP (map2
))
8365 from_string
= string
;
8366 goto replay_sequence
;
8371 else if (CONSP (XCDR (key
))
8372 && CONSP (EVENT_START (key
))
8373 && CONSP (XCDR (EVENT_START (key
))))
8377 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8378 /* Handle menu-bar events:
8379 insert the dummy prefix event `menu-bar'. */
8380 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
8382 if (t
+ 1 >= bufsize
)
8383 error ("Key sequence too long");
8387 /* Zap the position in key, so we know that we've
8388 expanded it, and don't try to do so again. */
8389 POSN_BUFFER_POSN (EVENT_START (key
))
8390 = Fcons (posn
, Qnil
);
8393 goto replay_sequence
;
8395 else if (CONSP (posn
))
8397 /* We're looking at the second event of a
8398 sequence which we expanded before. Set
8399 last_real_key_start appropriately. */
8400 if (last_real_key_start
== t
&& t
> 0)
8401 last_real_key_start
= t
- 1;
8406 /* We have finally decided that KEY is something we might want
8408 first_binding
= (follow_key (key
,
8409 nmaps
- first_binding
,
8410 submaps
+ first_binding
,
8411 defs
+ first_binding
,
8412 submaps
+ first_binding
)
8415 /* If KEY wasn't bound, we'll try some fallbacks. */
8416 if (first_binding
>= nmaps
)
8420 head
= EVENT_HEAD (key
);
8421 if (help_char_p (head
) && t
> 0)
8423 read_key_sequence_cmd
= Vprefix_help_command
;
8425 last_nonmenu_event
= key
;
8426 /* The Microsoft C compiler can't handle the goto that
8434 Lisp_Object breakdown
;
8437 breakdown
= parse_modifiers (head
);
8438 modifiers
= XINT (XCAR (XCDR (breakdown
)));
8439 /* Attempt to reduce an unbound mouse event to a simpler
8440 event that is bound:
8441 Drags reduce to clicks.
8442 Double-clicks reduce to clicks.
8443 Triple-clicks reduce to double-clicks, then to clicks.
8444 Down-clicks are eliminated.
8445 Double-downs reduce to downs, then are eliminated.
8446 Triple-downs reduce to double-downs, then to downs,
8447 then are eliminated. */
8448 if (modifiers
& (down_modifier
| drag_modifier
8449 | double_modifier
| triple_modifier
))
8451 while (modifiers
& (down_modifier
| drag_modifier
8452 | double_modifier
| triple_modifier
))
8454 Lisp_Object new_head
, new_click
;
8455 if (modifiers
& triple_modifier
)
8456 modifiers
^= (double_modifier
| triple_modifier
);
8457 else if (modifiers
& double_modifier
)
8458 modifiers
&= ~double_modifier
;
8459 else if (modifiers
& drag_modifier
)
8460 modifiers
&= ~drag_modifier
;
8463 /* Dispose of this `down' event by simply jumping
8464 back to replay_key, to get another event.
8466 Note that if this event came from mock input,
8467 then just jumping back to replay_key will just
8468 hand it to us again. So we have to wipe out any
8471 We could delete keybuf[t] and shift everything
8472 after that to the left by one spot, but we'd also
8473 have to fix up any variable that points into
8474 keybuf, and shifting isn't really necessary
8477 Adding prefixes for non-textual mouse clicks
8478 creates two characters of mock input, and both
8479 must be thrown away. If we're only looking at
8480 the prefix now, we can just jump back to
8481 replay_key. On the other hand, if we've already
8482 processed the prefix, and now the actual click
8483 itself is giving us trouble, then we've lost the
8484 state of the keymaps we want to backtrack to, and
8485 we need to replay the whole sequence to rebuild
8488 Beyond that, only function key expansion could
8489 create more than two keys, but that should never
8490 generate mouse events, so it's okay to zero
8491 mock_input in that case too.
8493 Isn't this just the most wonderful code ever? */
8494 if (t
== last_real_key_start
)
8501 mock_input
= last_real_key_start
;
8502 goto replay_sequence
;
8507 = apply_modifiers (modifiers
, XCAR (breakdown
));
8509 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
8511 /* Look for a binding for this new key. follow_key
8512 promises that it didn't munge submaps the
8513 last time we called it, since key was unbound. */
8515 = (follow_key (new_click
,
8516 nmaps
- local_first_binding
,
8517 submaps
+ local_first_binding
,
8518 defs
+ local_first_binding
,
8519 submaps
+ local_first_binding
)
8520 + local_first_binding
);
8522 /* If that click is bound, go for it. */
8523 if (first_binding
< nmaps
)
8528 /* Otherwise, we'll leave key set to the drag event. */
8535 /* Normally, last_nonmenu_event gets the previous key we read.
8536 But when a mouse popup menu is being used,
8537 we don't update last_nonmenu_event; it continues to hold the mouse
8538 event that preceded the first level of menu. */
8539 if (!used_mouse_menu
)
8540 last_nonmenu_event
= key
;
8542 /* Record what part of this_command_keys is the current key sequence. */
8543 this_single_command_key_start
= this_command_key_count
- t
;
8545 prev_fkey_map
= fkey_map
;
8546 prev_fkey_start
= fkey_start
;
8547 prev_fkey_end
= fkey_end
;
8549 prev_keytran_map
= keytran_map
;
8550 prev_keytran_start
= keytran_start
;
8551 prev_keytran_end
= keytran_end
;
8553 /* If the sequence is unbound, see if we can hang a function key
8554 off the end of it. We only want to scan real keyboard input
8555 for function key sequences, so if mock_input says that we're
8556 re-reading old events, don't examine it. */
8557 if (first_binding
>= nmaps
8560 Lisp_Object fkey_next
;
8562 /* Continue scan from fkey_end until we find a bound suffix.
8563 If we fail, increment fkey_start
8564 and start fkey_end from there. */
8565 while (fkey_end
< t
)
8569 key
= keybuf
[fkey_end
++];
8571 = access_keymap (fkey_map
, key
, 1, 0, 1);
8573 /* Handle symbol with autoload definition. */
8574 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8575 && CONSP (XSYMBOL (fkey_next
)->function
)
8576 && EQ (XCAR (XSYMBOL (fkey_next
)->function
), Qautoload
))
8577 do_autoload (XSYMBOL (fkey_next
)->function
,
8580 /* Handle a symbol whose function definition is a keymap
8582 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8583 && (!NILP (Farrayp (XSYMBOL (fkey_next
)->function
))
8584 || KEYMAPP (XSYMBOL (fkey_next
)->function
)))
8585 fkey_next
= XSYMBOL (fkey_next
)->function
;
8587 #if 0 /* I didn't turn this on, because it might cause trouble
8588 for the mapping of return into C-m and tab into C-i. */
8589 /* Optionally don't map function keys into other things.
8590 This enables the user to redefine kp- keys easily. */
8591 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
8595 /* If the function key map gives a function, not an
8596 array, then call the function with no args and use
8597 its value instead. */
8598 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8601 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8605 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
8606 fkey_next
= call1 (fkey_next
, prompt
);
8608 /* If the function returned something invalid,
8609 barf--don't ignore it.
8610 (To ignore it safely, we would need to gcpro a bunch of
8611 other variables.) */
8612 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
8613 error ("Function in key-translation-map returns invalid key sequence");
8616 function_key_possible
= ! NILP (fkey_next
);
8618 /* If keybuf[fkey_start..fkey_end] is bound in the
8619 function key map and it's a suffix of the current
8620 sequence (i.e. fkey_end == t), replace it with
8621 the binding and restart with fkey_start at the end. */
8622 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
8625 int len
= XFASTINT (Flength (fkey_next
));
8627 t
= fkey_start
+ len
;
8629 error ("Key sequence too long");
8631 if (VECTORP (fkey_next
))
8632 bcopy (XVECTOR (fkey_next
)->contents
,
8633 keybuf
+ fkey_start
,
8634 (t
- fkey_start
) * sizeof (keybuf
[0]));
8635 else if (STRINGP (fkey_next
))
8639 for (i
= 0; i
< len
; i
++)
8640 XSETFASTINT (keybuf
[fkey_start
+ i
],
8641 XSTRING (fkey_next
)->data
[i
]);
8645 fkey_start
= fkey_end
= t
;
8646 fkey_map
= Vfunction_key_map
;
8648 /* Do pass the results through key-translation-map.
8649 But don't retranslate what key-translation-map
8650 has already translated. */
8651 keytran_end
= keytran_start
;
8652 keytran_map
= Vkey_translation_map
;
8654 goto replay_sequence
;
8657 fkey_map
= get_keymap (fkey_next
, 0, 1);
8659 /* If we no longer have a bound suffix, try a new positions for
8661 if (!CONSP (fkey_map
))
8663 fkey_end
= ++fkey_start
;
8664 fkey_map
= Vfunction_key_map
;
8665 function_key_possible
= 0;
8670 /* Look for this sequence in key-translation-map. */
8672 Lisp_Object keytran_next
;
8674 /* Scan from keytran_end until we find a bound suffix. */
8675 while (keytran_end
< t
)
8679 key
= keybuf
[keytran_end
++];
8681 = access_keymap (keytran_map
, key
, 1, 0, 1);
8683 /* Handle symbol with autoload definition. */
8684 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8685 && CONSP (XSYMBOL (keytran_next
)->function
)
8686 && EQ (XCAR (XSYMBOL (keytran_next
)->function
), Qautoload
))
8687 do_autoload (XSYMBOL (keytran_next
)->function
,
8690 /* Handle a symbol whose function definition is a keymap
8692 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8693 && (!NILP (Farrayp (XSYMBOL (keytran_next
)->function
))
8694 || KEYMAPP (XSYMBOL (keytran_next
)->function
)))
8695 keytran_next
= XSYMBOL (keytran_next
)->function
;
8697 /* If the key translation map gives a function, not an
8698 array, then call the function with one arg and use
8699 its value instead. */
8700 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8701 && keytran_end
== t
)
8703 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8707 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
8708 keytran_next
= call1 (keytran_next
, prompt
);
8710 /* If the function returned something invalid,
8711 barf--don't ignore it.
8712 (To ignore it safely, we would need to gcpro a bunch of
8713 other variables.) */
8714 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
8715 error ("Function in key-translation-map returns invalid key sequence");
8718 key_translation_possible
= ! NILP (keytran_next
);
8720 /* If keybuf[keytran_start..keytran_end] is bound in the
8721 key translation map and it's a suffix of the current
8722 sequence (i.e. keytran_end == t), replace it with
8723 the binding and restart with keytran_start at the end. */
8724 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
8725 && keytran_end
== t
)
8727 int len
= XFASTINT (Flength (keytran_next
));
8729 t
= keytran_start
+ len
;
8731 error ("Key sequence too long");
8733 if (VECTORP (keytran_next
))
8734 bcopy (XVECTOR (keytran_next
)->contents
,
8735 keybuf
+ keytran_start
,
8736 (t
- keytran_start
) * sizeof (keybuf
[0]));
8737 else if (STRINGP (keytran_next
))
8741 for (i
= 0; i
< len
; i
++)
8742 XSETFASTINT (keybuf
[keytran_start
+ i
],
8743 XSTRING (keytran_next
)->data
[i
]);
8747 keytran_start
= keytran_end
= t
;
8748 keytran_map
= Vkey_translation_map
;
8750 /* Don't pass the results of key-translation-map
8751 through function-key-map. */
8752 fkey_start
= fkey_end
= t
;
8753 fkey_map
= Vfunction_key_map
;
8755 goto replay_sequence
;
8758 keytran_map
= get_keymap (keytran_next
, 0, 1);
8760 /* If we no longer have a bound suffix, try a new positions for
8762 if (!CONSP (keytran_map
))
8764 keytran_end
= ++keytran_start
;
8765 keytran_map
= Vkey_translation_map
;
8766 key_translation_possible
= 0;
8771 /* If KEY is not defined in any of the keymaps,
8772 and cannot be part of a function key or translation,
8773 and is an upper case letter
8774 use the corresponding lower-case letter instead. */
8775 if (first_binding
== nmaps
&& ! function_key_possible
8776 && ! key_translation_possible
8778 && ((((XINT (key
) & 0x3ffff)
8779 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
8780 && UPPERCASEP (XINT (key
) & 0x3ffff))
8781 || (XINT (key
) & shift_modifier
)))
8783 Lisp_Object new_key
;
8785 original_uppercase
= key
;
8786 original_uppercase_position
= t
- 1;
8788 if (XINT (key
) & shift_modifier
)
8789 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
8791 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
8792 | (XINT (key
) & ~0x3ffff)));
8794 /* We have to do this unconditionally, regardless of whether
8795 the lower-case char is defined in the keymaps, because they
8796 might get translated through function-key-map. */
8797 keybuf
[t
- 1] = new_key
;
8800 fkey_map
= prev_fkey_map
;
8801 fkey_start
= prev_fkey_start
;
8802 fkey_end
= prev_fkey_end
;
8804 keytran_map
= prev_keytran_map
;
8805 keytran_start
= prev_keytran_start
;
8806 keytran_end
= prev_keytran_end
;
8808 goto replay_sequence
;
8810 /* If KEY is not defined in any of the keymaps,
8811 and cannot be part of a function key or translation,
8812 and is a shifted function key,
8813 use the corresponding unshifted function key instead. */
8814 if (first_binding
== nmaps
&& ! function_key_possible
8815 && ! key_translation_possible
8818 Lisp_Object breakdown
;
8821 breakdown
= parse_modifiers (key
);
8822 modifiers
= XINT (XCAR (XCDR (breakdown
)));
8823 if (modifiers
& shift_modifier
)
8825 Lisp_Object new_key
;
8827 original_uppercase
= key
;
8828 original_uppercase_position
= t
- 1;
8830 modifiers
&= ~shift_modifier
;
8831 new_key
= apply_modifiers (modifiers
,
8834 keybuf
[t
- 1] = new_key
;
8837 fkey_map
= prev_fkey_map
;
8838 fkey_start
= prev_fkey_start
;
8839 fkey_end
= prev_fkey_end
;
8841 keytran_map
= prev_keytran_map
;
8842 keytran_start
= prev_keytran_start
;
8843 keytran_end
= prev_keytran_end
;
8845 goto replay_sequence
;
8851 read_key_sequence_cmd
= (first_binding
< nmaps
8852 ? defs
[first_binding
]
8855 unread_switch_frame
= delayed_switch_frame
;
8856 unbind_to (count
, Qnil
);
8858 /* Don't downcase the last character if the caller says don't.
8859 Don't downcase it if the result is undefined, either. */
8860 if ((dont_downcase_last
|| first_binding
>= nmaps
)
8861 && t
- 1 == original_uppercase_position
)
8862 keybuf
[t
- 1] = original_uppercase
;
8864 /* Occasionally we fabricate events, perhaps by expanding something
8865 according to function-key-map, or by adding a prefix symbol to a
8866 mouse click in the scroll bar or modeline. In this cases, return
8867 the entire generated key sequence, even if we hit an unbound
8868 prefix or a definition before the end. This means that you will
8869 be able to push back the event properly, and also means that
8870 read-key-sequence will always return a logical unit.
8873 for (; t
< mock_input
; t
++)
8875 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8876 && NILP (Fzerop (Vecho_keystrokes
)))
8877 echo_char (keybuf
[t
]);
8878 add_command_key (keybuf
[t
]);
8886 #if 0 /* This doc string is too long for some compilers.
8887 This commented-out definition serves for DOC. */
8888 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
8889 "Read a sequence of keystrokes and return as a string or vector.\n\
8890 The sequence is sufficient to specify a non-prefix command in the\n\
8891 current local and global maps.\n\
8893 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
8894 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
8895 as a continuation of the previous key.\n\
8897 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
8898 convert the last event to lower case. (Normally any upper case event\n\
8899 is converted to lower case if the original event is undefined and the lower\n\
8900 case equivalent is defined.) A non-nil value is appropriate for reading\n\
8901 a key sequence to be defined.\n\
8903 A C-g typed while in this function is treated like any other character,\n\
8904 and `quit-flag' is not set.\n\
8906 If the key sequence starts with a mouse click, then the sequence is read\n\
8907 using the keymaps of the buffer of the window clicked in, not the buffer\n\
8908 of the selected window as normal.\n\
8910 `read-key-sequence' drops unbound button-down events, since you normally\n\
8911 only care about the click or drag events which follow them. If a drag\n\
8912 or multi-click event is unbound, but the corresponding click event would\n\
8913 be bound, `read-key-sequence' turns the event into a click event at the\n\
8914 drag's starting position. This means that you don't have to distinguish\n\
8915 between click and drag, double, or triple events unless you want to.\n\
8917 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
8918 lines separating windows, and scroll bars with imaginary keys\n\
8919 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
8921 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
8922 function will process a switch-frame event if the user switches frames\n\
8923 before typing anything. If the user switches frames in the middle of a\n\
8924 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
8925 is nil, then the event will be put off until after the current key sequence.\n\
8927 `read-key-sequence' checks `function-key-map' for function key\n\
8928 sequences, where they wouldn't conflict with ordinary bindings. See\n\
8929 `function-key-map' for more details.\n\
8931 The optional fifth argument COMMAND-LOOP, if non-nil, means\n\
8932 that this key sequence is being read by something that will\n\
8933 read commands one after another. It should be nil if the caller\n\
8934 will read just one key sequence.")
8935 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
, command
-loop
)
8938 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
8940 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
8942 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
8943 Lisp_Object can_return_switch_frame
, command_loop
;
8945 Lisp_Object keybuf
[30];
8947 struct gcpro gcpro1
;
8948 int count
= specpdl_ptr
- specpdl
;
8951 CHECK_STRING (prompt
, 0);
8954 specbind (Qinput_method_exit_on_first_char
,
8955 (NILP (command_loop
) ? Qt
: Qnil
));
8956 specbind (Qinput_method_use_echo_area
,
8957 (NILP (command_loop
) ? Qt
: Qnil
));
8959 bzero (keybuf
, sizeof keybuf
);
8961 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
8963 if (NILP (continue_echo
))
8965 this_command_key_count
= 0;
8966 this_single_command_key_start
= 0;
8969 #ifdef HAVE_X_WINDOWS
8970 if (display_hourglass_p
)
8971 cancel_hourglass ();
8974 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
8975 prompt
, ! NILP (dont_downcase_last
),
8976 ! NILP (can_return_switch_frame
), 0);
8978 #if 0 /* The following is fine for code reading a key sequence and
8979 then proceeding with a lenghty compuation, but it's not good
8980 for code reading keys in a loop, like an input method. */
8981 #ifdef HAVE_X_WINDOWS
8982 if (display_hourglass_p
)
8993 return unbind_to (count
, make_event_array (i
, keybuf
));
8996 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
8997 Sread_key_sequence_vector
, 1, 5, 0,
8998 "Like `read-key-sequence' but always return a vector.")
8999 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9001 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9002 Lisp_Object can_return_switch_frame
, command_loop
;
9004 Lisp_Object keybuf
[30];
9006 struct gcpro gcpro1
;
9007 int count
= specpdl_ptr
- specpdl
;
9010 CHECK_STRING (prompt
, 0);
9013 specbind (Qinput_method_exit_on_first_char
,
9014 (NILP (command_loop
) ? Qt
: Qnil
));
9015 specbind (Qinput_method_use_echo_area
,
9016 (NILP (command_loop
) ? Qt
: Qnil
));
9018 bzero (keybuf
, sizeof keybuf
);
9020 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9022 if (NILP (continue_echo
))
9024 this_command_key_count
= 0;
9025 this_single_command_key_start
= 0;
9028 #ifdef HAVE_X_WINDOWS
9029 if (display_hourglass_p
)
9030 cancel_hourglass ();
9033 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9034 prompt
, ! NILP (dont_downcase_last
),
9035 ! NILP (can_return_switch_frame
), 0);
9037 #ifdef HAVE_X_WINDOWS
9038 if (display_hourglass_p
)
9048 return unbind_to (count
, Fvector (i
, keybuf
));
9051 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9052 "Execute CMD as an editor command.\n\
9053 CMD must be a symbol that satisfies the `commandp' predicate.\n\
9054 Optional second arg RECORD-FLAG non-nil\n\
9055 means unconditionally put this command in `command-history'.\n\
9056 Otherwise, that is done only if an arg is read using the minibuffer.\n\
9057 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
9058 when reading the arguments; if it is nil, (this-command-keys) is used.\n\
9059 The argument SPECIAL, if non-nil, means that this command is executing\n\
9060 a special event, so ignore the prefix argument and don't clear it.")
9061 (cmd
, record_flag
, keys
, special
)
9062 Lisp_Object cmd
, record_flag
, keys
, special
;
9064 register Lisp_Object final
;
9065 register Lisp_Object tem
;
9066 Lisp_Object prefixarg
;
9067 struct backtrace backtrace
;
9068 extern int debug_on_next_call
;
9070 debug_on_next_call
= 0;
9074 prefixarg
= current_kboard
->Vprefix_arg
;
9075 Vcurrent_prefix_arg
= prefixarg
;
9076 current_kboard
->Vprefix_arg
= Qnil
;
9083 tem
= Fget (cmd
, Qdisabled
);
9084 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9086 tem
= Fsymbol_value (Qdisabled_command_hook
);
9088 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9094 final
= Findirect_function (cmd
);
9096 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9098 struct gcpro gcpro1
, gcpro2
;
9100 GCPRO2 (cmd
, prefixarg
);
9101 do_autoload (final
, cmd
);
9108 if (STRINGP (final
) || VECTORP (final
))
9110 /* If requested, place the macro in the command history. For
9111 other sorts of commands, call-interactively takes care of
9113 if (!NILP (record_flag
))
9116 = Fcons (Fcons (Qexecute_kbd_macro
,
9117 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9120 /* Don't keep command history around forever. */
9121 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9123 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9129 return Fexecute_kbd_macro (final
, prefixarg
);
9132 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9134 backtrace
.next
= backtrace_list
;
9135 backtrace_list
= &backtrace
;
9136 backtrace
.function
= &Qcall_interactively
;
9137 backtrace
.args
= &cmd
;
9138 backtrace
.nargs
= 1;
9139 backtrace
.evalargs
= 0;
9141 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9143 backtrace_list
= backtrace
.next
;
9151 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9153 "Read function name, then read its arguments and call it.")
9155 Lisp_Object prefixarg
;
9157 Lisp_Object function
;
9159 Lisp_Object saved_keys
;
9160 Lisp_Object bindings
, value
;
9161 struct gcpro gcpro1
, gcpro2
;
9163 saved_keys
= Fvector (this_command_key_count
,
9164 XVECTOR (this_command_keys
)->contents
);
9166 GCPRO2 (saved_keys
, prefixarg
);
9168 if (EQ (prefixarg
, Qminus
))
9170 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9171 strcpy (buf
, "C-u ");
9172 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9174 if (sizeof (int) == sizeof (EMACS_INT
))
9175 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9176 else if (sizeof (long) == sizeof (EMACS_INT
))
9177 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9181 else if (INTEGERP (prefixarg
))
9183 if (sizeof (int) == sizeof (EMACS_INT
))
9184 sprintf (buf
, "%d ", XINT (prefixarg
));
9185 else if (sizeof (long) == sizeof (EMACS_INT
))
9186 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9191 /* This isn't strictly correct if execute-extended-command
9192 is bound to anything else. Perhaps it should use
9193 this_command_keys? */
9194 strcat (buf
, "M-x ");
9196 /* Prompt with buf, and then read a string, completing from and
9197 restricting to the set of all defined commands. Don't provide
9198 any initial input. Save the command read on the extended-command
9200 function
= Fcompleting_read (build_string (buf
),
9201 Vobarray
, Qcommandp
,
9202 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9205 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
9206 error ("No command name given");
9208 /* Set this_command_keys to the concatenation of saved_keys and
9209 function, followed by a RET. */
9211 struct Lisp_String
*str
;
9215 this_command_key_count
= 0;
9216 this_single_command_key_start
= 0;
9218 keys
= XVECTOR (saved_keys
)->contents
;
9219 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9220 add_command_key (keys
[i
]);
9222 str
= XSTRING (function
);
9223 for (i
= 0; i
< str
->size
; i
++)
9224 add_command_key (Faref (function
, make_number (i
)));
9226 add_command_key (make_number ('\015'));
9231 function
= Fintern (function
, Qnil
);
9232 current_kboard
->Vprefix_arg
= prefixarg
;
9233 Vthis_command
= function
;
9234 real_this_command
= function
;
9236 /* If enabled, show which key runs this command. */
9237 if (!NILP (Vsuggest_key_bindings
)
9238 && NILP (Vexecuting_macro
)
9239 && SYMBOLP (function
))
9240 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9246 GCPRO2 (bindings
, value
);
9247 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9249 /* If the command has a key binding, print it now. */
9250 if (!NILP (bindings
)
9251 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9254 /* But first wait, and skip the message if there is input. */
9256 if (!NILP (echo_area_buffer
[0]))
9257 /* This command displayed something in the echo area;
9258 so wait a few seconds, then display our suggestion message. */
9259 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9260 ? XINT (Vsuggest_key_bindings
) : 2);
9262 /* This command left the echo area empty,
9263 so display our message immediately. */
9266 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9267 && ! CONSP (Vunread_command_events
))
9269 Lisp_Object binding
;
9271 int message_p
= push_message ();
9272 int count
= BINDING_STACK_SIZE ();
9274 record_unwind_protect (push_message_unwind
, Qnil
);
9275 binding
= Fkey_description (bindings
);
9278 = (char *) alloca (XSYMBOL (function
)->name
->size
9279 + STRING_BYTES (XSTRING (binding
))
9281 sprintf (newmessage
, "You can run the command `%s' with %s",
9282 XSYMBOL (function
)->name
->data
,
9283 XSTRING (binding
)->data
);
9284 message2_nolog (newmessage
,
9285 strlen (newmessage
),
9286 STRING_MULTIBYTE (binding
));
9287 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9288 ? Vsuggest_key_bindings
: make_number (2)),
9293 unbind_to (count
, Qnil
);
9297 RETURN_UNGCPRO (value
);
9300 /* Find the set of keymaps now active.
9301 Store into *MAPS_P a vector holding the various maps
9302 and return the number of them. The vector was malloc'd
9303 and the caller should free it. */
9306 current_active_maps (maps_p
)
9307 Lisp_Object
**maps_p
;
9309 Lisp_Object
*tmaps
, *maps
;
9312 /* Should overriding-terminal-local-map and overriding-local-map apply? */
9313 if (!NILP (Voverriding_local_map_menu_flag
))
9315 /* Yes, use them (if non-nil) as well as the global map. */
9316 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
9318 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9319 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9320 if (!NILP (Voverriding_local_map
))
9321 maps
[nmaps
++] = Voverriding_local_map
;
9325 /* No, so use major and minor mode keymaps and keymap property. */
9327 Lisp_Object map
= get_local_map (PT
, current_buffer
, Qkeymap
);
9330 nmaps
= current_minor_maps (NULL
, &tmaps
);
9331 maps
= (Lisp_Object
*) alloca ((nmaps
+ extra_maps
)
9332 * sizeof (maps
[0]));
9333 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
9335 maps
[nmaps
++] = map
;
9336 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
9338 maps
[nmaps
++] = current_global_map
;
9344 /* Return nonzero if input events are pending. */
9347 detect_input_pending ()
9350 get_input_pending (&input_pending
, 0);
9352 return input_pending
;
9355 /* Return nonzero if input events are pending, and run any pending timers. */
9358 detect_input_pending_run_timers (do_display
)
9361 int old_timers_run
= timers_run
;
9364 get_input_pending (&input_pending
, 1);
9366 if (old_timers_run
!= timers_run
&& do_display
)
9368 redisplay_preserve_echo_area (8);
9369 /* The following fixes a bug when using lazy-lock with
9370 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9371 from an idle timer function. The symptom of the bug is that
9372 the cursor sometimes doesn't become visible until the next X
9373 event is processed. --gerd. */
9375 rif
->flush_display (NULL
);
9378 return input_pending
;
9381 /* This is called in some cases before a possible quit.
9382 It cases the next call to detect_input_pending to recompute input_pending.
9383 So calling this function unnecessarily can't do any harm. */
9386 clear_input_pending ()
9391 /* Return nonzero if there are pending requeued events.
9392 This isn't used yet. The hope is to make wait_reading_process_input
9393 call it, and return return if it runs Lisp code that unreads something.
9394 The problem is, kbd_buffer_get_event needs to be fixed to know what
9395 to do in that case. It isn't trivial. */
9398 requeued_events_pending_p ()
9400 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9404 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9405 "T if command input is currently available with no waiting.\n\
9406 Actually, the value is nil only if we can be sure that no input is available.")
9409 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9412 get_input_pending (&input_pending
, 1);
9413 return input_pending
> 0 ? Qt
: Qnil
;
9416 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9417 "Return vector of last 100 events, not counting those from keyboard macros.")
9420 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9423 if (total_keys
< NUM_RECENT_KEYS
)
9424 return Fvector (total_keys
, keys
);
9427 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9428 bcopy (keys
+ recent_keys_index
,
9429 XVECTOR (val
)->contents
,
9430 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9432 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9433 recent_keys_index
* sizeof (Lisp_Object
));
9438 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9439 "Return the key sequence that invoked this command.\n\
9440 The value is a string or a vector.")
9443 return make_event_array (this_command_key_count
,
9444 XVECTOR (this_command_keys
)->contents
);
9447 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9448 "Return the key sequence that invoked this command, as a vector.")
9451 return Fvector (this_command_key_count
,
9452 XVECTOR (this_command_keys
)->contents
);
9455 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9456 Sthis_single_command_keys
, 0, 0, 0,
9457 "Return the key sequence that invoked this command.\n\
9458 Unlike `this-command-keys', this function's value\n\
9459 does not include prefix arguments.\n\
9460 The value is always a vector.")
9463 return Fvector (this_command_key_count
9464 - this_single_command_key_start
,
9465 (XVECTOR (this_command_keys
)->contents
9466 + this_single_command_key_start
));
9469 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9470 Sthis_single_command_raw_keys
, 0, 0, 0,
9471 "Return the raw events that were read for this command.\n\
9472 Unlike `this-single-command-keys', this function's value\n\
9473 shows the events before all translations (except for input methods).\n\
9474 The value is always a vector.")
9477 return Fvector (raw_keybuf_count
,
9478 (XVECTOR (raw_keybuf
)->contents
));
9481 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9482 Sreset_this_command_lengths
, 0, 0, 0,
9483 "Used for complicated reasons in `universal-argument-other-key'.\n\
9485 `universal-argument-other-key' rereads the event just typed.\n\
9486 It then gets translated through `function-key-map'.\n\
9487 The translated event gets included in the echo area and in\n\
9488 the value of `this-command-keys' in addition to the raw original event.\n\
9489 That is not right.\n\
9491 Calling this function directs the translated event to replace\n\
9492 the original event, so that only one version of the event actually\n\
9493 appears in the echo area and in the value of `this-command-keys.'.")
9496 before_command_restore_flag
= 1;
9497 before_command_key_count_1
= before_command_key_count
;
9498 before_command_echo_length_1
= before_command_echo_length
;
9502 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9503 Sclear_this_command_keys
, 0, 0, 0,
9504 "Clear out the vector that `this-command-keys' returns.\n\
9505 Clear vector containing last 100 events.")
9510 this_command_key_count
= 0;
9512 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
9513 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
9515 recent_keys_index
= 0;
9519 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
9520 "Return the current depth in recursive edits.")
9524 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
9528 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
9529 "FOpen dribble file: ",
9530 "Start writing all keyboard characters to a dribble file called FILE.\n\
9531 If FILE is nil, close any open dribble file.")
9542 file
= Fexpand_file_name (file
, Qnil
);
9543 dribble
= fopen (XSTRING (file
)->data
, "w");
9545 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
9550 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
9551 "Discard the contents of the terminal input buffer.\n\
9552 Also cancel any kbd macro being defined.")
9555 current_kboard
->defining_kbd_macro
= Qnil
;
9556 update_mode_lines
++;
9558 Vunread_command_events
= Qnil
;
9559 unread_command_char
= -1;
9561 discard_tty_input ();
9563 kbd_fetch_ptr
= kbd_store_ptr
;
9564 Ffillarray (kbd_buffer_gcpro
, Qnil
);
9570 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
9571 "Stop Emacs and return to superior process. You can resume later.\n\
9572 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
9573 control, run a subshell instead.\n\n\
9574 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
9575 to be read as terminal input by Emacs's parent, after suspension.\n\
9577 Before suspending, run the normal hook `suspend-hook'.\n\
9578 After resumption run the normal hook `suspend-resume-hook'.\n\
9580 Some operating systems cannot stop the Emacs process and resume it later.\n\
9581 On such systems, Emacs starts a subshell instead of suspending.")
9583 Lisp_Object stuffstring
;
9585 int count
= specpdl_ptr
- specpdl
;
9586 int old_height
, old_width
;
9588 struct gcpro gcpro1
;
9590 if (!NILP (stuffstring
))
9591 CHECK_STRING (stuffstring
, 0);
9593 /* Run the functions in suspend-hook. */
9594 if (!NILP (Vrun_hooks
))
9595 call1 (Vrun_hooks
, intern ("suspend-hook"));
9597 GCPRO1 (stuffstring
);
9598 get_frame_size (&old_width
, &old_height
);
9600 /* sys_suspend can get an error if it tries to fork a subshell
9601 and the system resources aren't available for that. */
9602 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
9604 stuff_buffered_input (stuffstring
);
9609 unbind_to (count
, Qnil
);
9611 /* Check if terminal/window size has changed.
9612 Note that this is not useful when we are running directly
9613 with a window system; but suspend should be disabled in that case. */
9614 get_frame_size (&width
, &height
);
9615 if (width
!= old_width
|| height
!= old_height
)
9616 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
9618 /* Run suspend-resume-hook. */
9619 if (!NILP (Vrun_hooks
))
9620 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
9626 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
9627 Then in any case stuff anything Emacs has read ahead and not used. */
9630 stuff_buffered_input (stuffstring
)
9631 Lisp_Object stuffstring
;
9633 /* stuff_char works only in BSD, versions 4.2 and up. */
9636 register unsigned char *p
;
9638 if (STRINGP (stuffstring
))
9642 p
= XSTRING (stuffstring
)->data
;
9643 count
= STRING_BYTES (XSTRING (stuffstring
));
9649 /* Anything we have read ahead, put back for the shell to read. */
9650 /* ?? What should this do when we have multiple keyboards??
9651 Should we ignore anything that was typed in at the "wrong" kboard? */
9652 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
9656 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
9657 kbd_fetch_ptr
= kbd_buffer
;
9658 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
9659 stuff_char (kbd_fetch_ptr
->code
);
9661 kbd_fetch_ptr
->kind
= no_event
;
9662 idx
= 2 * (kbd_fetch_ptr
- kbd_buffer
);
9663 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
9664 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
9669 #endif /* BSD_SYSTEM and not BSD4_1 */
9673 set_waiting_for_input (time_to_clear
)
9674 EMACS_TIME
*time_to_clear
;
9676 input_available_clear_time
= time_to_clear
;
9678 /* Tell interrupt_signal to throw back to read_char, */
9679 waiting_for_input
= 1;
9681 /* If interrupt_signal was called before and buffered a C-g,
9682 make it run again now, to avoid timing error. */
9683 if (!NILP (Vquit_flag
))
9684 quit_throw_to_read_char ();
9688 clear_waiting_for_input ()
9690 /* Tell interrupt_signal not to throw back to read_char, */
9691 waiting_for_input
= 0;
9692 input_available_clear_time
= 0;
9695 /* This routine is called at interrupt level in response to C-G.
9697 If interrupt_input, this is the handler for SIGINT. Otherwise, it
9698 is called from kbd_buffer_store_event, in handling SIGIO or
9701 If `waiting_for_input' is non zero, then unless `echoing' is
9702 nonzero, immediately throw back to read_char.
9704 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
9705 eval to throw, when it gets a chance. If quit-flag is already
9706 non-nil, it stops the job right away. */
9709 interrupt_signal (signalnum
) /* If we don't have an argument, */
9710 int signalnum
; /* some compilers complain in signal calls. */
9713 /* Must preserve main program's value of errno. */
9714 int old_errno
= errno
;
9715 struct frame
*sf
= SELECTED_FRAME ();
9717 #if defined (USG) && !defined (POSIX_SIGNALS)
9718 if (!read_socket_hook
&& NILP (Vwindow_system
))
9720 /* USG systems forget handlers when they are used;
9721 must reestablish each time */
9722 signal (SIGINT
, interrupt_signal
);
9723 signal (SIGQUIT
, interrupt_signal
);
9729 if (!NILP (Vquit_flag
)
9730 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
9732 /* If SIGINT isn't blocked, don't let us be interrupted by
9733 another SIGINT, it might be harmful due to non-reentrancy
9734 in I/O functions. */
9735 sigblock (sigmask (SIGINT
));
9740 #ifdef SIGTSTP /* Support possible in later USG versions */
9742 * On systems which can suspend the current process and return to the original
9743 * shell, this command causes the user to end up back at the shell.
9744 * The "Auto-save" and "Abort" questions are not asked until
9745 * the user elects to return to emacs, at which point he can save the current
9746 * job and either dump core or continue.
9751 if (sys_suspend () == -1)
9753 printf ("Not running as a subprocess;\n");
9754 printf ("you can continue or abort.\n");
9757 /* Perhaps should really fork an inferior shell?
9758 But that would not provide any way to get back
9759 to the original shell, ever. */
9760 printf ("No support for stopping a process on this operating system;\n");
9761 printf ("you can continue or abort.\n");
9762 #endif /* not VMS */
9763 #endif /* not SIGTSTP */
9765 /* We must remain inside the screen area when the internal terminal
9766 is used. Note that [Enter] is not echoed by dos. */
9769 /* It doesn't work to autosave while GC is in progress;
9770 the code used for auto-saving doesn't cope with the mark bit. */
9771 if (!gc_in_progress
)
9773 printf ("Auto-save? (y or n) ");
9775 if (((c
= getchar ()) & ~040) == 'Y')
9777 Fdo_auto_save (Qt
, Qnil
);
9779 printf ("\r\nAuto-save done");
9780 #else /* not MSDOS */
9781 printf ("Auto-save done\n");
9782 #endif /* not MSDOS */
9784 while (c
!= '\n') c
= getchar ();
9788 /* During GC, it must be safe to reenable quitting again. */
9789 Vinhibit_quit
= Qnil
;
9792 #endif /* not MSDOS */
9793 printf ("Garbage collection in progress; cannot auto-save now\r\n");
9794 printf ("but will instead do a real quit after garbage collection ends\r\n");
9799 printf ("\r\nAbort? (y or n) ");
9800 #else /* not MSDOS */
9802 printf ("Abort (and enter debugger)? (y or n) ");
9804 printf ("Abort (and dump core)? (y or n) ");
9805 #endif /* not VMS */
9806 #endif /* not MSDOS */
9808 if (((c
= getchar ()) & ~040) == 'Y')
9810 while (c
!= '\n') c
= getchar ();
9812 printf ("\r\nContinuing...\r\n");
9813 #else /* not MSDOS */
9814 printf ("Continuing...\n");
9815 #endif /* not MSDOS */
9822 /* If executing a function that wants to be interrupted out of
9823 and the user has not deferred quitting by binding `inhibit-quit'
9824 then quit right away. */
9825 if (immediate_quit
&& NILP (Vinhibit_quit
))
9827 struct gl_state_s saved
;
9828 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9833 GCPRO4 (saved
.object
, saved
.global_code
,
9834 saved
.current_syntax_table
, saved
.old_prop
);
9835 Fsignal (Qquit
, Qnil
);
9840 /* Else request quit when it's safe */
9844 if (waiting_for_input
&& !echoing
)
9845 quit_throw_to_read_char ();
9850 /* Handle a C-g by making read_char return C-g. */
9853 quit_throw_to_read_char ()
9856 /* Prevent another signal from doing this before we finish. */
9857 clear_waiting_for_input ();
9860 Vunread_command_events
= Qnil
;
9861 unread_command_char
= -1;
9863 #if 0 /* Currently, sit_for is called from read_char without turning
9864 off polling. And that can call set_waiting_for_input.
9865 It seems to be harmless. */
9866 #ifdef POLL_FOR_INPUT
9867 /* May be > 1 if in recursive minibuffer. */
9868 if (poll_suppress_count
== 0)
9872 if (FRAMEP (internal_last_event_frame
)
9873 && !EQ (internal_last_event_frame
, selected_frame
))
9874 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
9877 _longjmp (getcjmp
, 1);
9880 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
9881 "Set mode of reading keyboard input.\n\
9882 First arg INTERRUPT non-nil means use input interrupts;\n\
9883 nil means use CBREAK mode.\n\
9884 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
9885 (no effect except in CBREAK mode).\n\
9886 Third arg META t means accept 8-bit input (for a Meta key).\n\
9887 META nil means ignore the top bit, on the assumption it is parity.\n\
9888 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
9889 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
9890 See also `current-input-mode'.")
9891 (interrupt
, flow
, meta
, quit
)
9892 Lisp_Object interrupt
, flow
, meta
, quit
;
9895 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
9896 error ("set-input-mode: QUIT must be an ASCII character");
9898 #ifdef POLL_FOR_INPUT
9903 /* this causes startup screen to be restored and messes with the mouse */
9908 /* Note SIGIO has been undef'd if FIONREAD is missing. */
9909 if (read_socket_hook
)
9911 /* When using X, don't give the user a real choice,
9912 because we haven't implemented the mechanisms to support it. */
9913 #ifdef NO_SOCK_SIGIO
9914 interrupt_input
= 0;
9915 #else /* not NO_SOCK_SIGIO */
9916 interrupt_input
= 1;
9917 #endif /* NO_SOCK_SIGIO */
9920 interrupt_input
= !NILP (interrupt
);
9921 #else /* not SIGIO */
9922 interrupt_input
= 0;
9923 #endif /* not SIGIO */
9925 /* Our VMS input only works by interrupts, as of now. */
9927 interrupt_input
= 1;
9930 flow_control
= !NILP (flow
);
9933 else if (EQ (meta
, Qt
))
9938 /* Don't let this value be out of range. */
9939 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
9945 #ifdef POLL_FOR_INPUT
9946 poll_suppress_count
= 1;
9952 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
9953 "Return information about the way Emacs currently reads keyboard input.\n\
9954 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
9955 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
9956 nil, Emacs is using CBREAK mode.\n\
9957 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
9958 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
9959 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
9960 META nil means ignoring the top bit, on the assumption it is parity.\n\
9961 META is neither t nor nil if accepting 8-bit input and using\n\
9962 all 8 bits as the character code.\n\
9963 QUIT is the character Emacs currently uses to quit.\n\
9964 The elements of this list correspond to the arguments of\n\
9970 val
[0] = interrupt_input
? Qt
: Qnil
;
9971 val
[1] = flow_control
? Qt
: Qnil
;
9972 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
9973 XSETFASTINT (val
[3], quit_char
);
9975 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
9980 * Set up a new kboard object with reasonable initial values.
9986 kb
->Voverriding_terminal_local_map
= Qnil
;
9987 kb
->Vlast_command
= Qnil
;
9988 kb
->Vreal_last_command
= Qnil
;
9989 kb
->Vprefix_arg
= Qnil
;
9990 kb
->Vlast_prefix_arg
= Qnil
;
9991 kb
->kbd_queue
= Qnil
;
9992 kb
->kbd_queue_has_data
= 0;
9993 kb
->immediate_echo
= 0;
9994 kb
->echoptr
= kb
->echobuf
;
9995 kb
->echo_after_prompt
= -1;
9996 kb
->kbd_macro_buffer
= 0;
9997 kb
->kbd_macro_bufsize
= 0;
9998 kb
->defining_kbd_macro
= Qnil
;
9999 kb
->Vlast_kbd_macro
= Qnil
;
10000 kb
->reference_count
= 0;
10001 kb
->Vsystem_key_alist
= Qnil
;
10002 kb
->system_key_syms
= Qnil
;
10003 kb
->Vdefault_minibuffer_frame
= Qnil
;
10007 * Destroy the contents of a kboard object, but not the object itself.
10008 * We use this just before deleting it, or if we're going to initialize
10009 * it a second time.
10015 if (kb
->kbd_macro_buffer
)
10016 xfree (kb
->kbd_macro_buffer
);
10019 #ifdef MULTI_KBOARD
10021 /* Free KB and memory referenced from it. */
10029 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10032 *kbp
= kb
->next_kboard
;
10034 /* Prevent a dangling reference to KB. */
10035 if (kb
== current_kboard
10036 && FRAMEP (selected_frame
)
10037 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10039 current_kboard
= XFRAME (selected_frame
)->kboard
;
10040 if (current_kboard
== kb
)
10048 #endif /* MULTI_KBOARD */
10053 /* This is correct before outermost invocation of the editor loop */
10054 command_loop_level
= -1;
10055 immediate_quit
= 0;
10056 quit_char
= Ctl ('g');
10057 Vunread_command_events
= Qnil
;
10058 unread_command_char
= -1;
10059 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10061 recent_keys_index
= 0;
10062 kbd_fetch_ptr
= kbd_buffer
;
10063 kbd_store_ptr
= kbd_buffer
;
10064 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10066 do_mouse_tracking
= Qnil
;
10070 /* This means that command_loop_1 won't try to select anything the first
10072 internal_last_event_frame
= Qnil
;
10073 Vlast_event_frame
= internal_last_event_frame
;
10075 #ifdef MULTI_KBOARD
10076 current_kboard
= initial_kboard
;
10078 wipe_kboard (current_kboard
);
10079 init_kboard (current_kboard
);
10081 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10083 signal (SIGINT
, interrupt_signal
);
10084 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10085 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10086 SIGQUIT and we can't tell which one it will give us. */
10087 signal (SIGQUIT
, interrupt_signal
);
10088 #endif /* HAVE_TERMIO */
10090 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10092 if (!noninteractive
)
10093 signal (SIGIO
, input_available_signal
);
10096 /* Use interrupt input by default, if it works and noninterrupt input
10097 has deficiencies. */
10099 #ifdef INTERRUPT_INPUT
10100 interrupt_input
= 1;
10102 interrupt_input
= 0;
10105 /* Our VMS input only works by interrupts, as of now. */
10107 interrupt_input
= 1;
10113 if (keyboard_init_hook
)
10114 (*keyboard_init_hook
) ();
10116 #ifdef POLL_FOR_INPUT
10117 poll_suppress_count
= 1;
10122 /* This type's only use is in syms_of_keyboard, to initialize the
10123 event header symbols and put properties on them. */
10124 struct event_head
{
10130 struct event_head head_table
[] = {
10131 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
10132 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
10133 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
10134 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
10135 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
10136 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
10140 syms_of_keyboard ()
10142 Vlispy_mouse_stem
= build_string ("mouse");
10143 staticpro (&Vlispy_mouse_stem
);
10146 QCimage
= intern (":image");
10147 staticpro (&QCimage
);
10149 staticpro (&Qhelp_echo
);
10150 Qhelp_echo
= intern ("help-echo");
10152 staticpro (&item_properties
);
10153 item_properties
= Qnil
;
10155 staticpro (&tool_bar_item_properties
);
10156 tool_bar_item_properties
= Qnil
;
10157 staticpro (&tool_bar_items_vector
);
10158 tool_bar_items_vector
= Qnil
;
10160 staticpro (&real_this_command
);
10161 real_this_command
= Qnil
;
10163 Qtimer_event_handler
= intern ("timer-event-handler");
10164 staticpro (&Qtimer_event_handler
);
10166 Qdisabled_command_hook
= intern ("disabled-command-hook");
10167 staticpro (&Qdisabled_command_hook
);
10169 Qself_insert_command
= intern ("self-insert-command");
10170 staticpro (&Qself_insert_command
);
10172 Qforward_char
= intern ("forward-char");
10173 staticpro (&Qforward_char
);
10175 Qbackward_char
= intern ("backward-char");
10176 staticpro (&Qbackward_char
);
10178 Qdisabled
= intern ("disabled");
10179 staticpro (&Qdisabled
);
10181 Qundefined
= intern ("undefined");
10182 staticpro (&Qundefined
);
10184 Qpre_command_hook
= intern ("pre-command-hook");
10185 staticpro (&Qpre_command_hook
);
10187 Qpost_command_hook
= intern ("post-command-hook");
10188 staticpro (&Qpost_command_hook
);
10190 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10191 staticpro (&Qpost_command_idle_hook
);
10193 Qdeferred_action_function
= intern ("deferred-action-function");
10194 staticpro (&Qdeferred_action_function
);
10196 Qcommand_hook_internal
= intern ("command-hook-internal");
10197 staticpro (&Qcommand_hook_internal
);
10199 Qfunction_key
= intern ("function-key");
10200 staticpro (&Qfunction_key
);
10201 Qmouse_click
= intern ("mouse-click");
10202 staticpro (&Qmouse_click
);
10204 Qmouse_wheel
= intern ("mouse-wheel");
10205 staticpro (&Qmouse_wheel
);
10206 Qlanguage_change
= intern ("language-change");
10207 staticpro (&Qlanguage_change
);
10209 Qdrag_n_drop
= intern ("drag-n-drop");
10210 staticpro (&Qdrag_n_drop
);
10212 Qusr1_signal
= intern ("usr1-signal");
10213 staticpro (&Qusr1_signal
);
10214 Qusr2_signal
= intern ("usr2-signal");
10215 staticpro (&Qusr2_signal
);
10217 Qmenu_enable
= intern ("menu-enable");
10218 staticpro (&Qmenu_enable
);
10219 Qmenu_alias
= intern ("menu-alias");
10220 staticpro (&Qmenu_alias
);
10221 QCenable
= intern (":enable");
10222 staticpro (&QCenable
);
10223 QCvisible
= intern (":visible");
10224 staticpro (&QCvisible
);
10225 QChelp
= intern (":help");
10226 staticpro (&QChelp
);
10227 QCfilter
= intern (":filter");
10228 staticpro (&QCfilter
);
10229 QCbutton
= intern (":button");
10230 staticpro (&QCbutton
);
10231 QCkeys
= intern (":keys");
10232 staticpro (&QCkeys
);
10233 QCkey_sequence
= intern (":key-sequence");
10234 staticpro (&QCkey_sequence
);
10235 QCtoggle
= intern (":toggle");
10236 staticpro (&QCtoggle
);
10237 QCradio
= intern (":radio");
10238 staticpro (&QCradio
);
10240 Qmode_line
= intern ("mode-line");
10241 staticpro (&Qmode_line
);
10242 Qvertical_line
= intern ("vertical-line");
10243 staticpro (&Qvertical_line
);
10244 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10245 staticpro (&Qvertical_scroll_bar
);
10246 Qmenu_bar
= intern ("menu-bar");
10247 staticpro (&Qmenu_bar
);
10249 Qabove_handle
= intern ("above-handle");
10250 staticpro (&Qabove_handle
);
10251 Qhandle
= intern ("handle");
10252 staticpro (&Qhandle
);
10253 Qbelow_handle
= intern ("below-handle");
10254 staticpro (&Qbelow_handle
);
10255 Qup
= intern ("up");
10257 Qdown
= intern ("down");
10258 staticpro (&Qdown
);
10259 Qtop
= intern ("top");
10261 Qbottom
= intern ("bottom");
10262 staticpro (&Qbottom
);
10263 Qend_scroll
= intern ("end-scroll");
10264 staticpro (&Qend_scroll
);
10265 Qratio
= intern ("ratio");
10266 staticpro (&Qratio
);
10268 Qevent_kind
= intern ("event-kind");
10269 staticpro (&Qevent_kind
);
10270 Qevent_symbol_elements
= intern ("event-symbol-elements");
10271 staticpro (&Qevent_symbol_elements
);
10272 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10273 staticpro (&Qevent_symbol_element_mask
);
10274 Qmodifier_cache
= intern ("modifier-cache");
10275 staticpro (&Qmodifier_cache
);
10277 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10278 staticpro (&Qrecompute_lucid_menubar
);
10279 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10280 staticpro (&Qactivate_menubar_hook
);
10282 Qpolling_period
= intern ("polling-period");
10283 staticpro (&Qpolling_period
);
10285 Qinput_method_function
= intern ("input-method-function");
10286 staticpro (&Qinput_method_function
);
10288 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10289 staticpro (&Qinput_method_exit_on_first_char
);
10290 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10291 staticpro (&Qinput_method_use_echo_area
);
10293 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10294 Fset (Qinput_method_use_echo_area
, Qnil
);
10296 last_point_position_buffer
= Qnil
;
10299 struct event_head
*p
;
10301 for (p
= head_table
;
10302 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10305 *p
->var
= intern (p
->name
);
10306 staticpro (p
->var
);
10307 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10308 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10312 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10313 staticpro (&button_down_location
);
10314 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10315 staticpro (&mouse_syms
);
10319 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10321 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10322 for (i
= 0; i
< len
; i
++)
10323 if (modifier_names
[i
])
10324 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10325 staticpro (&modifier_symbols
);
10328 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10329 staticpro (&recent_keys
);
10331 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10332 staticpro (&this_command_keys
);
10334 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10335 staticpro (&raw_keybuf
);
10337 Qextended_command_history
= intern ("extended-command-history");
10338 Fset (Qextended_command_history
, Qnil
);
10339 staticpro (&Qextended_command_history
);
10341 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10342 staticpro (&kbd_buffer_gcpro
);
10344 accent_key_syms
= Qnil
;
10345 staticpro (&accent_key_syms
);
10347 func_key_syms
= Qnil
;
10348 staticpro (&func_key_syms
);
10351 mouse_wheel_syms
= Qnil
;
10352 staticpro (&mouse_wheel_syms
);
10354 drag_n_drop_syms
= Qnil
;
10355 staticpro (&drag_n_drop_syms
);
10358 unread_switch_frame
= Qnil
;
10359 staticpro (&unread_switch_frame
);
10361 internal_last_event_frame
= Qnil
;
10362 staticpro (&internal_last_event_frame
);
10364 read_key_sequence_cmd
= Qnil
;
10365 staticpro (&read_key_sequence_cmd
);
10367 menu_bar_one_keymap_changed_items
= Qnil
;
10368 staticpro (&menu_bar_one_keymap_changed_items
);
10370 defsubr (&Sevent_convert_list
);
10371 defsubr (&Sread_key_sequence
);
10372 defsubr (&Sread_key_sequence_vector
);
10373 defsubr (&Srecursive_edit
);
10375 defsubr (&Strack_mouse
);
10377 defsubr (&Sinput_pending_p
);
10378 defsubr (&Scommand_execute
);
10379 defsubr (&Srecent_keys
);
10380 defsubr (&Sthis_command_keys
);
10381 defsubr (&Sthis_command_keys_vector
);
10382 defsubr (&Sthis_single_command_keys
);
10383 defsubr (&Sthis_single_command_raw_keys
);
10384 defsubr (&Sreset_this_command_lengths
);
10385 defsubr (&Sclear_this_command_keys
);
10386 defsubr (&Ssuspend_emacs
);
10387 defsubr (&Sabort_recursive_edit
);
10388 defsubr (&Sexit_recursive_edit
);
10389 defsubr (&Srecursion_depth
);
10390 defsubr (&Stop_level
);
10391 defsubr (&Sdiscard_input
);
10392 defsubr (&Sopen_dribble_file
);
10393 defsubr (&Sset_input_mode
);
10394 defsubr (&Scurrent_input_mode
);
10395 defsubr (&Sexecute_extended_command
);
10397 DEFVAR_LISP ("last-command-char", &last_command_char
,
10398 "Last input event that was part of a command.");
10400 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10401 "Last input event that was part of a command.");
10403 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10404 "Last input event in a command, except for mouse menu events.\n\
10405 Mouse menus give back keys that don't look like mouse events;\n\
10406 this variable holds the actual mouse event that led to the menu,\n\
10407 so that you can determine whether the command was run by mouse or not.");
10409 DEFVAR_LISP ("last-input-char", &last_input_char
,
10410 "Last input event.");
10412 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10413 "Last input event.");
10415 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10416 "List of events to be read as the command input.\n\
10417 These events are processed first, before actual keyboard input.");
10418 Vunread_command_events
= Qnil
;
10420 DEFVAR_INT ("unread-command-char", &unread_command_char
,
10421 "If not -1, an object to be read as next command input event.");
10423 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
10424 "List of events to be processed as input by input methods.\n\
10425 These events are processed after `unread-command-events', but\n\
10426 before actual keyboard input.");
10427 Vunread_post_input_method_events
= Qnil
;
10429 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
10430 "List of events to be processed as input by input methods.\n\
10431 These events are processed after `unread-command-events', but\n\
10432 before actual keyboard input.");
10433 Vunread_input_method_events
= Qnil
;
10435 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
10436 "Meta-prefix character code.\n\
10437 Meta-foo as command input turns into this character followed by foo.");
10438 XSETINT (meta_prefix_char
, 033);
10440 DEFVAR_KBOARD ("last-command", Vlast_command
,
10441 "The last command executed.\n\
10442 Normally a symbol with a function definition, but can be whatever was found\n\
10443 in the keymap, or whatever the variable `this-command' was set to by that\n\
10446 The value `mode-exit' is special; it means that the previous command\n\
10447 read an event that told it to exit, and it did so and unread that event.\n\
10448 In other words, the present command is the event that made the previous\n\
10451 The value `kill-region' is special; it means that the previous command\n\
10452 was a kill command.");
10454 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
10455 "Same as `last-command', but never altered by Lisp code.");
10457 DEFVAR_LISP ("this-command", &Vthis_command
,
10458 "The command now being executed.\n\
10459 The command can set this variable; whatever is put here\n\
10460 will be in `last-command' during the following command.");
10461 Vthis_command
= Qnil
;
10463 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
10464 "*Number of input events between auto-saves.\n\
10465 Zero means disable autosaving due to number of characters typed.");
10466 auto_save_interval
= 300;
10468 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
10469 "*Number of seconds idle time before auto-save.\n\
10470 Zero or nil means disable auto-saving due to idleness.\n\
10471 After auto-saving due to this many seconds of idle time,\n\
10472 Emacs also does a garbage collection if that seems to be warranted.");
10473 XSETFASTINT (Vauto_save_timeout
, 30);
10475 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
10476 "*Nonzero means echo unfinished commands after this many seconds of pause.\n\
10477 The value may be integer or floating point.");
10478 Vecho_keystrokes
= make_number (1);
10480 DEFVAR_INT ("polling-period", &polling_period
,
10481 "*Interval between polling for input during Lisp execution.\n\
10482 The reason for polling is to make C-g work to stop a running program.\n\
10483 Polling is needed only when using X windows and SIGIO does not work.\n\
10484 Polling is automatically disabled in all other cases.");
10485 polling_period
= 2;
10487 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
10488 "*Maximum time between mouse clicks to make a double-click.\n\
10489 Measured in milliseconds. nil means disable double-click recognition;\n\
10490 t means double-clicks have no time limit and are detected\n\
10491 by position only.");
10492 Vdouble_click_time
= make_number (500);
10494 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
10495 "*Non-nil means inhibit local map menu bar menus.");
10496 inhibit_local_menu_bar_menus
= 0;
10498 DEFVAR_INT ("num-input-keys", &num_input_keys
,
10499 "Number of complete key sequences read as input so far.\n\
10500 This includes key sequences read from keyboard macros.\n\
10501 The number is effectively the number of interactive command invocations.");
10502 num_input_keys
= 0;
10504 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
10505 "Number of input events read from the keyboard so far.\n\
10506 This does not include events generated by keyboard macros.");
10507 num_nonmacro_input_events
= 0;
10509 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
10510 "The frame in which the most recently read event occurred.\n\
10511 If the last event came from a keyboard macro, this is set to `macro'.");
10512 Vlast_event_frame
= Qnil
;
10514 /* This variable is set up in sysdep.c. */
10515 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
10516 "The ERASE character as set by the user with stty.");
10518 DEFVAR_LISP ("help-char", &Vhelp_char
,
10519 "Character to recognize as meaning Help.\n\
10520 When it is read, do `(eval help-form)', and display result if it's a string.\n\
10521 If the value of `help-form' is nil, this char can be read normally.");
10522 XSETINT (Vhelp_char
, Ctl ('H'));
10524 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
10525 "List of input events to recognize as meaning Help.\n\
10526 These work just like the value of `help-char' (see that).");
10527 Vhelp_event_list
= Qnil
;
10529 DEFVAR_LISP ("help-form", &Vhelp_form
,
10530 "Form to execute when character `help-char' is read.\n\
10531 If the form returns a string, that string is displayed.\n\
10532 If `help-form' is nil, the help char is not recognized.");
10535 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
10536 "Command to run when `help-char' character follows a prefix key.\n\
10537 This command is used only when there is no actual binding\n\
10538 for that character after that prefix key.");
10539 Vprefix_help_command
= Qnil
;
10541 DEFVAR_LISP ("top-level", &Vtop_level
,
10542 "Form to evaluate when Emacs starts up.\n\
10543 Useful to set before you dump a modified Emacs.");
10546 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
10547 "Translate table for keyboard input, or nil.\n\
10548 Each character is looked up in this string and the contents used instead.\n\
10549 The value may be a string, a vector, or a char-table.\n\
10550 If it is a string or vector of length N,\n\
10551 character codes N and up are untranslated.\n\
10552 In a vector or a char-table, an element which is nil means \"no translation\".");
10553 Vkeyboard_translate_table
= Qnil
;
10555 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
10556 "Non-nil means to always spawn a subshell instead of suspending.\n\
10557 \(Even if the operating system has support for stopping a process.\)");
10558 cannot_suspend
= 0;
10560 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
10561 "Non-nil means prompt with menus when appropriate.\n\
10562 This is done when reading from a keymap that has a prompt string,\n\
10563 for elements that have prompt strings.\n\
10564 The menu is displayed on the screen\n\
10565 if X menus were enabled at configuration\n\
10566 time and the previous event was a mouse click prefix key.\n\
10567 Otherwise, menu prompting uses the echo area.");
10568 menu_prompting
= 1;
10570 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
10571 "Character to see next line of menu prompt.\n\
10572 Type this character while in a menu prompt to rotate around the lines of it.");
10573 XSETINT (menu_prompt_more_char
, ' ');
10575 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
10576 "A mask of additional modifier keys to use with every keyboard character.\n\
10577 Emacs applies the modifiers of the character stored here to each keyboard\n\
10578 character it reads. For example, after evaluating the expression\n\
10579 (setq extra-keyboard-modifiers ?\\C-x)\n\
10580 all input characters will have the control modifier applied to them.\n\
10582 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
10583 not count as a control character; rather, it counts as a character\n\
10584 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
10585 cancels any modification.");
10586 extra_keyboard_modifiers
= 0;
10588 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
10589 "If an editing command sets this to t, deactivate the mark afterward.\n\
10590 The command loop sets this to nil before each command,\n\
10591 and tests the value when the command returns.\n\
10592 Buffer modification stores t in this variable.");
10593 Vdeactivate_mark
= Qnil
;
10595 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
10596 "Temporary storage of pre-command-hook or post-command-hook.");
10597 Vcommand_hook_internal
= Qnil
;
10599 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
10600 "Normal hook run before each command is executed.\n\
10601 If an unhandled error happens in running this hook,\n\
10602 the hook value is set to nil, since otherwise the error\n\
10603 might happen repeatedly and make Emacs nonfunctional.");
10604 Vpre_command_hook
= Qnil
;
10606 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
10607 "Normal hook run after each command is executed.\n\
10608 If an unhandled error happens in running this hook,\n\
10609 the hook value is set to nil, since otherwise the error\n\
10610 might happen repeatedly and make Emacs nonfunctional.");
10611 Vpost_command_hook
= Qnil
;
10613 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
10614 "Normal hook run after each command is executed, if idle.\n\
10615 Errors running the hook are caught and ignored.\n\
10616 This feature is obsolete; use idle timers instead. See `etc/NEWS'.");
10617 Vpost_command_idle_hook
= Qnil
;
10619 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
10620 "Delay time before running `post-command-idle-hook'.\n\
10621 This is measured in microseconds.");
10622 post_command_idle_delay
= 100000;
10625 DEFVAR_LISP ("echo-area-clear-hook", ...,
10626 "Normal hook run when clearing the echo area.");
10628 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
10629 XSYMBOL (Qecho_area_clear_hook
)->value
= Qnil
;
10631 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
10632 "t means menu bar, specified Lucid style, needs to be recomputed.");
10633 Vlucid_menu_bar_dirty_flag
= Qnil
;
10635 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
10636 "List of menu bar items to move to the end of the menu bar.\n\
10637 The elements of the list are event types that may have menu bar bindings.");
10638 Vmenu_bar_final_items
= Qnil
;
10640 DEFVAR_KBOARD ("overriding-terminal-local-map",
10641 Voverriding_terminal_local_map
,
10642 "Per-terminal keymap that overrides all other local keymaps.\n\
10643 If this variable is non-nil, it is used as a keymap instead of the\n\
10644 buffer's local map, and the minor mode keymaps and text property keymaps.\n\
10645 This variable is intended to let commands such as `universal-argument'\n\
10646 set up a different keymap for reading the next command.");
10648 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
10649 "Keymap that overrides all other local keymaps.\n\
10650 If this variable is non-nil, it is used as a keymap instead of the\n\
10651 buffer's local map, and the minor mode keymaps and text property keymaps.");
10652 Voverriding_local_map
= Qnil
;
10654 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
10655 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
10656 Otherwise, the menu bar continues to reflect the buffer's local map\n\
10657 and the minor mode maps regardless of `overriding-local-map'.");
10658 Voverriding_local_map_menu_flag
= Qnil
;
10660 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
10661 "Keymap defining bindings for special events to execute at low level.");
10662 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
10664 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
10665 "*Non-nil means generate motion events for mouse motion.");
10667 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
10668 "Alist of system-specific X windows key symbols.\n\
10669 Each element should have the form (N . SYMBOL) where N is the\n\
10670 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
10671 and SYMBOL is its name.");
10673 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
10674 "List of deferred actions to be performed at a later time.\n\
10675 The precise format isn't relevant here; we just check whether it is nil.");
10676 Vdeferred_action_list
= Qnil
;
10678 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
10679 "Function to call to handle deferred actions, after each command.\n\
10680 This function is called with no arguments after each command\n\
10681 whenever `deferred-action-list' is non-nil.");
10682 Vdeferred_action_function
= Qnil
;
10684 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
10685 "*Non-nil means show the equivalent key-binding when M-x command has one.\n\
10686 The value can be a length of time to show the message for.\n\
10687 If the value is non-nil and not a number, we wait 2 seconds.");
10688 Vsuggest_key_bindings
= Qt
;
10690 DEFVAR_LISP ("timer-list", &Vtimer_list
,
10691 "List of active absolute time timers in order of increasing time");
10692 Vtimer_list
= Qnil
;
10694 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
10695 "List of active idle-time timers in order of increasing time");
10696 Vtimer_idle_list
= Qnil
;
10698 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
10699 "If non-nil, the function that implements the current input method.\n\
10700 It's called with one argument, a printing character that was just read.\n\
10701 \(That means a character with code 040...0176.)\n\
10702 Typically this function uses `read-event' to read additional events.\n\
10703 When it does so, it should first bind `input-method-function' to nil\n\
10704 so it will not be called recursively.\n\
10706 The function should return a list of zero or more events\n\
10707 to be used as input. If it wants to put back some events\n\
10708 to be reconsidered, separately, by the input method,\n\
10709 it can add them to the beginning of `unread-command-events'.\n\
10711 The input method function can find in `input-method-previous-method'\n\
10712 the previous echo area message.\n\
10714 The input method function should refer to the variables\n\
10715 `input-method-use-echo-area' and `input-method-exit-on-first-char'\n\
10716 for guidance on what to do.");
10717 Vinput_method_function
= Qnil
;
10719 DEFVAR_LISP ("input-method-previous-message",
10720 &Vinput_method_previous_message
,
10721 "When `input-method-function' is called, hold the previous echo area message.\n\
10722 This variable exists because `read-event' clears the echo area\n\
10723 before running the input method. It is nil if there was no message.");
10724 Vinput_method_previous_message
= Qnil
;
10726 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
10727 "If non-nil, the function that implements the display of help.\n\
10728 It's called with one argument, the help string to display.");
10729 Vshow_help_function
= Qnil
;
10731 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
10732 "If non-nil, suppress point adjustment after executing a command.\n\
10734 After a command is executed, if point is moved into a region that has\n\
10735 special properties (e.g. composition, display), we adjust point to\n\
10736 the boundary of the region. But, several special commands sets this\n\
10737 variable to non-nil, then we suppress the point adjustment.\n\
10739 This variable is set to nil before reading a command, and is checked\n\
10740 just after executing the command");
10741 Vdisable_point_adjustment
= Qnil
;
10743 DEFVAR_LISP ("global-disable-point-adjustment",
10744 &Vglobal_disable_point_adjustment
,
10745 "*If non-nil, always suppress point adjustment.\n\
10747 The default value is nil, in which case, point adjustment are\n\
10748 suppressed only after special commands that set\n\
10749 `disable-point-adjustment' (which see) to non-nil.");
10750 Vglobal_disable_point_adjustment
= Qnil
;
10752 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
10753 "Non-nil means updating menu bindings is allowed.\n\
10754 A value of nil means menu bindings should not be updated.\n\
10755 Used during Emacs' startup.");
10756 update_menu_bindings
= 1;
10758 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
10759 "*How long to display an echo-area message when the minibuffer is active.\n\
10760 If the value is not a number, such messages don't time out.");
10761 Vminibuffer_message_timeout
= make_number (2);
10765 keys_of_keyboard ()
10767 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
10768 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
10769 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
10770 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
10771 initial_define_key (meta_map
, 'x', "execute-extended-command");
10773 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
10774 "handle-delete-frame");
10775 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
10777 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",