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
));
679 static void timer_start_idle
P_ ((void));
680 static void timer_stop_idle
P_ ((void));
681 static void timer_resume_idle
P_ ((void));
683 /* Nonzero means don't try to suspend even if the operating system seems
685 static int cannot_suspend
;
687 extern Lisp_Object Qidentity
, Qonly
;
689 /* Install the string STR as the beginning of the string of echoing,
690 so that it serves as a prompt for the next character.
691 Also start echoing. */
697 current_kboard
->echo_string
= str
;
698 current_kboard
->echo_after_prompt
= SCHARS (str
);
702 /* Add C to the echo string, if echoing is going on.
703 C can be a character, which is printed prettily ("M-C-x" and all that
704 jazz), or a symbol, whose name is printed. */
710 if (current_kboard
->immediate_echo
)
712 int size
= KEY_DESCRIPTION_SIZE
+ 100;
713 char *buffer
= (char *) alloca (size
);
715 Lisp_Object echo_string
;
717 echo_string
= current_kboard
->echo_string
;
719 /* If someone has passed us a composite event, use its head symbol. */
724 ptr
= push_key_description (XINT (c
), ptr
, 1);
726 else if (SYMBOLP (c
))
728 Lisp_Object name
= SYMBOL_NAME (c
);
729 int nbytes
= SBYTES (name
);
731 if (size
- (ptr
- buffer
) < nbytes
)
733 int offset
= ptr
- buffer
;
734 size
= max (2 * size
, size
+ nbytes
);
735 buffer
= (char *) alloca (size
);
736 ptr
= buffer
+ offset
;
739 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
740 STRING_MULTIBYTE (name
), 1);
743 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
746 const char *text
= " (Type ? for further options)";
747 int len
= strlen (text
);
749 if (size
- (ptr
- buffer
) < len
)
751 int offset
= ptr
- buffer
;
753 buffer
= (char *) alloca (size
);
754 ptr
= buffer
+ offset
;
757 bcopy (text
, ptr
, len
);
761 /* Replace a dash from echo_dash with a space, otherwise
762 add a space at the end as a separator between keys. */
763 if (STRINGP (echo_string
)
764 && SCHARS (echo_string
) > 1)
766 Lisp_Object last_char
, prev_char
, idx
;
768 idx
= make_number (SCHARS (echo_string
) - 2);
769 prev_char
= Faref (echo_string
, idx
);
771 idx
= make_number (SCHARS (echo_string
) - 1);
772 last_char
= Faref (echo_string
, idx
);
774 /* We test PREV_CHAR to make sure this isn't the echoing
776 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
777 Faset (echo_string
, idx
, make_number (' '));
779 echo_string
= concat2 (echo_string
, build_string (" "));
782 current_kboard
->echo_string
783 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
789 /* Temporarily add a dash to the end of the echo string if it's not
790 empty, so that it serves as a mini-prompt for the very next character. */
795 /* Do nothing if not echoing at all. */
796 if (NILP (current_kboard
->echo_string
))
799 if (!current_kboard
->immediate_echo
800 && SCHARS (current_kboard
->echo_string
) == 0)
803 /* Do nothing if we just printed a prompt. */
804 if (current_kboard
->echo_after_prompt
805 == SCHARS (current_kboard
->echo_string
))
808 /* Do nothing if we have already put a dash at the end. */
809 if (SCHARS (current_kboard
->echo_string
) > 1)
811 Lisp_Object last_char
, prev_char
, idx
;
813 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
814 prev_char
= Faref (current_kboard
->echo_string
, idx
);
816 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
817 last_char
= Faref (current_kboard
->echo_string
, idx
);
819 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
823 /* Put a dash at the end of the buffer temporarily,
824 but make it go away when the next character is added. */
825 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
830 /* Display the current echo string, and begin echoing if not already
836 if (!current_kboard
->immediate_echo
)
839 current_kboard
->immediate_echo
= 1;
841 for (i
= 0; i
< this_command_key_count
; i
++)
845 /* Set before_command_echo_length to the value that would
846 have been saved before the start of this subcommand in
847 command_loop_1, if we had already been echoing then. */
848 if (i
== this_single_command_key_start
)
849 before_command_echo_length
= echo_length ();
851 c
= XVECTOR (this_command_keys
)->contents
[i
];
852 if (! (EVENT_HAS_PARAMETERS (c
)
853 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
857 /* Set before_command_echo_length to the value that would
858 have been saved before the start of this subcommand in
859 command_loop_1, if we had already been echoing then. */
860 if (this_command_key_count
== this_single_command_key_start
)
861 before_command_echo_length
= echo_length ();
863 /* Put a dash at the end to invite the user to type more. */
868 message3_nolog (current_kboard
->echo_string
,
869 SBYTES (current_kboard
->echo_string
),
870 STRING_MULTIBYTE (current_kboard
->echo_string
));
873 /* Record in what buffer we echoed, and from which kboard. */
874 echo_message_buffer
= echo_area_buffer
[0];
875 echo_kboard
= current_kboard
;
877 if (waiting_for_input
&& !NILP (Vquit_flag
))
878 quit_throw_to_read_char ();
881 /* Turn off echoing, for the start of a new command. */
886 current_kboard
->immediate_echo
= 0;
887 current_kboard
->echo_after_prompt
= -1;
888 current_kboard
->echo_string
= Qnil
;
889 ok_to_echo_at_next_pause
= NULL
;
891 echo_message_buffer
= Qnil
;
894 /* Return the length of the current echo string. */
899 return (STRINGP (current_kboard
->echo_string
)
900 ? SCHARS (current_kboard
->echo_string
)
904 /* Truncate the current echo message to its first LEN chars.
905 This and echo_char get used by read_key_sequence when the user
906 switches frames while entering a key sequence. */
909 echo_truncate (nchars
)
912 if (STRINGP (current_kboard
->echo_string
))
913 current_kboard
->echo_string
914 = Fsubstring (current_kboard
->echo_string
,
915 make_number (0), make_number (nchars
));
916 truncate_echo_area (nchars
);
920 /* Functions for manipulating this_command_keys. */
922 add_command_key (key
)
925 #if 0 /* Not needed after we made Freset_this_command_lengths
926 do the job immediately. */
927 /* If reset-this-command-length was called recently, obey it now.
928 See the doc string of that function for an explanation of why. */
929 if (before_command_restore_flag
)
931 this_command_key_count
= before_command_key_count_1
;
932 if (this_command_key_count
< this_single_command_key_start
)
933 this_single_command_key_start
= this_command_key_count
;
934 echo_truncate (before_command_echo_length_1
);
935 before_command_restore_flag
= 0;
939 if (this_command_key_count
>= ASIZE (this_command_keys
))
940 this_command_keys
= larger_vector (this_command_keys
,
941 2 * ASIZE (this_command_keys
),
944 AREF (this_command_keys
, this_command_key_count
) = key
;
945 ++this_command_key_count
;
952 int count
= SPECPDL_INDEX ();
955 if (command_loop_level
> 0)
957 specbind (Qstandard_output
, Qt
);
958 specbind (Qstandard_input
, Qt
);
961 #ifdef HAVE_X_WINDOWS
962 /* The command loop has started an hourglass timer, so we have to
963 cancel it here, otherwise it will fire because the recursive edit
964 can take some time. Do not check for display_hourglass_p here,
965 because it could already be nil. */
969 /* This function may have been called from a debugger called from
970 within redisplay, for instance by Edebugging a function called
971 from fontification-functions. We want to allow redisplay in
972 the debugging session.
974 The recursive edit is left with a `(throw exit ...)'. The `exit'
975 tag is not caught anywhere in redisplay, i.e. when we leave the
976 recursive edit, the original redisplay leading to the recursive
977 edit will be unwound. The outcome should therefore be safe. */
978 specbind (Qinhibit_redisplay
, Qnil
);
981 val
= command_loop ();
983 Fsignal (Qquit
, Qnil
);
984 /* Handle throw from read_minibuf when using minibuffer
985 while it's active but we're in another window. */
987 Fsignal (Qerror
, Fcons (val
, Qnil
));
989 return unbind_to (count
, Qnil
);
992 /* When an auto-save happens, record the "time", and don't do again soon. */
997 last_auto_save
= num_nonmacro_input_events
;
1000 /* Make an auto save happen as soon as possible at command level. */
1003 force_auto_save_soon ()
1005 last_auto_save
= - auto_save_interval
- 1;
1007 record_asynch_buffer_change ();
1010 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1011 doc
: /* Invoke the editor command loop recursively.
1012 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1013 that tells this function to return.
1014 Alternately, `(throw 'exit t)' makes this function signal an error.
1015 This function is called by the editor initialization to begin editing. */)
1018 int count
= SPECPDL_INDEX ();
1021 /* If we enter while input is blocked, don't lock up here.
1022 This may happen through the debugger during redisplay. */
1023 if (INPUT_BLOCKED_P
)
1026 command_loop_level
++;
1027 update_mode_lines
= 1;
1029 if (command_loop_level
1030 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1031 buffer
= Fcurrent_buffer ();
1035 /* If we leave recursive_edit_1 below with a `throw' for instance,
1036 like it is done in the splash screen display, we have to
1037 make sure that we restore single_kboard as command_loop_1
1038 would have done if it were left normally. */
1039 record_unwind_protect (recursive_edit_unwind
,
1040 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1042 recursive_edit_1 ();
1043 return unbind_to (count
, Qnil
);
1047 recursive_edit_unwind (info
)
1050 if (BUFFERP (XCAR (info
)))
1051 Fset_buffer (XCAR (info
));
1053 if (NILP (XCDR (info
)))
1054 any_kboard_state ();
1056 single_kboard_state ();
1058 command_loop_level
--;
1059 update_mode_lines
= 1;
1068 #if 0 /* Theory: if there's anything in Vunread_command_events,
1069 it will right away be read by read_key_sequence,
1070 and then if we do switch KBOARDS, it will go into the side
1071 queue then. So we don't need to do anything special here -- rms. */
1072 if (CONSP (Vunread_command_events
))
1074 current_kboard
->kbd_queue
1075 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1076 current_kboard
->kbd_queue_has_data
= 1;
1078 Vunread_command_events
= Qnil
;
1084 /* Switch to the single-kboard state, making current_kboard
1085 the only KBOARD from which further input is accepted. */
1088 single_kboard_state ()
1095 /* If we're in single_kboard state for kboard KBOARD,
1099 not_single_kboard_state (kboard
)
1103 if (kboard
== current_kboard
)
1108 /* Maintain a stack of kboards, so other parts of Emacs
1109 can switch temporarily to the kboard of a given frame
1110 and then revert to the previous status. */
1115 struct kboard_stack
*next
;
1118 static struct kboard_stack
*kboard_stack
;
1121 push_frame_kboard (f
)
1125 struct kboard_stack
*p
1126 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1128 p
->next
= kboard_stack
;
1129 p
->kboard
= current_kboard
;
1132 current_kboard
= FRAME_KBOARD (f
);
1140 struct kboard_stack
*p
= kboard_stack
;
1141 current_kboard
= p
->kboard
;
1142 kboard_stack
= p
->next
;
1147 /* Handle errors that are not handled at inner levels
1148 by printing an error message and returning to the editor command loop. */
1154 Lisp_Object old_level
, old_length
;
1155 char macroerror
[50];
1157 #ifdef HAVE_X_WINDOWS
1158 if (display_hourglass_p
)
1159 cancel_hourglass ();
1162 if (!NILP (executing_macro
))
1164 if (executing_macro_iterations
== 1)
1165 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1167 sprintf (macroerror
, "After %d kbd macro iterations: ",
1168 executing_macro_iterations
);
1173 Vstandard_output
= Qt
;
1174 Vstandard_input
= Qt
;
1175 Vexecuting_macro
= Qnil
;
1176 executing_macro
= Qnil
;
1177 current_kboard
->Vprefix_arg
= Qnil
;
1178 current_kboard
->Vlast_prefix_arg
= Qnil
;
1181 /* Avoid unquittable loop if data contains a circular list. */
1182 old_level
= Vprint_level
;
1183 old_length
= Vprint_length
;
1184 XSETFASTINT (Vprint_level
, 10);
1185 XSETFASTINT (Vprint_length
, 10);
1186 cmd_error_internal (data
, macroerror
);
1187 Vprint_level
= old_level
;
1188 Vprint_length
= old_length
;
1192 Vinhibit_quit
= Qnil
;
1194 if (command_loop_level
== 0 && minibuf_level
== 0)
1195 any_kboard_state ();
1198 return make_number (0);
1201 /* Take actions on handling an error. DATA is the data that describes
1204 CONTEXT is a C-string containing ASCII characters only which
1205 describes the context in which the error happened. If we need to
1206 generalize CONTEXT to allow multibyte characters, make it a Lisp
1210 cmd_error_internal (data
, context
)
1215 int kill_emacs_p
= 0;
1216 struct frame
*sf
= SELECTED_FRAME ();
1220 clear_message (1, 0);
1222 /* If the window system or terminal frame hasn't been initialized
1223 yet, or we're not interactive, it's best to dump this message out
1224 to stderr and exit. */
1225 if (!sf
->glyphs_initialized_p
1226 /* This is the case of the frame dumped with Emacs, when we're
1227 running under a window system. */
1228 || (!NILP (Vwindow_system
)
1229 && !inhibit_window_system
1230 && FRAME_TERMCAP_P (sf
))
1233 stream
= Qexternal_debugging_output
;
1239 message_log_maybe_newline ();
1244 /* The immediate context is not interesting for Quits,
1245 since they are asyncronous. */
1246 if (EQ (XCAR (data
), Qquit
))
1247 Vsignaling_function
= Qnil
;
1249 print_error_message (data
, stream
, context
, Vsignaling_function
);
1251 Vsignaling_function
= Qnil
;
1253 /* If the window system or terminal frame hasn't been initialized
1254 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1258 Fkill_emacs (make_number (-1));
1262 Lisp_Object
command_loop_1 ();
1263 Lisp_Object
command_loop_2 ();
1264 Lisp_Object
top_level_1 ();
1266 /* Entry to editor-command-loop.
1267 This level has the catches for exiting/returning to editor command loop.
1268 It returns nil to exit recursive edit, t to abort it. */
1273 if (command_loop_level
> 0 || minibuf_level
> 0)
1276 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1277 executing_macro
= Qnil
;
1283 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1284 /* Reset single_kboard in case top-level set it while
1285 evaluating an -f option, or we are stuck there for some
1287 any_kboard_state ();
1288 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1289 executing_macro
= Qnil
;
1291 /* End of file in -batch run causes exit here. */
1297 /* Here we catch errors in execution of commands within the
1298 editing loop, and reenter the editing loop.
1299 When there is an error, cmd_error runs and returns a non-nil
1300 value to us. A value of nil means that command_loop_1 itself
1301 returned due to end of file (or end of kbd macro). */
1306 register Lisp_Object val
;
1309 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1310 while (!NILP (val
));
1318 return Feval (Vtop_level
);
1324 /* On entry to the outer level, run the startup file */
1325 if (!NILP (Vtop_level
))
1326 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1327 else if (!NILP (Vpurify_flag
))
1328 message ("Bare impure Emacs (standard Lisp code not loaded)");
1330 message ("Bare Emacs (standard Lisp code not loaded)");
1334 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1335 doc
: /* Exit all recursive editing levels. */)
1338 #ifdef HAVE_X_WINDOWS
1339 if (display_hourglass_p
)
1340 cancel_hourglass ();
1343 /* Unblock input if we enter with input blocked. This may happen if
1344 redisplay traps e.g. during tool-bar update with input blocked. */
1345 while (INPUT_BLOCKED_P
)
1348 return Fthrow (Qtop_level
, Qnil
);
1351 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1352 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1355 if (command_loop_level
> 0 || minibuf_level
> 0)
1356 Fthrow (Qexit
, Qnil
);
1358 error ("No recursive edit is in progress");
1362 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1363 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1366 if (command_loop_level
> 0 || minibuf_level
> 0)
1369 error ("No recursive edit is in progress");
1373 /* This is the actual command reading loop,
1374 sans error-handling encapsulation. */
1376 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1378 void safe_run_hooks
P_ ((Lisp_Object
));
1379 static void adjust_point_for_property
P_ ((int, int));
1381 /* Cancel hourglass from protect_unwind.
1383 #ifdef HAVE_X_WINDOWS
1385 cancel_hourglass_unwind (arg
)
1388 cancel_hourglass ();
1399 Lisp_Object keybuf
[30];
1403 struct buffer
*prev_buffer
= NULL
;
1405 int was_locked
= single_kboard
;
1407 int already_adjusted
;
1409 current_kboard
->Vprefix_arg
= Qnil
;
1410 current_kboard
->Vlast_prefix_arg
= Qnil
;
1411 Vdeactivate_mark
= Qnil
;
1412 waiting_for_input
= 0;
1416 this_command_key_count
= 0;
1417 this_command_key_count_reset
= 0;
1418 this_single_command_key_start
= 0;
1420 if (NILP (Vmemory_full
))
1422 /* Make sure this hook runs after commands that get errors and
1423 throw to top level. */
1424 /* Note that the value cell will never directly contain nil
1425 if the symbol is a local variable. */
1426 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1427 safe_run_hooks (Qpost_command_hook
);
1429 /* If displaying a message, resize the echo area window to fit
1430 that message's size exactly. */
1431 if (!NILP (echo_area_buffer
[0]))
1432 resize_echo_area_exactly ();
1434 if (!NILP (Vdeferred_action_list
))
1435 call0 (Vdeferred_action_function
);
1437 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1439 if (NILP (Vunread_command_events
)
1440 && NILP (Vunread_input_method_events
)
1441 && NILP (Vunread_post_input_method_events
)
1442 && NILP (Vexecuting_macro
)
1443 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1444 safe_run_hooks (Qpost_command_idle_hook
);
1448 Vmemory_full
= Qnil
;
1450 /* Do this after running Vpost_command_hook, for consistency. */
1451 current_kboard
->Vlast_command
= Vthis_command
;
1452 current_kboard
->Vreal_last_command
= real_this_command
;
1456 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1459 /* Make sure the current window's buffer is selected. */
1460 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1461 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1463 /* Display any malloc warning that just came out. Use while because
1464 displaying one warning can cause another. */
1466 while (pending_malloc_warning
)
1467 display_malloc_warning ();
1471 Vdeactivate_mark
= Qnil
;
1473 /* If minibuffer on and echo area in use,
1474 wait a short time and redraw minibuffer. */
1477 && !NILP (echo_area_buffer
[0])
1478 && EQ (minibuf_window
, echo_area_window
)
1479 && NUMBERP (Vminibuffer_message_timeout
))
1481 /* Bind inhibit-quit to t so that C-g gets read in
1482 rather than quitting back to the minibuffer. */
1483 int count
= SPECPDL_INDEX ();
1484 specbind (Qinhibit_quit
, Qt
);
1486 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1487 /* Clear the echo area. */
1489 safe_run_hooks (Qecho_area_clear_hook
);
1491 unbind_to (count
, Qnil
);
1493 /* If a C-g came in before, treat it as input now. */
1494 if (!NILP (Vquit_flag
))
1497 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1502 alloca (0); /* Cause a garbage collection now */
1503 /* Since we can free the most stuff here. */
1504 #endif /* C_ALLOCA */
1507 /* Select the frame that the last event came from. Usually,
1508 switch-frame events will take care of this, but if some lisp
1509 code swallows a switch-frame event, we'll fix things up here.
1510 Is this a good idea? */
1511 if (FRAMEP (internal_last_event_frame
)
1512 && !EQ (internal_last_event_frame
, selected_frame
))
1513 Fselect_frame (internal_last_event_frame
, Qnil
);
1515 /* If it has changed current-menubar from previous value,
1516 really recompute the menubar from the value. */
1517 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1518 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1519 call0 (Qrecompute_lucid_menubar
);
1521 before_command_key_count
= this_command_key_count
;
1522 before_command_echo_length
= echo_length ();
1524 Vthis_command
= Qnil
;
1525 real_this_command
= Qnil
;
1527 /* Read next key sequence; i gets its length. */
1528 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1531 /* A filter may have run while we were reading the input. */
1532 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1534 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1535 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1539 /* Now we have read a key sequence of length I,
1540 or else I is 0 and we found end of file. */
1542 if (i
== 0) /* End of file -- happens only in */
1543 return Qnil
; /* a kbd macro, at the end. */
1544 /* -1 means read_key_sequence got a menu that was rejected.
1545 Just loop around and read another command. */
1549 this_command_key_count
= 0;
1550 this_command_key_count_reset
= 0;
1551 this_single_command_key_start
= 0;
1555 last_command_char
= keybuf
[i
- 1];
1557 /* If the previous command tried to force a specific window-start,
1558 forget about that, in case this command moves point far away
1559 from that position. But also throw away beg_unchanged and
1560 end_unchanged information in that case, so that redisplay will
1561 update the whole window properly. */
1562 if (!NILP (XWINDOW (selected_window
)->force_start
))
1565 XWINDOW (selected_window
)->force_start
= Qnil
;
1566 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1567 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1570 cmd
= read_key_sequence_cmd
;
1571 if (!NILP (Vexecuting_macro
))
1573 if (!NILP (Vquit_flag
))
1575 Vexecuting_macro
= Qt
;
1576 QUIT
; /* Make some noise. */
1577 /* Will return since macro now empty. */
1581 /* Do redisplay processing after this command except in special
1582 cases identified below. */
1583 prev_buffer
= current_buffer
;
1584 prev_modiff
= MODIFF
;
1585 last_point_position
= PT
;
1586 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1588 /* By default, we adjust point to a boundary of a region that
1589 has such a property that should be treated intangible
1590 (e.g. composition, display). But, some commands will set
1591 this variable differently. */
1592 Vdisable_point_adjustment
= Qnil
;
1594 /* Process filters and timers may have messed with deactivate-mark.
1595 reset it before we execute the command. */
1596 Vdeactivate_mark
= Qnil
;
1598 /* Remap command through active keymaps */
1599 Vthis_original_command
= cmd
;
1603 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1607 /* Execute the command. */
1609 Vthis_command
= cmd
;
1610 real_this_command
= cmd
;
1611 /* Note that the value cell will never directly contain nil
1612 if the symbol is a local variable. */
1613 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1614 safe_run_hooks (Qpre_command_hook
);
1616 already_adjusted
= 0;
1618 if (NILP (Vthis_command
))
1620 /* nil means key is undefined. */
1622 current_kboard
->defining_kbd_macro
= Qnil
;
1623 update_mode_lines
= 1;
1624 current_kboard
->Vprefix_arg
= Qnil
;
1628 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1630 /* In case we jump to directly_done. */
1631 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1633 /* Recognize some common commands in common situations and
1634 do them directly. */
1635 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1637 struct Lisp_Char_Table
*dp
1638 = window_display_table (XWINDOW (selected_window
));
1639 lose
= FETCH_CHAR (PT_BYTE
);
1641 if (! NILP (Vpost_command_hook
))
1642 /* Put this before calling adjust_point_for_property
1643 so it will only get called once in any case. */
1645 if (current_buffer
== prev_buffer
1646 && last_point_position
!= PT
1647 && NILP (Vdisable_point_adjustment
)
1648 && NILP (Vglobal_disable_point_adjustment
))
1649 adjust_point_for_property (last_point_position
, 0);
1650 already_adjusted
= 1;
1651 if (PT
== last_point_position
+ 1
1653 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1654 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1655 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1656 && (lose
>= 0x20 && lose
< 0x7f)))
1657 : (lose
>= 0x20 && lose
< 0x7f))
1658 /* To extract the case of continuation on
1659 wide-column characters. */
1660 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1661 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1663 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1665 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1667 && !windows_or_buffers_changed
1668 && EQ (current_buffer
->selective_display
, Qnil
)
1669 && !detect_input_pending ()
1670 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1671 && NILP (Vexecuting_macro
))
1672 direct_output_forward_char (1);
1675 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1677 struct Lisp_Char_Table
*dp
1678 = window_display_table (XWINDOW (selected_window
));
1680 lose
= FETCH_CHAR (PT_BYTE
);
1681 if (! NILP (Vpost_command_hook
))
1683 if (current_buffer
== prev_buffer
1684 && last_point_position
!= PT
1685 && NILP (Vdisable_point_adjustment
)
1686 && NILP (Vglobal_disable_point_adjustment
))
1687 adjust_point_for_property (last_point_position
, 0);
1688 already_adjusted
= 1;
1689 if (PT
== last_point_position
- 1
1691 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1692 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1693 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1694 && (lose
>= 0x20 && lose
< 0x7f)))
1695 : (lose
>= 0x20 && lose
< 0x7f))
1696 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1698 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1700 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1702 && !windows_or_buffers_changed
1703 && EQ (current_buffer
->selective_display
, Qnil
)
1704 && !detect_input_pending ()
1705 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1706 && NILP (Vexecuting_macro
))
1707 direct_output_forward_char (-1);
1710 else if (EQ (Vthis_command
, Qself_insert_command
)
1711 /* Try this optimization only on char keystrokes. */
1712 && NATNUMP (last_command_char
)
1713 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1716 = translate_char (Vtranslation_table_for_input
,
1717 XFASTINT (last_command_char
), 0, 0, 0);
1719 if (NILP (Vexecuting_macro
)
1720 && !EQ (minibuf_window
, selected_window
))
1722 if (!nonundocount
|| nonundocount
>= 20)
1730 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1732 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1734 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1736 || MODIFF
<= SAVE_MODIFF
1737 || windows_or_buffers_changed
1738 || !EQ (current_buffer
->selective_display
, Qnil
)
1739 || detect_input_pending ()
1740 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1741 || !NILP (Vexecuting_macro
));
1743 value
= internal_self_insert (c
, 0);
1748 if (! NILP (Vpost_command_hook
))
1749 /* Put this before calling adjust_point_for_property
1750 so it will only get called once in any case. */
1753 /* VALUE == 1 when AFTER-CHANGE functions are
1754 installed which is the case most of the time
1755 because FONT-LOCK installs one. */
1756 if (!lose
&& !value
)
1757 direct_output_for_insert (c
);
1762 /* Here for a command that isn't executed directly */
1765 #ifdef HAVE_X_WINDOWS
1766 int scount
= SPECPDL_INDEX ();
1768 if (display_hourglass_p
1769 && NILP (Vexecuting_macro
))
1771 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1777 if (NILP (current_kboard
->Vprefix_arg
))
1779 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1781 #ifdef HAVE_X_WINDOWS
1782 /* Do not check display_hourglass_p here, because
1783 Fcommand_execute could change it, but we should cancel
1784 hourglass cursor anyway.
1785 But don't cancel the hourglass within a macro
1786 just because a command in the macro finishes. */
1787 if (NILP (Vexecuting_macro
))
1788 unbind_to (scount
, Qnil
);
1793 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1795 /* Note that the value cell will never directly contain nil
1796 if the symbol is a local variable. */
1797 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1798 safe_run_hooks (Qpost_command_hook
);
1800 /* If displaying a message, resize the echo area window to fit
1801 that message's size exactly. */
1802 if (!NILP (echo_area_buffer
[0]))
1803 resize_echo_area_exactly ();
1805 if (!NILP (Vdeferred_action_list
))
1806 safe_run_hooks (Qdeferred_action_function
);
1808 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1810 if (NILP (Vunread_command_events
)
1811 && NILP (Vunread_input_method_events
)
1812 && NILP (Vunread_post_input_method_events
)
1813 && NILP (Vexecuting_macro
)
1814 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1815 safe_run_hooks (Qpost_command_idle_hook
);
1818 /* If there is a prefix argument,
1819 1) We don't want Vlast_command to be ``universal-argument''
1820 (that would be dumb), so don't set Vlast_command,
1821 2) we want to leave echoing on so that the prefix will be
1822 echoed as part of this key sequence, so don't call
1824 3) we want to leave this_command_key_count non-zero, so that
1825 read_char will realize that it is re-reading a character, and
1826 not echo it a second time.
1828 If the command didn't actually create a prefix arg,
1829 but is merely a frame event that is transparent to prefix args,
1830 then the above doesn't apply. */
1831 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1833 current_kboard
->Vlast_command
= Vthis_command
;
1834 current_kboard
->Vreal_last_command
= real_this_command
;
1836 this_command_key_count
= 0;
1837 this_command_key_count_reset
= 0;
1838 this_single_command_key_start
= 0;
1841 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1843 /* Setting transient-mark-mode to `only' is a way of
1844 turning it on for just one command. */
1846 if (EQ (Vtransient_mark_mode
, Qidentity
))
1847 Vtransient_mark_mode
= Qnil
;
1848 if (EQ (Vtransient_mark_mode
, Qonly
))
1849 Vtransient_mark_mode
= Qidentity
;
1851 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1853 /* We could also call `deactivate'mark'. */
1854 if (EQ (Vtransient_mark_mode
, Qlambda
))
1855 Vtransient_mark_mode
= Qnil
;
1858 current_buffer
->mark_active
= Qnil
;
1859 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1862 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1863 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1868 if (current_buffer
== prev_buffer
1869 && last_point_position
!= PT
1870 && NILP (Vdisable_point_adjustment
)
1871 && NILP (Vglobal_disable_point_adjustment
)
1872 && !already_adjusted
)
1873 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1875 /* Install chars successfully executed in kbd macro. */
1877 if (!NILP (current_kboard
->defining_kbd_macro
)
1878 && NILP (current_kboard
->Vprefix_arg
))
1879 finalize_kbd_macro_chars ();
1883 any_kboard_state ();
1888 extern Lisp_Object Qcomposition
, Qdisplay
;
1890 /* Adjust point to a boundary of a region that has such a property
1891 that should be treated intangible. For the moment, we check
1892 `composition', `display' and `invisible' properties.
1893 LAST_PT is the last position of point. */
1895 extern Lisp_Object Qafter_string
, Qbefore_string
;
1896 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1899 adjust_point_for_property (last_pt
, modified
)
1904 Lisp_Object val
, overlay
, tmp
;
1905 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1908 /* FIXME: cycling is probably not necessary because these properties
1909 can't be usefully combined anyway. */
1910 while (check_composition
|| check_display
|| check_invisible
)
1912 if (check_composition
1913 && PT
> BEGV
&& PT
< ZV
1914 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1915 && COMPOSITION_VALID_P (beg
, end
, val
)
1916 && beg
< PT
/* && end > PT <- It's always the case. */
1917 && (last_pt
<= beg
|| last_pt
>= end
))
1920 SET_PT (PT
< last_pt
? beg
: end
);
1921 check_display
= check_invisible
= 1;
1923 check_composition
= 0;
1925 && PT
> BEGV
&& PT
< ZV
1926 && !NILP (val
= get_char_property_and_overlay
1927 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1928 && display_prop_intangible_p (val
)
1929 && (!OVERLAYP (overlay
)
1930 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1931 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1932 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1933 && beg
< PT
) /* && end > PT <- It's always the case. */
1936 SET_PT (PT
< last_pt
? beg
: end
);
1937 check_composition
= check_invisible
= 1;
1940 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1942 int inv
, ellipsis
= 0;
1945 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1947 && !NILP (val
= get_char_property_and_overlay
1948 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1949 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1951 ellipsis
= ellipsis
|| inv
> 1
1952 || (OVERLAYP (overlay
)
1953 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1954 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1955 tmp
= Fnext_single_char_property_change
1956 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1957 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1960 && !NILP (val
= get_char_property_and_overlay
1961 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1962 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1964 ellipsis
= ellipsis
|| inv
> 1
1965 || (OVERLAYP (overlay
)
1966 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1967 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1968 tmp
= Fprevious_single_char_property_change
1969 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1970 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1973 /* Move away from the inside area. */
1974 if (beg
< PT
&& end
> PT
)
1976 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1977 /* We haven't moved yet (so we don't need to fear
1978 infinite-looping) and we were outside the range
1979 before (so either end of the range still corresponds
1980 to a move in the right direction): pretend we moved
1981 less than we actually did, so that we still have
1982 more freedom below in choosing which end of the range
1984 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1985 /* We either have moved already or the last point
1986 was already in the range: we don't get to choose
1987 which end of the range we have to go to. */
1988 : (PT
< last_pt
? beg
: end
));
1989 check_composition
= check_display
= 1;
1991 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1992 the point to something other than its argument, due to
1993 point-motion hooks, intangibility, etc. */
1994 xassert (PT
== beg
|| PT
== end
);
1997 /* Pretend the area doesn't exist if the buffer is not
1999 if (!modified
&& !ellipsis
&& beg
< end
)
2001 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2002 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2003 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2004 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2005 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2006 /* We've already moved as far as we can. Trying to go
2007 to the other end would mean moving backwards and thus
2008 could lead to an infinite loop. */
2010 else if (val
= get_pos_property (make_number (PT
),
2012 TEXT_PROP_MEANS_INVISIBLE (val
)
2013 && (val
= get_pos_property
2014 (make_number (PT
== beg
? end
: beg
),
2016 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2017 (check_composition
= check_display
= 1,
2018 SET_PT (PT
== beg
? end
: beg
));
2021 check_invisible
= 0;
2025 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2028 safe_run_hooks_1 (hook
)
2031 return call1 (Vrun_hooks
, Vinhibit_quit
);
2034 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2037 safe_run_hooks_error (data
)
2040 Lisp_Object args
[3];
2041 args
[0] = build_string ("Error in %s: %s");
2042 args
[1] = Vinhibit_quit
;
2045 return Fset (Vinhibit_quit
, Qnil
);
2048 /* If we get an error while running the hook, cause the hook variable
2049 to be nil. Also inhibit quits, so that C-g won't cause the hook
2050 to mysteriously evaporate. */
2053 safe_run_hooks (hook
)
2056 int count
= SPECPDL_INDEX ();
2057 specbind (Qinhibit_quit
, hook
);
2059 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2061 unbind_to (count
, Qnil
);
2065 /* Number of seconds between polling for input. This is a Lisp
2066 variable that can be bound. */
2068 EMACS_INT polling_period
;
2070 /* Nonzero means polling for input is temporarily suppressed. */
2072 int poll_suppress_count
;
2074 /* Asynchronous timer for polling. */
2076 struct atimer
*poll_timer
;
2079 #ifdef POLL_FOR_INPUT
2081 /* Poll for input, so what we catch a C-g if it comes in. This
2082 function is called from x_make_frame_visible, see comment
2088 if (interrupt_input_blocked
== 0
2089 && !waiting_for_input
)
2090 read_avail_input (0);
2093 /* Timer callback function for poll_timer. TIMER is equal to
2097 poll_for_input (timer
)
2098 struct atimer
*timer
;
2100 if (poll_suppress_count
== 0)
2101 poll_for_input_1 ();
2104 #endif /* POLL_FOR_INPUT */
2106 /* Begin signals to poll for input, if they are appropriate.
2107 This function is called unconditionally from various places. */
2112 #ifdef POLL_FOR_INPUT
2113 if (read_socket_hook
&& !interrupt_input
)
2115 /* Turn alarm handling on unconditionally. It might have
2116 been turned off in process.c. */
2117 turn_on_atimers (1);
2119 /* If poll timer doesn't exist, are we need one with
2120 a different interval, start a new one. */
2121 if (poll_timer
== NULL
2122 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2124 EMACS_TIME interval
;
2127 cancel_atimer (poll_timer
);
2129 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2130 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2131 poll_for_input
, NULL
);
2134 /* Let the timer's callback function poll for input
2135 if this becomes zero. */
2136 --poll_suppress_count
;
2141 /* Nonzero if we are using polling to handle input asynchronously. */
2144 input_polling_used ()
2146 #ifdef POLL_FOR_INPUT
2147 return read_socket_hook
&& !interrupt_input
;
2153 /* Turn off polling. */
2158 #ifdef POLL_FOR_INPUT
2159 if (read_socket_hook
&& !interrupt_input
)
2160 ++poll_suppress_count
;
2164 /* Set the value of poll_suppress_count to COUNT
2165 and start or stop polling accordingly. */
2168 set_poll_suppress_count (count
)
2171 #ifdef POLL_FOR_INPUT
2172 if (count
== 0 && poll_suppress_count
!= 0)
2174 poll_suppress_count
= 1;
2177 else if (count
!= 0 && poll_suppress_count
== 0)
2181 poll_suppress_count
= count
;
2185 /* Bind polling_period to a value at least N.
2186 But don't decrease it. */
2189 bind_polling_period (n
)
2192 #ifdef POLL_FOR_INPUT
2193 int new = polling_period
;
2198 stop_other_atimers (poll_timer
);
2200 specbind (Qpolling_period
, make_number (new));
2201 /* Start a new alarm with the new period. */
2206 /* Apply the control modifier to CHARACTER. */
2212 /* Save the upper bits here. */
2213 int upper
= c
& ~0177;
2217 /* Everything in the columns containing the upper-case letters
2218 denotes a control character. */
2219 if (c
>= 0100 && c
< 0140)
2223 /* Set the shift modifier for a control char
2224 made from a shifted letter. But only for letters! */
2225 if (oc
>= 'A' && oc
<= 'Z')
2226 c
|= shift_modifier
;
2229 /* The lower-case letters denote control characters too. */
2230 else if (c
>= 'a' && c
<= 'z')
2233 /* Include the bits for control and shift
2234 only if the basic ASCII code can't indicate them. */
2238 /* Replace the high bits. */
2239 c
|= (upper
& ~ctrl_modifier
);
2244 /* Display help echo in the echo area.
2246 HELP a string means display that string, HELP nil means clear the
2247 help echo. If HELP is a function, call it with OBJECT and POS as
2248 arguments; the function should return a help string or nil for
2249 none. For all other types of HELP evaluate it to obtain a string.
2251 WINDOW is the window in which the help was generated, if any.
2252 It is nil if not in a window.
2254 If OBJECT is a buffer, POS is the position in the buffer where the
2255 `help-echo' text property was found.
2257 If OBJECT is an overlay, that overlay has a `help-echo' property,
2258 and POS is the position in the overlay's buffer under the mouse.
2260 If OBJECT is a string (an overlay string or a string displayed with
2261 the `display' property). POS is the position in that string under
2264 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2265 echo overwrites a keystroke echo currently displayed in the echo
2268 Note: this function may only be called with HELP nil or a string
2269 from X code running asynchronously. */
2272 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2273 Lisp_Object help
, window
, object
, pos
;
2274 int ok_to_overwrite_keystroke_echo
;
2276 if (!NILP (help
) && !STRINGP (help
))
2278 if (FUNCTIONP (help
))
2280 Lisp_Object args
[4];
2285 help
= safe_call (4, args
);
2288 help
= safe_eval (help
);
2290 if (!STRINGP (help
))
2294 if (STRINGP (help
) || NILP (help
))
2296 if (!NILP (Vshow_help_function
))
2297 call1 (Vshow_help_function
, help
);
2298 else if (/* Don't overwrite minibuffer contents. */
2299 !MINI_WINDOW_P (XWINDOW (selected_window
))
2300 /* Don't overwrite a keystroke echo. */
2301 && (NILP (echo_message_buffer
)
2302 || ok_to_overwrite_keystroke_echo
)
2303 /* Don't overwrite a prompt. */
2304 && !cursor_in_echo_area
)
2308 int count
= SPECPDL_INDEX ();
2310 if (!help_echo_showing_p
)
2311 Vpre_help_message
= current_message ();
2313 specbind (Qmessage_truncate_lines
, Qt
);
2314 message3_nolog (help
, SBYTES (help
),
2315 STRING_MULTIBYTE (help
));
2316 unbind_to (count
, Qnil
);
2318 else if (STRINGP (Vpre_help_message
))
2320 message3_nolog (Vpre_help_message
,
2321 SBYTES (Vpre_help_message
),
2322 STRING_MULTIBYTE (Vpre_help_message
));
2323 Vpre_help_message
= Qnil
;
2329 help_echo_showing_p
= STRINGP (help
);
2335 /* Input of single characters from keyboard */
2337 Lisp_Object
print_help ();
2338 static Lisp_Object
kbd_buffer_get_event ();
2339 static void record_char ();
2342 static jmp_buf wrong_kboard_jmpbuf
;
2345 #define STOP_POLLING \
2346 do { if (! polling_stopped_here) stop_polling (); \
2347 polling_stopped_here = 1; } while (0)
2349 #define RESUME_POLLING \
2350 do { if (polling_stopped_here) start_polling (); \
2351 polling_stopped_here = 0; } while (0)
2353 /* read a character from the keyboard; call the redisplay if needed */
2354 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2355 -1 means do not do redisplay, but do do autosaving.
2358 /* The arguments MAPS and NMAPS are for menu prompting.
2359 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2361 PREV_EVENT is the previous input event, or nil if we are reading
2362 the first event of a key sequence (or not reading a key sequence).
2363 If PREV_EVENT is t, that is a "magic" value that says
2364 not to run input methods, but in other respects to act as if
2365 not reading a key sequence.
2367 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2368 if we used a mouse menu to read the input, or zero otherwise. If
2369 USED_MOUSE_MENU is null, we don't dereference it.
2371 Value is t if we showed a menu and the user rejected it. */
2374 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2378 Lisp_Object prev_event
;
2379 int *used_mouse_menu
;
2381 volatile Lisp_Object c
;
2383 jmp_buf local_getcjmp
;
2385 volatile int key_already_recorded
= 0;
2386 Lisp_Object tem
, save
;
2387 volatile Lisp_Object previous_echo_area_message
;
2388 volatile Lisp_Object also_record
;
2389 volatile int reread
;
2390 struct gcpro gcpro1
, gcpro2
;
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
));
2902 if (commandflag
>= 0
2903 && !input_pending
&& !detect_input_pending_run_timers (0))
2911 /* Buffer switch events are only for internal wakeups
2912 so don't show them to the user.
2913 Also, don't record a key if we already did. */
2914 if (BUFFERP (c
) || key_already_recorded
)
2917 /* Process special events within read_char
2918 and loop around to read another event. */
2921 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2926 int was_locked
= single_kboard
;
2928 last_input_char
= c
;
2929 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2931 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2932 /* We stopped being idle for this event; undo that. This
2933 prevents automatic window selection (under
2934 mouse_autoselect_window from acting as a real input event, for
2935 example banishing the mouse under mouse-avoidance-mode. */
2936 timer_resume_idle ();
2938 /* Resume allowing input from any kboard, if that was true before. */
2940 any_kboard_state ();
2945 /* Handle things that only apply to characters. */
2948 /* If kbd_buffer_get_event gave us an EOF, return that. */
2952 if ((STRINGP (Vkeyboard_translate_table
)
2953 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2954 || (VECTORP (Vkeyboard_translate_table
)
2955 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2956 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2957 && CHAR_VALID_P (XINT (c
), 0)))
2960 d
= Faref (Vkeyboard_translate_table
, c
);
2961 /* nil in keyboard-translate-table means no translation. */
2967 /* If this event is a mouse click in the menu bar,
2968 return just menu-bar for now. Modify the mouse click event
2969 so we won't do this twice, then queue it up. */
2970 if (EVENT_HAS_PARAMETERS (c
)
2972 && CONSP (EVENT_START (c
))
2973 && CONSP (XCDR (EVENT_START (c
))))
2977 posn
= POSN_POSN (EVENT_START (c
));
2978 /* Handle menu-bar events:
2979 insert the dummy prefix event `menu-bar'. */
2980 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2982 /* Change menu-bar to (menu-bar) as the event "position". */
2983 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2986 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2991 /* Store these characters into recent_keys, the dribble file if any,
2992 and the keyboard macro being defined, if any. */
2994 if (! NILP (also_record
))
2995 record_char (also_record
);
2997 /* Wipe the echo area.
2998 But first, if we are about to use an input method,
2999 save the echo area contents for it to refer to. */
3001 && ! NILP (Vinput_method_function
)
3002 && (unsigned) XINT (c
) >= ' '
3003 && (unsigned) XINT (c
) != 127
3004 && (unsigned) XINT (c
) < 256)
3006 previous_echo_area_message
= Fcurrent_message ();
3007 Vinput_method_previous_message
= previous_echo_area_message
;
3010 /* Now wipe the echo area, except for help events which do their
3011 own stuff with the echo area. */
3013 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3014 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3016 if (!NILP (echo_area_buffer
[0]))
3017 safe_run_hooks (Qecho_area_clear_hook
);
3018 clear_message (1, 0);
3021 reread_for_input_method
:
3023 /* Pass this to the input method, if appropriate. */
3025 && ! NILP (Vinput_method_function
)
3026 /* Don't run the input method within a key sequence,
3027 after the first event of the key sequence. */
3028 && NILP (prev_event
)
3029 && (unsigned) XINT (c
) >= ' '
3030 && (unsigned) XINT (c
) != 127
3031 && (unsigned) XINT (c
) < 256)
3034 int key_count
, key_count_reset
;
3035 struct gcpro gcpro1
;
3036 int count
= SPECPDL_INDEX ();
3038 /* Save the echo status. */
3039 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3040 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3041 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3044 if (before_command_restore_flag
)
3046 this_command_key_count
= before_command_key_count_1
;
3047 if (this_command_key_count
< this_single_command_key_start
)
3048 this_single_command_key_start
= this_command_key_count
;
3049 echo_truncate (before_command_echo_length_1
);
3050 before_command_restore_flag
= 0;
3054 /* Save the this_command_keys status. */
3055 key_count
= this_command_key_count
;
3056 key_count_reset
= this_command_key_count_reset
;
3059 keys
= Fcopy_sequence (this_command_keys
);
3064 /* Clear out this_command_keys. */
3065 this_command_key_count
= 0;
3066 this_command_key_count_reset
= 0;
3068 /* Now wipe the echo area. */
3069 if (!NILP (echo_area_buffer
[0]))
3070 safe_run_hooks (Qecho_area_clear_hook
);
3071 clear_message (1, 0);
3074 /* If we are not reading a key sequence,
3075 never use the echo area. */
3078 specbind (Qinput_method_use_echo_area
, Qt
);
3081 /* Call the input method. */
3082 tem
= call1 (Vinput_method_function
, c
);
3084 tem
= unbind_to (count
, tem
);
3086 /* Restore the saved echoing state
3087 and this_command_keys state. */
3088 this_command_key_count
= key_count
;
3089 this_command_key_count_reset
= key_count_reset
;
3091 this_command_keys
= keys
;
3094 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3095 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3096 if (saved_immediate_echo
)
3101 /* The input method can return no events. */
3104 /* Bring back the previous message, if any. */
3105 if (! NILP (previous_echo_area_message
))
3106 message_with_string ("%s", previous_echo_area_message
, 0);
3109 /* It returned one event or more. */
3111 Vunread_post_input_method_events
3112 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3117 /* Display help if not echoing. */
3118 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3120 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3121 Lisp_Object help
, object
, position
, window
, tem
;
3123 tem
= Fcdr (XCDR (c
));
3126 window
= Fcar (tem
);
3128 object
= Fcar (tem
);
3130 position
= Fcar (tem
);
3132 show_help_echo (help
, window
, object
, position
, 0);
3134 /* We stopped being idle for this event; undo that. */
3135 timer_resume_idle ();
3139 if (! reread
|| this_command_key_count
== 0
3140 || this_command_key_count_reset
)
3143 /* Don't echo mouse motion events. */
3144 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3145 && NILP (Fzerop (Vecho_keystrokes
))
3146 && ! (EVENT_HAS_PARAMETERS (c
)
3147 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3150 if (! NILP (also_record
))
3151 echo_char (also_record
);
3152 /* Once we reread a character, echoing can happen
3153 the next time we pause to read a new one. */
3154 ok_to_echo_at_next_pause
= current_kboard
;
3157 /* Record this character as part of the current key. */
3158 add_command_key (c
);
3159 if (! NILP (also_record
))
3160 add_command_key (also_record
);
3163 last_input_char
= c
;
3166 /* Process the help character specially if enabled */
3167 if (!NILP (Vhelp_form
) && help_char_p (c
))
3170 count
= SPECPDL_INDEX ();
3172 record_unwind_protect (Fset_window_configuration
,
3173 Fcurrent_window_configuration (Qnil
));
3175 tem0
= Feval (Vhelp_form
);
3177 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3181 c
= read_char (0, 0, 0, Qnil
, 0);
3182 while (BUFFERP (c
));
3183 /* Remove the help from the frame */
3184 unbind_to (count
, Qnil
);
3187 if (EQ (c
, make_number (040)))
3191 c
= read_char (0, 0, 0, Qnil
, 0);
3192 while (BUFFERP (c
));
3201 /* Record a key that came from a mouse menu.
3202 Record it for echoing, for this-command-keys, and so on. */
3208 /* Wipe the echo area. */
3209 clear_message (1, 0);
3214 before_command_key_count
= this_command_key_count
;
3215 before_command_echo_length
= echo_length ();
3218 /* Don't echo mouse motion events. */
3219 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3220 && NILP (Fzerop (Vecho_keystrokes
)))
3224 /* Once we reread a character, echoing can happen
3225 the next time we pause to read a new one. */
3226 ok_to_echo_at_next_pause
= 0;
3229 /* Record this character as part of the current key. */
3230 add_command_key (c
);
3232 /* Re-reading in the middle of a command */
3233 last_input_char
= c
;
3237 /* Return 1 if should recognize C as "the help character". */
3245 if (EQ (c
, Vhelp_char
))
3247 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3248 if (EQ (c
, XCAR (tail
)))
3253 /* Record the input event C in various ways. */
3261 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3263 /* To avoid filling recent_keys with help-echo and mouse-movement
3264 events, we filter out repeated help-echo events, only store the
3265 first and last in a series of mouse-movement events, and don't
3266 store repeated help-echo events which are only separated by
3267 mouse-movement events. */
3269 Lisp_Object ev1
, ev2
, ev3
;
3272 if ((ix1
= recent_keys_index
- 1) < 0)
3273 ix1
= NUM_RECENT_KEYS
- 1;
3274 ev1
= AREF (recent_keys
, ix1
);
3276 if ((ix2
= ix1
- 1) < 0)
3277 ix2
= NUM_RECENT_KEYS
- 1;
3278 ev2
= AREF (recent_keys
, ix2
);
3280 if ((ix3
= ix2
- 1) < 0)
3281 ix3
= NUM_RECENT_KEYS
- 1;
3282 ev3
= AREF (recent_keys
, ix3
);
3284 if (EQ (XCAR (c
), Qhelp_echo
))
3286 /* Don't record `help-echo' in recent_keys unless it shows some help
3287 message, and a different help than the previously recorded
3289 Lisp_Object help
, last_help
;
3291 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3292 if (!STRINGP (help
))
3294 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3295 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3297 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3298 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3299 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3301 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3302 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3303 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3304 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3307 else if (EQ (XCAR (c
), Qmouse_movement
))
3309 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3310 So additional mouse movement events replace the last element. */
3311 Lisp_Object last_window
, window
;
3313 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3314 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3315 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3316 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3317 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3319 ASET (recent_keys
, ix1
, c
);
3325 store_kbd_macro_char (c
);
3330 ASET (recent_keys
, recent_keys_index
, c
);
3331 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3332 recent_keys_index
= 0;
3334 else if (recorded
< 0)
3336 /* We need to remove one or two events from recent_keys.
3337 To do this, we simply put nil at those events and move the
3338 recent_keys_index backwards over those events. Usually,
3339 users will never see those nil events, as they will be
3340 overwritten by the command keys entered to see recent_keys
3343 while (recorded
++ < 0 && total_keys
> 0)
3345 if (total_keys
< NUM_RECENT_KEYS
)
3347 if (--recent_keys_index
< 0)
3348 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3349 ASET (recent_keys
, recent_keys_index
, Qnil
);
3353 num_nonmacro_input_events
++;
3355 /* Write c to the dribble file. If c is a lispy event, write
3356 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3357 If you, dear reader, have a better idea, you've got the source. :-) */
3362 if (XUINT (c
) < 0x100)
3363 putc (XINT (c
), dribble
);
3365 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3369 Lisp_Object dribblee
;
3371 /* If it's a structured event, take the event header. */
3372 dribblee
= EVENT_HEAD (c
);
3374 if (SYMBOLP (dribblee
))
3376 putc ('<', dribble
);
3377 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3378 SBYTES (SYMBOL_NAME (dribblee
)),
3380 putc ('>', dribble
);
3392 struct buffer
*old
= current_buffer
;
3393 Fprinc (object
, Qnil
);
3394 set_buffer_internal (XBUFFER (Vstandard_output
));
3395 call0 (intern ("help-mode"));
3396 set_buffer_internal (old
);
3400 /* Copy out or in the info on where C-g should throw to.
3401 This is used when running Lisp code from within get_char,
3402 in case get_char is called recursively.
3403 See read_process_output. */
3409 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3413 restore_getcjmp (temp
)
3416 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3421 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3422 of this function. */
3425 tracking_off (old_value
)
3426 Lisp_Object old_value
;
3428 do_mouse_tracking
= old_value
;
3429 if (NILP (old_value
))
3431 /* Redisplay may have been preempted because there was input
3432 available, and it assumes it will be called again after the
3433 input has been processed. If the only input available was
3434 the sort that we have just disabled, then we need to call
3436 if (!readable_events (1))
3438 redisplay_preserve_echo_area (6);
3439 get_input_pending (&input_pending
, 1);
3445 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3446 doc
: /* Evaluate BODY with mouse movement events enabled.
3447 Within a `track-mouse' form, mouse motion generates input events that
3448 you can read with `read-event'.
3449 Normally, mouse motion is ignored.
3450 usage: (track-mouse BODY ...) */)
3454 int count
= SPECPDL_INDEX ();
3457 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3459 do_mouse_tracking
= Qt
;
3461 val
= Fprogn (args
);
3462 return unbind_to (count
, val
);
3465 /* If mouse has moved on some frame, return one of those frames.
3466 Return 0 otherwise. */
3471 Lisp_Object tail
, frame
;
3473 FOR_EACH_FRAME (tail
, frame
)
3475 if (XFRAME (frame
)->mouse_moved
)
3476 return XFRAME (frame
);
3482 #endif /* HAVE_MOUSE */
3484 /* Low level keyboard/mouse input.
3485 kbd_buffer_store_event places events in kbd_buffer, and
3486 kbd_buffer_get_event retrieves them. */
3488 /* Return true iff there are any events in the queue that read-char
3489 would return. If this returns false, a read-char would block. */
3491 readable_filtered_events (do_timers_now
, filter_events
)
3496 timer_check (do_timers_now
);
3498 /* If the buffer contains only FOCUS_IN_EVENT events,
3499 and FILTER_EVENTS is nonzero, report it as empty. */
3500 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3502 int have_live_event
= 1;
3506 struct input_event
*event
;
3508 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3512 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3515 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3517 if (event
== kbd_store_ptr
)
3518 have_live_event
= 0;
3521 if (have_live_event
) return 1;
3525 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3530 if (current_kboard
->kbd_queue_has_data
)
3536 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3537 if (kb
->kbd_queue_has_data
)
3543 /* Return true iff there are any events in the queue that read-char
3544 would return. If this returns false, a read-char would block. */
3546 readable_events (do_timers_now
)
3549 return readable_filtered_events (do_timers_now
, 0);
3552 /* Set this for debugging, to have a way to get out */
3557 event_to_kboard (event
)
3558 struct input_event
*event
;
3561 frame
= event
->frame_or_window
;
3563 frame
= XCAR (frame
);
3564 else if (WINDOWP (frame
))
3565 frame
= WINDOW_FRAME (XWINDOW (frame
));
3567 /* There are still some events that don't set this field.
3568 For now, just ignore the problem.
3569 Also ignore dead frames here. */
3570 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3573 return FRAME_KBOARD (XFRAME (frame
));
3577 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3580 kbd_buffer_store_event (event
)
3581 register struct input_event
*event
;
3583 kbd_buffer_store_event_hold (event
, 0);
3586 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3588 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3589 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3590 Else, if EVENT is a quit event, store the quit event
3591 in HOLD_QUIT, and return (thus ignoring further events).
3593 This is used in read_avail_input to postpone the processing
3594 of the quit event until all subsequent input events have been
3595 parsed (and discarded).
3599 kbd_buffer_store_event_hold (event
, hold_quit
)
3600 register struct input_event
*event
;
3601 struct input_event
*hold_quit
;
3603 if (event
->kind
== NO_EVENT
)
3606 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3609 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3611 register int c
= event
->code
& 0377;
3613 if (event
->modifiers
& ctrl_modifier
)
3614 c
= make_ctrl_char (c
);
3616 c
|= (event
->modifiers
3617 & (meta_modifier
| alt_modifier
3618 | hyper_modifier
| super_modifier
));
3624 struct input_event
*sp
;
3627 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3628 kb
!= current_kboard
))
3631 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3632 Fcons (make_number (c
), Qnil
));
3633 kb
->kbd_queue_has_data
= 1;
3634 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3636 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3639 if (event_to_kboard (sp
) == kb
)
3641 sp
->kind
= NO_EVENT
;
3642 sp
->frame_or_window
= Qnil
;
3652 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3656 /* If this results in a quit_char being returned to Emacs as
3657 input, set Vlast_event_frame properly. If this doesn't
3658 get returned to Emacs as an event, the next event read
3659 will set Vlast_event_frame again, so this is safe to do. */
3663 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3665 focus
= event
->frame_or_window
;
3666 internal_last_event_frame
= focus
;
3667 Vlast_event_frame
= focus
;
3670 last_event_timestamp
= event
->timestamp
;
3671 interrupt_signal (0 /* dummy */);
3675 if (c
&& c
== stop_character
)
3681 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3682 Just ignore the second one. */
3683 else if (event
->kind
== BUFFER_SWITCH_EVENT
3684 && kbd_fetch_ptr
!= kbd_store_ptr
3685 && ((kbd_store_ptr
== kbd_buffer
3686 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3687 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3690 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3691 kbd_store_ptr
= kbd_buffer
;
3693 /* Don't let the very last slot in the buffer become full,
3694 since that would make the two pointers equal,
3695 and that is indistinguishable from an empty buffer.
3696 Discard the event if it would fill the last slot. */
3697 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3699 *kbd_store_ptr
= *event
;
3705 /* Put an input event back in the head of the event queue. */
3708 kbd_buffer_unget_event (event
)
3709 register struct input_event
*event
;
3711 if (kbd_fetch_ptr
== kbd_buffer
)
3712 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3714 /* Don't let the very last slot in the buffer become full, */
3715 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3718 *kbd_fetch_ptr
= *event
;
3723 /* Generate HELP_EVENT input_events in BUFP which has room for
3724 SIZE events. If there's not enough room in BUFP, ignore this
3727 HELP is the help form.
3729 FRAME is the frame on which the help is generated. OBJECT is the
3730 Lisp object where the help was found (a buffer, a string, an
3731 overlay, or nil if neither from a string nor from a buffer. POS is
3732 the position within OBJECT where the help was found.
3734 Value is the number of input_events generated. */
3737 gen_help_event (help
, frame
, window
, object
, pos
)
3738 Lisp_Object help
, frame
, object
, window
;
3741 struct input_event event
;
3745 event
.kind
= HELP_EVENT
;
3746 event
.frame_or_window
= frame
;
3748 event
.x
= WINDOWP (window
) ? window
: frame
;
3751 kbd_buffer_store_event (&event
);
3755 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3758 kbd_buffer_store_help_event (frame
, help
)
3759 Lisp_Object frame
, help
;
3761 struct input_event event
;
3763 event
.kind
= HELP_EVENT
;
3764 event
.frame_or_window
= frame
;
3769 kbd_buffer_store_event (&event
);
3773 /* Discard any mouse events in the event buffer by setting them to
3776 discard_mouse_events ()
3778 struct input_event
*sp
;
3779 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3781 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3784 if (sp
->kind
== MOUSE_CLICK_EVENT
3785 || sp
->kind
== WHEEL_EVENT
3787 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3789 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3791 sp
->kind
= NO_EVENT
;
3797 /* Return non-zero if there are any real events waiting in the event
3798 buffer, not counting `NO_EVENT's.
3800 If DISCARD is non-zero, discard NO_EVENT events at the front of
3801 the input queue, possibly leaving the input queue empty if there
3802 are no real input events. */
3805 kbd_buffer_events_waiting (discard
)
3808 struct input_event
*sp
;
3810 for (sp
= kbd_fetch_ptr
;
3811 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3814 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3821 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3825 /* Clear input event EVENT. */
3829 struct input_event
*event
;
3831 event
->kind
= NO_EVENT
;
3835 /* Read one event from the event buffer, waiting if necessary.
3836 The value is a Lisp object representing the event.
3837 The value is nil for an event that should be ignored,
3838 or that was handled here.
3839 We always read and discard one event. */
3842 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3844 int *used_mouse_menu
;
3853 *kbp
= current_kboard
;
3857 /* Wait until there is input available. */
3860 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3863 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3867 /* If the quit flag is set, then read_char will return
3868 quit_char, so that counts as "available input." */
3869 if (!NILP (Vquit_flag
))
3870 quit_throw_to_read_char ();
3872 /* One way or another, wait until input is available; then, if
3873 interrupt handlers have not read it, read it now. */
3876 wait_for_kbd_input ();
3878 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3882 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3885 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3889 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3891 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3892 /* Pass 1 for EXPECT since we just waited to have input. */
3893 read_avail_input (1);
3895 #endif /* not VMS */
3898 if (CONSP (Vunread_command_events
))
3901 first
= XCAR (Vunread_command_events
);
3902 Vunread_command_events
= XCDR (Vunread_command_events
);
3903 *kbp
= current_kboard
;
3907 /* At this point, we know that there is a readable event available
3908 somewhere. If the event queue is empty, then there must be a
3909 mouse movement enabled and available. */
3910 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3912 struct input_event
*event
;
3914 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3918 last_event_timestamp
= event
->timestamp
;
3921 *kbp
= event_to_kboard (event
);
3923 *kbp
= current_kboard
; /* Better than returning null ptr? */
3925 *kbp
= &the_only_kboard
;
3930 /* These two kinds of events get special handling
3931 and don't actually appear to the command loop.
3932 We return nil for them. */
3933 if (event
->kind
== SELECTION_REQUEST_EVENT
3934 || event
->kind
== SELECTION_CLEAR_EVENT
)
3937 struct input_event copy
;
3939 /* Remove it from the buffer before processing it,
3940 since otherwise swallow_events will see it
3941 and process it again. */
3943 kbd_fetch_ptr
= event
+ 1;
3944 input_pending
= readable_events (0);
3945 x_handle_selection_event (©
);
3947 /* We're getting selection request events, but we don't have
3953 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3954 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3956 /* Make an event (delete-frame (FRAME)). */
3957 obj
= Fcons (event
->frame_or_window
, Qnil
);
3958 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3959 kbd_fetch_ptr
= event
+ 1;
3962 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3963 else if (event
->kind
== ICONIFY_EVENT
)
3965 /* Make an event (iconify-frame (FRAME)). */
3966 obj
= Fcons (event
->frame_or_window
, Qnil
);
3967 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3968 kbd_fetch_ptr
= event
+ 1;
3970 else if (event
->kind
== DEICONIFY_EVENT
)
3972 /* Make an event (make-frame-visible (FRAME)). */
3973 obj
= Fcons (event
->frame_or_window
, Qnil
);
3974 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3975 kbd_fetch_ptr
= event
+ 1;
3978 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3980 /* The value doesn't matter here; only the type is tested. */
3981 XSETBUFFER (obj
, current_buffer
);
3982 kbd_fetch_ptr
= event
+ 1;
3984 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
3985 || defined (USE_GTK)
3986 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3988 kbd_fetch_ptr
= event
+ 1;
3989 input_pending
= readable_events (0);
3990 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3991 x_activate_menubar (XFRAME (event
->frame_or_window
));
3995 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3997 /* Make an event (language-change (FRAME CHARSET LCID)). */
3998 obj
= Fcons (event
->frame_or_window
, Qnil
);
3999 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4000 kbd_fetch_ptr
= event
+ 1;
4003 else if (event
->kind
== SAVE_SESSION_EVENT
)
4005 obj
= Fcons (Qsave_session
, Qnil
);
4006 kbd_fetch_ptr
= event
+ 1;
4008 /* Just discard these, by returning nil.
4009 With MULTI_KBOARD, these events are used as placeholders
4010 when we need to randomly delete events from the queue.
4011 (They shouldn't otherwise be found in the buffer,
4012 but on some machines it appears they do show up
4013 even without MULTI_KBOARD.) */
4014 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4015 mouse events during a popup-menu call. */
4016 else if (event
->kind
== NO_EVENT
)
4017 kbd_fetch_ptr
= event
+ 1;
4018 else if (event
->kind
== HELP_EVENT
)
4020 Lisp_Object object
, position
, help
, frame
, window
;
4022 frame
= event
->frame_or_window
;
4023 object
= event
->arg
;
4024 position
= make_number (event
->code
);
4027 clear_event (event
);
4029 kbd_fetch_ptr
= event
+ 1;
4030 if (!WINDOWP (window
))
4032 obj
= Fcons (Qhelp_echo
,
4033 list5 (frame
, help
, window
, object
, position
));
4035 else if (event
->kind
== FOCUS_IN_EVENT
)
4037 /* Notification of a FocusIn event. The frame receiving the
4038 focus is in event->frame_or_window. Generate a
4039 switch-frame event if necessary. */
4040 Lisp_Object frame
, focus
;
4042 frame
= event
->frame_or_window
;
4043 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4047 if (!EQ (frame
, internal_last_event_frame
)
4048 && !EQ (frame
, selected_frame
))
4049 obj
= make_lispy_switch_frame (frame
);
4050 internal_last_event_frame
= frame
;
4051 kbd_fetch_ptr
= event
+ 1;
4055 /* If this event is on a different frame, return a switch-frame this
4056 time, and leave the event in the queue for next time. */
4060 frame
= event
->frame_or_window
;
4062 frame
= XCAR (frame
);
4063 else if (WINDOWP (frame
))
4064 frame
= WINDOW_FRAME (XWINDOW (frame
));
4066 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4070 if (! EQ (frame
, internal_last_event_frame
)
4071 && !EQ (frame
, selected_frame
))
4072 obj
= make_lispy_switch_frame (frame
);
4073 internal_last_event_frame
= frame
;
4075 /* If we didn't decide to make a switch-frame event, go ahead
4076 and build a real event from the queue entry. */
4080 obj
= make_lispy_event (event
);
4082 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4083 || defined (USE_GTK)
4084 /* If this was a menu selection, then set the flag to inhibit
4085 writing to last_nonmenu_event. Don't do this if the event
4086 we're returning is (menu-bar), though; that indicates the
4087 beginning of the menu sequence, and we might as well leave
4088 that as the `event with parameters' for this selection. */
4090 && !EQ (event
->frame_or_window
, event
->arg
)
4091 && (event
->kind
== MENU_BAR_EVENT
4092 || event
->kind
== TOOL_BAR_EVENT
))
4093 *used_mouse_menu
= 1;
4096 /* Wipe out this event, to catch bugs. */
4097 clear_event (event
);
4098 kbd_fetch_ptr
= event
+ 1;
4103 /* Try generating a mouse motion event. */
4104 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4106 FRAME_PTR f
= some_mouse_moved ();
4107 Lisp_Object bar_window
;
4108 enum scroll_bar_part part
;
4112 *kbp
= current_kboard
;
4113 /* Note that this uses F to determine which display to look at.
4114 If there is no valid info, it does not store anything
4115 so x remains nil. */
4117 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4121 /* Decide if we should generate a switch-frame event. Don't
4122 generate switch-frame events for motion outside of all Emacs
4128 frame
= FRAME_FOCUS_FRAME (f
);
4130 XSETFRAME (frame
, f
);
4132 if (! EQ (frame
, internal_last_event_frame
)
4133 && !EQ (frame
, selected_frame
))
4134 obj
= make_lispy_switch_frame (frame
);
4135 internal_last_event_frame
= frame
;
4138 /* If we didn't decide to make a switch-frame event, go ahead and
4139 return a mouse-motion event. */
4140 if (!NILP (x
) && NILP (obj
))
4141 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4143 #endif /* HAVE_MOUSE */
4145 /* We were promised by the above while loop that there was
4146 something for us to read! */
4149 input_pending
= readable_events (0);
4151 Vlast_event_frame
= internal_last_event_frame
;
4156 /* Process any events that are not user-visible,
4157 then return, without reading any user-visible events. */
4160 swallow_events (do_display
)
4165 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4167 struct input_event
*event
;
4169 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4173 last_event_timestamp
= event
->timestamp
;
4175 /* These two kinds of events get special handling
4176 and don't actually appear to the command loop. */
4177 if (event
->kind
== SELECTION_REQUEST_EVENT
4178 || event
->kind
== SELECTION_CLEAR_EVENT
)
4181 struct input_event copy
;
4183 /* Remove it from the buffer before processing it,
4184 since otherwise swallow_events called recursively could see it
4185 and process it again. */
4187 kbd_fetch_ptr
= event
+ 1;
4188 input_pending
= readable_events (0);
4189 x_handle_selection_event (©
);
4191 /* We're getting selection request events, but we don't have
4200 old_timers_run
= timers_run
;
4201 get_input_pending (&input_pending
, 1);
4203 if (timers_run
!= old_timers_run
&& do_display
)
4204 redisplay_preserve_echo_area (7);
4207 /* Record the start of when Emacs is idle,
4208 for the sake of running idle-time timers. */
4215 /* If we are already in the idle state, do nothing. */
4216 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4219 EMACS_GET_TIME (timer_idleness_start_time
);
4221 timer_last_idleness_start_time
= timer_idleness_start_time
;
4223 /* Mark all idle-time timers as once again candidates for running. */
4224 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4228 timer
= XCAR (timers
);
4230 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4232 XVECTOR (timer
)->contents
[0] = Qnil
;
4236 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4241 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4244 /* Resume idle timer from last idle start time. */
4247 timer_resume_idle ()
4249 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4252 timer_idleness_start_time
= timer_last_idleness_start_time
;
4255 /* This is only for debugging. */
4256 struct input_event last_timer_event
;
4258 /* Check whether a timer has fired. To prevent larger problems we simply
4259 disregard elements that are not proper timers. Do not make a circular
4260 timer list for the time being.
4262 Returns the number of seconds to wait until the next timer fires. If a
4263 timer is triggering now, return zero seconds.
4264 If no timer is active, return -1 seconds.
4266 If a timer is ripe, we run it, with quitting turned off.
4268 DO_IT_NOW is now ignored. It used to mean that we should
4269 run the timer directly instead of queueing a timer-event.
4270 Now we always run timers directly. */
4273 timer_check (do_it_now
)
4276 EMACS_TIME nexttime
;
4277 EMACS_TIME now
, idleness_now
;
4278 Lisp_Object timers
, idle_timers
, chosen_timer
;
4279 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4281 EMACS_SET_SECS (nexttime
, -1);
4282 EMACS_SET_USECS (nexttime
, -1);
4284 /* Always consider the ordinary timers. */
4285 timers
= Vtimer_list
;
4286 /* Consider the idle timers only if Emacs is idle. */
4287 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4288 idle_timers
= Vtimer_idle_list
;
4291 chosen_timer
= Qnil
;
4292 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4294 if (CONSP (timers
) || CONSP (idle_timers
))
4296 EMACS_GET_TIME (now
);
4297 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4298 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4301 while (CONSP (timers
) || CONSP (idle_timers
))
4303 Lisp_Object
*vector
;
4304 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4305 EMACS_TIME timer_time
, idle_timer_time
;
4306 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4308 /* Skip past invalid timers and timers already handled. */
4311 timer
= XCAR (timers
);
4312 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4314 timers
= XCDR (timers
);
4317 vector
= XVECTOR (timer
)->contents
;
4319 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4320 || !INTEGERP (vector
[3])
4321 || ! NILP (vector
[0]))
4323 timers
= XCDR (timers
);
4327 if (!NILP (idle_timers
))
4329 timer
= XCAR (idle_timers
);
4330 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4332 idle_timers
= XCDR (idle_timers
);
4335 vector
= XVECTOR (timer
)->contents
;
4337 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4338 || !INTEGERP (vector
[3])
4339 || ! NILP (vector
[0]))
4341 idle_timers
= XCDR (idle_timers
);
4346 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4347 based on the next ordinary timer.
4348 TIMER_DIFFERENCE is the distance in time from NOW to when
4349 this timer becomes ripe (negative if it's already ripe). */
4352 timer
= XCAR (timers
);
4353 vector
= XVECTOR (timer
)->contents
;
4354 EMACS_SET_SECS (timer_time
,
4355 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4356 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4357 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4360 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4361 based on the next idle timer. */
4362 if (!NILP (idle_timers
))
4364 idle_timer
= XCAR (idle_timers
);
4365 vector
= XVECTOR (idle_timer
)->contents
;
4366 EMACS_SET_SECS (idle_timer_time
,
4367 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4368 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4369 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4372 /* Decide which timer is the next timer,
4373 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4374 Also step down the list where we found that timer. */
4376 if (! NILP (timers
) && ! NILP (idle_timers
))
4379 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4380 if (EMACS_TIME_NEG_P (temp
))
4382 chosen_timer
= timer
;
4383 timers
= XCDR (timers
);
4384 difference
= timer_difference
;
4388 chosen_timer
= idle_timer
;
4389 idle_timers
= XCDR (idle_timers
);
4390 difference
= idle_timer_difference
;
4393 else if (! NILP (timers
))
4395 chosen_timer
= timer
;
4396 timers
= XCDR (timers
);
4397 difference
= timer_difference
;
4401 chosen_timer
= idle_timer
;
4402 idle_timers
= XCDR (idle_timers
);
4403 difference
= idle_timer_difference
;
4405 vector
= XVECTOR (chosen_timer
)->contents
;
4407 /* If timer is ripe, run it if it hasn't been run. */
4408 if (EMACS_TIME_NEG_P (difference
)
4409 || (EMACS_SECS (difference
) == 0
4410 && EMACS_USECS (difference
) == 0))
4412 if (NILP (vector
[0]))
4414 int was_locked
= single_kboard
;
4415 int count
= SPECPDL_INDEX ();
4416 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4418 /* Mark the timer as triggered to prevent problems if the lisp
4419 code fails to reschedule it right. */
4422 specbind (Qinhibit_quit
, Qt
);
4424 call1 (Qtimer_event_handler
, chosen_timer
);
4425 Vdeactivate_mark
= old_deactivate_mark
;
4427 unbind_to (count
, Qnil
);
4429 /* Resume allowing input from any kboard, if that was true before. */
4431 any_kboard_state ();
4433 /* Since we have handled the event,
4434 we don't need to tell the caller to wake up and do it. */
4438 /* When we encounter a timer that is still waiting,
4439 return the amount of time to wait before it is ripe. */
4446 /* No timers are pending in the future. */
4447 /* Return 0 if we generated an event, and -1 if not. */
4452 /* Caches for modify_event_symbol. */
4453 static Lisp_Object accent_key_syms
;
4454 static Lisp_Object func_key_syms
;
4455 static Lisp_Object mouse_syms
;
4456 static Lisp_Object wheel_syms
;
4457 static Lisp_Object drag_n_drop_syms
;
4459 /* This is a list of keysym codes for special "accent" characters.
4460 It parallels lispy_accent_keys. */
4462 static int lispy_accent_codes
[] =
4464 #ifdef XK_dead_circumflex
4469 #ifdef XK_dead_grave
4474 #ifdef XK_dead_tilde
4479 #ifdef XK_dead_diaeresis
4484 #ifdef XK_dead_macron
4489 #ifdef XK_dead_degree
4494 #ifdef XK_dead_acute
4499 #ifdef XK_dead_cedilla
4504 #ifdef XK_dead_breve
4509 #ifdef XK_dead_ogonek
4514 #ifdef XK_dead_caron
4519 #ifdef XK_dead_doubleacute
4520 XK_dead_doubleacute
,
4524 #ifdef XK_dead_abovedot
4529 #ifdef XK_dead_abovering
4539 #ifdef XK_dead_belowdot
4544 #ifdef XK_dead_voiced_sound
4545 XK_dead_voiced_sound
,
4549 #ifdef XK_dead_semivoiced_sound
4550 XK_dead_semivoiced_sound
,
4566 /* This is a list of Lisp names for special "accent" characters.
4567 It parallels lispy_accent_codes. */
4569 static char *lispy_accent_keys
[] =
4587 "dead-voiced-sound",
4588 "dead-semivoiced-sound",
4594 #define FUNCTION_KEY_OFFSET 0x0
4596 char *lispy_function_keys
[] =
4600 0, /* VK_LBUTTON 0x01 */
4601 0, /* VK_RBUTTON 0x02 */
4602 "cancel", /* VK_CANCEL 0x03 */
4603 0, /* VK_MBUTTON 0x04 */
4605 0, 0, 0, /* 0x05 .. 0x07 */
4607 "backspace", /* VK_BACK 0x08 */
4608 "tab", /* VK_TAB 0x09 */
4610 0, 0, /* 0x0A .. 0x0B */
4612 "clear", /* VK_CLEAR 0x0C */
4613 "return", /* VK_RETURN 0x0D */
4615 0, 0, /* 0x0E .. 0x0F */
4617 0, /* VK_SHIFT 0x10 */
4618 0, /* VK_CONTROL 0x11 */
4619 0, /* VK_MENU 0x12 */
4620 "pause", /* VK_PAUSE 0x13 */
4621 "capslock", /* VK_CAPITAL 0x14 */
4623 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4625 "escape", /* VK_ESCAPE 0x1B */
4627 0, 0, 0, 0, /* 0x1C .. 0x1F */
4629 0, /* VK_SPACE 0x20 */
4630 "prior", /* VK_PRIOR 0x21 */
4631 "next", /* VK_NEXT 0x22 */
4632 "end", /* VK_END 0x23 */
4633 "home", /* VK_HOME 0x24 */
4634 "left", /* VK_LEFT 0x25 */
4635 "up", /* VK_UP 0x26 */
4636 "right", /* VK_RIGHT 0x27 */
4637 "down", /* VK_DOWN 0x28 */
4638 "select", /* VK_SELECT 0x29 */
4639 "print", /* VK_PRINT 0x2A */
4640 "execute", /* VK_EXECUTE 0x2B */
4641 "snapshot", /* VK_SNAPSHOT 0x2C */
4642 "insert", /* VK_INSERT 0x2D */
4643 "delete", /* VK_DELETE 0x2E */
4644 "help", /* VK_HELP 0x2F */
4646 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4648 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4650 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4652 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4654 0, 0, 0, 0, 0, 0, 0, 0, 0,
4655 0, 0, 0, 0, 0, 0, 0, 0, 0,
4656 0, 0, 0, 0, 0, 0, 0, 0,
4658 "lwindow", /* VK_LWIN 0x5B */
4659 "rwindow", /* VK_RWIN 0x5C */
4660 "apps", /* VK_APPS 0x5D */
4662 0, 0, /* 0x5E .. 0x5F */
4664 "kp-0", /* VK_NUMPAD0 0x60 */
4665 "kp-1", /* VK_NUMPAD1 0x61 */
4666 "kp-2", /* VK_NUMPAD2 0x62 */
4667 "kp-3", /* VK_NUMPAD3 0x63 */
4668 "kp-4", /* VK_NUMPAD4 0x64 */
4669 "kp-5", /* VK_NUMPAD5 0x65 */
4670 "kp-6", /* VK_NUMPAD6 0x66 */
4671 "kp-7", /* VK_NUMPAD7 0x67 */
4672 "kp-8", /* VK_NUMPAD8 0x68 */
4673 "kp-9", /* VK_NUMPAD9 0x69 */
4674 "kp-multiply", /* VK_MULTIPLY 0x6A */
4675 "kp-add", /* VK_ADD 0x6B */
4676 "kp-separator", /* VK_SEPARATOR 0x6C */
4677 "kp-subtract", /* VK_SUBTRACT 0x6D */
4678 "kp-decimal", /* VK_DECIMAL 0x6E */
4679 "kp-divide", /* VK_DIVIDE 0x6F */
4680 "f1", /* VK_F1 0x70 */
4681 "f2", /* VK_F2 0x71 */
4682 "f3", /* VK_F3 0x72 */
4683 "f4", /* VK_F4 0x73 */
4684 "f5", /* VK_F5 0x74 */
4685 "f6", /* VK_F6 0x75 */
4686 "f7", /* VK_F7 0x76 */
4687 "f8", /* VK_F8 0x77 */
4688 "f9", /* VK_F9 0x78 */
4689 "f10", /* VK_F10 0x79 */
4690 "f11", /* VK_F11 0x7A */
4691 "f12", /* VK_F12 0x7B */
4692 "f13", /* VK_F13 0x7C */
4693 "f14", /* VK_F14 0x7D */
4694 "f15", /* VK_F15 0x7E */
4695 "f16", /* VK_F16 0x7F */
4696 "f17", /* VK_F17 0x80 */
4697 "f18", /* VK_F18 0x81 */
4698 "f19", /* VK_F19 0x82 */
4699 "f20", /* VK_F20 0x83 */
4700 "f21", /* VK_F21 0x84 */
4701 "f22", /* VK_F22 0x85 */
4702 "f23", /* VK_F23 0x86 */
4703 "f24", /* VK_F24 0x87 */
4705 0, 0, 0, 0, /* 0x88 .. 0x8B */
4706 0, 0, 0, 0, /* 0x8C .. 0x8F */
4708 "kp-numlock", /* VK_NUMLOCK 0x90 */
4709 "scroll", /* VK_SCROLL 0x91 */
4711 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4712 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4713 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4714 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4715 "kp-end", /* VK_NUMPAD_END 0x96 */
4716 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4717 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4718 "kp-up", /* VK_NUMPAD_UP 0x99 */
4719 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4720 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4721 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4722 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4724 0, 0, /* 0x9E .. 0x9F */
4727 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4728 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4729 * No other API or message will distinguish left and right keys this way.
4733 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4734 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4735 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4736 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4737 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4743 "attn", /* VK_ATTN 0xF6 */
4744 "crsel", /* VK_CRSEL 0xF7 */
4745 "exsel", /* VK_EXSEL 0xF8 */
4746 "ereof", /* VK_EREOF 0xF9 */
4747 "play", /* VK_PLAY 0xFA */
4748 "zoom", /* VK_ZOOM 0xFB */
4749 "noname", /* VK_NONAME 0xFC */
4750 "pa1", /* VK_PA1 0xFD */
4751 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4755 #else /* not HAVE_NTGUI */
4757 /* This should be dealt with in XTread_socket now, and that doesn't
4758 depend on the client system having the Kana syms defined. See also
4759 the XK_kana_A case below. */
4762 static char *lispy_kana_keys
[] =
4764 /* X Keysym value */
4765 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4766 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4767 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4768 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4769 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4770 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4771 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4772 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4773 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4774 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4775 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4776 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4777 "kana-i", "kana-u", "kana-e", "kana-o",
4778 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4779 "prolongedsound", "kana-A", "kana-I", "kana-U",
4780 "kana-E", "kana-O", "kana-KA", "kana-KI",
4781 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4782 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4783 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4784 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4785 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4786 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4787 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4788 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4789 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4790 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4791 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4792 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4794 #endif /* XK_kana_A */
4797 #define FUNCTION_KEY_OFFSET 0xff00
4799 /* You'll notice that this table is arranged to be conveniently
4800 indexed by X Windows keysym values. */
4801 static char *lispy_function_keys
[] =
4803 /* X Keysym value */
4805 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4806 "backspace", "tab", "linefeed", "clear",
4808 0, 0, 0, "pause", /* 0xff10...1f */
4809 0, 0, 0, 0, 0, 0, 0, "escape",
4811 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4812 "romaji", "hiragana", "katakana", "hiragana-katakana",
4813 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4814 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4815 "eisu-toggle", /* 0xff30...3f */
4816 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4817 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4819 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4820 "down", "prior", "next", "end",
4821 "begin", 0, 0, 0, 0, 0, 0, 0,
4822 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4833 "break", /* 0xff6b */
4836 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4837 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4838 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4839 0, 0, 0, 0, 0, 0, 0, 0,
4840 "kp-tab", /* 0xff89 */
4842 "kp-enter", /* 0xff8d */
4844 "kp-f1", /* 0xff91 */
4848 "kp-home", /* 0xff95 */
4853 "kp-prior", /* kp-page-up */
4854 "kp-next", /* kp-page-down */
4860 0, 0, 0, 0, 0, 0, 0, 0, 0,
4861 "kp-multiply", /* 0xffaa */
4866 "kp-divide", /* 0xffaf */
4867 "kp-0", /* 0xffb0 */
4868 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4871 "kp-equal", /* 0xffbd */
4872 "f1", /* 0xffbe */ /* IsFunctionKey */
4874 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4875 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4876 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4877 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4878 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4879 0, 0, 0, 0, 0, 0, 0, 0,
4880 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4881 0, 0, 0, 0, 0, 0, 0, "delete"
4884 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4885 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4887 static char *iso_lispy_function_keys
[] =
4889 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4890 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4891 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4892 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4893 "iso-lefttab", /* 0xfe20 */
4894 "iso-move-line-up", "iso-move-line-down",
4895 "iso-partial-line-up", "iso-partial-line-down",
4896 "iso-partial-space-left", "iso-partial-space-right",
4897 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4898 "iso-release-margin-left", "iso-release-margin-right",
4899 "iso-release-both-margins",
4900 "iso-fast-cursor-left", "iso-fast-cursor-right",
4901 "iso-fast-cursor-up", "iso-fast-cursor-down",
4902 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4903 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4906 #endif /* not HAVE_NTGUI */
4908 Lisp_Object Vlispy_mouse_stem
;
4910 static char *lispy_wheel_names
[] =
4912 "wheel-up", "wheel-down"
4915 /* drag-n-drop events are generated when a set of selected files are
4916 dragged from another application and dropped onto an Emacs window. */
4917 static char *lispy_drag_n_drop_names
[] =
4922 /* Scroll bar parts. */
4923 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4924 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4925 Lisp_Object Qtop
, Qratio
;
4927 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4928 Lisp_Object
*scroll_bar_parts
[] = {
4929 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4930 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4933 /* User signal events. */
4934 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4936 Lisp_Object
*lispy_user_signals
[] =
4938 &Qusr1_signal
, &Qusr2_signal
4942 /* A vector, indexed by button number, giving the down-going location
4943 of currently depressed buttons, both scroll bar and non-scroll bar.
4945 The elements have the form
4946 (BUTTON-NUMBER MODIFIER-MASK . REST)
4947 where REST is the cdr of a position as it would be reported in the event.
4949 The make_lispy_event function stores positions here to tell the
4950 difference between click and drag events, and to store the starting
4951 location to be included in drag events. */
4953 static Lisp_Object button_down_location
;
4955 /* Information about the most recent up-going button event: Which
4956 button, what location, and what time. */
4958 static int last_mouse_button
;
4959 static int last_mouse_x
;
4960 static int last_mouse_y
;
4961 static unsigned long button_down_time
;
4963 /* The maximum time between clicks to make a double-click, or Qnil to
4964 disable double-click detection, or Qt for no time limit. */
4966 Lisp_Object Vdouble_click_time
;
4968 /* Maximum number of pixels the mouse may be moved between clicks
4969 to make a double-click. */
4971 EMACS_INT double_click_fuzz
;
4973 /* The number of clicks in this multiple-click. */
4975 int double_click_count
;
4977 /* Return position of a mouse click or wheel event */
4980 make_lispy_position (f
, x
, y
, time
)
4986 enum window_part part
;
4987 Lisp_Object posn
= Qnil
;
4988 Lisp_Object extra_info
= Qnil
;
4991 /* Set `window' to the window under frame pixel coordinates (x,y) */
4993 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
4994 &part
, &wx
, &wy
, 0);
4998 if (WINDOWP (window
))
5000 /* It's a click in window window at frame coordinates (x,y) */
5001 struct window
*w
= XWINDOW (window
);
5002 Lisp_Object string_info
= Qnil
;
5003 int textpos
= -1, rx
= -1, ry
= -1;
5004 int dx
= -1, dy
= -1;
5005 int width
= -1, height
= -1;
5006 Lisp_Object object
= Qnil
;
5008 /* Set event coordinates to window-relative coordinates
5009 for constructing the Lisp event below. */
5013 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5015 /* Mode line or header line. Look for a string under
5016 the mouse that may have a `local-map' property. */
5020 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5022 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5023 &object
, &dx
, &dy
, &width
, &height
);
5024 if (STRINGP (string
))
5025 string_info
= Fcons (string
, make_number (charpos
));
5026 if (w
== XWINDOW (selected_window
))
5029 textpos
= XMARKER (w
->pointm
)->charpos
;
5031 else if (part
== ON_VERTICAL_BORDER
)
5033 posn
= Qvertical_line
;
5038 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5043 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5045 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5046 &object
, &dx
, &dy
, &width
, &height
);
5047 if (STRINGP (string
))
5048 string_info
= Fcons (string
, make_number (charpos
));
5050 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
5052 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
5055 if (part
== ON_RIGHT_FRINGE
)
5056 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5057 + window_box_width (w
, TEXT_AREA
)
5058 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5059 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5061 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5062 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5067 Lisp_Object string2
, object2
= Qnil
;
5068 struct display_pos p
;
5070 int width2
, height2
;
5071 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5072 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5073 &object2
, &dx2
, &dy2
,
5075 textpos
= CHARPOS (p
.pos
);
5076 if (rx
< 0) rx
= wx
;
5077 if (ry
< 0) ry
= wy
;
5078 if (dx
< 0) dx
= dx2
;
5079 if (dy
< 0) dy
= dy2
;
5080 if (width
< 0) width
= width2
;
5081 if (height
< 0) height
= height2
;
5085 posn
= make_number (textpos
);
5086 if (STRINGP (string2
))
5087 string_info
= Fcons (string2
,
5088 make_number (CHARPOS (p
.string_pos
)));
5094 #ifdef HAVE_WINDOW_SYSTEM
5095 if (IMAGEP (object
))
5097 Lisp_Object image_map
, hotspot
;
5098 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5100 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5102 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5103 posn
= XCAR (hotspot
);
5108 extra_info
= Fcons (object
,
5109 Fcons (Fcons (make_number (dx
),
5111 Fcons (Fcons (make_number (width
),
5112 make_number (height
)),
5116 extra_info
= Fcons (string_info
,
5117 Fcons (make_number (textpos
),
5118 Fcons (Fcons (make_number (rx
),
5124 XSETFRAME (window
, f
);
5129 XSETFASTINT (*x
, 0);
5130 XSETFASTINT (*y
, 0);
5133 return Fcons (window
,
5135 Fcons (Fcons (*x
, *y
),
5136 Fcons (make_number (time
),
5140 /* Given a struct input_event, build the lisp event which represents
5141 it. If EVENT is 0, build a mouse movement event from the mouse
5142 movement buffer, which should have a movement event in it.
5144 Note that events must be passed to this function in the order they
5145 are received; this function stores the location of button presses
5146 in order to build drag events when the button is released. */
5149 make_lispy_event (event
)
5150 struct input_event
*event
;
5154 switch (SWITCH_ENUM_CAST (event
->kind
))
5156 /* A simple keystroke. */
5157 case ASCII_KEYSTROKE_EVENT
:
5159 Lisp_Object lispy_c
;
5160 int c
= event
->code
& 0377;
5161 /* Turn ASCII characters into control characters
5163 if (event
->modifiers
& ctrl_modifier
)
5164 c
= make_ctrl_char (c
);
5166 /* Add in the other modifier bits. We took care of ctrl_modifier
5167 just above, and the shift key was taken care of by the X code,
5168 and applied to control characters by make_ctrl_char. */
5169 c
|= (event
->modifiers
5170 & (meta_modifier
| alt_modifier
5171 | hyper_modifier
| super_modifier
));
5172 /* Distinguish Shift-SPC from SPC. */
5173 if ((event
->code
& 0377) == 040
5174 && event
->modifiers
& shift_modifier
)
5175 c
|= shift_modifier
;
5176 button_down_time
= 0;
5177 XSETFASTINT (lispy_c
, c
);
5181 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5183 Lisp_Object lispy_c
;
5184 int c
= event
->code
;
5186 /* Add in the other modifier bits. We took care of ctrl_modifier
5187 just above, and the shift key was taken care of by the X code,
5188 and applied to control characters by make_ctrl_char. */
5189 c
|= (event
->modifiers
5190 & (meta_modifier
| alt_modifier
5191 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5192 /* What about the `shift' modifier ? */
5193 button_down_time
= 0;
5194 XSETFASTINT (lispy_c
, c
);
5198 /* A function key. The symbol may need to have modifier prefixes
5200 case NON_ASCII_KEYSTROKE_EVENT
:
5201 button_down_time
= 0;
5203 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5204 if (event
->code
== lispy_accent_codes
[i
])
5205 return modify_event_symbol (i
,
5207 Qfunction_key
, Qnil
,
5208 lispy_accent_keys
, &accent_key_syms
,
5209 (sizeof (lispy_accent_keys
)
5210 / sizeof (lispy_accent_keys
[0])));
5214 if (event
->code
>= 0x400 && event
->code
< 0x500)
5215 return modify_event_symbol (event
->code
- 0x400,
5216 event
->modifiers
& ~shift_modifier
,
5217 Qfunction_key
, Qnil
,
5218 lispy_kana_keys
, &func_key_syms
,
5219 (sizeof (lispy_kana_keys
)
5220 / sizeof (lispy_kana_keys
[0])));
5221 #endif /* XK_kana_A */
5224 #ifdef ISO_FUNCTION_KEY_OFFSET
5225 if (event
->code
< FUNCTION_KEY_OFFSET
5226 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5227 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5229 Qfunction_key
, Qnil
,
5230 iso_lispy_function_keys
, &func_key_syms
,
5231 (sizeof (iso_lispy_function_keys
)
5232 / sizeof (iso_lispy_function_keys
[0])));
5235 /* Handle system-specific or unknown keysyms. */
5236 if (event
->code
& (1 << 28)
5237 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5238 || (event
->code
- FUNCTION_KEY_OFFSET
5239 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5240 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5242 /* We need to use an alist rather than a vector as the cache
5243 since we can't make a vector long enuf. */
5244 if (NILP (current_kboard
->system_key_syms
))
5245 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5246 return modify_event_symbol (event
->code
,
5249 current_kboard
->Vsystem_key_alist
,
5250 0, ¤t_kboard
->system_key_syms
,
5254 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5256 Qfunction_key
, Qnil
,
5257 lispy_function_keys
, &func_key_syms
,
5258 (sizeof (lispy_function_keys
)
5259 / sizeof (lispy_function_keys
[0])));
5262 /* A mouse click. Figure out where it is, decide whether it's
5263 a press, click or drag, and build the appropriate structure. */
5264 case MOUSE_CLICK_EVENT
:
5265 #ifndef USE_TOOLKIT_SCROLL_BARS
5266 case SCROLL_BAR_CLICK_EVENT
:
5269 int button
= event
->code
;
5271 Lisp_Object position
;
5272 Lisp_Object
*start_pos_ptr
;
5273 Lisp_Object start_pos
;
5277 /* Build the position as appropriate for this mouse click. */
5278 if (event
->kind
== MOUSE_CLICK_EVENT
)
5280 struct frame
*f
= XFRAME (event
->frame_or_window
);
5281 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5285 /* Ignore mouse events that were made on frame that
5286 have been deleted. */
5287 if (! FRAME_LIVE_P (f
))
5290 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5291 /* EVENT->x and EVENT->y are frame-relative pixel
5292 coordinates at this place. Under old redisplay, COLUMN
5293 and ROW are set to frame relative glyph coordinates
5294 which are then used to determine whether this click is
5295 in a menu (non-toolkit version). */
5296 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5297 &column
, &row
, NULL
, 1);
5299 /* In the non-toolkit version, clicks on the menu bar
5300 are ordinary button events in the event buffer.
5301 Distinguish them, and invoke the menu.
5303 (In the toolkit version, the toolkit handles the menu bar
5304 and Emacs doesn't know about it until after the user
5305 makes a selection.) */
5306 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5307 && (event
->modifiers
& down_modifier
))
5309 Lisp_Object items
, item
;
5314 /* Activate the menu bar on the down event. If the
5315 up event comes in before the menu code can deal with it,
5317 if (! (event
->modifiers
& down_modifier
))
5321 /* Find the menu bar item under `column'. */
5323 items
= FRAME_MENU_BAR_ITEMS (f
);
5324 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5326 Lisp_Object pos
, string
;
5327 string
= AREF (items
, i
+ 1);
5328 pos
= AREF (items
, i
+ 3);
5331 if (column
>= XINT (pos
)
5332 && column
< XINT (pos
) + SCHARS (string
))
5334 item
= AREF (items
, i
);
5339 /* ELisp manual 2.4b says (x y) are window relative but
5340 code says they are frame-relative. */
5342 = Fcons (event
->frame_or_window
,
5344 Fcons (Fcons (event
->x
, event
->y
),
5345 Fcons (make_number (event
->timestamp
),
5348 return Fcons (item
, Fcons (position
, Qnil
));
5350 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5352 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5355 #ifndef USE_TOOLKIT_SCROLL_BARS
5358 /* It's a scrollbar click. */
5360 Lisp_Object portion_whole
;
5363 window
= event
->frame_or_window
;
5364 portion_whole
= Fcons (event
->x
, event
->y
);
5365 part
= *scroll_bar_parts
[(int) event
->part
];
5369 Fcons (Qvertical_scroll_bar
,
5370 Fcons (portion_whole
,
5371 Fcons (make_number (event
->timestamp
),
5372 Fcons (part
, Qnil
)))));
5374 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5376 if (button
>= ASIZE (button_down_location
))
5378 button_down_location
= larger_vector (button_down_location
,
5380 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5383 start_pos_ptr
= &AREF (button_down_location
, button
);
5384 start_pos
= *start_pos_ptr
;
5385 *start_pos_ptr
= Qnil
;
5388 /* On window-system frames, use the value of
5389 double-click-fuzz as is. On other frames, interpret it
5390 as a multiple of 1/8 characters. */
5394 if (WINDOWP (event
->frame_or_window
))
5395 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5396 else if (FRAMEP (event
->frame_or_window
))
5397 f
= XFRAME (event
->frame_or_window
);
5401 if (FRAME_WINDOW_P (f
))
5402 fuzz
= double_click_fuzz
;
5404 fuzz
= double_click_fuzz
/ 8;
5406 is_double
= (button
== last_mouse_button
5407 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5408 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5409 && button_down_time
!= 0
5410 && (EQ (Vdouble_click_time
, Qt
)
5411 || (INTEGERP (Vdouble_click_time
)
5412 && ((int)(event
->timestamp
- button_down_time
)
5413 < XINT (Vdouble_click_time
)))));
5416 last_mouse_button
= button
;
5417 last_mouse_x
= XINT (event
->x
);
5418 last_mouse_y
= XINT (event
->y
);
5420 /* If this is a button press, squirrel away the location, so
5421 we can decide later whether it was a click or a drag. */
5422 if (event
->modifiers
& down_modifier
)
5426 double_click_count
++;
5427 event
->modifiers
|= ((double_click_count
> 2)
5432 double_click_count
= 1;
5433 button_down_time
= event
->timestamp
;
5434 *start_pos_ptr
= Fcopy_alist (position
);
5437 /* Now we're releasing a button - check the co-ordinates to
5438 see if this was a click or a drag. */
5439 else if (event
->modifiers
& up_modifier
)
5441 /* If we did not see a down before this up, ignore the up.
5442 Probably this happened because the down event chose a
5443 menu item. It would be an annoyance to treat the
5444 release of the button that chose the menu item as a
5447 if (!CONSP (start_pos
))
5450 event
->modifiers
&= ~up_modifier
;
5451 #if 0 /* Formerly we treated an up with no down as a click event. */
5452 if (!CONSP (start_pos
))
5453 event
->modifiers
|= click_modifier
;
5458 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5460 /* The third element of every position
5461 should be the (x,y) pair. */
5462 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5464 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5466 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5467 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5470 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5471 && ydiff
< double_click_fuzz
5472 && ydiff
> - double_click_fuzz
)
5473 /* Mouse hasn't moved (much). */
5474 event
->modifiers
|= click_modifier
;
5477 button_down_time
= 0;
5478 event
->modifiers
|= drag_modifier
;
5481 /* Don't check is_double; treat this as multiple
5482 if the down-event was multiple. */
5483 if (double_click_count
> 1)
5484 event
->modifiers
|= ((double_click_count
> 2)
5490 /* Every mouse event should either have the down_modifier or
5491 the up_modifier set. */
5495 /* Get the symbol we should use for the mouse click. */
5498 head
= modify_event_symbol (button
,
5500 Qmouse_click
, Vlispy_mouse_stem
,
5503 XVECTOR (mouse_syms
)->size
);
5504 if (event
->modifiers
& drag_modifier
)
5509 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5512 Fcons (make_number (double_click_count
),
5523 Lisp_Object position
;
5526 /* Build the position as appropriate for this mouse click. */
5527 struct frame
*f
= XFRAME (event
->frame_or_window
);
5529 /* Ignore wheel events that were made on frame that have been
5531 if (! FRAME_LIVE_P (f
))
5534 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5537 /* Set double or triple modifiers to indicate the wheel speed. */
5539 /* On window-system frames, use the value of
5540 double-click-fuzz as is. On other frames, interpret it
5541 as a multiple of 1/8 characters. */
5546 if (WINDOWP (event
->frame_or_window
))
5547 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5548 else if (FRAMEP (event
->frame_or_window
))
5549 f
= XFRAME (event
->frame_or_window
);
5553 if (FRAME_WINDOW_P (f
))
5554 fuzz
= double_click_fuzz
;
5556 fuzz
= double_click_fuzz
/ 8;
5558 is_double
= (last_mouse_button
< 0
5559 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5560 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5561 && button_down_time
!= 0
5562 && (EQ (Vdouble_click_time
, Qt
)
5563 || (INTEGERP (Vdouble_click_time
)
5564 && ((int)(event
->timestamp
- button_down_time
)
5565 < XINT (Vdouble_click_time
)))));
5568 double_click_count
++;
5569 event
->modifiers
|= ((double_click_count
> 2)
5575 double_click_count
= 1;
5576 event
->modifiers
|= click_modifier
;
5579 button_down_time
= event
->timestamp
;
5580 /* Use a negative value to distinguish wheel from mouse button. */
5581 last_mouse_button
= -1;
5582 last_mouse_x
= XINT (event
->x
);
5583 last_mouse_y
= XINT (event
->y
);
5589 if (event
->modifiers
& up_modifier
)
5591 /* Emit a wheel-up event. */
5592 event
->modifiers
&= ~up_modifier
;
5595 else if (event
->modifiers
& down_modifier
)
5597 /* Emit a wheel-down event. */
5598 event
->modifiers
&= ~down_modifier
;
5602 /* Every wheel event should either have the down_modifier or
5603 the up_modifier set. */
5606 /* Get the symbol we should use for the wheel event. */
5607 head
= modify_event_symbol (symbol_num
,
5613 ASIZE (wheel_syms
));
5616 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5619 Fcons (make_number (double_click_count
),
5628 #ifdef USE_TOOLKIT_SCROLL_BARS
5630 /* We don't have down and up events if using toolkit scroll bars,
5631 so make this always a click event. Store in the `part' of
5632 the Lisp event a symbol which maps to the following actions:
5634 `above_handle' page up
5635 `below_handle' page down
5639 `bottom' bottom of buffer
5640 `handle' thumb has been dragged.
5641 `end-scroll' end of interaction with scroll bar
5643 The incoming input_event contains in its `part' member an
5644 index of type `enum scroll_bar_part' which we can use as an
5645 index in scroll_bar_parts to get the appropriate symbol. */
5647 case SCROLL_BAR_CLICK_EVENT
:
5649 Lisp_Object position
, head
, window
, portion_whole
, part
;
5651 window
= event
->frame_or_window
;
5652 portion_whole
= Fcons (event
->x
, event
->y
);
5653 part
= *scroll_bar_parts
[(int) event
->part
];
5657 Fcons (Qvertical_scroll_bar
,
5658 Fcons (portion_whole
,
5659 Fcons (make_number (event
->timestamp
),
5660 Fcons (part
, Qnil
)))));
5662 /* Always treat scroll bar events as clicks. */
5663 event
->modifiers
|= click_modifier
;
5664 event
->modifiers
&= ~up_modifier
;
5666 if (event
->code
>= ASIZE (mouse_syms
))
5667 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5669 /* Get the symbol we should use for the mouse click. */
5670 head
= modify_event_symbol (event
->code
,
5675 XVECTOR (mouse_syms
)->size
);
5676 return Fcons (head
, Fcons (position
, Qnil
));
5679 #endif /* USE_TOOLKIT_SCROLL_BARS */
5682 case W32_SCROLL_BAR_CLICK_EVENT
:
5684 int button
= event
->code
;
5686 Lisp_Object position
;
5687 Lisp_Object
*start_pos_ptr
;
5688 Lisp_Object start_pos
;
5692 Lisp_Object portion_whole
;
5695 window
= event
->frame_or_window
;
5696 portion_whole
= Fcons (event
->x
, event
->y
);
5697 part
= *scroll_bar_parts
[(int) event
->part
];
5701 Fcons (Qvertical_scroll_bar
,
5702 Fcons (portion_whole
,
5703 Fcons (make_number (event
->timestamp
),
5704 Fcons (part
, Qnil
)))));
5707 /* Always treat W32 scroll bar events as clicks. */
5708 event
->modifiers
|= click_modifier
;
5711 /* Get the symbol we should use for the mouse click. */
5714 head
= modify_event_symbol (button
,
5719 XVECTOR (mouse_syms
)->size
);
5725 #endif /* WINDOWSNT */
5727 case DRAG_N_DROP_EVENT
:
5730 Lisp_Object head
, position
;
5733 /* The frame_or_window field should be a cons of the frame in
5734 which the event occurred and a list of the filenames
5736 if (! CONSP (event
->frame_or_window
))
5739 f
= XFRAME (XCAR (event
->frame_or_window
));
5740 files
= XCDR (event
->frame_or_window
);
5742 /* Ignore mouse events that were made on frames that
5743 have been deleted. */
5744 if (! FRAME_LIVE_P (f
))
5747 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5750 head
= modify_event_symbol (0, event
->modifiers
,
5752 lispy_drag_n_drop_names
,
5753 &drag_n_drop_syms
, 1);
5759 #endif /* HAVE_MOUSE */
5761 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5762 || defined (USE_GTK)
5763 case MENU_BAR_EVENT
:
5764 if (EQ (event
->arg
, event
->frame_or_window
))
5765 /* This is the prefix key. We translate this to
5766 `(menu_bar)' because the code in keyboard.c for menu
5767 events, which we use, relies on this. */
5768 return Fcons (Qmenu_bar
, Qnil
);
5772 case SELECT_WINDOW_EVENT
:
5773 /* Make an event (select-window (WINDOW)). */
5774 return Fcons (Qselect_window
,
5775 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5778 case TOOL_BAR_EVENT
:
5779 if (EQ (event
->arg
, event
->frame_or_window
))
5780 /* This is the prefix key. We translate this to
5781 `(tool_bar)' because the code in keyboard.c for tool bar
5782 events, which we use, relies on this. */
5783 return Fcons (Qtool_bar
, Qnil
);
5784 else if (SYMBOLP (event
->arg
))
5785 return apply_modifiers (event
->modifiers
, event
->arg
);
5788 case USER_SIGNAL_EVENT
:
5789 /* A user signal. */
5790 return *lispy_user_signals
[event
->code
];
5792 case SAVE_SESSION_EVENT
:
5793 return Qsave_session
;
5795 /* The 'kind' field of the event is something we don't recognize. */
5804 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5806 Lisp_Object bar_window
;
5807 enum scroll_bar_part part
;
5811 /* Is it a scroll bar movement? */
5812 if (frame
&& ! NILP (bar_window
))
5814 Lisp_Object part_sym
;
5816 part_sym
= *scroll_bar_parts
[(int) part
];
5817 return Fcons (Qscroll_bar_movement
,
5818 (Fcons (Fcons (bar_window
,
5819 Fcons (Qvertical_scroll_bar
,
5820 Fcons (Fcons (x
, y
),
5821 Fcons (make_number (time
),
5827 /* Or is it an ordinary mouse movement? */
5830 Lisp_Object position
;
5832 position
= make_lispy_position (frame
, &x
, &y
, time
);
5834 return Fcons (Qmouse_movement
,
5840 #endif /* HAVE_MOUSE */
5842 /* Construct a switch frame event. */
5844 make_lispy_switch_frame (frame
)
5847 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5850 /* Manipulating modifiers. */
5852 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5854 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5855 SYMBOL's name of the end of the modifiers; the string from this
5856 position is the unmodified symbol name.
5858 This doesn't use any caches. */
5861 parse_modifiers_uncached (symbol
, modifier_end
)
5869 CHECK_SYMBOL (symbol
);
5872 name
= SYMBOL_NAME (symbol
);
5874 for (i
= 0; i
+2 <= SBYTES (name
); )
5876 int this_mod_end
= 0;
5879 /* See if the name continues with a modifier word.
5880 Check that the word appears, but don't check what follows it.
5881 Set this_mod and this_mod_end to record what we find. */
5883 switch (SREF (name
, i
))
5885 #define SINGLE_LETTER_MOD(BIT) \
5886 (this_mod_end = i + 1, this_mod = BIT)
5889 SINGLE_LETTER_MOD (alt_modifier
);
5893 SINGLE_LETTER_MOD (ctrl_modifier
);
5897 SINGLE_LETTER_MOD (hyper_modifier
);
5901 SINGLE_LETTER_MOD (meta_modifier
);
5905 SINGLE_LETTER_MOD (shift_modifier
);
5909 SINGLE_LETTER_MOD (super_modifier
);
5912 #undef SINGLE_LETTER_MOD
5914 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5915 if (i + LEN + 1 <= SBYTES (name) \
5916 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5918 this_mod_end = i + LEN; \
5923 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5924 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5925 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5929 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5931 #undef MULTI_LETTER_MOD
5935 /* If we found no modifier, stop looking for them. */
5936 if (this_mod_end
== 0)
5939 /* Check there is a dash after the modifier, so that it
5940 really is a modifier. */
5941 if (this_mod_end
>= SBYTES (name
)
5942 || SREF (name
, this_mod_end
) != '-')
5945 /* This modifier is real; look for another. */
5946 modifiers
|= this_mod
;
5947 i
= this_mod_end
+ 1;
5950 /* Should we include the `click' modifier? */
5951 if (! (modifiers
& (down_modifier
| drag_modifier
5952 | double_modifier
| triple_modifier
))
5953 && i
+ 7 == SBYTES (name
)
5954 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5955 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5956 modifiers
|= click_modifier
;
5964 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5965 prepended to the string BASE[0..BASE_LEN-1].
5966 This doesn't use any caches. */
5968 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5971 int base_len
, base_len_byte
;
5973 /* Since BASE could contain nulls, we can't use intern here; we have
5974 to use Fintern, which expects a genuine Lisp_String, and keeps a
5977 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5983 /* Only the event queue may use the `up' modifier; it should always
5984 be turned into a click or drag event before presented to lisp code. */
5985 if (modifiers
& up_modifier
)
5988 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5989 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5990 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5991 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5992 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5993 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5994 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5995 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5996 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5997 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5998 /* The click modifier is denoted by the absence of other modifiers. */
6002 mod_len
= p
- new_mods
;
6006 Lisp_Object new_name
;
6008 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6009 mod_len
+ base_len_byte
);
6010 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6011 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6013 return Fintern (new_name
, Qnil
);
6018 static char *modifier_names
[] =
6020 "up", "down", "drag", "click", "double", "triple", 0, 0,
6021 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6022 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6024 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6026 static Lisp_Object modifier_symbols
;
6028 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6030 lispy_modifier_list (modifiers
)
6033 Lisp_Object modifier_list
;
6036 modifier_list
= Qnil
;
6037 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6038 if (modifiers
& (1<<i
))
6039 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6042 return modifier_list
;
6046 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6047 where UNMODIFIED is the unmodified form of SYMBOL,
6048 MASK is the set of modifiers present in SYMBOL's name.
6049 This is similar to parse_modifiers_uncached, but uses the cache in
6050 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6051 Qevent_symbol_elements property. */
6054 parse_modifiers (symbol
)
6057 Lisp_Object elements
;
6059 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6060 if (CONSP (elements
))
6065 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6066 Lisp_Object unmodified
;
6069 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6070 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6073 if (modifiers
& ~INTMASK
)
6075 XSETFASTINT (mask
, modifiers
);
6076 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6078 /* Cache the parsing results on SYMBOL. */
6079 Fput (symbol
, Qevent_symbol_element_mask
,
6081 Fput (symbol
, Qevent_symbol_elements
,
6082 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6084 /* Since we know that SYMBOL is modifiers applied to unmodified,
6085 it would be nice to put that in unmodified's cache.
6086 But we can't, since we're not sure that parse_modifiers is
6093 /* Apply the modifiers MODIFIERS to the symbol BASE.
6094 BASE must be unmodified.
6096 This is like apply_modifiers_uncached, but uses BASE's
6097 Qmodifier_cache property, if present. It also builds
6098 Qevent_symbol_elements properties, since it has that info anyway.
6100 apply_modifiers copies the value of BASE's Qevent_kind property to
6101 the modified symbol. */
6103 apply_modifiers (modifiers
, base
)
6107 Lisp_Object cache
, index
, entry
, new_symbol
;
6109 /* Mask out upper bits. We don't know where this value's been. */
6110 modifiers
&= INTMASK
;
6112 /* The click modifier never figures into cache indices. */
6113 cache
= Fget (base
, Qmodifier_cache
);
6114 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6115 entry
= assq_no_quit (index
, cache
);
6118 new_symbol
= XCDR (entry
);
6121 /* We have to create the symbol ourselves. */
6122 new_symbol
= apply_modifiers_uncached (modifiers
,
6123 SDATA (SYMBOL_NAME (base
)),
6124 SCHARS (SYMBOL_NAME (base
)),
6125 SBYTES (SYMBOL_NAME (base
)));
6127 /* Add the new symbol to the base's cache. */
6128 entry
= Fcons (index
, new_symbol
);
6129 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6131 /* We have the parsing info now for free, so we could add it to
6133 XSETFASTINT (index, modifiers);
6134 Fput (new_symbol, Qevent_symbol_element_mask,
6135 Fcons (base, Fcons (index, Qnil)));
6136 Fput (new_symbol, Qevent_symbol_elements,
6137 Fcons (base, lispy_modifier_list (modifiers)));
6138 Sadly, this is only correct if `base' is indeed a base event,
6139 which is not necessarily the case. -stef */
6142 /* Make sure this symbol is of the same kind as BASE.
6144 You'd think we could just set this once and for all when we
6145 intern the symbol above, but reorder_modifiers may call us when
6146 BASE's property isn't set right; we can't assume that just
6147 because it has a Qmodifier_cache property it must have its
6148 Qevent_kind set right as well. */
6149 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6153 kind
= Fget (base
, Qevent_kind
);
6155 Fput (new_symbol
, Qevent_kind
, kind
);
6162 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6163 return a symbol with the modifiers placed in the canonical order.
6164 Canonical order is alphabetical, except for down and drag, which
6165 always come last. The 'click' modifier is never written out.
6167 Fdefine_key calls this to make sure that (for example) C-M-foo
6168 and M-C-foo end up being equivalent in the keymap. */
6171 reorder_modifiers (symbol
)
6174 /* It's hopefully okay to write the code this way, since everything
6175 will soon be in caches, and no consing will be done at all. */
6178 parsed
= parse_modifiers (symbol
);
6179 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6184 /* For handling events, we often want to produce a symbol whose name
6185 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6186 to some base, like the name of a function key or mouse button.
6187 modify_event_symbol produces symbols of this sort.
6189 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6190 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6193 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6194 into symbol names, or a string specifying a name stem used to
6195 construct a symbol name or the form `STEM-N', where N is the decimal
6196 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6197 non-nil; otherwise NAME_TABLE is used.
6199 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6200 persist between calls to modify_event_symbol that it can use to
6201 store a cache of the symbols it's generated for this NAME_TABLE
6202 before. The object stored there may be a vector or an alist.
6204 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6206 MODIFIERS is a set of modifier bits (as given in struct input_events)
6207 whose prefixes should be applied to the symbol name.
6209 SYMBOL_KIND is the value to be placed in the event_kind property of
6210 the returned symbol.
6212 The symbols we create are supposed to have an
6213 `event-symbol-elements' property, which lists the modifiers present
6214 in the symbol's name. */
6217 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6218 name_table
, symbol_table
, table_size
)
6221 Lisp_Object symbol_kind
;
6222 Lisp_Object name_alist_or_stem
;
6224 Lisp_Object
*symbol_table
;
6225 unsigned int table_size
;
6228 Lisp_Object symbol_int
;
6230 /* Get rid of the "vendor-specific" bit here. */
6231 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6233 /* Is this a request for a valid symbol? */
6234 if (symbol_num
< 0 || symbol_num
>= table_size
)
6237 if (CONSP (*symbol_table
))
6238 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6240 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6241 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6242 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6243 we've never used that symbol before. */
6246 if (! VECTORP (*symbol_table
)
6247 || XVECTOR (*symbol_table
)->size
!= table_size
)
6251 XSETFASTINT (size
, table_size
);
6252 *symbol_table
= Fmake_vector (size
, Qnil
);
6255 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6258 /* Have we already used this symbol before? */
6261 /* No; let's create it. */
6262 if (CONSP (name_alist_or_stem
))
6263 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6264 else if (STRINGP (name_alist_or_stem
))
6266 int len
= SBYTES (name_alist_or_stem
);
6267 char *buf
= (char *) alloca (len
+ 50);
6268 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6269 (long) XINT (symbol_int
) + 1);
6270 value
= intern (buf
);
6272 else if (name_table
!= 0 && name_table
[symbol_num
])
6273 value
= intern (name_table
[symbol_num
]);
6275 #ifdef HAVE_WINDOW_SYSTEM
6278 char *name
= x_get_keysym_name (symbol_num
);
6280 value
= intern (name
);
6287 sprintf (buf
, "key-%d", symbol_num
);
6288 value
= intern (buf
);
6291 if (CONSP (*symbol_table
))
6292 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6294 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6296 /* Fill in the cache entries for this symbol; this also
6297 builds the Qevent_symbol_elements property, which the user
6299 apply_modifiers (modifiers
& click_modifier
, value
);
6300 Fput (value
, Qevent_kind
, symbol_kind
);
6303 /* Apply modifiers to that symbol. */
6304 return apply_modifiers (modifiers
, value
);
6307 /* Convert a list that represents an event type,
6308 such as (ctrl meta backspace), into the usual representation of that
6309 event type as a number or a symbol. */
6311 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6312 doc
: /* Convert the event description list EVENT-DESC to an event type.
6313 EVENT-DESC should contain one base event type (a character or symbol)
6314 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6315 drag, down, double or triple). The base must be last.
6316 The return value is an event type (a character or symbol) which
6317 has the same base event type and all the specified modifiers. */)
6319 Lisp_Object event_desc
;
6327 while (CONSP (rest
))
6335 /* Given a symbol, see if it is a modifier name. */
6336 if (SYMBOLP (elt
) && CONSP (rest
))
6337 this = parse_solitary_modifier (elt
);
6341 else if (!NILP (base
))
6342 error ("Two bases given in one event");
6348 /* Let the symbol A refer to the character A. */
6349 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6350 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6352 if (INTEGERP (base
))
6354 /* Turn (shift a) into A. */
6355 if ((modifiers
& shift_modifier
) != 0
6356 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6358 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6359 modifiers
&= ~shift_modifier
;
6362 /* Turn (control a) into C-a. */
6363 if (modifiers
& ctrl_modifier
)
6364 return make_number ((modifiers
& ~ctrl_modifier
)
6365 | make_ctrl_char (XINT (base
)));
6367 return make_number (modifiers
| XINT (base
));
6369 else if (SYMBOLP (base
))
6370 return apply_modifiers (modifiers
, base
);
6373 error ("Invalid base event");
6378 /* Try to recognize SYMBOL as a modifier name.
6379 Return the modifier flag bit, or 0 if not recognized. */
6382 parse_solitary_modifier (symbol
)
6385 Lisp_Object name
= SYMBOL_NAME (symbol
);
6387 switch (SREF (name
, 0))
6389 #define SINGLE_LETTER_MOD(BIT) \
6390 if (SBYTES (name) == 1) \
6393 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6394 if (LEN == SBYTES (name) \
6395 && ! strncmp (SDATA (name), NAME, LEN)) \
6399 SINGLE_LETTER_MOD (alt_modifier
);
6403 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6407 SINGLE_LETTER_MOD (ctrl_modifier
);
6411 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6412 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6416 SINGLE_LETTER_MOD (hyper_modifier
);
6420 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6424 SINGLE_LETTER_MOD (meta_modifier
);
6428 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6432 SINGLE_LETTER_MOD (shift_modifier
);
6436 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6437 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6438 SINGLE_LETTER_MOD (super_modifier
);
6442 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6443 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6444 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6448 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6451 #undef SINGLE_LETTER_MOD
6452 #undef MULTI_LETTER_MOD
6458 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6459 Such a list is not valid as an event,
6460 but it can be a Lucid-style event type list. */
6463 lucid_event_type_list_p (object
)
6468 if (! CONSP (object
))
6471 if (EQ (XCAR (object
), Qhelp_echo
)
6472 || EQ (XCAR (object
), Qvertical_line
)
6473 || EQ (XCAR (object
), Qmode_line
)
6474 || EQ (XCAR (object
), Qheader_line
))
6477 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6481 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6488 /* Store into *addr a value nonzero if terminal input chars are available.
6489 Serves the purpose of ioctl (0, FIONREAD, addr)
6490 but works even if FIONREAD does not exist.
6491 (In fact, this may actually read some input.)
6493 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6494 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6497 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6502 /* First of all, have we already counted some input? */
6503 *addr
= (!NILP (Vquit_flag
)
6504 || readable_filtered_events (do_timers_now
, filter_events
));
6506 /* If input is being read as it arrives, and we have none, there is none. */
6507 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6510 /* Try to read some input and see how much we get. */
6512 *addr
= (!NILP (Vquit_flag
)
6513 || readable_filtered_events (do_timers_now
, filter_events
));
6516 /* Store into *addr a value nonzero if terminal input chars are available.
6517 Serves the purpose of ioctl (0, FIONREAD, addr)
6518 but works even if FIONREAD does not exist.
6519 (In fact, this may actually read some input.)
6521 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6524 get_input_pending (addr
, do_timers_now
)
6528 get_filtered_input_pending (addr
, do_timers_now
, 0);
6531 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6534 gobble_input (expected
)
6539 if (interrupt_input
)
6542 mask
= sigblock (sigmask (SIGIO
));
6543 read_avail_input (expected
);
6547 #ifdef POLL_FOR_INPUT
6548 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6551 mask
= sigblock (sigmask (SIGALRM
));
6552 read_avail_input (expected
);
6558 read_avail_input (expected
);
6562 /* Put a BUFFER_SWITCH_EVENT in the buffer
6563 so that read_key_sequence will notice the new current buffer. */
6566 record_asynch_buffer_change ()
6568 struct input_event event
;
6572 event
.kind
= BUFFER_SWITCH_EVENT
;
6573 event
.frame_or_window
= Qnil
;
6577 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6578 The purpose of the event is to make read_key_sequence look up the
6579 keymaps again. If we aren't in read_key_sequence, we don't need one,
6580 and the event could cause trouble by messing up (input-pending-p). */
6581 tem
= Fwaiting_for_user_input_p ();
6585 /* We never need these events if we have no asynchronous subprocesses. */
6589 /* Make sure no interrupt happens while storing the event. */
6591 if (interrupt_input
)
6594 mask
= sigblock (sigmask (SIGIO
));
6595 kbd_buffer_store_event (&event
);
6602 kbd_buffer_store_event (&event
);
6609 /* Read any terminal input already buffered up by the system
6610 into the kbd_buffer, but do not wait.
6612 EXPECTED should be nonzero if the caller knows there is some input.
6614 Except on VMS, all input is read by this function.
6615 If interrupt_input is nonzero, this function MUST be called
6616 only when SIGIO is blocked.
6618 Returns the number of keyboard chars read, or -1 meaning
6619 this is a bad time to try to read input. */
6622 read_avail_input (expected
)
6628 if (read_socket_hook
)
6632 struct input_event hold_quit
;
6634 EVENT_INIT (hold_quit
);
6635 hold_quit
.kind
= NO_EVENT
;
6637 /* No need for FIONREAD or fcntl; just say don't wait. */
6638 while (nr
= (*read_socket_hook
) (input_fd
, expected
, &hold_quit
), nr
> 0)
6643 if (hold_quit
.kind
!= NO_EVENT
)
6644 kbd_buffer_store_event (&hold_quit
);
6648 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6649 the kbd_buffer can really hold. That may prevent loss
6650 of characters on some systems when input is stuffed at us. */
6651 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6654 /* Determine how many characters we should *try* to read. */
6657 #else /* not WINDOWSNT */
6659 n_to_read
= dos_keysns ();
6662 #else /* not MSDOS */
6664 /* Find out how much input is available. */
6665 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6666 /* Formerly simply reported no input, but that sometimes led to
6667 a failure of Emacs to terminate.
6668 SIGHUP seems appropriate if we can't reach the terminal. */
6669 /* ??? Is it really right to send the signal just to this process
6670 rather than to the whole process group?
6671 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6673 if (! noninteractive
)
6674 kill (getpid (), SIGHUP
);
6680 if (n_to_read
> sizeof cbuf
)
6681 n_to_read
= sizeof cbuf
;
6682 #else /* no FIONREAD */
6683 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6684 /* Read some input if available, but don't wait. */
6685 n_to_read
= sizeof cbuf
;
6686 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6691 #endif /* not MSDOS */
6692 #endif /* not WINDOWSNT */
6694 /* Now read; for one reason or another, this will not block.
6695 NREAD is set to the number of chars read. */
6699 cbuf
[0] = dos_keyread ();
6702 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6704 /* POSIX infers that processes which are not in the session leader's
6705 process group won't get SIGHUP's at logout time. BSDI adheres to
6706 this part standard and returns -1 from read (0) with errno==EIO
6707 when the control tty is taken away.
6708 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6709 if (nread
== -1 && errno
== EIO
)
6711 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6712 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6713 This looks incorrect, but it isn't, because _BSD causes
6714 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6715 and that causes a value other than 0 when there is no input. */
6721 /* We used to retry the read if it was interrupted.
6722 But this does the wrong thing when O_NDELAY causes
6723 an EAGAIN error. Does anybody know of a situation
6724 where a retry is actually needed? */
6726 nread
< 0 && (errno
== EAGAIN
6740 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6741 fcntl (input_fd
, F_SETFL
, 0);
6742 #endif /* USG or DGUX or CYGWIN */
6743 #endif /* no FIONREAD */
6744 for (i
= 0; i
< nread
; i
++)
6746 struct input_event buf
;
6748 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6750 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6751 buf
.modifiers
= meta_modifier
;
6756 buf
.frame_or_window
= selected_frame
;
6759 kbd_buffer_store_event (&buf
);
6760 /* Don't look at input that follows a C-g too closely.
6761 This reduces lossage due to autorepeat on C-g. */
6762 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6763 && buf
.code
== quit_char
)
6770 #endif /* not VMS */
6773 handle_async_input ()
6776 extern int select_alarmed
;
6778 interrupt_input_pending
= 0;
6783 nread
= read_avail_input (1);
6784 /* -1 means it's not ok to read the input now.
6785 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6786 0 means there was no keyboard input available. */
6791 select_alarmed
= 1; /* Force the select emulator back to life */
6796 #ifdef SIGIO /* for entire page */
6797 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6800 input_available_signal (signo
)
6803 /* Must preserve main program's value of errno. */
6804 int old_errno
= errno
;
6806 #if defined (USG) && !defined (POSIX_SIGNALS)
6807 /* USG systems forget handlers when they are used;
6808 must reestablish each time */
6809 signal (signo
, input_available_signal
);
6816 if (input_available_clear_time
)
6817 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6820 interrupt_input_pending
= 1;
6822 handle_async_input ();
6832 /* Send ourselves a SIGIO.
6834 This function exists so that the UNBLOCK_INPUT macro in
6835 blockinput.h can have some way to take care of input we put off
6836 dealing with, without assuming that every file which uses
6837 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6839 reinvoke_input_signal ()
6842 handle_async_input ();
6848 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6849 static Lisp_Object menu_bar_one_keymap_changed_items
;
6851 /* These variables hold the vector under construction within
6852 menu_bar_items and its subroutines, and the current index
6853 for storing into that vector. */
6854 static Lisp_Object menu_bar_items_vector
;
6855 static int menu_bar_items_index
;
6857 /* Return a vector of menu items for a menu bar, appropriate
6858 to the current buffer. Each item has three elements in the vector:
6861 OLD is an old vector we can optionally reuse, or nil. */
6864 menu_bar_items (old
)
6867 /* The number of keymaps we're scanning right now, and the number of
6868 keymaps we have allocated space for. */
6871 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6872 in the current keymaps, or nil where it is not a prefix. */
6875 Lisp_Object def
, tail
;
6884 struct gcpro gcpro1
;
6886 /* In order to build the menus, we need to call the keymap
6887 accessors. They all call QUIT. But this function is called
6888 during redisplay, during which a quit is fatal. So inhibit
6889 quitting while building the menus.
6890 We do this instead of specbind because (1) errors will clear it anyway
6891 and (2) this avoids risk of specpdl overflow. */
6892 oquit
= Vinhibit_quit
;
6896 menu_bar_items_vector
= old
;
6898 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6899 menu_bar_items_index
= 0;
6901 GCPRO1 (menu_bar_items_vector
);
6903 /* Build our list of keymaps.
6904 If we recognize a function key and replace its escape sequence in
6905 keybuf with its symbol, or if the sequence starts with a mouse
6906 click and we need to switch buffers, we jump back here to rebuild
6907 the initial keymaps from the current buffer. */
6911 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6912 if (!NILP (Voverriding_local_map_menu_flag
))
6914 /* Yes, use them (if non-nil) as well as the global map. */
6915 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6917 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6918 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6919 if (!NILP (Voverriding_local_map
))
6920 maps
[nmaps
++] = Voverriding_local_map
;
6924 /* No, so use major and minor mode keymaps and keymap property.
6925 Note that menu-bar bindings in the local-map and keymap
6926 properties may not work reliable, as they are only
6927 recognized when the menu-bar (or mode-line) is updated,
6928 which does not normally happen after every command. */
6931 nminor
= current_minor_maps (NULL
, &tmaps
);
6932 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6934 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6935 maps
[nmaps
++] = tem
;
6936 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6938 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6940 maps
[nmaps
++] = current_global_map
;
6943 /* Look up in each map the dummy prefix key `menu-bar'. */
6947 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6948 if (!NILP (maps
[mapno
]))
6950 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6954 menu_bar_one_keymap_changed_items
= Qnil
;
6955 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
6959 /* Move to the end those items that should be at the end. */
6961 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6964 int end
= menu_bar_items_index
;
6966 for (i
= 0; i
< end
; i
+= 4)
6967 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6969 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6970 /* Move the item at index I to the end,
6971 shifting all the others forward. */
6972 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6973 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6974 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6975 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6977 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6978 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6979 (end
- i
- 4) * sizeof (Lisp_Object
));
6980 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6981 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6982 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6983 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6988 /* Add nil, nil, nil, nil at the end. */
6989 i
= menu_bar_items_index
;
6990 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6993 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6994 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6995 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6996 menu_bar_items_vector
= tem
;
6998 /* Add this item. */
6999 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7000 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7001 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7002 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7003 menu_bar_items_index
= i
;
7005 Vinhibit_quit
= oquit
;
7007 return menu_bar_items_vector
;
7010 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7011 If there's already an item for KEY, add this DEF to it. */
7013 Lisp_Object item_properties
;
7016 menu_bar_item (key
, item
, dummy1
, dummy2
)
7017 Lisp_Object key
, item
, dummy1
;
7020 struct gcpro gcpro1
;
7024 if (EQ (item
, Qundefined
))
7026 /* If a map has an explicit `undefined' as definition,
7027 discard any previously made menu bar item. */
7029 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7030 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7032 if (menu_bar_items_index
> i
+ 4)
7033 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7034 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7035 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7036 menu_bar_items_index
-= 4;
7040 /* If this keymap has already contributed to this KEY,
7041 don't contribute to it a second time. */
7042 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7043 if (!NILP (tem
) || NILP (item
))
7046 menu_bar_one_keymap_changed_items
7047 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7049 /* We add to menu_bar_one_keymap_changed_items before doing the
7050 parse_menu_item, so that if it turns out it wasn't a menu item,
7051 it still correctly hides any further menu item. */
7053 i
= parse_menu_item (item
, 0, 1);
7058 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7060 /* Find any existing item for this KEY. */
7061 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7062 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7065 /* If we did not find this KEY, add it at the end. */
7066 if (i
== menu_bar_items_index
)
7068 /* If vector is too small, get a bigger one. */
7069 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7072 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7073 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7074 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7075 menu_bar_items_vector
= tem
;
7078 /* Add this item. */
7079 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7080 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7081 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7082 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7083 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7084 menu_bar_items_index
= i
;
7086 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7090 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7091 /* If the new and the old items are not both keymaps,
7092 the lookup will only find `item'. */
7093 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7094 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7098 /* This is used as the handler when calling menu_item_eval_property. */
7100 menu_item_eval_property_1 (arg
)
7103 /* If we got a quit from within the menu computation,
7104 quit all the way out of it. This takes care of C-] in the debugger. */
7105 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7106 Fsignal (Qquit
, Qnil
);
7111 /* Evaluate an expression and return the result (or nil if something
7112 went wrong). Used to evaluate dynamic parts of menu items. */
7114 menu_item_eval_property (sexpr
)
7117 int count
= SPECPDL_INDEX ();
7119 specbind (Qinhibit_redisplay
, Qt
);
7120 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7121 menu_item_eval_property_1
);
7122 return unbind_to (count
, val
);
7125 /* This function parses a menu item and leaves the result in the
7126 vector item_properties.
7127 ITEM is a key binding, a possible menu item.
7128 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7129 evaluate dynamic expressions in the menu item.
7130 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7132 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7133 parse_menu_item returns true if the item is a menu item and false
7137 parse_menu_item (item
, notreal
, inmenubar
)
7139 int notreal
, inmenubar
;
7141 Lisp_Object def
, tem
, item_string
, start
;
7142 Lisp_Object cachelist
;
7144 Lisp_Object keyhint
;
7155 /* Create item_properties vector if necessary. */
7156 if (NILP (item_properties
))
7158 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7160 /* Initialize optional entries. */
7161 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7162 AREF (item_properties
, i
) = Qnil
;
7163 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7165 /* Save the item here to protect it from GC. */
7166 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7168 item_string
= XCAR (item
);
7172 if (STRINGP (item_string
))
7174 /* Old format menu item. */
7175 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7177 /* Maybe help string. */
7178 if (CONSP (item
) && STRINGP (XCAR (item
)))
7180 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7185 /* Maybe key binding cache. */
7186 if (CONSP (item
) && CONSP (XCAR (item
))
7187 && (NILP (XCAR (XCAR (item
)))
7188 || VECTORP (XCAR (XCAR (item
)))))
7190 cachelist
= XCAR (item
);
7194 /* This is the real definition--the function to run. */
7195 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7197 /* Get enable property, if any. */
7200 tem
= Fget (item
, Qmenu_enable
);
7202 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7205 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7207 /* New format menu item. */
7208 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7209 start
= XCDR (item
);
7212 /* We have a real binding. */
7213 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7215 item
= XCDR (start
);
7216 /* Is there a cache list with key equivalences. */
7217 if (CONSP (item
) && CONSP (XCAR (item
)))
7219 cachelist
= XCAR (item
);
7223 /* Parse properties. */
7224 while (CONSP (item
) && CONSP (XCDR (item
)))
7229 if (EQ (tem
, QCenable
))
7230 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7231 else if (EQ (tem
, QCvisible
) && !notreal
)
7233 /* If got a visible property and that evaluates to nil
7234 then ignore this item. */
7235 tem
= menu_item_eval_property (XCAR (item
));
7239 else if (EQ (tem
, QChelp
))
7240 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7241 else if (EQ (tem
, QCfilter
))
7243 else if (EQ (tem
, QCkey_sequence
))
7246 if (NILP (cachelist
)
7247 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7248 /* Be GC protected. Set keyhint to item instead of tem. */
7251 else if (EQ (tem
, QCkeys
))
7254 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7255 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7257 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7262 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7264 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7266 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7273 else if (inmenubar
|| !NILP (start
))
7277 return 0; /* not a menu item */
7279 /* If item string is not a string, evaluate it to get string.
7280 If we don't get a string, skip this item. */
7281 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7282 if (!(STRINGP (item_string
) || notreal
))
7284 item_string
= menu_item_eval_property (item_string
);
7285 if (!STRINGP (item_string
))
7287 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7290 /* If got a filter apply it on definition. */
7291 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7294 def
= menu_item_eval_property (list2 (XCAR (filter
),
7295 list2 (Qquote
, def
)));
7297 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7300 /* Enable or disable selection of item. */
7301 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7307 tem
= menu_item_eval_property (tem
);
7308 if (inmenubar
&& NILP (tem
))
7309 return 0; /* Ignore disabled items in menu bar. */
7310 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7313 /* If we got no definition, this item is just unselectable text which
7314 is OK in a submenu but not in the menubar. */
7316 return (inmenubar
? 0 : 1);
7318 /* See if this is a separate pane or a submenu. */
7319 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7320 tem
= get_keymap (def
, 0, 1);
7321 /* For a subkeymap, just record its details and exit. */
7324 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7325 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7329 /* At the top level in the menu bar, do likewise for commands also.
7330 The menu bar does not display equivalent key bindings anyway.
7331 ITEM_PROPERTY_DEF is already set up properly. */
7335 /* This is a command. See if there is an equivalent key binding. */
7336 if (NILP (cachelist
))
7338 /* We have to create a cachelist. */
7339 CHECK_IMPURE (start
);
7340 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7341 cachelist
= XCAR (XCDR (start
));
7343 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7344 if (!NILP (keyhint
))
7346 XSETCAR (cachelist
, XCAR (keyhint
));
7349 else if (STRINGP (tem
))
7351 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7352 XSETCAR (cachelist
, Qt
);
7356 tem
= XCAR (cachelist
);
7363 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7365 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7368 def
= XCAR (prefix
);
7369 prefix
= XCDR (prefix
);
7372 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7374 if (!update_menu_bindings
)
7376 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7378 if (newcache
/* Always check first time. */
7379 /* Should we check everything when precomputing key
7381 /* If something had no key binding before, don't recheck it
7382 because that is too slow--except if we have a list of
7383 rebound commands in Vdefine_key_rebound_commands, do
7384 recheck any command that appears in that list. */
7385 || (CONSP (Vdefine_key_rebound_commands
)
7386 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7389 /* We had a saved key. Is it still bound to the command? */
7392 /* If the command is an alias for another
7393 (such as lmenu.el set it up), check if the
7394 original command matches the cached command. */
7395 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7396 chkcache
= 1; /* Need to recompute key binding. */
7400 /* Recompute equivalent key binding. If the command is an alias
7401 for another (such as lmenu.el set it up), see if the original
7402 command name has equivalent keys. Otherwise look up the
7403 specified command itself. We don't try both, because that
7404 makes lmenu menus slow. */
7406 && SYMBOLP (XSYMBOL (def
)->function
)
7407 && ! NILP (Fget (def
, Qmenu_alias
)))
7408 def
= XSYMBOL (def
)->function
;
7409 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7410 XSETCAR (cachelist
, tem
);
7413 XSETCDR (cachelist
, Qnil
);
7417 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7419 tem
= XCAR (cachelist
);
7423 newcache
= chkcache
;
7426 tem
= Fkey_description (tem
, Qnil
);
7429 if (STRINGP (XCAR (prefix
)))
7430 tem
= concat2 (XCAR (prefix
), tem
);
7431 if (STRINGP (XCDR (prefix
)))
7432 tem
= concat2 (tem
, XCDR (prefix
));
7434 XSETCDR (cachelist
, tem
);
7438 tem
= XCDR (cachelist
);
7439 if (newcache
&& !NILP (tem
))
7441 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7442 XSETCDR (cachelist
, tem
);
7445 /* If we only want to precompute equivalent key bindings, stop here. */
7449 /* If we have an equivalent key binding, use that. */
7450 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7452 /* Include this when menu help is implemented.
7453 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7454 if (!(NILP (tem) || STRINGP (tem)))
7456 tem = menu_item_eval_property (tem);
7459 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7463 /* Handle radio buttons or toggle boxes. */
7464 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7466 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7467 = menu_item_eval_property (tem
);
7474 /***********************************************************************
7476 ***********************************************************************/
7478 /* A vector holding tool bar items while they are parsed in function
7479 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7482 static Lisp_Object tool_bar_items_vector
;
7484 /* A vector holding the result of parse_tool_bar_item. Layout is like
7485 the one for a single item in tool_bar_items_vector. */
7487 static Lisp_Object tool_bar_item_properties
;
7489 /* Next free index in tool_bar_items_vector. */
7491 static int ntool_bar_items
;
7493 /* The symbols `tool-bar', and `:image'. */
7495 extern Lisp_Object Qtool_bar
;
7496 Lisp_Object QCimage
;
7498 /* Function prototypes. */
7500 static void init_tool_bar_items
P_ ((Lisp_Object
));
7501 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7502 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7503 static void append_tool_bar_item
P_ ((void));
7506 /* Return a vector of tool bar items for keymaps currently in effect.
7507 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7508 tool bar items found. */
7511 tool_bar_items (reuse
, nitems
)
7522 /* In order to build the menus, we need to call the keymap
7523 accessors. They all call QUIT. But this function is called
7524 during redisplay, during which a quit is fatal. So inhibit
7525 quitting while building the menus. We do this instead of
7526 specbind because (1) errors will clear it anyway and (2) this
7527 avoids risk of specpdl overflow. */
7528 oquit
= Vinhibit_quit
;
7531 /* Initialize tool_bar_items_vector and protect it from GC. */
7532 init_tool_bar_items (reuse
);
7534 /* Build list of keymaps in maps. Set nmaps to the number of maps
7537 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7538 if (!NILP (Voverriding_local_map_menu_flag
))
7540 /* Yes, use them (if non-nil) as well as the global map. */
7541 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7543 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7544 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7545 if (!NILP (Voverriding_local_map
))
7546 maps
[nmaps
++] = Voverriding_local_map
;
7550 /* No, so use major and minor mode keymaps and keymap property.
7551 Note that tool-bar bindings in the local-map and keymap
7552 properties may not work reliable, as they are only
7553 recognized when the tool-bar (or mode-line) is updated,
7554 which does not normally happen after every command. */
7557 nminor
= current_minor_maps (NULL
, &tmaps
);
7558 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7560 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7561 maps
[nmaps
++] = tem
;
7562 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7564 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7567 /* Add global keymap at the end. */
7568 maps
[nmaps
++] = current_global_map
;
7570 /* Process maps in reverse order and look up in each map the prefix
7572 for (i
= nmaps
- 1; i
>= 0; --i
)
7573 if (!NILP (maps
[i
]))
7577 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7582 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7583 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7585 Lisp_Object keydef
= XCAR (tail
);
7587 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7592 Vinhibit_quit
= oquit
;
7593 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7594 return tool_bar_items_vector
;
7598 /* Process the definition of KEY which is DEF. */
7601 process_tool_bar_item (key
, def
)
7602 Lisp_Object key
, def
;
7605 extern Lisp_Object Qundefined
;
7606 struct gcpro gcpro1
, gcpro2
;
7608 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7612 if (EQ (def
, Qundefined
))
7614 /* If a map has an explicit `undefined' as definition,
7615 discard any previously made item. */
7616 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7618 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7620 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7622 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7623 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7624 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7625 * sizeof (Lisp_Object
)));
7626 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7631 else if (parse_tool_bar_item (key
, def
))
7632 /* Append a new tool bar item to tool_bar_items_vector. Accept
7633 more than one definition for the same key. */
7634 append_tool_bar_item ();
7640 /* Parse a tool bar item specification ITEM for key KEY and return the
7641 result in tool_bar_item_properties. Value is zero if ITEM is
7644 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7646 CAPTION is the caption of the item, If it's not a string, it is
7647 evaluated to get a string.
7649 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7650 as binding are currently ignored.
7652 The following properties are recognized:
7656 FORM is evaluated and specifies whether the tool bar item is
7657 enabled or disabled.
7661 FORM is evaluated and specifies whether the tool bar item is visible.
7663 - `:filter FUNCTION'
7665 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7666 result is stored as the new binding.
7668 - `:button (TYPE SELECTED)'
7670 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7671 and specifies whether the button is selected (pressed) or not.
7675 IMAGES is either a single image specification or a vector of four
7676 image specifications. See enum tool_bar_item_images.
7678 - `:help HELP-STRING'.
7680 Gives a help string to display for the tool bar item. */
7683 parse_tool_bar_item (key
, item
)
7684 Lisp_Object key
, item
;
7686 /* Access slot with index IDX of vector tool_bar_item_properties. */
7687 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7689 Lisp_Object filter
= Qnil
;
7690 Lisp_Object caption
;
7693 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7694 Rule out items that aren't lists, don't start with
7695 `menu-item' or whose rest following `tool-bar-item' is not a
7698 || !EQ (XCAR (item
), Qmenu_item
)
7699 || (item
= XCDR (item
),
7703 /* Create tool_bar_item_properties vector if necessary. Reset it to
7705 if (VECTORP (tool_bar_item_properties
))
7707 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7711 tool_bar_item_properties
7712 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7715 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7716 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7718 /* Get the caption of the item. If the caption is not a string,
7719 evaluate it to get a string. If we don't get a string, skip this
7721 caption
= XCAR (item
);
7722 if (!STRINGP (caption
))
7724 caption
= menu_item_eval_property (caption
);
7725 if (!STRINGP (caption
))
7728 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7730 /* Give up if rest following the caption is not a list. */
7735 /* Store the binding. */
7736 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7739 /* Ignore cached key binding, if any. */
7740 if (CONSP (item
) && CONSP (XCAR (item
)))
7743 /* Process the rest of the properties. */
7744 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7746 Lisp_Object key
, value
;
7749 value
= XCAR (XCDR (item
));
7751 if (EQ (key
, QCenable
))
7752 /* `:enable FORM'. */
7753 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7754 else if (EQ (key
, QCvisible
))
7756 /* `:visible FORM'. If got a visible property and that
7757 evaluates to nil then ignore this item. */
7758 if (NILP (menu_item_eval_property (value
)))
7761 else if (EQ (key
, QChelp
))
7762 /* `:help HELP-STRING'. */
7763 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7764 else if (EQ (key
, QCfilter
))
7765 /* ':filter FORM'. */
7767 else if (EQ (key
, QCbutton
) && CONSP (value
))
7769 /* `:button (TYPE . SELECTED)'. */
7770 Lisp_Object type
, selected
;
7772 type
= XCAR (value
);
7773 selected
= XCDR (value
);
7774 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7776 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7777 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7780 else if (EQ (key
, QCimage
)
7782 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7783 /* Value is either a single image specification or a vector
7784 of 4 such specifications for the different button states. */
7785 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7788 /* If got a filter apply it on binding. */
7790 PROP (TOOL_BAR_ITEM_BINDING
)
7791 = menu_item_eval_property (list2 (filter
,
7793 PROP (TOOL_BAR_ITEM_BINDING
))));
7795 /* See if the binding is a keymap. Give up if it is. */
7796 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7799 /* Enable or disable selection of item. */
7800 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7801 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7802 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7804 /* Handle radio buttons or toggle boxes. */
7805 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7806 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7807 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7815 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7816 that can be reused. */
7819 init_tool_bar_items (reuse
)
7822 if (VECTORP (reuse
))
7823 tool_bar_items_vector
= reuse
;
7825 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7826 ntool_bar_items
= 0;
7830 /* Append parsed tool bar item properties from
7831 tool_bar_item_properties */
7834 append_tool_bar_item ()
7836 Lisp_Object
*to
, *from
;
7838 /* Enlarge tool_bar_items_vector if necessary. */
7839 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7840 >= XVECTOR (tool_bar_items_vector
)->size
)
7842 Lisp_Object new_vector
;
7843 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7845 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7846 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7847 XVECTOR (new_vector
)->contents
,
7848 old_size
* sizeof (Lisp_Object
));
7849 tool_bar_items_vector
= new_vector
;
7852 /* Append entries from tool_bar_item_properties to the end of
7853 tool_bar_items_vector. */
7854 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7855 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7856 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7857 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7864 /* Read a character using menus based on maps in the array MAPS.
7865 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7866 Return t if we displayed a menu but the user rejected it.
7868 PREV_EVENT is the previous input event, or nil if we are reading
7869 the first event of a key sequence.
7871 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7872 if we used a mouse menu to read the input, or zero otherwise. If
7873 USED_MOUSE_MENU is null, we don't dereference it.
7875 The prompting is done based on the prompt-string of the map
7876 and the strings associated with various map elements.
7878 This can be done with X menus or with menus put in the minibuf.
7879 These are done in different ways, depending on how the input will be read.
7880 Menus using X are done after auto-saving in read-char, getting the input
7881 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7882 and do auto-saving in the inner call of read_char. */
7885 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7888 Lisp_Object prev_event
;
7889 int *used_mouse_menu
;
7892 register Lisp_Object name
= Qnil
;
7894 if (used_mouse_menu
)
7895 *used_mouse_menu
= 0;
7897 /* Use local over global Menu maps */
7899 if (! menu_prompting
)
7902 /* Optionally disregard all but the global map. */
7903 if (inhibit_local_menu_bar_menus
)
7905 maps
+= (nmaps
- 1);
7909 /* Get the menu name from the first map that has one (a prompt string). */
7910 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7912 name
= Fkeymap_prompt (maps
[mapno
]);
7917 /* If we don't have any menus, just read a character normally. */
7918 if (!STRINGP (name
))
7922 /* If we got to this point via a mouse click,
7923 use a real menu for mouse selection. */
7924 if (EVENT_HAS_PARAMETERS (prev_event
)
7925 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7926 && !EQ (XCAR (prev_event
), Qtool_bar
))
7928 /* Display the menu and get the selection. */
7929 Lisp_Object
*realmaps
7930 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7934 /* Use the maps that are not nil. */
7935 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7936 if (!NILP (maps
[mapno
]))
7937 realmaps
[nmaps1
++] = maps
[mapno
];
7939 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7944 record_menu_key (XCAR (value
));
7946 /* If we got multiple events, unread all but
7948 There is no way to prevent those unread events
7949 from showing up later in last_nonmenu_event.
7950 So turn symbol and integer events into lists,
7951 to indicate that they came from a mouse menu,
7952 so that when present in last_nonmenu_event
7953 they won't confuse things. */
7954 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7956 record_menu_key (XCAR (tem
));
7957 if (SYMBOLP (XCAR (tem
))
7958 || INTEGERP (XCAR (tem
)))
7959 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7962 /* If we got more than one event, put all but the first
7963 onto this list to be read later.
7964 Return just the first event now. */
7965 Vunread_command_events
7966 = nconc2 (XCDR (value
), Vunread_command_events
);
7967 value
= XCAR (value
);
7969 else if (NILP (value
))
7971 if (used_mouse_menu
)
7972 *used_mouse_menu
= 1;
7975 #endif /* HAVE_MENUS */
7979 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7980 We make this bigger when necessary, and never free it. */
7981 static char *read_char_minibuf_menu_text
;
7982 /* Size of that buffer. */
7983 static int read_char_minibuf_menu_width
;
7986 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7992 register Lisp_Object name
;
7994 /* FIXME: Use the minibuffer's frame width. */
7995 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
7998 Lisp_Object rest
, vector
;
8004 if (! menu_prompting
)
8007 /* Make sure we have a big enough buffer for the menu text. */
8008 if (read_char_minibuf_menu_text
== 0)
8010 read_char_minibuf_menu_width
= width
+ 4;
8011 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8013 else if (width
+ 4 > read_char_minibuf_menu_width
)
8015 read_char_minibuf_menu_width
= width
+ 4;
8016 read_char_minibuf_menu_text
8017 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8019 menu
= read_char_minibuf_menu_text
;
8021 /* Get the menu name from the first map that has one (a prompt string). */
8022 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8024 name
= Fkeymap_prompt (maps
[mapno
]);
8029 /* If we don't have any menus, just read a character normally. */
8030 if (!STRINGP (name
))
8033 /* Prompt string always starts with map's prompt, and a space. */
8034 strcpy (menu
, SDATA (name
));
8035 nlength
= SBYTES (name
);
8036 menu
[nlength
++] = ':';
8037 menu
[nlength
++] = ' ';
8040 /* Start prompting at start of first map. */
8044 /* Present the documented bindings, a line at a time. */
8051 Lisp_Object orig_defn_macro
;
8053 /* Loop over elements of map. */
8058 /* If reached end of map, start at beginning of next map. */
8062 /* At end of last map, wrap around to first map if just starting,
8063 or end this line if already have something on it. */
8067 if (notfirst
|| nobindings
) break;
8072 /* Look at the next element of the map. */
8074 elt
= XVECTOR (vector
)->contents
[idx
];
8076 elt
= Fcar_safe (rest
);
8078 if (idx
< 0 && VECTORP (elt
))
8080 /* If we found a dense table in the keymap,
8081 advanced past it, but start scanning its contents. */
8082 rest
= Fcdr_safe (rest
);
8088 /* An ordinary element. */
8089 Lisp_Object event
, tem
;
8093 event
= Fcar_safe (elt
); /* alist */
8094 elt
= Fcdr_safe (elt
);
8098 XSETINT (event
, idx
); /* vector */
8101 /* Ignore the element if it has no prompt string. */
8102 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8104 /* 1 if the char to type matches the string. */
8106 Lisp_Object upcased_event
, downcased_event
;
8107 Lisp_Object desc
= Qnil
;
8109 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8111 upcased_event
= Fupcase (event
);
8112 downcased_event
= Fdowncase (event
);
8113 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8114 || XINT (downcased_event
) == SREF (s
, 0));
8116 desc
= Fsingle_key_description (event
, Qnil
);
8118 #if 0 /* It is redundant to list the equivalent key bindings because
8119 the prefix is what the user has already typed. */
8121 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8123 /* Insert equivalent keybinding. */
8124 s
= concat2 (s
, tem
);
8127 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8128 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8130 /* Insert button prefix. */
8131 Lisp_Object selected
8132 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8133 if (EQ (tem
, QCradio
))
8134 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8136 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8137 s
= concat2 (tem
, s
);
8141 /* If we have room for the prompt string, add it to this line.
8142 If this is the first on the line, always add it. */
8143 if ((SCHARS (s
) + i
+ 2
8144 + (char_matches
? 0 : SCHARS (desc
) + 3))
8150 /* Punctuate between strings. */
8153 strcpy (menu
+ i
, ", ");
8159 /* If the char to type doesn't match the string's
8160 first char, explicitly show what char to type. */
8163 /* Add as much of string as fits. */
8164 thiswidth
= SCHARS (desc
);
8165 if (thiswidth
+ i
> width
)
8166 thiswidth
= width
- i
;
8167 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8169 strcpy (menu
+ i
, " = ");
8173 /* Add as much of string as fits. */
8174 thiswidth
= SCHARS (s
);
8175 if (thiswidth
+ i
> width
)
8176 thiswidth
= width
- i
;
8177 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8183 /* If this element does not fit, end the line now,
8184 and save the element for the next line. */
8185 strcpy (menu
+ i
, "...");
8190 /* Move past this element. */
8191 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8192 /* Handle reaching end of dense table. */
8197 rest
= Fcdr_safe (rest
);
8201 /* Prompt with that and read response. */
8202 message2_nolog (menu
, strlen (menu
),
8203 ! NILP (current_buffer
->enable_multibyte_characters
));
8205 /* Make believe its not a keyboard macro in case the help char
8206 is pressed. Help characters are not recorded because menu prompting
8207 is not used on replay.
8209 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8210 current_kboard
->defining_kbd_macro
= Qnil
;
8212 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8213 while (BUFFERP (obj
));
8214 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8216 if (!INTEGERP (obj
))
8221 if (! EQ (obj
, menu_prompt_more_char
)
8222 && (!INTEGERP (menu_prompt_more_char
)
8223 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8225 if (!NILP (current_kboard
->defining_kbd_macro
))
8226 store_kbd_macro_char (obj
);
8229 /* Help char - go round again */
8233 /* Reading key sequences. */
8235 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8236 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8237 keymap, or nil otherwise. Return the index of the first keymap in
8238 which KEY has any binding, or NMAPS if no map has a binding.
8240 If KEY is a meta ASCII character, treat it like meta-prefix-char
8241 followed by the corresponding non-meta character. Keymaps in
8242 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8245 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8248 NEXT may be the same array as CURRENT. */
8251 follow_key (key
, nmaps
, current
, defs
, next
)
8253 Lisp_Object
*current
, *defs
, *next
;
8256 int i
, first_binding
;
8258 first_binding
= nmaps
;
8259 for (i
= nmaps
- 1; i
>= 0; i
--)
8261 if (! NILP (current
[i
]))
8263 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8264 if (! NILP (defs
[i
]))
8271 /* Given the set of bindings we've found, produce the next set of maps. */
8272 if (first_binding
< nmaps
)
8273 for (i
= 0; i
< nmaps
; i
++)
8274 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8276 return first_binding
;
8279 /* Structure used to keep track of partial application of key remapping
8280 such as Vfunction_key_map and Vkey_translation_map. */
8281 typedef struct keyremap
8283 Lisp_Object map
, parent
;
8287 /* Lookup KEY in MAP.
8288 MAP is a keymap mapping keys to key vectors or functions.
8289 If the mapping is a function and DO_FUNCTION is non-zero, then
8290 the function is called with PROMPT as parameter and its return
8291 value is used as the return value of this function (after checking
8292 that it is indeed a vector). */
8295 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8296 Lisp_Object map
, key
, prompt
;
8301 next
= access_keymap (map
, key
, 1, 0, 1);
8303 /* Handle symbol with autoload definition. */
8304 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8305 && CONSP (XSYMBOL (next
)->function
)
8306 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8307 do_autoload (XSYMBOL (next
)->function
, next
);
8309 /* Handle a symbol whose function definition is a keymap
8311 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8312 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8313 || KEYMAPP (XSYMBOL (next
)->function
)))
8314 next
= XSYMBOL (next
)->function
;
8316 /* If the keymap gives a function, not an
8317 array, then call the function with one arg and use
8318 its value instead. */
8319 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8324 next
= call1 (next
, prompt
);
8325 /* If the function returned something invalid,
8326 barf--don't ignore it.
8327 (To ignore it safely, we would need to gcpro a bunch of
8328 other variables.) */
8329 if (! (VECTORP (next
) || STRINGP (next
)))
8330 error ("Function %s returns invalid key sequence", tem
);
8335 /* Do one step of the key remapping used for function-key-map and
8336 key-translation-map:
8337 KEYBUF is the buffer holding the input events.
8338 BUFSIZE is its maximum size.
8339 FKEY is a pointer to the keyremap structure to use.
8340 INPUT is the index of the last element in KEYBUF.
8341 DOIT if non-zero says that the remapping can actually take place.
8342 DIFF is used to return the number of keys added/removed by the remapping.
8343 PARENT is the root of the keymap.
8344 PROMPT is the prompt to use if the remapping happens through a function.
8345 The return value is non-zero if the remapping actually took place. */
8348 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8349 Lisp_Object
*keybuf
, prompt
;
8351 int input
, doit
, *diff
, bufsize
;
8353 Lisp_Object next
, key
;
8355 key
= keybuf
[fkey
->end
++];
8356 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8358 /* If keybuf[fkey->start..fkey->end] is bound in the
8359 map and we're in a position to do the key remapping, replace it with
8360 the binding and restart with fkey->start at the end. */
8361 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8363 int len
= XFASTINT (Flength (next
));
8366 *diff
= len
- (fkey
->end
- fkey
->start
);
8368 if (input
+ *diff
>= bufsize
)
8369 error ("Key sequence too long");
8371 /* Shift the keys that follow fkey->end. */
8373 for (i
= fkey
->end
; i
< input
; i
++)
8374 keybuf
[i
+ *diff
] = keybuf
[i
];
8376 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8377 keybuf
[i
+ *diff
] = keybuf
[i
];
8378 /* Overwrite the old keys with the new ones. */
8379 for (i
= 0; i
< len
; i
++)
8380 keybuf
[fkey
->start
+ i
]
8381 = Faref (next
, make_number (i
));
8383 fkey
->start
= fkey
->end
+= *diff
;
8384 fkey
->map
= fkey
->parent
;
8389 fkey
->map
= get_keymap (next
, 0, 1);
8391 /* If we no longer have a bound suffix, try a new position for
8393 if (!CONSP (fkey
->map
))
8395 fkey
->end
= ++fkey
->start
;
8396 fkey
->map
= fkey
->parent
;
8401 /* Read a sequence of keys that ends with a non prefix character,
8402 storing it in KEYBUF, a buffer of size BUFSIZE.
8404 Return the length of the key sequence stored.
8405 Return -1 if the user rejected a command menu.
8407 Echo starting immediately unless `prompt' is 0.
8409 Where a key sequence ends depends on the currently active keymaps.
8410 These include any minor mode keymaps active in the current buffer,
8411 the current buffer's local map, and the global map.
8413 If a key sequence has no other bindings, we check Vfunction_key_map
8414 to see if some trailing subsequence might be the beginning of a
8415 function key's sequence. If so, we try to read the whole function
8416 key, and substitute its symbolic name into the key sequence.
8418 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8419 `double-' events into similar click events, if that would make them
8420 bound. We try to turn `triple-' events first into `double-' events,
8423 If we get a mouse click in a mode line, vertical divider, or other
8424 non-text area, we treat the click as if it were prefixed by the
8425 symbol denoting that area - `mode-line', `vertical-line', or
8428 If the sequence starts with a mouse click, we read the key sequence
8429 with respect to the buffer clicked on, not the current buffer.
8431 If the user switches frames in the midst of a key sequence, we put
8432 off the switch-frame event until later; the next call to
8433 read_char will return it.
8435 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8436 from the selected window's buffer. */
8439 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8440 can_return_switch_frame
, fix_current_buffer
)
8441 Lisp_Object
*keybuf
;
8444 int dont_downcase_last
;
8445 int can_return_switch_frame
;
8446 int fix_current_buffer
;
8448 volatile Lisp_Object from_string
;
8449 volatile int count
= SPECPDL_INDEX ();
8451 /* How many keys there are in the current key sequence. */
8454 /* The length of the echo buffer when we started reading, and
8455 the length of this_command_keys when we started reading. */
8456 volatile int echo_start
;
8457 volatile int keys_start
;
8459 /* The number of keymaps we're scanning right now, and the number of
8460 keymaps we have allocated space for. */
8462 volatile int nmaps_allocated
= 0;
8464 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8465 the current keymaps. */
8466 Lisp_Object
*volatile defs
= NULL
;
8468 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8469 in the current keymaps, or nil where it is not a prefix. */
8470 Lisp_Object
*volatile submaps
= NULL
;
8472 /* The local map to start out with at start of key sequence. */
8473 volatile Lisp_Object orig_local_map
;
8475 /* The map from the `keymap' property to start out with at start of
8477 volatile Lisp_Object orig_keymap
;
8479 /* 1 if we have already considered switching to the local-map property
8480 of the place where a mouse click occurred. */
8481 volatile int localized_local_map
= 0;
8483 /* The index in defs[] of the first keymap that has a binding for
8484 this key sequence. In other words, the lowest i such that
8485 defs[i] is non-nil. */
8486 volatile int first_binding
;
8487 /* Index of the first key that has no binding.
8488 It is useless to try fkey.start larger than that. */
8489 volatile int first_unbound
;
8491 /* If t < mock_input, then KEYBUF[t] should be read as the next
8494 We use this to recover after recognizing a function key. Once we
8495 realize that a suffix of the current key sequence is actually a
8496 function key's escape sequence, we replace the suffix with the
8497 function key's binding from Vfunction_key_map. Now keybuf
8498 contains a new and different key sequence, so the echo area,
8499 this_command_keys, and the submaps and defs arrays are wrong. In
8500 this situation, we set mock_input to t, set t to 0, and jump to
8501 restart_sequence; the loop will read keys from keybuf up until
8502 mock_input, thus rebuilding the state; and then it will resume
8503 reading characters from the keyboard. */
8504 volatile int mock_input
= 0;
8506 /* If the sequence is unbound in submaps[], then
8507 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8508 and fkey.map is its binding.
8510 These might be > t, indicating that all function key scanning
8511 should hold off until t reaches them. We do this when we've just
8512 recognized a function key, to avoid searching for the function
8513 key's again in Vfunction_key_map. */
8514 volatile keyremap fkey
;
8516 /* Likewise, for key_translation_map. */
8517 volatile keyremap keytran
;
8519 /* If we receive a `switch-frame' or `select-window' event in the middle of
8520 a key sequence, we put it off for later.
8521 While we're reading, we keep the event here. */
8522 volatile Lisp_Object delayed_switch_frame
;
8524 /* See the comment below... */
8525 #if defined (GOBBLE_FIRST_EVENT)
8526 Lisp_Object first_event
;
8529 volatile Lisp_Object original_uppercase
;
8530 volatile int original_uppercase_position
= -1;
8532 /* Gets around Microsoft compiler limitations. */
8535 struct buffer
*starting_buffer
;
8537 /* List of events for which a fake prefix key has been generated. */
8538 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8540 #if defined (GOBBLE_FIRST_EVENT)
8544 struct gcpro gcpro1
;
8546 GCPRO1 (fake_prefixed_keys
);
8547 raw_keybuf_count
= 0;
8549 last_nonmenu_event
= Qnil
;
8551 delayed_switch_frame
= Qnil
;
8552 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8553 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8554 /* If there is no translation-map, turn off scanning. */
8555 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8556 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8561 echo_prompt (prompt
);
8562 else if (cursor_in_echo_area
8563 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8564 && NILP (Fzerop (Vecho_keystrokes
)))
8565 /* This doesn't put in a dash if the echo buffer is empty, so
8566 you don't always see a dash hanging out in the minibuffer. */
8570 /* Record the initial state of the echo area and this_command_keys;
8571 we will need to restore them if we replay a key sequence. */
8573 echo_start
= echo_length ();
8574 keys_start
= this_command_key_count
;
8575 this_single_command_key_start
= keys_start
;
8577 #if defined (GOBBLE_FIRST_EVENT)
8578 /* This doesn't quite work, because some of the things that read_char
8579 does cannot safely be bypassed. It seems too risky to try to make
8582 /* Read the first char of the sequence specially, before setting
8583 up any keymaps, in case a filter runs and switches buffers on us. */
8584 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8586 #endif /* GOBBLE_FIRST_EVENT */
8588 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8589 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8592 /* We jump here when the key sequence has been thoroughly changed, and
8593 we need to rescan it starting from the beginning. When we jump here,
8594 keybuf[0..mock_input] holds the sequence we should reread. */
8597 starting_buffer
= current_buffer
;
8598 first_unbound
= bufsize
+ 1;
8600 /* Build our list of keymaps.
8601 If we recognize a function key and replace its escape sequence in
8602 keybuf with its symbol, or if the sequence starts with a mouse
8603 click and we need to switch buffers, we jump back here to rebuild
8604 the initial keymaps from the current buffer. */
8607 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8608 || !NILP (Voverriding_local_map
))
8610 if (3 > nmaps_allocated
)
8612 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8613 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8614 nmaps_allocated
= 3;
8616 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8617 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8618 if (!NILP (Voverriding_local_map
))
8619 submaps
[nmaps
++] = Voverriding_local_map
;
8627 nminor
= current_minor_maps (0, &maps
);
8628 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8630 if (total
> nmaps_allocated
)
8632 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8633 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8634 nmaps_allocated
= total
;
8637 if (!NILP (orig_keymap
))
8638 submaps
[nmaps
++] = orig_keymap
;
8640 bcopy (maps
, (void *) (submaps
+ nmaps
),
8641 nminor
* sizeof (submaps
[0]));
8645 submaps
[nmaps
++] = orig_local_map
;
8647 submaps
[nmaps
++] = current_global_map
;
8649 /* Find an accurate initial value for first_binding. */
8650 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8651 if (! NILP (submaps
[first_binding
]))
8654 /* Start from the beginning in keybuf. */
8657 /* These are no-ops the first time through, but if we restart, they
8658 revert the echo area and this_command_keys to their original state. */
8659 this_command_key_count
= keys_start
;
8660 if (INTERACTIVE
&& t
< mock_input
)
8661 echo_truncate (echo_start
);
8663 /* If the best binding for the current key sequence is a keymap, or
8664 we may be looking at a function key's escape sequence, keep on
8666 while (first_binding
< nmaps
8667 /* Keep reading as long as there's a prefix binding. */
8668 ? !NILP (submaps
[first_binding
])
8669 /* Don't return in the middle of a possible function key sequence,
8670 if the only bindings we found were via case conversion.
8671 Thus, if ESC O a has a function-key-map translation
8672 and ESC o has a binding, don't return after ESC O,
8673 so that we can translate ESC O plus the next character. */
8674 : (fkey
.start
< t
|| keytran
.start
< t
))
8677 int used_mouse_menu
= 0;
8679 /* Where the last real key started. If we need to throw away a
8680 key that has expanded into more than one element of keybuf
8681 (say, a mouse click on the mode line which is being treated
8682 as [mode-line (mouse-...)], then we backtrack to this point
8684 volatile int last_real_key_start
;
8686 /* These variables are analogous to echo_start and keys_start;
8687 while those allow us to restart the entire key sequence,
8688 echo_local_start and keys_local_start allow us to throw away
8690 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8692 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8693 eassert (fkey
.start
<= fkey
.end
);
8694 eassert (keytran
.start
<= keytran
.end
);
8695 /* key-translation-map is applied *after* function-key-map. */
8696 eassert (keytran
.end
<= fkey
.start
);
8698 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8699 { /* The prefix upto first_unbound has no binding and has
8700 no translation left to do either, so we know it's unbound.
8701 If we don't stop now, we risk staying here indefinitely
8702 (if the user keeps entering fkey or keytran prefixes
8703 like C-c ESC ESC ESC ESC ...) */
8705 for (i
= first_unbound
+ 1; i
< t
; i
++)
8706 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8707 mock_input
= t
- first_unbound
- 1;
8708 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8709 fkey
.map
= fkey
.parent
;
8710 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8711 keytran
.map
= keytran
.parent
;
8712 goto replay_sequence
;
8716 error ("Key sequence too long");
8719 echo_local_start
= echo_length ();
8720 keys_local_start
= this_command_key_count
;
8721 local_first_binding
= first_binding
;
8724 /* These are no-ops, unless we throw away a keystroke below and
8725 jumped back up to replay_key; in that case, these restore the
8726 variables to their original state, allowing us to replay the
8728 if (INTERACTIVE
&& t
< mock_input
)
8729 echo_truncate (echo_local_start
);
8730 this_command_key_count
= keys_local_start
;
8731 first_binding
= local_first_binding
;
8733 /* By default, assume each event is "real". */
8734 last_real_key_start
= t
;
8736 /* Does mock_input indicate that we are re-reading a key sequence? */
8740 add_command_key (key
);
8741 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8742 && NILP (Fzerop (Vecho_keystrokes
)))
8746 /* If not, we should actually read a character. */
8751 KBOARD
*interrupted_kboard
= current_kboard
;
8752 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8753 if (setjmp (wrong_kboard_jmpbuf
))
8755 if (!NILP (delayed_switch_frame
))
8757 interrupted_kboard
->kbd_queue
8758 = Fcons (delayed_switch_frame
,
8759 interrupted_kboard
->kbd_queue
);
8760 delayed_switch_frame
= Qnil
;
8763 interrupted_kboard
->kbd_queue
8764 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8766 /* If the side queue is non-empty, ensure it begins with a
8767 switch-frame, so we'll replay it in the right context. */
8768 if (CONSP (interrupted_kboard
->kbd_queue
)
8769 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8770 !(EVENT_HAS_PARAMETERS (key
)
8771 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8775 XSETFRAME (frame
, interrupted_frame
);
8776 interrupted_kboard
->kbd_queue
8777 = Fcons (make_lispy_switch_frame (frame
),
8778 interrupted_kboard
->kbd_queue
);
8781 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8782 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8783 goto replay_sequence
;
8786 key
= read_char (NILP (prompt
), nmaps
,
8787 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8791 /* read_char returns t when it shows a menu and the user rejects it.
8795 unbind_to (count
, Qnil
);
8800 /* read_char returns -1 at the end of a macro.
8801 Emacs 18 handles this by returning immediately with a
8802 zero, so that's what we'll do. */
8803 if (INTEGERP (key
) && XINT (key
) == -1)
8806 /* The Microsoft C compiler can't handle the goto that
8812 /* If the current buffer has been changed from under us, the
8813 keymap may have changed, so replay the sequence. */
8816 timer_resume_idle ();
8819 /* Reset the current buffer from the selected window
8820 in case something changed the former and not the latter.
8821 This is to be more consistent with the behavior
8822 of the command_loop_1. */
8823 if (fix_current_buffer
)
8825 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8827 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8828 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8831 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8832 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8833 goto replay_sequence
;
8836 /* If we have a quit that was typed in another frame, and
8837 quit_throw_to_read_char switched buffers,
8838 replay to get the right keymap. */
8840 && XINT (key
) == quit_char
8841 && current_buffer
!= starting_buffer
)
8844 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8848 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8849 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8850 goto replay_sequence
;
8855 if (EVENT_HAS_PARAMETERS (key
)
8856 /* Either a `switch-frame' or a `select-window' event. */
8857 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8859 /* If we're at the beginning of a key sequence, and the caller
8860 says it's okay, go ahead and return this event. If we're
8861 in the midst of a key sequence, delay it until the end. */
8862 if (t
> 0 || !can_return_switch_frame
)
8864 delayed_switch_frame
= key
;
8870 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8873 /* Clicks in non-text areas get prefixed by the symbol
8874 in their CHAR-ADDRESS field. For example, a click on
8875 the mode line is prefixed by the symbol `mode-line'.
8877 Furthermore, key sequences beginning with mouse clicks
8878 are read using the keymaps of the buffer clicked on, not
8879 the current buffer. So we may have to switch the buffer
8882 When we turn one event into two events, we must make sure
8883 that neither of the two looks like the original--so that,
8884 if we replay the events, they won't be expanded again.
8885 If not for this, such reexpansion could happen either here
8886 or when user programs play with this-command-keys. */
8887 if (EVENT_HAS_PARAMETERS (key
))
8892 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8893 if (EQ (kind
, Qmouse_click
))
8895 Lisp_Object window
, posn
;
8897 window
= POSN_WINDOW (EVENT_START (key
));
8898 posn
= POSN_POSN (EVENT_START (key
));
8901 || (!NILP (fake_prefixed_keys
)
8902 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8904 /* We're looking a second time at an event for which
8905 we generated a fake prefix key. Set
8906 last_real_key_start appropriately. */
8908 last_real_key_start
= t
- 1;
8911 /* Key sequences beginning with mouse clicks are
8912 read using the keymaps in the buffer clicked on,
8913 not the current buffer. If we're at the
8914 beginning of a key sequence, switch buffers. */
8915 if (last_real_key_start
== 0
8917 && BUFFERP (XWINDOW (window
)->buffer
)
8918 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8920 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8924 /* Arrange to go back to the original buffer once we're
8925 done reading the key sequence. Note that we can't
8926 use save_excursion_{save,restore} here, because they
8927 save point as well as the current buffer; we don't
8928 want to save point, because redisplay may change it,
8929 to accommodate a Fset_window_start or something. We
8930 don't want to do this at the top of the function,
8931 because we may get input from a subprocess which
8932 wants to change the selected window and stuff (say,
8934 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8936 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8938 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8939 orig_local_map
= get_local_map (PT
, current_buffer
,
8941 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8942 goto replay_sequence
;
8945 /* For a mouse click, get the local text-property keymap
8946 of the place clicked on, rather than point. */
8947 if (last_real_key_start
== 0
8948 && CONSP (XCDR (key
))
8949 && ! localized_local_map
)
8951 Lisp_Object map_here
, start
, pos
;
8953 localized_local_map
= 1;
8954 start
= EVENT_START (key
);
8956 if (CONSP (start
) && POSN_INBUFFER_P (start
))
8958 pos
= POSN_BUFFER_POSN (start
);
8960 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8962 map_here
= get_local_map (XINT (pos
),
8963 current_buffer
, Qlocal_map
);
8964 if (!EQ (map_here
, orig_local_map
))
8966 orig_local_map
= map_here
;
8970 goto replay_sequence
;
8972 map_here
= get_local_map (XINT (pos
),
8973 current_buffer
, Qkeymap
);
8974 if (!EQ (map_here
, orig_keymap
))
8976 orig_keymap
= map_here
;
8980 goto replay_sequence
;
8986 /* Expand mode-line and scroll-bar events into two events:
8987 use posn as a fake prefix key. */
8989 && (NILP (fake_prefixed_keys
)
8990 || NILP (Fmemq (key
, fake_prefixed_keys
))))
8992 if (t
+ 1 >= bufsize
)
8993 error ("Key sequence too long");
8996 keybuf
[t
+ 1] = key
;
8999 /* Record that a fake prefix key has been generated
9000 for KEY. Don't modify the event; this would
9001 prevent proper action when the event is pushed
9002 back into unread-command-events. */
9003 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9005 /* If on a mode line string with a local keymap,
9006 reconsider the key sequence with that keymap. */
9007 if (string
= POSN_STRING (EVENT_START (key
)),
9008 (CONSP (string
) && STRINGP (XCAR (string
))))
9010 Lisp_Object pos
, map
, map2
;
9012 pos
= XCDR (string
);
9013 string
= XCAR (string
);
9015 && XINT (pos
) < SCHARS (string
))
9017 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9019 orig_local_map
= map
;
9020 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9023 if (!NILP (map
) || !NILP (map2
))
9024 goto replay_sequence
;
9030 else if (NILP (from_string
)
9031 && (string
= POSN_STRING (EVENT_START (key
)),
9032 (CONSP (string
) && STRINGP (XCAR (string
)))))
9034 /* For a click on a string, i.e. overlay string or a
9035 string displayed via the `display' property,
9036 consider `local-map' and `keymap' properties of
9038 Lisp_Object pos
, map
, map2
;
9040 pos
= XCDR (string
);
9041 string
= XCAR (string
);
9043 && XINT (pos
) < SCHARS (string
))
9045 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9047 orig_local_map
= map
;
9048 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9052 if (!NILP (map
) || !NILP (map2
))
9054 from_string
= string
;
9055 goto replay_sequence
;
9060 else if (CONSP (XCDR (key
))
9061 && CONSP (EVENT_START (key
))
9062 && CONSP (XCDR (EVENT_START (key
))))
9066 posn
= POSN_POSN (EVENT_START (key
));
9067 /* Handle menu-bar events:
9068 insert the dummy prefix event `menu-bar'. */
9069 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9071 if (t
+ 1 >= bufsize
)
9072 error ("Key sequence too long");
9076 /* Zap the position in key, so we know that we've
9077 expanded it, and don't try to do so again. */
9078 POSN_SET_POSN (EVENT_START (key
),
9079 Fcons (posn
, Qnil
));
9082 goto replay_sequence
;
9084 else if (CONSP (posn
))
9086 /* We're looking at the second event of a
9087 sequence which we expanded before. Set
9088 last_real_key_start appropriately. */
9089 if (last_real_key_start
== t
&& t
> 0)
9090 last_real_key_start
= t
- 1;
9095 /* We have finally decided that KEY is something we might want
9097 first_binding
= (follow_key (key
,
9098 nmaps
- first_binding
,
9099 submaps
+ first_binding
,
9100 defs
+ first_binding
,
9101 submaps
+ first_binding
)
9104 /* If KEY wasn't bound, we'll try some fallbacks. */
9105 if (first_binding
< nmaps
)
9106 /* This is needed for the following scenario:
9107 event 0: a down-event that gets dropped by calling replay_key.
9108 event 1: some normal prefix like C-h.
9109 After event 0, first_unbound is 0, after event 1 fkey.start
9110 and keytran.start are both 1, so when we see that C-h is bound,
9111 we need to update first_unbound. */
9112 first_unbound
= max (t
+ 1, first_unbound
);
9117 /* Remember the position to put an upper bound on fkey.start. */
9118 first_unbound
= min (t
, first_unbound
);
9120 head
= EVENT_HEAD (key
);
9121 if (help_char_p (head
) && t
> 0)
9123 read_key_sequence_cmd
= Vprefix_help_command
;
9125 last_nonmenu_event
= key
;
9126 /* The Microsoft C compiler can't handle the goto that
9134 Lisp_Object breakdown
;
9137 breakdown
= parse_modifiers (head
);
9138 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9139 /* Attempt to reduce an unbound mouse event to a simpler
9140 event that is bound:
9141 Drags reduce to clicks.
9142 Double-clicks reduce to clicks.
9143 Triple-clicks reduce to double-clicks, then to clicks.
9144 Down-clicks are eliminated.
9145 Double-downs reduce to downs, then are eliminated.
9146 Triple-downs reduce to double-downs, then to downs,
9147 then are eliminated. */
9148 if (modifiers
& (down_modifier
| drag_modifier
9149 | double_modifier
| triple_modifier
))
9151 while (modifiers
& (down_modifier
| drag_modifier
9152 | double_modifier
| triple_modifier
))
9154 Lisp_Object new_head
, new_click
;
9155 if (modifiers
& triple_modifier
)
9156 modifiers
^= (double_modifier
| triple_modifier
);
9157 else if (modifiers
& double_modifier
)
9158 modifiers
&= ~double_modifier
;
9159 else if (modifiers
& drag_modifier
)
9160 modifiers
&= ~drag_modifier
;
9163 /* Dispose of this `down' event by simply jumping
9164 back to replay_key, to get another event.
9166 Note that if this event came from mock input,
9167 then just jumping back to replay_key will just
9168 hand it to us again. So we have to wipe out any
9171 We could delete keybuf[t] and shift everything
9172 after that to the left by one spot, but we'd also
9173 have to fix up any variable that points into
9174 keybuf, and shifting isn't really necessary
9177 Adding prefixes for non-textual mouse clicks
9178 creates two characters of mock input, and both
9179 must be thrown away. If we're only looking at
9180 the prefix now, we can just jump back to
9181 replay_key. On the other hand, if we've already
9182 processed the prefix, and now the actual click
9183 itself is giving us trouble, then we've lost the
9184 state of the keymaps we want to backtrack to, and
9185 we need to replay the whole sequence to rebuild
9188 Beyond that, only function key expansion could
9189 create more than two keys, but that should never
9190 generate mouse events, so it's okay to zero
9191 mock_input in that case too.
9193 FIXME: The above paragraph seems just plain
9194 wrong, if you consider things like
9195 xterm-mouse-mode. -stef
9197 Isn't this just the most wonderful code ever? */
9199 /* If mock_input > t + 1, the above simplification
9200 will actually end up dropping keys on the floor.
9201 This is probably OK for now, but even
9202 if mock_input <= t + 1, we need to adjust fkey
9204 Typical case [header-line down-mouse-N]:
9205 mock_input = 2, t = 1, fkey.end = 1,
9206 last_real_key_start = 0. */
9207 if (fkey
.end
> last_real_key_start
)
9209 fkey
.end
= fkey
.start
9210 = min (last_real_key_start
, fkey
.start
);
9211 fkey
.map
= fkey
.parent
;
9212 if (keytran
.end
> last_real_key_start
)
9214 keytran
.end
= keytran
.start
9215 = min (last_real_key_start
, keytran
.start
);
9216 keytran
.map
= keytran
.parent
;
9219 if (t
== last_real_key_start
)
9226 mock_input
= last_real_key_start
;
9227 goto replay_sequence
;
9232 = apply_modifiers (modifiers
, XCAR (breakdown
));
9234 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9236 /* Look for a binding for this new key. follow_key
9237 promises that it didn't munge submaps the
9238 last time we called it, since key was unbound. */
9240 = (follow_key (new_click
,
9241 nmaps
- local_first_binding
,
9242 submaps
+ local_first_binding
,
9243 defs
+ local_first_binding
,
9244 submaps
+ local_first_binding
)
9245 + local_first_binding
);
9247 /* If that click is bound, go for it. */
9248 if (first_binding
< nmaps
)
9253 /* Otherwise, we'll leave key set to the drag event. */
9260 /* Normally, last_nonmenu_event gets the previous key we read.
9261 But when a mouse popup menu is being used,
9262 we don't update last_nonmenu_event; it continues to hold the mouse
9263 event that preceded the first level of menu. */
9264 if (!used_mouse_menu
)
9265 last_nonmenu_event
= key
;
9267 /* Record what part of this_command_keys is the current key sequence. */
9268 this_single_command_key_start
= this_command_key_count
- t
;
9270 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9271 /* There is a binding and it's not a prefix.
9272 There is thus no function-key in this sequence.
9273 Moving fkey.start is important in this case to allow keytran.start
9274 to go over the sequence before we return (since we keep the
9275 invariant that keytran.end <= fkey.start). */
9278 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9281 /* If the sequence is unbound, see if we can hang a function key
9282 off the end of it. */
9283 /* Continue scan from fkey.end until we find a bound suffix. */
9284 while (fkey
.end
< t
)
9286 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9289 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9290 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9291 max (t
, mock_input
),
9292 /* If there's a binding (i.e.
9293 first_binding >= nmaps) we don't want
9294 to apply this function-key-mapping. */
9295 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9300 mock_input
= diff
+ max (t
, mock_input
);
9301 goto replay_sequence
;
9305 /* Look for this sequence in key-translation-map.
9306 Scan from keytran.end until we find a bound suffix. */
9307 while (keytran
.end
< fkey
.start
)
9309 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9312 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9313 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9318 mock_input
= diff
+ max (t
, mock_input
);
9319 /* Adjust the function-key-map counters. */
9323 goto replay_sequence
;
9327 /* If KEY is not defined in any of the keymaps,
9328 and cannot be part of a function key or translation,
9329 and is an upper case letter
9330 use the corresponding lower-case letter instead. */
9331 if (first_binding
>= nmaps
9332 && fkey
.start
>= t
&& keytran
.start
>= t
9334 && ((((XINT (key
) & 0x3ffff)
9335 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9336 && UPPERCASEP (XINT (key
) & 0x3ffff))
9337 || (XINT (key
) & shift_modifier
)))
9339 Lisp_Object new_key
;
9341 original_uppercase
= key
;
9342 original_uppercase_position
= t
- 1;
9344 if (XINT (key
) & shift_modifier
)
9345 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9347 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9348 | (XINT (key
) & ~0x3ffff)));
9350 /* We have to do this unconditionally, regardless of whether
9351 the lower-case char is defined in the keymaps, because they
9352 might get translated through function-key-map. */
9353 keybuf
[t
- 1] = new_key
;
9354 mock_input
= max (t
, mock_input
);
9356 goto replay_sequence
;
9358 /* If KEY is not defined in any of the keymaps,
9359 and cannot be part of a function key or translation,
9360 and is a shifted function key,
9361 use the corresponding unshifted function key instead. */
9362 if (first_binding
>= nmaps
9363 && fkey
.start
>= t
&& keytran
.start
>= t
9366 Lisp_Object breakdown
;
9369 breakdown
= parse_modifiers (key
);
9370 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9371 if (modifiers
& shift_modifier
)
9373 Lisp_Object new_key
;
9375 original_uppercase
= key
;
9376 original_uppercase_position
= t
- 1;
9378 modifiers
&= ~shift_modifier
;
9379 new_key
= apply_modifiers (modifiers
,
9382 keybuf
[t
- 1] = new_key
;
9383 mock_input
= max (t
, mock_input
);
9384 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9385 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9387 goto replay_sequence
;
9393 read_key_sequence_cmd
= (first_binding
< nmaps
9394 ? defs
[first_binding
]
9397 unread_switch_frame
= delayed_switch_frame
;
9398 unbind_to (count
, Qnil
);
9400 /* Don't downcase the last character if the caller says don't.
9401 Don't downcase it if the result is undefined, either. */
9402 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9403 && t
- 1 == original_uppercase_position
)
9404 keybuf
[t
- 1] = original_uppercase
;
9406 /* Occasionally we fabricate events, perhaps by expanding something
9407 according to function-key-map, or by adding a prefix symbol to a
9408 mouse click in the scroll bar or modeline. In this cases, return
9409 the entire generated key sequence, even if we hit an unbound
9410 prefix or a definition before the end. This means that you will
9411 be able to push back the event properly, and also means that
9412 read-key-sequence will always return a logical unit.
9415 for (; t
< mock_input
; t
++)
9417 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9418 && NILP (Fzerop (Vecho_keystrokes
)))
9419 echo_char (keybuf
[t
]);
9420 add_command_key (keybuf
[t
]);
9429 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9430 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9431 The sequence is sufficient to specify a non-prefix command in the
9432 current local and global maps.
9434 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9435 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9436 as a continuation of the previous key.
9438 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9439 convert the last event to lower case. (Normally any upper case event
9440 is converted to lower case if the original event is undefined and the lower
9441 case equivalent is defined.) A non-nil value is appropriate for reading
9442 a key sequence to be defined.
9444 A C-g typed while in this function is treated like any other character,
9445 and `quit-flag' is not set.
9447 If the key sequence starts with a mouse click, then the sequence is read
9448 using the keymaps of the buffer of the window clicked in, not the buffer
9449 of the selected window as normal.
9451 `read-key-sequence' drops unbound button-down events, since you normally
9452 only care about the click or drag events which follow them. If a drag
9453 or multi-click event is unbound, but the corresponding click event would
9454 be bound, `read-key-sequence' turns the event into a click event at the
9455 drag's starting position. This means that you don't have to distinguish
9456 between click and drag, double, or triple events unless you want to.
9458 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9459 lines separating windows, and scroll bars with imaginary keys
9460 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9462 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9463 function will process a switch-frame event if the user switches frames
9464 before typing anything. If the user switches frames in the middle of a
9465 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9466 is nil, then the event will be put off until after the current key sequence.
9468 `read-key-sequence' checks `function-key-map' for function key
9469 sequences, where they wouldn't conflict with ordinary bindings. See
9470 `function-key-map' for more details.
9472 The optional fifth argument COMMAND-LOOP, if non-nil, means
9473 that this key sequence is being read by something that will
9474 read commands one after another. It should be nil if the caller
9475 will read just one key sequence. */)
9476 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9478 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9479 Lisp_Object can_return_switch_frame
, command_loop
;
9481 Lisp_Object keybuf
[30];
9483 struct gcpro gcpro1
;
9484 int count
= SPECPDL_INDEX ();
9487 CHECK_STRING (prompt
);
9490 specbind (Qinput_method_exit_on_first_char
,
9491 (NILP (command_loop
) ? Qt
: Qnil
));
9492 specbind (Qinput_method_use_echo_area
,
9493 (NILP (command_loop
) ? Qt
: Qnil
));
9495 bzero (keybuf
, sizeof keybuf
);
9497 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9499 if (NILP (continue_echo
))
9501 this_command_key_count
= 0;
9502 this_command_key_count_reset
= 0;
9503 this_single_command_key_start
= 0;
9506 #ifdef HAVE_X_WINDOWS
9507 if (display_hourglass_p
)
9508 cancel_hourglass ();
9511 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9512 prompt
, ! NILP (dont_downcase_last
),
9513 ! NILP (can_return_switch_frame
), 0);
9515 #if 0 /* The following is fine for code reading a key sequence and
9516 then proceeding with a lenghty computation, but it's not good
9517 for code reading keys in a loop, like an input method. */
9518 #ifdef HAVE_X_WINDOWS
9519 if (display_hourglass_p
)
9530 return unbind_to (count
, make_event_array (i
, keybuf
));
9533 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9534 Sread_key_sequence_vector
, 1, 5, 0,
9535 doc
: /* Like `read-key-sequence' but always return a vector. */)
9536 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9538 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9539 Lisp_Object can_return_switch_frame
, command_loop
;
9541 Lisp_Object keybuf
[30];
9543 struct gcpro gcpro1
;
9544 int count
= SPECPDL_INDEX ();
9547 CHECK_STRING (prompt
);
9550 specbind (Qinput_method_exit_on_first_char
,
9551 (NILP (command_loop
) ? Qt
: Qnil
));
9552 specbind (Qinput_method_use_echo_area
,
9553 (NILP (command_loop
) ? Qt
: Qnil
));
9555 bzero (keybuf
, sizeof keybuf
);
9557 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9559 if (NILP (continue_echo
))
9561 this_command_key_count
= 0;
9562 this_command_key_count_reset
= 0;
9563 this_single_command_key_start
= 0;
9566 #ifdef HAVE_X_WINDOWS
9567 if (display_hourglass_p
)
9568 cancel_hourglass ();
9571 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9572 prompt
, ! NILP (dont_downcase_last
),
9573 ! NILP (can_return_switch_frame
), 0);
9575 #ifdef HAVE_X_WINDOWS
9576 if (display_hourglass_p
)
9586 return unbind_to (count
, Fvector (i
, keybuf
));
9589 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9590 doc
: /* Execute CMD as an editor command.
9591 CMD must be a symbol that satisfies the `commandp' predicate.
9592 Optional second arg RECORD-FLAG non-nil
9593 means unconditionally put this command in `command-history'.
9594 Otherwise, that is done only if an arg is read using the minibuffer.
9595 The argument KEYS specifies the value to use instead of (this-command-keys)
9596 when reading the arguments; if it is nil, (this-command-keys) is used.
9597 The argument SPECIAL, if non-nil, means that this command is executing
9598 a special event, so ignore the prefix argument and don't clear it. */)
9599 (cmd
, record_flag
, keys
, special
)
9600 Lisp_Object cmd
, record_flag
, keys
, special
;
9602 register Lisp_Object final
;
9603 register Lisp_Object tem
;
9604 Lisp_Object prefixarg
;
9605 struct backtrace backtrace
;
9606 extern int debug_on_next_call
;
9608 debug_on_next_call
= 0;
9612 prefixarg
= current_kboard
->Vprefix_arg
;
9613 Vcurrent_prefix_arg
= prefixarg
;
9614 current_kboard
->Vprefix_arg
= Qnil
;
9621 tem
= Fget (cmd
, Qdisabled
);
9622 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9624 tem
= Fsymbol_value (Qdisabled_command_function
);
9626 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9632 final
= Findirect_function (cmd
);
9634 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9636 struct gcpro gcpro1
, gcpro2
;
9638 GCPRO2 (cmd
, prefixarg
);
9639 do_autoload (final
, cmd
);
9646 if (STRINGP (final
) || VECTORP (final
))
9648 /* If requested, place the macro in the command history. For
9649 other sorts of commands, call-interactively takes care of
9651 if (!NILP (record_flag
))
9654 = Fcons (Fcons (Qexecute_kbd_macro
,
9655 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9658 /* Don't keep command history around forever. */
9659 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9661 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9663 XSETCDR (tem
, Qnil
);
9667 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9670 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9672 backtrace
.next
= backtrace_list
;
9673 backtrace_list
= &backtrace
;
9674 backtrace
.function
= &Qcall_interactively
;
9675 backtrace
.args
= &cmd
;
9676 backtrace
.nargs
= 1;
9677 backtrace
.evalargs
= 0;
9678 backtrace
.debug_on_exit
= 0;
9680 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9682 backtrace_list
= backtrace
.next
;
9690 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9692 doc
: /* Read function name, then read its arguments and call it. */)
9694 Lisp_Object prefixarg
;
9696 Lisp_Object function
;
9698 int saved_last_point_position
;
9699 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9700 Lisp_Object bindings
, value
;
9701 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9703 saved_keys
= Fvector (this_command_key_count
,
9704 XVECTOR (this_command_keys
)->contents
);
9705 saved_last_point_position_buffer
= last_point_position_buffer
;
9706 saved_last_point_position
= last_point_position
;
9708 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9710 if (EQ (prefixarg
, Qminus
))
9712 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9713 strcpy (buf
, "C-u ");
9714 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9715 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9716 else if (INTEGERP (prefixarg
))
9717 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9719 /* This isn't strictly correct if execute-extended-command
9720 is bound to anything else. Perhaps it should use
9721 this_command_keys? */
9722 strcat (buf
, "M-x ");
9724 /* Prompt with buf, and then read a string, completing from and
9725 restricting to the set of all defined commands. Don't provide
9726 any initial input. Save the command read on the extended-command
9728 function
= Fcompleting_read (build_string (buf
),
9729 Vobarray
, Qcommandp
,
9730 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9733 if (STRINGP (function
) && SCHARS (function
) == 0)
9734 error ("No command name given");
9736 /* Set this_command_keys to the concatenation of saved_keys and
9737 function, followed by a RET. */
9742 this_command_key_count
= 0;
9743 this_command_key_count_reset
= 0;
9744 this_single_command_key_start
= 0;
9746 keys
= XVECTOR (saved_keys
)->contents
;
9747 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9748 add_command_key (keys
[i
]);
9750 for (i
= 0; i
< SCHARS (function
); i
++)
9751 add_command_key (Faref (function
, make_number (i
)));
9753 add_command_key (make_number ('\015'));
9756 last_point_position
= saved_last_point_position
;
9757 last_point_position_buffer
= saved_last_point_position_buffer
;
9761 function
= Fintern (function
, Qnil
);
9762 current_kboard
->Vprefix_arg
= prefixarg
;
9763 Vthis_command
= function
;
9764 real_this_command
= function
;
9766 /* If enabled, show which key runs this command. */
9767 if (!NILP (Vsuggest_key_bindings
)
9768 && NILP (Vexecuting_macro
)
9769 && SYMBOLP (function
))
9770 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9776 GCPRO2 (bindings
, value
);
9777 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9779 /* If the command has a key binding, print it now. */
9780 if (!NILP (bindings
)
9781 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9784 /* But first wait, and skip the message if there is input. */
9786 if (!NILP (echo_area_buffer
[0]))
9787 /* This command displayed something in the echo area;
9788 so wait a few seconds, then display our suggestion message. */
9789 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9790 ? XINT (Vsuggest_key_bindings
) : 2);
9792 /* This command left the echo area empty,
9793 so display our message immediately. */
9796 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9797 && ! CONSP (Vunread_command_events
))
9799 Lisp_Object binding
;
9801 int message_p
= push_message ();
9802 int count
= SPECPDL_INDEX ();
9804 record_unwind_protect (pop_message_unwind
, Qnil
);
9805 binding
= Fkey_description (bindings
, Qnil
);
9808 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9811 sprintf (newmessage
, "You can run the command `%s' with %s",
9812 SDATA (SYMBOL_NAME (function
)),
9814 message2_nolog (newmessage
,
9815 strlen (newmessage
),
9816 STRING_MULTIBYTE (binding
));
9817 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9818 ? Vsuggest_key_bindings
: make_number (2)),
9823 unbind_to (count
, Qnil
);
9827 RETURN_UNGCPRO (value
);
9831 /* Return nonzero if input events are pending. */
9834 detect_input_pending ()
9837 get_input_pending (&input_pending
, 0);
9839 return input_pending
;
9842 /* Return nonzero if input events are pending, and run any pending timers. */
9845 detect_input_pending_run_timers (do_display
)
9848 int old_timers_run
= timers_run
;
9851 get_input_pending (&input_pending
, 1);
9853 if (old_timers_run
!= timers_run
&& do_display
)
9855 redisplay_preserve_echo_area (8);
9856 /* The following fixes a bug when using lazy-lock with
9857 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9858 from an idle timer function. The symptom of the bug is that
9859 the cursor sometimes doesn't become visible until the next X
9860 event is processed. --gerd. */
9862 rif
->flush_display (NULL
);
9865 return input_pending
;
9868 /* This is called in some cases before a possible quit.
9869 It cases the next call to detect_input_pending to recompute input_pending.
9870 So calling this function unnecessarily can't do any harm. */
9873 clear_input_pending ()
9878 /* Return nonzero if there are pending requeued events.
9879 This isn't used yet. The hope is to make wait_reading_process_output
9880 call it, and return if it runs Lisp code that unreads something.
9881 The problem is, kbd_buffer_get_event needs to be fixed to know what
9882 to do in that case. It isn't trivial. */
9885 requeued_events_pending_p ()
9887 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9891 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9892 doc
: /* Return t if command input is currently available with no wait.
9893 Actually, the value is nil only if we can be sure that no input is available;
9894 if there is a doubt, the value is t. */)
9897 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9900 get_filtered_input_pending (&input_pending
, 1, 1);
9901 return input_pending
> 0 ? Qt
: Qnil
;
9904 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9905 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9908 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9911 if (total_keys
< NUM_RECENT_KEYS
)
9912 return Fvector (total_keys
, keys
);
9915 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9916 bcopy (keys
+ recent_keys_index
,
9917 XVECTOR (val
)->contents
,
9918 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9920 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9921 recent_keys_index
* sizeof (Lisp_Object
));
9926 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9927 doc
: /* Return the key sequence that invoked this command.
9928 However, if the command has called `read-key-sequence', it returns
9929 the last key sequence that has been read.
9930 The value is a string or a vector. */)
9933 return make_event_array (this_command_key_count
,
9934 XVECTOR (this_command_keys
)->contents
);
9937 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9938 doc
: /* Return the key sequence that invoked this command, as a vector.
9939 However, if the command has called `read-key-sequence', it returns
9940 the last key sequence that has been read. */)
9943 return Fvector (this_command_key_count
,
9944 XVECTOR (this_command_keys
)->contents
);
9947 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9948 Sthis_single_command_keys
, 0, 0, 0,
9949 doc
: /* Return the key sequence that invoked this command.
9950 More generally, it returns the last key sequence read, either by
9951 the command loop or by `read-key-sequence'.
9952 Unlike `this-command-keys', this function's value
9953 does not include prefix arguments.
9954 The value is always a vector. */)
9957 return Fvector (this_command_key_count
9958 - this_single_command_key_start
,
9959 (XVECTOR (this_command_keys
)->contents
9960 + this_single_command_key_start
));
9963 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9964 Sthis_single_command_raw_keys
, 0, 0, 0,
9965 doc
: /* Return the raw events that were read for this command.
9966 More generally, it returns the last key sequence read, either by
9967 the command loop or by `read-key-sequence'.
9968 Unlike `this-single-command-keys', this function's value
9969 shows the events before all translations (except for input methods).
9970 The value is always a vector. */)
9973 return Fvector (raw_keybuf_count
,
9974 (XVECTOR (raw_keybuf
)->contents
));
9977 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9978 Sreset_this_command_lengths
, 0, 0, 0,
9979 doc
: /* Make the unread events replace the last command and echo.
9980 Used in `universal-argument-other-key'.
9982 `universal-argument-other-key' rereads the event just typed.
9983 It then gets translated through `function-key-map'.
9984 The translated event has to replace the real events,
9985 both in the value of (this-command-keys) and in echoing.
9986 To achieve this, `universal-argument-other-key' calls
9987 `reset-this-command-lengths', which discards the record of reading
9988 these events the first time. */)
9991 this_command_key_count
= before_command_key_count
;
9992 if (this_command_key_count
< this_single_command_key_start
)
9993 this_single_command_key_start
= this_command_key_count
;
9995 echo_truncate (before_command_echo_length
);
9997 /* Cause whatever we put into unread-command-events
9998 to echo as if it were being freshly read from the keyboard. */
9999 this_command_key_count_reset
= 1;
10004 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10005 Sclear_this_command_keys
, 0, 1, 0,
10006 doc
: /* Clear out the vector that `this-command-keys' returns.
10007 Also clear the record of the last 100 events, unless optional arg
10008 KEEP-RECORD is non-nil. */)
10010 Lisp_Object keep_record
;
10014 this_command_key_count
= 0;
10015 this_command_key_count_reset
= 0;
10017 if (NILP (keep_record
))
10019 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10020 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10022 recent_keys_index
= 0;
10027 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10028 doc
: /* Return the current depth in recursive edits. */)
10032 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10036 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10037 "FOpen dribble file: ",
10038 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10039 If FILE is nil, close any open dribble file. */)
10050 file
= Fexpand_file_name (file
, Qnil
);
10051 dribble
= fopen (SDATA (file
), "w");
10053 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10058 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10059 doc
: /* Discard the contents of the terminal input buffer.
10060 Also end any kbd macro being defined. */)
10063 if (!NILP (current_kboard
->defining_kbd_macro
))
10065 /* Discard the last command from the macro. */
10066 Fcancel_kbd_macro_events ();
10070 update_mode_lines
++;
10072 Vunread_command_events
= Qnil
;
10073 unread_command_char
= -1;
10075 discard_tty_input ();
10077 kbd_fetch_ptr
= kbd_store_ptr
;
10083 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10084 doc
: /* Stop Emacs and return to superior process. You can resume later.
10085 If `cannot-suspend' is non-nil, or if the system doesn't support job
10086 control, run a subshell instead.
10088 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10089 to be read as terminal input by Emacs's parent, after suspension.
10091 Before suspending, run the normal hook `suspend-hook'.
10092 After resumption run the normal hook `suspend-resume-hook'.
10094 Some operating systems cannot stop the Emacs process and resume it later.
10095 On such systems, Emacs starts a subshell instead of suspending. */)
10097 Lisp_Object stuffstring
;
10099 int count
= SPECPDL_INDEX ();
10100 int old_height
, old_width
;
10102 struct gcpro gcpro1
;
10104 if (!NILP (stuffstring
))
10105 CHECK_STRING (stuffstring
);
10107 /* Run the functions in suspend-hook. */
10108 if (!NILP (Vrun_hooks
))
10109 call1 (Vrun_hooks
, intern ("suspend-hook"));
10111 GCPRO1 (stuffstring
);
10112 get_frame_size (&old_width
, &old_height
);
10113 reset_sys_modes ();
10114 /* sys_suspend can get an error if it tries to fork a subshell
10115 and the system resources aren't available for that. */
10116 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10118 stuff_buffered_input (stuffstring
);
10119 if (cannot_suspend
)
10123 unbind_to (count
, Qnil
);
10125 /* Check if terminal/window size has changed.
10126 Note that this is not useful when we are running directly
10127 with a window system; but suspend should be disabled in that case. */
10128 get_frame_size (&width
, &height
);
10129 if (width
!= old_width
|| height
!= old_height
)
10130 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10132 /* Run suspend-resume-hook. */
10133 if (!NILP (Vrun_hooks
))
10134 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10140 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10141 Then in any case stuff anything Emacs has read ahead and not used. */
10144 stuff_buffered_input (stuffstring
)
10145 Lisp_Object stuffstring
;
10147 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10148 register unsigned char *p
;
10150 if (STRINGP (stuffstring
))
10152 register int count
;
10154 p
= SDATA (stuffstring
);
10155 count
= SBYTES (stuffstring
);
10156 while (count
-- > 0)
10161 /* Anything we have read ahead, put back for the shell to read. */
10162 /* ?? What should this do when we have multiple keyboards??
10163 Should we ignore anything that was typed in at the "wrong" kboard?
10165 rms: we should stuff everything back into the kboard
10167 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10170 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10171 kbd_fetch_ptr
= kbd_buffer
;
10172 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10173 stuff_char (kbd_fetch_ptr
->code
);
10175 clear_event (kbd_fetch_ptr
);
10179 #endif /* SIGTSTP */
10183 set_waiting_for_input (time_to_clear
)
10184 EMACS_TIME
*time_to_clear
;
10186 input_available_clear_time
= time_to_clear
;
10188 /* Tell interrupt_signal to throw back to read_char, */
10189 waiting_for_input
= 1;
10191 /* If interrupt_signal was called before and buffered a C-g,
10192 make it run again now, to avoid timing error. */
10193 if (!NILP (Vquit_flag
))
10194 quit_throw_to_read_char ();
10198 clear_waiting_for_input ()
10200 /* Tell interrupt_signal not to throw back to read_char, */
10201 waiting_for_input
= 0;
10202 input_available_clear_time
= 0;
10205 /* This routine is called at interrupt level in response to C-g.
10207 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10208 is called from kbd_buffer_store_event, in handling SIGIO or
10211 If `waiting_for_input' is non zero, then unless `echoing' is
10212 nonzero, immediately throw back to read_char.
10214 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10215 eval to throw, when it gets a chance. If quit-flag is already
10216 non-nil, it stops the job right away. */
10219 interrupt_signal (signalnum
) /* If we don't have an argument, */
10220 int signalnum
; /* some compilers complain in signal calls. */
10223 /* Must preserve main program's value of errno. */
10224 int old_errno
= errno
;
10225 struct frame
*sf
= SELECTED_FRAME ();
10227 #if defined (USG) && !defined (POSIX_SIGNALS)
10228 if (!read_socket_hook
&& NILP (Vwindow_system
))
10230 /* USG systems forget handlers when they are used;
10231 must reestablish each time */
10232 signal (SIGINT
, interrupt_signal
);
10233 signal (SIGQUIT
, interrupt_signal
);
10239 if (!NILP (Vquit_flag
)
10240 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10242 /* If SIGINT isn't blocked, don't let us be interrupted by
10243 another SIGINT, it might be harmful due to non-reentrancy
10244 in I/O functions. */
10245 sigblock (sigmask (SIGINT
));
10248 reset_sys_modes ();
10250 #ifdef SIGTSTP /* Support possible in later USG versions */
10252 * On systems which can suspend the current process and return to the original
10253 * shell, this command causes the user to end up back at the shell.
10254 * The "Auto-save" and "Abort" questions are not asked until
10255 * the user elects to return to emacs, at which point he can save the current
10256 * job and either dump core or continue.
10261 if (sys_suspend () == -1)
10263 printf ("Not running as a subprocess;\n");
10264 printf ("you can continue or abort.\n");
10266 #else /* not VMS */
10267 /* Perhaps should really fork an inferior shell?
10268 But that would not provide any way to get back
10269 to the original shell, ever. */
10270 printf ("No support for stopping a process on this operating system;\n");
10271 printf ("you can continue or abort.\n");
10272 #endif /* not VMS */
10273 #endif /* not SIGTSTP */
10275 /* We must remain inside the screen area when the internal terminal
10276 is used. Note that [Enter] is not echoed by dos. */
10279 /* It doesn't work to autosave while GC is in progress;
10280 the code used for auto-saving doesn't cope with the mark bit. */
10281 if (!gc_in_progress
)
10283 printf ("Auto-save? (y or n) ");
10285 if (((c
= getchar ()) & ~040) == 'Y')
10287 Fdo_auto_save (Qt
, Qnil
);
10289 printf ("\r\nAuto-save done");
10290 #else /* not MSDOS */
10291 printf ("Auto-save done\n");
10292 #endif /* not MSDOS */
10294 while (c
!= '\n') c
= getchar ();
10298 /* During GC, it must be safe to reenable quitting again. */
10299 Vinhibit_quit
= Qnil
;
10302 #endif /* not MSDOS */
10303 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10304 printf ("but will instead do a real quit after garbage collection ends\r\n");
10309 printf ("\r\nAbort? (y or n) ");
10310 #else /* not MSDOS */
10312 printf ("Abort (and enter debugger)? (y or n) ");
10313 #else /* not VMS */
10314 printf ("Abort (and dump core)? (y or n) ");
10315 #endif /* not VMS */
10316 #endif /* not MSDOS */
10318 if (((c
= getchar ()) & ~040) == 'Y')
10320 while (c
!= '\n') c
= getchar ();
10322 printf ("\r\nContinuing...\r\n");
10323 #else /* not MSDOS */
10324 printf ("Continuing...\n");
10325 #endif /* not MSDOS */
10332 /* If executing a function that wants to be interrupted out of
10333 and the user has not deferred quitting by binding `inhibit-quit'
10334 then quit right away. */
10335 if (immediate_quit
&& NILP (Vinhibit_quit
))
10337 struct gl_state_s saved
;
10338 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10340 immediate_quit
= 0;
10343 GCPRO4 (saved
.object
, saved
.global_code
,
10344 saved
.current_syntax_table
, saved
.old_prop
);
10345 Fsignal (Qquit
, Qnil
);
10350 /* Else request quit when it's safe */
10354 if (waiting_for_input
&& !echoing
)
10355 quit_throw_to_read_char ();
10360 /* Handle a C-g by making read_char return C-g. */
10363 quit_throw_to_read_char ()
10366 /* Prevent another signal from doing this before we finish. */
10367 clear_waiting_for_input ();
10370 Vunread_command_events
= Qnil
;
10371 unread_command_char
= -1;
10373 #if 0 /* Currently, sit_for is called from read_char without turning
10374 off polling. And that can call set_waiting_for_input.
10375 It seems to be harmless. */
10376 #ifdef POLL_FOR_INPUT
10377 /* May be > 1 if in recursive minibuffer. */
10378 if (poll_suppress_count
== 0)
10382 if (FRAMEP (internal_last_event_frame
)
10383 && !EQ (internal_last_event_frame
, selected_frame
))
10384 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10387 _longjmp (getcjmp
, 1);
10390 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10391 doc
: /* Set mode of reading keyboard input.
10392 First arg INTERRUPT non-nil means use input interrupts;
10393 nil means use CBREAK mode.
10394 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10395 (no effect except in CBREAK mode).
10396 Third arg META t means accept 8-bit input (for a Meta key).
10397 META nil means ignore the top bit, on the assumption it is parity.
10398 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10399 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10400 See also `current-input-mode'. */)
10401 (interrupt
, flow
, meta
, quit
)
10402 Lisp_Object interrupt
, flow
, meta
, quit
;
10405 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10406 error ("set-input-mode: QUIT must be an ASCII character");
10408 #ifdef POLL_FOR_INPUT
10413 /* this causes startup screen to be restored and messes with the mouse */
10414 reset_sys_modes ();
10418 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10419 if (read_socket_hook
)
10421 /* When using X, don't give the user a real choice,
10422 because we haven't implemented the mechanisms to support it. */
10423 #ifdef NO_SOCK_SIGIO
10424 interrupt_input
= 0;
10425 #else /* not NO_SOCK_SIGIO */
10426 interrupt_input
= 1;
10427 #endif /* NO_SOCK_SIGIO */
10430 interrupt_input
= !NILP (interrupt
);
10431 #else /* not SIGIO */
10432 interrupt_input
= 0;
10433 #endif /* not SIGIO */
10435 /* Our VMS input only works by interrupts, as of now. */
10437 interrupt_input
= 1;
10440 flow_control
= !NILP (flow
);
10443 else if (EQ (meta
, Qt
))
10448 /* Don't let this value be out of range. */
10449 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10455 #ifdef POLL_FOR_INPUT
10456 poll_suppress_count
= 1;
10462 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10463 doc
: /* Return information about the way Emacs currently reads keyboard input.
10464 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10465 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10466 nil, Emacs is using CBREAK mode.
10467 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10468 terminal; this does not apply if Emacs uses interrupt-driven input.
10469 META is t if accepting 8-bit input with 8th bit as Meta flag.
10470 META nil means ignoring the top bit, on the assumption it is parity.
10471 META is neither t nor nil if accepting 8-bit input and using
10472 all 8 bits as the character code.
10473 QUIT is the character Emacs currently uses to quit.
10474 The elements of this list correspond to the arguments of
10475 `set-input-mode'. */)
10478 Lisp_Object val
[4];
10480 val
[0] = interrupt_input
? Qt
: Qnil
;
10481 val
[1] = flow_control
? Qt
: Qnil
;
10482 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10483 XSETFASTINT (val
[3], quit_char
);
10485 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10488 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 3, 0,
10489 doc
: /* Return position information for pixel coordinates X and Y.
10490 By default, X and Y are relative to text area of the selected window.
10491 Optional third arg FRAME_OR_WINDOW non-nil specifies frame or window.
10493 The return value is similar to a mouse click position:
10494 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10495 IMAGE (DX . DY) (WIDTH . HEIGHT))
10496 The `posn-' functions access elements of such lists. */)
10497 (x
, y
, frame_or_window
)
10498 Lisp_Object x
, y
, frame_or_window
;
10500 if (NILP (frame_or_window
))
10501 frame_or_window
= selected_window
;
10503 if (WINDOWP (frame_or_window
))
10507 CHECK_LIVE_WINDOW (frame_or_window
);
10509 w
= XWINDOW (frame_or_window
);
10510 XSETINT (x
, (WINDOW_TO_FRAME_PIXEL_X (w
, XINT (x
))
10511 + window_box_left_offset (w
, TEXT_AREA
)));
10512 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10513 frame_or_window
= w
->frame
;
10516 CHECK_LIVE_FRAME (frame_or_window
);
10518 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10521 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10522 doc
: /* Return position information for buffer POS in WINDOW.
10523 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10525 Return nil if position is not visible in window. Otherwise,
10526 the return value is similar to that returned by `event-start' for
10527 a mouse click at the upper left corner of the glyph corresponding
10528 to the given buffer position:
10529 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10530 IMAGE (DX . DY) (WIDTH . HEIGHT))
10531 The `posn-' functions access elements of such lists. */*/
)
10533 Lisp_Object pos
, window
;
10537 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10539 tem
= Fposn_at_x_y (XCAR (tem
), XCAR (XCDR (tem
)), window
);
10545 * Set up a new kboard object with reasonable initial values.
10551 kb
->Voverriding_terminal_local_map
= Qnil
;
10552 kb
->Vlast_command
= Qnil
;
10553 kb
->Vreal_last_command
= Qnil
;
10554 kb
->Vprefix_arg
= Qnil
;
10555 kb
->Vlast_prefix_arg
= Qnil
;
10556 kb
->kbd_queue
= Qnil
;
10557 kb
->kbd_queue_has_data
= 0;
10558 kb
->immediate_echo
= 0;
10559 kb
->echo_string
= Qnil
;
10560 kb
->echo_after_prompt
= -1;
10561 kb
->kbd_macro_buffer
= 0;
10562 kb
->kbd_macro_bufsize
= 0;
10563 kb
->defining_kbd_macro
= Qnil
;
10564 kb
->Vlast_kbd_macro
= Qnil
;
10565 kb
->reference_count
= 0;
10566 kb
->Vsystem_key_alist
= Qnil
;
10567 kb
->system_key_syms
= Qnil
;
10568 kb
->Vdefault_minibuffer_frame
= Qnil
;
10572 * Destroy the contents of a kboard object, but not the object itself.
10573 * We use this just before deleting it, or if we're going to initialize
10574 * it a second time.
10580 if (kb
->kbd_macro_buffer
)
10581 xfree (kb
->kbd_macro_buffer
);
10584 #ifdef MULTI_KBOARD
10586 /* Free KB and memory referenced from it. */
10594 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10597 *kbp
= kb
->next_kboard
;
10599 /* Prevent a dangling reference to KB. */
10600 if (kb
== current_kboard
10601 && FRAMEP (selected_frame
)
10602 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10604 current_kboard
= XFRAME (selected_frame
)->kboard
;
10605 if (current_kboard
== kb
)
10613 #endif /* MULTI_KBOARD */
10618 /* This is correct before outermost invocation of the editor loop */
10619 command_loop_level
= -1;
10620 immediate_quit
= 0;
10621 quit_char
= Ctl ('g');
10622 Vunread_command_events
= Qnil
;
10623 unread_command_char
= -1;
10624 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10626 recent_keys_index
= 0;
10627 kbd_fetch_ptr
= kbd_buffer
;
10628 kbd_store_ptr
= kbd_buffer
;
10630 do_mouse_tracking
= Qnil
;
10634 /* This means that command_loop_1 won't try to select anything the first
10636 internal_last_event_frame
= Qnil
;
10637 Vlast_event_frame
= internal_last_event_frame
;
10639 #ifdef MULTI_KBOARD
10640 current_kboard
= initial_kboard
;
10642 wipe_kboard (current_kboard
);
10643 init_kboard (current_kboard
);
10645 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10647 signal (SIGINT
, interrupt_signal
);
10648 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10649 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10650 SIGQUIT and we can't tell which one it will give us. */
10651 signal (SIGQUIT
, interrupt_signal
);
10652 #endif /* HAVE_TERMIO */
10654 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10656 if (!noninteractive
)
10657 signal (SIGIO
, input_available_signal
);
10660 /* Use interrupt input by default, if it works and noninterrupt input
10661 has deficiencies. */
10663 #ifdef INTERRUPT_INPUT
10664 interrupt_input
= 1;
10666 interrupt_input
= 0;
10669 /* Our VMS input only works by interrupts, as of now. */
10671 interrupt_input
= 1;
10677 if (keyboard_init_hook
)
10678 (*keyboard_init_hook
) ();
10680 #ifdef POLL_FOR_INPUT
10681 poll_suppress_count
= 1;
10686 /* At least provide an escape route since C-g doesn't work. */
10687 signal (SIGINT
, interrupt_signal
);
10691 /* This type's only use is in syms_of_keyboard, to initialize the
10692 event header symbols and put properties on them. */
10693 struct event_head
{
10699 struct event_head head_table
[] = {
10700 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10701 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10702 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10703 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10704 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10705 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10706 /* `select-window' should be handled just like `switch-frame'
10707 in read_key_sequence. */
10708 {&Qselect_window
, "select-window", &Qswitch_frame
}
10712 syms_of_keyboard ()
10714 Vpre_help_message
= Qnil
;
10715 staticpro (&Vpre_help_message
);
10717 Vlispy_mouse_stem
= build_string ("mouse");
10718 staticpro (&Vlispy_mouse_stem
);
10721 QCimage
= intern (":image");
10722 staticpro (&QCimage
);
10724 staticpro (&Qhelp_echo
);
10725 Qhelp_echo
= intern ("help-echo");
10727 staticpro (&item_properties
);
10728 item_properties
= Qnil
;
10730 staticpro (&tool_bar_item_properties
);
10731 tool_bar_item_properties
= Qnil
;
10732 staticpro (&tool_bar_items_vector
);
10733 tool_bar_items_vector
= Qnil
;
10735 staticpro (&real_this_command
);
10736 real_this_command
= Qnil
;
10738 Qtimer_event_handler
= intern ("timer-event-handler");
10739 staticpro (&Qtimer_event_handler
);
10741 Qdisabled_command_function
= intern ("disabled-command-function");
10742 staticpro (&Qdisabled_command_function
);
10744 Qself_insert_command
= intern ("self-insert-command");
10745 staticpro (&Qself_insert_command
);
10747 Qforward_char
= intern ("forward-char");
10748 staticpro (&Qforward_char
);
10750 Qbackward_char
= intern ("backward-char");
10751 staticpro (&Qbackward_char
);
10753 Qdisabled
= intern ("disabled");
10754 staticpro (&Qdisabled
);
10756 Qundefined
= intern ("undefined");
10757 staticpro (&Qundefined
);
10759 Qpre_command_hook
= intern ("pre-command-hook");
10760 staticpro (&Qpre_command_hook
);
10762 Qpost_command_hook
= intern ("post-command-hook");
10763 staticpro (&Qpost_command_hook
);
10765 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10766 staticpro (&Qpost_command_idle_hook
);
10768 Qdeferred_action_function
= intern ("deferred-action-function");
10769 staticpro (&Qdeferred_action_function
);
10771 Qcommand_hook_internal
= intern ("command-hook-internal");
10772 staticpro (&Qcommand_hook_internal
);
10774 Qfunction_key
= intern ("function-key");
10775 staticpro (&Qfunction_key
);
10776 Qmouse_click
= intern ("mouse-click");
10777 staticpro (&Qmouse_click
);
10779 Qlanguage_change
= intern ("language-change");
10780 staticpro (&Qlanguage_change
);
10782 Qdrag_n_drop
= intern ("drag-n-drop");
10783 staticpro (&Qdrag_n_drop
);
10785 Qsave_session
= intern ("save-session");
10786 staticpro(&Qsave_session
);
10788 Qusr1_signal
= intern ("usr1-signal");
10789 staticpro (&Qusr1_signal
);
10790 Qusr2_signal
= intern ("usr2-signal");
10791 staticpro (&Qusr2_signal
);
10793 Qmenu_enable
= intern ("menu-enable");
10794 staticpro (&Qmenu_enable
);
10795 Qmenu_alias
= intern ("menu-alias");
10796 staticpro (&Qmenu_alias
);
10797 QCenable
= intern (":enable");
10798 staticpro (&QCenable
);
10799 QCvisible
= intern (":visible");
10800 staticpro (&QCvisible
);
10801 QChelp
= intern (":help");
10802 staticpro (&QChelp
);
10803 QCfilter
= intern (":filter");
10804 staticpro (&QCfilter
);
10805 QCbutton
= intern (":button");
10806 staticpro (&QCbutton
);
10807 QCkeys
= intern (":keys");
10808 staticpro (&QCkeys
);
10809 QCkey_sequence
= intern (":key-sequence");
10810 staticpro (&QCkey_sequence
);
10811 QCtoggle
= intern (":toggle");
10812 staticpro (&QCtoggle
);
10813 QCradio
= intern (":radio");
10814 staticpro (&QCradio
);
10816 Qmode_line
= intern ("mode-line");
10817 staticpro (&Qmode_line
);
10818 Qvertical_line
= intern ("vertical-line");
10819 staticpro (&Qvertical_line
);
10820 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10821 staticpro (&Qvertical_scroll_bar
);
10822 Qmenu_bar
= intern ("menu-bar");
10823 staticpro (&Qmenu_bar
);
10825 Qabove_handle
= intern ("above-handle");
10826 staticpro (&Qabove_handle
);
10827 Qhandle
= intern ("handle");
10828 staticpro (&Qhandle
);
10829 Qbelow_handle
= intern ("below-handle");
10830 staticpro (&Qbelow_handle
);
10831 Qup
= intern ("up");
10833 Qdown
= intern ("down");
10834 staticpro (&Qdown
);
10835 Qtop
= intern ("top");
10837 Qbottom
= intern ("bottom");
10838 staticpro (&Qbottom
);
10839 Qend_scroll
= intern ("end-scroll");
10840 staticpro (&Qend_scroll
);
10841 Qratio
= intern ("ratio");
10842 staticpro (&Qratio
);
10844 Qevent_kind
= intern ("event-kind");
10845 staticpro (&Qevent_kind
);
10846 Qevent_symbol_elements
= intern ("event-symbol-elements");
10847 staticpro (&Qevent_symbol_elements
);
10848 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10849 staticpro (&Qevent_symbol_element_mask
);
10850 Qmodifier_cache
= intern ("modifier-cache");
10851 staticpro (&Qmodifier_cache
);
10853 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10854 staticpro (&Qrecompute_lucid_menubar
);
10855 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10856 staticpro (&Qactivate_menubar_hook
);
10858 Qpolling_period
= intern ("polling-period");
10859 staticpro (&Qpolling_period
);
10861 Qinput_method_function
= intern ("input-method-function");
10862 staticpro (&Qinput_method_function
);
10864 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10865 staticpro (&Qinput_method_exit_on_first_char
);
10866 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10867 staticpro (&Qinput_method_use_echo_area
);
10869 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10870 Fset (Qinput_method_use_echo_area
, Qnil
);
10872 last_point_position_buffer
= Qnil
;
10875 struct event_head
*p
;
10877 for (p
= head_table
;
10878 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10881 *p
->var
= intern (p
->name
);
10882 staticpro (p
->var
);
10883 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10884 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10888 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10889 staticpro (&button_down_location
);
10890 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10891 staticpro (&mouse_syms
);
10892 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
10893 staticpro (&wheel_syms
);
10897 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10899 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10900 for (i
= 0; i
< len
; i
++)
10901 if (modifier_names
[i
])
10902 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10903 staticpro (&modifier_symbols
);
10906 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10907 staticpro (&recent_keys
);
10909 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10910 staticpro (&this_command_keys
);
10912 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10913 staticpro (&raw_keybuf
);
10915 Qextended_command_history
= intern ("extended-command-history");
10916 Fset (Qextended_command_history
, Qnil
);
10917 staticpro (&Qextended_command_history
);
10919 accent_key_syms
= Qnil
;
10920 staticpro (&accent_key_syms
);
10922 func_key_syms
= Qnil
;
10923 staticpro (&func_key_syms
);
10925 drag_n_drop_syms
= Qnil
;
10926 staticpro (&drag_n_drop_syms
);
10928 unread_switch_frame
= Qnil
;
10929 staticpro (&unread_switch_frame
);
10931 internal_last_event_frame
= Qnil
;
10932 staticpro (&internal_last_event_frame
);
10934 read_key_sequence_cmd
= Qnil
;
10935 staticpro (&read_key_sequence_cmd
);
10937 menu_bar_one_keymap_changed_items
= Qnil
;
10938 staticpro (&menu_bar_one_keymap_changed_items
);
10940 defsubr (&Sevent_convert_list
);
10941 defsubr (&Sread_key_sequence
);
10942 defsubr (&Sread_key_sequence_vector
);
10943 defsubr (&Srecursive_edit
);
10945 defsubr (&Strack_mouse
);
10947 defsubr (&Sinput_pending_p
);
10948 defsubr (&Scommand_execute
);
10949 defsubr (&Srecent_keys
);
10950 defsubr (&Sthis_command_keys
);
10951 defsubr (&Sthis_command_keys_vector
);
10952 defsubr (&Sthis_single_command_keys
);
10953 defsubr (&Sthis_single_command_raw_keys
);
10954 defsubr (&Sreset_this_command_lengths
);
10955 defsubr (&Sclear_this_command_keys
);
10956 defsubr (&Ssuspend_emacs
);
10957 defsubr (&Sabort_recursive_edit
);
10958 defsubr (&Sexit_recursive_edit
);
10959 defsubr (&Srecursion_depth
);
10960 defsubr (&Stop_level
);
10961 defsubr (&Sdiscard_input
);
10962 defsubr (&Sopen_dribble_file
);
10963 defsubr (&Sset_input_mode
);
10964 defsubr (&Scurrent_input_mode
);
10965 defsubr (&Sexecute_extended_command
);
10966 defsubr (&Sposn_at_point
);
10967 defsubr (&Sposn_at_x_y
);
10969 DEFVAR_LISP ("last-command-char", &last_command_char
,
10970 doc
: /* Last input event that was part of a command. */);
10972 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10973 doc
: /* Last input event that was part of a command. */);
10975 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10976 doc
: /* Last input event in a command, except for mouse menu events.
10977 Mouse menus give back keys that don't look like mouse events;
10978 this variable holds the actual mouse event that led to the menu,
10979 so that you can determine whether the command was run by mouse or not. */);
10981 DEFVAR_LISP ("last-input-char", &last_input_char
,
10982 doc
: /* Last input event. */);
10984 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10985 doc
: /* Last input event. */);
10987 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10988 doc
: /* List of events to be read as the command input.
10989 These events are processed first, before actual keyboard input. */);
10990 Vunread_command_events
= Qnil
;
10992 DEFVAR_INT ("unread-command-char", &unread_command_char
,
10993 doc
: /* If not -1, an object to be read as next command input event. */);
10995 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
10996 doc
: /* List of events to be processed as input by input methods.
10997 These events are processed after `unread-command-events', but
10998 before actual keyboard input. */);
10999 Vunread_post_input_method_events
= Qnil
;
11001 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11002 doc
: /* List of events to be processed as input by input methods.
11003 These events are processed after `unread-command-events', but
11004 before actual keyboard input. */);
11005 Vunread_input_method_events
= Qnil
;
11007 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11008 doc
: /* Meta-prefix character code.
11009 Meta-foo as command input turns into this character followed by foo. */);
11010 XSETINT (meta_prefix_char
, 033);
11012 DEFVAR_KBOARD ("last-command", Vlast_command
,
11013 doc
: /* The last command executed.
11014 Normally a symbol with a function definition, but can be whatever was found
11015 in the keymap, or whatever the variable `this-command' was set to by that
11018 The value `mode-exit' is special; it means that the previous command
11019 read an event that told it to exit, and it did so and unread that event.
11020 In other words, the present command is the event that made the previous
11023 The value `kill-region' is special; it means that the previous command
11024 was a kill command. */);
11026 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11027 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11029 DEFVAR_LISP ("this-command", &Vthis_command
,
11030 doc
: /* The command now being executed.
11031 The command can set this variable; whatever is put here
11032 will be in `last-command' during the following command. */);
11033 Vthis_command
= Qnil
;
11035 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11036 doc
: /* The command bound to the current key sequence before remapping.
11037 It equals `this-command' if the original command was not remapped through
11038 any of the active keymaps. Otherwise, the value of `this-command' is the
11039 result of looking up the original command in the active keymaps. */);
11040 Vthis_original_command
= Qnil
;
11042 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11043 doc
: /* *Number of input events between auto-saves.
11044 Zero means disable autosaving due to number of characters typed. */);
11045 auto_save_interval
= 300;
11047 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11048 doc
: /* *Number of seconds idle time before auto-save.
11049 Zero or nil means disable auto-saving due to idleness.
11050 After auto-saving due to this many seconds of idle time,
11051 Emacs also does a garbage collection if that seems to be warranted. */);
11052 XSETFASTINT (Vauto_save_timeout
, 30);
11054 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11055 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11056 The value may be integer or floating point. */);
11057 Vecho_keystrokes
= make_number (1);
11059 DEFVAR_INT ("polling-period", &polling_period
,
11060 doc
: /* *Interval between polling for input during Lisp execution.
11061 The reason for polling is to make C-g work to stop a running program.
11062 Polling is needed only when using X windows and SIGIO does not work.
11063 Polling is automatically disabled in all other cases. */);
11064 polling_period
= 2;
11066 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11067 doc
: /* *Maximum time between mouse clicks to make a double-click.
11068 Measured in milliseconds. nil means disable double-click recognition;
11069 t means double-clicks have no time limit and are detected
11070 by position only. */);
11071 Vdouble_click_time
= make_number (500);
11073 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11074 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11075 On window-system frames, value is the number of pixels the mouse may have
11076 moved horizontally or vertically between two clicks to make a double-click.
11077 On non window-system frames, value is interpreted in units of 1/8 characters
11080 This variable is also the threshold for motion of the mouse
11081 to count as a drag. */);
11082 double_click_fuzz
= 3;
11084 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11085 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11086 inhibit_local_menu_bar_menus
= 0;
11088 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11089 doc
: /* Number of complete key sequences read as input so far.
11090 This includes key sequences read from keyboard macros.
11091 The number is effectively the number of interactive command invocations. */);
11092 num_input_keys
= 0;
11094 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11095 doc
: /* Number of input events read from the keyboard so far.
11096 This does not include events generated by keyboard macros. */);
11097 num_nonmacro_input_events
= 0;
11099 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11100 doc
: /* The frame in which the most recently read event occurred.
11101 If the last event came from a keyboard macro, this is set to `macro'. */);
11102 Vlast_event_frame
= Qnil
;
11104 /* This variable is set up in sysdep.c. */
11105 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11106 doc
: /* The ERASE character as set by the user with stty. */);
11108 DEFVAR_LISP ("help-char", &Vhelp_char
,
11109 doc
: /* Character to recognize as meaning Help.
11110 When it is read, do `(eval help-form)', and display result if it's a string.
11111 If the value of `help-form' is nil, this char can be read normally. */);
11112 XSETINT (Vhelp_char
, Ctl ('H'));
11114 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11115 doc
: /* List of input events to recognize as meaning Help.
11116 These work just like the value of `help-char' (see that). */);
11117 Vhelp_event_list
= Qnil
;
11119 DEFVAR_LISP ("help-form", &Vhelp_form
,
11120 doc
: /* Form to execute when character `help-char' is read.
11121 If the form returns a string, that string is displayed.
11122 If `help-form' is nil, the help char is not recognized. */);
11125 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11126 doc
: /* Command to run when `help-char' character follows a prefix key.
11127 This command is used only when there is no actual binding
11128 for that character after that prefix key. */);
11129 Vprefix_help_command
= Qnil
;
11131 DEFVAR_LISP ("top-level", &Vtop_level
,
11132 doc
: /* Form to evaluate when Emacs starts up.
11133 Useful to set before you dump a modified Emacs. */);
11136 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11137 doc
: /* Translate table for keyboard input, or nil.
11138 If non-nil, the value should be a char-table. Each character read
11139 from the keyboard is looked up in this char-table. If the value found
11140 there is non-nil, then it is used instead of the actual input character.
11142 The value can also be a string or vector, but this is considered obsolete.
11143 If it is a string or vector of length N, character codes N and up are left
11144 untranslated. In a vector, an element which is nil means "no translation".
11146 This is applied to the characters supplied to input methods, not their
11147 output. See also `translation-table-for-input'. */);
11148 Vkeyboard_translate_table
= Qnil
;
11150 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11151 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11152 \(Even if the operating system has support for stopping a process.\) */);
11153 cannot_suspend
= 0;
11155 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11156 doc
: /* Non-nil means prompt with menus when appropriate.
11157 This is done when reading from a keymap that has a prompt string,
11158 for elements that have prompt strings.
11159 The menu is displayed on the screen
11160 if X menus were enabled at configuration
11161 time and the previous event was a mouse click prefix key.
11162 Otherwise, menu prompting uses the echo area. */);
11163 menu_prompting
= 1;
11165 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11166 doc
: /* Character to see next line of menu prompt.
11167 Type this character while in a menu prompt to rotate around the lines of it. */);
11168 XSETINT (menu_prompt_more_char
, ' ');
11170 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11171 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11172 Emacs applies the modifiers of the character stored here to each keyboard
11173 character it reads. For example, after evaluating the expression
11174 (setq extra-keyboard-modifiers ?\\C-x)
11175 all input characters will have the control modifier applied to them.
11177 Note that the character ?\\C-@, equivalent to the integer zero, does
11178 not count as a control character; rather, it counts as a character
11179 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11180 cancels any modification. */);
11181 extra_keyboard_modifiers
= 0;
11183 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11184 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11185 The command loop sets this to nil before each command,
11186 and tests the value when the command returns.
11187 Buffer modification stores t in this variable. */);
11188 Vdeactivate_mark
= Qnil
;
11190 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11191 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11192 Vcommand_hook_internal
= Qnil
;
11194 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11195 doc
: /* Normal hook run before each command is executed.
11196 If an unhandled error happens in running this hook,
11197 the hook value is set to nil, since otherwise the error
11198 might happen repeatedly and make Emacs nonfunctional. */);
11199 Vpre_command_hook
= Qnil
;
11201 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11202 doc
: /* Normal hook run after each command is executed.
11203 If an unhandled error happens in running this hook,
11204 the hook value is set to nil, since otherwise the error
11205 might happen repeatedly and make Emacs nonfunctional. */);
11206 Vpost_command_hook
= Qnil
;
11208 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11209 doc
: /* Normal hook run after each command is executed, if idle.
11210 Errors running the hook are caught and ignored. */);
11211 Vpost_command_idle_hook
= Qnil
;
11213 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11214 doc
: /* Delay time before running `post-command-idle-hook'.
11215 This is measured in microseconds. */);
11216 post_command_idle_delay
= 100000;
11219 DEFVAR_LISP ("echo-area-clear-hook", ...,
11220 doc
: /* Normal hook run when clearing the echo area. */);
11222 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11223 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11225 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11226 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11227 Vlucid_menu_bar_dirty_flag
= Qnil
;
11229 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11230 doc
: /* List of menu bar items to move to the end of the menu bar.
11231 The elements of the list are event types that may have menu bar bindings. */);
11232 Vmenu_bar_final_items
= Qnil
;
11234 DEFVAR_KBOARD ("overriding-terminal-local-map",
11235 Voverriding_terminal_local_map
,
11236 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11237 If this variable is non-nil, it is used as a keymap instead of the
11238 buffer's local map, and the minor mode keymaps and text property keymaps.
11239 It also overrides `overriding-local-map'.
11240 This variable is intended to let commands such as `universal-argument'
11241 set up a different keymap for reading the next command. */);
11243 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11244 doc
: /* Keymap that overrides all other local keymaps.
11245 If this variable is non-nil, it is used as a keymap instead of the
11246 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11247 Voverriding_local_map
= Qnil
;
11249 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11250 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11251 Otherwise, the menu bar continues to reflect the buffer's local map
11252 and the minor mode maps regardless of `overriding-local-map'. */);
11253 Voverriding_local_map_menu_flag
= Qnil
;
11255 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11256 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11257 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11259 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11260 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11262 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11263 doc
: /* Alist of system-specific X windows key symbols.
11264 Each element should have the form (N . SYMBOL) where N is the
11265 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11266 and SYMBOL is its name. */);
11268 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11269 doc
: /* List of deferred actions to be performed at a later time.
11270 The precise format isn't relevant here; we just check whether it is nil. */);
11271 Vdeferred_action_list
= Qnil
;
11273 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11274 doc
: /* Function to call to handle deferred actions, after each command.
11275 This function is called with no arguments after each command
11276 whenever `deferred-action-list' is non-nil. */);
11277 Vdeferred_action_function
= Qnil
;
11279 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11280 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11281 The value can be a length of time to show the message for.
11282 If the value is non-nil and not a number, we wait 2 seconds. */);
11283 Vsuggest_key_bindings
= Qt
;
11285 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11286 doc
: /* List of active absolute time timers in order of increasing time. */);
11287 Vtimer_list
= Qnil
;
11289 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11290 doc
: /* List of active idle-time timers in order of increasing time. */);
11291 Vtimer_idle_list
= Qnil
;
11293 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11294 doc
: /* If non-nil, the function that implements the current input method.
11295 It's called with one argument, a printing character that was just read.
11296 \(That means a character with code 040...0176.)
11297 Typically this function uses `read-event' to read additional events.
11298 When it does so, it should first bind `input-method-function' to nil
11299 so it will not be called recursively.
11301 The function should return a list of zero or more events
11302 to be used as input. If it wants to put back some events
11303 to be reconsidered, separately, by the input method,
11304 it can add them to the beginning of `unread-command-events'.
11306 The input method function can find in `input-method-previous-method'
11307 the previous echo area message.
11309 The input method function should refer to the variables
11310 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11311 for guidance on what to do. */);
11312 Vinput_method_function
= Qnil
;
11314 DEFVAR_LISP ("input-method-previous-message",
11315 &Vinput_method_previous_message
,
11316 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11317 This variable exists because `read-event' clears the echo area
11318 before running the input method. It is nil if there was no message. */);
11319 Vinput_method_previous_message
= Qnil
;
11321 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11322 doc
: /* If non-nil, the function that implements the display of help.
11323 It's called with one argument, the help string to display. */);
11324 Vshow_help_function
= Qnil
;
11326 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11327 doc
: /* If non-nil, suppress point adjustment after executing a command.
11329 After a command is executed, if point is moved into a region that has
11330 special properties (e.g. composition, display), we adjust point to
11331 the boundary of the region. But, when a command sets this variable to
11332 non-nil, we suppress the point adjustment.
11334 This variable is set to nil before reading a command, and is checked
11335 just after executing the command. */);
11336 Vdisable_point_adjustment
= Qnil
;
11338 DEFVAR_LISP ("global-disable-point-adjustment",
11339 &Vglobal_disable_point_adjustment
,
11340 doc
: /* *If non-nil, always suppress point adjustment.
11342 The default value is nil, in which case, point adjustment are
11343 suppressed only after special commands that set
11344 `disable-point-adjustment' (which see) to non-nil. */);
11345 Vglobal_disable_point_adjustment
= Qnil
;
11347 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11348 doc
: /* Non-nil means updating menu bindings is allowed.
11349 A value of nil means menu bindings should not be updated.
11350 Used during Emacs' startup. */);
11351 update_menu_bindings
= 1;
11353 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11354 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11355 If the value is not a number, such messages don't time out. */);
11356 Vminibuffer_message_timeout
= make_number (2);
11360 keys_of_keyboard ()
11362 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11363 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11364 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11365 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11366 initial_define_key (meta_map
, 'x', "execute-extended-command");
11368 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11369 "handle-delete-frame");
11370 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11372 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11374 /* Handling it at such a low-level causes read_key_sequence to get
11375 * confused because it doesn't realize that the current_buffer was
11376 * changed by read_char.
11378 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11379 * "handle-select-window"); */
11380 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11381 "handle-save-session");
11384 /* Mark the pointers in the kboard objects.
11385 Called by the Fgarbage_collector. */
11391 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11393 if (kb
->kbd_macro_buffer
)
11394 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11396 mark_object (kb
->Voverriding_terminal_local_map
);
11397 mark_object (kb
->Vlast_command
);
11398 mark_object (kb
->Vreal_last_command
);
11399 mark_object (kb
->Vprefix_arg
);
11400 mark_object (kb
->Vlast_prefix_arg
);
11401 mark_object (kb
->kbd_queue
);
11402 mark_object (kb
->defining_kbd_macro
);
11403 mark_object (kb
->Vlast_kbd_macro
);
11404 mark_object (kb
->Vsystem_key_alist
);
11405 mark_object (kb
->system_key_syms
);
11406 mark_object (kb
->Vdefault_minibuffer_frame
);
11407 mark_object (kb
->echo_string
);
11410 struct input_event
*event
;
11411 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11413 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11414 event
= kbd_buffer
;
11415 if (event
->kind
!= SELECTION_REQUEST_EVENT
11416 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11418 mark_object (event
->x
);
11419 mark_object (event
->y
);
11421 mark_object (event
->frame_or_window
);
11422 mark_object (event
->arg
);
11427 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11428 (do not change this comment) */