1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96,97,99,2000,01,02,03
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. */
26 #include "systty.h" /* This must be included befor termchar.h. */
29 #include "termhooks.h"
38 #include "dispextern.h"
40 #include "intervals.h"
42 #include "blockinput.h"
54 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #include "syssignal.h"
60 #include <sys/types.h>
65 /* This is to get the definitions of the XK_ symbols. */
72 #endif /* HAVE_NTGUI */
82 /* Variables for blockinput.h: */
84 /* Non-zero if interrupt input is blocked right now. */
85 int interrupt_input_blocked
;
87 /* Nonzero means an input interrupt has arrived
88 during the current critical section. */
89 int interrupt_input_pending
;
92 #ifdef HAVE_WINDOW_SYSTEM
93 /* Make all keyboard buffers much bigger when using X windows. */
95 /* But not too big (local data > 32K error) if on Mac OS Classic. */
96 #define KBD_BUFFER_SIZE 512
98 #define KBD_BUFFER_SIZE 4096
100 #else /* No X-windows, character input */
101 #define KBD_BUFFER_SIZE 4096
102 #endif /* No X-windows */
104 #define abs(x) ((x) >= 0 ? (x) : -(x))
106 /* Following definition copied from eval.c */
110 struct backtrace
*next
;
111 Lisp_Object
*function
;
112 Lisp_Object
*args
; /* Points to vector of args. */
113 int nargs
; /* length of vector. If nargs is UNEVALLED,
114 args points to slot holding list of
120 KBOARD
*initial_kboard
;
121 KBOARD
*current_kboard
;
125 KBOARD the_only_kboard
;
128 /* Non-nil disable property on a command means
129 do not execute it; call disabled-command-hook's value instead. */
130 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
132 #define NUM_RECENT_KEYS (100)
133 int recent_keys_index
; /* Index for storing next element into recent_keys */
134 int total_keys
; /* Total number of elements stored into recent_keys */
135 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
137 /* Vector holding the key sequence that invoked the current command.
138 It is reused for each command, and it may be longer than the current
139 sequence; this_command_key_count indicates how many elements
140 actually mean something.
141 It's easier to staticpro a single Lisp_Object than an array. */
142 Lisp_Object this_command_keys
;
143 int this_command_key_count
;
145 /* 1 after calling Freset_this_command_lengths.
147 int this_command_key_count_reset
;
149 /* This vector is used as a buffer to record the events that were actually read
150 by read_key_sequence. */
151 Lisp_Object raw_keybuf
;
152 int raw_keybuf_count
;
154 #define GROW_RAW_KEYBUF \
155 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
157 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
159 new = Fmake_vector (make_number (newsize), Qnil); \
160 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
161 raw_keybuf_count * sizeof (Lisp_Object)); \
165 /* Number of elements of this_command_keys
166 that precede this key sequence. */
167 int this_single_command_key_start
;
169 /* Record values of this_command_key_count and echo_length ()
170 before this command was read. */
171 static int before_command_key_count
;
172 static int before_command_echo_length
;
174 extern int minbuf_level
;
176 extern int message_enable_multibyte
;
178 extern struct backtrace
*backtrace_list
;
180 /* If non-nil, the function that implements the display of help.
181 It's called with one argument, the help string to display. */
183 Lisp_Object Vshow_help_function
;
185 /* If a string, the message displayed before displaying a help-echo
188 Lisp_Object Vpre_help_message
;
190 /* Nonzero means do menu prompting. */
192 static int menu_prompting
;
194 /* Character to see next line of menu prompt. */
196 static Lisp_Object menu_prompt_more_char
;
198 /* For longjmp to where kbd input is being done. */
200 static jmp_buf getcjmp
;
202 /* True while doing kbd input. */
203 int waiting_for_input
;
205 /* True while displaying for echoing. Delays C-g throwing. */
209 /* Non-null means we can start echoing at the next input pause even
210 though there is something in the echo area. */
212 static struct kboard
*ok_to_echo_at_next_pause
;
214 /* The kboard last echoing, or null for none. Reset to 0 in
215 cancel_echoing. If non-null, and a current echo area message
216 exists, and echo_message_buffer is eq to the current message
217 buffer, we know that the message comes from echo_kboard. */
219 struct kboard
*echo_kboard
;
221 /* The buffer used for echoing. Set in echo_now, reset in
224 Lisp_Object echo_message_buffer
;
226 /* Nonzero means disregard local maps for the menu bar. */
227 static int inhibit_local_menu_bar_menus
;
229 /* Nonzero means C-g should cause immediate error-signal. */
232 /* The user's ERASE setting. */
233 Lisp_Object Vtty_erase_char
;
235 /* Character to recognize as the help char. */
236 Lisp_Object Vhelp_char
;
238 /* List of other event types to recognize as meaning "help". */
239 Lisp_Object Vhelp_event_list
;
241 /* Form to execute when help char is typed. */
242 Lisp_Object Vhelp_form
;
244 /* Command to run when the help character follows a prefix key. */
245 Lisp_Object Vprefix_help_command
;
247 /* List of items that should move to the end of the menu bar. */
248 Lisp_Object Vmenu_bar_final_items
;
250 /* Non-nil means show the equivalent key-binding for
251 any M-x command that has one.
252 The value can be a length of time to show the message for.
253 If the value is non-nil and not a number, we wait 2 seconds. */
254 Lisp_Object Vsuggest_key_bindings
;
256 /* How long to display an echo-area message when the minibuffer is active.
257 If the value is not a number, such messages don't time out. */
258 Lisp_Object Vminibuffer_message_timeout
;
260 /* Character that causes a quit. Normally C-g.
262 If we are running on an ordinary terminal, this must be an ordinary
263 ASCII char, since we want to make it our interrupt character.
265 If we are not running on an ordinary terminal, it still needs to be
266 an ordinary ASCII char. This character needs to be recognized in
267 the input interrupt handler. At this point, the keystroke is
268 represented as a struct input_event, while the desired quit
269 character is specified as a lispy event. The mapping from struct
270 input_events to lispy events cannot run in an interrupt handler,
271 and the reverse mapping is difficult for anything but ASCII
274 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
278 extern Lisp_Object current_global_map
;
279 extern int minibuf_level
;
281 /* If non-nil, this is a map that overrides all other local maps. */
282 Lisp_Object Voverriding_local_map
;
284 /* If non-nil, Voverriding_local_map applies to the menu bar. */
285 Lisp_Object Voverriding_local_map_menu_flag
;
287 /* Keymap that defines special misc events that should
288 be processed immediately at a low level. */
289 Lisp_Object Vspecial_event_map
;
291 /* Current depth in recursive edits. */
292 int command_loop_level
;
294 /* Total number of times command_loop has read a key sequence. */
295 EMACS_INT num_input_keys
;
297 /* Last input character read as a command. */
298 Lisp_Object last_command_char
;
300 /* Last input character read as a command, not counting menus
301 reached by the mouse. */
302 Lisp_Object last_nonmenu_event
;
304 /* Last input character read for any purpose. */
305 Lisp_Object last_input_char
;
307 /* If not Qnil, a list of objects to be read as subsequent command input. */
308 Lisp_Object Vunread_command_events
;
310 /* If not Qnil, a list of objects to be read as subsequent command input
311 including input method processing. */
312 Lisp_Object Vunread_input_method_events
;
314 /* If not Qnil, a list of objects to be read as subsequent command input
315 but NOT including input method processing. */
316 Lisp_Object Vunread_post_input_method_events
;
318 /* If not -1, an event to be read as subsequent command input. */
319 EMACS_INT unread_command_char
;
321 /* If not Qnil, this is a switch-frame event which we decided to put
322 off until the end of a key sequence. This should be read as the
323 next command input, after any unread_command_events.
325 read_key_sequence uses this to delay switch-frame events until the
326 end of the key sequence; Fread_char uses it to put off switch-frame
327 events until a non-ASCII event is acceptable as input. */
328 Lisp_Object unread_switch_frame
;
330 /* A mask of extra modifier bits to put into every keyboard char. */
331 EMACS_INT extra_keyboard_modifiers
;
333 /* Char to use as prefix when a meta character is typed in.
334 This is bound on entry to minibuffer in case ESC is changed there. */
336 Lisp_Object meta_prefix_char
;
338 /* Last size recorded for a current buffer which is not a minibuffer. */
339 static int last_non_minibuf_size
;
341 /* Number of idle seconds before an auto-save and garbage collection. */
342 static Lisp_Object Vauto_save_timeout
;
344 /* Total number of times read_char has returned. */
345 int num_input_events
;
347 /* Total number of times read_char has returned, outside of macros. */
348 EMACS_INT num_nonmacro_input_events
;
350 /* Auto-save automatically when this many characters have been typed
351 since the last time. */
353 static EMACS_INT auto_save_interval
;
355 /* Value of num_nonmacro_input_events as of last auto save. */
359 /* The command being executed by the command loop.
360 Commands may set this, and the value set will be copied into
361 current_kboard->Vlast_command instead of the actual command. */
362 Lisp_Object Vthis_command
;
364 /* This is like Vthis_command, except that commands never set it. */
365 Lisp_Object real_this_command
;
367 /* If the lookup of the command returns a binding, the original
368 command is stored in this-original-command. It is nil otherwise. */
369 Lisp_Object Vthis_original_command
;
371 /* The value of point when the last command was executed. */
372 int last_point_position
;
374 /* The buffer that was current when the last command was started. */
375 Lisp_Object last_point_position_buffer
;
377 /* The frame in which the last input event occurred, or Qmacro if the
378 last event came from a macro. We use this to determine when to
379 generate switch-frame events. This may be cleared by functions
380 like Fselect_frame, to make sure that a switch-frame event is
381 generated by the next character. */
382 Lisp_Object internal_last_event_frame
;
384 /* A user-visible version of the above, intended to allow users to
385 figure out where the last event came from, if the event doesn't
386 carry that information itself (i.e. if it was a character). */
387 Lisp_Object Vlast_event_frame
;
389 /* The timestamp of the last input event we received from the X server.
390 X Windows wants this for selection ownership. */
391 unsigned long last_event_timestamp
;
393 Lisp_Object Qself_insert_command
;
394 Lisp_Object Qforward_char
;
395 Lisp_Object Qbackward_char
;
396 Lisp_Object Qundefined
;
397 Lisp_Object Qtimer_event_handler
;
399 /* read_key_sequence stores here the command definition of the
400 key sequence that it reads. */
401 Lisp_Object read_key_sequence_cmd
;
403 /* Echo unfinished commands after this many seconds of pause. */
404 Lisp_Object Vecho_keystrokes
;
406 /* Form to evaluate (if non-nil) when Emacs is started. */
407 Lisp_Object Vtop_level
;
409 /* User-supplied table to translate input characters. */
410 Lisp_Object Vkeyboard_translate_table
;
412 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
413 extern Lisp_Object Vfunction_key_map
;
415 /* Another keymap that maps key sequences into key sequences.
416 This one takes precedence over ordinary definitions. */
417 extern Lisp_Object Vkey_translation_map
;
419 /* If non-nil, this implements the current input method. */
420 Lisp_Object Vinput_method_function
;
421 Lisp_Object Qinput_method_function
;
423 /* When we call Vinput_method_function,
424 this holds the echo area message that was just erased. */
425 Lisp_Object Vinput_method_previous_message
;
427 /* Non-nil means deactivate the mark at end of this command. */
428 Lisp_Object Vdeactivate_mark
;
430 /* Menu bar specified in Lucid Emacs fashion. */
432 Lisp_Object Vlucid_menu_bar_dirty_flag
;
433 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
435 Lisp_Object Qecho_area_clear_hook
;
437 /* Hooks to run before and after each command. */
438 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
439 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
440 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
441 /* Hook run after a command if there's no more input soon. */
442 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
444 /* Delay time in microseconds before running post-command-idle-hook. */
445 EMACS_INT post_command_idle_delay
;
447 /* List of deferred actions to be performed at a later time.
448 The precise format isn't relevant here; we just check whether it is nil. */
449 Lisp_Object Vdeferred_action_list
;
451 /* Function to call to handle deferred actions, when there are any. */
452 Lisp_Object Vdeferred_action_function
;
453 Lisp_Object Qdeferred_action_function
;
455 Lisp_Object Qinput_method_exit_on_first_char
;
456 Lisp_Object Qinput_method_use_echo_area
;
458 /* File in which we write all commands we read. */
461 /* Nonzero if input is available. */
464 /* Non-zero means force key bindings update in parse_menu_item. */
466 int update_menu_bindings
;
468 extern char *pending_malloc_warning
;
470 /* Circular buffer for pre-read keyboard input. */
472 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
474 /* Vector to GCPRO the Lisp objects referenced from kbd_buffer.
476 The interrupt-level event handlers will never enqueue an event on a
477 frame which is not in Vframe_list, and once an event is dequeued,
478 internal_last_event_frame or the event itself points to the frame.
481 But while the event is sitting in the queue, it's completely
482 unprotected. Suppose the user types one command which will run for
483 a while and then delete a frame, and then types another event at
484 the frame that will be deleted, before the command gets around to
485 it. Suppose there are no references to this frame elsewhere in
486 Emacs, and a GC occurs before the second event is dequeued. Now we
487 have an event referring to a freed frame, which will crash Emacs
490 Similar things happen when an event on a scroll bar is enqueued; the
491 window may be deleted while the event is in the queue.
493 So, we use this vector to protect the Lisp_Objects in the event
494 queue. That way, they'll be dequeued as dead frames or windows,
495 but still valid Lisp objects.
497 If kbd_buffer[i].kind != NO_EVENT, then
499 AREF (kbd_buffer_gcpro, 2 * i) == kbd_buffer[i].frame_or_window.
500 AREF (kbd_buffer_gcpro, 2 * i + 1) == kbd_buffer[i].arg. */
502 static Lisp_Object kbd_buffer_gcpro
;
504 /* Pointer to next available character in kbd_buffer.
505 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
506 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
507 next available char is in kbd_buffer[0]. */
508 static struct input_event
*kbd_fetch_ptr
;
510 /* Pointer to next place to store character in kbd_buffer. This
511 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
512 character should go in kbd_buffer[0]. */
513 static struct input_event
* volatile kbd_store_ptr
;
515 /* The above pair of variables forms a "queue empty" flag. When we
516 enqueue a non-hook event, we increment kbd_store_ptr. When we
517 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
518 there is input available iff the two pointers are not equal.
520 Why not just have a flag set and cleared by the enqueuing and
521 dequeuing functions? Such a flag could be screwed up by interrupts
522 at inopportune times. */
524 /* If this flag is non-nil, we check mouse_moved to see when the
525 mouse moves, and motion events will appear in the input stream.
526 Otherwise, mouse motion is ignored. */
527 Lisp_Object do_mouse_tracking
;
529 /* Symbols to head events. */
530 Lisp_Object Qmouse_movement
;
531 Lisp_Object Qscroll_bar_movement
;
532 Lisp_Object Qswitch_frame
;
533 Lisp_Object Qdelete_frame
;
534 Lisp_Object Qiconify_frame
;
535 Lisp_Object Qmake_frame_visible
;
536 Lisp_Object Qselect_window
;
537 Lisp_Object Qhelp_echo
;
539 /* Symbols to denote kinds of events. */
540 Lisp_Object Qfunction_key
;
541 Lisp_Object Qmouse_click
;
543 Lisp_Object Qlanguage_change
;
545 Lisp_Object Qdrag_n_drop
;
546 Lisp_Object Qsave_session
;
548 /* Lisp_Object Qmouse_movement; - also an event header */
550 /* Properties of event headers. */
551 Lisp_Object Qevent_kind
;
552 Lisp_Object Qevent_symbol_elements
;
554 /* menu item parts */
555 Lisp_Object Qmenu_alias
;
556 Lisp_Object Qmenu_enable
;
557 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
558 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
559 extern Lisp_Object Vdefine_key_rebound_commands
;
560 extern Lisp_Object Qmenu_item
;
562 /* An event header symbol HEAD may have a property named
563 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
564 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
565 mask of modifiers applied to it. If present, this is used to help
566 speed up parse_modifiers. */
567 Lisp_Object Qevent_symbol_element_mask
;
569 /* An unmodified event header BASE may have a property named
570 Qmodifier_cache, which is an alist mapping modifier masks onto
571 modified versions of BASE. If present, this helps speed up
573 Lisp_Object Qmodifier_cache
;
575 /* Symbols to use for parts of windows. */
576 Lisp_Object Qmode_line
;
577 Lisp_Object Qvertical_line
;
578 Lisp_Object Qvertical_scroll_bar
;
579 Lisp_Object Qmenu_bar
;
580 extern Lisp_Object Qleft_margin
, Qright_margin
;
581 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
582 extern Lisp_Object QCmap
;
584 Lisp_Object
recursive_edit_unwind (), command_loop ();
585 Lisp_Object
Fthis_command_keys ();
586 Lisp_Object Qextended_command_history
;
587 EMACS_TIME
timer_check ();
589 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
591 extern char *x_get_keysym_name ();
593 static void record_menu_key ();
594 static int echo_length ();
596 Lisp_Object Qpolling_period
;
598 /* List of absolute timers. Appears in order of next scheduled event. */
599 Lisp_Object Vtimer_list
;
601 /* List of idle time timers. Appears in order of next scheduled event. */
602 Lisp_Object Vtimer_idle_list
;
604 /* Incremented whenever a timer is run. */
607 extern Lisp_Object Vprint_level
, Vprint_length
;
609 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
611 EMACS_TIME
*input_available_clear_time
;
613 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
614 Default is 1 if INTERRUPT_INPUT is defined. */
617 /* Nonzero while interrupts are temporarily deferred during redisplay. */
618 int interrupts_deferred
;
620 /* Nonzero means use ^S/^Q for flow control. */
623 /* Allow m- file to inhibit use of FIONREAD. */
624 #ifdef BROKEN_FIONREAD
628 /* We are unable to use interrupts if FIONREAD is not available,
629 so flush SIGIO so we won't try. */
636 /* If we support a window system, turn on the code to poll periodically
637 to detect C-g. It isn't actually used when doing interrupt input. */
638 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
639 #define POLL_FOR_INPUT
642 /* After a command is executed, if point is moved into a region that
643 has specific properties (e.g. composition, display), we adjust
644 point to the boundary of the region. But, if a command sets this
645 variable to non-nil, we suppress this point adjustment. This
646 variable is set to nil before reading a command. */
648 Lisp_Object Vdisable_point_adjustment
;
650 /* If non-nil, always disable point adjustment. */
652 Lisp_Object Vglobal_disable_point_adjustment
;
654 /* The time when Emacs started being idle. */
656 static EMACS_TIME timer_idleness_start_time
;
658 /* After Emacs stops being idle, this saves the last value
659 of timer_idleness_start_time from when it was idle. */
661 static EMACS_TIME timer_last_idleness_start_time
;
664 /* Global variable declarations. */
666 /* Function for init_keyboard to call with no args (if nonzero). */
667 void (*keyboard_init_hook
) ();
669 static int read_avail_input
P_ ((int));
670 static void get_input_pending
P_ ((int *, int));
671 static void get_filtered_input_pending
P_ ((int *, int, int));
672 static int readable_events
P_ ((int));
673 static int readable_filtered_events
P_ ((int, int));
674 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
675 Lisp_Object
, int *));
676 static Lisp_Object
read_char_x_menu_prompt ();
677 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
679 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
681 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
682 enum scroll_bar_part
,
683 Lisp_Object
, Lisp_Object
,
686 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
687 Lisp_Object
, char **,
688 Lisp_Object
*, unsigned));
689 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
690 static int parse_solitary_modifier
P_ ((Lisp_Object
));
691 static int parse_solitary_modifier ();
692 static void save_getcjmp
P_ ((jmp_buf));
693 static void save_getcjmp ();
694 static void restore_getcjmp
P_ ((jmp_buf));
695 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
696 static void clear_event
P_ ((struct input_event
*));
697 static void any_kboard_state
P_ ((void));
698 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
700 /* Nonzero means don't try to suspend even if the operating system seems
702 static int cannot_suspend
;
704 /* Install the string STR as the beginning of the string of echoing,
705 so that it serves as a prompt for the next character.
706 Also start echoing. */
712 current_kboard
->echo_string
= str
;
713 current_kboard
->echo_after_prompt
= SCHARS (str
);
717 /* Add C to the echo string, if echoing is going on.
718 C can be a character, which is printed prettily ("M-C-x" and all that
719 jazz), or a symbol, whose name is printed. */
725 if (current_kboard
->immediate_echo
)
727 int size
= KEY_DESCRIPTION_SIZE
+ 100;
728 char *buffer
= (char *) alloca (size
);
730 Lisp_Object echo_string
;
732 echo_string
= current_kboard
->echo_string
;
734 /* If someone has passed us a composite event, use its head symbol. */
739 ptr
= push_key_description (XINT (c
), ptr
, 1);
741 else if (SYMBOLP (c
))
743 Lisp_Object name
= SYMBOL_NAME (c
);
744 int nbytes
= SBYTES (name
);
746 if (size
- (ptr
- buffer
) < nbytes
)
748 int offset
= ptr
- buffer
;
749 size
= max (2 * size
, size
+ nbytes
);
750 buffer
= (char *) alloca (size
);
751 ptr
= buffer
+ offset
;
754 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
755 STRING_MULTIBYTE (name
), 1);
758 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
761 const char *text
= " (Type ? for further options)";
762 int len
= strlen (text
);
764 if (size
- (ptr
- buffer
) < len
)
766 int offset
= ptr
- buffer
;
768 buffer
= (char *) alloca (size
);
769 ptr
= buffer
+ offset
;
772 bcopy (text
, ptr
, len
);
776 /* Replace a dash from echo_dash with a space, otherwise
777 add a space at the end as a separator between keys. */
778 if (STRINGP (echo_string
)
779 && SCHARS (echo_string
) > 1)
781 Lisp_Object last_char
, prev_char
, idx
;
783 idx
= make_number (SCHARS (echo_string
) - 2);
784 prev_char
= Faref (echo_string
, idx
);
786 idx
= make_number (SCHARS (echo_string
) - 1);
787 last_char
= Faref (echo_string
, idx
);
789 /* We test PREV_CHAR to make sure this isn't the echoing
791 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
792 Faset (echo_string
, idx
, make_number (' '));
794 echo_string
= concat2 (echo_string
, build_string (" "));
797 current_kboard
->echo_string
798 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
804 /* Temporarily add a dash to the end of the echo string if it's not
805 empty, so that it serves as a mini-prompt for the very next character. */
810 /* Do nothing if not echoing at all. */
811 if (NILP (current_kboard
->echo_string
))
814 if (!current_kboard
->immediate_echo
815 && SCHARS (current_kboard
->echo_string
) == 0)
818 /* Do nothing if we just printed a prompt. */
819 if (current_kboard
->echo_after_prompt
820 == SCHARS (current_kboard
->echo_string
))
823 /* Put a dash at the end of the buffer temporarily,
824 but make it go away when the next character is added. */
825 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
830 /* Display the current echo string, and begin echoing if not already
836 if (!current_kboard
->immediate_echo
)
839 current_kboard
->immediate_echo
= 1;
841 for (i
= 0; i
< this_command_key_count
; i
++)
845 /* Set before_command_echo_length to the value that would
846 have been saved before the start of this subcommand in
847 command_loop_1, if we had already been echoing then. */
848 if (i
== this_single_command_key_start
)
849 before_command_echo_length
= echo_length ();
851 c
= XVECTOR (this_command_keys
)->contents
[i
];
852 if (! (EVENT_HAS_PARAMETERS (c
)
853 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
857 /* Set before_command_echo_length to the value that would
858 have been saved before the start of this subcommand in
859 command_loop_1, if we had already been echoing then. */
860 if (this_command_key_count
== this_single_command_key_start
)
861 before_command_echo_length
= echo_length ();
863 /* Put a dash at the end to invite the user to type more. */
868 message3_nolog (current_kboard
->echo_string
,
869 SBYTES (current_kboard
->echo_string
),
870 STRING_MULTIBYTE (current_kboard
->echo_string
));
873 /* Record in what buffer we echoed, and from which kboard. */
874 echo_message_buffer
= echo_area_buffer
[0];
875 echo_kboard
= current_kboard
;
877 if (waiting_for_input
&& !NILP (Vquit_flag
))
878 quit_throw_to_read_char ();
881 /* Turn off echoing, for the start of a new command. */
886 current_kboard
->immediate_echo
= 0;
887 current_kboard
->echo_after_prompt
= -1;
888 current_kboard
->echo_string
= Qnil
;
889 ok_to_echo_at_next_pause
= NULL
;
891 echo_message_buffer
= Qnil
;
894 /* Return the length of the current echo string. */
899 return (STRINGP (current_kboard
->echo_string
)
900 ? SCHARS (current_kboard
->echo_string
)
904 /* Truncate the current echo message to its first LEN chars.
905 This and echo_char get used by read_key_sequence when the user
906 switches frames while entering a key sequence. */
909 echo_truncate (nchars
)
912 if (STRINGP (current_kboard
->echo_string
))
913 current_kboard
->echo_string
914 = Fsubstring (current_kboard
->echo_string
,
915 make_number (0), make_number (nchars
));
916 truncate_echo_area (nchars
);
920 /* Functions for manipulating this_command_keys. */
922 add_command_key (key
)
925 #if 0 /* Not needed after we made Freset_this_command_lengths
926 do the job immediately. */
927 /* If reset-this-command-length was called recently, obey it now.
928 See the doc string of that function for an explanation of why. */
929 if (before_command_restore_flag
)
931 this_command_key_count
= before_command_key_count_1
;
932 if (this_command_key_count
< this_single_command_key_start
)
933 this_single_command_key_start
= this_command_key_count
;
934 echo_truncate (before_command_echo_length_1
);
935 before_command_restore_flag
= 0;
939 if (this_command_key_count
>= ASIZE (this_command_keys
))
940 this_command_keys
= larger_vector (this_command_keys
,
941 2 * ASIZE (this_command_keys
),
944 AREF (this_command_keys
, this_command_key_count
) = key
;
945 ++this_command_key_count
;
952 int count
= SPECPDL_INDEX ();
955 if (command_loop_level
> 0)
957 specbind (Qstandard_output
, Qt
);
958 specbind (Qstandard_input
, Qt
);
961 #ifdef HAVE_X_WINDOWS
962 /* The command loop has started an hourglass timer, so we have to
963 cancel it here, otherwise it will fire because the recursive edit
964 can take some time. Do not check for display_hourglass_p here,
965 because it could already be nil. */
969 /* This function may have been called from a debugger called from
970 within redisplay, for instance by Edebugging a function called
971 from fontification-functions. We want to allow redisplay in
972 the debugging session.
974 The recursive edit is left with a `(throw exit ...)'. The `exit'
975 tag is not caught anywhere in redisplay, i.e. when we leave the
976 recursive edit, the original redisplay leading to the recursive
977 edit will be unwound. The outcome should therefore be safe. */
978 specbind (Qinhibit_redisplay
, Qnil
);
981 val
= command_loop ();
983 Fsignal (Qquit
, Qnil
);
984 /* Handle throw from read_minibuf when using minibuffer
985 while it's active but we're in another window. */
987 Fsignal (Qerror
, Fcons (val
, Qnil
));
989 return unbind_to (count
, Qnil
);
992 /* When an auto-save happens, record the "time", and don't do again soon. */
997 last_auto_save
= num_nonmacro_input_events
;
1000 /* Make an auto save happen as soon as possible at command level. */
1003 force_auto_save_soon ()
1005 last_auto_save
= - auto_save_interval
- 1;
1007 record_asynch_buffer_change ();
1010 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1011 doc
: /* Invoke the editor command loop recursively.
1012 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1013 that tells this function to return.
1014 Alternately, `(throw 'exit t)' makes this function signal an error.
1015 This function is called by the editor initialization to begin editing. */)
1018 int count
= SPECPDL_INDEX ();
1021 command_loop_level
++;
1022 update_mode_lines
= 1;
1024 if (command_loop_level
1025 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1026 buffer
= Fcurrent_buffer ();
1030 /* If we leave recursive_edit_1 below with a `throw' for instance,
1031 like it is done in the splash screen display, we have to
1032 make sure that we restore single_kboard as command_loop_1
1033 would have done if it were left normally. */
1034 record_unwind_protect (recursive_edit_unwind
,
1035 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1037 recursive_edit_1 ();
1038 return unbind_to (count
, Qnil
);
1042 recursive_edit_unwind (info
)
1045 if (BUFFERP (XCAR (info
)))
1046 Fset_buffer (XCAR (info
));
1048 if (NILP (XCDR (info
)))
1049 any_kboard_state ();
1051 single_kboard_state ();
1053 command_loop_level
--;
1054 update_mode_lines
= 1;
1063 #if 0 /* Theory: if there's anything in Vunread_command_events,
1064 it will right away be read by read_key_sequence,
1065 and then if we do switch KBOARDS, it will go into the side
1066 queue then. So we don't need to do anything special here -- rms. */
1067 if (CONSP (Vunread_command_events
))
1069 current_kboard
->kbd_queue
1070 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1071 current_kboard
->kbd_queue_has_data
= 1;
1073 Vunread_command_events
= Qnil
;
1079 /* Switch to the single-kboard state, making current_kboard
1080 the only KBOARD from which further input is accepted. */
1083 single_kboard_state ()
1090 /* Maintain a stack of kboards, so other parts of Emacs
1091 can switch temporarily to the kboard of a given frame
1092 and then revert to the previous status. */
1097 struct kboard_stack
*next
;
1100 static struct kboard_stack
*kboard_stack
;
1103 push_frame_kboard (f
)
1107 struct kboard_stack
*p
1108 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1110 p
->next
= kboard_stack
;
1111 p
->kboard
= current_kboard
;
1114 current_kboard
= FRAME_KBOARD (f
);
1122 struct kboard_stack
*p
= kboard_stack
;
1123 current_kboard
= p
->kboard
;
1124 kboard_stack
= p
->next
;
1129 /* Handle errors that are not handled at inner levels
1130 by printing an error message and returning to the editor command loop. */
1136 Lisp_Object old_level
, old_length
;
1137 char macroerror
[50];
1139 #ifdef HAVE_X_WINDOWS
1140 if (display_hourglass_p
)
1141 cancel_hourglass ();
1144 if (!NILP (executing_macro
))
1146 if (executing_macro_iterations
== 1)
1147 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1149 sprintf (macroerror
, "After %d kbd macro iterations: ",
1150 executing_macro_iterations
);
1155 Vstandard_output
= Qt
;
1156 Vstandard_input
= Qt
;
1157 Vexecuting_macro
= Qnil
;
1158 executing_macro
= Qnil
;
1159 current_kboard
->Vprefix_arg
= Qnil
;
1160 current_kboard
->Vlast_prefix_arg
= Qnil
;
1163 /* Avoid unquittable loop if data contains a circular list. */
1164 old_level
= Vprint_level
;
1165 old_length
= Vprint_length
;
1166 XSETFASTINT (Vprint_level
, 10);
1167 XSETFASTINT (Vprint_length
, 10);
1168 cmd_error_internal (data
, macroerror
);
1169 Vprint_level
= old_level
;
1170 Vprint_length
= old_length
;
1174 Vinhibit_quit
= Qnil
;
1176 any_kboard_state ();
1179 return make_number (0);
1182 /* Take actions on handling an error. DATA is the data that describes
1185 CONTEXT is a C-string containing ASCII characters only which
1186 describes the context in which the error happened. If we need to
1187 generalize CONTEXT to allow multibyte characters, make it a Lisp
1191 cmd_error_internal (data
, context
)
1196 int kill_emacs_p
= 0;
1197 struct frame
*sf
= SELECTED_FRAME ();
1201 clear_message (1, 0);
1203 /* If the window system or terminal frame hasn't been initialized
1204 yet, or we're not interactive, it's best to dump this message out
1205 to stderr and exit. */
1206 if (!sf
->glyphs_initialized_p
1207 /* This is the case of the frame dumped with Emacs, when we're
1208 running under a window system. */
1209 || (!NILP (Vwindow_system
)
1210 && !inhibit_window_system
1211 && FRAME_TERMCAP_P (sf
))
1214 stream
= Qexternal_debugging_output
;
1220 message_log_maybe_newline ();
1225 /* The immediate context is not interesting for Quits,
1226 since they are asyncronous. */
1227 if (EQ (XCAR (data
), Qquit
))
1228 Vsignaling_function
= Qnil
;
1230 print_error_message (data
, stream
, context
, Vsignaling_function
);
1232 Vsignaling_function
= Qnil
;
1234 /* If the window system or terminal frame hasn't been initialized
1235 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1239 Fkill_emacs (make_number (-1));
1243 Lisp_Object
command_loop_1 ();
1244 Lisp_Object
command_loop_2 ();
1245 Lisp_Object
top_level_1 ();
1247 /* Entry to editor-command-loop.
1248 This level has the catches for exiting/returning to editor command loop.
1249 It returns nil to exit recursive edit, t to abort it. */
1254 if (command_loop_level
> 0 || minibuf_level
> 0)
1257 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1258 executing_macro
= Qnil
;
1264 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1265 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1266 executing_macro
= Qnil
;
1268 /* End of file in -batch run causes exit here. */
1274 /* Here we catch errors in execution of commands within the
1275 editing loop, and reenter the editing loop.
1276 When there is an error, cmd_error runs and returns a non-nil
1277 value to us. A value of nil means that command_loop_1 itself
1278 returned due to end of file (or end of kbd macro). */
1283 register Lisp_Object val
;
1286 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1287 while (!NILP (val
));
1295 return Feval (Vtop_level
);
1301 /* On entry to the outer level, run the startup file */
1302 if (!NILP (Vtop_level
))
1303 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1304 else if (!NILP (Vpurify_flag
))
1305 message ("Bare impure Emacs (standard Lisp code not loaded)");
1307 message ("Bare Emacs (standard Lisp code not loaded)");
1311 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1312 doc
: /* Exit all recursive editing levels. */)
1315 #ifdef HAVE_X_WINDOWS
1316 if (display_hourglass_p
)
1317 cancel_hourglass ();
1319 return Fthrow (Qtop_level
, Qnil
);
1322 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1323 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1326 if (command_loop_level
> 0 || minibuf_level
> 0)
1327 Fthrow (Qexit
, Qnil
);
1329 error ("No recursive edit is in progress");
1333 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1334 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1337 if (command_loop_level
> 0 || minibuf_level
> 0)
1340 error ("No recursive edit is in progress");
1344 /* This is the actual command reading loop,
1345 sans error-handling encapsulation. */
1347 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1349 void safe_run_hooks
P_ ((Lisp_Object
));
1350 static void adjust_point_for_property
P_ ((int, int));
1352 /* Cancel hourglass from protect_unwind.
1354 #ifdef HAVE_X_WINDOWS
1356 cancel_hourglass_unwind (arg
)
1359 cancel_hourglass ();
1369 Lisp_Object keybuf
[30];
1373 struct buffer
*prev_buffer
= NULL
;
1375 int was_locked
= single_kboard
;
1377 int already_adjusted
;
1379 current_kboard
->Vprefix_arg
= Qnil
;
1380 current_kboard
->Vlast_prefix_arg
= Qnil
;
1381 Vdeactivate_mark
= Qnil
;
1382 waiting_for_input
= 0;
1386 this_command_key_count
= 0;
1387 this_command_key_count_reset
= 0;
1388 this_single_command_key_start
= 0;
1390 if (NILP (Vmemory_full
))
1392 /* Make sure this hook runs after commands that get errors and
1393 throw to top level. */
1394 /* Note that the value cell will never directly contain nil
1395 if the symbol is a local variable. */
1396 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1397 safe_run_hooks (Qpost_command_hook
);
1399 /* If displaying a message, resize the echo area window to fit
1400 that message's size exactly. */
1401 if (!NILP (echo_area_buffer
[0]))
1402 resize_echo_area_exactly ();
1404 if (!NILP (Vdeferred_action_list
))
1405 call0 (Vdeferred_action_function
);
1407 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1409 if (NILP (Vunread_command_events
)
1410 && NILP (Vunread_input_method_events
)
1411 && NILP (Vunread_post_input_method_events
)
1412 && NILP (Vexecuting_macro
)
1413 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1414 safe_run_hooks (Qpost_command_idle_hook
);
1418 Vmemory_full
= Qnil
;
1420 /* Do this after running Vpost_command_hook, for consistency. */
1421 current_kboard
->Vlast_command
= Vthis_command
;
1422 current_kboard
->Vreal_last_command
= real_this_command
;
1426 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1429 /* Make sure the current window's buffer is selected. */
1430 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1431 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1433 /* Display any malloc warning that just came out. Use while because
1434 displaying one warning can cause another. */
1436 while (pending_malloc_warning
)
1437 display_malloc_warning ();
1441 Vdeactivate_mark
= Qnil
;
1443 /* If minibuffer on and echo area in use,
1444 wait a short time and redraw minibuffer. */
1447 && !NILP (echo_area_buffer
[0])
1448 && EQ (minibuf_window
, echo_area_window
)
1449 && NUMBERP (Vminibuffer_message_timeout
))
1451 /* Bind inhibit-quit to t so that C-g gets read in
1452 rather than quitting back to the minibuffer. */
1453 int count
= SPECPDL_INDEX ();
1454 specbind (Qinhibit_quit
, Qt
);
1456 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1457 /* Clear the echo area. */
1459 safe_run_hooks (Qecho_area_clear_hook
);
1461 unbind_to (count
, Qnil
);
1463 /* If a C-g came in before, treat it as input now. */
1464 if (!NILP (Vquit_flag
))
1467 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1472 alloca (0); /* Cause a garbage collection now */
1473 /* Since we can free the most stuff here. */
1474 #endif /* C_ALLOCA */
1477 /* Select the frame that the last event came from. Usually,
1478 switch-frame events will take care of this, but if some lisp
1479 code swallows a switch-frame event, we'll fix things up here.
1480 Is this a good idea? */
1481 if (FRAMEP (internal_last_event_frame
)
1482 && !EQ (internal_last_event_frame
, selected_frame
))
1483 Fselect_frame (internal_last_event_frame
, Qnil
);
1485 /* If it has changed current-menubar from previous value,
1486 really recompute the menubar from the value. */
1487 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1488 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1489 call0 (Qrecompute_lucid_menubar
);
1491 before_command_key_count
= this_command_key_count
;
1492 before_command_echo_length
= echo_length ();
1494 Vthis_command
= Qnil
;
1495 real_this_command
= Qnil
;
1497 /* Read next key sequence; i gets its length. */
1498 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1501 /* A filter may have run while we were reading the input. */
1502 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1504 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1505 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1509 /* Now we have read a key sequence of length I,
1510 or else I is 0 and we found end of file. */
1512 if (i
== 0) /* End of file -- happens only in */
1513 return Qnil
; /* a kbd macro, at the end. */
1514 /* -1 means read_key_sequence got a menu that was rejected.
1515 Just loop around and read another command. */
1519 this_command_key_count
= 0;
1520 this_command_key_count_reset
= 0;
1521 this_single_command_key_start
= 0;
1525 last_command_char
= keybuf
[i
- 1];
1527 /* If the previous command tried to force a specific window-start,
1528 forget about that, in case this command moves point far away
1529 from that position. But also throw away beg_unchanged and
1530 end_unchanged information in that case, so that redisplay will
1531 update the whole window properly. */
1532 if (!NILP (XWINDOW (selected_window
)->force_start
))
1535 XWINDOW (selected_window
)->force_start
= Qnil
;
1536 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1537 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1540 cmd
= read_key_sequence_cmd
;
1541 if (!NILP (Vexecuting_macro
))
1543 if (!NILP (Vquit_flag
))
1545 Vexecuting_macro
= Qt
;
1546 QUIT
; /* Make some noise. */
1547 /* Will return since macro now empty. */
1551 /* Do redisplay processing after this command except in special
1552 cases identified below. */
1553 prev_buffer
= current_buffer
;
1554 prev_modiff
= MODIFF
;
1555 last_point_position
= PT
;
1556 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1558 /* By default, we adjust point to a boundary of a region that
1559 has such a property that should be treated intangible
1560 (e.g. composition, display). But, some commands will set
1561 this variable differently. */
1562 Vdisable_point_adjustment
= Qnil
;
1564 /* Process filters and timers may have messed with deactivate-mark.
1565 reset it before we execute the command. */
1566 Vdeactivate_mark
= Qnil
;
1568 /* Remap command through active keymaps */
1569 Vthis_original_command
= cmd
;
1573 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1577 /* Execute the command. */
1579 Vthis_command
= cmd
;
1580 real_this_command
= cmd
;
1581 /* Note that the value cell will never directly contain nil
1582 if the symbol is a local variable. */
1583 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1584 safe_run_hooks (Qpre_command_hook
);
1586 already_adjusted
= 0;
1588 if (NILP (Vthis_command
))
1590 /* nil means key is undefined. */
1592 current_kboard
->defining_kbd_macro
= Qnil
;
1593 update_mode_lines
= 1;
1594 current_kboard
->Vprefix_arg
= Qnil
;
1598 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1600 /* In case we jump to directly_done. */
1601 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1603 /* Recognize some common commands in common situations and
1604 do them directly. */
1605 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1607 struct Lisp_Char_Table
*dp
1608 = window_display_table (XWINDOW (selected_window
));
1609 lose
= FETCH_CHAR (PT_BYTE
);
1611 if (! NILP (Vpost_command_hook
))
1612 /* Put this before calling adjust_point_for_property
1613 so it will only get called once in any case. */
1615 if (current_buffer
== prev_buffer
1616 && last_point_position
!= PT
1617 && NILP (Vdisable_point_adjustment
)
1618 && NILP (Vglobal_disable_point_adjustment
))
1619 adjust_point_for_property (last_point_position
, 0);
1620 already_adjusted
= 1;
1621 if (PT
== last_point_position
+ 1
1623 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1624 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1625 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1626 && (lose
>= 0x20 && lose
< 0x7f)))
1627 : (lose
>= 0x20 && lose
< 0x7f))
1628 /* To extract the case of continuation on
1629 wide-column characters. */
1630 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1631 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1633 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1635 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1637 && !windows_or_buffers_changed
1638 && EQ (current_buffer
->selective_display
, Qnil
)
1639 && !detect_input_pending ()
1640 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1641 && NILP (Vexecuting_macro
))
1642 direct_output_forward_char (1);
1645 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1647 struct Lisp_Char_Table
*dp
1648 = window_display_table (XWINDOW (selected_window
));
1650 lose
= FETCH_CHAR (PT_BYTE
);
1651 if (! NILP (Vpost_command_hook
))
1653 if (current_buffer
== prev_buffer
1654 && last_point_position
!= PT
1655 && NILP (Vdisable_point_adjustment
)
1656 && NILP (Vglobal_disable_point_adjustment
))
1657 adjust_point_for_property (last_point_position
, 0);
1658 already_adjusted
= 1;
1659 if (PT
== last_point_position
- 1
1661 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1662 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1663 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1664 && (lose
>= 0x20 && lose
< 0x7f)))
1665 : (lose
>= 0x20 && lose
< 0x7f))
1666 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1668 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1670 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1672 && !windows_or_buffers_changed
1673 && EQ (current_buffer
->selective_display
, Qnil
)
1674 && !detect_input_pending ()
1675 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1676 && NILP (Vexecuting_macro
))
1677 direct_output_forward_char (-1);
1680 else if (EQ (Vthis_command
, Qself_insert_command
)
1681 /* Try this optimization only on char keystrokes. */
1682 && NATNUMP (last_command_char
)
1683 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1686 = translate_char (Vtranslation_table_for_input
,
1687 XFASTINT (last_command_char
), 0, 0, 0);
1689 if (NILP (Vexecuting_macro
)
1690 && !EQ (minibuf_window
, selected_window
))
1692 if (!nonundocount
|| nonundocount
>= 20)
1700 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1702 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1704 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1706 || MODIFF
<= SAVE_MODIFF
1707 || windows_or_buffers_changed
1708 || !EQ (current_buffer
->selective_display
, Qnil
)
1709 || detect_input_pending ()
1710 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1711 || !NILP (Vexecuting_macro
));
1713 value
= internal_self_insert (c
, 0);
1718 if (! NILP (Vpost_command_hook
))
1719 /* Put this before calling adjust_point_for_property
1720 so it will only get called once in any case. */
1723 /* VALUE == 1 when AFTER-CHANGE functions are
1724 installed which is the case most of the time
1725 because FONT-LOCK installs one. */
1726 if (!lose
&& !value
)
1727 direct_output_for_insert (c
);
1732 /* Here for a command that isn't executed directly */
1735 #ifdef HAVE_X_WINDOWS
1736 int scount
= SPECPDL_INDEX ();
1738 if (display_hourglass_p
1739 && NILP (Vexecuting_macro
))
1741 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1747 if (NILP (current_kboard
->Vprefix_arg
))
1749 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1751 #ifdef HAVE_X_WINDOWS
1752 /* Do not check display_hourglass_p here, because
1753 Fcommand_execute could change it, but we should cancel
1754 hourglass cursor anyway.
1755 But don't cancel the hourglass within a macro
1756 just because a command in the macro finishes. */
1757 if (NILP (Vexecuting_macro
))
1758 unbind_to (scount
, Qnil
);
1763 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1765 /* Note that the value cell will never directly contain nil
1766 if the symbol is a local variable. */
1767 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1768 safe_run_hooks (Qpost_command_hook
);
1770 /* If displaying a message, resize the echo area window to fit
1771 that message's size exactly. */
1772 if (!NILP (echo_area_buffer
[0]))
1773 resize_echo_area_exactly ();
1775 if (!NILP (Vdeferred_action_list
))
1776 safe_run_hooks (Qdeferred_action_function
);
1778 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1780 if (NILP (Vunread_command_events
)
1781 && NILP (Vunread_input_method_events
)
1782 && NILP (Vunread_post_input_method_events
)
1783 && NILP (Vexecuting_macro
)
1784 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1785 safe_run_hooks (Qpost_command_idle_hook
);
1788 /* If there is a prefix argument,
1789 1) We don't want Vlast_command to be ``universal-argument''
1790 (that would be dumb), so don't set Vlast_command,
1791 2) we want to leave echoing on so that the prefix will be
1792 echoed as part of this key sequence, so don't call
1794 3) we want to leave this_command_key_count non-zero, so that
1795 read_char will realize that it is re-reading a character, and
1796 not echo it a second time.
1798 If the command didn't actually create a prefix arg,
1799 but is merely a frame event that is transparent to prefix args,
1800 then the above doesn't apply. */
1801 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1803 current_kboard
->Vlast_command
= Vthis_command
;
1804 current_kboard
->Vreal_last_command
= real_this_command
;
1806 this_command_key_count
= 0;
1807 this_command_key_count_reset
= 0;
1808 this_single_command_key_start
= 0;
1811 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1813 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1815 /* We could also call `deactivate'mark'. */
1816 if (EQ (Vtransient_mark_mode
, Qlambda
))
1817 Vtransient_mark_mode
= Qnil
;
1820 current_buffer
->mark_active
= Qnil
;
1821 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1824 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1825 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1830 if (current_buffer
== prev_buffer
1831 && last_point_position
!= PT
1832 && NILP (Vdisable_point_adjustment
)
1833 && NILP (Vglobal_disable_point_adjustment
)
1834 && !already_adjusted
)
1835 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1837 /* Install chars successfully executed in kbd macro. */
1839 if (!NILP (current_kboard
->defining_kbd_macro
)
1840 && NILP (current_kboard
->Vprefix_arg
))
1841 finalize_kbd_macro_chars ();
1845 any_kboard_state ();
1850 extern Lisp_Object Qcomposition
, Qdisplay
;
1852 /* Adjust point to a boundary of a region that has such a property
1853 that should be treated intangible. For the moment, we check
1854 `composition', `display' and `invisible' properties.
1855 LAST_PT is the last position of point. */
1857 extern Lisp_Object Qafter_string
, Qbefore_string
;
1858 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1861 adjust_point_for_property (last_pt
, modified
)
1866 Lisp_Object val
, overlay
, tmp
;
1867 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1870 /* FIXME: cycling is probably not necessary because these properties
1871 can't be usefully combined anyway. */
1872 while (check_composition
|| check_display
|| check_invisible
)
1874 if (check_composition
1875 && PT
> BEGV
&& PT
< ZV
1876 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1877 && COMPOSITION_VALID_P (beg
, end
, val
)
1878 && beg
< PT
/* && end > PT <- It's always the case. */
1879 && (last_pt
<= beg
|| last_pt
>= end
))
1882 SET_PT (PT
< last_pt
? beg
: end
);
1883 check_display
= check_invisible
= 1;
1885 check_composition
= 0;
1887 && PT
> BEGV
&& PT
< ZV
1888 && !NILP (val
= get_char_property_and_overlay
1889 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1890 && display_prop_intangible_p (val
)
1891 && (!OVERLAYP (overlay
)
1892 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1893 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1894 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1895 && beg
< PT
) /* && end > PT <- It's always the case. */
1898 SET_PT (PT
< last_pt
? beg
: end
);
1899 check_composition
= check_invisible
= 1;
1902 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1904 int inv
, ellipsis
= 0;
1907 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1909 && !NILP (val
= get_char_property_and_overlay
1910 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1911 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1913 ellipsis
= ellipsis
|| inv
> 1
1914 || (OVERLAYP (overlay
)
1915 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1916 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1917 tmp
= Fnext_single_char_property_change
1918 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1919 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1922 && !NILP (val
= get_char_property_and_overlay
1923 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1924 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1926 ellipsis
= ellipsis
|| inv
> 1
1927 || (OVERLAYP (overlay
)
1928 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1929 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1930 tmp
= Fprevious_single_char_property_change
1931 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1932 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1935 /* Move away from the inside area. */
1936 if (beg
< PT
&& end
> PT
)
1938 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1939 /* We haven't moved yet (so we don't need to fear
1940 infinite-looping) and we were outside the range
1941 before (so either end of the range still corresponds
1942 to a move in the right direction): pretend we moved
1943 less than we actually did, so that we still have
1944 more freedom below in choosing which end of the range
1946 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1947 /* We either have moved already or the last point
1948 was already in the range: we don't get to choose
1949 which end of the range we have to go to. */
1950 : (PT
< last_pt
? beg
: end
));
1951 check_composition
= check_display
= 1;
1953 xassert (PT
== beg
|| PT
== end
);
1954 /* Pretend the area doesn't exist if the buffer is not
1956 if (!modified
&& !ellipsis
&& beg
< end
)
1958 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1959 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1960 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1961 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1962 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1963 /* We've already moved as far as we can. Trying to go
1964 to the other end would mean moving backwards and thus
1965 could lead to an infinite loop. */
1967 else if (val
= get_pos_property (make_number (PT
),
1969 TEXT_PROP_MEANS_INVISIBLE (val
)
1970 && (val
= get_pos_property
1971 (make_number (PT
== beg
? end
: beg
),
1973 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1974 (check_composition
= check_display
= 1,
1975 SET_PT (PT
== beg
? end
: beg
));
1978 check_invisible
= 0;
1982 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1985 safe_run_hooks_1 (hook
)
1988 return call1 (Vrun_hooks
, Vinhibit_quit
);
1991 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1994 safe_run_hooks_error (data
)
1997 Lisp_Object args
[3];
1998 args
[0] = build_string ("Error in %s: %s");
1999 args
[1] = Vinhibit_quit
;
2002 return Fset (Vinhibit_quit
, Qnil
);
2005 /* If we get an error while running the hook, cause the hook variable
2006 to be nil. Also inhibit quits, so that C-g won't cause the hook
2007 to mysteriously evaporate. */
2010 safe_run_hooks (hook
)
2013 int count
= SPECPDL_INDEX ();
2014 specbind (Qinhibit_quit
, hook
);
2016 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2018 unbind_to (count
, Qnil
);
2022 /* Number of seconds between polling for input. This is a Lisp
2023 variable that can be bound. */
2025 EMACS_INT polling_period
;
2027 /* Nonzero means polling for input is temporarily suppressed. */
2029 int poll_suppress_count
;
2031 /* Asynchronous timer for polling. */
2033 struct atimer
*poll_timer
;
2036 #ifdef POLL_FOR_INPUT
2038 /* Poll for input, so what we catch a C-g if it comes in. This
2039 function is called from x_make_frame_visible, see comment
2045 if (interrupt_input_blocked
== 0
2046 && !waiting_for_input
)
2047 read_avail_input (0);
2050 /* Timer callback function for poll_timer. TIMER is equal to
2054 poll_for_input (timer
)
2055 struct atimer
*timer
;
2057 if (poll_suppress_count
== 0)
2058 poll_for_input_1 ();
2061 #endif /* POLL_FOR_INPUT */
2063 /* Begin signals to poll for input, if they are appropriate.
2064 This function is called unconditionally from various places. */
2069 #ifdef POLL_FOR_INPUT
2070 if (read_socket_hook
&& !interrupt_input
)
2072 /* Turn alarm handling on unconditionally. It might have
2073 been turned off in process.c. */
2074 turn_on_atimers (1);
2076 /* If poll timer doesn't exist, are we need one with
2077 a different interval, start a new one. */
2078 if (poll_timer
== NULL
2079 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2081 EMACS_TIME interval
;
2084 cancel_atimer (poll_timer
);
2086 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2087 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2088 poll_for_input
, NULL
);
2091 /* Let the timer's callback function poll for input
2092 if this becomes zero. */
2093 --poll_suppress_count
;
2098 /* Nonzero if we are using polling to handle input asynchronously. */
2101 input_polling_used ()
2103 #ifdef POLL_FOR_INPUT
2104 return read_socket_hook
&& !interrupt_input
;
2110 /* Turn off polling. */
2115 #ifdef POLL_FOR_INPUT
2116 if (read_socket_hook
&& !interrupt_input
)
2117 ++poll_suppress_count
;
2121 /* Set the value of poll_suppress_count to COUNT
2122 and start or stop polling accordingly. */
2125 set_poll_suppress_count (count
)
2128 #ifdef POLL_FOR_INPUT
2129 if (count
== 0 && poll_suppress_count
!= 0)
2131 poll_suppress_count
= 1;
2134 else if (count
!= 0 && poll_suppress_count
== 0)
2138 poll_suppress_count
= count
;
2142 /* Bind polling_period to a value at least N.
2143 But don't decrease it. */
2146 bind_polling_period (n
)
2149 #ifdef POLL_FOR_INPUT
2150 int new = polling_period
;
2155 stop_other_atimers (poll_timer
);
2157 specbind (Qpolling_period
, make_number (new));
2158 /* Start a new alarm with the new period. */
2163 /* Apply the control modifier to CHARACTER. */
2169 /* Save the upper bits here. */
2170 int upper
= c
& ~0177;
2174 /* Everything in the columns containing the upper-case letters
2175 denotes a control character. */
2176 if (c
>= 0100 && c
< 0140)
2180 /* Set the shift modifier for a control char
2181 made from a shifted letter. But only for letters! */
2182 if (oc
>= 'A' && oc
<= 'Z')
2183 c
|= shift_modifier
;
2186 /* The lower-case letters denote control characters too. */
2187 else if (c
>= 'a' && c
<= 'z')
2190 /* Include the bits for control and shift
2191 only if the basic ASCII code can't indicate them. */
2195 /* Replace the high bits. */
2196 c
|= (upper
& ~ctrl_modifier
);
2201 /* Display help echo in the echo area.
2203 HELP a string means display that string, HELP nil means clear the
2204 help echo. If HELP is a function, call it with OBJECT and POS as
2205 arguments; the function should return a help string or nil for
2206 none. For all other types of HELP evaluate it to obtain a string.
2208 WINDOW is the window in which the help was generated, if any.
2209 It is nil if not in a window.
2211 If OBJECT is a buffer, POS is the position in the buffer where the
2212 `help-echo' text property was found.
2214 If OBJECT is an overlay, that overlay has a `help-echo' property,
2215 and POS is the position in the overlay's buffer under the mouse.
2217 If OBJECT is a string (an overlay string or a string displayed with
2218 the `display' property). POS is the position in that string under
2221 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2222 echo overwrites a keystroke echo currently displayed in the echo
2225 Note: this function may only be called with HELP nil or a string
2226 from X code running asynchronously. */
2229 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2230 Lisp_Object help
, window
, object
, pos
;
2231 int ok_to_overwrite_keystroke_echo
;
2233 if (!NILP (help
) && !STRINGP (help
))
2235 if (FUNCTIONP (help
))
2237 Lisp_Object args
[4];
2242 help
= safe_call (4, args
);
2245 help
= safe_eval (help
);
2247 if (!STRINGP (help
))
2251 if (STRINGP (help
) || NILP (help
))
2253 if (!NILP (Vshow_help_function
))
2254 call1 (Vshow_help_function
, help
);
2255 else if (/* Don't overwrite minibuffer contents. */
2256 !MINI_WINDOW_P (XWINDOW (selected_window
))
2257 /* Don't overwrite a keystroke echo. */
2258 && (NILP (echo_message_buffer
)
2259 || ok_to_overwrite_keystroke_echo
)
2260 /* Don't overwrite a prompt. */
2261 && !cursor_in_echo_area
)
2265 int count
= SPECPDL_INDEX ();
2267 if (!help_echo_showing_p
)
2268 Vpre_help_message
= current_message ();
2270 specbind (Qmessage_truncate_lines
, Qt
);
2271 message3_nolog (help
, SBYTES (help
),
2272 STRING_MULTIBYTE (help
));
2273 unbind_to (count
, Qnil
);
2275 else if (STRINGP (Vpre_help_message
))
2277 message3_nolog (Vpre_help_message
,
2278 SBYTES (Vpre_help_message
),
2279 STRING_MULTIBYTE (Vpre_help_message
));
2280 Vpre_help_message
= Qnil
;
2286 help_echo_showing_p
= STRINGP (help
);
2292 /* Input of single characters from keyboard */
2294 Lisp_Object
print_help ();
2295 static Lisp_Object
kbd_buffer_get_event ();
2296 static void record_char ();
2299 static jmp_buf wrong_kboard_jmpbuf
;
2302 #define STOP_POLLING \
2303 do { if (! polling_stopped_here) stop_polling (); \
2304 polling_stopped_here = 1; } while (0)
2306 #define RESUME_POLLING \
2307 do { if (polling_stopped_here) start_polling (); \
2308 polling_stopped_here = 0; } while (0)
2310 /* read a character from the keyboard; call the redisplay if needed */
2311 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2312 -1 means do not do redisplay, but do do autosaving.
2315 /* The arguments MAPS and NMAPS are for menu prompting.
2316 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2318 PREV_EVENT is the previous input event, or nil if we are reading
2319 the first event of a key sequence (or not reading a key sequence).
2320 If PREV_EVENT is t, that is a "magic" value that says
2321 not to run input methods, but in other respects to act as if
2322 not reading a key sequence.
2324 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2325 if we used a mouse menu to read the input, or zero otherwise. If
2326 USED_MOUSE_MENU is null, we don't dereference it.
2328 Value is t if we showed a menu and the user rejected it. */
2331 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2335 Lisp_Object prev_event
;
2336 int *used_mouse_menu
;
2338 volatile Lisp_Object c
;
2340 jmp_buf local_getcjmp
;
2342 volatile int key_already_recorded
= 0;
2343 Lisp_Object tem
, save
;
2344 volatile Lisp_Object previous_echo_area_message
;
2345 volatile Lisp_Object also_record
;
2346 volatile int reread
;
2347 struct gcpro gcpro1
, gcpro2
;
2348 EMACS_TIME last_idle_start
;
2349 int polling_stopped_here
= 0;
2353 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2354 before_command_key_count
= this_command_key_count
;
2355 before_command_echo_length
= echo_length ();
2358 previous_echo_area_message
= Qnil
;
2360 GCPRO2 (c
, previous_echo_area_message
);
2365 if (CONSP (Vunread_post_input_method_events
))
2367 c
= XCAR (Vunread_post_input_method_events
);
2368 Vunread_post_input_method_events
2369 = XCDR (Vunread_post_input_method_events
);
2371 /* Undo what read_char_x_menu_prompt did when it unread
2372 additional keys returned by Fx_popup_menu. */
2374 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2382 if (unread_command_char
!= -1)
2384 XSETINT (c
, unread_command_char
);
2385 unread_command_char
= -1;
2391 if (CONSP (Vunread_command_events
))
2393 c
= XCAR (Vunread_command_events
);
2394 Vunread_command_events
= XCDR (Vunread_command_events
);
2396 /* Undo what read_char_x_menu_prompt did when it unread
2397 additional keys returned by Fx_popup_menu. */
2399 && EQ (XCDR (c
), Qdisabled
)
2400 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2403 /* If the queued event is something that used the mouse,
2404 set used_mouse_menu accordingly. */
2406 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2407 *used_mouse_menu
= 1;
2410 goto reread_for_input_method
;
2413 if (CONSP (Vunread_input_method_events
))
2415 c
= XCAR (Vunread_input_method_events
);
2416 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2418 /* Undo what read_char_x_menu_prompt did when it unread
2419 additional keys returned by Fx_popup_menu. */
2421 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2425 goto reread_for_input_method
;
2428 this_command_key_count_reset
= 0;
2430 if (!NILP (Vexecuting_macro
))
2432 /* We set this to Qmacro; since that's not a frame, nobody will
2433 try to switch frames on us, and the selected window will
2436 Since this event came from a macro, it would be misleading to
2437 leave internal_last_event_frame set to wherever the last
2438 real event came from. Normally, a switch-frame event selects
2439 internal_last_event_frame after each command is read, but
2440 events read from a macro should never cause a new frame to be
2442 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2444 /* Exit the macro if we are at the end.
2445 Also, some things replace the macro with t
2446 to force an early exit. */
2447 if (EQ (Vexecuting_macro
, Qt
)
2448 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2454 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2455 if (STRINGP (Vexecuting_macro
)
2456 && (XINT (c
) & 0x80))
2457 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2459 executing_macro_index
++;
2464 if (!NILP (unread_switch_frame
))
2466 c
= unread_switch_frame
;
2467 unread_switch_frame
= Qnil
;
2469 /* This event should make it into this_command_keys, and get echoed
2470 again, so we do not set `reread'. */
2474 /* if redisplay was requested */
2475 if (commandflag
>= 0)
2477 /* If there is pending input, process any events which are not
2478 user-visible, such as X selection_request events. */
2480 || detect_input_pending_run_timers (0))
2481 swallow_events (0); /* may clear input_pending */
2483 /* Redisplay if no pending input. */
2484 while (!input_pending
)
2486 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2487 redisplay_preserve_echo_area (5);
2492 /* Normal case: no input arrived during redisplay. */
2495 /* Input arrived and pre-empted redisplay.
2496 Process any events which are not user-visible. */
2498 /* If that cleared input_pending, try again to redisplay. */
2502 /* Message turns off echoing unless more keystrokes turn it on again.
2504 The code in 20.x for the condition was
2506 1. echo_area_glyphs && *echo_area_glyphs
2507 2. && echo_area_glyphs != current_kboard->echobuf
2508 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2510 (1) means there's a current message displayed
2512 (2) means it's not the message from echoing from the current
2515 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2516 is set to a non-null value. This is done in read_char and it is
2517 set to echo_area_glyphs after a call to echo_char. That means
2518 ok_to_echo_at_next_pause is either null or
2519 current_kboard->echobuf with the appropriate current_kboard at
2522 So, condition (3) means in clear text ok_to_echo_at_next_pause
2523 must be either null, or the current message isn't from echoing at
2524 all, or it's from echoing from a different kboard than the
2527 if (/* There currently is something in the echo area. */
2528 !NILP (echo_area_buffer
[0])
2529 && (/* And it's either not from echoing. */
2530 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2531 /* Or it's an echo from a different kboard. */
2532 || echo_kboard
!= current_kboard
2533 /* Or we explicitly allow overwriting whatever there is. */
2534 || ok_to_echo_at_next_pause
== NULL
))
2539 /* Try reading a character via menu prompting in the minibuf.
2540 Try this before the sit-for, because the sit-for
2541 would do the wrong thing if we are supposed to do
2542 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2543 after a mouse event so don't try a minibuf menu. */
2545 if (nmaps
> 0 && INTERACTIVE
2546 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2547 /* Don't bring up a menu if we already have another event. */
2548 && NILP (Vunread_command_events
)
2549 && unread_command_char
< 0
2550 && !detect_input_pending_run_timers (0))
2552 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2555 key_already_recorded
= 1;
2560 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2561 We will do that below, temporarily for short sections of code,
2562 when appropriate. local_getcjmp must be in effect
2563 around any call to sit_for or kbd_buffer_get_event;
2564 it *must not* be in effect when we call redisplay. */
2566 if (_setjmp (local_getcjmp
))
2568 XSETINT (c
, quit_char
);
2569 internal_last_event_frame
= selected_frame
;
2570 Vlast_event_frame
= internal_last_event_frame
;
2571 /* If we report the quit char as an event,
2572 don't do so more than once. */
2573 if (!NILP (Vinhibit_quit
))
2578 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2579 if (kb
!= current_kboard
)
2581 Lisp_Object link
= kb
->kbd_queue
;
2582 /* We shouldn't get here if we were in single-kboard mode! */
2587 while (CONSP (XCDR (link
)))
2589 if (!NILP (XCDR (link
)))
2593 kb
->kbd_queue
= Fcons (c
, Qnil
);
2595 XSETCDR (link
, Fcons (c
, Qnil
));
2596 kb
->kbd_queue_has_data
= 1;
2597 current_kboard
= kb
;
2598 /* This is going to exit from read_char
2599 so we had better get rid of this frame's stuff. */
2601 longjmp (wrong_kboard_jmpbuf
, 1);
2608 timer_start_idle ();
2610 /* If in middle of key sequence and minibuffer not active,
2611 start echoing if enough time elapses. */
2613 if (minibuf_level
== 0
2614 && !current_kboard
->immediate_echo
2615 && this_command_key_count
> 0
2617 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2618 && NILP (Fzerop (Vecho_keystrokes
))
2619 && (/* No message. */
2620 NILP (echo_area_buffer
[0])
2621 /* Or empty message. */
2622 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2623 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2624 /* Or already echoing from same kboard. */
2625 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2626 /* Or not echoing before and echoing allowed. */
2627 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2631 /* After a mouse event, start echoing right away.
2632 This is because we are probably about to display a menu,
2633 and we don't want to delay before doing so. */
2634 if (EVENT_HAS_PARAMETERS (prev_event
))
2639 double duration
= extract_float (Vecho_keystrokes
);
2640 sec
= (int) duration
;
2641 usec
= (duration
- sec
) * 1000000;
2642 save_getcjmp (save_jump
);
2643 restore_getcjmp (local_getcjmp
);
2644 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2645 restore_getcjmp (save_jump
);
2647 && ! CONSP (Vunread_command_events
))
2652 /* Maybe auto save due to number of keystrokes. */
2654 if (commandflag
!= 0
2655 && auto_save_interval
> 0
2656 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2657 && !detect_input_pending_run_timers (0))
2659 Fdo_auto_save (Qnil
, Qnil
);
2660 /* Hooks can actually change some buffers in auto save. */
2664 /* Try reading using an X menu.
2665 This is never confused with reading using the minibuf
2666 because the recursive call of read_char in read_char_minibuf_menu_prompt
2667 does not pass on any keymaps. */
2669 if (nmaps
> 0 && INTERACTIVE
2670 && !NILP (prev_event
)
2671 && EVENT_HAS_PARAMETERS (prev_event
)
2672 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2673 && !EQ (XCAR (prev_event
), Qtool_bar
)
2674 /* Don't bring up a menu if we already have another event. */
2675 && NILP (Vunread_command_events
)
2676 && unread_command_char
< 0)
2678 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2680 /* Now that we have read an event, Emacs is not idle. */
2686 /* Maybe autosave and/or garbage collect due to idleness. */
2688 if (INTERACTIVE
&& NILP (c
))
2690 int delay_level
, buffer_size
;
2692 /* Slow down auto saves logarithmically in size of current buffer,
2693 and garbage collect while we're at it. */
2694 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2695 last_non_minibuf_size
= Z
- BEG
;
2696 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2698 while (buffer_size
> 64)
2699 delay_level
++, buffer_size
-= buffer_size
>> 2;
2700 if (delay_level
< 4) delay_level
= 4;
2701 /* delay_level is 4 for files under around 50k, 7 at 100k,
2702 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2704 /* Auto save if enough time goes by without input. */
2705 if (commandflag
!= 0
2706 && num_nonmacro_input_events
> last_auto_save
2707 && INTEGERP (Vauto_save_timeout
)
2708 && XINT (Vauto_save_timeout
) > 0)
2712 save_getcjmp (save_jump
);
2713 restore_getcjmp (local_getcjmp
);
2714 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2716 restore_getcjmp (save_jump
);
2719 && ! CONSP (Vunread_command_events
))
2721 Fdo_auto_save (Qnil
, Qnil
);
2723 /* If we have auto-saved and there is still no input
2724 available, garbage collect if there has been enough
2725 consing going on to make it worthwhile. */
2726 if (!detect_input_pending_run_timers (0)
2727 && consing_since_gc
> gc_cons_threshold
/ 2)
2728 Fgarbage_collect ();
2735 /* If this has become non-nil here, it has been set by a timer
2736 or sentinel or filter. */
2737 if (CONSP (Vunread_command_events
))
2739 c
= XCAR (Vunread_command_events
);
2740 Vunread_command_events
= XCDR (Vunread_command_events
);
2743 /* Read something from current KBOARD's side queue, if possible. */
2747 if (current_kboard
->kbd_queue_has_data
)
2749 if (!CONSP (current_kboard
->kbd_queue
))
2751 c
= XCAR (current_kboard
->kbd_queue
);
2752 current_kboard
->kbd_queue
2753 = XCDR (current_kboard
->kbd_queue
);
2754 if (NILP (current_kboard
->kbd_queue
))
2755 current_kboard
->kbd_queue_has_data
= 0;
2756 input_pending
= readable_events (0);
2757 if (EVENT_HAS_PARAMETERS (c
)
2758 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2759 internal_last_event_frame
= XCAR (XCDR (c
));
2760 Vlast_event_frame
= internal_last_event_frame
;
2765 /* If current_kboard's side queue is empty check the other kboards.
2766 If one of them has data that we have not yet seen here,
2767 switch to it and process the data waiting for it.
2769 Note: if the events queued up for another kboard
2770 have already been seen here, and therefore are not a complete command,
2771 the kbd_queue_has_data field is 0, so we skip that kboard here.
2772 That's to avoid an infinite loop switching between kboards here. */
2773 if (NILP (c
) && !single_kboard
)
2776 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2777 if (kb
->kbd_queue_has_data
)
2779 current_kboard
= kb
;
2780 /* This is going to exit from read_char
2781 so we had better get rid of this frame's stuff. */
2783 longjmp (wrong_kboard_jmpbuf
, 1);
2792 /* Finally, we read from the main queue,
2793 and if that gives us something we can't use yet, we put it on the
2794 appropriate side queue and try again. */
2800 /* Actually read a character, waiting if necessary. */
2801 save_getcjmp (save_jump
);
2802 restore_getcjmp (local_getcjmp
);
2803 timer_start_idle ();
2804 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2805 restore_getcjmp (save_jump
);
2808 if (! NILP (c
) && (kb
!= current_kboard
))
2810 Lisp_Object link
= kb
->kbd_queue
;
2813 while (CONSP (XCDR (link
)))
2815 if (!NILP (XCDR (link
)))
2819 kb
->kbd_queue
= Fcons (c
, Qnil
);
2821 XSETCDR (link
, Fcons (c
, Qnil
));
2822 kb
->kbd_queue_has_data
= 1;
2826 current_kboard
= kb
;
2827 /* This is going to exit from read_char
2828 so we had better get rid of this frame's stuff. */
2830 longjmp (wrong_kboard_jmpbuf
, 1);
2835 /* Terminate Emacs in batch mode if at eof. */
2836 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2837 Fkill_emacs (make_number (1));
2841 /* Add in any extra modifiers, where appropriate. */
2842 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2843 || ((extra_keyboard_modifiers
& 0177) < ' '
2844 && (extra_keyboard_modifiers
& 0177) != 0))
2845 XSETINT (c
, make_ctrl_char (XINT (c
)));
2847 /* Transfer any other modifier bits directly from
2848 extra_keyboard_modifiers to c. Ignore the actual character code
2849 in the low 16 bits of extra_keyboard_modifiers. */
2850 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2855 /* Record the last idle start time so that we can reset it
2856 should the next event read be a help-echo. */
2857 last_idle_start
= timer_idleness_start_time
;
2863 if (commandflag
>= 0
2864 && !input_pending
&& !detect_input_pending_run_timers (0))
2872 /* Buffer switch events are only for internal wakeups
2873 so don't show them to the user.
2874 Also, don't record a key if we already did. */
2875 if (BUFFERP (c
) || key_already_recorded
)
2878 /* Process special events within read_char
2879 and loop around to read another event. */
2882 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2887 int was_locked
= single_kboard
;
2889 last_input_char
= c
;
2890 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2892 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2893 /* We stopped being idle for this event; undo that. This
2894 prevents automatic window selection (under
2895 mouse_autoselect_window from acting as a real input event, for
2896 example banishing the mouse under mouse-avoidance-mode. */
2897 timer_idleness_start_time
= last_idle_start
;
2899 /* Resume allowing input from any kboard, if that was true before. */
2901 any_kboard_state ();
2906 /* Handle things that only apply to characters. */
2909 /* If kbd_buffer_get_event gave us an EOF, return that. */
2913 if ((STRINGP (Vkeyboard_translate_table
)
2914 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2915 || (VECTORP (Vkeyboard_translate_table
)
2916 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2917 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2918 && CHAR_VALID_P (XINT (c
), 0)))
2921 d
= Faref (Vkeyboard_translate_table
, c
);
2922 /* nil in keyboard-translate-table means no translation. */
2928 /* If this event is a mouse click in the menu bar,
2929 return just menu-bar for now. Modify the mouse click event
2930 so we won't do this twice, then queue it up. */
2931 if (EVENT_HAS_PARAMETERS (c
)
2933 && CONSP (EVENT_START (c
))
2934 && CONSP (XCDR (EVENT_START (c
))))
2938 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2939 /* Handle menu-bar events:
2940 insert the dummy prefix event `menu-bar'. */
2941 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2943 /* Change menu-bar to (menu-bar) as the event "position". */
2944 POSN_BUFFER_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2947 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2952 /* Store these characters into recent_keys, the dribble file if any,
2953 and the keyboard macro being defined, if any. */
2955 if (! NILP (also_record
))
2956 record_char (also_record
);
2958 /* Wipe the echo area.
2959 But first, if we are about to use an input method,
2960 save the echo area contents for it to refer to. */
2962 && ! NILP (Vinput_method_function
)
2963 && (unsigned) XINT (c
) >= ' '
2964 && (unsigned) XINT (c
) != 127
2965 && (unsigned) XINT (c
) < 256)
2967 previous_echo_area_message
= Fcurrent_message ();
2968 Vinput_method_previous_message
= previous_echo_area_message
;
2971 /* Now wipe the echo area, except for help events which do their
2972 own stuff with the echo area. */
2974 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2975 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2977 if (!NILP (echo_area_buffer
[0]))
2978 safe_run_hooks (Qecho_area_clear_hook
);
2979 clear_message (1, 0);
2982 reread_for_input_method
:
2984 /* Pass this to the input method, if appropriate. */
2986 && ! NILP (Vinput_method_function
)
2987 /* Don't run the input method within a key sequence,
2988 after the first event of the key sequence. */
2989 && NILP (prev_event
)
2990 && (unsigned) XINT (c
) >= ' '
2991 && (unsigned) XINT (c
) != 127
2992 && (unsigned) XINT (c
) < 256)
2995 int key_count
, key_count_reset
;
2996 struct gcpro gcpro1
;
2997 int count
= SPECPDL_INDEX ();
2999 /* Save the echo status. */
3000 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3001 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3002 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3005 if (before_command_restore_flag
)
3007 this_command_key_count
= before_command_key_count_1
;
3008 if (this_command_key_count
< this_single_command_key_start
)
3009 this_single_command_key_start
= this_command_key_count
;
3010 echo_truncate (before_command_echo_length_1
);
3011 before_command_restore_flag
= 0;
3015 /* Save the this_command_keys status. */
3016 key_count
= this_command_key_count
;
3017 key_count_reset
= this_command_key_count_reset
;
3020 keys
= Fcopy_sequence (this_command_keys
);
3025 /* Clear out this_command_keys. */
3026 this_command_key_count
= 0;
3027 this_command_key_count_reset
= 0;
3029 /* Now wipe the echo area. */
3030 if (!NILP (echo_area_buffer
[0]))
3031 safe_run_hooks (Qecho_area_clear_hook
);
3032 clear_message (1, 0);
3035 /* If we are not reading a key sequence,
3036 never use the echo area. */
3039 specbind (Qinput_method_use_echo_area
, Qt
);
3042 /* Call the input method. */
3043 tem
= call1 (Vinput_method_function
, c
);
3045 tem
= unbind_to (count
, tem
);
3047 /* Restore the saved echoing state
3048 and this_command_keys state. */
3049 this_command_key_count
= key_count
;
3050 this_command_key_count_reset
= key_count_reset
;
3052 this_command_keys
= keys
;
3055 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3056 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3057 if (saved_immediate_echo
)
3062 /* The input method can return no events. */
3065 /* Bring back the previous message, if any. */
3066 if (! NILP (previous_echo_area_message
))
3067 message_with_string ("%s", previous_echo_area_message
, 0);
3070 /* It returned one event or more. */
3072 Vunread_post_input_method_events
3073 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3078 /* Display help if not echoing. */
3079 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3081 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3082 Lisp_Object help
, object
, position
, window
, tem
;
3084 tem
= Fcdr (XCDR (c
));
3087 window
= Fcar (tem
);
3089 object
= Fcar (tem
);
3091 position
= Fcar (tem
);
3093 show_help_echo (help
, window
, object
, position
, 0);
3095 /* We stopped being idle for this event; undo that. */
3096 timer_idleness_start_time
= last_idle_start
;
3100 if (! reread
|| this_command_key_count
== 0
3101 || this_command_key_count_reset
)
3104 /* Don't echo mouse motion events. */
3105 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3106 && NILP (Fzerop (Vecho_keystrokes
))
3107 && ! (EVENT_HAS_PARAMETERS (c
)
3108 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3111 if (! NILP (also_record
))
3112 echo_char (also_record
);
3113 /* Once we reread a character, echoing can happen
3114 the next time we pause to read a new one. */
3115 ok_to_echo_at_next_pause
= current_kboard
;
3118 /* Record this character as part of the current key. */
3119 add_command_key (c
);
3120 if (! NILP (also_record
))
3121 add_command_key (also_record
);
3124 last_input_char
= c
;
3127 /* Process the help character specially if enabled */
3128 if (!NILP (Vhelp_form
) && help_char_p (c
))
3131 count
= SPECPDL_INDEX ();
3133 record_unwind_protect (Fset_window_configuration
,
3134 Fcurrent_window_configuration (Qnil
));
3136 tem0
= Feval (Vhelp_form
);
3138 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3142 c
= read_char (0, 0, 0, Qnil
, 0);
3143 while (BUFFERP (c
));
3144 /* Remove the help from the frame */
3145 unbind_to (count
, Qnil
);
3148 if (EQ (c
, make_number (040)))
3152 c
= read_char (0, 0, 0, Qnil
, 0);
3153 while (BUFFERP (c
));
3162 /* Record a key that came from a mouse menu.
3163 Record it for echoing, for this-command-keys, and so on. */
3169 /* Wipe the echo area. */
3170 clear_message (1, 0);
3175 before_command_key_count
= this_command_key_count
;
3176 before_command_echo_length
= echo_length ();
3179 /* Don't echo mouse motion events. */
3180 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3181 && NILP (Fzerop (Vecho_keystrokes
)))
3185 /* Once we reread a character, echoing can happen
3186 the next time we pause to read a new one. */
3187 ok_to_echo_at_next_pause
= 0;
3190 /* Record this character as part of the current key. */
3191 add_command_key (c
);
3193 /* Re-reading in the middle of a command */
3194 last_input_char
= c
;
3198 /* Return 1 if should recognize C as "the help character". */
3206 if (EQ (c
, Vhelp_char
))
3208 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3209 if (EQ (c
, XCAR (tail
)))
3214 /* Record the input event C in various ways. */
3222 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3224 /* To avoid filling recent_keys with help-echo and mouse-movement
3225 events, we filter out repeated help-echo events, only store the
3226 first and last in a series of mouse-movement events, and don't
3227 store repeated help-echo events which are only separated by
3228 mouse-movement events. */
3230 Lisp_Object ev1
, ev2
, ev3
;
3233 if ((ix1
= recent_keys_index
- 1) < 0)
3234 ix1
= NUM_RECENT_KEYS
- 1;
3235 ev1
= AREF (recent_keys
, ix1
);
3237 if ((ix2
= ix1
- 1) < 0)
3238 ix2
= NUM_RECENT_KEYS
- 1;
3239 ev2
= AREF (recent_keys
, ix2
);
3241 if ((ix3
= ix2
- 1) < 0)
3242 ix3
= NUM_RECENT_KEYS
- 1;
3243 ev3
= AREF (recent_keys
, ix3
);
3245 if (EQ (XCAR (c
), Qhelp_echo
))
3247 /* Don't record `help-echo' in recent_keys unless it shows some help
3248 message, and a different help than the previously recorded
3250 Lisp_Object help
, last_help
;
3252 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3253 if (!STRINGP (help
))
3255 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3256 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3258 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3259 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3260 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3262 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3263 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3264 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3265 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3268 else if (EQ (XCAR (c
), Qmouse_movement
))
3270 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3271 So additional mouse movement events replace the last element. */
3272 Lisp_Object last_window
, window
;
3274 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3275 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3276 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3277 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3278 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3280 ASET (recent_keys
, ix1
, c
);
3286 store_kbd_macro_char (c
);
3291 ASET (recent_keys
, recent_keys_index
, c
);
3292 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3293 recent_keys_index
= 0;
3295 else if (recorded
< 0)
3297 /* We need to remove one or two events from recent_keys.
3298 To do this, we simply put nil at those events and move the
3299 recent_keys_index backwards over those events. Usually,
3300 users will never see those nil events, as they will be
3301 overwritten by the command keys entered to see recent_keys
3304 while (recorded
++ < 0 && total_keys
> 0)
3306 if (total_keys
< NUM_RECENT_KEYS
)
3308 if (--recent_keys_index
< 0)
3309 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3310 ASET (recent_keys
, recent_keys_index
, Qnil
);
3314 num_nonmacro_input_events
++;
3316 /* Write c to the dribble file. If c is a lispy event, write
3317 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3318 If you, dear reader, have a better idea, you've got the source. :-) */
3323 if (XUINT (c
) < 0x100)
3324 putc (XINT (c
), dribble
);
3326 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3330 Lisp_Object dribblee
;
3332 /* If it's a structured event, take the event header. */
3333 dribblee
= EVENT_HEAD (c
);
3335 if (SYMBOLP (dribblee
))
3337 putc ('<', dribble
);
3338 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3339 SBYTES (SYMBOL_NAME (dribblee
)),
3341 putc ('>', dribble
);
3353 struct buffer
*old
= current_buffer
;
3354 Fprinc (object
, Qnil
);
3355 set_buffer_internal (XBUFFER (Vstandard_output
));
3356 call0 (intern ("help-mode"));
3357 set_buffer_internal (old
);
3361 /* Copy out or in the info on where C-g should throw to.
3362 This is used when running Lisp code from within get_char,
3363 in case get_char is called recursively.
3364 See read_process_output. */
3370 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3374 restore_getcjmp (temp
)
3377 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3382 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3383 of this function. */
3386 tracking_off (old_value
)
3387 Lisp_Object old_value
;
3389 do_mouse_tracking
= old_value
;
3390 if (NILP (old_value
))
3392 /* Redisplay may have been preempted because there was input
3393 available, and it assumes it will be called again after the
3394 input has been processed. If the only input available was
3395 the sort that we have just disabled, then we need to call
3397 if (!readable_events (1))
3399 redisplay_preserve_echo_area (6);
3400 get_input_pending (&input_pending
, 1);
3406 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3407 doc
: /* Evaluate BODY with mouse movement events enabled.
3408 Within a `track-mouse' form, mouse motion generates input events that
3409 you can read with `read-event'.
3410 Normally, mouse motion is ignored.
3411 usage: (track-mouse BODY ...) */)
3415 int count
= SPECPDL_INDEX ();
3418 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3420 do_mouse_tracking
= Qt
;
3422 val
= Fprogn (args
);
3423 return unbind_to (count
, val
);
3426 /* If mouse has moved on some frame, return one of those frames.
3427 Return 0 otherwise. */
3432 Lisp_Object tail
, frame
;
3434 FOR_EACH_FRAME (tail
, frame
)
3436 if (XFRAME (frame
)->mouse_moved
)
3437 return XFRAME (frame
);
3443 #endif /* HAVE_MOUSE */
3445 /* Low level keyboard/mouse input.
3446 kbd_buffer_store_event places events in kbd_buffer, and
3447 kbd_buffer_get_event retrieves them. */
3449 /* Return true iff there are any events in the queue that read-char
3450 would return. If this returns false, a read-char would block. */
3452 readable_filtered_events (do_timers_now
, filter_events
)
3457 timer_check (do_timers_now
);
3459 /* If the buffer contains only FOCUS_IN_EVENT events,
3460 and FILTER_EVENTS is nonzero, report it as empty. */
3461 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3463 int have_live_event
= 1;
3467 struct input_event
*event
;
3469 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3473 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3476 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3478 if (event
== kbd_store_ptr
)
3479 have_live_event
= 0;
3482 if (have_live_event
) return 1;
3486 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3491 if (current_kboard
->kbd_queue_has_data
)
3497 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3498 if (kb
->kbd_queue_has_data
)
3504 /* Return true iff there are any events in the queue that read-char
3505 would return. If this returns false, a read-char would block. */
3507 readable_events (do_timers_now
)
3510 return readable_filtered_events (do_timers_now
, 0);
3513 /* Set this for debugging, to have a way to get out */
3518 event_to_kboard (event
)
3519 struct input_event
*event
;
3522 frame
= event
->frame_or_window
;
3524 frame
= XCAR (frame
);
3525 else if (WINDOWP (frame
))
3526 frame
= WINDOW_FRAME (XWINDOW (frame
));
3528 /* There are still some events that don't set this field.
3529 For now, just ignore the problem.
3530 Also ignore dead frames here. */
3531 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3534 return FRAME_KBOARD (XFRAME (frame
));
3538 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3541 kbd_buffer_store_event (event
)
3542 register struct input_event
*event
;
3544 if (event
->kind
== NO_EVENT
)
3547 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3549 register int c
= event
->code
& 0377;
3551 if (event
->modifiers
& ctrl_modifier
)
3552 c
= make_ctrl_char (c
);
3554 c
|= (event
->modifiers
3555 & (meta_modifier
| alt_modifier
3556 | hyper_modifier
| super_modifier
));
3562 struct input_event
*sp
;
3565 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3566 kb
!= current_kboard
))
3569 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3570 Fcons (make_number (c
), Qnil
));
3571 kb
->kbd_queue_has_data
= 1;
3572 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3574 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3577 if (event_to_kboard (sp
) == kb
)
3579 sp
->kind
= NO_EVENT
;
3580 sp
->frame_or_window
= Qnil
;
3588 /* If this results in a quit_char being returned to Emacs as
3589 input, set Vlast_event_frame properly. If this doesn't
3590 get returned to Emacs as an event, the next event read
3591 will set Vlast_event_frame again, so this is safe to do. */
3595 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3597 focus
= event
->frame_or_window
;
3598 internal_last_event_frame
= focus
;
3599 Vlast_event_frame
= focus
;
3602 last_event_timestamp
= event
->timestamp
;
3603 interrupt_signal (0 /* dummy */);
3607 if (c
&& c
== stop_character
)
3613 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3614 Just ignore the second one. */
3615 else if (event
->kind
== BUFFER_SWITCH_EVENT
3616 && kbd_fetch_ptr
!= kbd_store_ptr
3617 && kbd_store_ptr
->kind
== BUFFER_SWITCH_EVENT
)
3620 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3621 kbd_store_ptr
= kbd_buffer
;
3623 /* Don't let the very last slot in the buffer become full,
3624 since that would make the two pointers equal,
3625 and that is indistinguishable from an empty buffer.
3626 Discard the event if it would fill the last slot. */
3627 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3631 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3632 prone to assign individual members for other events, in case
3633 the input_event structure is changed. --2000-07-13, gerd. */
3634 struct input_event
*sp
= kbd_store_ptr
;
3635 sp
->kind
= event
->kind
;
3636 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3638 /* We must not use the ordinary copying code for this case,
3639 since `part' is an enum and copying it might not copy enough
3641 bcopy (event
, (char *) sp
, sizeof (*event
));
3646 sp
->code
= event
->code
;
3647 sp
->part
= event
->part
;
3648 sp
->frame_or_window
= event
->frame_or_window
;
3649 sp
->arg
= event
->arg
;
3650 sp
->modifiers
= event
->modifiers
;
3653 sp
->timestamp
= event
->timestamp
;
3656 *kbd_store_ptr
= *event
;
3659 idx
= 2 * (kbd_store_ptr
- kbd_buffer
);
3660 ASET (kbd_buffer_gcpro
, idx
, event
->frame_or_window
);
3661 ASET (kbd_buffer_gcpro
, idx
+ 1, event
->arg
);
3667 /* Generate HELP_EVENT input_events in BUFP which has room for
3668 SIZE events. If there's not enough room in BUFP, ignore this
3671 HELP is the help form.
3673 FRAME is the frame on which the help is generated. OBJECT is the
3674 Lisp object where the help was found (a buffer, a string, an
3675 overlay, or nil if neither from a string nor from a buffer. POS is
3676 the position within OBJECT where the help was found.
3678 Value is the number of input_events generated. */
3681 gen_help_event (bufp
, size
, help
, frame
, window
, object
, pos
)
3682 struct input_event
*bufp
;
3684 Lisp_Object help
, frame
, object
, window
;
3689 bufp
->kind
= HELP_EVENT
;
3690 bufp
->frame_or_window
= frame
;
3692 bufp
->x
= WINDOWP (window
) ? window
: frame
;
3701 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3704 kbd_buffer_store_help_event (frame
, help
)
3705 Lisp_Object frame
, help
;
3707 struct input_event event
;
3709 event
.kind
= HELP_EVENT
;
3710 event
.frame_or_window
= frame
;
3715 kbd_buffer_store_event (&event
);
3719 /* Discard any mouse events in the event buffer by setting them to
3722 discard_mouse_events ()
3724 struct input_event
*sp
;
3725 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3727 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3730 if (sp
->kind
== MOUSE_CLICK_EVENT
3731 || sp
->kind
== WHEEL_EVENT
3733 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3735 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3737 sp
->kind
= NO_EVENT
;
3743 /* Return non-zero if there are any real events waiting in the event
3744 buffer, not counting `NO_EVENT's.
3746 If DISCARD is non-zero, discard NO_EVENT events at the front of
3747 the input queue, possibly leaving the input queue empty if there
3748 are no real input events. */
3751 kbd_buffer_events_waiting (discard
)
3754 struct input_event
*sp
;
3756 for (sp
= kbd_fetch_ptr
;
3757 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3760 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3767 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3771 /* Clear input event EVENT. */
3775 struct input_event
*event
;
3777 int idx
= 2 * (event
- kbd_buffer
);
3778 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
3779 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
3780 event
->kind
= NO_EVENT
;
3784 /* Read one event from the event buffer, waiting if necessary.
3785 The value is a Lisp object representing the event.
3786 The value is nil for an event that should be ignored,
3787 or that was handled here.
3788 We always read and discard one event. */
3791 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3793 int *used_mouse_menu
;
3802 *kbp
= current_kboard
;
3806 /* Wait until there is input available. */
3809 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3812 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3816 /* If the quit flag is set, then read_char will return
3817 quit_char, so that counts as "available input." */
3818 if (!NILP (Vquit_flag
))
3819 quit_throw_to_read_char ();
3821 /* One way or another, wait until input is available; then, if
3822 interrupt handlers have not read it, read it now. */
3825 wait_for_kbd_input ();
3827 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3831 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3834 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3838 Lisp_Object minus_one
;
3840 XSETINT (minus_one
, -1);
3841 wait_reading_process_input (0, 0, minus_one
, 1);
3843 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3844 /* Pass 1 for EXPECT since we just waited to have input. */
3845 read_avail_input (1);
3847 #endif /* not VMS */
3850 if (CONSP (Vunread_command_events
))
3853 first
= XCAR (Vunread_command_events
);
3854 Vunread_command_events
= XCDR (Vunread_command_events
);
3855 *kbp
= current_kboard
;
3859 /* At this point, we know that there is a readable event available
3860 somewhere. If the event queue is empty, then there must be a
3861 mouse movement enabled and available. */
3862 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3864 struct input_event
*event
;
3866 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3870 last_event_timestamp
= event
->timestamp
;
3873 *kbp
= event_to_kboard (event
);
3875 *kbp
= current_kboard
; /* Better than returning null ptr? */
3877 *kbp
= &the_only_kboard
;
3882 /* These two kinds of events get special handling
3883 and don't actually appear to the command loop.
3884 We return nil for them. */
3885 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3888 struct input_event copy
;
3890 /* Remove it from the buffer before processing it,
3891 since otherwise swallow_events will see it
3892 and process it again. */
3894 kbd_fetch_ptr
= event
+ 1;
3895 input_pending
= readable_events (0);
3896 x_handle_selection_request (©
);
3898 /* We're getting selection request events, but we don't have
3904 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3907 struct input_event copy
;
3909 /* Remove it from the buffer before processing it. */
3911 kbd_fetch_ptr
= event
+ 1;
3912 input_pending
= readable_events (0);
3913 x_handle_selection_clear (©
);
3915 /* We're getting selection request events, but we don't have
3920 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3921 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3923 /* Make an event (delete-frame (FRAME)). */
3924 obj
= Fcons (event
->frame_or_window
, Qnil
);
3925 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3926 kbd_fetch_ptr
= event
+ 1;
3929 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3930 else if (event
->kind
== ICONIFY_EVENT
)
3932 /* Make an event (iconify-frame (FRAME)). */
3933 obj
= Fcons (event
->frame_or_window
, Qnil
);
3934 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3935 kbd_fetch_ptr
= event
+ 1;
3937 else if (event
->kind
== DEICONIFY_EVENT
)
3939 /* Make an event (make-frame-visible (FRAME)). */
3940 obj
= Fcons (event
->frame_or_window
, Qnil
);
3941 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3942 kbd_fetch_ptr
= event
+ 1;
3945 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3947 /* The value doesn't matter here; only the type is tested. */
3948 XSETBUFFER (obj
, current_buffer
);
3949 kbd_fetch_ptr
= event
+ 1;
3951 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
3952 || defined (USE_GTK)
3953 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3955 kbd_fetch_ptr
= event
+ 1;
3956 input_pending
= readable_events (0);
3957 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3958 x_activate_menubar (XFRAME (event
->frame_or_window
));
3962 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3964 /* Make an event (language-change (FRAME CHARSET LCID)). */
3965 obj
= Fcons (event
->modifiers
, Qnil
);
3966 obj
= Fcons (event
->code
, obj
);
3967 obj
= Fcons (event
->frame_or_window
, obj
);
3968 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3969 kbd_fetch_ptr
= event
+ 1;
3972 else if (event
->kind
== SAVE_SESSION_EVENT
)
3974 obj
= Fcons (Qsave_session
, Qnil
);
3975 kbd_fetch_ptr
= event
+ 1;
3977 /* Just discard these, by returning nil.
3978 With MULTI_KBOARD, these events are used as placeholders
3979 when we need to randomly delete events from the queue.
3980 (They shouldn't otherwise be found in the buffer,
3981 but on some machines it appears they do show up
3982 even without MULTI_KBOARD.) */
3983 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3984 mouse events during a popup-menu call. */
3985 else if (event
->kind
== NO_EVENT
)
3986 kbd_fetch_ptr
= event
+ 1;
3987 else if (event
->kind
== HELP_EVENT
)
3989 Lisp_Object object
, position
, help
, frame
, window
;
3991 frame
= event
->frame_or_window
;
3992 object
= event
->arg
;
3993 position
= make_number (event
->code
);
3996 clear_event (event
);
3998 kbd_fetch_ptr
= event
+ 1;
3999 if (!WINDOWP (window
))
4001 obj
= Fcons (Qhelp_echo
,
4002 list5 (frame
, help
, window
, object
, position
));
4004 else if (event
->kind
== FOCUS_IN_EVENT
)
4006 /* Notification of a FocusIn event. The frame receiving the
4007 focus is in event->frame_or_window. Generate a
4008 switch-frame event if necessary. */
4009 Lisp_Object frame
, focus
;
4011 frame
= event
->frame_or_window
;
4012 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4016 if (!EQ (frame
, internal_last_event_frame
)
4017 && !EQ (frame
, selected_frame
))
4018 obj
= make_lispy_switch_frame (frame
);
4019 internal_last_event_frame
= frame
;
4020 kbd_fetch_ptr
= event
+ 1;
4024 /* If this event is on a different frame, return a switch-frame this
4025 time, and leave the event in the queue for next time. */
4029 frame
= event
->frame_or_window
;
4031 frame
= XCAR (frame
);
4032 else if (WINDOWP (frame
))
4033 frame
= WINDOW_FRAME (XWINDOW (frame
));
4035 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4039 if (! EQ (frame
, internal_last_event_frame
)
4040 && !EQ (frame
, selected_frame
))
4041 obj
= make_lispy_switch_frame (frame
);
4042 internal_last_event_frame
= frame
;
4044 /* If we didn't decide to make a switch-frame event, go ahead
4045 and build a real event from the queue entry. */
4049 obj
= make_lispy_event (event
);
4051 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4052 || defined (USE_GTK)
4053 /* If this was a menu selection, then set the flag to inhibit
4054 writing to last_nonmenu_event. Don't do this if the event
4055 we're returning is (menu-bar), though; that indicates the
4056 beginning of the menu sequence, and we might as well leave
4057 that as the `event with parameters' for this selection. */
4059 && !EQ (event
->frame_or_window
, event
->arg
)
4060 && (event
->kind
== MENU_BAR_EVENT
4061 || event
->kind
== TOOL_BAR_EVENT
))
4062 *used_mouse_menu
= 1;
4065 /* Wipe out this event, to catch bugs. */
4066 clear_event (event
);
4067 kbd_fetch_ptr
= event
+ 1;
4072 /* Try generating a mouse motion event. */
4073 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4075 FRAME_PTR f
= some_mouse_moved ();
4076 Lisp_Object bar_window
;
4077 enum scroll_bar_part part
;
4081 *kbp
= current_kboard
;
4082 /* Note that this uses F to determine which display to look at.
4083 If there is no valid info, it does not store anything
4084 so x remains nil. */
4086 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4090 /* Decide if we should generate a switch-frame event. Don't
4091 generate switch-frame events for motion outside of all Emacs
4097 frame
= FRAME_FOCUS_FRAME (f
);
4099 XSETFRAME (frame
, f
);
4101 if (! EQ (frame
, internal_last_event_frame
)
4102 && !EQ (frame
, selected_frame
))
4103 obj
= make_lispy_switch_frame (frame
);
4104 internal_last_event_frame
= frame
;
4107 /* If we didn't decide to make a switch-frame event, go ahead and
4108 return a mouse-motion event. */
4109 if (!NILP (x
) && NILP (obj
))
4110 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4112 #endif /* HAVE_MOUSE */
4114 /* We were promised by the above while loop that there was
4115 something for us to read! */
4118 input_pending
= readable_events (0);
4120 Vlast_event_frame
= internal_last_event_frame
;
4125 /* Process any events that are not user-visible,
4126 then return, without reading any user-visible events. */
4129 swallow_events (do_display
)
4134 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4136 struct input_event
*event
;
4138 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4142 last_event_timestamp
= event
->timestamp
;
4144 /* These two kinds of events get special handling
4145 and don't actually appear to the command loop. */
4146 if (event
->kind
== SELECTION_REQUEST_EVENT
)
4149 struct input_event copy
;
4151 /* Remove it from the buffer before processing it,
4152 since otherwise swallow_events called recursively could see it
4153 and process it again. */
4155 kbd_fetch_ptr
= event
+ 1;
4156 input_pending
= readable_events (0);
4157 x_handle_selection_request (©
);
4159 /* We're getting selection request events, but we don't have
4165 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
4168 struct input_event copy
;
4170 /* Remove it from the buffer before processing it, */
4173 kbd_fetch_ptr
= event
+ 1;
4174 input_pending
= readable_events (0);
4175 x_handle_selection_clear (©
);
4177 /* We're getting selection request events, but we don't have
4186 old_timers_run
= timers_run
;
4187 get_input_pending (&input_pending
, 1);
4189 if (timers_run
!= old_timers_run
&& do_display
)
4190 redisplay_preserve_echo_area (7);
4193 /* Record the start of when Emacs is idle,
4194 for the sake of running idle-time timers. */
4201 /* If we are already in the idle state, do nothing. */
4202 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4205 EMACS_GET_TIME (timer_idleness_start_time
);
4207 timer_last_idleness_start_time
= timer_idleness_start_time
;
4209 /* Mark all idle-time timers as once again candidates for running. */
4210 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4214 timer
= XCAR (timers
);
4216 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4218 XVECTOR (timer
)->contents
[0] = Qnil
;
4222 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4227 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4230 /* This is only for debugging. */
4231 struct input_event last_timer_event
;
4233 /* Check whether a timer has fired. To prevent larger problems we simply
4234 disregard elements that are not proper timers. Do not make a circular
4235 timer list for the time being.
4237 Returns the number of seconds to wait until the next timer fires. If a
4238 timer is triggering now, return zero seconds.
4239 If no timer is active, return -1 seconds.
4241 If a timer is ripe, we run it, with quitting turned off.
4243 DO_IT_NOW is now ignored. It used to mean that we should
4244 run the timer directly instead of queueing a timer-event.
4245 Now we always run timers directly. */
4248 timer_check (do_it_now
)
4251 EMACS_TIME nexttime
;
4252 EMACS_TIME now
, idleness_now
;
4253 Lisp_Object timers
, idle_timers
, chosen_timer
;
4254 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4256 EMACS_SET_SECS (nexttime
, -1);
4257 EMACS_SET_USECS (nexttime
, -1);
4259 /* Always consider the ordinary timers. */
4260 timers
= Vtimer_list
;
4261 /* Consider the idle timers only if Emacs is idle. */
4262 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4263 idle_timers
= Vtimer_idle_list
;
4266 chosen_timer
= Qnil
;
4267 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4269 if (CONSP (timers
) || CONSP (idle_timers
))
4271 EMACS_GET_TIME (now
);
4272 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4273 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4276 while (CONSP (timers
) || CONSP (idle_timers
))
4278 Lisp_Object
*vector
;
4279 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4280 EMACS_TIME timer_time
, idle_timer_time
;
4281 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4283 /* Skip past invalid timers and timers already handled. */
4286 timer
= XCAR (timers
);
4287 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4289 timers
= XCDR (timers
);
4292 vector
= XVECTOR (timer
)->contents
;
4294 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4295 || !INTEGERP (vector
[3])
4296 || ! NILP (vector
[0]))
4298 timers
= XCDR (timers
);
4302 if (!NILP (idle_timers
))
4304 timer
= XCAR (idle_timers
);
4305 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4307 idle_timers
= XCDR (idle_timers
);
4310 vector
= XVECTOR (timer
)->contents
;
4312 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4313 || !INTEGERP (vector
[3])
4314 || ! NILP (vector
[0]))
4316 idle_timers
= XCDR (idle_timers
);
4321 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4322 based on the next ordinary timer.
4323 TIMER_DIFFERENCE is the distance in time from NOW to when
4324 this timer becomes ripe (negative if it's already ripe). */
4327 timer
= XCAR (timers
);
4328 vector
= XVECTOR (timer
)->contents
;
4329 EMACS_SET_SECS (timer_time
,
4330 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4331 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4332 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4335 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4336 based on the next idle timer. */
4337 if (!NILP (idle_timers
))
4339 idle_timer
= XCAR (idle_timers
);
4340 vector
= XVECTOR (idle_timer
)->contents
;
4341 EMACS_SET_SECS (idle_timer_time
,
4342 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4343 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4344 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4347 /* Decide which timer is the next timer,
4348 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4349 Also step down the list where we found that timer. */
4351 if (! NILP (timers
) && ! NILP (idle_timers
))
4354 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4355 if (EMACS_TIME_NEG_P (temp
))
4357 chosen_timer
= timer
;
4358 timers
= XCDR (timers
);
4359 difference
= timer_difference
;
4363 chosen_timer
= idle_timer
;
4364 idle_timers
= XCDR (idle_timers
);
4365 difference
= idle_timer_difference
;
4368 else if (! NILP (timers
))
4370 chosen_timer
= timer
;
4371 timers
= XCDR (timers
);
4372 difference
= timer_difference
;
4376 chosen_timer
= idle_timer
;
4377 idle_timers
= XCDR (idle_timers
);
4378 difference
= idle_timer_difference
;
4380 vector
= XVECTOR (chosen_timer
)->contents
;
4382 /* If timer is ripe, run it if it hasn't been run. */
4383 if (EMACS_TIME_NEG_P (difference
)
4384 || (EMACS_SECS (difference
) == 0
4385 && EMACS_USECS (difference
) == 0))
4387 if (NILP (vector
[0]))
4389 int was_locked
= single_kboard
;
4390 int count
= SPECPDL_INDEX ();
4391 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4393 /* Mark the timer as triggered to prevent problems if the lisp
4394 code fails to reschedule it right. */
4397 specbind (Qinhibit_quit
, Qt
);
4399 call1 (Qtimer_event_handler
, chosen_timer
);
4400 Vdeactivate_mark
= old_deactivate_mark
;
4402 unbind_to (count
, Qnil
);
4404 /* Resume allowing input from any kboard, if that was true before. */
4406 any_kboard_state ();
4408 /* Since we have handled the event,
4409 we don't need to tell the caller to wake up and do it. */
4413 /* When we encounter a timer that is still waiting,
4414 return the amount of time to wait before it is ripe. */
4421 /* No timers are pending in the future. */
4422 /* Return 0 if we generated an event, and -1 if not. */
4427 /* Caches for modify_event_symbol. */
4428 static Lisp_Object accent_key_syms
;
4429 static Lisp_Object func_key_syms
;
4430 static Lisp_Object mouse_syms
;
4431 static Lisp_Object wheel_syms
;
4432 static Lisp_Object drag_n_drop_syms
;
4434 /* This is a list of keysym codes for special "accent" characters.
4435 It parallels lispy_accent_keys. */
4437 static int lispy_accent_codes
[] =
4439 #ifdef XK_dead_circumflex
4444 #ifdef XK_dead_grave
4449 #ifdef XK_dead_tilde
4454 #ifdef XK_dead_diaeresis
4459 #ifdef XK_dead_macron
4464 #ifdef XK_dead_degree
4469 #ifdef XK_dead_acute
4474 #ifdef XK_dead_cedilla
4479 #ifdef XK_dead_breve
4484 #ifdef XK_dead_ogonek
4489 #ifdef XK_dead_caron
4494 #ifdef XK_dead_doubleacute
4495 XK_dead_doubleacute
,
4499 #ifdef XK_dead_abovedot
4504 #ifdef XK_dead_abovering
4514 #ifdef XK_dead_belowdot
4519 #ifdef XK_dead_voiced_sound
4520 XK_dead_voiced_sound
,
4524 #ifdef XK_dead_semivoiced_sound
4525 XK_dead_semivoiced_sound
,
4541 /* This is a list of Lisp names for special "accent" characters.
4542 It parallels lispy_accent_codes. */
4544 static char *lispy_accent_keys
[] =
4562 "dead-voiced-sound",
4563 "dead-semivoiced-sound",
4569 #define FUNCTION_KEY_OFFSET 0x0
4571 char *lispy_function_keys
[] =
4575 0, /* VK_LBUTTON 0x01 */
4576 0, /* VK_RBUTTON 0x02 */
4577 "cancel", /* VK_CANCEL 0x03 */
4578 0, /* VK_MBUTTON 0x04 */
4580 0, 0, 0, /* 0x05 .. 0x07 */
4582 "backspace", /* VK_BACK 0x08 */
4583 "tab", /* VK_TAB 0x09 */
4585 0, 0, /* 0x0A .. 0x0B */
4587 "clear", /* VK_CLEAR 0x0C */
4588 "return", /* VK_RETURN 0x0D */
4590 0, 0, /* 0x0E .. 0x0F */
4592 0, /* VK_SHIFT 0x10 */
4593 0, /* VK_CONTROL 0x11 */
4594 0, /* VK_MENU 0x12 */
4595 "pause", /* VK_PAUSE 0x13 */
4596 "capslock", /* VK_CAPITAL 0x14 */
4598 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4600 "escape", /* VK_ESCAPE 0x1B */
4602 0, 0, 0, 0, /* 0x1C .. 0x1F */
4604 0, /* VK_SPACE 0x20 */
4605 "prior", /* VK_PRIOR 0x21 */
4606 "next", /* VK_NEXT 0x22 */
4607 "end", /* VK_END 0x23 */
4608 "home", /* VK_HOME 0x24 */
4609 "left", /* VK_LEFT 0x25 */
4610 "up", /* VK_UP 0x26 */
4611 "right", /* VK_RIGHT 0x27 */
4612 "down", /* VK_DOWN 0x28 */
4613 "select", /* VK_SELECT 0x29 */
4614 "print", /* VK_PRINT 0x2A */
4615 "execute", /* VK_EXECUTE 0x2B */
4616 "snapshot", /* VK_SNAPSHOT 0x2C */
4617 "insert", /* VK_INSERT 0x2D */
4618 "delete", /* VK_DELETE 0x2E */
4619 "help", /* VK_HELP 0x2F */
4621 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4623 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4625 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4627 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4629 0, 0, 0, 0, 0, 0, 0, 0, 0,
4630 0, 0, 0, 0, 0, 0, 0, 0, 0,
4631 0, 0, 0, 0, 0, 0, 0, 0,
4633 "lwindow", /* VK_LWIN 0x5B */
4634 "rwindow", /* VK_RWIN 0x5C */
4635 "apps", /* VK_APPS 0x5D */
4637 0, 0, /* 0x5E .. 0x5F */
4639 "kp-0", /* VK_NUMPAD0 0x60 */
4640 "kp-1", /* VK_NUMPAD1 0x61 */
4641 "kp-2", /* VK_NUMPAD2 0x62 */
4642 "kp-3", /* VK_NUMPAD3 0x63 */
4643 "kp-4", /* VK_NUMPAD4 0x64 */
4644 "kp-5", /* VK_NUMPAD5 0x65 */
4645 "kp-6", /* VK_NUMPAD6 0x66 */
4646 "kp-7", /* VK_NUMPAD7 0x67 */
4647 "kp-8", /* VK_NUMPAD8 0x68 */
4648 "kp-9", /* VK_NUMPAD9 0x69 */
4649 "kp-multiply", /* VK_MULTIPLY 0x6A */
4650 "kp-add", /* VK_ADD 0x6B */
4651 "kp-separator", /* VK_SEPARATOR 0x6C */
4652 "kp-subtract", /* VK_SUBTRACT 0x6D */
4653 "kp-decimal", /* VK_DECIMAL 0x6E */
4654 "kp-divide", /* VK_DIVIDE 0x6F */
4655 "f1", /* VK_F1 0x70 */
4656 "f2", /* VK_F2 0x71 */
4657 "f3", /* VK_F3 0x72 */
4658 "f4", /* VK_F4 0x73 */
4659 "f5", /* VK_F5 0x74 */
4660 "f6", /* VK_F6 0x75 */
4661 "f7", /* VK_F7 0x76 */
4662 "f8", /* VK_F8 0x77 */
4663 "f9", /* VK_F9 0x78 */
4664 "f10", /* VK_F10 0x79 */
4665 "f11", /* VK_F11 0x7A */
4666 "f12", /* VK_F12 0x7B */
4667 "f13", /* VK_F13 0x7C */
4668 "f14", /* VK_F14 0x7D */
4669 "f15", /* VK_F15 0x7E */
4670 "f16", /* VK_F16 0x7F */
4671 "f17", /* VK_F17 0x80 */
4672 "f18", /* VK_F18 0x81 */
4673 "f19", /* VK_F19 0x82 */
4674 "f20", /* VK_F20 0x83 */
4675 "f21", /* VK_F21 0x84 */
4676 "f22", /* VK_F22 0x85 */
4677 "f23", /* VK_F23 0x86 */
4678 "f24", /* VK_F24 0x87 */
4680 0, 0, 0, 0, /* 0x88 .. 0x8B */
4681 0, 0, 0, 0, /* 0x8C .. 0x8F */
4683 "kp-numlock", /* VK_NUMLOCK 0x90 */
4684 "scroll", /* VK_SCROLL 0x91 */
4686 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4687 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4688 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4689 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4690 "kp-end", /* VK_NUMPAD_END 0x96 */
4691 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4692 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4693 "kp-up", /* VK_NUMPAD_UP 0x99 */
4694 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4695 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4696 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4697 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4699 0, 0, /* 0x9E .. 0x9F */
4702 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4703 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4704 * No other API or message will distinguish left and right keys this way.
4708 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4709 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4710 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4711 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4712 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4718 "attn", /* VK_ATTN 0xF6 */
4719 "crsel", /* VK_CRSEL 0xF7 */
4720 "exsel", /* VK_EXSEL 0xF8 */
4721 "ereof", /* VK_EREOF 0xF9 */
4722 "play", /* VK_PLAY 0xFA */
4723 "zoom", /* VK_ZOOM 0xFB */
4724 "noname", /* VK_NONAME 0xFC */
4725 "pa1", /* VK_PA1 0xFD */
4726 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4730 #else /* not HAVE_NTGUI */
4732 /* This should be dealt with in XTread_socket now, and that doesn't
4733 depend on the client system having the Kana syms defined. See also
4734 the XK_kana_A case below. */
4737 static char *lispy_kana_keys
[] =
4739 /* X Keysym value */
4740 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4741 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4742 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4743 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4744 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4745 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4746 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4747 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4748 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4749 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4750 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4751 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4752 "kana-i", "kana-u", "kana-e", "kana-o",
4753 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4754 "prolongedsound", "kana-A", "kana-I", "kana-U",
4755 "kana-E", "kana-O", "kana-KA", "kana-KI",
4756 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4757 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4758 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4759 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4760 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4761 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4762 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4763 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4764 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4765 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4766 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4767 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4769 #endif /* XK_kana_A */
4772 #define FUNCTION_KEY_OFFSET 0xff00
4774 /* You'll notice that this table is arranged to be conveniently
4775 indexed by X Windows keysym values. */
4776 static char *lispy_function_keys
[] =
4778 /* X Keysym value */
4780 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4781 "backspace", "tab", "linefeed", "clear",
4783 0, 0, 0, "pause", /* 0xff10...1f */
4784 0, 0, 0, 0, 0, 0, 0, "escape",
4786 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4787 "romaji", "hiragana", "katakana", "hiragana-katakana",
4788 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4789 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4790 "eisu-toggle", /* 0xff30...3f */
4791 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4792 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4794 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4795 "down", "prior", "next", "end",
4796 "begin", 0, 0, 0, 0, 0, 0, 0,
4797 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4808 "break", /* 0xff6b */
4811 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4812 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4813 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4814 0, 0, 0, 0, 0, 0, 0, 0,
4815 "kp-tab", /* 0xff89 */
4817 "kp-enter", /* 0xff8d */
4819 "kp-f1", /* 0xff91 */
4823 "kp-home", /* 0xff95 */
4828 "kp-prior", /* kp-page-up */
4829 "kp-next", /* kp-page-down */
4835 0, 0, 0, 0, 0, 0, 0, 0, 0,
4836 "kp-multiply", /* 0xffaa */
4841 "kp-divide", /* 0xffaf */
4842 "kp-0", /* 0xffb0 */
4843 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4846 "kp-equal", /* 0xffbd */
4847 "f1", /* 0xffbe */ /* IsFunctionKey */
4849 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4850 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4851 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4852 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4853 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4854 0, 0, 0, 0, 0, 0, 0, 0,
4855 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4856 0, 0, 0, 0, 0, 0, 0, "delete"
4859 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4860 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4862 static char *iso_lispy_function_keys
[] =
4864 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4865 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4866 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4867 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4868 "iso-lefttab", /* 0xfe20 */
4869 "iso-move-line-up", "iso-move-line-down",
4870 "iso-partial-line-up", "iso-partial-line-down",
4871 "iso-partial-space-left", "iso-partial-space-right",
4872 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4873 "iso-release-margin-left", "iso-release-margin-right",
4874 "iso-release-both-margins",
4875 "iso-fast-cursor-left", "iso-fast-cursor-right",
4876 "iso-fast-cursor-up", "iso-fast-cursor-down",
4877 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4878 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4881 #endif /* not HAVE_NTGUI */
4883 Lisp_Object Vlispy_mouse_stem
;
4885 static char *lispy_wheel_names
[] =
4887 "wheel-up", "wheel-down"
4890 /* drag-n-drop events are generated when a set of selected files are
4891 dragged from another application and dropped onto an Emacs window. */
4892 static char *lispy_drag_n_drop_names
[] =
4897 /* Scroll bar parts. */
4898 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4899 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4900 Lisp_Object Qtop
, Qratio
;
4902 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4903 Lisp_Object
*scroll_bar_parts
[] = {
4904 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4905 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4908 /* User signal events. */
4909 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4911 Lisp_Object
*lispy_user_signals
[] =
4913 &Qusr1_signal
, &Qusr2_signal
4917 /* A vector, indexed by button number, giving the down-going location
4918 of currently depressed buttons, both scroll bar and non-scroll bar.
4920 The elements have the form
4921 (BUTTON-NUMBER MODIFIER-MASK . REST)
4922 where REST is the cdr of a position as it would be reported in the event.
4924 The make_lispy_event function stores positions here to tell the
4925 difference between click and drag events, and to store the starting
4926 location to be included in drag events. */
4928 static Lisp_Object button_down_location
;
4930 /* Information about the most recent up-going button event: Which
4931 button, what location, and what time. */
4933 static int last_mouse_button
;
4934 static int last_mouse_x
;
4935 static int last_mouse_y
;
4936 static unsigned long button_down_time
;
4938 /* The maximum time between clicks to make a double-click, or Qnil to
4939 disable double-click detection, or Qt for no time limit. */
4941 Lisp_Object Vdouble_click_time
;
4943 /* Maximum number of pixels the mouse may be moved between clicks
4944 to make a double-click. */
4946 EMACS_INT double_click_fuzz
;
4948 /* The number of clicks in this multiple-click. */
4950 int double_click_count
;
4952 /* Return position of a mouse click or wheel event */
4955 make_lispy_position (f
, x
, y
, time
)
4961 enum window_part part
;
4962 Lisp_Object posn
= Qnil
;
4963 Lisp_Object extra_info
= Qnil
;
4966 /* Set `window' to the window under frame pixel coordinates (x,y) */
4968 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
4969 &part
, &wx
, &wy
, 0);
4973 if (WINDOWP (window
))
4975 /* It's a click in window window at frame coordinates (x,y) */
4976 struct window
*w
= XWINDOW (window
);
4977 Lisp_Object object
= Qnil
;
4978 int textpos
= -1, rx
= -1, ry
= -1;
4979 int dx
= -1, dy
= -1;
4981 /* Set event coordinates to window-relative coordinates
4982 for constructing the Lisp event below. */
4986 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
4988 /* Mode line or header line. Look for a string under
4989 the mouse that may have a `local-map' property. */
4993 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
4995 string
= mode_line_string (w
, &rx
, &ry
, &dx
, &dy
, part
, &charpos
);
4996 if (STRINGP (string
))
4997 object
= Fcons (string
, make_number (charpos
));
4998 if (w
== XWINDOW (selected_window
))
5001 textpos
= XMARKER (w
->pointm
)->charpos
;
5003 else if (part
== ON_VERTICAL_BORDER
)
5005 posn
= Qvertical_line
;
5009 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5014 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5016 string
= marginal_area_string (w
, &rx
, &ry
, &dx
, &dy
, part
, &charpos
);
5017 if (STRINGP (string
))
5018 object
= Fcons (string
, make_number (charpos
));
5019 #ifdef HAVE_WINDOW_SYSTEM
5020 else if (IMAGEP (string
))
5022 Lisp_Object image_map
, hotspot
;
5024 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5026 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5028 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5029 posn
= XCAR (hotspot
);
5033 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
5035 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
5038 if (part
== ON_RIGHT_FRINGE
)
5039 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5040 + window_box_width (w
, TEXT_AREA
)
5041 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5042 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5044 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5045 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5051 struct display_pos p
;
5053 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5054 buffer_posn_from_coords (w
, &wx
, &wy
, &dx2
, &dy2
, &string
, &p
);
5055 textpos
= CHARPOS (p
.pos
);
5056 if (rx
< 0) rx
= wx
;
5057 if (ry
< 0) ry
= wy
;
5058 if (dx
< 0) dx
= dx2
;
5059 if (dy
< 0) dy
= dy2
;
5063 posn
= make_number (textpos
);
5064 if (STRINGP (string
))
5065 object
= Fcons (string
,
5066 make_number (CHARPOS (p
.string_pos
)));
5067 #ifdef HAVE_WINDOW_SYSTEM
5068 else if (IMAGEP (string
))
5070 Lisp_Object image_map
, hotspot
;
5072 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5074 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5076 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5077 posn
= XCAR (hotspot
);
5083 extra_info
= Fcons (object
,
5084 Fcons (make_number (textpos
),
5085 Fcons (Fcons (make_number (rx
),
5087 Fcons (Fcons (make_number (dx
),
5093 XSETFRAME (window
, f
);
5098 XSETFASTINT (*x
, 0);
5099 XSETFASTINT (*y
, 0);
5102 return Fcons (window
,
5104 Fcons (Fcons (*x
, *y
),
5105 Fcons (make_number (time
),
5109 /* Given a struct input_event, build the lisp event which represents
5110 it. If EVENT is 0, build a mouse movement event from the mouse
5111 movement buffer, which should have a movement event in it.
5113 Note that events must be passed to this function in the order they
5114 are received; this function stores the location of button presses
5115 in order to build drag events when the button is released. */
5118 make_lispy_event (event
)
5119 struct input_event
*event
;
5123 switch (SWITCH_ENUM_CAST (event
->kind
))
5125 /* A simple keystroke. */
5126 case ASCII_KEYSTROKE_EVENT
:
5128 Lisp_Object lispy_c
;
5129 int c
= event
->code
& 0377;
5130 /* Turn ASCII characters into control characters
5132 if (event
->modifiers
& ctrl_modifier
)
5133 c
= make_ctrl_char (c
);
5135 /* Add in the other modifier bits. We took care of ctrl_modifier
5136 just above, and the shift key was taken care of by the X code,
5137 and applied to control characters by make_ctrl_char. */
5138 c
|= (event
->modifiers
5139 & (meta_modifier
| alt_modifier
5140 | hyper_modifier
| super_modifier
));
5141 /* Distinguish Shift-SPC from SPC. */
5142 if ((event
->code
& 0377) == 040
5143 && event
->modifiers
& shift_modifier
)
5144 c
|= shift_modifier
;
5145 button_down_time
= 0;
5146 XSETFASTINT (lispy_c
, c
);
5150 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5152 Lisp_Object lispy_c
;
5153 int c
= event
->code
;
5155 /* Add in the other modifier bits. We took care of ctrl_modifier
5156 just above, and the shift key was taken care of by the X code,
5157 and applied to control characters by make_ctrl_char. */
5158 c
|= (event
->modifiers
5159 & (meta_modifier
| alt_modifier
5160 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5161 /* What about the `shift' modifier ? */
5162 button_down_time
= 0;
5163 XSETFASTINT (lispy_c
, c
);
5167 /* A function key. The symbol may need to have modifier prefixes
5169 case NON_ASCII_KEYSTROKE_EVENT
:
5170 button_down_time
= 0;
5172 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5173 if (event
->code
== lispy_accent_codes
[i
])
5174 return modify_event_symbol (i
,
5176 Qfunction_key
, Qnil
,
5177 lispy_accent_keys
, &accent_key_syms
,
5178 (sizeof (lispy_accent_keys
)
5179 / sizeof (lispy_accent_keys
[0])));
5183 if (event
->code
>= 0x400 && event
->code
< 0x500)
5184 return modify_event_symbol (event
->code
- 0x400,
5185 event
->modifiers
& ~shift_modifier
,
5186 Qfunction_key
, Qnil
,
5187 lispy_kana_keys
, &func_key_syms
,
5188 (sizeof (lispy_kana_keys
)
5189 / sizeof (lispy_kana_keys
[0])));
5190 #endif /* XK_kana_A */
5193 #ifdef ISO_FUNCTION_KEY_OFFSET
5194 if (event
->code
< FUNCTION_KEY_OFFSET
5195 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5196 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5198 Qfunction_key
, Qnil
,
5199 iso_lispy_function_keys
, &func_key_syms
,
5200 (sizeof (iso_lispy_function_keys
)
5201 / sizeof (iso_lispy_function_keys
[0])));
5204 /* Handle system-specific or unknown keysyms. */
5205 if (event
->code
& (1 << 28)
5206 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5207 || (event
->code
- FUNCTION_KEY_OFFSET
5208 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5209 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5211 /* We need to use an alist rather than a vector as the cache
5212 since we can't make a vector long enuf. */
5213 if (NILP (current_kboard
->system_key_syms
))
5214 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5215 return modify_event_symbol (event
->code
,
5218 current_kboard
->Vsystem_key_alist
,
5219 0, ¤t_kboard
->system_key_syms
,
5223 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5225 Qfunction_key
, Qnil
,
5226 lispy_function_keys
, &func_key_syms
,
5227 (sizeof (lispy_function_keys
)
5228 / sizeof (lispy_function_keys
[0])));
5231 /* A mouse click. Figure out where it is, decide whether it's
5232 a press, click or drag, and build the appropriate structure. */
5233 case MOUSE_CLICK_EVENT
:
5234 #ifndef USE_TOOLKIT_SCROLL_BARS
5235 case SCROLL_BAR_CLICK_EVENT
:
5238 int button
= event
->code
;
5240 Lisp_Object position
;
5241 Lisp_Object
*start_pos_ptr
;
5242 Lisp_Object start_pos
;
5246 /* Build the position as appropriate for this mouse click. */
5247 if (event
->kind
== MOUSE_CLICK_EVENT
)
5249 struct frame
*f
= XFRAME (event
->frame_or_window
);
5250 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5254 /* Ignore mouse events that were made on frame that
5255 have been deleted. */
5256 if (! FRAME_LIVE_P (f
))
5259 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5260 /* EVENT->x and EVENT->y are frame-relative pixel
5261 coordinates at this place. Under old redisplay, COLUMN
5262 and ROW are set to frame relative glyph coordinates
5263 which are then used to determine whether this click is
5264 in a menu (non-toolkit version). */
5265 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5266 &column
, &row
, NULL
, 1);
5268 /* In the non-toolkit version, clicks on the menu bar
5269 are ordinary button events in the event buffer.
5270 Distinguish them, and invoke the menu.
5272 (In the toolkit version, the toolkit handles the menu bar
5273 and Emacs doesn't know about it until after the user
5274 makes a selection.) */
5275 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5276 && (event
->modifiers
& down_modifier
))
5278 Lisp_Object items
, item
;
5283 /* Activate the menu bar on the down event. If the
5284 up event comes in before the menu code can deal with it,
5286 if (! (event
->modifiers
& down_modifier
))
5290 /* Find the menu bar item under `column'. */
5292 items
= FRAME_MENU_BAR_ITEMS (f
);
5293 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5295 Lisp_Object pos
, string
;
5296 string
= AREF (items
, i
+ 1);
5297 pos
= AREF (items
, i
+ 3);
5300 if (column
>= XINT (pos
)
5301 && column
< XINT (pos
) + SCHARS (string
))
5303 item
= AREF (items
, i
);
5308 /* ELisp manual 2.4b says (x y) are window relative but
5309 code says they are frame-relative. */
5311 = Fcons (event
->frame_or_window
,
5313 Fcons (Fcons (event
->x
, event
->y
),
5314 Fcons (make_number (event
->timestamp
),
5317 return Fcons (item
, Fcons (position
, Qnil
));
5319 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5321 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5324 #ifndef USE_TOOLKIT_SCROLL_BARS
5327 /* It's a scrollbar click. */
5329 Lisp_Object portion_whole
;
5332 window
= event
->frame_or_window
;
5333 portion_whole
= Fcons (event
->x
, event
->y
);
5334 part
= *scroll_bar_parts
[(int) event
->part
];
5338 Fcons (Qvertical_scroll_bar
,
5339 Fcons (portion_whole
,
5340 Fcons (make_number (event
->timestamp
),
5341 Fcons (part
, Qnil
)))));
5343 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5345 if (button
>= ASIZE (button_down_location
))
5347 button_down_location
= larger_vector (button_down_location
,
5349 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5352 start_pos_ptr
= &AREF (button_down_location
, button
);
5353 start_pos
= *start_pos_ptr
;
5354 *start_pos_ptr
= Qnil
;
5357 /* On window-system frames, use the value of
5358 double-click-fuzz as is. On other frames, interpret it
5359 as a multiple of 1/8 characters. */
5363 if (WINDOWP (event
->frame_or_window
))
5364 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5365 else if (FRAMEP (event
->frame_or_window
))
5366 f
= XFRAME (event
->frame_or_window
);
5370 if (FRAME_WINDOW_P (f
))
5371 fuzz
= double_click_fuzz
;
5373 fuzz
= double_click_fuzz
/ 8;
5375 is_double
= (button
== last_mouse_button
5376 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5377 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5378 && button_down_time
!= 0
5379 && (EQ (Vdouble_click_time
, Qt
)
5380 || (INTEGERP (Vdouble_click_time
)
5381 && ((int)(event
->timestamp
- button_down_time
)
5382 < XINT (Vdouble_click_time
)))));
5385 last_mouse_button
= button
;
5386 last_mouse_x
= XINT (event
->x
);
5387 last_mouse_y
= XINT (event
->y
);
5389 /* If this is a button press, squirrel away the location, so
5390 we can decide later whether it was a click or a drag. */
5391 if (event
->modifiers
& down_modifier
)
5395 double_click_count
++;
5396 event
->modifiers
|= ((double_click_count
> 2)
5401 double_click_count
= 1;
5402 button_down_time
= event
->timestamp
;
5403 *start_pos_ptr
= Fcopy_alist (position
);
5406 /* Now we're releasing a button - check the co-ordinates to
5407 see if this was a click or a drag. */
5408 else if (event
->modifiers
& up_modifier
)
5410 /* If we did not see a down before this up, ignore the up.
5411 Probably this happened because the down event chose a
5412 menu item. It would be an annoyance to treat the
5413 release of the button that chose the menu item as a
5416 if (!CONSP (start_pos
))
5419 event
->modifiers
&= ~up_modifier
;
5420 #if 0 /* Formerly we treated an up with no down as a click event. */
5421 if (!CONSP (start_pos
))
5422 event
->modifiers
|= click_modifier
;
5427 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5429 /* The third element of every position
5430 should be the (x,y) pair. */
5431 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5433 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5435 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5436 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5439 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5440 && ydiff
< double_click_fuzz
5441 && ydiff
> - double_click_fuzz
)
5442 /* Mouse hasn't moved (much). */
5443 event
->modifiers
|= click_modifier
;
5446 button_down_time
= 0;
5447 event
->modifiers
|= drag_modifier
;
5450 /* Don't check is_double; treat this as multiple
5451 if the down-event was multiple. */
5452 if (double_click_count
> 1)
5453 event
->modifiers
|= ((double_click_count
> 2)
5459 /* Every mouse event should either have the down_modifier or
5460 the up_modifier set. */
5464 /* Get the symbol we should use for the mouse click. */
5467 head
= modify_event_symbol (button
,
5469 Qmouse_click
, Vlispy_mouse_stem
,
5472 XVECTOR (mouse_syms
)->size
);
5473 if (event
->modifiers
& drag_modifier
)
5478 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5481 Fcons (make_number (double_click_count
),
5492 Lisp_Object position
;
5495 /* Build the position as appropriate for this mouse click. */
5496 struct frame
*f
= XFRAME (event
->frame_or_window
);
5498 /* Ignore wheel events that were made on frame that have been
5500 if (! FRAME_LIVE_P (f
))
5503 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5506 /* Set double or triple modifiers to indicate the wheel speed. */
5508 /* On window-system frames, use the value of
5509 double-click-fuzz as is. On other frames, interpret it
5510 as a multiple of 1/8 characters. */
5515 if (WINDOWP (event
->frame_or_window
))
5516 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5517 else if (FRAMEP (event
->frame_or_window
))
5518 f
= XFRAME (event
->frame_or_window
);
5522 if (FRAME_WINDOW_P (f
))
5523 fuzz
= double_click_fuzz
;
5525 fuzz
= double_click_fuzz
/ 8;
5527 is_double
= (last_mouse_button
< 0
5528 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5529 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5530 && button_down_time
!= 0
5531 && (EQ (Vdouble_click_time
, Qt
)
5532 || (INTEGERP (Vdouble_click_time
)
5533 && ((int)(event
->timestamp
- button_down_time
)
5534 < XINT (Vdouble_click_time
)))));
5537 double_click_count
++;
5538 event
->modifiers
|= ((double_click_count
> 2)
5544 double_click_count
= 1;
5545 event
->modifiers
|= click_modifier
;
5548 button_down_time
= event
->timestamp
;
5549 /* Use a negative value to distinguish wheel from mouse button. */
5550 last_mouse_button
= -1;
5551 last_mouse_x
= XINT (event
->x
);
5552 last_mouse_y
= XINT (event
->y
);
5558 if (event
->modifiers
& up_modifier
)
5560 /* Emit a wheel-up event. */
5561 event
->modifiers
&= ~up_modifier
;
5564 else if (event
->modifiers
& down_modifier
)
5566 /* Emit a wheel-down event. */
5567 event
->modifiers
&= ~down_modifier
;
5571 /* Every wheel event should either have the down_modifier or
5572 the up_modifier set. */
5575 /* Get the symbol we should use for the wheel event. */
5576 head
= modify_event_symbol (symbol_num
,
5582 ASIZE (wheel_syms
));
5585 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5588 Fcons (make_number (double_click_count
),
5597 #ifdef USE_TOOLKIT_SCROLL_BARS
5599 /* We don't have down and up events if using toolkit scroll bars,
5600 so make this always a click event. Store in the `part' of
5601 the Lisp event a symbol which maps to the following actions:
5603 `above_handle' page up
5604 `below_handle' page down
5608 `bottom' bottom of buffer
5609 `handle' thumb has been dragged.
5610 `end-scroll' end of interaction with scroll bar
5612 The incoming input_event contains in its `part' member an
5613 index of type `enum scroll_bar_part' which we can use as an
5614 index in scroll_bar_parts to get the appropriate symbol. */
5616 case SCROLL_BAR_CLICK_EVENT
:
5618 Lisp_Object position
, head
, window
, portion_whole
, part
;
5620 window
= event
->frame_or_window
;
5621 portion_whole
= Fcons (event
->x
, event
->y
);
5622 part
= *scroll_bar_parts
[(int) event
->part
];
5626 Fcons (Qvertical_scroll_bar
,
5627 Fcons (portion_whole
,
5628 Fcons (make_number (event
->timestamp
),
5629 Fcons (part
, Qnil
)))));
5631 /* Always treat scroll bar events as clicks. */
5632 event
->modifiers
|= click_modifier
;
5633 event
->modifiers
&= ~up_modifier
;
5635 if (event
->code
>= ASIZE (mouse_syms
))
5636 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5638 /* Get the symbol we should use for the mouse click. */
5639 head
= modify_event_symbol (event
->code
,
5644 XVECTOR (mouse_syms
)->size
);
5645 return Fcons (head
, Fcons (position
, Qnil
));
5648 #endif /* USE_TOOLKIT_SCROLL_BARS */
5651 case W32_SCROLL_BAR_CLICK_EVENT
:
5653 int button
= event
->code
;
5655 Lisp_Object position
;
5656 Lisp_Object
*start_pos_ptr
;
5657 Lisp_Object start_pos
;
5661 Lisp_Object portion_whole
;
5664 window
= event
->frame_or_window
;
5665 portion_whole
= Fcons (event
->x
, event
->y
);
5666 part
= *scroll_bar_parts
[(int) event
->part
];
5670 Fcons (Qvertical_scroll_bar
,
5671 Fcons (portion_whole
,
5672 Fcons (make_number (event
->timestamp
),
5673 Fcons (part
, Qnil
)))));
5676 /* Always treat W32 scroll bar events as clicks. */
5677 event
->modifiers
|= click_modifier
;
5680 /* Get the symbol we should use for the mouse click. */
5683 head
= modify_event_symbol (button
,
5688 XVECTOR (mouse_syms
)->size
);
5694 #endif /* WINDOWSNT */
5696 case DRAG_N_DROP_EVENT
:
5699 Lisp_Object head
, position
;
5702 /* The frame_or_window field should be a cons of the frame in
5703 which the event occurred and a list of the filenames
5705 if (! CONSP (event
->frame_or_window
))
5708 f
= XFRAME (XCAR (event
->frame_or_window
));
5709 files
= XCDR (event
->frame_or_window
);
5711 /* Ignore mouse events that were made on frames that
5712 have been deleted. */
5713 if (! FRAME_LIVE_P (f
))
5716 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5719 head
= modify_event_symbol (0, event
->modifiers
,
5721 lispy_drag_n_drop_names
,
5722 &drag_n_drop_syms
, 1);
5728 #endif /* HAVE_MOUSE */
5730 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5731 || defined (USE_GTK)
5732 case MENU_BAR_EVENT
:
5733 if (EQ (event
->arg
, event
->frame_or_window
))
5734 /* This is the prefix key. We translate this to
5735 `(menu_bar)' because the code in keyboard.c for menu
5736 events, which we use, relies on this. */
5737 return Fcons (Qmenu_bar
, Qnil
);
5741 case SELECT_WINDOW_EVENT
:
5742 /* Make an event (select-window (WINDOW)). */
5743 return Fcons (Qselect_window
,
5744 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5747 case TOOL_BAR_EVENT
:
5748 if (EQ (event
->arg
, event
->frame_or_window
))
5749 /* This is the prefix key. We translate this to
5750 `(tool_bar)' because the code in keyboard.c for tool bar
5751 events, which we use, relies on this. */
5752 return Fcons (Qtool_bar
, Qnil
);
5753 else if (SYMBOLP (event
->arg
))
5754 return apply_modifiers (event
->modifiers
, event
->arg
);
5757 case USER_SIGNAL_EVENT
:
5758 /* A user signal. */
5759 return *lispy_user_signals
[event
->code
];
5761 case SAVE_SESSION_EVENT
:
5762 return Qsave_session
;
5764 /* The 'kind' field of the event is something we don't recognize. */
5773 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5775 Lisp_Object bar_window
;
5776 enum scroll_bar_part part
;
5780 /* Is it a scroll bar movement? */
5781 if (frame
&& ! NILP (bar_window
))
5783 Lisp_Object part_sym
;
5785 part_sym
= *scroll_bar_parts
[(int) part
];
5786 return Fcons (Qscroll_bar_movement
,
5787 (Fcons (Fcons (bar_window
,
5788 Fcons (Qvertical_scroll_bar
,
5789 Fcons (Fcons (x
, y
),
5790 Fcons (make_number (time
),
5796 /* Or is it an ordinary mouse movement? */
5799 Lisp_Object position
;
5801 position
= make_lispy_position (frame
, &x
, &y
, time
);
5803 return Fcons (Qmouse_movement
,
5809 #endif /* HAVE_MOUSE */
5811 /* Construct a switch frame event. */
5813 make_lispy_switch_frame (frame
)
5816 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5819 /* Manipulating modifiers. */
5821 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5823 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5824 SYMBOL's name of the end of the modifiers; the string from this
5825 position is the unmodified symbol name.
5827 This doesn't use any caches. */
5830 parse_modifiers_uncached (symbol
, modifier_end
)
5838 CHECK_SYMBOL (symbol
);
5841 name
= SYMBOL_NAME (symbol
);
5843 for (i
= 0; i
+2 <= SBYTES (name
); )
5845 int this_mod_end
= 0;
5848 /* See if the name continues with a modifier word.
5849 Check that the word appears, but don't check what follows it.
5850 Set this_mod and this_mod_end to record what we find. */
5852 switch (SREF (name
, i
))
5854 #define SINGLE_LETTER_MOD(BIT) \
5855 (this_mod_end = i + 1, this_mod = BIT)
5858 SINGLE_LETTER_MOD (alt_modifier
);
5862 SINGLE_LETTER_MOD (ctrl_modifier
);
5866 SINGLE_LETTER_MOD (hyper_modifier
);
5870 SINGLE_LETTER_MOD (meta_modifier
);
5874 SINGLE_LETTER_MOD (shift_modifier
);
5878 SINGLE_LETTER_MOD (super_modifier
);
5881 #undef SINGLE_LETTER_MOD
5883 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5884 if (i + LEN + 1 <= SBYTES (name) \
5885 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5887 this_mod_end = i + LEN; \
5892 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5893 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5894 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5898 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5900 #undef MULTI_LETTER_MOD
5904 /* If we found no modifier, stop looking for them. */
5905 if (this_mod_end
== 0)
5908 /* Check there is a dash after the modifier, so that it
5909 really is a modifier. */
5910 if (this_mod_end
>= SBYTES (name
)
5911 || SREF (name
, this_mod_end
) != '-')
5914 /* This modifier is real; look for another. */
5915 modifiers
|= this_mod
;
5916 i
= this_mod_end
+ 1;
5919 /* Should we include the `click' modifier? */
5920 if (! (modifiers
& (down_modifier
| drag_modifier
5921 | double_modifier
| triple_modifier
))
5922 && i
+ 7 == SBYTES (name
)
5923 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5924 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5925 modifiers
|= click_modifier
;
5933 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5934 prepended to the string BASE[0..BASE_LEN-1].
5935 This doesn't use any caches. */
5937 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5940 int base_len
, base_len_byte
;
5942 /* Since BASE could contain nulls, we can't use intern here; we have
5943 to use Fintern, which expects a genuine Lisp_String, and keeps a
5946 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5952 /* Only the event queue may use the `up' modifier; it should always
5953 be turned into a click or drag event before presented to lisp code. */
5954 if (modifiers
& up_modifier
)
5957 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5958 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5959 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5960 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5961 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5962 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5963 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5964 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5965 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5966 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5967 /* The click modifier is denoted by the absence of other modifiers. */
5971 mod_len
= p
- new_mods
;
5975 Lisp_Object new_name
;
5977 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5978 mod_len
+ base_len_byte
);
5979 bcopy (new_mods
, SDATA (new_name
), mod_len
);
5980 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
5982 return Fintern (new_name
, Qnil
);
5987 static char *modifier_names
[] =
5989 "up", "down", "drag", "click", "double", "triple", 0, 0,
5990 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5991 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5993 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5995 static Lisp_Object modifier_symbols
;
5997 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5999 lispy_modifier_list (modifiers
)
6002 Lisp_Object modifier_list
;
6005 modifier_list
= Qnil
;
6006 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6007 if (modifiers
& (1<<i
))
6008 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6011 return modifier_list
;
6015 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6016 where UNMODIFIED is the unmodified form of SYMBOL,
6017 MASK is the set of modifiers present in SYMBOL's name.
6018 This is similar to parse_modifiers_uncached, but uses the cache in
6019 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6020 Qevent_symbol_elements property. */
6023 parse_modifiers (symbol
)
6026 Lisp_Object elements
;
6028 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6029 if (CONSP (elements
))
6034 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6035 Lisp_Object unmodified
;
6038 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6039 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6042 if (modifiers
& ~INTMASK
)
6044 XSETFASTINT (mask
, modifiers
);
6045 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6047 /* Cache the parsing results on SYMBOL. */
6048 Fput (symbol
, Qevent_symbol_element_mask
,
6050 Fput (symbol
, Qevent_symbol_elements
,
6051 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6053 /* Since we know that SYMBOL is modifiers applied to unmodified,
6054 it would be nice to put that in unmodified's cache.
6055 But we can't, since we're not sure that parse_modifiers is
6062 /* Apply the modifiers MODIFIERS to the symbol BASE.
6063 BASE must be unmodified.
6065 This is like apply_modifiers_uncached, but uses BASE's
6066 Qmodifier_cache property, if present. It also builds
6067 Qevent_symbol_elements properties, since it has that info anyway.
6069 apply_modifiers copies the value of BASE's Qevent_kind property to
6070 the modified symbol. */
6072 apply_modifiers (modifiers
, base
)
6076 Lisp_Object cache
, index
, entry
, new_symbol
;
6078 /* Mask out upper bits. We don't know where this value's been. */
6079 modifiers
&= INTMASK
;
6081 /* The click modifier never figures into cache indices. */
6082 cache
= Fget (base
, Qmodifier_cache
);
6083 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6084 entry
= assq_no_quit (index
, cache
);
6087 new_symbol
= XCDR (entry
);
6090 /* We have to create the symbol ourselves. */
6091 new_symbol
= apply_modifiers_uncached (modifiers
,
6092 SDATA (SYMBOL_NAME (base
)),
6093 SCHARS (SYMBOL_NAME (base
)),
6094 SBYTES (SYMBOL_NAME (base
)));
6096 /* Add the new symbol to the base's cache. */
6097 entry
= Fcons (index
, new_symbol
);
6098 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6100 /* We have the parsing info now for free, so we could add it to
6102 XSETFASTINT (index, modifiers);
6103 Fput (new_symbol, Qevent_symbol_element_mask,
6104 Fcons (base, Fcons (index, Qnil)));
6105 Fput (new_symbol, Qevent_symbol_elements,
6106 Fcons (base, lispy_modifier_list (modifiers)));
6107 Sadly, this is only correct if `base' is indeed a base event,
6108 which is not necessarily the case. -stef */
6111 /* Make sure this symbol is of the same kind as BASE.
6113 You'd think we could just set this once and for all when we
6114 intern the symbol above, but reorder_modifiers may call us when
6115 BASE's property isn't set right; we can't assume that just
6116 because it has a Qmodifier_cache property it must have its
6117 Qevent_kind set right as well. */
6118 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6122 kind
= Fget (base
, Qevent_kind
);
6124 Fput (new_symbol
, Qevent_kind
, kind
);
6131 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6132 return a symbol with the modifiers placed in the canonical order.
6133 Canonical order is alphabetical, except for down and drag, which
6134 always come last. The 'click' modifier is never written out.
6136 Fdefine_key calls this to make sure that (for example) C-M-foo
6137 and M-C-foo end up being equivalent in the keymap. */
6140 reorder_modifiers (symbol
)
6143 /* It's hopefully okay to write the code this way, since everything
6144 will soon be in caches, and no consing will be done at all. */
6147 parsed
= parse_modifiers (symbol
);
6148 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6153 /* For handling events, we often want to produce a symbol whose name
6154 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6155 to some base, like the name of a function key or mouse button.
6156 modify_event_symbol produces symbols of this sort.
6158 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6159 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6162 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6163 into symbol names, or a string specifying a name stem used to
6164 construct a symbol name or the form `STEM-N', where N is the decimal
6165 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6166 non-nil; otherwise NAME_TABLE is used.
6168 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6169 persist between calls to modify_event_symbol that it can use to
6170 store a cache of the symbols it's generated for this NAME_TABLE
6171 before. The object stored there may be a vector or an alist.
6173 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6175 MODIFIERS is a set of modifier bits (as given in struct input_events)
6176 whose prefixes should be applied to the symbol name.
6178 SYMBOL_KIND is the value to be placed in the event_kind property of
6179 the returned symbol.
6181 The symbols we create are supposed to have an
6182 `event-symbol-elements' property, which lists the modifiers present
6183 in the symbol's name. */
6186 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6187 name_table
, symbol_table
, table_size
)
6190 Lisp_Object symbol_kind
;
6191 Lisp_Object name_alist_or_stem
;
6193 Lisp_Object
*symbol_table
;
6194 unsigned int table_size
;
6197 Lisp_Object symbol_int
;
6199 /* Get rid of the "vendor-specific" bit here. */
6200 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6202 /* Is this a request for a valid symbol? */
6203 if (symbol_num
< 0 || symbol_num
>= table_size
)
6206 if (CONSP (*symbol_table
))
6207 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6209 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6210 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6211 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6212 we've never used that symbol before. */
6215 if (! VECTORP (*symbol_table
)
6216 || XVECTOR (*symbol_table
)->size
!= table_size
)
6220 XSETFASTINT (size
, table_size
);
6221 *symbol_table
= Fmake_vector (size
, Qnil
);
6224 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6227 /* Have we already used this symbol before? */
6230 /* No; let's create it. */
6231 if (CONSP (name_alist_or_stem
))
6232 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6233 else if (STRINGP (name_alist_or_stem
))
6235 int len
= SBYTES (name_alist_or_stem
);
6236 char *buf
= (char *) alloca (len
+ 50);
6237 if (sizeof (int) == sizeof (EMACS_INT
))
6238 sprintf (buf
, "%s-%d", SDATA (name_alist_or_stem
),
6239 XINT (symbol_int
) + 1);
6240 else if (sizeof (long) == sizeof (EMACS_INT
))
6241 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6242 XINT (symbol_int
) + 1);
6243 value
= intern (buf
);
6245 else if (name_table
!= 0 && name_table
[symbol_num
])
6246 value
= intern (name_table
[symbol_num
]);
6248 #ifdef HAVE_WINDOW_SYSTEM
6251 char *name
= x_get_keysym_name (symbol_num
);
6253 value
= intern (name
);
6260 sprintf (buf
, "key-%d", symbol_num
);
6261 value
= intern (buf
);
6264 if (CONSP (*symbol_table
))
6265 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6267 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6269 /* Fill in the cache entries for this symbol; this also
6270 builds the Qevent_symbol_elements property, which the user
6272 apply_modifiers (modifiers
& click_modifier
, value
);
6273 Fput (value
, Qevent_kind
, symbol_kind
);
6276 /* Apply modifiers to that symbol. */
6277 return apply_modifiers (modifiers
, value
);
6280 /* Convert a list that represents an event type,
6281 such as (ctrl meta backspace), into the usual representation of that
6282 event type as a number or a symbol. */
6284 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6285 doc
: /* Convert the event description list EVENT-DESC to an event type.
6286 EVENT-DESC should contain one base event type (a character or symbol)
6287 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6288 drag, down, double or triple). The base must be last.
6289 The return value is an event type (a character or symbol) which
6290 has the same base event type and all the specified modifiers. */)
6292 Lisp_Object event_desc
;
6300 while (CONSP (rest
))
6308 /* Given a symbol, see if it is a modifier name. */
6309 if (SYMBOLP (elt
) && CONSP (rest
))
6310 this = parse_solitary_modifier (elt
);
6314 else if (!NILP (base
))
6315 error ("Two bases given in one event");
6321 /* Let the symbol A refer to the character A. */
6322 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6323 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6325 if (INTEGERP (base
))
6327 /* Turn (shift a) into A. */
6328 if ((modifiers
& shift_modifier
) != 0
6329 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6331 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6332 modifiers
&= ~shift_modifier
;
6335 /* Turn (control a) into C-a. */
6336 if (modifiers
& ctrl_modifier
)
6337 return make_number ((modifiers
& ~ctrl_modifier
)
6338 | make_ctrl_char (XINT (base
)));
6340 return make_number (modifiers
| XINT (base
));
6342 else if (SYMBOLP (base
))
6343 return apply_modifiers (modifiers
, base
);
6346 error ("Invalid base event");
6351 /* Try to recognize SYMBOL as a modifier name.
6352 Return the modifier flag bit, or 0 if not recognized. */
6355 parse_solitary_modifier (symbol
)
6358 Lisp_Object name
= SYMBOL_NAME (symbol
);
6360 switch (SREF (name
, 0))
6362 #define SINGLE_LETTER_MOD(BIT) \
6363 if (SBYTES (name) == 1) \
6366 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6367 if (LEN == SBYTES (name) \
6368 && ! strncmp (SDATA (name), NAME, LEN)) \
6372 SINGLE_LETTER_MOD (alt_modifier
);
6376 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6380 SINGLE_LETTER_MOD (ctrl_modifier
);
6384 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6385 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6389 SINGLE_LETTER_MOD (hyper_modifier
);
6393 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6397 SINGLE_LETTER_MOD (meta_modifier
);
6401 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6405 SINGLE_LETTER_MOD (shift_modifier
);
6409 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6410 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6411 SINGLE_LETTER_MOD (super_modifier
);
6415 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6416 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6417 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6421 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6424 #undef SINGLE_LETTER_MOD
6425 #undef MULTI_LETTER_MOD
6431 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6432 Such a list is not valid as an event,
6433 but it can be a Lucid-style event type list. */
6436 lucid_event_type_list_p (object
)
6441 if (! CONSP (object
))
6444 if (EQ (XCAR (object
), Qhelp_echo
)
6445 || EQ (XCAR (object
), Qvertical_line
)
6446 || EQ (XCAR (object
), Qmode_line
)
6447 || EQ (XCAR (object
), Qheader_line
))
6450 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6454 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6461 /* Store into *addr a value nonzero if terminal input chars are available.
6462 Serves the purpose of ioctl (0, FIONREAD, addr)
6463 but works even if FIONREAD does not exist.
6464 (In fact, this may actually read some input.)
6466 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6467 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6470 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6475 /* First of all, have we already counted some input? */
6476 *addr
= (!NILP (Vquit_flag
)
6477 || readable_filtered_events (do_timers_now
, filter_events
));
6479 /* If input is being read as it arrives, and we have none, there is none. */
6480 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6483 /* Try to read some input and see how much we get. */
6485 *addr
= (!NILP (Vquit_flag
)
6486 || readable_filtered_events (do_timers_now
, filter_events
));
6489 /* Store into *addr a value nonzero if terminal input chars are available.
6490 Serves the purpose of ioctl (0, FIONREAD, addr)
6491 but works even if FIONREAD does not exist.
6492 (In fact, this may actually read some input.)
6494 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6497 get_input_pending (addr
, do_timers_now
)
6501 get_filtered_input_pending (addr
, do_timers_now
, 0);
6504 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6507 gobble_input (expected
)
6512 if (interrupt_input
)
6515 mask
= sigblock (sigmask (SIGIO
));
6516 read_avail_input (expected
);
6520 #ifdef POLL_FOR_INPUT
6521 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6524 mask
= sigblock (sigmask (SIGALRM
));
6525 read_avail_input (expected
);
6531 read_avail_input (expected
);
6535 /* Put a BUFFER_SWITCH_EVENT in the buffer
6536 so that read_key_sequence will notice the new current buffer. */
6539 record_asynch_buffer_change ()
6541 struct input_event event
;
6545 event
.kind
= BUFFER_SWITCH_EVENT
;
6546 event
.frame_or_window
= Qnil
;
6550 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6551 The purpose of the event is to make read_key_sequence look up the
6552 keymaps again. If we aren't in read_key_sequence, we don't need one,
6553 and the event could cause trouble by messing up (input-pending-p). */
6554 tem
= Fwaiting_for_user_input_p ();
6558 /* We never need these events if we have no asynchronous subprocesses. */
6562 /* Make sure no interrupt happens while storing the event. */
6564 if (interrupt_input
)
6567 mask
= sigblock (sigmask (SIGIO
));
6568 kbd_buffer_store_event (&event
);
6575 kbd_buffer_store_event (&event
);
6582 /* Read any terminal input already buffered up by the system
6583 into the kbd_buffer, but do not wait.
6585 EXPECTED should be nonzero if the caller knows there is some input.
6587 Except on VMS, all input is read by this function.
6588 If interrupt_input is nonzero, this function MUST be called
6589 only when SIGIO is blocked.
6591 Returns the number of keyboard chars read, or -1 meaning
6592 this is a bad time to try to read input. */
6595 read_avail_input (expected
)
6598 struct input_event buf
[KBD_BUFFER_SIZE
];
6602 for (i
= 0; i
< KBD_BUFFER_SIZE
; i
++)
6603 EVENT_INIT (buf
[i
]);
6605 if (read_socket_hook
)
6606 /* No need for FIONREAD or fcntl; just say don't wait. */
6607 nread
= (*read_socket_hook
) (buf
, KBD_BUFFER_SIZE
, expected
);
6610 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6611 the kbd_buffer can really hold. That may prevent loss
6612 of characters on some systems when input is stuffed at us. */
6613 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6615 struct tty_output
*tty
;
6620 #else /* not WINDOWSNT */
6622 n_to_read
= dos_keysns ();
6626 cbuf
[0] = dos_keyread ();
6629 #else /* not MSDOS */
6633 /* Try to read from each available tty, until one succeeds. */
6634 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
6636 if (! tty
->term_initted
)
6639 /* Determine how many characters we should *try* to read. */
6641 /* Find out how much input is available. */
6642 if (ioctl (fileno (TTY_INPUT (tty
)), FIONREAD
, &n_to_read
) < 0)
6644 /* Formerly simply reported no input, but that sometimes led to
6645 a failure of Emacs to terminate.
6646 SIGHUP seems appropriate if we can't reach the terminal. */
6647 /* ??? Is it really right to send the signal just to this process
6648 rather than to the whole process group?
6649 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6650 /* It appears to be the case, see narrow_foreground_group. */
6651 if (! noninteractive
)
6653 if (! tty_list
->next
)
6654 kill (getpid (), SIGHUP
); /* This was the last terminal. */
6656 n_to_read
= 0; /* XXX tty should be closed here. */
6665 if (n_to_read
> sizeof cbuf
)
6666 n_to_read
= sizeof cbuf
;
6667 #else /* no FIONREAD */
6668 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6669 /* Read some input if available, but don't wait. */
6670 n_to_read
= sizeof cbuf
;
6671 fcntl (fileno (TTY_INPUT (tty
)), F_SETFL
, O_NDELAY
);
6677 /* Now read; for one reason or another, this will not block.
6678 NREAD is set to the number of chars read. */
6681 nread
= emacs_read (fileno (TTY_INPUT (tty
)), cbuf
, n_to_read
);
6682 /* POSIX infers that processes which are not in the session leader's
6683 process group won't get SIGHUP's at logout time. BSDI adheres to
6684 this part standard and returns -1 from read (0) with errno==EIO
6685 when the control tty is taken away.
6686 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6687 if (nread
== -1 && errno
== EIO
)
6689 if (! tty_list
->next
)
6690 kill (0, SIGHUP
); /* This was the last terminal. */
6692 ; /* XXX tty should be closed here. */
6694 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6695 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6696 This looks incorrect, but it isn't, because _BSD causes
6697 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6698 and that causes a value other than 0 when there is no input. */
6701 if (! tty_list
->next
)
6702 kill (0, SIGHUP
); /* This was the last terminal. */
6704 ; /* XXX tty should be closed here. */
6709 /* We used to retry the read if it was interrupted.
6710 But this does the wrong thing when O_NDELAY causes
6711 an EAGAIN error. Does anybody know of a situation
6712 where a retry is actually needed? */
6714 nread
< 0 && (errno
== EAGAIN
6728 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6729 fcntl (fileno (TTY_INPUT (tty
)), F_SETFL
, 0);
6730 #endif /* USG or DGUX or CYGWIN */
6731 #endif /* no FIONREAD */
6735 } /* for each tty */
6740 #endif /* not MSDOS */
6741 #endif /* not WINDOWSNT */
6743 /* Select frame corresponding to the active tty. Note that the
6744 value of selected_frame is not reliable here, redisplay tends
6745 to temporarily change it. But tty should always be non-NULL. */
6746 frame
= (tty
? tty
->top_frame
: selected_frame
);
6748 for (i
= 0; i
< nread
; i
++)
6750 buf
[i
].kind
= ASCII_KEYSTROKE_EVENT
;
6751 buf
[i
].modifiers
= 0;
6752 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
6753 buf
[i
].modifiers
= meta_modifier
;
6754 if (tty
->meta_key
!= 2)
6757 buf
[i
].code
= cbuf
[i
];
6758 buf
[i
].frame_or_window
= frame
;
6763 /* Scan the chars for C-g and store them in kbd_buffer. */
6764 for (i
= 0; i
< nread
; i
++)
6766 kbd_buffer_store_event (&buf
[i
]);
6767 /* Don't look at input that follows a C-g too closely.
6768 This reduces lossage due to autorepeat on C-g. */
6769 if (buf
[i
].kind
== ASCII_KEYSTROKE_EVENT
6770 && buf
[i
].code
== quit_char
)
6776 #endif /* not VMS */
6778 #ifdef SIGIO /* for entire page */
6779 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6782 input_available_signal (signo
)
6785 /* Must preserve main program's value of errno. */
6786 int old_errno
= errno
;
6788 extern int select_alarmed
;
6791 #if defined (USG) && !defined (POSIX_SIGNALS)
6792 /* USG systems forget handlers when they are used;
6793 must reestablish each time */
6794 signal (signo
, input_available_signal
);
6801 if (input_available_clear_time
)
6802 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6807 nread
= read_avail_input (1);
6808 /* -1 means it's not ok to read the input now.
6809 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6810 0 means there was no keyboard input available. */
6815 select_alarmed
= 1; /* Force the select emulator back to life */
6826 /* Send ourselves a SIGIO.
6828 This function exists so that the UNBLOCK_INPUT macro in
6829 blockinput.h can have some way to take care of input we put off
6830 dealing with, without assuming that every file which uses
6831 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6833 reinvoke_input_signal ()
6836 kill (getpid (), SIGIO
);
6842 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6843 static Lisp_Object menu_bar_one_keymap_changed_items
;
6845 /* These variables hold the vector under construction within
6846 menu_bar_items and its subroutines, and the current index
6847 for storing into that vector. */
6848 static Lisp_Object menu_bar_items_vector
;
6849 static int menu_bar_items_index
;
6851 /* Return a vector of menu items for a menu bar, appropriate
6852 to the current buffer. Each item has three elements in the vector:
6855 OLD is an old vector we can optionally reuse, or nil. */
6858 menu_bar_items (old
)
6861 /* The number of keymaps we're scanning right now, and the number of
6862 keymaps we have allocated space for. */
6865 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6866 in the current keymaps, or nil where it is not a prefix. */
6869 Lisp_Object def
, tail
;
6878 struct gcpro gcpro1
;
6880 /* In order to build the menus, we need to call the keymap
6881 accessors. They all call QUIT. But this function is called
6882 during redisplay, during which a quit is fatal. So inhibit
6883 quitting while building the menus.
6884 We do this instead of specbind because (1) errors will clear it anyway
6885 and (2) this avoids risk of specpdl overflow. */
6886 oquit
= Vinhibit_quit
;
6890 menu_bar_items_vector
= old
;
6892 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6893 menu_bar_items_index
= 0;
6895 GCPRO1 (menu_bar_items_vector
);
6897 /* Build our list of keymaps.
6898 If we recognize a function key and replace its escape sequence in
6899 keybuf with its symbol, or if the sequence starts with a mouse
6900 click and we need to switch buffers, we jump back here to rebuild
6901 the initial keymaps from the current buffer. */
6905 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6906 if (!NILP (Voverriding_local_map_menu_flag
))
6908 /* Yes, use them (if non-nil) as well as the global map. */
6909 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6911 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6912 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6913 if (!NILP (Voverriding_local_map
))
6914 maps
[nmaps
++] = Voverriding_local_map
;
6918 /* No, so use major and minor mode keymaps and keymap property.
6919 Note that menu-bar bindings in the local-map and keymap
6920 properties may not work reliable, as they are only
6921 recognized when the menu-bar (or mode-line) is updated,
6922 which does not normally happen after every command. */
6925 nminor
= current_minor_maps (NULL
, &tmaps
);
6926 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6928 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6929 maps
[nmaps
++] = tem
;
6930 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6932 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6934 maps
[nmaps
++] = current_global_map
;
6937 /* Look up in each map the dummy prefix key `menu-bar'. */
6941 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6942 if (!NILP (maps
[mapno
]))
6944 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6948 menu_bar_one_keymap_changed_items
= Qnil
;
6949 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
6953 /* Move to the end those items that should be at the end. */
6955 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6958 int end
= menu_bar_items_index
;
6960 for (i
= 0; i
< end
; i
+= 4)
6961 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6963 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6964 /* Move the item at index I to the end,
6965 shifting all the others forward. */
6966 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6967 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6968 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6969 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6971 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6972 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6973 (end
- i
- 4) * sizeof (Lisp_Object
));
6974 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6975 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6976 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6977 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6982 /* Add nil, nil, nil, nil at the end. */
6983 i
= menu_bar_items_index
;
6984 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6987 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6988 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6989 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6990 menu_bar_items_vector
= tem
;
6992 /* Add this item. */
6993 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6994 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6995 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6996 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6997 menu_bar_items_index
= i
;
6999 Vinhibit_quit
= oquit
;
7001 return menu_bar_items_vector
;
7004 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7005 If there's already an item for KEY, add this DEF to it. */
7007 Lisp_Object item_properties
;
7010 menu_bar_item (key
, item
, dummy1
, dummy2
)
7011 Lisp_Object key
, item
, dummy1
;
7014 struct gcpro gcpro1
;
7018 if (EQ (item
, Qundefined
))
7020 /* If a map has an explicit `undefined' as definition,
7021 discard any previously made menu bar item. */
7023 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7024 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7026 if (menu_bar_items_index
> i
+ 4)
7027 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7028 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7029 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7030 menu_bar_items_index
-= 4;
7034 /* If this keymap has already contributed to this KEY,
7035 don't contribute to it a second time. */
7036 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7037 if (!NILP (tem
) || NILP (item
))
7040 menu_bar_one_keymap_changed_items
7041 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7043 /* We add to menu_bar_one_keymap_changed_items before doing the
7044 parse_menu_item, so that if it turns out it wasn't a menu item,
7045 it still correctly hides any further menu item. */
7047 i
= parse_menu_item (item
, 0, 1);
7052 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7054 /* Find any existing item for this KEY. */
7055 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7056 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7059 /* If we did not find this KEY, add it at the end. */
7060 if (i
== menu_bar_items_index
)
7062 /* If vector is too small, get a bigger one. */
7063 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7066 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7067 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7068 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7069 menu_bar_items_vector
= tem
;
7072 /* Add this item. */
7073 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7074 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7075 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7076 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7077 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7078 menu_bar_items_index
= i
;
7080 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7084 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7085 /* If the new and the old items are not both keymaps,
7086 the lookup will only find `item'. */
7087 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7088 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7092 /* This is used as the handler when calling menu_item_eval_property. */
7094 menu_item_eval_property_1 (arg
)
7097 /* If we got a quit from within the menu computation,
7098 quit all the way out of it. This takes care of C-] in the debugger. */
7099 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7100 Fsignal (Qquit
, Qnil
);
7105 /* Evaluate an expression and return the result (or nil if something
7106 went wrong). Used to evaluate dynamic parts of menu items. */
7108 menu_item_eval_property (sexpr
)
7111 int count
= SPECPDL_INDEX ();
7113 specbind (Qinhibit_redisplay
, Qt
);
7114 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7115 menu_item_eval_property_1
);
7116 return unbind_to (count
, val
);
7119 /* This function parses a menu item and leaves the result in the
7120 vector item_properties.
7121 ITEM is a key binding, a possible menu item.
7122 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7123 evaluate dynamic expressions in the menu item.
7124 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7126 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7127 parse_menu_item returns true if the item is a menu item and false
7131 parse_menu_item (item
, notreal
, inmenubar
)
7133 int notreal
, inmenubar
;
7135 Lisp_Object def
, tem
, item_string
, start
;
7136 Lisp_Object cachelist
;
7138 Lisp_Object keyhint
;
7149 /* Create item_properties vector if necessary. */
7150 if (NILP (item_properties
))
7152 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7154 /* Initialize optional entries. */
7155 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7156 AREF (item_properties
, i
) = Qnil
;
7157 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7159 /* Save the item here to protect it from GC. */
7160 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7162 item_string
= XCAR (item
);
7166 if (STRINGP (item_string
))
7168 /* Old format menu item. */
7169 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7171 /* Maybe help string. */
7172 if (CONSP (item
) && STRINGP (XCAR (item
)))
7174 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7179 /* Maybe key binding cache. */
7180 if (CONSP (item
) && CONSP (XCAR (item
))
7181 && (NILP (XCAR (XCAR (item
)))
7182 || VECTORP (XCAR (XCAR (item
)))))
7184 cachelist
= XCAR (item
);
7188 /* This is the real definition--the function to run. */
7189 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7191 /* Get enable property, if any. */
7194 tem
= Fget (item
, Qmenu_enable
);
7196 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7199 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7201 /* New format menu item. */
7202 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7203 start
= XCDR (item
);
7206 /* We have a real binding. */
7207 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7209 item
= XCDR (start
);
7210 /* Is there a cache list with key equivalences. */
7211 if (CONSP (item
) && CONSP (XCAR (item
)))
7213 cachelist
= XCAR (item
);
7217 /* Parse properties. */
7218 while (CONSP (item
) && CONSP (XCDR (item
)))
7223 if (EQ (tem
, QCenable
))
7224 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7225 else if (EQ (tem
, QCvisible
) && !notreal
)
7227 /* If got a visible property and that evaluates to nil
7228 then ignore this item. */
7229 tem
= menu_item_eval_property (XCAR (item
));
7233 else if (EQ (tem
, QChelp
))
7234 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7235 else if (EQ (tem
, QCfilter
))
7237 else if (EQ (tem
, QCkey_sequence
))
7240 if (NILP (cachelist
)
7241 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7242 /* Be GC protected. Set keyhint to item instead of tem. */
7245 else if (EQ (tem
, QCkeys
))
7248 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7249 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7251 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7256 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7258 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7260 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7267 else if (inmenubar
|| !NILP (start
))
7271 return 0; /* not a menu item */
7273 /* If item string is not a string, evaluate it to get string.
7274 If we don't get a string, skip this item. */
7275 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7276 if (!(STRINGP (item_string
) || notreal
))
7278 item_string
= menu_item_eval_property (item_string
);
7279 if (!STRINGP (item_string
))
7281 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7284 /* If got a filter apply it on definition. */
7285 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7288 def
= menu_item_eval_property (list2 (XCAR (filter
),
7289 list2 (Qquote
, def
)));
7291 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7294 /* Enable or disable selection of item. */
7295 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7301 tem
= menu_item_eval_property (tem
);
7302 if (inmenubar
&& NILP (tem
))
7303 return 0; /* Ignore disabled items in menu bar. */
7304 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7307 /* If we got no definition, this item is just unselectable text which
7308 is OK in a submenu but not in the menubar. */
7310 return (inmenubar
? 0 : 1);
7312 /* See if this is a separate pane or a submenu. */
7313 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7314 tem
= get_keymap (def
, 0, 1);
7315 /* For a subkeymap, just record its details and exit. */
7318 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7319 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7323 /* At the top level in the menu bar, do likewise for commands also.
7324 The menu bar does not display equivalent key bindings anyway.
7325 ITEM_PROPERTY_DEF is already set up properly. */
7329 /* This is a command. See if there is an equivalent key binding. */
7330 if (NILP (cachelist
))
7332 /* We have to create a cachelist. */
7333 CHECK_IMPURE (start
);
7334 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7335 cachelist
= XCAR (XCDR (start
));
7337 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7338 if (!NILP (keyhint
))
7340 XSETCAR (cachelist
, XCAR (keyhint
));
7343 else if (STRINGP (tem
))
7345 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7346 XSETCAR (cachelist
, Qt
);
7350 tem
= XCAR (cachelist
);
7357 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7359 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7362 def
= XCAR (prefix
);
7363 prefix
= XCDR (prefix
);
7366 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7368 if (!update_menu_bindings
)
7370 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7372 if (newcache
/* Always check first time. */
7373 /* Should we check everything when precomputing key
7375 /* If something had no key binding before, don't recheck it
7376 because that is too slow--except if we have a list of
7377 rebound commands in Vdefine_key_rebound_commands, do
7378 recheck any command that appears in that list. */
7379 || (CONSP (Vdefine_key_rebound_commands
)
7380 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7383 /* We had a saved key. Is it still bound to the command? */
7386 /* If the command is an alias for another
7387 (such as lmenu.el set it up), check if the
7388 original command matches the cached command. */
7389 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7390 chkcache
= 1; /* Need to recompute key binding. */
7394 /* Recompute equivalent key binding. If the command is an alias
7395 for another (such as lmenu.el set it up), see if the original
7396 command name has equivalent keys. Otherwise look up the
7397 specified command itself. We don't try both, because that
7398 makes lmenu menus slow. */
7400 && SYMBOLP (XSYMBOL (def
)->function
)
7401 && ! NILP (Fget (def
, Qmenu_alias
)))
7402 def
= XSYMBOL (def
)->function
;
7403 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7404 XSETCAR (cachelist
, tem
);
7407 XSETCDR (cachelist
, Qnil
);
7411 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7413 tem
= XCAR (cachelist
);
7417 newcache
= chkcache
;
7420 tem
= Fkey_description (tem
);
7423 if (STRINGP (XCAR (prefix
)))
7424 tem
= concat2 (XCAR (prefix
), tem
);
7425 if (STRINGP (XCDR (prefix
)))
7426 tem
= concat2 (tem
, XCDR (prefix
));
7428 XSETCDR (cachelist
, tem
);
7432 tem
= XCDR (cachelist
);
7433 if (newcache
&& !NILP (tem
))
7435 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7436 XSETCDR (cachelist
, tem
);
7439 /* If we only want to precompute equivalent key bindings, stop here. */
7443 /* If we have an equivalent key binding, use that. */
7444 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7446 /* Include this when menu help is implemented.
7447 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7448 if (!(NILP (tem) || STRINGP (tem)))
7450 tem = menu_item_eval_property (tem);
7453 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7457 /* Handle radio buttons or toggle boxes. */
7458 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7460 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7461 = menu_item_eval_property (tem
);
7468 /***********************************************************************
7470 ***********************************************************************/
7472 /* A vector holding tool bar items while they are parsed in function
7473 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7476 static Lisp_Object tool_bar_items_vector
;
7478 /* A vector holding the result of parse_tool_bar_item. Layout is like
7479 the one for a single item in tool_bar_items_vector. */
7481 static Lisp_Object tool_bar_item_properties
;
7483 /* Next free index in tool_bar_items_vector. */
7485 static int ntool_bar_items
;
7487 /* The symbols `tool-bar', and `:image'. */
7489 extern Lisp_Object Qtool_bar
;
7490 Lisp_Object QCimage
;
7492 /* Function prototypes. */
7494 static void init_tool_bar_items
P_ ((Lisp_Object
));
7495 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7496 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7497 static void append_tool_bar_item
P_ ((void));
7500 /* Return a vector of tool bar items for keymaps currently in effect.
7501 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7502 tool bar items found. */
7505 tool_bar_items (reuse
, nitems
)
7516 /* In order to build the menus, we need to call the keymap
7517 accessors. They all call QUIT. But this function is called
7518 during redisplay, during which a quit is fatal. So inhibit
7519 quitting while building the menus. We do this instead of
7520 specbind because (1) errors will clear it anyway and (2) this
7521 avoids risk of specpdl overflow. */
7522 oquit
= Vinhibit_quit
;
7525 /* Initialize tool_bar_items_vector and protect it from GC. */
7526 init_tool_bar_items (reuse
);
7528 /* Build list of keymaps in maps. Set nmaps to the number of maps
7531 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7532 if (!NILP (Voverriding_local_map_menu_flag
))
7534 /* Yes, use them (if non-nil) as well as the global map. */
7535 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7537 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7538 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7539 if (!NILP (Voverriding_local_map
))
7540 maps
[nmaps
++] = Voverriding_local_map
;
7544 /* No, so use major and minor mode keymaps and keymap property.
7545 Note that tool-bar bindings in the local-map and keymap
7546 properties may not work reliable, as they are only
7547 recognized when the tool-bar (or mode-line) is updated,
7548 which does not normally happen after every command. */
7551 nminor
= current_minor_maps (NULL
, &tmaps
);
7552 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7554 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7555 maps
[nmaps
++] = tem
;
7556 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7558 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7561 /* Add global keymap at the end. */
7562 maps
[nmaps
++] = current_global_map
;
7564 /* Process maps in reverse order and look up in each map the prefix
7566 for (i
= nmaps
- 1; i
>= 0; --i
)
7567 if (!NILP (maps
[i
]))
7571 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7576 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7577 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7579 Lisp_Object keydef
= XCAR (tail
);
7581 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7586 Vinhibit_quit
= oquit
;
7587 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7588 return tool_bar_items_vector
;
7592 /* Process the definition of KEY which is DEF. */
7595 process_tool_bar_item (key
, def
)
7596 Lisp_Object key
, def
;
7599 extern Lisp_Object Qundefined
;
7600 struct gcpro gcpro1
, gcpro2
;
7602 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7606 if (EQ (def
, Qundefined
))
7608 /* If a map has an explicit `undefined' as definition,
7609 discard any previously made item. */
7610 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7612 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7614 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7616 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7617 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7618 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7619 * sizeof (Lisp_Object
)));
7620 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7625 else if (parse_tool_bar_item (key
, def
))
7626 /* Append a new tool bar item to tool_bar_items_vector. Accept
7627 more than one definition for the same key. */
7628 append_tool_bar_item ();
7634 /* Parse a tool bar item specification ITEM for key KEY and return the
7635 result in tool_bar_item_properties. Value is zero if ITEM is
7638 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7640 CAPTION is the caption of the item, If it's not a string, it is
7641 evaluated to get a string.
7643 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7644 as binding are currently ignored.
7646 The following properties are recognized:
7650 FORM is evaluated and specifies whether the tool bar item is
7651 enabled or disabled.
7655 FORM is evaluated and specifies whether the tool bar item is visible.
7657 - `:filter FUNCTION'
7659 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7660 result is stored as the new binding.
7662 - `:button (TYPE SELECTED)'
7664 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7665 and specifies whether the button is selected (pressed) or not.
7669 IMAGES is either a single image specification or a vector of four
7670 image specifications. See enum tool_bar_item_images.
7672 - `:help HELP-STRING'.
7674 Gives a help string to display for the tool bar item. */
7677 parse_tool_bar_item (key
, item
)
7678 Lisp_Object key
, item
;
7680 /* Access slot with index IDX of vector tool_bar_item_properties. */
7681 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7683 Lisp_Object filter
= Qnil
;
7684 Lisp_Object caption
;
7687 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7688 Rule out items that aren't lists, don't start with
7689 `menu-item' or whose rest following `tool-bar-item' is not a
7692 || !EQ (XCAR (item
), Qmenu_item
)
7693 || (item
= XCDR (item
),
7697 /* Create tool_bar_item_properties vector if necessary. Reset it to
7699 if (VECTORP (tool_bar_item_properties
))
7701 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7705 tool_bar_item_properties
7706 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7709 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7710 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7712 /* Get the caption of the item. If the caption is not a string,
7713 evaluate it to get a string. If we don't get a string, skip this
7715 caption
= XCAR (item
);
7716 if (!STRINGP (caption
))
7718 caption
= menu_item_eval_property (caption
);
7719 if (!STRINGP (caption
))
7722 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7724 /* Give up if rest following the caption is not a list. */
7729 /* Store the binding. */
7730 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7733 /* Ignore cached key binding, if any. */
7734 if (CONSP (item
) && CONSP (XCAR (item
)))
7737 /* Process the rest of the properties. */
7738 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7740 Lisp_Object key
, value
;
7743 value
= XCAR (XCDR (item
));
7745 if (EQ (key
, QCenable
))
7746 /* `:enable FORM'. */
7747 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7748 else if (EQ (key
, QCvisible
))
7750 /* `:visible FORM'. If got a visible property and that
7751 evaluates to nil then ignore this item. */
7752 if (NILP (menu_item_eval_property (value
)))
7755 else if (EQ (key
, QChelp
))
7756 /* `:help HELP-STRING'. */
7757 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7758 else if (EQ (key
, QCfilter
))
7759 /* ':filter FORM'. */
7761 else if (EQ (key
, QCbutton
) && CONSP (value
))
7763 /* `:button (TYPE . SELECTED)'. */
7764 Lisp_Object type
, selected
;
7766 type
= XCAR (value
);
7767 selected
= XCDR (value
);
7768 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7770 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7771 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7774 else if (EQ (key
, QCimage
)
7776 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7777 /* Value is either a single image specification or a vector
7778 of 4 such specifications for the different button states. */
7779 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7782 /* If got a filter apply it on binding. */
7784 PROP (TOOL_BAR_ITEM_BINDING
)
7785 = menu_item_eval_property (list2 (filter
,
7787 PROP (TOOL_BAR_ITEM_BINDING
))));
7789 /* See if the binding is a keymap. Give up if it is. */
7790 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7793 /* Enable or disable selection of item. */
7794 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7795 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7796 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7798 /* Handle radio buttons or toggle boxes. */
7799 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7800 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7801 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7809 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7810 that can be reused. */
7813 init_tool_bar_items (reuse
)
7816 if (VECTORP (reuse
))
7817 tool_bar_items_vector
= reuse
;
7819 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7820 ntool_bar_items
= 0;
7824 /* Append parsed tool bar item properties from
7825 tool_bar_item_properties */
7828 append_tool_bar_item ()
7830 Lisp_Object
*to
, *from
;
7832 /* Enlarge tool_bar_items_vector if necessary. */
7833 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7834 >= XVECTOR (tool_bar_items_vector
)->size
)
7836 Lisp_Object new_vector
;
7837 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7839 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7840 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7841 XVECTOR (new_vector
)->contents
,
7842 old_size
* sizeof (Lisp_Object
));
7843 tool_bar_items_vector
= new_vector
;
7846 /* Append entries from tool_bar_item_properties to the end of
7847 tool_bar_items_vector. */
7848 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7849 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7850 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7851 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7858 /* Read a character using menus based on maps in the array MAPS.
7859 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7860 Return t if we displayed a menu but the user rejected it.
7862 PREV_EVENT is the previous input event, or nil if we are reading
7863 the first event of a key sequence.
7865 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7866 if we used a mouse menu to read the input, or zero otherwise. If
7867 USED_MOUSE_MENU is null, we don't dereference it.
7869 The prompting is done based on the prompt-string of the map
7870 and the strings associated with various map elements.
7872 This can be done with X menus or with menus put in the minibuf.
7873 These are done in different ways, depending on how the input will be read.
7874 Menus using X are done after auto-saving in read-char, getting the input
7875 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7876 and do auto-saving in the inner call of read_char. */
7879 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7882 Lisp_Object prev_event
;
7883 int *used_mouse_menu
;
7886 register Lisp_Object name
= Qnil
;
7888 if (used_mouse_menu
)
7889 *used_mouse_menu
= 0;
7891 /* Use local over global Menu maps */
7893 if (! menu_prompting
)
7896 /* Optionally disregard all but the global map. */
7897 if (inhibit_local_menu_bar_menus
)
7899 maps
+= (nmaps
- 1);
7903 /* Get the menu name from the first map that has one (a prompt string). */
7904 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7906 name
= Fkeymap_prompt (maps
[mapno
]);
7911 /* If we don't have any menus, just read a character normally. */
7912 if (!STRINGP (name
))
7916 /* If we got to this point via a mouse click,
7917 use a real menu for mouse selection. */
7918 if (EVENT_HAS_PARAMETERS (prev_event
)
7919 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7920 && !EQ (XCAR (prev_event
), Qtool_bar
))
7922 /* Display the menu and get the selection. */
7923 Lisp_Object
*realmaps
7924 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7928 /* Use the maps that are not nil. */
7929 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7930 if (!NILP (maps
[mapno
]))
7931 realmaps
[nmaps1
++] = maps
[mapno
];
7933 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7938 record_menu_key (XCAR (value
));
7940 /* If we got multiple events, unread all but
7942 There is no way to prevent those unread events
7943 from showing up later in last_nonmenu_event.
7944 So turn symbol and integer events into lists,
7945 to indicate that they came from a mouse menu,
7946 so that when present in last_nonmenu_event
7947 they won't confuse things. */
7948 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7950 record_menu_key (XCAR (tem
));
7951 if (SYMBOLP (XCAR (tem
))
7952 || INTEGERP (XCAR (tem
)))
7953 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7956 /* If we got more than one event, put all but the first
7957 onto this list to be read later.
7958 Return just the first event now. */
7959 Vunread_command_events
7960 = nconc2 (XCDR (value
), Vunread_command_events
);
7961 value
= XCAR (value
);
7963 else if (NILP (value
))
7965 if (used_mouse_menu
)
7966 *used_mouse_menu
= 1;
7969 #endif /* HAVE_MENUS */
7973 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7974 We make this bigger when necessary, and never free it. */
7975 static char *read_char_minibuf_menu_text
;
7976 /* Size of that buffer. */
7977 static int read_char_minibuf_menu_width
;
7980 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7986 register Lisp_Object name
;
7988 /* FIXME: Use the minibuffer's frame width. */
7989 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
7992 Lisp_Object rest
, vector
;
7998 if (! menu_prompting
)
8001 /* Make sure we have a big enough buffer for the menu text. */
8002 if (read_char_minibuf_menu_text
== 0)
8004 read_char_minibuf_menu_width
= width
+ 4;
8005 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8007 else if (width
+ 4 > read_char_minibuf_menu_width
)
8009 read_char_minibuf_menu_width
= width
+ 4;
8010 read_char_minibuf_menu_text
8011 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8013 menu
= read_char_minibuf_menu_text
;
8015 /* Get the menu name from the first map that has one (a prompt string). */
8016 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8018 name
= Fkeymap_prompt (maps
[mapno
]);
8023 /* If we don't have any menus, just read a character normally. */
8024 if (!STRINGP (name
))
8027 /* Prompt string always starts with map's prompt, and a space. */
8028 strcpy (menu
, SDATA (name
));
8029 nlength
= SBYTES (name
);
8030 menu
[nlength
++] = ':';
8031 menu
[nlength
++] = ' ';
8034 /* Start prompting at start of first map. */
8038 /* Present the documented bindings, a line at a time. */
8045 Lisp_Object orig_defn_macro
;
8047 /* Loop over elements of map. */
8052 /* If reached end of map, start at beginning of next map. */
8056 /* At end of last map, wrap around to first map if just starting,
8057 or end this line if already have something on it. */
8061 if (notfirst
|| nobindings
) break;
8066 /* Look at the next element of the map. */
8068 elt
= XVECTOR (vector
)->contents
[idx
];
8070 elt
= Fcar_safe (rest
);
8072 if (idx
< 0 && VECTORP (elt
))
8074 /* If we found a dense table in the keymap,
8075 advanced past it, but start scanning its contents. */
8076 rest
= Fcdr_safe (rest
);
8082 /* An ordinary element. */
8083 Lisp_Object event
, tem
;
8087 event
= Fcar_safe (elt
); /* alist */
8088 elt
= Fcdr_safe (elt
);
8092 XSETINT (event
, idx
); /* vector */
8095 /* Ignore the element if it has no prompt string. */
8096 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8098 /* 1 if the char to type matches the string. */
8100 Lisp_Object upcased_event
, downcased_event
;
8101 Lisp_Object desc
= Qnil
;
8103 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8105 upcased_event
= Fupcase (event
);
8106 downcased_event
= Fdowncase (event
);
8107 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8108 || XINT (downcased_event
) == SREF (s
, 0));
8110 desc
= Fsingle_key_description (event
, Qnil
);
8112 #if 0 /* It is redundant to list the equivalent key bindings because
8113 the prefix is what the user has already typed. */
8115 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8117 /* Insert equivalent keybinding. */
8118 s
= concat2 (s
, tem
);
8121 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8122 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8124 /* Insert button prefix. */
8125 Lisp_Object selected
8126 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8127 if (EQ (tem
, QCradio
))
8128 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8130 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8131 s
= concat2 (tem
, s
);
8135 /* If we have room for the prompt string, add it to this line.
8136 If this is the first on the line, always add it. */
8137 if ((SCHARS (s
) + i
+ 2
8138 + (char_matches
? 0 : SCHARS (desc
) + 3))
8144 /* Punctuate between strings. */
8147 strcpy (menu
+ i
, ", ");
8153 /* If the char to type doesn't match the string's
8154 first char, explicitly show what char to type. */
8157 /* Add as much of string as fits. */
8158 thiswidth
= SCHARS (desc
);
8159 if (thiswidth
+ i
> width
)
8160 thiswidth
= width
- i
;
8161 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8163 strcpy (menu
+ i
, " = ");
8167 /* Add as much of string as fits. */
8168 thiswidth
= SCHARS (s
);
8169 if (thiswidth
+ i
> width
)
8170 thiswidth
= width
- i
;
8171 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8177 /* If this element does not fit, end the line now,
8178 and save the element for the next line. */
8179 strcpy (menu
+ i
, "...");
8184 /* Move past this element. */
8185 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8186 /* Handle reaching end of dense table. */
8191 rest
= Fcdr_safe (rest
);
8195 /* Prompt with that and read response. */
8196 message2_nolog (menu
, strlen (menu
),
8197 ! NILP (current_buffer
->enable_multibyte_characters
));
8199 /* Make believe its not a keyboard macro in case the help char
8200 is pressed. Help characters are not recorded because menu prompting
8201 is not used on replay.
8203 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8204 current_kboard
->defining_kbd_macro
= Qnil
;
8206 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8207 while (BUFFERP (obj
));
8208 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8210 if (!INTEGERP (obj
))
8215 if (! EQ (obj
, menu_prompt_more_char
)
8216 && (!INTEGERP (menu_prompt_more_char
)
8217 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8219 if (!NILP (current_kboard
->defining_kbd_macro
))
8220 store_kbd_macro_char (obj
);
8223 /* Help char - go round again */
8227 /* Reading key sequences. */
8229 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8230 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8231 keymap, or nil otherwise. Return the index of the first keymap in
8232 which KEY has any binding, or NMAPS if no map has a binding.
8234 If KEY is a meta ASCII character, treat it like meta-prefix-char
8235 followed by the corresponding non-meta character. Keymaps in
8236 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8239 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8242 NEXT may be the same array as CURRENT. */
8245 follow_key (key
, nmaps
, current
, defs
, next
)
8247 Lisp_Object
*current
, *defs
, *next
;
8250 int i
, first_binding
;
8252 first_binding
= nmaps
;
8253 for (i
= nmaps
- 1; i
>= 0; i
--)
8255 if (! NILP (current
[i
]))
8257 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8258 if (! NILP (defs
[i
]))
8265 /* Given the set of bindings we've found, produce the next set of maps. */
8266 if (first_binding
< nmaps
)
8267 for (i
= 0; i
< nmaps
; i
++)
8268 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8270 return first_binding
;
8273 /* Structure used to keep track of partial application of key remapping
8274 such as Vfunction_key_map and Vkey_translation_map. */
8275 typedef struct keyremap
8277 Lisp_Object map
, parent
;
8281 /* Lookup KEY in MAP.
8282 MAP is a keymap mapping keys to key vectors or functions.
8283 If the mapping is a function and DO_FUNCTION is non-zero, then
8284 the function is called with PROMPT as parameter and its return
8285 value is used as the return value of this function (after checking
8286 that it is indeed a vector). */
8289 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8290 Lisp_Object map
, key
, prompt
;
8295 next
= access_keymap (map
, key
, 1, 0, 1);
8297 /* Handle symbol with autoload definition. */
8298 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8299 && CONSP (XSYMBOL (next
)->function
)
8300 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8301 do_autoload (XSYMBOL (next
)->function
, next
);
8303 /* Handle a symbol whose function definition is a keymap
8305 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8306 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8307 || KEYMAPP (XSYMBOL (next
)->function
)))
8308 next
= XSYMBOL (next
)->function
;
8310 /* If the keymap gives a function, not an
8311 array, then call the function with one arg and use
8312 its value instead. */
8313 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8318 next
= call1 (next
, prompt
);
8319 /* If the function returned something invalid,
8320 barf--don't ignore it.
8321 (To ignore it safely, we would need to gcpro a bunch of
8322 other variables.) */
8323 if (! (VECTORP (next
) || STRINGP (next
)))
8324 error ("Function %s returns invalid key sequence", tem
);
8329 /* Do one step of the key remapping used for function-key-map and
8330 key-translation-map:
8331 KEYBUF is the buffer holding the input events.
8332 BUFSIZE is its maximum size.
8333 FKEY is a pointer to the keyremap structure to use.
8334 INPUT is the index of the last element in KEYBUF.
8335 DOIT if non-zero says that the remapping can actually take place.
8336 DIFF is used to return the number of keys added/removed by the remapping.
8337 PARENT is the root of the keymap.
8338 PROMPT is the prompt to use if the remapping happens through a function.
8339 The return value is non-zero if the remapping actually took place. */
8342 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8343 Lisp_Object
*keybuf
, prompt
;
8345 int input
, doit
, *diff
, bufsize
;
8347 Lisp_Object next
, key
;
8349 key
= keybuf
[fkey
->end
++];
8350 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8352 /* If keybuf[fkey->start..fkey->end] is bound in the
8353 map and we're in a position to do the key remapping, replace it with
8354 the binding and restart with fkey->start at the end. */
8355 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8357 int len
= XFASTINT (Flength (next
));
8360 *diff
= len
- (fkey
->end
- fkey
->start
);
8362 if (input
+ *diff
>= bufsize
)
8363 error ("Key sequence too long");
8365 /* Shift the keys that follow fkey->end. */
8367 for (i
= fkey
->end
; i
< input
; i
++)
8368 keybuf
[i
+ *diff
] = keybuf
[i
];
8370 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8371 keybuf
[i
+ *diff
] = keybuf
[i
];
8372 /* Overwrite the old keys with the new ones. */
8373 for (i
= 0; i
< len
; i
++)
8374 keybuf
[fkey
->start
+ i
]
8375 = Faref (next
, make_number (i
));
8377 fkey
->start
= fkey
->end
+= *diff
;
8378 fkey
->map
= fkey
->parent
;
8383 fkey
->map
= get_keymap (next
, 0, 1);
8385 /* If we no longer have a bound suffix, try a new position for
8387 if (!CONSP (fkey
->map
))
8389 fkey
->end
= ++fkey
->start
;
8390 fkey
->map
= fkey
->parent
;
8395 /* Read a sequence of keys that ends with a non prefix character,
8396 storing it in KEYBUF, a buffer of size BUFSIZE.
8398 Return the length of the key sequence stored.
8399 Return -1 if the user rejected a command menu.
8401 Echo starting immediately unless `prompt' is 0.
8403 Where a key sequence ends depends on the currently active keymaps.
8404 These include any minor mode keymaps active in the current buffer,
8405 the current buffer's local map, and the global map.
8407 If a key sequence has no other bindings, we check Vfunction_key_map
8408 to see if some trailing subsequence might be the beginning of a
8409 function key's sequence. If so, we try to read the whole function
8410 key, and substitute its symbolic name into the key sequence.
8412 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8413 `double-' events into similar click events, if that would make them
8414 bound. We try to turn `triple-' events first into `double-' events,
8417 If we get a mouse click in a mode line, vertical divider, or other
8418 non-text area, we treat the click as if it were prefixed by the
8419 symbol denoting that area - `mode-line', `vertical-line', or
8422 If the sequence starts with a mouse click, we read the key sequence
8423 with respect to the buffer clicked on, not the current buffer.
8425 If the user switches frames in the midst of a key sequence, we put
8426 off the switch-frame event until later; the next call to
8427 read_char will return it.
8429 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8430 from the selected window's buffer. */
8433 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8434 can_return_switch_frame
, fix_current_buffer
)
8435 Lisp_Object
*keybuf
;
8438 int dont_downcase_last
;
8439 int can_return_switch_frame
;
8440 int fix_current_buffer
;
8442 volatile Lisp_Object from_string
;
8443 volatile int count
= SPECPDL_INDEX ();
8445 /* How many keys there are in the current key sequence. */
8448 /* The length of the echo buffer when we started reading, and
8449 the length of this_command_keys when we started reading. */
8450 volatile int echo_start
;
8451 volatile int keys_start
;
8453 /* The number of keymaps we're scanning right now, and the number of
8454 keymaps we have allocated space for. */
8456 volatile int nmaps_allocated
= 0;
8458 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8459 the current keymaps. */
8460 Lisp_Object
*volatile defs
= NULL
;
8462 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8463 in the current keymaps, or nil where it is not a prefix. */
8464 Lisp_Object
*volatile submaps
= NULL
;
8466 /* The local map to start out with at start of key sequence. */
8467 volatile Lisp_Object orig_local_map
;
8469 /* The map from the `keymap' property to start out with at start of
8471 volatile Lisp_Object orig_keymap
;
8473 /* 1 if we have already considered switching to the local-map property
8474 of the place where a mouse click occurred. */
8475 volatile int localized_local_map
= 0;
8477 /* The index in defs[] of the first keymap that has a binding for
8478 this key sequence. In other words, the lowest i such that
8479 defs[i] is non-nil. */
8480 volatile int first_binding
;
8481 /* Index of the first key that has no binding.
8482 It is useless to try fkey.start larger than that. */
8483 volatile int first_unbound
;
8485 /* If t < mock_input, then KEYBUF[t] should be read as the next
8488 We use this to recover after recognizing a function key. Once we
8489 realize that a suffix of the current key sequence is actually a
8490 function key's escape sequence, we replace the suffix with the
8491 function key's binding from Vfunction_key_map. Now keybuf
8492 contains a new and different key sequence, so the echo area,
8493 this_command_keys, and the submaps and defs arrays are wrong. In
8494 this situation, we set mock_input to t, set t to 0, and jump to
8495 restart_sequence; the loop will read keys from keybuf up until
8496 mock_input, thus rebuilding the state; and then it will resume
8497 reading characters from the keyboard. */
8498 volatile int mock_input
= 0;
8500 /* If the sequence is unbound in submaps[], then
8501 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8502 and fkey.map is its binding.
8504 These might be > t, indicating that all function key scanning
8505 should hold off until t reaches them. We do this when we've just
8506 recognized a function key, to avoid searching for the function
8507 key's again in Vfunction_key_map. */
8508 volatile keyremap fkey
;
8510 /* Likewise, for key_translation_map. */
8511 volatile keyremap keytran
;
8513 /* If we receive a `switch-frame' or `select-window' event in the middle of
8514 a key sequence, we put it off for later.
8515 While we're reading, we keep the event here. */
8516 volatile Lisp_Object delayed_switch_frame
;
8518 /* See the comment below... */
8519 #if defined (GOBBLE_FIRST_EVENT)
8520 Lisp_Object first_event
;
8523 volatile Lisp_Object original_uppercase
;
8524 volatile int original_uppercase_position
= -1;
8526 /* Gets around Microsoft compiler limitations. */
8529 struct buffer
*starting_buffer
;
8531 /* List of events for which a fake prefix key has been generated. */
8532 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8534 #if defined (GOBBLE_FIRST_EVENT)
8538 struct gcpro gcpro1
;
8540 GCPRO1 (fake_prefixed_keys
);
8541 raw_keybuf_count
= 0;
8543 last_nonmenu_event
= Qnil
;
8545 delayed_switch_frame
= Qnil
;
8546 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8547 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8548 /* If there is no translation-map, turn off scanning. */
8549 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8550 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8555 echo_prompt (prompt
);
8556 else if (cursor_in_echo_area
8557 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8558 && NILP (Fzerop (Vecho_keystrokes
)))
8559 /* This doesn't put in a dash if the echo buffer is empty, so
8560 you don't always see a dash hanging out in the minibuffer. */
8564 /* Record the initial state of the echo area and this_command_keys;
8565 we will need to restore them if we replay a key sequence. */
8567 echo_start
= echo_length ();
8568 keys_start
= this_command_key_count
;
8569 this_single_command_key_start
= keys_start
;
8571 #if defined (GOBBLE_FIRST_EVENT)
8572 /* This doesn't quite work, because some of the things that read_char
8573 does cannot safely be bypassed. It seems too risky to try to make
8576 /* Read the first char of the sequence specially, before setting
8577 up any keymaps, in case a filter runs and switches buffers on us. */
8578 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8580 #endif /* GOBBLE_FIRST_EVENT */
8582 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8583 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8586 /* We jump here when the key sequence has been thoroughly changed, and
8587 we need to rescan it starting from the beginning. When we jump here,
8588 keybuf[0..mock_input] holds the sequence we should reread. */
8591 starting_buffer
= current_buffer
;
8592 first_unbound
= bufsize
+ 1;
8594 /* Build our list of keymaps.
8595 If we recognize a function key and replace its escape sequence in
8596 keybuf with its symbol, or if the sequence starts with a mouse
8597 click and we need to switch buffers, we jump back here to rebuild
8598 the initial keymaps from the current buffer. */
8601 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8602 || !NILP (Voverriding_local_map
))
8604 if (3 > nmaps_allocated
)
8606 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8607 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8608 nmaps_allocated
= 3;
8610 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8611 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8612 if (!NILP (Voverriding_local_map
))
8613 submaps
[nmaps
++] = Voverriding_local_map
;
8621 nminor
= current_minor_maps (0, &maps
);
8622 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8624 if (total
> nmaps_allocated
)
8626 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8627 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8628 nmaps_allocated
= total
;
8631 if (!NILP (orig_keymap
))
8632 submaps
[nmaps
++] = orig_keymap
;
8634 bcopy (maps
, (void *) (submaps
+ nmaps
),
8635 nminor
* sizeof (submaps
[0]));
8639 submaps
[nmaps
++] = orig_local_map
;
8641 submaps
[nmaps
++] = current_global_map
;
8643 /* Find an accurate initial value for first_binding. */
8644 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8645 if (! NILP (submaps
[first_binding
]))
8648 /* Start from the beginning in keybuf. */
8651 /* These are no-ops the first time through, but if we restart, they
8652 revert the echo area and this_command_keys to their original state. */
8653 this_command_key_count
= keys_start
;
8654 if (INTERACTIVE
&& t
< mock_input
)
8655 echo_truncate (echo_start
);
8657 /* If the best binding for the current key sequence is a keymap, or
8658 we may be looking at a function key's escape sequence, keep on
8660 while (first_binding
< nmaps
8661 /* Keep reading as long as there's a prefix binding. */
8662 ? !NILP (submaps
[first_binding
])
8663 /* Don't return in the middle of a possible function key sequence,
8664 if the only bindings we found were via case conversion.
8665 Thus, if ESC O a has a function-key-map translation
8666 and ESC o has a binding, don't return after ESC O,
8667 so that we can translate ESC O plus the next character. */
8668 : (fkey
.start
< t
|| keytran
.start
< t
))
8671 int used_mouse_menu
= 0;
8673 /* Where the last real key started. If we need to throw away a
8674 key that has expanded into more than one element of keybuf
8675 (say, a mouse click on the mode line which is being treated
8676 as [mode-line (mouse-...)], then we backtrack to this point
8678 volatile int last_real_key_start
;
8680 /* These variables are analogous to echo_start and keys_start;
8681 while those allow us to restart the entire key sequence,
8682 echo_local_start and keys_local_start allow us to throw away
8684 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8686 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8687 eassert (fkey
.start
<= fkey
.end
);
8688 eassert (keytran
.start
<= keytran
.end
);
8689 /* key-translation-map is applied *after* function-key-map. */
8690 eassert (keytran
.end
<= fkey
.start
);
8692 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8693 { /* The prefix upto first_unbound has no binding and has
8694 no translation left to do either, so we know it's unbound.
8695 If we don't stop now, we risk staying here indefinitely
8696 (if the user keeps entering fkey or keytran prefixes
8697 like C-c ESC ESC ESC ESC ...) */
8699 for (i
= first_unbound
+ 1; i
< t
; i
++)
8700 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8701 mock_input
= t
- first_unbound
- 1;
8702 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8703 fkey
.map
= fkey
.parent
;
8704 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8705 keytran
.map
= keytran
.parent
;
8706 goto replay_sequence
;
8710 error ("Key sequence too long");
8713 echo_local_start
= echo_length ();
8714 keys_local_start
= this_command_key_count
;
8715 local_first_binding
= first_binding
;
8718 /* These are no-ops, unless we throw away a keystroke below and
8719 jumped back up to replay_key; in that case, these restore the
8720 variables to their original state, allowing us to replay the
8722 if (INTERACTIVE
&& t
< mock_input
)
8723 echo_truncate (echo_local_start
);
8724 this_command_key_count
= keys_local_start
;
8725 first_binding
= local_first_binding
;
8727 /* By default, assume each event is "real". */
8728 last_real_key_start
= t
;
8730 /* Does mock_input indicate that we are re-reading a key sequence? */
8734 add_command_key (key
);
8735 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8736 && NILP (Fzerop (Vecho_keystrokes
)))
8740 /* If not, we should actually read a character. */
8745 KBOARD
*interrupted_kboard
= current_kboard
;
8746 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8747 if (setjmp (wrong_kboard_jmpbuf
))
8749 if (!NILP (delayed_switch_frame
))
8751 interrupted_kboard
->kbd_queue
8752 = Fcons (delayed_switch_frame
,
8753 interrupted_kboard
->kbd_queue
);
8754 delayed_switch_frame
= Qnil
;
8757 interrupted_kboard
->kbd_queue
8758 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8760 /* If the side queue is non-empty, ensure it begins with a
8761 switch-frame, so we'll replay it in the right context. */
8762 if (CONSP (interrupted_kboard
->kbd_queue
)
8763 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8764 !(EVENT_HAS_PARAMETERS (key
)
8765 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8769 XSETFRAME (frame
, interrupted_frame
);
8770 interrupted_kboard
->kbd_queue
8771 = Fcons (make_lispy_switch_frame (frame
),
8772 interrupted_kboard
->kbd_queue
);
8775 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8776 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8777 goto replay_sequence
;
8780 key
= read_char (NILP (prompt
), nmaps
,
8781 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8785 /* read_char returns t when it shows a menu and the user rejects it.
8789 unbind_to (count
, Qnil
);
8794 /* read_char returns -1 at the end of a macro.
8795 Emacs 18 handles this by returning immediately with a
8796 zero, so that's what we'll do. */
8797 if (INTEGERP (key
) && XINT (key
) == -1)
8800 /* The Microsoft C compiler can't handle the goto that
8806 /* If the current buffer has been changed from under us, the
8807 keymap may have changed, so replay the sequence. */
8810 EMACS_TIME initial_idleness_start_time
;
8811 EMACS_SET_SECS_USECS (initial_idleness_start_time
,
8812 EMACS_SECS (timer_last_idleness_start_time
),
8813 EMACS_USECS (timer_last_idleness_start_time
));
8815 /* Resume idle state, using the same start-time as before. */
8816 timer_start_idle ();
8817 timer_idleness_start_time
= initial_idleness_start_time
;
8820 /* Reset the current buffer from the selected window
8821 in case something changed the former and not the latter.
8822 This is to be more consistent with the behavior
8823 of the command_loop_1. */
8824 if (fix_current_buffer
)
8826 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8828 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8829 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8832 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8833 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8834 goto replay_sequence
;
8837 /* If we have a quit that was typed in another frame, and
8838 quit_throw_to_read_char switched buffers,
8839 replay to get the right keymap. */
8841 && XINT (key
) == quit_char
8842 && current_buffer
!= starting_buffer
)
8845 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8849 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8850 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8851 goto replay_sequence
;
8856 if (EVENT_HAS_PARAMETERS (key
)
8857 /* Either a `switch-frame' or a `select-window' event. */
8858 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8860 /* If we're at the beginning of a key sequence, and the caller
8861 says it's okay, go ahead and return this event. If we're
8862 in the midst of a key sequence, delay it until the end. */
8863 if (t
> 0 || !can_return_switch_frame
)
8865 delayed_switch_frame
= key
;
8871 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8874 /* Clicks in non-text areas get prefixed by the symbol
8875 in their CHAR-ADDRESS field. For example, a click on
8876 the mode line is prefixed by the symbol `mode-line'.
8878 Furthermore, key sequences beginning with mouse clicks
8879 are read using the keymaps of the buffer clicked on, not
8880 the current buffer. So we may have to switch the buffer
8883 When we turn one event into two events, we must make sure
8884 that neither of the two looks like the original--so that,
8885 if we replay the events, they won't be expanded again.
8886 If not for this, such reexpansion could happen either here
8887 or when user programs play with this-command-keys. */
8888 if (EVENT_HAS_PARAMETERS (key
))
8893 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8894 if (EQ (kind
, Qmouse_click
))
8896 Lisp_Object window
, posn
;
8898 window
= POSN_WINDOW (EVENT_START (key
));
8899 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8902 || (!NILP (fake_prefixed_keys
)
8903 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8905 /* We're looking a second time at an event for which
8906 we generated a fake prefix key. Set
8907 last_real_key_start appropriately. */
8909 last_real_key_start
= t
- 1;
8912 /* Key sequences beginning with mouse clicks are
8913 read using the keymaps in the buffer clicked on,
8914 not the current buffer. If we're at the
8915 beginning of a key sequence, switch buffers. */
8916 if (last_real_key_start
== 0
8918 && BUFFERP (XWINDOW (window
)->buffer
)
8919 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8921 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8925 /* Arrange to go back to the original buffer once we're
8926 done reading the key sequence. Note that we can't
8927 use save_excursion_{save,restore} here, because they
8928 save point as well as the current buffer; we don't
8929 want to save point, because redisplay may change it,
8930 to accommodate a Fset_window_start or something. We
8931 don't want to do this at the top of the function,
8932 because we may get input from a subprocess which
8933 wants to change the selected window and stuff (say,
8935 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8937 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8939 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8940 orig_local_map
= get_local_map (PT
, current_buffer
,
8942 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8943 goto replay_sequence
;
8946 /* For a mouse click, get the local text-property keymap
8947 of the place clicked on, rather than point. */
8948 if (last_real_key_start
== 0
8949 && CONSP (XCDR (key
))
8950 && ! localized_local_map
)
8952 Lisp_Object map_here
, start
, pos
;
8954 localized_local_map
= 1;
8955 start
= EVENT_START (key
);
8957 if (CONSP (start
) && CONSP (XCDR (start
)))
8959 pos
= POSN_BUFFER_POSN (start
);
8961 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8963 map_here
= get_local_map (XINT (pos
),
8964 current_buffer
, Qlocal_map
);
8965 if (!EQ (map_here
, orig_local_map
))
8967 orig_local_map
= map_here
;
8971 goto replay_sequence
;
8973 map_here
= get_local_map (XINT (pos
),
8974 current_buffer
, Qkeymap
);
8975 if (!EQ (map_here
, orig_keymap
))
8977 orig_keymap
= map_here
;
8981 goto replay_sequence
;
8987 /* Expand mode-line and scroll-bar events into two events:
8988 use posn as a fake prefix key. */
8990 && (NILP (fake_prefixed_keys
)
8991 || NILP (Fmemq (key
, fake_prefixed_keys
))))
8993 if (t
+ 1 >= bufsize
)
8994 error ("Key sequence too long");
8997 keybuf
[t
+ 1] = key
;
9000 /* Record that a fake prefix key has been generated
9001 for KEY. Don't modify the event; this would
9002 prevent proper action when the event is pushed
9003 back into unread-command-events. */
9004 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9006 /* If on a mode line string with a local keymap,
9007 reconsider the key sequence with that keymap. */
9008 if (string
= POSN_STRING (EVENT_START (key
)),
9009 (CONSP (string
) && STRINGP (XCAR (string
))))
9011 Lisp_Object pos
, map
, map2
;
9013 pos
= XCDR (string
);
9014 string
= XCAR (string
);
9016 && XINT (pos
) < SCHARS (string
))
9018 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9020 orig_local_map
= map
;
9021 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9024 if (!NILP (map
) || !NILP (map2
))
9025 goto replay_sequence
;
9031 else if (NILP (from_string
)
9032 && (string
= POSN_STRING (EVENT_START (key
)),
9033 (CONSP (string
) && STRINGP (XCAR (string
)))))
9035 /* For a click on a string, i.e. overlay string or a
9036 string displayed via the `display' property,
9037 consider `local-map' and `keymap' properties of
9039 Lisp_Object pos
, map
, map2
;
9041 pos
= XCDR (string
);
9042 string
= XCAR (string
);
9044 && XINT (pos
) < SCHARS (string
))
9046 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9048 orig_local_map
= map
;
9049 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9053 if (!NILP (map
) || !NILP (map2
))
9055 from_string
= string
;
9056 goto replay_sequence
;
9061 else if (CONSP (XCDR (key
))
9062 && CONSP (EVENT_START (key
))
9063 && CONSP (XCDR (EVENT_START (key
))))
9067 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
9068 /* Handle menu-bar events:
9069 insert the dummy prefix event `menu-bar'. */
9070 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9072 if (t
+ 1 >= bufsize
)
9073 error ("Key sequence too long");
9077 /* Zap the position in key, so we know that we've
9078 expanded it, and don't try to do so again. */
9079 POSN_BUFFER_SET_POSN (EVENT_START (key
),
9080 Fcons (posn
, Qnil
));
9083 goto replay_sequence
;
9085 else if (CONSP (posn
))
9087 /* We're looking at the second event of a
9088 sequence which we expanded before. Set
9089 last_real_key_start appropriately. */
9090 if (last_real_key_start
== t
&& t
> 0)
9091 last_real_key_start
= t
- 1;
9096 /* We have finally decided that KEY is something we might want
9098 first_binding
= (follow_key (key
,
9099 nmaps
- first_binding
,
9100 submaps
+ first_binding
,
9101 defs
+ first_binding
,
9102 submaps
+ first_binding
)
9105 /* If KEY wasn't bound, we'll try some fallbacks. */
9106 if (first_binding
< nmaps
)
9107 /* This is needed for the following scenario:
9108 event 0: a down-event that gets dropped by calling replay_key.
9109 event 1: some normal prefix like C-h.
9110 After event 0, first_unbound is 0, after event 1 fkey.start
9111 and keytran.start are both 1, so when we see that C-h is bound,
9112 we need to update first_unbound. */
9113 first_unbound
= max (t
+ 1, first_unbound
);
9118 /* Remember the position to put an upper bound on fkey.start. */
9119 first_unbound
= min (t
, first_unbound
);
9121 head
= EVENT_HEAD (key
);
9122 if (help_char_p (head
) && t
> 0)
9124 read_key_sequence_cmd
= Vprefix_help_command
;
9126 last_nonmenu_event
= key
;
9127 /* The Microsoft C compiler can't handle the goto that
9135 Lisp_Object breakdown
;
9138 breakdown
= parse_modifiers (head
);
9139 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9140 /* Attempt to reduce an unbound mouse event to a simpler
9141 event that is bound:
9142 Drags reduce to clicks.
9143 Double-clicks reduce to clicks.
9144 Triple-clicks reduce to double-clicks, then to clicks.
9145 Down-clicks are eliminated.
9146 Double-downs reduce to downs, then are eliminated.
9147 Triple-downs reduce to double-downs, then to downs,
9148 then are eliminated. */
9149 if (modifiers
& (down_modifier
| drag_modifier
9150 | double_modifier
| triple_modifier
))
9152 while (modifiers
& (down_modifier
| drag_modifier
9153 | double_modifier
| triple_modifier
))
9155 Lisp_Object new_head
, new_click
;
9156 if (modifiers
& triple_modifier
)
9157 modifiers
^= (double_modifier
| triple_modifier
);
9158 else if (modifiers
& double_modifier
)
9159 modifiers
&= ~double_modifier
;
9160 else if (modifiers
& drag_modifier
)
9161 modifiers
&= ~drag_modifier
;
9164 /* Dispose of this `down' event by simply jumping
9165 back to replay_key, to get another event.
9167 Note that if this event came from mock input,
9168 then just jumping back to replay_key will just
9169 hand it to us again. So we have to wipe out any
9172 We could delete keybuf[t] and shift everything
9173 after that to the left by one spot, but we'd also
9174 have to fix up any variable that points into
9175 keybuf, and shifting isn't really necessary
9178 Adding prefixes for non-textual mouse clicks
9179 creates two characters of mock input, and both
9180 must be thrown away. If we're only looking at
9181 the prefix now, we can just jump back to
9182 replay_key. On the other hand, if we've already
9183 processed the prefix, and now the actual click
9184 itself is giving us trouble, then we've lost the
9185 state of the keymaps we want to backtrack to, and
9186 we need to replay the whole sequence to rebuild
9189 Beyond that, only function key expansion could
9190 create more than two keys, but that should never
9191 generate mouse events, so it's okay to zero
9192 mock_input in that case too.
9194 FIXME: The above paragraph seems just plain
9195 wrong, if you consider things like
9196 xterm-mouse-mode. -stef
9198 Isn't this just the most wonderful code ever? */
9200 /* If mock_input > t + 1, the above simplification
9201 will actually end up dropping keys on the floor.
9202 This is probably OK for now, but even
9203 if mock_input <= t + 1, we need to adjust fkey
9205 Typical case [header-line down-mouse-N]:
9206 mock_input = 2, t = 1, fkey.end = 1,
9207 last_real_key_start = 0. */
9208 if (fkey
.end
> last_real_key_start
)
9210 fkey
.end
= fkey
.start
9211 = min (last_real_key_start
, fkey
.start
);
9212 fkey
.map
= fkey
.parent
;
9213 if (keytran
.end
> last_real_key_start
)
9215 keytran
.end
= keytran
.start
9216 = min (last_real_key_start
, keytran
.start
);
9217 keytran
.map
= keytran
.parent
;
9220 if (t
== last_real_key_start
)
9227 mock_input
= last_real_key_start
;
9228 goto replay_sequence
;
9233 = apply_modifiers (modifiers
, XCAR (breakdown
));
9235 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9237 /* Look for a binding for this new key. follow_key
9238 promises that it didn't munge submaps the
9239 last time we called it, since key was unbound. */
9241 = (follow_key (new_click
,
9242 nmaps
- local_first_binding
,
9243 submaps
+ local_first_binding
,
9244 defs
+ local_first_binding
,
9245 submaps
+ local_first_binding
)
9246 + local_first_binding
);
9248 /* If that click is bound, go for it. */
9249 if (first_binding
< nmaps
)
9254 /* Otherwise, we'll leave key set to the drag event. */
9261 /* Normally, last_nonmenu_event gets the previous key we read.
9262 But when a mouse popup menu is being used,
9263 we don't update last_nonmenu_event; it continues to hold the mouse
9264 event that preceded the first level of menu. */
9265 if (!used_mouse_menu
)
9266 last_nonmenu_event
= key
;
9268 /* Record what part of this_command_keys is the current key sequence. */
9269 this_single_command_key_start
= this_command_key_count
- t
;
9271 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9272 /* There is a binding and it's not a prefix.
9273 There is thus no function-key in this sequence.
9274 Moving fkey.start is important in this case to allow keytran.start
9275 to go over the sequence before we return (since we keep the
9276 invariant that keytran.end <= fkey.start). */
9279 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9282 /* If the sequence is unbound, see if we can hang a function key
9283 off the end of it. */
9284 /* Continue scan from fkey.end until we find a bound suffix. */
9285 while (fkey
.end
< t
)
9287 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9290 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9291 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9292 max (t
, mock_input
),
9293 /* If there's a binding (i.e.
9294 first_binding >= nmaps) we don't want
9295 to apply this function-key-mapping. */
9296 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9301 mock_input
= diff
+ max (t
, mock_input
);
9302 goto replay_sequence
;
9306 /* Look for this sequence in key-translation-map.
9307 Scan from keytran.end until we find a bound suffix. */
9308 while (keytran
.end
< fkey
.start
)
9310 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9313 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9314 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9319 mock_input
= diff
+ max (t
, mock_input
);
9320 /* Adjust the function-key-map counters. */
9324 goto replay_sequence
;
9328 /* If KEY is not defined in any of the keymaps,
9329 and cannot be part of a function key or translation,
9330 and is an upper case letter
9331 use the corresponding lower-case letter instead. */
9332 if (first_binding
>= nmaps
9333 && fkey
.start
>= t
&& keytran
.start
>= t
9335 && ((((XINT (key
) & 0x3ffff)
9336 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9337 && UPPERCASEP (XINT (key
) & 0x3ffff))
9338 || (XINT (key
) & shift_modifier
)))
9340 Lisp_Object new_key
;
9342 original_uppercase
= key
;
9343 original_uppercase_position
= t
- 1;
9345 if (XINT (key
) & shift_modifier
)
9346 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9348 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9349 | (XINT (key
) & ~0x3ffff)));
9351 /* We have to do this unconditionally, regardless of whether
9352 the lower-case char is defined in the keymaps, because they
9353 might get translated through function-key-map. */
9354 keybuf
[t
- 1] = new_key
;
9355 mock_input
= max (t
, mock_input
);
9357 goto replay_sequence
;
9359 /* If KEY is not defined in any of the keymaps,
9360 and cannot be part of a function key or translation,
9361 and is a shifted function key,
9362 use the corresponding unshifted function key instead. */
9363 if (first_binding
>= nmaps
9364 && fkey
.start
>= t
&& keytran
.start
>= t
9367 Lisp_Object breakdown
;
9370 breakdown
= parse_modifiers (key
);
9371 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9372 if (modifiers
& shift_modifier
)
9374 Lisp_Object new_key
;
9376 original_uppercase
= key
;
9377 original_uppercase_position
= t
- 1;
9379 modifiers
&= ~shift_modifier
;
9380 new_key
= apply_modifiers (modifiers
,
9383 keybuf
[t
- 1] = new_key
;
9384 mock_input
= max (t
, mock_input
);
9385 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9386 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9388 goto replay_sequence
;
9394 read_key_sequence_cmd
= (first_binding
< nmaps
9395 ? defs
[first_binding
]
9398 unread_switch_frame
= delayed_switch_frame
;
9399 unbind_to (count
, Qnil
);
9401 /* Don't downcase the last character if the caller says don't.
9402 Don't downcase it if the result is undefined, either. */
9403 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9404 && t
- 1 == original_uppercase_position
)
9405 keybuf
[t
- 1] = original_uppercase
;
9407 /* Occasionally we fabricate events, perhaps by expanding something
9408 according to function-key-map, or by adding a prefix symbol to a
9409 mouse click in the scroll bar or modeline. In this cases, return
9410 the entire generated key sequence, even if we hit an unbound
9411 prefix or a definition before the end. This means that you will
9412 be able to push back the event properly, and also means that
9413 read-key-sequence will always return a logical unit.
9416 for (; t
< mock_input
; t
++)
9418 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9419 && NILP (Fzerop (Vecho_keystrokes
)))
9420 echo_char (keybuf
[t
]);
9421 add_command_key (keybuf
[t
]);
9430 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9431 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9432 The sequence is sufficient to specify a non-prefix command in the
9433 current local and global maps.
9435 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9436 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9437 as a continuation of the previous key.
9439 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9440 convert the last event to lower case. (Normally any upper case event
9441 is converted to lower case if the original event is undefined and the lower
9442 case equivalent is defined.) A non-nil value is appropriate for reading
9443 a key sequence to be defined.
9445 A C-g typed while in this function is treated like any other character,
9446 and `quit-flag' is not set.
9448 If the key sequence starts with a mouse click, then the sequence is read
9449 using the keymaps of the buffer of the window clicked in, not the buffer
9450 of the selected window as normal.
9452 `read-key-sequence' drops unbound button-down events, since you normally
9453 only care about the click or drag events which follow them. If a drag
9454 or multi-click event is unbound, but the corresponding click event would
9455 be bound, `read-key-sequence' turns the event into a click event at the
9456 drag's starting position. This means that you don't have to distinguish
9457 between click and drag, double, or triple events unless you want to.
9459 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9460 lines separating windows, and scroll bars with imaginary keys
9461 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9463 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9464 function will process a switch-frame event if the user switches frames
9465 before typing anything. If the user switches frames in the middle of a
9466 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9467 is nil, then the event will be put off until after the current key sequence.
9469 `read-key-sequence' checks `function-key-map' for function key
9470 sequences, where they wouldn't conflict with ordinary bindings. See
9471 `function-key-map' for more details.
9473 The optional fifth argument COMMAND-LOOP, if non-nil, means
9474 that this key sequence is being read by something that will
9475 read commands one after another. It should be nil if the caller
9476 will read just one key sequence. */)
9477 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9479 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9480 Lisp_Object can_return_switch_frame
, command_loop
;
9482 Lisp_Object keybuf
[30];
9484 struct gcpro gcpro1
;
9485 int count
= SPECPDL_INDEX ();
9488 CHECK_STRING (prompt
);
9491 specbind (Qinput_method_exit_on_first_char
,
9492 (NILP (command_loop
) ? Qt
: Qnil
));
9493 specbind (Qinput_method_use_echo_area
,
9494 (NILP (command_loop
) ? Qt
: Qnil
));
9496 bzero (keybuf
, sizeof keybuf
);
9498 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9500 if (NILP (continue_echo
))
9502 this_command_key_count
= 0;
9503 this_command_key_count_reset
= 0;
9504 this_single_command_key_start
= 0;
9507 #ifdef HAVE_X_WINDOWS
9508 if (display_hourglass_p
)
9509 cancel_hourglass ();
9512 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9513 prompt
, ! NILP (dont_downcase_last
),
9514 ! NILP (can_return_switch_frame
), 0);
9516 #if 0 /* The following is fine for code reading a key sequence and
9517 then proceeding with a lenghty computation, but it's not good
9518 for code reading keys in a loop, like an input method. */
9519 #ifdef HAVE_X_WINDOWS
9520 if (display_hourglass_p
)
9531 return unbind_to (count
, make_event_array (i
, keybuf
));
9534 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9535 Sread_key_sequence_vector
, 1, 5, 0,
9536 doc
: /* Like `read-key-sequence' but always return a vector. */)
9537 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9539 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9540 Lisp_Object can_return_switch_frame
, command_loop
;
9542 Lisp_Object keybuf
[30];
9544 struct gcpro gcpro1
;
9545 int count
= SPECPDL_INDEX ();
9548 CHECK_STRING (prompt
);
9551 specbind (Qinput_method_exit_on_first_char
,
9552 (NILP (command_loop
) ? Qt
: Qnil
));
9553 specbind (Qinput_method_use_echo_area
,
9554 (NILP (command_loop
) ? Qt
: Qnil
));
9556 bzero (keybuf
, sizeof keybuf
);
9558 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9560 if (NILP (continue_echo
))
9562 this_command_key_count
= 0;
9563 this_command_key_count_reset
= 0;
9564 this_single_command_key_start
= 0;
9567 #ifdef HAVE_X_WINDOWS
9568 if (display_hourglass_p
)
9569 cancel_hourglass ();
9572 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9573 prompt
, ! NILP (dont_downcase_last
),
9574 ! NILP (can_return_switch_frame
), 0);
9576 #ifdef HAVE_X_WINDOWS
9577 if (display_hourglass_p
)
9587 return unbind_to (count
, Fvector (i
, keybuf
));
9590 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9591 doc
: /* Execute CMD as an editor command.
9592 CMD must be a symbol that satisfies the `commandp' predicate.
9593 Optional second arg RECORD-FLAG non-nil
9594 means unconditionally put this command in `command-history'.
9595 Otherwise, that is done only if an arg is read using the minibuffer.
9596 The argument KEYS specifies the value to use instead of (this-command-keys)
9597 when reading the arguments; if it is nil, (this-command-keys) is used.
9598 The argument SPECIAL, if non-nil, means that this command is executing
9599 a special event, so ignore the prefix argument and don't clear it. */)
9600 (cmd
, record_flag
, keys
, special
)
9601 Lisp_Object cmd
, record_flag
, keys
, special
;
9603 register Lisp_Object final
;
9604 register Lisp_Object tem
;
9605 Lisp_Object prefixarg
;
9606 struct backtrace backtrace
;
9607 extern int debug_on_next_call
;
9609 debug_on_next_call
= 0;
9613 prefixarg
= current_kboard
->Vprefix_arg
;
9614 Vcurrent_prefix_arg
= prefixarg
;
9615 current_kboard
->Vprefix_arg
= Qnil
;
9622 tem
= Fget (cmd
, Qdisabled
);
9623 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9625 tem
= Fsymbol_value (Qdisabled_command_hook
);
9627 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9633 final
= Findirect_function (cmd
);
9635 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9637 struct gcpro gcpro1
, gcpro2
;
9639 GCPRO2 (cmd
, prefixarg
);
9640 do_autoload (final
, cmd
);
9647 if (STRINGP (final
) || VECTORP (final
))
9649 /* If requested, place the macro in the command history. For
9650 other sorts of commands, call-interactively takes care of
9652 if (!NILP (record_flag
))
9655 = Fcons (Fcons (Qexecute_kbd_macro
,
9656 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9659 /* Don't keep command history around forever. */
9660 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9662 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9664 XSETCDR (tem
, Qnil
);
9668 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9671 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9673 backtrace
.next
= backtrace_list
;
9674 backtrace_list
= &backtrace
;
9675 backtrace
.function
= &Qcall_interactively
;
9676 backtrace
.args
= &cmd
;
9677 backtrace
.nargs
= 1;
9678 backtrace
.evalargs
= 0;
9680 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9682 backtrace_list
= backtrace
.next
;
9690 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9692 doc
: /* Read function name, then read its arguments and call it. */)
9694 Lisp_Object prefixarg
;
9696 Lisp_Object function
;
9698 int saved_last_point_position
;
9699 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9700 Lisp_Object bindings
, value
;
9701 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9703 saved_keys
= Fvector (this_command_key_count
,
9704 XVECTOR (this_command_keys
)->contents
);
9705 saved_last_point_position_buffer
= last_point_position_buffer
;
9706 saved_last_point_position
= last_point_position
;
9708 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9710 if (EQ (prefixarg
, Qminus
))
9712 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9713 strcpy (buf
, "C-u ");
9714 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9716 if (sizeof (int) == sizeof (EMACS_INT
))
9717 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9718 else if (sizeof (long) == sizeof (EMACS_INT
))
9719 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9723 else if (INTEGERP (prefixarg
))
9725 if (sizeof (int) == sizeof (EMACS_INT
))
9726 sprintf (buf
, "%d ", XINT (prefixarg
));
9727 else if (sizeof (long) == sizeof (EMACS_INT
))
9728 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9733 /* This isn't strictly correct if execute-extended-command
9734 is bound to anything else. Perhaps it should use
9735 this_command_keys? */
9736 strcat (buf
, "M-x ");
9738 /* Prompt with buf, and then read a string, completing from and
9739 restricting to the set of all defined commands. Don't provide
9740 any initial input. Save the command read on the extended-command
9742 function
= Fcompleting_read (build_string (buf
),
9743 Vobarray
, Qcommandp
,
9744 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9747 if (STRINGP (function
) && SCHARS (function
) == 0)
9748 error ("No command name given");
9750 /* Set this_command_keys to the concatenation of saved_keys and
9751 function, followed by a RET. */
9756 this_command_key_count
= 0;
9757 this_command_key_count_reset
= 0;
9758 this_single_command_key_start
= 0;
9760 keys
= XVECTOR (saved_keys
)->contents
;
9761 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9762 add_command_key (keys
[i
]);
9764 for (i
= 0; i
< SCHARS (function
); i
++)
9765 add_command_key (Faref (function
, make_number (i
)));
9767 add_command_key (make_number ('\015'));
9770 last_point_position
= saved_last_point_position
;
9771 last_point_position_buffer
= saved_last_point_position_buffer
;
9775 function
= Fintern (function
, Qnil
);
9776 current_kboard
->Vprefix_arg
= prefixarg
;
9777 Vthis_command
= function
;
9778 real_this_command
= function
;
9780 /* If enabled, show which key runs this command. */
9781 if (!NILP (Vsuggest_key_bindings
)
9782 && NILP (Vexecuting_macro
)
9783 && SYMBOLP (function
))
9784 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9790 GCPRO2 (bindings
, value
);
9791 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9793 /* If the command has a key binding, print it now. */
9794 if (!NILP (bindings
)
9795 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9798 /* But first wait, and skip the message if there is input. */
9800 if (!NILP (echo_area_buffer
[0]))
9801 /* This command displayed something in the echo area;
9802 so wait a few seconds, then display our suggestion message. */
9803 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9804 ? XINT (Vsuggest_key_bindings
) : 2);
9806 /* This command left the echo area empty,
9807 so display our message immediately. */
9810 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9811 && ! CONSP (Vunread_command_events
))
9813 Lisp_Object binding
;
9815 int message_p
= push_message ();
9816 int count
= SPECPDL_INDEX ();
9818 record_unwind_protect (pop_message_unwind
, Qnil
);
9819 binding
= Fkey_description (bindings
);
9822 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9825 sprintf (newmessage
, "You can run the command `%s' with %s",
9826 SDATA (SYMBOL_NAME (function
)),
9828 message2_nolog (newmessage
,
9829 strlen (newmessage
),
9830 STRING_MULTIBYTE (binding
));
9831 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9832 ? Vsuggest_key_bindings
: make_number (2)),
9837 unbind_to (count
, Qnil
);
9841 RETURN_UNGCPRO (value
);
9845 /* Return nonzero if input events are pending. */
9848 detect_input_pending ()
9851 get_input_pending (&input_pending
, 0);
9853 return input_pending
;
9856 /* Return nonzero if input events are pending, and run any pending timers. */
9859 detect_input_pending_run_timers (do_display
)
9862 int old_timers_run
= timers_run
;
9865 get_input_pending (&input_pending
, 1);
9867 if (old_timers_run
!= timers_run
&& do_display
)
9869 redisplay_preserve_echo_area (8);
9870 /* The following fixes a bug when using lazy-lock with
9871 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9872 from an idle timer function. The symptom of the bug is that
9873 the cursor sometimes doesn't become visible until the next X
9874 event is processed. --gerd. */
9876 rif
->flush_display (NULL
);
9879 return input_pending
;
9882 /* This is called in some cases before a possible quit.
9883 It cases the next call to detect_input_pending to recompute input_pending.
9884 So calling this function unnecessarily can't do any harm. */
9887 clear_input_pending ()
9892 /* Return nonzero if there are pending requeued events.
9893 This isn't used yet. The hope is to make wait_reading_process_input
9894 call it, and return if it runs Lisp code that unreads something.
9895 The problem is, kbd_buffer_get_event needs to be fixed to know what
9896 to do in that case. It isn't trivial. */
9899 requeued_events_pending_p ()
9901 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9905 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9906 doc
: /* Return t if command input is currently available with no wait.
9907 Actually, the value is nil only if we can be sure that no input is available;
9908 if there is a doubt, the value is t. */)
9911 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9914 get_filtered_input_pending (&input_pending
, 1, 1);
9915 return input_pending
> 0 ? Qt
: Qnil
;
9918 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9919 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9922 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9925 if (total_keys
< NUM_RECENT_KEYS
)
9926 return Fvector (total_keys
, keys
);
9929 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9930 bcopy (keys
+ recent_keys_index
,
9931 XVECTOR (val
)->contents
,
9932 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9934 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9935 recent_keys_index
* sizeof (Lisp_Object
));
9940 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9941 doc
: /* Return the key sequence that invoked this command.
9942 However, if the command has called `read-key-sequence', it returns
9943 the last key sequence that has been read.
9944 The value is a string or a vector. */)
9947 return make_event_array (this_command_key_count
,
9948 XVECTOR (this_command_keys
)->contents
);
9951 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9952 doc
: /* Return the key sequence that invoked this command, as a vector.
9953 However, if the command has called `read-key-sequence', it returns
9954 the last key sequence that has been read. */)
9957 return Fvector (this_command_key_count
,
9958 XVECTOR (this_command_keys
)->contents
);
9961 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9962 Sthis_single_command_keys
, 0, 0, 0,
9963 doc
: /* Return the key sequence that invoked this command.
9964 More generally, it returns the last key sequence read, either by
9965 the command loop or by `read-key-sequence'.
9966 Unlike `this-command-keys', this function's value
9967 does not include prefix arguments.
9968 The value is always a vector. */)
9971 return Fvector (this_command_key_count
9972 - this_single_command_key_start
,
9973 (XVECTOR (this_command_keys
)->contents
9974 + this_single_command_key_start
));
9977 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9978 Sthis_single_command_raw_keys
, 0, 0, 0,
9979 doc
: /* Return the raw events that were read for this command.
9980 More generally, it returns the last key sequence read, either by
9981 the command loop or by `read-key-sequence'.
9982 Unlike `this-single-command-keys', this function's value
9983 shows the events before all translations (except for input methods).
9984 The value is always a vector. */)
9987 return Fvector (raw_keybuf_count
,
9988 (XVECTOR (raw_keybuf
)->contents
));
9991 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9992 Sreset_this_command_lengths
, 0, 0, 0,
9993 doc
: /* Make the unread events replace the last command and echo.
9994 Used in `universal-argument-other-key'.
9996 `universal-argument-other-key' rereads the event just typed.
9997 It then gets translated through `function-key-map'.
9998 The translated event has to replace the real events,
9999 both in the value of (this-command-keys) and in echoing.
10000 To achieve this, `universal-argument-other-key' calls
10001 `reset-this-command-lengths', which discards the record of reading
10002 these events the first time. */)
10005 this_command_key_count
= before_command_key_count
;
10006 if (this_command_key_count
< this_single_command_key_start
)
10007 this_single_command_key_start
= this_command_key_count
;
10009 echo_truncate (before_command_echo_length
);
10011 /* Cause whatever we put into unread-command-events
10012 to echo as if it were being freshly read from the keyboard. */
10013 this_command_key_count_reset
= 1;
10018 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10019 Sclear_this_command_keys
, 0, 1, 0,
10020 doc
: /* Clear out the vector that `this-command-keys' returns.
10021 Also clear the record of the last 100 events, unless optional arg
10022 KEEP-RECORD is non-nil. */)
10024 Lisp_Object keep_record
;
10028 this_command_key_count
= 0;
10029 this_command_key_count_reset
= 0;
10031 if (NILP (keep_record
))
10033 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10034 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10036 recent_keys_index
= 0;
10041 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10042 doc
: /* Return the current depth in recursive edits. */)
10046 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10050 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10051 "FOpen dribble file: ",
10052 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10053 If FILE is nil, close any open dribble file. */)
10064 file
= Fexpand_file_name (file
, Qnil
);
10065 dribble
= fopen (SDATA (file
), "w");
10067 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10072 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10073 doc
: /* Discard the contents of the terminal input buffer.
10074 Also end any kbd macro being defined. */)
10077 if (!NILP (current_kboard
->defining_kbd_macro
))
10079 /* Discard the last command from the macro. */
10080 Fcancel_kbd_macro_events ();
10084 update_mode_lines
++;
10086 Vunread_command_events
= Qnil
;
10087 unread_command_char
= -1;
10089 discard_tty_input ();
10091 kbd_fetch_ptr
= kbd_store_ptr
;
10092 Ffillarray (kbd_buffer_gcpro
, Qnil
);
10098 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10099 doc
: /* Stop Emacs and return to superior process. You can resume later.
10100 If `cannot-suspend' is non-nil, or if the system doesn't support job
10101 control, run a subshell instead.
10103 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10104 to be read as terminal input by Emacs's parent, after suspension.
10106 Before suspending, run the normal hook `suspend-hook'.
10107 After resumption run the normal hook `suspend-resume-hook'.
10109 Some operating systems cannot stop the Emacs process and resume it later.
10110 On such systems, Emacs starts a subshell instead of suspending. */)
10112 Lisp_Object stuffstring
;
10114 int count
= SPECPDL_INDEX ();
10115 int old_height
, old_width
;
10117 struct gcpro gcpro1
;
10119 if (tty_list
&& tty_list
->next
)
10120 error ("Suspend is not supported with multiple ttys");
10122 if (!NILP (stuffstring
))
10123 CHECK_STRING (stuffstring
);
10125 /* Run the functions in suspend-hook. */
10126 if (!NILP (Vrun_hooks
))
10127 call1 (Vrun_hooks
, intern ("suspend-hook"));
10129 GCPRO1 (stuffstring
);
10130 get_tty_size (CURTTY (), &old_width
, &old_height
);
10131 reset_all_sys_modes ();
10132 /* sys_suspend can get an error if it tries to fork a subshell
10133 and the system resources aren't available for that. */
10134 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10135 (Lisp_Object
)CURTTY()); /* XXX */
10136 stuff_buffered_input (stuffstring
);
10137 if (cannot_suspend
)
10141 unbind_to (count
, Qnil
);
10143 /* Check if terminal/window size has changed.
10144 Note that this is not useful when we are running directly
10145 with a window system; but suspend should be disabled in that case. */
10146 get_tty_size (CURTTY (), &width
, &height
);
10147 if (width
!= old_width
|| height
!= old_height
)
10148 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10150 /* Run suspend-resume-hook. */
10151 if (!NILP (Vrun_hooks
))
10152 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10158 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10159 Then in any case stuff anything Emacs has read ahead and not used. */
10162 stuff_buffered_input (stuffstring
)
10163 Lisp_Object stuffstring
;
10165 /* stuff_char works only in BSD, versions 4.2 and up. */
10168 register unsigned char *p
;
10170 if (STRINGP (stuffstring
))
10172 register int count
;
10174 p
= SDATA (stuffstring
);
10175 count
= SBYTES (stuffstring
);
10176 while (count
-- > 0)
10181 /* Anything we have read ahead, put back for the shell to read. */
10182 /* ?? What should this do when we have multiple keyboards??
10183 Should we ignore anything that was typed in at the "wrong" kboard? */
10184 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10188 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10189 kbd_fetch_ptr
= kbd_buffer
;
10190 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10191 stuff_char (kbd_fetch_ptr
->code
);
10193 kbd_fetch_ptr
->kind
= NO_EVENT
;
10194 idx
= 2 * (kbd_fetch_ptr
- kbd_buffer
);
10195 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
10196 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
10201 #endif /* BSD_SYSTEM and not BSD4_1 */
10205 set_waiting_for_input (time_to_clear
)
10206 EMACS_TIME
*time_to_clear
;
10208 input_available_clear_time
= time_to_clear
;
10210 /* Tell interrupt_signal to throw back to read_char, */
10211 waiting_for_input
= 1;
10213 /* If interrupt_signal was called before and buffered a C-g,
10214 make it run again now, to avoid timing error. */
10215 if (!NILP (Vquit_flag
))
10216 quit_throw_to_read_char ();
10220 clear_waiting_for_input ()
10222 /* Tell interrupt_signal not to throw back to read_char, */
10223 waiting_for_input
= 0;
10224 input_available_clear_time
= 0;
10227 /* This routine is called at interrupt level in response to C-g.
10229 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10230 is called from kbd_buffer_store_event, in handling SIGIO or
10233 If `waiting_for_input' is non zero, then unless `echoing' is
10234 nonzero, immediately throw back to read_char.
10236 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10237 eval to throw, when it gets a chance. If quit-flag is already
10238 non-nil, it stops the job right away. */
10241 interrupt_signal (signalnum
) /* If we don't have an argument, */
10242 int signalnum
; /* some compilers complain in signal calls. */
10245 /* Must preserve main program's value of errno. */
10246 int old_errno
= errno
;
10247 struct frame
*sf
= SELECTED_FRAME ();
10249 #if defined (USG) && !defined (POSIX_SIGNALS)
10250 if (!read_socket_hook
&& NILP (Vwindow_system
))
10252 /* USG systems forget handlers when they are used;
10253 must reestablish each time */
10254 signal (SIGINT
, interrupt_signal
);
10255 signal (SIGQUIT
, interrupt_signal
);
10261 if (!NILP (Vquit_flag
)
10262 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10264 /* If SIGINT isn't blocked, don't let us be interrupted by
10265 another SIGINT, it might be harmful due to non-reentrancy
10266 in I/O functions. */
10267 sigblock (sigmask (SIGINT
));
10270 reset_all_sys_modes ();
10272 #ifdef SIGTSTP /* Support possible in later USG versions */
10274 * On systems which can suspend the current process and return to the original
10275 * shell, this command causes the user to end up back at the shell.
10276 * The "Auto-save" and "Abort" questions are not asked until
10277 * the user elects to return to emacs, at which point he can save the current
10278 * job and either dump core or continue.
10283 if (sys_suspend () == -1)
10285 printf ("Not running as a subprocess;\n");
10286 printf ("you can continue or abort.\n");
10288 #else /* not VMS */
10289 /* Perhaps should really fork an inferior shell?
10290 But that would not provide any way to get back
10291 to the original shell, ever. */
10292 printf ("No support for stopping a process on this operating system;\n");
10293 printf ("you can continue or abort.\n");
10294 #endif /* not VMS */
10295 #endif /* not SIGTSTP */
10297 /* We must remain inside the screen area when the internal terminal
10298 is used. Note that [Enter] is not echoed by dos. */
10301 /* It doesn't work to autosave while GC is in progress;
10302 the code used for auto-saving doesn't cope with the mark bit. */
10303 if (!gc_in_progress
)
10305 printf ("Auto-save? (y or n) ");
10307 if (((c
= getchar ()) & ~040) == 'Y')
10309 Fdo_auto_save (Qt
, Qnil
);
10311 printf ("\r\nAuto-save done");
10312 #else /* not MSDOS */
10313 printf ("Auto-save done\n");
10314 #endif /* not MSDOS */
10316 while (c
!= '\n') c
= getchar ();
10320 /* During GC, it must be safe to reenable quitting again. */
10321 Vinhibit_quit
= Qnil
;
10324 #endif /* not MSDOS */
10325 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10326 printf ("but will instead do a real quit after garbage collection ends\r\n");
10331 printf ("\r\nAbort? (y or n) ");
10332 #else /* not MSDOS */
10334 printf ("Abort (and enter debugger)? (y or n) ");
10335 #else /* not VMS */
10336 printf ("Abort (and dump core)? (y or n) ");
10337 #endif /* not VMS */
10338 #endif /* not MSDOS */
10340 if (((c
= getchar ()) & ~040) == 'Y')
10342 while (c
!= '\n') c
= getchar ();
10344 printf ("\r\nContinuing...\r\n");
10345 #else /* not MSDOS */
10346 printf ("Continuing...\n");
10347 #endif /* not MSDOS */
10349 init_all_sys_modes ();
10354 /* If executing a function that wants to be interrupted out of
10355 and the user has not deferred quitting by binding `inhibit-quit'
10356 then quit right away. */
10357 if (immediate_quit
&& NILP (Vinhibit_quit
))
10359 struct gl_state_s saved
;
10360 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10362 immediate_quit
= 0;
10365 GCPRO4 (saved
.object
, saved
.global_code
,
10366 saved
.current_syntax_table
, saved
.old_prop
);
10367 Fsignal (Qquit
, Qnil
);
10372 /* Else request quit when it's safe */
10376 if (waiting_for_input
&& !echoing
)
10377 quit_throw_to_read_char ();
10382 /* Handle a C-g by making read_char return C-g. */
10385 quit_throw_to_read_char ()
10388 /* Prevent another signal from doing this before we finish. */
10389 clear_waiting_for_input ();
10392 Vunread_command_events
= Qnil
;
10393 unread_command_char
= -1;
10395 #if 0 /* Currently, sit_for is called from read_char without turning
10396 off polling. And that can call set_waiting_for_input.
10397 It seems to be harmless. */
10398 #ifdef POLL_FOR_INPUT
10399 /* May be > 1 if in recursive minibuffer. */
10400 if (poll_suppress_count
== 0)
10404 if (FRAMEP (internal_last_event_frame
)
10405 && !EQ (internal_last_event_frame
, selected_frame
))
10406 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10409 _longjmp (getcjmp
, 1);
10412 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10413 doc
: /* Set mode of reading keyboard input.
10414 First arg INTERRUPT non-nil means use input interrupts;
10415 nil means use CBREAK mode.
10416 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10417 (no effect except in CBREAK mode).
10418 Third arg META t means accept 8-bit input (for a Meta key).
10419 META nil means ignore the top bit, on the assumption it is parity.
10420 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10421 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10422 See also `current-input-mode'. */)
10423 (interrupt
, flow
, meta
, quit
)
10424 Lisp_Object interrupt
, flow
, meta
, quit
;
10427 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10428 error ("set-input-mode: QUIT must be an ASCII character");
10430 #ifdef POLL_FOR_INPUT
10435 /* this causes startup screen to be restored and messes with the mouse */
10436 reset_all_sys_modes ();
10440 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10441 if (read_socket_hook
)
10443 /* When using X, don't give the user a real choice,
10444 because we haven't implemented the mechanisms to support it. */
10445 #ifdef NO_SOCK_SIGIO
10446 interrupt_input
= 0;
10447 #else /* not NO_SOCK_SIGIO */
10448 interrupt_input
= 1;
10449 #endif /* NO_SOCK_SIGIO */
10452 interrupt_input
= !NILP (interrupt
);
10453 #else /* not SIGIO */
10454 interrupt_input
= 0;
10455 #endif /* not SIGIO */
10457 /* Our VMS input only works by interrupts, as of now. */
10459 interrupt_input
= 1;
10462 flow_control
= !NILP (flow
);
10464 FRAME_TTY (SELECTED_FRAME ())->meta_key
= 0;
10465 else if (EQ (meta
, Qt
))
10466 FRAME_TTY (SELECTED_FRAME ())->meta_key
= 1;
10468 FRAME_TTY (SELECTED_FRAME ())->meta_key
= 2;
10470 /* Don't let this value be out of range. */
10471 quit_char
= XINT (quit
) & (FRAME_TTY (SELECTED_FRAME ())->meta_key
? 0377 : 0177);
10474 init_all_sys_modes ();
10477 #ifdef POLL_FOR_INPUT
10478 poll_suppress_count
= 1;
10484 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10485 doc
: /* Return information about the way Emacs currently reads keyboard input.
10486 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10487 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10488 nil, Emacs is using CBREAK mode.
10489 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10490 terminal; this does not apply if Emacs uses interrupt-driven input.
10491 META is t if accepting 8-bit input with 8th bit as Meta flag.
10492 META nil means ignoring the top bit, on the assumption it is parity.
10493 META is neither t nor nil if accepting 8-bit input and using
10494 all 8 bits as the character code.
10495 QUIT is the character Emacs currently uses to quit.
10496 The elements of this list correspond to the arguments of
10497 `set-input-mode'. */)
10500 Lisp_Object val
[4];
10502 val
[0] = interrupt_input
? Qt
: Qnil
;
10503 val
[1] = flow_control
? Qt
: Qnil
;
10504 val
[2] = FRAME_TTY (SELECTED_FRAME ())->meta_key
== 2
10506 : FRAME_TTY (SELECTED_FRAME ())->meta_key
== 1 ? Qt
: Qnil
;
10507 XSETFASTINT (val
[3], quit_char
);
10509 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10514 * Set up a new kboard object with reasonable initial values.
10520 kb
->Voverriding_terminal_local_map
= Qnil
;
10521 kb
->Vlast_command
= Qnil
;
10522 kb
->Vreal_last_command
= Qnil
;
10523 kb
->Vprefix_arg
= Qnil
;
10524 kb
->Vlast_prefix_arg
= Qnil
;
10525 kb
->kbd_queue
= Qnil
;
10526 kb
->kbd_queue_has_data
= 0;
10527 kb
->immediate_echo
= 0;
10528 kb
->echo_string
= Qnil
;
10529 kb
->echo_after_prompt
= -1;
10530 kb
->kbd_macro_buffer
= 0;
10531 kb
->kbd_macro_bufsize
= 0;
10532 kb
->defining_kbd_macro
= Qnil
;
10533 kb
->Vlast_kbd_macro
= Qnil
;
10534 kb
->reference_count
= 0;
10535 kb
->Vsystem_key_alist
= Qnil
;
10536 kb
->system_key_syms
= Qnil
;
10537 kb
->Vdefault_minibuffer_frame
= Qnil
;
10541 * Destroy the contents of a kboard object, but not the object itself.
10542 * We use this just before deleting it, or if we're going to initialize
10543 * it a second time.
10549 if (kb
->kbd_macro_buffer
)
10550 xfree (kb
->kbd_macro_buffer
);
10553 #ifdef MULTI_KBOARD
10555 /* Free KB and memory referenced from it. */
10563 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10566 *kbp
= kb
->next_kboard
;
10568 /* Prevent a dangling reference to KB. */
10569 if (kb
== current_kboard
10570 && FRAMEP (selected_frame
)
10571 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10573 current_kboard
= XFRAME (selected_frame
)->kboard
;
10574 if (current_kboard
== kb
)
10582 #endif /* MULTI_KBOARD */
10587 /* This is correct before outermost invocation of the editor loop */
10588 command_loop_level
= -1;
10589 immediate_quit
= 0;
10590 quit_char
= Ctl ('g');
10591 Vunread_command_events
= Qnil
;
10592 unread_command_char
= -1;
10593 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10595 recent_keys_index
= 0;
10596 kbd_fetch_ptr
= kbd_buffer
;
10597 kbd_store_ptr
= kbd_buffer
;
10598 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10600 do_mouse_tracking
= Qnil
;
10604 /* This means that command_loop_1 won't try to select anything the first
10606 internal_last_event_frame
= Qnil
;
10607 Vlast_event_frame
= internal_last_event_frame
;
10609 #ifdef MULTI_KBOARD
10610 current_kboard
= initial_kboard
;
10612 wipe_kboard (current_kboard
);
10613 init_kboard (current_kboard
);
10615 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10617 signal (SIGINT
, interrupt_signal
);
10618 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10619 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10620 SIGQUIT and we can't tell which one it will give us. */
10621 signal (SIGQUIT
, interrupt_signal
);
10622 #endif /* HAVE_TERMIO */
10624 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10626 if (!noninteractive
)
10627 signal (SIGIO
, input_available_signal
);
10630 /* Use interrupt input by default, if it works and noninterrupt input
10631 has deficiencies. */
10633 #ifdef INTERRUPT_INPUT
10634 interrupt_input
= 1;
10636 interrupt_input
= 0;
10639 /* Our VMS input only works by interrupts, as of now. */
10641 interrupt_input
= 1;
10647 if (keyboard_init_hook
)
10648 (*keyboard_init_hook
) ();
10650 #ifdef POLL_FOR_INPUT
10651 poll_suppress_count
= 1;
10656 /* At least provide an escape route since C-g doesn't work. */
10657 signal (SIGINT
, interrupt_signal
);
10661 /* This type's only use is in syms_of_keyboard, to initialize the
10662 event header symbols and put properties on them. */
10663 struct event_head
{
10669 struct event_head head_table
[] = {
10670 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10671 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10672 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10673 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10674 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10675 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10676 /* `select-window' should be handled just like `switch-frame'
10677 in read_key_sequence. */
10678 {&Qselect_window
, "select-window", &Qswitch_frame
}
10682 syms_of_keyboard ()
10684 Vpre_help_message
= Qnil
;
10685 staticpro (&Vpre_help_message
);
10687 Vlispy_mouse_stem
= build_string ("mouse");
10688 staticpro (&Vlispy_mouse_stem
);
10691 QCimage
= intern (":image");
10692 staticpro (&QCimage
);
10694 staticpro (&Qhelp_echo
);
10695 Qhelp_echo
= intern ("help-echo");
10697 staticpro (&item_properties
);
10698 item_properties
= Qnil
;
10700 staticpro (&tool_bar_item_properties
);
10701 tool_bar_item_properties
= Qnil
;
10702 staticpro (&tool_bar_items_vector
);
10703 tool_bar_items_vector
= Qnil
;
10705 staticpro (&real_this_command
);
10706 real_this_command
= Qnil
;
10708 Qtimer_event_handler
= intern ("timer-event-handler");
10709 staticpro (&Qtimer_event_handler
);
10711 Qdisabled_command_hook
= intern ("disabled-command-hook");
10712 staticpro (&Qdisabled_command_hook
);
10714 Qself_insert_command
= intern ("self-insert-command");
10715 staticpro (&Qself_insert_command
);
10717 Qforward_char
= intern ("forward-char");
10718 staticpro (&Qforward_char
);
10720 Qbackward_char
= intern ("backward-char");
10721 staticpro (&Qbackward_char
);
10723 Qdisabled
= intern ("disabled");
10724 staticpro (&Qdisabled
);
10726 Qundefined
= intern ("undefined");
10727 staticpro (&Qundefined
);
10729 Qpre_command_hook
= intern ("pre-command-hook");
10730 staticpro (&Qpre_command_hook
);
10732 Qpost_command_hook
= intern ("post-command-hook");
10733 staticpro (&Qpost_command_hook
);
10735 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10736 staticpro (&Qpost_command_idle_hook
);
10738 Qdeferred_action_function
= intern ("deferred-action-function");
10739 staticpro (&Qdeferred_action_function
);
10741 Qcommand_hook_internal
= intern ("command-hook-internal");
10742 staticpro (&Qcommand_hook_internal
);
10744 Qfunction_key
= intern ("function-key");
10745 staticpro (&Qfunction_key
);
10746 Qmouse_click
= intern ("mouse-click");
10747 staticpro (&Qmouse_click
);
10749 Qlanguage_change
= intern ("language-change");
10750 staticpro (&Qlanguage_change
);
10752 Qdrag_n_drop
= intern ("drag-n-drop");
10753 staticpro (&Qdrag_n_drop
);
10755 Qsave_session
= intern ("save-session");
10756 staticpro(&Qsave_session
);
10758 Qusr1_signal
= intern ("usr1-signal");
10759 staticpro (&Qusr1_signal
);
10760 Qusr2_signal
= intern ("usr2-signal");
10761 staticpro (&Qusr2_signal
);
10763 Qmenu_enable
= intern ("menu-enable");
10764 staticpro (&Qmenu_enable
);
10765 Qmenu_alias
= intern ("menu-alias");
10766 staticpro (&Qmenu_alias
);
10767 QCenable
= intern (":enable");
10768 staticpro (&QCenable
);
10769 QCvisible
= intern (":visible");
10770 staticpro (&QCvisible
);
10771 QChelp
= intern (":help");
10772 staticpro (&QChelp
);
10773 QCfilter
= intern (":filter");
10774 staticpro (&QCfilter
);
10775 QCbutton
= intern (":button");
10776 staticpro (&QCbutton
);
10777 QCkeys
= intern (":keys");
10778 staticpro (&QCkeys
);
10779 QCkey_sequence
= intern (":key-sequence");
10780 staticpro (&QCkey_sequence
);
10781 QCtoggle
= intern (":toggle");
10782 staticpro (&QCtoggle
);
10783 QCradio
= intern (":radio");
10784 staticpro (&QCradio
);
10786 Qmode_line
= intern ("mode-line");
10787 staticpro (&Qmode_line
);
10788 Qvertical_line
= intern ("vertical-line");
10789 staticpro (&Qvertical_line
);
10790 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10791 staticpro (&Qvertical_scroll_bar
);
10792 Qmenu_bar
= intern ("menu-bar");
10793 staticpro (&Qmenu_bar
);
10795 Qabove_handle
= intern ("above-handle");
10796 staticpro (&Qabove_handle
);
10797 Qhandle
= intern ("handle");
10798 staticpro (&Qhandle
);
10799 Qbelow_handle
= intern ("below-handle");
10800 staticpro (&Qbelow_handle
);
10801 Qup
= intern ("up");
10803 Qdown
= intern ("down");
10804 staticpro (&Qdown
);
10805 Qtop
= intern ("top");
10807 Qbottom
= intern ("bottom");
10808 staticpro (&Qbottom
);
10809 Qend_scroll
= intern ("end-scroll");
10810 staticpro (&Qend_scroll
);
10811 Qratio
= intern ("ratio");
10812 staticpro (&Qratio
);
10814 Qevent_kind
= intern ("event-kind");
10815 staticpro (&Qevent_kind
);
10816 Qevent_symbol_elements
= intern ("event-symbol-elements");
10817 staticpro (&Qevent_symbol_elements
);
10818 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10819 staticpro (&Qevent_symbol_element_mask
);
10820 Qmodifier_cache
= intern ("modifier-cache");
10821 staticpro (&Qmodifier_cache
);
10823 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10824 staticpro (&Qrecompute_lucid_menubar
);
10825 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10826 staticpro (&Qactivate_menubar_hook
);
10828 Qpolling_period
= intern ("polling-period");
10829 staticpro (&Qpolling_period
);
10831 Qinput_method_function
= intern ("input-method-function");
10832 staticpro (&Qinput_method_function
);
10834 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10835 staticpro (&Qinput_method_exit_on_first_char
);
10836 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10837 staticpro (&Qinput_method_use_echo_area
);
10839 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10840 Fset (Qinput_method_use_echo_area
, Qnil
);
10842 last_point_position_buffer
= Qnil
;
10845 struct event_head
*p
;
10847 for (p
= head_table
;
10848 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10851 *p
->var
= intern (p
->name
);
10852 staticpro (p
->var
);
10853 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10854 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10858 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10859 staticpro (&button_down_location
);
10860 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10861 staticpro (&mouse_syms
);
10862 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
10863 staticpro (&wheel_syms
);
10867 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10869 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10870 for (i
= 0; i
< len
; i
++)
10871 if (modifier_names
[i
])
10872 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10873 staticpro (&modifier_symbols
);
10876 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10877 staticpro (&recent_keys
);
10879 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10880 staticpro (&this_command_keys
);
10882 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10883 staticpro (&raw_keybuf
);
10885 Qextended_command_history
= intern ("extended-command-history");
10886 Fset (Qextended_command_history
, Qnil
);
10887 staticpro (&Qextended_command_history
);
10889 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10890 staticpro (&kbd_buffer_gcpro
);
10892 accent_key_syms
= Qnil
;
10893 staticpro (&accent_key_syms
);
10895 func_key_syms
= Qnil
;
10896 staticpro (&func_key_syms
);
10898 drag_n_drop_syms
= Qnil
;
10899 staticpro (&drag_n_drop_syms
);
10901 unread_switch_frame
= Qnil
;
10902 staticpro (&unread_switch_frame
);
10904 internal_last_event_frame
= Qnil
;
10905 staticpro (&internal_last_event_frame
);
10907 read_key_sequence_cmd
= Qnil
;
10908 staticpro (&read_key_sequence_cmd
);
10910 menu_bar_one_keymap_changed_items
= Qnil
;
10911 staticpro (&menu_bar_one_keymap_changed_items
);
10913 defsubr (&Sevent_convert_list
);
10914 defsubr (&Sread_key_sequence
);
10915 defsubr (&Sread_key_sequence_vector
);
10916 defsubr (&Srecursive_edit
);
10918 defsubr (&Strack_mouse
);
10920 defsubr (&Sinput_pending_p
);
10921 defsubr (&Scommand_execute
);
10922 defsubr (&Srecent_keys
);
10923 defsubr (&Sthis_command_keys
);
10924 defsubr (&Sthis_command_keys_vector
);
10925 defsubr (&Sthis_single_command_keys
);
10926 defsubr (&Sthis_single_command_raw_keys
);
10927 defsubr (&Sreset_this_command_lengths
);
10928 defsubr (&Sclear_this_command_keys
);
10929 defsubr (&Ssuspend_emacs
);
10930 defsubr (&Sabort_recursive_edit
);
10931 defsubr (&Sexit_recursive_edit
);
10932 defsubr (&Srecursion_depth
);
10933 defsubr (&Stop_level
);
10934 defsubr (&Sdiscard_input
);
10935 defsubr (&Sopen_dribble_file
);
10936 defsubr (&Sset_input_mode
);
10937 defsubr (&Scurrent_input_mode
);
10938 defsubr (&Sexecute_extended_command
);
10940 DEFVAR_LISP ("last-command-char", &last_command_char
,
10941 doc
: /* Last input event that was part of a command. */);
10943 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10944 doc
: /* Last input event that was part of a command. */);
10946 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10947 doc
: /* Last input event in a command, except for mouse menu events.
10948 Mouse menus give back keys that don't look like mouse events;
10949 this variable holds the actual mouse event that led to the menu,
10950 so that you can determine whether the command was run by mouse or not. */);
10952 DEFVAR_LISP ("last-input-char", &last_input_char
,
10953 doc
: /* Last input event. */);
10955 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10956 doc
: /* Last input event. */);
10958 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10959 doc
: /* List of events to be read as the command input.
10960 These events are processed first, before actual keyboard input. */);
10961 Vunread_command_events
= Qnil
;
10963 DEFVAR_INT ("unread-command-char", &unread_command_char
,
10964 doc
: /* If not -1, an object to be read as next command input event. */);
10966 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
10967 doc
: /* List of events to be processed as input by input methods.
10968 These events are processed after `unread-command-events', but
10969 before actual keyboard input. */);
10970 Vunread_post_input_method_events
= Qnil
;
10972 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
10973 doc
: /* List of events to be processed as input by input methods.
10974 These events are processed after `unread-command-events', but
10975 before actual keyboard input. */);
10976 Vunread_input_method_events
= Qnil
;
10978 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
10979 doc
: /* Meta-prefix character code.
10980 Meta-foo as command input turns into this character followed by foo. */);
10981 XSETINT (meta_prefix_char
, 033);
10983 DEFVAR_KBOARD ("last-command", Vlast_command
,
10984 doc
: /* The last command executed.
10985 Normally a symbol with a function definition, but can be whatever was found
10986 in the keymap, or whatever the variable `this-command' was set to by that
10989 The value `mode-exit' is special; it means that the previous command
10990 read an event that told it to exit, and it did so and unread that event.
10991 In other words, the present command is the event that made the previous
10994 The value `kill-region' is special; it means that the previous command
10995 was a kill command. */);
10997 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
10998 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11000 DEFVAR_LISP ("this-command", &Vthis_command
,
11001 doc
: /* The command now being executed.
11002 The command can set this variable; whatever is put here
11003 will be in `last-command' during the following command. */);
11004 Vthis_command
= Qnil
;
11006 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11007 doc
: /* The command bound to the current key sequence before remapping.
11008 It equals `this-command' if the original command was not remapped through
11009 any of the active keymaps. Otherwise, the value of `this-command' is the
11010 result of looking up the original command in the active keymaps. */);
11011 Vthis_original_command
= Qnil
;
11013 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11014 doc
: /* *Number of input events between auto-saves.
11015 Zero means disable autosaving due to number of characters typed. */);
11016 auto_save_interval
= 300;
11018 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11019 doc
: /* *Number of seconds idle time before auto-save.
11020 Zero or nil means disable auto-saving due to idleness.
11021 After auto-saving due to this many seconds of idle time,
11022 Emacs also does a garbage collection if that seems to be warranted. */);
11023 XSETFASTINT (Vauto_save_timeout
, 30);
11025 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11026 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11027 The value may be integer or floating point. */);
11028 Vecho_keystrokes
= make_number (1);
11030 DEFVAR_INT ("polling-period", &polling_period
,
11031 doc
: /* *Interval between polling for input during Lisp execution.
11032 The reason for polling is to make C-g work to stop a running program.
11033 Polling is needed only when using X windows and SIGIO does not work.
11034 Polling is automatically disabled in all other cases. */);
11035 polling_period
= 2;
11037 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11038 doc
: /* *Maximum time between mouse clicks to make a double-click.
11039 Measured in milliseconds. nil means disable double-click recognition;
11040 t means double-clicks have no time limit and are detected
11041 by position only. */);
11042 Vdouble_click_time
= make_number (500);
11044 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11045 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11046 On window-system frames, value is the number of pixels the mouse may have
11047 moved horizontally or vertically between two clicks to make a double-click.
11048 On non window-system frames, value is interpreted in units of 1/8 characters
11051 This variable is also the threshold for motion of the mouse
11052 to count as a drag. */);
11053 double_click_fuzz
= 3;
11055 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11056 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11057 inhibit_local_menu_bar_menus
= 0;
11059 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11060 doc
: /* Number of complete key sequences read as input so far.
11061 This includes key sequences read from keyboard macros.
11062 The number is effectively the number of interactive command invocations. */);
11063 num_input_keys
= 0;
11065 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11066 doc
: /* Number of input events read from the keyboard so far.
11067 This does not include events generated by keyboard macros. */);
11068 num_nonmacro_input_events
= 0;
11070 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11071 doc
: /* The frame in which the most recently read event occurred.
11072 If the last event came from a keyboard macro, this is set to `macro'. */);
11073 Vlast_event_frame
= Qnil
;
11075 /* This variable is set up in sysdep.c. */
11076 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11077 doc
: /* The ERASE character as set by the user with stty. */);
11079 DEFVAR_LISP ("help-char", &Vhelp_char
,
11080 doc
: /* Character to recognize as meaning Help.
11081 When it is read, do `(eval help-form)', and display result if it's a string.
11082 If the value of `help-form' is nil, this char can be read normally. */);
11083 XSETINT (Vhelp_char
, Ctl ('H'));
11085 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11086 doc
: /* List of input events to recognize as meaning Help.
11087 These work just like the value of `help-char' (see that). */);
11088 Vhelp_event_list
= Qnil
;
11090 DEFVAR_LISP ("help-form", &Vhelp_form
,
11091 doc
: /* Form to execute when character `help-char' is read.
11092 If the form returns a string, that string is displayed.
11093 If `help-form' is nil, the help char is not recognized. */);
11096 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11097 doc
: /* Command to run when `help-char' character follows a prefix key.
11098 This command is used only when there is no actual binding
11099 for that character after that prefix key. */);
11100 Vprefix_help_command
= Qnil
;
11102 DEFVAR_LISP ("top-level", &Vtop_level
,
11103 doc
: /* Form to evaluate when Emacs starts up.
11104 Useful to set before you dump a modified Emacs. */);
11107 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11108 doc
: /* Translate table for keyboard input, or nil.
11109 Each character is looked up in this string and the contents used instead.
11110 The value may be a string, a vector, or a char-table.
11111 If it is a string or vector of length N,
11112 character codes N and up are untranslated.
11113 In a vector or a char-table, an element which is nil means "no translation".
11115 This is applied to the characters supplied to input methods, not their
11116 output. See also `translation-table-for-input'. */);
11117 Vkeyboard_translate_table
= Qnil
;
11119 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11120 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11121 \(Even if the operating system has support for stopping a process.\) */);
11122 cannot_suspend
= 0;
11124 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11125 doc
: /* Non-nil means prompt with menus when appropriate.
11126 This is done when reading from a keymap that has a prompt string,
11127 for elements that have prompt strings.
11128 The menu is displayed on the screen
11129 if X menus were enabled at configuration
11130 time and the previous event was a mouse click prefix key.
11131 Otherwise, menu prompting uses the echo area. */);
11132 menu_prompting
= 1;
11134 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11135 doc
: /* Character to see next line of menu prompt.
11136 Type this character while in a menu prompt to rotate around the lines of it. */);
11137 XSETINT (menu_prompt_more_char
, ' ');
11139 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11140 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11141 Emacs applies the modifiers of the character stored here to each keyboard
11142 character it reads. For example, after evaluating the expression
11143 (setq extra-keyboard-modifiers ?\\C-x)
11144 all input characters will have the control modifier applied to them.
11146 Note that the character ?\\C-@, equivalent to the integer zero, does
11147 not count as a control character; rather, it counts as a character
11148 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11149 cancels any modification. */);
11150 extra_keyboard_modifiers
= 0;
11152 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11153 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11154 The command loop sets this to nil before each command,
11155 and tests the value when the command returns.
11156 Buffer modification stores t in this variable. */);
11157 Vdeactivate_mark
= Qnil
;
11159 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11160 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11161 Vcommand_hook_internal
= Qnil
;
11163 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11164 doc
: /* Normal hook run before each command is executed.
11165 If an unhandled error happens in running this hook,
11166 the hook value is set to nil, since otherwise the error
11167 might happen repeatedly and make Emacs nonfunctional. */);
11168 Vpre_command_hook
= Qnil
;
11170 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11171 doc
: /* Normal hook run after each command is executed.
11172 If an unhandled error happens in running this hook,
11173 the hook value is set to nil, since otherwise the error
11174 might happen repeatedly and make Emacs nonfunctional. */);
11175 Vpost_command_hook
= Qnil
;
11177 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11178 doc
: /* Normal hook run after each command is executed, if idle.
11179 Errors running the hook are caught and ignored. */);
11180 Vpost_command_idle_hook
= Qnil
;
11182 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11183 doc
: /* Delay time before running `post-command-idle-hook'.
11184 This is measured in microseconds. */);
11185 post_command_idle_delay
= 100000;
11188 DEFVAR_LISP ("echo-area-clear-hook", ...,
11189 doc
: /* Normal hook run when clearing the echo area. */);
11191 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11192 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11194 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11195 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11196 Vlucid_menu_bar_dirty_flag
= Qnil
;
11198 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11199 doc
: /* List of menu bar items to move to the end of the menu bar.
11200 The elements of the list are event types that may have menu bar bindings. */);
11201 Vmenu_bar_final_items
= Qnil
;
11203 DEFVAR_KBOARD ("overriding-terminal-local-map",
11204 Voverriding_terminal_local_map
,
11205 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11206 If this variable is non-nil, it is used as a keymap instead of the
11207 buffer's local map, and the minor mode keymaps and text property keymaps.
11208 This variable is intended to let commands such as `universal-argument'
11209 set up a different keymap for reading the next command. */);
11211 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11212 doc
: /* Keymap that overrides all other local keymaps.
11213 If this variable is non-nil, it is used as a keymap instead of the
11214 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11215 Voverriding_local_map
= Qnil
;
11217 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11218 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11219 Otherwise, the menu bar continues to reflect the buffer's local map
11220 and the minor mode maps regardless of `overriding-local-map'. */);
11221 Voverriding_local_map_menu_flag
= Qnil
;
11223 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11224 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11225 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11227 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11228 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11230 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11231 doc
: /* Alist of system-specific X windows key symbols.
11232 Each element should have the form (N . SYMBOL) where N is the
11233 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11234 and SYMBOL is its name. */);
11236 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11237 doc
: /* List of deferred actions to be performed at a later time.
11238 The precise format isn't relevant here; we just check whether it is nil. */);
11239 Vdeferred_action_list
= Qnil
;
11241 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11242 doc
: /* Function to call to handle deferred actions, after each command.
11243 This function is called with no arguments after each command
11244 whenever `deferred-action-list' is non-nil. */);
11245 Vdeferred_action_function
= Qnil
;
11247 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11248 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11249 The value can be a length of time to show the message for.
11250 If the value is non-nil and not a number, we wait 2 seconds. */);
11251 Vsuggest_key_bindings
= Qt
;
11253 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11254 doc
: /* List of active absolute time timers in order of increasing time. */);
11255 Vtimer_list
= Qnil
;
11257 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11258 doc
: /* List of active idle-time timers in order of increasing time. */);
11259 Vtimer_idle_list
= Qnil
;
11261 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11262 doc
: /* If non-nil, the function that implements the current input method.
11263 It's called with one argument, a printing character that was just read.
11264 \(That means a character with code 040...0176.)
11265 Typically this function uses `read-event' to read additional events.
11266 When it does so, it should first bind `input-method-function' to nil
11267 so it will not be called recursively.
11269 The function should return a list of zero or more events
11270 to be used as input. If it wants to put back some events
11271 to be reconsidered, separately, by the input method,
11272 it can add them to the beginning of `unread-command-events'.
11274 The input method function can find in `input-method-previous-method'
11275 the previous echo area message.
11277 The input method function should refer to the variables
11278 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11279 for guidance on what to do. */);
11280 Vinput_method_function
= Qnil
;
11282 DEFVAR_LISP ("input-method-previous-message",
11283 &Vinput_method_previous_message
,
11284 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11285 This variable exists because `read-event' clears the echo area
11286 before running the input method. It is nil if there was no message. */);
11287 Vinput_method_previous_message
= Qnil
;
11289 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11290 doc
: /* If non-nil, the function that implements the display of help.
11291 It's called with one argument, the help string to display. */);
11292 Vshow_help_function
= Qnil
;
11294 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11295 doc
: /* If non-nil, suppress point adjustment after executing a command.
11297 After a command is executed, if point is moved into a region that has
11298 special properties (e.g. composition, display), we adjust point to
11299 the boundary of the region. But, several special commands sets this
11300 variable to non-nil, then we suppress the point adjustment.
11302 This variable is set to nil before reading a command, and is checked
11303 just after executing the command. */);
11304 Vdisable_point_adjustment
= Qnil
;
11306 DEFVAR_LISP ("global-disable-point-adjustment",
11307 &Vglobal_disable_point_adjustment
,
11308 doc
: /* *If non-nil, always suppress point adjustment.
11310 The default value is nil, in which case, point adjustment are
11311 suppressed only after special commands that set
11312 `disable-point-adjustment' (which see) to non-nil. */);
11313 Vglobal_disable_point_adjustment
= Qnil
;
11315 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11316 doc
: /* Non-nil means updating menu bindings is allowed.
11317 A value of nil means menu bindings should not be updated.
11318 Used during Emacs' startup. */);
11319 update_menu_bindings
= 1;
11321 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11322 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11323 If the value is not a number, such messages don't time out. */);
11324 Vminibuffer_message_timeout
= make_number (2);
11328 keys_of_keyboard ()
11330 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11331 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11332 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11333 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11334 initial_define_key (meta_map
, 'x', "execute-extended-command");
11336 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11337 "handle-delete-frame");
11338 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11340 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11342 /* Handling it at such a low-level causes read_key_sequence to get
11343 * confused because it doesn't realize that the current_buffer was
11344 * changed by read_char.
11346 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11347 * "handle-select-window"); */
11348 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11349 "handle-save-session");
11352 /* Mark the pointers in the kboard objects.
11353 Called by the Fgarbage_collector. */
11359 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11361 if (kb
->kbd_macro_buffer
)
11362 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11364 mark_object (kb
->Voverriding_terminal_local_map
);
11365 mark_object (kb
->Vlast_command
);
11366 mark_object (kb
->Vreal_last_command
);
11367 mark_object (kb
->Vprefix_arg
);
11368 mark_object (kb
->Vlast_prefix_arg
);
11369 mark_object (kb
->kbd_queue
);
11370 mark_object (kb
->defining_kbd_macro
);
11371 mark_object (kb
->Vlast_kbd_macro
);
11372 mark_object (kb
->Vsystem_key_alist
);
11373 mark_object (kb
->system_key_syms
);
11374 mark_object (kb
->Vdefault_minibuffer_frame
);
11375 mark_object (kb
->echo_string
);
11378 struct input_event
*event
;
11379 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11381 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11382 event
= kbd_buffer
;
11383 mark_object (event
->x
);
11384 mark_object (event
->y
);
11385 mark_object (event
->frame_or_window
);
11386 mark_object (event
->arg
);
11391 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11392 (do not change this comment) */