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 static 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 Lisp_Object
Fcommand_execute ();
1284 static int read_key_sequence ();
1285 void safe_run_hooks ();
1286 static void adjust_point_for_property ();
1294 Lisp_Object keybuf
[30];
1298 struct buffer
*prev_buffer
= NULL
;
1300 int was_locked
= single_kboard
;
1303 current_kboard
->Vprefix_arg
= Qnil
;
1304 current_kboard
->Vlast_prefix_arg
= Qnil
;
1305 Vdeactivate_mark
= Qnil
;
1306 waiting_for_input
= 0;
1310 this_command_key_count
= 0;
1311 this_single_command_key_start
= 0;
1313 /* Make sure this hook runs after commands that get errors and
1314 throw to top level. */
1315 /* Note that the value cell will never directly contain nil
1316 if the symbol is a local variable. */
1317 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1318 safe_run_hooks (Qpost_command_hook
);
1320 /* If displaying a message, resize the echo area window to fit
1321 that message's size exactly. */
1322 if (!NILP (echo_area_buffer
[0]))
1323 resize_echo_area_axactly ();
1325 if (!NILP (Vdeferred_action_list
))
1326 call0 (Vdeferred_action_function
);
1328 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1330 if (NILP (Vunread_command_events
)
1331 && NILP (Vunread_input_method_events
)
1332 && NILP (Vunread_post_input_method_events
)
1333 && NILP (Vexecuting_macro
)
1334 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1335 safe_run_hooks (Qpost_command_idle_hook
);
1338 /* Do this after running Vpost_command_hook, for consistency. */
1339 current_kboard
->Vlast_command
= Vthis_command
;
1340 current_kboard
->Vreal_last_command
= real_this_command
;
1344 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1347 /* Make sure the current window's buffer is selected. */
1348 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1349 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1351 /* Display any malloc warning that just came out. Use while because
1352 displaying one warning can cause another. */
1354 while (pending_malloc_warning
)
1355 display_malloc_warning ();
1359 Vdeactivate_mark
= Qnil
;
1361 /* If minibuffer on and echo area in use,
1362 wait a short time and redraw minibuffer. */
1365 && !NILP (echo_area_buffer
[0])
1366 && EQ (minibuf_window
, echo_area_window
)
1367 && NUMBERP (Vminibuffer_message_timeout
))
1369 /* Bind inhibit-quit to t so that C-g gets read in
1370 rather than quitting back to the minibuffer. */
1371 int count
= specpdl_ptr
- specpdl
;
1372 specbind (Qinhibit_quit
, Qt
);
1374 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1375 /* Clear the echo area. */
1377 safe_run_hooks (Qecho_area_clear_hook
);
1379 unbind_to (count
, Qnil
);
1381 /* If a C-g came in before, treat it as input now. */
1382 if (!NILP (Vquit_flag
))
1385 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1390 alloca (0); /* Cause a garbage collection now */
1391 /* Since we can free the most stuff here. */
1392 #endif /* C_ALLOCA */
1395 /* Select the frame that the last event came from. Usually,
1396 switch-frame events will take care of this, but if some lisp
1397 code swallows a switch-frame event, we'll fix things up here.
1398 Is this a good idea? */
1399 if (FRAMEP (internal_last_event_frame
)
1400 && !EQ (internal_last_event_frame
, selected_frame
))
1401 Fselect_frame (internal_last_event_frame
, Qnil
);
1403 /* If it has changed current-menubar from previous value,
1404 really recompute the menubar from the value. */
1405 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1406 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1407 call0 (Qrecompute_lucid_menubar
);
1409 before_command_key_count
= this_command_key_count
;
1410 before_command_echo_length
= echo_length ();
1412 Vthis_command
= Qnil
;
1413 real_this_command
= Qnil
;
1415 /* Read next key sequence; i gets its length. */
1416 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1419 /* A filter may have run while we were reading the input. */
1420 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1422 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1423 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1427 /* Now we have read a key sequence of length I,
1428 or else I is 0 and we found end of file. */
1430 if (i
== 0) /* End of file -- happens only in */
1431 return Qnil
; /* a kbd macro, at the end. */
1432 /* -1 means read_key_sequence got a menu that was rejected.
1433 Just loop around and read another command. */
1437 this_command_key_count
= 0;
1438 this_single_command_key_start
= 0;
1442 last_command_char
= keybuf
[i
- 1];
1444 /* If the previous command tried to force a specific window-start,
1445 forget about that, in case this command moves point far away
1446 from that position. But also throw away beg_unchanged and
1447 end_unchanged information in that case, so that redisplay will
1448 update the whole window properly. */
1449 if (!NILP (XWINDOW (selected_window
)->force_start
))
1452 XWINDOW (selected_window
)->force_start
= Qnil
;
1453 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1454 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1457 cmd
= read_key_sequence_cmd
;
1458 if (!NILP (Vexecuting_macro
))
1460 if (!NILP (Vquit_flag
))
1462 Vexecuting_macro
= Qt
;
1463 QUIT
; /* Make some noise. */
1464 /* Will return since macro now empty. */
1468 /* Do redisplay processing after this command except in special
1469 cases identified below. */
1470 prev_buffer
= current_buffer
;
1471 prev_modiff
= MODIFF
;
1472 last_point_position
= PT
;
1473 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1475 /* By default, we adjust point to a boundary of a region that
1476 has such a property that should be treated intangible
1477 (e.g. composition, display). But, some commands will set
1478 this variable differently. */
1479 Vdisable_point_adjustment
= Qnil
;
1481 /* Execute the command. */
1483 Vthis_command
= cmd
;
1484 real_this_command
= cmd
;
1485 /* Note that the value cell will never directly contain nil
1486 if the symbol is a local variable. */
1487 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1488 safe_run_hooks (Qpre_command_hook
);
1490 if (NILP (Vthis_command
))
1492 /* nil means key is undefined. */
1494 current_kboard
->defining_kbd_macro
= Qnil
;
1495 update_mode_lines
= 1;
1496 current_kboard
->Vprefix_arg
= Qnil
;
1500 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1502 /* In case we jump to directly_done. */
1503 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1505 /* Recognize some common commands in common situations and
1506 do them directly. */
1507 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1509 struct Lisp_Char_Table
*dp
1510 = window_display_table (XWINDOW (selected_window
));
1511 lose
= FETCH_CHAR (PT_BYTE
);
1514 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1515 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1516 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1517 && (lose
>= 0x20 && lose
< 0x7f)))
1518 : (lose
>= 0x20 && lose
< 0x7f))
1519 /* To extract the case of continuation on
1520 wide-column characters. */
1521 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1522 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1524 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1526 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1528 && !windows_or_buffers_changed
1529 && EQ (current_buffer
->selective_display
, Qnil
)
1530 && !detect_input_pending ()
1531 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1532 && NILP (Vexecuting_macro
))
1533 direct_output_forward_char (1);
1536 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1538 struct Lisp_Char_Table
*dp
1539 = window_display_table (XWINDOW (selected_window
));
1541 lose
= FETCH_CHAR (PT_BYTE
);
1543 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1544 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1545 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1546 && (lose
>= 0x20 && lose
< 0x7f)))
1547 : (lose
>= 0x20 && lose
< 0x7f))
1548 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1550 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1552 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1554 && !windows_or_buffers_changed
1555 && EQ (current_buffer
->selective_display
, Qnil
)
1556 && !detect_input_pending ()
1557 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1558 && NILP (Vexecuting_macro
))
1559 direct_output_forward_char (-1);
1562 else if (EQ (Vthis_command
, Qself_insert_command
)
1563 /* Try this optimization only on ascii keystrokes. */
1564 && INTEGERP (last_command_char
))
1566 unsigned int c
= XINT (last_command_char
);
1568 if (NILP (Vexecuting_macro
)
1569 && !EQ (minibuf_window
, selected_window
))
1571 if (!nonundocount
|| nonundocount
>= 20)
1579 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1581 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1583 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1585 || MODIFF
<= SAVE_MODIFF
1586 || windows_or_buffers_changed
1587 || !EQ (current_buffer
->selective_display
, Qnil
)
1588 || detect_input_pending ()
1589 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1590 || !NILP (Vexecuting_macro
));
1592 value
= internal_self_insert (c
, 0);
1597 /* VALUE == 1 when AFTER-CHANGE functions are
1598 installed which is the case most of the time
1599 because FONT-LOCK installs one. */
1600 if (!lose
&& !value
)
1601 direct_output_for_insert (c
);
1606 /* Here for a command that isn't executed directly */
1608 #ifdef HAVE_X_WINDOWS
1609 if (display_hourglass_p
)
1614 if (NILP (current_kboard
->Vprefix_arg
))
1616 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1618 #ifdef HAVE_X_WINDOWS
1619 if (display_hourglass_p
)
1620 cancel_hourglass ();
1624 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1626 /* Note that the value cell will never directly contain nil
1627 if the symbol is a local variable. */
1628 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1629 safe_run_hooks (Qpost_command_hook
);
1631 /* If displaying a message, resize the echo area window to fit
1632 that message's size exactly. */
1633 if (!NILP (echo_area_buffer
[0]))
1634 resize_echo_area_axactly ();
1636 if (!NILP (Vdeferred_action_list
))
1637 safe_run_hooks (Qdeferred_action_function
);
1639 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1641 if (NILP (Vunread_command_events
)
1642 && NILP (Vunread_input_method_events
)
1643 && NILP (Vunread_post_input_method_events
)
1644 && NILP (Vexecuting_macro
)
1645 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1646 safe_run_hooks (Qpost_command_idle_hook
);
1649 /* If there is a prefix argument,
1650 1) We don't want Vlast_command to be ``universal-argument''
1651 (that would be dumb), so don't set Vlast_command,
1652 2) we want to leave echoing on so that the prefix will be
1653 echoed as part of this key sequence, so don't call
1655 3) we want to leave this_command_key_count non-zero, so that
1656 read_char will realize that it is re-reading a character, and
1657 not echo it a second time.
1659 If the command didn't actually create a prefix arg,
1660 but is merely a frame event that is transparent to prefix args,
1661 then the above doesn't apply. */
1662 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1664 current_kboard
->Vlast_command
= Vthis_command
;
1665 current_kboard
->Vreal_last_command
= real_this_command
;
1667 this_command_key_count
= 0;
1668 this_single_command_key_start
= 0;
1671 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1673 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1675 current_buffer
->mark_active
= Qnil
;
1676 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1678 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1679 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1684 if (current_buffer
== prev_buffer
1685 && last_point_position
!= PT
1686 && NILP (Vdisable_point_adjustment
)
1687 && NILP (Vglobal_disable_point_adjustment
))
1688 adjust_point_for_property (last_point_position
);
1690 /* Install chars successfully executed in kbd macro. */
1692 if (!NILP (current_kboard
->defining_kbd_macro
)
1693 && NILP (current_kboard
->Vprefix_arg
))
1694 finalize_kbd_macro_chars ();
1698 any_kboard_state ();
1703 extern Lisp_Object Qcomposition
, Qdisplay
;
1705 /* Adjust point to a boundary of a region that has such a property
1706 that should be treated intangible. For the moment, we check
1707 `composition' and `display' property. LAST_PT is the last position
1711 adjust_point_for_property (last_pt
)
1716 int check_composition
= 1, check_display
= 1;
1718 while (check_composition
|| check_display
)
1720 if (check_composition
1721 && PT
> BEGV
&& PT
< ZV
1722 && get_property_and_range (PT
, Qcomposition
, &val
, &start
, &end
, Qnil
)
1723 && COMPOSITION_VALID_P (start
, end
, val
)
1724 && start
< PT
&& end
> PT
1725 && (last_pt
<= start
|| last_pt
>= end
))
1733 check_composition
= 0;
1735 && PT
> BEGV
&& PT
< ZV
1736 && get_property_and_range (PT
, Qdisplay
, &val
, &start
, &end
, Qnil
)
1737 && display_prop_intangible_p (val
)
1738 && start
< PT
&& end
> PT
1739 && (last_pt
<= start
|| last_pt
>= end
))
1745 check_composition
= 1;
1751 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1754 safe_run_hooks_1 (hook
)
1757 return call1 (Vrun_hooks
, Vinhibit_quit
);
1760 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1763 safe_run_hooks_error (data
)
1766 return Fset (Vinhibit_quit
, Qnil
);
1769 /* If we get an error while running the hook, cause the hook variable
1770 to be nil. Also inhibit quits, so that C-g won't cause the hook
1771 to mysteriously evaporate. */
1774 safe_run_hooks (hook
)
1777 int count
= specpdl_ptr
- specpdl
;
1778 specbind (Qinhibit_quit
, hook
);
1780 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1782 unbind_to (count
, Qnil
);
1786 /* Number of seconds between polling for input. This is a Lisp
1787 variable that can be bound. */
1791 /* Nonzero means polling for input is temporarily suppressed. */
1793 int poll_suppress_count
;
1795 /* Asynchronous timer for polling. */
1797 struct atimer
*poll_timer
;
1800 #ifdef POLL_FOR_INPUT
1802 /* Poll for input, so what we catch a C-g if it comes in. This
1803 function is called from x_make_frame_visible, see comment
1809 if (interrupt_input_blocked
== 0
1810 && !waiting_for_input
)
1811 read_avail_input (0);
1814 /* Timer callback function for poll_timer. TIMER is equal to
1818 poll_for_input (timer
)
1819 struct atimer
*timer
;
1821 if (poll_suppress_count
== 0)
1822 poll_for_input_1 ();
1825 #endif /* POLL_FOR_INPUT */
1827 /* Begin signals to poll for input, if they are appropriate.
1828 This function is called unconditionally from various places. */
1833 #ifdef POLL_FOR_INPUT
1834 if (read_socket_hook
&& !interrupt_input
)
1836 /* Turn alarm handling on unconditionally. It might have
1837 been turned off in process.c. */
1838 turn_on_atimers (1);
1840 /* If poll timer doesn't exist, are we need one with
1841 a different interval, start a new one. */
1842 if (poll_timer
== NULL
1843 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
1845 EMACS_TIME interval
;
1848 cancel_atimer (poll_timer
);
1850 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
1851 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1852 poll_for_input
, NULL
);
1855 /* Let the timer's callback function poll for input
1856 if this becomes zero. */
1857 --poll_suppress_count
;
1862 /* Nonzero if we are using polling to handle input asynchronously. */
1865 input_polling_used ()
1867 #ifdef POLL_FOR_INPUT
1868 return read_socket_hook
&& !interrupt_input
;
1874 /* Turn off polling. */
1879 #ifdef POLL_FOR_INPUT
1880 if (read_socket_hook
&& !interrupt_input
)
1881 ++poll_suppress_count
;
1885 /* Set the value of poll_suppress_count to COUNT
1886 and start or stop polling accordingly. */
1889 set_poll_suppress_count (count
)
1892 #ifdef POLL_FOR_INPUT
1893 if (count
== 0 && poll_suppress_count
!= 0)
1895 poll_suppress_count
= 1;
1898 else if (count
!= 0 && poll_suppress_count
== 0)
1902 poll_suppress_count
= count
;
1906 /* Bind polling_period to a value at least N.
1907 But don't decrease it. */
1910 bind_polling_period (n
)
1913 #ifdef POLL_FOR_INPUT
1914 int new = polling_period
;
1919 stop_other_atimers (poll_timer
);
1921 specbind (Qpolling_period
, make_number (new));
1922 /* Start a new alarm with the new period. */
1927 /* Apply the control modifier to CHARACTER. */
1933 /* Save the upper bits here. */
1934 int upper
= c
& ~0177;
1938 /* Everything in the columns containing the upper-case letters
1939 denotes a control character. */
1940 if (c
>= 0100 && c
< 0140)
1944 /* Set the shift modifier for a control char
1945 made from a shifted letter. But only for letters! */
1946 if (oc
>= 'A' && oc
<= 'Z')
1947 c
|= shift_modifier
;
1950 /* The lower-case letters denote control characters too. */
1951 else if (c
>= 'a' && c
<= 'z')
1954 /* Include the bits for control and shift
1955 only if the basic ASCII code can't indicate them. */
1959 /* Replace the high bits. */
1960 c
|= (upper
& ~ctrl_modifier
);
1965 /* Display help echo in the echo area.
1967 HELP a string means display that string, HELP nil means clear the
1968 help echo. If HELP is a function, call it with OBJECT and POS as
1969 arguments; the function should return a help string or nil for
1970 none. For all other types of HELP evaluate it to obtain a string.
1972 WINDOW is the window in which the help was generated, if any.
1973 It is nil if not in a window.
1975 If OBJECT is a buffer, POS is the position in the buffer where the
1976 `help-echo' text property was found.
1978 If OBJECT is an overlay, that overlay has a `help-echo' property,
1979 and POS is the position in the overlay's buffer under the mouse.
1981 If OBJECT is a string (an overlay string or a string displayed with
1982 the `display' property). POS is the position in that string under
1985 OK_TO_IVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
1986 echo overwrites a keystroke echo currently displayed in the echo
1989 Note: this function may only be called with HELP nil or a string
1990 from X code running asynchronously. */
1993 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
1994 Lisp_Object help
, window
, object
, pos
;
1995 int ok_to_overwrite_keystroke_echo
;
1997 if (!NILP (help
) && !STRINGP (help
))
1999 if (FUNCTIONP (help
))
2001 Lisp_Object args
[4];
2006 help
= safe_call (4, args
);
2009 help
= safe_eval (help
);
2011 if (!STRINGP (help
))
2015 if (STRINGP (help
) || NILP (help
))
2017 if (!NILP (Vshow_help_function
))
2018 call1 (Vshow_help_function
, help
);
2019 else if (/* Don't overwrite minibuffer contents. */
2020 !MINI_WINDOW_P (XWINDOW (selected_window
))
2021 /* Don't overwrite a keystroke echo. */
2022 && (NILP (echo_message_buffer
)
2023 || ok_to_overwrite_keystroke_echo
)
2024 /* Don't overwrite a prompt. */
2025 && !cursor_in_echo_area
)
2029 int count
= specpdl_ptr
- specpdl
;
2030 specbind (Qmessage_truncate_lines
, Qt
);
2031 message3_nolog (help
, STRING_BYTES (XSTRING (help
)),
2032 STRING_MULTIBYTE (help
));
2033 unbind_to (count
, Qnil
);
2039 help_echo_showing_p
= STRINGP (help
);
2045 /* Input of single characters from keyboard */
2047 Lisp_Object
print_help ();
2048 static Lisp_Object
kbd_buffer_get_event ();
2049 static void record_char ();
2052 static jmp_buf wrong_kboard_jmpbuf
;
2055 /* read a character from the keyboard; call the redisplay if needed */
2056 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2057 -1 means do not do redisplay, but do do autosaving.
2060 /* The arguments MAPS and NMAPS are for menu prompting.
2061 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2063 PREV_EVENT is the previous input event, or nil if we are reading
2064 the first event of a key sequence (or not reading a key sequence).
2065 If PREV_EVENT is t, that is a "magic" value that says
2066 not to run input methods, but in other respects to act as if
2067 not reading a key sequence.
2069 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2070 if we used a mouse menu to read the input, or zero otherwise. If
2071 USED_MOUSE_MENU is null, we don't dereference it.
2073 Value is t if we showed a menu and the user rejected it. */
2076 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2080 Lisp_Object prev_event
;
2081 int *used_mouse_menu
;
2083 volatile Lisp_Object c
;
2085 jmp_buf local_getcjmp
;
2087 volatile int key_already_recorded
= 0;
2088 Lisp_Object tem
, save
;
2089 volatile Lisp_Object previous_echo_area_message
;
2090 volatile Lisp_Object also_record
;
2091 volatile int reread
;
2092 struct gcpro gcpro1
, gcpro2
;
2096 before_command_key_count
= this_command_key_count
;
2097 before_command_echo_length
= echo_length ();
2099 previous_echo_area_message
= Qnil
;
2101 GCPRO2 (c
, previous_echo_area_message
);
2106 if (CONSP (Vunread_post_input_method_events
))
2108 c
= XCAR (Vunread_post_input_method_events
);
2109 Vunread_post_input_method_events
2110 = XCDR (Vunread_post_input_method_events
);
2112 /* Undo what read_char_x_menu_prompt did when it unread
2113 additional keys returned by Fx_popup_menu. */
2115 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2123 if (unread_command_char
!= -1)
2125 XSETINT (c
, unread_command_char
);
2126 unread_command_char
= -1;
2132 if (CONSP (Vunread_command_events
))
2134 c
= XCAR (Vunread_command_events
);
2135 Vunread_command_events
= XCDR (Vunread_command_events
);
2137 /* Undo what read_char_x_menu_prompt did when it unread
2138 additional keys returned by Fx_popup_menu. */
2140 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2144 /* If the queued event is something that used the mouse,
2145 set used_mouse_menu accordingly. */
2147 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2148 *used_mouse_menu
= 1;
2151 goto reread_for_input_method
;
2154 if (CONSP (Vunread_input_method_events
))
2156 c
= XCAR (Vunread_input_method_events
);
2157 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2159 /* Undo what read_char_x_menu_prompt did when it unread
2160 additional keys returned by Fx_popup_menu. */
2162 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2166 goto reread_for_input_method
;
2169 /* If there is no function key translated before
2170 reset-this-command-lengths takes effect, forget about it. */
2171 before_command_restore_flag
= 0;
2173 if (!NILP (Vexecuting_macro
))
2175 /* We set this to Qmacro; since that's not a frame, nobody will
2176 try to switch frames on us, and the selected window will
2179 Since this event came from a macro, it would be misleading to
2180 leave internal_last_event_frame set to wherever the last
2181 real event came from. Normally, a switch-frame event selects
2182 internal_last_event_frame after each command is read, but
2183 events read from a macro should never cause a new frame to be
2185 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2187 /* Exit the macro if we are at the end.
2188 Also, some things replace the macro with t
2189 to force an early exit. */
2190 if (EQ (Vexecuting_macro
, Qt
)
2191 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2197 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2198 if (STRINGP (Vexecuting_macro
)
2199 && (XINT (c
) & 0x80))
2200 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2202 executing_macro_index
++;
2207 if (!NILP (unread_switch_frame
))
2209 c
= unread_switch_frame
;
2210 unread_switch_frame
= Qnil
;
2212 /* This event should make it into this_command_keys, and get echoed
2213 again, so we do not set `reread'. */
2217 /* if redisplay was requested */
2218 if (commandflag
>= 0)
2220 /* If there is pending input, process any events which are not
2221 user-visible, such as X selection_request events. */
2223 || detect_input_pending_run_timers (0))
2224 swallow_events (0); /* may clear input_pending */
2226 /* Redisplay if no pending input. */
2227 while (!input_pending
)
2229 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2230 redisplay_preserve_echo_area (5);
2235 /* Normal case: no input arrived during redisplay. */
2238 /* Input arrived and pre-empted redisplay.
2239 Process any events which are not user-visible. */
2241 /* If that cleared input_pending, try again to redisplay. */
2245 /* Message turns off echoing unless more keystrokes turn it on again.
2247 The code in 20.x for the condition was
2249 1. echo_area_glyphs && *echo_area_glyphs
2250 2. && echo_area_glyphs != current_kboard->echobuf
2251 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2253 (1) means there's a current message displayed
2255 (2) means it's not the message from echoing from the current
2258 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2259 is set to a non-null value. This is done in read_char and it is
2260 set to echo_area_glyphs after a call to echo_char. That means
2261 ok_to_echo_at_next_pause is either null or
2262 current_kboard->echobuf with the appropriate current_kboard at
2265 So, condition (3) means in clear text ok_to_echo_at_next_pause
2266 must be either null, or the current message isn't from echoing at
2267 all, or it's from echoing from a different kboard than the
2270 if (/* There currently something in the echo area */
2271 !NILP (echo_area_buffer
[0])
2272 && (/* And it's either not from echoing. */
2273 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2274 /* Or it's an echo from a different kboard. */
2275 || echo_kboard
!= current_kboard
2276 /* Or we explicitly allow overwriting whatever there is. */
2277 || ok_to_echo_at_next_pause
== NULL
))
2282 /* Try reading a character via menu prompting in the minibuf.
2283 Try this before the sit-for, because the sit-for
2284 would do the wrong thing if we are supposed to do
2285 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2286 after a mouse event so don't try a minibuf menu. */
2288 if (nmaps
> 0 && INTERACTIVE
2289 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2290 /* Don't bring up a menu if we already have another event. */
2291 && NILP (Vunread_command_events
)
2292 && unread_command_char
< 0
2293 && !detect_input_pending_run_timers (0))
2295 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2298 key_already_recorded
= 1;
2303 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2304 We will do that below, temporarily for short sections of code,
2305 when appropriate. local_getcjmp must be in effect
2306 around any call to sit_for or kbd_buffer_get_event;
2307 it *must not* be in effect when we call redisplay. */
2309 if (_setjmp (local_getcjmp
))
2311 XSETINT (c
, quit_char
);
2312 internal_last_event_frame
= selected_frame
;
2313 Vlast_event_frame
= internal_last_event_frame
;
2314 /* If we report the quit char as an event,
2315 don't do so more than once. */
2316 if (!NILP (Vinhibit_quit
))
2321 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2322 if (kb
!= current_kboard
)
2324 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2325 /* We shouldn't get here if we were in single-kboard mode! */
2328 while (CONSP (*tailp
))
2329 tailp
= &XCDR (*tailp
);
2332 *tailp
= Fcons (c
, Qnil
);
2333 kb
->kbd_queue_has_data
= 1;
2334 current_kboard
= kb
;
2335 /* This is going to exit from read_char
2336 so we had better get rid of this frame's stuff. */
2338 longjmp (wrong_kboard_jmpbuf
, 1);
2345 timer_start_idle ();
2347 /* If in middle of key sequence and minibuffer not active,
2348 start echoing if enough time elapses. */
2350 if (minibuf_level
== 0
2351 && !current_kboard
->immediate_echo
2352 && this_command_key_count
> 0
2354 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2355 && NILP (Fzerop (Vecho_keystrokes
))
2356 && (/* No message. */
2357 NILP (echo_area_buffer
[0])
2358 /* Or empty message. */
2359 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2360 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2361 /* Or already echoing from same kboard. */
2362 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2363 /* Or not echoing before and echoing allowed. */
2364 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2368 /* After a mouse event, start echoing right away.
2369 This is because we are probably about to display a menu,
2370 and we don't want to delay before doing so. */
2371 if (EVENT_HAS_PARAMETERS (prev_event
))
2376 double duration
= extract_float (Vecho_keystrokes
);
2377 sec
= (int) duration
;
2378 usec
= (duration
- sec
) * 1000000;
2379 save_getcjmp (save_jump
);
2380 restore_getcjmp (local_getcjmp
);
2381 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2382 restore_getcjmp (save_jump
);
2384 && ! CONSP (Vunread_command_events
))
2389 /* Maybe auto save due to number of keystrokes. */
2391 if (commandflag
!= 0
2392 && auto_save_interval
> 0
2393 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2394 && !detect_input_pending_run_timers (0))
2396 Fdo_auto_save (Qnil
, Qnil
);
2397 /* Hooks can actually change some buffers in auto save. */
2401 /* Try reading using an X menu.
2402 This is never confused with reading using the minibuf
2403 because the recursive call of read_char in read_char_minibuf_menu_prompt
2404 does not pass on any keymaps. */
2406 if (nmaps
> 0 && INTERACTIVE
2407 && !NILP (prev_event
)
2408 && EVENT_HAS_PARAMETERS (prev_event
)
2409 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2410 && !EQ (XCAR (prev_event
), Qtool_bar
)
2411 /* Don't bring up a menu if we already have another event. */
2412 && NILP (Vunread_command_events
)
2413 && unread_command_char
< 0)
2415 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2417 /* Now that we have read an event, Emacs is not idle. */
2423 /* Maybe autosave and/or garbage collect due to idleness. */
2425 if (INTERACTIVE
&& NILP (c
))
2427 int delay_level
, buffer_size
;
2429 /* Slow down auto saves logarithmically in size of current buffer,
2430 and garbage collect while we're at it. */
2431 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2432 last_non_minibuf_size
= Z
- BEG
;
2433 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2435 while (buffer_size
> 64)
2436 delay_level
++, buffer_size
-= buffer_size
>> 2;
2437 if (delay_level
< 4) delay_level
= 4;
2438 /* delay_level is 4 for files under around 50k, 7 at 100k,
2439 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2441 /* Auto save if enough time goes by without input. */
2442 if (commandflag
!= 0
2443 && num_nonmacro_input_events
> last_auto_save
2444 && INTEGERP (Vauto_save_timeout
)
2445 && XINT (Vauto_save_timeout
) > 0)
2449 save_getcjmp (save_jump
);
2450 restore_getcjmp (local_getcjmp
);
2451 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2453 restore_getcjmp (save_jump
);
2456 && ! CONSP (Vunread_command_events
))
2458 Fdo_auto_save (Qnil
, Qnil
);
2460 /* If we have auto-saved and there is still no input
2461 available, garbage collect if there has been enough
2462 consing going on to make it worthwhile. */
2463 if (!detect_input_pending_run_timers (0)
2464 && consing_since_gc
> gc_cons_threshold
/ 2)
2465 Fgarbage_collect ();
2472 /* If this has become non-nil here, it has been set by a timer
2473 or sentinel or filter. */
2474 if (CONSP (Vunread_command_events
))
2476 c
= XCAR (Vunread_command_events
);
2477 Vunread_command_events
= XCDR (Vunread_command_events
);
2480 /* Read something from current KBOARD's side queue, if possible. */
2484 if (current_kboard
->kbd_queue_has_data
)
2486 if (!CONSP (current_kboard
->kbd_queue
))
2488 c
= XCAR (current_kboard
->kbd_queue
);
2489 current_kboard
->kbd_queue
2490 = XCDR (current_kboard
->kbd_queue
);
2491 if (NILP (current_kboard
->kbd_queue
))
2492 current_kboard
->kbd_queue_has_data
= 0;
2493 input_pending
= readable_events (0);
2494 if (EVENT_HAS_PARAMETERS (c
)
2495 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2496 internal_last_event_frame
= XCAR (XCDR (c
));
2497 Vlast_event_frame
= internal_last_event_frame
;
2502 /* If current_kboard's side queue is empty check the other kboards.
2503 If one of them has data that we have not yet seen here,
2504 switch to it and process the data waiting for it.
2506 Note: if the events queued up for another kboard
2507 have already been seen here, and therefore are not a complete command,
2508 the kbd_queue_has_data field is 0, so we skip that kboard here.
2509 That's to avoid an infinite loop switching between kboards here. */
2510 if (NILP (c
) && !single_kboard
)
2513 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2514 if (kb
->kbd_queue_has_data
)
2516 current_kboard
= kb
;
2517 /* This is going to exit from read_char
2518 so we had better get rid of this frame's stuff. */
2520 longjmp (wrong_kboard_jmpbuf
, 1);
2529 /* Finally, we read from the main queue,
2530 and if that gives us something we can't use yet, we put it on the
2531 appropriate side queue and try again. */
2537 /* Actually read a character, waiting if necessary. */
2538 save_getcjmp (save_jump
);
2539 restore_getcjmp (local_getcjmp
);
2540 timer_start_idle ();
2541 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2542 restore_getcjmp (save_jump
);
2545 if (! NILP (c
) && (kb
!= current_kboard
))
2547 Lisp_Object
*tailp
= &kb
->kbd_queue
;
2548 while (CONSP (*tailp
))
2549 tailp
= &XCDR (*tailp
);
2552 *tailp
= Fcons (c
, Qnil
);
2553 kb
->kbd_queue_has_data
= 1;
2557 current_kboard
= kb
;
2558 /* This is going to exit from read_char
2559 so we had better get rid of this frame's stuff. */
2561 longjmp (wrong_kboard_jmpbuf
, 1);
2566 /* Terminate Emacs in batch mode if at eof. */
2567 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2568 Fkill_emacs (make_number (1));
2572 /* Add in any extra modifiers, where appropriate. */
2573 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2574 || ((extra_keyboard_modifiers
& 0177) < ' '
2575 && (extra_keyboard_modifiers
& 0177) != 0))
2576 XSETINT (c
, make_ctrl_char (XINT (c
)));
2578 /* Transfer any other modifier bits directly from
2579 extra_keyboard_modifiers to c. Ignore the actual character code
2580 in the low 16 bits of extra_keyboard_modifiers. */
2581 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2591 if (commandflag
>= 0
2592 && !input_pending
&& !detect_input_pending_run_timers (0))
2600 /* Buffer switch events are only for internal wakeups
2601 so don't show them to the user.
2602 Also, don't record a key if we already did. */
2603 if (BUFFERP (c
) || key_already_recorded
)
2606 /* Process special events within read_char
2607 and loop around to read another event. */
2610 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2615 int was_locked
= single_kboard
;
2617 last_input_char
= c
;
2618 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2620 /* Resume allowing input from any kboard, if that was true before. */
2622 any_kboard_state ();
2627 /* Handle things that only apply to characters. */
2630 /* If kbd_buffer_get_event gave us an EOF, return that. */
2634 if ((STRINGP (Vkeyboard_translate_table
)
2635 && XSTRING (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2636 || (VECTORP (Vkeyboard_translate_table
)
2637 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2638 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2639 && CHAR_TABLE_ORDINARY_SLOTS
> (unsigned) XFASTINT (c
)))
2642 d
= Faref (Vkeyboard_translate_table
, c
);
2643 /* nil in keyboard-translate-table means no translation. */
2649 /* If this event is a mouse click in the menu bar,
2650 return just menu-bar for now. Modify the mouse click event
2651 so we won't do this twice, then queue it up. */
2652 if (EVENT_HAS_PARAMETERS (c
)
2654 && CONSP (EVENT_START (c
))
2655 && CONSP (XCDR (EVENT_START (c
))))
2659 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2660 /* Handle menu-bar events:
2661 insert the dummy prefix event `menu-bar'. */
2662 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2664 /* Change menu-bar to (menu-bar) as the event "position". */
2665 POSN_BUFFER_POSN (EVENT_START (c
)) = Fcons (posn
, Qnil
);
2668 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2673 /* Store these characters into recent_keys, the dribble file if any,
2674 and the keyboard macro being defined, if any. */
2676 if (! NILP (also_record
))
2677 record_char (also_record
);
2679 /* Wipe the echo area.
2680 But first, if we are about to use an input method,
2681 save the echo area contents for it to refer to. */
2683 && ! NILP (Vinput_method_function
)
2684 && (unsigned) XINT (c
) >= ' '
2685 && (unsigned) XINT (c
) != 127
2686 && (unsigned) XINT (c
) < 256)
2688 previous_echo_area_message
= Fcurrent_message ();
2689 Vinput_method_previous_message
= previous_echo_area_message
;
2692 /* Now wipe the echo area, except for help events which do their
2693 own stuff with the echo area. */
2694 if (!CONSP (c
) || !(EQ (Qhelp_echo
, XCAR (c
))))
2696 if (!NILP (echo_area_buffer
[0]))
2697 safe_run_hooks (Qecho_area_clear_hook
);
2698 clear_message (1, 0);
2701 reread_for_input_method
:
2703 /* Pass this to the input method, if appropriate. */
2705 && ! NILP (Vinput_method_function
)
2706 /* Don't run the input method within a key sequence,
2707 after the first event of the key sequence. */
2708 && NILP (prev_event
)
2709 && (unsigned) XINT (c
) >= ' '
2710 && (unsigned) XINT (c
) != 127
2711 && (unsigned) XINT (c
) < 256)
2715 struct gcpro gcpro1
;
2716 int count
= specpdl_ptr
- specpdl
;
2718 /* Save the echo status. */
2719 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2720 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2721 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2723 if (before_command_restore_flag
)
2725 this_command_key_count
= before_command_key_count_1
;
2726 if (this_command_key_count
< this_single_command_key_start
)
2727 this_single_command_key_start
= this_command_key_count
;
2728 echo_truncate (before_command_echo_length_1
);
2729 before_command_restore_flag
= 0;
2732 /* Save the this_command_keys status. */
2733 key_count
= this_command_key_count
;
2736 keys
= Fcopy_sequence (this_command_keys
);
2741 /* Clear out this_command_keys. */
2742 this_command_key_count
= 0;
2744 /* Now wipe the echo area. */
2745 if (!NILP (echo_area_buffer
[0]))
2746 safe_run_hooks (Qecho_area_clear_hook
);
2747 clear_message (1, 0);
2750 /* If we are not reading a key sequence,
2751 never use the echo area. */
2754 specbind (Qinput_method_use_echo_area
, Qt
);
2757 /* Call the input method. */
2758 tem
= call1 (Vinput_method_function
, c
);
2760 tem
= unbind_to (count
, tem
);
2762 /* Restore the saved echoing state
2763 and this_command_keys state. */
2764 this_command_key_count
= key_count
;
2766 this_command_keys
= keys
;
2769 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
2770 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
2771 if (saved_immediate_echo
)
2776 /* The input method can return no events. */
2779 /* Bring back the previous message, if any. */
2780 if (! NILP (previous_echo_area_message
))
2781 message_with_string ("%s", previous_echo_area_message
, 0);
2784 /* It returned one event or more. */
2786 Vunread_post_input_method_events
2787 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
2792 /* Display help if not echoing. */
2793 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
2795 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
2796 Lisp_Object help
, object
, position
, window
;
2797 help
= Fnth (make_number (2), c
);
2798 window
= Fnth (make_number (3), c
);
2799 object
= Fnth (make_number (4), c
);
2800 position
= Fnth (make_number (5), c
);
2801 show_help_echo (help
, window
, object
, position
, 0);
2805 if (this_command_key_count
== 0 || ! reread
)
2807 before_command_key_count
= this_command_key_count
;
2808 before_command_echo_length
= echo_length ();
2810 /* Don't echo mouse motion events. */
2811 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2812 && NILP (Fzerop (Vecho_keystrokes
))
2813 && ! (EVENT_HAS_PARAMETERS (c
)
2814 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
2817 if (! NILP (also_record
))
2818 echo_char (also_record
);
2819 /* Once we reread a character, echoing can happen
2820 the next time we pause to read a new one. */
2821 ok_to_echo_at_next_pause
= current_kboard
;
2824 /* Record this character as part of the current key. */
2825 add_command_key (c
);
2826 if (! NILP (also_record
))
2827 add_command_key (also_record
);
2830 last_input_char
= c
;
2833 /* Process the help character specially if enabled */
2834 if (!NILP (Vhelp_form
) && help_char_p (c
))
2837 count
= specpdl_ptr
- specpdl
;
2839 record_unwind_protect (Fset_window_configuration
,
2840 Fcurrent_window_configuration (Qnil
));
2842 tem0
= Feval (Vhelp_form
);
2844 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
2848 c
= read_char (0, 0, 0, Qnil
, 0);
2849 while (BUFFERP (c
));
2850 /* Remove the help from the frame */
2851 unbind_to (count
, Qnil
);
2854 if (EQ (c
, make_number (040)))
2858 c
= read_char (0, 0, 0, Qnil
, 0);
2859 while (BUFFERP (c
));
2866 /* Record a key that came from a mouse menu.
2867 Record it for echoing, for this-command-keys, and so on. */
2873 /* Wipe the echo area. */
2874 clear_message (1, 0);
2878 before_command_key_count
= this_command_key_count
;
2879 before_command_echo_length
= echo_length ();
2881 /* Don't echo mouse motion events. */
2882 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2883 && NILP (Fzerop (Vecho_keystrokes
)))
2887 /* Once we reread a character, echoing can happen
2888 the next time we pause to read a new one. */
2889 ok_to_echo_at_next_pause
= 0;
2892 /* Record this character as part of the current key. */
2893 add_command_key (c
);
2895 /* Re-reading in the middle of a command */
2896 last_input_char
= c
;
2900 /* Return 1 if should recognize C as "the help character". */
2908 if (EQ (c
, Vhelp_char
))
2910 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
2911 if (EQ (c
, XCAR (tail
)))
2916 /* Record the input event C in various ways. */
2922 /* Don't record `help-echo' in recent_keys unless it shows some help
2923 message, and a different help than the previoiusly recorded
2925 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
2929 help
= Fnth (make_number (2), c
);
2933 Lisp_Object last_c
, last_help
;
2935 last_idx
= recent_keys_index
- 1;
2937 last_idx
= NUM_RECENT_KEYS
- 1;
2938 last_c
= AREF (recent_keys
, last_idx
);
2941 || !EQ (XCAR (last_c
), Qhelp_echo
)
2942 || (last_help
= Fnth (make_number (2), last_c
),
2943 !EQ (last_help
, help
)))
2946 ASET (recent_keys
, recent_keys_index
, c
);
2947 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2948 recent_keys_index
= 0;
2955 ASET (recent_keys
, recent_keys_index
, c
);
2956 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
2957 recent_keys_index
= 0;
2960 /* Write c to the dribble file. If c is a lispy event, write
2961 the event's symbol to the dribble file, in <brackets>. Bleaugh.
2962 If you, dear reader, have a better idea, you've got the source. :-) */
2967 if (XUINT (c
) < 0x100)
2968 putc (XINT (c
), dribble
);
2970 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
2974 Lisp_Object dribblee
;
2976 /* If it's a structured event, take the event header. */
2977 dribblee
= EVENT_HEAD (c
);
2979 if (SYMBOLP (dribblee
))
2981 putc ('<', dribble
);
2982 fwrite (XSYMBOL (dribblee
)->name
->data
, sizeof (char),
2983 STRING_BYTES (XSYMBOL (dribblee
)->name
),
2985 putc ('>', dribble
);
2992 if (!CONSP (c
) || !EQ (Qhelp_echo
, XCAR (c
)))
2993 store_kbd_macro_char (c
);
2995 num_nonmacro_input_events
++;
3002 struct buffer
*old
= current_buffer
;
3003 Fprinc (object
, Qnil
);
3004 set_buffer_internal (XBUFFER (Vstandard_output
));
3005 call0 (intern ("help-mode"));
3006 set_buffer_internal (old
);
3010 /* Copy out or in the info on where C-g should throw to.
3011 This is used when running Lisp code from within get_char,
3012 in case get_char is called recursively.
3013 See read_process_output. */
3019 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3023 restore_getcjmp (temp
)
3026 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3031 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3032 of this function. */
3035 tracking_off (old_value
)
3036 Lisp_Object old_value
;
3038 do_mouse_tracking
= old_value
;
3039 if (NILP (old_value
))
3041 /* Redisplay may have been preempted because there was input
3042 available, and it assumes it will be called again after the
3043 input has been processed. If the only input available was
3044 the sort that we have just disabled, then we need to call
3046 if (!readable_events (1))
3048 redisplay_preserve_echo_area (6);
3049 get_input_pending (&input_pending
, 1);
3055 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3056 "Evaluate BODY with mouse movement events enabled.\n\
3057 Within a `track-mouse' form, mouse motion generates input events that\n\
3058 you can read with `read-event'.\n\
3059 Normally, mouse motion is ignored.")
3063 int count
= specpdl_ptr
- specpdl
;
3066 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3068 do_mouse_tracking
= Qt
;
3070 val
= Fprogn (args
);
3071 return unbind_to (count
, val
);
3074 /* If mouse has moved on some frame, return one of those frames.
3075 Return 0 otherwise. */
3080 Lisp_Object tail
, frame
;
3082 FOR_EACH_FRAME (tail
, frame
)
3084 if (XFRAME (frame
)->mouse_moved
)
3085 return XFRAME (frame
);
3091 #endif /* HAVE_MOUSE */
3093 /* Low level keyboard/mouse input.
3094 kbd_buffer_store_event places events in kbd_buffer, and
3095 kbd_buffer_get_event retrieves them. */
3097 /* Return true iff there are any events in the queue that read-char
3098 would return. If this returns false, a read-char would block. */
3100 readable_events (do_timers_now
)
3104 timer_check (do_timers_now
);
3106 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3109 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3114 if (current_kboard
->kbd_queue_has_data
)
3120 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3121 if (kb
->kbd_queue_has_data
)
3127 /* Set this for debugging, to have a way to get out */
3132 event_to_kboard (event
)
3133 struct input_event
*event
;
3136 frame
= event
->frame_or_window
;
3138 frame
= XCAR (frame
);
3139 else if (WINDOWP (frame
))
3140 frame
= WINDOW_FRAME (XWINDOW (frame
));
3142 /* There are still some events that don't set this field.
3143 For now, just ignore the problem.
3144 Also ignore dead frames here. */
3145 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3148 return FRAME_KBOARD (XFRAME (frame
));
3152 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3155 kbd_buffer_store_event (event
)
3156 register struct input_event
*event
;
3158 if (event
->kind
== no_event
)
3161 if (event
->kind
== ascii_keystroke
)
3163 register int c
= event
->code
& 0377;
3165 if (event
->modifiers
& ctrl_modifier
)
3166 c
= make_ctrl_char (c
);
3168 c
|= (event
->modifiers
3169 & (meta_modifier
| alt_modifier
3170 | hyper_modifier
| super_modifier
));
3174 extern SIGTYPE
interrupt_signal ();
3177 struct input_event
*sp
;
3180 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3181 kb
!= current_kboard
))
3184 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3185 Fcons (make_number (c
), Qnil
));
3186 kb
->kbd_queue_has_data
= 1;
3187 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3189 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3192 if (event_to_kboard (sp
) == kb
)
3194 sp
->kind
= no_event
;
3195 sp
->frame_or_window
= Qnil
;
3203 /* If this results in a quit_char being returned to Emacs as
3204 input, set Vlast_event_frame properly. If this doesn't
3205 get returned to Emacs as an event, the next event read
3206 will set Vlast_event_frame again, so this is safe to do. */
3210 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3212 focus
= event
->frame_or_window
;
3213 internal_last_event_frame
= focus
;
3214 Vlast_event_frame
= focus
;
3217 last_event_timestamp
= event
->timestamp
;
3218 interrupt_signal ();
3222 if (c
&& c
== stop_character
)
3228 /* Don't insert two buffer_switch_event's in a row.
3229 Just ignore the second one. */
3230 else if (event
->kind
== buffer_switch_event
3231 && kbd_fetch_ptr
!= kbd_store_ptr
3232 && kbd_store_ptr
->kind
== buffer_switch_event
)
3235 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3236 kbd_store_ptr
= kbd_buffer
;
3238 /* Don't let the very last slot in the buffer become full,
3239 since that would make the two pointers equal,
3240 and that is indistinguishable from an empty buffer.
3241 Discard the event if it would fill the last slot. */
3242 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3246 #if 0 /* The selection_request_event case looks bogus, and it's error
3247 prone to assign individual members for other events, in case
3248 the input_event structure is changed. --2000-07-13, gerd. */
3249 struct input_event
*sp
= kbd_store_ptr
;
3250 sp
->kind
= event
->kind
;
3251 if (event
->kind
== selection_request_event
)
3253 /* We must not use the ordinary copying code for this case,
3254 since `part' is an enum and copying it might not copy enough
3256 bcopy (event
, (char *) sp
, sizeof (*event
));
3261 sp
->code
= event
->code
;
3262 sp
->part
= event
->part
;
3263 sp
->frame_or_window
= event
->frame_or_window
;
3264 sp
->arg
= event
->arg
;
3265 sp
->modifiers
= event
->modifiers
;
3268 sp
->timestamp
= event
->timestamp
;
3271 *kbd_store_ptr
= *event
;
3274 idx
= 2 * (kbd_store_ptr
- kbd_buffer
);
3275 ASET (kbd_buffer_gcpro
, idx
, event
->frame_or_window
);
3276 ASET (kbd_buffer_gcpro
, idx
+ 1, event
->arg
);
3282 /* Generate HELP_EVENT input_events in BUFP which has room for
3283 SIZE events. If there's not enough room in BUFP, ignore this
3286 HELP is the help form.
3288 FRAME is the frame on which the help is generated. OBJECT is the
3289 Lisp object where the help was found (a buffer, a string, an
3290 overlay, or nil if neither from a string nor from a buffer. POS is
3291 the position within OBJECT where the help was found.
3293 Value is the number of input_events generated. */
3296 gen_help_event (bufp
, size
, help
, frame
, window
, object
, pos
)
3297 struct input_event
*bufp
;
3299 Lisp_Object help
, frame
, object
, window
;
3302 int nevents_stored
= 0;
3306 bufp
->kind
= HELP_EVENT
;
3307 bufp
->frame_or_window
= frame
;
3309 bufp
->x
= make_number (pos
);
3313 bufp
->kind
= HELP_EVENT
;
3314 bufp
->frame_or_window
= WINDOWP (window
) ? window
: frame
;
3320 return nevents_stored
;
3324 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3327 kbd_buffer_store_help_event (frame
, help
)
3328 Lisp_Object frame
, help
;
3330 struct input_event event
;
3332 event
.kind
= HELP_EVENT
;
3333 event
.frame_or_window
= frame
;
3335 event
.x
= make_number (0);
3337 kbd_buffer_store_event (&event
);
3339 event
.kind
= HELP_EVENT
;
3340 event
.frame_or_window
= frame
;
3342 event
.x
= make_number (0);
3344 kbd_buffer_store_event (&event
);
3348 /* Discard any mouse events in the event buffer by setting them to
3351 discard_mouse_events ()
3353 struct input_event
*sp
;
3354 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3356 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3359 if (sp
->kind
== mouse_click
3361 || sp
->kind
== w32_scroll_bar_click
3363 || sp
->kind
== scroll_bar_click
)
3365 sp
->kind
= no_event
;
3371 /* Return non-zero if there are any real events waiting in the event
3372 buffer, not counting `no_event's.
3374 If DISCARD is non-zero, discard no_event events at the front of
3375 the input queue, possibly leaving the input queue empty if there
3376 are no real input events. */
3379 kbd_buffer_events_waiting (discard
)
3382 struct input_event
*sp
;
3384 for (sp
= kbd_fetch_ptr
;
3385 sp
!= kbd_store_ptr
&& sp
->kind
== no_event
;
3388 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3395 return sp
!= kbd_store_ptr
&& sp
->kind
!= no_event
;
3399 /* Clear input event EVENT. */
3403 struct input_event
*event
;
3405 int idx
= 2 * (event
- kbd_buffer
);
3406 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
3407 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
3408 event
->kind
= no_event
;
3412 /* Read one event from the event buffer, waiting if necessary.
3413 The value is a Lisp object representing the event.
3414 The value is nil for an event that should be ignored,
3415 or that was handled here.
3416 We always read and discard one event. */
3419 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3421 int *used_mouse_menu
;
3430 *kbp
= current_kboard
;
3434 /* Wait until there is input available. */
3437 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3440 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3444 /* If the quit flag is set, then read_char will return
3445 quit_char, so that counts as "available input." */
3446 if (!NILP (Vquit_flag
))
3447 quit_throw_to_read_char ();
3449 /* One way or another, wait until input is available; then, if
3450 interrupt handlers have not read it, read it now. */
3453 wait_for_kbd_input ();
3455 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3459 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3462 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3466 Lisp_Object minus_one
;
3468 XSETINT (minus_one
, -1);
3469 wait_reading_process_input (0, 0, minus_one
, 1);
3471 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3472 /* Pass 1 for EXPECT since we just waited to have input. */
3473 read_avail_input (1);
3475 #endif /* not VMS */
3478 if (CONSP (Vunread_command_events
))
3481 first
= XCAR (Vunread_command_events
);
3482 Vunread_command_events
= XCDR (Vunread_command_events
);
3483 *kbp
= current_kboard
;
3487 /* At this point, we know that there is a readable event available
3488 somewhere. If the event queue is empty, then there must be a
3489 mouse movement enabled and available. */
3490 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3492 struct input_event
*event
;
3494 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3498 last_event_timestamp
= event
->timestamp
;
3501 *kbp
= event_to_kboard (event
);
3503 *kbp
= current_kboard
; /* Better than returning null ptr? */
3505 *kbp
= &the_only_kboard
;
3510 /* These two kinds of events get special handling
3511 and don't actually appear to the command loop.
3512 We return nil for them. */
3513 if (event
->kind
== selection_request_event
)
3516 struct input_event copy
;
3518 /* Remove it from the buffer before processing it,
3519 since otherwise swallow_events will see it
3520 and process it again. */
3522 kbd_fetch_ptr
= event
+ 1;
3523 input_pending
= readable_events (0);
3524 x_handle_selection_request (©
);
3526 /* We're getting selection request events, but we don't have
3532 else if (event
->kind
== selection_clear_event
)
3535 struct input_event copy
;
3537 /* Remove it from the buffer before processing it. */
3539 kbd_fetch_ptr
= event
+ 1;
3540 input_pending
= readable_events (0);
3541 x_handle_selection_clear (©
);
3543 /* We're getting selection request events, but we don't have
3548 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (macintosh)
3549 else if (event
->kind
== delete_window_event
)
3551 /* Make an event (delete-frame (FRAME)). */
3552 obj
= Fcons (event
->frame_or_window
, Qnil
);
3553 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3554 kbd_fetch_ptr
= event
+ 1;
3557 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3558 else if (event
->kind
== iconify_event
)
3560 /* Make an event (iconify-frame (FRAME)). */
3561 obj
= Fcons (event
->frame_or_window
, Qnil
);
3562 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3563 kbd_fetch_ptr
= event
+ 1;
3565 else if (event
->kind
== deiconify_event
)
3567 /* Make an event (make-frame-visible (FRAME)). */
3568 obj
= Fcons (event
->frame_or_window
, Qnil
);
3569 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3570 kbd_fetch_ptr
= event
+ 1;
3573 else if (event
->kind
== buffer_switch_event
)
3575 /* The value doesn't matter here; only the type is tested. */
3576 XSETBUFFER (obj
, current_buffer
);
3577 kbd_fetch_ptr
= event
+ 1;
3579 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
3580 else if (event
->kind
== menu_bar_activate_event
)
3582 kbd_fetch_ptr
= event
+ 1;
3583 input_pending
= readable_events (0);
3584 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3585 x_activate_menubar (XFRAME (event
->frame_or_window
));
3589 else if (event
->kind
== language_change_event
)
3591 /* Make an event (language-change (FRAME CHARSET LCID)). */
3592 obj
= Fcons (event
->modifiers
, Qnil
);
3593 obj
= Fcons (event
->code
, Qnil
);
3594 obj
= Fcons (event
->frame_or_window
, obj
);
3595 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3596 kbd_fetch_ptr
= event
+ 1;
3599 /* Just discard these, by returning nil.
3600 With MULTI_KBOARD, these events are used as placeholders
3601 when we need to randomly delete events from the queue.
3602 (They shouldn't otherwise be found in the buffer,
3603 but on some machines it appears they do show up
3604 even without MULTI_KBOARD.) */
3605 /* On Windows NT/9X, no_event is used to delete extraneous
3606 mouse events during a popup-menu call. */
3607 else if (event
->kind
== no_event
)
3608 kbd_fetch_ptr
= event
+ 1;
3609 else if (event
->kind
== HELP_EVENT
)
3611 /* There are always two HELP_EVENTs in the input queue. */
3612 Lisp_Object object
, position
, help
, frame
, window
;
3614 xassert (event
->code
== 0);
3615 frame
= event
->frame_or_window
;
3616 object
= event
->arg
;
3617 position
= event
->x
;
3618 clear_event (event
);
3620 kbd_fetch_ptr
= event
+ 1;
3621 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3624 xassert (event
->code
== 1);
3626 window
= event
->frame_or_window
;
3627 if (!WINDOWP (window
))
3629 obj
= Fcons (Qhelp_echo
,
3630 list5 (frame
, help
, window
, object
, position
));
3631 clear_event (event
);
3632 kbd_fetch_ptr
= event
+ 1;
3634 else if (event
->kind
== FOCUS_IN_EVENT
)
3636 /* Notification of a FocusIn event. The frame receiving the
3637 focus is in event->frame_or_window. Generate a
3638 switch-frame event if necessary. */
3639 Lisp_Object frame
, focus
;
3641 frame
= event
->frame_or_window
;
3642 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3646 if (!EQ (frame
, internal_last_event_frame
)
3647 && !EQ (frame
, selected_frame
))
3648 obj
= make_lispy_switch_frame (frame
);
3649 internal_last_event_frame
= frame
;
3650 kbd_fetch_ptr
= event
+ 1;
3654 /* If this event is on a different frame, return a switch-frame this
3655 time, and leave the event in the queue for next time. */
3659 frame
= event
->frame_or_window
;
3661 frame
= XCAR (frame
);
3662 else if (WINDOWP (frame
))
3663 frame
= WINDOW_FRAME (XWINDOW (frame
));
3665 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3669 if (! EQ (frame
, internal_last_event_frame
)
3670 && !EQ (frame
, selected_frame
))
3671 obj
= make_lispy_switch_frame (frame
);
3672 internal_last_event_frame
= frame
;
3674 /* If we didn't decide to make a switch-frame event, go ahead
3675 and build a real event from the queue entry. */
3679 obj
= make_lispy_event (event
);
3681 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
3682 /* If this was a menu selection, then set the flag to inhibit
3683 writing to last_nonmenu_event. Don't do this if the event
3684 we're returning is (menu-bar), though; that indicates the
3685 beginning of the menu sequence, and we might as well leave
3686 that as the `event with parameters' for this selection. */
3688 && !EQ (event
->frame_or_window
, event
->arg
)
3689 && (event
->kind
== MENU_BAR_EVENT
3690 || event
->kind
== TOOL_BAR_EVENT
))
3691 *used_mouse_menu
= 1;
3694 /* Wipe out this event, to catch bugs. */
3695 clear_event (event
);
3696 kbd_fetch_ptr
= event
+ 1;
3701 /* Try generating a mouse motion event. */
3702 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3704 FRAME_PTR f
= some_mouse_moved ();
3705 Lisp_Object bar_window
;
3706 enum scroll_bar_part part
;
3710 *kbp
= current_kboard
;
3711 /* Note that this uses F to determine which display to look at.
3712 If there is no valid info, it does not store anything
3713 so x remains nil. */
3715 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
3719 /* Decide if we should generate a switch-frame event. Don't
3720 generate switch-frame events for motion outside of all Emacs
3726 frame
= FRAME_FOCUS_FRAME (f
);
3728 XSETFRAME (frame
, f
);
3730 if (! EQ (frame
, internal_last_event_frame
)
3731 && !EQ (frame
, selected_frame
))
3732 obj
= make_lispy_switch_frame (frame
);
3733 internal_last_event_frame
= frame
;
3736 /* If we didn't decide to make a switch-frame event, go ahead and
3737 return a mouse-motion event. */
3738 if (!NILP (x
) && NILP (obj
))
3739 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
3741 #endif /* HAVE_MOUSE */
3743 /* We were promised by the above while loop that there was
3744 something for us to read! */
3747 input_pending
= readable_events (0);
3749 Vlast_event_frame
= internal_last_event_frame
;
3754 /* Process any events that are not user-visible,
3755 then return, without reading any user-visible events. */
3758 swallow_events (do_display
)
3763 while (kbd_fetch_ptr
!= kbd_store_ptr
)
3765 struct input_event
*event
;
3767 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3771 last_event_timestamp
= event
->timestamp
;
3773 /* These two kinds of events get special handling
3774 and don't actually appear to the command loop. */
3775 if (event
->kind
== selection_request_event
)
3778 struct input_event copy
;
3780 /* Remove it from the buffer before processing it,
3781 since otherwise swallow_events called recursively could see it
3782 and process it again. */
3784 kbd_fetch_ptr
= event
+ 1;
3785 input_pending
= readable_events (0);
3786 x_handle_selection_request (©
);
3788 /* We're getting selection request events, but we don't have
3794 else if (event
->kind
== selection_clear_event
)
3797 struct input_event copy
;
3799 /* Remove it from the buffer before processing it, */
3802 kbd_fetch_ptr
= event
+ 1;
3803 input_pending
= readable_events (0);
3804 x_handle_selection_clear (©
);
3806 /* We're getting selection request events, but we don't have
3815 old_timers_run
= timers_run
;
3816 get_input_pending (&input_pending
, 1);
3818 if (timers_run
!= old_timers_run
&& do_display
)
3819 redisplay_preserve_echo_area (7);
3822 static EMACS_TIME timer_idleness_start_time
;
3824 /* Record the start of when Emacs is idle,
3825 for the sake of running idle-time timers. */
3832 /* If we are already in the idle state, do nothing. */
3833 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3836 EMACS_GET_TIME (timer_idleness_start_time
);
3838 /* Mark all idle-time timers as once again candidates for running. */
3839 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
3843 timer
= XCAR (timers
);
3845 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3847 XVECTOR (timer
)->contents
[0] = Qnil
;
3851 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
3856 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
3859 /* This is only for debugging. */
3860 struct input_event last_timer_event
;
3862 /* Check whether a timer has fired. To prevent larger problems we simply
3863 disregard elements that are not proper timers. Do not make a circular
3864 timer list for the time being.
3866 Returns the number of seconds to wait until the next timer fires. If a
3867 timer is triggering now, return zero seconds.
3868 If no timer is active, return -1 seconds.
3870 If a timer is ripe, we run it, with quitting turned off.
3872 DO_IT_NOW is now ignored. It used to mean that we should
3873 run the timer directly instead of queueing a timer-event.
3874 Now we always run timers directly. */
3877 timer_check (do_it_now
)
3880 EMACS_TIME nexttime
;
3881 EMACS_TIME now
, idleness_now
;
3882 Lisp_Object timers
, idle_timers
, chosen_timer
;
3883 struct gcpro gcpro1
, gcpro2
, gcpro3
;
3885 EMACS_SET_SECS (nexttime
, -1);
3886 EMACS_SET_USECS (nexttime
, -1);
3888 /* Always consider the ordinary timers. */
3889 timers
= Vtimer_list
;
3890 /* Consider the idle timers only if Emacs is idle. */
3891 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3892 idle_timers
= Vtimer_idle_list
;
3895 chosen_timer
= Qnil
;
3896 GCPRO3 (timers
, idle_timers
, chosen_timer
);
3898 if (CONSP (timers
) || CONSP (idle_timers
))
3900 EMACS_GET_TIME (now
);
3901 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
3902 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
3905 while (CONSP (timers
) || CONSP (idle_timers
))
3907 Lisp_Object
*vector
;
3908 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
3909 EMACS_TIME timer_time
, idle_timer_time
;
3910 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
3912 /* Skip past invalid timers and timers already handled. */
3915 timer
= XCAR (timers
);
3916 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3918 timers
= XCDR (timers
);
3921 vector
= XVECTOR (timer
)->contents
;
3923 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3924 || !INTEGERP (vector
[3])
3925 || ! NILP (vector
[0]))
3927 timers
= XCDR (timers
);
3931 if (!NILP (idle_timers
))
3933 timer
= XCAR (idle_timers
);
3934 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
3936 idle_timers
= XCDR (idle_timers
);
3939 vector
= XVECTOR (timer
)->contents
;
3941 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
3942 || !INTEGERP (vector
[3])
3943 || ! NILP (vector
[0]))
3945 idle_timers
= XCDR (idle_timers
);
3950 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
3951 based on the next ordinary timer.
3952 TIMER_DIFFERENCE is the distance in time from NOW to when
3953 this timer becomes ripe (negative if it's already ripe). */
3956 timer
= XCAR (timers
);
3957 vector
= XVECTOR (timer
)->contents
;
3958 EMACS_SET_SECS (timer_time
,
3959 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3960 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
3961 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
3964 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
3965 based on the next idle timer. */
3966 if (!NILP (idle_timers
))
3968 idle_timer
= XCAR (idle_timers
);
3969 vector
= XVECTOR (idle_timer
)->contents
;
3970 EMACS_SET_SECS (idle_timer_time
,
3971 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
3972 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
3973 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
3976 /* Decide which timer is the next timer,
3977 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
3978 Also step down the list where we found that timer. */
3980 if (! NILP (timers
) && ! NILP (idle_timers
))
3983 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
3984 if (EMACS_TIME_NEG_P (temp
))
3986 chosen_timer
= timer
;
3987 timers
= XCDR (timers
);
3988 difference
= timer_difference
;
3992 chosen_timer
= idle_timer
;
3993 idle_timers
= XCDR (idle_timers
);
3994 difference
= idle_timer_difference
;
3997 else if (! NILP (timers
))
3999 chosen_timer
= timer
;
4000 timers
= XCDR (timers
);
4001 difference
= timer_difference
;
4005 chosen_timer
= idle_timer
;
4006 idle_timers
= XCDR (idle_timers
);
4007 difference
= idle_timer_difference
;
4009 vector
= XVECTOR (chosen_timer
)->contents
;
4011 /* If timer is ripe, run it if it hasn't been run. */
4012 if (EMACS_TIME_NEG_P (difference
)
4013 || (EMACS_SECS (difference
) == 0
4014 && EMACS_USECS (difference
) == 0))
4016 if (NILP (vector
[0]))
4018 int was_locked
= single_kboard
;
4019 int count
= specpdl_ptr
- specpdl
;
4021 /* Mark the timer as triggered to prevent problems if the lisp
4022 code fails to reschedule it right. */
4025 specbind (Qinhibit_quit
, Qt
);
4027 call1 (Qtimer_event_handler
, chosen_timer
);
4030 unbind_to (count
, Qnil
);
4032 /* Resume allowing input from any kboard, if that was true before. */
4034 any_kboard_state ();
4036 /* Since we have handled the event,
4037 we don't need to tell the caller to wake up and do it. */
4041 /* When we encounter a timer that is still waiting,
4042 return the amount of time to wait before it is ripe. */
4049 /* No timers are pending in the future. */
4050 /* Return 0 if we generated an event, and -1 if not. */
4055 /* Caches for modify_event_symbol. */
4056 static Lisp_Object accent_key_syms
;
4057 static Lisp_Object func_key_syms
;
4058 static Lisp_Object mouse_syms
;
4060 static Lisp_Object mouse_wheel_syms
;
4062 static Lisp_Object drag_n_drop_syms
;
4064 /* This is a list of keysym codes for special "accent" characters.
4065 It parallels lispy_accent_keys. */
4067 static int lispy_accent_codes
[] =
4069 #ifdef XK_dead_circumflex
4074 #ifdef XK_dead_grave
4079 #ifdef XK_dead_tilde
4084 #ifdef XK_dead_diaeresis
4089 #ifdef XK_dead_macron
4094 #ifdef XK_dead_degree
4099 #ifdef XK_dead_acute
4104 #ifdef XK_dead_cedilla
4109 #ifdef XK_dead_breve
4114 #ifdef XK_dead_ogonek
4119 #ifdef XK_dead_caron
4124 #ifdef XK_dead_doubleacute
4125 XK_dead_doubleacute
,
4129 #ifdef XK_dead_abovedot
4136 /* This is a list of Lisp names for special "accent" characters.
4137 It parallels lispy_accent_codes. */
4139 static char *lispy_accent_keys
[] =
4157 #define FUNCTION_KEY_OFFSET 0x0
4159 char *lispy_function_keys
[] =
4163 0, /* VK_LBUTTON 0x01 */
4164 0, /* VK_RBUTTON 0x02 */
4165 "cancel", /* VK_CANCEL 0x03 */
4166 0, /* VK_MBUTTON 0x04 */
4168 0, 0, 0, /* 0x05 .. 0x07 */
4170 "backspace", /* VK_BACK 0x08 */
4171 "tab", /* VK_TAB 0x09 */
4173 0, 0, /* 0x0A .. 0x0B */
4175 "clear", /* VK_CLEAR 0x0C */
4176 "return", /* VK_RETURN 0x0D */
4178 0, 0, /* 0x0E .. 0x0F */
4180 0, /* VK_SHIFT 0x10 */
4181 0, /* VK_CONTROL 0x11 */
4182 0, /* VK_MENU 0x12 */
4183 "pause", /* VK_PAUSE 0x13 */
4184 "capslock", /* VK_CAPITAL 0x14 */
4186 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4188 "escape", /* VK_ESCAPE 0x1B */
4190 0, 0, 0, 0, /* 0x1C .. 0x1F */
4192 0, /* VK_SPACE 0x20 */
4193 "prior", /* VK_PRIOR 0x21 */
4194 "next", /* VK_NEXT 0x22 */
4195 "end", /* VK_END 0x23 */
4196 "home", /* VK_HOME 0x24 */
4197 "left", /* VK_LEFT 0x25 */
4198 "up", /* VK_UP 0x26 */
4199 "right", /* VK_RIGHT 0x27 */
4200 "down", /* VK_DOWN 0x28 */
4201 "select", /* VK_SELECT 0x29 */
4202 "print", /* VK_PRINT 0x2A */
4203 "execute", /* VK_EXECUTE 0x2B */
4204 "snapshot", /* VK_SNAPSHOT 0x2C */
4205 "insert", /* VK_INSERT 0x2D */
4206 "delete", /* VK_DELETE 0x2E */
4207 "help", /* VK_HELP 0x2F */
4209 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4211 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4213 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4215 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4217 0, 0, 0, 0, 0, 0, 0, 0, 0,
4218 0, 0, 0, 0, 0, 0, 0, 0, 0,
4219 0, 0, 0, 0, 0, 0, 0, 0,
4221 "lwindow", /* VK_LWIN 0x5B */
4222 "rwindow", /* VK_RWIN 0x5C */
4223 "apps", /* VK_APPS 0x5D */
4225 0, 0, /* 0x5E .. 0x5F */
4227 "kp-0", /* VK_NUMPAD0 0x60 */
4228 "kp-1", /* VK_NUMPAD1 0x61 */
4229 "kp-2", /* VK_NUMPAD2 0x62 */
4230 "kp-3", /* VK_NUMPAD3 0x63 */
4231 "kp-4", /* VK_NUMPAD4 0x64 */
4232 "kp-5", /* VK_NUMPAD5 0x65 */
4233 "kp-6", /* VK_NUMPAD6 0x66 */
4234 "kp-7", /* VK_NUMPAD7 0x67 */
4235 "kp-8", /* VK_NUMPAD8 0x68 */
4236 "kp-9", /* VK_NUMPAD9 0x69 */
4237 "kp-multiply", /* VK_MULTIPLY 0x6A */
4238 "kp-add", /* VK_ADD 0x6B */
4239 "kp-separator", /* VK_SEPARATOR 0x6C */
4240 "kp-subtract", /* VK_SUBTRACT 0x6D */
4241 "kp-decimal", /* VK_DECIMAL 0x6E */
4242 "kp-divide", /* VK_DIVIDE 0x6F */
4243 "f1", /* VK_F1 0x70 */
4244 "f2", /* VK_F2 0x71 */
4245 "f3", /* VK_F3 0x72 */
4246 "f4", /* VK_F4 0x73 */
4247 "f5", /* VK_F5 0x74 */
4248 "f6", /* VK_F6 0x75 */
4249 "f7", /* VK_F7 0x76 */
4250 "f8", /* VK_F8 0x77 */
4251 "f9", /* VK_F9 0x78 */
4252 "f10", /* VK_F10 0x79 */
4253 "f11", /* VK_F11 0x7A */
4254 "f12", /* VK_F12 0x7B */
4255 "f13", /* VK_F13 0x7C */
4256 "f14", /* VK_F14 0x7D */
4257 "f15", /* VK_F15 0x7E */
4258 "f16", /* VK_F16 0x7F */
4259 "f17", /* VK_F17 0x80 */
4260 "f18", /* VK_F18 0x81 */
4261 "f19", /* VK_F19 0x82 */
4262 "f20", /* VK_F20 0x83 */
4263 "f21", /* VK_F21 0x84 */
4264 "f22", /* VK_F22 0x85 */
4265 "f23", /* VK_F23 0x86 */
4266 "f24", /* VK_F24 0x87 */
4268 0, 0, 0, 0, /* 0x88 .. 0x8B */
4269 0, 0, 0, 0, /* 0x8C .. 0x8F */
4271 "kp-numlock", /* VK_NUMLOCK 0x90 */
4272 "scroll", /* VK_SCROLL 0x91 */
4274 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4275 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4276 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4277 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4278 "kp-end", /* VK_NUMPAD_END 0x96 */
4279 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4280 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4281 "kp-up", /* VK_NUMPAD_UP 0x99 */
4282 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4283 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4284 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4285 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4287 0, 0, /* 0x9E .. 0x9F */
4290 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4291 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4292 * No other API or message will distinguish left and right keys this way.
4296 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4297 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4298 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4299 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4300 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4306 "attn", /* VK_ATTN 0xF6 */
4307 "crsel", /* VK_CRSEL 0xF7 */
4308 "exsel", /* VK_EXSEL 0xF8 */
4309 "ereof", /* VK_EREOF 0xF9 */
4310 "play", /* VK_PLAY 0xFA */
4311 "zoom", /* VK_ZOOM 0xFB */
4312 "noname", /* VK_NONAME 0xFC */
4313 "pa1", /* VK_PA1 0xFD */
4314 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4318 #else /* not HAVE_NTGUI */
4321 static char *lispy_kana_keys
[] =
4323 /* X Keysym value */
4324 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4325 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4326 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4327 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4328 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4329 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4330 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4331 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4332 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4333 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4334 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4335 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4336 "kana-i", "kana-u", "kana-e", "kana-o",
4337 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4338 "prolongedsound", "kana-A", "kana-I", "kana-U",
4339 "kana-E", "kana-O", "kana-KA", "kana-KI",
4340 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4341 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4342 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4343 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4344 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4345 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4346 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4347 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4348 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4349 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4350 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4351 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4353 #endif /* XK_kana_A */
4355 #define FUNCTION_KEY_OFFSET 0xff00
4357 /* You'll notice that this table is arranged to be conveniently
4358 indexed by X Windows keysym values. */
4359 static char *lispy_function_keys
[] =
4361 /* X Keysym value */
4363 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4364 "backspace", "tab", "linefeed", "clear",
4366 0, 0, 0, "pause", /* 0xff10...1f */
4367 0, 0, 0, 0, 0, 0, 0, "escape",
4369 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4370 "romaji", "hiragana", "katakana", "hiragana-katakana",
4371 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4372 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4373 "eisu-toggle", /* 0xff30...3f */
4374 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4375 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4377 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4378 "down", "prior", "next", "end",
4379 "begin", 0, 0, 0, 0, 0, 0, 0,
4380 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4391 "break", /* 0xff6b */
4394 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4395 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4396 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4397 0, 0, 0, 0, 0, 0, 0, 0,
4398 "kp-tab", /* 0xff89 */
4400 "kp-enter", /* 0xff8d */
4402 "kp-f1", /* 0xff91 */
4406 "kp-home", /* 0xff95 */
4411 "kp-prior", /* kp-page-up */
4412 "kp-next", /* kp-page-down */
4418 0, 0, 0, 0, 0, 0, 0, 0, 0,
4419 "kp-multiply", /* 0xffaa */
4424 "kp-divide", /* 0xffaf */
4425 "kp-0", /* 0xffb0 */
4426 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4429 "kp-equal", /* 0xffbd */
4430 "f1", /* 0xffbe */ /* IsFunctionKey */
4432 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4433 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4434 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4435 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4436 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4437 0, 0, 0, 0, 0, 0, 0, 0,
4438 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4439 0, 0, 0, 0, 0, 0, 0, "delete"
4442 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4443 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4445 static char *iso_lispy_function_keys
[] =
4447 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4448 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4449 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4450 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4451 "iso-lefttab", /* 0xfe20 */
4452 "iso-move-line-up", "iso-move-line-down",
4453 "iso-partial-line-up", "iso-partial-line-down",
4454 "iso-partial-space-left", "iso-partial-space-right",
4455 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4456 "iso-release-margin-left", "iso-release-margin-right",
4457 "iso-release-both-margins",
4458 "iso-fast-cursor-left", "iso-fast-cursor-right",
4459 "iso-fast-cursor-up", "iso-fast-cursor-down",
4460 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4461 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4464 #endif /* not HAVE_NTGUI */
4466 Lisp_Object Vlispy_mouse_stem
;
4469 /* mouse-wheel events are generated by the wheel on devices such as
4470 the MS Intellimouse. The wheel sits in between the left and right
4471 mouse buttons, and is typically used to scroll or zoom the window
4472 underneath the pointer. mouse-wheel events specify the object on
4473 which they operate, and a delta corresponding to the amount and
4474 direction that the wheel is rotated. Clicking the mouse-wheel
4475 generates a mouse-2 event. */
4476 static char *lispy_mouse_wheel_names
[] =
4481 #endif /* WINDOWSNT */
4483 /* drag-n-drop events are generated when a set of selected files are
4484 dragged from another application and dropped onto an Emacs window. */
4485 static char *lispy_drag_n_drop_names
[] =
4490 /* Scroll bar parts. */
4491 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4492 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4493 Lisp_Object Qtop
, Qratio
;
4495 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4496 Lisp_Object
*scroll_bar_parts
[] = {
4497 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4498 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4501 /* User signal events. */
4502 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4504 Lisp_Object
*lispy_user_signals
[] =
4506 &Qusr1_signal
, &Qusr2_signal
4510 /* A vector, indexed by button number, giving the down-going location
4511 of currently depressed buttons, both scroll bar and non-scroll bar.
4513 The elements have the form
4514 (BUTTON-NUMBER MODIFIER-MASK . REST)
4515 where REST is the cdr of a position as it would be reported in the event.
4517 The make_lispy_event function stores positions here to tell the
4518 difference between click and drag events, and to store the starting
4519 location to be included in drag events. */
4521 static Lisp_Object button_down_location
;
4523 /* Information about the most recent up-going button event: Which
4524 button, what location, and what time. */
4526 static int last_mouse_button
;
4527 static int last_mouse_x
;
4528 static int last_mouse_y
;
4529 static unsigned long button_down_time
;
4531 /* The maximum time between clicks to make a double-click,
4532 or Qnil to disable double-click detection,
4533 or Qt for no time limit. */
4534 Lisp_Object Vdouble_click_time
;
4536 /* The number of clicks in this multiple-click. */
4538 int double_click_count
;
4540 /* Given a struct input_event, build the lisp event which represents
4541 it. If EVENT is 0, build a mouse movement event from the mouse
4542 movement buffer, which should have a movement event in it.
4544 Note that events must be passed to this function in the order they
4545 are received; this function stores the location of button presses
4546 in order to build drag events when the button is released. */
4549 make_lispy_event (event
)
4550 struct input_event
*event
;
4554 switch (SWITCH_ENUM_CAST (event
->kind
))
4556 /* A simple keystroke. */
4557 case ascii_keystroke
:
4559 Lisp_Object lispy_c
;
4560 int c
= event
->code
& 0377;
4561 /* Turn ASCII characters into control characters
4563 if (event
->modifiers
& ctrl_modifier
)
4564 c
= make_ctrl_char (c
);
4566 /* Add in the other modifier bits. We took care of ctrl_modifier
4567 just above, and the shift key was taken care of by the X code,
4568 and applied to control characters by make_ctrl_char. */
4569 c
|= (event
->modifiers
4570 & (meta_modifier
| alt_modifier
4571 | hyper_modifier
| super_modifier
));
4572 /* Distinguish Shift-SPC from SPC. */
4573 if ((event
->code
& 0377) == 040
4574 && event
->modifiers
& shift_modifier
)
4575 c
|= shift_modifier
;
4576 button_down_time
= 0;
4577 XSETFASTINT (lispy_c
, c
);
4581 case multibyte_char_keystroke
:
4583 Lisp_Object lispy_c
;
4585 XSETFASTINT (lispy_c
, event
->code
);
4589 /* A function key. The symbol may need to have modifier prefixes
4591 case non_ascii_keystroke
:
4592 button_down_time
= 0;
4594 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
4595 if (event
->code
== lispy_accent_codes
[i
])
4596 return modify_event_symbol (i
,
4598 Qfunction_key
, Qnil
,
4599 lispy_accent_keys
, &accent_key_syms
,
4600 (sizeof (lispy_accent_keys
)
4601 / sizeof (lispy_accent_keys
[0])));
4603 /* Handle system-specific keysyms. */
4604 if (event
->code
& (1 << 28))
4606 /* We need to use an alist rather than a vector as the cache
4607 since we can't make a vector long enuf. */
4608 if (NILP (current_kboard
->system_key_syms
))
4609 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
4610 return modify_event_symbol (event
->code
,
4613 current_kboard
->Vsystem_key_alist
,
4614 0, ¤t_kboard
->system_key_syms
,
4619 if (event
->code
>= 0x400 && event
->code
< 0x500)
4620 return modify_event_symbol (event
->code
- 0x400,
4621 event
->modifiers
& ~shift_modifier
,
4622 Qfunction_key
, Qnil
,
4623 lispy_kana_keys
, &func_key_syms
,
4624 (sizeof (lispy_kana_keys
)
4625 / sizeof (lispy_kana_keys
[0])));
4626 #endif /* XK_kana_A */
4628 #ifdef ISO_FUNCTION_KEY_OFFSET
4629 if (event
->code
< FUNCTION_KEY_OFFSET
4630 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
4631 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
4633 Qfunction_key
, Qnil
,
4634 iso_lispy_function_keys
, &func_key_syms
,
4635 (sizeof (iso_lispy_function_keys
)
4636 / sizeof (iso_lispy_function_keys
[0])));
4639 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
4641 Qfunction_key
, Qnil
,
4642 lispy_function_keys
, &func_key_syms
,
4643 (sizeof (lispy_function_keys
)
4644 / sizeof (lispy_function_keys
[0])));
4647 /* A mouse click. Figure out where it is, decide whether it's
4648 a press, click or drag, and build the appropriate structure. */
4650 #ifndef USE_TOOLKIT_SCROLL_BARS
4651 case scroll_bar_click
:
4654 int button
= event
->code
;
4656 Lisp_Object position
;
4657 Lisp_Object
*start_pos_ptr
;
4658 Lisp_Object start_pos
;
4662 /* Build the position as appropriate for this mouse click. */
4663 if (event
->kind
== mouse_click
)
4666 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
4669 Lisp_Object string_info
= Qnil
;
4672 /* Ignore mouse events that were made on frame that
4673 have been deleted. */
4674 if (! FRAME_LIVE_P (f
))
4677 /* EVENT->x and EVENT->y are frame-relative pixel
4678 coordinates at this place. Under old redisplay, COLUMN
4679 and ROW are set to frame relative glyph coordinates
4680 which are then used to determine whether this click is
4681 in a menu (non-toolkit version). */
4682 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
4683 &column
, &row
, NULL
, 1);
4685 #ifndef USE_X_TOOLKIT
4686 /* In the non-toolkit version, clicks on the menu bar
4687 are ordinary button events in the event buffer.
4688 Distinguish them, and invoke the menu.
4690 (In the toolkit version, the toolkit handles the menu bar
4691 and Emacs doesn't know about it until after the user
4692 makes a selection.) */
4693 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
4694 && (event
->modifiers
& down_modifier
))
4696 Lisp_Object items
, item
;
4701 /* Activate the menu bar on the down event. If the
4702 up event comes in before the menu code can deal with it,
4704 if (! (event
->modifiers
& down_modifier
))
4708 /* Find the menu bar item under `column'. */
4710 items
= FRAME_MENU_BAR_ITEMS (f
);
4711 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
4713 Lisp_Object pos
, string
;
4714 string
= AREF (items
, i
+ 1);
4715 pos
= AREF (items
, i
+ 3);
4718 if (column
>= XINT (pos
)
4719 && column
< XINT (pos
) + XSTRING (string
)->size
)
4721 item
= AREF (items
, i
);
4726 /* ELisp manual 2.4b says (x y) are window relative but
4727 code says they are frame-relative. */
4729 = Fcons (event
->frame_or_window
,
4731 Fcons (Fcons (event
->x
, event
->y
),
4732 Fcons (make_number (event
->timestamp
),
4735 return Fcons (item
, Fcons (position
, Qnil
));
4737 #endif /* not USE_X_TOOLKIT */
4739 /* Set `window' to the window under frame pixel coordinates
4740 event->x/event->y. */
4741 window
= window_from_coordinates (f
, XINT (event
->x
),
4742 XINT (event
->y
), &part
, 0);
4744 if (!WINDOWP (window
))
4746 window
= event
->frame_or_window
;
4751 /* It's a click in window window at frame coordinates
4752 event->x/ event->y. */
4753 struct window
*w
= XWINDOW (window
);
4755 /* Get window relative coordinates. Original code
4756 `rounded' this to glyph boundaries. */
4757 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
4758 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
4760 /* Set event coordinates to window-relative coordinates
4761 for constructing the Lisp event below. */
4762 XSETINT (event
->x
, wx
);
4763 XSETINT (event
->y
, wy
);
4765 if (part
== 1 || part
== 3)
4767 /* Mode line or header line. Look for a string under
4768 the mouse that may have a `local-map' property. */
4772 posn
= part
== 1 ? Qmode_line
: Qheader_line
;
4773 string
= mode_line_string (w
, wx
, wy
, part
== 1, &charpos
);
4774 if (STRINGP (string
))
4775 string_info
= Fcons (string
, make_number (charpos
));
4778 posn
= Qvertical_line
;
4780 XSETINT (posn
, buffer_posn_from_coords (w
, &wx
, &wy
));
4786 Fcons (Fcons (event
->x
, event
->y
),
4787 Fcons (make_number (event
->timestamp
),
4790 : Fcons (string_info
, Qnil
))))));
4792 #ifndef USE_TOOLKIT_SCROLL_BARS
4795 /* It's a scrollbar click. */
4797 Lisp_Object portion_whole
;
4800 window
= event
->frame_or_window
;
4801 portion_whole
= Fcons (event
->x
, event
->y
);
4802 part
= *scroll_bar_parts
[(int) event
->part
];
4806 Fcons (Qvertical_scroll_bar
,
4807 Fcons (portion_whole
,
4808 Fcons (make_number (event
->timestamp
),
4809 Fcons (part
, Qnil
)))));
4811 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4813 if (button
>= ASIZE (button_down_location
))
4815 button_down_location
= larger_vector (button_down_location
,
4817 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
4820 start_pos_ptr
= &AREF (button_down_location
, button
);
4821 start_pos
= *start_pos_ptr
;
4822 *start_pos_ptr
= Qnil
;
4824 is_double
= (button
== last_mouse_button
4825 && XINT (event
->x
) == last_mouse_x
4826 && XINT (event
->y
) == last_mouse_y
4827 && button_down_time
!= 0
4828 && (EQ (Vdouble_click_time
, Qt
)
4829 || (INTEGERP (Vdouble_click_time
)
4830 && ((int)(event
->timestamp
- button_down_time
)
4831 < XINT (Vdouble_click_time
)))));
4832 last_mouse_button
= button
;
4833 last_mouse_x
= XINT (event
->x
);
4834 last_mouse_y
= XINT (event
->y
);
4836 /* If this is a button press, squirrel away the location, so
4837 we can decide later whether it was a click or a drag. */
4838 if (event
->modifiers
& down_modifier
)
4842 double_click_count
++;
4843 event
->modifiers
|= ((double_click_count
> 2)
4848 double_click_count
= 1;
4849 button_down_time
= event
->timestamp
;
4850 *start_pos_ptr
= Fcopy_alist (position
);
4853 /* Now we're releasing a button - check the co-ordinates to
4854 see if this was a click or a drag. */
4855 else if (event
->modifiers
& up_modifier
)
4857 /* If we did not see a down before this up, ignore the up.
4858 Probably this happened because the down event chose a
4859 menu item. It would be an annoyance to treat the
4860 release of the button that chose the menu item as a
4863 if (!CONSP (start_pos
))
4866 event
->modifiers
&= ~up_modifier
;
4867 #if 0 /* Formerly we treated an up with no down as a click event. */
4868 if (!CONSP (start_pos
))
4869 event
->modifiers
|= click_modifier
;
4873 /* The third element of every position should be the (x,y)
4877 down
= Fnth (make_number (2), start_pos
);
4878 if (EQ (event
->x
, XCAR (down
)) && EQ (event
->y
, XCDR (down
)))
4879 /* Mouse hasn't moved. */
4880 event
->modifiers
|= click_modifier
;
4883 Lisp_Object window1
, window2
, posn1
, posn2
;
4885 /* Avoid generating a drag event if the mouse
4886 hasn't actually moved off the buffer position. */
4887 window1
= Fnth (make_number (0), position
);
4888 posn1
= Fnth (make_number (1), position
);
4889 window2
= Fnth (make_number (0), start_pos
);
4890 posn2
= Fnth (make_number (1), start_pos
);
4892 if (EQ (window1
, window2
) && EQ (posn1
, posn2
))
4893 event
->modifiers
|= click_modifier
;
4896 button_down_time
= 0;
4897 event
->modifiers
|= drag_modifier
;
4901 /* Don't check is_double; treat this as multiple
4902 if the down-event was multiple. */
4903 if (double_click_count
> 1)
4904 event
->modifiers
|= ((double_click_count
> 2)
4910 /* Every mouse event should either have the down_modifier or
4911 the up_modifier set. */
4915 /* Get the symbol we should use for the mouse click. */
4918 head
= modify_event_symbol (button
,
4920 Qmouse_click
, Vlispy_mouse_stem
,
4923 XVECTOR (mouse_syms
)->size
);
4924 if (event
->modifiers
& drag_modifier
)
4929 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
4932 Fcons (make_number (double_click_count
),
4941 #if USE_TOOLKIT_SCROLL_BARS
4943 /* We don't have down and up events if using toolkit scroll bars,
4944 so make this always a click event. Store in the `part' of
4945 the Lisp event a symbol which maps to the following actions:
4947 `above_handle' page up
4948 `below_handle' page down
4952 `bottom' bottom of buffer
4953 `handle' thumb has been dragged.
4954 `end-scroll' end of interaction with scroll bar
4956 The incoming input_event contains in its `part' member an
4957 index of type `enum scroll_bar_part' which we can use as an
4958 index in scroll_bar_parts to get the appropriate symbol. */
4960 case scroll_bar_click
:
4962 Lisp_Object position
, head
, window
, portion_whole
, part
;
4964 window
= event
->frame_or_window
;
4965 portion_whole
= Fcons (event
->x
, event
->y
);
4966 part
= *scroll_bar_parts
[(int) event
->part
];
4970 Fcons (Qvertical_scroll_bar
,
4971 Fcons (portion_whole
,
4972 Fcons (make_number (event
->timestamp
),
4973 Fcons (part
, Qnil
)))));
4975 /* Always treat scroll bar events as clicks. */
4976 event
->modifiers
|= click_modifier
;
4978 /* Get the symbol we should use for the mouse click. */
4979 head
= modify_event_symbol (event
->code
,
4984 XVECTOR (mouse_syms
)->size
);
4985 return Fcons (head
, Fcons (position
, Qnil
));
4988 #endif /* USE_TOOLKIT_SCROLL_BARS */
4991 case w32_scroll_bar_click
:
4993 int button
= event
->code
;
4995 Lisp_Object position
;
4996 Lisp_Object
*start_pos_ptr
;
4997 Lisp_Object start_pos
;
5001 Lisp_Object portion_whole
;
5004 window
= event
->frame_or_window
;
5005 portion_whole
= Fcons (event
->x
, event
->y
);
5006 part
= *scroll_bar_parts
[(int) event
->part
];
5010 Fcons (Qvertical_scroll_bar
,
5011 Fcons (portion_whole
,
5012 Fcons (make_number (event
->timestamp
),
5013 Fcons (part
, Qnil
)))));
5016 /* Always treat W32 scroll bar events as clicks. */
5017 event
->modifiers
|= click_modifier
;
5020 /* Get the symbol we should use for the mouse click. */
5023 head
= modify_event_symbol (button
,
5028 XVECTOR (mouse_syms
)->size
);
5037 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5040 Lisp_Object head
, position
;
5043 /* Ignore mouse events that were made on frame that
5044 have been deleted. */
5045 if (! FRAME_LIVE_P (f
))
5047 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5048 &column
, &row
, NULL
, 1);
5049 window
= window_from_coordinates (f
, XINT (event
->x
),
5050 XINT (event
->y
), &part
, 0);
5052 if (!WINDOWP (window
))
5054 window
= event
->frame_or_window
;
5059 int pixcolumn
, pixrow
;
5060 column
-= XINT (XWINDOW (window
)->left
);
5061 row
-= XINT (XWINDOW (window
)->top
);
5062 glyph_to_pixel_coords (XWINDOW(window
), column
, row
,
5063 &pixcolumn
, &pixrow
);
5064 XSETINT (event
->x
, pixcolumn
);
5065 XSETINT (event
->y
, pixrow
);
5070 posn
= Qvertical_line
;
5072 posn
= Qheader_line
;
5075 buffer_posn_from_coords (XWINDOW (window
),
5080 Lisp_Object head
, position
;
5085 Fcons (Fcons (event
->x
, event
->y
),
5086 Fcons (make_number (event
->timestamp
),
5089 head
= modify_event_symbol (0, event
->modifiers
,
5091 lispy_mouse_wheel_names
,
5092 &mouse_wheel_syms
, 1);
5095 Fcons (make_number (event
->code
),
5099 #endif /* WINDOWSNT */
5109 /* The frame_or_window field should be a cons of the frame in
5110 which the event occurred and a list of the filenames
5112 if (! CONSP (event
->frame_or_window
))
5115 f
= XFRAME (XCAR (event
->frame_or_window
));
5116 files
= XCDR (event
->frame_or_window
);
5118 /* Ignore mouse events that were made on frames that
5119 have been deleted. */
5120 if (! FRAME_LIVE_P (f
))
5123 window
= window_from_coordinates (f
, XINT (event
->x
),
5124 XINT (event
->y
), &part
, 0);
5126 if (!WINDOWP (window
))
5128 window
= XCAR (event
->frame_or_window
);
5133 /* It's an event in window `window' at frame coordinates
5134 event->x/ event->y. */
5135 struct window
*w
= XWINDOW (window
);
5137 /* Get window relative coordinates. */
5138 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
5139 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
5141 /* Set event coordinates to window-relative coordinates
5142 for constructing the Lisp event below. */
5143 XSETINT (event
->x
, wx
);
5144 XSETINT (event
->y
, wy
);
5149 posn
= Qvertical_line
;
5151 posn
= Qheader_line
;
5153 XSETINT (posn
, buffer_posn_from_coords (w
, &wx
, &wy
));
5157 Lisp_Object head
, position
;
5162 Fcons (Fcons (event
->x
, event
->y
),
5163 Fcons (make_number (event
->timestamp
),
5166 head
= modify_event_symbol (0, event
->modifiers
,
5168 lispy_drag_n_drop_names
,
5169 &drag_n_drop_syms
, 1);
5176 #endif /* HAVE_MOUSE */
5178 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
5179 case MENU_BAR_EVENT
:
5180 if (EQ (event
->arg
, event
->frame_or_window
))
5181 /* This is the prefix key. We translate this to
5182 `(menu_bar)' because the code in keyboard.c for menu
5183 events, which we use, relies on this. */
5184 return Fcons (Qmenu_bar
, Qnil
);
5188 case TOOL_BAR_EVENT
:
5189 if (EQ (event
->arg
, event
->frame_or_window
))
5190 /* This is the prefix key. We translate this to
5191 `(tool_bar)' because the code in keyboard.c for menu
5192 events, which we use, relies on this. */
5193 return Fcons (Qtool_bar
, Qnil
);
5194 else if (SYMBOLP (event
->arg
))
5195 return apply_modifiers (event
->modifiers
, event
->arg
);
5198 case USER_SIGNAL_EVENT
:
5199 /* A user signal. */
5200 return *lispy_user_signals
[event
->code
];
5202 /* The 'kind' field of the event is something we don't recognize. */
5211 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5213 Lisp_Object bar_window
;
5214 enum scroll_bar_part part
;
5218 /* Is it a scroll bar movement? */
5219 if (frame
&& ! NILP (bar_window
))
5221 Lisp_Object part_sym
;
5223 part_sym
= *scroll_bar_parts
[(int) part
];
5224 return Fcons (Qscroll_bar_movement
,
5225 (Fcons (Fcons (bar_window
,
5226 Fcons (Qvertical_scroll_bar
,
5227 Fcons (Fcons (x
, y
),
5228 Fcons (make_number (time
),
5234 /* Or is it an ordinary mouse movement? */
5242 /* It's in a frame; which window on that frame? */
5243 window
= window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
, 0);
5247 if (WINDOWP (window
))
5249 struct window
*w
= XWINDOW (window
);
5252 /* Get window relative coordinates. */
5253 wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (x
));
5254 wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (y
));
5261 posn
= Qvertical_line
;
5263 posn
= Qheader_line
;
5265 XSETINT (posn
, buffer_posn_from_coords (w
, &wx
, &wy
));
5267 else if (frame
!= 0)
5269 XSETFRAME (window
, frame
);
5280 return Fcons (Qmouse_movement
,
5281 Fcons (Fcons (window
,
5283 Fcons (Fcons (x
, y
),
5284 Fcons (make_number (time
),
5290 #endif /* HAVE_MOUSE */
5292 /* Construct a switch frame event. */
5294 make_lispy_switch_frame (frame
)
5297 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5300 /* Manipulating modifiers. */
5302 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5304 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5305 SYMBOL's name of the end of the modifiers; the string from this
5306 position is the unmodified symbol name.
5308 This doesn't use any caches. */
5311 parse_modifiers_uncached (symbol
, modifier_end
)
5315 struct Lisp_String
*name
;
5319 CHECK_SYMBOL (symbol
, 1);
5322 name
= XSYMBOL (symbol
)->name
;
5324 for (i
= 0; i
+2 <= STRING_BYTES (name
); )
5326 int this_mod_end
= 0;
5329 /* See if the name continues with a modifier word.
5330 Check that the word appears, but don't check what follows it.
5331 Set this_mod and this_mod_end to record what we find. */
5333 switch (name
->data
[i
])
5335 #define SINGLE_LETTER_MOD(BIT) \
5336 (this_mod_end = i + 1, this_mod = BIT)
5339 SINGLE_LETTER_MOD (alt_modifier
);
5343 SINGLE_LETTER_MOD (ctrl_modifier
);
5347 SINGLE_LETTER_MOD (hyper_modifier
);
5351 SINGLE_LETTER_MOD (meta_modifier
);
5355 SINGLE_LETTER_MOD (shift_modifier
);
5359 SINGLE_LETTER_MOD (super_modifier
);
5362 #undef SINGLE_LETTER_MOD
5365 /* If we found no modifier, stop looking for them. */
5366 if (this_mod_end
== 0)
5369 /* Check there is a dash after the modifier, so that it
5370 really is a modifier. */
5371 if (this_mod_end
>= STRING_BYTES (name
)
5372 || name
->data
[this_mod_end
] != '-')
5375 /* This modifier is real; look for another. */
5376 modifiers
|= this_mod
;
5377 i
= this_mod_end
+ 1;
5380 /* Should we include the `click' modifier? */
5381 if (! (modifiers
& (down_modifier
| drag_modifier
5382 | double_modifier
| triple_modifier
))
5383 && i
+ 7 == STRING_BYTES (name
)
5384 && strncmp (name
->data
+ i
, "mouse-", 6) == 0
5385 && ('0' <= name
->data
[i
+ 6] && name
->data
[i
+ 6] <= '9'))
5386 modifiers
|= click_modifier
;
5394 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5395 prepended to the string BASE[0..BASE_LEN-1].
5396 This doesn't use any caches. */
5398 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5401 int base_len
, base_len_byte
;
5403 /* Since BASE could contain nulls, we can't use intern here; we have
5404 to use Fintern, which expects a genuine Lisp_String, and keeps a
5407 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5413 /* Only the event queue may use the `up' modifier; it should always
5414 be turned into a click or drag event before presented to lisp code. */
5415 if (modifiers
& up_modifier
)
5418 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5419 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5420 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5421 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5422 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5423 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5424 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5425 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5426 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5427 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5428 /* The click modifier is denoted by the absence of other modifiers. */
5432 mod_len
= p
- new_mods
;
5436 Lisp_Object new_name
;
5438 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5439 mod_len
+ base_len_byte
);
5440 bcopy (new_mods
, XSTRING (new_name
)->data
, mod_len
);
5441 bcopy (base
, XSTRING (new_name
)->data
+ mod_len
, base_len_byte
);
5443 return Fintern (new_name
, Qnil
);
5448 static char *modifier_names
[] =
5450 "up", "down", "drag", "click", "double", "triple", 0, 0,
5451 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5452 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5454 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5456 static Lisp_Object modifier_symbols
;
5458 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5460 lispy_modifier_list (modifiers
)
5463 Lisp_Object modifier_list
;
5466 modifier_list
= Qnil
;
5467 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
5468 if (modifiers
& (1<<i
))
5469 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
5472 return modifier_list
;
5476 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
5477 where UNMODIFIED is the unmodified form of SYMBOL,
5478 MASK is the set of modifiers present in SYMBOL's name.
5479 This is similar to parse_modifiers_uncached, but uses the cache in
5480 SYMBOL's Qevent_symbol_element_mask property, and maintains the
5481 Qevent_symbol_elements property. */
5484 parse_modifiers (symbol
)
5487 Lisp_Object elements
;
5489 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
5490 if (CONSP (elements
))
5495 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
5496 Lisp_Object unmodified
;
5499 unmodified
= Fintern (make_string (XSYMBOL (symbol
)->name
->data
+ end
,
5500 STRING_BYTES (XSYMBOL (symbol
)->name
) - end
),
5503 if (modifiers
& ~(((EMACS_INT
)1 << VALBITS
) - 1))
5505 XSETFASTINT (mask
, modifiers
);
5506 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
5508 /* Cache the parsing results on SYMBOL. */
5509 Fput (symbol
, Qevent_symbol_element_mask
,
5511 Fput (symbol
, Qevent_symbol_elements
,
5512 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
5514 /* Since we know that SYMBOL is modifiers applied to unmodified,
5515 it would be nice to put that in unmodified's cache.
5516 But we can't, since we're not sure that parse_modifiers is
5523 /* Apply the modifiers MODIFIERS to the symbol BASE.
5524 BASE must be unmodified.
5526 This is like apply_modifiers_uncached, but uses BASE's
5527 Qmodifier_cache property, if present. It also builds
5528 Qevent_symbol_elements properties, since it has that info anyway.
5530 apply_modifiers copies the value of BASE's Qevent_kind property to
5531 the modified symbol. */
5533 apply_modifiers (modifiers
, base
)
5537 Lisp_Object cache
, index
, entry
, new_symbol
;
5539 /* Mask out upper bits. We don't know where this value's been. */
5540 modifiers
&= ((EMACS_INT
)1 << VALBITS
) - 1;
5542 /* The click modifier never figures into cache indices. */
5543 cache
= Fget (base
, Qmodifier_cache
);
5544 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
5545 entry
= assq_no_quit (index
, cache
);
5548 new_symbol
= XCDR (entry
);
5551 /* We have to create the symbol ourselves. */
5552 new_symbol
= apply_modifiers_uncached (modifiers
,
5553 XSYMBOL (base
)->name
->data
,
5554 XSYMBOL (base
)->name
->size
,
5555 STRING_BYTES (XSYMBOL (base
)->name
));
5557 /* Add the new symbol to the base's cache. */
5558 entry
= Fcons (index
, new_symbol
);
5559 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
5561 /* We have the parsing info now for free, so add it to the caches. */
5562 XSETFASTINT (index
, modifiers
);
5563 Fput (new_symbol
, Qevent_symbol_element_mask
,
5564 Fcons (base
, Fcons (index
, Qnil
)));
5565 Fput (new_symbol
, Qevent_symbol_elements
,
5566 Fcons (base
, lispy_modifier_list (modifiers
)));
5569 /* Make sure this symbol is of the same kind as BASE.
5571 You'd think we could just set this once and for all when we
5572 intern the symbol above, but reorder_modifiers may call us when
5573 BASE's property isn't set right; we can't assume that just
5574 because it has a Qmodifier_cache property it must have its
5575 Qevent_kind set right as well. */
5576 if (NILP (Fget (new_symbol
, Qevent_kind
)))
5580 kind
= Fget (base
, Qevent_kind
);
5582 Fput (new_symbol
, Qevent_kind
, kind
);
5589 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
5590 return a symbol with the modifiers placed in the canonical order.
5591 Canonical order is alphabetical, except for down and drag, which
5592 always come last. The 'click' modifier is never written out.
5594 Fdefine_key calls this to make sure that (for example) C-M-foo
5595 and M-C-foo end up being equivalent in the keymap. */
5598 reorder_modifiers (symbol
)
5601 /* It's hopefully okay to write the code this way, since everything
5602 will soon be in caches, and no consing will be done at all. */
5605 parsed
= parse_modifiers (symbol
);
5606 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
5611 /* For handling events, we often want to produce a symbol whose name
5612 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
5613 to some base, like the name of a function key or mouse button.
5614 modify_event_symbol produces symbols of this sort.
5616 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
5617 is the name of the i'th symbol. TABLE_SIZE is the number of elements
5620 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
5621 into symbol names, or a string specifying a name stem used to
5622 construct a symbol name or the form `STEM-N', where N is the decimal
5623 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
5624 non-nil; otherwise NAME_TABLE is used.
5626 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
5627 persist between calls to modify_event_symbol that it can use to
5628 store a cache of the symbols it's generated for this NAME_TABLE
5629 before. The object stored there may be a vector or an alist.
5631 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
5633 MODIFIERS is a set of modifier bits (as given in struct input_events)
5634 whose prefixes should be applied to the symbol name.
5636 SYMBOL_KIND is the value to be placed in the event_kind property of
5637 the returned symbol.
5639 The symbols we create are supposed to have an
5640 `event-symbol-elements' property, which lists the modifiers present
5641 in the symbol's name. */
5644 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
5645 name_table
, symbol_table
, table_size
)
5648 Lisp_Object symbol_kind
;
5649 Lisp_Object name_alist_or_stem
;
5651 Lisp_Object
*symbol_table
;
5652 unsigned int table_size
;
5655 Lisp_Object symbol_int
;
5657 /* Get rid of the "vendor-specific" bit here. */
5658 XSETINT (symbol_int
, symbol_num
& 0xffffff);
5660 /* Is this a request for a valid symbol? */
5661 if (symbol_num
< 0 || symbol_num
>= table_size
)
5664 if (CONSP (*symbol_table
))
5665 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
5667 /* If *symbol_table doesn't seem to be initialized properly, fix that.
5668 *symbol_table should be a lisp vector TABLE_SIZE elements long,
5669 where the Nth element is the symbol for NAME_TABLE[N], or nil if
5670 we've never used that symbol before. */
5673 if (! VECTORP (*symbol_table
)
5674 || XVECTOR (*symbol_table
)->size
!= table_size
)
5678 XSETFASTINT (size
, table_size
);
5679 *symbol_table
= Fmake_vector (size
, Qnil
);
5682 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
5685 /* Have we already used this symbol before? */
5688 /* No; let's create it. */
5689 if (CONSP (name_alist_or_stem
))
5690 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
5691 else if (STRINGP (name_alist_or_stem
))
5693 int len
= STRING_BYTES (XSTRING (name_alist_or_stem
));
5694 char *buf
= (char *) alloca (len
+ 50);
5695 sprintf (buf
, "%s-%d", XSTRING (name_alist_or_stem
)->data
,
5696 XINT (symbol_int
) + 1);
5697 value
= intern (buf
);
5699 else if (name_table
!= 0 && name_table
[symbol_num
])
5700 value
= intern (name_table
[symbol_num
]);
5702 #ifdef HAVE_WINDOW_SYSTEM
5705 char *name
= x_get_keysym_name (symbol_num
);
5707 value
= intern (name
);
5714 sprintf (buf
, "key-%d", symbol_num
);
5715 value
= intern (buf
);
5718 if (CONSP (*symbol_table
))
5719 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
5721 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
5723 /* Fill in the cache entries for this symbol; this also
5724 builds the Qevent_symbol_elements property, which the user
5726 apply_modifiers (modifiers
& click_modifier
, value
);
5727 Fput (value
, Qevent_kind
, symbol_kind
);
5730 /* Apply modifiers to that symbol. */
5731 return apply_modifiers (modifiers
, value
);
5734 /* Convert a list that represents an event type,
5735 such as (ctrl meta backspace), into the usual representation of that
5736 event type as a number or a symbol. */
5738 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
5739 "Convert the event description list EVENT-DESC to an event type.\n\
5740 EVENT-DESC should contain one base event type (a character or symbol)\n\
5741 and zero or more modifier names (control, meta, hyper, super, shift, alt,\n\
5742 drag, down, double or triple). The base must be last.\n\
5743 The return value is an event type (a character or symbol) which\n\
5744 has the same base event type and all the specified modifiers.")
5746 Lisp_Object event_desc
;
5754 while (CONSP (rest
))
5762 /* Given a symbol, see if it is a modifier name. */
5763 if (SYMBOLP (elt
) && CONSP (rest
))
5764 this = parse_solitary_modifier (elt
);
5768 else if (!NILP (base
))
5769 error ("Two bases given in one event");
5775 /* Let the symbol A refer to the character A. */
5776 if (SYMBOLP (base
) && XSYMBOL (base
)->name
->size
== 1)
5777 XSETINT (base
, XSYMBOL (base
)->name
->data
[0]);
5779 if (INTEGERP (base
))
5781 /* Turn (shift a) into A. */
5782 if ((modifiers
& shift_modifier
) != 0
5783 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
5785 XSETINT (base
, XINT (base
) - ('a' - 'A'));
5786 modifiers
&= ~shift_modifier
;
5789 /* Turn (control a) into C-a. */
5790 if (modifiers
& ctrl_modifier
)
5791 return make_number ((modifiers
& ~ctrl_modifier
)
5792 | make_ctrl_char (XINT (base
)));
5794 return make_number (modifiers
| XINT (base
));
5796 else if (SYMBOLP (base
))
5797 return apply_modifiers (modifiers
, base
);
5800 error ("Invalid base event");
5805 /* Try to recognize SYMBOL as a modifier name.
5806 Return the modifier flag bit, or 0 if not recognized. */
5809 parse_solitary_modifier (symbol
)
5812 struct Lisp_String
*name
= XSYMBOL (symbol
)->name
;
5814 switch (name
->data
[0])
5816 #define SINGLE_LETTER_MOD(BIT) \
5817 if (STRING_BYTES (name) == 1) \
5820 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5821 if (LEN == STRING_BYTES (name) \
5822 && ! strncmp (name->data, NAME, LEN)) \
5826 SINGLE_LETTER_MOD (alt_modifier
);
5830 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
5834 SINGLE_LETTER_MOD (ctrl_modifier
);
5838 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
5839 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
5843 SINGLE_LETTER_MOD (hyper_modifier
);
5847 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
5851 SINGLE_LETTER_MOD (meta_modifier
);
5855 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
5859 SINGLE_LETTER_MOD (shift_modifier
);
5863 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
5864 MULTI_LETTER_MOD (super_modifier
, "super", 5);
5865 SINGLE_LETTER_MOD (super_modifier
);
5869 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5870 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5871 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5875 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5878 #undef SINGLE_LETTER_MOD
5879 #undef MULTI_LETTER_MOD
5885 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
5886 Such a list is not valid as an event,
5887 but it can be a Lucid-style event type list. */
5890 lucid_event_type_list_p (object
)
5895 if (! CONSP (object
))
5898 if (EQ (XCAR (object
), Qhelp_echo
)
5899 || EQ (XCAR (object
), Qvertical_line
)
5900 || EQ (XCAR (object
), Qmode_line
)
5901 || EQ (XCAR (object
), Qheader_line
))
5904 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
5908 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
5915 /* Store into *addr a value nonzero if terminal input chars are available.
5916 Serves the purpose of ioctl (0, FIONREAD, addr)
5917 but works even if FIONREAD does not exist.
5918 (In fact, this may actually read some input.)
5920 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
5923 get_input_pending (addr
, do_timers_now
)
5927 /* First of all, have we already counted some input? */
5928 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
5930 /* If input is being read as it arrives, and we have none, there is none. */
5931 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
5934 /* Try to read some input and see how much we get. */
5936 *addr
= !NILP (Vquit_flag
) || readable_events (do_timers_now
);
5939 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
5942 gobble_input (expected
)
5947 if (interrupt_input
)
5950 mask
= sigblock (sigmask (SIGIO
));
5951 read_avail_input (expected
);
5955 #ifdef POLL_FOR_INPUT
5956 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
5959 mask
= sigblock (sigmask (SIGALRM
));
5960 read_avail_input (expected
);
5966 read_avail_input (expected
);
5970 /* Put a buffer_switch_event in the buffer
5971 so that read_key_sequence will notice the new current buffer. */
5974 record_asynch_buffer_change ()
5976 struct input_event event
;
5979 event
.kind
= buffer_switch_event
;
5980 event
.frame_or_window
= Qnil
;
5984 /* We don't need a buffer-switch event unless Emacs is waiting for input.
5985 The purpose of the event is to make read_key_sequence look up the
5986 keymaps again. If we aren't in read_key_sequence, we don't need one,
5987 and the event could cause trouble by messing up (input-pending-p). */
5988 tem
= Fwaiting_for_user_input_p ();
5992 /* We never need these events if we have no asynchronous subprocesses. */
5996 /* Make sure no interrupt happens while storing the event. */
5998 if (interrupt_input
)
6001 mask
= sigblock (sigmask (SIGIO
));
6002 kbd_buffer_store_event (&event
);
6009 kbd_buffer_store_event (&event
);
6016 /* Read any terminal input already buffered up by the system
6017 into the kbd_buffer, but do not wait.
6019 EXPECTED should be nonzero if the caller knows there is some input.
6021 Except on VMS, all input is read by this function.
6022 If interrupt_input is nonzero, this function MUST be called
6023 only when SIGIO is blocked.
6025 Returns the number of keyboard chars read, or -1 meaning
6026 this is a bad time to try to read input. */
6029 read_avail_input (expected
)
6032 struct input_event buf
[KBD_BUFFER_SIZE
];
6036 if (read_socket_hook
)
6037 /* No need for FIONREAD or fcntl; just say don't wait. */
6038 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
6041 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6042 the kbd_buffer can really hold. That may prevent loss
6043 of characters on some systems when input is stuffed at us. */
6044 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6047 /* Determine how many characters we should *try* to read. */
6050 #else /* not WINDOWSNT */
6052 n_to_read
= dos_keysns ();
6055 #else /* not MSDOS */
6057 /* Find out how much input is available. */
6058 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6059 /* Formerly simply reported no input, but that sometimes led to
6060 a failure of Emacs to terminate.
6061 SIGHUP seems appropriate if we can't reach the terminal. */
6062 /* ??? Is it really right to send the signal just to this process
6063 rather than to the whole process group?
6064 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6065 kill (getpid (), SIGHUP
);
6068 if (n_to_read
> sizeof cbuf
)
6069 n_to_read
= sizeof cbuf
;
6070 #else /* no FIONREAD */
6071 #if defined (USG) || defined (DGUX)
6072 /* Read some input if available, but don't wait. */
6073 n_to_read
= sizeof cbuf
;
6074 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6079 #endif /* not MSDOS */
6080 #endif /* not WINDOWSNT */
6082 /* Now read; for one reason or another, this will not block.
6083 NREAD is set to the number of chars read. */
6087 cbuf
[0] = dos_keyread ();
6090 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6092 /* POSIX infers that processes which are not in the session leader's
6093 process group won't get SIGHUP's at logout time. BSDI adheres to
6094 this part standard and returns -1 from read (0) with errno==EIO
6095 when the control tty is taken away.
6096 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6097 if (nread
== -1 && errno
== EIO
)
6099 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6100 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6101 This looks incorrect, but it isn't, because _BSD causes
6102 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6103 and that causes a value other than 0 when there is no input. */
6109 /* We used to retry the read if it was interrupted.
6110 But this does the wrong thing when O_NDELAY causes
6111 an EAGAIN error. Does anybody know of a situation
6112 where a retry is actually needed? */
6114 nread
< 0 && (errno
== EAGAIN
6128 #if defined (USG) || defined (DGUX)
6129 fcntl (input_fd
, F_SETFL
, 0);
6130 #endif /* USG or DGUX */
6131 #endif /* no FIONREAD */
6132 for (i
= 0; i
< nread
; i
++)
6134 buf
[i
].kind
= ascii_keystroke
;
6135 buf
[i
].modifiers
= 0;
6136 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6137 buf
[i
].modifiers
= meta_modifier
;
6141 buf
[i
].code
= cbuf
[i
];
6142 buf
[i
].frame_or_window
= selected_frame
;
6147 /* Scan the chars for C-g and store them in kbd_buffer. */
6148 for (i
= 0; i
< nread
; i
++)
6150 kbd_buffer_store_event (&buf
[i
]);
6151 /* Don't look at input that follows a C-g too closely.
6152 This reduces lossage due to autorepeat on C-g. */
6153 if (buf
[i
].kind
== ascii_keystroke
6154 && buf
[i
].code
== quit_char
)
6160 #endif /* not VMS */
6162 #ifdef SIGIO /* for entire page */
6163 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6166 input_available_signal (signo
)
6169 /* Must preserve main program's value of errno. */
6170 int old_errno
= errno
;
6172 extern int select_alarmed
;
6175 #if defined (USG) && !defined (POSIX_SIGNALS)
6176 /* USG systems forget handlers when they are used;
6177 must reestablish each time */
6178 signal (signo
, input_available_signal
);
6185 if (input_available_clear_time
)
6186 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6191 nread
= read_avail_input (1);
6192 /* -1 means it's not ok to read the input now.
6193 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6194 0 means there was no keyboard input available. */
6199 select_alarmed
= 1; /* Force the select emulator back to life */
6210 /* Send ourselves a SIGIO.
6212 This function exists so that the UNBLOCK_INPUT macro in
6213 blockinput.h can have some way to take care of input we put off
6214 dealing with, without assuming that every file which uses
6215 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6217 reinvoke_input_signal ()
6220 kill (getpid (), SIGIO
);
6226 /* Return the prompt-string of a sparse keymap.
6227 This is the first element which is a string.
6228 Return nil if there is none. */
6236 register Lisp_Object tem
;
6245 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6246 static void menu_bar_one_keymap
P_ ((Lisp_Object
));
6248 /* These variables hold the vector under construction within
6249 menu_bar_items and its subroutines, and the current index
6250 for storing into that vector. */
6251 static Lisp_Object menu_bar_items_vector
;
6252 static int menu_bar_items_index
;
6254 /* Return a vector of menu items for a menu bar, appropriate
6255 to the current buffer. Each item has three elements in the vector:
6258 OLD is an old vector we can optionally reuse, or nil. */
6261 menu_bar_items (old
)
6264 /* The number of keymaps we're scanning right now, and the number of
6265 keymaps we have allocated space for. */
6268 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6269 in the current keymaps, or nil where it is not a prefix. */
6272 Lisp_Object def
, tail
;
6281 struct gcpro gcpro1
;
6283 /* In order to build the menus, we need to call the keymap
6284 accessors. They all call QUIT. But this function is called
6285 during redisplay, during which a quit is fatal. So inhibit
6286 quitting while building the menus.
6287 We do this instead of specbind because (1) errors will clear it anyway
6288 and (2) this avoids risk of specpdl overflow. */
6289 oquit
= Vinhibit_quit
;
6293 menu_bar_items_vector
= old
;
6295 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6296 menu_bar_items_index
= 0;
6298 GCPRO1 (menu_bar_items_vector
);
6300 /* Build our list of keymaps.
6301 If we recognize a function key and replace its escape sequence in
6302 keybuf with its symbol, or if the sequence starts with a mouse
6303 click and we need to switch buffers, we jump back here to rebuild
6304 the initial keymaps from the current buffer. */
6308 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6309 if (!NILP (Voverriding_local_map_menu_flag
))
6311 /* Yes, use them (if non-nil) as well as the global map. */
6312 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6314 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6315 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6316 if (!NILP (Voverriding_local_map
))
6317 maps
[nmaps
++] = Voverriding_local_map
;
6321 /* No, so use major and minor mode keymaps and keymap property. */
6323 Lisp_Object map
= get_local_map (PT
, current_buffer
, Qkeymap
);
6326 nmaps
= current_minor_maps (NULL
, &tmaps
);
6327 maps
= (Lisp_Object
*) alloca ((nmaps
+ extra_maps
)
6328 * sizeof (maps
[0]));
6329 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
6331 maps
[nmaps
++] = map
;
6332 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6334 maps
[nmaps
++] = current_global_map
;
6337 /* Look up in each map the dummy prefix key `menu-bar'. */
6341 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6342 if (!NILP (maps
[mapno
]))
6344 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6347 menu_bar_one_keymap (def
);
6350 /* Move to the end those items that should be at the end. */
6352 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6355 int end
= menu_bar_items_index
;
6357 for (i
= 0; i
< end
; i
+= 4)
6358 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6360 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6361 /* Move the item at index I to the end,
6362 shifting all the others forward. */
6363 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6364 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6365 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6366 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6368 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6369 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6370 (end
- i
- 4) * sizeof (Lisp_Object
));
6371 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6372 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6373 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6374 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6379 /* Add nil, nil, nil, nil at the end. */
6380 i
= menu_bar_items_index
;
6381 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6384 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6385 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6386 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6387 menu_bar_items_vector
= tem
;
6389 /* Add this item. */
6390 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6391 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6392 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6393 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6394 menu_bar_items_index
= i
;
6396 Vinhibit_quit
= oquit
;
6398 return menu_bar_items_vector
;
6401 /* Scan one map KEYMAP, accumulating any menu items it defines
6402 in menu_bar_items_vector. */
6404 static Lisp_Object menu_bar_one_keymap_changed_items
;
6407 menu_bar_one_keymap (keymap
)
6410 Lisp_Object tail
, item
;
6412 menu_bar_one_keymap_changed_items
= Qnil
;
6414 /* Loop over all keymap entries that have menu strings. */
6415 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
6419 menu_bar_item (XCAR (item
), XCDR (item
));
6420 else if (VECTORP (item
))
6422 /* Loop over the char values represented in the vector. */
6423 int len
= XVECTOR (item
)->size
;
6425 for (c
= 0; c
< len
; c
++)
6427 Lisp_Object character
;
6428 XSETFASTINT (character
, c
);
6429 menu_bar_item (character
, XVECTOR (item
)->contents
[c
]);
6435 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
6436 If there's already an item for KEY, add this DEF to it. */
6438 Lisp_Object item_properties
;
6441 menu_bar_item (key
, item
)
6442 Lisp_Object key
, item
;
6444 struct gcpro gcpro1
;
6448 if (EQ (item
, Qundefined
))
6450 /* If a map has an explicit `undefined' as definition,
6451 discard any previously made menu bar item. */
6453 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6454 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6456 if (menu_bar_items_index
> i
+ 4)
6457 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6458 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6459 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
6460 menu_bar_items_index
-= 4;
6464 /* If this keymap has already contributed to this KEY,
6465 don't contribute to it a second time. */
6466 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
6467 if (!NILP (tem
) || NILP (item
))
6470 menu_bar_one_keymap_changed_items
6471 = Fcons (key
, menu_bar_one_keymap_changed_items
);
6473 /* We add to menu_bar_one_keymap_changed_items before doing the
6474 parse_menu_item, so that if it turns out it wasn't a menu item,
6475 it still correctly hides any further menu item. */
6477 i
= parse_menu_item (item
, 0, 1);
6482 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6484 /* Find any existing item for this KEY. */
6485 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6486 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6489 /* If we did not find this KEY, add it at the end. */
6490 if (i
== menu_bar_items_index
)
6492 /* If vector is too small, get a bigger one. */
6493 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6496 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6497 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6498 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6499 menu_bar_items_vector
= tem
;
6502 /* Add this item. */
6503 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
6504 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
6505 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6506 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
6507 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
6508 menu_bar_items_index
= i
;
6510 /* We did find an item for this KEY. Add ITEM to its list of maps. */
6514 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6515 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (item
, old
);
6519 /* This is used as the handler when calling menu_item_eval_property. */
6521 menu_item_eval_property_1 (arg
)
6524 /* If we got a quit from within the menu computation,
6525 quit all the way out of it. This takes care of C-] in the debugger. */
6526 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
6527 Fsignal (Qquit
, Qnil
);
6532 /* Evaluate an expression and return the result (or nil if something
6533 went wrong). Used to evaluate dynamic parts of menu items. */
6535 menu_item_eval_property (sexpr
)
6538 int count
= specpdl_ptr
- specpdl
;
6540 specbind (Qinhibit_redisplay
, Qt
);
6541 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
6542 menu_item_eval_property_1
);
6543 return unbind_to (count
, val
);
6546 /* This function parses a menu item and leaves the result in the
6547 vector item_properties.
6548 ITEM is a key binding, a possible menu item.
6549 If NOTREAL is nonzero, only check for equivalent key bindings, don't
6550 evaluate dynamic expressions in the menu item.
6551 INMENUBAR is > 0 when this is considered for an entry in a menu bar
6553 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
6554 parse_menu_item returns true if the item is a menu item and false
6558 parse_menu_item (item
, notreal
, inmenubar
)
6560 int notreal
, inmenubar
;
6562 Lisp_Object def
, tem
, item_string
, start
;
6563 Lisp_Object cachelist
;
6565 Lisp_Object keyhint
;
6576 /* Create item_properties vector if necessary. */
6577 if (NILP (item_properties
))
6579 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
6581 /* Initialize optional entries. */
6582 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
6583 AREF (item_properties
, i
) = Qnil
;
6584 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
6586 /* Save the item here to protect it from GC. */
6587 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
6589 item_string
= XCAR (item
);
6593 if (STRINGP (item_string
))
6595 /* Old format menu item. */
6596 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
6598 /* Maybe help string. */
6599 if (CONSP (item
) && STRINGP (XCAR (item
)))
6601 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
6606 /* Maybe key binding cache. */
6607 if (CONSP (item
) && CONSP (XCAR (item
))
6608 && (NILP (XCAR (XCAR (item
)))
6609 || VECTORP (XCAR (XCAR (item
)))))
6611 cachelist
= XCAR (item
);
6615 /* This is the real definition--the function to run. */
6616 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
6618 /* Get enable property, if any. */
6621 tem
= Fget (item
, Qmenu_enable
);
6623 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
6626 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
6628 /* New format menu item. */
6629 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
6630 start
= XCDR (item
);
6633 /* We have a real binding. */
6634 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
6636 item
= XCDR (start
);
6637 /* Is there a cache list with key equivalences. */
6638 if (CONSP (item
) && CONSP (XCAR (item
)))
6640 cachelist
= XCAR (item
);
6644 /* Parse properties. */
6645 while (CONSP (item
) && CONSP (XCDR (item
)))
6650 if (EQ (tem
, QCenable
))
6651 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
6652 else if (EQ (tem
, QCvisible
) && !notreal
)
6654 /* If got a visible property and that evaluates to nil
6655 then ignore this item. */
6656 tem
= menu_item_eval_property (XCAR (item
));
6660 else if (EQ (tem
, QChelp
))
6661 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
6662 else if (EQ (tem
, QCfilter
))
6664 else if (EQ (tem
, QCkey_sequence
))
6667 if (NILP (cachelist
)
6668 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
6669 /* Be GC protected. Set keyhint to item instead of tem. */
6672 else if (EQ (tem
, QCkeys
))
6675 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
6676 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
6678 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
6683 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
6685 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
6687 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
6694 else if (inmenubar
|| !NILP (start
))
6698 return 0; /* not a menu item */
6700 /* If item string is not a string, evaluate it to get string.
6701 If we don't get a string, skip this item. */
6702 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
6703 if (!(STRINGP (item_string
) || notreal
))
6705 item_string
= menu_item_eval_property (item_string
);
6706 if (!STRINGP (item_string
))
6708 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
6711 /* If got a filter apply it on definition. */
6712 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
6715 def
= menu_item_eval_property (list2 (XCAR (filter
),
6716 list2 (Qquote
, def
)));
6718 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
6721 /* If we got no definition, this item is just unselectable text which
6722 is OK in a submenu but not in the menubar. */
6724 return (inmenubar
? 0 : 1);
6726 /* Enable or disable selection of item. */
6727 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
6733 tem
= menu_item_eval_property (tem
);
6734 if (inmenubar
&& NILP (tem
))
6735 return 0; /* Ignore disabled items in menu bar. */
6736 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
6739 /* See if this is a separate pane or a submenu. */
6740 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
6741 tem
= get_keymap (def
, 0, 1);
6742 /* For a subkeymap, just record its details and exit. */
6745 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
6746 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
6750 /* At the top level in the menu bar, do likewise for commands also.
6751 The menu bar does not display equivalent key bindings anyway.
6752 ITEM_PROPERTY_DEF is already set up properly. */
6756 /* This is a command. See if there is an equivalent key binding. */
6757 if (NILP (cachelist
))
6759 /* We have to create a cachelist. */
6760 CHECK_IMPURE (start
);
6761 XCDR (start
) = Fcons (Fcons (Qnil
, Qnil
), XCDR (start
));
6762 cachelist
= XCAR (XCDR (start
));
6764 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
6765 if (!NILP (keyhint
))
6767 XCAR (cachelist
) = XCAR (keyhint
);
6770 else if (STRINGP (tem
))
6772 XCDR (cachelist
) = Fsubstitute_command_keys (tem
);
6773 XCAR (cachelist
) = Qt
;
6777 tem
= XCAR (cachelist
);
6784 tem
= Fkey_binding (tem
, Qnil
);
6786 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
6789 def
= XCAR (prefix
);
6790 prefix
= XCDR (prefix
);
6793 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
6795 if (!update_menu_bindings
)
6797 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
6799 if (newcache
/* Always check first time. */
6800 /* Should we check everything when precomputing key
6802 /* If something had no key binding before, don't recheck it
6803 because that is too slow--except if we have a list of
6804 rebound commands in Vdefine_key_rebound_commands, do
6805 recheck any command that appears in that list. */
6806 || (CONSP (Vdefine_key_rebound_commands
)
6807 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
6810 /* We had a saved key. Is it still bound to the command? */
6813 /* If the command is an alias for another
6814 (such as lmenu.el set it up), check if the
6815 original command matches the cached command. */
6816 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
6817 chkcache
= 1; /* Need to recompute key binding. */
6821 /* Recompute equivalent key binding. If the command is an alias
6822 for another (such as lmenu.el set it up), see if the original
6823 command name has equivalent keys. Otherwise look up the
6824 specified command itself. We don't try both, because that
6825 makes lmenu menus slow. */
6827 && SYMBOLP (XSYMBOL (def
)->function
)
6828 && ! NILP (Fget (def
, Qmenu_alias
)))
6829 def
= XSYMBOL (def
)->function
;
6830 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
);
6831 XCAR (cachelist
) = tem
;
6834 XCDR (cachelist
) = Qnil
;
6838 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
6840 tem
= XCAR (cachelist
);
6844 newcache
= chkcache
;
6847 tem
= Fkey_description (tem
);
6850 if (STRINGP (XCAR (prefix
)))
6851 tem
= concat2 (XCAR (prefix
), tem
);
6852 if (STRINGP (XCDR (prefix
)))
6853 tem
= concat2 (tem
, XCDR (prefix
));
6855 XCDR (cachelist
) = tem
;
6859 tem
= XCDR (cachelist
);
6860 if (newcache
&& !NILP (tem
))
6862 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
6863 XCDR (cachelist
) = tem
;
6866 /* If we only want to precompute equivalent key bindings, stop here. */
6870 /* If we have an equivalent key binding, use that. */
6871 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
6873 /* Include this when menu help is implemented.
6874 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
6875 if (!(NILP (tem) || STRINGP (tem)))
6877 tem = menu_item_eval_property (tem);
6880 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
6884 /* Handle radio buttons or toggle boxes. */
6885 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
6887 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
6888 = menu_item_eval_property (tem
);
6895 /***********************************************************************
6897 ***********************************************************************/
6899 /* A vector holding tool bar items while they are parsed in function
6900 tool_bar_items runs Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
6903 static Lisp_Object tool_bar_items_vector
;
6905 /* A vector holding the result of parse_tool_bar_item. Layout is like
6906 the one for a single item in tool_bar_items_vector. */
6908 static Lisp_Object tool_bar_item_properties
;
6910 /* Next free index in tool_bar_items_vector. */
6912 static int ntool_bar_items
;
6914 /* The symbols `tool-bar', and `:image'. */
6916 extern Lisp_Object Qtool_bar
;
6917 Lisp_Object QCimage
;
6919 /* Function prototypes. */
6921 static void init_tool_bar_items
P_ ((Lisp_Object
));
6922 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6923 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6924 static void append_tool_bar_item
P_ ((void));
6927 /* Return a vector of tool bar items for keymaps currently in effect.
6928 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
6929 tool bar items found. */
6932 tool_bar_items (reuse
, nitems
)
6940 extern Lisp_Object Voverriding_local_map_menu_flag
;
6941 extern Lisp_Object Voverriding_local_map
;
6945 /* In order to build the menus, we need to call the keymap
6946 accessors. They all call QUIT. But this function is called
6947 during redisplay, during which a quit is fatal. So inhibit
6948 quitting while building the menus. We do this instead of
6949 specbind because (1) errors will clear it anyway and (2) this
6950 avoids risk of specpdl overflow. */
6951 oquit
= Vinhibit_quit
;
6954 /* Initialize tool_bar_items_vector and protect it from GC. */
6955 init_tool_bar_items (reuse
);
6957 /* Build list of keymaps in maps. Set nmaps to the number of maps
6960 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6961 if (!NILP (Voverriding_local_map_menu_flag
))
6963 /* Yes, use them (if non-nil) as well as the global map. */
6964 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6966 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6967 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6968 if (!NILP (Voverriding_local_map
))
6969 maps
[nmaps
++] = Voverriding_local_map
;
6973 /* No, so use major and minor mode keymaps and keymap property. */
6975 Lisp_Object map
= get_local_map (PT
, current_buffer
, Qkeymap
);
6978 nmaps
= current_minor_maps (NULL
, &tmaps
);
6979 maps
= (Lisp_Object
*) alloca ((nmaps
+ extra_maps
)
6980 * sizeof (maps
[0]));
6981 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
6983 maps
[nmaps
++] = map
;
6984 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6987 /* Add global keymap at the end. */
6988 maps
[nmaps
++] = current_global_map
;
6990 /* Process maps in reverse order and look up in each map the prefix
6992 for (i
= nmaps
- 1; i
>= 0; --i
)
6993 if (!NILP (maps
[i
]))
6997 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7002 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7003 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7005 Lisp_Object keydef
= XCAR (tail
);
7007 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7012 Vinhibit_quit
= oquit
;
7013 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7014 return tool_bar_items_vector
;
7018 /* Process the definition of KEY which is DEF. */
7021 process_tool_bar_item (key
, def
)
7022 Lisp_Object key
, def
;
7025 extern Lisp_Object Qundefined
;
7026 struct gcpro gcpro1
, gcpro2
;
7028 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7032 if (EQ (def
, Qundefined
))
7034 /* If a map has an explicit `undefined' as definition,
7035 discard any previously made item. */
7036 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7038 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7040 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7042 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7043 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7044 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7045 * sizeof (Lisp_Object
)));
7046 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7051 else if (parse_tool_bar_item (key
, def
))
7052 /* Append a new tool bar item to tool_bar_items_vector. Accept
7053 more than one definition for the same key. */
7054 append_tool_bar_item ();
7060 /* Parse a tool bar item specification ITEM for key KEY and return the
7061 result in tool_bar_item_properties. Value is zero if ITEM is
7064 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7066 CAPTION is the caption of the item, If it's not a string, it is
7067 evaluated to get a string.
7069 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7070 as binding are currently ignored.
7072 The following properties are recognized:
7076 FORM is evaluated and specifies whether the tool bar item is
7077 enabled or disabled.
7081 FORM is evaluated and specifies whether the tool bar item is visible.
7083 - `:filter FUNCTION'
7085 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7086 result is stored as the new binding.
7088 - `:button (TYPE SELECTED)'
7090 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7091 and specifies whether the button is selected (pressed) or not.
7095 IMAGES is either a single image specification or a vector of four
7096 image specifications. See enum tool_bar_item_images.
7098 - `:help HELP-STRING'.
7100 Gives a help string to display for the tool bar item. */
7103 parse_tool_bar_item (key
, item
)
7104 Lisp_Object key
, item
;
7106 /* Access slot with index IDX of vector tool_bar_item_properties. */
7107 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7109 Lisp_Object filter
= Qnil
;
7110 Lisp_Object caption
;
7111 extern Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
;
7112 extern Lisp_Object QCbutton
, QCtoggle
, QCradio
;
7115 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7116 Rule out items that aren't lists, don't start with
7117 `menu-item' or whose rest following `tool-bar-item' is not a
7120 || !EQ (XCAR (item
), Qmenu_item
)
7121 || (item
= XCDR (item
),
7125 /* Create tool_bar_item_properties vector if necessary. Reset it to
7127 if (VECTORP (tool_bar_item_properties
))
7129 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7133 tool_bar_item_properties
7134 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7137 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7138 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7140 /* Get the caption of the item. If the caption is not a string,
7141 evaluate it to get a string. If we don't get a string, skip this
7143 caption
= XCAR (item
);
7144 if (!STRINGP (caption
))
7146 caption
= menu_item_eval_property (caption
);
7147 if (!STRINGP (caption
))
7150 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7152 /* Give up if rest following the caption is not a list. */
7157 /* Store the binding. */
7158 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7161 /* Ignore cached key binding, if any. */
7162 if (CONSP (item
) && CONSP (XCAR (item
)))
7165 /* Process the rest of the properties. */
7166 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7168 Lisp_Object key
, value
;
7171 value
= XCAR (XCDR (item
));
7173 if (EQ (key
, QCenable
))
7174 /* `:enable FORM'. */
7175 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7176 else if (EQ (key
, QCvisible
))
7178 /* `:visible FORM'. If got a visible property and that
7179 evaluates to nil then ignore this item. */
7180 if (NILP (menu_item_eval_property (value
)))
7183 else if (EQ (key
, QChelp
))
7184 /* `:help HELP-STRING'. */
7185 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7186 else if (EQ (key
, QCfilter
))
7187 /* ':filter FORM'. */
7189 else if (EQ (key
, QCbutton
) && CONSP (value
))
7191 /* `:button (TYPE . SELECTED)'. */
7192 Lisp_Object type
, selected
;
7194 type
= XCAR (value
);
7195 selected
= XCDR (value
);
7196 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7198 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7199 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7202 else if (EQ (key
, QCimage
)
7204 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7205 /* Value is either a single image specification or a vector
7206 of 4 such specifications for the different buttion states. */
7207 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7210 /* If got a filter apply it on binding. */
7212 PROP (TOOL_BAR_ITEM_BINDING
)
7213 = menu_item_eval_property (list2 (filter
,
7215 PROP (TOOL_BAR_ITEM_BINDING
))));
7217 /* See if the binding is a keymap. Give up if it is. */
7218 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7221 /* Enable or disable selection of item. */
7222 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7223 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7224 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7226 /* Handle radio buttons or toggle boxes. */
7227 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7228 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7229 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7237 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7238 that can be reused. */
7241 init_tool_bar_items (reuse
)
7244 if (VECTORP (reuse
))
7245 tool_bar_items_vector
= reuse
;
7247 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7248 ntool_bar_items
= 0;
7252 /* Append parsed tool bar item properties from
7253 tool_bar_item_properties */
7256 append_tool_bar_item ()
7258 Lisp_Object
*to
, *from
;
7260 /* Enlarge tool_bar_items_vector if necessary. */
7261 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7262 >= XVECTOR (tool_bar_items_vector
)->size
)
7264 Lisp_Object new_vector
;
7265 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7267 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7268 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7269 XVECTOR (new_vector
)->contents
,
7270 old_size
* sizeof (Lisp_Object
));
7271 tool_bar_items_vector
= new_vector
;
7274 /* Append entries from tool_bar_item_properties to the end of
7275 tool_bar_items_vector. */
7276 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7277 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7278 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7279 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7286 /* Read a character using menus based on maps in the array MAPS.
7287 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7288 Return t if we displayed a menu but the user rejected it.
7290 PREV_EVENT is the previous input event, or nil if we are reading
7291 the first event of a key sequence.
7293 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7294 if we used a mouse menu to read the input, or zero otherwise. If
7295 USED_MOUSE_MENU is null, we don't dereference it.
7297 The prompting is done based on the prompt-string of the map
7298 and the strings associated with various map elements.
7300 This can be done with X menus or with menus put in the minibuf.
7301 These are done in different ways, depending on how the input will be read.
7302 Menus using X are done after auto-saving in read-char, getting the input
7303 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7304 and do auto-saving in the inner call of read_char. */
7307 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7310 Lisp_Object prev_event
;
7311 int *used_mouse_menu
;
7314 register Lisp_Object name
;
7316 if (used_mouse_menu
)
7317 *used_mouse_menu
= 0;
7319 /* Use local over global Menu maps */
7321 if (! menu_prompting
)
7324 /* Optionally disregard all but the global map. */
7325 if (inhibit_local_menu_bar_menus
)
7327 maps
+= (nmaps
- 1);
7331 /* Get the menu name from the first map that has one (a prompt string). */
7332 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7334 name
= map_prompt (maps
[mapno
]);
7339 /* If we don't have any menus, just read a character normally. */
7344 /* If we got to this point via a mouse click,
7345 use a real menu for mouse selection. */
7346 if (EVENT_HAS_PARAMETERS (prev_event
)
7347 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7348 && !EQ (XCAR (prev_event
), Qtool_bar
))
7350 /* Display the menu and get the selection. */
7351 Lisp_Object
*realmaps
7352 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7356 /* Use the maps that are not nil. */
7357 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7358 if (!NILP (maps
[mapno
]))
7359 realmaps
[nmaps1
++] = maps
[mapno
];
7361 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7366 record_menu_key (XCAR (value
));
7368 /* If we got multiple events, unread all but
7370 There is no way to prevent those unread events
7371 from showing up later in last_nonmenu_event.
7372 So turn symbol and integer events into lists,
7373 to indicate that they came from a mouse menu,
7374 so that when present in last_nonmenu_event
7375 they won't confuse things. */
7376 for (tem
= XCDR (value
); !NILP (tem
);
7379 record_menu_key (XCAR (tem
));
7380 if (SYMBOLP (XCAR (tem
))
7381 || INTEGERP (XCAR (tem
)))
7383 = Fcons (XCAR (tem
), Qnil
);
7386 /* If we got more than one event, put all but the first
7387 onto this list to be read later.
7388 Return just the first event now. */
7389 Vunread_command_events
7390 = nconc2 (XCDR (value
), Vunread_command_events
);
7391 value
= XCAR (value
);
7393 else if (NILP (value
))
7395 if (used_mouse_menu
)
7396 *used_mouse_menu
= 1;
7399 #endif /* HAVE_MENUS */
7403 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7404 We make this bigger when necessary, and never free it. */
7405 static char *read_char_minibuf_menu_text
;
7406 /* Size of that buffer. */
7407 static int read_char_minibuf_menu_width
;
7410 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7416 register Lisp_Object name
;
7418 int width
= FRAME_WIDTH (SELECTED_FRAME ()) - 4;
7421 Lisp_Object rest
, vector
;
7426 if (! menu_prompting
)
7429 /* Make sure we have a big enough buffer for the menu text. */
7430 if (read_char_minibuf_menu_text
== 0)
7432 read_char_minibuf_menu_width
= width
+ 4;
7433 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
7435 else if (width
+ 4 > read_char_minibuf_menu_width
)
7437 read_char_minibuf_menu_width
= width
+ 4;
7438 read_char_minibuf_menu_text
7439 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
7441 menu
= read_char_minibuf_menu_text
;
7443 /* Get the menu name from the first map that has one (a prompt string). */
7444 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7446 name
= map_prompt (maps
[mapno
]);
7451 /* If we don't have any menus, just read a character normally. */
7455 /* Prompt string always starts with map's prompt, and a space. */
7456 strcpy (menu
, XSTRING (name
)->data
);
7457 nlength
= STRING_BYTES (XSTRING (name
));
7458 menu
[nlength
++] = ':';
7459 menu
[nlength
++] = ' ';
7462 /* Start prompting at start of first map. */
7466 /* Present the documented bindings, a line at a time. */
7473 Lisp_Object orig_defn_macro
;
7475 /* Loop over elements of map. */
7480 /* If reached end of map, start at beginning of next map. */
7484 /* At end of last map, wrap around to first map if just starting,
7485 or end this line if already have something on it. */
7489 if (notfirst
|| nobindings
) break;
7494 /* Look at the next element of the map. */
7496 elt
= XVECTOR (vector
)->contents
[idx
];
7498 elt
= Fcar_safe (rest
);
7500 if (idx
< 0 && VECTORP (elt
))
7502 /* If we found a dense table in the keymap,
7503 advanced past it, but start scanning its contents. */
7504 rest
= Fcdr_safe (rest
);
7510 /* An ordinary element. */
7511 Lisp_Object event
, tem
;
7515 event
= Fcar_safe (elt
); /* alist */
7516 elt
= Fcdr_safe (elt
);
7520 XSETINT (event
, idx
); /* vector */
7523 /* Ignore the element if it has no prompt string. */
7524 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
7526 /* 1 if the char to type matches the string. */
7528 Lisp_Object upcased_event
, downcased_event
;
7529 Lisp_Object desc
= Qnil
;
7531 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7533 upcased_event
= Fupcase (event
);
7534 downcased_event
= Fdowncase (event
);
7535 char_matches
= (XINT (upcased_event
) == XSTRING (s
)->data
[0]
7536 || XINT (downcased_event
) == XSTRING (s
)->data
[0]);
7538 desc
= Fsingle_key_description (event
, Qnil
);
7541 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
7543 /* Insert equivalent keybinding. */
7544 s
= concat2 (s
, tem
);
7547 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
7548 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
7550 /* Insert button prefix. */
7551 Lisp_Object selected
7552 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
7553 if (EQ (tem
, QCradio
))
7554 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
7556 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
7557 s
= concat2 (tem
, s
);
7561 /* If we have room for the prompt string, add it to this line.
7562 If this is the first on the line, always add it. */
7563 if ((XSTRING (s
)->size
+ i
+ 2
7564 + (char_matches
? 0 : XSTRING (desc
)->size
+ 3))
7570 /* Punctuate between strings. */
7573 strcpy (menu
+ i
, ", ");
7579 /* If the char to type doesn't match the string's
7580 first char, explicitly show what char to type. */
7583 /* Add as much of string as fits. */
7584 thiswidth
= XSTRING (desc
)->size
;
7585 if (thiswidth
+ i
> width
)
7586 thiswidth
= width
- i
;
7587 bcopy (XSTRING (desc
)->data
, menu
+ i
, thiswidth
);
7589 strcpy (menu
+ i
, " = ");
7593 /* Add as much of string as fits. */
7594 thiswidth
= XSTRING (s
)->size
;
7595 if (thiswidth
+ i
> width
)
7596 thiswidth
= width
- i
;
7597 bcopy (XSTRING (s
)->data
, menu
+ i
, thiswidth
);
7603 /* If this element does not fit, end the line now,
7604 and save the element for the next line. */
7605 strcpy (menu
+ i
, "...");
7610 /* Move past this element. */
7611 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
7612 /* Handle reaching end of dense table. */
7617 rest
= Fcdr_safe (rest
);
7621 /* Prompt with that and read response. */
7622 message2_nolog (menu
, strlen (menu
),
7623 ! NILP (current_buffer
->enable_multibyte_characters
));
7625 /* Make believe its not a keyboard macro in case the help char
7626 is pressed. Help characters are not recorded because menu prompting
7627 is not used on replay.
7629 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
7630 current_kboard
->defining_kbd_macro
= Qnil
;
7632 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
7633 while (BUFFERP (obj
));
7634 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
7636 if (!INTEGERP (obj
))
7641 if (! EQ (obj
, menu_prompt_more_char
)
7642 && (!INTEGERP (menu_prompt_more_char
)
7643 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
7645 if (!NILP (current_kboard
->defining_kbd_macro
))
7646 store_kbd_macro_char (obj
);
7649 /* Help char - go round again */
7653 /* Reading key sequences. */
7655 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
7656 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
7657 keymap, or nil otherwise. Return the index of the first keymap in
7658 which KEY has any binding, or NMAPS if no map has a binding.
7660 If KEY is a meta ASCII character, treat it like meta-prefix-char
7661 followed by the corresponding non-meta character. Keymaps in
7662 CURRENT with non-prefix bindings for meta-prefix-char become nil in
7665 If KEY has no bindings in any of the CURRENT maps, NEXT is left
7668 NEXT may be the same array as CURRENT. */
7671 follow_key (key
, nmaps
, current
, defs
, next
)
7673 Lisp_Object
*current
, *defs
, *next
;
7676 int i
, first_binding
;
7679 first_binding
= nmaps
;
7680 for (i
= nmaps
- 1; i
>= 0; i
--)
7682 if (! NILP (current
[i
]))
7690 defs
[i
] = access_keymap (map
, key
, 1, 0, 1);
7691 if (! NILP (defs
[i
]))
7698 /* Given the set of bindings we've found, produce the next set of maps. */
7699 if (first_binding
< nmaps
)
7700 for (i
= 0; i
< nmaps
; i
++)
7701 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
7703 return first_binding
;
7706 /* Read a sequence of keys that ends with a non prefix character,
7707 storing it in KEYBUF, a buffer of size BUFSIZE.
7709 Return the length of the key sequence stored.
7710 Return -1 if the user rejected a command menu.
7712 Echo starting immediately unless `prompt' is 0.
7714 Where a key sequence ends depends on the currently active keymaps.
7715 These include any minor mode keymaps active in the current buffer,
7716 the current buffer's local map, and the global map.
7718 If a key sequence has no other bindings, we check Vfunction_key_map
7719 to see if some trailing subsequence might be the beginning of a
7720 function key's sequence. If so, we try to read the whole function
7721 key, and substitute its symbolic name into the key sequence.
7723 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
7724 `double-' events into similar click events, if that would make them
7725 bound. We try to turn `triple-' events first into `double-' events,
7728 If we get a mouse click in a mode line, vertical divider, or other
7729 non-text area, we treat the click as if it were prefixed by the
7730 symbol denoting that area - `mode-line', `vertical-line', or
7733 If the sequence starts with a mouse click, we read the key sequence
7734 with respect to the buffer clicked on, not the current buffer.
7736 If the user switches frames in the midst of a key sequence, we put
7737 off the switch-frame event until later; the next call to
7738 read_char will return it.
7740 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
7741 from the selected window's buffer. */
7744 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
7745 can_return_switch_frame
, fix_current_buffer
)
7746 Lisp_Object
*keybuf
;
7749 int dont_downcase_last
;
7750 int can_return_switch_frame
;
7751 int fix_current_buffer
;
7753 volatile int count
= specpdl_ptr
- specpdl
;
7755 /* How many keys there are in the current key sequence. */
7758 /* The length of the echo buffer when we started reading, and
7759 the length of this_command_keys when we started reading. */
7760 volatile int echo_start
;
7761 volatile int keys_start
;
7763 /* The number of keymaps we're scanning right now, and the number of
7764 keymaps we have allocated space for. */
7766 volatile int nmaps_allocated
= 0;
7768 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
7769 the current keymaps. */
7770 Lisp_Object
*volatile defs
= NULL
;
7772 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7773 in the current keymaps, or nil where it is not a prefix. */
7774 Lisp_Object
*volatile submaps
= NULL
;
7776 /* The local map to start out with at start of key sequence. */
7777 volatile Lisp_Object orig_local_map
;
7779 /* The map from the `keymap' property to start out with at start of
7781 volatile Lisp_Object orig_keymap
;
7783 /* 1 if we have already considered switching to the local-map property
7784 of the place where a mouse click occurred. */
7785 volatile int localized_local_map
= 0;
7787 /* The index in defs[] of the first keymap that has a binding for
7788 this key sequence. In other words, the lowest i such that
7789 defs[i] is non-nil. */
7790 volatile int first_binding
;
7792 /* If t < mock_input, then KEYBUF[t] should be read as the next
7795 We use this to recover after recognizing a function key. Once we
7796 realize that a suffix of the current key sequence is actually a
7797 function key's escape sequence, we replace the suffix with the
7798 function key's binding from Vfunction_key_map. Now keybuf
7799 contains a new and different key sequence, so the echo area,
7800 this_command_keys, and the submaps and defs arrays are wrong. In
7801 this situation, we set mock_input to t, set t to 0, and jump to
7802 restart_sequence; the loop will read keys from keybuf up until
7803 mock_input, thus rebuilding the state; and then it will resume
7804 reading characters from the keyboard. */
7805 volatile int mock_input
= 0;
7807 /* If the sequence is unbound in submaps[], then
7808 keybuf[fkey_start..fkey_end-1] is a prefix in Vfunction_key_map,
7809 and fkey_map is its binding.
7811 These might be > t, indicating that all function key scanning
7812 should hold off until t reaches them. We do this when we've just
7813 recognized a function key, to avoid searching for the function
7814 key's again in Vfunction_key_map. */
7815 volatile int fkey_start
= 0, fkey_end
= 0;
7816 volatile Lisp_Object fkey_map
;
7818 /* Likewise, for key_translation_map. */
7819 volatile int keytran_start
= 0, keytran_end
= 0;
7820 volatile Lisp_Object keytran_map
;
7822 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
7823 we put it off for later. While we're reading, we keep the event here. */
7824 volatile Lisp_Object delayed_switch_frame
;
7826 /* See the comment below... */
7827 #if defined (GOBBLE_FIRST_EVENT)
7828 Lisp_Object first_event
;
7831 volatile Lisp_Object original_uppercase
;
7832 volatile int original_uppercase_position
= -1;
7834 /* Gets around Microsoft compiler limitations. */
7837 struct buffer
*starting_buffer
;
7839 /* Nonzero if we seem to have got the beginning of a binding
7840 in function_key_map. */
7841 volatile int function_key_possible
= 0;
7842 volatile int key_translation_possible
= 0;
7844 /* Save the status of key translation before each step,
7845 so that we can restore this after downcasing. */
7846 Lisp_Object prev_fkey_map
;
7847 int prev_fkey_start
;
7850 Lisp_Object prev_keytran_map
;
7851 int prev_keytran_start
;
7852 int prev_keytran_end
;
7854 #if defined (GOBBLE_FIRST_EVENT)
7858 raw_keybuf_count
= 0;
7860 last_nonmenu_event
= Qnil
;
7862 delayed_switch_frame
= Qnil
;
7863 fkey_map
= Vfunction_key_map
;
7864 keytran_map
= Vkey_translation_map
;
7866 /* If there is no function-key-map, turn off function key scanning. */
7867 if (!KEYMAPP (Vfunction_key_map
))
7868 fkey_start
= fkey_end
= bufsize
+ 1;
7870 /* If there is no key-translation-map, turn off scanning. */
7871 if (!KEYMAPP (Vkey_translation_map
))
7872 keytran_start
= keytran_end
= bufsize
+ 1;
7877 echo_prompt (prompt
);
7878 else if (cursor_in_echo_area
7879 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
7880 && NILP (Fzerop (Vecho_keystrokes
)))
7881 /* This doesn't put in a dash if the echo buffer is empty, so
7882 you don't always see a dash hanging out in the minibuffer. */
7886 /* Record the initial state of the echo area and this_command_keys;
7887 we will need to restore them if we replay a key sequence. */
7889 echo_start
= echo_length ();
7890 keys_start
= this_command_key_count
;
7891 this_single_command_key_start
= keys_start
;
7893 #if defined (GOBBLE_FIRST_EVENT)
7894 /* This doesn't quite work, because some of the things that read_char
7895 does cannot safely be bypassed. It seems too risky to try to make
7898 /* Read the first char of the sequence specially, before setting
7899 up any keymaps, in case a filter runs and switches buffers on us. */
7900 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
7902 #endif /* GOBBLE_FIRST_EVENT */
7904 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
7905 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
7907 /* We jump here when the key sequence has been thoroughly changed, and
7908 we need to rescan it starting from the beginning. When we jump here,
7909 keybuf[0..mock_input] holds the sequence we should reread. */
7912 starting_buffer
= current_buffer
;
7913 function_key_possible
= 0;
7914 key_translation_possible
= 0;
7916 /* Build our list of keymaps.
7917 If we recognize a function key and replace its escape sequence in
7918 keybuf with its symbol, or if the sequence starts with a mouse
7919 click and we need to switch buffers, we jump back here to rebuild
7920 the initial keymaps from the current buffer. */
7924 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
7925 || !NILP (Voverriding_local_map
))
7927 if (3 > nmaps_allocated
)
7929 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
7930 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
7931 nmaps_allocated
= 3;
7934 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7935 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7936 if (!NILP (Voverriding_local_map
))
7937 submaps
[nmaps
++] = Voverriding_local_map
;
7942 nmaps
= current_minor_maps (0, &maps
);
7943 if (!NILP (orig_keymap
))
7945 if (nmaps
+ extra_maps
> nmaps_allocated
)
7947 submaps
= (Lisp_Object
*) alloca ((nmaps
+extra_maps
)
7948 * sizeof (submaps
[0]));
7949 defs
= (Lisp_Object
*) alloca ((nmaps
+extra_maps
)
7950 * sizeof (defs
[0]));
7951 nmaps_allocated
= nmaps
+ extra_maps
;
7953 bcopy (maps
, (void *) submaps
, nmaps
* sizeof (submaps
[0]));
7954 if (!NILP (orig_keymap
))
7955 submaps
[nmaps
++] = orig_keymap
;
7956 submaps
[nmaps
++] = orig_local_map
;
7958 submaps
[nmaps
++] = current_global_map
;
7961 /* Find an accurate initial value for first_binding. */
7962 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
7963 if (! NILP (submaps
[first_binding
]))
7966 /* Start from the beginning in keybuf. */
7969 /* These are no-ops the first time through, but if we restart, they
7970 revert the echo area and this_command_keys to their original state. */
7971 this_command_key_count
= keys_start
;
7972 if (INTERACTIVE
&& t
< mock_input
)
7973 echo_truncate (echo_start
);
7975 /* If the best binding for the current key sequence is a keymap, or
7976 we may be looking at a function key's escape sequence, keep on
7978 while ((first_binding
< nmaps
&& ! NILP (submaps
[first_binding
]))
7979 || (first_binding
>= nmaps
7981 /* mock input is never part of a function key's sequence. */
7982 && mock_input
<= fkey_start
)
7983 || (first_binding
>= nmaps
7984 && keytran_start
< t
&& key_translation_possible
)
7985 /* Don't return in the middle of a possible function key sequence,
7986 if the only bindings we found were via case conversion.
7987 Thus, if ESC O a has a function-key-map translation
7988 and ESC o has a binding, don't return after ESC O,
7989 so that we can translate ESC O plus the next character. */
7993 int used_mouse_menu
= 0;
7995 /* Where the last real key started. If we need to throw away a
7996 key that has expanded into more than one element of keybuf
7997 (say, a mouse click on the mode line which is being treated
7998 as [mode-line (mouse-...)], then we backtrack to this point
8000 volatile int last_real_key_start
;
8002 /* These variables are analogous to echo_start and keys_start;
8003 while those allow us to restart the entire key sequence,
8004 echo_local_start and keys_local_start allow us to throw away
8006 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8009 error ("Key sequence too long");
8012 echo_local_start
= echo_length ();
8013 keys_local_start
= this_command_key_count
;
8014 local_first_binding
= first_binding
;
8017 /* These are no-ops, unless we throw away a keystroke below and
8018 jumped back up to replay_key; in that case, these restore the
8019 variables to their original state, allowing us to replay the
8021 if (INTERACTIVE
&& t
< mock_input
)
8022 echo_truncate (echo_local_start
);
8023 this_command_key_count
= keys_local_start
;
8024 first_binding
= local_first_binding
;
8026 /* By default, assume each event is "real". */
8027 last_real_key_start
= t
;
8029 /* Does mock_input indicate that we are re-reading a key sequence? */
8033 add_command_key (key
);
8034 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8035 && NILP (Fzerop (Vecho_keystrokes
)))
8039 /* If not, we should actually read a character. */
8044 KBOARD
*interrupted_kboard
= current_kboard
;
8045 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8046 if (setjmp (wrong_kboard_jmpbuf
))
8048 if (!NILP (delayed_switch_frame
))
8050 interrupted_kboard
->kbd_queue
8051 = Fcons (delayed_switch_frame
,
8052 interrupted_kboard
->kbd_queue
);
8053 delayed_switch_frame
= Qnil
;
8056 interrupted_kboard
->kbd_queue
8057 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8059 /* If the side queue is non-empty, ensure it begins with a
8060 switch-frame, so we'll replay it in the right context. */
8061 if (CONSP (interrupted_kboard
->kbd_queue
)
8062 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8063 !(EVENT_HAS_PARAMETERS (key
)
8064 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8068 XSETFRAME (frame
, interrupted_frame
);
8069 interrupted_kboard
->kbd_queue
8070 = Fcons (make_lispy_switch_frame (frame
),
8071 interrupted_kboard
->kbd_queue
);
8074 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8075 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8076 goto replay_sequence
;
8079 key
= read_char (NILP (prompt
), nmaps
,
8080 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8084 /* read_char returns t when it shows a menu and the user rejects it.
8088 unbind_to (count
, Qnil
);
8092 /* read_char returns -1 at the end of a macro.
8093 Emacs 18 handles this by returning immediately with a
8094 zero, so that's what we'll do. */
8095 if (INTEGERP (key
) && XINT (key
) == -1)
8098 /* The Microsoft C compiler can't handle the goto that
8104 /* If the current buffer has been changed from under us, the
8105 keymap may have changed, so replay the sequence. */
8109 /* Reset the current buffer from the selected window
8110 in case something changed the former and not the latter.
8111 This is to be more consistent with the behavior
8112 of the command_loop_1. */
8113 if (fix_current_buffer
)
8115 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8117 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8118 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8121 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8122 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8123 goto replay_sequence
;
8126 /* If we have a quit that was typed in another frame, and
8127 quit_throw_to_read_char switched buffers,
8128 replay to get the right keymap. */
8129 if (XINT (key
) == quit_char
&& current_buffer
!= starting_buffer
)
8132 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8136 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8137 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8138 goto replay_sequence
;
8143 if (EVENT_HAS_PARAMETERS (key
)
8144 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8146 /* If we're at the beginning of a key sequence, and the caller
8147 says it's okay, go ahead and return this event. If we're
8148 in the midst of a key sequence, delay it until the end. */
8149 if (t
> 0 || !can_return_switch_frame
)
8151 delayed_switch_frame
= key
;
8157 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8160 /* Clicks in non-text areas get prefixed by the symbol
8161 in their CHAR-ADDRESS field. For example, a click on
8162 the mode line is prefixed by the symbol `mode-line'.
8164 Furthermore, key sequences beginning with mouse clicks
8165 are read using the keymaps of the buffer clicked on, not
8166 the current buffer. So we may have to switch the buffer
8169 When we turn one event into two events, we must make sure
8170 that neither of the two looks like the original--so that,
8171 if we replay the events, they won't be expanded again.
8172 If not for this, such reexpansion could happen either here
8173 or when user programs play with this-command-keys. */
8174 if (EVENT_HAS_PARAMETERS (key
))
8178 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8179 if (EQ (kind
, Qmouse_click
))
8181 Lisp_Object window
, posn
;
8183 window
= POSN_WINDOW (EVENT_START (key
));
8184 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8188 /* We're looking at the second event of a
8189 sequence which we expanded before. Set
8190 last_real_key_start appropriately. */
8192 last_real_key_start
= t
- 1;
8195 /* Key sequences beginning with mouse clicks are
8196 read using the keymaps in the buffer clicked on,
8197 not the current buffer. If we're at the
8198 beginning of a key sequence, switch buffers. */
8199 if (last_real_key_start
== 0
8201 && BUFFERP (XWINDOW (window
)->buffer
)
8202 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8204 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8208 /* Arrange to go back to the original buffer once we're
8209 done reading the key sequence. Note that we can't
8210 use save_excursion_{save,restore} here, because they
8211 save point as well as the current buffer; we don't
8212 want to save point, because redisplay may change it,
8213 to accommodate a Fset_window_start or something. We
8214 don't want to do this at the top of the function,
8215 because we may get input from a subprocess which
8216 wants to change the selected window and stuff (say,
8218 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8220 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8222 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8223 orig_local_map
= get_local_map (PT
, current_buffer
,
8225 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8226 goto replay_sequence
;
8229 /* For a mouse click, get the local text-property keymap
8230 of the place clicked on, rather than point. */
8231 if (last_real_key_start
== 0
8232 && CONSP (XCDR (key
))
8233 && ! localized_local_map
)
8235 Lisp_Object map_here
, start
, pos
;
8237 localized_local_map
= 1;
8238 start
= EVENT_START (key
);
8240 if (CONSP (start
) && CONSP (XCDR (start
)))
8242 pos
= POSN_BUFFER_POSN (start
);
8244 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8246 map_here
= get_local_map (XINT (pos
),
8247 current_buffer
, Qlocal_map
);
8248 if (!EQ (map_here
, orig_local_map
))
8250 orig_local_map
= map_here
;
8254 goto replay_sequence
;
8256 map_here
= get_local_map (XINT (pos
),
8257 current_buffer
, Qkeymap
);
8258 if (!EQ (map_here
, orig_keymap
))
8260 orig_keymap
= map_here
;
8264 goto replay_sequence
;
8270 /* Expand mode-line and scroll-bar events into two events:
8271 use posn as a fake prefix key. */
8274 if (t
+ 1 >= bufsize
)
8275 error ("Key sequence too long");
8280 /* Zap the position in key, so we know that we've
8281 expanded it, and don't try to do so again. */
8282 POSN_BUFFER_POSN (EVENT_START (key
))
8283 = Fcons (posn
, Qnil
);
8285 /* If on a mode line string with a local keymap,
8286 reconsider the key sequence with that keymap. */
8287 if (CONSP (POSN_STRING (EVENT_START (key
))))
8289 Lisp_Object string
, pos
, map
, map2
;
8291 string
= POSN_STRING (EVENT_START (key
));
8292 pos
= XCDR (string
);
8293 string
= XCAR (string
);
8295 && XINT (pos
) < XSTRING (string
)->size
)
8297 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8299 orig_local_map
= map
;
8300 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8303 if (!NILP (map
) || !NILP (map2
))
8304 goto replay_sequence
;
8311 else if (CONSP (XCDR (key
))
8312 && CONSP (EVENT_START (key
))
8313 && CONSP (XCDR (EVENT_START (key
))))
8317 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8318 /* Handle menu-bar events:
8319 insert the dummy prefix event `menu-bar'. */
8320 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
8322 if (t
+ 1 >= bufsize
)
8323 error ("Key sequence too long");
8327 /* Zap the position in key, so we know that we've
8328 expanded it, and don't try to do so again. */
8329 POSN_BUFFER_POSN (EVENT_START (key
))
8330 = Fcons (posn
, Qnil
);
8333 goto replay_sequence
;
8335 else if (CONSP (posn
))
8337 /* We're looking at the second event of a
8338 sequence which we expanded before. Set
8339 last_real_key_start appropriately. */
8340 if (last_real_key_start
== t
&& t
> 0)
8341 last_real_key_start
= t
- 1;
8346 /* We have finally decided that KEY is something we might want
8348 first_binding
= (follow_key (key
,
8349 nmaps
- first_binding
,
8350 submaps
+ first_binding
,
8351 defs
+ first_binding
,
8352 submaps
+ first_binding
)
8355 /* If KEY wasn't bound, we'll try some fallbacks. */
8356 if (first_binding
>= nmaps
)
8360 head
= EVENT_HEAD (key
);
8361 if (help_char_p (head
) && t
> 0)
8363 read_key_sequence_cmd
= Vprefix_help_command
;
8365 last_nonmenu_event
= key
;
8366 /* The Microsoft C compiler can't handle the goto that
8374 Lisp_Object breakdown
;
8377 breakdown
= parse_modifiers (head
);
8378 modifiers
= XINT (XCAR (XCDR (breakdown
)));
8379 /* Attempt to reduce an unbound mouse event to a simpler
8380 event that is bound:
8381 Drags reduce to clicks.
8382 Double-clicks reduce to clicks.
8383 Triple-clicks reduce to double-clicks, then to clicks.
8384 Down-clicks are eliminated.
8385 Double-downs reduce to downs, then are eliminated.
8386 Triple-downs reduce to double-downs, then to downs,
8387 then are eliminated. */
8388 if (modifiers
& (down_modifier
| drag_modifier
8389 | double_modifier
| triple_modifier
))
8391 while (modifiers
& (down_modifier
| drag_modifier
8392 | double_modifier
| triple_modifier
))
8394 Lisp_Object new_head
, new_click
;
8395 if (modifiers
& triple_modifier
)
8396 modifiers
^= (double_modifier
| triple_modifier
);
8397 else if (modifiers
& double_modifier
)
8398 modifiers
&= ~double_modifier
;
8399 else if (modifiers
& drag_modifier
)
8400 modifiers
&= ~drag_modifier
;
8403 /* Dispose of this `down' event by simply jumping
8404 back to replay_key, to get another event.
8406 Note that if this event came from mock input,
8407 then just jumping back to replay_key will just
8408 hand it to us again. So we have to wipe out any
8411 We could delete keybuf[t] and shift everything
8412 after that to the left by one spot, but we'd also
8413 have to fix up any variable that points into
8414 keybuf, and shifting isn't really necessary
8417 Adding prefixes for non-textual mouse clicks
8418 creates two characters of mock input, and both
8419 must be thrown away. If we're only looking at
8420 the prefix now, we can just jump back to
8421 replay_key. On the other hand, if we've already
8422 processed the prefix, and now the actual click
8423 itself is giving us trouble, then we've lost the
8424 state of the keymaps we want to backtrack to, and
8425 we need to replay the whole sequence to rebuild
8428 Beyond that, only function key expansion could
8429 create more than two keys, but that should never
8430 generate mouse events, so it's okay to zero
8431 mock_input in that case too.
8433 Isn't this just the most wonderful code ever? */
8434 if (t
== last_real_key_start
)
8441 mock_input
= last_real_key_start
;
8442 goto replay_sequence
;
8447 = apply_modifiers (modifiers
, XCAR (breakdown
));
8449 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
8451 /* Look for a binding for this new key. follow_key
8452 promises that it didn't munge submaps the
8453 last time we called it, since key was unbound. */
8455 = (follow_key (new_click
,
8456 nmaps
- local_first_binding
,
8457 submaps
+ local_first_binding
,
8458 defs
+ local_first_binding
,
8459 submaps
+ local_first_binding
)
8460 + local_first_binding
);
8462 /* If that click is bound, go for it. */
8463 if (first_binding
< nmaps
)
8468 /* Otherwise, we'll leave key set to the drag event. */
8475 /* Normally, last_nonmenu_event gets the previous key we read.
8476 But when a mouse popup menu is being used,
8477 we don't update last_nonmenu_event; it continues to hold the mouse
8478 event that preceded the first level of menu. */
8479 if (!used_mouse_menu
)
8480 last_nonmenu_event
= key
;
8482 /* Record what part of this_command_keys is the current key sequence. */
8483 this_single_command_key_start
= this_command_key_count
- t
;
8485 prev_fkey_map
= fkey_map
;
8486 prev_fkey_start
= fkey_start
;
8487 prev_fkey_end
= fkey_end
;
8489 prev_keytran_map
= keytran_map
;
8490 prev_keytran_start
= keytran_start
;
8491 prev_keytran_end
= keytran_end
;
8493 /* If the sequence is unbound, see if we can hang a function key
8494 off the end of it. We only want to scan real keyboard input
8495 for function key sequences, so if mock_input says that we're
8496 re-reading old events, don't examine it. */
8497 if (first_binding
>= nmaps
8500 Lisp_Object fkey_next
;
8502 /* Continue scan from fkey_end until we find a bound suffix.
8503 If we fail, increment fkey_start
8504 and start fkey_end from there. */
8505 while (fkey_end
< t
)
8509 key
= keybuf
[fkey_end
++];
8511 = access_keymap (fkey_map
, key
, 1, 0, 1);
8513 /* Handle symbol with autoload definition. */
8514 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8515 && CONSP (XSYMBOL (fkey_next
)->function
)
8516 && EQ (XCAR (XSYMBOL (fkey_next
)->function
), Qautoload
))
8517 do_autoload (XSYMBOL (fkey_next
)->function
,
8520 /* Handle a symbol whose function definition is a keymap
8522 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8523 && (!NILP (Farrayp (XSYMBOL (fkey_next
)->function
))
8524 || KEYMAPP (XSYMBOL (fkey_next
)->function
)))
8525 fkey_next
= XSYMBOL (fkey_next
)->function
;
8527 #if 0 /* I didn't turn this on, because it might cause trouble
8528 for the mapping of return into C-m and tab into C-i. */
8529 /* Optionally don't map function keys into other things.
8530 This enables the user to redefine kp- keys easily. */
8531 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
8535 /* If the function key map gives a function, not an
8536 array, then call the function with no args and use
8537 its value instead. */
8538 if (SYMBOLP (fkey_next
) && ! NILP (Ffboundp (fkey_next
))
8541 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8545 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
8546 fkey_next
= call1 (fkey_next
, prompt
);
8548 /* If the function returned something invalid,
8549 barf--don't ignore it.
8550 (To ignore it safely, we would need to gcpro a bunch of
8551 other variables.) */
8552 if (! (VECTORP (fkey_next
) || STRINGP (fkey_next
)))
8553 error ("Function in key-translation-map returns invalid key sequence");
8556 function_key_possible
= ! NILP (fkey_next
);
8558 /* If keybuf[fkey_start..fkey_end] is bound in the
8559 function key map and it's a suffix of the current
8560 sequence (i.e. fkey_end == t), replace it with
8561 the binding and restart with fkey_start at the end. */
8562 if ((VECTORP (fkey_next
) || STRINGP (fkey_next
))
8565 int len
= XFASTINT (Flength (fkey_next
));
8567 t
= fkey_start
+ len
;
8569 error ("Key sequence too long");
8571 if (VECTORP (fkey_next
))
8572 bcopy (XVECTOR (fkey_next
)->contents
,
8573 keybuf
+ fkey_start
,
8574 (t
- fkey_start
) * sizeof (keybuf
[0]));
8575 else if (STRINGP (fkey_next
))
8579 for (i
= 0; i
< len
; i
++)
8580 XSETFASTINT (keybuf
[fkey_start
+ i
],
8581 XSTRING (fkey_next
)->data
[i
]);
8585 fkey_start
= fkey_end
= t
;
8586 fkey_map
= Vfunction_key_map
;
8588 /* Do pass the results through key-translation-map.
8589 But don't retranslate what key-translation-map
8590 has already translated. */
8591 keytran_end
= keytran_start
;
8592 keytran_map
= Vkey_translation_map
;
8594 goto replay_sequence
;
8597 fkey_map
= get_keymap (fkey_next
, 0, 1);
8599 /* If we no longer have a bound suffix, try a new positions for
8601 if (!CONSP (fkey_map
))
8603 fkey_end
= ++fkey_start
;
8604 fkey_map
= Vfunction_key_map
;
8605 function_key_possible
= 0;
8610 /* Look for this sequence in key-translation-map. */
8612 Lisp_Object keytran_next
;
8614 /* Scan from keytran_end until we find a bound suffix. */
8615 while (keytran_end
< t
)
8619 key
= keybuf
[keytran_end
++];
8621 = access_keymap (keytran_map
, key
, 1, 0, 1);
8623 /* Handle symbol with autoload definition. */
8624 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8625 && CONSP (XSYMBOL (keytran_next
)->function
)
8626 && EQ (XCAR (XSYMBOL (keytran_next
)->function
), Qautoload
))
8627 do_autoload (XSYMBOL (keytran_next
)->function
,
8630 /* Handle a symbol whose function definition is a keymap
8632 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8633 && (!NILP (Farrayp (XSYMBOL (keytran_next
)->function
))
8634 || KEYMAPP (XSYMBOL (keytran_next
)->function
)))
8635 keytran_next
= XSYMBOL (keytran_next
)->function
;
8637 /* If the key translation map gives a function, not an
8638 array, then call the function with one arg and use
8639 its value instead. */
8640 if (SYMBOLP (keytran_next
) && ! NILP (Ffboundp (keytran_next
))
8641 && keytran_end
== t
)
8643 struct gcpro gcpro1
, gcpro2
, gcpro3
;
8647 GCPRO3 (fkey_map
, keytran_map
, delayed_switch_frame
);
8648 keytran_next
= call1 (keytran_next
, prompt
);
8650 /* If the function returned something invalid,
8651 barf--don't ignore it.
8652 (To ignore it safely, we would need to gcpro a bunch of
8653 other variables.) */
8654 if (! (VECTORP (keytran_next
) || STRINGP (keytran_next
)))
8655 error ("Function in key-translation-map returns invalid key sequence");
8658 key_translation_possible
= ! NILP (keytran_next
);
8660 /* If keybuf[keytran_start..keytran_end] is bound in the
8661 key translation map and it's a suffix of the current
8662 sequence (i.e. keytran_end == t), replace it with
8663 the binding and restart with keytran_start at the end. */
8664 if ((VECTORP (keytran_next
) || STRINGP (keytran_next
))
8665 && keytran_end
== t
)
8667 int len
= XFASTINT (Flength (keytran_next
));
8669 t
= keytran_start
+ len
;
8671 error ("Key sequence too long");
8673 if (VECTORP (keytran_next
))
8674 bcopy (XVECTOR (keytran_next
)->contents
,
8675 keybuf
+ keytran_start
,
8676 (t
- keytran_start
) * sizeof (keybuf
[0]));
8677 else if (STRINGP (keytran_next
))
8681 for (i
= 0; i
< len
; i
++)
8682 XSETFASTINT (keybuf
[keytran_start
+ i
],
8683 XSTRING (keytran_next
)->data
[i
]);
8687 keytran_start
= keytran_end
= t
;
8688 keytran_map
= Vkey_translation_map
;
8690 /* Don't pass the results of key-translation-map
8691 through function-key-map. */
8692 fkey_start
= fkey_end
= t
;
8693 fkey_map
= Vfunction_key_map
;
8695 goto replay_sequence
;
8698 keytran_map
= get_keymap (keytran_next
, 0, 1);
8700 /* If we no longer have a bound suffix, try a new positions for
8702 if (!CONSP (keytran_map
))
8704 keytran_end
= ++keytran_start
;
8705 keytran_map
= Vkey_translation_map
;
8706 key_translation_possible
= 0;
8711 /* If KEY is not defined in any of the keymaps,
8712 and cannot be part of a function key or translation,
8713 and is an upper case letter
8714 use the corresponding lower-case letter instead. */
8715 if (first_binding
== nmaps
&& ! function_key_possible
8716 && ! key_translation_possible
8718 && ((((XINT (key
) & 0x3ffff)
8719 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
8720 && UPPERCASEP (XINT (key
) & 0x3ffff))
8721 || (XINT (key
) & shift_modifier
)))
8723 Lisp_Object new_key
;
8725 original_uppercase
= key
;
8726 original_uppercase_position
= t
- 1;
8728 if (XINT (key
) & shift_modifier
)
8729 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
8731 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
8732 | (XINT (key
) & ~0x3ffff)));
8734 /* We have to do this unconditionally, regardless of whether
8735 the lower-case char is defined in the keymaps, because they
8736 might get translated through function-key-map. */
8737 keybuf
[t
- 1] = new_key
;
8740 fkey_map
= prev_fkey_map
;
8741 fkey_start
= prev_fkey_start
;
8742 fkey_end
= prev_fkey_end
;
8744 keytran_map
= prev_keytran_map
;
8745 keytran_start
= prev_keytran_start
;
8746 keytran_end
= prev_keytran_end
;
8748 goto replay_sequence
;
8750 /* If KEY is not defined in any of the keymaps,
8751 and cannot be part of a function key or translation,
8752 and is a shifted function key,
8753 use the corresponding unshifted function key instead. */
8754 if (first_binding
== nmaps
&& ! function_key_possible
8755 && ! key_translation_possible
8758 Lisp_Object breakdown
;
8761 breakdown
= parse_modifiers (key
);
8762 modifiers
= XINT (XCAR (XCDR (breakdown
)));
8763 if (modifiers
& shift_modifier
)
8765 Lisp_Object new_key
;
8767 original_uppercase
= key
;
8768 original_uppercase_position
= t
- 1;
8770 modifiers
&= ~shift_modifier
;
8771 new_key
= apply_modifiers (modifiers
,
8774 keybuf
[t
- 1] = new_key
;
8777 fkey_map
= prev_fkey_map
;
8778 fkey_start
= prev_fkey_start
;
8779 fkey_end
= prev_fkey_end
;
8781 keytran_map
= prev_keytran_map
;
8782 keytran_start
= prev_keytran_start
;
8783 keytran_end
= prev_keytran_end
;
8785 goto replay_sequence
;
8791 read_key_sequence_cmd
= (first_binding
< nmaps
8792 ? defs
[first_binding
]
8795 unread_switch_frame
= delayed_switch_frame
;
8796 unbind_to (count
, Qnil
);
8798 /* Don't downcase the last character if the caller says don't.
8799 Don't downcase it if the result is undefined, either. */
8800 if ((dont_downcase_last
|| first_binding
>= nmaps
)
8801 && t
- 1 == original_uppercase_position
)
8802 keybuf
[t
- 1] = original_uppercase
;
8804 /* Occasionally we fabricate events, perhaps by expanding something
8805 according to function-key-map, or by adding a prefix symbol to a
8806 mouse click in the scroll bar or modeline. In this cases, return
8807 the entire generated key sequence, even if we hit an unbound
8808 prefix or a definition before the end. This means that you will
8809 be able to push back the event properly, and also means that
8810 read-key-sequence will always return a logical unit.
8813 for (; t
< mock_input
; t
++)
8815 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8816 && NILP (Fzerop (Vecho_keystrokes
)))
8817 echo_char (keybuf
[t
]);
8818 add_command_key (keybuf
[t
]);
8826 #if 0 /* This doc string is too long for some compilers.
8827 This commented-out definition serves for DOC. */
8828 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 4, 0,
8829 "Read a sequence of keystrokes and return as a string or vector.\n\
8830 The sequence is sufficient to specify a non-prefix command in the\n\
8831 current local and global maps.\n\
8833 First arg PROMPT is a prompt string. If nil, do not prompt specially.\n\
8834 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos\n\
8835 as a continuation of the previous key.\n\
8837 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not\n\
8838 convert the last event to lower case. (Normally any upper case event\n\
8839 is converted to lower case if the original event is undefined and the lower\n\
8840 case equivalent is defined.) A non-nil value is appropriate for reading\n\
8841 a key sequence to be defined.\n\
8843 A C-g typed while in this function is treated like any other character,\n\
8844 and `quit-flag' is not set.\n\
8846 If the key sequence starts with a mouse click, then the sequence is read\n\
8847 using the keymaps of the buffer of the window clicked in, not the buffer\n\
8848 of the selected window as normal.\n\
8850 `read-key-sequence' drops unbound button-down events, since you normally\n\
8851 only care about the click or drag events which follow them. If a drag\n\
8852 or multi-click event is unbound, but the corresponding click event would\n\
8853 be bound, `read-key-sequence' turns the event into a click event at the\n\
8854 drag's starting position. This means that you don't have to distinguish\n\
8855 between click and drag, double, or triple events unless you want to.\n\
8857 `read-key-sequence' prefixes mouse events on mode lines, the vertical\n\
8858 lines separating windows, and scroll bars with imaginary keys\n\
8859 `mode-line', `vertical-line', and `vertical-scroll-bar'.\n\
8861 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this\n\
8862 function will process a switch-frame event if the user switches frames\n\
8863 before typing anything. If the user switches frames in the middle of a\n\
8864 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME\n\
8865 is nil, then the event will be put off until after the current key sequence.\n\
8867 `read-key-sequence' checks `function-key-map' for function key\n\
8868 sequences, where they wouldn't conflict with ordinary bindings. See\n\
8869 `function-key-map' for more details.\n\
8871 The optional fifth argument COMMAND-LOOP, if non-nil, means\n\
8872 that this key sequence is being read by something that will\n\
8873 read commands one after another. It should be nil if the caller\n\
8874 will read just one key sequence.")
8875 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
, command
-loop
)
8878 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
8880 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
8882 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
8883 Lisp_Object can_return_switch_frame
, command_loop
;
8885 Lisp_Object keybuf
[30];
8887 struct gcpro gcpro1
;
8888 int count
= specpdl_ptr
- specpdl
;
8891 CHECK_STRING (prompt
, 0);
8894 specbind (Qinput_method_exit_on_first_char
,
8895 (NILP (command_loop
) ? Qt
: Qnil
));
8896 specbind (Qinput_method_use_echo_area
,
8897 (NILP (command_loop
) ? Qt
: Qnil
));
8899 bzero (keybuf
, sizeof keybuf
);
8901 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
8903 if (NILP (continue_echo
))
8905 this_command_key_count
= 0;
8906 this_single_command_key_start
= 0;
8909 #ifdef HAVE_X_WINDOWS
8910 if (display_hourglass_p
)
8911 cancel_hourglass ();
8914 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
8915 prompt
, ! NILP (dont_downcase_last
),
8916 ! NILP (can_return_switch_frame
), 0);
8918 #if 0 /* The following is fine for code reading a key sequence and
8919 then proceeding with a lenghty compuation, but it's not good
8920 for code reading keys in a loop, like an input method. */
8921 #ifdef HAVE_X_WINDOWS
8922 if (display_hourglass_p
)
8933 return unbind_to (count
, make_event_array (i
, keybuf
));
8936 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
8937 Sread_key_sequence_vector
, 1, 5, 0,
8938 "Like `read-key-sequence' but always return a vector.")
8939 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
8941 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
8942 Lisp_Object can_return_switch_frame
, command_loop
;
8944 Lisp_Object keybuf
[30];
8946 struct gcpro gcpro1
;
8947 int count
= specpdl_ptr
- specpdl
;
8950 CHECK_STRING (prompt
, 0);
8953 specbind (Qinput_method_exit_on_first_char
,
8954 (NILP (command_loop
) ? Qt
: Qnil
));
8955 specbind (Qinput_method_use_echo_area
,
8956 (NILP (command_loop
) ? Qt
: Qnil
));
8958 bzero (keybuf
, sizeof keybuf
);
8960 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
8962 if (NILP (continue_echo
))
8964 this_command_key_count
= 0;
8965 this_single_command_key_start
= 0;
8968 #ifdef HAVE_X_WINDOWS
8969 if (display_hourglass_p
)
8970 cancel_hourglass ();
8973 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
8974 prompt
, ! NILP (dont_downcase_last
),
8975 ! NILP (can_return_switch_frame
), 0);
8977 #ifdef HAVE_X_WINDOWS
8978 if (display_hourglass_p
)
8988 return unbind_to (count
, Fvector (i
, keybuf
));
8991 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
8992 "Execute CMD as an editor command.\n\
8993 CMD must be a symbol that satisfies the `commandp' predicate.\n\
8994 Optional second arg RECORD-FLAG non-nil\n\
8995 means unconditionally put this command in `command-history'.\n\
8996 Otherwise, that is done only if an arg is read using the minibuffer.\n\
8997 The argument KEYS specifies the value to use instead of (this-command-keys)\n\
8998 when reading the arguments; if it is nil, (this-command-keys) is used.\n\
8999 The argument SPECIAL, if non-nil, means that this command is executing\n\
9000 a special event, so ignore the prefix argument and don't clear it.")
9001 (cmd
, record_flag
, keys
, special
)
9002 Lisp_Object cmd
, record_flag
, keys
, special
;
9004 register Lisp_Object final
;
9005 register Lisp_Object tem
;
9006 Lisp_Object prefixarg
;
9007 struct backtrace backtrace
;
9008 extern int debug_on_next_call
;
9010 debug_on_next_call
= 0;
9014 prefixarg
= current_kboard
->Vprefix_arg
;
9015 Vcurrent_prefix_arg
= prefixarg
;
9016 current_kboard
->Vprefix_arg
= Qnil
;
9023 tem
= Fget (cmd
, Qdisabled
);
9024 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9026 tem
= Fsymbol_value (Qdisabled_command_hook
);
9028 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9034 final
= Findirect_function (cmd
);
9036 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9038 struct gcpro gcpro1
, gcpro2
;
9040 GCPRO2 (cmd
, prefixarg
);
9041 do_autoload (final
, cmd
);
9048 if (STRINGP (final
) || VECTORP (final
))
9050 /* If requested, place the macro in the command history. For
9051 other sorts of commands, call-interactively takes care of
9053 if (!NILP (record_flag
))
9056 = Fcons (Fcons (Qexecute_kbd_macro
,
9057 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9060 /* Don't keep command history around forever. */
9061 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9063 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9069 return Fexecute_kbd_macro (final
, prefixarg
);
9072 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9074 backtrace
.next
= backtrace_list
;
9075 backtrace_list
= &backtrace
;
9076 backtrace
.function
= &Qcall_interactively
;
9077 backtrace
.args
= &cmd
;
9078 backtrace
.nargs
= 1;
9079 backtrace
.evalargs
= 0;
9081 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9083 backtrace_list
= backtrace
.next
;
9091 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9093 "Read function name, then read its arguments and call it.")
9095 Lisp_Object prefixarg
;
9097 Lisp_Object function
;
9099 Lisp_Object saved_keys
;
9100 Lisp_Object bindings
, value
;
9101 struct gcpro gcpro1
, gcpro2
;
9103 saved_keys
= Fvector (this_command_key_count
,
9104 XVECTOR (this_command_keys
)->contents
);
9106 GCPRO2 (saved_keys
, prefixarg
);
9108 if (EQ (prefixarg
, Qminus
))
9110 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9111 strcpy (buf
, "C-u ");
9112 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9114 if (sizeof (int) == sizeof (EMACS_INT
))
9115 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9116 else if (sizeof (long) == sizeof (EMACS_INT
))
9117 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9121 else if (INTEGERP (prefixarg
))
9123 if (sizeof (int) == sizeof (EMACS_INT
))
9124 sprintf (buf
, "%d ", XINT (prefixarg
));
9125 else if (sizeof (long) == sizeof (EMACS_INT
))
9126 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9131 /* This isn't strictly correct if execute-extended-command
9132 is bound to anything else. Perhaps it should use
9133 this_command_keys? */
9134 strcat (buf
, "M-x ");
9136 /* Prompt with buf, and then read a string, completing from and
9137 restricting to the set of all defined commands. Don't provide
9138 any initial input. Save the command read on the extended-command
9140 function
= Fcompleting_read (build_string (buf
),
9141 Vobarray
, Qcommandp
,
9142 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9145 if (STRINGP (function
) && XSTRING (function
)->size
== 0)
9146 error ("No command name given");
9148 /* Set this_command_keys to the concatenation of saved_keys and
9149 function, followed by a RET. */
9151 struct Lisp_String
*str
;
9155 this_command_key_count
= 0;
9156 this_single_command_key_start
= 0;
9158 keys
= XVECTOR (saved_keys
)->contents
;
9159 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9160 add_command_key (keys
[i
]);
9162 str
= XSTRING (function
);
9163 for (i
= 0; i
< str
->size
; i
++)
9164 add_command_key (Faref (function
, make_number (i
)));
9166 add_command_key (make_number ('\015'));
9171 function
= Fintern (function
, Qnil
);
9172 current_kboard
->Vprefix_arg
= prefixarg
;
9173 Vthis_command
= function
;
9174 real_this_command
= function
;
9176 /* If enabled, show which key runs this command. */
9177 if (!NILP (Vsuggest_key_bindings
)
9178 && NILP (Vexecuting_macro
)
9179 && SYMBOLP (function
))
9180 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9186 GCPRO2 (bindings
, value
);
9187 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9189 /* If the command has a key binding, print it now. */
9190 if (!NILP (bindings
)
9191 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9194 /* But first wait, and skip the message if there is input. */
9196 if (!NILP (echo_area_buffer
[0]))
9197 /* This command displayed something in the echo area;
9198 so wait a few seconds, then display our suggestion message. */
9199 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9200 ? XINT (Vsuggest_key_bindings
) : 2);
9202 /* This command left the echo area empty,
9203 so display our message immediately. */
9206 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9207 && ! CONSP (Vunread_command_events
))
9209 Lisp_Object binding
;
9211 int message_p
= push_message ();
9212 int count
= BINDING_STACK_SIZE ();
9214 record_unwind_protect (push_message_unwind
, Qnil
);
9215 binding
= Fkey_description (bindings
);
9218 = (char *) alloca (XSYMBOL (function
)->name
->size
9219 + STRING_BYTES (XSTRING (binding
))
9221 sprintf (newmessage
, "You can run the command `%s' with %s",
9222 XSYMBOL (function
)->name
->data
,
9223 XSTRING (binding
)->data
);
9224 message2_nolog (newmessage
,
9225 strlen (newmessage
),
9226 STRING_MULTIBYTE (binding
));
9227 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9228 ? Vsuggest_key_bindings
: make_number (2)),
9233 unbind_to (count
, Qnil
);
9237 RETURN_UNGCPRO (value
);
9240 /* Find the set of keymaps now active.
9241 Store into *MAPS_P a vector holding the various maps
9242 and return the number of them. The vector was malloc'd
9243 and the caller should free it. */
9246 current_active_maps (maps_p
)
9247 Lisp_Object
**maps_p
;
9249 Lisp_Object
*tmaps
, *maps
;
9252 /* Should overriding-terminal-local-map and overriding-local-map apply? */
9253 if (!NILP (Voverriding_local_map_menu_flag
))
9255 /* Yes, use them (if non-nil) as well as the global map. */
9256 maps
= (Lisp_Object
*) xmalloc (3 * sizeof (maps
[0]));
9258 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9259 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9260 if (!NILP (Voverriding_local_map
))
9261 maps
[nmaps
++] = Voverriding_local_map
;
9265 /* No, so use major and minor mode keymaps and keymap property. */
9267 Lisp_Object map
= get_local_map (PT
, current_buffer
, Qkeymap
);
9270 nmaps
= current_minor_maps (NULL
, &tmaps
);
9271 maps
= (Lisp_Object
*) alloca ((nmaps
+ extra_maps
)
9272 * sizeof (maps
[0]));
9273 bcopy (tmaps
, maps
, nmaps
* sizeof (maps
[0]));
9275 maps
[nmaps
++] = map
;
9276 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
9278 maps
[nmaps
++] = current_global_map
;
9284 /* Return nonzero if input events are pending. */
9287 detect_input_pending ()
9290 get_input_pending (&input_pending
, 0);
9292 return input_pending
;
9295 /* Return nonzero if input events are pending, and run any pending timers. */
9298 detect_input_pending_run_timers (do_display
)
9301 int old_timers_run
= timers_run
;
9304 get_input_pending (&input_pending
, 1);
9306 if (old_timers_run
!= timers_run
&& do_display
)
9308 redisplay_preserve_echo_area (8);
9309 /* The following fixes a bug when using lazy-lock with
9310 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9311 from an idle timer function. The symptom of the bug is that
9312 the cursor sometimes doesn't become visible until the next X
9313 event is processed. --gerd. */
9315 rif
->flush_display (NULL
);
9318 return input_pending
;
9321 /* This is called in some cases before a possible quit.
9322 It cases the next call to detect_input_pending to recompute input_pending.
9323 So calling this function unnecessarily can't do any harm. */
9326 clear_input_pending ()
9331 /* Return nonzero if there are pending requeued events.
9332 This isn't used yet. The hope is to make wait_reading_process_input
9333 call it, and return return if it runs Lisp code that unreads something.
9334 The problem is, kbd_buffer_get_event needs to be fixed to know what
9335 to do in that case. It isn't trivial. */
9338 requeued_events_pending_p ()
9340 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9344 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9345 "T if command input is currently available with no waiting.\n\
9346 Actually, the value is nil only if we can be sure that no input is available.")
9349 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9352 get_input_pending (&input_pending
, 1);
9353 return input_pending
> 0 ? Qt
: Qnil
;
9356 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9357 "Return vector of last 100 events, not counting those from keyboard macros.")
9360 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9363 if (total_keys
< NUM_RECENT_KEYS
)
9364 return Fvector (total_keys
, keys
);
9367 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9368 bcopy (keys
+ recent_keys_index
,
9369 XVECTOR (val
)->contents
,
9370 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9372 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9373 recent_keys_index
* sizeof (Lisp_Object
));
9378 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9379 "Return the key sequence that invoked this command.\n\
9380 The value is a string or a vector.")
9383 return make_event_array (this_command_key_count
,
9384 XVECTOR (this_command_keys
)->contents
);
9387 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9388 "Return the key sequence that invoked this command, as a vector.")
9391 return Fvector (this_command_key_count
,
9392 XVECTOR (this_command_keys
)->contents
);
9395 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9396 Sthis_single_command_keys
, 0, 0, 0,
9397 "Return the key sequence that invoked this command.\n\
9398 Unlike `this-command-keys', this function's value\n\
9399 does not include prefix arguments.\n\
9400 The value is always a vector.")
9403 return Fvector (this_command_key_count
9404 - this_single_command_key_start
,
9405 (XVECTOR (this_command_keys
)->contents
9406 + this_single_command_key_start
));
9409 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9410 Sthis_single_command_raw_keys
, 0, 0, 0,
9411 "Return the raw events that were read for this command.\n\
9412 Unlike `this-single-command-keys', this function's value\n\
9413 shows the events before all translations (except for input methods).\n\
9414 The value is always a vector.")
9417 return Fvector (raw_keybuf_count
,
9418 (XVECTOR (raw_keybuf
)->contents
));
9421 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9422 Sreset_this_command_lengths
, 0, 0, 0,
9423 "Used for complicated reasons in `universal-argument-other-key'.\n\
9425 `universal-argument-other-key' rereads the event just typed.\n\
9426 It then gets translated through `function-key-map'.\n\
9427 The translated event gets included in the echo area and in\n\
9428 the value of `this-command-keys' in addition to the raw original event.\n\
9429 That is not right.\n\
9431 Calling this function directs the translated event to replace\n\
9432 the original event, so that only one version of the event actually\n\
9433 appears in the echo area and in the value of `this-command-keys.'.")
9436 before_command_restore_flag
= 1;
9437 before_command_key_count_1
= before_command_key_count
;
9438 before_command_echo_length_1
= before_command_echo_length
;
9442 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9443 Sclear_this_command_keys
, 0, 0, 0,
9444 "Clear out the vector that `this-command-keys' returns.\n\
9445 Clear vector containing last 100 events.")
9450 this_command_key_count
= 0;
9452 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
9453 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
9455 recent_keys_index
= 0;
9459 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
9460 "Return the current depth in recursive edits.")
9464 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
9468 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
9469 "FOpen dribble file: ",
9470 "Start writing all keyboard characters to a dribble file called FILE.\n\
9471 If FILE is nil, close any open dribble file.")
9482 file
= Fexpand_file_name (file
, Qnil
);
9483 dribble
= fopen (XSTRING (file
)->data
, "w");
9485 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
9490 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
9491 "Discard the contents of the terminal input buffer.\n\
9492 Also cancel any kbd macro being defined.")
9495 current_kboard
->defining_kbd_macro
= Qnil
;
9496 update_mode_lines
++;
9498 Vunread_command_events
= Qnil
;
9499 unread_command_char
= -1;
9501 discard_tty_input ();
9503 kbd_fetch_ptr
= kbd_store_ptr
;
9504 Ffillarray (kbd_buffer_gcpro
, Qnil
);
9510 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
9511 "Stop Emacs and return to superior process. You can resume later.\n\
9512 If `cannot-suspend' is non-nil, or if the system doesn't support job\n\
9513 control, run a subshell instead.\n\n\
9514 If optional arg STUFFSTRING is non-nil, its characters are stuffed\n\
9515 to be read as terminal input by Emacs's parent, after suspension.\n\
9517 Before suspending, run the normal hook `suspend-hook'.\n\
9518 After resumption run the normal hook `suspend-resume-hook'.\n\
9520 Some operating systems cannot stop the Emacs process and resume it later.\n\
9521 On such systems, Emacs starts a subshell instead of suspending.")
9523 Lisp_Object stuffstring
;
9525 int count
= specpdl_ptr
- specpdl
;
9526 int old_height
, old_width
;
9528 struct gcpro gcpro1
;
9530 if (!NILP (stuffstring
))
9531 CHECK_STRING (stuffstring
, 0);
9533 /* Run the functions in suspend-hook. */
9534 if (!NILP (Vrun_hooks
))
9535 call1 (Vrun_hooks
, intern ("suspend-hook"));
9537 GCPRO1 (stuffstring
);
9538 get_frame_size (&old_width
, &old_height
);
9540 /* sys_suspend can get an error if it tries to fork a subshell
9541 and the system resources aren't available for that. */
9542 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
9544 stuff_buffered_input (stuffstring
);
9549 unbind_to (count
, Qnil
);
9551 /* Check if terminal/window size has changed.
9552 Note that this is not useful when we are running directly
9553 with a window system; but suspend should be disabled in that case. */
9554 get_frame_size (&width
, &height
);
9555 if (width
!= old_width
|| height
!= old_height
)
9556 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
9558 /* Run suspend-resume-hook. */
9559 if (!NILP (Vrun_hooks
))
9560 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
9566 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
9567 Then in any case stuff anything Emacs has read ahead and not used. */
9570 stuff_buffered_input (stuffstring
)
9571 Lisp_Object stuffstring
;
9573 /* stuff_char works only in BSD, versions 4.2 and up. */
9576 register unsigned char *p
;
9578 if (STRINGP (stuffstring
))
9582 p
= XSTRING (stuffstring
)->data
;
9583 count
= STRING_BYTES (XSTRING (stuffstring
));
9589 /* Anything we have read ahead, put back for the shell to read. */
9590 /* ?? What should this do when we have multiple keyboards??
9591 Should we ignore anything that was typed in at the "wrong" kboard? */
9592 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
9596 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
9597 kbd_fetch_ptr
= kbd_buffer
;
9598 if (kbd_fetch_ptr
->kind
== ascii_keystroke
)
9599 stuff_char (kbd_fetch_ptr
->code
);
9601 kbd_fetch_ptr
->kind
= no_event
;
9602 idx
= 2 * (kbd_fetch_ptr
- kbd_buffer
);
9603 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
9604 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
9609 #endif /* BSD_SYSTEM and not BSD4_1 */
9613 set_waiting_for_input (time_to_clear
)
9614 EMACS_TIME
*time_to_clear
;
9616 input_available_clear_time
= time_to_clear
;
9618 /* Tell interrupt_signal to throw back to read_char, */
9619 waiting_for_input
= 1;
9621 /* If interrupt_signal was called before and buffered a C-g,
9622 make it run again now, to avoid timing error. */
9623 if (!NILP (Vquit_flag
))
9624 quit_throw_to_read_char ();
9628 clear_waiting_for_input ()
9630 /* Tell interrupt_signal not to throw back to read_char, */
9631 waiting_for_input
= 0;
9632 input_available_clear_time
= 0;
9635 /* This routine is called at interrupt level in response to C-G.
9637 If interrupt_input, this is the handler for SIGINT. Otherwise, it
9638 is called from kbd_buffer_store_event, in handling SIGIO or
9641 If `waiting_for_input' is non zero, then unless `echoing' is
9642 nonzero, immediately throw back to read_char.
9644 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
9645 eval to throw, when it gets a chance. If quit-flag is already
9646 non-nil, it stops the job right away. */
9649 interrupt_signal (signalnum
) /* If we don't have an argument, */
9650 int signalnum
; /* some compilers complain in signal calls. */
9653 /* Must preserve main program's value of errno. */
9654 int old_errno
= errno
;
9655 struct frame
*sf
= SELECTED_FRAME ();
9657 #if defined (USG) && !defined (POSIX_SIGNALS)
9658 if (!read_socket_hook
&& NILP (Vwindow_system
))
9660 /* USG systems forget handlers when they are used;
9661 must reestablish each time */
9662 signal (SIGINT
, interrupt_signal
);
9663 signal (SIGQUIT
, interrupt_signal
);
9669 if (!NILP (Vquit_flag
)
9670 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
9672 /* If SIGINT isn't blocked, don't let us be interrupted by
9673 another SIGINT, it might be harmful due to non-reentrancy
9674 in I/O functions. */
9675 sigblock (sigmask (SIGINT
));
9680 #ifdef SIGTSTP /* Support possible in later USG versions */
9682 * On systems which can suspend the current process and return to the original
9683 * shell, this command causes the user to end up back at the shell.
9684 * The "Auto-save" and "Abort" questions are not asked until
9685 * the user elects to return to emacs, at which point he can save the current
9686 * job and either dump core or continue.
9691 if (sys_suspend () == -1)
9693 printf ("Not running as a subprocess;\n");
9694 printf ("you can continue or abort.\n");
9697 /* Perhaps should really fork an inferior shell?
9698 But that would not provide any way to get back
9699 to the original shell, ever. */
9700 printf ("No support for stopping a process on this operating system;\n");
9701 printf ("you can continue or abort.\n");
9702 #endif /* not VMS */
9703 #endif /* not SIGTSTP */
9705 /* We must remain inside the screen area when the internal terminal
9706 is used. Note that [Enter] is not echoed by dos. */
9709 /* It doesn't work to autosave while GC is in progress;
9710 the code used for auto-saving doesn't cope with the mark bit. */
9711 if (!gc_in_progress
)
9713 printf ("Auto-save? (y or n) ");
9715 if (((c
= getchar ()) & ~040) == 'Y')
9717 Fdo_auto_save (Qt
, Qnil
);
9719 printf ("\r\nAuto-save done");
9720 #else /* not MSDOS */
9721 printf ("Auto-save done\n");
9722 #endif /* not MSDOS */
9724 while (c
!= '\n') c
= getchar ();
9728 /* During GC, it must be safe to reenable quitting again. */
9729 Vinhibit_quit
= Qnil
;
9732 #endif /* not MSDOS */
9733 printf ("Garbage collection in progress; cannot auto-save now\r\n");
9734 printf ("but will instead do a real quit after garbage collection ends\r\n");
9739 printf ("\r\nAbort? (y or n) ");
9740 #else /* not MSDOS */
9742 printf ("Abort (and enter debugger)? (y or n) ");
9744 printf ("Abort (and dump core)? (y or n) ");
9745 #endif /* not VMS */
9746 #endif /* not MSDOS */
9748 if (((c
= getchar ()) & ~040) == 'Y')
9750 while (c
!= '\n') c
= getchar ();
9752 printf ("\r\nContinuing...\r\n");
9753 #else /* not MSDOS */
9754 printf ("Continuing...\n");
9755 #endif /* not MSDOS */
9762 /* If executing a function that wants to be interrupted out of
9763 and the user has not deferred quitting by binding `inhibit-quit'
9764 then quit right away. */
9765 if (immediate_quit
&& NILP (Vinhibit_quit
))
9767 struct gl_state_s saved
;
9768 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9773 GCPRO4 (saved
.object
, saved
.global_code
,
9774 saved
.current_syntax_table
, saved
.old_prop
);
9775 Fsignal (Qquit
, Qnil
);
9780 /* Else request quit when it's safe */
9784 if (waiting_for_input
&& !echoing
)
9785 quit_throw_to_read_char ();
9790 /* Handle a C-g by making read_char return C-g. */
9793 quit_throw_to_read_char ()
9796 /* Prevent another signal from doing this before we finish. */
9797 clear_waiting_for_input ();
9800 Vunread_command_events
= Qnil
;
9801 unread_command_char
= -1;
9803 #if 0 /* Currently, sit_for is called from read_char without turning
9804 off polling. And that can call set_waiting_for_input.
9805 It seems to be harmless. */
9806 #ifdef POLL_FOR_INPUT
9807 /* May be > 1 if in recursive minibuffer. */
9808 if (poll_suppress_count
== 0)
9812 if (FRAMEP (internal_last_event_frame
)
9813 && !EQ (internal_last_event_frame
, selected_frame
))
9814 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
9817 _longjmp (getcjmp
, 1);
9820 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
9821 "Set mode of reading keyboard input.\n\
9822 First arg INTERRUPT non-nil means use input interrupts;\n\
9823 nil means use CBREAK mode.\n\
9824 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal\n\
9825 (no effect except in CBREAK mode).\n\
9826 Third arg META t means accept 8-bit input (for a Meta key).\n\
9827 META nil means ignore the top bit, on the assumption it is parity.\n\
9828 Otherwise, accept 8-bit input and don't use the top bit for Meta.\n\
9829 Optional fourth arg QUIT if non-nil specifies character to use for quitting.\n\
9830 See also `current-input-mode'.")
9831 (interrupt
, flow
, meta
, quit
)
9832 Lisp_Object interrupt
, flow
, meta
, quit
;
9835 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
9836 error ("set-input-mode: QUIT must be an ASCII character");
9838 #ifdef POLL_FOR_INPUT
9843 /* this causes startup screen to be restored and messes with the mouse */
9848 /* Note SIGIO has been undef'd if FIONREAD is missing. */
9849 if (read_socket_hook
)
9851 /* When using X, don't give the user a real choice,
9852 because we haven't implemented the mechanisms to support it. */
9853 #ifdef NO_SOCK_SIGIO
9854 interrupt_input
= 0;
9855 #else /* not NO_SOCK_SIGIO */
9856 interrupt_input
= 1;
9857 #endif /* NO_SOCK_SIGIO */
9860 interrupt_input
= !NILP (interrupt
);
9861 #else /* not SIGIO */
9862 interrupt_input
= 0;
9863 #endif /* not SIGIO */
9865 /* Our VMS input only works by interrupts, as of now. */
9867 interrupt_input
= 1;
9870 flow_control
= !NILP (flow
);
9873 else if (EQ (meta
, Qt
))
9878 /* Don't let this value be out of range. */
9879 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
9885 #ifdef POLL_FOR_INPUT
9886 poll_suppress_count
= 1;
9892 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
9893 "Return information about the way Emacs currently reads keyboard input.\n\
9894 The value is a list of the form (INTERRUPT FLOW META QUIT), where\n\
9895 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if\n\
9896 nil, Emacs is using CBREAK mode.\n\
9897 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the\n\
9898 terminal; this does not apply if Emacs uses interrupt-driven input.\n\
9899 META is t if accepting 8-bit input with 8th bit as Meta flag.\n\
9900 META nil means ignoring the top bit, on the assumption it is parity.\n\
9901 META is neither t nor nil if accepting 8-bit input and using\n\
9902 all 8 bits as the character code.\n\
9903 QUIT is the character Emacs currently uses to quit.\n\
9904 The elements of this list correspond to the arguments of\n\
9910 val
[0] = interrupt_input
? Qt
: Qnil
;
9911 val
[1] = flow_control
? Qt
: Qnil
;
9912 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
9913 XSETFASTINT (val
[3], quit_char
);
9915 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
9920 * Set up a new kboard object with reasonable initial values.
9926 kb
->Voverriding_terminal_local_map
= Qnil
;
9927 kb
->Vlast_command
= Qnil
;
9928 kb
->Vreal_last_command
= Qnil
;
9929 kb
->Vprefix_arg
= Qnil
;
9930 kb
->Vlast_prefix_arg
= Qnil
;
9931 kb
->kbd_queue
= Qnil
;
9932 kb
->kbd_queue_has_data
= 0;
9933 kb
->immediate_echo
= 0;
9934 kb
->echoptr
= kb
->echobuf
;
9935 kb
->echo_after_prompt
= -1;
9936 kb
->kbd_macro_buffer
= 0;
9937 kb
->kbd_macro_bufsize
= 0;
9938 kb
->defining_kbd_macro
= Qnil
;
9939 kb
->Vlast_kbd_macro
= Qnil
;
9940 kb
->reference_count
= 0;
9941 kb
->Vsystem_key_alist
= Qnil
;
9942 kb
->system_key_syms
= Qnil
;
9943 kb
->Vdefault_minibuffer_frame
= Qnil
;
9947 * Destroy the contents of a kboard object, but not the object itself.
9948 * We use this just before deleting it, or if we're going to initialize
9955 if (kb
->kbd_macro_buffer
)
9956 xfree (kb
->kbd_macro_buffer
);
9965 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
9968 *kbp
= kb
->next_kboard
;
9977 /* This is correct before outermost invocation of the editor loop */
9978 command_loop_level
= -1;
9980 quit_char
= Ctl ('g');
9981 Vunread_command_events
= Qnil
;
9982 unread_command_char
= -1;
9983 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
9985 recent_keys_index
= 0;
9986 kbd_fetch_ptr
= kbd_buffer
;
9987 kbd_store_ptr
= kbd_buffer
;
9988 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
9990 do_mouse_tracking
= Qnil
;
9994 /* This means that command_loop_1 won't try to select anything the first
9996 internal_last_event_frame
= Qnil
;
9997 Vlast_event_frame
= internal_last_event_frame
;
10000 current_kboard
= initial_kboard
;
10002 wipe_kboard (current_kboard
);
10003 init_kboard (current_kboard
);
10005 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10007 signal (SIGINT
, interrupt_signal
);
10008 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10009 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10010 SIGQUIT and we can't tell which one it will give us. */
10011 signal (SIGQUIT
, interrupt_signal
);
10012 #endif /* HAVE_TERMIO */
10014 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10016 if (!noninteractive
)
10017 signal (SIGIO
, input_available_signal
);
10020 /* Use interrupt input by default, if it works and noninterrupt input
10021 has deficiencies. */
10023 #ifdef INTERRUPT_INPUT
10024 interrupt_input
= 1;
10026 interrupt_input
= 0;
10029 /* Our VMS input only works by interrupts, as of now. */
10031 interrupt_input
= 1;
10037 if (keyboard_init_hook
)
10038 (*keyboard_init_hook
) ();
10040 #ifdef POLL_FOR_INPUT
10041 poll_suppress_count
= 1;
10046 /* This type's only use is in syms_of_keyboard, to initialize the
10047 event header symbols and put properties on them. */
10048 struct event_head
{
10054 struct event_head head_table
[] = {
10055 &Qmouse_movement
, "mouse-movement", &Qmouse_movement
,
10056 &Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
,
10057 &Qswitch_frame
, "switch-frame", &Qswitch_frame
,
10058 &Qdelete_frame
, "delete-frame", &Qdelete_frame
,
10059 &Qiconify_frame
, "iconify-frame", &Qiconify_frame
,
10060 &Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
,
10064 syms_of_keyboard ()
10066 Vlispy_mouse_stem
= build_string ("mouse");
10067 staticpro (&Vlispy_mouse_stem
);
10070 QCimage
= intern (":image");
10071 staticpro (&QCimage
);
10073 staticpro (&Qhelp_echo
);
10074 Qhelp_echo
= intern ("help-echo");
10076 staticpro (&item_properties
);
10077 item_properties
= Qnil
;
10079 staticpro (&tool_bar_item_properties
);
10080 tool_bar_item_properties
= Qnil
;
10081 staticpro (&tool_bar_items_vector
);
10082 tool_bar_items_vector
= Qnil
;
10084 staticpro (&real_this_command
);
10085 real_this_command
= Qnil
;
10087 Qtimer_event_handler
= intern ("timer-event-handler");
10088 staticpro (&Qtimer_event_handler
);
10090 Qdisabled_command_hook
= intern ("disabled-command-hook");
10091 staticpro (&Qdisabled_command_hook
);
10093 Qself_insert_command
= intern ("self-insert-command");
10094 staticpro (&Qself_insert_command
);
10096 Qforward_char
= intern ("forward-char");
10097 staticpro (&Qforward_char
);
10099 Qbackward_char
= intern ("backward-char");
10100 staticpro (&Qbackward_char
);
10102 Qdisabled
= intern ("disabled");
10103 staticpro (&Qdisabled
);
10105 Qundefined
= intern ("undefined");
10106 staticpro (&Qundefined
);
10108 Qpre_command_hook
= intern ("pre-command-hook");
10109 staticpro (&Qpre_command_hook
);
10111 Qpost_command_hook
= intern ("post-command-hook");
10112 staticpro (&Qpost_command_hook
);
10114 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10115 staticpro (&Qpost_command_idle_hook
);
10117 Qdeferred_action_function
= intern ("deferred-action-function");
10118 staticpro (&Qdeferred_action_function
);
10120 Qcommand_hook_internal
= intern ("command-hook-internal");
10121 staticpro (&Qcommand_hook_internal
);
10123 Qfunction_key
= intern ("function-key");
10124 staticpro (&Qfunction_key
);
10125 Qmouse_click
= intern ("mouse-click");
10126 staticpro (&Qmouse_click
);
10128 Qmouse_wheel
= intern ("mouse-wheel");
10129 staticpro (&Qmouse_wheel
);
10130 Qlanguage_change
= intern ("language-change");
10131 staticpro (&Qlanguage_change
);
10133 Qdrag_n_drop
= intern ("drag-n-drop");
10134 staticpro (&Qdrag_n_drop
);
10136 Qusr1_signal
= intern ("usr1-signal");
10137 staticpro (&Qusr1_signal
);
10138 Qusr2_signal
= intern ("usr2-signal");
10139 staticpro (&Qusr2_signal
);
10141 Qmenu_enable
= intern ("menu-enable");
10142 staticpro (&Qmenu_enable
);
10143 Qmenu_alias
= intern ("menu-alias");
10144 staticpro (&Qmenu_alias
);
10145 QCenable
= intern (":enable");
10146 staticpro (&QCenable
);
10147 QCvisible
= intern (":visible");
10148 staticpro (&QCvisible
);
10149 QChelp
= intern (":help");
10150 staticpro (&QChelp
);
10151 QCfilter
= intern (":filter");
10152 staticpro (&QCfilter
);
10153 QCbutton
= intern (":button");
10154 staticpro (&QCbutton
);
10155 QCkeys
= intern (":keys");
10156 staticpro (&QCkeys
);
10157 QCkey_sequence
= intern (":key-sequence");
10158 staticpro (&QCkey_sequence
);
10159 QCtoggle
= intern (":toggle");
10160 staticpro (&QCtoggle
);
10161 QCradio
= intern (":radio");
10162 staticpro (&QCradio
);
10164 Qmode_line
= intern ("mode-line");
10165 staticpro (&Qmode_line
);
10166 Qvertical_line
= intern ("vertical-line");
10167 staticpro (&Qvertical_line
);
10168 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10169 staticpro (&Qvertical_scroll_bar
);
10170 Qmenu_bar
= intern ("menu-bar");
10171 staticpro (&Qmenu_bar
);
10173 Qabove_handle
= intern ("above-handle");
10174 staticpro (&Qabove_handle
);
10175 Qhandle
= intern ("handle");
10176 staticpro (&Qhandle
);
10177 Qbelow_handle
= intern ("below-handle");
10178 staticpro (&Qbelow_handle
);
10179 Qup
= intern ("up");
10181 Qdown
= intern ("down");
10182 staticpro (&Qdown
);
10183 Qtop
= intern ("top");
10185 Qbottom
= intern ("bottom");
10186 staticpro (&Qbottom
);
10187 Qend_scroll
= intern ("end-scroll");
10188 staticpro (&Qend_scroll
);
10189 Qratio
= intern ("ratio");
10190 staticpro (&Qratio
);
10192 Qevent_kind
= intern ("event-kind");
10193 staticpro (&Qevent_kind
);
10194 Qevent_symbol_elements
= intern ("event-symbol-elements");
10195 staticpro (&Qevent_symbol_elements
);
10196 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10197 staticpro (&Qevent_symbol_element_mask
);
10198 Qmodifier_cache
= intern ("modifier-cache");
10199 staticpro (&Qmodifier_cache
);
10201 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10202 staticpro (&Qrecompute_lucid_menubar
);
10203 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10204 staticpro (&Qactivate_menubar_hook
);
10206 Qpolling_period
= intern ("polling-period");
10207 staticpro (&Qpolling_period
);
10209 Qinput_method_function
= intern ("input-method-function");
10210 staticpro (&Qinput_method_function
);
10212 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10213 staticpro (&Qinput_method_exit_on_first_char
);
10214 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10215 staticpro (&Qinput_method_use_echo_area
);
10217 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10218 Fset (Qinput_method_use_echo_area
, Qnil
);
10220 last_point_position_buffer
= Qnil
;
10223 struct event_head
*p
;
10225 for (p
= head_table
;
10226 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10229 *p
->var
= intern (p
->name
);
10230 staticpro (p
->var
);
10231 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10232 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10236 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10237 staticpro (&button_down_location
);
10238 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10239 staticpro (&mouse_syms
);
10243 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10245 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10246 for (i
= 0; i
< len
; i
++)
10247 if (modifier_names
[i
])
10248 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10249 staticpro (&modifier_symbols
);
10252 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10253 staticpro (&recent_keys
);
10255 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10256 staticpro (&this_command_keys
);
10258 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10259 staticpro (&raw_keybuf
);
10261 Qextended_command_history
= intern ("extended-command-history");
10262 Fset (Qextended_command_history
, Qnil
);
10263 staticpro (&Qextended_command_history
);
10265 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10266 staticpro (&kbd_buffer_gcpro
);
10268 accent_key_syms
= Qnil
;
10269 staticpro (&accent_key_syms
);
10271 func_key_syms
= Qnil
;
10272 staticpro (&func_key_syms
);
10275 mouse_wheel_syms
= Qnil
;
10276 staticpro (&mouse_wheel_syms
);
10278 drag_n_drop_syms
= Qnil
;
10279 staticpro (&drag_n_drop_syms
);
10282 unread_switch_frame
= Qnil
;
10283 staticpro (&unread_switch_frame
);
10285 internal_last_event_frame
= Qnil
;
10286 staticpro (&internal_last_event_frame
);
10288 read_key_sequence_cmd
= Qnil
;
10289 staticpro (&read_key_sequence_cmd
);
10291 menu_bar_one_keymap_changed_items
= Qnil
;
10292 staticpro (&menu_bar_one_keymap_changed_items
);
10294 defsubr (&Sevent_convert_list
);
10295 defsubr (&Sread_key_sequence
);
10296 defsubr (&Sread_key_sequence_vector
);
10297 defsubr (&Srecursive_edit
);
10299 defsubr (&Strack_mouse
);
10301 defsubr (&Sinput_pending_p
);
10302 defsubr (&Scommand_execute
);
10303 defsubr (&Srecent_keys
);
10304 defsubr (&Sthis_command_keys
);
10305 defsubr (&Sthis_command_keys_vector
);
10306 defsubr (&Sthis_single_command_keys
);
10307 defsubr (&Sthis_single_command_raw_keys
);
10308 defsubr (&Sreset_this_command_lengths
);
10309 defsubr (&Sclear_this_command_keys
);
10310 defsubr (&Ssuspend_emacs
);
10311 defsubr (&Sabort_recursive_edit
);
10312 defsubr (&Sexit_recursive_edit
);
10313 defsubr (&Srecursion_depth
);
10314 defsubr (&Stop_level
);
10315 defsubr (&Sdiscard_input
);
10316 defsubr (&Sopen_dribble_file
);
10317 defsubr (&Sset_input_mode
);
10318 defsubr (&Scurrent_input_mode
);
10319 defsubr (&Sexecute_extended_command
);
10321 DEFVAR_LISP ("last-command-char", &last_command_char
,
10322 "Last input event that was part of a command.");
10324 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10325 "Last input event that was part of a command.");
10327 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10328 "Last input event in a command, except for mouse menu events.\n\
10329 Mouse menus give back keys that don't look like mouse events;\n\
10330 this variable holds the actual mouse event that led to the menu,\n\
10331 so that you can determine whether the command was run by mouse or not.");
10333 DEFVAR_LISP ("last-input-char", &last_input_char
,
10334 "Last input event.");
10336 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10337 "Last input event.");
10339 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10340 "List of events to be read as the command input.\n\
10341 These events are processed first, before actual keyboard input.");
10342 Vunread_command_events
= Qnil
;
10344 DEFVAR_INT ("unread-command-char", &unread_command_char
,
10345 "If not -1, an object to be read as next command input event.");
10347 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
10348 "List of events to be processed as input by input methods.\n\
10349 These events are processed after `unread-command-events', but\n\
10350 before actual keyboard input.");
10351 Vunread_post_input_method_events
= Qnil
;
10353 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
10354 "List of events to be processed as input by input methods.\n\
10355 These events are processed after `unread-command-events', but\n\
10356 before actual keyboard input.");
10357 Vunread_input_method_events
= Qnil
;
10359 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
10360 "Meta-prefix character code.\n\
10361 Meta-foo as command input turns into this character followed by foo.");
10362 XSETINT (meta_prefix_char
, 033);
10364 DEFVAR_KBOARD ("last-command", Vlast_command
,
10365 "The last command executed.\n\
10366 Normally a symbol with a function definition, but can be whatever was found\n\
10367 in the keymap, or whatever the variable `this-command' was set to by that\n\
10370 The value `mode-exit' is special; it means that the previous command\n\
10371 read an event that told it to exit, and it did so and unread that event.\n\
10372 In other words, the present command is the event that made the previous\n\
10375 The value `kill-region' is special; it means that the previous command\n\
10376 was a kill command.");
10378 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
10379 "Same as `last-command', but never altered by Lisp code.");
10381 DEFVAR_LISP ("this-command", &Vthis_command
,
10382 "The command now being executed.\n\
10383 The command can set this variable; whatever is put here\n\
10384 will be in `last-command' during the following command.");
10385 Vthis_command
= Qnil
;
10387 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
10388 "*Number of input events between auto-saves.\n\
10389 Zero means disable autosaving due to number of characters typed.");
10390 auto_save_interval
= 300;
10392 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
10393 "*Number of seconds idle time before auto-save.\n\
10394 Zero or nil means disable auto-saving due to idleness.\n\
10395 After auto-saving due to this many seconds of idle time,\n\
10396 Emacs also does a garbage collection if that seems to be warranted.");
10397 XSETFASTINT (Vauto_save_timeout
, 30);
10399 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
10400 "*Nonzero means echo unfinished commands after this many seconds of pause.\n\
10401 The value may be integer or floating point.");
10402 Vecho_keystrokes
= make_number (1);
10404 DEFVAR_INT ("polling-period", &polling_period
,
10405 "*Interval between polling for input during Lisp execution.\n\
10406 The reason for polling is to make C-g work to stop a running program.\n\
10407 Polling is needed only when using X windows and SIGIO does not work.\n\
10408 Polling is automatically disabled in all other cases.");
10409 polling_period
= 2;
10411 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
10412 "*Maximum time between mouse clicks to make a double-click.\n\
10413 Measured in milliseconds. nil means disable double-click recognition;\n\
10414 t means double-clicks have no time limit and are detected\n\
10415 by position only.");
10416 Vdouble_click_time
= make_number (500);
10418 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
10419 "*Non-nil means inhibit local map menu bar menus.");
10420 inhibit_local_menu_bar_menus
= 0;
10422 DEFVAR_INT ("num-input-keys", &num_input_keys
,
10423 "Number of complete key sequences read as input so far.\n\
10424 This includes key sequences read from keyboard macros.\n\
10425 The number is effectively the number of interactive command invocations.");
10426 num_input_keys
= 0;
10428 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
10429 "Number of input events read from the keyboard so far.\n\
10430 This does not include events generated by keyboard macros.");
10431 num_nonmacro_input_events
= 0;
10433 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
10434 "The frame in which the most recently read event occurred.\n\
10435 If the last event came from a keyboard macro, this is set to `macro'.");
10436 Vlast_event_frame
= Qnil
;
10438 /* This variable is set up in sysdep.c. */
10439 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
10440 "The ERASE character as set by the user with stty.");
10442 DEFVAR_LISP ("help-char", &Vhelp_char
,
10443 "Character to recognize as meaning Help.\n\
10444 When it is read, do `(eval help-form)', and display result if it's a string.\n\
10445 If the value of `help-form' is nil, this char can be read normally.");
10446 XSETINT (Vhelp_char
, Ctl ('H'));
10448 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
10449 "List of input events to recognize as meaning Help.\n\
10450 These work just like the value of `help-char' (see that).");
10451 Vhelp_event_list
= Qnil
;
10453 DEFVAR_LISP ("help-form", &Vhelp_form
,
10454 "Form to execute when character `help-char' is read.\n\
10455 If the form returns a string, that string is displayed.\n\
10456 If `help-form' is nil, the help char is not recognized.");
10459 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
10460 "Command to run when `help-char' character follows a prefix key.\n\
10461 This command is used only when there is no actual binding\n\
10462 for that character after that prefix key.");
10463 Vprefix_help_command
= Qnil
;
10465 DEFVAR_LISP ("top-level", &Vtop_level
,
10466 "Form to evaluate when Emacs starts up.\n\
10467 Useful to set before you dump a modified Emacs.");
10470 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
10471 "Translate table for keyboard input, or nil.\n\
10472 Each character is looked up in this string and the contents used instead.\n\
10473 The value may be a string, a vector, or a char-table.\n\
10474 If it is a string or vector of length N,\n\
10475 character codes N and up are untranslated.\n\
10476 In a vector or a char-table, an element which is nil means \"no translation\".");
10477 Vkeyboard_translate_table
= Qnil
;
10479 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
10480 "Non-nil means to always spawn a subshell instead of suspending.\n\
10481 \(Even if the operating system has support for stopping a process.\)");
10482 cannot_suspend
= 0;
10484 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
10485 "Non-nil means prompt with menus when appropriate.\n\
10486 This is done when reading from a keymap that has a prompt string,\n\
10487 for elements that have prompt strings.\n\
10488 The menu is displayed on the screen\n\
10489 if X menus were enabled at configuration\n\
10490 time and the previous event was a mouse click prefix key.\n\
10491 Otherwise, menu prompting uses the echo area.");
10492 menu_prompting
= 1;
10494 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
10495 "Character to see next line of menu prompt.\n\
10496 Type this character while in a menu prompt to rotate around the lines of it.");
10497 XSETINT (menu_prompt_more_char
, ' ');
10499 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
10500 "A mask of additional modifier keys to use with every keyboard character.\n\
10501 Emacs applies the modifiers of the character stored here to each keyboard\n\
10502 character it reads. For example, after evaluating the expression\n\
10503 (setq extra-keyboard-modifiers ?\\C-x)\n\
10504 all input characters will have the control modifier applied to them.\n\
10506 Note that the character ?\\C-@, equivalent to the integer zero, does\n\
10507 not count as a control character; rather, it counts as a character\n\
10508 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero\n\
10509 cancels any modification.");
10510 extra_keyboard_modifiers
= 0;
10512 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
10513 "If an editing command sets this to t, deactivate the mark afterward.\n\
10514 The command loop sets this to nil before each command,\n\
10515 and tests the value when the command returns.\n\
10516 Buffer modification stores t in this variable.");
10517 Vdeactivate_mark
= Qnil
;
10519 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
10520 "Temporary storage of pre-command-hook or post-command-hook.");
10521 Vcommand_hook_internal
= Qnil
;
10523 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
10524 "Normal hook run before each command is executed.\n\
10525 If an unhandled error happens in running this hook,\n\
10526 the hook value is set to nil, since otherwise the error\n\
10527 might happen repeatedly and make Emacs nonfunctional.");
10528 Vpre_command_hook
= Qnil
;
10530 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
10531 "Normal hook run after each command is executed.\n\
10532 If an unhandled error happens in running this hook,\n\
10533 the hook value is set to nil, since otherwise the error\n\
10534 might happen repeatedly and make Emacs nonfunctional.");
10535 Vpost_command_hook
= Qnil
;
10537 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
10538 "Normal hook run after each command is executed, if idle.\n\
10539 Errors running the hook are caught and ignored.\n\
10540 This feature is obsolete; use idle timers instead. See `etc/NEWS'.");
10541 Vpost_command_idle_hook
= Qnil
;
10543 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
10544 "Delay time before running `post-command-idle-hook'.\n\
10545 This is measured in microseconds.");
10546 post_command_idle_delay
= 100000;
10549 DEFVAR_LISP ("echo-area-clear-hook", ...,
10550 "Normal hook run when clearing the echo area.");
10552 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
10553 XSYMBOL (Qecho_area_clear_hook
)->value
= Qnil
;
10555 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
10556 "t means menu bar, specified Lucid style, needs to be recomputed.");
10557 Vlucid_menu_bar_dirty_flag
= Qnil
;
10559 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
10560 "List of menu bar items to move to the end of the menu bar.\n\
10561 The elements of the list are event types that may have menu bar bindings.");
10562 Vmenu_bar_final_items
= Qnil
;
10564 DEFVAR_KBOARD ("overriding-terminal-local-map",
10565 Voverriding_terminal_local_map
,
10566 "Per-terminal keymap that overrides all other local keymaps.\n\
10567 If this variable is non-nil, it is used as a keymap instead of the\n\
10568 buffer's local map, and the minor mode keymaps and text property keymaps.\n\
10569 This variable is intended to let commands such as `universal-argumemnt'\n\
10570 set up a different keymap for reading the next command.");
10572 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
10573 "Keymap that overrides all other local keymaps.\n\
10574 If this variable is non-nil, it is used as a keymap instead of the\n\
10575 buffer's local map, and the minor mode keymaps and text property keymaps.");
10576 Voverriding_local_map
= Qnil
;
10578 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
10579 "Non-nil means `overriding-local-map' applies to the menu bar.\n\
10580 Otherwise, the menu bar continues to reflect the buffer's local map\n\
10581 and the minor mode maps regardless of `overriding-local-map'.");
10582 Voverriding_local_map_menu_flag
= Qnil
;
10584 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
10585 "Keymap defining bindings for special events to execute at low level.");
10586 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
10588 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
10589 "*Non-nil means generate motion events for mouse motion.");
10591 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
10592 "Alist of system-specific X windows key symbols.\n\
10593 Each element should have the form (N . SYMBOL) where N is the\n\
10594 numeric keysym code (sans the \"system-specific\" bit 1<<28)\n\
10595 and SYMBOL is its name.");
10597 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
10598 "List of deferred actions to be performed at a later time.\n\
10599 The precise format isn't relevant here; we just check whether it is nil.");
10600 Vdeferred_action_list
= Qnil
;
10602 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
10603 "Function to call to handle deferred actions, after each command.\n\
10604 This function is called with no arguments after each command\n\
10605 whenever `deferred-action-list' is non-nil.");
10606 Vdeferred_action_function
= Qnil
;
10608 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
10609 "*Non-nil means show the equivalent key-binding when M-x command has one.\n\
10610 The value can be a length of time to show the message for.\n\
10611 If the value is non-nil and not a number, we wait 2 seconds.");
10612 Vsuggest_key_bindings
= Qt
;
10614 DEFVAR_LISP ("timer-list", &Vtimer_list
,
10615 "List of active absolute time timers in order of increasing time");
10616 Vtimer_list
= Qnil
;
10618 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
10619 "List of active idle-time timers in order of increasing time");
10620 Vtimer_idle_list
= Qnil
;
10622 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
10623 "If non-nil, the function that implements the current input method.\n\
10624 It's called with one argument, a printing character that was just read.\n\
10625 \(That means a character with code 040...0176.)\n\
10626 Typically this function uses `read-event' to read additional events.\n\
10627 When it does so, it should first bind `input-method-function' to nil\n\
10628 so it will not be called recursively.\n\
10630 The function should return a list of zero or more events\n\
10631 to be used as input. If it wants to put back some events\n\
10632 to be reconsidered, separately, by the input method,\n\
10633 it can add them to the beginning of `unread-command-events'.\n\
10635 The input method function can find in `input-method-previous-method'\n\
10636 the previous echo area message.\n\
10638 The input method function should refer to the variables\n\
10639 `input-method-use-echo-area' and `input-method-exit-on-first-char'\n\
10640 for guidance on what to do.");
10641 Vinput_method_function
= Qnil
;
10643 DEFVAR_LISP ("input-method-previous-message",
10644 &Vinput_method_previous_message
,
10645 "When `input-method-function' is called, hold the previous echo area message.\n\
10646 This variable exists because `read-event' clears the echo area\n\
10647 before running the input method. It is nil if there was no message.");
10648 Vinput_method_previous_message
= Qnil
;
10650 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
10651 "If non-nil, the function that implements the display of help.\n\
10652 It's called with one argument, the help string to display.");
10653 Vshow_help_function
= Qnil
;
10655 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
10656 "If non-nil, suppress point adjustment after executing a command.\n\
10658 After a command is executed, if point is moved into a region that has\n\
10659 special properties (e.g. composition, display), we adjust point to\n\
10660 the boundary of the region. But, several special commands sets this\n\
10661 variable to non-nil, then we suppress the point adjustment.\n\
10663 This variable is set to nil before reading a command, and is checked\n\
10664 just after executing the command");
10665 Vdisable_point_adjustment
= Qnil
;
10667 DEFVAR_LISP ("global-disable-point-adjustment",
10668 &Vglobal_disable_point_adjustment
,
10669 "*If non-nil, always suppress point adjustment.\n\
10671 The default value is nil, in which case, point adjustment are\n\
10672 suppressed only after special commands that set\n\
10673 `disable-point-adjustment' (which see) to non-nil.");
10674 Vglobal_disable_point_adjustment
= Qnil
;
10676 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
10677 "Non-nil means updating menu bindings is allowed.\n\
10678 A value of nil means menu bindings should not be updated.\n\
10679 Used during Emacs' startup.");
10680 update_menu_bindings
= 1;
10682 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
10683 "*How long to display an echo-area message when the minibuffer is active.\n\
10684 If the value is not a number, such messages don't time out.");
10685 Vminibuffer_message_timeout
= make_number (2);
10689 keys_of_keyboard ()
10691 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
10692 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
10693 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
10694 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
10695 initial_define_key (meta_map
, 'x', "execute-extended-command");
10697 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
10698 "handle-delete-frame");
10699 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
10701 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",