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,04
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. */
29 #include "termhooks.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
53 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
59 #include <sys/types.h>
64 /* This is to get the definitions of the XK_ symbols. */
71 #endif /* HAVE_NTGUI */
81 /* Variables for blockinput.h: */
83 /* Non-zero if interrupt input is blocked right now. */
84 int interrupt_input_blocked
;
86 /* Nonzero means an input interrupt has arrived
87 during the current critical section. */
88 int interrupt_input_pending
;
91 #ifdef HAVE_WINDOW_SYSTEM
92 /* Make all keyboard buffers much bigger when using X windows. */
94 /* But not too big (local data > 32K error) if on Mac OS Classic. */
95 #define KBD_BUFFER_SIZE 512
97 #define KBD_BUFFER_SIZE 4096
99 #else /* No X-windows, character input */
100 #define KBD_BUFFER_SIZE 4096
101 #endif /* No X-windows */
103 #define abs(x) ((x) >= 0 ? (x) : -(x))
105 /* Following definition copied from eval.c */
109 struct backtrace
*next
;
110 Lisp_Object
*function
;
111 Lisp_Object
*args
; /* Points to vector of args. */
112 int nargs
; /* length of vector. If nargs is UNEVALLED,
113 args points to slot holding list of
119 KBOARD
*initial_kboard
;
120 KBOARD
*current_kboard
;
124 KBOARD the_only_kboard
;
127 /* Non-nil disable property on a command means
128 do not execute it; call disabled-command-hook's value instead. */
129 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
131 #define NUM_RECENT_KEYS (100)
132 int recent_keys_index
; /* Index for storing next element into recent_keys */
133 int total_keys
; /* Total number of elements stored into recent_keys */
134 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
136 /* Vector holding the key sequence that invoked the current command.
137 It is reused for each command, and it may be longer than the current
138 sequence; this_command_key_count indicates how many elements
139 actually mean something.
140 It's easier to staticpro a single Lisp_Object than an array. */
141 Lisp_Object this_command_keys
;
142 int this_command_key_count
;
144 /* 1 after calling Freset_this_command_lengths.
146 int this_command_key_count_reset
;
148 /* This vector is used as a buffer to record the events that were actually read
149 by read_key_sequence. */
150 Lisp_Object raw_keybuf
;
151 int raw_keybuf_count
;
153 #define GROW_RAW_KEYBUF \
154 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
156 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
158 new = Fmake_vector (make_number (newsize), Qnil); \
159 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
160 raw_keybuf_count * sizeof (Lisp_Object)); \
164 /* Number of elements of this_command_keys
165 that precede this key sequence. */
166 int this_single_command_key_start
;
168 /* Record values of this_command_key_count and echo_length ()
169 before this command was read. */
170 static int before_command_key_count
;
171 static int before_command_echo_length
;
173 extern int minbuf_level
;
175 extern int message_enable_multibyte
;
177 extern struct backtrace
*backtrace_list
;
179 /* If non-nil, the function that implements the display of help.
180 It's called with one argument, the help string to display. */
182 Lisp_Object Vshow_help_function
;
184 /* If a string, the message displayed before displaying a help-echo
187 Lisp_Object Vpre_help_message
;
189 /* Nonzero means do menu prompting. */
191 static int menu_prompting
;
193 /* Character to see next line of menu prompt. */
195 static Lisp_Object menu_prompt_more_char
;
197 /* For longjmp to where kbd input is being done. */
199 static jmp_buf getcjmp
;
201 /* True while doing kbd input. */
202 int waiting_for_input
;
204 /* True while displaying for echoing. Delays C-g throwing. */
208 /* Non-null means we can start echoing at the next input pause even
209 though there is something in the echo area. */
211 static struct kboard
*ok_to_echo_at_next_pause
;
213 /* The kboard last echoing, or null for none. Reset to 0 in
214 cancel_echoing. If non-null, and a current echo area message
215 exists, and echo_message_buffer is eq to the current message
216 buffer, we know that the message comes from echo_kboard. */
218 struct kboard
*echo_kboard
;
220 /* The buffer used for echoing. Set in echo_now, reset in
223 Lisp_Object echo_message_buffer
;
225 /* Nonzero means disregard local maps for the menu bar. */
226 static int inhibit_local_menu_bar_menus
;
228 /* Nonzero means C-g should cause immediate error-signal. */
231 /* The user's ERASE setting. */
232 Lisp_Object Vtty_erase_char
;
234 /* Character to recognize as the help char. */
235 Lisp_Object Vhelp_char
;
237 /* List of other event types to recognize as meaning "help". */
238 Lisp_Object Vhelp_event_list
;
240 /* Form to execute when help char is typed. */
241 Lisp_Object Vhelp_form
;
243 /* Command to run when the help character follows a prefix key. */
244 Lisp_Object Vprefix_help_command
;
246 /* List of items that should move to the end of the menu bar. */
247 Lisp_Object Vmenu_bar_final_items
;
249 /* Non-nil means show the equivalent key-binding for
250 any M-x command that has one.
251 The value can be a length of time to show the message for.
252 If the value is non-nil and not a number, we wait 2 seconds. */
253 Lisp_Object Vsuggest_key_bindings
;
255 /* How long to display an echo-area message when the minibuffer is active.
256 If the value is not a number, such messages don't time out. */
257 Lisp_Object Vminibuffer_message_timeout
;
259 /* Character that causes a quit. Normally C-g.
261 If we are running on an ordinary terminal, this must be an ordinary
262 ASCII char, since we want to make it our interrupt character.
264 If we are not running on an ordinary terminal, it still needs to be
265 an ordinary ASCII char. This character needs to be recognized in
266 the input interrupt handler. At this point, the keystroke is
267 represented as a struct input_event, while the desired quit
268 character is specified as a lispy event. The mapping from struct
269 input_events to lispy events cannot run in an interrupt handler,
270 and the reverse mapping is difficult for anything but ASCII
273 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
277 extern Lisp_Object current_global_map
;
278 extern int minibuf_level
;
280 /* If non-nil, this is a map that overrides all other local maps. */
281 Lisp_Object Voverriding_local_map
;
283 /* If non-nil, Voverriding_local_map applies to the menu bar. */
284 Lisp_Object Voverriding_local_map_menu_flag
;
286 /* Keymap that defines special misc events that should
287 be processed immediately at a low level. */
288 Lisp_Object Vspecial_event_map
;
290 /* Current depth in recursive edits. */
291 int command_loop_level
;
293 /* Total number of times command_loop has read a key sequence. */
294 EMACS_INT num_input_keys
;
296 /* Last input character read as a command. */
297 Lisp_Object last_command_char
;
299 /* Last input character read as a command, not counting menus
300 reached by the mouse. */
301 Lisp_Object last_nonmenu_event
;
303 /* Last input character read for any purpose. */
304 Lisp_Object last_input_char
;
306 /* If not Qnil, a list of objects to be read as subsequent command input. */
307 Lisp_Object Vunread_command_events
;
309 /* If not Qnil, a list of objects to be read as subsequent command input
310 including input method processing. */
311 Lisp_Object Vunread_input_method_events
;
313 /* If not Qnil, a list of objects to be read as subsequent command input
314 but NOT including input method processing. */
315 Lisp_Object Vunread_post_input_method_events
;
317 /* If not -1, an event to be read as subsequent command input. */
318 EMACS_INT unread_command_char
;
320 /* If not Qnil, this is a switch-frame event which we decided to put
321 off until the end of a key sequence. This should be read as the
322 next command input, after any unread_command_events.
324 read_key_sequence uses this to delay switch-frame events until the
325 end of the key sequence; Fread_char uses it to put off switch-frame
326 events until a non-ASCII event is acceptable as input. */
327 Lisp_Object unread_switch_frame
;
329 /* A mask of extra modifier bits to put into every keyboard char. */
330 EMACS_INT extra_keyboard_modifiers
;
332 /* Char to use as prefix when a meta character is typed in.
333 This is bound on entry to minibuffer in case ESC is changed there. */
335 Lisp_Object meta_prefix_char
;
337 /* Last size recorded for a current buffer which is not a minibuffer. */
338 static int last_non_minibuf_size
;
340 /* Number of idle seconds before an auto-save and garbage collection. */
341 static Lisp_Object Vauto_save_timeout
;
343 /* Total number of times read_char has returned. */
344 int num_input_events
;
346 /* Total number of times read_char has returned, outside of macros. */
347 EMACS_INT num_nonmacro_input_events
;
349 /* Auto-save automatically when this many characters have been typed
350 since the last time. */
352 static EMACS_INT auto_save_interval
;
354 /* Value of num_nonmacro_input_events as of last auto save. */
358 /* The command being executed by the command loop.
359 Commands may set this, and the value set will be copied into
360 current_kboard->Vlast_command instead of the actual command. */
361 Lisp_Object Vthis_command
;
363 /* This is like Vthis_command, except that commands never set it. */
364 Lisp_Object real_this_command
;
366 /* If the lookup of the command returns a binding, the original
367 command is stored in this-original-command. It is nil otherwise. */
368 Lisp_Object Vthis_original_command
;
370 /* The value of point when the last command was executed. */
371 int last_point_position
;
373 /* The buffer that was current when the last command was started. */
374 Lisp_Object last_point_position_buffer
;
376 /* The frame in which the last input event occurred, or Qmacro if the
377 last event came from a macro. We use this to determine when to
378 generate switch-frame events. This may be cleared by functions
379 like Fselect_frame, to make sure that a switch-frame event is
380 generated by the next character. */
381 Lisp_Object internal_last_event_frame
;
383 /* A user-visible version of the above, intended to allow users to
384 figure out where the last event came from, if the event doesn't
385 carry that information itself (i.e. if it was a character). */
386 Lisp_Object Vlast_event_frame
;
388 /* The timestamp of the last input event we received from the X server.
389 X Windows wants this for selection ownership. */
390 unsigned long last_event_timestamp
;
392 Lisp_Object Qself_insert_command
;
393 Lisp_Object Qforward_char
;
394 Lisp_Object Qbackward_char
;
395 Lisp_Object Qundefined
;
396 Lisp_Object Qtimer_event_handler
;
398 /* read_key_sequence stores here the command definition of the
399 key sequence that it reads. */
400 Lisp_Object read_key_sequence_cmd
;
402 /* Echo unfinished commands after this many seconds of pause. */
403 Lisp_Object Vecho_keystrokes
;
405 /* Form to evaluate (if non-nil) when Emacs is started. */
406 Lisp_Object Vtop_level
;
408 /* User-supplied table to translate input characters. */
409 Lisp_Object Vkeyboard_translate_table
;
411 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
412 extern Lisp_Object Vfunction_key_map
;
414 /* Another keymap that maps key sequences into key sequences.
415 This one takes precedence over ordinary definitions. */
416 extern Lisp_Object Vkey_translation_map
;
418 /* If non-nil, this implements the current input method. */
419 Lisp_Object Vinput_method_function
;
420 Lisp_Object Qinput_method_function
;
422 /* When we call Vinput_method_function,
423 this holds the echo area message that was just erased. */
424 Lisp_Object Vinput_method_previous_message
;
426 /* Non-nil means deactivate the mark at end of this command. */
427 Lisp_Object Vdeactivate_mark
;
429 /* Menu bar specified in Lucid Emacs fashion. */
431 Lisp_Object Vlucid_menu_bar_dirty_flag
;
432 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
434 Lisp_Object Qecho_area_clear_hook
;
436 /* Hooks to run before and after each command. */
437 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
438 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
439 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
440 /* Hook run after a command if there's no more input soon. */
441 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
443 /* Delay time in microseconds before running post-command-idle-hook. */
444 EMACS_INT post_command_idle_delay
;
446 /* List of deferred actions to be performed at a later time.
447 The precise format isn't relevant here; we just check whether it is nil. */
448 Lisp_Object Vdeferred_action_list
;
450 /* Function to call to handle deferred actions, when there are any. */
451 Lisp_Object Vdeferred_action_function
;
452 Lisp_Object Qdeferred_action_function
;
454 Lisp_Object Qinput_method_exit_on_first_char
;
455 Lisp_Object Qinput_method_use_echo_area
;
457 /* File in which we write all commands we read. */
460 /* Nonzero if input is available. */
463 /* Non-zero means force key bindings update in parse_menu_item. */
465 int update_menu_bindings
;
467 extern char *pending_malloc_warning
;
469 /* Circular buffer for pre-read keyboard input. */
471 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
473 /* Pointer to next available character in kbd_buffer.
474 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
475 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
476 next available char is in kbd_buffer[0]. */
477 static struct input_event
*kbd_fetch_ptr
;
479 /* Pointer to next place to store character in kbd_buffer. This
480 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
481 character should go in kbd_buffer[0]. */
482 static struct input_event
* volatile kbd_store_ptr
;
484 /* The above pair of variables forms a "queue empty" flag. When we
485 enqueue a non-hook event, we increment kbd_store_ptr. When we
486 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
487 there is input available iff the two pointers are not equal.
489 Why not just have a flag set and cleared by the enqueuing and
490 dequeuing functions? Such a flag could be screwed up by interrupts
491 at inopportune times. */
493 /* If this flag is non-nil, we check mouse_moved to see when the
494 mouse moves, and motion events will appear in the input stream.
495 Otherwise, mouse motion is ignored. */
496 Lisp_Object do_mouse_tracking
;
498 /* Symbols to head events. */
499 Lisp_Object Qmouse_movement
;
500 Lisp_Object Qscroll_bar_movement
;
501 Lisp_Object Qswitch_frame
;
502 Lisp_Object Qdelete_frame
;
503 Lisp_Object Qiconify_frame
;
504 Lisp_Object Qmake_frame_visible
;
505 Lisp_Object Qselect_window
;
506 Lisp_Object Qhelp_echo
;
508 /* Symbols to denote kinds of events. */
509 Lisp_Object Qfunction_key
;
510 Lisp_Object Qmouse_click
;
512 Lisp_Object Qlanguage_change
;
514 Lisp_Object Qdrag_n_drop
;
515 Lisp_Object Qsave_session
;
517 /* Lisp_Object Qmouse_movement; - also an event header */
519 /* Properties of event headers. */
520 Lisp_Object Qevent_kind
;
521 Lisp_Object Qevent_symbol_elements
;
523 /* menu item parts */
524 Lisp_Object Qmenu_alias
;
525 Lisp_Object Qmenu_enable
;
526 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
527 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
528 extern Lisp_Object Vdefine_key_rebound_commands
;
529 extern Lisp_Object Qmenu_item
;
531 /* An event header symbol HEAD may have a property named
532 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
533 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
534 mask of modifiers applied to it. If present, this is used to help
535 speed up parse_modifiers. */
536 Lisp_Object Qevent_symbol_element_mask
;
538 /* An unmodified event header BASE may have a property named
539 Qmodifier_cache, which is an alist mapping modifier masks onto
540 modified versions of BASE. If present, this helps speed up
542 Lisp_Object Qmodifier_cache
;
544 /* Symbols to use for parts of windows. */
545 Lisp_Object Qmode_line
;
546 Lisp_Object Qvertical_line
;
547 Lisp_Object Qvertical_scroll_bar
;
548 Lisp_Object Qmenu_bar
;
549 extern Lisp_Object Qleft_margin
, Qright_margin
;
550 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
551 extern Lisp_Object QCmap
;
553 Lisp_Object
recursive_edit_unwind (), command_loop ();
554 Lisp_Object
Fthis_command_keys ();
555 Lisp_Object Qextended_command_history
;
556 EMACS_TIME
timer_check ();
558 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
560 extern char *x_get_keysym_name ();
562 static void record_menu_key ();
563 static int echo_length ();
565 Lisp_Object Qpolling_period
;
567 /* List of absolute timers. Appears in order of next scheduled event. */
568 Lisp_Object Vtimer_list
;
570 /* List of idle time timers. Appears in order of next scheduled event. */
571 Lisp_Object Vtimer_idle_list
;
573 /* Incremented whenever a timer is run. */
576 extern Lisp_Object Vprint_level
, Vprint_length
;
578 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
580 EMACS_TIME
*input_available_clear_time
;
582 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
583 Default is 1 if INTERRUPT_INPUT is defined. */
586 /* Nonzero while interrupts are temporarily deferred during redisplay. */
587 int interrupts_deferred
;
589 /* Allow m- file to inhibit use of FIONREAD. */
590 #ifdef BROKEN_FIONREAD
594 /* We are unable to use interrupts if FIONREAD is not available,
595 so flush SIGIO so we won't try. */
602 /* If we support a window system, turn on the code to poll periodically
603 to detect C-g. It isn't actually used when doing interrupt input. */
604 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
605 #define POLL_FOR_INPUT
608 /* After a command is executed, if point is moved into a region that
609 has specific properties (e.g. composition, display), we adjust
610 point to the boundary of the region. But, if a command sets this
611 variable to non-nil, we suppress this point adjustment. This
612 variable is set to nil before reading a command. */
614 Lisp_Object Vdisable_point_adjustment
;
616 /* If non-nil, always disable point adjustment. */
618 Lisp_Object Vglobal_disable_point_adjustment
;
620 /* The time when Emacs started being idle. */
622 static EMACS_TIME timer_idleness_start_time
;
624 /* After Emacs stops being idle, this saves the last value
625 of timer_idleness_start_time from when it was idle. */
627 static EMACS_TIME timer_last_idleness_start_time
;
630 /* Global variable declarations. */
632 /* Function for init_keyboard to call with no args (if nonzero). */
633 void (*keyboard_init_hook
) ();
635 static int read_avail_input
P_ ((int));
636 static void get_input_pending
P_ ((int *, int));
637 static void get_filtered_input_pending
P_ ((int *, int, int));
638 static int readable_events
P_ ((int));
639 static int readable_filtered_events
P_ ((int, int));
640 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
641 Lisp_Object
, int *));
642 static Lisp_Object
read_char_x_menu_prompt ();
643 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
645 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
647 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
648 enum scroll_bar_part
,
649 Lisp_Object
, Lisp_Object
,
652 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
653 Lisp_Object
, char **,
654 Lisp_Object
*, unsigned));
655 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
656 static int parse_solitary_modifier
P_ ((Lisp_Object
));
657 static int parse_solitary_modifier ();
658 static void save_getcjmp
P_ ((jmp_buf));
659 static void save_getcjmp ();
660 static void restore_getcjmp
P_ ((jmp_buf));
661 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
662 static void clear_event
P_ ((struct input_event
*));
663 static void any_kboard_state
P_ ((void));
664 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
665 static void handle_interrupt
P_ ((void));
667 /* Nonzero means don't try to suspend even if the operating system seems
669 static int cannot_suspend
;
671 /* Install the string STR as the beginning of the string of echoing,
672 so that it serves as a prompt for the next character.
673 Also start echoing. */
679 current_kboard
->echo_string
= str
;
680 current_kboard
->echo_after_prompt
= SCHARS (str
);
684 /* Add C to the echo string, if echoing is going on.
685 C can be a character, which is printed prettily ("M-C-x" and all that
686 jazz), or a symbol, whose name is printed. */
692 if (current_kboard
->immediate_echo
)
694 int size
= KEY_DESCRIPTION_SIZE
+ 100;
695 char *buffer
= (char *) alloca (size
);
697 Lisp_Object echo_string
;
699 echo_string
= current_kboard
->echo_string
;
701 /* If someone has passed us a composite event, use its head symbol. */
706 ptr
= push_key_description (XINT (c
), ptr
, 1);
708 else if (SYMBOLP (c
))
710 Lisp_Object name
= SYMBOL_NAME (c
);
711 int nbytes
= SBYTES (name
);
713 if (size
- (ptr
- buffer
) < nbytes
)
715 int offset
= ptr
- buffer
;
716 size
= max (2 * size
, size
+ nbytes
);
717 buffer
= (char *) alloca (size
);
718 ptr
= buffer
+ offset
;
721 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
722 STRING_MULTIBYTE (name
), 1);
725 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
728 const char *text
= " (Type ? for further options)";
729 int len
= strlen (text
);
731 if (size
- (ptr
- buffer
) < len
)
733 int offset
= ptr
- buffer
;
735 buffer
= (char *) alloca (size
);
736 ptr
= buffer
+ offset
;
739 bcopy (text
, ptr
, len
);
743 /* Replace a dash from echo_dash with a space, otherwise
744 add a space at the end as a separator between keys. */
745 if (STRINGP (echo_string
)
746 && SCHARS (echo_string
) > 1)
748 Lisp_Object last_char
, prev_char
, idx
;
750 idx
= make_number (SCHARS (echo_string
) - 2);
751 prev_char
= Faref (echo_string
, idx
);
753 idx
= make_number (SCHARS (echo_string
) - 1);
754 last_char
= Faref (echo_string
, idx
);
756 /* We test PREV_CHAR to make sure this isn't the echoing
758 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
759 Faset (echo_string
, idx
, make_number (' '));
761 echo_string
= concat2 (echo_string
, build_string (" "));
764 current_kboard
->echo_string
765 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
771 /* Temporarily add a dash to the end of the echo string if it's not
772 empty, so that it serves as a mini-prompt for the very next character. */
777 /* Do nothing if not echoing at all. */
778 if (NILP (current_kboard
->echo_string
))
781 if (!current_kboard
->immediate_echo
782 && SCHARS (current_kboard
->echo_string
) == 0)
785 /* Do nothing if we just printed a prompt. */
786 if (current_kboard
->echo_after_prompt
787 == SCHARS (current_kboard
->echo_string
))
790 /* Put a dash at the end of the buffer temporarily,
791 but make it go away when the next character is added. */
792 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
797 /* Display the current echo string, and begin echoing if not already
803 if (!current_kboard
->immediate_echo
)
806 current_kboard
->immediate_echo
= 1;
808 for (i
= 0; i
< this_command_key_count
; i
++)
812 /* Set before_command_echo_length to the value that would
813 have been saved before the start of this subcommand in
814 command_loop_1, if we had already been echoing then. */
815 if (i
== this_single_command_key_start
)
816 before_command_echo_length
= echo_length ();
818 c
= XVECTOR (this_command_keys
)->contents
[i
];
819 if (! (EVENT_HAS_PARAMETERS (c
)
820 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
824 /* Set before_command_echo_length to the value that would
825 have been saved before the start of this subcommand in
826 command_loop_1, if we had already been echoing then. */
827 if (this_command_key_count
== this_single_command_key_start
)
828 before_command_echo_length
= echo_length ();
830 /* Put a dash at the end to invite the user to type more. */
835 message3_nolog (current_kboard
->echo_string
,
836 SBYTES (current_kboard
->echo_string
),
837 STRING_MULTIBYTE (current_kboard
->echo_string
));
840 /* Record in what buffer we echoed, and from which kboard. */
841 echo_message_buffer
= echo_area_buffer
[0];
842 echo_kboard
= current_kboard
;
844 if (waiting_for_input
&& !NILP (Vquit_flag
))
845 quit_throw_to_read_char ();
848 /* Turn off echoing, for the start of a new command. */
853 current_kboard
->immediate_echo
= 0;
854 current_kboard
->echo_after_prompt
= -1;
855 current_kboard
->echo_string
= Qnil
;
856 ok_to_echo_at_next_pause
= NULL
;
858 echo_message_buffer
= Qnil
;
861 /* Return the length of the current echo string. */
866 return (STRINGP (current_kboard
->echo_string
)
867 ? SCHARS (current_kboard
->echo_string
)
871 /* Truncate the current echo message to its first LEN chars.
872 This and echo_char get used by read_key_sequence when the user
873 switches frames while entering a key sequence. */
876 echo_truncate (nchars
)
879 if (STRINGP (current_kboard
->echo_string
))
880 current_kboard
->echo_string
881 = Fsubstring (current_kboard
->echo_string
,
882 make_number (0), make_number (nchars
));
883 truncate_echo_area (nchars
);
887 /* Functions for manipulating this_command_keys. */
889 add_command_key (key
)
892 #if 0 /* Not needed after we made Freset_this_command_lengths
893 do the job immediately. */
894 /* If reset-this-command-length was called recently, obey it now.
895 See the doc string of that function for an explanation of why. */
896 if (before_command_restore_flag
)
898 this_command_key_count
= before_command_key_count_1
;
899 if (this_command_key_count
< this_single_command_key_start
)
900 this_single_command_key_start
= this_command_key_count
;
901 echo_truncate (before_command_echo_length_1
);
902 before_command_restore_flag
= 0;
906 if (this_command_key_count
>= ASIZE (this_command_keys
))
907 this_command_keys
= larger_vector (this_command_keys
,
908 2 * ASIZE (this_command_keys
),
911 AREF (this_command_keys
, this_command_key_count
) = key
;
912 ++this_command_key_count
;
919 int count
= SPECPDL_INDEX ();
922 if (command_loop_level
> 0)
924 specbind (Qstandard_output
, Qt
);
925 specbind (Qstandard_input
, Qt
);
928 #ifdef HAVE_X_WINDOWS
929 /* The command loop has started an hourglass timer, so we have to
930 cancel it here, otherwise it will fire because the recursive edit
931 can take some time. Do not check for display_hourglass_p here,
932 because it could already be nil. */
936 /* This function may have been called from a debugger called from
937 within redisplay, for instance by Edebugging a function called
938 from fontification-functions. We want to allow redisplay in
939 the debugging session.
941 The recursive edit is left with a `(throw exit ...)'. The `exit'
942 tag is not caught anywhere in redisplay, i.e. when we leave the
943 recursive edit, the original redisplay leading to the recursive
944 edit will be unwound. The outcome should therefore be safe. */
945 specbind (Qinhibit_redisplay
, Qnil
);
948 val
= command_loop ();
950 Fsignal (Qquit
, Qnil
);
951 /* Handle throw from read_minibuf when using minibuffer
952 while it's active but we're in another window. */
954 Fsignal (Qerror
, Fcons (val
, Qnil
));
956 return unbind_to (count
, Qnil
);
959 /* When an auto-save happens, record the "time", and don't do again soon. */
964 last_auto_save
= num_nonmacro_input_events
;
967 /* Make an auto save happen as soon as possible at command level. */
970 force_auto_save_soon ()
972 last_auto_save
= - auto_save_interval
- 1;
974 record_asynch_buffer_change ();
977 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
978 doc
: /* Invoke the editor command loop recursively.
979 To get out of the recursive edit, a command can do `(throw 'exit nil)';
980 that tells this function to return.
981 Alternately, `(throw 'exit t)' makes this function signal an error.
982 This function is called by the editor initialization to begin editing. */)
985 int count
= SPECPDL_INDEX ();
988 command_loop_level
++;
989 update_mode_lines
= 1;
991 if (command_loop_level
992 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
993 buffer
= Fcurrent_buffer ();
997 /* If we leave recursive_edit_1 below with a `throw' for instance,
998 like it is done in the splash screen display, we have to
999 make sure that we restore single_kboard as command_loop_1
1000 would have done if it were left normally. */
1001 record_unwind_protect (recursive_edit_unwind
,
1002 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1004 recursive_edit_1 ();
1005 return unbind_to (count
, Qnil
);
1009 recursive_edit_unwind (info
)
1012 if (BUFFERP (XCAR (info
)))
1013 Fset_buffer (XCAR (info
));
1015 if (NILP (XCDR (info
)))
1016 any_kboard_state ();
1018 single_kboard_state ();
1020 command_loop_level
--;
1021 update_mode_lines
= 1;
1030 #if 0 /* Theory: if there's anything in Vunread_command_events,
1031 it will right away be read by read_key_sequence,
1032 and then if we do switch KBOARDS, it will go into the side
1033 queue then. So we don't need to do anything special here -- rms. */
1034 if (CONSP (Vunread_command_events
))
1036 current_kboard
->kbd_queue
1037 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1038 current_kboard
->kbd_queue_has_data
= 1;
1040 Vunread_command_events
= Qnil
;
1046 /* Switch to the single-kboard state, making current_kboard
1047 the only KBOARD from which further input is accepted. */
1050 single_kboard_state ()
1057 /* Maintain a stack of kboards, so other parts of Emacs
1058 can switch temporarily to the kboard of a given frame
1059 and then revert to the previous status. */
1064 struct kboard_stack
*next
;
1067 static struct kboard_stack
*kboard_stack
;
1070 push_frame_kboard (f
)
1074 struct kboard_stack
*p
1075 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1077 p
->next
= kboard_stack
;
1078 p
->kboard
= current_kboard
;
1081 current_kboard
= FRAME_KBOARD (f
);
1089 struct kboard_stack
*p
= kboard_stack
;
1090 current_kboard
= p
->kboard
;
1091 kboard_stack
= p
->next
;
1096 /* Handle errors that are not handled at inner levels
1097 by printing an error message and returning to the editor command loop. */
1103 Lisp_Object old_level
, old_length
;
1104 char macroerror
[50];
1106 #ifdef HAVE_X_WINDOWS
1107 if (display_hourglass_p
)
1108 cancel_hourglass ();
1111 if (!NILP (executing_macro
))
1113 if (executing_macro_iterations
== 1)
1114 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1116 sprintf (macroerror
, "After %d kbd macro iterations: ",
1117 executing_macro_iterations
);
1122 Vstandard_output
= Qt
;
1123 Vstandard_input
= Qt
;
1124 Vexecuting_macro
= Qnil
;
1125 executing_macro
= Qnil
;
1126 current_kboard
->Vprefix_arg
= Qnil
;
1127 current_kboard
->Vlast_prefix_arg
= Qnil
;
1130 /* Avoid unquittable loop if data contains a circular list. */
1131 old_level
= Vprint_level
;
1132 old_length
= Vprint_length
;
1133 XSETFASTINT (Vprint_level
, 10);
1134 XSETFASTINT (Vprint_length
, 10);
1135 cmd_error_internal (data
, macroerror
);
1136 Vprint_level
= old_level
;
1137 Vprint_length
= old_length
;
1141 Vinhibit_quit
= Qnil
;
1143 any_kboard_state ();
1146 return make_number (0);
1149 /* Take actions on handling an error. DATA is the data that describes
1152 CONTEXT is a C-string containing ASCII characters only which
1153 describes the context in which the error happened. If we need to
1154 generalize CONTEXT to allow multibyte characters, make it a Lisp
1158 cmd_error_internal (data
, context
)
1163 int kill_emacs_p
= 0;
1164 struct frame
*sf
= SELECTED_FRAME ();
1168 clear_message (1, 0);
1170 /* If the window system or terminal frame hasn't been initialized
1171 yet, or we're not interactive, it's best to dump this message out
1172 to stderr and exit. */
1173 if (!sf
->glyphs_initialized_p
1174 /* This is the case of the frame dumped with Emacs, when we're
1175 running under a window system. */
1176 || FRAME_INITIAL_P (sf
)
1179 stream
= Qexternal_debugging_output
;
1185 message_log_maybe_newline ();
1190 /* The immediate context is not interesting for Quits,
1191 since they are asyncronous. */
1192 if (EQ (XCAR (data
), Qquit
))
1193 Vsignaling_function
= Qnil
;
1195 print_error_message (data
, stream
, context
, Vsignaling_function
);
1197 Vsignaling_function
= Qnil
;
1199 /* If the window system or terminal frame hasn't been initialized
1200 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1204 Fkill_emacs (make_number (-1));
1208 Lisp_Object
command_loop_1 ();
1209 Lisp_Object
command_loop_2 ();
1210 Lisp_Object
top_level_1 ();
1212 /* Entry to editor-command-loop.
1213 This level has the catches for exiting/returning to editor command loop.
1214 It returns nil to exit recursive edit, t to abort it. */
1219 if (command_loop_level
> 0 || minibuf_level
> 0)
1222 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1223 executing_macro
= Qnil
;
1229 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1230 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1231 executing_macro
= Qnil
;
1233 /* End of file in -batch run causes exit here. */
1239 /* Here we catch errors in execution of commands within the
1240 editing loop, and reenter the editing loop.
1241 When there is an error, cmd_error runs and returns a non-nil
1242 value to us. A value of nil means that command_loop_1 itself
1243 returned due to end of file (or end of kbd macro). */
1248 register Lisp_Object val
;
1251 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1252 while (!NILP (val
));
1260 return Feval (Vtop_level
);
1266 /* On entry to the outer level, run the startup file */
1267 if (!NILP (Vtop_level
))
1268 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1269 else if (!NILP (Vpurify_flag
))
1270 message ("Bare impure Emacs (standard Lisp code not loaded)");
1272 message ("Bare Emacs (standard Lisp code not loaded)");
1276 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1277 doc
: /* Exit all recursive editing levels. */)
1280 #ifdef HAVE_X_WINDOWS
1281 if (display_hourglass_p
)
1282 cancel_hourglass ();
1284 return Fthrow (Qtop_level
, Qnil
);
1287 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1288 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1291 if (command_loop_level
> 0 || minibuf_level
> 0)
1292 Fthrow (Qexit
, Qnil
);
1294 error ("No recursive edit is in progress");
1298 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1299 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1302 if (command_loop_level
> 0 || minibuf_level
> 0)
1305 error ("No recursive edit is in progress");
1309 /* This is the actual command reading loop,
1310 sans error-handling encapsulation. */
1312 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1314 void safe_run_hooks
P_ ((Lisp_Object
));
1315 static void adjust_point_for_property
P_ ((int, int));
1317 /* Cancel hourglass from protect_unwind.
1319 #ifdef HAVE_X_WINDOWS
1321 cancel_hourglass_unwind (arg
)
1324 cancel_hourglass ();
1334 Lisp_Object keybuf
[30];
1338 struct buffer
*prev_buffer
= NULL
;
1340 int was_locked
= single_kboard
;
1342 int already_adjusted
;
1344 current_kboard
->Vprefix_arg
= Qnil
;
1345 current_kboard
->Vlast_prefix_arg
= Qnil
;
1346 Vdeactivate_mark
= Qnil
;
1347 waiting_for_input
= 0;
1351 this_command_key_count
= 0;
1352 this_command_key_count_reset
= 0;
1353 this_single_command_key_start
= 0;
1355 if (NILP (Vmemory_full
))
1357 /* Make sure this hook runs after commands that get errors and
1358 throw to top level. */
1359 /* Note that the value cell will never directly contain nil
1360 if the symbol is a local variable. */
1361 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1362 safe_run_hooks (Qpost_command_hook
);
1364 /* If displaying a message, resize the echo area window to fit
1365 that message's size exactly. */
1366 if (!NILP (echo_area_buffer
[0]))
1367 resize_echo_area_exactly ();
1369 if (!NILP (Vdeferred_action_list
))
1370 call0 (Vdeferred_action_function
);
1372 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1374 if (NILP (Vunread_command_events
)
1375 && NILP (Vunread_input_method_events
)
1376 && NILP (Vunread_post_input_method_events
)
1377 && NILP (Vexecuting_macro
)
1378 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1379 safe_run_hooks (Qpost_command_idle_hook
);
1383 Vmemory_full
= Qnil
;
1385 /* Do this after running Vpost_command_hook, for consistency. */
1386 current_kboard
->Vlast_command
= Vthis_command
;
1387 current_kboard
->Vreal_last_command
= real_this_command
;
1391 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1394 /* Make sure the current window's buffer is selected. */
1395 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1396 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1398 /* Display any malloc warning that just came out. Use while because
1399 displaying one warning can cause another. */
1401 while (pending_malloc_warning
)
1402 display_malloc_warning ();
1406 Vdeactivate_mark
= Qnil
;
1408 /* If minibuffer on and echo area in use,
1409 wait a short time and redraw minibuffer. */
1412 && !NILP (echo_area_buffer
[0])
1413 && EQ (minibuf_window
, echo_area_window
)
1414 && NUMBERP (Vminibuffer_message_timeout
))
1416 /* Bind inhibit-quit to t so that C-g gets read in
1417 rather than quitting back to the minibuffer. */
1418 int count
= SPECPDL_INDEX ();
1419 specbind (Qinhibit_quit
, Qt
);
1421 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1422 /* Clear the echo area. */
1424 safe_run_hooks (Qecho_area_clear_hook
);
1426 unbind_to (count
, Qnil
);
1428 /* If a C-g came in before, treat it as input now. */
1429 if (!NILP (Vquit_flag
))
1432 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1437 alloca (0); /* Cause a garbage collection now */
1438 /* Since we can free the most stuff here. */
1439 #endif /* C_ALLOCA */
1442 /* Select the frame that the last event came from. Usually,
1443 switch-frame events will take care of this, but if some lisp
1444 code swallows a switch-frame event, we'll fix things up here.
1445 Is this a good idea? */
1446 if (FRAMEP (internal_last_event_frame
)
1447 && !EQ (internal_last_event_frame
, selected_frame
))
1448 Fselect_frame (internal_last_event_frame
, Qnil
);
1450 /* If it has changed current-menubar from previous value,
1451 really recompute the menubar from the value. */
1452 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1453 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1454 call0 (Qrecompute_lucid_menubar
);
1456 before_command_key_count
= this_command_key_count
;
1457 before_command_echo_length
= echo_length ();
1459 Vthis_command
= Qnil
;
1460 real_this_command
= Qnil
;
1462 /* Read next key sequence; i gets its length. */
1463 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1466 /* A filter may have run while we were reading the input. */
1467 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1469 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1470 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1474 /* Now we have read a key sequence of length I,
1475 or else I is 0 and we found end of file. */
1477 if (i
== 0) /* End of file -- happens only in */
1478 return Qnil
; /* a kbd macro, at the end. */
1479 /* -1 means read_key_sequence got a menu that was rejected.
1480 Just loop around and read another command. */
1484 this_command_key_count
= 0;
1485 this_command_key_count_reset
= 0;
1486 this_single_command_key_start
= 0;
1490 last_command_char
= keybuf
[i
- 1];
1492 /* If the previous command tried to force a specific window-start,
1493 forget about that, in case this command moves point far away
1494 from that position. But also throw away beg_unchanged and
1495 end_unchanged information in that case, so that redisplay will
1496 update the whole window properly. */
1497 if (!NILP (XWINDOW (selected_window
)->force_start
))
1500 XWINDOW (selected_window
)->force_start
= Qnil
;
1501 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1502 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1505 cmd
= read_key_sequence_cmd
;
1506 if (!NILP (Vexecuting_macro
))
1508 if (!NILP (Vquit_flag
))
1510 Vexecuting_macro
= Qt
;
1511 QUIT
; /* Make some noise. */
1512 /* Will return since macro now empty. */
1516 /* Do redisplay processing after this command except in special
1517 cases identified below. */
1518 prev_buffer
= current_buffer
;
1519 prev_modiff
= MODIFF
;
1520 last_point_position
= PT
;
1521 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1523 /* By default, we adjust point to a boundary of a region that
1524 has such a property that should be treated intangible
1525 (e.g. composition, display). But, some commands will set
1526 this variable differently. */
1527 Vdisable_point_adjustment
= Qnil
;
1529 /* Process filters and timers may have messed with deactivate-mark.
1530 reset it before we execute the command. */
1531 Vdeactivate_mark
= Qnil
;
1533 /* Remap command through active keymaps */
1534 Vthis_original_command
= cmd
;
1538 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1542 /* Execute the command. */
1544 Vthis_command
= cmd
;
1545 real_this_command
= cmd
;
1546 /* Note that the value cell will never directly contain nil
1547 if the symbol is a local variable. */
1548 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1549 safe_run_hooks (Qpre_command_hook
);
1551 already_adjusted
= 0;
1553 if (NILP (Vthis_command
))
1555 /* nil means key is undefined. */
1557 current_kboard
->defining_kbd_macro
= Qnil
;
1558 update_mode_lines
= 1;
1559 current_kboard
->Vprefix_arg
= Qnil
;
1563 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1565 /* In case we jump to directly_done. */
1566 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1568 /* Recognize some common commands in common situations and
1569 do them directly. */
1570 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1572 struct Lisp_Char_Table
*dp
1573 = window_display_table (XWINDOW (selected_window
));
1574 lose
= FETCH_CHAR (PT_BYTE
);
1576 if (! NILP (Vpost_command_hook
))
1577 /* Put this before calling adjust_point_for_property
1578 so it will only get called once in any case. */
1580 if (current_buffer
== prev_buffer
1581 && last_point_position
!= PT
1582 && NILP (Vdisable_point_adjustment
)
1583 && NILP (Vglobal_disable_point_adjustment
))
1584 adjust_point_for_property (last_point_position
, 0);
1585 already_adjusted
= 1;
1586 if (PT
== last_point_position
+ 1
1588 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1589 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1590 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1591 && (lose
>= 0x20 && lose
< 0x7f)))
1592 : (lose
>= 0x20 && lose
< 0x7f))
1593 /* To extract the case of continuation on
1594 wide-column characters. */
1595 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1596 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1598 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1600 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1602 && !windows_or_buffers_changed
1603 && EQ (current_buffer
->selective_display
, Qnil
)
1604 && !detect_input_pending ()
1605 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1606 && NILP (Vexecuting_macro
))
1607 direct_output_forward_char (1);
1610 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1612 struct Lisp_Char_Table
*dp
1613 = window_display_table (XWINDOW (selected_window
));
1615 lose
= FETCH_CHAR (PT_BYTE
);
1616 if (! NILP (Vpost_command_hook
))
1618 if (current_buffer
== prev_buffer
1619 && last_point_position
!= PT
1620 && NILP (Vdisable_point_adjustment
)
1621 && NILP (Vglobal_disable_point_adjustment
))
1622 adjust_point_for_property (last_point_position
, 0);
1623 already_adjusted
= 1;
1624 if (PT
== last_point_position
- 1
1626 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1627 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1628 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1629 && (lose
>= 0x20 && lose
< 0x7f)))
1630 : (lose
>= 0x20 && lose
< 0x7f))
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
, Qself_insert_command
)
1646 /* Try this optimization only on char keystrokes. */
1647 && NATNUMP (last_command_char
)
1648 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1651 = translate_char (Vtranslation_table_for_input
,
1652 XFASTINT (last_command_char
), 0, 0, 0);
1654 if (NILP (Vexecuting_macro
)
1655 && !EQ (minibuf_window
, selected_window
))
1657 if (!nonundocount
|| nonundocount
>= 20)
1665 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1667 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1669 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1671 || MODIFF
<= SAVE_MODIFF
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
));
1678 value
= internal_self_insert (c
, 0);
1683 if (! NILP (Vpost_command_hook
))
1684 /* Put this before calling adjust_point_for_property
1685 so it will only get called once in any case. */
1688 /* VALUE == 1 when AFTER-CHANGE functions are
1689 installed which is the case most of the time
1690 because FONT-LOCK installs one. */
1691 if (!lose
&& !value
)
1692 direct_output_for_insert (c
);
1697 /* Here for a command that isn't executed directly */
1700 #ifdef HAVE_X_WINDOWS
1701 int scount
= SPECPDL_INDEX ();
1703 if (display_hourglass_p
1704 && NILP (Vexecuting_macro
))
1706 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1712 if (NILP (current_kboard
->Vprefix_arg
))
1714 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1716 #ifdef HAVE_X_WINDOWS
1717 /* Do not check display_hourglass_p here, because
1718 Fcommand_execute could change it, but we should cancel
1719 hourglass cursor anyway.
1720 But don't cancel the hourglass within a macro
1721 just because a command in the macro finishes. */
1722 if (NILP (Vexecuting_macro
))
1723 unbind_to (scount
, Qnil
);
1728 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1730 /* Note that the value cell will never directly contain nil
1731 if the symbol is a local variable. */
1732 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1733 safe_run_hooks (Qpost_command_hook
);
1735 /* If displaying a message, resize the echo area window to fit
1736 that message's size exactly. */
1737 if (!NILP (echo_area_buffer
[0]))
1738 resize_echo_area_exactly ();
1740 if (!NILP (Vdeferred_action_list
))
1741 safe_run_hooks (Qdeferred_action_function
);
1743 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1745 if (NILP (Vunread_command_events
)
1746 && NILP (Vunread_input_method_events
)
1747 && NILP (Vunread_post_input_method_events
)
1748 && NILP (Vexecuting_macro
)
1749 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1750 safe_run_hooks (Qpost_command_idle_hook
);
1753 /* If there is a prefix argument,
1754 1) We don't want Vlast_command to be ``universal-argument''
1755 (that would be dumb), so don't set Vlast_command,
1756 2) we want to leave echoing on so that the prefix will be
1757 echoed as part of this key sequence, so don't call
1759 3) we want to leave this_command_key_count non-zero, so that
1760 read_char will realize that it is re-reading a character, and
1761 not echo it a second time.
1763 If the command didn't actually create a prefix arg,
1764 but is merely a frame event that is transparent to prefix args,
1765 then the above doesn't apply. */
1766 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1768 current_kboard
->Vlast_command
= Vthis_command
;
1769 current_kboard
->Vreal_last_command
= real_this_command
;
1771 this_command_key_count
= 0;
1772 this_command_key_count_reset
= 0;
1773 this_single_command_key_start
= 0;
1776 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1778 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1780 /* We could also call `deactivate'mark'. */
1781 if (EQ (Vtransient_mark_mode
, Qlambda
))
1782 Vtransient_mark_mode
= Qnil
;
1785 current_buffer
->mark_active
= Qnil
;
1786 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1789 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1790 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1795 if (current_buffer
== prev_buffer
1796 && last_point_position
!= PT
1797 && NILP (Vdisable_point_adjustment
)
1798 && NILP (Vglobal_disable_point_adjustment
)
1799 && !already_adjusted
)
1800 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1802 /* Install chars successfully executed in kbd macro. */
1804 if (!NILP (current_kboard
->defining_kbd_macro
)
1805 && NILP (current_kboard
->Vprefix_arg
))
1806 finalize_kbd_macro_chars ();
1810 any_kboard_state ();
1815 extern Lisp_Object Qcomposition
, Qdisplay
;
1817 /* Adjust point to a boundary of a region that has such a property
1818 that should be treated intangible. For the moment, we check
1819 `composition', `display' and `invisible' properties.
1820 LAST_PT is the last position of point. */
1822 extern Lisp_Object Qafter_string
, Qbefore_string
;
1823 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1826 adjust_point_for_property (last_pt
, modified
)
1831 Lisp_Object val
, overlay
, tmp
;
1832 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1835 /* FIXME: cycling is probably not necessary because these properties
1836 can't be usefully combined anyway. */
1837 while (check_composition
|| check_display
|| check_invisible
)
1839 if (check_composition
1840 && PT
> BEGV
&& PT
< ZV
1841 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1842 && COMPOSITION_VALID_P (beg
, end
, val
)
1843 && beg
< PT
/* && end > PT <- It's always the case. */
1844 && (last_pt
<= beg
|| last_pt
>= end
))
1847 SET_PT (PT
< last_pt
? beg
: end
);
1848 check_display
= check_invisible
= 1;
1850 check_composition
= 0;
1852 && PT
> BEGV
&& PT
< ZV
1853 && !NILP (val
= get_char_property_and_overlay
1854 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1855 && display_prop_intangible_p (val
)
1856 && (!OVERLAYP (overlay
)
1857 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1858 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1859 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1860 && beg
< PT
) /* && end > PT <- It's always the case. */
1863 SET_PT (PT
< last_pt
? beg
: end
);
1864 check_composition
= check_invisible
= 1;
1867 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1869 int inv
, ellipsis
= 0;
1872 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1874 && !NILP (val
= get_char_property_and_overlay
1875 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1876 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1878 ellipsis
= ellipsis
|| inv
> 1
1879 || (OVERLAYP (overlay
)
1880 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1881 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1882 tmp
= Fnext_single_char_property_change
1883 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1884 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1887 && !NILP (val
= get_char_property_and_overlay
1888 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1889 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1891 ellipsis
= ellipsis
|| inv
> 1
1892 || (OVERLAYP (overlay
)
1893 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1894 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1895 tmp
= Fprevious_single_char_property_change
1896 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1897 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1900 /* Move away from the inside area. */
1901 if (beg
< PT
&& end
> PT
)
1903 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1904 /* We haven't moved yet (so we don't need to fear
1905 infinite-looping) and we were outside the range
1906 before (so either end of the range still corresponds
1907 to a move in the right direction): pretend we moved
1908 less than we actually did, so that we still have
1909 more freedom below in choosing which end of the range
1911 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1912 /* We either have moved already or the last point
1913 was already in the range: we don't get to choose
1914 which end of the range we have to go to. */
1915 : (PT
< last_pt
? beg
: end
));
1916 check_composition
= check_display
= 1;
1918 xassert (PT
== beg
|| PT
== end
);
1919 /* Pretend the area doesn't exist if the buffer is not
1921 if (!modified
&& !ellipsis
&& beg
< end
)
1923 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1924 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1925 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1926 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1927 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1928 /* We've already moved as far as we can. Trying to go
1929 to the other end would mean moving backwards and thus
1930 could lead to an infinite loop. */
1932 else if (val
= get_pos_property (make_number (PT
),
1934 TEXT_PROP_MEANS_INVISIBLE (val
)
1935 && (val
= get_pos_property
1936 (make_number (PT
== beg
? end
: beg
),
1938 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1939 (check_composition
= check_display
= 1,
1940 SET_PT (PT
== beg
? end
: beg
));
1943 check_invisible
= 0;
1947 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1950 safe_run_hooks_1 (hook
)
1953 return call1 (Vrun_hooks
, Vinhibit_quit
);
1956 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1959 safe_run_hooks_error (data
)
1962 Lisp_Object args
[3];
1963 args
[0] = build_string ("Error in %s: %s");
1964 args
[1] = Vinhibit_quit
;
1967 return Fset (Vinhibit_quit
, Qnil
);
1970 /* If we get an error while running the hook, cause the hook variable
1971 to be nil. Also inhibit quits, so that C-g won't cause the hook
1972 to mysteriously evaporate. */
1975 safe_run_hooks (hook
)
1978 int count
= SPECPDL_INDEX ();
1979 specbind (Qinhibit_quit
, hook
);
1981 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1983 unbind_to (count
, Qnil
);
1987 /* Number of seconds between polling for input. This is a Lisp
1988 variable that can be bound. */
1990 EMACS_INT polling_period
;
1992 /* Nonzero means polling for input is temporarily suppressed. */
1994 int poll_suppress_count
;
1996 /* Asynchronous timer for polling. */
1998 struct atimer
*poll_timer
;
2001 #ifdef POLL_FOR_INPUT
2003 /* Poll for input, so what we catch a C-g if it comes in. This
2004 function is called from x_make_frame_visible, see comment
2010 if (interrupt_input_blocked
== 0
2011 && !waiting_for_input
)
2012 read_avail_input (0);
2015 /* Timer callback function for poll_timer. TIMER is equal to
2019 poll_for_input (timer
)
2020 struct atimer
*timer
;
2022 if (poll_suppress_count
== 0)
2023 poll_for_input_1 ();
2026 #endif /* POLL_FOR_INPUT */
2028 /* Begin signals to poll for input, if they are appropriate.
2029 This function is called unconditionally from various places. */
2034 #ifdef POLL_FOR_INPUT
2035 /* XXX This condition was (read_socket_hook && !interrupt_input),
2036 but read_socket_hook is not global anymore. Let's pretend that
2038 if (!interrupt_input
)
2040 /* Turn alarm handling on unconditionally. It might have
2041 been turned off in process.c. */
2042 turn_on_atimers (1);
2044 /* If poll timer doesn't exist, are we need one with
2045 a different interval, start a new one. */
2046 if (poll_timer
== NULL
2047 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2049 EMACS_TIME interval
;
2052 cancel_atimer (poll_timer
);
2054 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2055 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2056 poll_for_input
, NULL
);
2059 /* Let the timer's callback function poll for input
2060 if this becomes zero. */
2061 --poll_suppress_count
;
2066 /* Nonzero if we are using polling to handle input asynchronously. */
2069 input_polling_used ()
2071 #ifdef POLL_FOR_INPUT
2072 /* XXX This condition was (read_socket_hook && !interrupt_input),
2073 but read_socket_hook is not global anymore. Let's pretend that
2075 return !interrupt_input
;
2081 /* Turn off polling. */
2086 #ifdef POLL_FOR_INPUT
2087 /* XXX This condition was (read_socket_hook && !interrupt_input),
2088 but read_socket_hook is not global anymore. Let's pretend that
2090 if (!interrupt_input
)
2091 ++poll_suppress_count
;
2095 /* Set the value of poll_suppress_count to COUNT
2096 and start or stop polling accordingly. */
2099 set_poll_suppress_count (count
)
2102 #ifdef POLL_FOR_INPUT
2103 if (count
== 0 && poll_suppress_count
!= 0)
2105 poll_suppress_count
= 1;
2108 else if (count
!= 0 && poll_suppress_count
== 0)
2112 poll_suppress_count
= count
;
2116 /* Bind polling_period to a value at least N.
2117 But don't decrease it. */
2120 bind_polling_period (n
)
2123 #ifdef POLL_FOR_INPUT
2124 int new = polling_period
;
2129 stop_other_atimers (poll_timer
);
2131 specbind (Qpolling_period
, make_number (new));
2132 /* Start a new alarm with the new period. */
2137 /* Apply the control modifier to CHARACTER. */
2143 /* Save the upper bits here. */
2144 int upper
= c
& ~0177;
2148 /* Everything in the columns containing the upper-case letters
2149 denotes a control character. */
2150 if (c
>= 0100 && c
< 0140)
2154 /* Set the shift modifier for a control char
2155 made from a shifted letter. But only for letters! */
2156 if (oc
>= 'A' && oc
<= 'Z')
2157 c
|= shift_modifier
;
2160 /* The lower-case letters denote control characters too. */
2161 else if (c
>= 'a' && c
<= 'z')
2164 /* Include the bits for control and shift
2165 only if the basic ASCII code can't indicate them. */
2169 /* Replace the high bits. */
2170 c
|= (upper
& ~ctrl_modifier
);
2175 /* Display help echo in the echo area.
2177 HELP a string means display that string, HELP nil means clear the
2178 help echo. If HELP is a function, call it with OBJECT and POS as
2179 arguments; the function should return a help string or nil for
2180 none. For all other types of HELP evaluate it to obtain a string.
2182 WINDOW is the window in which the help was generated, if any.
2183 It is nil if not in a window.
2185 If OBJECT is a buffer, POS is the position in the buffer where the
2186 `help-echo' text property was found.
2188 If OBJECT is an overlay, that overlay has a `help-echo' property,
2189 and POS is the position in the overlay's buffer under the mouse.
2191 If OBJECT is a string (an overlay string or a string displayed with
2192 the `display' property). POS is the position in that string under
2195 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2196 echo overwrites a keystroke echo currently displayed in the echo
2199 Note: this function may only be called with HELP nil or a string
2200 from X code running asynchronously. */
2203 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2204 Lisp_Object help
, window
, object
, pos
;
2205 int ok_to_overwrite_keystroke_echo
;
2207 if (!NILP (help
) && !STRINGP (help
))
2209 if (FUNCTIONP (help
))
2211 Lisp_Object args
[4];
2216 help
= safe_call (4, args
);
2219 help
= safe_eval (help
);
2221 if (!STRINGP (help
))
2225 if (STRINGP (help
) || NILP (help
))
2227 if (!NILP (Vshow_help_function
))
2228 call1 (Vshow_help_function
, help
);
2229 else if (/* Don't overwrite minibuffer contents. */
2230 !MINI_WINDOW_P (XWINDOW (selected_window
))
2231 /* Don't overwrite a keystroke echo. */
2232 && (NILP (echo_message_buffer
)
2233 || ok_to_overwrite_keystroke_echo
)
2234 /* Don't overwrite a prompt. */
2235 && !cursor_in_echo_area
)
2239 int count
= SPECPDL_INDEX ();
2241 if (!help_echo_showing_p
)
2242 Vpre_help_message
= current_message ();
2244 specbind (Qmessage_truncate_lines
, Qt
);
2245 message3_nolog (help
, SBYTES (help
),
2246 STRING_MULTIBYTE (help
));
2247 unbind_to (count
, Qnil
);
2249 else if (STRINGP (Vpre_help_message
))
2251 message3_nolog (Vpre_help_message
,
2252 SBYTES (Vpre_help_message
),
2253 STRING_MULTIBYTE (Vpre_help_message
));
2254 Vpre_help_message
= Qnil
;
2260 help_echo_showing_p
= STRINGP (help
);
2266 /* Input of single characters from keyboard */
2268 Lisp_Object
print_help ();
2269 static Lisp_Object
kbd_buffer_get_event ();
2270 static void record_char ();
2273 static jmp_buf wrong_kboard_jmpbuf
;
2276 #define STOP_POLLING \
2277 do { if (! polling_stopped_here) stop_polling (); \
2278 polling_stopped_here = 1; } while (0)
2280 #define RESUME_POLLING \
2281 do { if (polling_stopped_here) start_polling (); \
2282 polling_stopped_here = 0; } while (0)
2284 /* read a character from the keyboard; call the redisplay if needed */
2285 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2286 -1 means do not do redisplay, but do do autosaving.
2289 /* The arguments MAPS and NMAPS are for menu prompting.
2290 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2292 PREV_EVENT is the previous input event, or nil if we are reading
2293 the first event of a key sequence (or not reading a key sequence).
2294 If PREV_EVENT is t, that is a "magic" value that says
2295 not to run input methods, but in other respects to act as if
2296 not reading a key sequence.
2298 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2299 if we used a mouse menu to read the input, or zero otherwise. If
2300 USED_MOUSE_MENU is null, we don't dereference it.
2302 Value is t if we showed a menu and the user rejected it. */
2305 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2309 Lisp_Object prev_event
;
2310 int *used_mouse_menu
;
2312 volatile Lisp_Object c
;
2314 jmp_buf local_getcjmp
;
2316 volatile int key_already_recorded
= 0;
2317 Lisp_Object tem
, save
;
2318 volatile Lisp_Object previous_echo_area_message
;
2319 volatile Lisp_Object also_record
;
2320 volatile int reread
;
2321 struct gcpro gcpro1
, gcpro2
;
2322 EMACS_TIME last_idle_start
;
2323 int polling_stopped_here
= 0;
2327 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2328 before_command_key_count
= this_command_key_count
;
2329 before_command_echo_length
= echo_length ();
2332 previous_echo_area_message
= Qnil
;
2334 GCPRO2 (c
, previous_echo_area_message
);
2339 if (CONSP (Vunread_post_input_method_events
))
2341 c
= XCAR (Vunread_post_input_method_events
);
2342 Vunread_post_input_method_events
2343 = XCDR (Vunread_post_input_method_events
);
2345 /* Undo what read_char_x_menu_prompt did when it unread
2346 additional keys returned by Fx_popup_menu. */
2348 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2356 if (unread_command_char
!= -1)
2358 XSETINT (c
, unread_command_char
);
2359 unread_command_char
= -1;
2365 if (CONSP (Vunread_command_events
))
2367 c
= XCAR (Vunread_command_events
);
2368 Vunread_command_events
= XCDR (Vunread_command_events
);
2370 /* Undo what read_char_x_menu_prompt did when it unread
2371 additional keys returned by Fx_popup_menu. */
2373 && EQ (XCDR (c
), Qdisabled
)
2374 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2377 /* If the queued event is something that used the mouse,
2378 set used_mouse_menu accordingly. */
2380 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2381 *used_mouse_menu
= 1;
2384 goto reread_for_input_method
;
2387 if (CONSP (Vunread_input_method_events
))
2389 c
= XCAR (Vunread_input_method_events
);
2390 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2392 /* Undo what read_char_x_menu_prompt did when it unread
2393 additional keys returned by Fx_popup_menu. */
2395 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2399 goto reread_for_input_method
;
2402 this_command_key_count_reset
= 0;
2404 if (!NILP (Vexecuting_macro
))
2406 /* We set this to Qmacro; since that's not a frame, nobody will
2407 try to switch frames on us, and the selected window will
2410 Since this event came from a macro, it would be misleading to
2411 leave internal_last_event_frame set to wherever the last
2412 real event came from. Normally, a switch-frame event selects
2413 internal_last_event_frame after each command is read, but
2414 events read from a macro should never cause a new frame to be
2416 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2418 /* Exit the macro if we are at the end.
2419 Also, some things replace the macro with t
2420 to force an early exit. */
2421 if (EQ (Vexecuting_macro
, Qt
)
2422 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2428 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2429 if (STRINGP (Vexecuting_macro
)
2430 && (XINT (c
) & 0x80))
2431 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2433 executing_macro_index
++;
2438 if (!NILP (unread_switch_frame
))
2440 c
= unread_switch_frame
;
2441 unread_switch_frame
= Qnil
;
2443 /* This event should make it into this_command_keys, and get echoed
2444 again, so we do not set `reread'. */
2448 /* if redisplay was requested */
2449 if (commandflag
>= 0)
2451 /* If there is pending input, process any events which are not
2452 user-visible, such as X selection_request events. */
2454 || detect_input_pending_run_timers (0))
2455 swallow_events (0); /* may clear input_pending */
2457 /* Redisplay if no pending input. */
2458 while (!input_pending
)
2460 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2461 redisplay_preserve_echo_area (5);
2466 /* Normal case: no input arrived during redisplay. */
2469 /* Input arrived and pre-empted redisplay.
2470 Process any events which are not user-visible. */
2472 /* If that cleared input_pending, try again to redisplay. */
2476 /* Message turns off echoing unless more keystrokes turn it on again.
2478 The code in 20.x for the condition was
2480 1. echo_area_glyphs && *echo_area_glyphs
2481 2. && echo_area_glyphs != current_kboard->echobuf
2482 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2484 (1) means there's a current message displayed
2486 (2) means it's not the message from echoing from the current
2489 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2490 is set to a non-null value. This is done in read_char and it is
2491 set to echo_area_glyphs after a call to echo_char. That means
2492 ok_to_echo_at_next_pause is either null or
2493 current_kboard->echobuf with the appropriate current_kboard at
2496 So, condition (3) means in clear text ok_to_echo_at_next_pause
2497 must be either null, or the current message isn't from echoing at
2498 all, or it's from echoing from a different kboard than the
2501 if (/* There currently is something in the echo area. */
2502 !NILP (echo_area_buffer
[0])
2503 && (/* And it's either not from echoing. */
2504 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2505 /* Or it's an echo from a different kboard. */
2506 || echo_kboard
!= current_kboard
2507 /* Or we explicitly allow overwriting whatever there is. */
2508 || ok_to_echo_at_next_pause
== NULL
))
2513 /* Try reading a character via menu prompting in the minibuf.
2514 Try this before the sit-for, because the sit-for
2515 would do the wrong thing if we are supposed to do
2516 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2517 after a mouse event so don't try a minibuf menu. */
2519 if (nmaps
> 0 && INTERACTIVE
2520 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2521 /* Don't bring up a menu if we already have another event. */
2522 && NILP (Vunread_command_events
)
2523 && unread_command_char
< 0
2524 && !detect_input_pending_run_timers (0))
2526 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2529 key_already_recorded
= 1;
2534 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2535 We will do that below, temporarily for short sections of code,
2536 when appropriate. local_getcjmp must be in effect
2537 around any call to sit_for or kbd_buffer_get_event;
2538 it *must not* be in effect when we call redisplay. */
2540 if (_setjmp (local_getcjmp
))
2542 XSETINT (c
, quit_char
);
2543 internal_last_event_frame
= selected_frame
;
2544 Vlast_event_frame
= internal_last_event_frame
;
2545 /* If we report the quit char as an event,
2546 don't do so more than once. */
2547 if (!NILP (Vinhibit_quit
))
2552 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2553 if (kb
!= current_kboard
)
2555 Lisp_Object link
= kb
->kbd_queue
;
2556 /* We shouldn't get here if we were in single-kboard mode! */
2561 while (CONSP (XCDR (link
)))
2563 if (!NILP (XCDR (link
)))
2567 kb
->kbd_queue
= Fcons (c
, Qnil
);
2569 XSETCDR (link
, Fcons (c
, Qnil
));
2570 kb
->kbd_queue_has_data
= 1;
2571 current_kboard
= kb
;
2572 /* This is going to exit from read_char
2573 so we had better get rid of this frame's stuff. */
2575 longjmp (wrong_kboard_jmpbuf
, 1);
2582 timer_start_idle ();
2584 /* If in middle of key sequence and minibuffer not active,
2585 start echoing if enough time elapses. */
2587 if (minibuf_level
== 0
2588 && !current_kboard
->immediate_echo
2589 && this_command_key_count
> 0
2591 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2592 && NILP (Fzerop (Vecho_keystrokes
))
2593 && (/* No message. */
2594 NILP (echo_area_buffer
[0])
2595 /* Or empty message. */
2596 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2597 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2598 /* Or already echoing from same kboard. */
2599 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2600 /* Or not echoing before and echoing allowed. */
2601 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2605 /* After a mouse event, start echoing right away.
2606 This is because we are probably about to display a menu,
2607 and we don't want to delay before doing so. */
2608 if (EVENT_HAS_PARAMETERS (prev_event
))
2613 double duration
= extract_float (Vecho_keystrokes
);
2614 sec
= (int) duration
;
2615 usec
= (duration
- sec
) * 1000000;
2616 save_getcjmp (save_jump
);
2617 restore_getcjmp (local_getcjmp
);
2618 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2619 restore_getcjmp (save_jump
);
2621 && ! CONSP (Vunread_command_events
))
2626 /* Maybe auto save due to number of keystrokes. */
2628 if (commandflag
!= 0
2629 && auto_save_interval
> 0
2630 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2631 && !detect_input_pending_run_timers (0))
2633 Fdo_auto_save (Qnil
, Qnil
);
2634 /* Hooks can actually change some buffers in auto save. */
2638 /* Try reading using an X menu.
2639 This is never confused with reading using the minibuf
2640 because the recursive call of read_char in read_char_minibuf_menu_prompt
2641 does not pass on any keymaps. */
2643 if (nmaps
> 0 && INTERACTIVE
2644 && !NILP (prev_event
)
2645 && EVENT_HAS_PARAMETERS (prev_event
)
2646 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2647 && !EQ (XCAR (prev_event
), Qtool_bar
)
2648 /* Don't bring up a menu if we already have another event. */
2649 && NILP (Vunread_command_events
)
2650 && unread_command_char
< 0)
2652 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2654 /* Now that we have read an event, Emacs is not idle. */
2660 /* Maybe autosave and/or garbage collect due to idleness. */
2662 if (INTERACTIVE
&& NILP (c
))
2664 int delay_level
, buffer_size
;
2666 /* Slow down auto saves logarithmically in size of current buffer,
2667 and garbage collect while we're at it. */
2668 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2669 last_non_minibuf_size
= Z
- BEG
;
2670 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2672 while (buffer_size
> 64)
2673 delay_level
++, buffer_size
-= buffer_size
>> 2;
2674 if (delay_level
< 4) delay_level
= 4;
2675 /* delay_level is 4 for files under around 50k, 7 at 100k,
2676 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2678 /* Auto save if enough time goes by without input. */
2679 if (commandflag
!= 0
2680 && num_nonmacro_input_events
> last_auto_save
2681 && INTEGERP (Vauto_save_timeout
)
2682 && XINT (Vauto_save_timeout
) > 0)
2686 save_getcjmp (save_jump
);
2687 restore_getcjmp (local_getcjmp
);
2688 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2690 restore_getcjmp (save_jump
);
2693 && ! CONSP (Vunread_command_events
))
2695 Fdo_auto_save (Qnil
, Qnil
);
2697 /* If we have auto-saved and there is still no input
2698 available, garbage collect if there has been enough
2699 consing going on to make it worthwhile. */
2700 if (!detect_input_pending_run_timers (0)
2701 && consing_since_gc
> gc_cons_threshold
/ 2)
2702 Fgarbage_collect ();
2709 /* If this has become non-nil here, it has been set by a timer
2710 or sentinel or filter. */
2711 if (CONSP (Vunread_command_events
))
2713 c
= XCAR (Vunread_command_events
);
2714 Vunread_command_events
= XCDR (Vunread_command_events
);
2717 /* Read something from current KBOARD's side queue, if possible. */
2721 if (current_kboard
->kbd_queue_has_data
)
2723 if (!CONSP (current_kboard
->kbd_queue
))
2725 c
= XCAR (current_kboard
->kbd_queue
);
2726 current_kboard
->kbd_queue
2727 = XCDR (current_kboard
->kbd_queue
);
2728 if (NILP (current_kboard
->kbd_queue
))
2729 current_kboard
->kbd_queue_has_data
= 0;
2730 input_pending
= readable_events (0);
2731 if (EVENT_HAS_PARAMETERS (c
)
2732 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2733 internal_last_event_frame
= XCAR (XCDR (c
));
2734 Vlast_event_frame
= internal_last_event_frame
;
2739 /* If current_kboard's side queue is empty check the other kboards.
2740 If one of them has data that we have not yet seen here,
2741 switch to it and process the data waiting for it.
2743 Note: if the events queued up for another kboard
2744 have already been seen here, and therefore are not a complete command,
2745 the kbd_queue_has_data field is 0, so we skip that kboard here.
2746 That's to avoid an infinite loop switching between kboards here. */
2747 if (NILP (c
) && !single_kboard
)
2750 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2751 if (kb
->kbd_queue_has_data
)
2753 current_kboard
= kb
;
2754 /* This is going to exit from read_char
2755 so we had better get rid of this frame's stuff. */
2757 longjmp (wrong_kboard_jmpbuf
, 1);
2766 /* Finally, we read from the main queue,
2767 and if that gives us something we can't use yet, we put it on the
2768 appropriate side queue and try again. */
2774 /* Actually read a character, waiting if necessary. */
2775 save_getcjmp (save_jump
);
2776 restore_getcjmp (local_getcjmp
);
2777 timer_start_idle ();
2778 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2779 restore_getcjmp (save_jump
);
2782 if (! NILP (c
) && (kb
!= current_kboard
))
2784 Lisp_Object link
= kb
->kbd_queue
;
2787 while (CONSP (XCDR (link
)))
2789 if (!NILP (XCDR (link
)))
2793 kb
->kbd_queue
= Fcons (c
, Qnil
);
2795 XSETCDR (link
, Fcons (c
, Qnil
));
2796 kb
->kbd_queue_has_data
= 1;
2800 current_kboard
= kb
;
2801 /* This is going to exit from read_char
2802 so we had better get rid of this frame's stuff. */
2804 longjmp (wrong_kboard_jmpbuf
, 1);
2809 /* Terminate Emacs in batch mode if at eof. */
2810 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2811 Fkill_emacs (make_number (1));
2815 /* Add in any extra modifiers, where appropriate. */
2816 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2817 || ((extra_keyboard_modifiers
& 0177) < ' '
2818 && (extra_keyboard_modifiers
& 0177) != 0))
2819 XSETINT (c
, make_ctrl_char (XINT (c
)));
2821 /* Transfer any other modifier bits directly from
2822 extra_keyboard_modifiers to c. Ignore the actual character code
2823 in the low 16 bits of extra_keyboard_modifiers. */
2824 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2829 /* Record the last idle start time so that we can reset it
2830 should the next event read be a help-echo. */
2831 last_idle_start
= timer_idleness_start_time
;
2837 if (commandflag
>= 0
2838 && !input_pending
&& !detect_input_pending_run_timers (0))
2846 /* Buffer switch events are only for internal wakeups
2847 so don't show them to the user.
2848 Also, don't record a key if we already did. */
2849 if (BUFFERP (c
) || key_already_recorded
)
2852 /* Process special events within read_char
2853 and loop around to read another event. */
2856 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2861 int was_locked
= single_kboard
;
2863 last_input_char
= c
;
2864 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2866 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2867 /* We stopped being idle for this event; undo that. This
2868 prevents automatic window selection (under
2869 mouse_autoselect_window from acting as a real input event, for
2870 example banishing the mouse under mouse-avoidance-mode. */
2871 timer_idleness_start_time
= last_idle_start
;
2873 /* Resume allowing input from any kboard, if that was true before. */
2875 any_kboard_state ();
2880 /* Handle things that only apply to characters. */
2883 /* If kbd_buffer_get_event gave us an EOF, return that. */
2887 if ((STRINGP (Vkeyboard_translate_table
)
2888 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2889 || (VECTORP (Vkeyboard_translate_table
)
2890 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2891 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2892 && CHAR_VALID_P (XINT (c
), 0)))
2895 d
= Faref (Vkeyboard_translate_table
, c
);
2896 /* nil in keyboard-translate-table means no translation. */
2902 /* If this event is a mouse click in the menu bar,
2903 return just menu-bar for now. Modify the mouse click event
2904 so we won't do this twice, then queue it up. */
2905 if (EVENT_HAS_PARAMETERS (c
)
2907 && CONSP (EVENT_START (c
))
2908 && CONSP (XCDR (EVENT_START (c
))))
2912 posn
= POSN_POSN (EVENT_START (c
));
2913 /* Handle menu-bar events:
2914 insert the dummy prefix event `menu-bar'. */
2915 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2917 /* Change menu-bar to (menu-bar) as the event "position". */
2918 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2921 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2926 /* Store these characters into recent_keys, the dribble file if any,
2927 and the keyboard macro being defined, if any. */
2929 if (! NILP (also_record
))
2930 record_char (also_record
);
2932 /* Wipe the echo area.
2933 But first, if we are about to use an input method,
2934 save the echo area contents for it to refer to. */
2936 && ! NILP (Vinput_method_function
)
2937 && (unsigned) XINT (c
) >= ' '
2938 && (unsigned) XINT (c
) != 127
2939 && (unsigned) XINT (c
) < 256)
2941 previous_echo_area_message
= Fcurrent_message ();
2942 Vinput_method_previous_message
= previous_echo_area_message
;
2945 /* Now wipe the echo area, except for help events which do their
2946 own stuff with the echo area. */
2948 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2949 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2951 if (!NILP (echo_area_buffer
[0]))
2952 safe_run_hooks (Qecho_area_clear_hook
);
2953 clear_message (1, 0);
2956 reread_for_input_method
:
2958 /* Pass this to the input method, if appropriate. */
2960 && ! NILP (Vinput_method_function
)
2961 /* Don't run the input method within a key sequence,
2962 after the first event of the key sequence. */
2963 && NILP (prev_event
)
2964 && (unsigned) XINT (c
) >= ' '
2965 && (unsigned) XINT (c
) != 127
2966 && (unsigned) XINT (c
) < 256)
2969 int key_count
, key_count_reset
;
2970 struct gcpro gcpro1
;
2971 int count
= SPECPDL_INDEX ();
2973 /* Save the echo status. */
2974 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2975 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2976 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2979 if (before_command_restore_flag
)
2981 this_command_key_count
= before_command_key_count_1
;
2982 if (this_command_key_count
< this_single_command_key_start
)
2983 this_single_command_key_start
= this_command_key_count
;
2984 echo_truncate (before_command_echo_length_1
);
2985 before_command_restore_flag
= 0;
2989 /* Save the this_command_keys status. */
2990 key_count
= this_command_key_count
;
2991 key_count_reset
= this_command_key_count_reset
;
2994 keys
= Fcopy_sequence (this_command_keys
);
2999 /* Clear out this_command_keys. */
3000 this_command_key_count
= 0;
3001 this_command_key_count_reset
= 0;
3003 /* Now wipe the echo area. */
3004 if (!NILP (echo_area_buffer
[0]))
3005 safe_run_hooks (Qecho_area_clear_hook
);
3006 clear_message (1, 0);
3009 /* If we are not reading a key sequence,
3010 never use the echo area. */
3013 specbind (Qinput_method_use_echo_area
, Qt
);
3016 /* Call the input method. */
3017 tem
= call1 (Vinput_method_function
, c
);
3019 tem
= unbind_to (count
, tem
);
3021 /* Restore the saved echoing state
3022 and this_command_keys state. */
3023 this_command_key_count
= key_count
;
3024 this_command_key_count_reset
= key_count_reset
;
3026 this_command_keys
= keys
;
3029 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3030 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3031 if (saved_immediate_echo
)
3036 /* The input method can return no events. */
3039 /* Bring back the previous message, if any. */
3040 if (! NILP (previous_echo_area_message
))
3041 message_with_string ("%s", previous_echo_area_message
, 0);
3044 /* It returned one event or more. */
3046 Vunread_post_input_method_events
3047 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3052 /* Display help if not echoing. */
3053 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3055 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3056 Lisp_Object help
, object
, position
, window
, tem
;
3058 tem
= Fcdr (XCDR (c
));
3061 window
= Fcar (tem
);
3063 object
= Fcar (tem
);
3065 position
= Fcar (tem
);
3067 show_help_echo (help
, window
, object
, position
, 0);
3069 /* We stopped being idle for this event; undo that. */
3070 timer_idleness_start_time
= last_idle_start
;
3074 if (! reread
|| this_command_key_count
== 0
3075 || this_command_key_count_reset
)
3078 /* Don't echo mouse motion events. */
3079 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3080 && NILP (Fzerop (Vecho_keystrokes
))
3081 && ! (EVENT_HAS_PARAMETERS (c
)
3082 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3085 if (! NILP (also_record
))
3086 echo_char (also_record
);
3087 /* Once we reread a character, echoing can happen
3088 the next time we pause to read a new one. */
3089 ok_to_echo_at_next_pause
= current_kboard
;
3092 /* Record this character as part of the current key. */
3093 add_command_key (c
);
3094 if (! NILP (also_record
))
3095 add_command_key (also_record
);
3098 last_input_char
= c
;
3101 /* Process the help character specially if enabled */
3102 if (!NILP (Vhelp_form
) && help_char_p (c
))
3105 count
= SPECPDL_INDEX ();
3107 record_unwind_protect (Fset_window_configuration
,
3108 Fcurrent_window_configuration (Qnil
));
3110 tem0
= Feval (Vhelp_form
);
3112 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3116 c
= read_char (0, 0, 0, Qnil
, 0);
3117 while (BUFFERP (c
));
3118 /* Remove the help from the frame */
3119 unbind_to (count
, Qnil
);
3122 if (EQ (c
, make_number (040)))
3126 c
= read_char (0, 0, 0, Qnil
, 0);
3127 while (BUFFERP (c
));
3136 /* Record a key that came from a mouse menu.
3137 Record it for echoing, for this-command-keys, and so on. */
3143 /* Wipe the echo area. */
3144 clear_message (1, 0);
3149 before_command_key_count
= this_command_key_count
;
3150 before_command_echo_length
= echo_length ();
3153 /* Don't echo mouse motion events. */
3154 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3155 && NILP (Fzerop (Vecho_keystrokes
)))
3159 /* Once we reread a character, echoing can happen
3160 the next time we pause to read a new one. */
3161 ok_to_echo_at_next_pause
= 0;
3164 /* Record this character as part of the current key. */
3165 add_command_key (c
);
3167 /* Re-reading in the middle of a command */
3168 last_input_char
= c
;
3172 /* Return 1 if should recognize C as "the help character". */
3180 if (EQ (c
, Vhelp_char
))
3182 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3183 if (EQ (c
, XCAR (tail
)))
3188 /* Record the input event C in various ways. */
3196 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3198 /* To avoid filling recent_keys with help-echo and mouse-movement
3199 events, we filter out repeated help-echo events, only store the
3200 first and last in a series of mouse-movement events, and don't
3201 store repeated help-echo events which are only separated by
3202 mouse-movement events. */
3204 Lisp_Object ev1
, ev2
, ev3
;
3207 if ((ix1
= recent_keys_index
- 1) < 0)
3208 ix1
= NUM_RECENT_KEYS
- 1;
3209 ev1
= AREF (recent_keys
, ix1
);
3211 if ((ix2
= ix1
- 1) < 0)
3212 ix2
= NUM_RECENT_KEYS
- 1;
3213 ev2
= AREF (recent_keys
, ix2
);
3215 if ((ix3
= ix2
- 1) < 0)
3216 ix3
= NUM_RECENT_KEYS
- 1;
3217 ev3
= AREF (recent_keys
, ix3
);
3219 if (EQ (XCAR (c
), Qhelp_echo
))
3221 /* Don't record `help-echo' in recent_keys unless it shows some help
3222 message, and a different help than the previously recorded
3224 Lisp_Object help
, last_help
;
3226 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3227 if (!STRINGP (help
))
3229 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3230 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3232 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3233 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3234 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3236 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3237 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3238 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3239 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3242 else if (EQ (XCAR (c
), Qmouse_movement
))
3244 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3245 So additional mouse movement events replace the last element. */
3246 Lisp_Object last_window
, window
;
3248 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3249 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3250 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3251 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3252 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3254 ASET (recent_keys
, ix1
, c
);
3260 store_kbd_macro_char (c
);
3265 ASET (recent_keys
, recent_keys_index
, c
);
3266 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3267 recent_keys_index
= 0;
3269 else if (recorded
< 0)
3271 /* We need to remove one or two events from recent_keys.
3272 To do this, we simply put nil at those events and move the
3273 recent_keys_index backwards over those events. Usually,
3274 users will never see those nil events, as they will be
3275 overwritten by the command keys entered to see recent_keys
3278 while (recorded
++ < 0 && total_keys
> 0)
3280 if (total_keys
< NUM_RECENT_KEYS
)
3282 if (--recent_keys_index
< 0)
3283 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3284 ASET (recent_keys
, recent_keys_index
, Qnil
);
3288 num_nonmacro_input_events
++;
3290 /* Write c to the dribble file. If c is a lispy event, write
3291 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3292 If you, dear reader, have a better idea, you've got the source. :-) */
3297 if (XUINT (c
) < 0x100)
3298 putc (XINT (c
), dribble
);
3300 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3304 Lisp_Object dribblee
;
3306 /* If it's a structured event, take the event header. */
3307 dribblee
= EVENT_HEAD (c
);
3309 if (SYMBOLP (dribblee
))
3311 putc ('<', dribble
);
3312 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3313 SBYTES (SYMBOL_NAME (dribblee
)),
3315 putc ('>', dribble
);
3327 struct buffer
*old
= current_buffer
;
3328 Fprinc (object
, Qnil
);
3329 set_buffer_internal (XBUFFER (Vstandard_output
));
3330 call0 (intern ("help-mode"));
3331 set_buffer_internal (old
);
3335 /* Copy out or in the info on where C-g should throw to.
3336 This is used when running Lisp code from within get_char,
3337 in case get_char is called recursively.
3338 See read_process_output. */
3344 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3348 restore_getcjmp (temp
)
3351 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3356 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3357 of this function. */
3360 tracking_off (old_value
)
3361 Lisp_Object old_value
;
3363 do_mouse_tracking
= old_value
;
3364 if (NILP (old_value
))
3366 /* Redisplay may have been preempted because there was input
3367 available, and it assumes it will be called again after the
3368 input has been processed. If the only input available was
3369 the sort that we have just disabled, then we need to call
3371 if (!readable_events (1))
3373 redisplay_preserve_echo_area (6);
3374 get_input_pending (&input_pending
, 1);
3380 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3381 doc
: /* Evaluate BODY with mouse movement events enabled.
3382 Within a `track-mouse' form, mouse motion generates input events that
3383 you can read with `read-event'.
3384 Normally, mouse motion is ignored.
3385 usage: (track-mouse BODY ...) */)
3389 int count
= SPECPDL_INDEX ();
3392 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3394 do_mouse_tracking
= Qt
;
3396 val
= Fprogn (args
);
3397 return unbind_to (count
, val
);
3400 /* If mouse has moved on some frame, return one of those frames.
3401 Return 0 otherwise. */
3406 Lisp_Object tail
, frame
;
3408 FOR_EACH_FRAME (tail
, frame
)
3410 if (XFRAME (frame
)->mouse_moved
)
3411 return XFRAME (frame
);
3417 #endif /* HAVE_MOUSE */
3419 /* Low level keyboard/mouse input.
3420 kbd_buffer_store_event places events in kbd_buffer, and
3421 kbd_buffer_get_event retrieves them. */
3423 /* Return true iff there are any events in the queue that read-char
3424 would return. If this returns false, a read-char would block. */
3426 readable_filtered_events (do_timers_now
, filter_events
)
3431 timer_check (do_timers_now
);
3433 /* If the buffer contains only FOCUS_IN_EVENT events,
3434 and FILTER_EVENTS is nonzero, report it as empty. */
3435 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3437 int have_live_event
= 1;
3441 struct input_event
*event
;
3443 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3447 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3450 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3452 if (event
== kbd_store_ptr
)
3453 have_live_event
= 0;
3456 if (have_live_event
) return 1;
3460 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3465 if (current_kboard
->kbd_queue_has_data
)
3471 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3472 if (kb
->kbd_queue_has_data
)
3478 /* Return true iff there are any events in the queue that read-char
3479 would return. If this returns false, a read-char would block. */
3481 readable_events (do_timers_now
)
3484 return readable_filtered_events (do_timers_now
, 0);
3487 /* Set this for debugging, to have a way to get out */
3492 event_to_kboard (event
)
3493 struct input_event
*event
;
3496 frame
= event
->frame_or_window
;
3498 frame
= XCAR (frame
);
3499 else if (WINDOWP (frame
))
3500 frame
= WINDOW_FRAME (XWINDOW (frame
));
3502 /* There are still some events that don't set this field.
3503 For now, just ignore the problem.
3504 Also ignore dead frames here. */
3505 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3508 return FRAME_KBOARD (XFRAME (frame
));
3512 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3515 kbd_buffer_store_event (event
)
3516 register struct input_event
*event
;
3518 if (event
->kind
== NO_EVENT
)
3521 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3523 register int c
= event
->code
& 0377;
3525 if (event
->modifiers
& ctrl_modifier
)
3526 c
= make_ctrl_char (c
);
3528 c
|= (event
->modifiers
3529 & (meta_modifier
| alt_modifier
3530 | hyper_modifier
| super_modifier
));
3536 struct input_event
*sp
;
3539 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3540 kb
!= current_kboard
))
3543 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3544 Fcons (make_number (c
), Qnil
));
3545 kb
->kbd_queue_has_data
= 1;
3546 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3548 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3551 if (event_to_kboard (sp
) == kb
)
3553 sp
->kind
= NO_EVENT
;
3554 sp
->frame_or_window
= Qnil
;
3562 /* If this results in a quit_char being returned to Emacs as
3563 input, set Vlast_event_frame properly. If this doesn't
3564 get returned to Emacs as an event, the next event read
3565 will set Vlast_event_frame again, so this is safe to do. */
3569 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3571 focus
= event
->frame_or_window
;
3572 internal_last_event_frame
= focus
;
3573 Vlast_event_frame
= focus
;
3576 last_event_timestamp
= event
->timestamp
;
3577 handle_interrupt ();
3581 if (c
&& c
== stop_character
)
3587 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3588 Just ignore the second one. */
3589 else if (event
->kind
== BUFFER_SWITCH_EVENT
3590 && kbd_fetch_ptr
!= kbd_store_ptr
3591 && kbd_store_ptr
->kind
== BUFFER_SWITCH_EVENT
)
3594 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3595 kbd_store_ptr
= kbd_buffer
;
3597 /* Don't let the very last slot in the buffer become full,
3598 since that would make the two pointers equal,
3599 and that is indistinguishable from an empty buffer.
3600 Discard the event if it would fill the last slot. */
3601 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3604 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3605 prone to assign individual members for other events, in case
3606 the input_event structure is changed. --2000-07-13, gerd. */
3607 struct input_event
*sp
= kbd_store_ptr
;
3608 sp
->kind
= event
->kind
;
3609 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3611 /* We must not use the ordinary copying code for this case,
3612 since `part' is an enum and copying it might not copy enough
3614 bcopy (event
, (char *) sp
, sizeof (*event
));
3619 sp
->code
= event
->code
;
3620 sp
->part
= event
->part
;
3621 sp
->frame_or_window
= event
->frame_or_window
;
3622 sp
->arg
= event
->arg
;
3623 sp
->modifiers
= event
->modifiers
;
3626 sp
->timestamp
= event
->timestamp
;
3629 *kbd_store_ptr
= *event
;
3637 /* Generate HELP_EVENT input_events in BUFP which has room for
3638 SIZE events. If there's not enough room in BUFP, ignore this
3641 HELP is the help form.
3643 FRAME is the frame on which the help is generated. OBJECT is the
3644 Lisp object where the help was found (a buffer, a string, an
3645 overlay, or nil if neither from a string nor from a buffer. POS is
3646 the position within OBJECT where the help was found.
3648 Value is the number of input_events generated. */
3651 gen_help_event (bufp
, size
, help
, frame
, window
, object
, pos
)
3652 struct input_event
*bufp
;
3654 Lisp_Object help
, frame
, object
, window
;
3659 bufp
->kind
= HELP_EVENT
;
3660 bufp
->frame_or_window
= frame
;
3662 bufp
->x
= WINDOWP (window
) ? window
: frame
;
3671 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3674 kbd_buffer_store_help_event (frame
, help
)
3675 Lisp_Object frame
, help
;
3677 struct input_event event
;
3679 event
.kind
= HELP_EVENT
;
3680 event
.frame_or_window
= frame
;
3685 kbd_buffer_store_event (&event
);
3689 /* Discard any mouse events in the event buffer by setting them to
3692 discard_mouse_events ()
3694 struct input_event
*sp
;
3695 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3697 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3700 if (sp
->kind
== MOUSE_CLICK_EVENT
3701 || sp
->kind
== WHEEL_EVENT
3703 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3705 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3707 sp
->kind
= NO_EVENT
;
3713 /* Return non-zero if there are any real events waiting in the event
3714 buffer, not counting `NO_EVENT's.
3716 If DISCARD is non-zero, discard NO_EVENT events at the front of
3717 the input queue, possibly leaving the input queue empty if there
3718 are no real input events. */
3721 kbd_buffer_events_waiting (discard
)
3724 struct input_event
*sp
;
3726 for (sp
= kbd_fetch_ptr
;
3727 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3730 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3737 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3741 /* Clear input event EVENT. */
3745 struct input_event
*event
;
3747 event
->kind
= NO_EVENT
;
3751 /* Read one event from the event buffer, waiting if necessary.
3752 The value is a Lisp object representing the event.
3753 The value is nil for an event that should be ignored,
3754 or that was handled here.
3755 We always read and discard one event. */
3758 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3760 int *used_mouse_menu
;
3769 *kbp
= current_kboard
;
3773 /* Wait until there is input available. */
3776 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3779 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3783 /* If the quit flag is set, then read_char will return
3784 quit_char, so that counts as "available input." */
3785 if (!NILP (Vquit_flag
))
3786 quit_throw_to_read_char ();
3788 /* One way or another, wait until input is available; then, if
3789 interrupt handlers have not read it, read it now. */
3792 wait_for_kbd_input ();
3794 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3798 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3801 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3805 Lisp_Object minus_one
;
3807 XSETINT (minus_one
, -1);
3808 wait_reading_process_input (0, 0, minus_one
, 1);
3810 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3811 /* Pass 1 for EXPECT since we just waited to have input. */
3812 read_avail_input (1);
3814 #endif /* not VMS */
3817 if (CONSP (Vunread_command_events
))
3820 first
= XCAR (Vunread_command_events
);
3821 Vunread_command_events
= XCDR (Vunread_command_events
);
3822 *kbp
= current_kboard
;
3826 /* At this point, we know that there is a readable event available
3827 somewhere. If the event queue is empty, then there must be a
3828 mouse movement enabled and available. */
3829 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3831 struct input_event
*event
;
3833 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3837 last_event_timestamp
= event
->timestamp
;
3840 *kbp
= event_to_kboard (event
);
3842 *kbp
= current_kboard
; /* Better than returning null ptr? */
3844 *kbp
= &the_only_kboard
;
3849 /* These two kinds of events get special handling
3850 and don't actually appear to the command loop.
3851 We return nil for them. */
3852 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3855 struct input_event copy
;
3857 /* Remove it from the buffer before processing it,
3858 since otherwise swallow_events will see it
3859 and process it again. */
3861 kbd_fetch_ptr
= event
+ 1;
3862 input_pending
= readable_events (0);
3863 x_handle_selection_request (©
);
3865 /* We're getting selection request events, but we don't have
3871 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3874 struct input_event copy
;
3876 /* Remove it from the buffer before processing it. */
3878 kbd_fetch_ptr
= event
+ 1;
3879 input_pending
= readable_events (0);
3880 x_handle_selection_clear (©
);
3882 /* We're getting selection request events, but we don't have
3887 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3888 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3890 /* Make an event (delete-frame (FRAME)). */
3891 obj
= Fcons (event
->frame_or_window
, Qnil
);
3892 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3893 kbd_fetch_ptr
= event
+ 1;
3896 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3897 else if (event
->kind
== ICONIFY_EVENT
)
3899 /* Make an event (iconify-frame (FRAME)). */
3900 obj
= Fcons (event
->frame_or_window
, Qnil
);
3901 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3902 kbd_fetch_ptr
= event
+ 1;
3904 else if (event
->kind
== DEICONIFY_EVENT
)
3906 /* Make an event (make-frame-visible (FRAME)). */
3907 obj
= Fcons (event
->frame_or_window
, Qnil
);
3908 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3909 kbd_fetch_ptr
= event
+ 1;
3912 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3914 /* The value doesn't matter here; only the type is tested. */
3915 XSETBUFFER (obj
, current_buffer
);
3916 kbd_fetch_ptr
= event
+ 1;
3918 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
3919 || defined (USE_GTK)
3920 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3922 kbd_fetch_ptr
= event
+ 1;
3923 input_pending
= readable_events (0);
3924 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3925 x_activate_menubar (XFRAME (event
->frame_or_window
));
3929 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3931 /* Make an event (language-change (FRAME CHARSET LCID)). */
3932 obj
= Fcons (event
->modifiers
, Qnil
);
3933 obj
= Fcons (event
->code
, obj
);
3934 obj
= Fcons (event
->frame_or_window
, obj
);
3935 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3936 kbd_fetch_ptr
= event
+ 1;
3939 else if (event
->kind
== SAVE_SESSION_EVENT
)
3941 obj
= Fcons (Qsave_session
, Qnil
);
3942 kbd_fetch_ptr
= event
+ 1;
3944 /* Just discard these, by returning nil.
3945 With MULTI_KBOARD, these events are used as placeholders
3946 when we need to randomly delete events from the queue.
3947 (They shouldn't otherwise be found in the buffer,
3948 but on some machines it appears they do show up
3949 even without MULTI_KBOARD.) */
3950 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3951 mouse events during a popup-menu call. */
3952 else if (event
->kind
== NO_EVENT
)
3953 kbd_fetch_ptr
= event
+ 1;
3954 else if (event
->kind
== HELP_EVENT
)
3956 Lisp_Object object
, position
, help
, frame
, window
;
3958 frame
= event
->frame_or_window
;
3959 object
= event
->arg
;
3960 position
= make_number (event
->code
);
3963 clear_event (event
);
3965 kbd_fetch_ptr
= event
+ 1;
3966 if (!WINDOWP (window
))
3968 obj
= Fcons (Qhelp_echo
,
3969 list5 (frame
, help
, window
, object
, position
));
3971 else if (event
->kind
== FOCUS_IN_EVENT
)
3973 /* Notification of a FocusIn event. The frame receiving the
3974 focus is in event->frame_or_window. Generate a
3975 switch-frame event if necessary. */
3976 Lisp_Object frame
, focus
;
3978 frame
= event
->frame_or_window
;
3979 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3983 if (!EQ (frame
, internal_last_event_frame
)
3984 && !EQ (frame
, selected_frame
))
3985 obj
= make_lispy_switch_frame (frame
);
3986 internal_last_event_frame
= frame
;
3987 kbd_fetch_ptr
= event
+ 1;
3991 /* If this event is on a different frame, return a switch-frame this
3992 time, and leave the event in the queue for next time. */
3996 frame
= event
->frame_or_window
;
3998 frame
= XCAR (frame
);
3999 else if (WINDOWP (frame
))
4000 frame
= WINDOW_FRAME (XWINDOW (frame
));
4002 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4006 if (! EQ (frame
, internal_last_event_frame
)
4007 && !EQ (frame
, selected_frame
))
4008 obj
= make_lispy_switch_frame (frame
);
4009 internal_last_event_frame
= frame
;
4011 /* If we didn't decide to make a switch-frame event, go ahead
4012 and build a real event from the queue entry. */
4016 obj
= make_lispy_event (event
);
4018 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4019 || defined (USE_GTK)
4020 /* If this was a menu selection, then set the flag to inhibit
4021 writing to last_nonmenu_event. Don't do this if the event
4022 we're returning is (menu-bar), though; that indicates the
4023 beginning of the menu sequence, and we might as well leave
4024 that as the `event with parameters' for this selection. */
4026 && !EQ (event
->frame_or_window
, event
->arg
)
4027 && (event
->kind
== MENU_BAR_EVENT
4028 || event
->kind
== TOOL_BAR_EVENT
))
4029 *used_mouse_menu
= 1;
4032 /* Wipe out this event, to catch bugs. */
4033 clear_event (event
);
4034 kbd_fetch_ptr
= event
+ 1;
4039 /* Try generating a mouse motion event. */
4040 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4042 FRAME_PTR f
= some_mouse_moved ();
4043 Lisp_Object bar_window
;
4044 enum scroll_bar_part part
;
4048 *kbp
= current_kboard
;
4049 /* Note that this uses F to determine which display to look at.
4050 If there is no valid info, it does not store anything
4051 so x remains nil. */
4053 if (f
&& FRAME_DISPLAY (f
)->mouse_position_hook
) /* XXX Can f or mouse_position_hook be NULL here? */
4054 (*FRAME_DISPLAY (f
)->mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4058 /* Decide if we should generate a switch-frame event. Don't
4059 generate switch-frame events for motion outside of all Emacs
4065 frame
= FRAME_FOCUS_FRAME (f
);
4067 XSETFRAME (frame
, f
);
4069 if (! EQ (frame
, internal_last_event_frame
)
4070 && !EQ (frame
, selected_frame
))
4071 obj
= make_lispy_switch_frame (frame
);
4072 internal_last_event_frame
= frame
;
4075 /* If we didn't decide to make a switch-frame event, go ahead and
4076 return a mouse-motion event. */
4077 if (!NILP (x
) && NILP (obj
))
4078 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4080 #endif /* HAVE_MOUSE */
4082 /* We were promised by the above while loop that there was
4083 something for us to read! */
4086 input_pending
= readable_events (0);
4088 Vlast_event_frame
= internal_last_event_frame
;
4093 /* Process any events that are not user-visible,
4094 then return, without reading any user-visible events. */
4097 swallow_events (do_display
)
4102 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4104 struct input_event
*event
;
4106 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4110 last_event_timestamp
= event
->timestamp
;
4112 /* These two kinds of events get special handling
4113 and don't actually appear to the command loop. */
4114 if (event
->kind
== SELECTION_REQUEST_EVENT
)
4117 struct input_event copy
;
4119 /* Remove it from the buffer before processing it,
4120 since otherwise swallow_events called recursively could see it
4121 and process it again. */
4123 kbd_fetch_ptr
= event
+ 1;
4124 input_pending
= readable_events (0);
4125 x_handle_selection_request (©
);
4127 /* We're getting selection request events, but we don't have
4133 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
4136 struct input_event copy
;
4138 /* Remove it from the buffer before processing it, */
4141 kbd_fetch_ptr
= event
+ 1;
4142 input_pending
= readable_events (0);
4143 x_handle_selection_clear (©
);
4145 /* We're getting selection request events, but we don't have
4154 old_timers_run
= timers_run
;
4155 get_input_pending (&input_pending
, 1);
4157 if (timers_run
!= old_timers_run
&& do_display
)
4158 redisplay_preserve_echo_area (7);
4161 /* Record the start of when Emacs is idle,
4162 for the sake of running idle-time timers. */
4169 /* If we are already in the idle state, do nothing. */
4170 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4173 EMACS_GET_TIME (timer_idleness_start_time
);
4175 timer_last_idleness_start_time
= timer_idleness_start_time
;
4177 /* Mark all idle-time timers as once again candidates for running. */
4178 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4182 timer
= XCAR (timers
);
4184 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4186 XVECTOR (timer
)->contents
[0] = Qnil
;
4190 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4195 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4198 /* This is only for debugging. */
4199 struct input_event last_timer_event
;
4201 /* Check whether a timer has fired. To prevent larger problems we simply
4202 disregard elements that are not proper timers. Do not make a circular
4203 timer list for the time being.
4205 Returns the number of seconds to wait until the next timer fires. If a
4206 timer is triggering now, return zero seconds.
4207 If no timer is active, return -1 seconds.
4209 If a timer is ripe, we run it, with quitting turned off.
4211 DO_IT_NOW is now ignored. It used to mean that we should
4212 run the timer directly instead of queueing a timer-event.
4213 Now we always run timers directly. */
4216 timer_check (do_it_now
)
4219 EMACS_TIME nexttime
;
4220 EMACS_TIME now
, idleness_now
;
4221 Lisp_Object timers
, idle_timers
, chosen_timer
;
4222 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4224 EMACS_SET_SECS (nexttime
, -1);
4225 EMACS_SET_USECS (nexttime
, -1);
4227 /* Always consider the ordinary timers. */
4228 timers
= Vtimer_list
;
4229 /* Consider the idle timers only if Emacs is idle. */
4230 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4231 idle_timers
= Vtimer_idle_list
;
4234 chosen_timer
= Qnil
;
4235 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4237 if (CONSP (timers
) || CONSP (idle_timers
))
4239 EMACS_GET_TIME (now
);
4240 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4241 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4244 while (CONSP (timers
) || CONSP (idle_timers
))
4246 Lisp_Object
*vector
;
4247 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4248 EMACS_TIME timer_time
, idle_timer_time
;
4249 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4251 /* Skip past invalid timers and timers already handled. */
4254 timer
= XCAR (timers
);
4255 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4257 timers
= XCDR (timers
);
4260 vector
= XVECTOR (timer
)->contents
;
4262 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4263 || !INTEGERP (vector
[3])
4264 || ! NILP (vector
[0]))
4266 timers
= XCDR (timers
);
4270 if (!NILP (idle_timers
))
4272 timer
= XCAR (idle_timers
);
4273 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4275 idle_timers
= XCDR (idle_timers
);
4278 vector
= XVECTOR (timer
)->contents
;
4280 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4281 || !INTEGERP (vector
[3])
4282 || ! NILP (vector
[0]))
4284 idle_timers
= XCDR (idle_timers
);
4289 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4290 based on the next ordinary timer.
4291 TIMER_DIFFERENCE is the distance in time from NOW to when
4292 this timer becomes ripe (negative if it's already ripe). */
4295 timer
= XCAR (timers
);
4296 vector
= XVECTOR (timer
)->contents
;
4297 EMACS_SET_SECS (timer_time
,
4298 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4299 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4300 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4303 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4304 based on the next idle timer. */
4305 if (!NILP (idle_timers
))
4307 idle_timer
= XCAR (idle_timers
);
4308 vector
= XVECTOR (idle_timer
)->contents
;
4309 EMACS_SET_SECS (idle_timer_time
,
4310 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4311 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4312 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4315 /* Decide which timer is the next timer,
4316 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4317 Also step down the list where we found that timer. */
4319 if (! NILP (timers
) && ! NILP (idle_timers
))
4322 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4323 if (EMACS_TIME_NEG_P (temp
))
4325 chosen_timer
= timer
;
4326 timers
= XCDR (timers
);
4327 difference
= timer_difference
;
4331 chosen_timer
= idle_timer
;
4332 idle_timers
= XCDR (idle_timers
);
4333 difference
= idle_timer_difference
;
4336 else if (! NILP (timers
))
4338 chosen_timer
= timer
;
4339 timers
= XCDR (timers
);
4340 difference
= timer_difference
;
4344 chosen_timer
= idle_timer
;
4345 idle_timers
= XCDR (idle_timers
);
4346 difference
= idle_timer_difference
;
4348 vector
= XVECTOR (chosen_timer
)->contents
;
4350 /* If timer is ripe, run it if it hasn't been run. */
4351 if (EMACS_TIME_NEG_P (difference
)
4352 || (EMACS_SECS (difference
) == 0
4353 && EMACS_USECS (difference
) == 0))
4355 if (NILP (vector
[0]))
4357 int was_locked
= single_kboard
;
4358 int count
= SPECPDL_INDEX ();
4359 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4361 /* Mark the timer as triggered to prevent problems if the lisp
4362 code fails to reschedule it right. */
4365 specbind (Qinhibit_quit
, Qt
);
4367 call1 (Qtimer_event_handler
, chosen_timer
);
4368 Vdeactivate_mark
= old_deactivate_mark
;
4370 unbind_to (count
, Qnil
);
4372 /* Resume allowing input from any kboard, if that was true before. */
4374 any_kboard_state ();
4376 /* Since we have handled the event,
4377 we don't need to tell the caller to wake up and do it. */
4381 /* When we encounter a timer that is still waiting,
4382 return the amount of time to wait before it is ripe. */
4389 /* No timers are pending in the future. */
4390 /* Return 0 if we generated an event, and -1 if not. */
4395 /* Caches for modify_event_symbol. */
4396 static Lisp_Object accent_key_syms
;
4397 static Lisp_Object func_key_syms
;
4398 static Lisp_Object mouse_syms
;
4399 static Lisp_Object wheel_syms
;
4400 static Lisp_Object drag_n_drop_syms
;
4402 /* This is a list of keysym codes for special "accent" characters.
4403 It parallels lispy_accent_keys. */
4405 static int lispy_accent_codes
[] =
4407 #ifdef XK_dead_circumflex
4412 #ifdef XK_dead_grave
4417 #ifdef XK_dead_tilde
4422 #ifdef XK_dead_diaeresis
4427 #ifdef XK_dead_macron
4432 #ifdef XK_dead_degree
4437 #ifdef XK_dead_acute
4442 #ifdef XK_dead_cedilla
4447 #ifdef XK_dead_breve
4452 #ifdef XK_dead_ogonek
4457 #ifdef XK_dead_caron
4462 #ifdef XK_dead_doubleacute
4463 XK_dead_doubleacute
,
4467 #ifdef XK_dead_abovedot
4472 #ifdef XK_dead_abovering
4482 #ifdef XK_dead_belowdot
4487 #ifdef XK_dead_voiced_sound
4488 XK_dead_voiced_sound
,
4492 #ifdef XK_dead_semivoiced_sound
4493 XK_dead_semivoiced_sound
,
4509 /* This is a list of Lisp names for special "accent" characters.
4510 It parallels lispy_accent_codes. */
4512 static char *lispy_accent_keys
[] =
4530 "dead-voiced-sound",
4531 "dead-semivoiced-sound",
4537 #define FUNCTION_KEY_OFFSET 0x0
4539 char *lispy_function_keys
[] =
4543 0, /* VK_LBUTTON 0x01 */
4544 0, /* VK_RBUTTON 0x02 */
4545 "cancel", /* VK_CANCEL 0x03 */
4546 0, /* VK_MBUTTON 0x04 */
4548 0, 0, 0, /* 0x05 .. 0x07 */
4550 "backspace", /* VK_BACK 0x08 */
4551 "tab", /* VK_TAB 0x09 */
4553 0, 0, /* 0x0A .. 0x0B */
4555 "clear", /* VK_CLEAR 0x0C */
4556 "return", /* VK_RETURN 0x0D */
4558 0, 0, /* 0x0E .. 0x0F */
4560 0, /* VK_SHIFT 0x10 */
4561 0, /* VK_CONTROL 0x11 */
4562 0, /* VK_MENU 0x12 */
4563 "pause", /* VK_PAUSE 0x13 */
4564 "capslock", /* VK_CAPITAL 0x14 */
4566 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4568 "escape", /* VK_ESCAPE 0x1B */
4570 0, 0, 0, 0, /* 0x1C .. 0x1F */
4572 0, /* VK_SPACE 0x20 */
4573 "prior", /* VK_PRIOR 0x21 */
4574 "next", /* VK_NEXT 0x22 */
4575 "end", /* VK_END 0x23 */
4576 "home", /* VK_HOME 0x24 */
4577 "left", /* VK_LEFT 0x25 */
4578 "up", /* VK_UP 0x26 */
4579 "right", /* VK_RIGHT 0x27 */
4580 "down", /* VK_DOWN 0x28 */
4581 "select", /* VK_SELECT 0x29 */
4582 "print", /* VK_PRINT 0x2A */
4583 "execute", /* VK_EXECUTE 0x2B */
4584 "snapshot", /* VK_SNAPSHOT 0x2C */
4585 "insert", /* VK_INSERT 0x2D */
4586 "delete", /* VK_DELETE 0x2E */
4587 "help", /* VK_HELP 0x2F */
4589 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4591 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4593 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4595 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4597 0, 0, 0, 0, 0, 0, 0, 0, 0,
4598 0, 0, 0, 0, 0, 0, 0, 0, 0,
4599 0, 0, 0, 0, 0, 0, 0, 0,
4601 "lwindow", /* VK_LWIN 0x5B */
4602 "rwindow", /* VK_RWIN 0x5C */
4603 "apps", /* VK_APPS 0x5D */
4605 0, 0, /* 0x5E .. 0x5F */
4607 "kp-0", /* VK_NUMPAD0 0x60 */
4608 "kp-1", /* VK_NUMPAD1 0x61 */
4609 "kp-2", /* VK_NUMPAD2 0x62 */
4610 "kp-3", /* VK_NUMPAD3 0x63 */
4611 "kp-4", /* VK_NUMPAD4 0x64 */
4612 "kp-5", /* VK_NUMPAD5 0x65 */
4613 "kp-6", /* VK_NUMPAD6 0x66 */
4614 "kp-7", /* VK_NUMPAD7 0x67 */
4615 "kp-8", /* VK_NUMPAD8 0x68 */
4616 "kp-9", /* VK_NUMPAD9 0x69 */
4617 "kp-multiply", /* VK_MULTIPLY 0x6A */
4618 "kp-add", /* VK_ADD 0x6B */
4619 "kp-separator", /* VK_SEPARATOR 0x6C */
4620 "kp-subtract", /* VK_SUBTRACT 0x6D */
4621 "kp-decimal", /* VK_DECIMAL 0x6E */
4622 "kp-divide", /* VK_DIVIDE 0x6F */
4623 "f1", /* VK_F1 0x70 */
4624 "f2", /* VK_F2 0x71 */
4625 "f3", /* VK_F3 0x72 */
4626 "f4", /* VK_F4 0x73 */
4627 "f5", /* VK_F5 0x74 */
4628 "f6", /* VK_F6 0x75 */
4629 "f7", /* VK_F7 0x76 */
4630 "f8", /* VK_F8 0x77 */
4631 "f9", /* VK_F9 0x78 */
4632 "f10", /* VK_F10 0x79 */
4633 "f11", /* VK_F11 0x7A */
4634 "f12", /* VK_F12 0x7B */
4635 "f13", /* VK_F13 0x7C */
4636 "f14", /* VK_F14 0x7D */
4637 "f15", /* VK_F15 0x7E */
4638 "f16", /* VK_F16 0x7F */
4639 "f17", /* VK_F17 0x80 */
4640 "f18", /* VK_F18 0x81 */
4641 "f19", /* VK_F19 0x82 */
4642 "f20", /* VK_F20 0x83 */
4643 "f21", /* VK_F21 0x84 */
4644 "f22", /* VK_F22 0x85 */
4645 "f23", /* VK_F23 0x86 */
4646 "f24", /* VK_F24 0x87 */
4648 0, 0, 0, 0, /* 0x88 .. 0x8B */
4649 0, 0, 0, 0, /* 0x8C .. 0x8F */
4651 "kp-numlock", /* VK_NUMLOCK 0x90 */
4652 "scroll", /* VK_SCROLL 0x91 */
4654 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4655 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4656 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4657 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4658 "kp-end", /* VK_NUMPAD_END 0x96 */
4659 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4660 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4661 "kp-up", /* VK_NUMPAD_UP 0x99 */
4662 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4663 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4664 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4665 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4667 0, 0, /* 0x9E .. 0x9F */
4670 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4671 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4672 * No other API or message will distinguish left and right keys this way.
4676 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4677 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4678 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4679 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4680 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4686 "attn", /* VK_ATTN 0xF6 */
4687 "crsel", /* VK_CRSEL 0xF7 */
4688 "exsel", /* VK_EXSEL 0xF8 */
4689 "ereof", /* VK_EREOF 0xF9 */
4690 "play", /* VK_PLAY 0xFA */
4691 "zoom", /* VK_ZOOM 0xFB */
4692 "noname", /* VK_NONAME 0xFC */
4693 "pa1", /* VK_PA1 0xFD */
4694 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4698 #else /* not HAVE_NTGUI */
4700 /* This should be dealt with in XTread_socket now, and that doesn't
4701 depend on the client system having the Kana syms defined. See also
4702 the XK_kana_A case below. */
4705 static char *lispy_kana_keys
[] =
4707 /* X Keysym value */
4708 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4709 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4710 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4711 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4712 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4713 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4714 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4715 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4716 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4717 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4718 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4719 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4720 "kana-i", "kana-u", "kana-e", "kana-o",
4721 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4722 "prolongedsound", "kana-A", "kana-I", "kana-U",
4723 "kana-E", "kana-O", "kana-KA", "kana-KI",
4724 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4725 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4726 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4727 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4728 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4729 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4730 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4731 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4732 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4733 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4734 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4735 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4737 #endif /* XK_kana_A */
4740 #define FUNCTION_KEY_OFFSET 0xff00
4742 /* You'll notice that this table is arranged to be conveniently
4743 indexed by X Windows keysym values. */
4744 static char *lispy_function_keys
[] =
4746 /* X Keysym value */
4748 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4749 "backspace", "tab", "linefeed", "clear",
4751 0, 0, 0, "pause", /* 0xff10...1f */
4752 0, 0, 0, 0, 0, 0, 0, "escape",
4754 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4755 "romaji", "hiragana", "katakana", "hiragana-katakana",
4756 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4757 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4758 "eisu-toggle", /* 0xff30...3f */
4759 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4760 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4762 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4763 "down", "prior", "next", "end",
4764 "begin", 0, 0, 0, 0, 0, 0, 0,
4765 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4776 "break", /* 0xff6b */
4779 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4780 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4781 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4782 0, 0, 0, 0, 0, 0, 0, 0,
4783 "kp-tab", /* 0xff89 */
4785 "kp-enter", /* 0xff8d */
4787 "kp-f1", /* 0xff91 */
4791 "kp-home", /* 0xff95 */
4796 "kp-prior", /* kp-page-up */
4797 "kp-next", /* kp-page-down */
4803 0, 0, 0, 0, 0, 0, 0, 0, 0,
4804 "kp-multiply", /* 0xffaa */
4809 "kp-divide", /* 0xffaf */
4810 "kp-0", /* 0xffb0 */
4811 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4814 "kp-equal", /* 0xffbd */
4815 "f1", /* 0xffbe */ /* IsFunctionKey */
4817 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4818 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4819 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4820 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4821 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4822 0, 0, 0, 0, 0, 0, 0, 0,
4823 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4824 0, 0, 0, 0, 0, 0, 0, "delete"
4827 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4828 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4830 static char *iso_lispy_function_keys
[] =
4832 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4833 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4834 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4835 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4836 "iso-lefttab", /* 0xfe20 */
4837 "iso-move-line-up", "iso-move-line-down",
4838 "iso-partial-line-up", "iso-partial-line-down",
4839 "iso-partial-space-left", "iso-partial-space-right",
4840 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4841 "iso-release-margin-left", "iso-release-margin-right",
4842 "iso-release-both-margins",
4843 "iso-fast-cursor-left", "iso-fast-cursor-right",
4844 "iso-fast-cursor-up", "iso-fast-cursor-down",
4845 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4846 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4849 #endif /* not HAVE_NTGUI */
4851 Lisp_Object Vlispy_mouse_stem
;
4853 static char *lispy_wheel_names
[] =
4855 "wheel-up", "wheel-down"
4858 /* drag-n-drop events are generated when a set of selected files are
4859 dragged from another application and dropped onto an Emacs window. */
4860 static char *lispy_drag_n_drop_names
[] =
4865 /* Scroll bar parts. */
4866 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4867 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4868 Lisp_Object Qtop
, Qratio
;
4870 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4871 Lisp_Object
*scroll_bar_parts
[] = {
4872 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4873 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4876 /* User signal events. */
4877 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4879 Lisp_Object
*lispy_user_signals
[] =
4881 &Qusr1_signal
, &Qusr2_signal
4885 /* A vector, indexed by button number, giving the down-going location
4886 of currently depressed buttons, both scroll bar and non-scroll bar.
4888 The elements have the form
4889 (BUTTON-NUMBER MODIFIER-MASK . REST)
4890 where REST is the cdr of a position as it would be reported in the event.
4892 The make_lispy_event function stores positions here to tell the
4893 difference between click and drag events, and to store the starting
4894 location to be included in drag events. */
4896 static Lisp_Object button_down_location
;
4898 /* Information about the most recent up-going button event: Which
4899 button, what location, and what time. */
4901 static int last_mouse_button
;
4902 static int last_mouse_x
;
4903 static int last_mouse_y
;
4904 static unsigned long button_down_time
;
4906 /* The maximum time between clicks to make a double-click, or Qnil to
4907 disable double-click detection, or Qt for no time limit. */
4909 Lisp_Object Vdouble_click_time
;
4911 /* Maximum number of pixels the mouse may be moved between clicks
4912 to make a double-click. */
4914 EMACS_INT double_click_fuzz
;
4916 /* The number of clicks in this multiple-click. */
4918 int double_click_count
;
4920 /* Return position of a mouse click or wheel event */
4923 make_lispy_position (f
, x
, y
, time
)
4929 enum window_part part
;
4930 Lisp_Object posn
= Qnil
;
4931 Lisp_Object extra_info
= Qnil
;
4934 /* Set `window' to the window under frame pixel coordinates (x,y) */
4936 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
4937 &part
, &wx
, &wy
, 0);
4941 if (WINDOWP (window
))
4943 /* It's a click in window window at frame coordinates (x,y) */
4944 struct window
*w
= XWINDOW (window
);
4945 Lisp_Object string_info
= Qnil
;
4946 int textpos
= -1, rx
= -1, ry
= -1;
4947 int dx
= -1, dy
= -1;
4948 int width
= -1, height
= -1;
4949 Lisp_Object object
= Qnil
;
4951 /* Set event coordinates to window-relative coordinates
4952 for constructing the Lisp event below. */
4956 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
4958 /* Mode line or header line. Look for a string under
4959 the mouse that may have a `local-map' property. */
4963 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
4965 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
4966 &object
, &dx
, &dy
, &width
, &height
);
4967 if (STRINGP (string
))
4968 string_info
= Fcons (string
, make_number (charpos
));
4969 if (w
== XWINDOW (selected_window
))
4972 textpos
= XMARKER (w
->pointm
)->charpos
;
4974 else if (part
== ON_VERTICAL_BORDER
)
4976 posn
= Qvertical_line
;
4981 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
4986 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
4988 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
4989 &object
, &dx
, &dy
, &width
, &height
);
4990 if (STRINGP (string
))
4991 string_info
= Fcons (string
, make_number (charpos
));
4993 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
4995 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
4998 if (part
== ON_RIGHT_FRINGE
)
4999 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5000 + window_box_width (w
, TEXT_AREA
)
5001 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5002 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5004 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5005 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5010 Lisp_Object string2
, object2
= Qnil
;
5011 struct display_pos p
;
5013 int width2
, height2
;
5014 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5015 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5016 &object2
, &dx2
, &dy2
,
5018 textpos
= CHARPOS (p
.pos
);
5019 if (rx
< 0) rx
= wx
;
5020 if (ry
< 0) ry
= wy
;
5021 if (dx
< 0) dx
= dx2
;
5022 if (dy
< 0) dy
= dy2
;
5023 if (width
< 0) width
= width2
;
5024 if (height
< 0) height
= height2
;
5028 posn
= make_number (textpos
);
5029 if (STRINGP (string2
))
5030 string_info
= Fcons (string2
,
5031 make_number (CHARPOS (p
.string_pos
)));
5037 #ifdef HAVE_WINDOW_SYSTEM
5038 if (IMAGEP (object
))
5040 Lisp_Object image_map
, hotspot
;
5041 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5043 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5045 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5046 posn
= XCAR (hotspot
);
5051 extra_info
= Fcons (object
,
5052 Fcons (Fcons (make_number (dx
),
5054 Fcons (Fcons (make_number (width
),
5055 make_number (height
)),
5059 extra_info
= Fcons (string_info
,
5060 Fcons (make_number (textpos
),
5061 Fcons (Fcons (make_number (rx
),
5067 XSETFRAME (window
, f
);
5072 XSETFASTINT (*x
, 0);
5073 XSETFASTINT (*y
, 0);
5076 return Fcons (window
,
5078 Fcons (Fcons (*x
, *y
),
5079 Fcons (make_number (time
),
5083 /* Given a struct input_event, build the lisp event which represents
5084 it. If EVENT is 0, build a mouse movement event from the mouse
5085 movement buffer, which should have a movement event in it.
5087 Note that events must be passed to this function in the order they
5088 are received; this function stores the location of button presses
5089 in order to build drag events when the button is released. */
5092 make_lispy_event (event
)
5093 struct input_event
*event
;
5097 switch (SWITCH_ENUM_CAST (event
->kind
))
5099 /* A simple keystroke. */
5100 case ASCII_KEYSTROKE_EVENT
:
5102 Lisp_Object lispy_c
;
5103 int c
= event
->code
& 0377;
5104 /* Turn ASCII characters into control characters
5106 if (event
->modifiers
& ctrl_modifier
)
5107 c
= make_ctrl_char (c
);
5109 /* Add in the other modifier bits. We took care of ctrl_modifier
5110 just above, and the shift key was taken care of by the X code,
5111 and applied to control characters by make_ctrl_char. */
5112 c
|= (event
->modifiers
5113 & (meta_modifier
| alt_modifier
5114 | hyper_modifier
| super_modifier
));
5115 /* Distinguish Shift-SPC from SPC. */
5116 if ((event
->code
& 0377) == 040
5117 && event
->modifiers
& shift_modifier
)
5118 c
|= shift_modifier
;
5119 button_down_time
= 0;
5120 XSETFASTINT (lispy_c
, c
);
5124 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5126 Lisp_Object lispy_c
;
5127 int c
= event
->code
;
5129 /* Add in the other modifier bits. We took care of ctrl_modifier
5130 just above, and the shift key was taken care of by the X code,
5131 and applied to control characters by make_ctrl_char. */
5132 c
|= (event
->modifiers
5133 & (meta_modifier
| alt_modifier
5134 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5135 /* What about the `shift' modifier ? */
5136 button_down_time
= 0;
5137 XSETFASTINT (lispy_c
, c
);
5141 /* A function key. The symbol may need to have modifier prefixes
5143 case NON_ASCII_KEYSTROKE_EVENT
:
5144 button_down_time
= 0;
5146 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5147 if (event
->code
== lispy_accent_codes
[i
])
5148 return modify_event_symbol (i
,
5150 Qfunction_key
, Qnil
,
5151 lispy_accent_keys
, &accent_key_syms
,
5152 (sizeof (lispy_accent_keys
)
5153 / sizeof (lispy_accent_keys
[0])));
5157 if (event
->code
>= 0x400 && event
->code
< 0x500)
5158 return modify_event_symbol (event
->code
- 0x400,
5159 event
->modifiers
& ~shift_modifier
,
5160 Qfunction_key
, Qnil
,
5161 lispy_kana_keys
, &func_key_syms
,
5162 (sizeof (lispy_kana_keys
)
5163 / sizeof (lispy_kana_keys
[0])));
5164 #endif /* XK_kana_A */
5167 #ifdef ISO_FUNCTION_KEY_OFFSET
5168 if (event
->code
< FUNCTION_KEY_OFFSET
5169 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5170 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5172 Qfunction_key
, Qnil
,
5173 iso_lispy_function_keys
, &func_key_syms
,
5174 (sizeof (iso_lispy_function_keys
)
5175 / sizeof (iso_lispy_function_keys
[0])));
5178 /* Handle system-specific or unknown keysyms. */
5179 if (event
->code
& (1 << 28)
5180 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5181 || (event
->code
- FUNCTION_KEY_OFFSET
5182 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5183 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5185 /* We need to use an alist rather than a vector as the cache
5186 since we can't make a vector long enuf. */
5187 if (NILP (current_kboard
->system_key_syms
))
5188 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5189 return modify_event_symbol (event
->code
,
5192 current_kboard
->Vsystem_key_alist
,
5193 0, ¤t_kboard
->system_key_syms
,
5197 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5199 Qfunction_key
, Qnil
,
5200 lispy_function_keys
, &func_key_syms
,
5201 (sizeof (lispy_function_keys
)
5202 / sizeof (lispy_function_keys
[0])));
5205 /* A mouse click. Figure out where it is, decide whether it's
5206 a press, click or drag, and build the appropriate structure. */
5207 case MOUSE_CLICK_EVENT
:
5208 #ifndef USE_TOOLKIT_SCROLL_BARS
5209 case SCROLL_BAR_CLICK_EVENT
:
5212 int button
= event
->code
;
5214 Lisp_Object position
;
5215 Lisp_Object
*start_pos_ptr
;
5216 Lisp_Object start_pos
;
5220 /* Build the position as appropriate for this mouse click. */
5221 if (event
->kind
== MOUSE_CLICK_EVENT
)
5223 struct frame
*f
= XFRAME (event
->frame_or_window
);
5224 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5228 /* Ignore mouse events that were made on frame that
5229 have been deleted. */
5230 if (! FRAME_LIVE_P (f
))
5233 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5234 /* EVENT->x and EVENT->y are frame-relative pixel
5235 coordinates at this place. Under old redisplay, COLUMN
5236 and ROW are set to frame relative glyph coordinates
5237 which are then used to determine whether this click is
5238 in a menu (non-toolkit version). */
5239 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5240 &column
, &row
, NULL
, 1);
5242 /* In the non-toolkit version, clicks on the menu bar
5243 are ordinary button events in the event buffer.
5244 Distinguish them, and invoke the menu.
5246 (In the toolkit version, the toolkit handles the menu bar
5247 and Emacs doesn't know about it until after the user
5248 makes a selection.) */
5249 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5250 && (event
->modifiers
& down_modifier
))
5252 Lisp_Object items
, item
;
5257 /* Activate the menu bar on the down event. If the
5258 up event comes in before the menu code can deal with it,
5260 if (! (event
->modifiers
& down_modifier
))
5264 /* Find the menu bar item under `column'. */
5266 items
= FRAME_MENU_BAR_ITEMS (f
);
5267 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5269 Lisp_Object pos
, string
;
5270 string
= AREF (items
, i
+ 1);
5271 pos
= AREF (items
, i
+ 3);
5274 if (column
>= XINT (pos
)
5275 && column
< XINT (pos
) + SCHARS (string
))
5277 item
= AREF (items
, i
);
5282 /* ELisp manual 2.4b says (x y) are window relative but
5283 code says they are frame-relative. */
5285 = Fcons (event
->frame_or_window
,
5287 Fcons (Fcons (event
->x
, event
->y
),
5288 Fcons (make_number (event
->timestamp
),
5291 return Fcons (item
, Fcons (position
, Qnil
));
5293 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5295 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5298 #ifndef USE_TOOLKIT_SCROLL_BARS
5301 /* It's a scrollbar click. */
5303 Lisp_Object portion_whole
;
5306 window
= event
->frame_or_window
;
5307 portion_whole
= Fcons (event
->x
, event
->y
);
5308 part
= *scroll_bar_parts
[(int) event
->part
];
5312 Fcons (Qvertical_scroll_bar
,
5313 Fcons (portion_whole
,
5314 Fcons (make_number (event
->timestamp
),
5315 Fcons (part
, Qnil
)))));
5317 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5319 if (button
>= ASIZE (button_down_location
))
5321 button_down_location
= larger_vector (button_down_location
,
5323 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5326 start_pos_ptr
= &AREF (button_down_location
, button
);
5327 start_pos
= *start_pos_ptr
;
5328 *start_pos_ptr
= Qnil
;
5331 /* On window-system frames, use the value of
5332 double-click-fuzz as is. On other frames, interpret it
5333 as a multiple of 1/8 characters. */
5337 if (WINDOWP (event
->frame_or_window
))
5338 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5339 else if (FRAMEP (event
->frame_or_window
))
5340 f
= XFRAME (event
->frame_or_window
);
5344 if (FRAME_WINDOW_P (f
))
5345 fuzz
= double_click_fuzz
;
5347 fuzz
= double_click_fuzz
/ 8;
5349 is_double
= (button
== last_mouse_button
5350 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5351 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5352 && button_down_time
!= 0
5353 && (EQ (Vdouble_click_time
, Qt
)
5354 || (INTEGERP (Vdouble_click_time
)
5355 && ((int)(event
->timestamp
- button_down_time
)
5356 < XINT (Vdouble_click_time
)))));
5359 last_mouse_button
= button
;
5360 last_mouse_x
= XINT (event
->x
);
5361 last_mouse_y
= XINT (event
->y
);
5363 /* If this is a button press, squirrel away the location, so
5364 we can decide later whether it was a click or a drag. */
5365 if (event
->modifiers
& down_modifier
)
5369 double_click_count
++;
5370 event
->modifiers
|= ((double_click_count
> 2)
5375 double_click_count
= 1;
5376 button_down_time
= event
->timestamp
;
5377 *start_pos_ptr
= Fcopy_alist (position
);
5380 /* Now we're releasing a button - check the co-ordinates to
5381 see if this was a click or a drag. */
5382 else if (event
->modifiers
& up_modifier
)
5384 /* If we did not see a down before this up, ignore the up.
5385 Probably this happened because the down event chose a
5386 menu item. It would be an annoyance to treat the
5387 release of the button that chose the menu item as a
5390 if (!CONSP (start_pos
))
5393 event
->modifiers
&= ~up_modifier
;
5394 #if 0 /* Formerly we treated an up with no down as a click event. */
5395 if (!CONSP (start_pos
))
5396 event
->modifiers
|= click_modifier
;
5401 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5403 /* The third element of every position
5404 should be the (x,y) pair. */
5405 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5407 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5409 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5410 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5413 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5414 && ydiff
< double_click_fuzz
5415 && ydiff
> - double_click_fuzz
)
5416 /* Mouse hasn't moved (much). */
5417 event
->modifiers
|= click_modifier
;
5420 button_down_time
= 0;
5421 event
->modifiers
|= drag_modifier
;
5424 /* Don't check is_double; treat this as multiple
5425 if the down-event was multiple. */
5426 if (double_click_count
> 1)
5427 event
->modifiers
|= ((double_click_count
> 2)
5433 /* Every mouse event should either have the down_modifier or
5434 the up_modifier set. */
5438 /* Get the symbol we should use for the mouse click. */
5441 head
= modify_event_symbol (button
,
5443 Qmouse_click
, Vlispy_mouse_stem
,
5446 XVECTOR (mouse_syms
)->size
);
5447 if (event
->modifiers
& drag_modifier
)
5452 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5455 Fcons (make_number (double_click_count
),
5466 Lisp_Object position
;
5469 /* Build the position as appropriate for this mouse click. */
5470 struct frame
*f
= XFRAME (event
->frame_or_window
);
5472 /* Ignore wheel events that were made on frame that have been
5474 if (! FRAME_LIVE_P (f
))
5477 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5480 /* Set double or triple modifiers to indicate the wheel speed. */
5482 /* On window-system frames, use the value of
5483 double-click-fuzz as is. On other frames, interpret it
5484 as a multiple of 1/8 characters. */
5489 if (WINDOWP (event
->frame_or_window
))
5490 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5491 else if (FRAMEP (event
->frame_or_window
))
5492 f
= XFRAME (event
->frame_or_window
);
5496 if (FRAME_WINDOW_P (f
))
5497 fuzz
= double_click_fuzz
;
5499 fuzz
= double_click_fuzz
/ 8;
5501 is_double
= (last_mouse_button
< 0
5502 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5503 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5504 && button_down_time
!= 0
5505 && (EQ (Vdouble_click_time
, Qt
)
5506 || (INTEGERP (Vdouble_click_time
)
5507 && ((int)(event
->timestamp
- button_down_time
)
5508 < XINT (Vdouble_click_time
)))));
5511 double_click_count
++;
5512 event
->modifiers
|= ((double_click_count
> 2)
5518 double_click_count
= 1;
5519 event
->modifiers
|= click_modifier
;
5522 button_down_time
= event
->timestamp
;
5523 /* Use a negative value to distinguish wheel from mouse button. */
5524 last_mouse_button
= -1;
5525 last_mouse_x
= XINT (event
->x
);
5526 last_mouse_y
= XINT (event
->y
);
5532 if (event
->modifiers
& up_modifier
)
5534 /* Emit a wheel-up event. */
5535 event
->modifiers
&= ~up_modifier
;
5538 else if (event
->modifiers
& down_modifier
)
5540 /* Emit a wheel-down event. */
5541 event
->modifiers
&= ~down_modifier
;
5545 /* Every wheel event should either have the down_modifier or
5546 the up_modifier set. */
5549 /* Get the symbol we should use for the wheel event. */
5550 head
= modify_event_symbol (symbol_num
,
5556 ASIZE (wheel_syms
));
5559 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5562 Fcons (make_number (double_click_count
),
5571 #ifdef USE_TOOLKIT_SCROLL_BARS
5573 /* We don't have down and up events if using toolkit scroll bars,
5574 so make this always a click event. Store in the `part' of
5575 the Lisp event a symbol which maps to the following actions:
5577 `above_handle' page up
5578 `below_handle' page down
5582 `bottom' bottom of buffer
5583 `handle' thumb has been dragged.
5584 `end-scroll' end of interaction with scroll bar
5586 The incoming input_event contains in its `part' member an
5587 index of type `enum scroll_bar_part' which we can use as an
5588 index in scroll_bar_parts to get the appropriate symbol. */
5590 case SCROLL_BAR_CLICK_EVENT
:
5592 Lisp_Object position
, head
, window
, portion_whole
, part
;
5594 window
= event
->frame_or_window
;
5595 portion_whole
= Fcons (event
->x
, event
->y
);
5596 part
= *scroll_bar_parts
[(int) event
->part
];
5600 Fcons (Qvertical_scroll_bar
,
5601 Fcons (portion_whole
,
5602 Fcons (make_number (event
->timestamp
),
5603 Fcons (part
, Qnil
)))));
5605 /* Always treat scroll bar events as clicks. */
5606 event
->modifiers
|= click_modifier
;
5607 event
->modifiers
&= ~up_modifier
;
5609 if (event
->code
>= ASIZE (mouse_syms
))
5610 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5612 /* Get the symbol we should use for the mouse click. */
5613 head
= modify_event_symbol (event
->code
,
5618 XVECTOR (mouse_syms
)->size
);
5619 return Fcons (head
, Fcons (position
, Qnil
));
5622 #endif /* USE_TOOLKIT_SCROLL_BARS */
5625 case W32_SCROLL_BAR_CLICK_EVENT
:
5627 int button
= event
->code
;
5629 Lisp_Object position
;
5630 Lisp_Object
*start_pos_ptr
;
5631 Lisp_Object start_pos
;
5635 Lisp_Object portion_whole
;
5638 window
= event
->frame_or_window
;
5639 portion_whole
= Fcons (event
->x
, event
->y
);
5640 part
= *scroll_bar_parts
[(int) event
->part
];
5644 Fcons (Qvertical_scroll_bar
,
5645 Fcons (portion_whole
,
5646 Fcons (make_number (event
->timestamp
),
5647 Fcons (part
, Qnil
)))));
5650 /* Always treat W32 scroll bar events as clicks. */
5651 event
->modifiers
|= click_modifier
;
5654 /* Get the symbol we should use for the mouse click. */
5657 head
= modify_event_symbol (button
,
5662 XVECTOR (mouse_syms
)->size
);
5668 #endif /* WINDOWSNT */
5670 case DRAG_N_DROP_EVENT
:
5673 Lisp_Object head
, position
;
5676 /* The frame_or_window field should be a cons of the frame in
5677 which the event occurred and a list of the filenames
5679 if (! CONSP (event
->frame_or_window
))
5682 f
= XFRAME (XCAR (event
->frame_or_window
));
5683 files
= XCDR (event
->frame_or_window
);
5685 /* Ignore mouse events that were made on frames that
5686 have been deleted. */
5687 if (! FRAME_LIVE_P (f
))
5690 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5693 head
= modify_event_symbol (0, event
->modifiers
,
5695 lispy_drag_n_drop_names
,
5696 &drag_n_drop_syms
, 1);
5702 #endif /* HAVE_MOUSE */
5704 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5705 || defined (USE_GTK)
5706 case MENU_BAR_EVENT
:
5707 if (EQ (event
->arg
, event
->frame_or_window
))
5708 /* This is the prefix key. We translate this to
5709 `(menu_bar)' because the code in keyboard.c for menu
5710 events, which we use, relies on this. */
5711 return Fcons (Qmenu_bar
, Qnil
);
5715 case SELECT_WINDOW_EVENT
:
5716 /* Make an event (select-window (WINDOW)). */
5717 return Fcons (Qselect_window
,
5718 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5721 case TOOL_BAR_EVENT
:
5722 if (EQ (event
->arg
, event
->frame_or_window
))
5723 /* This is the prefix key. We translate this to
5724 `(tool_bar)' because the code in keyboard.c for tool bar
5725 events, which we use, relies on this. */
5726 return Fcons (Qtool_bar
, Qnil
);
5727 else if (SYMBOLP (event
->arg
))
5728 return apply_modifiers (event
->modifiers
, event
->arg
);
5731 case USER_SIGNAL_EVENT
:
5732 /* A user signal. */
5733 return *lispy_user_signals
[event
->code
];
5735 case SAVE_SESSION_EVENT
:
5736 return Qsave_session
;
5738 /* The 'kind' field of the event is something we don't recognize. */
5747 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5749 Lisp_Object bar_window
;
5750 enum scroll_bar_part part
;
5754 /* Is it a scroll bar movement? */
5755 if (frame
&& ! NILP (bar_window
))
5757 Lisp_Object part_sym
;
5759 part_sym
= *scroll_bar_parts
[(int) part
];
5760 return Fcons (Qscroll_bar_movement
,
5761 (Fcons (Fcons (bar_window
,
5762 Fcons (Qvertical_scroll_bar
,
5763 Fcons (Fcons (x
, y
),
5764 Fcons (make_number (time
),
5770 /* Or is it an ordinary mouse movement? */
5773 Lisp_Object position
;
5775 position
= make_lispy_position (frame
, &x
, &y
, time
);
5777 return Fcons (Qmouse_movement
,
5783 #endif /* HAVE_MOUSE */
5785 /* Construct a switch frame event. */
5787 make_lispy_switch_frame (frame
)
5790 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5793 /* Manipulating modifiers. */
5795 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5797 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5798 SYMBOL's name of the end of the modifiers; the string from this
5799 position is the unmodified symbol name.
5801 This doesn't use any caches. */
5804 parse_modifiers_uncached (symbol
, modifier_end
)
5812 CHECK_SYMBOL (symbol
);
5815 name
= SYMBOL_NAME (symbol
);
5817 for (i
= 0; i
+2 <= SBYTES (name
); )
5819 int this_mod_end
= 0;
5822 /* See if the name continues with a modifier word.
5823 Check that the word appears, but don't check what follows it.
5824 Set this_mod and this_mod_end to record what we find. */
5826 switch (SREF (name
, i
))
5828 #define SINGLE_LETTER_MOD(BIT) \
5829 (this_mod_end = i + 1, this_mod = BIT)
5832 SINGLE_LETTER_MOD (alt_modifier
);
5836 SINGLE_LETTER_MOD (ctrl_modifier
);
5840 SINGLE_LETTER_MOD (hyper_modifier
);
5844 SINGLE_LETTER_MOD (meta_modifier
);
5848 SINGLE_LETTER_MOD (shift_modifier
);
5852 SINGLE_LETTER_MOD (super_modifier
);
5855 #undef SINGLE_LETTER_MOD
5857 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5858 if (i + LEN + 1 <= SBYTES (name) \
5859 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5861 this_mod_end = i + LEN; \
5866 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5867 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5868 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5872 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5874 #undef MULTI_LETTER_MOD
5878 /* If we found no modifier, stop looking for them. */
5879 if (this_mod_end
== 0)
5882 /* Check there is a dash after the modifier, so that it
5883 really is a modifier. */
5884 if (this_mod_end
>= SBYTES (name
)
5885 || SREF (name
, this_mod_end
) != '-')
5888 /* This modifier is real; look for another. */
5889 modifiers
|= this_mod
;
5890 i
= this_mod_end
+ 1;
5893 /* Should we include the `click' modifier? */
5894 if (! (modifiers
& (down_modifier
| drag_modifier
5895 | double_modifier
| triple_modifier
))
5896 && i
+ 7 == SBYTES (name
)
5897 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5898 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5899 modifiers
|= click_modifier
;
5907 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5908 prepended to the string BASE[0..BASE_LEN-1].
5909 This doesn't use any caches. */
5911 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5914 int base_len
, base_len_byte
;
5916 /* Since BASE could contain nulls, we can't use intern here; we have
5917 to use Fintern, which expects a genuine Lisp_String, and keeps a
5920 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5926 /* Only the event queue may use the `up' modifier; it should always
5927 be turned into a click or drag event before presented to lisp code. */
5928 if (modifiers
& up_modifier
)
5931 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5932 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5933 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5934 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5935 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5936 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5937 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5938 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5939 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5940 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5941 /* The click modifier is denoted by the absence of other modifiers. */
5945 mod_len
= p
- new_mods
;
5949 Lisp_Object new_name
;
5951 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5952 mod_len
+ base_len_byte
);
5953 bcopy (new_mods
, SDATA (new_name
), mod_len
);
5954 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
5956 return Fintern (new_name
, Qnil
);
5961 static char *modifier_names
[] =
5963 "up", "down", "drag", "click", "double", "triple", 0, 0,
5964 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5965 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5967 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5969 static Lisp_Object modifier_symbols
;
5971 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5973 lispy_modifier_list (modifiers
)
5976 Lisp_Object modifier_list
;
5979 modifier_list
= Qnil
;
5980 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
5981 if (modifiers
& (1<<i
))
5982 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
5985 return modifier_list
;
5989 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
5990 where UNMODIFIED is the unmodified form of SYMBOL,
5991 MASK is the set of modifiers present in SYMBOL's name.
5992 This is similar to parse_modifiers_uncached, but uses the cache in
5993 SYMBOL's Qevent_symbol_element_mask property, and maintains the
5994 Qevent_symbol_elements property. */
5997 parse_modifiers (symbol
)
6000 Lisp_Object elements
;
6002 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6003 if (CONSP (elements
))
6008 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6009 Lisp_Object unmodified
;
6012 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6013 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6016 if (modifiers
& ~INTMASK
)
6018 XSETFASTINT (mask
, modifiers
);
6019 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6021 /* Cache the parsing results on SYMBOL. */
6022 Fput (symbol
, Qevent_symbol_element_mask
,
6024 Fput (symbol
, Qevent_symbol_elements
,
6025 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6027 /* Since we know that SYMBOL is modifiers applied to unmodified,
6028 it would be nice to put that in unmodified's cache.
6029 But we can't, since we're not sure that parse_modifiers is
6036 /* Apply the modifiers MODIFIERS to the symbol BASE.
6037 BASE must be unmodified.
6039 This is like apply_modifiers_uncached, but uses BASE's
6040 Qmodifier_cache property, if present. It also builds
6041 Qevent_symbol_elements properties, since it has that info anyway.
6043 apply_modifiers copies the value of BASE's Qevent_kind property to
6044 the modified symbol. */
6046 apply_modifiers (modifiers
, base
)
6050 Lisp_Object cache
, index
, entry
, new_symbol
;
6052 /* Mask out upper bits. We don't know where this value's been. */
6053 modifiers
&= INTMASK
;
6055 /* The click modifier never figures into cache indices. */
6056 cache
= Fget (base
, Qmodifier_cache
);
6057 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6058 entry
= assq_no_quit (index
, cache
);
6061 new_symbol
= XCDR (entry
);
6064 /* We have to create the symbol ourselves. */
6065 new_symbol
= apply_modifiers_uncached (modifiers
,
6066 SDATA (SYMBOL_NAME (base
)),
6067 SCHARS (SYMBOL_NAME (base
)),
6068 SBYTES (SYMBOL_NAME (base
)));
6070 /* Add the new symbol to the base's cache. */
6071 entry
= Fcons (index
, new_symbol
);
6072 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6074 /* We have the parsing info now for free, so we could add it to
6076 XSETFASTINT (index, modifiers);
6077 Fput (new_symbol, Qevent_symbol_element_mask,
6078 Fcons (base, Fcons (index, Qnil)));
6079 Fput (new_symbol, Qevent_symbol_elements,
6080 Fcons (base, lispy_modifier_list (modifiers)));
6081 Sadly, this is only correct if `base' is indeed a base event,
6082 which is not necessarily the case. -stef */
6085 /* Make sure this symbol is of the same kind as BASE.
6087 You'd think we could just set this once and for all when we
6088 intern the symbol above, but reorder_modifiers may call us when
6089 BASE's property isn't set right; we can't assume that just
6090 because it has a Qmodifier_cache property it must have its
6091 Qevent_kind set right as well. */
6092 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6096 kind
= Fget (base
, Qevent_kind
);
6098 Fput (new_symbol
, Qevent_kind
, kind
);
6105 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6106 return a symbol with the modifiers placed in the canonical order.
6107 Canonical order is alphabetical, except for down and drag, which
6108 always come last. The 'click' modifier is never written out.
6110 Fdefine_key calls this to make sure that (for example) C-M-foo
6111 and M-C-foo end up being equivalent in the keymap. */
6114 reorder_modifiers (symbol
)
6117 /* It's hopefully okay to write the code this way, since everything
6118 will soon be in caches, and no consing will be done at all. */
6121 parsed
= parse_modifiers (symbol
);
6122 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6127 /* For handling events, we often want to produce a symbol whose name
6128 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6129 to some base, like the name of a function key or mouse button.
6130 modify_event_symbol produces symbols of this sort.
6132 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6133 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6136 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6137 into symbol names, or a string specifying a name stem used to
6138 construct a symbol name or the form `STEM-N', where N is the decimal
6139 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6140 non-nil; otherwise NAME_TABLE is used.
6142 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6143 persist between calls to modify_event_symbol that it can use to
6144 store a cache of the symbols it's generated for this NAME_TABLE
6145 before. The object stored there may be a vector or an alist.
6147 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6149 MODIFIERS is a set of modifier bits (as given in struct input_events)
6150 whose prefixes should be applied to the symbol name.
6152 SYMBOL_KIND is the value to be placed in the event_kind property of
6153 the returned symbol.
6155 The symbols we create are supposed to have an
6156 `event-symbol-elements' property, which lists the modifiers present
6157 in the symbol's name. */
6160 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6161 name_table
, symbol_table
, table_size
)
6164 Lisp_Object symbol_kind
;
6165 Lisp_Object name_alist_or_stem
;
6167 Lisp_Object
*symbol_table
;
6168 unsigned int table_size
;
6171 Lisp_Object symbol_int
;
6173 /* Get rid of the "vendor-specific" bit here. */
6174 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6176 /* Is this a request for a valid symbol? */
6177 if (symbol_num
< 0 || symbol_num
>= table_size
)
6180 if (CONSP (*symbol_table
))
6181 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6183 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6184 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6185 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6186 we've never used that symbol before. */
6189 if (! VECTORP (*symbol_table
)
6190 || XVECTOR (*symbol_table
)->size
!= table_size
)
6194 XSETFASTINT (size
, table_size
);
6195 *symbol_table
= Fmake_vector (size
, Qnil
);
6198 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6201 /* Have we already used this symbol before? */
6204 /* No; let's create it. */
6205 if (CONSP (name_alist_or_stem
))
6206 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6207 else if (STRINGP (name_alist_or_stem
))
6209 int len
= SBYTES (name_alist_or_stem
);
6210 char *buf
= (char *) alloca (len
+ 50);
6211 if (sizeof (int) == sizeof (EMACS_INT
))
6212 sprintf (buf
, "%s-%d", SDATA (name_alist_or_stem
),
6213 XINT (symbol_int
) + 1);
6214 else if (sizeof (long) == sizeof (EMACS_INT
))
6215 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6216 XINT (symbol_int
) + 1);
6217 value
= intern (buf
);
6219 else if (name_table
!= 0 && name_table
[symbol_num
])
6220 value
= intern (name_table
[symbol_num
]);
6222 #ifdef HAVE_WINDOW_SYSTEM
6225 char *name
= x_get_keysym_name (symbol_num
);
6227 value
= intern (name
);
6234 sprintf (buf
, "key-%d", symbol_num
);
6235 value
= intern (buf
);
6238 if (CONSP (*symbol_table
))
6239 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6241 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6243 /* Fill in the cache entries for this symbol; this also
6244 builds the Qevent_symbol_elements property, which the user
6246 apply_modifiers (modifiers
& click_modifier
, value
);
6247 Fput (value
, Qevent_kind
, symbol_kind
);
6250 /* Apply modifiers to that symbol. */
6251 return apply_modifiers (modifiers
, value
);
6254 /* Convert a list that represents an event type,
6255 such as (ctrl meta backspace), into the usual representation of that
6256 event type as a number or a symbol. */
6258 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6259 doc
: /* Convert the event description list EVENT-DESC to an event type.
6260 EVENT-DESC should contain one base event type (a character or symbol)
6261 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6262 drag, down, double or triple). The base must be last.
6263 The return value is an event type (a character or symbol) which
6264 has the same base event type and all the specified modifiers. */)
6266 Lisp_Object event_desc
;
6274 while (CONSP (rest
))
6282 /* Given a symbol, see if it is a modifier name. */
6283 if (SYMBOLP (elt
) && CONSP (rest
))
6284 this = parse_solitary_modifier (elt
);
6288 else if (!NILP (base
))
6289 error ("Two bases given in one event");
6295 /* Let the symbol A refer to the character A. */
6296 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6297 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6299 if (INTEGERP (base
))
6301 /* Turn (shift a) into A. */
6302 if ((modifiers
& shift_modifier
) != 0
6303 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6305 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6306 modifiers
&= ~shift_modifier
;
6309 /* Turn (control a) into C-a. */
6310 if (modifiers
& ctrl_modifier
)
6311 return make_number ((modifiers
& ~ctrl_modifier
)
6312 | make_ctrl_char (XINT (base
)));
6314 return make_number (modifiers
| XINT (base
));
6316 else if (SYMBOLP (base
))
6317 return apply_modifiers (modifiers
, base
);
6320 error ("Invalid base event");
6325 /* Try to recognize SYMBOL as a modifier name.
6326 Return the modifier flag bit, or 0 if not recognized. */
6329 parse_solitary_modifier (symbol
)
6332 Lisp_Object name
= SYMBOL_NAME (symbol
);
6334 switch (SREF (name
, 0))
6336 #define SINGLE_LETTER_MOD(BIT) \
6337 if (SBYTES (name) == 1) \
6340 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6341 if (LEN == SBYTES (name) \
6342 && ! strncmp (SDATA (name), NAME, LEN)) \
6346 SINGLE_LETTER_MOD (alt_modifier
);
6350 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6354 SINGLE_LETTER_MOD (ctrl_modifier
);
6358 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6359 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6363 SINGLE_LETTER_MOD (hyper_modifier
);
6367 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6371 SINGLE_LETTER_MOD (meta_modifier
);
6375 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6379 SINGLE_LETTER_MOD (shift_modifier
);
6383 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6384 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6385 SINGLE_LETTER_MOD (super_modifier
);
6389 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6390 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6391 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6395 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6398 #undef SINGLE_LETTER_MOD
6399 #undef MULTI_LETTER_MOD
6405 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6406 Such a list is not valid as an event,
6407 but it can be a Lucid-style event type list. */
6410 lucid_event_type_list_p (object
)
6415 if (! CONSP (object
))
6418 if (EQ (XCAR (object
), Qhelp_echo
)
6419 || EQ (XCAR (object
), Qvertical_line
)
6420 || EQ (XCAR (object
), Qmode_line
)
6421 || EQ (XCAR (object
), Qheader_line
))
6424 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6428 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6435 /* Store into *addr a value nonzero if terminal input chars are available.
6436 Serves the purpose of ioctl (0, FIONREAD, addr)
6437 but works even if FIONREAD does not exist.
6438 (In fact, this may actually read some input.)
6440 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6441 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6444 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6449 /* First of all, have we already counted some input? */
6450 *addr
= (!NILP (Vquit_flag
)
6451 || readable_filtered_events (do_timers_now
, filter_events
));
6453 /* If input is being read as it arrives, and we have none, there is none. */
6454 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6457 /* Try to read some input and see how much we get. */
6459 *addr
= (!NILP (Vquit_flag
)
6460 || readable_filtered_events (do_timers_now
, filter_events
));
6463 /* Store into *addr a value nonzero if terminal input chars are available.
6464 Serves the purpose of ioctl (0, FIONREAD, addr)
6465 but works even if FIONREAD does not exist.
6466 (In fact, this may actually read some input.)
6468 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6471 get_input_pending (addr
, do_timers_now
)
6475 get_filtered_input_pending (addr
, do_timers_now
, 0);
6478 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6481 gobble_input (expected
)
6486 if (interrupt_input
)
6489 mask
= sigblock (sigmask (SIGIO
));
6490 read_avail_input (expected
);
6494 #ifdef POLL_FOR_INPUT
6495 /* XXX This condition was (read_socket_hook && !interrupt_input),
6496 but read_socket_hook is not global anymore. Let's pretend that
6498 if (!interrupt_input
&& poll_suppress_count
== 0)
6501 mask
= sigblock (sigmask (SIGALRM
));
6502 read_avail_input (expected
);
6508 read_avail_input (expected
);
6512 /* Put a BUFFER_SWITCH_EVENT in the buffer
6513 so that read_key_sequence will notice the new current buffer. */
6516 record_asynch_buffer_change ()
6518 struct input_event event
;
6522 event
.kind
= BUFFER_SWITCH_EVENT
;
6523 event
.frame_or_window
= Qnil
;
6527 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6528 The purpose of the event is to make read_key_sequence look up the
6529 keymaps again. If we aren't in read_key_sequence, we don't need one,
6530 and the event could cause trouble by messing up (input-pending-p). */
6531 tem
= Fwaiting_for_user_input_p ();
6535 /* We never need these events if we have no asynchronous subprocesses. */
6539 /* Make sure no interrupt happens while storing the event. */
6541 if (interrupt_input
)
6544 mask
= sigblock (sigmask (SIGIO
));
6545 kbd_buffer_store_event (&event
);
6552 kbd_buffer_store_event (&event
);
6559 /* Read any terminal input already buffered up by the system
6560 into the kbd_buffer, but do not wait.
6562 EXPECTED should be nonzero if the caller knows there is some input.
6564 Except on VMS, all input is read by this function.
6565 If interrupt_input is nonzero, this function MUST be called
6566 only when SIGIO is blocked.
6568 Returns the number of keyboard chars read, or -1 meaning
6569 this is a bad time to try to read input. */
6572 read_avail_input (expected
)
6575 struct input_event buf
[KBD_BUFFER_SIZE
];
6580 for (i
= 0; i
< KBD_BUFFER_SIZE
; i
++)
6581 EVENT_INIT (buf
[i
]);
6586 struct display
*next
= d
->next_display
;
6588 if (d
->read_socket_hook
)
6589 /* No need for FIONREAD or fcntl; just say don't wait. */
6590 nread
= (*d
->read_socket_hook
) (d
, buf
, KBD_BUFFER_SIZE
, expected
);
6594 /* The display device terminated; it should be closed. */
6596 /* Kill Emacs if this was our last display. */
6597 if (! display_list
->next_display
)
6598 kill (getpid (), SIGHUP
);
6600 /* XXX Is calling delete_display safe here? It calls Fdelete_frame. */
6601 if (d
->delete_display_hook
)
6602 (*d
->delete_display_hook
) (d
);
6608 /* We've got input. */
6615 /* Scan the chars for C-g and store them in kbd_buffer. */
6616 for (i
= 0; i
< nread
; i
++)
6618 kbd_buffer_store_event (&buf
[i
]);
6619 /* Don't look at input that follows a C-g too closely.
6620 This reduces lossage due to autorepeat on C-g. */
6621 if (buf
[i
].kind
== ASCII_KEYSTROKE_EVENT
6622 && buf
[i
].code
== quit_char
)
6629 /* This is the tty way of reading available input.
6631 Note that each terminal device has its own `struct display' object,
6632 and so this function is called once for each individual termcap
6633 display. The first parameter indicates which device to read from. */
6636 tty_read_avail_input (struct display
*display
,
6637 struct input_event
*buf
,
6638 int numchars
, int expected
)
6640 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6641 the kbd_buffer can really hold. That may prevent loss
6642 of characters on some systems when input is stuffed at us. */
6643 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6645 struct tty_display_info
*tty
= display
->display_info
.tty
;
6649 if (display
->type
!= output_termcap
)
6652 /* XXX I think the following code should be moved to separate
6653 functions in system-dependent files. */
6656 #else /* not WINDOWSNT */
6658 n_to_read
= dos_keysns ();
6662 cbuf
[0] = dos_keyread ();
6665 #else /* not MSDOS */
6667 if (! tty
->term_initted
)
6670 /* Determine how many characters we should *try* to read. */
6672 /* Find out how much input is available. */
6673 if (ioctl (fileno (TTY_INPUT (tty
)), FIONREAD
, &n_to_read
) < 0)
6675 if (! noninteractive
)
6676 return -2; /* Close this display. */
6682 if (n_to_read
> sizeof cbuf
)
6683 n_to_read
= sizeof cbuf
;
6684 #else /* no FIONREAD */
6685 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6686 /* Read some input if available, but don't wait. */
6687 n_to_read
= sizeof cbuf
;
6688 fcntl (fileno (TTY_INPUT (tty
)), F_SETFL
, O_NDELAY
);
6694 /* Now read; for one reason or another, this will not block.
6695 NREAD is set to the number of chars read. */
6698 nread
= emacs_read (fileno (TTY_INPUT (tty
)), cbuf
, n_to_read
);
6699 /* POSIX infers that processes which are not in the session leader's
6700 process group won't get SIGHUP's at logout time. BSDI adheres to
6701 this part standard and returns -1 from read (0) with errno==EIO
6702 when the control tty is taken away.
6703 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6704 if (nread
== -1 && errno
== EIO
)
6706 return -2; /* Close this display. */
6708 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6709 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6710 This looks incorrect, but it isn't, because _BSD causes
6711 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6712 and that causes a value other than 0 when there is no input. */
6715 return -2; /* Close this display. */
6720 /* We used to retry the read if it was interrupted.
6721 But this does the wrong thing when O_NDELAY causes
6722 an EAGAIN error. Does anybody know of a situation
6723 where a retry is actually needed? */
6725 nread
< 0 && (errno
== EAGAIN
6739 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6740 fcntl (fileno (TTY_INPUT (tty
)), F_SETFL
, 0);
6741 #endif /* USG or DGUX or CYGWIN */
6742 #endif /* no FIONREAD */
6747 #endif /* not MSDOS */
6748 #endif /* not WINDOWSNT */
6750 /* Select the frame corresponding to the active tty. Note that the
6751 value of selected_frame is not reliable here, redisplay tends to
6752 temporarily change it. */
6753 frame
= tty
->top_frame
;
6755 for (i
= 0; i
< nread
; i
++)
6757 buf
[i
].kind
= ASCII_KEYSTROKE_EVENT
;
6758 buf
[i
].modifiers
= 0;
6759 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
6760 buf
[i
].modifiers
= meta_modifier
;
6761 if (tty
->meta_key
!= 2)
6764 buf
[i
].code
= cbuf
[i
];
6765 buf
[i
].frame_or_window
= frame
;
6772 #endif /* not VMS */
6775 handle_async_input ()
6778 extern int select_alarmed
;
6780 interrupt_input_pending
= 0;
6785 nread
= read_avail_input (1);
6786 /* -1 means it's not ok to read the input now.
6787 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6788 0 means there was no keyboard input available. */
6793 select_alarmed
= 1; /* Force the select emulator back to life */
6798 #ifdef SIGIO /* for entire page */
6799 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6802 input_available_signal (signo
)
6805 /* Must preserve main program's value of errno. */
6806 int old_errno
= errno
;
6808 #if defined (USG) && !defined (POSIX_SIGNALS)
6809 /* USG systems forget handlers when they are used;
6810 must reestablish each time */
6811 signal (signo
, input_available_signal
);
6818 if (input_available_clear_time
)
6819 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6822 interrupt_input_pending
= 1;
6824 handle_async_input ();
6834 /* Send ourselves a SIGIO.
6836 This function exists so that the UNBLOCK_INPUT macro in
6837 blockinput.h can have some way to take care of input we put off
6838 dealing with, without assuming that every file which uses
6839 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6841 reinvoke_input_signal ()
6844 handle_async_input ();
6850 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6851 static Lisp_Object menu_bar_one_keymap_changed_items
;
6853 /* These variables hold the vector under construction within
6854 menu_bar_items and its subroutines, and the current index
6855 for storing into that vector. */
6856 static Lisp_Object menu_bar_items_vector
;
6857 static int menu_bar_items_index
;
6859 /* Return a vector of menu items for a menu bar, appropriate
6860 to the current buffer. Each item has three elements in the vector:
6863 OLD is an old vector we can optionally reuse, or nil. */
6866 menu_bar_items (old
)
6869 /* The number of keymaps we're scanning right now, and the number of
6870 keymaps we have allocated space for. */
6873 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6874 in the current keymaps, or nil where it is not a prefix. */
6877 Lisp_Object def
, tail
;
6886 struct gcpro gcpro1
;
6888 /* In order to build the menus, we need to call the keymap
6889 accessors. They all call QUIT. But this function is called
6890 during redisplay, during which a quit is fatal. So inhibit
6891 quitting while building the menus.
6892 We do this instead of specbind because (1) errors will clear it anyway
6893 and (2) this avoids risk of specpdl overflow. */
6894 oquit
= Vinhibit_quit
;
6898 menu_bar_items_vector
= old
;
6900 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6901 menu_bar_items_index
= 0;
6903 GCPRO1 (menu_bar_items_vector
);
6905 /* Build our list of keymaps.
6906 If we recognize a function key and replace its escape sequence in
6907 keybuf with its symbol, or if the sequence starts with a mouse
6908 click and we need to switch buffers, we jump back here to rebuild
6909 the initial keymaps from the current buffer. */
6913 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6914 if (!NILP (Voverriding_local_map_menu_flag
))
6916 /* Yes, use them (if non-nil) as well as the global map. */
6917 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6919 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6920 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6921 if (!NILP (Voverriding_local_map
))
6922 maps
[nmaps
++] = Voverriding_local_map
;
6926 /* No, so use major and minor mode keymaps and keymap property.
6927 Note that menu-bar bindings in the local-map and keymap
6928 properties may not work reliable, as they are only
6929 recognized when the menu-bar (or mode-line) is updated,
6930 which does not normally happen after every command. */
6933 nminor
= current_minor_maps (NULL
, &tmaps
);
6934 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6936 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6937 maps
[nmaps
++] = tem
;
6938 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6940 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6942 maps
[nmaps
++] = current_global_map
;
6945 /* Look up in each map the dummy prefix key `menu-bar'. */
6949 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6950 if (!NILP (maps
[mapno
]))
6952 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6956 menu_bar_one_keymap_changed_items
= Qnil
;
6957 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
6961 /* Move to the end those items that should be at the end. */
6963 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6966 int end
= menu_bar_items_index
;
6968 for (i
= 0; i
< end
; i
+= 4)
6969 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6971 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6972 /* Move the item at index I to the end,
6973 shifting all the others forward. */
6974 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6975 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6976 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6977 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6979 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6980 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6981 (end
- i
- 4) * sizeof (Lisp_Object
));
6982 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6983 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6984 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6985 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6990 /* Add nil, nil, nil, nil at the end. */
6991 i
= menu_bar_items_index
;
6992 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6995 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6996 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6997 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6998 menu_bar_items_vector
= tem
;
7000 /* Add this item. */
7001 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7002 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7003 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7004 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7005 menu_bar_items_index
= i
;
7007 Vinhibit_quit
= oquit
;
7009 return menu_bar_items_vector
;
7012 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7013 If there's already an item for KEY, add this DEF to it. */
7015 Lisp_Object item_properties
;
7018 menu_bar_item (key
, item
, dummy1
, dummy2
)
7019 Lisp_Object key
, item
, dummy1
;
7022 struct gcpro gcpro1
;
7026 if (EQ (item
, Qundefined
))
7028 /* If a map has an explicit `undefined' as definition,
7029 discard any previously made menu bar item. */
7031 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7032 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7034 if (menu_bar_items_index
> i
+ 4)
7035 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7036 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7037 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7038 menu_bar_items_index
-= 4;
7042 /* If this keymap has already contributed to this KEY,
7043 don't contribute to it a second time. */
7044 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7045 if (!NILP (tem
) || NILP (item
))
7048 menu_bar_one_keymap_changed_items
7049 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7051 /* We add to menu_bar_one_keymap_changed_items before doing the
7052 parse_menu_item, so that if it turns out it wasn't a menu item,
7053 it still correctly hides any further menu item. */
7055 i
= parse_menu_item (item
, 0, 1);
7060 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7062 /* Find any existing item for this KEY. */
7063 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7064 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7067 /* If we did not find this KEY, add it at the end. */
7068 if (i
== menu_bar_items_index
)
7070 /* If vector is too small, get a bigger one. */
7071 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7074 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7075 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7076 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7077 menu_bar_items_vector
= tem
;
7080 /* Add this item. */
7081 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7082 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7083 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7084 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7085 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7086 menu_bar_items_index
= i
;
7088 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7092 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7093 /* If the new and the old items are not both keymaps,
7094 the lookup will only find `item'. */
7095 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7096 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7100 /* This is used as the handler when calling menu_item_eval_property. */
7102 menu_item_eval_property_1 (arg
)
7105 /* If we got a quit from within the menu computation,
7106 quit all the way out of it. This takes care of C-] in the debugger. */
7107 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7108 Fsignal (Qquit
, Qnil
);
7113 /* Evaluate an expression and return the result (or nil if something
7114 went wrong). Used to evaluate dynamic parts of menu items. */
7116 menu_item_eval_property (sexpr
)
7119 int count
= SPECPDL_INDEX ();
7121 specbind (Qinhibit_redisplay
, Qt
);
7122 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7123 menu_item_eval_property_1
);
7124 return unbind_to (count
, val
);
7127 /* This function parses a menu item and leaves the result in the
7128 vector item_properties.
7129 ITEM is a key binding, a possible menu item.
7130 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7131 evaluate dynamic expressions in the menu item.
7132 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7134 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7135 parse_menu_item returns true if the item is a menu item and false
7139 parse_menu_item (item
, notreal
, inmenubar
)
7141 int notreal
, inmenubar
;
7143 Lisp_Object def
, tem
, item_string
, start
;
7144 Lisp_Object cachelist
;
7146 Lisp_Object keyhint
;
7157 /* Create item_properties vector if necessary. */
7158 if (NILP (item_properties
))
7160 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7162 /* Initialize optional entries. */
7163 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7164 AREF (item_properties
, i
) = Qnil
;
7165 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7167 /* Save the item here to protect it from GC. */
7168 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7170 item_string
= XCAR (item
);
7174 if (STRINGP (item_string
))
7176 /* Old format menu item. */
7177 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7179 /* Maybe help string. */
7180 if (CONSP (item
) && STRINGP (XCAR (item
)))
7182 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7187 /* Maybe key binding cache. */
7188 if (CONSP (item
) && CONSP (XCAR (item
))
7189 && (NILP (XCAR (XCAR (item
)))
7190 || VECTORP (XCAR (XCAR (item
)))))
7192 cachelist
= XCAR (item
);
7196 /* This is the real definition--the function to run. */
7197 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7199 /* Get enable property, if any. */
7202 tem
= Fget (item
, Qmenu_enable
);
7204 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7207 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7209 /* New format menu item. */
7210 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7211 start
= XCDR (item
);
7214 /* We have a real binding. */
7215 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7217 item
= XCDR (start
);
7218 /* Is there a cache list with key equivalences. */
7219 if (CONSP (item
) && CONSP (XCAR (item
)))
7221 cachelist
= XCAR (item
);
7225 /* Parse properties. */
7226 while (CONSP (item
) && CONSP (XCDR (item
)))
7231 if (EQ (tem
, QCenable
))
7232 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7233 else if (EQ (tem
, QCvisible
) && !notreal
)
7235 /* If got a visible property and that evaluates to nil
7236 then ignore this item. */
7237 tem
= menu_item_eval_property (XCAR (item
));
7241 else if (EQ (tem
, QChelp
))
7242 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7243 else if (EQ (tem
, QCfilter
))
7245 else if (EQ (tem
, QCkey_sequence
))
7248 if (NILP (cachelist
)
7249 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7250 /* Be GC protected. Set keyhint to item instead of tem. */
7253 else if (EQ (tem
, QCkeys
))
7256 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7257 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7259 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7264 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7266 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7268 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7275 else if (inmenubar
|| !NILP (start
))
7279 return 0; /* not a menu item */
7281 /* If item string is not a string, evaluate it to get string.
7282 If we don't get a string, skip this item. */
7283 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7284 if (!(STRINGP (item_string
) || notreal
))
7286 item_string
= menu_item_eval_property (item_string
);
7287 if (!STRINGP (item_string
))
7289 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7292 /* If got a filter apply it on definition. */
7293 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7296 def
= menu_item_eval_property (list2 (XCAR (filter
),
7297 list2 (Qquote
, def
)));
7299 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7302 /* Enable or disable selection of item. */
7303 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7309 tem
= menu_item_eval_property (tem
);
7310 if (inmenubar
&& NILP (tem
))
7311 return 0; /* Ignore disabled items in menu bar. */
7312 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7315 /* If we got no definition, this item is just unselectable text which
7316 is OK in a submenu but not in the menubar. */
7318 return (inmenubar
? 0 : 1);
7320 /* See if this is a separate pane or a submenu. */
7321 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7322 tem
= get_keymap (def
, 0, 1);
7323 /* For a subkeymap, just record its details and exit. */
7326 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7327 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7331 /* At the top level in the menu bar, do likewise for commands also.
7332 The menu bar does not display equivalent key bindings anyway.
7333 ITEM_PROPERTY_DEF is already set up properly. */
7337 /* This is a command. See if there is an equivalent key binding. */
7338 if (NILP (cachelist
))
7340 /* We have to create a cachelist. */
7341 CHECK_IMPURE (start
);
7342 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7343 cachelist
= XCAR (XCDR (start
));
7345 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7346 if (!NILP (keyhint
))
7348 XSETCAR (cachelist
, XCAR (keyhint
));
7351 else if (STRINGP (tem
))
7353 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7354 XSETCAR (cachelist
, Qt
);
7358 tem
= XCAR (cachelist
);
7365 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7367 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7370 def
= XCAR (prefix
);
7371 prefix
= XCDR (prefix
);
7374 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7376 if (!update_menu_bindings
)
7378 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7380 if (newcache
/* Always check first time. */
7381 /* Should we check everything when precomputing key
7383 /* If something had no key binding before, don't recheck it
7384 because that is too slow--except if we have a list of
7385 rebound commands in Vdefine_key_rebound_commands, do
7386 recheck any command that appears in that list. */
7387 || (CONSP (Vdefine_key_rebound_commands
)
7388 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7391 /* We had a saved key. Is it still bound to the command? */
7394 /* If the command is an alias for another
7395 (such as lmenu.el set it up), check if the
7396 original command matches the cached command. */
7397 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7398 chkcache
= 1; /* Need to recompute key binding. */
7402 /* Recompute equivalent key binding. If the command is an alias
7403 for another (such as lmenu.el set it up), see if the original
7404 command name has equivalent keys. Otherwise look up the
7405 specified command itself. We don't try both, because that
7406 makes lmenu menus slow. */
7408 && SYMBOLP (XSYMBOL (def
)->function
)
7409 && ! NILP (Fget (def
, Qmenu_alias
)))
7410 def
= XSYMBOL (def
)->function
;
7411 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7412 XSETCAR (cachelist
, tem
);
7415 XSETCDR (cachelist
, Qnil
);
7419 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7421 tem
= XCAR (cachelist
);
7425 newcache
= chkcache
;
7428 tem
= Fkey_description (tem
);
7431 if (STRINGP (XCAR (prefix
)))
7432 tem
= concat2 (XCAR (prefix
), tem
);
7433 if (STRINGP (XCDR (prefix
)))
7434 tem
= concat2 (tem
, XCDR (prefix
));
7436 XSETCDR (cachelist
, tem
);
7440 tem
= XCDR (cachelist
);
7441 if (newcache
&& !NILP (tem
))
7443 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7444 XSETCDR (cachelist
, tem
);
7447 /* If we only want to precompute equivalent key bindings, stop here. */
7451 /* If we have an equivalent key binding, use that. */
7452 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7454 /* Include this when menu help is implemented.
7455 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7456 if (!(NILP (tem) || STRINGP (tem)))
7458 tem = menu_item_eval_property (tem);
7461 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7465 /* Handle radio buttons or toggle boxes. */
7466 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7468 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7469 = menu_item_eval_property (tem
);
7476 /***********************************************************************
7478 ***********************************************************************/
7480 /* A vector holding tool bar items while they are parsed in function
7481 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7484 static Lisp_Object tool_bar_items_vector
;
7486 /* A vector holding the result of parse_tool_bar_item. Layout is like
7487 the one for a single item in tool_bar_items_vector. */
7489 static Lisp_Object tool_bar_item_properties
;
7491 /* Next free index in tool_bar_items_vector. */
7493 static int ntool_bar_items
;
7495 /* The symbols `tool-bar', and `:image'. */
7497 extern Lisp_Object Qtool_bar
;
7498 Lisp_Object QCimage
;
7500 /* Function prototypes. */
7502 static void init_tool_bar_items
P_ ((Lisp_Object
));
7503 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7504 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7505 static void append_tool_bar_item
P_ ((void));
7508 /* Return a vector of tool bar items for keymaps currently in effect.
7509 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7510 tool bar items found. */
7513 tool_bar_items (reuse
, nitems
)
7524 /* In order to build the menus, we need to call the keymap
7525 accessors. They all call QUIT. But this function is called
7526 during redisplay, during which a quit is fatal. So inhibit
7527 quitting while building the menus. We do this instead of
7528 specbind because (1) errors will clear it anyway and (2) this
7529 avoids risk of specpdl overflow. */
7530 oquit
= Vinhibit_quit
;
7533 /* Initialize tool_bar_items_vector and protect it from GC. */
7534 init_tool_bar_items (reuse
);
7536 /* Build list of keymaps in maps. Set nmaps to the number of maps
7539 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7540 if (!NILP (Voverriding_local_map_menu_flag
))
7542 /* Yes, use them (if non-nil) as well as the global map. */
7543 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7545 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7546 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7547 if (!NILP (Voverriding_local_map
))
7548 maps
[nmaps
++] = Voverriding_local_map
;
7552 /* No, so use major and minor mode keymaps and keymap property.
7553 Note that tool-bar bindings in the local-map and keymap
7554 properties may not work reliable, as they are only
7555 recognized when the tool-bar (or mode-line) is updated,
7556 which does not normally happen after every command. */
7559 nminor
= current_minor_maps (NULL
, &tmaps
);
7560 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7562 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7563 maps
[nmaps
++] = tem
;
7564 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7566 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7569 /* Add global keymap at the end. */
7570 maps
[nmaps
++] = current_global_map
;
7572 /* Process maps in reverse order and look up in each map the prefix
7574 for (i
= nmaps
- 1; i
>= 0; --i
)
7575 if (!NILP (maps
[i
]))
7579 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7584 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7585 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7587 Lisp_Object keydef
= XCAR (tail
);
7589 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7594 Vinhibit_quit
= oquit
;
7595 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7596 return tool_bar_items_vector
;
7600 /* Process the definition of KEY which is DEF. */
7603 process_tool_bar_item (key
, def
)
7604 Lisp_Object key
, def
;
7607 extern Lisp_Object Qundefined
;
7608 struct gcpro gcpro1
, gcpro2
;
7610 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7614 if (EQ (def
, Qundefined
))
7616 /* If a map has an explicit `undefined' as definition,
7617 discard any previously made item. */
7618 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7620 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7622 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7624 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7625 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7626 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7627 * sizeof (Lisp_Object
)));
7628 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7633 else if (parse_tool_bar_item (key
, def
))
7634 /* Append a new tool bar item to tool_bar_items_vector. Accept
7635 more than one definition for the same key. */
7636 append_tool_bar_item ();
7642 /* Parse a tool bar item specification ITEM for key KEY and return the
7643 result in tool_bar_item_properties. Value is zero if ITEM is
7646 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7648 CAPTION is the caption of the item, If it's not a string, it is
7649 evaluated to get a string.
7651 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7652 as binding are currently ignored.
7654 The following properties are recognized:
7658 FORM is evaluated and specifies whether the tool bar item is
7659 enabled or disabled.
7663 FORM is evaluated and specifies whether the tool bar item is visible.
7665 - `:filter FUNCTION'
7667 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7668 result is stored as the new binding.
7670 - `:button (TYPE SELECTED)'
7672 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7673 and specifies whether the button is selected (pressed) or not.
7677 IMAGES is either a single image specification or a vector of four
7678 image specifications. See enum tool_bar_item_images.
7680 - `:help HELP-STRING'.
7682 Gives a help string to display for the tool bar item. */
7685 parse_tool_bar_item (key
, item
)
7686 Lisp_Object key
, item
;
7688 /* Access slot with index IDX of vector tool_bar_item_properties. */
7689 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7691 Lisp_Object filter
= Qnil
;
7692 Lisp_Object caption
;
7695 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7696 Rule out items that aren't lists, don't start with
7697 `menu-item' or whose rest following `tool-bar-item' is not a
7700 || !EQ (XCAR (item
), Qmenu_item
)
7701 || (item
= XCDR (item
),
7705 /* Create tool_bar_item_properties vector if necessary. Reset it to
7707 if (VECTORP (tool_bar_item_properties
))
7709 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7713 tool_bar_item_properties
7714 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7717 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7718 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7720 /* Get the caption of the item. If the caption is not a string,
7721 evaluate it to get a string. If we don't get a string, skip this
7723 caption
= XCAR (item
);
7724 if (!STRINGP (caption
))
7726 caption
= menu_item_eval_property (caption
);
7727 if (!STRINGP (caption
))
7730 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7732 /* Give up if rest following the caption is not a list. */
7737 /* Store the binding. */
7738 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7741 /* Ignore cached key binding, if any. */
7742 if (CONSP (item
) && CONSP (XCAR (item
)))
7745 /* Process the rest of the properties. */
7746 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7748 Lisp_Object key
, value
;
7751 value
= XCAR (XCDR (item
));
7753 if (EQ (key
, QCenable
))
7754 /* `:enable FORM'. */
7755 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7756 else if (EQ (key
, QCvisible
))
7758 /* `:visible FORM'. If got a visible property and that
7759 evaluates to nil then ignore this item. */
7760 if (NILP (menu_item_eval_property (value
)))
7763 else if (EQ (key
, QChelp
))
7764 /* `:help HELP-STRING'. */
7765 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7766 else if (EQ (key
, QCfilter
))
7767 /* ':filter FORM'. */
7769 else if (EQ (key
, QCbutton
) && CONSP (value
))
7771 /* `:button (TYPE . SELECTED)'. */
7772 Lisp_Object type
, selected
;
7774 type
= XCAR (value
);
7775 selected
= XCDR (value
);
7776 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7778 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7779 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7782 else if (EQ (key
, QCimage
)
7784 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7785 /* Value is either a single image specification or a vector
7786 of 4 such specifications for the different button states. */
7787 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7790 /* If got a filter apply it on binding. */
7792 PROP (TOOL_BAR_ITEM_BINDING
)
7793 = menu_item_eval_property (list2 (filter
,
7795 PROP (TOOL_BAR_ITEM_BINDING
))));
7797 /* See if the binding is a keymap. Give up if it is. */
7798 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7801 /* Enable or disable selection of item. */
7802 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7803 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7804 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7806 /* Handle radio buttons or toggle boxes. */
7807 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7808 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7809 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7817 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7818 that can be reused. */
7821 init_tool_bar_items (reuse
)
7824 if (VECTORP (reuse
))
7825 tool_bar_items_vector
= reuse
;
7827 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7828 ntool_bar_items
= 0;
7832 /* Append parsed tool bar item properties from
7833 tool_bar_item_properties */
7836 append_tool_bar_item ()
7838 Lisp_Object
*to
, *from
;
7840 /* Enlarge tool_bar_items_vector if necessary. */
7841 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7842 >= XVECTOR (tool_bar_items_vector
)->size
)
7844 Lisp_Object new_vector
;
7845 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7847 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7848 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7849 XVECTOR (new_vector
)->contents
,
7850 old_size
* sizeof (Lisp_Object
));
7851 tool_bar_items_vector
= new_vector
;
7854 /* Append entries from tool_bar_item_properties to the end of
7855 tool_bar_items_vector. */
7856 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7857 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7858 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7859 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7866 /* Read a character using menus based on maps in the array MAPS.
7867 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7868 Return t if we displayed a menu but the user rejected it.
7870 PREV_EVENT is the previous input event, or nil if we are reading
7871 the first event of a key sequence.
7873 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7874 if we used a mouse menu to read the input, or zero otherwise. If
7875 USED_MOUSE_MENU is null, we don't dereference it.
7877 The prompting is done based on the prompt-string of the map
7878 and the strings associated with various map elements.
7880 This can be done with X menus or with menus put in the minibuf.
7881 These are done in different ways, depending on how the input will be read.
7882 Menus using X are done after auto-saving in read-char, getting the input
7883 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7884 and do auto-saving in the inner call of read_char. */
7887 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7890 Lisp_Object prev_event
;
7891 int *used_mouse_menu
;
7894 register Lisp_Object name
= Qnil
;
7896 if (used_mouse_menu
)
7897 *used_mouse_menu
= 0;
7899 /* Use local over global Menu maps */
7901 if (! menu_prompting
)
7904 /* Optionally disregard all but the global map. */
7905 if (inhibit_local_menu_bar_menus
)
7907 maps
+= (nmaps
- 1);
7911 /* Get the menu name from the first map that has one (a prompt string). */
7912 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7914 name
= Fkeymap_prompt (maps
[mapno
]);
7919 /* If we don't have any menus, just read a character normally. */
7920 if (!STRINGP (name
))
7924 /* If we got to this point via a mouse click,
7925 use a real menu for mouse selection. */
7926 if (EVENT_HAS_PARAMETERS (prev_event
)
7927 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7928 && !EQ (XCAR (prev_event
), Qtool_bar
))
7930 /* Display the menu and get the selection. */
7931 Lisp_Object
*realmaps
7932 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7936 /* Use the maps that are not nil. */
7937 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7938 if (!NILP (maps
[mapno
]))
7939 realmaps
[nmaps1
++] = maps
[mapno
];
7941 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7946 record_menu_key (XCAR (value
));
7948 /* If we got multiple events, unread all but
7950 There is no way to prevent those unread events
7951 from showing up later in last_nonmenu_event.
7952 So turn symbol and integer events into lists,
7953 to indicate that they came from a mouse menu,
7954 so that when present in last_nonmenu_event
7955 they won't confuse things. */
7956 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7958 record_menu_key (XCAR (tem
));
7959 if (SYMBOLP (XCAR (tem
))
7960 || INTEGERP (XCAR (tem
)))
7961 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7964 /* If we got more than one event, put all but the first
7965 onto this list to be read later.
7966 Return just the first event now. */
7967 Vunread_command_events
7968 = nconc2 (XCDR (value
), Vunread_command_events
);
7969 value
= XCAR (value
);
7971 else if (NILP (value
))
7973 if (used_mouse_menu
)
7974 *used_mouse_menu
= 1;
7977 #endif /* HAVE_MENUS */
7981 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7982 We make this bigger when necessary, and never free it. */
7983 static char *read_char_minibuf_menu_text
;
7984 /* Size of that buffer. */
7985 static int read_char_minibuf_menu_width
;
7988 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7994 register Lisp_Object name
;
7996 /* FIXME: Use the minibuffer's frame width. */
7997 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8000 Lisp_Object rest
, vector
;
8006 if (! menu_prompting
)
8009 /* Make sure we have a big enough buffer for the menu text. */
8010 if (read_char_minibuf_menu_text
== 0)
8012 read_char_minibuf_menu_width
= width
+ 4;
8013 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8015 else if (width
+ 4 > read_char_minibuf_menu_width
)
8017 read_char_minibuf_menu_width
= width
+ 4;
8018 read_char_minibuf_menu_text
8019 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8021 menu
= read_char_minibuf_menu_text
;
8023 /* Get the menu name from the first map that has one (a prompt string). */
8024 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8026 name
= Fkeymap_prompt (maps
[mapno
]);
8031 /* If we don't have any menus, just read a character normally. */
8032 if (!STRINGP (name
))
8035 /* Prompt string always starts with map's prompt, and a space. */
8036 strcpy (menu
, SDATA (name
));
8037 nlength
= SBYTES (name
);
8038 menu
[nlength
++] = ':';
8039 menu
[nlength
++] = ' ';
8042 /* Start prompting at start of first map. */
8046 /* Present the documented bindings, a line at a time. */
8053 Lisp_Object orig_defn_macro
;
8055 /* Loop over elements of map. */
8060 /* If reached end of map, start at beginning of next map. */
8064 /* At end of last map, wrap around to first map if just starting,
8065 or end this line if already have something on it. */
8069 if (notfirst
|| nobindings
) break;
8074 /* Look at the next element of the map. */
8076 elt
= XVECTOR (vector
)->contents
[idx
];
8078 elt
= Fcar_safe (rest
);
8080 if (idx
< 0 && VECTORP (elt
))
8082 /* If we found a dense table in the keymap,
8083 advanced past it, but start scanning its contents. */
8084 rest
= Fcdr_safe (rest
);
8090 /* An ordinary element. */
8091 Lisp_Object event
, tem
;
8095 event
= Fcar_safe (elt
); /* alist */
8096 elt
= Fcdr_safe (elt
);
8100 XSETINT (event
, idx
); /* vector */
8103 /* Ignore the element if it has no prompt string. */
8104 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8106 /* 1 if the char to type matches the string. */
8108 Lisp_Object upcased_event
, downcased_event
;
8109 Lisp_Object desc
= Qnil
;
8111 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8113 upcased_event
= Fupcase (event
);
8114 downcased_event
= Fdowncase (event
);
8115 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8116 || XINT (downcased_event
) == SREF (s
, 0));
8118 desc
= Fsingle_key_description (event
, Qnil
);
8120 #if 0 /* It is redundant to list the equivalent key bindings because
8121 the prefix is what the user has already typed. */
8123 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8125 /* Insert equivalent keybinding. */
8126 s
= concat2 (s
, tem
);
8129 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8130 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8132 /* Insert button prefix. */
8133 Lisp_Object selected
8134 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8135 if (EQ (tem
, QCradio
))
8136 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8138 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8139 s
= concat2 (tem
, s
);
8143 /* If we have room for the prompt string, add it to this line.
8144 If this is the first on the line, always add it. */
8145 if ((SCHARS (s
) + i
+ 2
8146 + (char_matches
? 0 : SCHARS (desc
) + 3))
8152 /* Punctuate between strings. */
8155 strcpy (menu
+ i
, ", ");
8161 /* If the char to type doesn't match the string's
8162 first char, explicitly show what char to type. */
8165 /* Add as much of string as fits. */
8166 thiswidth
= SCHARS (desc
);
8167 if (thiswidth
+ i
> width
)
8168 thiswidth
= width
- i
;
8169 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8171 strcpy (menu
+ i
, " = ");
8175 /* Add as much of string as fits. */
8176 thiswidth
= SCHARS (s
);
8177 if (thiswidth
+ i
> width
)
8178 thiswidth
= width
- i
;
8179 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8185 /* If this element does not fit, end the line now,
8186 and save the element for the next line. */
8187 strcpy (menu
+ i
, "...");
8192 /* Move past this element. */
8193 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8194 /* Handle reaching end of dense table. */
8199 rest
= Fcdr_safe (rest
);
8203 /* Prompt with that and read response. */
8204 message2_nolog (menu
, strlen (menu
),
8205 ! NILP (current_buffer
->enable_multibyte_characters
));
8207 /* Make believe its not a keyboard macro in case the help char
8208 is pressed. Help characters are not recorded because menu prompting
8209 is not used on replay.
8211 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8212 current_kboard
->defining_kbd_macro
= Qnil
;
8214 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8215 while (BUFFERP (obj
));
8216 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8218 if (!INTEGERP (obj
))
8223 if (! EQ (obj
, menu_prompt_more_char
)
8224 && (!INTEGERP (menu_prompt_more_char
)
8225 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8227 if (!NILP (current_kboard
->defining_kbd_macro
))
8228 store_kbd_macro_char (obj
);
8231 /* Help char - go round again */
8235 /* Reading key sequences. */
8237 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8238 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8239 keymap, or nil otherwise. Return the index of the first keymap in
8240 which KEY has any binding, or NMAPS if no map has a binding.
8242 If KEY is a meta ASCII character, treat it like meta-prefix-char
8243 followed by the corresponding non-meta character. Keymaps in
8244 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8247 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8250 NEXT may be the same array as CURRENT. */
8253 follow_key (key
, nmaps
, current
, defs
, next
)
8255 Lisp_Object
*current
, *defs
, *next
;
8258 int i
, first_binding
;
8260 first_binding
= nmaps
;
8261 for (i
= nmaps
- 1; i
>= 0; i
--)
8263 if (! NILP (current
[i
]))
8265 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8266 if (! NILP (defs
[i
]))
8273 /* Given the set of bindings we've found, produce the next set of maps. */
8274 if (first_binding
< nmaps
)
8275 for (i
= 0; i
< nmaps
; i
++)
8276 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8278 return first_binding
;
8281 /* Structure used to keep track of partial application of key remapping
8282 such as Vfunction_key_map and Vkey_translation_map. */
8283 typedef struct keyremap
8285 Lisp_Object map
, parent
;
8289 /* Lookup KEY in MAP.
8290 MAP is a keymap mapping keys to key vectors or functions.
8291 If the mapping is a function and DO_FUNCTION is non-zero, then
8292 the function is called with PROMPT as parameter and its return
8293 value is used as the return value of this function (after checking
8294 that it is indeed a vector). */
8297 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8298 Lisp_Object map
, key
, prompt
;
8303 next
= access_keymap (map
, key
, 1, 0, 1);
8305 /* Handle symbol with autoload definition. */
8306 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8307 && CONSP (XSYMBOL (next
)->function
)
8308 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8309 do_autoload (XSYMBOL (next
)->function
, next
);
8311 /* Handle a symbol whose function definition is a keymap
8313 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8314 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8315 || KEYMAPP (XSYMBOL (next
)->function
)))
8316 next
= XSYMBOL (next
)->function
;
8318 /* If the keymap gives a function, not an
8319 array, then call the function with one arg and use
8320 its value instead. */
8321 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8326 next
= call1 (next
, prompt
);
8327 /* If the function returned something invalid,
8328 barf--don't ignore it.
8329 (To ignore it safely, we would need to gcpro a bunch of
8330 other variables.) */
8331 if (! (VECTORP (next
) || STRINGP (next
)))
8332 error ("Function %s returns invalid key sequence", tem
);
8337 /* Do one step of the key remapping used for function-key-map and
8338 key-translation-map:
8339 KEYBUF is the buffer holding the input events.
8340 BUFSIZE is its maximum size.
8341 FKEY is a pointer to the keyremap structure to use.
8342 INPUT is the index of the last element in KEYBUF.
8343 DOIT if non-zero says that the remapping can actually take place.
8344 DIFF is used to return the number of keys added/removed by the remapping.
8345 PARENT is the root of the keymap.
8346 PROMPT is the prompt to use if the remapping happens through a function.
8347 The return value is non-zero if the remapping actually took place. */
8350 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8351 Lisp_Object
*keybuf
, prompt
;
8353 int input
, doit
, *diff
, bufsize
;
8355 Lisp_Object next
, key
;
8357 key
= keybuf
[fkey
->end
++];
8358 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8360 /* If keybuf[fkey->start..fkey->end] is bound in the
8361 map and we're in a position to do the key remapping, replace it with
8362 the binding and restart with fkey->start at the end. */
8363 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8365 int len
= XFASTINT (Flength (next
));
8368 *diff
= len
- (fkey
->end
- fkey
->start
);
8370 if (input
+ *diff
>= bufsize
)
8371 error ("Key sequence too long");
8373 /* Shift the keys that follow fkey->end. */
8375 for (i
= fkey
->end
; i
< input
; i
++)
8376 keybuf
[i
+ *diff
] = keybuf
[i
];
8378 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8379 keybuf
[i
+ *diff
] = keybuf
[i
];
8380 /* Overwrite the old keys with the new ones. */
8381 for (i
= 0; i
< len
; i
++)
8382 keybuf
[fkey
->start
+ i
]
8383 = Faref (next
, make_number (i
));
8385 fkey
->start
= fkey
->end
+= *diff
;
8386 fkey
->map
= fkey
->parent
;
8391 fkey
->map
= get_keymap (next
, 0, 1);
8393 /* If we no longer have a bound suffix, try a new position for
8395 if (!CONSP (fkey
->map
))
8397 fkey
->end
= ++fkey
->start
;
8398 fkey
->map
= fkey
->parent
;
8403 /* Read a sequence of keys that ends with a non prefix character,
8404 storing it in KEYBUF, a buffer of size BUFSIZE.
8406 Return the length of the key sequence stored.
8407 Return -1 if the user rejected a command menu.
8409 Echo starting immediately unless `prompt' is 0.
8411 Where a key sequence ends depends on the currently active keymaps.
8412 These include any minor mode keymaps active in the current buffer,
8413 the current buffer's local map, and the global map.
8415 If a key sequence has no other bindings, we check Vfunction_key_map
8416 to see if some trailing subsequence might be the beginning of a
8417 function key's sequence. If so, we try to read the whole function
8418 key, and substitute its symbolic name into the key sequence.
8420 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8421 `double-' events into similar click events, if that would make them
8422 bound. We try to turn `triple-' events first into `double-' events,
8425 If we get a mouse click in a mode line, vertical divider, or other
8426 non-text area, we treat the click as if it were prefixed by the
8427 symbol denoting that area - `mode-line', `vertical-line', or
8430 If the sequence starts with a mouse click, we read the key sequence
8431 with respect to the buffer clicked on, not the current buffer.
8433 If the user switches frames in the midst of a key sequence, we put
8434 off the switch-frame event until later; the next call to
8435 read_char will return it.
8437 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8438 from the selected window's buffer. */
8441 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8442 can_return_switch_frame
, fix_current_buffer
)
8443 Lisp_Object
*keybuf
;
8446 int dont_downcase_last
;
8447 int can_return_switch_frame
;
8448 int fix_current_buffer
;
8450 volatile Lisp_Object from_string
;
8451 volatile int count
= SPECPDL_INDEX ();
8453 /* How many keys there are in the current key sequence. */
8456 /* The length of the echo buffer when we started reading, and
8457 the length of this_command_keys when we started reading. */
8458 volatile int echo_start
;
8459 volatile int keys_start
;
8461 /* The number of keymaps we're scanning right now, and the number of
8462 keymaps we have allocated space for. */
8464 volatile int nmaps_allocated
= 0;
8466 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8467 the current keymaps. */
8468 Lisp_Object
*volatile defs
= NULL
;
8470 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8471 in the current keymaps, or nil where it is not a prefix. */
8472 Lisp_Object
*volatile submaps
= NULL
;
8474 /* The local map to start out with at start of key sequence. */
8475 volatile Lisp_Object orig_local_map
;
8477 /* The map from the `keymap' property to start out with at start of
8479 volatile Lisp_Object orig_keymap
;
8481 /* 1 if we have already considered switching to the local-map property
8482 of the place where a mouse click occurred. */
8483 volatile int localized_local_map
= 0;
8485 /* The index in defs[] of the first keymap that has a binding for
8486 this key sequence. In other words, the lowest i such that
8487 defs[i] is non-nil. */
8488 volatile int first_binding
;
8489 /* Index of the first key that has no binding.
8490 It is useless to try fkey.start larger than that. */
8491 volatile int first_unbound
;
8493 /* If t < mock_input, then KEYBUF[t] should be read as the next
8496 We use this to recover after recognizing a function key. Once we
8497 realize that a suffix of the current key sequence is actually a
8498 function key's escape sequence, we replace the suffix with the
8499 function key's binding from Vfunction_key_map. Now keybuf
8500 contains a new and different key sequence, so the echo area,
8501 this_command_keys, and the submaps and defs arrays are wrong. In
8502 this situation, we set mock_input to t, set t to 0, and jump to
8503 restart_sequence; the loop will read keys from keybuf up until
8504 mock_input, thus rebuilding the state; and then it will resume
8505 reading characters from the keyboard. */
8506 volatile int mock_input
= 0;
8508 /* If the sequence is unbound in submaps[], then
8509 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8510 and fkey.map is its binding.
8512 These might be > t, indicating that all function key scanning
8513 should hold off until t reaches them. We do this when we've just
8514 recognized a function key, to avoid searching for the function
8515 key's again in Vfunction_key_map. */
8516 volatile keyremap fkey
;
8518 /* Likewise, for key_translation_map. */
8519 volatile keyremap keytran
;
8521 /* If we receive a `switch-frame' or `select-window' event in the middle of
8522 a key sequence, we put it off for later.
8523 While we're reading, we keep the event here. */
8524 volatile Lisp_Object delayed_switch_frame
;
8526 /* See the comment below... */
8527 #if defined (GOBBLE_FIRST_EVENT)
8528 Lisp_Object first_event
;
8531 volatile Lisp_Object original_uppercase
;
8532 volatile int original_uppercase_position
= -1;
8534 /* Gets around Microsoft compiler limitations. */
8537 struct buffer
*starting_buffer
;
8539 /* List of events for which a fake prefix key has been generated. */
8540 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8542 #if defined (GOBBLE_FIRST_EVENT)
8546 struct gcpro gcpro1
;
8548 GCPRO1 (fake_prefixed_keys
);
8549 raw_keybuf_count
= 0;
8551 last_nonmenu_event
= Qnil
;
8553 delayed_switch_frame
= Qnil
;
8554 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8555 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8556 /* If there is no translation-map, turn off scanning. */
8557 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8558 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8563 echo_prompt (prompt
);
8564 else if (cursor_in_echo_area
8565 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8566 && NILP (Fzerop (Vecho_keystrokes
)))
8567 /* This doesn't put in a dash if the echo buffer is empty, so
8568 you don't always see a dash hanging out in the minibuffer. */
8572 /* Record the initial state of the echo area and this_command_keys;
8573 we will need to restore them if we replay a key sequence. */
8575 echo_start
= echo_length ();
8576 keys_start
= this_command_key_count
;
8577 this_single_command_key_start
= keys_start
;
8579 #if defined (GOBBLE_FIRST_EVENT)
8580 /* This doesn't quite work, because some of the things that read_char
8581 does cannot safely be bypassed. It seems too risky to try to make
8584 /* Read the first char of the sequence specially, before setting
8585 up any keymaps, in case a filter runs and switches buffers on us. */
8586 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8588 #endif /* GOBBLE_FIRST_EVENT */
8590 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8591 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8594 /* We jump here when the key sequence has been thoroughly changed, and
8595 we need to rescan it starting from the beginning. When we jump here,
8596 keybuf[0..mock_input] holds the sequence we should reread. */
8599 starting_buffer
= current_buffer
;
8600 first_unbound
= bufsize
+ 1;
8602 /* Build our list of keymaps.
8603 If we recognize a function key and replace its escape sequence in
8604 keybuf with its symbol, or if the sequence starts with a mouse
8605 click and we need to switch buffers, we jump back here to rebuild
8606 the initial keymaps from the current buffer. */
8609 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8610 || !NILP (Voverriding_local_map
))
8612 if (3 > nmaps_allocated
)
8614 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8615 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8616 nmaps_allocated
= 3;
8618 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8619 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8620 if (!NILP (Voverriding_local_map
))
8621 submaps
[nmaps
++] = Voverriding_local_map
;
8629 nminor
= current_minor_maps (0, &maps
);
8630 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8632 if (total
> nmaps_allocated
)
8634 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8635 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8636 nmaps_allocated
= total
;
8639 if (!NILP (orig_keymap
))
8640 submaps
[nmaps
++] = orig_keymap
;
8642 bcopy (maps
, (void *) (submaps
+ nmaps
),
8643 nminor
* sizeof (submaps
[0]));
8647 submaps
[nmaps
++] = orig_local_map
;
8649 submaps
[nmaps
++] = current_global_map
;
8651 /* Find an accurate initial value for first_binding. */
8652 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8653 if (! NILP (submaps
[first_binding
]))
8656 /* Start from the beginning in keybuf. */
8659 /* These are no-ops the first time through, but if we restart, they
8660 revert the echo area and this_command_keys to their original state. */
8661 this_command_key_count
= keys_start
;
8662 if (INTERACTIVE
&& t
< mock_input
)
8663 echo_truncate (echo_start
);
8665 /* If the best binding for the current key sequence is a keymap, or
8666 we may be looking at a function key's escape sequence, keep on
8668 while (first_binding
< nmaps
8669 /* Keep reading as long as there's a prefix binding. */
8670 ? !NILP (submaps
[first_binding
])
8671 /* Don't return in the middle of a possible function key sequence,
8672 if the only bindings we found were via case conversion.
8673 Thus, if ESC O a has a function-key-map translation
8674 and ESC o has a binding, don't return after ESC O,
8675 so that we can translate ESC O plus the next character. */
8676 : (fkey
.start
< t
|| keytran
.start
< t
))
8679 int used_mouse_menu
= 0;
8681 /* Where the last real key started. If we need to throw away a
8682 key that has expanded into more than one element of keybuf
8683 (say, a mouse click on the mode line which is being treated
8684 as [mode-line (mouse-...)], then we backtrack to this point
8686 volatile int last_real_key_start
;
8688 /* These variables are analogous to echo_start and keys_start;
8689 while those allow us to restart the entire key sequence,
8690 echo_local_start and keys_local_start allow us to throw away
8692 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8694 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8695 eassert (fkey
.start
<= fkey
.end
);
8696 eassert (keytran
.start
<= keytran
.end
);
8697 /* key-translation-map is applied *after* function-key-map. */
8698 eassert (keytran
.end
<= fkey
.start
);
8700 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8701 { /* The prefix upto first_unbound has no binding and has
8702 no translation left to do either, so we know it's unbound.
8703 If we don't stop now, we risk staying here indefinitely
8704 (if the user keeps entering fkey or keytran prefixes
8705 like C-c ESC ESC ESC ESC ...) */
8707 for (i
= first_unbound
+ 1; i
< t
; i
++)
8708 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8709 mock_input
= t
- first_unbound
- 1;
8710 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8711 fkey
.map
= fkey
.parent
;
8712 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8713 keytran
.map
= keytran
.parent
;
8714 goto replay_sequence
;
8718 error ("Key sequence too long");
8721 echo_local_start
= echo_length ();
8722 keys_local_start
= this_command_key_count
;
8723 local_first_binding
= first_binding
;
8726 /* These are no-ops, unless we throw away a keystroke below and
8727 jumped back up to replay_key; in that case, these restore the
8728 variables to their original state, allowing us to replay the
8730 if (INTERACTIVE
&& t
< mock_input
)
8731 echo_truncate (echo_local_start
);
8732 this_command_key_count
= keys_local_start
;
8733 first_binding
= local_first_binding
;
8735 /* By default, assume each event is "real". */
8736 last_real_key_start
= t
;
8738 /* Does mock_input indicate that we are re-reading a key sequence? */
8742 add_command_key (key
);
8743 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8744 && NILP (Fzerop (Vecho_keystrokes
)))
8748 /* If not, we should actually read a character. */
8753 KBOARD
*interrupted_kboard
= current_kboard
;
8754 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8755 if (setjmp (wrong_kboard_jmpbuf
))
8757 if (!NILP (delayed_switch_frame
))
8759 interrupted_kboard
->kbd_queue
8760 = Fcons (delayed_switch_frame
,
8761 interrupted_kboard
->kbd_queue
);
8762 delayed_switch_frame
= Qnil
;
8765 interrupted_kboard
->kbd_queue
8766 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8768 /* If the side queue is non-empty, ensure it begins with a
8769 switch-frame, so we'll replay it in the right context. */
8770 if (CONSP (interrupted_kboard
->kbd_queue
)
8771 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8772 !(EVENT_HAS_PARAMETERS (key
)
8773 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8777 XSETFRAME (frame
, interrupted_frame
);
8778 interrupted_kboard
->kbd_queue
8779 = Fcons (make_lispy_switch_frame (frame
),
8780 interrupted_kboard
->kbd_queue
);
8783 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8784 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8785 goto replay_sequence
;
8788 key
= read_char (NILP (prompt
), nmaps
,
8789 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8793 /* read_char returns t when it shows a menu and the user rejects it.
8797 unbind_to (count
, Qnil
);
8802 /* read_char returns -1 at the end of a macro.
8803 Emacs 18 handles this by returning immediately with a
8804 zero, so that's what we'll do. */
8805 if (INTEGERP (key
) && XINT (key
) == -1)
8808 /* The Microsoft C compiler can't handle the goto that
8814 /* If the current buffer has been changed from under us, the
8815 keymap may have changed, so replay the sequence. */
8818 EMACS_TIME initial_idleness_start_time
;
8819 EMACS_SET_SECS_USECS (initial_idleness_start_time
,
8820 EMACS_SECS (timer_last_idleness_start_time
),
8821 EMACS_USECS (timer_last_idleness_start_time
));
8823 /* Resume idle state, using the same start-time as before. */
8824 timer_start_idle ();
8825 timer_idleness_start_time
= initial_idleness_start_time
;
8828 /* Reset the current buffer from the selected window
8829 in case something changed the former and not the latter.
8830 This is to be more consistent with the behavior
8831 of the command_loop_1. */
8832 if (fix_current_buffer
)
8834 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8836 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8837 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8840 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8841 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8842 goto replay_sequence
;
8845 /* If we have a quit that was typed in another frame, and
8846 quit_throw_to_read_char switched buffers,
8847 replay to get the right keymap. */
8849 && XINT (key
) == quit_char
8850 && current_buffer
!= starting_buffer
)
8853 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8857 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8858 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8859 goto replay_sequence
;
8864 if (EVENT_HAS_PARAMETERS (key
)
8865 /* Either a `switch-frame' or a `select-window' event. */
8866 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8868 /* If we're at the beginning of a key sequence, and the caller
8869 says it's okay, go ahead and return this event. If we're
8870 in the midst of a key sequence, delay it until the end. */
8871 if (t
> 0 || !can_return_switch_frame
)
8873 delayed_switch_frame
= key
;
8879 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8882 /* Clicks in non-text areas get prefixed by the symbol
8883 in their CHAR-ADDRESS field. For example, a click on
8884 the mode line is prefixed by the symbol `mode-line'.
8886 Furthermore, key sequences beginning with mouse clicks
8887 are read using the keymaps of the buffer clicked on, not
8888 the current buffer. So we may have to switch the buffer
8891 When we turn one event into two events, we must make sure
8892 that neither of the two looks like the original--so that,
8893 if we replay the events, they won't be expanded again.
8894 If not for this, such reexpansion could happen either here
8895 or when user programs play with this-command-keys. */
8896 if (EVENT_HAS_PARAMETERS (key
))
8901 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8902 if (EQ (kind
, Qmouse_click
))
8904 Lisp_Object window
, posn
;
8906 window
= POSN_WINDOW (EVENT_START (key
));
8907 posn
= POSN_POSN (EVENT_START (key
));
8910 || (!NILP (fake_prefixed_keys
)
8911 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8913 /* We're looking a second time at an event for which
8914 we generated a fake prefix key. Set
8915 last_real_key_start appropriately. */
8917 last_real_key_start
= t
- 1;
8920 /* Key sequences beginning with mouse clicks are
8921 read using the keymaps in the buffer clicked on,
8922 not the current buffer. If we're at the
8923 beginning of a key sequence, switch buffers. */
8924 if (last_real_key_start
== 0
8926 && BUFFERP (XWINDOW (window
)->buffer
)
8927 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8929 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8933 /* Arrange to go back to the original buffer once we're
8934 done reading the key sequence. Note that we can't
8935 use save_excursion_{save,restore} here, because they
8936 save point as well as the current buffer; we don't
8937 want to save point, because redisplay may change it,
8938 to accommodate a Fset_window_start or something. We
8939 don't want to do this at the top of the function,
8940 because we may get input from a subprocess which
8941 wants to change the selected window and stuff (say,
8943 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8945 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8947 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8948 orig_local_map
= get_local_map (PT
, current_buffer
,
8950 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8951 goto replay_sequence
;
8954 /* For a mouse click, get the local text-property keymap
8955 of the place clicked on, rather than point. */
8956 if (last_real_key_start
== 0
8957 && CONSP (XCDR (key
))
8958 && ! localized_local_map
)
8960 Lisp_Object map_here
, start
, pos
;
8962 localized_local_map
= 1;
8963 start
= EVENT_START (key
);
8965 if (CONSP (start
) && POSN_INBUFFER_P (start
))
8967 pos
= POSN_BUFFER_POSN (start
);
8969 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8971 map_here
= get_local_map (XINT (pos
),
8972 current_buffer
, Qlocal_map
);
8973 if (!EQ (map_here
, orig_local_map
))
8975 orig_local_map
= map_here
;
8979 goto replay_sequence
;
8981 map_here
= get_local_map (XINT (pos
),
8982 current_buffer
, Qkeymap
);
8983 if (!EQ (map_here
, orig_keymap
))
8985 orig_keymap
= map_here
;
8989 goto replay_sequence
;
8995 /* Expand mode-line and scroll-bar events into two events:
8996 use posn as a fake prefix key. */
8998 && (NILP (fake_prefixed_keys
)
8999 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9001 if (t
+ 1 >= bufsize
)
9002 error ("Key sequence too long");
9005 keybuf
[t
+ 1] = key
;
9008 /* Record that a fake prefix key has been generated
9009 for KEY. Don't modify the event; this would
9010 prevent proper action when the event is pushed
9011 back into unread-command-events. */
9012 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9014 /* If on a mode line string with a local keymap,
9015 reconsider the key sequence with that keymap. */
9016 if (string
= POSN_STRING (EVENT_START (key
)),
9017 (CONSP (string
) && STRINGP (XCAR (string
))))
9019 Lisp_Object pos
, map
, map2
;
9021 pos
= XCDR (string
);
9022 string
= XCAR (string
);
9024 && XINT (pos
) < SCHARS (string
))
9026 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9028 orig_local_map
= map
;
9029 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9032 if (!NILP (map
) || !NILP (map2
))
9033 goto replay_sequence
;
9039 else if (NILP (from_string
)
9040 && (string
= POSN_STRING (EVENT_START (key
)),
9041 (CONSP (string
) && STRINGP (XCAR (string
)))))
9043 /* For a click on a string, i.e. overlay string or a
9044 string displayed via the `display' property,
9045 consider `local-map' and `keymap' properties of
9047 Lisp_Object pos
, map
, map2
;
9049 pos
= XCDR (string
);
9050 string
= XCAR (string
);
9052 && XINT (pos
) < SCHARS (string
))
9054 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9056 orig_local_map
= map
;
9057 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9061 if (!NILP (map
) || !NILP (map2
))
9063 from_string
= string
;
9064 goto replay_sequence
;
9069 else if (CONSP (XCDR (key
))
9070 && CONSP (EVENT_START (key
))
9071 && CONSP (XCDR (EVENT_START (key
))))
9075 posn
= POSN_POSN (EVENT_START (key
));
9076 /* Handle menu-bar events:
9077 insert the dummy prefix event `menu-bar'. */
9078 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9080 if (t
+ 1 >= bufsize
)
9081 error ("Key sequence too long");
9085 /* Zap the position in key, so we know that we've
9086 expanded it, and don't try to do so again. */
9087 POSN_SET_POSN (EVENT_START (key
),
9088 Fcons (posn
, Qnil
));
9091 goto replay_sequence
;
9093 else if (CONSP (posn
))
9095 /* We're looking at the second event of a
9096 sequence which we expanded before. Set
9097 last_real_key_start appropriately. */
9098 if (last_real_key_start
== t
&& t
> 0)
9099 last_real_key_start
= t
- 1;
9104 /* We have finally decided that KEY is something we might want
9106 first_binding
= (follow_key (key
,
9107 nmaps
- first_binding
,
9108 submaps
+ first_binding
,
9109 defs
+ first_binding
,
9110 submaps
+ first_binding
)
9113 /* If KEY wasn't bound, we'll try some fallbacks. */
9114 if (first_binding
< nmaps
)
9115 /* This is needed for the following scenario:
9116 event 0: a down-event that gets dropped by calling replay_key.
9117 event 1: some normal prefix like C-h.
9118 After event 0, first_unbound is 0, after event 1 fkey.start
9119 and keytran.start are both 1, so when we see that C-h is bound,
9120 we need to update first_unbound. */
9121 first_unbound
= max (t
+ 1, first_unbound
);
9126 /* Remember the position to put an upper bound on fkey.start. */
9127 first_unbound
= min (t
, first_unbound
);
9129 head
= EVENT_HEAD (key
);
9130 if (help_char_p (head
) && t
> 0)
9132 read_key_sequence_cmd
= Vprefix_help_command
;
9134 last_nonmenu_event
= key
;
9135 /* The Microsoft C compiler can't handle the goto that
9143 Lisp_Object breakdown
;
9146 breakdown
= parse_modifiers (head
);
9147 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9148 /* Attempt to reduce an unbound mouse event to a simpler
9149 event that is bound:
9150 Drags reduce to clicks.
9151 Double-clicks reduce to clicks.
9152 Triple-clicks reduce to double-clicks, then to clicks.
9153 Down-clicks are eliminated.
9154 Double-downs reduce to downs, then are eliminated.
9155 Triple-downs reduce to double-downs, then to downs,
9156 then are eliminated. */
9157 if (modifiers
& (down_modifier
| drag_modifier
9158 | double_modifier
| triple_modifier
))
9160 while (modifiers
& (down_modifier
| drag_modifier
9161 | double_modifier
| triple_modifier
))
9163 Lisp_Object new_head
, new_click
;
9164 if (modifiers
& triple_modifier
)
9165 modifiers
^= (double_modifier
| triple_modifier
);
9166 else if (modifiers
& double_modifier
)
9167 modifiers
&= ~double_modifier
;
9168 else if (modifiers
& drag_modifier
)
9169 modifiers
&= ~drag_modifier
;
9172 /* Dispose of this `down' event by simply jumping
9173 back to replay_key, to get another event.
9175 Note that if this event came from mock input,
9176 then just jumping back to replay_key will just
9177 hand it to us again. So we have to wipe out any
9180 We could delete keybuf[t] and shift everything
9181 after that to the left by one spot, but we'd also
9182 have to fix up any variable that points into
9183 keybuf, and shifting isn't really necessary
9186 Adding prefixes for non-textual mouse clicks
9187 creates two characters of mock input, and both
9188 must be thrown away. If we're only looking at
9189 the prefix now, we can just jump back to
9190 replay_key. On the other hand, if we've already
9191 processed the prefix, and now the actual click
9192 itself is giving us trouble, then we've lost the
9193 state of the keymaps we want to backtrack to, and
9194 we need to replay the whole sequence to rebuild
9197 Beyond that, only function key expansion could
9198 create more than two keys, but that should never
9199 generate mouse events, so it's okay to zero
9200 mock_input in that case too.
9202 FIXME: The above paragraph seems just plain
9203 wrong, if you consider things like
9204 xterm-mouse-mode. -stef
9206 Isn't this just the most wonderful code ever? */
9208 /* If mock_input > t + 1, the above simplification
9209 will actually end up dropping keys on the floor.
9210 This is probably OK for now, but even
9211 if mock_input <= t + 1, we need to adjust fkey
9213 Typical case [header-line down-mouse-N]:
9214 mock_input = 2, t = 1, fkey.end = 1,
9215 last_real_key_start = 0. */
9216 if (fkey
.end
> last_real_key_start
)
9218 fkey
.end
= fkey
.start
9219 = min (last_real_key_start
, fkey
.start
);
9220 fkey
.map
= fkey
.parent
;
9221 if (keytran
.end
> last_real_key_start
)
9223 keytran
.end
= keytran
.start
9224 = min (last_real_key_start
, keytran
.start
);
9225 keytran
.map
= keytran
.parent
;
9228 if (t
== last_real_key_start
)
9235 mock_input
= last_real_key_start
;
9236 goto replay_sequence
;
9241 = apply_modifiers (modifiers
, XCAR (breakdown
));
9243 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9245 /* Look for a binding for this new key. follow_key
9246 promises that it didn't munge submaps the
9247 last time we called it, since key was unbound. */
9249 = (follow_key (new_click
,
9250 nmaps
- local_first_binding
,
9251 submaps
+ local_first_binding
,
9252 defs
+ local_first_binding
,
9253 submaps
+ local_first_binding
)
9254 + local_first_binding
);
9256 /* If that click is bound, go for it. */
9257 if (first_binding
< nmaps
)
9262 /* Otherwise, we'll leave key set to the drag event. */
9269 /* Normally, last_nonmenu_event gets the previous key we read.
9270 But when a mouse popup menu is being used,
9271 we don't update last_nonmenu_event; it continues to hold the mouse
9272 event that preceded the first level of menu. */
9273 if (!used_mouse_menu
)
9274 last_nonmenu_event
= key
;
9276 /* Record what part of this_command_keys is the current key sequence. */
9277 this_single_command_key_start
= this_command_key_count
- t
;
9279 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9280 /* There is a binding and it's not a prefix.
9281 There is thus no function-key in this sequence.
9282 Moving fkey.start is important in this case to allow keytran.start
9283 to go over the sequence before we return (since we keep the
9284 invariant that keytran.end <= fkey.start). */
9287 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9290 /* If the sequence is unbound, see if we can hang a function key
9291 off the end of it. */
9292 /* Continue scan from fkey.end until we find a bound suffix. */
9293 while (fkey
.end
< t
)
9295 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9298 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9299 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9300 max (t
, mock_input
),
9301 /* If there's a binding (i.e.
9302 first_binding >= nmaps) we don't want
9303 to apply this function-key-mapping. */
9304 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9309 mock_input
= diff
+ max (t
, mock_input
);
9310 goto replay_sequence
;
9314 /* Look for this sequence in key-translation-map.
9315 Scan from keytran.end until we find a bound suffix. */
9316 while (keytran
.end
< fkey
.start
)
9318 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9321 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9322 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9327 mock_input
= diff
+ max (t
, mock_input
);
9328 /* Adjust the function-key-map counters. */
9332 goto replay_sequence
;
9336 /* If KEY is not defined in any of the keymaps,
9337 and cannot be part of a function key or translation,
9338 and is an upper case letter
9339 use the corresponding lower-case letter instead. */
9340 if (first_binding
>= nmaps
9341 && fkey
.start
>= t
&& keytran
.start
>= t
9343 && ((((XINT (key
) & 0x3ffff)
9344 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9345 && UPPERCASEP (XINT (key
) & 0x3ffff))
9346 || (XINT (key
) & shift_modifier
)))
9348 Lisp_Object new_key
;
9350 original_uppercase
= key
;
9351 original_uppercase_position
= t
- 1;
9353 if (XINT (key
) & shift_modifier
)
9354 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9356 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9357 | (XINT (key
) & ~0x3ffff)));
9359 /* We have to do this unconditionally, regardless of whether
9360 the lower-case char is defined in the keymaps, because they
9361 might get translated through function-key-map. */
9362 keybuf
[t
- 1] = new_key
;
9363 mock_input
= max (t
, mock_input
);
9365 goto replay_sequence
;
9367 /* If KEY is not defined in any of the keymaps,
9368 and cannot be part of a function key or translation,
9369 and is a shifted function key,
9370 use the corresponding unshifted function key instead. */
9371 if (first_binding
>= nmaps
9372 && fkey
.start
>= t
&& keytran
.start
>= t
9375 Lisp_Object breakdown
;
9378 breakdown
= parse_modifiers (key
);
9379 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9380 if (modifiers
& shift_modifier
)
9382 Lisp_Object new_key
;
9384 original_uppercase
= key
;
9385 original_uppercase_position
= t
- 1;
9387 modifiers
&= ~shift_modifier
;
9388 new_key
= apply_modifiers (modifiers
,
9391 keybuf
[t
- 1] = new_key
;
9392 mock_input
= max (t
, mock_input
);
9393 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9394 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9396 goto replay_sequence
;
9402 read_key_sequence_cmd
= (first_binding
< nmaps
9403 ? defs
[first_binding
]
9406 unread_switch_frame
= delayed_switch_frame
;
9407 unbind_to (count
, Qnil
);
9409 /* Don't downcase the last character if the caller says don't.
9410 Don't downcase it if the result is undefined, either. */
9411 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9412 && t
- 1 == original_uppercase_position
)
9413 keybuf
[t
- 1] = original_uppercase
;
9415 /* Occasionally we fabricate events, perhaps by expanding something
9416 according to function-key-map, or by adding a prefix symbol to a
9417 mouse click in the scroll bar or modeline. In this cases, return
9418 the entire generated key sequence, even if we hit an unbound
9419 prefix or a definition before the end. This means that you will
9420 be able to push back the event properly, and also means that
9421 read-key-sequence will always return a logical unit.
9424 for (; t
< mock_input
; t
++)
9426 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9427 && NILP (Fzerop (Vecho_keystrokes
)))
9428 echo_char (keybuf
[t
]);
9429 add_command_key (keybuf
[t
]);
9438 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9439 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9440 The sequence is sufficient to specify a non-prefix command in the
9441 current local and global maps.
9443 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9444 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9445 as a continuation of the previous key.
9447 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9448 convert the last event to lower case. (Normally any upper case event
9449 is converted to lower case if the original event is undefined and the lower
9450 case equivalent is defined.) A non-nil value is appropriate for reading
9451 a key sequence to be defined.
9453 A C-g typed while in this function is treated like any other character,
9454 and `quit-flag' is not set.
9456 If the key sequence starts with a mouse click, then the sequence is read
9457 using the keymaps of the buffer of the window clicked in, not the buffer
9458 of the selected window as normal.
9460 `read-key-sequence' drops unbound button-down events, since you normally
9461 only care about the click or drag events which follow them. If a drag
9462 or multi-click event is unbound, but the corresponding click event would
9463 be bound, `read-key-sequence' turns the event into a click event at the
9464 drag's starting position. This means that you don't have to distinguish
9465 between click and drag, double, or triple events unless you want to.
9467 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9468 lines separating windows, and scroll bars with imaginary keys
9469 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9471 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9472 function will process a switch-frame event if the user switches frames
9473 before typing anything. If the user switches frames in the middle of a
9474 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9475 is nil, then the event will be put off until after the current key sequence.
9477 `read-key-sequence' checks `function-key-map' for function key
9478 sequences, where they wouldn't conflict with ordinary bindings. See
9479 `function-key-map' for more details.
9481 The optional fifth argument COMMAND-LOOP, if non-nil, means
9482 that this key sequence is being read by something that will
9483 read commands one after another. It should be nil if the caller
9484 will read just one key sequence. */)
9485 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9487 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9488 Lisp_Object can_return_switch_frame
, command_loop
;
9490 Lisp_Object keybuf
[30];
9492 struct gcpro gcpro1
;
9493 int count
= SPECPDL_INDEX ();
9496 CHECK_STRING (prompt
);
9499 specbind (Qinput_method_exit_on_first_char
,
9500 (NILP (command_loop
) ? Qt
: Qnil
));
9501 specbind (Qinput_method_use_echo_area
,
9502 (NILP (command_loop
) ? Qt
: Qnil
));
9504 bzero (keybuf
, sizeof keybuf
);
9506 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9508 if (NILP (continue_echo
))
9510 this_command_key_count
= 0;
9511 this_command_key_count_reset
= 0;
9512 this_single_command_key_start
= 0;
9515 #ifdef HAVE_X_WINDOWS
9516 if (display_hourglass_p
)
9517 cancel_hourglass ();
9520 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9521 prompt
, ! NILP (dont_downcase_last
),
9522 ! NILP (can_return_switch_frame
), 0);
9524 #if 0 /* The following is fine for code reading a key sequence and
9525 then proceeding with a lenghty computation, but it's not good
9526 for code reading keys in a loop, like an input method. */
9527 #ifdef HAVE_X_WINDOWS
9528 if (display_hourglass_p
)
9539 return unbind_to (count
, make_event_array (i
, keybuf
));
9542 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9543 Sread_key_sequence_vector
, 1, 5, 0,
9544 doc
: /* Like `read-key-sequence' but always return a vector. */)
9545 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9547 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9548 Lisp_Object can_return_switch_frame
, command_loop
;
9550 Lisp_Object keybuf
[30];
9552 struct gcpro gcpro1
;
9553 int count
= SPECPDL_INDEX ();
9556 CHECK_STRING (prompt
);
9559 specbind (Qinput_method_exit_on_first_char
,
9560 (NILP (command_loop
) ? Qt
: Qnil
));
9561 specbind (Qinput_method_use_echo_area
,
9562 (NILP (command_loop
) ? Qt
: Qnil
));
9564 bzero (keybuf
, sizeof keybuf
);
9566 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9568 if (NILP (continue_echo
))
9570 this_command_key_count
= 0;
9571 this_command_key_count_reset
= 0;
9572 this_single_command_key_start
= 0;
9575 #ifdef HAVE_X_WINDOWS
9576 if (display_hourglass_p
)
9577 cancel_hourglass ();
9580 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9581 prompt
, ! NILP (dont_downcase_last
),
9582 ! NILP (can_return_switch_frame
), 0);
9584 #ifdef HAVE_X_WINDOWS
9585 if (display_hourglass_p
)
9595 return unbind_to (count
, Fvector (i
, keybuf
));
9598 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9599 doc
: /* Execute CMD as an editor command.
9600 CMD must be a symbol that satisfies the `commandp' predicate.
9601 Optional second arg RECORD-FLAG non-nil
9602 means unconditionally put this command in `command-history'.
9603 Otherwise, that is done only if an arg is read using the minibuffer.
9604 The argument KEYS specifies the value to use instead of (this-command-keys)
9605 when reading the arguments; if it is nil, (this-command-keys) is used.
9606 The argument SPECIAL, if non-nil, means that this command is executing
9607 a special event, so ignore the prefix argument and don't clear it. */)
9608 (cmd
, record_flag
, keys
, special
)
9609 Lisp_Object cmd
, record_flag
, keys
, special
;
9611 register Lisp_Object final
;
9612 register Lisp_Object tem
;
9613 Lisp_Object prefixarg
;
9614 struct backtrace backtrace
;
9615 extern int debug_on_next_call
;
9617 debug_on_next_call
= 0;
9621 prefixarg
= current_kboard
->Vprefix_arg
;
9622 Vcurrent_prefix_arg
= prefixarg
;
9623 current_kboard
->Vprefix_arg
= Qnil
;
9630 tem
= Fget (cmd
, Qdisabled
);
9631 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9633 tem
= Fsymbol_value (Qdisabled_command_hook
);
9635 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9641 final
= Findirect_function (cmd
);
9643 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9645 struct gcpro gcpro1
, gcpro2
;
9647 GCPRO2 (cmd
, prefixarg
);
9648 do_autoload (final
, cmd
);
9655 if (STRINGP (final
) || VECTORP (final
))
9657 /* If requested, place the macro in the command history. For
9658 other sorts of commands, call-interactively takes care of
9660 if (!NILP (record_flag
))
9663 = Fcons (Fcons (Qexecute_kbd_macro
,
9664 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9667 /* Don't keep command history around forever. */
9668 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9670 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9672 XSETCDR (tem
, Qnil
);
9676 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9679 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9681 backtrace
.next
= backtrace_list
;
9682 backtrace_list
= &backtrace
;
9683 backtrace
.function
= &Qcall_interactively
;
9684 backtrace
.args
= &cmd
;
9685 backtrace
.nargs
= 1;
9686 backtrace
.evalargs
= 0;
9688 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9690 backtrace_list
= backtrace
.next
;
9698 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9700 doc
: /* Read function name, then read its arguments and call it. */)
9702 Lisp_Object prefixarg
;
9704 Lisp_Object function
;
9706 int saved_last_point_position
;
9707 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9708 Lisp_Object bindings
, value
;
9709 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9711 saved_keys
= Fvector (this_command_key_count
,
9712 XVECTOR (this_command_keys
)->contents
);
9713 saved_last_point_position_buffer
= last_point_position_buffer
;
9714 saved_last_point_position
= last_point_position
;
9716 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9718 if (EQ (prefixarg
, Qminus
))
9720 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9721 strcpy (buf
, "C-u ");
9722 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9724 if (sizeof (int) == sizeof (EMACS_INT
))
9725 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9726 else if (sizeof (long) == sizeof (EMACS_INT
))
9727 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9731 else if (INTEGERP (prefixarg
))
9733 if (sizeof (int) == sizeof (EMACS_INT
))
9734 sprintf (buf
, "%d ", XINT (prefixarg
));
9735 else if (sizeof (long) == sizeof (EMACS_INT
))
9736 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9741 /* This isn't strictly correct if execute-extended-command
9742 is bound to anything else. Perhaps it should use
9743 this_command_keys? */
9744 strcat (buf
, "M-x ");
9746 /* Prompt with buf, and then read a string, completing from and
9747 restricting to the set of all defined commands. Don't provide
9748 any initial input. Save the command read on the extended-command
9750 function
= Fcompleting_read (build_string (buf
),
9751 Vobarray
, Qcommandp
,
9752 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9755 if (STRINGP (function
) && SCHARS (function
) == 0)
9756 error ("No command name given");
9758 /* Set this_command_keys to the concatenation of saved_keys and
9759 function, followed by a RET. */
9764 this_command_key_count
= 0;
9765 this_command_key_count_reset
= 0;
9766 this_single_command_key_start
= 0;
9768 keys
= XVECTOR (saved_keys
)->contents
;
9769 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9770 add_command_key (keys
[i
]);
9772 for (i
= 0; i
< SCHARS (function
); i
++)
9773 add_command_key (Faref (function
, make_number (i
)));
9775 add_command_key (make_number ('\015'));
9778 last_point_position
= saved_last_point_position
;
9779 last_point_position_buffer
= saved_last_point_position_buffer
;
9783 function
= Fintern (function
, Qnil
);
9784 current_kboard
->Vprefix_arg
= prefixarg
;
9785 Vthis_command
= function
;
9786 real_this_command
= function
;
9788 /* If enabled, show which key runs this command. */
9789 if (!NILP (Vsuggest_key_bindings
)
9790 && NILP (Vexecuting_macro
)
9791 && SYMBOLP (function
))
9792 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9798 GCPRO2 (bindings
, value
);
9799 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9801 /* If the command has a key binding, print it now. */
9802 if (!NILP (bindings
)
9803 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9806 /* But first wait, and skip the message if there is input. */
9808 if (!NILP (echo_area_buffer
[0]))
9809 /* This command displayed something in the echo area;
9810 so wait a few seconds, then display our suggestion message. */
9811 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9812 ? XINT (Vsuggest_key_bindings
) : 2);
9814 /* This command left the echo area empty,
9815 so display our message immediately. */
9818 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9819 && ! CONSP (Vunread_command_events
))
9821 Lisp_Object binding
;
9823 int message_p
= push_message ();
9824 int count
= SPECPDL_INDEX ();
9826 record_unwind_protect (pop_message_unwind
, Qnil
);
9827 binding
= Fkey_description (bindings
);
9830 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9833 sprintf (newmessage
, "You can run the command `%s' with %s",
9834 SDATA (SYMBOL_NAME (function
)),
9836 message2_nolog (newmessage
,
9837 strlen (newmessage
),
9838 STRING_MULTIBYTE (binding
));
9839 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9840 ? Vsuggest_key_bindings
: make_number (2)),
9845 unbind_to (count
, Qnil
);
9849 RETURN_UNGCPRO (value
);
9853 /* Return nonzero if input events are pending. */
9856 detect_input_pending ()
9859 get_input_pending (&input_pending
, 0);
9861 return input_pending
;
9864 /* Return nonzero if input events are pending, and run any pending timers. */
9867 detect_input_pending_run_timers (do_display
)
9870 int old_timers_run
= timers_run
;
9873 get_input_pending (&input_pending
, 1);
9875 if (old_timers_run
!= timers_run
&& do_display
)
9877 redisplay_preserve_echo_area (8);
9878 /* The following fixes a bug when using lazy-lock with
9879 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9880 from an idle timer function. The symptom of the bug is that
9881 the cursor sometimes doesn't become visible until the next X
9882 event is processed. --gerd. */
9884 Lisp_Object tail
, frame
;
9885 FOR_EACH_FRAME (tail
, frame
)
9886 if (FRAME_RIF (XFRAME (frame
)))
9887 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
9891 return input_pending
;
9894 /* This is called in some cases before a possible quit.
9895 It cases the next call to detect_input_pending to recompute input_pending.
9896 So calling this function unnecessarily can't do any harm. */
9899 clear_input_pending ()
9904 /* Return nonzero if there are pending requeued events.
9905 This isn't used yet. The hope is to make wait_reading_process_input
9906 call it, and return if it runs Lisp code that unreads something.
9907 The problem is, kbd_buffer_get_event needs to be fixed to know what
9908 to do in that case. It isn't trivial. */
9911 requeued_events_pending_p ()
9913 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9917 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9918 doc
: /* Return t if command input is currently available with no wait.
9919 Actually, the value is nil only if we can be sure that no input is available;
9920 if there is a doubt, the value is t. */)
9923 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9926 get_filtered_input_pending (&input_pending
, 1, 1);
9927 return input_pending
> 0 ? Qt
: Qnil
;
9930 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9931 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9934 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9937 if (total_keys
< NUM_RECENT_KEYS
)
9938 return Fvector (total_keys
, keys
);
9941 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9942 bcopy (keys
+ recent_keys_index
,
9943 XVECTOR (val
)->contents
,
9944 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9946 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9947 recent_keys_index
* sizeof (Lisp_Object
));
9952 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9953 doc
: /* Return the key sequence that invoked this command.
9954 However, if the command has called `read-key-sequence', it returns
9955 the last key sequence that has been read.
9956 The value is a string or a vector. */)
9959 return make_event_array (this_command_key_count
,
9960 XVECTOR (this_command_keys
)->contents
);
9963 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9964 doc
: /* Return the key sequence that invoked this command, as a vector.
9965 However, if the command has called `read-key-sequence', it returns
9966 the last key sequence that has been read. */)
9969 return Fvector (this_command_key_count
,
9970 XVECTOR (this_command_keys
)->contents
);
9973 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9974 Sthis_single_command_keys
, 0, 0, 0,
9975 doc
: /* Return the key sequence that invoked this command.
9976 More generally, it returns the last key sequence read, either by
9977 the command loop or by `read-key-sequence'.
9978 Unlike `this-command-keys', this function's value
9979 does not include prefix arguments.
9980 The value is always a vector. */)
9983 return Fvector (this_command_key_count
9984 - this_single_command_key_start
,
9985 (XVECTOR (this_command_keys
)->contents
9986 + this_single_command_key_start
));
9989 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9990 Sthis_single_command_raw_keys
, 0, 0, 0,
9991 doc
: /* Return the raw events that were read for this command.
9992 More generally, it returns the last key sequence read, either by
9993 the command loop or by `read-key-sequence'.
9994 Unlike `this-single-command-keys', this function's value
9995 shows the events before all translations (except for input methods).
9996 The value is always a vector. */)
9999 return Fvector (raw_keybuf_count
,
10000 (XVECTOR (raw_keybuf
)->contents
));
10003 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10004 Sreset_this_command_lengths
, 0, 0, 0,
10005 doc
: /* Make the unread events replace the last command and echo.
10006 Used in `universal-argument-other-key'.
10008 `universal-argument-other-key' rereads the event just typed.
10009 It then gets translated through `function-key-map'.
10010 The translated event has to replace the real events,
10011 both in the value of (this-command-keys) and in echoing.
10012 To achieve this, `universal-argument-other-key' calls
10013 `reset-this-command-lengths', which discards the record of reading
10014 these events the first time. */)
10017 this_command_key_count
= before_command_key_count
;
10018 if (this_command_key_count
< this_single_command_key_start
)
10019 this_single_command_key_start
= this_command_key_count
;
10021 echo_truncate (before_command_echo_length
);
10023 /* Cause whatever we put into unread-command-events
10024 to echo as if it were being freshly read from the keyboard. */
10025 this_command_key_count_reset
= 1;
10030 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10031 Sclear_this_command_keys
, 0, 1, 0,
10032 doc
: /* Clear out the vector that `this-command-keys' returns.
10033 Also clear the record of the last 100 events, unless optional arg
10034 KEEP-RECORD is non-nil. */)
10036 Lisp_Object keep_record
;
10040 this_command_key_count
= 0;
10041 this_command_key_count_reset
= 0;
10043 if (NILP (keep_record
))
10045 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10046 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10048 recent_keys_index
= 0;
10053 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10054 doc
: /* Return the current depth in recursive edits. */)
10058 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10062 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10063 "FOpen dribble file: ",
10064 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10065 If FILE is nil, close any open dribble file. */)
10076 file
= Fexpand_file_name (file
, Qnil
);
10077 dribble
= fopen (SDATA (file
), "w");
10079 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10084 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10085 doc
: /* Discard the contents of the terminal input buffer.
10086 Also end any kbd macro being defined. */)
10089 if (!NILP (current_kboard
->defining_kbd_macro
))
10091 /* Discard the last command from the macro. */
10092 Fcancel_kbd_macro_events ();
10096 update_mode_lines
++;
10098 Vunread_command_events
= Qnil
;
10099 unread_command_char
= -1;
10101 discard_tty_input ();
10103 kbd_fetch_ptr
= kbd_store_ptr
;
10109 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10110 doc
: /* Stop Emacs and return to superior process. You can resume later.
10111 If `cannot-suspend' is non-nil, or if the system doesn't support job
10112 control, run a subshell instead.
10114 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10115 to be read as terminal input by Emacs's parent, after suspension.
10117 Before suspending, run the normal hook `suspend-hook'.
10118 After resumption run the normal hook `suspend-resume-hook'.
10120 Some operating systems cannot stop the Emacs process and resume it later.
10121 On such systems, Emacs starts a subshell instead of suspending. */)
10123 Lisp_Object stuffstring
;
10125 int count
= SPECPDL_INDEX ();
10126 int old_height
, old_width
;
10128 struct gcpro gcpro1
;
10130 if (tty_list
&& tty_list
->next
)
10131 error ("Suspend is not supported with multiple ttys");
10133 if (!NILP (stuffstring
))
10134 CHECK_STRING (stuffstring
);
10136 /* Run the functions in suspend-hook. */
10137 if (!NILP (Vrun_hooks
))
10138 call1 (Vrun_hooks
, intern ("suspend-hook"));
10140 GCPRO1 (stuffstring
);
10141 get_tty_size (fileno (TTY_INPUT (CURTTY ())), &old_width
, &old_height
);
10142 reset_all_sys_modes ();
10143 /* sys_suspend can get an error if it tries to fork a subshell
10144 and the system resources aren't available for that. */
10145 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10146 (Lisp_Object
)CURTTY()); /* XXX */
10147 stuff_buffered_input (stuffstring
);
10148 if (cannot_suspend
)
10152 unbind_to (count
, Qnil
);
10154 /* Check if terminal/window size has changed.
10155 Note that this is not useful when we are running directly
10156 with a window system; but suspend should be disabled in that case. */
10157 get_tty_size (fileno (TTY_INPUT (CURTTY ())), &width
, &height
);
10158 if (width
!= old_width
|| height
!= old_height
)
10159 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10161 /* Run suspend-resume-hook. */
10162 if (!NILP (Vrun_hooks
))
10163 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10169 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10170 Then in any case stuff anything Emacs has read ahead and not used. */
10173 stuff_buffered_input (stuffstring
)
10174 Lisp_Object stuffstring
;
10176 /* stuff_char works only in BSD, versions 4.2 and up. */
10179 register unsigned char *p
;
10181 if (STRINGP (stuffstring
))
10183 register int count
;
10185 p
= SDATA (stuffstring
);
10186 count
= SBYTES (stuffstring
);
10187 while (count
-- > 0)
10192 /* Anything we have read ahead, put back for the shell to read. */
10193 /* ?? What should this do when we have multiple keyboards??
10194 Should we ignore anything that was typed in at the "wrong" kboard? */
10195 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10198 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10199 kbd_fetch_ptr
= kbd_buffer
;
10200 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10201 stuff_char (kbd_fetch_ptr
->code
);
10203 clear_event (kbd_fetch_ptr
);
10208 #endif /* BSD_SYSTEM and not BSD4_1 */
10212 set_waiting_for_input (time_to_clear
)
10213 EMACS_TIME
*time_to_clear
;
10215 input_available_clear_time
= time_to_clear
;
10217 /* Tell handle_interrupt to throw back to read_char, */
10218 waiting_for_input
= 1;
10220 /* If handle_interrupt was called before and buffered a C-g,
10221 make it run again now, to avoid timing error. */
10222 if (!NILP (Vquit_flag
))
10223 quit_throw_to_read_char ();
10227 clear_waiting_for_input ()
10229 /* Tell handle_interrupt not to throw back to read_char, */
10230 waiting_for_input
= 0;
10231 input_available_clear_time
= 0;
10234 /* The SIGINT handler.
10236 If we have a frame on the controlling tty, the SIGINT was generated
10237 by C-g, so we call handle_interrupt. Otherwise, the handler kills
10241 interrupt_signal (signalnum
) /* If we don't have an argument, */
10242 int signalnum
; /* some compilers complain in signal calls. */
10244 /* Must preserve main program's value of errno. */
10245 int old_errno
= errno
;
10246 struct display
*display
;
10248 #if defined (USG) && !defined (POSIX_SIGNALS)
10249 /* USG systems forget handlers when they are used;
10250 must reestablish each time */
10251 signal (SIGINT
, interrupt_signal
);
10252 signal (SIGQUIT
, interrupt_signal
);
10255 /* See if we have a display on our controlling terminal. */
10256 display
= get_named_tty_display (NULL
);
10259 /* If there are no frames there, let's pretend that we are a
10260 well-behaving UN*X program and quit. */
10261 Fkill_emacs (Qnil
);
10265 /* Otherwise, the SIGINT was probably generated by C-g. */
10267 /* Set internal_last_event_frame to the top frame of the
10268 controlling tty, if we have a frame there. We disable the
10269 interrupt key on secondary ttys, so the SIGINT must have come
10270 from the controlling tty. */
10271 internal_last_event_frame
= display
->display_info
.tty
->top_frame
;
10273 handle_interrupt ();
10279 /* This routine is called at interrupt level in response to C-g.
10281 It is called from the SIGINT handler or kbd_buffer_store_event.
10283 If `waiting_for_input' is non zero, then unless `echoing' is
10284 nonzero, immediately throw back to read_char.
10286 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10287 eval to throw, when it gets a chance. If quit-flag is already
10288 non-nil, it stops the job right away. */
10291 handle_interrupt ()
10294 struct frame
*sf
= SELECTED_FRAME ();
10298 /* XXX This code needs to be revised for multi-tty support. */
10299 if (!NILP (Vquit_flag
)
10300 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10302 /* If SIGINT isn't blocked, don't let us be interrupted by
10303 another SIGINT, it might be harmful due to non-reentrancy
10304 in I/O functions. */
10305 sigblock (sigmask (SIGINT
));
10308 reset_all_sys_modes ();
10310 #ifdef SIGTSTP /* Support possible in later USG versions */
10312 * On systems which can suspend the current process and return to the original
10313 * shell, this command causes the user to end up back at the shell.
10314 * The "Auto-save" and "Abort" questions are not asked until
10315 * the user elects to return to emacs, at which point he can save the current
10316 * job and either dump core or continue.
10321 if (sys_suspend () == -1)
10323 printf ("Not running as a subprocess;\n");
10324 printf ("you can continue or abort.\n");
10326 #else /* not VMS */
10327 /* Perhaps should really fork an inferior shell?
10328 But that would not provide any way to get back
10329 to the original shell, ever. */
10330 printf ("No support for stopping a process on this operating system;\n");
10331 printf ("you can continue or abort.\n");
10332 #endif /* not VMS */
10333 #endif /* not SIGTSTP */
10335 /* We must remain inside the screen area when the internal terminal
10336 is used. Note that [Enter] is not echoed by dos. */
10339 /* It doesn't work to autosave while GC is in progress;
10340 the code used for auto-saving doesn't cope with the mark bit. */
10341 if (!gc_in_progress
)
10343 printf ("Auto-save? (y or n) ");
10345 if (((c
= getchar ()) & ~040) == 'Y')
10347 Fdo_auto_save (Qt
, Qnil
);
10349 printf ("\r\nAuto-save done");
10350 #else /* not MSDOS */
10351 printf ("Auto-save done\n");
10352 #endif /* not MSDOS */
10354 while (c
!= '\n') c
= getchar ();
10358 /* During GC, it must be safe to reenable quitting again. */
10359 Vinhibit_quit
= Qnil
;
10362 #endif /* not MSDOS */
10363 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10364 printf ("but will instead do a real quit after garbage collection ends\r\n");
10369 printf ("\r\nAbort? (y or n) ");
10370 #else /* not MSDOS */
10372 printf ("Abort (and enter debugger)? (y or n) ");
10373 #else /* not VMS */
10374 printf ("Abort (and dump core)? (y or n) ");
10375 #endif /* not VMS */
10376 #endif /* not MSDOS */
10378 if (((c
= getchar ()) & ~040) == 'Y')
10380 while (c
!= '\n') c
= getchar ();
10382 printf ("\r\nContinuing...\r\n");
10383 #else /* not MSDOS */
10384 printf ("Continuing...\n");
10385 #endif /* not MSDOS */
10387 init_all_sys_modes ();
10392 /* If executing a function that wants to be interrupted out of
10393 and the user has not deferred quitting by binding `inhibit-quit'
10394 then quit right away. */
10395 if (immediate_quit
&& NILP (Vinhibit_quit
))
10397 struct gl_state_s saved
;
10398 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10400 immediate_quit
= 0;
10403 GCPRO4 (saved
.object
, saved
.global_code
,
10404 saved
.current_syntax_table
, saved
.old_prop
);
10405 Fsignal (Qquit
, Qnil
);
10410 /* Else request quit when it's safe */
10414 if (waiting_for_input
&& !echoing
)
10415 quit_throw_to_read_char ();
10418 /* Handle a C-g by making read_char return C-g. */
10421 quit_throw_to_read_char ()
10424 /* Prevent another signal from doing this before we finish. */
10425 clear_waiting_for_input ();
10428 Vunread_command_events
= Qnil
;
10429 unread_command_char
= -1;
10431 #if 0 /* Currently, sit_for is called from read_char without turning
10432 off polling. And that can call set_waiting_for_input.
10433 It seems to be harmless. */
10434 #ifdef POLL_FOR_INPUT
10435 /* May be > 1 if in recursive minibuffer. */
10436 if (poll_suppress_count
== 0)
10440 if (FRAMEP (internal_last_event_frame
)
10441 && !EQ (internal_last_event_frame
, selected_frame
))
10442 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10445 _longjmp (getcjmp
, 1);
10448 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10449 doc
: /* Set mode of reading keyboard input.
10450 First arg INTERRUPT non-nil means use input interrupts;
10451 nil means use CBREAK mode.
10452 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10453 (no effect except in CBREAK mode).
10454 Third arg META t means accept 8-bit input (for a Meta key).
10455 META nil means ignore the top bit, on the assumption it is parity.
10456 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10457 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10458 See also `current-input-mode'. */)
10459 (interrupt
, flow
, meta
, quit
)
10460 Lisp_Object interrupt
, flow
, meta
, quit
;
10462 /* XXX This function needs to be revised for multi-device support.
10463 Currently it compiles fine, but its semantics are wrong. It sets
10464 global parameters (e.g. interrupt_input) based on only the
10465 current frame's device. */
10468 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10469 error ("set-input-mode: QUIT must be an ASCII character");
10471 #ifdef POLL_FOR_INPUT
10476 /* this causes startup screen to be restored and messes with the mouse */
10477 reset_all_sys_modes ();
10481 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10482 if (FRAME_DISPLAY (SELECTED_FRAME ())->read_socket_hook
)
10484 /* When using X, don't give the user a real choice,
10485 because we haven't implemented the mechanisms to support it. */
10486 #ifdef NO_SOCK_SIGIO
10487 interrupt_input
= 0;
10488 #else /* not NO_SOCK_SIGIO */
10489 interrupt_input
= 1;
10490 #endif /* NO_SOCK_SIGIO */
10493 interrupt_input
= !NILP (interrupt
);
10494 #else /* not SIGIO */
10495 interrupt_input
= 0;
10496 #endif /* not SIGIO */
10498 /* Our VMS input only works by interrupts, as of now. */
10500 interrupt_input
= 1;
10503 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10505 struct tty_display_info
*tty
= CURTTY ();
10506 tty
->flow_control
= !NILP (flow
);
10509 else if (EQ (meta
, Qt
))
10516 /* Don't let this value be out of range. */
10517 quit_char
= XINT (quit
) & (NILP (meta
) ? 0177 : 0377);
10520 init_all_sys_modes ();
10523 #ifdef POLL_FOR_INPUT
10524 poll_suppress_count
= 1;
10530 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10531 doc
: /* Return information about the way Emacs currently reads keyboard input.
10532 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10533 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10534 nil, Emacs is using CBREAK mode.
10535 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10536 terminal; this does not apply if Emacs uses interrupt-driven input.
10537 META is t if accepting 8-bit input with 8th bit as Meta flag.
10538 META nil means ignoring the top bit, on the assumption it is parity.
10539 META is neither t nor nil if accepting 8-bit input and using
10540 all 8 bits as the character code.
10541 QUIT is the character Emacs currently uses to quit.
10542 The elements of this list correspond to the arguments of
10543 `set-input-mode'. */)
10546 Lisp_Object val
[4];
10547 struct frame
*sf
= XFRAME (selected_frame
);
10549 val
[0] = interrupt_input
? Qt
: Qnil
;
10550 if (FRAME_TERMCAP_P (sf
))
10552 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10553 val
[2] = FRAME_TTY (sf
)->meta_key
== 2
10555 : CURTTY ()->meta_key
== 1 ? Qt
: Qnil
;
10562 XSETFASTINT (val
[3], quit_char
);
10564 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10569 * Set up a new kboard object with reasonable initial values.
10575 kb
->Voverriding_terminal_local_map
= Qnil
;
10576 kb
->Vlast_command
= Qnil
;
10577 kb
->Vreal_last_command
= Qnil
;
10578 kb
->Vprefix_arg
= Qnil
;
10579 kb
->Vlast_prefix_arg
= Qnil
;
10580 kb
->kbd_queue
= Qnil
;
10581 kb
->kbd_queue_has_data
= 0;
10582 kb
->immediate_echo
= 0;
10583 kb
->echo_string
= Qnil
;
10584 kb
->echo_after_prompt
= -1;
10585 kb
->kbd_macro_buffer
= 0;
10586 kb
->kbd_macro_bufsize
= 0;
10587 kb
->defining_kbd_macro
= Qnil
;
10588 kb
->Vlast_kbd_macro
= Qnil
;
10589 kb
->reference_count
= 0;
10590 kb
->Vsystem_key_alist
= Qnil
;
10591 kb
->system_key_syms
= Qnil
;
10592 kb
->Vdefault_minibuffer_frame
= Qnil
;
10596 * Destroy the contents of a kboard object, but not the object itself.
10597 * We use this just before deleting it, or if we're going to initialize
10598 * it a second time.
10604 if (kb
->kbd_macro_buffer
)
10605 xfree (kb
->kbd_macro_buffer
);
10608 #ifdef MULTI_KBOARD
10610 /* Free KB and memory referenced from it. */
10618 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10621 *kbp
= kb
->next_kboard
;
10623 /* Prevent a dangling reference to KB. */
10624 if (kb
== current_kboard
10625 && FRAMEP (selected_frame
)
10626 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10628 current_kboard
= XFRAME (selected_frame
)->kboard
;
10629 if (current_kboard
== kb
)
10637 #endif /* MULTI_KBOARD */
10642 /* This is correct before outermost invocation of the editor loop */
10643 command_loop_level
= -1;
10644 immediate_quit
= 0;
10645 quit_char
= Ctl ('g');
10646 Vunread_command_events
= Qnil
;
10647 unread_command_char
= -1;
10648 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10650 recent_keys_index
= 0;
10651 kbd_fetch_ptr
= kbd_buffer
;
10652 kbd_store_ptr
= kbd_buffer
;
10654 do_mouse_tracking
= Qnil
;
10658 /* This means that command_loop_1 won't try to select anything the first
10660 internal_last_event_frame
= Qnil
;
10661 Vlast_event_frame
= internal_last_event_frame
;
10663 #ifdef MULTI_KBOARD
10664 current_kboard
= initial_kboard
;
10666 wipe_kboard (current_kboard
);
10667 init_kboard (current_kboard
);
10669 if (!noninteractive
)
10671 /* Before multi-tty support, these handlers used to be installed
10672 only if the current session was a tty session. Now an Emacs
10673 session may have multiple display types, so we always handle
10674 SIGINT. There is special code in interrupt_signal to exit
10675 Emacs on SIGINT when there are no termcap frames on the
10676 controlling terminal. */
10677 signal (SIGINT
, interrupt_signal
);
10678 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10679 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10680 SIGQUIT and we can't tell which one it will give us. */
10681 signal (SIGQUIT
, interrupt_signal
);
10682 #endif /* HAVE_TERMIO */
10684 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10686 if (!noninteractive
)
10687 signal (SIGIO
, input_available_signal
);
10690 /* Use interrupt input by default, if it works and noninterrupt input
10691 has deficiencies. */
10693 #ifdef INTERRUPT_INPUT
10694 interrupt_input
= 1;
10696 interrupt_input
= 0;
10699 /* Our VMS input only works by interrupts, as of now. */
10701 interrupt_input
= 1;
10707 if (keyboard_init_hook
)
10708 (*keyboard_init_hook
) ();
10710 #ifdef POLL_FOR_INPUT
10711 poll_suppress_count
= 1;
10716 /* At least provide an escape route since C-g doesn't work. */
10717 signal (SIGINT
, interrupt_signal
);
10721 /* This type's only use is in syms_of_keyboard, to initialize the
10722 event header symbols and put properties on them. */
10723 struct event_head
{
10729 struct event_head head_table
[] = {
10730 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10731 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10732 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10733 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10734 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10735 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10736 /* `select-window' should be handled just like `switch-frame'
10737 in read_key_sequence. */
10738 {&Qselect_window
, "select-window", &Qswitch_frame
}
10742 syms_of_keyboard ()
10744 Vpre_help_message
= Qnil
;
10745 staticpro (&Vpre_help_message
);
10747 Vlispy_mouse_stem
= build_string ("mouse");
10748 staticpro (&Vlispy_mouse_stem
);
10751 QCimage
= intern (":image");
10752 staticpro (&QCimage
);
10754 staticpro (&Qhelp_echo
);
10755 Qhelp_echo
= intern ("help-echo");
10757 staticpro (&item_properties
);
10758 item_properties
= Qnil
;
10760 staticpro (&tool_bar_item_properties
);
10761 tool_bar_item_properties
= Qnil
;
10762 staticpro (&tool_bar_items_vector
);
10763 tool_bar_items_vector
= Qnil
;
10765 staticpro (&real_this_command
);
10766 real_this_command
= Qnil
;
10768 Qtimer_event_handler
= intern ("timer-event-handler");
10769 staticpro (&Qtimer_event_handler
);
10771 Qdisabled_command_hook
= intern ("disabled-command-hook");
10772 staticpro (&Qdisabled_command_hook
);
10774 Qself_insert_command
= intern ("self-insert-command");
10775 staticpro (&Qself_insert_command
);
10777 Qforward_char
= intern ("forward-char");
10778 staticpro (&Qforward_char
);
10780 Qbackward_char
= intern ("backward-char");
10781 staticpro (&Qbackward_char
);
10783 Qdisabled
= intern ("disabled");
10784 staticpro (&Qdisabled
);
10786 Qundefined
= intern ("undefined");
10787 staticpro (&Qundefined
);
10789 Qpre_command_hook
= intern ("pre-command-hook");
10790 staticpro (&Qpre_command_hook
);
10792 Qpost_command_hook
= intern ("post-command-hook");
10793 staticpro (&Qpost_command_hook
);
10795 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10796 staticpro (&Qpost_command_idle_hook
);
10798 Qdeferred_action_function
= intern ("deferred-action-function");
10799 staticpro (&Qdeferred_action_function
);
10801 Qcommand_hook_internal
= intern ("command-hook-internal");
10802 staticpro (&Qcommand_hook_internal
);
10804 Qfunction_key
= intern ("function-key");
10805 staticpro (&Qfunction_key
);
10806 Qmouse_click
= intern ("mouse-click");
10807 staticpro (&Qmouse_click
);
10809 Qlanguage_change
= intern ("language-change");
10810 staticpro (&Qlanguage_change
);
10812 Qdrag_n_drop
= intern ("drag-n-drop");
10813 staticpro (&Qdrag_n_drop
);
10815 Qsave_session
= intern ("save-session");
10816 staticpro(&Qsave_session
);
10818 Qusr1_signal
= intern ("usr1-signal");
10819 staticpro (&Qusr1_signal
);
10820 Qusr2_signal
= intern ("usr2-signal");
10821 staticpro (&Qusr2_signal
);
10823 Qmenu_enable
= intern ("menu-enable");
10824 staticpro (&Qmenu_enable
);
10825 Qmenu_alias
= intern ("menu-alias");
10826 staticpro (&Qmenu_alias
);
10827 QCenable
= intern (":enable");
10828 staticpro (&QCenable
);
10829 QCvisible
= intern (":visible");
10830 staticpro (&QCvisible
);
10831 QChelp
= intern (":help");
10832 staticpro (&QChelp
);
10833 QCfilter
= intern (":filter");
10834 staticpro (&QCfilter
);
10835 QCbutton
= intern (":button");
10836 staticpro (&QCbutton
);
10837 QCkeys
= intern (":keys");
10838 staticpro (&QCkeys
);
10839 QCkey_sequence
= intern (":key-sequence");
10840 staticpro (&QCkey_sequence
);
10841 QCtoggle
= intern (":toggle");
10842 staticpro (&QCtoggle
);
10843 QCradio
= intern (":radio");
10844 staticpro (&QCradio
);
10846 Qmode_line
= intern ("mode-line");
10847 staticpro (&Qmode_line
);
10848 Qvertical_line
= intern ("vertical-line");
10849 staticpro (&Qvertical_line
);
10850 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10851 staticpro (&Qvertical_scroll_bar
);
10852 Qmenu_bar
= intern ("menu-bar");
10853 staticpro (&Qmenu_bar
);
10855 Qabove_handle
= intern ("above-handle");
10856 staticpro (&Qabove_handle
);
10857 Qhandle
= intern ("handle");
10858 staticpro (&Qhandle
);
10859 Qbelow_handle
= intern ("below-handle");
10860 staticpro (&Qbelow_handle
);
10861 Qup
= intern ("up");
10863 Qdown
= intern ("down");
10864 staticpro (&Qdown
);
10865 Qtop
= intern ("top");
10867 Qbottom
= intern ("bottom");
10868 staticpro (&Qbottom
);
10869 Qend_scroll
= intern ("end-scroll");
10870 staticpro (&Qend_scroll
);
10871 Qratio
= intern ("ratio");
10872 staticpro (&Qratio
);
10874 Qevent_kind
= intern ("event-kind");
10875 staticpro (&Qevent_kind
);
10876 Qevent_symbol_elements
= intern ("event-symbol-elements");
10877 staticpro (&Qevent_symbol_elements
);
10878 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10879 staticpro (&Qevent_symbol_element_mask
);
10880 Qmodifier_cache
= intern ("modifier-cache");
10881 staticpro (&Qmodifier_cache
);
10883 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10884 staticpro (&Qrecompute_lucid_menubar
);
10885 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10886 staticpro (&Qactivate_menubar_hook
);
10888 Qpolling_period
= intern ("polling-period");
10889 staticpro (&Qpolling_period
);
10891 Qinput_method_function
= intern ("input-method-function");
10892 staticpro (&Qinput_method_function
);
10894 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10895 staticpro (&Qinput_method_exit_on_first_char
);
10896 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10897 staticpro (&Qinput_method_use_echo_area
);
10899 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10900 Fset (Qinput_method_use_echo_area
, Qnil
);
10902 last_point_position_buffer
= Qnil
;
10905 struct event_head
*p
;
10907 for (p
= head_table
;
10908 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10911 *p
->var
= intern (p
->name
);
10912 staticpro (p
->var
);
10913 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10914 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10918 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10919 staticpro (&button_down_location
);
10920 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10921 staticpro (&mouse_syms
);
10922 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
10923 staticpro (&wheel_syms
);
10927 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10929 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10930 for (i
= 0; i
< len
; i
++)
10931 if (modifier_names
[i
])
10932 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10933 staticpro (&modifier_symbols
);
10936 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10937 staticpro (&recent_keys
);
10939 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10940 staticpro (&this_command_keys
);
10942 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10943 staticpro (&raw_keybuf
);
10945 Qextended_command_history
= intern ("extended-command-history");
10946 Fset (Qextended_command_history
, Qnil
);
10947 staticpro (&Qextended_command_history
);
10949 accent_key_syms
= Qnil
;
10950 staticpro (&accent_key_syms
);
10952 func_key_syms
= Qnil
;
10953 staticpro (&func_key_syms
);
10955 drag_n_drop_syms
= Qnil
;
10956 staticpro (&drag_n_drop_syms
);
10958 unread_switch_frame
= Qnil
;
10959 staticpro (&unread_switch_frame
);
10961 internal_last_event_frame
= Qnil
;
10962 staticpro (&internal_last_event_frame
);
10964 read_key_sequence_cmd
= Qnil
;
10965 staticpro (&read_key_sequence_cmd
);
10967 menu_bar_one_keymap_changed_items
= Qnil
;
10968 staticpro (&menu_bar_one_keymap_changed_items
);
10970 defsubr (&Sevent_convert_list
);
10971 defsubr (&Sread_key_sequence
);
10972 defsubr (&Sread_key_sequence_vector
);
10973 defsubr (&Srecursive_edit
);
10975 defsubr (&Strack_mouse
);
10977 defsubr (&Sinput_pending_p
);
10978 defsubr (&Scommand_execute
);
10979 defsubr (&Srecent_keys
);
10980 defsubr (&Sthis_command_keys
);
10981 defsubr (&Sthis_command_keys_vector
);
10982 defsubr (&Sthis_single_command_keys
);
10983 defsubr (&Sthis_single_command_raw_keys
);
10984 defsubr (&Sreset_this_command_lengths
);
10985 defsubr (&Sclear_this_command_keys
);
10986 defsubr (&Ssuspend_emacs
);
10987 defsubr (&Sabort_recursive_edit
);
10988 defsubr (&Sexit_recursive_edit
);
10989 defsubr (&Srecursion_depth
);
10990 defsubr (&Stop_level
);
10991 defsubr (&Sdiscard_input
);
10992 defsubr (&Sopen_dribble_file
);
10993 defsubr (&Sset_input_mode
);
10994 defsubr (&Scurrent_input_mode
);
10995 defsubr (&Sexecute_extended_command
);
10997 DEFVAR_LISP ("last-command-char", &last_command_char
,
10998 doc
: /* Last input event that was part of a command. */);
11000 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11001 doc
: /* Last input event that was part of a command. */);
11003 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11004 doc
: /* Last input event in a command, except for mouse menu events.
11005 Mouse menus give back keys that don't look like mouse events;
11006 this variable holds the actual mouse event that led to the menu,
11007 so that you can determine whether the command was run by mouse or not. */);
11009 DEFVAR_LISP ("last-input-char", &last_input_char
,
11010 doc
: /* Last input event. */);
11012 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11013 doc
: /* Last input event. */);
11015 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11016 doc
: /* List of events to be read as the command input.
11017 These events are processed first, before actual keyboard input. */);
11018 Vunread_command_events
= Qnil
;
11020 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11021 doc
: /* If not -1, an object to be read as next command input event. */);
11023 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11024 doc
: /* List of events to be processed as input by input methods.
11025 These events are processed after `unread-command-events', but
11026 before actual keyboard input. */);
11027 Vunread_post_input_method_events
= Qnil
;
11029 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11030 doc
: /* List of events to be processed as input by input methods.
11031 These events are processed after `unread-command-events', but
11032 before actual keyboard input. */);
11033 Vunread_input_method_events
= Qnil
;
11035 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11036 doc
: /* Meta-prefix character code.
11037 Meta-foo as command input turns into this character followed by foo. */);
11038 XSETINT (meta_prefix_char
, 033);
11040 DEFVAR_KBOARD ("last-command", Vlast_command
,
11041 doc
: /* The last command executed.
11042 Normally a symbol with a function definition, but can be whatever was found
11043 in the keymap, or whatever the variable `this-command' was set to by that
11046 The value `mode-exit' is special; it means that the previous command
11047 read an event that told it to exit, and it did so and unread that event.
11048 In other words, the present command is the event that made the previous
11051 The value `kill-region' is special; it means that the previous command
11052 was a kill command. */);
11054 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11055 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11057 DEFVAR_LISP ("this-command", &Vthis_command
,
11058 doc
: /* The command now being executed.
11059 The command can set this variable; whatever is put here
11060 will be in `last-command' during the following command. */);
11061 Vthis_command
= Qnil
;
11063 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11064 doc
: /* The command bound to the current key sequence before remapping.
11065 It equals `this-command' if the original command was not remapped through
11066 any of the active keymaps. Otherwise, the value of `this-command' is the
11067 result of looking up the original command in the active keymaps. */);
11068 Vthis_original_command
= Qnil
;
11070 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11071 doc
: /* *Number of input events between auto-saves.
11072 Zero means disable autosaving due to number of characters typed. */);
11073 auto_save_interval
= 300;
11075 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11076 doc
: /* *Number of seconds idle time before auto-save.
11077 Zero or nil means disable auto-saving due to idleness.
11078 After auto-saving due to this many seconds of idle time,
11079 Emacs also does a garbage collection if that seems to be warranted. */);
11080 XSETFASTINT (Vauto_save_timeout
, 30);
11082 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11083 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11084 The value may be integer or floating point. */);
11085 Vecho_keystrokes
= make_number (1);
11087 DEFVAR_INT ("polling-period", &polling_period
,
11088 doc
: /* *Interval between polling for input during Lisp execution.
11089 The reason for polling is to make C-g work to stop a running program.
11090 Polling is needed only when using X windows and SIGIO does not work.
11091 Polling is automatically disabled in all other cases. */);
11092 polling_period
= 2;
11094 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11095 doc
: /* *Maximum time between mouse clicks to make a double-click.
11096 Measured in milliseconds. nil means disable double-click recognition;
11097 t means double-clicks have no time limit and are detected
11098 by position only. */);
11099 Vdouble_click_time
= make_number (500);
11101 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11102 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11103 On window-system frames, value is the number of pixels the mouse may have
11104 moved horizontally or vertically between two clicks to make a double-click.
11105 On non window-system frames, value is interpreted in units of 1/8 characters
11108 This variable is also the threshold for motion of the mouse
11109 to count as a drag. */);
11110 double_click_fuzz
= 3;
11112 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11113 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11114 inhibit_local_menu_bar_menus
= 0;
11116 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11117 doc
: /* Number of complete key sequences read as input so far.
11118 This includes key sequences read from keyboard macros.
11119 The number is effectively the number of interactive command invocations. */);
11120 num_input_keys
= 0;
11122 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11123 doc
: /* Number of input events read from the keyboard so far.
11124 This does not include events generated by keyboard macros. */);
11125 num_nonmacro_input_events
= 0;
11127 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11128 doc
: /* The frame in which the most recently read event occurred.
11129 If the last event came from a keyboard macro, this is set to `macro'. */);
11130 Vlast_event_frame
= Qnil
;
11132 /* This variable is set up in sysdep.c. */
11133 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11134 doc
: /* The ERASE character as set by the user with stty. */);
11136 DEFVAR_LISP ("help-char", &Vhelp_char
,
11137 doc
: /* Character to recognize as meaning Help.
11138 When it is read, do `(eval help-form)', and display result if it's a string.
11139 If the value of `help-form' is nil, this char can be read normally. */);
11140 XSETINT (Vhelp_char
, Ctl ('H'));
11142 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11143 doc
: /* List of input events to recognize as meaning Help.
11144 These work just like the value of `help-char' (see that). */);
11145 Vhelp_event_list
= Qnil
;
11147 DEFVAR_LISP ("help-form", &Vhelp_form
,
11148 doc
: /* Form to execute when character `help-char' is read.
11149 If the form returns a string, that string is displayed.
11150 If `help-form' is nil, the help char is not recognized. */);
11153 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11154 doc
: /* Command to run when `help-char' character follows a prefix key.
11155 This command is used only when there is no actual binding
11156 for that character after that prefix key. */);
11157 Vprefix_help_command
= Qnil
;
11159 DEFVAR_LISP ("top-level", &Vtop_level
,
11160 doc
: /* Form to evaluate when Emacs starts up.
11161 Useful to set before you dump a modified Emacs. */);
11164 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11165 doc
: /* Translate table for keyboard input, or nil.
11166 Each character is looked up in this string and the contents used instead.
11167 The value may be a string, a vector, or a char-table.
11168 If it is a string or vector of length N,
11169 character codes N and up are untranslated.
11170 In a vector or a char-table, an element which is nil means "no translation".
11172 This is applied to the characters supplied to input methods, not their
11173 output. See also `translation-table-for-input'. */);
11174 Vkeyboard_translate_table
= Qnil
;
11176 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11177 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11178 \(Even if the operating system has support for stopping a process.\) */);
11179 cannot_suspend
= 0;
11181 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11182 doc
: /* Non-nil means prompt with menus when appropriate.
11183 This is done when reading from a keymap that has a prompt string,
11184 for elements that have prompt strings.
11185 The menu is displayed on the screen
11186 if X menus were enabled at configuration
11187 time and the previous event was a mouse click prefix key.
11188 Otherwise, menu prompting uses the echo area. */);
11189 menu_prompting
= 1;
11191 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11192 doc
: /* Character to see next line of menu prompt.
11193 Type this character while in a menu prompt to rotate around the lines of it. */);
11194 XSETINT (menu_prompt_more_char
, ' ');
11196 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11197 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11198 Emacs applies the modifiers of the character stored here to each keyboard
11199 character it reads. For example, after evaluating the expression
11200 (setq extra-keyboard-modifiers ?\\C-x)
11201 all input characters will have the control modifier applied to them.
11203 Note that the character ?\\C-@, equivalent to the integer zero, does
11204 not count as a control character; rather, it counts as a character
11205 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11206 cancels any modification. */);
11207 extra_keyboard_modifiers
= 0;
11209 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11210 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11211 The command loop sets this to nil before each command,
11212 and tests the value when the command returns.
11213 Buffer modification stores t in this variable. */);
11214 Vdeactivate_mark
= Qnil
;
11216 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11217 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11218 Vcommand_hook_internal
= Qnil
;
11220 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11221 doc
: /* Normal hook run before each command is executed.
11222 If an unhandled error happens in running this hook,
11223 the hook value is set to nil, since otherwise the error
11224 might happen repeatedly and make Emacs nonfunctional. */);
11225 Vpre_command_hook
= Qnil
;
11227 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11228 doc
: /* Normal hook run after each command is executed.
11229 If an unhandled error happens in running this hook,
11230 the hook value is set to nil, since otherwise the error
11231 might happen repeatedly and make Emacs nonfunctional. */);
11232 Vpost_command_hook
= Qnil
;
11234 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11235 doc
: /* Normal hook run after each command is executed, if idle.
11236 Errors running the hook are caught and ignored. */);
11237 Vpost_command_idle_hook
= Qnil
;
11239 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11240 doc
: /* Delay time before running `post-command-idle-hook'.
11241 This is measured in microseconds. */);
11242 post_command_idle_delay
= 100000;
11245 DEFVAR_LISP ("echo-area-clear-hook", ...,
11246 doc
: /* Normal hook run when clearing the echo area. */);
11248 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11249 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11251 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11252 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11253 Vlucid_menu_bar_dirty_flag
= Qnil
;
11255 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11256 doc
: /* List of menu bar items to move to the end of the menu bar.
11257 The elements of the list are event types that may have menu bar bindings. */);
11258 Vmenu_bar_final_items
= Qnil
;
11260 DEFVAR_KBOARD ("overriding-terminal-local-map",
11261 Voverriding_terminal_local_map
,
11262 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11263 If this variable is non-nil, it is used as a keymap instead of the
11264 buffer's local map, and the minor mode keymaps and text property keymaps.
11265 This variable is intended to let commands such as `universal-argument'
11266 set up a different keymap for reading the next command. */);
11268 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11269 doc
: /* Keymap that overrides all other local keymaps.
11270 If this variable is non-nil, it is used as a keymap instead of the
11271 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11272 Voverriding_local_map
= Qnil
;
11274 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11275 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11276 Otherwise, the menu bar continues to reflect the buffer's local map
11277 and the minor mode maps regardless of `overriding-local-map'. */);
11278 Voverriding_local_map_menu_flag
= Qnil
;
11280 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11281 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11282 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11284 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11285 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11287 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11288 doc
: /* Alist of system-specific X windows key symbols.
11289 Each element should have the form (N . SYMBOL) where N is the
11290 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11291 and SYMBOL is its name. */);
11293 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11294 doc
: /* List of deferred actions to be performed at a later time.
11295 The precise format isn't relevant here; we just check whether it is nil. */);
11296 Vdeferred_action_list
= Qnil
;
11298 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11299 doc
: /* Function to call to handle deferred actions, after each command.
11300 This function is called with no arguments after each command
11301 whenever `deferred-action-list' is non-nil. */);
11302 Vdeferred_action_function
= Qnil
;
11304 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11305 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11306 The value can be a length of time to show the message for.
11307 If the value is non-nil and not a number, we wait 2 seconds. */);
11308 Vsuggest_key_bindings
= Qt
;
11310 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11311 doc
: /* List of active absolute time timers in order of increasing time. */);
11312 Vtimer_list
= Qnil
;
11314 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11315 doc
: /* List of active idle-time timers in order of increasing time. */);
11316 Vtimer_idle_list
= Qnil
;
11318 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11319 doc
: /* If non-nil, the function that implements the current input method.
11320 It's called with one argument, a printing character that was just read.
11321 \(That means a character with code 040...0176.)
11322 Typically this function uses `read-event' to read additional events.
11323 When it does so, it should first bind `input-method-function' to nil
11324 so it will not be called recursively.
11326 The function should return a list of zero or more events
11327 to be used as input. If it wants to put back some events
11328 to be reconsidered, separately, by the input method,
11329 it can add them to the beginning of `unread-command-events'.
11331 The input method function can find in `input-method-previous-method'
11332 the previous echo area message.
11334 The input method function should refer to the variables
11335 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11336 for guidance on what to do. */);
11337 Vinput_method_function
= Qnil
;
11339 DEFVAR_LISP ("input-method-previous-message",
11340 &Vinput_method_previous_message
,
11341 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11342 This variable exists because `read-event' clears the echo area
11343 before running the input method. It is nil if there was no message. */);
11344 Vinput_method_previous_message
= Qnil
;
11346 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11347 doc
: /* If non-nil, the function that implements the display of help.
11348 It's called with one argument, the help string to display. */);
11349 Vshow_help_function
= Qnil
;
11351 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11352 doc
: /* If non-nil, suppress point adjustment after executing a command.
11354 After a command is executed, if point is moved into a region that has
11355 special properties (e.g. composition, display), we adjust point to
11356 the boundary of the region. But, several special commands sets this
11357 variable to non-nil, then we suppress the point adjustment.
11359 This variable is set to nil before reading a command, and is checked
11360 just after executing the command. */);
11361 Vdisable_point_adjustment
= Qnil
;
11363 DEFVAR_LISP ("global-disable-point-adjustment",
11364 &Vglobal_disable_point_adjustment
,
11365 doc
: /* *If non-nil, always suppress point adjustment.
11367 The default value is nil, in which case, point adjustment are
11368 suppressed only after special commands that set
11369 `disable-point-adjustment' (which see) to non-nil. */);
11370 Vglobal_disable_point_adjustment
= Qnil
;
11372 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11373 doc
: /* Non-nil means updating menu bindings is allowed.
11374 A value of nil means menu bindings should not be updated.
11375 Used during Emacs' startup. */);
11376 update_menu_bindings
= 1;
11378 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11379 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11380 If the value is not a number, such messages don't time out. */);
11381 Vminibuffer_message_timeout
= make_number (2);
11385 keys_of_keyboard ()
11387 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11388 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11389 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11390 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11391 initial_define_key (meta_map
, 'x', "execute-extended-command");
11393 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11394 "handle-delete-frame");
11395 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11397 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11399 /* Handling it at such a low-level causes read_key_sequence to get
11400 * confused because it doesn't realize that the current_buffer was
11401 * changed by read_char.
11403 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11404 * "handle-select-window"); */
11405 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11406 "handle-save-session");
11409 /* Mark the pointers in the kboard objects.
11410 Called by the Fgarbage_collector. */
11416 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11418 if (kb
->kbd_macro_buffer
)
11419 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11421 mark_object (kb
->Voverriding_terminal_local_map
);
11422 mark_object (kb
->Vlast_command
);
11423 mark_object (kb
->Vreal_last_command
);
11424 mark_object (kb
->Vprefix_arg
);
11425 mark_object (kb
->Vlast_prefix_arg
);
11426 mark_object (kb
->kbd_queue
);
11427 mark_object (kb
->defining_kbd_macro
);
11428 mark_object (kb
->Vlast_kbd_macro
);
11429 mark_object (kb
->Vsystem_key_alist
);
11430 mark_object (kb
->system_key_syms
);
11431 mark_object (kb
->Vdefault_minibuffer_frame
);
11432 mark_object (kb
->echo_string
);
11435 struct input_event
*event
;
11436 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11438 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11439 event
= kbd_buffer
;
11440 mark_object (event
->x
);
11441 mark_object (event
->y
);
11442 mark_object (event
->frame_or_window
);
11443 mark_object (event
->arg
);
11448 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11449 (do not change this comment) */