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. */
28 #include "termhooks.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
53 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
60 #include <sys/types.h>
65 /* This is to get the definitions of the XK_ symbols. */
72 #endif /* HAVE_NTGUI */
82 /* Variables for blockinput.h: */
84 /* Non-zero if interrupt input is blocked right now. */
85 int interrupt_input_blocked
;
87 /* Nonzero means an input interrupt has arrived
88 during the current critical section. */
89 int interrupt_input_pending
;
92 /* File descriptor to use for input. */
95 #ifdef HAVE_WINDOW_SYSTEM
96 /* Make all keyboard buffers much bigger when using X windows. */
98 /* But not too big (local data > 32K error) if on Mac OS Classic. */
99 #define KBD_BUFFER_SIZE 512
101 #define KBD_BUFFER_SIZE 4096
103 #else /* No X-windows, character input */
104 #define KBD_BUFFER_SIZE 4096
105 #endif /* No X-windows */
107 #define abs(x) ((x) >= 0 ? (x) : -(x))
109 /* Following definition copied from eval.c */
113 struct backtrace
*next
;
114 Lisp_Object
*function
;
115 Lisp_Object
*args
; /* Points to vector of args. */
116 int nargs
; /* length of vector. If nargs is UNEVALLED,
117 args points to slot holding list of
120 /* Nonzero means call value of debugger when done with this operation. */
125 KBOARD
*initial_kboard
;
126 KBOARD
*current_kboard
;
130 KBOARD the_only_kboard
;
133 /* Non-nil disable property on a command means
134 do not execute it; call disabled-command-function's value instead. */
135 Lisp_Object Qdisabled
, Qdisabled_command_function
;
137 #define NUM_RECENT_KEYS (100)
138 int recent_keys_index
; /* Index for storing next element into recent_keys */
139 int total_keys
; /* Total number of elements stored into recent_keys */
140 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
142 /* Vector holding the key sequence that invoked the current command.
143 It is reused for each command, and it may be longer than the current
144 sequence; this_command_key_count indicates how many elements
145 actually mean something.
146 It's easier to staticpro a single Lisp_Object than an array. */
147 Lisp_Object this_command_keys
;
148 int this_command_key_count
;
150 /* 1 after calling Freset_this_command_lengths.
152 int this_command_key_count_reset
;
154 /* This vector is used as a buffer to record the events that were actually read
155 by read_key_sequence. */
156 Lisp_Object raw_keybuf
;
157 int raw_keybuf_count
;
159 #define GROW_RAW_KEYBUF \
160 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
162 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
164 new = Fmake_vector (make_number (newsize), Qnil); \
165 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
166 raw_keybuf_count * sizeof (Lisp_Object)); \
170 /* Number of elements of this_command_keys
171 that precede this key sequence. */
172 int this_single_command_key_start
;
174 /* Record values of this_command_key_count and echo_length ()
175 before this command was read. */
176 static int before_command_key_count
;
177 static int before_command_echo_length
;
179 extern int minbuf_level
;
181 extern int message_enable_multibyte
;
183 extern struct backtrace
*backtrace_list
;
185 /* If non-nil, the function that implements the display of help.
186 It's called with one argument, the help string to display. */
188 Lisp_Object Vshow_help_function
;
190 /* If a string, the message displayed before displaying a help-echo
193 Lisp_Object Vpre_help_message
;
195 /* Nonzero means do menu prompting. */
197 static int menu_prompting
;
199 /* Character to see next line of menu prompt. */
201 static Lisp_Object menu_prompt_more_char
;
203 /* For longjmp to where kbd input is being done. */
205 static jmp_buf getcjmp
;
207 /* True while doing kbd input. */
208 int waiting_for_input
;
210 /* True while displaying for echoing. Delays C-g throwing. */
214 /* Non-null means we can start echoing at the next input pause even
215 though there is something in the echo area. */
217 static struct kboard
*ok_to_echo_at_next_pause
;
219 /* The kboard last echoing, or null for none. Reset to 0 in
220 cancel_echoing. If non-null, and a current echo area message
221 exists, and echo_message_buffer is eq to the current message
222 buffer, we know that the message comes from echo_kboard. */
224 struct kboard
*echo_kboard
;
226 /* The buffer used for echoing. Set in echo_now, reset in
229 Lisp_Object echo_message_buffer
;
231 /* Nonzero means disregard local maps for the menu bar. */
232 static int inhibit_local_menu_bar_menus
;
234 /* Nonzero means C-g should cause immediate error-signal. */
237 /* The user's ERASE setting. */
238 Lisp_Object Vtty_erase_char
;
240 /* Character to recognize as the help char. */
241 Lisp_Object Vhelp_char
;
243 /* List of other event types to recognize as meaning "help". */
244 Lisp_Object Vhelp_event_list
;
246 /* Form to execute when help char is typed. */
247 Lisp_Object Vhelp_form
;
249 /* Command to run when the help character follows a prefix key. */
250 Lisp_Object Vprefix_help_command
;
252 /* List of items that should move to the end of the menu bar. */
253 Lisp_Object Vmenu_bar_final_items
;
255 /* Non-nil means show the equivalent key-binding for
256 any M-x command that has one.
257 The value can be a length of time to show the message for.
258 If the value is non-nil and not a number, we wait 2 seconds. */
259 Lisp_Object Vsuggest_key_bindings
;
261 /* How long to display an echo-area message when the minibuffer is active.
262 If the value is not a number, such messages don't time out. */
263 Lisp_Object Vminibuffer_message_timeout
;
265 /* Character that causes a quit. Normally C-g.
267 If we are running on an ordinary terminal, this must be an ordinary
268 ASCII char, since we want to make it our interrupt character.
270 If we are not running on an ordinary terminal, it still needs to be
271 an ordinary ASCII char. This character needs to be recognized in
272 the input interrupt handler. At this point, the keystroke is
273 represented as a struct input_event, while the desired quit
274 character is specified as a lispy event. The mapping from struct
275 input_events to lispy events cannot run in an interrupt handler,
276 and the reverse mapping is difficult for anything but ASCII
279 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
283 extern Lisp_Object current_global_map
;
284 extern int minibuf_level
;
286 /* If non-nil, this is a map that overrides all other local maps. */
287 Lisp_Object Voverriding_local_map
;
289 /* If non-nil, Voverriding_local_map applies to the menu bar. */
290 Lisp_Object Voverriding_local_map_menu_flag
;
292 /* Keymap that defines special misc events that should
293 be processed immediately at a low level. */
294 Lisp_Object Vspecial_event_map
;
296 /* Current depth in recursive edits. */
297 int command_loop_level
;
299 /* Total number of times command_loop has read a key sequence. */
300 EMACS_INT num_input_keys
;
302 /* Last input character read as a command. */
303 Lisp_Object last_command_char
;
305 /* Last input character read as a command, not counting menus
306 reached by the mouse. */
307 Lisp_Object last_nonmenu_event
;
309 /* Last input character read for any purpose. */
310 Lisp_Object last_input_char
;
312 /* If not Qnil, a list of objects to be read as subsequent command input. */
313 Lisp_Object Vunread_command_events
;
315 /* If not Qnil, a list of objects to be read as subsequent command input
316 including input method processing. */
317 Lisp_Object Vunread_input_method_events
;
319 /* If not Qnil, a list of objects to be read as subsequent command input
320 but NOT including input method processing. */
321 Lisp_Object Vunread_post_input_method_events
;
323 /* If not -1, an event to be read as subsequent command input. */
324 EMACS_INT unread_command_char
;
326 /* If not Qnil, this is a switch-frame event which we decided to put
327 off until the end of a key sequence. This should be read as the
328 next command input, after any unread_command_events.
330 read_key_sequence uses this to delay switch-frame events until the
331 end of the key sequence; Fread_char uses it to put off switch-frame
332 events until a non-ASCII event is acceptable as input. */
333 Lisp_Object unread_switch_frame
;
335 /* A mask of extra modifier bits to put into every keyboard char. */
336 EMACS_INT extra_keyboard_modifiers
;
338 /* Char to use as prefix when a meta character is typed in.
339 This is bound on entry to minibuffer in case ESC is changed there. */
341 Lisp_Object meta_prefix_char
;
343 /* Last size recorded for a current buffer which is not a minibuffer. */
344 static int last_non_minibuf_size
;
346 /* Number of idle seconds before an auto-save and garbage collection. */
347 static Lisp_Object Vauto_save_timeout
;
349 /* Total number of times read_char has returned. */
350 int num_input_events
;
352 /* Total number of times read_char has returned, outside of macros. */
353 EMACS_INT num_nonmacro_input_events
;
355 /* Auto-save automatically when this many characters have been typed
356 since the last time. */
358 static EMACS_INT auto_save_interval
;
360 /* Value of num_nonmacro_input_events as of last auto save. */
364 /* The command being executed by the command loop.
365 Commands may set this, and the value set will be copied into
366 current_kboard->Vlast_command instead of the actual command. */
367 Lisp_Object Vthis_command
;
369 /* This is like Vthis_command, except that commands never set it. */
370 Lisp_Object real_this_command
;
372 /* If the lookup of the command returns a binding, the original
373 command is stored in this-original-command. It is nil otherwise. */
374 Lisp_Object Vthis_original_command
;
376 /* The value of point when the last command was executed. */
377 int last_point_position
;
379 /* The buffer that was current when the last command was started. */
380 Lisp_Object last_point_position_buffer
;
382 /* The frame in which the last input event occurred, or Qmacro if the
383 last event came from a macro. We use this to determine when to
384 generate switch-frame events. This may be cleared by functions
385 like Fselect_frame, to make sure that a switch-frame event is
386 generated by the next character. */
387 Lisp_Object internal_last_event_frame
;
389 /* A user-visible version of the above, intended to allow users to
390 figure out where the last event came from, if the event doesn't
391 carry that information itself (i.e. if it was a character). */
392 Lisp_Object Vlast_event_frame
;
394 /* The timestamp of the last input event we received from the X server.
395 X Windows wants this for selection ownership. */
396 unsigned long last_event_timestamp
;
398 Lisp_Object Qself_insert_command
;
399 Lisp_Object Qforward_char
;
400 Lisp_Object Qbackward_char
;
401 Lisp_Object Qundefined
;
402 Lisp_Object Qtimer_event_handler
;
404 /* read_key_sequence stores here the command definition of the
405 key sequence that it reads. */
406 Lisp_Object read_key_sequence_cmd
;
408 /* Echo unfinished commands after this many seconds of pause. */
409 Lisp_Object Vecho_keystrokes
;
411 /* Form to evaluate (if non-nil) when Emacs is started. */
412 Lisp_Object Vtop_level
;
414 /* User-supplied table to translate input characters. */
415 Lisp_Object Vkeyboard_translate_table
;
417 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
418 extern Lisp_Object Vfunction_key_map
;
420 /* Another keymap that maps key sequences into key sequences.
421 This one takes precedence over ordinary definitions. */
422 extern Lisp_Object Vkey_translation_map
;
424 /* If non-nil, this implements the current input method. */
425 Lisp_Object Vinput_method_function
;
426 Lisp_Object Qinput_method_function
;
428 /* When we call Vinput_method_function,
429 this holds the echo area message that was just erased. */
430 Lisp_Object Vinput_method_previous_message
;
432 /* Non-nil means deactivate the mark at end of this command. */
433 Lisp_Object Vdeactivate_mark
;
435 /* Menu bar specified in Lucid Emacs fashion. */
437 Lisp_Object Vlucid_menu_bar_dirty_flag
;
438 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
440 Lisp_Object Qecho_area_clear_hook
;
442 /* Hooks to run before and after each command. */
443 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
444 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
445 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
446 /* Hook run after a command if there's no more input soon. */
447 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
449 /* Delay time in microseconds before running post-command-idle-hook. */
450 EMACS_INT post_command_idle_delay
;
452 /* List of deferred actions to be performed at a later time.
453 The precise format isn't relevant here; we just check whether it is nil. */
454 Lisp_Object Vdeferred_action_list
;
456 /* Function to call to handle deferred actions, when there are any. */
457 Lisp_Object Vdeferred_action_function
;
458 Lisp_Object Qdeferred_action_function
;
460 Lisp_Object Qinput_method_exit_on_first_char
;
461 Lisp_Object Qinput_method_use_echo_area
;
463 /* File in which we write all commands we read. */
466 /* Nonzero if input is available. */
469 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
470 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
474 /* Non-zero means force key bindings update in parse_menu_item. */
476 int update_menu_bindings
;
478 extern char *pending_malloc_warning
;
480 /* Circular buffer for pre-read keyboard input. */
482 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
484 /* Pointer to next available character in kbd_buffer.
485 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
486 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
487 next available char is in kbd_buffer[0]. */
488 static struct input_event
*kbd_fetch_ptr
;
490 /* Pointer to next place to store character in kbd_buffer. This
491 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
492 character should go in kbd_buffer[0]. */
493 static struct input_event
* volatile kbd_store_ptr
;
495 /* The above pair of variables forms a "queue empty" flag. When we
496 enqueue a non-hook event, we increment kbd_store_ptr. When we
497 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
498 there is input available iff the two pointers are not equal.
500 Why not just have a flag set and cleared by the enqueuing and
501 dequeuing functions? Such a flag could be screwed up by interrupts
502 at inopportune times. */
504 /* If this flag is non-nil, we check mouse_moved to see when the
505 mouse moves, and motion events will appear in the input stream.
506 Otherwise, mouse motion is ignored. */
507 Lisp_Object do_mouse_tracking
;
509 /* Symbols to head events. */
510 Lisp_Object Qmouse_movement
;
511 Lisp_Object Qscroll_bar_movement
;
512 Lisp_Object Qswitch_frame
;
513 Lisp_Object Qdelete_frame
;
514 Lisp_Object Qiconify_frame
;
515 Lisp_Object Qmake_frame_visible
;
516 Lisp_Object Qselect_window
;
517 Lisp_Object Qhelp_echo
;
519 /* Symbols to denote kinds of events. */
520 Lisp_Object Qfunction_key
;
521 Lisp_Object Qmouse_click
;
523 Lisp_Object Qlanguage_change
;
525 Lisp_Object Qdrag_n_drop
;
526 Lisp_Object Qsave_session
;
528 /* Lisp_Object Qmouse_movement; - also an event header */
530 /* Properties of event headers. */
531 Lisp_Object Qevent_kind
;
532 Lisp_Object Qevent_symbol_elements
;
534 /* menu item parts */
535 Lisp_Object Qmenu_alias
;
536 Lisp_Object Qmenu_enable
;
537 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
538 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
539 extern Lisp_Object Vdefine_key_rebound_commands
;
540 extern Lisp_Object Qmenu_item
;
542 /* An event header symbol HEAD may have a property named
543 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
544 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
545 mask of modifiers applied to it. If present, this is used to help
546 speed up parse_modifiers. */
547 Lisp_Object Qevent_symbol_element_mask
;
549 /* An unmodified event header BASE may have a property named
550 Qmodifier_cache, which is an alist mapping modifier masks onto
551 modified versions of BASE. If present, this helps speed up
553 Lisp_Object Qmodifier_cache
;
555 /* Symbols to use for parts of windows. */
556 Lisp_Object Qmode_line
;
557 Lisp_Object Qvertical_line
;
558 Lisp_Object Qvertical_scroll_bar
;
559 Lisp_Object Qmenu_bar
;
560 extern Lisp_Object Qleft_margin
, Qright_margin
;
561 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
562 extern Lisp_Object QCmap
;
564 Lisp_Object
recursive_edit_unwind (), command_loop ();
565 Lisp_Object
Fthis_command_keys ();
566 Lisp_Object Qextended_command_history
;
567 EMACS_TIME
timer_check ();
569 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
571 extern char *x_get_keysym_name ();
573 static void record_menu_key ();
574 static int echo_length ();
576 Lisp_Object Qpolling_period
;
578 /* List of absolute timers. Appears in order of next scheduled event. */
579 Lisp_Object Vtimer_list
;
581 /* List of idle time timers. Appears in order of next scheduled event. */
582 Lisp_Object Vtimer_idle_list
;
584 /* Incremented whenever a timer is run. */
587 extern Lisp_Object Vprint_level
, Vprint_length
;
589 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
591 EMACS_TIME
*input_available_clear_time
;
593 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
594 Default is 1 if INTERRUPT_INPUT is defined. */
597 /* Nonzero while interrupts are temporarily deferred during redisplay. */
598 int interrupts_deferred
;
600 /* Nonzero means use ^S/^Q for flow control. */
603 /* Allow m- file to inhibit use of FIONREAD. */
604 #ifdef BROKEN_FIONREAD
608 /* We are unable to use interrupts if FIONREAD is not available,
609 so flush SIGIO so we won't try. */
610 #if !defined (FIONREAD) || defined(HAVE_CARBON)
616 /* If we support a window system, turn on the code to poll periodically
617 to detect C-g. It isn't actually used when doing interrupt input. */
618 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
619 #define POLL_FOR_INPUT
622 /* After a command is executed, if point is moved into a region that
623 has specific properties (e.g. composition, display), we adjust
624 point to the boundary of the region. But, if a command sets this
625 variable to non-nil, we suppress this point adjustment. This
626 variable is set to nil before reading a command. */
628 Lisp_Object Vdisable_point_adjustment
;
630 /* If non-nil, always disable point adjustment. */
632 Lisp_Object Vglobal_disable_point_adjustment
;
634 /* The time when Emacs started being idle. */
636 static EMACS_TIME timer_idleness_start_time
;
638 /* After Emacs stops being idle, this saves the last value
639 of timer_idleness_start_time from when it was idle. */
641 static EMACS_TIME timer_last_idleness_start_time
;
644 /* Global variable declarations. */
646 /* Function for init_keyboard to call with no args (if nonzero). */
647 void (*keyboard_init_hook
) ();
649 static int read_avail_input
P_ ((int));
650 static void get_input_pending
P_ ((int *, int));
651 static void get_filtered_input_pending
P_ ((int *, int, int));
652 static int readable_events
P_ ((int));
653 static int readable_filtered_events
P_ ((int, int));
654 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
655 Lisp_Object
, int *));
656 static Lisp_Object
read_char_x_menu_prompt ();
657 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
659 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
661 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
662 enum scroll_bar_part
,
663 Lisp_Object
, Lisp_Object
,
666 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
667 Lisp_Object
, char **,
668 Lisp_Object
*, unsigned));
669 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
670 static int parse_solitary_modifier
P_ ((Lisp_Object
));
671 static int parse_solitary_modifier ();
672 static void save_getcjmp
P_ ((jmp_buf));
673 static void save_getcjmp ();
674 static void restore_getcjmp
P_ ((jmp_buf));
675 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
676 static void clear_event
P_ ((struct input_event
*));
677 static void any_kboard_state
P_ ((void));
678 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
680 /* Nonzero means don't try to suspend even if the operating system seems
682 static int cannot_suspend
;
684 extern Lisp_Object Qidentity
, Qonly
;
686 /* Install the string STR as the beginning of the string of echoing,
687 so that it serves as a prompt for the next character.
688 Also start echoing. */
694 current_kboard
->echo_string
= str
;
695 current_kboard
->echo_after_prompt
= SCHARS (str
);
699 /* Add C to the echo string, if echoing is going on.
700 C can be a character, which is printed prettily ("M-C-x" and all that
701 jazz), or a symbol, whose name is printed. */
707 if (current_kboard
->immediate_echo
)
709 int size
= KEY_DESCRIPTION_SIZE
+ 100;
710 char *buffer
= (char *) alloca (size
);
712 Lisp_Object echo_string
;
714 echo_string
= current_kboard
->echo_string
;
716 /* If someone has passed us a composite event, use its head symbol. */
721 ptr
= push_key_description (XINT (c
), ptr
, 1);
723 else if (SYMBOLP (c
))
725 Lisp_Object name
= SYMBOL_NAME (c
);
726 int nbytes
= SBYTES (name
);
728 if (size
- (ptr
- buffer
) < nbytes
)
730 int offset
= ptr
- buffer
;
731 size
= max (2 * size
, size
+ nbytes
);
732 buffer
= (char *) alloca (size
);
733 ptr
= buffer
+ offset
;
736 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
737 STRING_MULTIBYTE (name
), 1);
740 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
743 const char *text
= " (Type ? for further options)";
744 int len
= strlen (text
);
746 if (size
- (ptr
- buffer
) < len
)
748 int offset
= ptr
- buffer
;
750 buffer
= (char *) alloca (size
);
751 ptr
= buffer
+ offset
;
754 bcopy (text
, ptr
, len
);
758 /* Replace a dash from echo_dash with a space, otherwise
759 add a space at the end as a separator between keys. */
760 if (STRINGP (echo_string
)
761 && SCHARS (echo_string
) > 1)
763 Lisp_Object last_char
, prev_char
, idx
;
765 idx
= make_number (SCHARS (echo_string
) - 2);
766 prev_char
= Faref (echo_string
, idx
);
768 idx
= make_number (SCHARS (echo_string
) - 1);
769 last_char
= Faref (echo_string
, idx
);
771 /* We test PREV_CHAR to make sure this isn't the echoing
773 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
774 Faset (echo_string
, idx
, make_number (' '));
776 echo_string
= concat2 (echo_string
, build_string (" "));
779 current_kboard
->echo_string
780 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
786 /* Temporarily add a dash to the end of the echo string if it's not
787 empty, so that it serves as a mini-prompt for the very next character. */
792 /* Do nothing if not echoing at all. */
793 if (NILP (current_kboard
->echo_string
))
796 if (!current_kboard
->immediate_echo
797 && SCHARS (current_kboard
->echo_string
) == 0)
800 /* Do nothing if we just printed a prompt. */
801 if (current_kboard
->echo_after_prompt
802 == SCHARS (current_kboard
->echo_string
))
805 /* Do nothing if we have already put a dash at the end. */
806 if (SCHARS (current_kboard
->echo_string
) > 1)
808 Lisp_Object last_char
, prev_char
, idx
;
810 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
811 prev_char
= Faref (current_kboard
->echo_string
, idx
);
813 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
814 last_char
= Faref (current_kboard
->echo_string
, idx
);
816 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
820 /* Put a dash at the end of the buffer temporarily,
821 but make it go away when the next character is added. */
822 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
827 /* Display the current echo string, and begin echoing if not already
833 if (!current_kboard
->immediate_echo
)
836 current_kboard
->immediate_echo
= 1;
838 for (i
= 0; i
< this_command_key_count
; i
++)
842 /* Set before_command_echo_length to the value that would
843 have been saved before the start of this subcommand in
844 command_loop_1, if we had already been echoing then. */
845 if (i
== this_single_command_key_start
)
846 before_command_echo_length
= echo_length ();
848 c
= XVECTOR (this_command_keys
)->contents
[i
];
849 if (! (EVENT_HAS_PARAMETERS (c
)
850 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
854 /* Set before_command_echo_length to the value that would
855 have been saved before the start of this subcommand in
856 command_loop_1, if we had already been echoing then. */
857 if (this_command_key_count
== this_single_command_key_start
)
858 before_command_echo_length
= echo_length ();
860 /* Put a dash at the end to invite the user to type more. */
865 message3_nolog (current_kboard
->echo_string
,
866 SBYTES (current_kboard
->echo_string
),
867 STRING_MULTIBYTE (current_kboard
->echo_string
));
870 /* Record in what buffer we echoed, and from which kboard. */
871 echo_message_buffer
= echo_area_buffer
[0];
872 echo_kboard
= current_kboard
;
874 if (waiting_for_input
&& !NILP (Vquit_flag
))
875 quit_throw_to_read_char ();
878 /* Turn off echoing, for the start of a new command. */
883 current_kboard
->immediate_echo
= 0;
884 current_kboard
->echo_after_prompt
= -1;
885 current_kboard
->echo_string
= Qnil
;
886 ok_to_echo_at_next_pause
= NULL
;
888 echo_message_buffer
= Qnil
;
891 /* Return the length of the current echo string. */
896 return (STRINGP (current_kboard
->echo_string
)
897 ? SCHARS (current_kboard
->echo_string
)
901 /* Truncate the current echo message to its first LEN chars.
902 This and echo_char get used by read_key_sequence when the user
903 switches frames while entering a key sequence. */
906 echo_truncate (nchars
)
909 if (STRINGP (current_kboard
->echo_string
))
910 current_kboard
->echo_string
911 = Fsubstring (current_kboard
->echo_string
,
912 make_number (0), make_number (nchars
));
913 truncate_echo_area (nchars
);
917 /* Functions for manipulating this_command_keys. */
919 add_command_key (key
)
922 #if 0 /* Not needed after we made Freset_this_command_lengths
923 do the job immediately. */
924 /* If reset-this-command-length was called recently, obey it now.
925 See the doc string of that function for an explanation of why. */
926 if (before_command_restore_flag
)
928 this_command_key_count
= before_command_key_count_1
;
929 if (this_command_key_count
< this_single_command_key_start
)
930 this_single_command_key_start
= this_command_key_count
;
931 echo_truncate (before_command_echo_length_1
);
932 before_command_restore_flag
= 0;
936 if (this_command_key_count
>= ASIZE (this_command_keys
))
937 this_command_keys
= larger_vector (this_command_keys
,
938 2 * ASIZE (this_command_keys
),
941 AREF (this_command_keys
, this_command_key_count
) = key
;
942 ++this_command_key_count
;
949 int count
= SPECPDL_INDEX ();
952 if (command_loop_level
> 0)
954 specbind (Qstandard_output
, Qt
);
955 specbind (Qstandard_input
, Qt
);
958 #ifdef HAVE_X_WINDOWS
959 /* The command loop has started an hourglass timer, so we have to
960 cancel it here, otherwise it will fire because the recursive edit
961 can take some time. Do not check for display_hourglass_p here,
962 because it could already be nil. */
966 /* This function may have been called from a debugger called from
967 within redisplay, for instance by Edebugging a function called
968 from fontification-functions. We want to allow redisplay in
969 the debugging session.
971 The recursive edit is left with a `(throw exit ...)'. The `exit'
972 tag is not caught anywhere in redisplay, i.e. when we leave the
973 recursive edit, the original redisplay leading to the recursive
974 edit will be unwound. The outcome should therefore be safe. */
975 specbind (Qinhibit_redisplay
, Qnil
);
978 val
= command_loop ();
980 Fsignal (Qquit
, Qnil
);
981 /* Handle throw from read_minibuf when using minibuffer
982 while it's active but we're in another window. */
984 Fsignal (Qerror
, Fcons (val
, Qnil
));
986 return unbind_to (count
, Qnil
);
989 /* When an auto-save happens, record the "time", and don't do again soon. */
994 last_auto_save
= num_nonmacro_input_events
;
997 /* Make an auto save happen as soon as possible at command level. */
1000 force_auto_save_soon ()
1002 last_auto_save
= - auto_save_interval
- 1;
1004 record_asynch_buffer_change ();
1007 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1008 doc
: /* Invoke the editor command loop recursively.
1009 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1010 that tells this function to return.
1011 Alternately, `(throw 'exit t)' makes this function signal an error.
1012 This function is called by the editor initialization to begin editing. */)
1015 int count
= SPECPDL_INDEX ();
1018 /* If we enter while input is blocked, don't lock up here.
1019 This may happen through the debugger during redisplay. */
1020 if (INPUT_BLOCKED_P
)
1023 command_loop_level
++;
1024 update_mode_lines
= 1;
1026 if (command_loop_level
1027 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1028 buffer
= Fcurrent_buffer ();
1032 /* If we leave recursive_edit_1 below with a `throw' for instance,
1033 like it is done in the splash screen display, we have to
1034 make sure that we restore single_kboard as command_loop_1
1035 would have done if it were left normally. */
1036 record_unwind_protect (recursive_edit_unwind
,
1037 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1039 recursive_edit_1 ();
1040 return unbind_to (count
, Qnil
);
1044 recursive_edit_unwind (info
)
1047 if (BUFFERP (XCAR (info
)))
1048 Fset_buffer (XCAR (info
));
1050 if (NILP (XCDR (info
)))
1051 any_kboard_state ();
1053 single_kboard_state ();
1055 command_loop_level
--;
1056 update_mode_lines
= 1;
1065 #if 0 /* Theory: if there's anything in Vunread_command_events,
1066 it will right away be read by read_key_sequence,
1067 and then if we do switch KBOARDS, it will go into the side
1068 queue then. So we don't need to do anything special here -- rms. */
1069 if (CONSP (Vunread_command_events
))
1071 current_kboard
->kbd_queue
1072 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1073 current_kboard
->kbd_queue_has_data
= 1;
1075 Vunread_command_events
= Qnil
;
1081 /* Switch to the single-kboard state, making current_kboard
1082 the only KBOARD from which further input is accepted. */
1085 single_kboard_state ()
1092 /* If we're in single_kboard state for kboard KBOARD,
1096 not_single_kboard_state (kboard
)
1100 if (kboard
== current_kboard
)
1105 /* Maintain a stack of kboards, so other parts of Emacs
1106 can switch temporarily to the kboard of a given frame
1107 and then revert to the previous status. */
1112 struct kboard_stack
*next
;
1115 static struct kboard_stack
*kboard_stack
;
1118 push_frame_kboard (f
)
1122 struct kboard_stack
*p
1123 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1125 p
->next
= kboard_stack
;
1126 p
->kboard
= current_kboard
;
1129 current_kboard
= FRAME_KBOARD (f
);
1137 struct kboard_stack
*p
= kboard_stack
;
1138 current_kboard
= p
->kboard
;
1139 kboard_stack
= p
->next
;
1144 /* Handle errors that are not handled at inner levels
1145 by printing an error message and returning to the editor command loop. */
1151 Lisp_Object old_level
, old_length
;
1152 char macroerror
[50];
1154 #ifdef HAVE_X_WINDOWS
1155 if (display_hourglass_p
)
1156 cancel_hourglass ();
1159 if (!NILP (executing_macro
))
1161 if (executing_macro_iterations
== 1)
1162 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1164 sprintf (macroerror
, "After %d kbd macro iterations: ",
1165 executing_macro_iterations
);
1170 Vstandard_output
= Qt
;
1171 Vstandard_input
= Qt
;
1172 Vexecuting_macro
= Qnil
;
1173 executing_macro
= Qnil
;
1174 current_kboard
->Vprefix_arg
= Qnil
;
1175 current_kboard
->Vlast_prefix_arg
= Qnil
;
1178 /* Avoid unquittable loop if data contains a circular list. */
1179 old_level
= Vprint_level
;
1180 old_length
= Vprint_length
;
1181 XSETFASTINT (Vprint_level
, 10);
1182 XSETFASTINT (Vprint_length
, 10);
1183 cmd_error_internal (data
, macroerror
);
1184 Vprint_level
= old_level
;
1185 Vprint_length
= old_length
;
1189 Vinhibit_quit
= Qnil
;
1191 if (command_loop_level
== 0 && minibuf_level
== 0)
1192 any_kboard_state ();
1195 return make_number (0);
1198 /* Take actions on handling an error. DATA is the data that describes
1201 CONTEXT is a C-string containing ASCII characters only which
1202 describes the context in which the error happened. If we need to
1203 generalize CONTEXT to allow multibyte characters, make it a Lisp
1207 cmd_error_internal (data
, context
)
1212 int kill_emacs_p
= 0;
1213 struct frame
*sf
= SELECTED_FRAME ();
1217 clear_message (1, 0);
1219 /* If the window system or terminal frame hasn't been initialized
1220 yet, or we're not interactive, it's best to dump this message out
1221 to stderr and exit. */
1222 if (!sf
->glyphs_initialized_p
1223 /* This is the case of the frame dumped with Emacs, when we're
1224 running under a window system. */
1225 || (!NILP (Vwindow_system
)
1226 && !inhibit_window_system
1227 && FRAME_TERMCAP_P (sf
))
1230 stream
= Qexternal_debugging_output
;
1236 message_log_maybe_newline ();
1241 /* The immediate context is not interesting for Quits,
1242 since they are asyncronous. */
1243 if (EQ (XCAR (data
), Qquit
))
1244 Vsignaling_function
= Qnil
;
1246 print_error_message (data
, stream
, context
, Vsignaling_function
);
1248 Vsignaling_function
= Qnil
;
1250 /* If the window system or terminal frame hasn't been initialized
1251 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1255 Fkill_emacs (make_number (-1));
1259 Lisp_Object
command_loop_1 ();
1260 Lisp_Object
command_loop_2 ();
1261 Lisp_Object
top_level_1 ();
1263 /* Entry to editor-command-loop.
1264 This level has the catches for exiting/returning to editor command loop.
1265 It returns nil to exit recursive edit, t to abort it. */
1270 if (command_loop_level
> 0 || minibuf_level
> 0)
1273 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1274 executing_macro
= Qnil
;
1280 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1281 /* Reset single_kboard in case top-level set it while
1282 evaluating an -f option, or we are stuck there for some
1284 any_kboard_state ();
1285 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1286 executing_macro
= Qnil
;
1288 /* End of file in -batch run causes exit here. */
1294 /* Here we catch errors in execution of commands within the
1295 editing loop, and reenter the editing loop.
1296 When there is an error, cmd_error runs and returns a non-nil
1297 value to us. A value of nil means that command_loop_1 itself
1298 returned due to end of file (or end of kbd macro). */
1303 register Lisp_Object val
;
1306 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1307 while (!NILP (val
));
1315 return Feval (Vtop_level
);
1321 /* On entry to the outer level, run the startup file */
1322 if (!NILP (Vtop_level
))
1323 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1324 else if (!NILP (Vpurify_flag
))
1325 message ("Bare impure Emacs (standard Lisp code not loaded)");
1327 message ("Bare Emacs (standard Lisp code not loaded)");
1331 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1332 doc
: /* Exit all recursive editing levels. */)
1335 #ifdef HAVE_X_WINDOWS
1336 if (display_hourglass_p
)
1337 cancel_hourglass ();
1340 /* Unblock input if we enter with input blocked. This may happen if
1341 redisplay traps e.g. during tool-bar update with input blocked. */
1342 while (INPUT_BLOCKED_P
)
1345 return Fthrow (Qtop_level
, Qnil
);
1348 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1349 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1352 if (command_loop_level
> 0 || minibuf_level
> 0)
1353 Fthrow (Qexit
, Qnil
);
1355 error ("No recursive edit is in progress");
1359 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1360 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1363 if (command_loop_level
> 0 || minibuf_level
> 0)
1366 error ("No recursive edit is in progress");
1370 /* This is the actual command reading loop,
1371 sans error-handling encapsulation. */
1373 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1375 void safe_run_hooks
P_ ((Lisp_Object
));
1376 static void adjust_point_for_property
P_ ((int, int));
1378 /* Cancel hourglass from protect_unwind.
1380 #ifdef HAVE_X_WINDOWS
1382 cancel_hourglass_unwind (arg
)
1385 cancel_hourglass ();
1396 Lisp_Object keybuf
[30];
1400 struct buffer
*prev_buffer
= NULL
;
1402 int was_locked
= single_kboard
;
1404 int already_adjusted
;
1406 current_kboard
->Vprefix_arg
= Qnil
;
1407 current_kboard
->Vlast_prefix_arg
= Qnil
;
1408 Vdeactivate_mark
= Qnil
;
1409 waiting_for_input
= 0;
1413 this_command_key_count
= 0;
1414 this_command_key_count_reset
= 0;
1415 this_single_command_key_start
= 0;
1417 if (NILP (Vmemory_full
))
1419 /* Make sure this hook runs after commands that get errors and
1420 throw to top level. */
1421 /* Note that the value cell will never directly contain nil
1422 if the symbol is a local variable. */
1423 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1424 safe_run_hooks (Qpost_command_hook
);
1426 /* If displaying a message, resize the echo area window to fit
1427 that message's size exactly. */
1428 if (!NILP (echo_area_buffer
[0]))
1429 resize_echo_area_exactly ();
1431 if (!NILP (Vdeferred_action_list
))
1432 call0 (Vdeferred_action_function
);
1434 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1436 if (NILP (Vunread_command_events
)
1437 && NILP (Vunread_input_method_events
)
1438 && NILP (Vunread_post_input_method_events
)
1439 && NILP (Vexecuting_macro
)
1440 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1441 safe_run_hooks (Qpost_command_idle_hook
);
1445 Vmemory_full
= Qnil
;
1447 /* Do this after running Vpost_command_hook, for consistency. */
1448 current_kboard
->Vlast_command
= Vthis_command
;
1449 current_kboard
->Vreal_last_command
= real_this_command
;
1453 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1456 /* Make sure the current window's buffer is selected. */
1457 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1458 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1460 /* Display any malloc warning that just came out. Use while because
1461 displaying one warning can cause another. */
1463 while (pending_malloc_warning
)
1464 display_malloc_warning ();
1468 Vdeactivate_mark
= Qnil
;
1470 /* If minibuffer on and echo area in use,
1471 wait a short time and redraw minibuffer. */
1474 && !NILP (echo_area_buffer
[0])
1475 && EQ (minibuf_window
, echo_area_window
)
1476 && NUMBERP (Vminibuffer_message_timeout
))
1478 /* Bind inhibit-quit to t so that C-g gets read in
1479 rather than quitting back to the minibuffer. */
1480 int count
= SPECPDL_INDEX ();
1481 specbind (Qinhibit_quit
, Qt
);
1483 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1484 /* Clear the echo area. */
1486 safe_run_hooks (Qecho_area_clear_hook
);
1488 unbind_to (count
, Qnil
);
1490 /* If a C-g came in before, treat it as input now. */
1491 if (!NILP (Vquit_flag
))
1494 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1499 alloca (0); /* Cause a garbage collection now */
1500 /* Since we can free the most stuff here. */
1501 #endif /* C_ALLOCA */
1504 /* Select the frame that the last event came from. Usually,
1505 switch-frame events will take care of this, but if some lisp
1506 code swallows a switch-frame event, we'll fix things up here.
1507 Is this a good idea? */
1508 if (FRAMEP (internal_last_event_frame
)
1509 && !EQ (internal_last_event_frame
, selected_frame
))
1510 Fselect_frame (internal_last_event_frame
, Qnil
);
1512 /* If it has changed current-menubar from previous value,
1513 really recompute the menubar from the value. */
1514 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1515 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1516 call0 (Qrecompute_lucid_menubar
);
1518 before_command_key_count
= this_command_key_count
;
1519 before_command_echo_length
= echo_length ();
1521 Vthis_command
= Qnil
;
1522 real_this_command
= Qnil
;
1524 /* Read next key sequence; i gets its length. */
1525 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1528 /* A filter may have run while we were reading the input. */
1529 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1531 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1532 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1536 /* Now we have read a key sequence of length I,
1537 or else I is 0 and we found end of file. */
1539 if (i
== 0) /* End of file -- happens only in */
1540 return Qnil
; /* a kbd macro, at the end. */
1541 /* -1 means read_key_sequence got a menu that was rejected.
1542 Just loop around and read another command. */
1546 this_command_key_count
= 0;
1547 this_command_key_count_reset
= 0;
1548 this_single_command_key_start
= 0;
1552 last_command_char
= keybuf
[i
- 1];
1554 /* If the previous command tried to force a specific window-start,
1555 forget about that, in case this command moves point far away
1556 from that position. But also throw away beg_unchanged and
1557 end_unchanged information in that case, so that redisplay will
1558 update the whole window properly. */
1559 if (!NILP (XWINDOW (selected_window
)->force_start
))
1562 XWINDOW (selected_window
)->force_start
= Qnil
;
1563 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1564 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1567 cmd
= read_key_sequence_cmd
;
1568 if (!NILP (Vexecuting_macro
))
1570 if (!NILP (Vquit_flag
))
1572 Vexecuting_macro
= Qt
;
1573 QUIT
; /* Make some noise. */
1574 /* Will return since macro now empty. */
1578 /* Do redisplay processing after this command except in special
1579 cases identified below. */
1580 prev_buffer
= current_buffer
;
1581 prev_modiff
= MODIFF
;
1582 last_point_position
= PT
;
1583 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1585 /* By default, we adjust point to a boundary of a region that
1586 has such a property that should be treated intangible
1587 (e.g. composition, display). But, some commands will set
1588 this variable differently. */
1589 Vdisable_point_adjustment
= Qnil
;
1591 /* Process filters and timers may have messed with deactivate-mark.
1592 reset it before we execute the command. */
1593 Vdeactivate_mark
= Qnil
;
1595 /* Remap command through active keymaps */
1596 Vthis_original_command
= cmd
;
1600 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1604 /* Execute the command. */
1606 Vthis_command
= cmd
;
1607 real_this_command
= cmd
;
1608 /* Note that the value cell will never directly contain nil
1609 if the symbol is a local variable. */
1610 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1611 safe_run_hooks (Qpre_command_hook
);
1613 already_adjusted
= 0;
1615 if (NILP (Vthis_command
))
1617 /* nil means key is undefined. */
1619 current_kboard
->defining_kbd_macro
= Qnil
;
1620 update_mode_lines
= 1;
1621 current_kboard
->Vprefix_arg
= Qnil
;
1625 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1627 /* In case we jump to directly_done. */
1628 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1630 /* Recognize some common commands in common situations and
1631 do them directly. */
1632 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1634 struct Lisp_Char_Table
*dp
1635 = window_display_table (XWINDOW (selected_window
));
1636 lose
= FETCH_CHAR (PT_BYTE
);
1638 if (! NILP (Vpost_command_hook
))
1639 /* Put this before calling adjust_point_for_property
1640 so it will only get called once in any case. */
1642 if (current_buffer
== prev_buffer
1643 && last_point_position
!= PT
1644 && NILP (Vdisable_point_adjustment
)
1645 && NILP (Vglobal_disable_point_adjustment
))
1646 adjust_point_for_property (last_point_position
, 0);
1647 already_adjusted
= 1;
1648 if (PT
== last_point_position
+ 1
1650 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1651 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1652 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1653 && (lose
>= 0x20 && lose
< 0x7f)))
1654 : (lose
>= 0x20 && lose
< 0x7f))
1655 /* To extract the case of continuation on
1656 wide-column characters. */
1657 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1658 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1660 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1662 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1664 && !windows_or_buffers_changed
1665 && EQ (current_buffer
->selective_display
, Qnil
)
1666 && !detect_input_pending ()
1667 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1668 && NILP (Vexecuting_macro
))
1669 direct_output_forward_char (1);
1672 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1674 struct Lisp_Char_Table
*dp
1675 = window_display_table (XWINDOW (selected_window
));
1677 lose
= FETCH_CHAR (PT_BYTE
);
1678 if (! NILP (Vpost_command_hook
))
1680 if (current_buffer
== prev_buffer
1681 && last_point_position
!= PT
1682 && NILP (Vdisable_point_adjustment
)
1683 && NILP (Vglobal_disable_point_adjustment
))
1684 adjust_point_for_property (last_point_position
, 0);
1685 already_adjusted
= 1;
1686 if (PT
== last_point_position
- 1
1688 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1689 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1690 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1691 && (lose
>= 0x20 && lose
< 0x7f)))
1692 : (lose
>= 0x20 && lose
< 0x7f))
1693 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1695 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1697 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1699 && !windows_or_buffers_changed
1700 && EQ (current_buffer
->selective_display
, Qnil
)
1701 && !detect_input_pending ()
1702 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1703 && NILP (Vexecuting_macro
))
1704 direct_output_forward_char (-1);
1707 else if (EQ (Vthis_command
, Qself_insert_command
)
1708 /* Try this optimization only on char keystrokes. */
1709 && NATNUMP (last_command_char
)
1710 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1713 = translate_char (Vtranslation_table_for_input
,
1714 XFASTINT (last_command_char
), 0, 0, 0);
1716 if (NILP (Vexecuting_macro
)
1717 && !EQ (minibuf_window
, selected_window
))
1719 if (!nonundocount
|| nonundocount
>= 20)
1727 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1729 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1731 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1733 || MODIFF
<= SAVE_MODIFF
1734 || windows_or_buffers_changed
1735 || !EQ (current_buffer
->selective_display
, Qnil
)
1736 || detect_input_pending ()
1737 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1738 || !NILP (Vexecuting_macro
));
1740 value
= internal_self_insert (c
, 0);
1745 if (! NILP (Vpost_command_hook
))
1746 /* Put this before calling adjust_point_for_property
1747 so it will only get called once in any case. */
1750 /* VALUE == 1 when AFTER-CHANGE functions are
1751 installed which is the case most of the time
1752 because FONT-LOCK installs one. */
1753 if (!lose
&& !value
)
1754 direct_output_for_insert (c
);
1759 /* Here for a command that isn't executed directly */
1762 #ifdef HAVE_X_WINDOWS
1763 int scount
= SPECPDL_INDEX ();
1765 if (display_hourglass_p
1766 && NILP (Vexecuting_macro
))
1768 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1774 if (NILP (current_kboard
->Vprefix_arg
))
1776 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1778 #ifdef HAVE_X_WINDOWS
1779 /* Do not check display_hourglass_p here, because
1780 Fcommand_execute could change it, but we should cancel
1781 hourglass cursor anyway.
1782 But don't cancel the hourglass within a macro
1783 just because a command in the macro finishes. */
1784 if (NILP (Vexecuting_macro
))
1785 unbind_to (scount
, Qnil
);
1790 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1792 /* Note that the value cell will never directly contain nil
1793 if the symbol is a local variable. */
1794 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1795 safe_run_hooks (Qpost_command_hook
);
1797 /* If displaying a message, resize the echo area window to fit
1798 that message's size exactly. */
1799 if (!NILP (echo_area_buffer
[0]))
1800 resize_echo_area_exactly ();
1802 if (!NILP (Vdeferred_action_list
))
1803 safe_run_hooks (Qdeferred_action_function
);
1805 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1807 if (NILP (Vunread_command_events
)
1808 && NILP (Vunread_input_method_events
)
1809 && NILP (Vunread_post_input_method_events
)
1810 && NILP (Vexecuting_macro
)
1811 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1812 safe_run_hooks (Qpost_command_idle_hook
);
1815 /* If there is a prefix argument,
1816 1) We don't want Vlast_command to be ``universal-argument''
1817 (that would be dumb), so don't set Vlast_command,
1818 2) we want to leave echoing on so that the prefix will be
1819 echoed as part of this key sequence, so don't call
1821 3) we want to leave this_command_key_count non-zero, so that
1822 read_char will realize that it is re-reading a character, and
1823 not echo it a second time.
1825 If the command didn't actually create a prefix arg,
1826 but is merely a frame event that is transparent to prefix args,
1827 then the above doesn't apply. */
1828 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1830 current_kboard
->Vlast_command
= Vthis_command
;
1831 current_kboard
->Vreal_last_command
= real_this_command
;
1833 this_command_key_count
= 0;
1834 this_command_key_count_reset
= 0;
1835 this_single_command_key_start
= 0;
1838 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1840 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1842 /* We could also call `deactivate'mark'. */
1843 if (EQ (Vtransient_mark_mode
, Qlambda
))
1844 Vtransient_mark_mode
= Qnil
;
1847 current_buffer
->mark_active
= Qnil
;
1848 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1851 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1852 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1855 /* Setting transient-mark-mode to `only' is a way of
1856 turning it on for just one command. */
1857 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1859 if (EQ (Vtransient_mark_mode
, Qidentity
))
1860 Vtransient_mark_mode
= Qnil
;
1861 if (EQ (Vtransient_mark_mode
, Qonly
))
1862 Vtransient_mark_mode
= Qidentity
;
1867 if (current_buffer
== prev_buffer
1868 && last_point_position
!= PT
1869 && NILP (Vdisable_point_adjustment
)
1870 && NILP (Vglobal_disable_point_adjustment
)
1871 && !already_adjusted
)
1872 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1874 /* Install chars successfully executed in kbd macro. */
1876 if (!NILP (current_kboard
->defining_kbd_macro
)
1877 && NILP (current_kboard
->Vprefix_arg
))
1878 finalize_kbd_macro_chars ();
1882 any_kboard_state ();
1887 extern Lisp_Object Qcomposition
, Qdisplay
;
1889 /* Adjust point to a boundary of a region that has such a property
1890 that should be treated intangible. For the moment, we check
1891 `composition', `display' and `invisible' properties.
1892 LAST_PT is the last position of point. */
1894 extern Lisp_Object Qafter_string
, Qbefore_string
;
1895 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1898 adjust_point_for_property (last_pt
, modified
)
1903 Lisp_Object val
, overlay
, tmp
;
1904 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1907 /* FIXME: cycling is probably not necessary because these properties
1908 can't be usefully combined anyway. */
1909 while (check_composition
|| check_display
|| check_invisible
)
1911 if (check_composition
1912 && PT
> BEGV
&& PT
< ZV
1913 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1914 && COMPOSITION_VALID_P (beg
, end
, val
)
1915 && beg
< PT
/* && end > PT <- It's always the case. */
1916 && (last_pt
<= beg
|| last_pt
>= end
))
1919 SET_PT (PT
< last_pt
? beg
: end
);
1920 check_display
= check_invisible
= 1;
1922 check_composition
= 0;
1924 && PT
> BEGV
&& PT
< ZV
1925 && !NILP (val
= get_char_property_and_overlay
1926 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1927 && display_prop_intangible_p (val
)
1928 && (!OVERLAYP (overlay
)
1929 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1930 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1931 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1932 && beg
< PT
) /* && end > PT <- It's always the case. */
1935 SET_PT (PT
< last_pt
? beg
: end
);
1936 check_composition
= check_invisible
= 1;
1939 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1941 int inv
, ellipsis
= 0;
1944 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1946 && !NILP (val
= get_char_property_and_overlay
1947 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1948 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1950 ellipsis
= ellipsis
|| inv
> 1
1951 || (OVERLAYP (overlay
)
1952 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1953 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1954 tmp
= Fnext_single_char_property_change
1955 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1956 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1959 && !NILP (val
= get_char_property_and_overlay
1960 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1961 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1963 ellipsis
= ellipsis
|| inv
> 1
1964 || (OVERLAYP (overlay
)
1965 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1966 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1967 tmp
= Fprevious_single_char_property_change
1968 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1969 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1972 /* Move away from the inside area. */
1973 if (beg
< PT
&& end
> PT
)
1975 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1976 /* We haven't moved yet (so we don't need to fear
1977 infinite-looping) and we were outside the range
1978 before (so either end of the range still corresponds
1979 to a move in the right direction): pretend we moved
1980 less than we actually did, so that we still have
1981 more freedom below in choosing which end of the range
1983 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1984 /* We either have moved already or the last point
1985 was already in the range: we don't get to choose
1986 which end of the range we have to go to. */
1987 : (PT
< last_pt
? beg
: end
));
1988 check_composition
= check_display
= 1;
1990 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1991 the point to something other than its argument, due to
1992 point-motion hooks, intangibility, etc. */
1993 xassert (PT
== beg
|| PT
== end
);
1996 /* Pretend the area doesn't exist if the buffer is not
1998 if (!modified
&& !ellipsis
&& beg
< end
)
2000 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2001 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2002 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2003 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2004 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2005 /* We've already moved as far as we can. Trying to go
2006 to the other end would mean moving backwards and thus
2007 could lead to an infinite loop. */
2009 else if (val
= get_pos_property (make_number (PT
),
2011 TEXT_PROP_MEANS_INVISIBLE (val
)
2012 && (val
= get_pos_property
2013 (make_number (PT
== beg
? end
: beg
),
2015 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2016 (check_composition
= check_display
= 1,
2017 SET_PT (PT
== beg
? end
: beg
));
2020 check_invisible
= 0;
2024 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2027 safe_run_hooks_1 (hook
)
2030 return call1 (Vrun_hooks
, Vinhibit_quit
);
2033 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2036 safe_run_hooks_error (data
)
2039 Lisp_Object args
[3];
2040 args
[0] = build_string ("Error in %s: %s");
2041 args
[1] = Vinhibit_quit
;
2044 return Fset (Vinhibit_quit
, Qnil
);
2047 /* If we get an error while running the hook, cause the hook variable
2048 to be nil. Also inhibit quits, so that C-g won't cause the hook
2049 to mysteriously evaporate. */
2052 safe_run_hooks (hook
)
2055 int count
= SPECPDL_INDEX ();
2056 specbind (Qinhibit_quit
, hook
);
2058 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2060 unbind_to (count
, Qnil
);
2064 /* Number of seconds between polling for input. This is a Lisp
2065 variable that can be bound. */
2067 EMACS_INT polling_period
;
2069 /* Nonzero means polling for input is temporarily suppressed. */
2071 int poll_suppress_count
;
2073 /* Asynchronous timer for polling. */
2075 struct atimer
*poll_timer
;
2078 #ifdef POLL_FOR_INPUT
2080 /* Poll for input, so what we catch a C-g if it comes in. This
2081 function is called from x_make_frame_visible, see comment
2087 if (interrupt_input_blocked
== 0
2088 && !waiting_for_input
)
2089 read_avail_input (0);
2092 /* Timer callback function for poll_timer. TIMER is equal to
2096 poll_for_input (timer
)
2097 struct atimer
*timer
;
2099 if (poll_suppress_count
== 0)
2100 poll_for_input_1 ();
2103 #endif /* POLL_FOR_INPUT */
2105 /* Begin signals to poll for input, if they are appropriate.
2106 This function is called unconditionally from various places. */
2111 #ifdef POLL_FOR_INPUT
2112 if (read_socket_hook
&& !interrupt_input
)
2114 /* Turn alarm handling on unconditionally. It might have
2115 been turned off in process.c. */
2116 turn_on_atimers (1);
2118 /* If poll timer doesn't exist, are we need one with
2119 a different interval, start a new one. */
2120 if (poll_timer
== NULL
2121 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2123 EMACS_TIME interval
;
2126 cancel_atimer (poll_timer
);
2128 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2129 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2130 poll_for_input
, NULL
);
2133 /* Let the timer's callback function poll for input
2134 if this becomes zero. */
2135 --poll_suppress_count
;
2140 /* Nonzero if we are using polling to handle input asynchronously. */
2143 input_polling_used ()
2145 #ifdef POLL_FOR_INPUT
2146 return read_socket_hook
&& !interrupt_input
;
2152 /* Turn off polling. */
2157 #ifdef POLL_FOR_INPUT
2158 if (read_socket_hook
&& !interrupt_input
)
2159 ++poll_suppress_count
;
2163 /* Set the value of poll_suppress_count to COUNT
2164 and start or stop polling accordingly. */
2167 set_poll_suppress_count (count
)
2170 #ifdef POLL_FOR_INPUT
2171 if (count
== 0 && poll_suppress_count
!= 0)
2173 poll_suppress_count
= 1;
2176 else if (count
!= 0 && poll_suppress_count
== 0)
2180 poll_suppress_count
= count
;
2184 /* Bind polling_period to a value at least N.
2185 But don't decrease it. */
2188 bind_polling_period (n
)
2191 #ifdef POLL_FOR_INPUT
2192 int new = polling_period
;
2197 stop_other_atimers (poll_timer
);
2199 specbind (Qpolling_period
, make_number (new));
2200 /* Start a new alarm with the new period. */
2205 /* Apply the control modifier to CHARACTER. */
2211 /* Save the upper bits here. */
2212 int upper
= c
& ~0177;
2216 /* Everything in the columns containing the upper-case letters
2217 denotes a control character. */
2218 if (c
>= 0100 && c
< 0140)
2222 /* Set the shift modifier for a control char
2223 made from a shifted letter. But only for letters! */
2224 if (oc
>= 'A' && oc
<= 'Z')
2225 c
|= shift_modifier
;
2228 /* The lower-case letters denote control characters too. */
2229 else if (c
>= 'a' && c
<= 'z')
2232 /* Include the bits for control and shift
2233 only if the basic ASCII code can't indicate them. */
2237 /* Replace the high bits. */
2238 c
|= (upper
& ~ctrl_modifier
);
2243 /* Display help echo in the echo area.
2245 HELP a string means display that string, HELP nil means clear the
2246 help echo. If HELP is a function, call it with OBJECT and POS as
2247 arguments; the function should return a help string or nil for
2248 none. For all other types of HELP evaluate it to obtain a string.
2250 WINDOW is the window in which the help was generated, if any.
2251 It is nil if not in a window.
2253 If OBJECT is a buffer, POS is the position in the buffer where the
2254 `help-echo' text property was found.
2256 If OBJECT is an overlay, that overlay has a `help-echo' property,
2257 and POS is the position in the overlay's buffer under the mouse.
2259 If OBJECT is a string (an overlay string or a string displayed with
2260 the `display' property). POS is the position in that string under
2263 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2264 echo overwrites a keystroke echo currently displayed in the echo
2267 Note: this function may only be called with HELP nil or a string
2268 from X code running asynchronously. */
2271 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2272 Lisp_Object help
, window
, object
, pos
;
2273 int ok_to_overwrite_keystroke_echo
;
2275 if (!NILP (help
) && !STRINGP (help
))
2277 if (FUNCTIONP (help
))
2279 Lisp_Object args
[4];
2284 help
= safe_call (4, args
);
2287 help
= safe_eval (help
);
2289 if (!STRINGP (help
))
2293 if (STRINGP (help
) || NILP (help
))
2295 if (!NILP (Vshow_help_function
))
2296 call1 (Vshow_help_function
, help
);
2297 else if (/* Don't overwrite minibuffer contents. */
2298 !MINI_WINDOW_P (XWINDOW (selected_window
))
2299 /* Don't overwrite a keystroke echo. */
2300 && (NILP (echo_message_buffer
)
2301 || ok_to_overwrite_keystroke_echo
)
2302 /* Don't overwrite a prompt. */
2303 && !cursor_in_echo_area
)
2307 int count
= SPECPDL_INDEX ();
2309 if (!help_echo_showing_p
)
2310 Vpre_help_message
= current_message ();
2312 specbind (Qmessage_truncate_lines
, Qt
);
2313 message3_nolog (help
, SBYTES (help
),
2314 STRING_MULTIBYTE (help
));
2315 unbind_to (count
, Qnil
);
2317 else if (STRINGP (Vpre_help_message
))
2319 message3_nolog (Vpre_help_message
,
2320 SBYTES (Vpre_help_message
),
2321 STRING_MULTIBYTE (Vpre_help_message
));
2322 Vpre_help_message
= Qnil
;
2328 help_echo_showing_p
= STRINGP (help
);
2334 /* Input of single characters from keyboard */
2336 Lisp_Object
print_help ();
2337 static Lisp_Object
kbd_buffer_get_event ();
2338 static void record_char ();
2341 static jmp_buf wrong_kboard_jmpbuf
;
2344 #define STOP_POLLING \
2345 do { if (! polling_stopped_here) stop_polling (); \
2346 polling_stopped_here = 1; } while (0)
2348 #define RESUME_POLLING \
2349 do { if (polling_stopped_here) start_polling (); \
2350 polling_stopped_here = 0; } while (0)
2352 /* read a character from the keyboard; call the redisplay if needed */
2353 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2354 -1 means do not do redisplay, but do do autosaving.
2357 /* The arguments MAPS and NMAPS are for menu prompting.
2358 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2360 PREV_EVENT is the previous input event, or nil if we are reading
2361 the first event of a key sequence (or not reading a key sequence).
2362 If PREV_EVENT is t, that is a "magic" value that says
2363 not to run input methods, but in other respects to act as if
2364 not reading a key sequence.
2366 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2367 if we used a mouse menu to read the input, or zero otherwise. If
2368 USED_MOUSE_MENU is null, we don't dereference it.
2370 Value is t if we showed a menu and the user rejected it. */
2373 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2377 Lisp_Object prev_event
;
2378 int *used_mouse_menu
;
2380 volatile Lisp_Object c
;
2382 jmp_buf local_getcjmp
;
2384 volatile int key_already_recorded
= 0;
2385 Lisp_Object tem
, save
;
2386 volatile Lisp_Object previous_echo_area_message
;
2387 volatile Lisp_Object also_record
;
2388 volatile int reread
;
2389 struct gcpro gcpro1
, gcpro2
;
2390 EMACS_TIME last_idle_start
;
2391 int polling_stopped_here
= 0;
2395 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2396 before_command_key_count
= this_command_key_count
;
2397 before_command_echo_length
= echo_length ();
2400 previous_echo_area_message
= Qnil
;
2402 GCPRO2 (c
, previous_echo_area_message
);
2407 if (CONSP (Vunread_post_input_method_events
))
2409 c
= XCAR (Vunread_post_input_method_events
);
2410 Vunread_post_input_method_events
2411 = XCDR (Vunread_post_input_method_events
);
2413 /* Undo what read_char_x_menu_prompt did when it unread
2414 additional keys returned by Fx_popup_menu. */
2416 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2424 if (unread_command_char
!= -1)
2426 XSETINT (c
, unread_command_char
);
2427 unread_command_char
= -1;
2433 if (CONSP (Vunread_command_events
))
2435 c
= XCAR (Vunread_command_events
);
2436 Vunread_command_events
= XCDR (Vunread_command_events
);
2438 /* Undo what read_char_x_menu_prompt did when it unread
2439 additional keys returned by Fx_popup_menu. */
2441 && EQ (XCDR (c
), Qdisabled
)
2442 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2445 /* If the queued event is something that used the mouse,
2446 set used_mouse_menu accordingly. */
2448 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2449 *used_mouse_menu
= 1;
2452 goto reread_for_input_method
;
2455 if (CONSP (Vunread_input_method_events
))
2457 c
= XCAR (Vunread_input_method_events
);
2458 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2460 /* Undo what read_char_x_menu_prompt did when it unread
2461 additional keys returned by Fx_popup_menu. */
2463 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2467 goto reread_for_input_method
;
2470 this_command_key_count_reset
= 0;
2472 if (!NILP (Vexecuting_macro
))
2474 /* We set this to Qmacro; since that's not a frame, nobody will
2475 try to switch frames on us, and the selected window will
2478 Since this event came from a macro, it would be misleading to
2479 leave internal_last_event_frame set to wherever the last
2480 real event came from. Normally, a switch-frame event selects
2481 internal_last_event_frame after each command is read, but
2482 events read from a macro should never cause a new frame to be
2484 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2486 /* Exit the macro if we are at the end.
2487 Also, some things replace the macro with t
2488 to force an early exit. */
2489 if (EQ (Vexecuting_macro
, Qt
)
2490 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2496 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2497 if (STRINGP (Vexecuting_macro
)
2498 && (XINT (c
) & 0x80))
2499 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2501 executing_macro_index
++;
2506 if (!NILP (unread_switch_frame
))
2508 c
= unread_switch_frame
;
2509 unread_switch_frame
= Qnil
;
2511 /* This event should make it into this_command_keys, and get echoed
2512 again, so we do not set `reread'. */
2516 /* if redisplay was requested */
2517 if (commandflag
>= 0)
2519 /* If there is pending input, process any events which are not
2520 user-visible, such as X selection_request events. */
2522 || detect_input_pending_run_timers (0))
2523 swallow_events (0); /* may clear input_pending */
2525 /* Redisplay if no pending input. */
2526 while (!input_pending
)
2528 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2529 redisplay_preserve_echo_area (5);
2534 /* Normal case: no input arrived during redisplay. */
2537 /* Input arrived and pre-empted redisplay.
2538 Process any events which are not user-visible. */
2540 /* If that cleared input_pending, try again to redisplay. */
2544 /* Message turns off echoing unless more keystrokes turn it on again.
2546 The code in 20.x for the condition was
2548 1. echo_area_glyphs && *echo_area_glyphs
2549 2. && echo_area_glyphs != current_kboard->echobuf
2550 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2552 (1) means there's a current message displayed
2554 (2) means it's not the message from echoing from the current
2557 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2558 is set to a non-null value. This is done in read_char and it is
2559 set to echo_area_glyphs after a call to echo_char. That means
2560 ok_to_echo_at_next_pause is either null or
2561 current_kboard->echobuf with the appropriate current_kboard at
2564 So, condition (3) means in clear text ok_to_echo_at_next_pause
2565 must be either null, or the current message isn't from echoing at
2566 all, or it's from echoing from a different kboard than the
2569 if (/* There currently is something in the echo area. */
2570 !NILP (echo_area_buffer
[0])
2571 && (/* And it's either not from echoing. */
2572 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2573 /* Or it's an echo from a different kboard. */
2574 || echo_kboard
!= current_kboard
2575 /* Or we explicitly allow overwriting whatever there is. */
2576 || ok_to_echo_at_next_pause
== NULL
))
2581 /* Try reading a character via menu prompting in the minibuf.
2582 Try this before the sit-for, because the sit-for
2583 would do the wrong thing if we are supposed to do
2584 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2585 after a mouse event so don't try a minibuf menu. */
2587 if (nmaps
> 0 && INTERACTIVE
2588 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2589 /* Don't bring up a menu if we already have another event. */
2590 && NILP (Vunread_command_events
)
2591 && unread_command_char
< 0
2592 && !detect_input_pending_run_timers (0))
2594 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2597 key_already_recorded
= 1;
2602 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2603 We will do that below, temporarily for short sections of code,
2604 when appropriate. local_getcjmp must be in effect
2605 around any call to sit_for or kbd_buffer_get_event;
2606 it *must not* be in effect when we call redisplay. */
2608 if (_setjmp (local_getcjmp
))
2610 XSETINT (c
, quit_char
);
2611 internal_last_event_frame
= selected_frame
;
2612 Vlast_event_frame
= internal_last_event_frame
;
2613 /* If we report the quit char as an event,
2614 don't do so more than once. */
2615 if (!NILP (Vinhibit_quit
))
2620 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2621 if (kb
!= current_kboard
)
2623 Lisp_Object link
= kb
->kbd_queue
;
2624 /* We shouldn't get here if we were in single-kboard mode! */
2629 while (CONSP (XCDR (link
)))
2631 if (!NILP (XCDR (link
)))
2635 kb
->kbd_queue
= Fcons (c
, Qnil
);
2637 XSETCDR (link
, Fcons (c
, Qnil
));
2638 kb
->kbd_queue_has_data
= 1;
2639 current_kboard
= kb
;
2640 /* This is going to exit from read_char
2641 so we had better get rid of this frame's stuff. */
2643 longjmp (wrong_kboard_jmpbuf
, 1);
2650 timer_start_idle ();
2652 /* If in middle of key sequence and minibuffer not active,
2653 start echoing if enough time elapses. */
2655 if (minibuf_level
== 0
2656 && !current_kboard
->immediate_echo
2657 && this_command_key_count
> 0
2659 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2660 && NILP (Fzerop (Vecho_keystrokes
))
2661 && (/* No message. */
2662 NILP (echo_area_buffer
[0])
2663 /* Or empty message. */
2664 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2665 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2666 /* Or already echoing from same kboard. */
2667 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2668 /* Or not echoing before and echoing allowed. */
2669 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2673 /* After a mouse event, start echoing right away.
2674 This is because we are probably about to display a menu,
2675 and we don't want to delay before doing so. */
2676 if (EVENT_HAS_PARAMETERS (prev_event
))
2681 double duration
= extract_float (Vecho_keystrokes
);
2682 sec
= (int) duration
;
2683 usec
= (duration
- sec
) * 1000000;
2684 save_getcjmp (save_jump
);
2685 restore_getcjmp (local_getcjmp
);
2686 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2687 restore_getcjmp (save_jump
);
2689 && ! CONSP (Vunread_command_events
))
2694 /* Maybe auto save due to number of keystrokes. */
2696 if (commandflag
!= 0
2697 && auto_save_interval
> 0
2698 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2699 && !detect_input_pending_run_timers (0))
2701 Fdo_auto_save (Qnil
, Qnil
);
2702 /* Hooks can actually change some buffers in auto save. */
2706 /* Try reading using an X menu.
2707 This is never confused with reading using the minibuf
2708 because the recursive call of read_char in read_char_minibuf_menu_prompt
2709 does not pass on any keymaps. */
2711 if (nmaps
> 0 && INTERACTIVE
2712 && !NILP (prev_event
)
2713 && EVENT_HAS_PARAMETERS (prev_event
)
2714 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2715 && !EQ (XCAR (prev_event
), Qtool_bar
)
2716 /* Don't bring up a menu if we already have another event. */
2717 && NILP (Vunread_command_events
)
2718 && unread_command_char
< 0)
2720 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2722 /* Now that we have read an event, Emacs is not idle. */
2728 /* Maybe autosave and/or garbage collect due to idleness. */
2730 if (INTERACTIVE
&& NILP (c
))
2732 int delay_level
, buffer_size
;
2734 /* Slow down auto saves logarithmically in size of current buffer,
2735 and garbage collect while we're at it. */
2736 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2737 last_non_minibuf_size
= Z
- BEG
;
2738 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2740 while (buffer_size
> 64)
2741 delay_level
++, buffer_size
-= buffer_size
>> 2;
2742 if (delay_level
< 4) delay_level
= 4;
2743 /* delay_level is 4 for files under around 50k, 7 at 100k,
2744 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2746 /* Auto save if enough time goes by without input. */
2747 if (commandflag
!= 0
2748 && num_nonmacro_input_events
> last_auto_save
2749 && INTEGERP (Vauto_save_timeout
)
2750 && XINT (Vauto_save_timeout
) > 0)
2754 save_getcjmp (save_jump
);
2755 restore_getcjmp (local_getcjmp
);
2756 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2758 restore_getcjmp (save_jump
);
2761 && ! CONSP (Vunread_command_events
))
2763 Fdo_auto_save (Qnil
, Qnil
);
2765 /* If we have auto-saved and there is still no input
2766 available, garbage collect if there has been enough
2767 consing going on to make it worthwhile. */
2768 if (!detect_input_pending_run_timers (0)
2769 && consing_since_gc
> gc_cons_threshold
/ 2)
2770 Fgarbage_collect ();
2777 /* If this has become non-nil here, it has been set by a timer
2778 or sentinel or filter. */
2779 if (CONSP (Vunread_command_events
))
2781 c
= XCAR (Vunread_command_events
);
2782 Vunread_command_events
= XCDR (Vunread_command_events
);
2785 /* Read something from current KBOARD's side queue, if possible. */
2789 if (current_kboard
->kbd_queue_has_data
)
2791 if (!CONSP (current_kboard
->kbd_queue
))
2793 c
= XCAR (current_kboard
->kbd_queue
);
2794 current_kboard
->kbd_queue
2795 = XCDR (current_kboard
->kbd_queue
);
2796 if (NILP (current_kboard
->kbd_queue
))
2797 current_kboard
->kbd_queue_has_data
= 0;
2798 input_pending
= readable_events (0);
2799 if (EVENT_HAS_PARAMETERS (c
)
2800 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2801 internal_last_event_frame
= XCAR (XCDR (c
));
2802 Vlast_event_frame
= internal_last_event_frame
;
2807 /* If current_kboard's side queue is empty check the other kboards.
2808 If one of them has data that we have not yet seen here,
2809 switch to it and process the data waiting for it.
2811 Note: if the events queued up for another kboard
2812 have already been seen here, and therefore are not a complete command,
2813 the kbd_queue_has_data field is 0, so we skip that kboard here.
2814 That's to avoid an infinite loop switching between kboards here. */
2815 if (NILP (c
) && !single_kboard
)
2818 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2819 if (kb
->kbd_queue_has_data
)
2821 current_kboard
= kb
;
2822 /* This is going to exit from read_char
2823 so we had better get rid of this frame's stuff. */
2825 longjmp (wrong_kboard_jmpbuf
, 1);
2834 /* Finally, we read from the main queue,
2835 and if that gives us something we can't use yet, we put it on the
2836 appropriate side queue and try again. */
2842 /* Actually read a character, waiting if necessary. */
2843 save_getcjmp (save_jump
);
2844 restore_getcjmp (local_getcjmp
);
2845 timer_start_idle ();
2846 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2847 restore_getcjmp (save_jump
);
2850 if (! NILP (c
) && (kb
!= current_kboard
))
2852 Lisp_Object link
= kb
->kbd_queue
;
2855 while (CONSP (XCDR (link
)))
2857 if (!NILP (XCDR (link
)))
2861 kb
->kbd_queue
= Fcons (c
, Qnil
);
2863 XSETCDR (link
, Fcons (c
, Qnil
));
2864 kb
->kbd_queue_has_data
= 1;
2868 current_kboard
= kb
;
2869 /* This is going to exit from read_char
2870 so we had better get rid of this frame's stuff. */
2872 longjmp (wrong_kboard_jmpbuf
, 1);
2877 /* Terminate Emacs in batch mode if at eof. */
2878 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2879 Fkill_emacs (make_number (1));
2883 /* Add in any extra modifiers, where appropriate. */
2884 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2885 || ((extra_keyboard_modifiers
& 0177) < ' '
2886 && (extra_keyboard_modifiers
& 0177) != 0))
2887 XSETINT (c
, make_ctrl_char (XINT (c
)));
2889 /* Transfer any other modifier bits directly from
2890 extra_keyboard_modifiers to c. Ignore the actual character code
2891 in the low 16 bits of extra_keyboard_modifiers. */
2892 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2897 /* Record the last idle start time so that we can reset it
2898 should the next event read be a help-echo. */
2899 last_idle_start
= timer_idleness_start_time
;
2905 if (commandflag
>= 0
2906 && !input_pending
&& !detect_input_pending_run_timers (0))
2914 /* Buffer switch events are only for internal wakeups
2915 so don't show them to the user.
2916 Also, don't record a key if we already did. */
2917 if (BUFFERP (c
) || key_already_recorded
)
2920 /* Process special events within read_char
2921 and loop around to read another event. */
2924 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2929 int was_locked
= single_kboard
;
2931 last_input_char
= c
;
2932 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2934 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2935 /* We stopped being idle for this event; undo that. This
2936 prevents automatic window selection (under
2937 mouse_autoselect_window from acting as a real input event, for
2938 example banishing the mouse under mouse-avoidance-mode. */
2939 timer_idleness_start_time
= last_idle_start
;
2941 /* Resume allowing input from any kboard, if that was true before. */
2943 any_kboard_state ();
2948 /* Handle things that only apply to characters. */
2951 /* If kbd_buffer_get_event gave us an EOF, return that. */
2955 if ((STRINGP (Vkeyboard_translate_table
)
2956 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2957 || (VECTORP (Vkeyboard_translate_table
)
2958 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2959 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2960 && CHAR_VALID_P (XINT (c
), 0)))
2963 d
= Faref (Vkeyboard_translate_table
, c
);
2964 /* nil in keyboard-translate-table means no translation. */
2970 /* If this event is a mouse click in the menu bar,
2971 return just menu-bar for now. Modify the mouse click event
2972 so we won't do this twice, then queue it up. */
2973 if (EVENT_HAS_PARAMETERS (c
)
2975 && CONSP (EVENT_START (c
))
2976 && CONSP (XCDR (EVENT_START (c
))))
2980 posn
= POSN_POSN (EVENT_START (c
));
2981 /* Handle menu-bar events:
2982 insert the dummy prefix event `menu-bar'. */
2983 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2985 /* Change menu-bar to (menu-bar) as the event "position". */
2986 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2989 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2994 /* Store these characters into recent_keys, the dribble file if any,
2995 and the keyboard macro being defined, if any. */
2997 if (! NILP (also_record
))
2998 record_char (also_record
);
3000 /* Wipe the echo area.
3001 But first, if we are about to use an input method,
3002 save the echo area contents for it to refer to. */
3004 && ! NILP (Vinput_method_function
)
3005 && (unsigned) XINT (c
) >= ' '
3006 && (unsigned) XINT (c
) != 127
3007 && (unsigned) XINT (c
) < 256)
3009 previous_echo_area_message
= Fcurrent_message ();
3010 Vinput_method_previous_message
= previous_echo_area_message
;
3013 /* Now wipe the echo area, except for help events which do their
3014 own stuff with the echo area. */
3016 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3017 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3019 if (!NILP (echo_area_buffer
[0]))
3020 safe_run_hooks (Qecho_area_clear_hook
);
3021 clear_message (1, 0);
3024 reread_for_input_method
:
3026 /* Pass this to the input method, if appropriate. */
3028 && ! NILP (Vinput_method_function
)
3029 /* Don't run the input method within a key sequence,
3030 after the first event of the key sequence. */
3031 && NILP (prev_event
)
3032 && (unsigned) XINT (c
) >= ' '
3033 && (unsigned) XINT (c
) != 127
3034 && (unsigned) XINT (c
) < 256)
3037 int key_count
, key_count_reset
;
3038 struct gcpro gcpro1
;
3039 int count
= SPECPDL_INDEX ();
3041 /* Save the echo status. */
3042 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3043 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3044 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3047 if (before_command_restore_flag
)
3049 this_command_key_count
= before_command_key_count_1
;
3050 if (this_command_key_count
< this_single_command_key_start
)
3051 this_single_command_key_start
= this_command_key_count
;
3052 echo_truncate (before_command_echo_length_1
);
3053 before_command_restore_flag
= 0;
3057 /* Save the this_command_keys status. */
3058 key_count
= this_command_key_count
;
3059 key_count_reset
= this_command_key_count_reset
;
3062 keys
= Fcopy_sequence (this_command_keys
);
3067 /* Clear out this_command_keys. */
3068 this_command_key_count
= 0;
3069 this_command_key_count_reset
= 0;
3071 /* Now wipe the echo area. */
3072 if (!NILP (echo_area_buffer
[0]))
3073 safe_run_hooks (Qecho_area_clear_hook
);
3074 clear_message (1, 0);
3077 /* If we are not reading a key sequence,
3078 never use the echo area. */
3081 specbind (Qinput_method_use_echo_area
, Qt
);
3084 /* Call the input method. */
3085 tem
= call1 (Vinput_method_function
, c
);
3087 tem
= unbind_to (count
, tem
);
3089 /* Restore the saved echoing state
3090 and this_command_keys state. */
3091 this_command_key_count
= key_count
;
3092 this_command_key_count_reset
= key_count_reset
;
3094 this_command_keys
= keys
;
3097 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3098 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3099 if (saved_immediate_echo
)
3104 /* The input method can return no events. */
3107 /* Bring back the previous message, if any. */
3108 if (! NILP (previous_echo_area_message
))
3109 message_with_string ("%s", previous_echo_area_message
, 0);
3112 /* It returned one event or more. */
3114 Vunread_post_input_method_events
3115 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3120 /* Display help if not echoing. */
3121 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3123 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3124 Lisp_Object help
, object
, position
, window
, tem
;
3126 tem
= Fcdr (XCDR (c
));
3129 window
= Fcar (tem
);
3131 object
= Fcar (tem
);
3133 position
= Fcar (tem
);
3135 show_help_echo (help
, window
, object
, position
, 0);
3137 /* We stopped being idle for this event; undo that. */
3138 timer_idleness_start_time
= last_idle_start
;
3142 if (! reread
|| this_command_key_count
== 0
3143 || this_command_key_count_reset
)
3146 /* Don't echo mouse motion events. */
3147 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3148 && NILP (Fzerop (Vecho_keystrokes
))
3149 && ! (EVENT_HAS_PARAMETERS (c
)
3150 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3153 if (! NILP (also_record
))
3154 echo_char (also_record
);
3155 /* Once we reread a character, echoing can happen
3156 the next time we pause to read a new one. */
3157 ok_to_echo_at_next_pause
= current_kboard
;
3160 /* Record this character as part of the current key. */
3161 add_command_key (c
);
3162 if (! NILP (also_record
))
3163 add_command_key (also_record
);
3166 last_input_char
= c
;
3169 /* Process the help character specially if enabled */
3170 if (!NILP (Vhelp_form
) && help_char_p (c
))
3173 count
= SPECPDL_INDEX ();
3175 record_unwind_protect (Fset_window_configuration
,
3176 Fcurrent_window_configuration (Qnil
));
3178 tem0
= Feval (Vhelp_form
);
3180 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3184 c
= read_char (0, 0, 0, Qnil
, 0);
3185 while (BUFFERP (c
));
3186 /* Remove the help from the frame */
3187 unbind_to (count
, Qnil
);
3190 if (EQ (c
, make_number (040)))
3194 c
= read_char (0, 0, 0, Qnil
, 0);
3195 while (BUFFERP (c
));
3204 /* Record a key that came from a mouse menu.
3205 Record it for echoing, for this-command-keys, and so on. */
3211 /* Wipe the echo area. */
3212 clear_message (1, 0);
3217 before_command_key_count
= this_command_key_count
;
3218 before_command_echo_length
= echo_length ();
3221 /* Don't echo mouse motion events. */
3222 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3223 && NILP (Fzerop (Vecho_keystrokes
)))
3227 /* Once we reread a character, echoing can happen
3228 the next time we pause to read a new one. */
3229 ok_to_echo_at_next_pause
= 0;
3232 /* Record this character as part of the current key. */
3233 add_command_key (c
);
3235 /* Re-reading in the middle of a command */
3236 last_input_char
= c
;
3240 /* Return 1 if should recognize C as "the help character". */
3248 if (EQ (c
, Vhelp_char
))
3250 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3251 if (EQ (c
, XCAR (tail
)))
3256 /* Record the input event C in various ways. */
3264 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3266 /* To avoid filling recent_keys with help-echo and mouse-movement
3267 events, we filter out repeated help-echo events, only store the
3268 first and last in a series of mouse-movement events, and don't
3269 store repeated help-echo events which are only separated by
3270 mouse-movement events. */
3272 Lisp_Object ev1
, ev2
, ev3
;
3275 if ((ix1
= recent_keys_index
- 1) < 0)
3276 ix1
= NUM_RECENT_KEYS
- 1;
3277 ev1
= AREF (recent_keys
, ix1
);
3279 if ((ix2
= ix1
- 1) < 0)
3280 ix2
= NUM_RECENT_KEYS
- 1;
3281 ev2
= AREF (recent_keys
, ix2
);
3283 if ((ix3
= ix2
- 1) < 0)
3284 ix3
= NUM_RECENT_KEYS
- 1;
3285 ev3
= AREF (recent_keys
, ix3
);
3287 if (EQ (XCAR (c
), Qhelp_echo
))
3289 /* Don't record `help-echo' in recent_keys unless it shows some help
3290 message, and a different help than the previously recorded
3292 Lisp_Object help
, last_help
;
3294 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3295 if (!STRINGP (help
))
3297 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3298 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3300 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3301 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3302 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3304 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3305 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3306 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3307 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3310 else if (EQ (XCAR (c
), Qmouse_movement
))
3312 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3313 So additional mouse movement events replace the last element. */
3314 Lisp_Object last_window
, window
;
3316 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3317 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3318 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3319 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3320 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3322 ASET (recent_keys
, ix1
, c
);
3328 store_kbd_macro_char (c
);
3333 ASET (recent_keys
, recent_keys_index
, c
);
3334 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3335 recent_keys_index
= 0;
3337 else if (recorded
< 0)
3339 /* We need to remove one or two events from recent_keys.
3340 To do this, we simply put nil at those events and move the
3341 recent_keys_index backwards over those events. Usually,
3342 users will never see those nil events, as they will be
3343 overwritten by the command keys entered to see recent_keys
3346 while (recorded
++ < 0 && total_keys
> 0)
3348 if (total_keys
< NUM_RECENT_KEYS
)
3350 if (--recent_keys_index
< 0)
3351 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3352 ASET (recent_keys
, recent_keys_index
, Qnil
);
3356 num_nonmacro_input_events
++;
3358 /* Write c to the dribble file. If c is a lispy event, write
3359 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3360 If you, dear reader, have a better idea, you've got the source. :-) */
3365 if (XUINT (c
) < 0x100)
3366 putc (XINT (c
), dribble
);
3368 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3372 Lisp_Object dribblee
;
3374 /* If it's a structured event, take the event header. */
3375 dribblee
= EVENT_HEAD (c
);
3377 if (SYMBOLP (dribblee
))
3379 putc ('<', dribble
);
3380 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3381 SBYTES (SYMBOL_NAME (dribblee
)),
3383 putc ('>', dribble
);
3395 struct buffer
*old
= current_buffer
;
3396 Fprinc (object
, Qnil
);
3397 set_buffer_internal (XBUFFER (Vstandard_output
));
3398 call0 (intern ("help-mode"));
3399 set_buffer_internal (old
);
3403 /* Copy out or in the info on where C-g should throw to.
3404 This is used when running Lisp code from within get_char,
3405 in case get_char is called recursively.
3406 See read_process_output. */
3412 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3416 restore_getcjmp (temp
)
3419 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3424 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3425 of this function. */
3428 tracking_off (old_value
)
3429 Lisp_Object old_value
;
3431 do_mouse_tracking
= old_value
;
3432 if (NILP (old_value
))
3434 /* Redisplay may have been preempted because there was input
3435 available, and it assumes it will be called again after the
3436 input has been processed. If the only input available was
3437 the sort that we have just disabled, then we need to call
3439 if (!readable_events (1))
3441 redisplay_preserve_echo_area (6);
3442 get_input_pending (&input_pending
, 1);
3448 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3449 doc
: /* Evaluate BODY with mouse movement events enabled.
3450 Within a `track-mouse' form, mouse motion generates input events that
3451 you can read with `read-event'.
3452 Normally, mouse motion is ignored.
3453 usage: (track-mouse BODY ...) */)
3457 int count
= SPECPDL_INDEX ();
3460 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3462 do_mouse_tracking
= Qt
;
3464 val
= Fprogn (args
);
3465 return unbind_to (count
, val
);
3468 /* If mouse has moved on some frame, return one of those frames.
3469 Return 0 otherwise. */
3474 Lisp_Object tail
, frame
;
3476 FOR_EACH_FRAME (tail
, frame
)
3478 if (XFRAME (frame
)->mouse_moved
)
3479 return XFRAME (frame
);
3485 #endif /* HAVE_MOUSE */
3487 /* Low level keyboard/mouse input.
3488 kbd_buffer_store_event places events in kbd_buffer, and
3489 kbd_buffer_get_event retrieves them. */
3491 /* Return true iff there are any events in the queue that read-char
3492 would return. If this returns false, a read-char would block. */
3494 readable_filtered_events (do_timers_now
, filter_events
)
3499 timer_check (do_timers_now
);
3501 /* If the buffer contains only FOCUS_IN_EVENT events,
3502 and FILTER_EVENTS is nonzero, report it as empty. */
3503 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3505 int have_live_event
= 1;
3509 struct input_event
*event
;
3511 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3515 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3518 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3520 if (event
== kbd_store_ptr
)
3521 have_live_event
= 0;
3524 if (have_live_event
) return 1;
3528 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3533 if (current_kboard
->kbd_queue_has_data
)
3539 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3540 if (kb
->kbd_queue_has_data
)
3546 /* Return true iff there are any events in the queue that read-char
3547 would return. If this returns false, a read-char would block. */
3549 readable_events (do_timers_now
)
3552 return readable_filtered_events (do_timers_now
, 0);
3555 /* Set this for debugging, to have a way to get out */
3560 event_to_kboard (event
)
3561 struct input_event
*event
;
3564 frame
= event
->frame_or_window
;
3566 frame
= XCAR (frame
);
3567 else if (WINDOWP (frame
))
3568 frame
= WINDOW_FRAME (XWINDOW (frame
));
3570 /* There are still some events that don't set this field.
3571 For now, just ignore the problem.
3572 Also ignore dead frames here. */
3573 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3576 return FRAME_KBOARD (XFRAME (frame
));
3580 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3583 kbd_buffer_store_event (event
)
3584 register struct input_event
*event
;
3586 kbd_buffer_store_event_hold (event
, 0);
3589 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3591 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3592 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3593 Else, if EVENT is a quit event, store the quit event
3594 in HOLD_QUIT, and return (thus ignoring further events).
3596 This is used in read_avail_input to postpone the processing
3597 of the quit event until all subsequent input events have been
3598 parsed (and discarded).
3602 kbd_buffer_store_event_hold (event
, hold_quit
)
3603 register struct input_event
*event
;
3604 struct input_event
*hold_quit
;
3606 if (event
->kind
== NO_EVENT
)
3609 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3612 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3614 register int c
= event
->code
& 0377;
3616 if (event
->modifiers
& ctrl_modifier
)
3617 c
= make_ctrl_char (c
);
3619 c
|= (event
->modifiers
3620 & (meta_modifier
| alt_modifier
3621 | hyper_modifier
| super_modifier
));
3627 struct input_event
*sp
;
3630 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3631 kb
!= current_kboard
))
3634 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3635 Fcons (make_number (c
), Qnil
));
3636 kb
->kbd_queue_has_data
= 1;
3637 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3639 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3642 if (event_to_kboard (sp
) == kb
)
3644 sp
->kind
= NO_EVENT
;
3645 sp
->frame_or_window
= Qnil
;
3655 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3659 /* If this results in a quit_char being returned to Emacs as
3660 input, set Vlast_event_frame properly. If this doesn't
3661 get returned to Emacs as an event, the next event read
3662 will set Vlast_event_frame again, so this is safe to do. */
3666 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3668 focus
= event
->frame_or_window
;
3669 internal_last_event_frame
= focus
;
3670 Vlast_event_frame
= focus
;
3673 last_event_timestamp
= event
->timestamp
;
3674 interrupt_signal (0 /* dummy */);
3678 if (c
&& c
== stop_character
)
3684 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3685 Just ignore the second one. */
3686 else if (event
->kind
== BUFFER_SWITCH_EVENT
3687 && kbd_fetch_ptr
!= kbd_store_ptr
3688 && ((kbd_store_ptr
== kbd_buffer
3689 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3690 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3693 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3694 kbd_store_ptr
= kbd_buffer
;
3696 /* Don't let the very last slot in the buffer become full,
3697 since that would make the two pointers equal,
3698 and that is indistinguishable from an empty buffer.
3699 Discard the event if it would fill the last slot. */
3700 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3703 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3704 prone to assign individual members for other events, in case
3705 the input_event structure is changed. --2000-07-13, gerd. */
3706 struct input_event
*sp
= kbd_store_ptr
;
3707 sp
->kind
= event
->kind
;
3708 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3710 /* We must not use the ordinary copying code for this case,
3711 since `part' is an enum and copying it might not copy enough
3713 bcopy (event
, (char *) sp
, sizeof (*event
));
3718 sp
->code
= event
->code
;
3719 sp
->part
= event
->part
;
3720 sp
->frame_or_window
= event
->frame_or_window
;
3721 sp
->arg
= event
->arg
;
3722 sp
->modifiers
= event
->modifiers
;
3725 sp
->timestamp
= event
->timestamp
;
3728 *kbd_store_ptr
= *event
;
3736 /* Generate HELP_EVENT input_events in BUFP which has room for
3737 SIZE events. If there's not enough room in BUFP, ignore this
3740 HELP is the help form.
3742 FRAME is the frame on which the help is generated. OBJECT is the
3743 Lisp object where the help was found (a buffer, a string, an
3744 overlay, or nil if neither from a string nor from a buffer. POS is
3745 the position within OBJECT where the help was found.
3747 Value is the number of input_events generated. */
3750 gen_help_event (help
, frame
, window
, object
, pos
)
3751 Lisp_Object help
, frame
, object
, window
;
3754 struct input_event event
;
3758 event
.kind
= HELP_EVENT
;
3759 event
.frame_or_window
= frame
;
3761 event
.x
= WINDOWP (window
) ? window
: frame
;
3764 kbd_buffer_store_event (&event
);
3768 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3771 kbd_buffer_store_help_event (frame
, help
)
3772 Lisp_Object frame
, help
;
3774 struct input_event event
;
3776 event
.kind
= HELP_EVENT
;
3777 event
.frame_or_window
= frame
;
3782 kbd_buffer_store_event (&event
);
3786 /* Discard any mouse events in the event buffer by setting them to
3789 discard_mouse_events ()
3791 struct input_event
*sp
;
3792 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3794 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3797 if (sp
->kind
== MOUSE_CLICK_EVENT
3798 || sp
->kind
== WHEEL_EVENT
3800 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3802 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3804 sp
->kind
= NO_EVENT
;
3810 /* Return non-zero if there are any real events waiting in the event
3811 buffer, not counting `NO_EVENT's.
3813 If DISCARD is non-zero, discard NO_EVENT events at the front of
3814 the input queue, possibly leaving the input queue empty if there
3815 are no real input events. */
3818 kbd_buffer_events_waiting (discard
)
3821 struct input_event
*sp
;
3823 for (sp
= kbd_fetch_ptr
;
3824 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3827 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3834 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3838 /* Clear input event EVENT. */
3842 struct input_event
*event
;
3844 event
->kind
= NO_EVENT
;
3848 /* Read one event from the event buffer, waiting if necessary.
3849 The value is a Lisp object representing the event.
3850 The value is nil for an event that should be ignored,
3851 or that was handled here.
3852 We always read and discard one event. */
3855 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3857 int *used_mouse_menu
;
3866 *kbp
= current_kboard
;
3870 /* Wait until there is input available. */
3873 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3876 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3880 /* If the quit flag is set, then read_char will return
3881 quit_char, so that counts as "available input." */
3882 if (!NILP (Vquit_flag
))
3883 quit_throw_to_read_char ();
3885 /* One way or another, wait until input is available; then, if
3886 interrupt handlers have not read it, read it now. */
3889 wait_for_kbd_input ();
3891 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3895 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3898 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3902 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3904 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3905 /* Pass 1 for EXPECT since we just waited to have input. */
3906 read_avail_input (1);
3908 #endif /* not VMS */
3911 if (CONSP (Vunread_command_events
))
3914 first
= XCAR (Vunread_command_events
);
3915 Vunread_command_events
= XCDR (Vunread_command_events
);
3916 *kbp
= current_kboard
;
3920 /* At this point, we know that there is a readable event available
3921 somewhere. If the event queue is empty, then there must be a
3922 mouse movement enabled and available. */
3923 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3925 struct input_event
*event
;
3927 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3931 last_event_timestamp
= event
->timestamp
;
3934 *kbp
= event_to_kboard (event
);
3936 *kbp
= current_kboard
; /* Better than returning null ptr? */
3938 *kbp
= &the_only_kboard
;
3943 /* These two kinds of events get special handling
3944 and don't actually appear to the command loop.
3945 We return nil for them. */
3946 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3949 struct input_event copy
;
3951 /* Remove it from the buffer before processing it,
3952 since otherwise swallow_events will see it
3953 and process it again. */
3955 kbd_fetch_ptr
= event
+ 1;
3956 input_pending
= readable_events (0);
3957 x_handle_selection_request (©
);
3959 /* We're getting selection request events, but we don't have
3965 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3968 struct input_event copy
;
3970 /* Remove it from the buffer before processing it. */
3972 kbd_fetch_ptr
= event
+ 1;
3973 input_pending
= readable_events (0);
3974 x_handle_selection_clear (©
);
3976 /* We're getting selection request events, but we don't have
3981 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3982 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3984 /* Make an event (delete-frame (FRAME)). */
3985 obj
= Fcons (event
->frame_or_window
, Qnil
);
3986 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3987 kbd_fetch_ptr
= event
+ 1;
3990 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3991 else if (event
->kind
== ICONIFY_EVENT
)
3993 /* Make an event (iconify-frame (FRAME)). */
3994 obj
= Fcons (event
->frame_or_window
, Qnil
);
3995 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3996 kbd_fetch_ptr
= event
+ 1;
3998 else if (event
->kind
== DEICONIFY_EVENT
)
4000 /* Make an event (make-frame-visible (FRAME)). */
4001 obj
= Fcons (event
->frame_or_window
, Qnil
);
4002 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4003 kbd_fetch_ptr
= event
+ 1;
4006 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4008 /* The value doesn't matter here; only the type is tested. */
4009 XSETBUFFER (obj
, current_buffer
);
4010 kbd_fetch_ptr
= event
+ 1;
4012 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4013 || defined (USE_GTK)
4014 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4016 kbd_fetch_ptr
= event
+ 1;
4017 input_pending
= readable_events (0);
4018 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4019 x_activate_menubar (XFRAME (event
->frame_or_window
));
4023 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4025 /* Make an event (language-change (FRAME CHARSET LCID)). */
4026 obj
= Fcons (event
->frame_or_window
, Qnil
);
4027 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4028 kbd_fetch_ptr
= event
+ 1;
4031 else if (event
->kind
== SAVE_SESSION_EVENT
)
4033 obj
= Fcons (Qsave_session
, Qnil
);
4034 kbd_fetch_ptr
= event
+ 1;
4036 /* Just discard these, by returning nil.
4037 With MULTI_KBOARD, these events are used as placeholders
4038 when we need to randomly delete events from the queue.
4039 (They shouldn't otherwise be found in the buffer,
4040 but on some machines it appears they do show up
4041 even without MULTI_KBOARD.) */
4042 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4043 mouse events during a popup-menu call. */
4044 else if (event
->kind
== NO_EVENT
)
4045 kbd_fetch_ptr
= event
+ 1;
4046 else if (event
->kind
== HELP_EVENT
)
4048 Lisp_Object object
, position
, help
, frame
, window
;
4050 frame
= event
->frame_or_window
;
4051 object
= event
->arg
;
4052 position
= make_number (event
->code
);
4055 clear_event (event
);
4057 kbd_fetch_ptr
= event
+ 1;
4058 if (!WINDOWP (window
))
4060 obj
= Fcons (Qhelp_echo
,
4061 list5 (frame
, help
, window
, object
, position
));
4063 else if (event
->kind
== FOCUS_IN_EVENT
)
4065 /* Notification of a FocusIn event. The frame receiving the
4066 focus is in event->frame_or_window. Generate a
4067 switch-frame event if necessary. */
4068 Lisp_Object frame
, focus
;
4070 frame
= event
->frame_or_window
;
4071 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4075 if (!EQ (frame
, internal_last_event_frame
)
4076 && !EQ (frame
, selected_frame
))
4077 obj
= make_lispy_switch_frame (frame
);
4078 internal_last_event_frame
= frame
;
4079 kbd_fetch_ptr
= event
+ 1;
4083 /* If this event is on a different frame, return a switch-frame this
4084 time, and leave the event in the queue for next time. */
4088 frame
= event
->frame_or_window
;
4090 frame
= XCAR (frame
);
4091 else if (WINDOWP (frame
))
4092 frame
= WINDOW_FRAME (XWINDOW (frame
));
4094 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4098 if (! EQ (frame
, internal_last_event_frame
)
4099 && !EQ (frame
, selected_frame
))
4100 obj
= make_lispy_switch_frame (frame
);
4101 internal_last_event_frame
= frame
;
4103 /* If we didn't decide to make a switch-frame event, go ahead
4104 and build a real event from the queue entry. */
4108 obj
= make_lispy_event (event
);
4110 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4111 || defined (USE_GTK)
4112 /* If this was a menu selection, then set the flag to inhibit
4113 writing to last_nonmenu_event. Don't do this if the event
4114 we're returning is (menu-bar), though; that indicates the
4115 beginning of the menu sequence, and we might as well leave
4116 that as the `event with parameters' for this selection. */
4118 && !EQ (event
->frame_or_window
, event
->arg
)
4119 && (event
->kind
== MENU_BAR_EVENT
4120 || event
->kind
== TOOL_BAR_EVENT
))
4121 *used_mouse_menu
= 1;
4124 /* Wipe out this event, to catch bugs. */
4125 clear_event (event
);
4126 kbd_fetch_ptr
= event
+ 1;
4131 /* Try generating a mouse motion event. */
4132 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4134 FRAME_PTR f
= some_mouse_moved ();
4135 Lisp_Object bar_window
;
4136 enum scroll_bar_part part
;
4140 *kbp
= current_kboard
;
4141 /* Note that this uses F to determine which display to look at.
4142 If there is no valid info, it does not store anything
4143 so x remains nil. */
4145 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4149 /* Decide if we should generate a switch-frame event. Don't
4150 generate switch-frame events for motion outside of all Emacs
4156 frame
= FRAME_FOCUS_FRAME (f
);
4158 XSETFRAME (frame
, f
);
4160 if (! EQ (frame
, internal_last_event_frame
)
4161 && !EQ (frame
, selected_frame
))
4162 obj
= make_lispy_switch_frame (frame
);
4163 internal_last_event_frame
= frame
;
4166 /* If we didn't decide to make a switch-frame event, go ahead and
4167 return a mouse-motion event. */
4168 if (!NILP (x
) && NILP (obj
))
4169 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4171 #endif /* HAVE_MOUSE */
4173 /* We were promised by the above while loop that there was
4174 something for us to read! */
4177 input_pending
= readable_events (0);
4179 Vlast_event_frame
= internal_last_event_frame
;
4184 /* Process any events that are not user-visible,
4185 then return, without reading any user-visible events. */
4188 swallow_events (do_display
)
4193 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4195 struct input_event
*event
;
4197 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4201 last_event_timestamp
= event
->timestamp
;
4203 /* These two kinds of events get special handling
4204 and don't actually appear to the command loop. */
4205 if (event
->kind
== SELECTION_REQUEST_EVENT
)
4208 struct input_event copy
;
4210 /* Remove it from the buffer before processing it,
4211 since otherwise swallow_events called recursively could see it
4212 and process it again. */
4214 kbd_fetch_ptr
= event
+ 1;
4215 input_pending
= readable_events (0);
4216 x_handle_selection_request (©
);
4218 /* We're getting selection request events, but we don't have
4224 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
4227 struct input_event copy
;
4229 /* Remove it from the buffer before processing it, */
4232 kbd_fetch_ptr
= event
+ 1;
4233 input_pending
= readable_events (0);
4234 x_handle_selection_clear (©
);
4236 /* We're getting selection request events, but we don't have
4245 old_timers_run
= timers_run
;
4246 get_input_pending (&input_pending
, 1);
4248 if (timers_run
!= old_timers_run
&& do_display
)
4249 redisplay_preserve_echo_area (7);
4252 /* Record the start of when Emacs is idle,
4253 for the sake of running idle-time timers. */
4260 /* If we are already in the idle state, do nothing. */
4261 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4264 EMACS_GET_TIME (timer_idleness_start_time
);
4266 timer_last_idleness_start_time
= timer_idleness_start_time
;
4268 /* Mark all idle-time timers as once again candidates for running. */
4269 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4273 timer
= XCAR (timers
);
4275 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4277 XVECTOR (timer
)->contents
[0] = Qnil
;
4281 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4286 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4289 /* This is only for debugging. */
4290 struct input_event last_timer_event
;
4292 /* Check whether a timer has fired. To prevent larger problems we simply
4293 disregard elements that are not proper timers. Do not make a circular
4294 timer list for the time being.
4296 Returns the number of seconds to wait until the next timer fires. If a
4297 timer is triggering now, return zero seconds.
4298 If no timer is active, return -1 seconds.
4300 If a timer is ripe, we run it, with quitting turned off.
4302 DO_IT_NOW is now ignored. It used to mean that we should
4303 run the timer directly instead of queueing a timer-event.
4304 Now we always run timers directly. */
4307 timer_check (do_it_now
)
4310 EMACS_TIME nexttime
;
4311 EMACS_TIME now
, idleness_now
;
4312 Lisp_Object timers
, idle_timers
, chosen_timer
;
4313 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4315 EMACS_SET_SECS (nexttime
, -1);
4316 EMACS_SET_USECS (nexttime
, -1);
4318 /* Always consider the ordinary timers. */
4319 timers
= Vtimer_list
;
4320 /* Consider the idle timers only if Emacs is idle. */
4321 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4322 idle_timers
= Vtimer_idle_list
;
4325 chosen_timer
= Qnil
;
4326 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4328 if (CONSP (timers
) || CONSP (idle_timers
))
4330 EMACS_GET_TIME (now
);
4331 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4332 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4335 while (CONSP (timers
) || CONSP (idle_timers
))
4337 Lisp_Object
*vector
;
4338 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4339 EMACS_TIME timer_time
, idle_timer_time
;
4340 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4342 /* Skip past invalid timers and timers already handled. */
4345 timer
= XCAR (timers
);
4346 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4348 timers
= XCDR (timers
);
4351 vector
= XVECTOR (timer
)->contents
;
4353 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4354 || !INTEGERP (vector
[3])
4355 || ! NILP (vector
[0]))
4357 timers
= XCDR (timers
);
4361 if (!NILP (idle_timers
))
4363 timer
= XCAR (idle_timers
);
4364 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4366 idle_timers
= XCDR (idle_timers
);
4369 vector
= XVECTOR (timer
)->contents
;
4371 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4372 || !INTEGERP (vector
[3])
4373 || ! NILP (vector
[0]))
4375 idle_timers
= XCDR (idle_timers
);
4380 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4381 based on the next ordinary timer.
4382 TIMER_DIFFERENCE is the distance in time from NOW to when
4383 this timer becomes ripe (negative if it's already ripe). */
4386 timer
= XCAR (timers
);
4387 vector
= XVECTOR (timer
)->contents
;
4388 EMACS_SET_SECS (timer_time
,
4389 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4390 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4391 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4394 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4395 based on the next idle timer. */
4396 if (!NILP (idle_timers
))
4398 idle_timer
= XCAR (idle_timers
);
4399 vector
= XVECTOR (idle_timer
)->contents
;
4400 EMACS_SET_SECS (idle_timer_time
,
4401 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4402 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4403 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4406 /* Decide which timer is the next timer,
4407 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4408 Also step down the list where we found that timer. */
4410 if (! NILP (timers
) && ! NILP (idle_timers
))
4413 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4414 if (EMACS_TIME_NEG_P (temp
))
4416 chosen_timer
= timer
;
4417 timers
= XCDR (timers
);
4418 difference
= timer_difference
;
4422 chosen_timer
= idle_timer
;
4423 idle_timers
= XCDR (idle_timers
);
4424 difference
= idle_timer_difference
;
4427 else if (! NILP (timers
))
4429 chosen_timer
= timer
;
4430 timers
= XCDR (timers
);
4431 difference
= timer_difference
;
4435 chosen_timer
= idle_timer
;
4436 idle_timers
= XCDR (idle_timers
);
4437 difference
= idle_timer_difference
;
4439 vector
= XVECTOR (chosen_timer
)->contents
;
4441 /* If timer is ripe, run it if it hasn't been run. */
4442 if (EMACS_TIME_NEG_P (difference
)
4443 || (EMACS_SECS (difference
) == 0
4444 && EMACS_USECS (difference
) == 0))
4446 if (NILP (vector
[0]))
4448 int was_locked
= single_kboard
;
4449 int count
= SPECPDL_INDEX ();
4450 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4452 /* Mark the timer as triggered to prevent problems if the lisp
4453 code fails to reschedule it right. */
4456 specbind (Qinhibit_quit
, Qt
);
4458 call1 (Qtimer_event_handler
, chosen_timer
);
4459 Vdeactivate_mark
= old_deactivate_mark
;
4461 unbind_to (count
, Qnil
);
4463 /* Resume allowing input from any kboard, if that was true before. */
4465 any_kboard_state ();
4467 /* Since we have handled the event,
4468 we don't need to tell the caller to wake up and do it. */
4472 /* When we encounter a timer that is still waiting,
4473 return the amount of time to wait before it is ripe. */
4480 /* No timers are pending in the future. */
4481 /* Return 0 if we generated an event, and -1 if not. */
4486 /* Caches for modify_event_symbol. */
4487 static Lisp_Object accent_key_syms
;
4488 static Lisp_Object func_key_syms
;
4489 static Lisp_Object mouse_syms
;
4490 static Lisp_Object wheel_syms
;
4491 static Lisp_Object drag_n_drop_syms
;
4493 /* This is a list of keysym codes for special "accent" characters.
4494 It parallels lispy_accent_keys. */
4496 static int lispy_accent_codes
[] =
4498 #ifdef XK_dead_circumflex
4503 #ifdef XK_dead_grave
4508 #ifdef XK_dead_tilde
4513 #ifdef XK_dead_diaeresis
4518 #ifdef XK_dead_macron
4523 #ifdef XK_dead_degree
4528 #ifdef XK_dead_acute
4533 #ifdef XK_dead_cedilla
4538 #ifdef XK_dead_breve
4543 #ifdef XK_dead_ogonek
4548 #ifdef XK_dead_caron
4553 #ifdef XK_dead_doubleacute
4554 XK_dead_doubleacute
,
4558 #ifdef XK_dead_abovedot
4563 #ifdef XK_dead_abovering
4573 #ifdef XK_dead_belowdot
4578 #ifdef XK_dead_voiced_sound
4579 XK_dead_voiced_sound
,
4583 #ifdef XK_dead_semivoiced_sound
4584 XK_dead_semivoiced_sound
,
4600 /* This is a list of Lisp names for special "accent" characters.
4601 It parallels lispy_accent_codes. */
4603 static char *lispy_accent_keys
[] =
4621 "dead-voiced-sound",
4622 "dead-semivoiced-sound",
4628 #define FUNCTION_KEY_OFFSET 0x0
4630 char *lispy_function_keys
[] =
4634 0, /* VK_LBUTTON 0x01 */
4635 0, /* VK_RBUTTON 0x02 */
4636 "cancel", /* VK_CANCEL 0x03 */
4637 0, /* VK_MBUTTON 0x04 */
4639 0, 0, 0, /* 0x05 .. 0x07 */
4641 "backspace", /* VK_BACK 0x08 */
4642 "tab", /* VK_TAB 0x09 */
4644 0, 0, /* 0x0A .. 0x0B */
4646 "clear", /* VK_CLEAR 0x0C */
4647 "return", /* VK_RETURN 0x0D */
4649 0, 0, /* 0x0E .. 0x0F */
4651 0, /* VK_SHIFT 0x10 */
4652 0, /* VK_CONTROL 0x11 */
4653 0, /* VK_MENU 0x12 */
4654 "pause", /* VK_PAUSE 0x13 */
4655 "capslock", /* VK_CAPITAL 0x14 */
4657 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4659 "escape", /* VK_ESCAPE 0x1B */
4661 0, 0, 0, 0, /* 0x1C .. 0x1F */
4663 0, /* VK_SPACE 0x20 */
4664 "prior", /* VK_PRIOR 0x21 */
4665 "next", /* VK_NEXT 0x22 */
4666 "end", /* VK_END 0x23 */
4667 "home", /* VK_HOME 0x24 */
4668 "left", /* VK_LEFT 0x25 */
4669 "up", /* VK_UP 0x26 */
4670 "right", /* VK_RIGHT 0x27 */
4671 "down", /* VK_DOWN 0x28 */
4672 "select", /* VK_SELECT 0x29 */
4673 "print", /* VK_PRINT 0x2A */
4674 "execute", /* VK_EXECUTE 0x2B */
4675 "snapshot", /* VK_SNAPSHOT 0x2C */
4676 "insert", /* VK_INSERT 0x2D */
4677 "delete", /* VK_DELETE 0x2E */
4678 "help", /* VK_HELP 0x2F */
4680 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4682 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4684 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4686 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4688 0, 0, 0, 0, 0, 0, 0, 0, 0,
4689 0, 0, 0, 0, 0, 0, 0, 0, 0,
4690 0, 0, 0, 0, 0, 0, 0, 0,
4692 "lwindow", /* VK_LWIN 0x5B */
4693 "rwindow", /* VK_RWIN 0x5C */
4694 "apps", /* VK_APPS 0x5D */
4696 0, 0, /* 0x5E .. 0x5F */
4698 "kp-0", /* VK_NUMPAD0 0x60 */
4699 "kp-1", /* VK_NUMPAD1 0x61 */
4700 "kp-2", /* VK_NUMPAD2 0x62 */
4701 "kp-3", /* VK_NUMPAD3 0x63 */
4702 "kp-4", /* VK_NUMPAD4 0x64 */
4703 "kp-5", /* VK_NUMPAD5 0x65 */
4704 "kp-6", /* VK_NUMPAD6 0x66 */
4705 "kp-7", /* VK_NUMPAD7 0x67 */
4706 "kp-8", /* VK_NUMPAD8 0x68 */
4707 "kp-9", /* VK_NUMPAD9 0x69 */
4708 "kp-multiply", /* VK_MULTIPLY 0x6A */
4709 "kp-add", /* VK_ADD 0x6B */
4710 "kp-separator", /* VK_SEPARATOR 0x6C */
4711 "kp-subtract", /* VK_SUBTRACT 0x6D */
4712 "kp-decimal", /* VK_DECIMAL 0x6E */
4713 "kp-divide", /* VK_DIVIDE 0x6F */
4714 "f1", /* VK_F1 0x70 */
4715 "f2", /* VK_F2 0x71 */
4716 "f3", /* VK_F3 0x72 */
4717 "f4", /* VK_F4 0x73 */
4718 "f5", /* VK_F5 0x74 */
4719 "f6", /* VK_F6 0x75 */
4720 "f7", /* VK_F7 0x76 */
4721 "f8", /* VK_F8 0x77 */
4722 "f9", /* VK_F9 0x78 */
4723 "f10", /* VK_F10 0x79 */
4724 "f11", /* VK_F11 0x7A */
4725 "f12", /* VK_F12 0x7B */
4726 "f13", /* VK_F13 0x7C */
4727 "f14", /* VK_F14 0x7D */
4728 "f15", /* VK_F15 0x7E */
4729 "f16", /* VK_F16 0x7F */
4730 "f17", /* VK_F17 0x80 */
4731 "f18", /* VK_F18 0x81 */
4732 "f19", /* VK_F19 0x82 */
4733 "f20", /* VK_F20 0x83 */
4734 "f21", /* VK_F21 0x84 */
4735 "f22", /* VK_F22 0x85 */
4736 "f23", /* VK_F23 0x86 */
4737 "f24", /* VK_F24 0x87 */
4739 0, 0, 0, 0, /* 0x88 .. 0x8B */
4740 0, 0, 0, 0, /* 0x8C .. 0x8F */
4742 "kp-numlock", /* VK_NUMLOCK 0x90 */
4743 "scroll", /* VK_SCROLL 0x91 */
4745 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4746 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4747 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4748 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4749 "kp-end", /* VK_NUMPAD_END 0x96 */
4750 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4751 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4752 "kp-up", /* VK_NUMPAD_UP 0x99 */
4753 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4754 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4755 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4756 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4758 0, 0, /* 0x9E .. 0x9F */
4761 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4762 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4763 * No other API or message will distinguish left and right keys this way.
4767 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4768 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4769 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4770 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4771 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4777 "attn", /* VK_ATTN 0xF6 */
4778 "crsel", /* VK_CRSEL 0xF7 */
4779 "exsel", /* VK_EXSEL 0xF8 */
4780 "ereof", /* VK_EREOF 0xF9 */
4781 "play", /* VK_PLAY 0xFA */
4782 "zoom", /* VK_ZOOM 0xFB */
4783 "noname", /* VK_NONAME 0xFC */
4784 "pa1", /* VK_PA1 0xFD */
4785 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4789 #else /* not HAVE_NTGUI */
4791 /* This should be dealt with in XTread_socket now, and that doesn't
4792 depend on the client system having the Kana syms defined. See also
4793 the XK_kana_A case below. */
4796 static char *lispy_kana_keys
[] =
4798 /* X Keysym value */
4799 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4800 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4801 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4802 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4803 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4804 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4805 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4806 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4807 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4808 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4809 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4810 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4811 "kana-i", "kana-u", "kana-e", "kana-o",
4812 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4813 "prolongedsound", "kana-A", "kana-I", "kana-U",
4814 "kana-E", "kana-O", "kana-KA", "kana-KI",
4815 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4816 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4817 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4818 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4819 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4820 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4821 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4822 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4823 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4824 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4825 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4826 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4828 #endif /* XK_kana_A */
4831 #define FUNCTION_KEY_OFFSET 0xff00
4833 /* You'll notice that this table is arranged to be conveniently
4834 indexed by X Windows keysym values. */
4835 static char *lispy_function_keys
[] =
4837 /* X Keysym value */
4839 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4840 "backspace", "tab", "linefeed", "clear",
4842 0, 0, 0, "pause", /* 0xff10...1f */
4843 0, 0, 0, 0, 0, 0, 0, "escape",
4845 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4846 "romaji", "hiragana", "katakana", "hiragana-katakana",
4847 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4848 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4849 "eisu-toggle", /* 0xff30...3f */
4850 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4851 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4853 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4854 "down", "prior", "next", "end",
4855 "begin", 0, 0, 0, 0, 0, 0, 0,
4856 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4867 "break", /* 0xff6b */
4870 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4871 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4872 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4873 0, 0, 0, 0, 0, 0, 0, 0,
4874 "kp-tab", /* 0xff89 */
4876 "kp-enter", /* 0xff8d */
4878 "kp-f1", /* 0xff91 */
4882 "kp-home", /* 0xff95 */
4887 "kp-prior", /* kp-page-up */
4888 "kp-next", /* kp-page-down */
4894 0, 0, 0, 0, 0, 0, 0, 0, 0,
4895 "kp-multiply", /* 0xffaa */
4900 "kp-divide", /* 0xffaf */
4901 "kp-0", /* 0xffb0 */
4902 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4905 "kp-equal", /* 0xffbd */
4906 "f1", /* 0xffbe */ /* IsFunctionKey */
4908 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4909 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4910 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4911 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4912 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4913 0, 0, 0, 0, 0, 0, 0, 0,
4914 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4915 0, 0, 0, 0, 0, 0, 0, "delete"
4918 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4919 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4921 static char *iso_lispy_function_keys
[] =
4923 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4924 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4925 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4926 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4927 "iso-lefttab", /* 0xfe20 */
4928 "iso-move-line-up", "iso-move-line-down",
4929 "iso-partial-line-up", "iso-partial-line-down",
4930 "iso-partial-space-left", "iso-partial-space-right",
4931 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4932 "iso-release-margin-left", "iso-release-margin-right",
4933 "iso-release-both-margins",
4934 "iso-fast-cursor-left", "iso-fast-cursor-right",
4935 "iso-fast-cursor-up", "iso-fast-cursor-down",
4936 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4937 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4940 #endif /* not HAVE_NTGUI */
4942 Lisp_Object Vlispy_mouse_stem
;
4944 static char *lispy_wheel_names
[] =
4946 "wheel-up", "wheel-down"
4949 /* drag-n-drop events are generated when a set of selected files are
4950 dragged from another application and dropped onto an Emacs window. */
4951 static char *lispy_drag_n_drop_names
[] =
4956 /* Scroll bar parts. */
4957 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4958 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4959 Lisp_Object Qtop
, Qratio
;
4961 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4962 Lisp_Object
*scroll_bar_parts
[] = {
4963 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4964 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4967 /* User signal events. */
4968 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4970 Lisp_Object
*lispy_user_signals
[] =
4972 &Qusr1_signal
, &Qusr2_signal
4976 /* A vector, indexed by button number, giving the down-going location
4977 of currently depressed buttons, both scroll bar and non-scroll bar.
4979 The elements have the form
4980 (BUTTON-NUMBER MODIFIER-MASK . REST)
4981 where REST is the cdr of a position as it would be reported in the event.
4983 The make_lispy_event function stores positions here to tell the
4984 difference between click and drag events, and to store the starting
4985 location to be included in drag events. */
4987 static Lisp_Object button_down_location
;
4989 /* Information about the most recent up-going button event: Which
4990 button, what location, and what time. */
4992 static int last_mouse_button
;
4993 static int last_mouse_x
;
4994 static int last_mouse_y
;
4995 static unsigned long button_down_time
;
4997 /* The maximum time between clicks to make a double-click, or Qnil to
4998 disable double-click detection, or Qt for no time limit. */
5000 Lisp_Object Vdouble_click_time
;
5002 /* Maximum number of pixels the mouse may be moved between clicks
5003 to make a double-click. */
5005 EMACS_INT double_click_fuzz
;
5007 /* The number of clicks in this multiple-click. */
5009 int double_click_count
;
5011 /* Return position of a mouse click or wheel event */
5014 make_lispy_position (f
, x
, y
, time
)
5020 enum window_part part
;
5021 Lisp_Object posn
= Qnil
;
5022 Lisp_Object extra_info
= Qnil
;
5025 /* Set `window' to the window under frame pixel coordinates (x,y) */
5027 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5028 &part
, &wx
, &wy
, 0);
5032 if (WINDOWP (window
))
5034 /* It's a click in window window at frame coordinates (x,y) */
5035 struct window
*w
= XWINDOW (window
);
5036 Lisp_Object string_info
= Qnil
;
5037 int textpos
= -1, rx
= -1, ry
= -1;
5038 int dx
= -1, dy
= -1;
5039 int width
= -1, height
= -1;
5040 Lisp_Object object
= Qnil
;
5042 /* Set event coordinates to window-relative coordinates
5043 for constructing the Lisp event below. */
5047 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5049 /* Mode line or header line. Look for a string under
5050 the mouse that may have a `local-map' property. */
5054 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5056 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5057 &object
, &dx
, &dy
, &width
, &height
);
5058 if (STRINGP (string
))
5059 string_info
= Fcons (string
, make_number (charpos
));
5060 if (w
== XWINDOW (selected_window
))
5063 textpos
= XMARKER (w
->pointm
)->charpos
;
5065 else if (part
== ON_VERTICAL_BORDER
)
5067 posn
= Qvertical_line
;
5072 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5077 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5079 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5080 &object
, &dx
, &dy
, &width
, &height
);
5081 if (STRINGP (string
))
5082 string_info
= Fcons (string
, make_number (charpos
));
5084 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
5086 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
5089 if (part
== ON_RIGHT_FRINGE
)
5090 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5091 + window_box_width (w
, TEXT_AREA
)
5092 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5093 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5095 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5096 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5101 Lisp_Object string2
, object2
= Qnil
;
5102 struct display_pos p
;
5104 int width2
, height2
;
5105 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5106 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5107 &object2
, &dx2
, &dy2
,
5109 textpos
= CHARPOS (p
.pos
);
5110 if (rx
< 0) rx
= wx
;
5111 if (ry
< 0) ry
= wy
;
5112 if (dx
< 0) dx
= dx2
;
5113 if (dy
< 0) dy
= dy2
;
5114 if (width
< 0) width
= width2
;
5115 if (height
< 0) height
= height2
;
5119 posn
= make_number (textpos
);
5120 if (STRINGP (string2
))
5121 string_info
= Fcons (string2
,
5122 make_number (CHARPOS (p
.string_pos
)));
5128 #ifdef HAVE_WINDOW_SYSTEM
5129 if (IMAGEP (object
))
5131 Lisp_Object image_map
, hotspot
;
5132 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5134 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5136 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5137 posn
= XCAR (hotspot
);
5142 extra_info
= Fcons (object
,
5143 Fcons (Fcons (make_number (dx
),
5145 Fcons (Fcons (make_number (width
),
5146 make_number (height
)),
5150 extra_info
= Fcons (string_info
,
5151 Fcons (make_number (textpos
),
5152 Fcons (Fcons (make_number (rx
),
5158 XSETFRAME (window
, f
);
5163 XSETFASTINT (*x
, 0);
5164 XSETFASTINT (*y
, 0);
5167 return Fcons (window
,
5169 Fcons (Fcons (*x
, *y
),
5170 Fcons (make_number (time
),
5174 /* Given a struct input_event, build the lisp event which represents
5175 it. If EVENT is 0, build a mouse movement event from the mouse
5176 movement buffer, which should have a movement event in it.
5178 Note that events must be passed to this function in the order they
5179 are received; this function stores the location of button presses
5180 in order to build drag events when the button is released. */
5183 make_lispy_event (event
)
5184 struct input_event
*event
;
5188 switch (SWITCH_ENUM_CAST (event
->kind
))
5190 /* A simple keystroke. */
5191 case ASCII_KEYSTROKE_EVENT
:
5193 Lisp_Object lispy_c
;
5194 int c
= event
->code
& 0377;
5195 /* Turn ASCII characters into control characters
5197 if (event
->modifiers
& ctrl_modifier
)
5198 c
= make_ctrl_char (c
);
5200 /* Add in the other modifier bits. We took care of ctrl_modifier
5201 just above, and the shift key was taken care of by the X code,
5202 and applied to control characters by make_ctrl_char. */
5203 c
|= (event
->modifiers
5204 & (meta_modifier
| alt_modifier
5205 | hyper_modifier
| super_modifier
));
5206 /* Distinguish Shift-SPC from SPC. */
5207 if ((event
->code
& 0377) == 040
5208 && event
->modifiers
& shift_modifier
)
5209 c
|= shift_modifier
;
5210 button_down_time
= 0;
5211 XSETFASTINT (lispy_c
, c
);
5215 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5217 Lisp_Object lispy_c
;
5218 int c
= event
->code
;
5220 /* Add in the other modifier bits. We took care of ctrl_modifier
5221 just above, and the shift key was taken care of by the X code,
5222 and applied to control characters by make_ctrl_char. */
5223 c
|= (event
->modifiers
5224 & (meta_modifier
| alt_modifier
5225 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5226 /* What about the `shift' modifier ? */
5227 button_down_time
= 0;
5228 XSETFASTINT (lispy_c
, c
);
5232 /* A function key. The symbol may need to have modifier prefixes
5234 case NON_ASCII_KEYSTROKE_EVENT
:
5235 button_down_time
= 0;
5237 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5238 if (event
->code
== lispy_accent_codes
[i
])
5239 return modify_event_symbol (i
,
5241 Qfunction_key
, Qnil
,
5242 lispy_accent_keys
, &accent_key_syms
,
5243 (sizeof (lispy_accent_keys
)
5244 / sizeof (lispy_accent_keys
[0])));
5248 if (event
->code
>= 0x400 && event
->code
< 0x500)
5249 return modify_event_symbol (event
->code
- 0x400,
5250 event
->modifiers
& ~shift_modifier
,
5251 Qfunction_key
, Qnil
,
5252 lispy_kana_keys
, &func_key_syms
,
5253 (sizeof (lispy_kana_keys
)
5254 / sizeof (lispy_kana_keys
[0])));
5255 #endif /* XK_kana_A */
5258 #ifdef ISO_FUNCTION_KEY_OFFSET
5259 if (event
->code
< FUNCTION_KEY_OFFSET
5260 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5261 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5263 Qfunction_key
, Qnil
,
5264 iso_lispy_function_keys
, &func_key_syms
,
5265 (sizeof (iso_lispy_function_keys
)
5266 / sizeof (iso_lispy_function_keys
[0])));
5269 /* Handle system-specific or unknown keysyms. */
5270 if (event
->code
& (1 << 28)
5271 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5272 || (event
->code
- FUNCTION_KEY_OFFSET
5273 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5274 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5276 /* We need to use an alist rather than a vector as the cache
5277 since we can't make a vector long enuf. */
5278 if (NILP (current_kboard
->system_key_syms
))
5279 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5280 return modify_event_symbol (event
->code
,
5283 current_kboard
->Vsystem_key_alist
,
5284 0, ¤t_kboard
->system_key_syms
,
5288 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5290 Qfunction_key
, Qnil
,
5291 lispy_function_keys
, &func_key_syms
,
5292 (sizeof (lispy_function_keys
)
5293 / sizeof (lispy_function_keys
[0])));
5296 /* A mouse click. Figure out where it is, decide whether it's
5297 a press, click or drag, and build the appropriate structure. */
5298 case MOUSE_CLICK_EVENT
:
5299 #ifndef USE_TOOLKIT_SCROLL_BARS
5300 case SCROLL_BAR_CLICK_EVENT
:
5303 int button
= event
->code
;
5305 Lisp_Object position
;
5306 Lisp_Object
*start_pos_ptr
;
5307 Lisp_Object start_pos
;
5311 /* Build the position as appropriate for this mouse click. */
5312 if (event
->kind
== MOUSE_CLICK_EVENT
)
5314 struct frame
*f
= XFRAME (event
->frame_or_window
);
5315 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5319 /* Ignore mouse events that were made on frame that
5320 have been deleted. */
5321 if (! FRAME_LIVE_P (f
))
5324 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5325 /* EVENT->x and EVENT->y are frame-relative pixel
5326 coordinates at this place. Under old redisplay, COLUMN
5327 and ROW are set to frame relative glyph coordinates
5328 which are then used to determine whether this click is
5329 in a menu (non-toolkit version). */
5330 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5331 &column
, &row
, NULL
, 1);
5333 /* In the non-toolkit version, clicks on the menu bar
5334 are ordinary button events in the event buffer.
5335 Distinguish them, and invoke the menu.
5337 (In the toolkit version, the toolkit handles the menu bar
5338 and Emacs doesn't know about it until after the user
5339 makes a selection.) */
5340 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5341 && (event
->modifiers
& down_modifier
))
5343 Lisp_Object items
, item
;
5348 /* Activate the menu bar on the down event. If the
5349 up event comes in before the menu code can deal with it,
5351 if (! (event
->modifiers
& down_modifier
))
5355 /* Find the menu bar item under `column'. */
5357 items
= FRAME_MENU_BAR_ITEMS (f
);
5358 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5360 Lisp_Object pos
, string
;
5361 string
= AREF (items
, i
+ 1);
5362 pos
= AREF (items
, i
+ 3);
5365 if (column
>= XINT (pos
)
5366 && column
< XINT (pos
) + SCHARS (string
))
5368 item
= AREF (items
, i
);
5373 /* ELisp manual 2.4b says (x y) are window relative but
5374 code says they are frame-relative. */
5376 = Fcons (event
->frame_or_window
,
5378 Fcons (Fcons (event
->x
, event
->y
),
5379 Fcons (make_number (event
->timestamp
),
5382 return Fcons (item
, Fcons (position
, Qnil
));
5384 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5386 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5389 #ifndef USE_TOOLKIT_SCROLL_BARS
5392 /* It's a scrollbar click. */
5394 Lisp_Object portion_whole
;
5397 window
= event
->frame_or_window
;
5398 portion_whole
= Fcons (event
->x
, event
->y
);
5399 part
= *scroll_bar_parts
[(int) event
->part
];
5403 Fcons (Qvertical_scroll_bar
,
5404 Fcons (portion_whole
,
5405 Fcons (make_number (event
->timestamp
),
5406 Fcons (part
, Qnil
)))));
5408 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5410 if (button
>= ASIZE (button_down_location
))
5412 button_down_location
= larger_vector (button_down_location
,
5414 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5417 start_pos_ptr
= &AREF (button_down_location
, button
);
5418 start_pos
= *start_pos_ptr
;
5419 *start_pos_ptr
= Qnil
;
5422 /* On window-system frames, use the value of
5423 double-click-fuzz as is. On other frames, interpret it
5424 as a multiple of 1/8 characters. */
5428 if (WINDOWP (event
->frame_or_window
))
5429 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5430 else if (FRAMEP (event
->frame_or_window
))
5431 f
= XFRAME (event
->frame_or_window
);
5435 if (FRAME_WINDOW_P (f
))
5436 fuzz
= double_click_fuzz
;
5438 fuzz
= double_click_fuzz
/ 8;
5440 is_double
= (button
== last_mouse_button
5441 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5442 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5443 && button_down_time
!= 0
5444 && (EQ (Vdouble_click_time
, Qt
)
5445 || (INTEGERP (Vdouble_click_time
)
5446 && ((int)(event
->timestamp
- button_down_time
)
5447 < XINT (Vdouble_click_time
)))));
5450 last_mouse_button
= button
;
5451 last_mouse_x
= XINT (event
->x
);
5452 last_mouse_y
= XINT (event
->y
);
5454 /* If this is a button press, squirrel away the location, so
5455 we can decide later whether it was a click or a drag. */
5456 if (event
->modifiers
& down_modifier
)
5460 double_click_count
++;
5461 event
->modifiers
|= ((double_click_count
> 2)
5466 double_click_count
= 1;
5467 button_down_time
= event
->timestamp
;
5468 *start_pos_ptr
= Fcopy_alist (position
);
5471 /* Now we're releasing a button - check the co-ordinates to
5472 see if this was a click or a drag. */
5473 else if (event
->modifiers
& up_modifier
)
5475 /* If we did not see a down before this up, ignore the up.
5476 Probably this happened because the down event chose a
5477 menu item. It would be an annoyance to treat the
5478 release of the button that chose the menu item as a
5481 if (!CONSP (start_pos
))
5484 event
->modifiers
&= ~up_modifier
;
5485 #if 0 /* Formerly we treated an up with no down as a click event. */
5486 if (!CONSP (start_pos
))
5487 event
->modifiers
|= click_modifier
;
5492 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5494 /* The third element of every position
5495 should be the (x,y) pair. */
5496 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5498 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5500 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5501 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5504 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5505 && ydiff
< double_click_fuzz
5506 && ydiff
> - double_click_fuzz
)
5507 /* Mouse hasn't moved (much). */
5508 event
->modifiers
|= click_modifier
;
5511 button_down_time
= 0;
5512 event
->modifiers
|= drag_modifier
;
5515 /* Don't check is_double; treat this as multiple
5516 if the down-event was multiple. */
5517 if (double_click_count
> 1)
5518 event
->modifiers
|= ((double_click_count
> 2)
5524 /* Every mouse event should either have the down_modifier or
5525 the up_modifier set. */
5529 /* Get the symbol we should use for the mouse click. */
5532 head
= modify_event_symbol (button
,
5534 Qmouse_click
, Vlispy_mouse_stem
,
5537 XVECTOR (mouse_syms
)->size
);
5538 if (event
->modifiers
& drag_modifier
)
5543 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5546 Fcons (make_number (double_click_count
),
5557 Lisp_Object position
;
5560 /* Build the position as appropriate for this mouse click. */
5561 struct frame
*f
= XFRAME (event
->frame_or_window
);
5563 /* Ignore wheel events that were made on frame that have been
5565 if (! FRAME_LIVE_P (f
))
5568 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5571 /* Set double or triple modifiers to indicate the wheel speed. */
5573 /* On window-system frames, use the value of
5574 double-click-fuzz as is. On other frames, interpret it
5575 as a multiple of 1/8 characters. */
5580 if (WINDOWP (event
->frame_or_window
))
5581 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5582 else if (FRAMEP (event
->frame_or_window
))
5583 f
= XFRAME (event
->frame_or_window
);
5587 if (FRAME_WINDOW_P (f
))
5588 fuzz
= double_click_fuzz
;
5590 fuzz
= double_click_fuzz
/ 8;
5592 is_double
= (last_mouse_button
< 0
5593 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5594 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5595 && button_down_time
!= 0
5596 && (EQ (Vdouble_click_time
, Qt
)
5597 || (INTEGERP (Vdouble_click_time
)
5598 && ((int)(event
->timestamp
- button_down_time
)
5599 < XINT (Vdouble_click_time
)))));
5602 double_click_count
++;
5603 event
->modifiers
|= ((double_click_count
> 2)
5609 double_click_count
= 1;
5610 event
->modifiers
|= click_modifier
;
5613 button_down_time
= event
->timestamp
;
5614 /* Use a negative value to distinguish wheel from mouse button. */
5615 last_mouse_button
= -1;
5616 last_mouse_x
= XINT (event
->x
);
5617 last_mouse_y
= XINT (event
->y
);
5623 if (event
->modifiers
& up_modifier
)
5625 /* Emit a wheel-up event. */
5626 event
->modifiers
&= ~up_modifier
;
5629 else if (event
->modifiers
& down_modifier
)
5631 /* Emit a wheel-down event. */
5632 event
->modifiers
&= ~down_modifier
;
5636 /* Every wheel event should either have the down_modifier or
5637 the up_modifier set. */
5640 /* Get the symbol we should use for the wheel event. */
5641 head
= modify_event_symbol (symbol_num
,
5647 ASIZE (wheel_syms
));
5650 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5653 Fcons (make_number (double_click_count
),
5662 #ifdef USE_TOOLKIT_SCROLL_BARS
5664 /* We don't have down and up events if using toolkit scroll bars,
5665 so make this always a click event. Store in the `part' of
5666 the Lisp event a symbol which maps to the following actions:
5668 `above_handle' page up
5669 `below_handle' page down
5673 `bottom' bottom of buffer
5674 `handle' thumb has been dragged.
5675 `end-scroll' end of interaction with scroll bar
5677 The incoming input_event contains in its `part' member an
5678 index of type `enum scroll_bar_part' which we can use as an
5679 index in scroll_bar_parts to get the appropriate symbol. */
5681 case SCROLL_BAR_CLICK_EVENT
:
5683 Lisp_Object position
, head
, window
, portion_whole
, part
;
5685 window
= event
->frame_or_window
;
5686 portion_whole
= Fcons (event
->x
, event
->y
);
5687 part
= *scroll_bar_parts
[(int) event
->part
];
5691 Fcons (Qvertical_scroll_bar
,
5692 Fcons (portion_whole
,
5693 Fcons (make_number (event
->timestamp
),
5694 Fcons (part
, Qnil
)))));
5696 /* Always treat scroll bar events as clicks. */
5697 event
->modifiers
|= click_modifier
;
5698 event
->modifiers
&= ~up_modifier
;
5700 if (event
->code
>= ASIZE (mouse_syms
))
5701 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5703 /* Get the symbol we should use for the mouse click. */
5704 head
= modify_event_symbol (event
->code
,
5709 XVECTOR (mouse_syms
)->size
);
5710 return Fcons (head
, Fcons (position
, Qnil
));
5713 #endif /* USE_TOOLKIT_SCROLL_BARS */
5716 case W32_SCROLL_BAR_CLICK_EVENT
:
5718 int button
= event
->code
;
5720 Lisp_Object position
;
5721 Lisp_Object
*start_pos_ptr
;
5722 Lisp_Object start_pos
;
5726 Lisp_Object portion_whole
;
5729 window
= event
->frame_or_window
;
5730 portion_whole
= Fcons (event
->x
, event
->y
);
5731 part
= *scroll_bar_parts
[(int) event
->part
];
5735 Fcons (Qvertical_scroll_bar
,
5736 Fcons (portion_whole
,
5737 Fcons (make_number (event
->timestamp
),
5738 Fcons (part
, Qnil
)))));
5741 /* Always treat W32 scroll bar events as clicks. */
5742 event
->modifiers
|= click_modifier
;
5745 /* Get the symbol we should use for the mouse click. */
5748 head
= modify_event_symbol (button
,
5753 XVECTOR (mouse_syms
)->size
);
5759 #endif /* WINDOWSNT */
5761 case DRAG_N_DROP_EVENT
:
5764 Lisp_Object head
, position
;
5767 /* The frame_or_window field should be a cons of the frame in
5768 which the event occurred and a list of the filenames
5770 if (! CONSP (event
->frame_or_window
))
5773 f
= XFRAME (XCAR (event
->frame_or_window
));
5774 files
= XCDR (event
->frame_or_window
);
5776 /* Ignore mouse events that were made on frames that
5777 have been deleted. */
5778 if (! FRAME_LIVE_P (f
))
5781 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5784 head
= modify_event_symbol (0, event
->modifiers
,
5786 lispy_drag_n_drop_names
,
5787 &drag_n_drop_syms
, 1);
5793 #endif /* HAVE_MOUSE */
5795 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5796 || defined (USE_GTK)
5797 case MENU_BAR_EVENT
:
5798 if (EQ (event
->arg
, event
->frame_or_window
))
5799 /* This is the prefix key. We translate this to
5800 `(menu_bar)' because the code in keyboard.c for menu
5801 events, which we use, relies on this. */
5802 return Fcons (Qmenu_bar
, Qnil
);
5806 case SELECT_WINDOW_EVENT
:
5807 /* Make an event (select-window (WINDOW)). */
5808 return Fcons (Qselect_window
,
5809 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5812 case TOOL_BAR_EVENT
:
5813 if (EQ (event
->arg
, event
->frame_or_window
))
5814 /* This is the prefix key. We translate this to
5815 `(tool_bar)' because the code in keyboard.c for tool bar
5816 events, which we use, relies on this. */
5817 return Fcons (Qtool_bar
, Qnil
);
5818 else if (SYMBOLP (event
->arg
))
5819 return apply_modifiers (event
->modifiers
, event
->arg
);
5822 case USER_SIGNAL_EVENT
:
5823 /* A user signal. */
5824 return *lispy_user_signals
[event
->code
];
5826 case SAVE_SESSION_EVENT
:
5827 return Qsave_session
;
5829 /* The 'kind' field of the event is something we don't recognize. */
5838 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5840 Lisp_Object bar_window
;
5841 enum scroll_bar_part part
;
5845 /* Is it a scroll bar movement? */
5846 if (frame
&& ! NILP (bar_window
))
5848 Lisp_Object part_sym
;
5850 part_sym
= *scroll_bar_parts
[(int) part
];
5851 return Fcons (Qscroll_bar_movement
,
5852 (Fcons (Fcons (bar_window
,
5853 Fcons (Qvertical_scroll_bar
,
5854 Fcons (Fcons (x
, y
),
5855 Fcons (make_number (time
),
5861 /* Or is it an ordinary mouse movement? */
5864 Lisp_Object position
;
5866 position
= make_lispy_position (frame
, &x
, &y
, time
);
5868 return Fcons (Qmouse_movement
,
5874 #endif /* HAVE_MOUSE */
5876 /* Construct a switch frame event. */
5878 make_lispy_switch_frame (frame
)
5881 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5884 /* Manipulating modifiers. */
5886 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5888 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5889 SYMBOL's name of the end of the modifiers; the string from this
5890 position is the unmodified symbol name.
5892 This doesn't use any caches. */
5895 parse_modifiers_uncached (symbol
, modifier_end
)
5903 CHECK_SYMBOL (symbol
);
5906 name
= SYMBOL_NAME (symbol
);
5908 for (i
= 0; i
+2 <= SBYTES (name
); )
5910 int this_mod_end
= 0;
5913 /* See if the name continues with a modifier word.
5914 Check that the word appears, but don't check what follows it.
5915 Set this_mod and this_mod_end to record what we find. */
5917 switch (SREF (name
, i
))
5919 #define SINGLE_LETTER_MOD(BIT) \
5920 (this_mod_end = i + 1, this_mod = BIT)
5923 SINGLE_LETTER_MOD (alt_modifier
);
5927 SINGLE_LETTER_MOD (ctrl_modifier
);
5931 SINGLE_LETTER_MOD (hyper_modifier
);
5935 SINGLE_LETTER_MOD (meta_modifier
);
5939 SINGLE_LETTER_MOD (shift_modifier
);
5943 SINGLE_LETTER_MOD (super_modifier
);
5946 #undef SINGLE_LETTER_MOD
5948 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5949 if (i + LEN + 1 <= SBYTES (name) \
5950 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5952 this_mod_end = i + LEN; \
5957 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5958 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5959 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5963 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5965 #undef MULTI_LETTER_MOD
5969 /* If we found no modifier, stop looking for them. */
5970 if (this_mod_end
== 0)
5973 /* Check there is a dash after the modifier, so that it
5974 really is a modifier. */
5975 if (this_mod_end
>= SBYTES (name
)
5976 || SREF (name
, this_mod_end
) != '-')
5979 /* This modifier is real; look for another. */
5980 modifiers
|= this_mod
;
5981 i
= this_mod_end
+ 1;
5984 /* Should we include the `click' modifier? */
5985 if (! (modifiers
& (down_modifier
| drag_modifier
5986 | double_modifier
| triple_modifier
))
5987 && i
+ 7 == SBYTES (name
)
5988 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5989 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5990 modifiers
|= click_modifier
;
5998 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5999 prepended to the string BASE[0..BASE_LEN-1].
6000 This doesn't use any caches. */
6002 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6005 int base_len
, base_len_byte
;
6007 /* Since BASE could contain nulls, we can't use intern here; we have
6008 to use Fintern, which expects a genuine Lisp_String, and keeps a
6011 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6017 /* Only the event queue may use the `up' modifier; it should always
6018 be turned into a click or drag event before presented to lisp code. */
6019 if (modifiers
& up_modifier
)
6022 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6023 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6024 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6025 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6026 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6027 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6028 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6029 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6030 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6031 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6032 /* The click modifier is denoted by the absence of other modifiers. */
6036 mod_len
= p
- new_mods
;
6040 Lisp_Object new_name
;
6042 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6043 mod_len
+ base_len_byte
);
6044 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6045 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6047 return Fintern (new_name
, Qnil
);
6052 static char *modifier_names
[] =
6054 "up", "down", "drag", "click", "double", "triple", 0, 0,
6055 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6056 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6058 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6060 static Lisp_Object modifier_symbols
;
6062 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6064 lispy_modifier_list (modifiers
)
6067 Lisp_Object modifier_list
;
6070 modifier_list
= Qnil
;
6071 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6072 if (modifiers
& (1<<i
))
6073 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6076 return modifier_list
;
6080 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6081 where UNMODIFIED is the unmodified form of SYMBOL,
6082 MASK is the set of modifiers present in SYMBOL's name.
6083 This is similar to parse_modifiers_uncached, but uses the cache in
6084 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6085 Qevent_symbol_elements property. */
6088 parse_modifiers (symbol
)
6091 Lisp_Object elements
;
6093 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6094 if (CONSP (elements
))
6099 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6100 Lisp_Object unmodified
;
6103 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6104 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6107 if (modifiers
& ~INTMASK
)
6109 XSETFASTINT (mask
, modifiers
);
6110 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6112 /* Cache the parsing results on SYMBOL. */
6113 Fput (symbol
, Qevent_symbol_element_mask
,
6115 Fput (symbol
, Qevent_symbol_elements
,
6116 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6118 /* Since we know that SYMBOL is modifiers applied to unmodified,
6119 it would be nice to put that in unmodified's cache.
6120 But we can't, since we're not sure that parse_modifiers is
6127 /* Apply the modifiers MODIFIERS to the symbol BASE.
6128 BASE must be unmodified.
6130 This is like apply_modifiers_uncached, but uses BASE's
6131 Qmodifier_cache property, if present. It also builds
6132 Qevent_symbol_elements properties, since it has that info anyway.
6134 apply_modifiers copies the value of BASE's Qevent_kind property to
6135 the modified symbol. */
6137 apply_modifiers (modifiers
, base
)
6141 Lisp_Object cache
, index
, entry
, new_symbol
;
6143 /* Mask out upper bits. We don't know where this value's been. */
6144 modifiers
&= INTMASK
;
6146 /* The click modifier never figures into cache indices. */
6147 cache
= Fget (base
, Qmodifier_cache
);
6148 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6149 entry
= assq_no_quit (index
, cache
);
6152 new_symbol
= XCDR (entry
);
6155 /* We have to create the symbol ourselves. */
6156 new_symbol
= apply_modifiers_uncached (modifiers
,
6157 SDATA (SYMBOL_NAME (base
)),
6158 SCHARS (SYMBOL_NAME (base
)),
6159 SBYTES (SYMBOL_NAME (base
)));
6161 /* Add the new symbol to the base's cache. */
6162 entry
= Fcons (index
, new_symbol
);
6163 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6165 /* We have the parsing info now for free, so we could add it to
6167 XSETFASTINT (index, modifiers);
6168 Fput (new_symbol, Qevent_symbol_element_mask,
6169 Fcons (base, Fcons (index, Qnil)));
6170 Fput (new_symbol, Qevent_symbol_elements,
6171 Fcons (base, lispy_modifier_list (modifiers)));
6172 Sadly, this is only correct if `base' is indeed a base event,
6173 which is not necessarily the case. -stef */
6176 /* Make sure this symbol is of the same kind as BASE.
6178 You'd think we could just set this once and for all when we
6179 intern the symbol above, but reorder_modifiers may call us when
6180 BASE's property isn't set right; we can't assume that just
6181 because it has a Qmodifier_cache property it must have its
6182 Qevent_kind set right as well. */
6183 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6187 kind
= Fget (base
, Qevent_kind
);
6189 Fput (new_symbol
, Qevent_kind
, kind
);
6196 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6197 return a symbol with the modifiers placed in the canonical order.
6198 Canonical order is alphabetical, except for down and drag, which
6199 always come last. The 'click' modifier is never written out.
6201 Fdefine_key calls this to make sure that (for example) C-M-foo
6202 and M-C-foo end up being equivalent in the keymap. */
6205 reorder_modifiers (symbol
)
6208 /* It's hopefully okay to write the code this way, since everything
6209 will soon be in caches, and no consing will be done at all. */
6212 parsed
= parse_modifiers (symbol
);
6213 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6218 /* For handling events, we often want to produce a symbol whose name
6219 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6220 to some base, like the name of a function key or mouse button.
6221 modify_event_symbol produces symbols of this sort.
6223 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6224 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6227 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6228 into symbol names, or a string specifying a name stem used to
6229 construct a symbol name or the form `STEM-N', where N is the decimal
6230 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6231 non-nil; otherwise NAME_TABLE is used.
6233 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6234 persist between calls to modify_event_symbol that it can use to
6235 store a cache of the symbols it's generated for this NAME_TABLE
6236 before. The object stored there may be a vector or an alist.
6238 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6240 MODIFIERS is a set of modifier bits (as given in struct input_events)
6241 whose prefixes should be applied to the symbol name.
6243 SYMBOL_KIND is the value to be placed in the event_kind property of
6244 the returned symbol.
6246 The symbols we create are supposed to have an
6247 `event-symbol-elements' property, which lists the modifiers present
6248 in the symbol's name. */
6251 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6252 name_table
, symbol_table
, table_size
)
6255 Lisp_Object symbol_kind
;
6256 Lisp_Object name_alist_or_stem
;
6258 Lisp_Object
*symbol_table
;
6259 unsigned int table_size
;
6262 Lisp_Object symbol_int
;
6264 /* Get rid of the "vendor-specific" bit here. */
6265 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6267 /* Is this a request for a valid symbol? */
6268 if (symbol_num
< 0 || symbol_num
>= table_size
)
6271 if (CONSP (*symbol_table
))
6272 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6274 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6275 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6276 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6277 we've never used that symbol before. */
6280 if (! VECTORP (*symbol_table
)
6281 || XVECTOR (*symbol_table
)->size
!= table_size
)
6285 XSETFASTINT (size
, table_size
);
6286 *symbol_table
= Fmake_vector (size
, Qnil
);
6289 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6292 /* Have we already used this symbol before? */
6295 /* No; let's create it. */
6296 if (CONSP (name_alist_or_stem
))
6297 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6298 else if (STRINGP (name_alist_or_stem
))
6300 int len
= SBYTES (name_alist_or_stem
);
6301 char *buf
= (char *) alloca (len
+ 50);
6302 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6303 (long) XINT (symbol_int
) + 1);
6304 value
= intern (buf
);
6306 else if (name_table
!= 0 && name_table
[symbol_num
])
6307 value
= intern (name_table
[symbol_num
]);
6309 #ifdef HAVE_WINDOW_SYSTEM
6312 char *name
= x_get_keysym_name (symbol_num
);
6314 value
= intern (name
);
6321 sprintf (buf
, "key-%d", symbol_num
);
6322 value
= intern (buf
);
6325 if (CONSP (*symbol_table
))
6326 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6328 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6330 /* Fill in the cache entries for this symbol; this also
6331 builds the Qevent_symbol_elements property, which the user
6333 apply_modifiers (modifiers
& click_modifier
, value
);
6334 Fput (value
, Qevent_kind
, symbol_kind
);
6337 /* Apply modifiers to that symbol. */
6338 return apply_modifiers (modifiers
, value
);
6341 /* Convert a list that represents an event type,
6342 such as (ctrl meta backspace), into the usual representation of that
6343 event type as a number or a symbol. */
6345 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6346 doc
: /* Convert the event description list EVENT-DESC to an event type.
6347 EVENT-DESC should contain one base event type (a character or symbol)
6348 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6349 drag, down, double or triple). The base must be last.
6350 The return value is an event type (a character or symbol) which
6351 has the same base event type and all the specified modifiers. */)
6353 Lisp_Object event_desc
;
6361 while (CONSP (rest
))
6369 /* Given a symbol, see if it is a modifier name. */
6370 if (SYMBOLP (elt
) && CONSP (rest
))
6371 this = parse_solitary_modifier (elt
);
6375 else if (!NILP (base
))
6376 error ("Two bases given in one event");
6382 /* Let the symbol A refer to the character A. */
6383 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6384 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6386 if (INTEGERP (base
))
6388 /* Turn (shift a) into A. */
6389 if ((modifiers
& shift_modifier
) != 0
6390 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6392 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6393 modifiers
&= ~shift_modifier
;
6396 /* Turn (control a) into C-a. */
6397 if (modifiers
& ctrl_modifier
)
6398 return make_number ((modifiers
& ~ctrl_modifier
)
6399 | make_ctrl_char (XINT (base
)));
6401 return make_number (modifiers
| XINT (base
));
6403 else if (SYMBOLP (base
))
6404 return apply_modifiers (modifiers
, base
);
6407 error ("Invalid base event");
6412 /* Try to recognize SYMBOL as a modifier name.
6413 Return the modifier flag bit, or 0 if not recognized. */
6416 parse_solitary_modifier (symbol
)
6419 Lisp_Object name
= SYMBOL_NAME (symbol
);
6421 switch (SREF (name
, 0))
6423 #define SINGLE_LETTER_MOD(BIT) \
6424 if (SBYTES (name) == 1) \
6427 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6428 if (LEN == SBYTES (name) \
6429 && ! strncmp (SDATA (name), NAME, LEN)) \
6433 SINGLE_LETTER_MOD (alt_modifier
);
6437 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6441 SINGLE_LETTER_MOD (ctrl_modifier
);
6445 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6446 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6450 SINGLE_LETTER_MOD (hyper_modifier
);
6454 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6458 SINGLE_LETTER_MOD (meta_modifier
);
6462 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6466 SINGLE_LETTER_MOD (shift_modifier
);
6470 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6471 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6472 SINGLE_LETTER_MOD (super_modifier
);
6476 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6477 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6478 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6482 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6485 #undef SINGLE_LETTER_MOD
6486 #undef MULTI_LETTER_MOD
6492 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6493 Such a list is not valid as an event,
6494 but it can be a Lucid-style event type list. */
6497 lucid_event_type_list_p (object
)
6502 if (! CONSP (object
))
6505 if (EQ (XCAR (object
), Qhelp_echo
)
6506 || EQ (XCAR (object
), Qvertical_line
)
6507 || EQ (XCAR (object
), Qmode_line
)
6508 || EQ (XCAR (object
), Qheader_line
))
6511 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6515 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6522 /* Store into *addr a value nonzero if terminal input chars are available.
6523 Serves the purpose of ioctl (0, FIONREAD, addr)
6524 but works even if FIONREAD does not exist.
6525 (In fact, this may actually read some input.)
6527 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6528 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6531 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6536 /* First of all, have we already counted some input? */
6537 *addr
= (!NILP (Vquit_flag
)
6538 || readable_filtered_events (do_timers_now
, filter_events
));
6540 /* If input is being read as it arrives, and we have none, there is none. */
6541 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6544 /* Try to read some input and see how much we get. */
6546 *addr
= (!NILP (Vquit_flag
)
6547 || readable_filtered_events (do_timers_now
, filter_events
));
6550 /* Store into *addr a value nonzero if terminal input chars are available.
6551 Serves the purpose of ioctl (0, FIONREAD, addr)
6552 but works even if FIONREAD does not exist.
6553 (In fact, this may actually read some input.)
6555 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6558 get_input_pending (addr
, do_timers_now
)
6562 get_filtered_input_pending (addr
, do_timers_now
, 0);
6565 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6568 gobble_input (expected
)
6573 if (interrupt_input
)
6576 mask
= sigblock (sigmask (SIGIO
));
6577 read_avail_input (expected
);
6581 #ifdef POLL_FOR_INPUT
6582 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6585 mask
= sigblock (sigmask (SIGALRM
));
6586 read_avail_input (expected
);
6592 read_avail_input (expected
);
6596 /* Put a BUFFER_SWITCH_EVENT in the buffer
6597 so that read_key_sequence will notice the new current buffer. */
6600 record_asynch_buffer_change ()
6602 struct input_event event
;
6606 event
.kind
= BUFFER_SWITCH_EVENT
;
6607 event
.frame_or_window
= Qnil
;
6611 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6612 The purpose of the event is to make read_key_sequence look up the
6613 keymaps again. If we aren't in read_key_sequence, we don't need one,
6614 and the event could cause trouble by messing up (input-pending-p). */
6615 tem
= Fwaiting_for_user_input_p ();
6619 /* We never need these events if we have no asynchronous subprocesses. */
6623 /* Make sure no interrupt happens while storing the event. */
6625 if (interrupt_input
)
6628 mask
= sigblock (sigmask (SIGIO
));
6629 kbd_buffer_store_event (&event
);
6636 kbd_buffer_store_event (&event
);
6643 /* Read any terminal input already buffered up by the system
6644 into the kbd_buffer, but do not wait.
6646 EXPECTED should be nonzero if the caller knows there is some input.
6648 Except on VMS, all input is read by this function.
6649 If interrupt_input is nonzero, this function MUST be called
6650 only when SIGIO is blocked.
6652 Returns the number of keyboard chars read, or -1 meaning
6653 this is a bad time to try to read input. */
6656 read_avail_input (expected
)
6662 if (read_socket_hook
)
6666 struct input_event hold_quit
;
6668 EVENT_INIT (hold_quit
);
6669 hold_quit
.kind
= NO_EVENT
;
6671 /* No need for FIONREAD or fcntl; just say don't wait. */
6672 while (nr
= (*read_socket_hook
) (input_fd
, expected
, &hold_quit
), nr
> 0)
6677 if (hold_quit
.kind
!= NO_EVENT
)
6678 kbd_buffer_store_event (&hold_quit
);
6682 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6683 the kbd_buffer can really hold. That may prevent loss
6684 of characters on some systems when input is stuffed at us. */
6685 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6688 /* Determine how many characters we should *try* to read. */
6691 #else /* not WINDOWSNT */
6693 n_to_read
= dos_keysns ();
6696 #else /* not MSDOS */
6698 /* Find out how much input is available. */
6699 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6700 /* Formerly simply reported no input, but that sometimes led to
6701 a failure of Emacs to terminate.
6702 SIGHUP seems appropriate if we can't reach the terminal. */
6703 /* ??? Is it really right to send the signal just to this process
6704 rather than to the whole process group?
6705 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6707 if (! noninteractive
)
6708 kill (getpid (), SIGHUP
);
6714 if (n_to_read
> sizeof cbuf
)
6715 n_to_read
= sizeof cbuf
;
6716 #else /* no FIONREAD */
6717 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6718 /* Read some input if available, but don't wait. */
6719 n_to_read
= sizeof cbuf
;
6720 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6725 #endif /* not MSDOS */
6726 #endif /* not WINDOWSNT */
6728 /* Now read; for one reason or another, this will not block.
6729 NREAD is set to the number of chars read. */
6733 cbuf
[0] = dos_keyread ();
6736 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6738 /* POSIX infers that processes which are not in the session leader's
6739 process group won't get SIGHUP's at logout time. BSDI adheres to
6740 this part standard and returns -1 from read (0) with errno==EIO
6741 when the control tty is taken away.
6742 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6743 if (nread
== -1 && errno
== EIO
)
6745 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6746 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6747 This looks incorrect, but it isn't, because _BSD causes
6748 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6749 and that causes a value other than 0 when there is no input. */
6755 /* We used to retry the read if it was interrupted.
6756 But this does the wrong thing when O_NDELAY causes
6757 an EAGAIN error. Does anybody know of a situation
6758 where a retry is actually needed? */
6760 nread
< 0 && (errno
== EAGAIN
6774 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6775 fcntl (input_fd
, F_SETFL
, 0);
6776 #endif /* USG or DGUX or CYGWIN */
6777 #endif /* no FIONREAD */
6778 for (i
= 0; i
< nread
; i
++)
6780 struct input_event buf
;
6782 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6784 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6785 buf
.modifiers
= meta_modifier
;
6790 buf
.frame_or_window
= selected_frame
;
6793 kbd_buffer_store_event (&buf
);
6794 /* Don't look at input that follows a C-g too closely.
6795 This reduces lossage due to autorepeat on C-g. */
6796 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6797 && buf
.code
== quit_char
)
6804 #endif /* not VMS */
6807 handle_async_input ()
6810 extern int select_alarmed
;
6812 interrupt_input_pending
= 0;
6817 nread
= read_avail_input (1);
6818 /* -1 means it's not ok to read the input now.
6819 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6820 0 means there was no keyboard input available. */
6825 select_alarmed
= 1; /* Force the select emulator back to life */
6830 #ifdef SIGIO /* for entire page */
6831 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6834 input_available_signal (signo
)
6837 /* Must preserve main program's value of errno. */
6838 int old_errno
= errno
;
6840 #if defined (USG) && !defined (POSIX_SIGNALS)
6841 /* USG systems forget handlers when they are used;
6842 must reestablish each time */
6843 signal (signo
, input_available_signal
);
6850 if (input_available_clear_time
)
6851 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6854 interrupt_input_pending
= 1;
6856 handle_async_input ();
6866 /* Send ourselves a SIGIO.
6868 This function exists so that the UNBLOCK_INPUT macro in
6869 blockinput.h can have some way to take care of input we put off
6870 dealing with, without assuming that every file which uses
6871 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6873 reinvoke_input_signal ()
6876 handle_async_input ();
6882 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6883 static Lisp_Object menu_bar_one_keymap_changed_items
;
6885 /* These variables hold the vector under construction within
6886 menu_bar_items and its subroutines, and the current index
6887 for storing into that vector. */
6888 static Lisp_Object menu_bar_items_vector
;
6889 static int menu_bar_items_index
;
6891 /* Return a vector of menu items for a menu bar, appropriate
6892 to the current buffer. Each item has three elements in the vector:
6895 OLD is an old vector we can optionally reuse, or nil. */
6898 menu_bar_items (old
)
6901 /* The number of keymaps we're scanning right now, and the number of
6902 keymaps we have allocated space for. */
6905 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6906 in the current keymaps, or nil where it is not a prefix. */
6909 Lisp_Object def
, tail
;
6918 struct gcpro gcpro1
;
6920 /* In order to build the menus, we need to call the keymap
6921 accessors. They all call QUIT. But this function is called
6922 during redisplay, during which a quit is fatal. So inhibit
6923 quitting while building the menus.
6924 We do this instead of specbind because (1) errors will clear it anyway
6925 and (2) this avoids risk of specpdl overflow. */
6926 oquit
= Vinhibit_quit
;
6930 menu_bar_items_vector
= old
;
6932 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6933 menu_bar_items_index
= 0;
6935 GCPRO1 (menu_bar_items_vector
);
6937 /* Build our list of keymaps.
6938 If we recognize a function key and replace its escape sequence in
6939 keybuf with its symbol, or if the sequence starts with a mouse
6940 click and we need to switch buffers, we jump back here to rebuild
6941 the initial keymaps from the current buffer. */
6945 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6946 if (!NILP (Voverriding_local_map_menu_flag
))
6948 /* Yes, use them (if non-nil) as well as the global map. */
6949 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6951 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6952 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6953 if (!NILP (Voverriding_local_map
))
6954 maps
[nmaps
++] = Voverriding_local_map
;
6958 /* No, so use major and minor mode keymaps and keymap property.
6959 Note that menu-bar bindings in the local-map and keymap
6960 properties may not work reliable, as they are only
6961 recognized when the menu-bar (or mode-line) is updated,
6962 which does not normally happen after every command. */
6965 nminor
= current_minor_maps (NULL
, &tmaps
);
6966 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6968 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6969 maps
[nmaps
++] = tem
;
6970 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6972 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6974 maps
[nmaps
++] = current_global_map
;
6977 /* Look up in each map the dummy prefix key `menu-bar'. */
6981 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6982 if (!NILP (maps
[mapno
]))
6984 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6988 menu_bar_one_keymap_changed_items
= Qnil
;
6989 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
6993 /* Move to the end those items that should be at the end. */
6995 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6998 int end
= menu_bar_items_index
;
7000 for (i
= 0; i
< end
; i
+= 4)
7001 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7003 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7004 /* Move the item at index I to the end,
7005 shifting all the others forward. */
7006 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7007 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7008 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7009 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7011 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7012 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7013 (end
- i
- 4) * sizeof (Lisp_Object
));
7014 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7015 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7016 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7017 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7022 /* Add nil, nil, nil, nil at the end. */
7023 i
= menu_bar_items_index
;
7024 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7027 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7028 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7029 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7030 menu_bar_items_vector
= tem
;
7032 /* Add this item. */
7033 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7034 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7035 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7036 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7037 menu_bar_items_index
= i
;
7039 Vinhibit_quit
= oquit
;
7041 return menu_bar_items_vector
;
7044 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7045 If there's already an item for KEY, add this DEF to it. */
7047 Lisp_Object item_properties
;
7050 menu_bar_item (key
, item
, dummy1
, dummy2
)
7051 Lisp_Object key
, item
, dummy1
;
7054 struct gcpro gcpro1
;
7058 if (EQ (item
, Qundefined
))
7060 /* If a map has an explicit `undefined' as definition,
7061 discard any previously made menu bar item. */
7063 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7064 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7066 if (menu_bar_items_index
> i
+ 4)
7067 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7068 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7069 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7070 menu_bar_items_index
-= 4;
7074 /* If this keymap has already contributed to this KEY,
7075 don't contribute to it a second time. */
7076 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7077 if (!NILP (tem
) || NILP (item
))
7080 menu_bar_one_keymap_changed_items
7081 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7083 /* We add to menu_bar_one_keymap_changed_items before doing the
7084 parse_menu_item, so that if it turns out it wasn't a menu item,
7085 it still correctly hides any further menu item. */
7087 i
= parse_menu_item (item
, 0, 1);
7092 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7094 /* Find any existing item for this KEY. */
7095 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7096 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7099 /* If we did not find this KEY, add it at the end. */
7100 if (i
== menu_bar_items_index
)
7102 /* If vector is too small, get a bigger one. */
7103 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7106 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7107 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7108 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7109 menu_bar_items_vector
= tem
;
7112 /* Add this item. */
7113 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7114 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7115 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7116 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7117 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7118 menu_bar_items_index
= i
;
7120 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7124 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7125 /* If the new and the old items are not both keymaps,
7126 the lookup will only find `item'. */
7127 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7128 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7132 /* This is used as the handler when calling menu_item_eval_property. */
7134 menu_item_eval_property_1 (arg
)
7137 /* If we got a quit from within the menu computation,
7138 quit all the way out of it. This takes care of C-] in the debugger. */
7139 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7140 Fsignal (Qquit
, Qnil
);
7145 /* Evaluate an expression and return the result (or nil if something
7146 went wrong). Used to evaluate dynamic parts of menu items. */
7148 menu_item_eval_property (sexpr
)
7151 int count
= SPECPDL_INDEX ();
7153 specbind (Qinhibit_redisplay
, Qt
);
7154 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7155 menu_item_eval_property_1
);
7156 return unbind_to (count
, val
);
7159 /* This function parses a menu item and leaves the result in the
7160 vector item_properties.
7161 ITEM is a key binding, a possible menu item.
7162 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7163 evaluate dynamic expressions in the menu item.
7164 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7166 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7167 parse_menu_item returns true if the item is a menu item and false
7171 parse_menu_item (item
, notreal
, inmenubar
)
7173 int notreal
, inmenubar
;
7175 Lisp_Object def
, tem
, item_string
, start
;
7176 Lisp_Object cachelist
;
7178 Lisp_Object keyhint
;
7189 /* Create item_properties vector if necessary. */
7190 if (NILP (item_properties
))
7192 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7194 /* Initialize optional entries. */
7195 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7196 AREF (item_properties
, i
) = Qnil
;
7197 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7199 /* Save the item here to protect it from GC. */
7200 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7202 item_string
= XCAR (item
);
7206 if (STRINGP (item_string
))
7208 /* Old format menu item. */
7209 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7211 /* Maybe help string. */
7212 if (CONSP (item
) && STRINGP (XCAR (item
)))
7214 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7219 /* Maybe key binding cache. */
7220 if (CONSP (item
) && CONSP (XCAR (item
))
7221 && (NILP (XCAR (XCAR (item
)))
7222 || VECTORP (XCAR (XCAR (item
)))))
7224 cachelist
= XCAR (item
);
7228 /* This is the real definition--the function to run. */
7229 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7231 /* Get enable property, if any. */
7234 tem
= Fget (item
, Qmenu_enable
);
7236 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7239 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7241 /* New format menu item. */
7242 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7243 start
= XCDR (item
);
7246 /* We have a real binding. */
7247 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7249 item
= XCDR (start
);
7250 /* Is there a cache list with key equivalences. */
7251 if (CONSP (item
) && CONSP (XCAR (item
)))
7253 cachelist
= XCAR (item
);
7257 /* Parse properties. */
7258 while (CONSP (item
) && CONSP (XCDR (item
)))
7263 if (EQ (tem
, QCenable
))
7264 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7265 else if (EQ (tem
, QCvisible
) && !notreal
)
7267 /* If got a visible property and that evaluates to nil
7268 then ignore this item. */
7269 tem
= menu_item_eval_property (XCAR (item
));
7273 else if (EQ (tem
, QChelp
))
7274 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7275 else if (EQ (tem
, QCfilter
))
7277 else if (EQ (tem
, QCkey_sequence
))
7280 if (NILP (cachelist
)
7281 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7282 /* Be GC protected. Set keyhint to item instead of tem. */
7285 else if (EQ (tem
, QCkeys
))
7288 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7289 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7291 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7296 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7298 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7300 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7307 else if (inmenubar
|| !NILP (start
))
7311 return 0; /* not a menu item */
7313 /* If item string is not a string, evaluate it to get string.
7314 If we don't get a string, skip this item. */
7315 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7316 if (!(STRINGP (item_string
) || notreal
))
7318 item_string
= menu_item_eval_property (item_string
);
7319 if (!STRINGP (item_string
))
7321 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7324 /* If got a filter apply it on definition. */
7325 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7328 def
= menu_item_eval_property (list2 (XCAR (filter
),
7329 list2 (Qquote
, def
)));
7331 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7334 /* Enable or disable selection of item. */
7335 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7341 tem
= menu_item_eval_property (tem
);
7342 if (inmenubar
&& NILP (tem
))
7343 return 0; /* Ignore disabled items in menu bar. */
7344 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7347 /* If we got no definition, this item is just unselectable text which
7348 is OK in a submenu but not in the menubar. */
7350 return (inmenubar
? 0 : 1);
7352 /* See if this is a separate pane or a submenu. */
7353 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7354 tem
= get_keymap (def
, 0, 1);
7355 /* For a subkeymap, just record its details and exit. */
7358 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7359 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7363 /* At the top level in the menu bar, do likewise for commands also.
7364 The menu bar does not display equivalent key bindings anyway.
7365 ITEM_PROPERTY_DEF is already set up properly. */
7369 /* This is a command. See if there is an equivalent key binding. */
7370 if (NILP (cachelist
))
7372 /* We have to create a cachelist. */
7373 CHECK_IMPURE (start
);
7374 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7375 cachelist
= XCAR (XCDR (start
));
7377 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7378 if (!NILP (keyhint
))
7380 XSETCAR (cachelist
, XCAR (keyhint
));
7383 else if (STRINGP (tem
))
7385 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7386 XSETCAR (cachelist
, Qt
);
7390 tem
= XCAR (cachelist
);
7397 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7399 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7402 def
= XCAR (prefix
);
7403 prefix
= XCDR (prefix
);
7406 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7408 if (!update_menu_bindings
)
7410 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7412 if (newcache
/* Always check first time. */
7413 /* Should we check everything when precomputing key
7415 /* If something had no key binding before, don't recheck it
7416 because that is too slow--except if we have a list of
7417 rebound commands in Vdefine_key_rebound_commands, do
7418 recheck any command that appears in that list. */
7419 || (CONSP (Vdefine_key_rebound_commands
)
7420 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7423 /* We had a saved key. Is it still bound to the command? */
7426 /* If the command is an alias for another
7427 (such as lmenu.el set it up), check if the
7428 original command matches the cached command. */
7429 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7430 chkcache
= 1; /* Need to recompute key binding. */
7434 /* Recompute equivalent key binding. If the command is an alias
7435 for another (such as lmenu.el set it up), see if the original
7436 command name has equivalent keys. Otherwise look up the
7437 specified command itself. We don't try both, because that
7438 makes lmenu menus slow. */
7440 && SYMBOLP (XSYMBOL (def
)->function
)
7441 && ! NILP (Fget (def
, Qmenu_alias
)))
7442 def
= XSYMBOL (def
)->function
;
7443 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7444 XSETCAR (cachelist
, tem
);
7447 XSETCDR (cachelist
, Qnil
);
7451 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7453 tem
= XCAR (cachelist
);
7457 newcache
= chkcache
;
7460 tem
= Fkey_description (tem
, Qnil
);
7463 if (STRINGP (XCAR (prefix
)))
7464 tem
= concat2 (XCAR (prefix
), tem
);
7465 if (STRINGP (XCDR (prefix
)))
7466 tem
= concat2 (tem
, XCDR (prefix
));
7468 XSETCDR (cachelist
, tem
);
7472 tem
= XCDR (cachelist
);
7473 if (newcache
&& !NILP (tem
))
7475 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7476 XSETCDR (cachelist
, tem
);
7479 /* If we only want to precompute equivalent key bindings, stop here. */
7483 /* If we have an equivalent key binding, use that. */
7484 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7486 /* Include this when menu help is implemented.
7487 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7488 if (!(NILP (tem) || STRINGP (tem)))
7490 tem = menu_item_eval_property (tem);
7493 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7497 /* Handle radio buttons or toggle boxes. */
7498 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7500 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7501 = menu_item_eval_property (tem
);
7508 /***********************************************************************
7510 ***********************************************************************/
7512 /* A vector holding tool bar items while they are parsed in function
7513 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7516 static Lisp_Object tool_bar_items_vector
;
7518 /* A vector holding the result of parse_tool_bar_item. Layout is like
7519 the one for a single item in tool_bar_items_vector. */
7521 static Lisp_Object tool_bar_item_properties
;
7523 /* Next free index in tool_bar_items_vector. */
7525 static int ntool_bar_items
;
7527 /* The symbols `tool-bar', and `:image'. */
7529 extern Lisp_Object Qtool_bar
;
7530 Lisp_Object QCimage
;
7532 /* Function prototypes. */
7534 static void init_tool_bar_items
P_ ((Lisp_Object
));
7535 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7536 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7537 static void append_tool_bar_item
P_ ((void));
7540 /* Return a vector of tool bar items for keymaps currently in effect.
7541 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7542 tool bar items found. */
7545 tool_bar_items (reuse
, nitems
)
7556 /* In order to build the menus, we need to call the keymap
7557 accessors. They all call QUIT. But this function is called
7558 during redisplay, during which a quit is fatal. So inhibit
7559 quitting while building the menus. We do this instead of
7560 specbind because (1) errors will clear it anyway and (2) this
7561 avoids risk of specpdl overflow. */
7562 oquit
= Vinhibit_quit
;
7565 /* Initialize tool_bar_items_vector and protect it from GC. */
7566 init_tool_bar_items (reuse
);
7568 /* Build list of keymaps in maps. Set nmaps to the number of maps
7571 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7572 if (!NILP (Voverriding_local_map_menu_flag
))
7574 /* Yes, use them (if non-nil) as well as the global map. */
7575 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7577 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7578 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7579 if (!NILP (Voverriding_local_map
))
7580 maps
[nmaps
++] = Voverriding_local_map
;
7584 /* No, so use major and minor mode keymaps and keymap property.
7585 Note that tool-bar bindings in the local-map and keymap
7586 properties may not work reliable, as they are only
7587 recognized when the tool-bar (or mode-line) is updated,
7588 which does not normally happen after every command. */
7591 nminor
= current_minor_maps (NULL
, &tmaps
);
7592 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7594 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7595 maps
[nmaps
++] = tem
;
7596 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7598 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7601 /* Add global keymap at the end. */
7602 maps
[nmaps
++] = current_global_map
;
7604 /* Process maps in reverse order and look up in each map the prefix
7606 for (i
= nmaps
- 1; i
>= 0; --i
)
7607 if (!NILP (maps
[i
]))
7611 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7616 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7617 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7619 Lisp_Object keydef
= XCAR (tail
);
7621 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7626 Vinhibit_quit
= oquit
;
7627 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7628 return tool_bar_items_vector
;
7632 /* Process the definition of KEY which is DEF. */
7635 process_tool_bar_item (key
, def
)
7636 Lisp_Object key
, def
;
7639 extern Lisp_Object Qundefined
;
7640 struct gcpro gcpro1
, gcpro2
;
7642 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7646 if (EQ (def
, Qundefined
))
7648 /* If a map has an explicit `undefined' as definition,
7649 discard any previously made item. */
7650 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7652 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7654 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7656 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7657 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7658 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7659 * sizeof (Lisp_Object
)));
7660 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7665 else if (parse_tool_bar_item (key
, def
))
7666 /* Append a new tool bar item to tool_bar_items_vector. Accept
7667 more than one definition for the same key. */
7668 append_tool_bar_item ();
7674 /* Parse a tool bar item specification ITEM for key KEY and return the
7675 result in tool_bar_item_properties. Value is zero if ITEM is
7678 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7680 CAPTION is the caption of the item, If it's not a string, it is
7681 evaluated to get a string.
7683 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7684 as binding are currently ignored.
7686 The following properties are recognized:
7690 FORM is evaluated and specifies whether the tool bar item is
7691 enabled or disabled.
7695 FORM is evaluated and specifies whether the tool bar item is visible.
7697 - `:filter FUNCTION'
7699 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7700 result is stored as the new binding.
7702 - `:button (TYPE SELECTED)'
7704 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7705 and specifies whether the button is selected (pressed) or not.
7709 IMAGES is either a single image specification or a vector of four
7710 image specifications. See enum tool_bar_item_images.
7712 - `:help HELP-STRING'.
7714 Gives a help string to display for the tool bar item. */
7717 parse_tool_bar_item (key
, item
)
7718 Lisp_Object key
, item
;
7720 /* Access slot with index IDX of vector tool_bar_item_properties. */
7721 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7723 Lisp_Object filter
= Qnil
;
7724 Lisp_Object caption
;
7727 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7728 Rule out items that aren't lists, don't start with
7729 `menu-item' or whose rest following `tool-bar-item' is not a
7732 || !EQ (XCAR (item
), Qmenu_item
)
7733 || (item
= XCDR (item
),
7737 /* Create tool_bar_item_properties vector if necessary. Reset it to
7739 if (VECTORP (tool_bar_item_properties
))
7741 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7745 tool_bar_item_properties
7746 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7749 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7750 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7752 /* Get the caption of the item. If the caption is not a string,
7753 evaluate it to get a string. If we don't get a string, skip this
7755 caption
= XCAR (item
);
7756 if (!STRINGP (caption
))
7758 caption
= menu_item_eval_property (caption
);
7759 if (!STRINGP (caption
))
7762 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7764 /* Give up if rest following the caption is not a list. */
7769 /* Store the binding. */
7770 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7773 /* Ignore cached key binding, if any. */
7774 if (CONSP (item
) && CONSP (XCAR (item
)))
7777 /* Process the rest of the properties. */
7778 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7780 Lisp_Object key
, value
;
7783 value
= XCAR (XCDR (item
));
7785 if (EQ (key
, QCenable
))
7786 /* `:enable FORM'. */
7787 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7788 else if (EQ (key
, QCvisible
))
7790 /* `:visible FORM'. If got a visible property and that
7791 evaluates to nil then ignore this item. */
7792 if (NILP (menu_item_eval_property (value
)))
7795 else if (EQ (key
, QChelp
))
7796 /* `:help HELP-STRING'. */
7797 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7798 else if (EQ (key
, QCfilter
))
7799 /* ':filter FORM'. */
7801 else if (EQ (key
, QCbutton
) && CONSP (value
))
7803 /* `:button (TYPE . SELECTED)'. */
7804 Lisp_Object type
, selected
;
7806 type
= XCAR (value
);
7807 selected
= XCDR (value
);
7808 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7810 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7811 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7814 else if (EQ (key
, QCimage
)
7816 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7817 /* Value is either a single image specification or a vector
7818 of 4 such specifications for the different button states. */
7819 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7822 /* If got a filter apply it on binding. */
7824 PROP (TOOL_BAR_ITEM_BINDING
)
7825 = menu_item_eval_property (list2 (filter
,
7827 PROP (TOOL_BAR_ITEM_BINDING
))));
7829 /* See if the binding is a keymap. Give up if it is. */
7830 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7833 /* Enable or disable selection of item. */
7834 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7835 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7836 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7838 /* Handle radio buttons or toggle boxes. */
7839 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7840 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7841 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7849 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7850 that can be reused. */
7853 init_tool_bar_items (reuse
)
7856 if (VECTORP (reuse
))
7857 tool_bar_items_vector
= reuse
;
7859 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7860 ntool_bar_items
= 0;
7864 /* Append parsed tool bar item properties from
7865 tool_bar_item_properties */
7868 append_tool_bar_item ()
7870 Lisp_Object
*to
, *from
;
7872 /* Enlarge tool_bar_items_vector if necessary. */
7873 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7874 >= XVECTOR (tool_bar_items_vector
)->size
)
7876 Lisp_Object new_vector
;
7877 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7879 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7880 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7881 XVECTOR (new_vector
)->contents
,
7882 old_size
* sizeof (Lisp_Object
));
7883 tool_bar_items_vector
= new_vector
;
7886 /* Append entries from tool_bar_item_properties to the end of
7887 tool_bar_items_vector. */
7888 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7889 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7890 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7891 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7898 /* Read a character using menus based on maps in the array MAPS.
7899 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7900 Return t if we displayed a menu but the user rejected it.
7902 PREV_EVENT is the previous input event, or nil if we are reading
7903 the first event of a key sequence.
7905 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7906 if we used a mouse menu to read the input, or zero otherwise. If
7907 USED_MOUSE_MENU is null, we don't dereference it.
7909 The prompting is done based on the prompt-string of the map
7910 and the strings associated with various map elements.
7912 This can be done with X menus or with menus put in the minibuf.
7913 These are done in different ways, depending on how the input will be read.
7914 Menus using X are done after auto-saving in read-char, getting the input
7915 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7916 and do auto-saving in the inner call of read_char. */
7919 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7922 Lisp_Object prev_event
;
7923 int *used_mouse_menu
;
7926 register Lisp_Object name
= Qnil
;
7928 if (used_mouse_menu
)
7929 *used_mouse_menu
= 0;
7931 /* Use local over global Menu maps */
7933 if (! menu_prompting
)
7936 /* Optionally disregard all but the global map. */
7937 if (inhibit_local_menu_bar_menus
)
7939 maps
+= (nmaps
- 1);
7943 /* Get the menu name from the first map that has one (a prompt string). */
7944 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7946 name
= Fkeymap_prompt (maps
[mapno
]);
7951 /* If we don't have any menus, just read a character normally. */
7952 if (!STRINGP (name
))
7956 /* If we got to this point via a mouse click,
7957 use a real menu for mouse selection. */
7958 if (EVENT_HAS_PARAMETERS (prev_event
)
7959 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7960 && !EQ (XCAR (prev_event
), Qtool_bar
))
7962 /* Display the menu and get the selection. */
7963 Lisp_Object
*realmaps
7964 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7968 /* Use the maps that are not nil. */
7969 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7970 if (!NILP (maps
[mapno
]))
7971 realmaps
[nmaps1
++] = maps
[mapno
];
7973 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7978 record_menu_key (XCAR (value
));
7980 /* If we got multiple events, unread all but
7982 There is no way to prevent those unread events
7983 from showing up later in last_nonmenu_event.
7984 So turn symbol and integer events into lists,
7985 to indicate that they came from a mouse menu,
7986 so that when present in last_nonmenu_event
7987 they won't confuse things. */
7988 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7990 record_menu_key (XCAR (tem
));
7991 if (SYMBOLP (XCAR (tem
))
7992 || INTEGERP (XCAR (tem
)))
7993 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7996 /* If we got more than one event, put all but the first
7997 onto this list to be read later.
7998 Return just the first event now. */
7999 Vunread_command_events
8000 = nconc2 (XCDR (value
), Vunread_command_events
);
8001 value
= XCAR (value
);
8003 else if (NILP (value
))
8005 if (used_mouse_menu
)
8006 *used_mouse_menu
= 1;
8009 #endif /* HAVE_MENUS */
8013 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8014 We make this bigger when necessary, and never free it. */
8015 static char *read_char_minibuf_menu_text
;
8016 /* Size of that buffer. */
8017 static int read_char_minibuf_menu_width
;
8020 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8026 register Lisp_Object name
;
8028 /* FIXME: Use the minibuffer's frame width. */
8029 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8032 Lisp_Object rest
, vector
;
8038 if (! menu_prompting
)
8041 /* Make sure we have a big enough buffer for the menu text. */
8042 if (read_char_minibuf_menu_text
== 0)
8044 read_char_minibuf_menu_width
= width
+ 4;
8045 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8047 else if (width
+ 4 > read_char_minibuf_menu_width
)
8049 read_char_minibuf_menu_width
= width
+ 4;
8050 read_char_minibuf_menu_text
8051 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8053 menu
= read_char_minibuf_menu_text
;
8055 /* Get the menu name from the first map that has one (a prompt string). */
8056 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8058 name
= Fkeymap_prompt (maps
[mapno
]);
8063 /* If we don't have any menus, just read a character normally. */
8064 if (!STRINGP (name
))
8067 /* Prompt string always starts with map's prompt, and a space. */
8068 strcpy (menu
, SDATA (name
));
8069 nlength
= SBYTES (name
);
8070 menu
[nlength
++] = ':';
8071 menu
[nlength
++] = ' ';
8074 /* Start prompting at start of first map. */
8078 /* Present the documented bindings, a line at a time. */
8085 Lisp_Object orig_defn_macro
;
8087 /* Loop over elements of map. */
8092 /* If reached end of map, start at beginning of next map. */
8096 /* At end of last map, wrap around to first map if just starting,
8097 or end this line if already have something on it. */
8101 if (notfirst
|| nobindings
) break;
8106 /* Look at the next element of the map. */
8108 elt
= XVECTOR (vector
)->contents
[idx
];
8110 elt
= Fcar_safe (rest
);
8112 if (idx
< 0 && VECTORP (elt
))
8114 /* If we found a dense table in the keymap,
8115 advanced past it, but start scanning its contents. */
8116 rest
= Fcdr_safe (rest
);
8122 /* An ordinary element. */
8123 Lisp_Object event
, tem
;
8127 event
= Fcar_safe (elt
); /* alist */
8128 elt
= Fcdr_safe (elt
);
8132 XSETINT (event
, idx
); /* vector */
8135 /* Ignore the element if it has no prompt string. */
8136 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8138 /* 1 if the char to type matches the string. */
8140 Lisp_Object upcased_event
, downcased_event
;
8141 Lisp_Object desc
= Qnil
;
8143 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8145 upcased_event
= Fupcase (event
);
8146 downcased_event
= Fdowncase (event
);
8147 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8148 || XINT (downcased_event
) == SREF (s
, 0));
8150 desc
= Fsingle_key_description (event
, Qnil
);
8152 #if 0 /* It is redundant to list the equivalent key bindings because
8153 the prefix is what the user has already typed. */
8155 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8157 /* Insert equivalent keybinding. */
8158 s
= concat2 (s
, tem
);
8161 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8162 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8164 /* Insert button prefix. */
8165 Lisp_Object selected
8166 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8167 if (EQ (tem
, QCradio
))
8168 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8170 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8171 s
= concat2 (tem
, s
);
8175 /* If we have room for the prompt string, add it to this line.
8176 If this is the first on the line, always add it. */
8177 if ((SCHARS (s
) + i
+ 2
8178 + (char_matches
? 0 : SCHARS (desc
) + 3))
8184 /* Punctuate between strings. */
8187 strcpy (menu
+ i
, ", ");
8193 /* If the char to type doesn't match the string's
8194 first char, explicitly show what char to type. */
8197 /* Add as much of string as fits. */
8198 thiswidth
= SCHARS (desc
);
8199 if (thiswidth
+ i
> width
)
8200 thiswidth
= width
- i
;
8201 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8203 strcpy (menu
+ i
, " = ");
8207 /* Add as much of string as fits. */
8208 thiswidth
= SCHARS (s
);
8209 if (thiswidth
+ i
> width
)
8210 thiswidth
= width
- i
;
8211 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8217 /* If this element does not fit, end the line now,
8218 and save the element for the next line. */
8219 strcpy (menu
+ i
, "...");
8224 /* Move past this element. */
8225 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8226 /* Handle reaching end of dense table. */
8231 rest
= Fcdr_safe (rest
);
8235 /* Prompt with that and read response. */
8236 message2_nolog (menu
, strlen (menu
),
8237 ! NILP (current_buffer
->enable_multibyte_characters
));
8239 /* Make believe its not a keyboard macro in case the help char
8240 is pressed. Help characters are not recorded because menu prompting
8241 is not used on replay.
8243 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8244 current_kboard
->defining_kbd_macro
= Qnil
;
8246 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8247 while (BUFFERP (obj
));
8248 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8250 if (!INTEGERP (obj
))
8255 if (! EQ (obj
, menu_prompt_more_char
)
8256 && (!INTEGERP (menu_prompt_more_char
)
8257 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8259 if (!NILP (current_kboard
->defining_kbd_macro
))
8260 store_kbd_macro_char (obj
);
8263 /* Help char - go round again */
8267 /* Reading key sequences. */
8269 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8270 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8271 keymap, or nil otherwise. Return the index of the first keymap in
8272 which KEY has any binding, or NMAPS if no map has a binding.
8274 If KEY is a meta ASCII character, treat it like meta-prefix-char
8275 followed by the corresponding non-meta character. Keymaps in
8276 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8279 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8282 NEXT may be the same array as CURRENT. */
8285 follow_key (key
, nmaps
, current
, defs
, next
)
8287 Lisp_Object
*current
, *defs
, *next
;
8290 int i
, first_binding
;
8292 first_binding
= nmaps
;
8293 for (i
= nmaps
- 1; i
>= 0; i
--)
8295 if (! NILP (current
[i
]))
8297 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8298 if (! NILP (defs
[i
]))
8305 /* Given the set of bindings we've found, produce the next set of maps. */
8306 if (first_binding
< nmaps
)
8307 for (i
= 0; i
< nmaps
; i
++)
8308 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8310 return first_binding
;
8313 /* Structure used to keep track of partial application of key remapping
8314 such as Vfunction_key_map and Vkey_translation_map. */
8315 typedef struct keyremap
8317 Lisp_Object map
, parent
;
8321 /* Lookup KEY in MAP.
8322 MAP is a keymap mapping keys to key vectors or functions.
8323 If the mapping is a function and DO_FUNCTION is non-zero, then
8324 the function is called with PROMPT as parameter and its return
8325 value is used as the return value of this function (after checking
8326 that it is indeed a vector). */
8329 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8330 Lisp_Object map
, key
, prompt
;
8335 next
= access_keymap (map
, key
, 1, 0, 1);
8337 /* Handle symbol with autoload definition. */
8338 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8339 && CONSP (XSYMBOL (next
)->function
)
8340 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8341 do_autoload (XSYMBOL (next
)->function
, next
);
8343 /* Handle a symbol whose function definition is a keymap
8345 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8346 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8347 || KEYMAPP (XSYMBOL (next
)->function
)))
8348 next
= XSYMBOL (next
)->function
;
8350 /* If the keymap gives a function, not an
8351 array, then call the function with one arg and use
8352 its value instead. */
8353 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8358 next
= call1 (next
, prompt
);
8359 /* If the function returned something invalid,
8360 barf--don't ignore it.
8361 (To ignore it safely, we would need to gcpro a bunch of
8362 other variables.) */
8363 if (! (VECTORP (next
) || STRINGP (next
)))
8364 error ("Function %s returns invalid key sequence", tem
);
8369 /* Do one step of the key remapping used for function-key-map and
8370 key-translation-map:
8371 KEYBUF is the buffer holding the input events.
8372 BUFSIZE is its maximum size.
8373 FKEY is a pointer to the keyremap structure to use.
8374 INPUT is the index of the last element in KEYBUF.
8375 DOIT if non-zero says that the remapping can actually take place.
8376 DIFF is used to return the number of keys added/removed by the remapping.
8377 PARENT is the root of the keymap.
8378 PROMPT is the prompt to use if the remapping happens through a function.
8379 The return value is non-zero if the remapping actually took place. */
8382 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8383 Lisp_Object
*keybuf
, prompt
;
8385 int input
, doit
, *diff
, bufsize
;
8387 Lisp_Object next
, key
;
8389 key
= keybuf
[fkey
->end
++];
8390 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8392 /* If keybuf[fkey->start..fkey->end] is bound in the
8393 map and we're in a position to do the key remapping, replace it with
8394 the binding and restart with fkey->start at the end. */
8395 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8397 int len
= XFASTINT (Flength (next
));
8400 *diff
= len
- (fkey
->end
- fkey
->start
);
8402 if (input
+ *diff
>= bufsize
)
8403 error ("Key sequence too long");
8405 /* Shift the keys that follow fkey->end. */
8407 for (i
= fkey
->end
; i
< input
; i
++)
8408 keybuf
[i
+ *diff
] = keybuf
[i
];
8410 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8411 keybuf
[i
+ *diff
] = keybuf
[i
];
8412 /* Overwrite the old keys with the new ones. */
8413 for (i
= 0; i
< len
; i
++)
8414 keybuf
[fkey
->start
+ i
]
8415 = Faref (next
, make_number (i
));
8417 fkey
->start
= fkey
->end
+= *diff
;
8418 fkey
->map
= fkey
->parent
;
8423 fkey
->map
= get_keymap (next
, 0, 1);
8425 /* If we no longer have a bound suffix, try a new position for
8427 if (!CONSP (fkey
->map
))
8429 fkey
->end
= ++fkey
->start
;
8430 fkey
->map
= fkey
->parent
;
8435 /* Read a sequence of keys that ends with a non prefix character,
8436 storing it in KEYBUF, a buffer of size BUFSIZE.
8438 Return the length of the key sequence stored.
8439 Return -1 if the user rejected a command menu.
8441 Echo starting immediately unless `prompt' is 0.
8443 Where a key sequence ends depends on the currently active keymaps.
8444 These include any minor mode keymaps active in the current buffer,
8445 the current buffer's local map, and the global map.
8447 If a key sequence has no other bindings, we check Vfunction_key_map
8448 to see if some trailing subsequence might be the beginning of a
8449 function key's sequence. If so, we try to read the whole function
8450 key, and substitute its symbolic name into the key sequence.
8452 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8453 `double-' events into similar click events, if that would make them
8454 bound. We try to turn `triple-' events first into `double-' events,
8457 If we get a mouse click in a mode line, vertical divider, or other
8458 non-text area, we treat the click as if it were prefixed by the
8459 symbol denoting that area - `mode-line', `vertical-line', or
8462 If the sequence starts with a mouse click, we read the key sequence
8463 with respect to the buffer clicked on, not the current buffer.
8465 If the user switches frames in the midst of a key sequence, we put
8466 off the switch-frame event until later; the next call to
8467 read_char will return it.
8469 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8470 from the selected window's buffer. */
8473 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8474 can_return_switch_frame
, fix_current_buffer
)
8475 Lisp_Object
*keybuf
;
8478 int dont_downcase_last
;
8479 int can_return_switch_frame
;
8480 int fix_current_buffer
;
8482 volatile Lisp_Object from_string
;
8483 volatile int count
= SPECPDL_INDEX ();
8485 /* How many keys there are in the current key sequence. */
8488 /* The length of the echo buffer when we started reading, and
8489 the length of this_command_keys when we started reading. */
8490 volatile int echo_start
;
8491 volatile int keys_start
;
8493 /* The number of keymaps we're scanning right now, and the number of
8494 keymaps we have allocated space for. */
8496 volatile int nmaps_allocated
= 0;
8498 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8499 the current keymaps. */
8500 Lisp_Object
*volatile defs
= NULL
;
8502 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8503 in the current keymaps, or nil where it is not a prefix. */
8504 Lisp_Object
*volatile submaps
= NULL
;
8506 /* The local map to start out with at start of key sequence. */
8507 volatile Lisp_Object orig_local_map
;
8509 /* The map from the `keymap' property to start out with at start of
8511 volatile Lisp_Object orig_keymap
;
8513 /* 1 if we have already considered switching to the local-map property
8514 of the place where a mouse click occurred. */
8515 volatile int localized_local_map
= 0;
8517 /* The index in defs[] of the first keymap that has a binding for
8518 this key sequence. In other words, the lowest i such that
8519 defs[i] is non-nil. */
8520 volatile int first_binding
;
8521 /* Index of the first key that has no binding.
8522 It is useless to try fkey.start larger than that. */
8523 volatile int first_unbound
;
8525 /* If t < mock_input, then KEYBUF[t] should be read as the next
8528 We use this to recover after recognizing a function key. Once we
8529 realize that a suffix of the current key sequence is actually a
8530 function key's escape sequence, we replace the suffix with the
8531 function key's binding from Vfunction_key_map. Now keybuf
8532 contains a new and different key sequence, so the echo area,
8533 this_command_keys, and the submaps and defs arrays are wrong. In
8534 this situation, we set mock_input to t, set t to 0, and jump to
8535 restart_sequence; the loop will read keys from keybuf up until
8536 mock_input, thus rebuilding the state; and then it will resume
8537 reading characters from the keyboard. */
8538 volatile int mock_input
= 0;
8540 /* If the sequence is unbound in submaps[], then
8541 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8542 and fkey.map is its binding.
8544 These might be > t, indicating that all function key scanning
8545 should hold off until t reaches them. We do this when we've just
8546 recognized a function key, to avoid searching for the function
8547 key's again in Vfunction_key_map. */
8548 volatile keyremap fkey
;
8550 /* Likewise, for key_translation_map. */
8551 volatile keyremap keytran
;
8553 /* If we receive a `switch-frame' or `select-window' event in the middle of
8554 a key sequence, we put it off for later.
8555 While we're reading, we keep the event here. */
8556 volatile Lisp_Object delayed_switch_frame
;
8558 /* See the comment below... */
8559 #if defined (GOBBLE_FIRST_EVENT)
8560 Lisp_Object first_event
;
8563 volatile Lisp_Object original_uppercase
;
8564 volatile int original_uppercase_position
= -1;
8566 /* Gets around Microsoft compiler limitations. */
8569 struct buffer
*starting_buffer
;
8571 /* List of events for which a fake prefix key has been generated. */
8572 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8574 #if defined (GOBBLE_FIRST_EVENT)
8578 struct gcpro gcpro1
;
8580 GCPRO1 (fake_prefixed_keys
);
8581 raw_keybuf_count
= 0;
8583 last_nonmenu_event
= Qnil
;
8585 delayed_switch_frame
= Qnil
;
8586 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8587 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8588 /* If there is no translation-map, turn off scanning. */
8589 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8590 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8595 echo_prompt (prompt
);
8596 else if (cursor_in_echo_area
8597 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8598 && NILP (Fzerop (Vecho_keystrokes
)))
8599 /* This doesn't put in a dash if the echo buffer is empty, so
8600 you don't always see a dash hanging out in the minibuffer. */
8604 /* Record the initial state of the echo area and this_command_keys;
8605 we will need to restore them if we replay a key sequence. */
8607 echo_start
= echo_length ();
8608 keys_start
= this_command_key_count
;
8609 this_single_command_key_start
= keys_start
;
8611 #if defined (GOBBLE_FIRST_EVENT)
8612 /* This doesn't quite work, because some of the things that read_char
8613 does cannot safely be bypassed. It seems too risky to try to make
8616 /* Read the first char of the sequence specially, before setting
8617 up any keymaps, in case a filter runs and switches buffers on us. */
8618 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8620 #endif /* GOBBLE_FIRST_EVENT */
8622 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8623 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8626 /* We jump here when the key sequence has been thoroughly changed, and
8627 we need to rescan it starting from the beginning. When we jump here,
8628 keybuf[0..mock_input] holds the sequence we should reread. */
8631 starting_buffer
= current_buffer
;
8632 first_unbound
= bufsize
+ 1;
8634 /* Build our list of keymaps.
8635 If we recognize a function key and replace its escape sequence in
8636 keybuf with its symbol, or if the sequence starts with a mouse
8637 click and we need to switch buffers, we jump back here to rebuild
8638 the initial keymaps from the current buffer. */
8641 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8642 || !NILP (Voverriding_local_map
))
8644 if (3 > nmaps_allocated
)
8646 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8647 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8648 nmaps_allocated
= 3;
8650 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8651 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8652 if (!NILP (Voverriding_local_map
))
8653 submaps
[nmaps
++] = Voverriding_local_map
;
8661 nminor
= current_minor_maps (0, &maps
);
8662 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8664 if (total
> nmaps_allocated
)
8666 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8667 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8668 nmaps_allocated
= total
;
8671 if (!NILP (orig_keymap
))
8672 submaps
[nmaps
++] = orig_keymap
;
8674 bcopy (maps
, (void *) (submaps
+ nmaps
),
8675 nminor
* sizeof (submaps
[0]));
8679 submaps
[nmaps
++] = orig_local_map
;
8681 submaps
[nmaps
++] = current_global_map
;
8683 /* Find an accurate initial value for first_binding. */
8684 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8685 if (! NILP (submaps
[first_binding
]))
8688 /* Start from the beginning in keybuf. */
8691 /* These are no-ops the first time through, but if we restart, they
8692 revert the echo area and this_command_keys to their original state. */
8693 this_command_key_count
= keys_start
;
8694 if (INTERACTIVE
&& t
< mock_input
)
8695 echo_truncate (echo_start
);
8697 /* If the best binding for the current key sequence is a keymap, or
8698 we may be looking at a function key's escape sequence, keep on
8700 while (first_binding
< nmaps
8701 /* Keep reading as long as there's a prefix binding. */
8702 ? !NILP (submaps
[first_binding
])
8703 /* Don't return in the middle of a possible function key sequence,
8704 if the only bindings we found were via case conversion.
8705 Thus, if ESC O a has a function-key-map translation
8706 and ESC o has a binding, don't return after ESC O,
8707 so that we can translate ESC O plus the next character. */
8708 : (fkey
.start
< t
|| keytran
.start
< t
))
8711 int used_mouse_menu
= 0;
8713 /* Where the last real key started. If we need to throw away a
8714 key that has expanded into more than one element of keybuf
8715 (say, a mouse click on the mode line which is being treated
8716 as [mode-line (mouse-...)], then we backtrack to this point
8718 volatile int last_real_key_start
;
8720 /* These variables are analogous to echo_start and keys_start;
8721 while those allow us to restart the entire key sequence,
8722 echo_local_start and keys_local_start allow us to throw away
8724 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8726 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8727 eassert (fkey
.start
<= fkey
.end
);
8728 eassert (keytran
.start
<= keytran
.end
);
8729 /* key-translation-map is applied *after* function-key-map. */
8730 eassert (keytran
.end
<= fkey
.start
);
8732 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8733 { /* The prefix upto first_unbound has no binding and has
8734 no translation left to do either, so we know it's unbound.
8735 If we don't stop now, we risk staying here indefinitely
8736 (if the user keeps entering fkey or keytran prefixes
8737 like C-c ESC ESC ESC ESC ...) */
8739 for (i
= first_unbound
+ 1; i
< t
; i
++)
8740 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8741 mock_input
= t
- first_unbound
- 1;
8742 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8743 fkey
.map
= fkey
.parent
;
8744 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8745 keytran
.map
= keytran
.parent
;
8746 goto replay_sequence
;
8750 error ("Key sequence too long");
8753 echo_local_start
= echo_length ();
8754 keys_local_start
= this_command_key_count
;
8755 local_first_binding
= first_binding
;
8758 /* These are no-ops, unless we throw away a keystroke below and
8759 jumped back up to replay_key; in that case, these restore the
8760 variables to their original state, allowing us to replay the
8762 if (INTERACTIVE
&& t
< mock_input
)
8763 echo_truncate (echo_local_start
);
8764 this_command_key_count
= keys_local_start
;
8765 first_binding
= local_first_binding
;
8767 /* By default, assume each event is "real". */
8768 last_real_key_start
= t
;
8770 /* Does mock_input indicate that we are re-reading a key sequence? */
8774 add_command_key (key
);
8775 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8776 && NILP (Fzerop (Vecho_keystrokes
)))
8780 /* If not, we should actually read a character. */
8785 KBOARD
*interrupted_kboard
= current_kboard
;
8786 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8787 if (setjmp (wrong_kboard_jmpbuf
))
8789 if (!NILP (delayed_switch_frame
))
8791 interrupted_kboard
->kbd_queue
8792 = Fcons (delayed_switch_frame
,
8793 interrupted_kboard
->kbd_queue
);
8794 delayed_switch_frame
= Qnil
;
8797 interrupted_kboard
->kbd_queue
8798 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8800 /* If the side queue is non-empty, ensure it begins with a
8801 switch-frame, so we'll replay it in the right context. */
8802 if (CONSP (interrupted_kboard
->kbd_queue
)
8803 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8804 !(EVENT_HAS_PARAMETERS (key
)
8805 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8809 XSETFRAME (frame
, interrupted_frame
);
8810 interrupted_kboard
->kbd_queue
8811 = Fcons (make_lispy_switch_frame (frame
),
8812 interrupted_kboard
->kbd_queue
);
8815 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8816 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8817 goto replay_sequence
;
8820 key
= read_char (NILP (prompt
), nmaps
,
8821 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8825 /* read_char returns t when it shows a menu and the user rejects it.
8829 unbind_to (count
, Qnil
);
8834 /* read_char returns -1 at the end of a macro.
8835 Emacs 18 handles this by returning immediately with a
8836 zero, so that's what we'll do. */
8837 if (INTEGERP (key
) && XINT (key
) == -1)
8840 /* The Microsoft C compiler can't handle the goto that
8846 /* If the current buffer has been changed from under us, the
8847 keymap may have changed, so replay the sequence. */
8850 EMACS_TIME initial_idleness_start_time
;
8851 EMACS_SET_SECS_USECS (initial_idleness_start_time
,
8852 EMACS_SECS (timer_last_idleness_start_time
),
8853 EMACS_USECS (timer_last_idleness_start_time
));
8855 /* Resume idle state, using the same start-time as before. */
8856 timer_start_idle ();
8857 timer_idleness_start_time
= initial_idleness_start_time
;
8860 /* Reset the current buffer from the selected window
8861 in case something changed the former and not the latter.
8862 This is to be more consistent with the behavior
8863 of the command_loop_1. */
8864 if (fix_current_buffer
)
8866 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8868 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8869 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8872 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8873 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8874 goto replay_sequence
;
8877 /* If we have a quit that was typed in another frame, and
8878 quit_throw_to_read_char switched buffers,
8879 replay to get the right keymap. */
8881 && XINT (key
) == quit_char
8882 && current_buffer
!= starting_buffer
)
8885 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8889 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8890 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8891 goto replay_sequence
;
8896 if (EVENT_HAS_PARAMETERS (key
)
8897 /* Either a `switch-frame' or a `select-window' event. */
8898 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8900 /* If we're at the beginning of a key sequence, and the caller
8901 says it's okay, go ahead and return this event. If we're
8902 in the midst of a key sequence, delay it until the end. */
8903 if (t
> 0 || !can_return_switch_frame
)
8905 delayed_switch_frame
= key
;
8911 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8914 /* Clicks in non-text areas get prefixed by the symbol
8915 in their CHAR-ADDRESS field. For example, a click on
8916 the mode line is prefixed by the symbol `mode-line'.
8918 Furthermore, key sequences beginning with mouse clicks
8919 are read using the keymaps of the buffer clicked on, not
8920 the current buffer. So we may have to switch the buffer
8923 When we turn one event into two events, we must make sure
8924 that neither of the two looks like the original--so that,
8925 if we replay the events, they won't be expanded again.
8926 If not for this, such reexpansion could happen either here
8927 or when user programs play with this-command-keys. */
8928 if (EVENT_HAS_PARAMETERS (key
))
8933 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8934 if (EQ (kind
, Qmouse_click
))
8936 Lisp_Object window
, posn
;
8938 window
= POSN_WINDOW (EVENT_START (key
));
8939 posn
= POSN_POSN (EVENT_START (key
));
8942 || (!NILP (fake_prefixed_keys
)
8943 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8945 /* We're looking a second time at an event for which
8946 we generated a fake prefix key. Set
8947 last_real_key_start appropriately. */
8949 last_real_key_start
= t
- 1;
8952 /* Key sequences beginning with mouse clicks are
8953 read using the keymaps in the buffer clicked on,
8954 not the current buffer. If we're at the
8955 beginning of a key sequence, switch buffers. */
8956 if (last_real_key_start
== 0
8958 && BUFFERP (XWINDOW (window
)->buffer
)
8959 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8961 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8965 /* Arrange to go back to the original buffer once we're
8966 done reading the key sequence. Note that we can't
8967 use save_excursion_{save,restore} here, because they
8968 save point as well as the current buffer; we don't
8969 want to save point, because redisplay may change it,
8970 to accommodate a Fset_window_start or something. We
8971 don't want to do this at the top of the function,
8972 because we may get input from a subprocess which
8973 wants to change the selected window and stuff (say,
8975 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8977 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8979 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8980 orig_local_map
= get_local_map (PT
, current_buffer
,
8982 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8983 goto replay_sequence
;
8986 /* For a mouse click, get the local text-property keymap
8987 of the place clicked on, rather than point. */
8988 if (last_real_key_start
== 0
8989 && CONSP (XCDR (key
))
8990 && ! localized_local_map
)
8992 Lisp_Object map_here
, start
, pos
;
8994 localized_local_map
= 1;
8995 start
= EVENT_START (key
);
8997 if (CONSP (start
) && POSN_INBUFFER_P (start
))
8999 pos
= POSN_BUFFER_POSN (start
);
9001 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9003 map_here
= get_local_map (XINT (pos
),
9004 current_buffer
, Qlocal_map
);
9005 if (!EQ (map_here
, orig_local_map
))
9007 orig_local_map
= map_here
;
9011 goto replay_sequence
;
9013 map_here
= get_local_map (XINT (pos
),
9014 current_buffer
, Qkeymap
);
9015 if (!EQ (map_here
, orig_keymap
))
9017 orig_keymap
= map_here
;
9021 goto replay_sequence
;
9027 /* Expand mode-line and scroll-bar events into two events:
9028 use posn as a fake prefix key. */
9030 && (NILP (fake_prefixed_keys
)
9031 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9033 if (t
+ 1 >= bufsize
)
9034 error ("Key sequence too long");
9037 keybuf
[t
+ 1] = key
;
9040 /* Record that a fake prefix key has been generated
9041 for KEY. Don't modify the event; this would
9042 prevent proper action when the event is pushed
9043 back into unread-command-events. */
9044 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9046 /* If on a mode line string with a local keymap,
9047 reconsider the key sequence with that keymap. */
9048 if (string
= POSN_STRING (EVENT_START (key
)),
9049 (CONSP (string
) && STRINGP (XCAR (string
))))
9051 Lisp_Object pos
, map
, map2
;
9053 pos
= XCDR (string
);
9054 string
= XCAR (string
);
9056 && XINT (pos
) < SCHARS (string
))
9058 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9060 orig_local_map
= map
;
9061 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9064 if (!NILP (map
) || !NILP (map2
))
9065 goto replay_sequence
;
9071 else if (NILP (from_string
)
9072 && (string
= POSN_STRING (EVENT_START (key
)),
9073 (CONSP (string
) && STRINGP (XCAR (string
)))))
9075 /* For a click on a string, i.e. overlay string or a
9076 string displayed via the `display' property,
9077 consider `local-map' and `keymap' properties of
9079 Lisp_Object pos
, map
, map2
;
9081 pos
= XCDR (string
);
9082 string
= XCAR (string
);
9084 && XINT (pos
) < SCHARS (string
))
9086 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9088 orig_local_map
= map
;
9089 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9093 if (!NILP (map
) || !NILP (map2
))
9095 from_string
= string
;
9096 goto replay_sequence
;
9101 else if (CONSP (XCDR (key
))
9102 && CONSP (EVENT_START (key
))
9103 && CONSP (XCDR (EVENT_START (key
))))
9107 posn
= POSN_POSN (EVENT_START (key
));
9108 /* Handle menu-bar events:
9109 insert the dummy prefix event `menu-bar'. */
9110 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9112 if (t
+ 1 >= bufsize
)
9113 error ("Key sequence too long");
9117 /* Zap the position in key, so we know that we've
9118 expanded it, and don't try to do so again. */
9119 POSN_SET_POSN (EVENT_START (key
),
9120 Fcons (posn
, Qnil
));
9123 goto replay_sequence
;
9125 else if (CONSP (posn
))
9127 /* We're looking at the second event of a
9128 sequence which we expanded before. Set
9129 last_real_key_start appropriately. */
9130 if (last_real_key_start
== t
&& t
> 0)
9131 last_real_key_start
= t
- 1;
9136 /* We have finally decided that KEY is something we might want
9138 first_binding
= (follow_key (key
,
9139 nmaps
- first_binding
,
9140 submaps
+ first_binding
,
9141 defs
+ first_binding
,
9142 submaps
+ first_binding
)
9145 /* If KEY wasn't bound, we'll try some fallbacks. */
9146 if (first_binding
< nmaps
)
9147 /* This is needed for the following scenario:
9148 event 0: a down-event that gets dropped by calling replay_key.
9149 event 1: some normal prefix like C-h.
9150 After event 0, first_unbound is 0, after event 1 fkey.start
9151 and keytran.start are both 1, so when we see that C-h is bound,
9152 we need to update first_unbound. */
9153 first_unbound
= max (t
+ 1, first_unbound
);
9158 /* Remember the position to put an upper bound on fkey.start. */
9159 first_unbound
= min (t
, first_unbound
);
9161 head
= EVENT_HEAD (key
);
9162 if (help_char_p (head
) && t
> 0)
9164 read_key_sequence_cmd
= Vprefix_help_command
;
9166 last_nonmenu_event
= key
;
9167 /* The Microsoft C compiler can't handle the goto that
9175 Lisp_Object breakdown
;
9178 breakdown
= parse_modifiers (head
);
9179 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9180 /* Attempt to reduce an unbound mouse event to a simpler
9181 event that is bound:
9182 Drags reduce to clicks.
9183 Double-clicks reduce to clicks.
9184 Triple-clicks reduce to double-clicks, then to clicks.
9185 Down-clicks are eliminated.
9186 Double-downs reduce to downs, then are eliminated.
9187 Triple-downs reduce to double-downs, then to downs,
9188 then are eliminated. */
9189 if (modifiers
& (down_modifier
| drag_modifier
9190 | double_modifier
| triple_modifier
))
9192 while (modifiers
& (down_modifier
| drag_modifier
9193 | double_modifier
| triple_modifier
))
9195 Lisp_Object new_head
, new_click
;
9196 if (modifiers
& triple_modifier
)
9197 modifiers
^= (double_modifier
| triple_modifier
);
9198 else if (modifiers
& double_modifier
)
9199 modifiers
&= ~double_modifier
;
9200 else if (modifiers
& drag_modifier
)
9201 modifiers
&= ~drag_modifier
;
9204 /* Dispose of this `down' event by simply jumping
9205 back to replay_key, to get another event.
9207 Note that if this event came from mock input,
9208 then just jumping back to replay_key will just
9209 hand it to us again. So we have to wipe out any
9212 We could delete keybuf[t] and shift everything
9213 after that to the left by one spot, but we'd also
9214 have to fix up any variable that points into
9215 keybuf, and shifting isn't really necessary
9218 Adding prefixes for non-textual mouse clicks
9219 creates two characters of mock input, and both
9220 must be thrown away. If we're only looking at
9221 the prefix now, we can just jump back to
9222 replay_key. On the other hand, if we've already
9223 processed the prefix, and now the actual click
9224 itself is giving us trouble, then we've lost the
9225 state of the keymaps we want to backtrack to, and
9226 we need to replay the whole sequence to rebuild
9229 Beyond that, only function key expansion could
9230 create more than two keys, but that should never
9231 generate mouse events, so it's okay to zero
9232 mock_input in that case too.
9234 FIXME: The above paragraph seems just plain
9235 wrong, if you consider things like
9236 xterm-mouse-mode. -stef
9238 Isn't this just the most wonderful code ever? */
9240 /* If mock_input > t + 1, the above simplification
9241 will actually end up dropping keys on the floor.
9242 This is probably OK for now, but even
9243 if mock_input <= t + 1, we need to adjust fkey
9245 Typical case [header-line down-mouse-N]:
9246 mock_input = 2, t = 1, fkey.end = 1,
9247 last_real_key_start = 0. */
9248 if (fkey
.end
> last_real_key_start
)
9250 fkey
.end
= fkey
.start
9251 = min (last_real_key_start
, fkey
.start
);
9252 fkey
.map
= fkey
.parent
;
9253 if (keytran
.end
> last_real_key_start
)
9255 keytran
.end
= keytran
.start
9256 = min (last_real_key_start
, keytran
.start
);
9257 keytran
.map
= keytran
.parent
;
9260 if (t
== last_real_key_start
)
9267 mock_input
= last_real_key_start
;
9268 goto replay_sequence
;
9273 = apply_modifiers (modifiers
, XCAR (breakdown
));
9275 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9277 /* Look for a binding for this new key. follow_key
9278 promises that it didn't munge submaps the
9279 last time we called it, since key was unbound. */
9281 = (follow_key (new_click
,
9282 nmaps
- local_first_binding
,
9283 submaps
+ local_first_binding
,
9284 defs
+ local_first_binding
,
9285 submaps
+ local_first_binding
)
9286 + local_first_binding
);
9288 /* If that click is bound, go for it. */
9289 if (first_binding
< nmaps
)
9294 /* Otherwise, we'll leave key set to the drag event. */
9301 /* Normally, last_nonmenu_event gets the previous key we read.
9302 But when a mouse popup menu is being used,
9303 we don't update last_nonmenu_event; it continues to hold the mouse
9304 event that preceded the first level of menu. */
9305 if (!used_mouse_menu
)
9306 last_nonmenu_event
= key
;
9308 /* Record what part of this_command_keys is the current key sequence. */
9309 this_single_command_key_start
= this_command_key_count
- t
;
9311 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9312 /* There is a binding and it's not a prefix.
9313 There is thus no function-key in this sequence.
9314 Moving fkey.start is important in this case to allow keytran.start
9315 to go over the sequence before we return (since we keep the
9316 invariant that keytran.end <= fkey.start). */
9319 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9322 /* If the sequence is unbound, see if we can hang a function key
9323 off the end of it. */
9324 /* Continue scan from fkey.end until we find a bound suffix. */
9325 while (fkey
.end
< t
)
9327 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9330 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9331 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9332 max (t
, mock_input
),
9333 /* If there's a binding (i.e.
9334 first_binding >= nmaps) we don't want
9335 to apply this function-key-mapping. */
9336 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9341 mock_input
= diff
+ max (t
, mock_input
);
9342 goto replay_sequence
;
9346 /* Look for this sequence in key-translation-map.
9347 Scan from keytran.end until we find a bound suffix. */
9348 while (keytran
.end
< fkey
.start
)
9350 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9353 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9354 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9359 mock_input
= diff
+ max (t
, mock_input
);
9360 /* Adjust the function-key-map counters. */
9364 goto replay_sequence
;
9368 /* If KEY is not defined in any of the keymaps,
9369 and cannot be part of a function key or translation,
9370 and is an upper case letter
9371 use the corresponding lower-case letter instead. */
9372 if (first_binding
>= nmaps
9373 && fkey
.start
>= t
&& keytran
.start
>= t
9375 && ((((XINT (key
) & 0x3ffff)
9376 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9377 && UPPERCASEP (XINT (key
) & 0x3ffff))
9378 || (XINT (key
) & shift_modifier
)))
9380 Lisp_Object new_key
;
9382 original_uppercase
= key
;
9383 original_uppercase_position
= t
- 1;
9385 if (XINT (key
) & shift_modifier
)
9386 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9388 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9389 | (XINT (key
) & ~0x3ffff)));
9391 /* We have to do this unconditionally, regardless of whether
9392 the lower-case char is defined in the keymaps, because they
9393 might get translated through function-key-map. */
9394 keybuf
[t
- 1] = new_key
;
9395 mock_input
= max (t
, mock_input
);
9397 goto replay_sequence
;
9399 /* If KEY is not defined in any of the keymaps,
9400 and cannot be part of a function key or translation,
9401 and is a shifted function key,
9402 use the corresponding unshifted function key instead. */
9403 if (first_binding
>= nmaps
9404 && fkey
.start
>= t
&& keytran
.start
>= t
9407 Lisp_Object breakdown
;
9410 breakdown
= parse_modifiers (key
);
9411 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9412 if (modifiers
& shift_modifier
)
9414 Lisp_Object new_key
;
9416 original_uppercase
= key
;
9417 original_uppercase_position
= t
- 1;
9419 modifiers
&= ~shift_modifier
;
9420 new_key
= apply_modifiers (modifiers
,
9423 keybuf
[t
- 1] = new_key
;
9424 mock_input
= max (t
, mock_input
);
9425 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9426 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9428 goto replay_sequence
;
9434 read_key_sequence_cmd
= (first_binding
< nmaps
9435 ? defs
[first_binding
]
9438 unread_switch_frame
= delayed_switch_frame
;
9439 unbind_to (count
, Qnil
);
9441 /* Don't downcase the last character if the caller says don't.
9442 Don't downcase it if the result is undefined, either. */
9443 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9444 && t
- 1 == original_uppercase_position
)
9445 keybuf
[t
- 1] = original_uppercase
;
9447 /* Occasionally we fabricate events, perhaps by expanding something
9448 according to function-key-map, or by adding a prefix symbol to a
9449 mouse click in the scroll bar or modeline. In this cases, return
9450 the entire generated key sequence, even if we hit an unbound
9451 prefix or a definition before the end. This means that you will
9452 be able to push back the event properly, and also means that
9453 read-key-sequence will always return a logical unit.
9456 for (; t
< mock_input
; t
++)
9458 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9459 && NILP (Fzerop (Vecho_keystrokes
)))
9460 echo_char (keybuf
[t
]);
9461 add_command_key (keybuf
[t
]);
9470 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9471 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9472 The sequence is sufficient to specify a non-prefix command in the
9473 current local and global maps.
9475 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9476 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9477 as a continuation of the previous key.
9479 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9480 convert the last event to lower case. (Normally any upper case event
9481 is converted to lower case if the original event is undefined and the lower
9482 case equivalent is defined.) A non-nil value is appropriate for reading
9483 a key sequence to be defined.
9485 A C-g typed while in this function is treated like any other character,
9486 and `quit-flag' is not set.
9488 If the key sequence starts with a mouse click, then the sequence is read
9489 using the keymaps of the buffer of the window clicked in, not the buffer
9490 of the selected window as normal.
9492 `read-key-sequence' drops unbound button-down events, since you normally
9493 only care about the click or drag events which follow them. If a drag
9494 or multi-click event is unbound, but the corresponding click event would
9495 be bound, `read-key-sequence' turns the event into a click event at the
9496 drag's starting position. This means that you don't have to distinguish
9497 between click and drag, double, or triple events unless you want to.
9499 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9500 lines separating windows, and scroll bars with imaginary keys
9501 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9503 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9504 function will process a switch-frame event if the user switches frames
9505 before typing anything. If the user switches frames in the middle of a
9506 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9507 is nil, then the event will be put off until after the current key sequence.
9509 `read-key-sequence' checks `function-key-map' for function key
9510 sequences, where they wouldn't conflict with ordinary bindings. See
9511 `function-key-map' for more details.
9513 The optional fifth argument COMMAND-LOOP, if non-nil, means
9514 that this key sequence is being read by something that will
9515 read commands one after another. It should be nil if the caller
9516 will read just one key sequence. */)
9517 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9519 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9520 Lisp_Object can_return_switch_frame
, command_loop
;
9522 Lisp_Object keybuf
[30];
9524 struct gcpro gcpro1
;
9525 int count
= SPECPDL_INDEX ();
9528 CHECK_STRING (prompt
);
9531 specbind (Qinput_method_exit_on_first_char
,
9532 (NILP (command_loop
) ? Qt
: Qnil
));
9533 specbind (Qinput_method_use_echo_area
,
9534 (NILP (command_loop
) ? Qt
: Qnil
));
9536 bzero (keybuf
, sizeof keybuf
);
9538 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9540 if (NILP (continue_echo
))
9542 this_command_key_count
= 0;
9543 this_command_key_count_reset
= 0;
9544 this_single_command_key_start
= 0;
9547 #ifdef HAVE_X_WINDOWS
9548 if (display_hourglass_p
)
9549 cancel_hourglass ();
9552 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9553 prompt
, ! NILP (dont_downcase_last
),
9554 ! NILP (can_return_switch_frame
), 0);
9556 #if 0 /* The following is fine for code reading a key sequence and
9557 then proceeding with a lenghty computation, but it's not good
9558 for code reading keys in a loop, like an input method. */
9559 #ifdef HAVE_X_WINDOWS
9560 if (display_hourglass_p
)
9571 return unbind_to (count
, make_event_array (i
, keybuf
));
9574 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9575 Sread_key_sequence_vector
, 1, 5, 0,
9576 doc
: /* Like `read-key-sequence' but always return a vector. */)
9577 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9579 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9580 Lisp_Object can_return_switch_frame
, command_loop
;
9582 Lisp_Object keybuf
[30];
9584 struct gcpro gcpro1
;
9585 int count
= SPECPDL_INDEX ();
9588 CHECK_STRING (prompt
);
9591 specbind (Qinput_method_exit_on_first_char
,
9592 (NILP (command_loop
) ? Qt
: Qnil
));
9593 specbind (Qinput_method_use_echo_area
,
9594 (NILP (command_loop
) ? Qt
: Qnil
));
9596 bzero (keybuf
, sizeof keybuf
);
9598 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9600 if (NILP (continue_echo
))
9602 this_command_key_count
= 0;
9603 this_command_key_count_reset
= 0;
9604 this_single_command_key_start
= 0;
9607 #ifdef HAVE_X_WINDOWS
9608 if (display_hourglass_p
)
9609 cancel_hourglass ();
9612 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9613 prompt
, ! NILP (dont_downcase_last
),
9614 ! NILP (can_return_switch_frame
), 0);
9616 #ifdef HAVE_X_WINDOWS
9617 if (display_hourglass_p
)
9627 return unbind_to (count
, Fvector (i
, keybuf
));
9630 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9631 doc
: /* Execute CMD as an editor command.
9632 CMD must be a symbol that satisfies the `commandp' predicate.
9633 Optional second arg RECORD-FLAG non-nil
9634 means unconditionally put this command in `command-history'.
9635 Otherwise, that is done only if an arg is read using the minibuffer.
9636 The argument KEYS specifies the value to use instead of (this-command-keys)
9637 when reading the arguments; if it is nil, (this-command-keys) is used.
9638 The argument SPECIAL, if non-nil, means that this command is executing
9639 a special event, so ignore the prefix argument and don't clear it. */)
9640 (cmd
, record_flag
, keys
, special
)
9641 Lisp_Object cmd
, record_flag
, keys
, special
;
9643 register Lisp_Object final
;
9644 register Lisp_Object tem
;
9645 Lisp_Object prefixarg
;
9646 struct backtrace backtrace
;
9647 extern int debug_on_next_call
;
9649 debug_on_next_call
= 0;
9653 prefixarg
= current_kboard
->Vprefix_arg
;
9654 Vcurrent_prefix_arg
= prefixarg
;
9655 current_kboard
->Vprefix_arg
= Qnil
;
9662 tem
= Fget (cmd
, Qdisabled
);
9663 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9665 tem
= Fsymbol_value (Qdisabled_command_function
);
9667 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9673 final
= Findirect_function (cmd
);
9675 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9677 struct gcpro gcpro1
, gcpro2
;
9679 GCPRO2 (cmd
, prefixarg
);
9680 do_autoload (final
, cmd
);
9687 if (STRINGP (final
) || VECTORP (final
))
9689 /* If requested, place the macro in the command history. For
9690 other sorts of commands, call-interactively takes care of
9692 if (!NILP (record_flag
))
9695 = Fcons (Fcons (Qexecute_kbd_macro
,
9696 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9699 /* Don't keep command history around forever. */
9700 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9702 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9704 XSETCDR (tem
, Qnil
);
9708 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9711 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9713 backtrace
.next
= backtrace_list
;
9714 backtrace_list
= &backtrace
;
9715 backtrace
.function
= &Qcall_interactively
;
9716 backtrace
.args
= &cmd
;
9717 backtrace
.nargs
= 1;
9718 backtrace
.evalargs
= 0;
9719 backtrace
.debug_on_exit
= 0;
9721 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9723 backtrace_list
= backtrace
.next
;
9731 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9733 doc
: /* Read function name, then read its arguments and call it. */)
9735 Lisp_Object prefixarg
;
9737 Lisp_Object function
;
9739 int saved_last_point_position
;
9740 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9741 Lisp_Object bindings
, value
;
9742 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9744 saved_keys
= Fvector (this_command_key_count
,
9745 XVECTOR (this_command_keys
)->contents
);
9746 saved_last_point_position_buffer
= last_point_position_buffer
;
9747 saved_last_point_position
= last_point_position
;
9749 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9751 if (EQ (prefixarg
, Qminus
))
9753 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9754 strcpy (buf
, "C-u ");
9755 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9756 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9757 else if (INTEGERP (prefixarg
))
9758 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9760 /* This isn't strictly correct if execute-extended-command
9761 is bound to anything else. Perhaps it should use
9762 this_command_keys? */
9763 strcat (buf
, "M-x ");
9765 /* Prompt with buf, and then read a string, completing from and
9766 restricting to the set of all defined commands. Don't provide
9767 any initial input. Save the command read on the extended-command
9769 function
= Fcompleting_read (build_string (buf
),
9770 Vobarray
, Qcommandp
,
9771 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9774 if (STRINGP (function
) && SCHARS (function
) == 0)
9775 error ("No command name given");
9777 /* Set this_command_keys to the concatenation of saved_keys and
9778 function, followed by a RET. */
9783 this_command_key_count
= 0;
9784 this_command_key_count_reset
= 0;
9785 this_single_command_key_start
= 0;
9787 keys
= XVECTOR (saved_keys
)->contents
;
9788 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9789 add_command_key (keys
[i
]);
9791 for (i
= 0; i
< SCHARS (function
); i
++)
9792 add_command_key (Faref (function
, make_number (i
)));
9794 add_command_key (make_number ('\015'));
9797 last_point_position
= saved_last_point_position
;
9798 last_point_position_buffer
= saved_last_point_position_buffer
;
9802 function
= Fintern (function
, Qnil
);
9803 current_kboard
->Vprefix_arg
= prefixarg
;
9804 Vthis_command
= function
;
9805 real_this_command
= function
;
9807 /* If enabled, show which key runs this command. */
9808 if (!NILP (Vsuggest_key_bindings
)
9809 && NILP (Vexecuting_macro
)
9810 && SYMBOLP (function
))
9811 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9817 GCPRO2 (bindings
, value
);
9818 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9820 /* If the command has a key binding, print it now. */
9821 if (!NILP (bindings
)
9822 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9825 /* But first wait, and skip the message if there is input. */
9827 if (!NILP (echo_area_buffer
[0]))
9828 /* This command displayed something in the echo area;
9829 so wait a few seconds, then display our suggestion message. */
9830 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9831 ? XINT (Vsuggest_key_bindings
) : 2);
9833 /* This command left the echo area empty,
9834 so display our message immediately. */
9837 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9838 && ! CONSP (Vunread_command_events
))
9840 Lisp_Object binding
;
9842 int message_p
= push_message ();
9843 int count
= SPECPDL_INDEX ();
9845 record_unwind_protect (pop_message_unwind
, Qnil
);
9846 binding
= Fkey_description (bindings
, Qnil
);
9849 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9852 sprintf (newmessage
, "You can run the command `%s' with %s",
9853 SDATA (SYMBOL_NAME (function
)),
9855 message2_nolog (newmessage
,
9856 strlen (newmessage
),
9857 STRING_MULTIBYTE (binding
));
9858 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9859 ? Vsuggest_key_bindings
: make_number (2)),
9864 unbind_to (count
, Qnil
);
9868 RETURN_UNGCPRO (value
);
9872 /* Return nonzero if input events are pending. */
9875 detect_input_pending ()
9878 get_input_pending (&input_pending
, 0);
9880 return input_pending
;
9883 /* Return nonzero if input events are pending, and run any pending timers. */
9886 detect_input_pending_run_timers (do_display
)
9889 int old_timers_run
= timers_run
;
9892 get_input_pending (&input_pending
, 1);
9894 if (old_timers_run
!= timers_run
&& do_display
)
9896 redisplay_preserve_echo_area (8);
9897 /* The following fixes a bug when using lazy-lock with
9898 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9899 from an idle timer function. The symptom of the bug is that
9900 the cursor sometimes doesn't become visible until the next X
9901 event is processed. --gerd. */
9903 rif
->flush_display (NULL
);
9906 return input_pending
;
9909 /* This is called in some cases before a possible quit.
9910 It cases the next call to detect_input_pending to recompute input_pending.
9911 So calling this function unnecessarily can't do any harm. */
9914 clear_input_pending ()
9919 /* Return nonzero if there are pending requeued events.
9920 This isn't used yet. The hope is to make wait_reading_process_output
9921 call it, and return if it runs Lisp code that unreads something.
9922 The problem is, kbd_buffer_get_event needs to be fixed to know what
9923 to do in that case. It isn't trivial. */
9926 requeued_events_pending_p ()
9928 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9932 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9933 doc
: /* Return t if command input is currently available with no wait.
9934 Actually, the value is nil only if we can be sure that no input is available;
9935 if there is a doubt, the value is t. */)
9938 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9941 get_filtered_input_pending (&input_pending
, 1, 1);
9942 return input_pending
> 0 ? Qt
: Qnil
;
9945 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9946 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9949 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9952 if (total_keys
< NUM_RECENT_KEYS
)
9953 return Fvector (total_keys
, keys
);
9956 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9957 bcopy (keys
+ recent_keys_index
,
9958 XVECTOR (val
)->contents
,
9959 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9961 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9962 recent_keys_index
* sizeof (Lisp_Object
));
9967 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9968 doc
: /* Return the key sequence that invoked this command.
9969 However, if the command has called `read-key-sequence', it returns
9970 the last key sequence that has been read.
9971 The value is a string or a vector. */)
9974 return make_event_array (this_command_key_count
,
9975 XVECTOR (this_command_keys
)->contents
);
9978 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9979 doc
: /* Return the key sequence that invoked this command, as a vector.
9980 However, if the command has called `read-key-sequence', it returns
9981 the last key sequence that has been read. */)
9984 return Fvector (this_command_key_count
,
9985 XVECTOR (this_command_keys
)->contents
);
9988 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9989 Sthis_single_command_keys
, 0, 0, 0,
9990 doc
: /* Return the key sequence that invoked this command.
9991 More generally, it returns the last key sequence read, either by
9992 the command loop or by `read-key-sequence'.
9993 Unlike `this-command-keys', this function's value
9994 does not include prefix arguments.
9995 The value is always a vector. */)
9998 return Fvector (this_command_key_count
9999 - this_single_command_key_start
,
10000 (XVECTOR (this_command_keys
)->contents
10001 + this_single_command_key_start
));
10004 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10005 Sthis_single_command_raw_keys
, 0, 0, 0,
10006 doc
: /* Return the raw events that were read for this command.
10007 More generally, it returns the last key sequence read, either by
10008 the command loop or by `read-key-sequence'.
10009 Unlike `this-single-command-keys', this function's value
10010 shows the events before all translations (except for input methods).
10011 The value is always a vector. */)
10014 return Fvector (raw_keybuf_count
,
10015 (XVECTOR (raw_keybuf
)->contents
));
10018 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10019 Sreset_this_command_lengths
, 0, 0, 0,
10020 doc
: /* Make the unread events replace the last command and echo.
10021 Used in `universal-argument-other-key'.
10023 `universal-argument-other-key' rereads the event just typed.
10024 It then gets translated through `function-key-map'.
10025 The translated event has to replace the real events,
10026 both in the value of (this-command-keys) and in echoing.
10027 To achieve this, `universal-argument-other-key' calls
10028 `reset-this-command-lengths', which discards the record of reading
10029 these events the first time. */)
10032 this_command_key_count
= before_command_key_count
;
10033 if (this_command_key_count
< this_single_command_key_start
)
10034 this_single_command_key_start
= this_command_key_count
;
10036 echo_truncate (before_command_echo_length
);
10038 /* Cause whatever we put into unread-command-events
10039 to echo as if it were being freshly read from the keyboard. */
10040 this_command_key_count_reset
= 1;
10045 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10046 Sclear_this_command_keys
, 0, 1, 0,
10047 doc
: /* Clear out the vector that `this-command-keys' returns.
10048 Also clear the record of the last 100 events, unless optional arg
10049 KEEP-RECORD is non-nil. */)
10051 Lisp_Object keep_record
;
10055 this_command_key_count
= 0;
10056 this_command_key_count_reset
= 0;
10058 if (NILP (keep_record
))
10060 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10061 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10063 recent_keys_index
= 0;
10068 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10069 doc
: /* Return the current depth in recursive edits. */)
10073 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10077 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10078 "FOpen dribble file: ",
10079 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10080 If FILE is nil, close any open dribble file. */)
10091 file
= Fexpand_file_name (file
, Qnil
);
10092 dribble
= fopen (SDATA (file
), "w");
10094 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10099 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10100 doc
: /* Discard the contents of the terminal input buffer.
10101 Also end any kbd macro being defined. */)
10104 if (!NILP (current_kboard
->defining_kbd_macro
))
10106 /* Discard the last command from the macro. */
10107 Fcancel_kbd_macro_events ();
10111 update_mode_lines
++;
10113 Vunread_command_events
= Qnil
;
10114 unread_command_char
= -1;
10116 discard_tty_input ();
10118 kbd_fetch_ptr
= kbd_store_ptr
;
10124 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10125 doc
: /* Stop Emacs and return to superior process. You can resume later.
10126 If `cannot-suspend' is non-nil, or if the system doesn't support job
10127 control, run a subshell instead.
10129 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10130 to be read as terminal input by Emacs's parent, after suspension.
10132 Before suspending, run the normal hook `suspend-hook'.
10133 After resumption run the normal hook `suspend-resume-hook'.
10135 Some operating systems cannot stop the Emacs process and resume it later.
10136 On such systems, Emacs starts a subshell instead of suspending. */)
10138 Lisp_Object stuffstring
;
10140 int count
= SPECPDL_INDEX ();
10141 int old_height
, old_width
;
10143 struct gcpro gcpro1
;
10145 if (!NILP (stuffstring
))
10146 CHECK_STRING (stuffstring
);
10148 /* Run the functions in suspend-hook. */
10149 if (!NILP (Vrun_hooks
))
10150 call1 (Vrun_hooks
, intern ("suspend-hook"));
10152 GCPRO1 (stuffstring
);
10153 get_frame_size (&old_width
, &old_height
);
10154 reset_sys_modes ();
10155 /* sys_suspend can get an error if it tries to fork a subshell
10156 and the system resources aren't available for that. */
10157 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10159 stuff_buffered_input (stuffstring
);
10160 if (cannot_suspend
)
10164 unbind_to (count
, Qnil
);
10166 /* Check if terminal/window size has changed.
10167 Note that this is not useful when we are running directly
10168 with a window system; but suspend should be disabled in that case. */
10169 get_frame_size (&width
, &height
);
10170 if (width
!= old_width
|| height
!= old_height
)
10171 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10173 /* Run suspend-resume-hook. */
10174 if (!NILP (Vrun_hooks
))
10175 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10181 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10182 Then in any case stuff anything Emacs has read ahead and not used. */
10185 stuff_buffered_input (stuffstring
)
10186 Lisp_Object stuffstring
;
10188 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10189 register unsigned char *p
;
10191 if (STRINGP (stuffstring
))
10193 register int count
;
10195 p
= SDATA (stuffstring
);
10196 count
= SBYTES (stuffstring
);
10197 while (count
-- > 0)
10202 /* Anything we have read ahead, put back for the shell to read. */
10203 /* ?? What should this do when we have multiple keyboards??
10204 Should we ignore anything that was typed in at the "wrong" kboard?
10206 rms: we should stuff everything back into the kboard
10208 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10211 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10212 kbd_fetch_ptr
= kbd_buffer
;
10213 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10214 stuff_char (kbd_fetch_ptr
->code
);
10216 clear_event (kbd_fetch_ptr
);
10220 #endif /* SIGTSTP */
10224 set_waiting_for_input (time_to_clear
)
10225 EMACS_TIME
*time_to_clear
;
10227 input_available_clear_time
= time_to_clear
;
10229 /* Tell interrupt_signal to throw back to read_char, */
10230 waiting_for_input
= 1;
10232 /* If interrupt_signal was called before and buffered a C-g,
10233 make it run again now, to avoid timing error. */
10234 if (!NILP (Vquit_flag
))
10235 quit_throw_to_read_char ();
10239 clear_waiting_for_input ()
10241 /* Tell interrupt_signal not to throw back to read_char, */
10242 waiting_for_input
= 0;
10243 input_available_clear_time
= 0;
10246 /* This routine is called at interrupt level in response to C-g.
10248 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10249 is called from kbd_buffer_store_event, in handling SIGIO or
10252 If `waiting_for_input' is non zero, then unless `echoing' is
10253 nonzero, immediately throw back to read_char.
10255 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10256 eval to throw, when it gets a chance. If quit-flag is already
10257 non-nil, it stops the job right away. */
10260 interrupt_signal (signalnum
) /* If we don't have an argument, */
10261 int signalnum
; /* some compilers complain in signal calls. */
10264 /* Must preserve main program's value of errno. */
10265 int old_errno
= errno
;
10266 struct frame
*sf
= SELECTED_FRAME ();
10268 #if defined (USG) && !defined (POSIX_SIGNALS)
10269 if (!read_socket_hook
&& NILP (Vwindow_system
))
10271 /* USG systems forget handlers when they are used;
10272 must reestablish each time */
10273 signal (SIGINT
, interrupt_signal
);
10274 signal (SIGQUIT
, interrupt_signal
);
10280 if (!NILP (Vquit_flag
)
10281 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10283 /* If SIGINT isn't blocked, don't let us be interrupted by
10284 another SIGINT, it might be harmful due to non-reentrancy
10285 in I/O functions. */
10286 sigblock (sigmask (SIGINT
));
10289 reset_sys_modes ();
10291 #ifdef SIGTSTP /* Support possible in later USG versions */
10293 * On systems which can suspend the current process and return to the original
10294 * shell, this command causes the user to end up back at the shell.
10295 * The "Auto-save" and "Abort" questions are not asked until
10296 * the user elects to return to emacs, at which point he can save the current
10297 * job and either dump core or continue.
10302 if (sys_suspend () == -1)
10304 printf ("Not running as a subprocess;\n");
10305 printf ("you can continue or abort.\n");
10307 #else /* not VMS */
10308 /* Perhaps should really fork an inferior shell?
10309 But that would not provide any way to get back
10310 to the original shell, ever. */
10311 printf ("No support for stopping a process on this operating system;\n");
10312 printf ("you can continue or abort.\n");
10313 #endif /* not VMS */
10314 #endif /* not SIGTSTP */
10316 /* We must remain inside the screen area when the internal terminal
10317 is used. Note that [Enter] is not echoed by dos. */
10320 /* It doesn't work to autosave while GC is in progress;
10321 the code used for auto-saving doesn't cope with the mark bit. */
10322 if (!gc_in_progress
)
10324 printf ("Auto-save? (y or n) ");
10326 if (((c
= getchar ()) & ~040) == 'Y')
10328 Fdo_auto_save (Qt
, Qnil
);
10330 printf ("\r\nAuto-save done");
10331 #else /* not MSDOS */
10332 printf ("Auto-save done\n");
10333 #endif /* not MSDOS */
10335 while (c
!= '\n') c
= getchar ();
10339 /* During GC, it must be safe to reenable quitting again. */
10340 Vinhibit_quit
= Qnil
;
10343 #endif /* not MSDOS */
10344 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10345 printf ("but will instead do a real quit after garbage collection ends\r\n");
10350 printf ("\r\nAbort? (y or n) ");
10351 #else /* not MSDOS */
10353 printf ("Abort (and enter debugger)? (y or n) ");
10354 #else /* not VMS */
10355 printf ("Abort (and dump core)? (y or n) ");
10356 #endif /* not VMS */
10357 #endif /* not MSDOS */
10359 if (((c
= getchar ()) & ~040) == 'Y')
10361 while (c
!= '\n') c
= getchar ();
10363 printf ("\r\nContinuing...\r\n");
10364 #else /* not MSDOS */
10365 printf ("Continuing...\n");
10366 #endif /* not MSDOS */
10373 /* If executing a function that wants to be interrupted out of
10374 and the user has not deferred quitting by binding `inhibit-quit'
10375 then quit right away. */
10376 if (immediate_quit
&& NILP (Vinhibit_quit
))
10378 struct gl_state_s saved
;
10379 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10381 immediate_quit
= 0;
10384 GCPRO4 (saved
.object
, saved
.global_code
,
10385 saved
.current_syntax_table
, saved
.old_prop
);
10386 Fsignal (Qquit
, Qnil
);
10391 /* Else request quit when it's safe */
10395 if (waiting_for_input
&& !echoing
)
10396 quit_throw_to_read_char ();
10401 /* Handle a C-g by making read_char return C-g. */
10404 quit_throw_to_read_char ()
10407 /* Prevent another signal from doing this before we finish. */
10408 clear_waiting_for_input ();
10411 Vunread_command_events
= Qnil
;
10412 unread_command_char
= -1;
10414 #if 0 /* Currently, sit_for is called from read_char without turning
10415 off polling. And that can call set_waiting_for_input.
10416 It seems to be harmless. */
10417 #ifdef POLL_FOR_INPUT
10418 /* May be > 1 if in recursive minibuffer. */
10419 if (poll_suppress_count
== 0)
10423 if (FRAMEP (internal_last_event_frame
)
10424 && !EQ (internal_last_event_frame
, selected_frame
))
10425 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10428 _longjmp (getcjmp
, 1);
10431 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10432 doc
: /* Set mode of reading keyboard input.
10433 First arg INTERRUPT non-nil means use input interrupts;
10434 nil means use CBREAK mode.
10435 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10436 (no effect except in CBREAK mode).
10437 Third arg META t means accept 8-bit input (for a Meta key).
10438 META nil means ignore the top bit, on the assumption it is parity.
10439 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10440 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10441 See also `current-input-mode'. */)
10442 (interrupt
, flow
, meta
, quit
)
10443 Lisp_Object interrupt
, flow
, meta
, quit
;
10446 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10447 error ("set-input-mode: QUIT must be an ASCII character");
10449 #ifdef POLL_FOR_INPUT
10454 /* this causes startup screen to be restored and messes with the mouse */
10455 reset_sys_modes ();
10459 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10460 if (read_socket_hook
)
10462 /* When using X, don't give the user a real choice,
10463 because we haven't implemented the mechanisms to support it. */
10464 #ifdef NO_SOCK_SIGIO
10465 interrupt_input
= 0;
10466 #else /* not NO_SOCK_SIGIO */
10467 interrupt_input
= 1;
10468 #endif /* NO_SOCK_SIGIO */
10471 interrupt_input
= !NILP (interrupt
);
10472 #else /* not SIGIO */
10473 interrupt_input
= 0;
10474 #endif /* not SIGIO */
10476 /* Our VMS input only works by interrupts, as of now. */
10478 interrupt_input
= 1;
10481 flow_control
= !NILP (flow
);
10484 else if (EQ (meta
, Qt
))
10489 /* Don't let this value be out of range. */
10490 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10496 #ifdef POLL_FOR_INPUT
10497 poll_suppress_count
= 1;
10503 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10504 doc
: /* Return information about the way Emacs currently reads keyboard input.
10505 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10506 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10507 nil, Emacs is using CBREAK mode.
10508 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10509 terminal; this does not apply if Emacs uses interrupt-driven input.
10510 META is t if accepting 8-bit input with 8th bit as Meta flag.
10511 META nil means ignoring the top bit, on the assumption it is parity.
10512 META is neither t nor nil if accepting 8-bit input and using
10513 all 8 bits as the character code.
10514 QUIT is the character Emacs currently uses to quit.
10515 The elements of this list correspond to the arguments of
10516 `set-input-mode'. */)
10519 Lisp_Object val
[4];
10521 val
[0] = interrupt_input
? Qt
: Qnil
;
10522 val
[1] = flow_control
? Qt
: Qnil
;
10523 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10524 XSETFASTINT (val
[3], quit_char
);
10526 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10529 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 3, 0,
10530 doc
: /* Return position information for pixel coordinates X and Y.
10531 By default, X and Y are relative to text area of the selected window.
10532 Optional third arg FRAME_OR_WINDOW non-nil specifies frame or window.
10534 The return value is similar to a mouse click position:
10535 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10536 IMAGE (DX . DY) (WIDTH . HEIGHT))
10537 The `posn-' functions access elements of such lists. */)
10538 (x
, y
, frame_or_window
)
10539 Lisp_Object x
, y
, frame_or_window
;
10541 if (NILP (frame_or_window
))
10542 frame_or_window
= selected_window
;
10544 if (WINDOWP (frame_or_window
))
10548 CHECK_LIVE_WINDOW (frame_or_window
);
10550 w
= XWINDOW (frame_or_window
);
10551 XSETINT (x
, (WINDOW_TO_FRAME_PIXEL_X (w
, XINT (x
))
10552 + window_box_left_offset (w
, TEXT_AREA
)));
10553 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10554 frame_or_window
= w
->frame
;
10557 CHECK_LIVE_FRAME (frame_or_window
);
10559 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10562 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10563 doc
: /* Return position information for buffer POS in WINDOW.
10564 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10566 Return nil if position is not visible in window. Otherwise,
10567 the return value is similar to that returned by `event-start' for
10568 a mouse click at the upper left corner of the glyph corresponding
10569 to the given buffer position:
10570 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10571 IMAGE (DX . DY) (WIDTH . HEIGHT))
10572 The `posn-' functions access elements of such lists. */*/
)
10574 Lisp_Object pos
, window
;
10578 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10580 tem
= Fposn_at_x_y (XCAR (tem
), XCAR (XCDR (tem
)), window
);
10586 * Set up a new kboard object with reasonable initial values.
10592 kb
->Voverriding_terminal_local_map
= Qnil
;
10593 kb
->Vlast_command
= Qnil
;
10594 kb
->Vreal_last_command
= Qnil
;
10595 kb
->Vprefix_arg
= Qnil
;
10596 kb
->Vlast_prefix_arg
= Qnil
;
10597 kb
->kbd_queue
= Qnil
;
10598 kb
->kbd_queue_has_data
= 0;
10599 kb
->immediate_echo
= 0;
10600 kb
->echo_string
= Qnil
;
10601 kb
->echo_after_prompt
= -1;
10602 kb
->kbd_macro_buffer
= 0;
10603 kb
->kbd_macro_bufsize
= 0;
10604 kb
->defining_kbd_macro
= Qnil
;
10605 kb
->Vlast_kbd_macro
= Qnil
;
10606 kb
->reference_count
= 0;
10607 kb
->Vsystem_key_alist
= Qnil
;
10608 kb
->system_key_syms
= Qnil
;
10609 kb
->Vdefault_minibuffer_frame
= Qnil
;
10613 * Destroy the contents of a kboard object, but not the object itself.
10614 * We use this just before deleting it, or if we're going to initialize
10615 * it a second time.
10621 if (kb
->kbd_macro_buffer
)
10622 xfree (kb
->kbd_macro_buffer
);
10625 #ifdef MULTI_KBOARD
10627 /* Free KB and memory referenced from it. */
10635 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10638 *kbp
= kb
->next_kboard
;
10640 /* Prevent a dangling reference to KB. */
10641 if (kb
== current_kboard
10642 && FRAMEP (selected_frame
)
10643 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10645 current_kboard
= XFRAME (selected_frame
)->kboard
;
10646 if (current_kboard
== kb
)
10654 #endif /* MULTI_KBOARD */
10659 /* This is correct before outermost invocation of the editor loop */
10660 command_loop_level
= -1;
10661 immediate_quit
= 0;
10662 quit_char
= Ctl ('g');
10663 Vunread_command_events
= Qnil
;
10664 unread_command_char
= -1;
10665 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10667 recent_keys_index
= 0;
10668 kbd_fetch_ptr
= kbd_buffer
;
10669 kbd_store_ptr
= kbd_buffer
;
10671 do_mouse_tracking
= Qnil
;
10675 /* This means that command_loop_1 won't try to select anything the first
10677 internal_last_event_frame
= Qnil
;
10678 Vlast_event_frame
= internal_last_event_frame
;
10680 #ifdef MULTI_KBOARD
10681 current_kboard
= initial_kboard
;
10683 wipe_kboard (current_kboard
);
10684 init_kboard (current_kboard
);
10686 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10688 signal (SIGINT
, interrupt_signal
);
10689 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10690 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10691 SIGQUIT and we can't tell which one it will give us. */
10692 signal (SIGQUIT
, interrupt_signal
);
10693 #endif /* HAVE_TERMIO */
10695 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10697 if (!noninteractive
)
10698 signal (SIGIO
, input_available_signal
);
10701 /* Use interrupt input by default, if it works and noninterrupt input
10702 has deficiencies. */
10704 #ifdef INTERRUPT_INPUT
10705 interrupt_input
= 1;
10707 interrupt_input
= 0;
10710 /* Our VMS input only works by interrupts, as of now. */
10712 interrupt_input
= 1;
10718 if (keyboard_init_hook
)
10719 (*keyboard_init_hook
) ();
10721 #ifdef POLL_FOR_INPUT
10722 poll_suppress_count
= 1;
10727 /* At least provide an escape route since C-g doesn't work. */
10728 signal (SIGINT
, interrupt_signal
);
10732 /* This type's only use is in syms_of_keyboard, to initialize the
10733 event header symbols and put properties on them. */
10734 struct event_head
{
10740 struct event_head head_table
[] = {
10741 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10742 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10743 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10744 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10745 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10746 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10747 /* `select-window' should be handled just like `switch-frame'
10748 in read_key_sequence. */
10749 {&Qselect_window
, "select-window", &Qswitch_frame
}
10753 syms_of_keyboard ()
10755 Vpre_help_message
= Qnil
;
10756 staticpro (&Vpre_help_message
);
10758 Vlispy_mouse_stem
= build_string ("mouse");
10759 staticpro (&Vlispy_mouse_stem
);
10762 QCimage
= intern (":image");
10763 staticpro (&QCimage
);
10765 staticpro (&Qhelp_echo
);
10766 Qhelp_echo
= intern ("help-echo");
10768 staticpro (&item_properties
);
10769 item_properties
= Qnil
;
10771 staticpro (&tool_bar_item_properties
);
10772 tool_bar_item_properties
= Qnil
;
10773 staticpro (&tool_bar_items_vector
);
10774 tool_bar_items_vector
= Qnil
;
10776 staticpro (&real_this_command
);
10777 real_this_command
= Qnil
;
10779 Qtimer_event_handler
= intern ("timer-event-handler");
10780 staticpro (&Qtimer_event_handler
);
10782 Qdisabled_command_function
= intern ("disabled-command-function");
10783 staticpro (&Qdisabled_command_function
);
10785 Qself_insert_command
= intern ("self-insert-command");
10786 staticpro (&Qself_insert_command
);
10788 Qforward_char
= intern ("forward-char");
10789 staticpro (&Qforward_char
);
10791 Qbackward_char
= intern ("backward-char");
10792 staticpro (&Qbackward_char
);
10794 Qdisabled
= intern ("disabled");
10795 staticpro (&Qdisabled
);
10797 Qundefined
= intern ("undefined");
10798 staticpro (&Qundefined
);
10800 Qpre_command_hook
= intern ("pre-command-hook");
10801 staticpro (&Qpre_command_hook
);
10803 Qpost_command_hook
= intern ("post-command-hook");
10804 staticpro (&Qpost_command_hook
);
10806 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10807 staticpro (&Qpost_command_idle_hook
);
10809 Qdeferred_action_function
= intern ("deferred-action-function");
10810 staticpro (&Qdeferred_action_function
);
10812 Qcommand_hook_internal
= intern ("command-hook-internal");
10813 staticpro (&Qcommand_hook_internal
);
10815 Qfunction_key
= intern ("function-key");
10816 staticpro (&Qfunction_key
);
10817 Qmouse_click
= intern ("mouse-click");
10818 staticpro (&Qmouse_click
);
10820 Qlanguage_change
= intern ("language-change");
10821 staticpro (&Qlanguage_change
);
10823 Qdrag_n_drop
= intern ("drag-n-drop");
10824 staticpro (&Qdrag_n_drop
);
10826 Qsave_session
= intern ("save-session");
10827 staticpro(&Qsave_session
);
10829 Qusr1_signal
= intern ("usr1-signal");
10830 staticpro (&Qusr1_signal
);
10831 Qusr2_signal
= intern ("usr2-signal");
10832 staticpro (&Qusr2_signal
);
10834 Qmenu_enable
= intern ("menu-enable");
10835 staticpro (&Qmenu_enable
);
10836 Qmenu_alias
= intern ("menu-alias");
10837 staticpro (&Qmenu_alias
);
10838 QCenable
= intern (":enable");
10839 staticpro (&QCenable
);
10840 QCvisible
= intern (":visible");
10841 staticpro (&QCvisible
);
10842 QChelp
= intern (":help");
10843 staticpro (&QChelp
);
10844 QCfilter
= intern (":filter");
10845 staticpro (&QCfilter
);
10846 QCbutton
= intern (":button");
10847 staticpro (&QCbutton
);
10848 QCkeys
= intern (":keys");
10849 staticpro (&QCkeys
);
10850 QCkey_sequence
= intern (":key-sequence");
10851 staticpro (&QCkey_sequence
);
10852 QCtoggle
= intern (":toggle");
10853 staticpro (&QCtoggle
);
10854 QCradio
= intern (":radio");
10855 staticpro (&QCradio
);
10857 Qmode_line
= intern ("mode-line");
10858 staticpro (&Qmode_line
);
10859 Qvertical_line
= intern ("vertical-line");
10860 staticpro (&Qvertical_line
);
10861 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10862 staticpro (&Qvertical_scroll_bar
);
10863 Qmenu_bar
= intern ("menu-bar");
10864 staticpro (&Qmenu_bar
);
10866 Qabove_handle
= intern ("above-handle");
10867 staticpro (&Qabove_handle
);
10868 Qhandle
= intern ("handle");
10869 staticpro (&Qhandle
);
10870 Qbelow_handle
= intern ("below-handle");
10871 staticpro (&Qbelow_handle
);
10872 Qup
= intern ("up");
10874 Qdown
= intern ("down");
10875 staticpro (&Qdown
);
10876 Qtop
= intern ("top");
10878 Qbottom
= intern ("bottom");
10879 staticpro (&Qbottom
);
10880 Qend_scroll
= intern ("end-scroll");
10881 staticpro (&Qend_scroll
);
10882 Qratio
= intern ("ratio");
10883 staticpro (&Qratio
);
10885 Qevent_kind
= intern ("event-kind");
10886 staticpro (&Qevent_kind
);
10887 Qevent_symbol_elements
= intern ("event-symbol-elements");
10888 staticpro (&Qevent_symbol_elements
);
10889 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10890 staticpro (&Qevent_symbol_element_mask
);
10891 Qmodifier_cache
= intern ("modifier-cache");
10892 staticpro (&Qmodifier_cache
);
10894 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10895 staticpro (&Qrecompute_lucid_menubar
);
10896 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10897 staticpro (&Qactivate_menubar_hook
);
10899 Qpolling_period
= intern ("polling-period");
10900 staticpro (&Qpolling_period
);
10902 Qinput_method_function
= intern ("input-method-function");
10903 staticpro (&Qinput_method_function
);
10905 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10906 staticpro (&Qinput_method_exit_on_first_char
);
10907 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10908 staticpro (&Qinput_method_use_echo_area
);
10910 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10911 Fset (Qinput_method_use_echo_area
, Qnil
);
10913 last_point_position_buffer
= Qnil
;
10916 struct event_head
*p
;
10918 for (p
= head_table
;
10919 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10922 *p
->var
= intern (p
->name
);
10923 staticpro (p
->var
);
10924 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10925 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10929 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10930 staticpro (&button_down_location
);
10931 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10932 staticpro (&mouse_syms
);
10933 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
10934 staticpro (&wheel_syms
);
10938 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10940 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10941 for (i
= 0; i
< len
; i
++)
10942 if (modifier_names
[i
])
10943 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10944 staticpro (&modifier_symbols
);
10947 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10948 staticpro (&recent_keys
);
10950 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10951 staticpro (&this_command_keys
);
10953 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10954 staticpro (&raw_keybuf
);
10956 Qextended_command_history
= intern ("extended-command-history");
10957 Fset (Qextended_command_history
, Qnil
);
10958 staticpro (&Qextended_command_history
);
10960 accent_key_syms
= Qnil
;
10961 staticpro (&accent_key_syms
);
10963 func_key_syms
= Qnil
;
10964 staticpro (&func_key_syms
);
10966 drag_n_drop_syms
= Qnil
;
10967 staticpro (&drag_n_drop_syms
);
10969 unread_switch_frame
= Qnil
;
10970 staticpro (&unread_switch_frame
);
10972 internal_last_event_frame
= Qnil
;
10973 staticpro (&internal_last_event_frame
);
10975 read_key_sequence_cmd
= Qnil
;
10976 staticpro (&read_key_sequence_cmd
);
10978 menu_bar_one_keymap_changed_items
= Qnil
;
10979 staticpro (&menu_bar_one_keymap_changed_items
);
10981 defsubr (&Sevent_convert_list
);
10982 defsubr (&Sread_key_sequence
);
10983 defsubr (&Sread_key_sequence_vector
);
10984 defsubr (&Srecursive_edit
);
10986 defsubr (&Strack_mouse
);
10988 defsubr (&Sinput_pending_p
);
10989 defsubr (&Scommand_execute
);
10990 defsubr (&Srecent_keys
);
10991 defsubr (&Sthis_command_keys
);
10992 defsubr (&Sthis_command_keys_vector
);
10993 defsubr (&Sthis_single_command_keys
);
10994 defsubr (&Sthis_single_command_raw_keys
);
10995 defsubr (&Sreset_this_command_lengths
);
10996 defsubr (&Sclear_this_command_keys
);
10997 defsubr (&Ssuspend_emacs
);
10998 defsubr (&Sabort_recursive_edit
);
10999 defsubr (&Sexit_recursive_edit
);
11000 defsubr (&Srecursion_depth
);
11001 defsubr (&Stop_level
);
11002 defsubr (&Sdiscard_input
);
11003 defsubr (&Sopen_dribble_file
);
11004 defsubr (&Sset_input_mode
);
11005 defsubr (&Scurrent_input_mode
);
11006 defsubr (&Sexecute_extended_command
);
11007 defsubr (&Sposn_at_point
);
11008 defsubr (&Sposn_at_x_y
);
11010 DEFVAR_LISP ("last-command-char", &last_command_char
,
11011 doc
: /* Last input event that was part of a command. */);
11013 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11014 doc
: /* Last input event that was part of a command. */);
11016 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11017 doc
: /* Last input event in a command, except for mouse menu events.
11018 Mouse menus give back keys that don't look like mouse events;
11019 this variable holds the actual mouse event that led to the menu,
11020 so that you can determine whether the command was run by mouse or not. */);
11022 DEFVAR_LISP ("last-input-char", &last_input_char
,
11023 doc
: /* Last input event. */);
11025 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11026 doc
: /* Last input event. */);
11028 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11029 doc
: /* List of events to be read as the command input.
11030 These events are processed first, before actual keyboard input. */);
11031 Vunread_command_events
= Qnil
;
11033 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11034 doc
: /* If not -1, an object to be read as next command input event. */);
11036 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11037 doc
: /* List of events to be processed as input by input methods.
11038 These events are processed after `unread-command-events', but
11039 before actual keyboard input. */);
11040 Vunread_post_input_method_events
= Qnil
;
11042 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11043 doc
: /* List of events to be processed as input by input methods.
11044 These events are processed after `unread-command-events', but
11045 before actual keyboard input. */);
11046 Vunread_input_method_events
= Qnil
;
11048 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11049 doc
: /* Meta-prefix character code.
11050 Meta-foo as command input turns into this character followed by foo. */);
11051 XSETINT (meta_prefix_char
, 033);
11053 DEFVAR_KBOARD ("last-command", Vlast_command
,
11054 doc
: /* The last command executed.
11055 Normally a symbol with a function definition, but can be whatever was found
11056 in the keymap, or whatever the variable `this-command' was set to by that
11059 The value `mode-exit' is special; it means that the previous command
11060 read an event that told it to exit, and it did so and unread that event.
11061 In other words, the present command is the event that made the previous
11064 The value `kill-region' is special; it means that the previous command
11065 was a kill command. */);
11067 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11068 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11070 DEFVAR_LISP ("this-command", &Vthis_command
,
11071 doc
: /* The command now being executed.
11072 The command can set this variable; whatever is put here
11073 will be in `last-command' during the following command. */);
11074 Vthis_command
= Qnil
;
11076 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11077 doc
: /* The command bound to the current key sequence before remapping.
11078 It equals `this-command' if the original command was not remapped through
11079 any of the active keymaps. Otherwise, the value of `this-command' is the
11080 result of looking up the original command in the active keymaps. */);
11081 Vthis_original_command
= Qnil
;
11083 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11084 doc
: /* *Number of input events between auto-saves.
11085 Zero means disable autosaving due to number of characters typed. */);
11086 auto_save_interval
= 300;
11088 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11089 doc
: /* *Number of seconds idle time before auto-save.
11090 Zero or nil means disable auto-saving due to idleness.
11091 After auto-saving due to this many seconds of idle time,
11092 Emacs also does a garbage collection if that seems to be warranted. */);
11093 XSETFASTINT (Vauto_save_timeout
, 30);
11095 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11096 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11097 The value may be integer or floating point. */);
11098 Vecho_keystrokes
= make_number (1);
11100 DEFVAR_INT ("polling-period", &polling_period
,
11101 doc
: /* *Interval between polling for input during Lisp execution.
11102 The reason for polling is to make C-g work to stop a running program.
11103 Polling is needed only when using X windows and SIGIO does not work.
11104 Polling is automatically disabled in all other cases. */);
11105 polling_period
= 2;
11107 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11108 doc
: /* *Maximum time between mouse clicks to make a double-click.
11109 Measured in milliseconds. nil means disable double-click recognition;
11110 t means double-clicks have no time limit and are detected
11111 by position only. */);
11112 Vdouble_click_time
= make_number (500);
11114 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11115 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11116 On window-system frames, value is the number of pixels the mouse may have
11117 moved horizontally or vertically between two clicks to make a double-click.
11118 On non window-system frames, value is interpreted in units of 1/8 characters
11121 This variable is also the threshold for motion of the mouse
11122 to count as a drag. */);
11123 double_click_fuzz
= 3;
11125 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11126 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11127 inhibit_local_menu_bar_menus
= 0;
11129 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11130 doc
: /* Number of complete key sequences read as input so far.
11131 This includes key sequences read from keyboard macros.
11132 The number is effectively the number of interactive command invocations. */);
11133 num_input_keys
= 0;
11135 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11136 doc
: /* Number of input events read from the keyboard so far.
11137 This does not include events generated by keyboard macros. */);
11138 num_nonmacro_input_events
= 0;
11140 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11141 doc
: /* The frame in which the most recently read event occurred.
11142 If the last event came from a keyboard macro, this is set to `macro'. */);
11143 Vlast_event_frame
= Qnil
;
11145 /* This variable is set up in sysdep.c. */
11146 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11147 doc
: /* The ERASE character as set by the user with stty. */);
11149 DEFVAR_LISP ("help-char", &Vhelp_char
,
11150 doc
: /* Character to recognize as meaning Help.
11151 When it is read, do `(eval help-form)', and display result if it's a string.
11152 If the value of `help-form' is nil, this char can be read normally. */);
11153 XSETINT (Vhelp_char
, Ctl ('H'));
11155 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11156 doc
: /* List of input events to recognize as meaning Help.
11157 These work just like the value of `help-char' (see that). */);
11158 Vhelp_event_list
= Qnil
;
11160 DEFVAR_LISP ("help-form", &Vhelp_form
,
11161 doc
: /* Form to execute when character `help-char' is read.
11162 If the form returns a string, that string is displayed.
11163 If `help-form' is nil, the help char is not recognized. */);
11166 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11167 doc
: /* Command to run when `help-char' character follows a prefix key.
11168 This command is used only when there is no actual binding
11169 for that character after that prefix key. */);
11170 Vprefix_help_command
= Qnil
;
11172 DEFVAR_LISP ("top-level", &Vtop_level
,
11173 doc
: /* Form to evaluate when Emacs starts up.
11174 Useful to set before you dump a modified Emacs. */);
11177 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11178 doc
: /* Translate table for keyboard input, or nil.
11179 If non-nil, the value should be a char-table. Each character read
11180 from the keyboard is looked up in this char-table. If the value found
11181 there is non-nil, then it is used instead of the actual input character.
11183 The value can also be a string or vector, but this is considered obsolete.
11184 If it is a string or vector of length N, character codes N and up are left
11185 untranslated. In a vector, an element which is nil means "no translation".
11187 This is applied to the characters supplied to input methods, not their
11188 output. See also `translation-table-for-input'. */);
11189 Vkeyboard_translate_table
= Qnil
;
11191 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11192 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11193 \(Even if the operating system has support for stopping a process.\) */);
11194 cannot_suspend
= 0;
11196 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11197 doc
: /* Non-nil means prompt with menus when appropriate.
11198 This is done when reading from a keymap that has a prompt string,
11199 for elements that have prompt strings.
11200 The menu is displayed on the screen
11201 if X menus were enabled at configuration
11202 time and the previous event was a mouse click prefix key.
11203 Otherwise, menu prompting uses the echo area. */);
11204 menu_prompting
= 1;
11206 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11207 doc
: /* Character to see next line of menu prompt.
11208 Type this character while in a menu prompt to rotate around the lines of it. */);
11209 XSETINT (menu_prompt_more_char
, ' ');
11211 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11212 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11213 Emacs applies the modifiers of the character stored here to each keyboard
11214 character it reads. For example, after evaluating the expression
11215 (setq extra-keyboard-modifiers ?\\C-x)
11216 all input characters will have the control modifier applied to them.
11218 Note that the character ?\\C-@, equivalent to the integer zero, does
11219 not count as a control character; rather, it counts as a character
11220 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11221 cancels any modification. */);
11222 extra_keyboard_modifiers
= 0;
11224 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11225 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11226 The command loop sets this to nil before each command,
11227 and tests the value when the command returns.
11228 Buffer modification stores t in this variable. */);
11229 Vdeactivate_mark
= Qnil
;
11231 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11232 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11233 Vcommand_hook_internal
= Qnil
;
11235 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11236 doc
: /* Normal hook run before each command is executed.
11237 If an unhandled error happens in running this hook,
11238 the hook value is set to nil, since otherwise the error
11239 might happen repeatedly and make Emacs nonfunctional. */);
11240 Vpre_command_hook
= Qnil
;
11242 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11243 doc
: /* Normal hook run after each command is executed.
11244 If an unhandled error happens in running this hook,
11245 the hook value is set to nil, since otherwise the error
11246 might happen repeatedly and make Emacs nonfunctional. */);
11247 Vpost_command_hook
= Qnil
;
11249 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11250 doc
: /* Normal hook run after each command is executed, if idle.
11251 Errors running the hook are caught and ignored. */);
11252 Vpost_command_idle_hook
= Qnil
;
11254 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11255 doc
: /* Delay time before running `post-command-idle-hook'.
11256 This is measured in microseconds. */);
11257 post_command_idle_delay
= 100000;
11260 DEFVAR_LISP ("echo-area-clear-hook", ...,
11261 doc
: /* Normal hook run when clearing the echo area. */);
11263 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11264 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11266 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11267 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11268 Vlucid_menu_bar_dirty_flag
= Qnil
;
11270 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11271 doc
: /* List of menu bar items to move to the end of the menu bar.
11272 The elements of the list are event types that may have menu bar bindings. */);
11273 Vmenu_bar_final_items
= Qnil
;
11275 DEFVAR_KBOARD ("overriding-terminal-local-map",
11276 Voverriding_terminal_local_map
,
11277 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11278 If this variable is non-nil, it is used as a keymap instead of the
11279 buffer's local map, and the minor mode keymaps and text property keymaps.
11280 It also overrides `overriding-local-map'.
11281 This variable is intended to let commands such as `universal-argument'
11282 set up a different keymap for reading the next command. */);
11284 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11285 doc
: /* Keymap that overrides all other local keymaps.
11286 If this variable is non-nil, it is used as a keymap instead of the
11287 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11288 Voverriding_local_map
= Qnil
;
11290 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11291 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11292 Otherwise, the menu bar continues to reflect the buffer's local map
11293 and the minor mode maps regardless of `overriding-local-map'. */);
11294 Voverriding_local_map_menu_flag
= Qnil
;
11296 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11297 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11298 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11300 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11301 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11303 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11304 doc
: /* Alist of system-specific X windows key symbols.
11305 Each element should have the form (N . SYMBOL) where N is the
11306 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11307 and SYMBOL is its name. */);
11309 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11310 doc
: /* List of deferred actions to be performed at a later time.
11311 The precise format isn't relevant here; we just check whether it is nil. */);
11312 Vdeferred_action_list
= Qnil
;
11314 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11315 doc
: /* Function to call to handle deferred actions, after each command.
11316 This function is called with no arguments after each command
11317 whenever `deferred-action-list' is non-nil. */);
11318 Vdeferred_action_function
= Qnil
;
11320 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11321 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11322 The value can be a length of time to show the message for.
11323 If the value is non-nil and not a number, we wait 2 seconds. */);
11324 Vsuggest_key_bindings
= Qt
;
11326 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11327 doc
: /* List of active absolute time timers in order of increasing time. */);
11328 Vtimer_list
= Qnil
;
11330 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11331 doc
: /* List of active idle-time timers in order of increasing time. */);
11332 Vtimer_idle_list
= Qnil
;
11334 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11335 doc
: /* If non-nil, the function that implements the current input method.
11336 It's called with one argument, a printing character that was just read.
11337 \(That means a character with code 040...0176.)
11338 Typically this function uses `read-event' to read additional events.
11339 When it does so, it should first bind `input-method-function' to nil
11340 so it will not be called recursively.
11342 The function should return a list of zero or more events
11343 to be used as input. If it wants to put back some events
11344 to be reconsidered, separately, by the input method,
11345 it can add them to the beginning of `unread-command-events'.
11347 The input method function can find in `input-method-previous-method'
11348 the previous echo area message.
11350 The input method function should refer to the variables
11351 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11352 for guidance on what to do. */);
11353 Vinput_method_function
= Qnil
;
11355 DEFVAR_LISP ("input-method-previous-message",
11356 &Vinput_method_previous_message
,
11357 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11358 This variable exists because `read-event' clears the echo area
11359 before running the input method. It is nil if there was no message. */);
11360 Vinput_method_previous_message
= Qnil
;
11362 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11363 doc
: /* If non-nil, the function that implements the display of help.
11364 It's called with one argument, the help string to display. */);
11365 Vshow_help_function
= Qnil
;
11367 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11368 doc
: /* If non-nil, suppress point adjustment after executing a command.
11370 After a command is executed, if point is moved into a region that has
11371 special properties (e.g. composition, display), we adjust point to
11372 the boundary of the region. But, when a command sets this variable to
11373 non-nil, we suppress the point adjustment.
11375 This variable is set to nil before reading a command, and is checked
11376 just after executing the command. */);
11377 Vdisable_point_adjustment
= Qnil
;
11379 DEFVAR_LISP ("global-disable-point-adjustment",
11380 &Vglobal_disable_point_adjustment
,
11381 doc
: /* *If non-nil, always suppress point adjustment.
11383 The default value is nil, in which case, point adjustment are
11384 suppressed only after special commands that set
11385 `disable-point-adjustment' (which see) to non-nil. */);
11386 Vglobal_disable_point_adjustment
= Qnil
;
11388 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11389 doc
: /* Non-nil means updating menu bindings is allowed.
11390 A value of nil means menu bindings should not be updated.
11391 Used during Emacs' startup. */);
11392 update_menu_bindings
= 1;
11394 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11395 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11396 If the value is not a number, such messages don't time out. */);
11397 Vminibuffer_message_timeout
= make_number (2);
11401 keys_of_keyboard ()
11403 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11404 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11405 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11406 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11407 initial_define_key (meta_map
, 'x', "execute-extended-command");
11409 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11410 "handle-delete-frame");
11411 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11413 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11415 /* Handling it at such a low-level causes read_key_sequence to get
11416 * confused because it doesn't realize that the current_buffer was
11417 * changed by read_char.
11419 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11420 * "handle-select-window"); */
11421 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11422 "handle-save-session");
11425 /* Mark the pointers in the kboard objects.
11426 Called by the Fgarbage_collector. */
11432 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11434 if (kb
->kbd_macro_buffer
)
11435 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11437 mark_object (kb
->Voverriding_terminal_local_map
);
11438 mark_object (kb
->Vlast_command
);
11439 mark_object (kb
->Vreal_last_command
);
11440 mark_object (kb
->Vprefix_arg
);
11441 mark_object (kb
->Vlast_prefix_arg
);
11442 mark_object (kb
->kbd_queue
);
11443 mark_object (kb
->defining_kbd_macro
);
11444 mark_object (kb
->Vlast_kbd_macro
);
11445 mark_object (kb
->Vsystem_key_alist
);
11446 mark_object (kb
->system_key_syms
);
11447 mark_object (kb
->Vdefault_minibuffer_frame
);
11448 mark_object (kb
->echo_string
);
11451 struct input_event
*event
;
11452 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11454 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11455 event
= kbd_buffer
;
11456 if (event
->kind
!= SELECTION_REQUEST_EVENT
)
11458 mark_object (event
->x
);
11459 mark_object (event
->y
);
11461 mark_object (event
->frame_or_window
);
11462 mark_object (event
->arg
);
11467 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11468 (do not change this comment) */