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"
35 #include "character.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 && ASCII_BYTE_P (lose
)
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
));
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 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1845 /* We could also call `deactivate'mark'. */
1846 if (EQ (Vtransient_mark_mode
, Qlambda
))
1847 Vtransient_mark_mode
= Qnil
;
1850 current_buffer
->mark_active
= Qnil
;
1851 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1854 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1855 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1858 /* Setting transient-mark-mode to `only' is a way of
1859 turning it on for just one command. */
1860 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1862 if (EQ (Vtransient_mark_mode
, Qidentity
))
1863 Vtransient_mark_mode
= Qnil
;
1864 if (EQ (Vtransient_mark_mode
, Qonly
))
1865 Vtransient_mark_mode
= Qidentity
;
1870 if (current_buffer
== prev_buffer
1871 && last_point_position
!= PT
1872 && NILP (Vdisable_point_adjustment
)
1873 && NILP (Vglobal_disable_point_adjustment
)
1874 && !already_adjusted
)
1875 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1877 /* Install chars successfully executed in kbd macro. */
1879 if (!NILP (current_kboard
->defining_kbd_macro
)
1880 && NILP (current_kboard
->Vprefix_arg
))
1881 finalize_kbd_macro_chars ();
1885 any_kboard_state ();
1890 extern Lisp_Object Qcomposition
, Qdisplay
;
1892 /* Adjust point to a boundary of a region that has such a property
1893 that should be treated intangible. For the moment, we check
1894 `composition', `display' and `invisible' properties.
1895 LAST_PT is the last position of point. */
1897 extern Lisp_Object Qafter_string
, Qbefore_string
;
1898 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1901 adjust_point_for_property (last_pt
, modified
)
1906 Lisp_Object val
, overlay
, tmp
;
1907 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1910 /* FIXME: cycling is probably not necessary because these properties
1911 can't be usefully combined anyway. */
1912 while (check_composition
|| check_display
|| check_invisible
)
1914 if (check_composition
1915 && PT
> BEGV
&& PT
< ZV
1916 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1917 && COMPOSITION_VALID_P (beg
, end
, val
)
1918 && beg
< PT
/* && end > PT <- It's always the case. */
1919 && (last_pt
<= beg
|| last_pt
>= end
))
1922 SET_PT (PT
< last_pt
? beg
: end
);
1923 check_display
= check_invisible
= 1;
1925 check_composition
= 0;
1927 && PT
> BEGV
&& PT
< ZV
1928 && !NILP (val
= get_char_property_and_overlay
1929 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1930 && display_prop_intangible_p (val
)
1931 && (!OVERLAYP (overlay
)
1932 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1933 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1934 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1935 && beg
< PT
) /* && end > PT <- It's always the case. */
1938 SET_PT (PT
< last_pt
? beg
: end
);
1939 check_composition
= check_invisible
= 1;
1942 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1944 int inv
, ellipsis
= 0;
1947 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1949 && !NILP (val
= get_char_property_and_overlay
1950 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1951 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1953 ellipsis
= ellipsis
|| inv
> 1
1954 || (OVERLAYP (overlay
)
1955 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1956 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1957 tmp
= Fnext_single_char_property_change
1958 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1959 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1962 && !NILP (val
= get_char_property_and_overlay
1963 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1964 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1966 ellipsis
= ellipsis
|| inv
> 1
1967 || (OVERLAYP (overlay
)
1968 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1969 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1970 tmp
= Fprevious_single_char_property_change
1971 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1972 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1975 /* Move away from the inside area. */
1976 if (beg
< PT
&& end
> PT
)
1978 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1979 /* We haven't moved yet (so we don't need to fear
1980 infinite-looping) and we were outside the range
1981 before (so either end of the range still corresponds
1982 to a move in the right direction): pretend we moved
1983 less than we actually did, so that we still have
1984 more freedom below in choosing which end of the range
1986 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1987 /* We either have moved already or the last point
1988 was already in the range: we don't get to choose
1989 which end of the range we have to go to. */
1990 : (PT
< last_pt
? beg
: end
));
1991 check_composition
= check_display
= 1;
1993 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1994 the point to something other than its argument, due to
1995 point-motion hooks, intangibility, etc. */
1996 xassert (PT
== beg
|| PT
== end
);
1999 /* Pretend the area doesn't exist if the buffer is not
2001 if (!modified
&& !ellipsis
&& beg
< end
)
2003 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2004 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2005 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2006 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2007 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2008 /* We've already moved as far as we can. Trying to go
2009 to the other end would mean moving backwards and thus
2010 could lead to an infinite loop. */
2012 else if (val
= get_pos_property (make_number (PT
),
2014 TEXT_PROP_MEANS_INVISIBLE (val
)
2015 && (val
= get_pos_property
2016 (make_number (PT
== beg
? end
: beg
),
2018 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2019 (check_composition
= check_display
= 1,
2020 SET_PT (PT
== beg
? end
: beg
));
2023 check_invisible
= 0;
2027 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2030 safe_run_hooks_1 (hook
)
2033 return call1 (Vrun_hooks
, Vinhibit_quit
);
2036 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2039 safe_run_hooks_error (data
)
2042 Lisp_Object args
[3];
2043 args
[0] = build_string ("Error in %s: %s");
2044 args
[1] = Vinhibit_quit
;
2047 return Fset (Vinhibit_quit
, Qnil
);
2050 /* If we get an error while running the hook, cause the hook variable
2051 to be nil. Also inhibit quits, so that C-g won't cause the hook
2052 to mysteriously evaporate. */
2055 safe_run_hooks (hook
)
2058 int count
= SPECPDL_INDEX ();
2059 specbind (Qinhibit_quit
, hook
);
2061 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2063 unbind_to (count
, Qnil
);
2067 /* Number of seconds between polling for input. This is a Lisp
2068 variable that can be bound. */
2070 EMACS_INT polling_period
;
2072 /* Nonzero means polling for input is temporarily suppressed. */
2074 int poll_suppress_count
;
2076 /* Asynchronous timer for polling. */
2078 struct atimer
*poll_timer
;
2081 #ifdef POLL_FOR_INPUT
2083 /* Poll for input, so what we catch a C-g if it comes in. This
2084 function is called from x_make_frame_visible, see comment
2090 if (interrupt_input_blocked
== 0
2091 && !waiting_for_input
)
2092 read_avail_input (0);
2095 /* Timer callback function for poll_timer. TIMER is equal to
2099 poll_for_input (timer
)
2100 struct atimer
*timer
;
2102 if (poll_suppress_count
== 0)
2103 poll_for_input_1 ();
2106 #endif /* POLL_FOR_INPUT */
2108 /* Begin signals to poll for input, if they are appropriate.
2109 This function is called unconditionally from various places. */
2114 #ifdef POLL_FOR_INPUT
2115 if (read_socket_hook
&& !interrupt_input
)
2117 /* Turn alarm handling on unconditionally. It might have
2118 been turned off in process.c. */
2119 turn_on_atimers (1);
2121 /* If poll timer doesn't exist, are we need one with
2122 a different interval, start a new one. */
2123 if (poll_timer
== NULL
2124 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2126 EMACS_TIME interval
;
2129 cancel_atimer (poll_timer
);
2131 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2132 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2133 poll_for_input
, NULL
);
2136 /* Let the timer's callback function poll for input
2137 if this becomes zero. */
2138 --poll_suppress_count
;
2143 /* Nonzero if we are using polling to handle input asynchronously. */
2146 input_polling_used ()
2148 #ifdef POLL_FOR_INPUT
2149 return read_socket_hook
&& !interrupt_input
;
2155 /* Turn off polling. */
2160 #ifdef POLL_FOR_INPUT
2161 if (read_socket_hook
&& !interrupt_input
)
2162 ++poll_suppress_count
;
2166 /* Set the value of poll_suppress_count to COUNT
2167 and start or stop polling accordingly. */
2170 set_poll_suppress_count (count
)
2173 #ifdef POLL_FOR_INPUT
2174 if (count
== 0 && poll_suppress_count
!= 0)
2176 poll_suppress_count
= 1;
2179 else if (count
!= 0 && poll_suppress_count
== 0)
2183 poll_suppress_count
= count
;
2187 /* Bind polling_period to a value at least N.
2188 But don't decrease it. */
2191 bind_polling_period (n
)
2194 #ifdef POLL_FOR_INPUT
2195 int new = polling_period
;
2200 stop_other_atimers (poll_timer
);
2202 specbind (Qpolling_period
, make_number (new));
2203 /* Start a new alarm with the new period. */
2208 /* Apply the control modifier to CHARACTER. */
2214 /* Save the upper bits here. */
2215 int upper
= c
& ~0177;
2219 /* Everything in the columns containing the upper-case letters
2220 denotes a control character. */
2221 if (c
>= 0100 && c
< 0140)
2225 /* Set the shift modifier for a control char
2226 made from a shifted letter. But only for letters! */
2227 if (oc
>= 'A' && oc
<= 'Z')
2228 c
|= shift_modifier
;
2231 /* The lower-case letters denote control characters too. */
2232 else if (c
>= 'a' && c
<= 'z')
2235 /* Include the bits for control and shift
2236 only if the basic ASCII code can't indicate them. */
2240 /* Replace the high bits. */
2241 c
|= (upper
& ~ctrl_modifier
);
2246 /* Display help echo in the echo area.
2248 HELP a string means display that string, HELP nil means clear the
2249 help echo. If HELP is a function, call it with OBJECT and POS as
2250 arguments; the function should return a help string or nil for
2251 none. For all other types of HELP evaluate it to obtain a string.
2253 WINDOW is the window in which the help was generated, if any.
2254 It is nil if not in a window.
2256 If OBJECT is a buffer, POS is the position in the buffer where the
2257 `help-echo' text property was found.
2259 If OBJECT is an overlay, that overlay has a `help-echo' property,
2260 and POS is the position in the overlay's buffer under the mouse.
2262 If OBJECT is a string (an overlay string or a string displayed with
2263 the `display' property). POS is the position in that string under
2266 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2267 echo overwrites a keystroke echo currently displayed in the echo
2270 Note: this function may only be called with HELP nil or a string
2271 from X code running asynchronously. */
2274 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2275 Lisp_Object help
, window
, object
, pos
;
2276 int ok_to_overwrite_keystroke_echo
;
2278 if (!NILP (help
) && !STRINGP (help
))
2280 if (FUNCTIONP (help
))
2282 Lisp_Object args
[4];
2287 help
= safe_call (4, args
);
2290 help
= safe_eval (help
);
2292 if (!STRINGP (help
))
2296 if (STRINGP (help
) || NILP (help
))
2298 if (!NILP (Vshow_help_function
))
2299 call1 (Vshow_help_function
, help
);
2300 else if (/* Don't overwrite minibuffer contents. */
2301 !MINI_WINDOW_P (XWINDOW (selected_window
))
2302 /* Don't overwrite a keystroke echo. */
2303 && (NILP (echo_message_buffer
)
2304 || ok_to_overwrite_keystroke_echo
)
2305 /* Don't overwrite a prompt. */
2306 && !cursor_in_echo_area
)
2310 int count
= SPECPDL_INDEX ();
2312 if (!help_echo_showing_p
)
2313 Vpre_help_message
= current_message ();
2315 specbind (Qmessage_truncate_lines
, Qt
);
2316 message3_nolog (help
, SBYTES (help
),
2317 STRING_MULTIBYTE (help
));
2318 unbind_to (count
, Qnil
);
2320 else if (STRINGP (Vpre_help_message
))
2322 message3_nolog (Vpre_help_message
,
2323 SBYTES (Vpre_help_message
),
2324 STRING_MULTIBYTE (Vpre_help_message
));
2325 Vpre_help_message
= Qnil
;
2331 help_echo_showing_p
= STRINGP (help
);
2337 /* Input of single characters from keyboard */
2339 Lisp_Object
print_help ();
2340 static Lisp_Object
kbd_buffer_get_event ();
2341 static void record_char ();
2344 static jmp_buf wrong_kboard_jmpbuf
;
2347 #define STOP_POLLING \
2348 do { if (! polling_stopped_here) stop_polling (); \
2349 polling_stopped_here = 1; } while (0)
2351 #define RESUME_POLLING \
2352 do { if (polling_stopped_here) start_polling (); \
2353 polling_stopped_here = 0; } while (0)
2355 /* read a character from the keyboard; call the redisplay if needed */
2356 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2357 -1 means do not do redisplay, but do do autosaving.
2360 /* The arguments MAPS and NMAPS are for menu prompting.
2361 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2363 PREV_EVENT is the previous input event, or nil if we are reading
2364 the first event of a key sequence (or not reading a key sequence).
2365 If PREV_EVENT is t, that is a "magic" value that says
2366 not to run input methods, but in other respects to act as if
2367 not reading a key sequence.
2369 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2370 if we used a mouse menu to read the input, or zero otherwise. If
2371 USED_MOUSE_MENU is null, we don't dereference it.
2373 Value is t if we showed a menu and the user rejected it. */
2376 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2380 Lisp_Object prev_event
;
2381 int *used_mouse_menu
;
2383 volatile Lisp_Object c
;
2385 jmp_buf local_getcjmp
;
2387 volatile int key_already_recorded
= 0;
2388 Lisp_Object tem
, save
;
2389 volatile Lisp_Object previous_echo_area_message
;
2390 volatile Lisp_Object also_record
;
2391 volatile int reread
;
2392 struct gcpro gcpro1
, gcpro2
;
2393 int polling_stopped_here
= 0;
2397 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2398 before_command_key_count
= this_command_key_count
;
2399 before_command_echo_length
= echo_length ();
2402 previous_echo_area_message
= Qnil
;
2404 GCPRO2 (c
, previous_echo_area_message
);
2409 if (CONSP (Vunread_post_input_method_events
))
2411 c
= XCAR (Vunread_post_input_method_events
);
2412 Vunread_post_input_method_events
2413 = XCDR (Vunread_post_input_method_events
);
2415 /* Undo what read_char_x_menu_prompt did when it unread
2416 additional keys returned by Fx_popup_menu. */
2418 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2426 if (unread_command_char
!= -1)
2428 XSETINT (c
, unread_command_char
);
2429 unread_command_char
= -1;
2435 if (CONSP (Vunread_command_events
))
2437 c
= XCAR (Vunread_command_events
);
2438 Vunread_command_events
= XCDR (Vunread_command_events
);
2440 /* Undo what read_char_x_menu_prompt did when it unread
2441 additional keys returned by Fx_popup_menu. */
2443 && EQ (XCDR (c
), Qdisabled
)
2444 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2447 /* If the queued event is something that used the mouse,
2448 set used_mouse_menu accordingly. */
2450 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2451 *used_mouse_menu
= 1;
2454 goto reread_for_input_method
;
2457 if (CONSP (Vunread_input_method_events
))
2459 c
= XCAR (Vunread_input_method_events
);
2460 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2462 /* Undo what read_char_x_menu_prompt did when it unread
2463 additional keys returned by Fx_popup_menu. */
2465 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2469 goto reread_for_input_method
;
2472 this_command_key_count_reset
= 0;
2474 if (!NILP (Vexecuting_macro
))
2476 /* We set this to Qmacro; since that's not a frame, nobody will
2477 try to switch frames on us, and the selected window will
2480 Since this event came from a macro, it would be misleading to
2481 leave internal_last_event_frame set to wherever the last
2482 real event came from. Normally, a switch-frame event selects
2483 internal_last_event_frame after each command is read, but
2484 events read from a macro should never cause a new frame to be
2486 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2488 /* Exit the macro if we are at the end.
2489 Also, some things replace the macro with t
2490 to force an early exit. */
2491 if (EQ (Vexecuting_macro
, Qt
)
2492 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2498 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2499 if (STRINGP (Vexecuting_macro
)
2500 && (XINT (c
) & 0x80))
2501 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2503 executing_macro_index
++;
2508 if (!NILP (unread_switch_frame
))
2510 c
= unread_switch_frame
;
2511 unread_switch_frame
= Qnil
;
2513 /* This event should make it into this_command_keys, and get echoed
2514 again, so we do not set `reread'. */
2518 /* if redisplay was requested */
2519 if (commandflag
>= 0)
2521 /* If there is pending input, process any events which are not
2522 user-visible, such as X selection_request events. */
2524 || detect_input_pending_run_timers (0))
2525 swallow_events (0); /* may clear input_pending */
2527 /* Redisplay if no pending input. */
2528 while (!input_pending
)
2530 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2531 redisplay_preserve_echo_area (5);
2536 /* Normal case: no input arrived during redisplay. */
2539 /* Input arrived and pre-empted redisplay.
2540 Process any events which are not user-visible. */
2542 /* If that cleared input_pending, try again to redisplay. */
2546 /* Message turns off echoing unless more keystrokes turn it on again.
2548 The code in 20.x for the condition was
2550 1. echo_area_glyphs && *echo_area_glyphs
2551 2. && echo_area_glyphs != current_kboard->echobuf
2552 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2554 (1) means there's a current message displayed
2556 (2) means it's not the message from echoing from the current
2559 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2560 is set to a non-null value. This is done in read_char and it is
2561 set to echo_area_glyphs after a call to echo_char. That means
2562 ok_to_echo_at_next_pause is either null or
2563 current_kboard->echobuf with the appropriate current_kboard at
2566 So, condition (3) means in clear text ok_to_echo_at_next_pause
2567 must be either null, or the current message isn't from echoing at
2568 all, or it's from echoing from a different kboard than the
2571 if (/* There currently is something in the echo area. */
2572 !NILP (echo_area_buffer
[0])
2573 && (/* And it's either not from echoing. */
2574 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2575 /* Or it's an echo from a different kboard. */
2576 || echo_kboard
!= current_kboard
2577 /* Or we explicitly allow overwriting whatever there is. */
2578 || ok_to_echo_at_next_pause
== NULL
))
2583 /* Try reading a character via menu prompting in the minibuf.
2584 Try this before the sit-for, because the sit-for
2585 would do the wrong thing if we are supposed to do
2586 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2587 after a mouse event so don't try a minibuf menu. */
2589 if (nmaps
> 0 && INTERACTIVE
2590 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2591 /* Don't bring up a menu if we already have another event. */
2592 && NILP (Vunread_command_events
)
2593 && unread_command_char
< 0
2594 && !detect_input_pending_run_timers (0))
2596 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2599 key_already_recorded
= 1;
2604 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2605 We will do that below, temporarily for short sections of code,
2606 when appropriate. local_getcjmp must be in effect
2607 around any call to sit_for or kbd_buffer_get_event;
2608 it *must not* be in effect when we call redisplay. */
2610 if (_setjmp (local_getcjmp
))
2612 XSETINT (c
, quit_char
);
2613 internal_last_event_frame
= selected_frame
;
2614 Vlast_event_frame
= internal_last_event_frame
;
2615 /* If we report the quit char as an event,
2616 don't do so more than once. */
2617 if (!NILP (Vinhibit_quit
))
2622 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2623 if (kb
!= current_kboard
)
2625 Lisp_Object link
= kb
->kbd_queue
;
2626 /* We shouldn't get here if we were in single-kboard mode! */
2631 while (CONSP (XCDR (link
)))
2633 if (!NILP (XCDR (link
)))
2637 kb
->kbd_queue
= Fcons (c
, Qnil
);
2639 XSETCDR (link
, Fcons (c
, Qnil
));
2640 kb
->kbd_queue_has_data
= 1;
2641 current_kboard
= kb
;
2642 /* This is going to exit from read_char
2643 so we had better get rid of this frame's stuff. */
2645 longjmp (wrong_kboard_jmpbuf
, 1);
2652 timer_start_idle ();
2654 /* If in middle of key sequence and minibuffer not active,
2655 start echoing if enough time elapses. */
2657 if (minibuf_level
== 0
2658 && !current_kboard
->immediate_echo
2659 && this_command_key_count
> 0
2661 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2662 && NILP (Fzerop (Vecho_keystrokes
))
2663 && (/* No message. */
2664 NILP (echo_area_buffer
[0])
2665 /* Or empty message. */
2666 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2667 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2668 /* Or already echoing from same kboard. */
2669 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2670 /* Or not echoing before and echoing allowed. */
2671 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2675 /* After a mouse event, start echoing right away.
2676 This is because we are probably about to display a menu,
2677 and we don't want to delay before doing so. */
2678 if (EVENT_HAS_PARAMETERS (prev_event
))
2683 double duration
= extract_float (Vecho_keystrokes
);
2684 sec
= (int) duration
;
2685 usec
= (duration
- sec
) * 1000000;
2686 save_getcjmp (save_jump
);
2687 restore_getcjmp (local_getcjmp
);
2688 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2689 restore_getcjmp (save_jump
);
2691 && ! CONSP (Vunread_command_events
))
2696 /* Maybe auto save due to number of keystrokes. */
2698 if (commandflag
!= 0
2699 && auto_save_interval
> 0
2700 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2701 && !detect_input_pending_run_timers (0))
2703 Fdo_auto_save (Qnil
, Qnil
);
2704 /* Hooks can actually change some buffers in auto save. */
2708 /* Try reading using an X menu.
2709 This is never confused with reading using the minibuf
2710 because the recursive call of read_char in read_char_minibuf_menu_prompt
2711 does not pass on any keymaps. */
2713 if (nmaps
> 0 && INTERACTIVE
2714 && !NILP (prev_event
)
2715 && EVENT_HAS_PARAMETERS (prev_event
)
2716 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2717 && !EQ (XCAR (prev_event
), Qtool_bar
)
2718 /* Don't bring up a menu if we already have another event. */
2719 && NILP (Vunread_command_events
)
2720 && unread_command_char
< 0)
2722 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2724 /* Now that we have read an event, Emacs is not idle. */
2730 /* Maybe autosave and/or garbage collect due to idleness. */
2732 if (INTERACTIVE
&& NILP (c
))
2734 int delay_level
, buffer_size
;
2736 /* Slow down auto saves logarithmically in size of current buffer,
2737 and garbage collect while we're at it. */
2738 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2739 last_non_minibuf_size
= Z
- BEG
;
2740 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2742 while (buffer_size
> 64)
2743 delay_level
++, buffer_size
-= buffer_size
>> 2;
2744 if (delay_level
< 4) delay_level
= 4;
2745 /* delay_level is 4 for files under around 50k, 7 at 100k,
2746 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2748 /* Auto save if enough time goes by without input. */
2749 if (commandflag
!= 0
2750 && num_nonmacro_input_events
> last_auto_save
2751 && INTEGERP (Vauto_save_timeout
)
2752 && XINT (Vauto_save_timeout
) > 0)
2756 save_getcjmp (save_jump
);
2757 restore_getcjmp (local_getcjmp
);
2758 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2760 restore_getcjmp (save_jump
);
2763 && ! CONSP (Vunread_command_events
))
2765 Fdo_auto_save (Qnil
, Qnil
);
2767 /* If we have auto-saved and there is still no input
2768 available, garbage collect if there has been enough
2769 consing going on to make it worthwhile. */
2770 if (!detect_input_pending_run_timers (0)
2771 && consing_since_gc
> gc_cons_threshold
/ 2)
2772 Fgarbage_collect ();
2779 /* If this has become non-nil here, it has been set by a timer
2780 or sentinel or filter. */
2781 if (CONSP (Vunread_command_events
))
2783 c
= XCAR (Vunread_command_events
);
2784 Vunread_command_events
= XCDR (Vunread_command_events
);
2787 /* Read something from current KBOARD's side queue, if possible. */
2791 if (current_kboard
->kbd_queue_has_data
)
2793 if (!CONSP (current_kboard
->kbd_queue
))
2795 c
= XCAR (current_kboard
->kbd_queue
);
2796 current_kboard
->kbd_queue
2797 = XCDR (current_kboard
->kbd_queue
);
2798 if (NILP (current_kboard
->kbd_queue
))
2799 current_kboard
->kbd_queue_has_data
= 0;
2800 input_pending
= readable_events (0);
2801 if (EVENT_HAS_PARAMETERS (c
)
2802 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2803 internal_last_event_frame
= XCAR (XCDR (c
));
2804 Vlast_event_frame
= internal_last_event_frame
;
2809 /* If current_kboard's side queue is empty check the other kboards.
2810 If one of them has data that we have not yet seen here,
2811 switch to it and process the data waiting for it.
2813 Note: if the events queued up for another kboard
2814 have already been seen here, and therefore are not a complete command,
2815 the kbd_queue_has_data field is 0, so we skip that kboard here.
2816 That's to avoid an infinite loop switching between kboards here. */
2817 if (NILP (c
) && !single_kboard
)
2820 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2821 if (kb
->kbd_queue_has_data
)
2823 current_kboard
= kb
;
2824 /* This is going to exit from read_char
2825 so we had better get rid of this frame's stuff. */
2827 longjmp (wrong_kboard_jmpbuf
, 1);
2836 /* Finally, we read from the main queue,
2837 and if that gives us something we can't use yet, we put it on the
2838 appropriate side queue and try again. */
2844 /* Actually read a character, waiting if necessary. */
2845 save_getcjmp (save_jump
);
2846 restore_getcjmp (local_getcjmp
);
2847 timer_start_idle ();
2848 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2849 restore_getcjmp (save_jump
);
2852 if (! NILP (c
) && (kb
!= current_kboard
))
2854 Lisp_Object link
= kb
->kbd_queue
;
2857 while (CONSP (XCDR (link
)))
2859 if (!NILP (XCDR (link
)))
2863 kb
->kbd_queue
= Fcons (c
, Qnil
);
2865 XSETCDR (link
, Fcons (c
, Qnil
));
2866 kb
->kbd_queue_has_data
= 1;
2870 current_kboard
= kb
;
2871 /* This is going to exit from read_char
2872 so we had better get rid of this frame's stuff. */
2874 longjmp (wrong_kboard_jmpbuf
, 1);
2879 /* Terminate Emacs in batch mode if at eof. */
2880 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2881 Fkill_emacs (make_number (1));
2885 /* Add in any extra modifiers, where appropriate. */
2886 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2887 || ((extra_keyboard_modifiers
& 0177) < ' '
2888 && (extra_keyboard_modifiers
& 0177) != 0))
2889 XSETINT (c
, make_ctrl_char (XINT (c
)));
2891 /* Transfer any other modifier bits directly from
2892 extra_keyboard_modifiers to c. Ignore the actual character code
2893 in the low 16 bits of extra_keyboard_modifiers. */
2894 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2904 if (commandflag
>= 0
2905 && !input_pending
&& !detect_input_pending_run_timers (0))
2913 /* Buffer switch events are only for internal wakeups
2914 so don't show them to the user.
2915 Also, don't record a key if we already did. */
2916 if (BUFFERP (c
) || key_already_recorded
)
2919 /* Process special events within read_char
2920 and loop around to read another event. */
2923 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2928 int was_locked
= single_kboard
;
2930 last_input_char
= c
;
2931 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2933 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2934 /* We stopped being idle for this event; undo that. This
2935 prevents automatic window selection (under
2936 mouse_autoselect_window from acting as a real input event, for
2937 example banishing the mouse under mouse-avoidance-mode. */
2938 timer_resume_idle ();
2940 /* Resume allowing input from any kboard, if that was true before. */
2942 any_kboard_state ();
2947 /* Handle things that only apply to characters. */
2950 /* If kbd_buffer_get_event gave us an EOF, return that. */
2954 if ((STRINGP (Vkeyboard_translate_table
)
2955 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2956 || (VECTORP (Vkeyboard_translate_table
)
2957 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2958 || CHAR_TABLE_P (Vkeyboard_translate_table
))
2961 d
= Faref (Vkeyboard_translate_table
, c
);
2962 /* nil in keyboard-translate-table means no translation. */
2968 /* If this event is a mouse click in the menu bar,
2969 return just menu-bar for now. Modify the mouse click event
2970 so we won't do this twice, then queue it up. */
2971 if (EVENT_HAS_PARAMETERS (c
)
2973 && CONSP (EVENT_START (c
))
2974 && CONSP (XCDR (EVENT_START (c
))))
2978 posn
= POSN_POSN (EVENT_START (c
));
2979 /* Handle menu-bar events:
2980 insert the dummy prefix event `menu-bar'. */
2981 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2983 /* Change menu-bar to (menu-bar) as the event "position". */
2984 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2987 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2992 /* Store these characters into recent_keys, the dribble file if any,
2993 and the keyboard macro being defined, if any. */
2995 if (! NILP (also_record
))
2996 record_char (also_record
);
2998 /* Wipe the echo area.
2999 But first, if we are about to use an input method,
3000 save the echo area contents for it to refer to. */
3002 && ! NILP (Vinput_method_function
)
3003 && (unsigned) XINT (c
) >= ' '
3004 && (unsigned) XINT (c
) != 127
3005 && (unsigned) XINT (c
) < 256)
3007 previous_echo_area_message
= Fcurrent_message ();
3008 Vinput_method_previous_message
= previous_echo_area_message
;
3011 /* Now wipe the echo area, except for help events which do their
3012 own stuff with the echo area. */
3014 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3015 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3017 if (!NILP (echo_area_buffer
[0]))
3018 safe_run_hooks (Qecho_area_clear_hook
);
3019 clear_message (1, 0);
3022 reread_for_input_method
:
3024 /* Pass this to the input method, if appropriate. */
3026 && ! NILP (Vinput_method_function
)
3027 /* Don't run the input method within a key sequence,
3028 after the first event of the key sequence. */
3029 && NILP (prev_event
)
3030 && (unsigned) XINT (c
) >= ' '
3031 && (unsigned) XINT (c
) != 127
3032 && (unsigned) XINT (c
) < 256)
3035 int key_count
, key_count_reset
;
3036 struct gcpro gcpro1
;
3037 int count
= SPECPDL_INDEX ();
3039 /* Save the echo status. */
3040 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3041 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3042 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3045 if (before_command_restore_flag
)
3047 this_command_key_count
= before_command_key_count_1
;
3048 if (this_command_key_count
< this_single_command_key_start
)
3049 this_single_command_key_start
= this_command_key_count
;
3050 echo_truncate (before_command_echo_length_1
);
3051 before_command_restore_flag
= 0;
3055 /* Save the this_command_keys status. */
3056 key_count
= this_command_key_count
;
3057 key_count_reset
= this_command_key_count_reset
;
3060 keys
= Fcopy_sequence (this_command_keys
);
3065 /* Clear out this_command_keys. */
3066 this_command_key_count
= 0;
3067 this_command_key_count_reset
= 0;
3069 /* Now wipe the echo area. */
3070 if (!NILP (echo_area_buffer
[0]))
3071 safe_run_hooks (Qecho_area_clear_hook
);
3072 clear_message (1, 0);
3075 /* If we are not reading a key sequence,
3076 never use the echo area. */
3079 specbind (Qinput_method_use_echo_area
, Qt
);
3082 /* Call the input method. */
3083 tem
= call1 (Vinput_method_function
, c
);
3085 tem
= unbind_to (count
, tem
);
3087 /* Restore the saved echoing state
3088 and this_command_keys state. */
3089 this_command_key_count
= key_count
;
3090 this_command_key_count_reset
= key_count_reset
;
3092 this_command_keys
= keys
;
3095 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3096 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3097 if (saved_immediate_echo
)
3102 /* The input method can return no events. */
3105 /* Bring back the previous message, if any. */
3106 if (! NILP (previous_echo_area_message
))
3107 message_with_string ("%s", previous_echo_area_message
, 0);
3110 /* It returned one event or more. */
3112 Vunread_post_input_method_events
3113 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3118 /* Display help if not echoing. */
3119 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3121 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3122 Lisp_Object help
, object
, position
, window
, tem
;
3124 tem
= Fcdr (XCDR (c
));
3127 window
= Fcar (tem
);
3129 object
= Fcar (tem
);
3131 position
= Fcar (tem
);
3133 show_help_echo (help
, window
, object
, position
, 0);
3135 /* We stopped being idle for this event; undo that. */
3136 timer_resume_idle ();
3140 if (! reread
|| this_command_key_count
== 0
3141 || this_command_key_count_reset
)
3144 /* Don't echo mouse motion events. */
3145 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3146 && NILP (Fzerop (Vecho_keystrokes
))
3147 && ! (EVENT_HAS_PARAMETERS (c
)
3148 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3151 if (! NILP (also_record
))
3152 echo_char (also_record
);
3153 /* Once we reread a character, echoing can happen
3154 the next time we pause to read a new one. */
3155 ok_to_echo_at_next_pause
= current_kboard
;
3158 /* Record this character as part of the current key. */
3159 add_command_key (c
);
3160 if (! NILP (also_record
))
3161 add_command_key (also_record
);
3164 last_input_char
= c
;
3167 /* Process the help character specially if enabled */
3168 if (!NILP (Vhelp_form
) && help_char_p (c
))
3171 count
= SPECPDL_INDEX ();
3173 record_unwind_protect (Fset_window_configuration
,
3174 Fcurrent_window_configuration (Qnil
));
3176 tem0
= Feval (Vhelp_form
);
3178 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3182 c
= read_char (0, 0, 0, Qnil
, 0);
3183 while (BUFFERP (c
));
3184 /* Remove the help from the frame */
3185 unbind_to (count
, Qnil
);
3188 if (EQ (c
, make_number (040)))
3192 c
= read_char (0, 0, 0, Qnil
, 0);
3193 while (BUFFERP (c
));
3202 /* Record a key that came from a mouse menu.
3203 Record it for echoing, for this-command-keys, and so on. */
3209 /* Wipe the echo area. */
3210 clear_message (1, 0);
3215 before_command_key_count
= this_command_key_count
;
3216 before_command_echo_length
= echo_length ();
3219 /* Don't echo mouse motion events. */
3220 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3221 && NILP (Fzerop (Vecho_keystrokes
)))
3225 /* Once we reread a character, echoing can happen
3226 the next time we pause to read a new one. */
3227 ok_to_echo_at_next_pause
= 0;
3230 /* Record this character as part of the current key. */
3231 add_command_key (c
);
3233 /* Re-reading in the middle of a command */
3234 last_input_char
= c
;
3238 /* Return 1 if should recognize C as "the help character". */
3246 if (EQ (c
, Vhelp_char
))
3248 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3249 if (EQ (c
, XCAR (tail
)))
3254 /* Record the input event C in various ways. */
3262 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3264 /* To avoid filling recent_keys with help-echo and mouse-movement
3265 events, we filter out repeated help-echo events, only store the
3266 first and last in a series of mouse-movement events, and don't
3267 store repeated help-echo events which are only separated by
3268 mouse-movement events. */
3270 Lisp_Object ev1
, ev2
, ev3
;
3273 if ((ix1
= recent_keys_index
- 1) < 0)
3274 ix1
= NUM_RECENT_KEYS
- 1;
3275 ev1
= AREF (recent_keys
, ix1
);
3277 if ((ix2
= ix1
- 1) < 0)
3278 ix2
= NUM_RECENT_KEYS
- 1;
3279 ev2
= AREF (recent_keys
, ix2
);
3281 if ((ix3
= ix2
- 1) < 0)
3282 ix3
= NUM_RECENT_KEYS
- 1;
3283 ev3
= AREF (recent_keys
, ix3
);
3285 if (EQ (XCAR (c
), Qhelp_echo
))
3287 /* Don't record `help-echo' in recent_keys unless it shows some help
3288 message, and a different help than the previously recorded
3290 Lisp_Object help
, last_help
;
3292 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3293 if (!STRINGP (help
))
3295 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3296 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3298 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3299 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3300 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3302 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3303 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3304 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3305 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3308 else if (EQ (XCAR (c
), Qmouse_movement
))
3310 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3311 So additional mouse movement events replace the last element. */
3312 Lisp_Object last_window
, window
;
3314 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3315 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3316 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3317 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3318 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3320 ASET (recent_keys
, ix1
, c
);
3326 store_kbd_macro_char (c
);
3331 ASET (recent_keys
, recent_keys_index
, c
);
3332 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3333 recent_keys_index
= 0;
3335 else if (recorded
< 0)
3337 /* We need to remove one or two events from recent_keys.
3338 To do this, we simply put nil at those events and move the
3339 recent_keys_index backwards over those events. Usually,
3340 users will never see those nil events, as they will be
3341 overwritten by the command keys entered to see recent_keys
3344 while (recorded
++ < 0 && total_keys
> 0)
3346 if (total_keys
< NUM_RECENT_KEYS
)
3348 if (--recent_keys_index
< 0)
3349 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3350 ASET (recent_keys
, recent_keys_index
, Qnil
);
3354 num_nonmacro_input_events
++;
3356 /* Write c to the dribble file. If c is a lispy event, write
3357 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3358 If you, dear reader, have a better idea, you've got the source. :-) */
3363 if (XUINT (c
) < 0x100)
3364 putc (XINT (c
), dribble
);
3366 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3370 Lisp_Object dribblee
;
3372 /* If it's a structured event, take the event header. */
3373 dribblee
= EVENT_HEAD (c
);
3375 if (SYMBOLP (dribblee
))
3377 putc ('<', dribble
);
3378 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3379 SBYTES (SYMBOL_NAME (dribblee
)),
3381 putc ('>', dribble
);
3393 struct buffer
*old
= current_buffer
;
3394 Fprinc (object
, Qnil
);
3395 set_buffer_internal (XBUFFER (Vstandard_output
));
3396 call0 (intern ("help-mode"));
3397 set_buffer_internal (old
);
3401 /* Copy out or in the info on where C-g should throw to.
3402 This is used when running Lisp code from within get_char,
3403 in case get_char is called recursively.
3404 See read_process_output. */
3410 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3414 restore_getcjmp (temp
)
3417 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3422 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3423 of this function. */
3426 tracking_off (old_value
)
3427 Lisp_Object old_value
;
3429 do_mouse_tracking
= old_value
;
3430 if (NILP (old_value
))
3432 /* Redisplay may have been preempted because there was input
3433 available, and it assumes it will be called again after the
3434 input has been processed. If the only input available was
3435 the sort that we have just disabled, then we need to call
3437 if (!readable_events (1))
3439 redisplay_preserve_echo_area (6);
3440 get_input_pending (&input_pending
, 1);
3446 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3447 doc
: /* Evaluate BODY with mouse movement events enabled.
3448 Within a `track-mouse' form, mouse motion generates input events that
3449 you can read with `read-event'.
3450 Normally, mouse motion is ignored.
3451 usage: (track-mouse BODY ...) */)
3455 int count
= SPECPDL_INDEX ();
3458 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3460 do_mouse_tracking
= Qt
;
3462 val
= Fprogn (args
);
3463 return unbind_to (count
, val
);
3466 /* If mouse has moved on some frame, return one of those frames.
3467 Return 0 otherwise. */
3472 Lisp_Object tail
, frame
;
3474 FOR_EACH_FRAME (tail
, frame
)
3476 if (XFRAME (frame
)->mouse_moved
)
3477 return XFRAME (frame
);
3483 #endif /* HAVE_MOUSE */
3485 /* Low level keyboard/mouse input.
3486 kbd_buffer_store_event places events in kbd_buffer, and
3487 kbd_buffer_get_event retrieves them. */
3489 /* Return true iff there are any events in the queue that read-char
3490 would return. If this returns false, a read-char would block. */
3492 readable_filtered_events (do_timers_now
, filter_events
)
3497 timer_check (do_timers_now
);
3499 /* If the buffer contains only FOCUS_IN_EVENT events,
3500 and FILTER_EVENTS is nonzero, report it as empty. */
3501 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3503 int have_live_event
= 1;
3507 struct input_event
*event
;
3509 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3513 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3516 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3518 if (event
== kbd_store_ptr
)
3519 have_live_event
= 0;
3522 if (have_live_event
) return 1;
3526 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3531 if (current_kboard
->kbd_queue_has_data
)
3537 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3538 if (kb
->kbd_queue_has_data
)
3544 /* Return true iff there are any events in the queue that read-char
3545 would return. If this returns false, a read-char would block. */
3547 readable_events (do_timers_now
)
3550 return readable_filtered_events (do_timers_now
, 0);
3553 /* Set this for debugging, to have a way to get out */
3558 event_to_kboard (event
)
3559 struct input_event
*event
;
3562 frame
= event
->frame_or_window
;
3564 frame
= XCAR (frame
);
3565 else if (WINDOWP (frame
))
3566 frame
= WINDOW_FRAME (XWINDOW (frame
));
3568 /* There are still some events that don't set this field.
3569 For now, just ignore the problem.
3570 Also ignore dead frames here. */
3571 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3574 return FRAME_KBOARD (XFRAME (frame
));
3578 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3581 kbd_buffer_store_event (event
)
3582 register struct input_event
*event
;
3584 kbd_buffer_store_event_hold (event
, 0);
3587 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3589 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3590 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3591 Else, if EVENT is a quit event, store the quit event
3592 in HOLD_QUIT, and return (thus ignoring further events).
3594 This is used in read_avail_input to postpone the processing
3595 of the quit event until all subsequent input events have been
3596 parsed (and discarded).
3600 kbd_buffer_store_event_hold (event
, hold_quit
)
3601 register struct input_event
*event
;
3602 struct input_event
*hold_quit
;
3604 if (event
->kind
== NO_EVENT
)
3607 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3610 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3612 register int c
= event
->code
& 0377;
3614 if (event
->modifiers
& ctrl_modifier
)
3615 c
= make_ctrl_char (c
);
3617 c
|= (event
->modifiers
3618 & (meta_modifier
| alt_modifier
3619 | hyper_modifier
| super_modifier
));
3625 struct input_event
*sp
;
3628 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3629 kb
!= current_kboard
))
3632 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3633 Fcons (make_number (c
), Qnil
));
3634 kb
->kbd_queue_has_data
= 1;
3635 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3637 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3640 if (event_to_kboard (sp
) == kb
)
3642 sp
->kind
= NO_EVENT
;
3643 sp
->frame_or_window
= Qnil
;
3653 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3657 /* If this results in a quit_char being returned to Emacs as
3658 input, set Vlast_event_frame properly. If this doesn't
3659 get returned to Emacs as an event, the next event read
3660 will set Vlast_event_frame again, so this is safe to do. */
3664 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3666 focus
= event
->frame_or_window
;
3667 internal_last_event_frame
= focus
;
3668 Vlast_event_frame
= focus
;
3671 last_event_timestamp
= event
->timestamp
;
3672 interrupt_signal (0 /* dummy */);
3676 if (c
&& c
== stop_character
)
3682 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3683 Just ignore the second one. */
3684 else if (event
->kind
== BUFFER_SWITCH_EVENT
3685 && kbd_fetch_ptr
!= kbd_store_ptr
3686 && ((kbd_store_ptr
== kbd_buffer
3687 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3688 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3691 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3692 kbd_store_ptr
= kbd_buffer
;
3694 /* Don't let the very last slot in the buffer become full,
3695 since that would make the two pointers equal,
3696 and that is indistinguishable from an empty buffer.
3697 Discard the event if it would fill the last slot. */
3698 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3701 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3702 prone to assign individual members for other events, in case
3703 the input_event structure is changed. --2000-07-13, gerd. */
3704 struct input_event
*sp
= kbd_store_ptr
;
3705 sp
->kind
= event
->kind
;
3706 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3708 /* We must not use the ordinary copying code for this case,
3709 since `part' is an enum and copying it might not copy enough
3711 bcopy (event
, (char *) sp
, sizeof (*event
));
3716 sp
->code
= event
->code
;
3717 sp
->part
= event
->part
;
3718 sp
->frame_or_window
= event
->frame_or_window
;
3719 sp
->arg
= event
->arg
;
3720 sp
->modifiers
= event
->modifiers
;
3723 sp
->timestamp
= event
->timestamp
;
3726 *kbd_store_ptr
= *event
;
3734 /* Generate HELP_EVENT input_events in BUFP which has room for
3735 SIZE events. If there's not enough room in BUFP, ignore this
3738 HELP is the help form.
3740 FRAME is the frame on which the help is generated. OBJECT is the
3741 Lisp object where the help was found (a buffer, a string, an
3742 overlay, or nil if neither from a string nor from a buffer. POS is
3743 the position within OBJECT where the help was found.
3745 Value is the number of input_events generated. */
3748 gen_help_event (help
, frame
, window
, object
, pos
)
3749 Lisp_Object help
, frame
, object
, window
;
3752 struct input_event event
;
3756 event
.kind
= HELP_EVENT
;
3757 event
.frame_or_window
= frame
;
3759 event
.x
= WINDOWP (window
) ? window
: frame
;
3762 kbd_buffer_store_event (&event
);
3766 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3769 kbd_buffer_store_help_event (frame
, help
)
3770 Lisp_Object frame
, help
;
3772 struct input_event event
;
3774 event
.kind
= HELP_EVENT
;
3775 event
.frame_or_window
= frame
;
3780 kbd_buffer_store_event (&event
);
3784 /* Discard any mouse events in the event buffer by setting them to
3787 discard_mouse_events ()
3789 struct input_event
*sp
;
3790 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3792 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3795 if (sp
->kind
== MOUSE_CLICK_EVENT
3796 || sp
->kind
== WHEEL_EVENT
3798 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3800 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3802 sp
->kind
= NO_EVENT
;
3808 /* Return non-zero if there are any real events waiting in the event
3809 buffer, not counting `NO_EVENT's.
3811 If DISCARD is non-zero, discard NO_EVENT events at the front of
3812 the input queue, possibly leaving the input queue empty if there
3813 are no real input events. */
3816 kbd_buffer_events_waiting (discard
)
3819 struct input_event
*sp
;
3821 for (sp
= kbd_fetch_ptr
;
3822 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3825 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3832 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3836 /* Clear input event EVENT. */
3840 struct input_event
*event
;
3842 event
->kind
= NO_EVENT
;
3846 /* Read one event from the event buffer, waiting if necessary.
3847 The value is a Lisp object representing the event.
3848 The value is nil for an event that should be ignored,
3849 or that was handled here.
3850 We always read and discard one event. */
3853 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3855 int *used_mouse_menu
;
3864 *kbp
= current_kboard
;
3868 /* Wait until there is input available. */
3871 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3874 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3878 /* If the quit flag is set, then read_char will return
3879 quit_char, so that counts as "available input." */
3880 if (!NILP (Vquit_flag
))
3881 quit_throw_to_read_char ();
3883 /* One way or another, wait until input is available; then, if
3884 interrupt handlers have not read it, read it now. */
3887 wait_for_kbd_input ();
3889 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3893 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3896 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3900 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3902 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3903 /* Pass 1 for EXPECT since we just waited to have input. */
3904 read_avail_input (1);
3906 #endif /* not VMS */
3909 if (CONSP (Vunread_command_events
))
3912 first
= XCAR (Vunread_command_events
);
3913 Vunread_command_events
= XCDR (Vunread_command_events
);
3914 *kbp
= current_kboard
;
3918 /* At this point, we know that there is a readable event available
3919 somewhere. If the event queue is empty, then there must be a
3920 mouse movement enabled and available. */
3921 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3923 struct input_event
*event
;
3925 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3929 last_event_timestamp
= event
->timestamp
;
3932 *kbp
= event_to_kboard (event
);
3934 *kbp
= current_kboard
; /* Better than returning null ptr? */
3936 *kbp
= &the_only_kboard
;
3941 /* These two kinds of events get special handling
3942 and don't actually appear to the command loop.
3943 We return nil for them. */
3944 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3947 struct input_event copy
;
3949 /* Remove it from the buffer before processing it,
3950 since otherwise swallow_events will see it
3951 and process it again. */
3953 kbd_fetch_ptr
= event
+ 1;
3954 input_pending
= readable_events (0);
3955 x_handle_selection_request (©
);
3957 /* We're getting selection request events, but we don't have
3963 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3966 struct input_event copy
;
3968 /* Remove it from the buffer before processing it. */
3970 kbd_fetch_ptr
= event
+ 1;
3971 input_pending
= readable_events (0);
3972 x_handle_selection_clear (©
);
3974 /* We're getting selection request events, but we don't have
3979 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3980 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3982 /* Make an event (delete-frame (FRAME)). */
3983 obj
= Fcons (event
->frame_or_window
, Qnil
);
3984 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3985 kbd_fetch_ptr
= event
+ 1;
3988 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3989 else if (event
->kind
== ICONIFY_EVENT
)
3991 /* Make an event (iconify-frame (FRAME)). */
3992 obj
= Fcons (event
->frame_or_window
, Qnil
);
3993 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3994 kbd_fetch_ptr
= event
+ 1;
3996 else if (event
->kind
== DEICONIFY_EVENT
)
3998 /* Make an event (make-frame-visible (FRAME)). */
3999 obj
= Fcons (event
->frame_or_window
, Qnil
);
4000 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4001 kbd_fetch_ptr
= event
+ 1;
4004 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4006 /* The value doesn't matter here; only the type is tested. */
4007 XSETBUFFER (obj
, current_buffer
);
4008 kbd_fetch_ptr
= event
+ 1;
4010 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4011 || defined (USE_GTK)
4012 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4014 kbd_fetch_ptr
= event
+ 1;
4015 input_pending
= readable_events (0);
4016 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4017 x_activate_menubar (XFRAME (event
->frame_or_window
));
4021 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4023 /* Make an event (language-change (FRAME CHARSET LCID)). */
4024 obj
= Fcons (event
->frame_or_window
, Qnil
);
4025 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4026 kbd_fetch_ptr
= event
+ 1;
4029 else if (event
->kind
== SAVE_SESSION_EVENT
)
4031 obj
= Fcons (Qsave_session
, Qnil
);
4032 kbd_fetch_ptr
= event
+ 1;
4034 /* Just discard these, by returning nil.
4035 With MULTI_KBOARD, these events are used as placeholders
4036 when we need to randomly delete events from the queue.
4037 (They shouldn't otherwise be found in the buffer,
4038 but on some machines it appears they do show up
4039 even without MULTI_KBOARD.) */
4040 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4041 mouse events during a popup-menu call. */
4042 else if (event
->kind
== NO_EVENT
)
4043 kbd_fetch_ptr
= event
+ 1;
4044 else if (event
->kind
== HELP_EVENT
)
4046 Lisp_Object object
, position
, help
, frame
, window
;
4048 frame
= event
->frame_or_window
;
4049 object
= event
->arg
;
4050 position
= make_number (event
->code
);
4053 clear_event (event
);
4055 kbd_fetch_ptr
= event
+ 1;
4056 if (!WINDOWP (window
))
4058 obj
= Fcons (Qhelp_echo
,
4059 list5 (frame
, help
, window
, object
, position
));
4061 else if (event
->kind
== FOCUS_IN_EVENT
)
4063 /* Notification of a FocusIn event. The frame receiving the
4064 focus is in event->frame_or_window. Generate a
4065 switch-frame event if necessary. */
4066 Lisp_Object frame
, focus
;
4068 frame
= event
->frame_or_window
;
4069 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4073 if (!EQ (frame
, internal_last_event_frame
)
4074 && !EQ (frame
, selected_frame
))
4075 obj
= make_lispy_switch_frame (frame
);
4076 internal_last_event_frame
= frame
;
4077 kbd_fetch_ptr
= event
+ 1;
4081 /* If this event is on a different frame, return a switch-frame this
4082 time, and leave the event in the queue for next time. */
4086 frame
= event
->frame_or_window
;
4088 frame
= XCAR (frame
);
4089 else if (WINDOWP (frame
))
4090 frame
= WINDOW_FRAME (XWINDOW (frame
));
4092 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4096 if (! EQ (frame
, internal_last_event_frame
)
4097 && !EQ (frame
, selected_frame
))
4098 obj
= make_lispy_switch_frame (frame
);
4099 internal_last_event_frame
= frame
;
4101 /* If we didn't decide to make a switch-frame event, go ahead
4102 and build a real event from the queue entry. */
4106 obj
= make_lispy_event (event
);
4108 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4109 || defined (USE_GTK)
4110 /* If this was a menu selection, then set the flag to inhibit
4111 writing to last_nonmenu_event. Don't do this if the event
4112 we're returning is (menu-bar), though; that indicates the
4113 beginning of the menu sequence, and we might as well leave
4114 that as the `event with parameters' for this selection. */
4116 && !EQ (event
->frame_or_window
, event
->arg
)
4117 && (event
->kind
== MENU_BAR_EVENT
4118 || event
->kind
== TOOL_BAR_EVENT
))
4119 *used_mouse_menu
= 1;
4122 /* Wipe out this event, to catch bugs. */
4123 clear_event (event
);
4124 kbd_fetch_ptr
= event
+ 1;
4129 /* Try generating a mouse motion event. */
4130 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4132 FRAME_PTR f
= some_mouse_moved ();
4133 Lisp_Object bar_window
;
4134 enum scroll_bar_part part
;
4138 *kbp
= current_kboard
;
4139 /* Note that this uses F to determine which display to look at.
4140 If there is no valid info, it does not store anything
4141 so x remains nil. */
4143 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4147 /* Decide if we should generate a switch-frame event. Don't
4148 generate switch-frame events for motion outside of all Emacs
4154 frame
= FRAME_FOCUS_FRAME (f
);
4156 XSETFRAME (frame
, f
);
4158 if (! EQ (frame
, internal_last_event_frame
)
4159 && !EQ (frame
, selected_frame
))
4160 obj
= make_lispy_switch_frame (frame
);
4161 internal_last_event_frame
= frame
;
4164 /* If we didn't decide to make a switch-frame event, go ahead and
4165 return a mouse-motion event. */
4166 if (!NILP (x
) && NILP (obj
))
4167 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4169 #endif /* HAVE_MOUSE */
4171 /* We were promised by the above while loop that there was
4172 something for us to read! */
4175 input_pending
= readable_events (0);
4177 Vlast_event_frame
= internal_last_event_frame
;
4182 /* Process any events that are not user-visible,
4183 then return, without reading any user-visible events. */
4186 swallow_events (do_display
)
4191 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4193 struct input_event
*event
;
4195 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4199 last_event_timestamp
= event
->timestamp
;
4201 /* These two kinds of events get special handling
4202 and don't actually appear to the command loop. */
4203 if (event
->kind
== SELECTION_REQUEST_EVENT
)
4206 struct input_event copy
;
4208 /* Remove it from the buffer before processing it,
4209 since otherwise swallow_events called recursively could see it
4210 and process it again. */
4212 kbd_fetch_ptr
= event
+ 1;
4213 input_pending
= readable_events (0);
4214 x_handle_selection_request (©
);
4216 /* We're getting selection request events, but we don't have
4222 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
4225 struct input_event copy
;
4227 /* Remove it from the buffer before processing it, */
4230 kbd_fetch_ptr
= event
+ 1;
4231 input_pending
= readable_events (0);
4232 x_handle_selection_clear (©
);
4234 /* We're getting selection request events, but we don't have
4243 old_timers_run
= timers_run
;
4244 get_input_pending (&input_pending
, 1);
4246 if (timers_run
!= old_timers_run
&& do_display
)
4247 redisplay_preserve_echo_area (7);
4250 /* Record the start of when Emacs is idle,
4251 for the sake of running idle-time timers. */
4258 /* If we are already in the idle state, do nothing. */
4259 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4262 EMACS_GET_TIME (timer_idleness_start_time
);
4264 timer_last_idleness_start_time
= timer_idleness_start_time
;
4266 /* Mark all idle-time timers as once again candidates for running. */
4267 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4271 timer
= XCAR (timers
);
4273 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4275 XVECTOR (timer
)->contents
[0] = Qnil
;
4279 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4284 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4287 /* Resume idle timer from last idle start time. */
4290 timer_resume_idle ()
4292 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4295 timer_idleness_start_time
= timer_last_idleness_start_time
;
4298 /* This is only for debugging. */
4299 struct input_event last_timer_event
;
4301 /* Check whether a timer has fired. To prevent larger problems we simply
4302 disregard elements that are not proper timers. Do not make a circular
4303 timer list for the time being.
4305 Returns the number of seconds to wait until the next timer fires. If a
4306 timer is triggering now, return zero seconds.
4307 If no timer is active, return -1 seconds.
4309 If a timer is ripe, we run it, with quitting turned off.
4311 DO_IT_NOW is now ignored. It used to mean that we should
4312 run the timer directly instead of queueing a timer-event.
4313 Now we always run timers directly. */
4316 timer_check (do_it_now
)
4319 EMACS_TIME nexttime
;
4320 EMACS_TIME now
, idleness_now
;
4321 Lisp_Object timers
, idle_timers
, chosen_timer
;
4322 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4324 EMACS_SET_SECS (nexttime
, -1);
4325 EMACS_SET_USECS (nexttime
, -1);
4327 /* Always consider the ordinary timers. */
4328 timers
= Vtimer_list
;
4329 /* Consider the idle timers only if Emacs is idle. */
4330 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4331 idle_timers
= Vtimer_idle_list
;
4334 chosen_timer
= Qnil
;
4335 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4337 if (CONSP (timers
) || CONSP (idle_timers
))
4339 EMACS_GET_TIME (now
);
4340 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4341 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4344 while (CONSP (timers
) || CONSP (idle_timers
))
4346 Lisp_Object
*vector
;
4347 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4348 EMACS_TIME timer_time
, idle_timer_time
;
4349 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4351 /* Skip past invalid timers and timers already handled. */
4354 timer
= XCAR (timers
);
4355 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4357 timers
= XCDR (timers
);
4360 vector
= XVECTOR (timer
)->contents
;
4362 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4363 || !INTEGERP (vector
[3])
4364 || ! NILP (vector
[0]))
4366 timers
= XCDR (timers
);
4370 if (!NILP (idle_timers
))
4372 timer
= XCAR (idle_timers
);
4373 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4375 idle_timers
= XCDR (idle_timers
);
4378 vector
= XVECTOR (timer
)->contents
;
4380 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4381 || !INTEGERP (vector
[3])
4382 || ! NILP (vector
[0]))
4384 idle_timers
= XCDR (idle_timers
);
4389 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4390 based on the next ordinary timer.
4391 TIMER_DIFFERENCE is the distance in time from NOW to when
4392 this timer becomes ripe (negative if it's already ripe). */
4395 timer
= XCAR (timers
);
4396 vector
= XVECTOR (timer
)->contents
;
4397 EMACS_SET_SECS (timer_time
,
4398 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4399 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4400 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4403 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4404 based on the next idle timer. */
4405 if (!NILP (idle_timers
))
4407 idle_timer
= XCAR (idle_timers
);
4408 vector
= XVECTOR (idle_timer
)->contents
;
4409 EMACS_SET_SECS (idle_timer_time
,
4410 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4411 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4412 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4415 /* Decide which timer is the next timer,
4416 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4417 Also step down the list where we found that timer. */
4419 if (! NILP (timers
) && ! NILP (idle_timers
))
4422 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4423 if (EMACS_TIME_NEG_P (temp
))
4425 chosen_timer
= timer
;
4426 timers
= XCDR (timers
);
4427 difference
= timer_difference
;
4431 chosen_timer
= idle_timer
;
4432 idle_timers
= XCDR (idle_timers
);
4433 difference
= idle_timer_difference
;
4436 else if (! NILP (timers
))
4438 chosen_timer
= timer
;
4439 timers
= XCDR (timers
);
4440 difference
= timer_difference
;
4444 chosen_timer
= idle_timer
;
4445 idle_timers
= XCDR (idle_timers
);
4446 difference
= idle_timer_difference
;
4448 vector
= XVECTOR (chosen_timer
)->contents
;
4450 /* If timer is ripe, run it if it hasn't been run. */
4451 if (EMACS_TIME_NEG_P (difference
)
4452 || (EMACS_SECS (difference
) == 0
4453 && EMACS_USECS (difference
) == 0))
4455 if (NILP (vector
[0]))
4457 int was_locked
= single_kboard
;
4458 int count
= SPECPDL_INDEX ();
4459 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4461 /* Mark the timer as triggered to prevent problems if the lisp
4462 code fails to reschedule it right. */
4465 specbind (Qinhibit_quit
, Qt
);
4467 call1 (Qtimer_event_handler
, chosen_timer
);
4468 Vdeactivate_mark
= old_deactivate_mark
;
4470 unbind_to (count
, Qnil
);
4472 /* Resume allowing input from any kboard, if that was true before. */
4474 any_kboard_state ();
4476 /* Since we have handled the event,
4477 we don't need to tell the caller to wake up and do it. */
4481 /* When we encounter a timer that is still waiting,
4482 return the amount of time to wait before it is ripe. */
4489 /* No timers are pending in the future. */
4490 /* Return 0 if we generated an event, and -1 if not. */
4495 /* Caches for modify_event_symbol. */
4496 static Lisp_Object accent_key_syms
;
4497 static Lisp_Object func_key_syms
;
4498 static Lisp_Object mouse_syms
;
4499 static Lisp_Object wheel_syms
;
4500 static Lisp_Object drag_n_drop_syms
;
4502 /* This is a list of keysym codes for special "accent" characters.
4503 It parallels lispy_accent_keys. */
4505 static int lispy_accent_codes
[] =
4507 #ifdef XK_dead_circumflex
4512 #ifdef XK_dead_grave
4517 #ifdef XK_dead_tilde
4522 #ifdef XK_dead_diaeresis
4527 #ifdef XK_dead_macron
4532 #ifdef XK_dead_degree
4537 #ifdef XK_dead_acute
4542 #ifdef XK_dead_cedilla
4547 #ifdef XK_dead_breve
4552 #ifdef XK_dead_ogonek
4557 #ifdef XK_dead_caron
4562 #ifdef XK_dead_doubleacute
4563 XK_dead_doubleacute
,
4567 #ifdef XK_dead_abovedot
4572 #ifdef XK_dead_abovering
4582 #ifdef XK_dead_belowdot
4587 #ifdef XK_dead_voiced_sound
4588 XK_dead_voiced_sound
,
4592 #ifdef XK_dead_semivoiced_sound
4593 XK_dead_semivoiced_sound
,
4609 /* This is a list of Lisp names for special "accent" characters.
4610 It parallels lispy_accent_codes. */
4612 static char *lispy_accent_keys
[] =
4630 "dead-voiced-sound",
4631 "dead-semivoiced-sound",
4637 #define FUNCTION_KEY_OFFSET 0x0
4639 char *lispy_function_keys
[] =
4643 0, /* VK_LBUTTON 0x01 */
4644 0, /* VK_RBUTTON 0x02 */
4645 "cancel", /* VK_CANCEL 0x03 */
4646 0, /* VK_MBUTTON 0x04 */
4648 0, 0, 0, /* 0x05 .. 0x07 */
4650 "backspace", /* VK_BACK 0x08 */
4651 "tab", /* VK_TAB 0x09 */
4653 0, 0, /* 0x0A .. 0x0B */
4655 "clear", /* VK_CLEAR 0x0C */
4656 "return", /* VK_RETURN 0x0D */
4658 0, 0, /* 0x0E .. 0x0F */
4660 0, /* VK_SHIFT 0x10 */
4661 0, /* VK_CONTROL 0x11 */
4662 0, /* VK_MENU 0x12 */
4663 "pause", /* VK_PAUSE 0x13 */
4664 "capslock", /* VK_CAPITAL 0x14 */
4666 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4668 "escape", /* VK_ESCAPE 0x1B */
4670 0, 0, 0, 0, /* 0x1C .. 0x1F */
4672 0, /* VK_SPACE 0x20 */
4673 "prior", /* VK_PRIOR 0x21 */
4674 "next", /* VK_NEXT 0x22 */
4675 "end", /* VK_END 0x23 */
4676 "home", /* VK_HOME 0x24 */
4677 "left", /* VK_LEFT 0x25 */
4678 "up", /* VK_UP 0x26 */
4679 "right", /* VK_RIGHT 0x27 */
4680 "down", /* VK_DOWN 0x28 */
4681 "select", /* VK_SELECT 0x29 */
4682 "print", /* VK_PRINT 0x2A */
4683 "execute", /* VK_EXECUTE 0x2B */
4684 "snapshot", /* VK_SNAPSHOT 0x2C */
4685 "insert", /* VK_INSERT 0x2D */
4686 "delete", /* VK_DELETE 0x2E */
4687 "help", /* VK_HELP 0x2F */
4689 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4691 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4693 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4695 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4697 0, 0, 0, 0, 0, 0, 0, 0, 0,
4698 0, 0, 0, 0, 0, 0, 0, 0, 0,
4699 0, 0, 0, 0, 0, 0, 0, 0,
4701 "lwindow", /* VK_LWIN 0x5B */
4702 "rwindow", /* VK_RWIN 0x5C */
4703 "apps", /* VK_APPS 0x5D */
4705 0, 0, /* 0x5E .. 0x5F */
4707 "kp-0", /* VK_NUMPAD0 0x60 */
4708 "kp-1", /* VK_NUMPAD1 0x61 */
4709 "kp-2", /* VK_NUMPAD2 0x62 */
4710 "kp-3", /* VK_NUMPAD3 0x63 */
4711 "kp-4", /* VK_NUMPAD4 0x64 */
4712 "kp-5", /* VK_NUMPAD5 0x65 */
4713 "kp-6", /* VK_NUMPAD6 0x66 */
4714 "kp-7", /* VK_NUMPAD7 0x67 */
4715 "kp-8", /* VK_NUMPAD8 0x68 */
4716 "kp-9", /* VK_NUMPAD9 0x69 */
4717 "kp-multiply", /* VK_MULTIPLY 0x6A */
4718 "kp-add", /* VK_ADD 0x6B */
4719 "kp-separator", /* VK_SEPARATOR 0x6C */
4720 "kp-subtract", /* VK_SUBTRACT 0x6D */
4721 "kp-decimal", /* VK_DECIMAL 0x6E */
4722 "kp-divide", /* VK_DIVIDE 0x6F */
4723 "f1", /* VK_F1 0x70 */
4724 "f2", /* VK_F2 0x71 */
4725 "f3", /* VK_F3 0x72 */
4726 "f4", /* VK_F4 0x73 */
4727 "f5", /* VK_F5 0x74 */
4728 "f6", /* VK_F6 0x75 */
4729 "f7", /* VK_F7 0x76 */
4730 "f8", /* VK_F8 0x77 */
4731 "f9", /* VK_F9 0x78 */
4732 "f10", /* VK_F10 0x79 */
4733 "f11", /* VK_F11 0x7A */
4734 "f12", /* VK_F12 0x7B */
4735 "f13", /* VK_F13 0x7C */
4736 "f14", /* VK_F14 0x7D */
4737 "f15", /* VK_F15 0x7E */
4738 "f16", /* VK_F16 0x7F */
4739 "f17", /* VK_F17 0x80 */
4740 "f18", /* VK_F18 0x81 */
4741 "f19", /* VK_F19 0x82 */
4742 "f20", /* VK_F20 0x83 */
4743 "f21", /* VK_F21 0x84 */
4744 "f22", /* VK_F22 0x85 */
4745 "f23", /* VK_F23 0x86 */
4746 "f24", /* VK_F24 0x87 */
4748 0, 0, 0, 0, /* 0x88 .. 0x8B */
4749 0, 0, 0, 0, /* 0x8C .. 0x8F */
4751 "kp-numlock", /* VK_NUMLOCK 0x90 */
4752 "scroll", /* VK_SCROLL 0x91 */
4754 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4755 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4756 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4757 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4758 "kp-end", /* VK_NUMPAD_END 0x96 */
4759 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4760 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4761 "kp-up", /* VK_NUMPAD_UP 0x99 */
4762 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4763 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4764 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4765 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4767 0, 0, /* 0x9E .. 0x9F */
4770 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4771 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4772 * No other API or message will distinguish left and right keys this way.
4776 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4777 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4778 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4779 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4780 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4786 "attn", /* VK_ATTN 0xF6 */
4787 "crsel", /* VK_CRSEL 0xF7 */
4788 "exsel", /* VK_EXSEL 0xF8 */
4789 "ereof", /* VK_EREOF 0xF9 */
4790 "play", /* VK_PLAY 0xFA */
4791 "zoom", /* VK_ZOOM 0xFB */
4792 "noname", /* VK_NONAME 0xFC */
4793 "pa1", /* VK_PA1 0xFD */
4794 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4798 #else /* not HAVE_NTGUI */
4800 /* This should be dealt with in XTread_socket now, and that doesn't
4801 depend on the client system having the Kana syms defined. See also
4802 the XK_kana_A case below. */
4805 static char *lispy_kana_keys
[] =
4807 /* X Keysym value */
4808 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4809 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4810 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4811 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4812 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4813 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4814 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4815 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4816 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4817 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4818 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4819 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4820 "kana-i", "kana-u", "kana-e", "kana-o",
4821 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4822 "prolongedsound", "kana-A", "kana-I", "kana-U",
4823 "kana-E", "kana-O", "kana-KA", "kana-KI",
4824 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4825 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4826 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4827 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4828 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4829 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4830 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4831 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4832 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4833 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4834 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4835 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4837 #endif /* XK_kana_A */
4840 #define FUNCTION_KEY_OFFSET 0xff00
4842 /* You'll notice that this table is arranged to be conveniently
4843 indexed by X Windows keysym values. */
4844 static char *lispy_function_keys
[] =
4846 /* X Keysym value */
4848 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4849 "backspace", "tab", "linefeed", "clear",
4851 0, 0, 0, "pause", /* 0xff10...1f */
4852 0, 0, 0, 0, 0, 0, 0, "escape",
4854 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4855 "romaji", "hiragana", "katakana", "hiragana-katakana",
4856 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4857 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4858 "eisu-toggle", /* 0xff30...3f */
4859 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4860 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4862 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4863 "down", "prior", "next", "end",
4864 "begin", 0, 0, 0, 0, 0, 0, 0,
4865 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4876 "break", /* 0xff6b */
4879 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4880 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4881 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4882 0, 0, 0, 0, 0, 0, 0, 0,
4883 "kp-tab", /* 0xff89 */
4885 "kp-enter", /* 0xff8d */
4887 "kp-f1", /* 0xff91 */
4891 "kp-home", /* 0xff95 */
4896 "kp-prior", /* kp-page-up */
4897 "kp-next", /* kp-page-down */
4903 0, 0, 0, 0, 0, 0, 0, 0, 0,
4904 "kp-multiply", /* 0xffaa */
4909 "kp-divide", /* 0xffaf */
4910 "kp-0", /* 0xffb0 */
4911 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4914 "kp-equal", /* 0xffbd */
4915 "f1", /* 0xffbe */ /* IsFunctionKey */
4917 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4918 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4919 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4920 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4921 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4922 0, 0, 0, 0, 0, 0, 0, 0,
4923 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4924 0, 0, 0, 0, 0, 0, 0, "delete"
4927 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4928 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4930 static char *iso_lispy_function_keys
[] =
4932 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4933 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4934 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4935 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4936 "iso-lefttab", /* 0xfe20 */
4937 "iso-move-line-up", "iso-move-line-down",
4938 "iso-partial-line-up", "iso-partial-line-down",
4939 "iso-partial-space-left", "iso-partial-space-right",
4940 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4941 "iso-release-margin-left", "iso-release-margin-right",
4942 "iso-release-both-margins",
4943 "iso-fast-cursor-left", "iso-fast-cursor-right",
4944 "iso-fast-cursor-up", "iso-fast-cursor-down",
4945 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4946 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4949 #endif /* not HAVE_NTGUI */
4951 Lisp_Object Vlispy_mouse_stem
;
4953 static char *lispy_wheel_names
[] =
4955 "wheel-up", "wheel-down"
4958 /* drag-n-drop events are generated when a set of selected files are
4959 dragged from another application and dropped onto an Emacs window. */
4960 static char *lispy_drag_n_drop_names
[] =
4965 /* Scroll bar parts. */
4966 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4967 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4968 Lisp_Object Qtop
, Qratio
;
4970 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4971 Lisp_Object
*scroll_bar_parts
[] = {
4972 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4973 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4976 /* User signal events. */
4977 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4979 Lisp_Object
*lispy_user_signals
[] =
4981 &Qusr1_signal
, &Qusr2_signal
4985 /* A vector, indexed by button number, giving the down-going location
4986 of currently depressed buttons, both scroll bar and non-scroll bar.
4988 The elements have the form
4989 (BUTTON-NUMBER MODIFIER-MASK . REST)
4990 where REST is the cdr of a position as it would be reported in the event.
4992 The make_lispy_event function stores positions here to tell the
4993 difference between click and drag events, and to store the starting
4994 location to be included in drag events. */
4996 static Lisp_Object button_down_location
;
4998 /* Information about the most recent up-going button event: Which
4999 button, what location, and what time. */
5001 static int last_mouse_button
;
5002 static int last_mouse_x
;
5003 static int last_mouse_y
;
5004 static unsigned long button_down_time
;
5006 /* The maximum time between clicks to make a double-click, or Qnil to
5007 disable double-click detection, or Qt for no time limit. */
5009 Lisp_Object Vdouble_click_time
;
5011 /* Maximum number of pixels the mouse may be moved between clicks
5012 to make a double-click. */
5014 EMACS_INT double_click_fuzz
;
5016 /* The number of clicks in this multiple-click. */
5018 int double_click_count
;
5020 /* Return position of a mouse click or wheel event */
5023 make_lispy_position (f
, x
, y
, time
)
5029 enum window_part part
;
5030 Lisp_Object posn
= Qnil
;
5031 Lisp_Object extra_info
= Qnil
;
5034 /* Set `window' to the window under frame pixel coordinates (x,y) */
5036 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5037 &part
, &wx
, &wy
, 0);
5041 if (WINDOWP (window
))
5043 /* It's a click in window window at frame coordinates (x,y) */
5044 struct window
*w
= XWINDOW (window
);
5045 Lisp_Object string_info
= Qnil
;
5046 int textpos
= -1, rx
= -1, ry
= -1;
5047 int dx
= -1, dy
= -1;
5048 int width
= -1, height
= -1;
5049 Lisp_Object object
= Qnil
;
5051 /* Set event coordinates to window-relative coordinates
5052 for constructing the Lisp event below. */
5056 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5058 /* Mode line or header line. Look for a string under
5059 the mouse that may have a `local-map' property. */
5063 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5065 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5066 &object
, &dx
, &dy
, &width
, &height
);
5067 if (STRINGP (string
))
5068 string_info
= Fcons (string
, make_number (charpos
));
5069 if (w
== XWINDOW (selected_window
))
5072 textpos
= XMARKER (w
->pointm
)->charpos
;
5074 else if (part
== ON_VERTICAL_BORDER
)
5076 posn
= Qvertical_line
;
5081 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5086 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5088 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5089 &object
, &dx
, &dy
, &width
, &height
);
5090 if (STRINGP (string
))
5091 string_info
= Fcons (string
, make_number (charpos
));
5093 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
5095 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
5098 if (part
== ON_RIGHT_FRINGE
)
5099 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5100 + window_box_width (w
, TEXT_AREA
)
5101 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5102 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5104 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5105 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5110 Lisp_Object string2
, object2
= Qnil
;
5111 struct display_pos p
;
5113 int width2
, height2
;
5114 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5115 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5116 &object2
, &dx2
, &dy2
,
5118 textpos
= CHARPOS (p
.pos
);
5119 if (rx
< 0) rx
= wx
;
5120 if (ry
< 0) ry
= wy
;
5121 if (dx
< 0) dx
= dx2
;
5122 if (dy
< 0) dy
= dy2
;
5123 if (width
< 0) width
= width2
;
5124 if (height
< 0) height
= height2
;
5128 posn
= make_number (textpos
);
5129 if (STRINGP (string2
))
5130 string_info
= Fcons (string2
,
5131 make_number (CHARPOS (p
.string_pos
)));
5137 #ifdef HAVE_WINDOW_SYSTEM
5138 if (IMAGEP (object
))
5140 Lisp_Object image_map
, hotspot
;
5141 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5143 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5145 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5146 posn
= XCAR (hotspot
);
5151 extra_info
= Fcons (object
,
5152 Fcons (Fcons (make_number (dx
),
5154 Fcons (Fcons (make_number (width
),
5155 make_number (height
)),
5159 extra_info
= Fcons (string_info
,
5160 Fcons (make_number (textpos
),
5161 Fcons (Fcons (make_number (rx
),
5167 XSETFRAME (window
, f
);
5172 XSETFASTINT (*x
, 0);
5173 XSETFASTINT (*y
, 0);
5176 return Fcons (window
,
5178 Fcons (Fcons (*x
, *y
),
5179 Fcons (make_number (time
),
5183 /* Given a struct input_event, build the lisp event which represents
5184 it. If EVENT is 0, build a mouse movement event from the mouse
5185 movement buffer, which should have a movement event in it.
5187 Note that events must be passed to this function in the order they
5188 are received; this function stores the location of button presses
5189 in order to build drag events when the button is released. */
5192 make_lispy_event (event
)
5193 struct input_event
*event
;
5197 switch (SWITCH_ENUM_CAST (event
->kind
))
5199 /* A simple keystroke. */
5200 case ASCII_KEYSTROKE_EVENT
:
5202 Lisp_Object lispy_c
;
5203 int c
= event
->code
& 0377;
5204 /* Turn ASCII characters into control characters
5206 if (event
->modifiers
& ctrl_modifier
)
5207 c
= make_ctrl_char (c
);
5209 /* Add in the other modifier bits. We took care of ctrl_modifier
5210 just above, and the shift key was taken care of by the X code,
5211 and applied to control characters by make_ctrl_char. */
5212 c
|= (event
->modifiers
5213 & (meta_modifier
| alt_modifier
5214 | hyper_modifier
| super_modifier
));
5215 /* Distinguish Shift-SPC from SPC. */
5216 if ((event
->code
& 0377) == 040
5217 && event
->modifiers
& shift_modifier
)
5218 c
|= shift_modifier
;
5219 button_down_time
= 0;
5220 XSETFASTINT (lispy_c
, c
);
5224 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5226 Lisp_Object lispy_c
;
5227 int c
= event
->code
;
5229 /* Add in the other modifier bits. We took care of ctrl_modifier
5230 just above, and the shift key was taken care of by the X code,
5231 and applied to control characters by make_ctrl_char. */
5232 c
|= (event
->modifiers
5233 & (meta_modifier
| alt_modifier
5234 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5235 /* What about the `shift' modifier ? */
5236 button_down_time
= 0;
5237 XSETFASTINT (lispy_c
, c
);
5241 /* A function key. The symbol may need to have modifier prefixes
5243 case NON_ASCII_KEYSTROKE_EVENT
:
5244 button_down_time
= 0;
5246 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5247 if (event
->code
== lispy_accent_codes
[i
])
5248 return modify_event_symbol (i
,
5250 Qfunction_key
, Qnil
,
5251 lispy_accent_keys
, &accent_key_syms
,
5252 (sizeof (lispy_accent_keys
)
5253 / sizeof (lispy_accent_keys
[0])));
5257 if (event
->code
>= 0x400 && event
->code
< 0x500)
5258 return modify_event_symbol (event
->code
- 0x400,
5259 event
->modifiers
& ~shift_modifier
,
5260 Qfunction_key
, Qnil
,
5261 lispy_kana_keys
, &func_key_syms
,
5262 (sizeof (lispy_kana_keys
)
5263 / sizeof (lispy_kana_keys
[0])));
5264 #endif /* XK_kana_A */
5267 #ifdef ISO_FUNCTION_KEY_OFFSET
5268 if (event
->code
< FUNCTION_KEY_OFFSET
5269 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5270 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5272 Qfunction_key
, Qnil
,
5273 iso_lispy_function_keys
, &func_key_syms
,
5274 (sizeof (iso_lispy_function_keys
)
5275 / sizeof (iso_lispy_function_keys
[0])));
5278 /* Handle system-specific or unknown keysyms. */
5279 if (event
->code
& (1 << 28)
5280 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5281 || (event
->code
- FUNCTION_KEY_OFFSET
5282 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5283 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5285 /* We need to use an alist rather than a vector as the cache
5286 since we can't make a vector long enuf. */
5287 if (NILP (current_kboard
->system_key_syms
))
5288 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5289 return modify_event_symbol (event
->code
,
5292 current_kboard
->Vsystem_key_alist
,
5293 0, ¤t_kboard
->system_key_syms
,
5297 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5299 Qfunction_key
, Qnil
,
5300 lispy_function_keys
, &func_key_syms
,
5301 (sizeof (lispy_function_keys
)
5302 / sizeof (lispy_function_keys
[0])));
5305 /* A mouse click. Figure out where it is, decide whether it's
5306 a press, click or drag, and build the appropriate structure. */
5307 case MOUSE_CLICK_EVENT
:
5308 #ifndef USE_TOOLKIT_SCROLL_BARS
5309 case SCROLL_BAR_CLICK_EVENT
:
5312 int button
= event
->code
;
5314 Lisp_Object position
;
5315 Lisp_Object
*start_pos_ptr
;
5316 Lisp_Object start_pos
;
5320 /* Build the position as appropriate for this mouse click. */
5321 if (event
->kind
== MOUSE_CLICK_EVENT
)
5323 struct frame
*f
= XFRAME (event
->frame_or_window
);
5324 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5328 /* Ignore mouse events that were made on frame that
5329 have been deleted. */
5330 if (! FRAME_LIVE_P (f
))
5333 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5334 /* EVENT->x and EVENT->y are frame-relative pixel
5335 coordinates at this place. Under old redisplay, COLUMN
5336 and ROW are set to frame relative glyph coordinates
5337 which are then used to determine whether this click is
5338 in a menu (non-toolkit version). */
5339 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5340 &column
, &row
, NULL
, 1);
5342 /* In the non-toolkit version, clicks on the menu bar
5343 are ordinary button events in the event buffer.
5344 Distinguish them, and invoke the menu.
5346 (In the toolkit version, the toolkit handles the menu bar
5347 and Emacs doesn't know about it until after the user
5348 makes a selection.) */
5349 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5350 && (event
->modifiers
& down_modifier
))
5352 Lisp_Object items
, item
;
5357 /* Activate the menu bar on the down event. If the
5358 up event comes in before the menu code can deal with it,
5360 if (! (event
->modifiers
& down_modifier
))
5364 /* Find the menu bar item under `column'. */
5366 items
= FRAME_MENU_BAR_ITEMS (f
);
5367 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5369 Lisp_Object pos
, string
;
5370 string
= AREF (items
, i
+ 1);
5371 pos
= AREF (items
, i
+ 3);
5374 if (column
>= XINT (pos
)
5375 && column
< XINT (pos
) + SCHARS (string
))
5377 item
= AREF (items
, i
);
5382 /* ELisp manual 2.4b says (x y) are window relative but
5383 code says they are frame-relative. */
5385 = Fcons (event
->frame_or_window
,
5387 Fcons (Fcons (event
->x
, event
->y
),
5388 Fcons (make_number (event
->timestamp
),
5391 return Fcons (item
, Fcons (position
, Qnil
));
5393 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5395 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5398 #ifndef USE_TOOLKIT_SCROLL_BARS
5401 /* It's a scrollbar click. */
5403 Lisp_Object portion_whole
;
5406 window
= event
->frame_or_window
;
5407 portion_whole
= Fcons (event
->x
, event
->y
);
5408 part
= *scroll_bar_parts
[(int) event
->part
];
5412 Fcons (Qvertical_scroll_bar
,
5413 Fcons (portion_whole
,
5414 Fcons (make_number (event
->timestamp
),
5415 Fcons (part
, Qnil
)))));
5417 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5419 if (button
>= ASIZE (button_down_location
))
5421 button_down_location
= larger_vector (button_down_location
,
5423 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5426 start_pos_ptr
= &AREF (button_down_location
, button
);
5427 start_pos
= *start_pos_ptr
;
5428 *start_pos_ptr
= Qnil
;
5431 /* On window-system frames, use the value of
5432 double-click-fuzz as is. On other frames, interpret it
5433 as a multiple of 1/8 characters. */
5437 if (WINDOWP (event
->frame_or_window
))
5438 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5439 else if (FRAMEP (event
->frame_or_window
))
5440 f
= XFRAME (event
->frame_or_window
);
5444 if (FRAME_WINDOW_P (f
))
5445 fuzz
= double_click_fuzz
;
5447 fuzz
= double_click_fuzz
/ 8;
5449 is_double
= (button
== last_mouse_button
5450 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5451 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5452 && button_down_time
!= 0
5453 && (EQ (Vdouble_click_time
, Qt
)
5454 || (INTEGERP (Vdouble_click_time
)
5455 && ((int)(event
->timestamp
- button_down_time
)
5456 < XINT (Vdouble_click_time
)))));
5459 last_mouse_button
= button
;
5460 last_mouse_x
= XINT (event
->x
);
5461 last_mouse_y
= XINT (event
->y
);
5463 /* If this is a button press, squirrel away the location, so
5464 we can decide later whether it was a click or a drag. */
5465 if (event
->modifiers
& down_modifier
)
5469 double_click_count
++;
5470 event
->modifiers
|= ((double_click_count
> 2)
5475 double_click_count
= 1;
5476 button_down_time
= event
->timestamp
;
5477 *start_pos_ptr
= Fcopy_alist (position
);
5480 /* Now we're releasing a button - check the co-ordinates to
5481 see if this was a click or a drag. */
5482 else if (event
->modifiers
& up_modifier
)
5484 /* If we did not see a down before this up, ignore the up.
5485 Probably this happened because the down event chose a
5486 menu item. It would be an annoyance to treat the
5487 release of the button that chose the menu item as a
5490 if (!CONSP (start_pos
))
5493 event
->modifiers
&= ~up_modifier
;
5494 #if 0 /* Formerly we treated an up with no down as a click event. */
5495 if (!CONSP (start_pos
))
5496 event
->modifiers
|= click_modifier
;
5501 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5503 /* The third element of every position
5504 should be the (x,y) pair. */
5505 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5507 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5509 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5510 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5513 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5514 && ydiff
< double_click_fuzz
5515 && ydiff
> - double_click_fuzz
)
5516 /* Mouse hasn't moved (much). */
5517 event
->modifiers
|= click_modifier
;
5520 button_down_time
= 0;
5521 event
->modifiers
|= drag_modifier
;
5524 /* Don't check is_double; treat this as multiple
5525 if the down-event was multiple. */
5526 if (double_click_count
> 1)
5527 event
->modifiers
|= ((double_click_count
> 2)
5533 /* Every mouse event should either have the down_modifier or
5534 the up_modifier set. */
5538 /* Get the symbol we should use for the mouse click. */
5541 head
= modify_event_symbol (button
,
5543 Qmouse_click
, Vlispy_mouse_stem
,
5546 XVECTOR (mouse_syms
)->size
);
5547 if (event
->modifiers
& drag_modifier
)
5552 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5555 Fcons (make_number (double_click_count
),
5566 Lisp_Object position
;
5569 /* Build the position as appropriate for this mouse click. */
5570 struct frame
*f
= XFRAME (event
->frame_or_window
);
5572 /* Ignore wheel events that were made on frame that have been
5574 if (! FRAME_LIVE_P (f
))
5577 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5580 /* Set double or triple modifiers to indicate the wheel speed. */
5582 /* On window-system frames, use the value of
5583 double-click-fuzz as is. On other frames, interpret it
5584 as a multiple of 1/8 characters. */
5589 if (WINDOWP (event
->frame_or_window
))
5590 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5591 else if (FRAMEP (event
->frame_or_window
))
5592 f
= XFRAME (event
->frame_or_window
);
5596 if (FRAME_WINDOW_P (f
))
5597 fuzz
= double_click_fuzz
;
5599 fuzz
= double_click_fuzz
/ 8;
5601 is_double
= (last_mouse_button
< 0
5602 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5603 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5604 && button_down_time
!= 0
5605 && (EQ (Vdouble_click_time
, Qt
)
5606 || (INTEGERP (Vdouble_click_time
)
5607 && ((int)(event
->timestamp
- button_down_time
)
5608 < XINT (Vdouble_click_time
)))));
5611 double_click_count
++;
5612 event
->modifiers
|= ((double_click_count
> 2)
5618 double_click_count
= 1;
5619 event
->modifiers
|= click_modifier
;
5622 button_down_time
= event
->timestamp
;
5623 /* Use a negative value to distinguish wheel from mouse button. */
5624 last_mouse_button
= -1;
5625 last_mouse_x
= XINT (event
->x
);
5626 last_mouse_y
= XINT (event
->y
);
5632 if (event
->modifiers
& up_modifier
)
5634 /* Emit a wheel-up event. */
5635 event
->modifiers
&= ~up_modifier
;
5638 else if (event
->modifiers
& down_modifier
)
5640 /* Emit a wheel-down event. */
5641 event
->modifiers
&= ~down_modifier
;
5645 /* Every wheel event should either have the down_modifier or
5646 the up_modifier set. */
5649 /* Get the symbol we should use for the wheel event. */
5650 head
= modify_event_symbol (symbol_num
,
5656 ASIZE (wheel_syms
));
5659 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5662 Fcons (make_number (double_click_count
),
5671 #ifdef USE_TOOLKIT_SCROLL_BARS
5673 /* We don't have down and up events if using toolkit scroll bars,
5674 so make this always a click event. Store in the `part' of
5675 the Lisp event a symbol which maps to the following actions:
5677 `above_handle' page up
5678 `below_handle' page down
5682 `bottom' bottom of buffer
5683 `handle' thumb has been dragged.
5684 `end-scroll' end of interaction with scroll bar
5686 The incoming input_event contains in its `part' member an
5687 index of type `enum scroll_bar_part' which we can use as an
5688 index in scroll_bar_parts to get the appropriate symbol. */
5690 case SCROLL_BAR_CLICK_EVENT
:
5692 Lisp_Object position
, head
, window
, portion_whole
, part
;
5694 window
= event
->frame_or_window
;
5695 portion_whole
= Fcons (event
->x
, event
->y
);
5696 part
= *scroll_bar_parts
[(int) event
->part
];
5700 Fcons (Qvertical_scroll_bar
,
5701 Fcons (portion_whole
,
5702 Fcons (make_number (event
->timestamp
),
5703 Fcons (part
, Qnil
)))));
5705 /* Always treat scroll bar events as clicks. */
5706 event
->modifiers
|= click_modifier
;
5707 event
->modifiers
&= ~up_modifier
;
5709 if (event
->code
>= ASIZE (mouse_syms
))
5710 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5712 /* Get the symbol we should use for the mouse click. */
5713 head
= modify_event_symbol (event
->code
,
5718 XVECTOR (mouse_syms
)->size
);
5719 return Fcons (head
, Fcons (position
, Qnil
));
5722 #endif /* USE_TOOLKIT_SCROLL_BARS */
5725 case W32_SCROLL_BAR_CLICK_EVENT
:
5727 int button
= event
->code
;
5729 Lisp_Object position
;
5730 Lisp_Object
*start_pos_ptr
;
5731 Lisp_Object start_pos
;
5735 Lisp_Object portion_whole
;
5738 window
= event
->frame_or_window
;
5739 portion_whole
= Fcons (event
->x
, event
->y
);
5740 part
= *scroll_bar_parts
[(int) event
->part
];
5744 Fcons (Qvertical_scroll_bar
,
5745 Fcons (portion_whole
,
5746 Fcons (make_number (event
->timestamp
),
5747 Fcons (part
, Qnil
)))));
5750 /* Always treat W32 scroll bar events as clicks. */
5751 event
->modifiers
|= click_modifier
;
5754 /* Get the symbol we should use for the mouse click. */
5757 head
= modify_event_symbol (button
,
5762 XVECTOR (mouse_syms
)->size
);
5768 #endif /* WINDOWSNT */
5770 case DRAG_N_DROP_EVENT
:
5773 Lisp_Object head
, position
;
5776 /* The frame_or_window field should be a cons of the frame in
5777 which the event occurred and a list of the filenames
5779 if (! CONSP (event
->frame_or_window
))
5782 f
= XFRAME (XCAR (event
->frame_or_window
));
5783 files
= XCDR (event
->frame_or_window
);
5785 /* Ignore mouse events that were made on frames that
5786 have been deleted. */
5787 if (! FRAME_LIVE_P (f
))
5790 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5793 head
= modify_event_symbol (0, event
->modifiers
,
5795 lispy_drag_n_drop_names
,
5796 &drag_n_drop_syms
, 1);
5802 #endif /* HAVE_MOUSE */
5804 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5805 || defined (USE_GTK)
5806 case MENU_BAR_EVENT
:
5807 if (EQ (event
->arg
, event
->frame_or_window
))
5808 /* This is the prefix key. We translate this to
5809 `(menu_bar)' because the code in keyboard.c for menu
5810 events, which we use, relies on this. */
5811 return Fcons (Qmenu_bar
, Qnil
);
5815 case SELECT_WINDOW_EVENT
:
5816 /* Make an event (select-window (WINDOW)). */
5817 return Fcons (Qselect_window
,
5818 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5821 case TOOL_BAR_EVENT
:
5822 if (EQ (event
->arg
, event
->frame_or_window
))
5823 /* This is the prefix key. We translate this to
5824 `(tool_bar)' because the code in keyboard.c for tool bar
5825 events, which we use, relies on this. */
5826 return Fcons (Qtool_bar
, Qnil
);
5827 else if (SYMBOLP (event
->arg
))
5828 return apply_modifiers (event
->modifiers
, event
->arg
);
5831 case USER_SIGNAL_EVENT
:
5832 /* A user signal. */
5833 return *lispy_user_signals
[event
->code
];
5835 case SAVE_SESSION_EVENT
:
5836 return Qsave_session
;
5838 /* The 'kind' field of the event is something we don't recognize. */
5847 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5849 Lisp_Object bar_window
;
5850 enum scroll_bar_part part
;
5854 /* Is it a scroll bar movement? */
5855 if (frame
&& ! NILP (bar_window
))
5857 Lisp_Object part_sym
;
5859 part_sym
= *scroll_bar_parts
[(int) part
];
5860 return Fcons (Qscroll_bar_movement
,
5861 (Fcons (Fcons (bar_window
,
5862 Fcons (Qvertical_scroll_bar
,
5863 Fcons (Fcons (x
, y
),
5864 Fcons (make_number (time
),
5870 /* Or is it an ordinary mouse movement? */
5873 Lisp_Object position
;
5875 position
= make_lispy_position (frame
, &x
, &y
, time
);
5877 return Fcons (Qmouse_movement
,
5883 #endif /* HAVE_MOUSE */
5885 /* Construct a switch frame event. */
5887 make_lispy_switch_frame (frame
)
5890 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5893 /* Manipulating modifiers. */
5895 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5897 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5898 SYMBOL's name of the end of the modifiers; the string from this
5899 position is the unmodified symbol name.
5901 This doesn't use any caches. */
5904 parse_modifiers_uncached (symbol
, modifier_end
)
5912 CHECK_SYMBOL (symbol
);
5915 name
= SYMBOL_NAME (symbol
);
5917 for (i
= 0; i
+2 <= SBYTES (name
); )
5919 int this_mod_end
= 0;
5922 /* See if the name continues with a modifier word.
5923 Check that the word appears, but don't check what follows it.
5924 Set this_mod and this_mod_end to record what we find. */
5926 switch (SREF (name
, i
))
5928 #define SINGLE_LETTER_MOD(BIT) \
5929 (this_mod_end = i + 1, this_mod = BIT)
5932 SINGLE_LETTER_MOD (alt_modifier
);
5936 SINGLE_LETTER_MOD (ctrl_modifier
);
5940 SINGLE_LETTER_MOD (hyper_modifier
);
5944 SINGLE_LETTER_MOD (meta_modifier
);
5948 SINGLE_LETTER_MOD (shift_modifier
);
5952 SINGLE_LETTER_MOD (super_modifier
);
5955 #undef SINGLE_LETTER_MOD
5957 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5958 if (i + LEN + 1 <= SBYTES (name) \
5959 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5961 this_mod_end = i + LEN; \
5966 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5967 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5968 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5972 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5974 #undef MULTI_LETTER_MOD
5978 /* If we found no modifier, stop looking for them. */
5979 if (this_mod_end
== 0)
5982 /* Check there is a dash after the modifier, so that it
5983 really is a modifier. */
5984 if (this_mod_end
>= SBYTES (name
)
5985 || SREF (name
, this_mod_end
) != '-')
5988 /* This modifier is real; look for another. */
5989 modifiers
|= this_mod
;
5990 i
= this_mod_end
+ 1;
5993 /* Should we include the `click' modifier? */
5994 if (! (modifiers
& (down_modifier
| drag_modifier
5995 | double_modifier
| triple_modifier
))
5996 && i
+ 7 == SBYTES (name
)
5997 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5998 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5999 modifiers
|= click_modifier
;
6007 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6008 prepended to the string BASE[0..BASE_LEN-1].
6009 This doesn't use any caches. */
6011 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6014 int base_len
, base_len_byte
;
6016 /* Since BASE could contain nulls, we can't use intern here; we have
6017 to use Fintern, which expects a genuine Lisp_String, and keeps a
6020 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6026 /* Only the event queue may use the `up' modifier; it should always
6027 be turned into a click or drag event before presented to lisp code. */
6028 if (modifiers
& up_modifier
)
6031 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6032 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6033 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6034 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6035 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6036 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6037 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6038 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6039 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6040 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6041 /* The click modifier is denoted by the absence of other modifiers. */
6045 mod_len
= p
- new_mods
;
6049 Lisp_Object new_name
;
6051 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6052 mod_len
+ base_len_byte
);
6053 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6054 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6056 return Fintern (new_name
, Qnil
);
6061 static char *modifier_names
[] =
6063 "up", "down", "drag", "click", "double", "triple", 0, 0,
6064 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6065 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6067 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6069 static Lisp_Object modifier_symbols
;
6071 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6073 lispy_modifier_list (modifiers
)
6076 Lisp_Object modifier_list
;
6079 modifier_list
= Qnil
;
6080 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6081 if (modifiers
& (1<<i
))
6082 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6085 return modifier_list
;
6089 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6090 where UNMODIFIED is the unmodified form of SYMBOL,
6091 MASK is the set of modifiers present in SYMBOL's name.
6092 This is similar to parse_modifiers_uncached, but uses the cache in
6093 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6094 Qevent_symbol_elements property. */
6097 parse_modifiers (symbol
)
6100 Lisp_Object elements
;
6102 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6103 if (CONSP (elements
))
6108 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6109 Lisp_Object unmodified
;
6112 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6113 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6116 if (modifiers
& ~INTMASK
)
6118 XSETFASTINT (mask
, modifiers
);
6119 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6121 /* Cache the parsing results on SYMBOL. */
6122 Fput (symbol
, Qevent_symbol_element_mask
,
6124 Fput (symbol
, Qevent_symbol_elements
,
6125 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6127 /* Since we know that SYMBOL is modifiers applied to unmodified,
6128 it would be nice to put that in unmodified's cache.
6129 But we can't, since we're not sure that parse_modifiers is
6136 /* Apply the modifiers MODIFIERS to the symbol BASE.
6137 BASE must be unmodified.
6139 This is like apply_modifiers_uncached, but uses BASE's
6140 Qmodifier_cache property, if present. It also builds
6141 Qevent_symbol_elements properties, since it has that info anyway.
6143 apply_modifiers copies the value of BASE's Qevent_kind property to
6144 the modified symbol. */
6146 apply_modifiers (modifiers
, base
)
6150 Lisp_Object cache
, index
, entry
, new_symbol
;
6152 /* Mask out upper bits. We don't know where this value's been. */
6153 modifiers
&= INTMASK
;
6155 /* The click modifier never figures into cache indices. */
6156 cache
= Fget (base
, Qmodifier_cache
);
6157 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6158 entry
= assq_no_quit (index
, cache
);
6161 new_symbol
= XCDR (entry
);
6164 /* We have to create the symbol ourselves. */
6165 new_symbol
= apply_modifiers_uncached (modifiers
,
6166 SDATA (SYMBOL_NAME (base
)),
6167 SCHARS (SYMBOL_NAME (base
)),
6168 SBYTES (SYMBOL_NAME (base
)));
6170 /* Add the new symbol to the base's cache. */
6171 entry
= Fcons (index
, new_symbol
);
6172 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6174 /* We have the parsing info now for free, so we could add it to
6176 XSETFASTINT (index, modifiers);
6177 Fput (new_symbol, Qevent_symbol_element_mask,
6178 Fcons (base, Fcons (index, Qnil)));
6179 Fput (new_symbol, Qevent_symbol_elements,
6180 Fcons (base, lispy_modifier_list (modifiers)));
6181 Sadly, this is only correct if `base' is indeed a base event,
6182 which is not necessarily the case. -stef */
6185 /* Make sure this symbol is of the same kind as BASE.
6187 You'd think we could just set this once and for all when we
6188 intern the symbol above, but reorder_modifiers may call us when
6189 BASE's property isn't set right; we can't assume that just
6190 because it has a Qmodifier_cache property it must have its
6191 Qevent_kind set right as well. */
6192 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6196 kind
= Fget (base
, Qevent_kind
);
6198 Fput (new_symbol
, Qevent_kind
, kind
);
6205 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6206 return a symbol with the modifiers placed in the canonical order.
6207 Canonical order is alphabetical, except for down and drag, which
6208 always come last. The 'click' modifier is never written out.
6210 Fdefine_key calls this to make sure that (for example) C-M-foo
6211 and M-C-foo end up being equivalent in the keymap. */
6214 reorder_modifiers (symbol
)
6217 /* It's hopefully okay to write the code this way, since everything
6218 will soon be in caches, and no consing will be done at all. */
6221 parsed
= parse_modifiers (symbol
);
6222 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6227 /* For handling events, we often want to produce a symbol whose name
6228 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6229 to some base, like the name of a function key or mouse button.
6230 modify_event_symbol produces symbols of this sort.
6232 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6233 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6236 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6237 into symbol names, or a string specifying a name stem used to
6238 construct a symbol name or the form `STEM-N', where N is the decimal
6239 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6240 non-nil; otherwise NAME_TABLE is used.
6242 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6243 persist between calls to modify_event_symbol that it can use to
6244 store a cache of the symbols it's generated for this NAME_TABLE
6245 before. The object stored there may be a vector or an alist.
6247 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6249 MODIFIERS is a set of modifier bits (as given in struct input_events)
6250 whose prefixes should be applied to the symbol name.
6252 SYMBOL_KIND is the value to be placed in the event_kind property of
6253 the returned symbol.
6255 The symbols we create are supposed to have an
6256 `event-symbol-elements' property, which lists the modifiers present
6257 in the symbol's name. */
6260 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6261 name_table
, symbol_table
, table_size
)
6264 Lisp_Object symbol_kind
;
6265 Lisp_Object name_alist_or_stem
;
6267 Lisp_Object
*symbol_table
;
6268 unsigned int table_size
;
6271 Lisp_Object symbol_int
;
6273 /* Get rid of the "vendor-specific" bit here. */
6274 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6276 /* Is this a request for a valid symbol? */
6277 if (symbol_num
< 0 || symbol_num
>= table_size
)
6280 if (CONSP (*symbol_table
))
6281 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6283 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6284 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6285 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6286 we've never used that symbol before. */
6289 if (! VECTORP (*symbol_table
)
6290 || XVECTOR (*symbol_table
)->size
!= table_size
)
6294 XSETFASTINT (size
, table_size
);
6295 *symbol_table
= Fmake_vector (size
, Qnil
);
6298 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6301 /* Have we already used this symbol before? */
6304 /* No; let's create it. */
6305 if (CONSP (name_alist_or_stem
))
6306 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6307 else if (STRINGP (name_alist_or_stem
))
6309 int len
= SBYTES (name_alist_or_stem
);
6310 char *buf
= (char *) alloca (len
+ 50);
6311 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6312 (long) XINT (symbol_int
) + 1);
6313 value
= intern (buf
);
6315 else if (name_table
!= 0 && name_table
[symbol_num
])
6316 value
= intern (name_table
[symbol_num
]);
6318 #ifdef HAVE_WINDOW_SYSTEM
6321 char *name
= x_get_keysym_name (symbol_num
);
6323 value
= intern (name
);
6330 sprintf (buf
, "key-%d", symbol_num
);
6331 value
= intern (buf
);
6334 if (CONSP (*symbol_table
))
6335 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6337 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6339 /* Fill in the cache entries for this symbol; this also
6340 builds the Qevent_symbol_elements property, which the user
6342 apply_modifiers (modifiers
& click_modifier
, value
);
6343 Fput (value
, Qevent_kind
, symbol_kind
);
6346 /* Apply modifiers to that symbol. */
6347 return apply_modifiers (modifiers
, value
);
6350 /* Convert a list that represents an event type,
6351 such as (ctrl meta backspace), into the usual representation of that
6352 event type as a number or a symbol. */
6354 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6355 doc
: /* Convert the event description list EVENT-DESC to an event type.
6356 EVENT-DESC should contain one base event type (a character or symbol)
6357 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6358 drag, down, double or triple). The base must be last.
6359 The return value is an event type (a character or symbol) which
6360 has the same base event type and all the specified modifiers. */)
6362 Lisp_Object event_desc
;
6370 while (CONSP (rest
))
6378 /* Given a symbol, see if it is a modifier name. */
6379 if (SYMBOLP (elt
) && CONSP (rest
))
6380 this = parse_solitary_modifier (elt
);
6384 else if (!NILP (base
))
6385 error ("Two bases given in one event");
6391 /* Let the symbol A refer to the character A. */
6392 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6393 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6395 if (INTEGERP (base
))
6397 /* Turn (shift a) into A. */
6398 if ((modifiers
& shift_modifier
) != 0
6399 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6401 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6402 modifiers
&= ~shift_modifier
;
6405 /* Turn (control a) into C-a. */
6406 if (modifiers
& ctrl_modifier
)
6407 return make_number ((modifiers
& ~ctrl_modifier
)
6408 | make_ctrl_char (XINT (base
)));
6410 return make_number (modifiers
| XINT (base
));
6412 else if (SYMBOLP (base
))
6413 return apply_modifiers (modifiers
, base
);
6416 error ("Invalid base event");
6421 /* Try to recognize SYMBOL as a modifier name.
6422 Return the modifier flag bit, or 0 if not recognized. */
6425 parse_solitary_modifier (symbol
)
6428 Lisp_Object name
= SYMBOL_NAME (symbol
);
6430 switch (SREF (name
, 0))
6432 #define SINGLE_LETTER_MOD(BIT) \
6433 if (SBYTES (name) == 1) \
6436 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6437 if (LEN == SBYTES (name) \
6438 && ! strncmp (SDATA (name), NAME, LEN)) \
6442 SINGLE_LETTER_MOD (alt_modifier
);
6446 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6450 SINGLE_LETTER_MOD (ctrl_modifier
);
6454 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6455 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6459 SINGLE_LETTER_MOD (hyper_modifier
);
6463 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6467 SINGLE_LETTER_MOD (meta_modifier
);
6471 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6475 SINGLE_LETTER_MOD (shift_modifier
);
6479 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6480 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6481 SINGLE_LETTER_MOD (super_modifier
);
6485 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6486 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6487 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6491 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6494 #undef SINGLE_LETTER_MOD
6495 #undef MULTI_LETTER_MOD
6501 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6502 Such a list is not valid as an event,
6503 but it can be a Lucid-style event type list. */
6506 lucid_event_type_list_p (object
)
6511 if (! CONSP (object
))
6514 if (EQ (XCAR (object
), Qhelp_echo
)
6515 || EQ (XCAR (object
), Qvertical_line
)
6516 || EQ (XCAR (object
), Qmode_line
)
6517 || EQ (XCAR (object
), Qheader_line
))
6520 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6524 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6531 /* Store into *addr a value nonzero if terminal input chars are available.
6532 Serves the purpose of ioctl (0, FIONREAD, addr)
6533 but works even if FIONREAD does not exist.
6534 (In fact, this may actually read some input.)
6536 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6537 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6540 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6545 /* First of all, have we already counted some input? */
6546 *addr
= (!NILP (Vquit_flag
)
6547 || readable_filtered_events (do_timers_now
, filter_events
));
6549 /* If input is being read as it arrives, and we have none, there is none. */
6550 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6553 /* Try to read some input and see how much we get. */
6555 *addr
= (!NILP (Vquit_flag
)
6556 || readable_filtered_events (do_timers_now
, filter_events
));
6559 /* Store into *addr a value nonzero if terminal input chars are available.
6560 Serves the purpose of ioctl (0, FIONREAD, addr)
6561 but works even if FIONREAD does not exist.
6562 (In fact, this may actually read some input.)
6564 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6567 get_input_pending (addr
, do_timers_now
)
6571 get_filtered_input_pending (addr
, do_timers_now
, 0);
6574 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6577 gobble_input (expected
)
6582 if (interrupt_input
)
6585 mask
= sigblock (sigmask (SIGIO
));
6586 read_avail_input (expected
);
6590 #ifdef POLL_FOR_INPUT
6591 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6594 mask
= sigblock (sigmask (SIGALRM
));
6595 read_avail_input (expected
);
6601 read_avail_input (expected
);
6605 /* Put a BUFFER_SWITCH_EVENT in the buffer
6606 so that read_key_sequence will notice the new current buffer. */
6609 record_asynch_buffer_change ()
6611 struct input_event event
;
6615 event
.kind
= BUFFER_SWITCH_EVENT
;
6616 event
.frame_or_window
= Qnil
;
6620 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6621 The purpose of the event is to make read_key_sequence look up the
6622 keymaps again. If we aren't in read_key_sequence, we don't need one,
6623 and the event could cause trouble by messing up (input-pending-p). */
6624 tem
= Fwaiting_for_user_input_p ();
6628 /* We never need these events if we have no asynchronous subprocesses. */
6632 /* Make sure no interrupt happens while storing the event. */
6634 if (interrupt_input
)
6637 mask
= sigblock (sigmask (SIGIO
));
6638 kbd_buffer_store_event (&event
);
6645 kbd_buffer_store_event (&event
);
6652 /* Read any terminal input already buffered up by the system
6653 into the kbd_buffer, but do not wait.
6655 EXPECTED should be nonzero if the caller knows there is some input.
6657 Except on VMS, all input is read by this function.
6658 If interrupt_input is nonzero, this function MUST be called
6659 only when SIGIO is blocked.
6661 Returns the number of keyboard chars read, or -1 meaning
6662 this is a bad time to try to read input. */
6665 read_avail_input (expected
)
6671 if (read_socket_hook
)
6675 struct input_event hold_quit
;
6677 EVENT_INIT (hold_quit
);
6678 hold_quit
.kind
= NO_EVENT
;
6680 /* No need for FIONREAD or fcntl; just say don't wait. */
6681 while (nr
= (*read_socket_hook
) (input_fd
, expected
, &hold_quit
), nr
> 0)
6686 if (hold_quit
.kind
!= NO_EVENT
)
6687 kbd_buffer_store_event (&hold_quit
);
6691 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6692 the kbd_buffer can really hold. That may prevent loss
6693 of characters on some systems when input is stuffed at us. */
6694 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6697 /* Determine how many characters we should *try* to read. */
6700 #else /* not WINDOWSNT */
6702 n_to_read
= dos_keysns ();
6705 #else /* not MSDOS */
6707 /* Find out how much input is available. */
6708 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6709 /* Formerly simply reported no input, but that sometimes led to
6710 a failure of Emacs to terminate.
6711 SIGHUP seems appropriate if we can't reach the terminal. */
6712 /* ??? Is it really right to send the signal just to this process
6713 rather than to the whole process group?
6714 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6716 if (! noninteractive
)
6717 kill (getpid (), SIGHUP
);
6723 if (n_to_read
> sizeof cbuf
)
6724 n_to_read
= sizeof cbuf
;
6725 #else /* no FIONREAD */
6726 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6727 /* Read some input if available, but don't wait. */
6728 n_to_read
= sizeof cbuf
;
6729 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6734 #endif /* not MSDOS */
6735 #endif /* not WINDOWSNT */
6737 /* Now read; for one reason or another, this will not block.
6738 NREAD is set to the number of chars read. */
6742 cbuf
[0] = dos_keyread ();
6745 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6747 /* POSIX infers that processes which are not in the session leader's
6748 process group won't get SIGHUP's at logout time. BSDI adheres to
6749 this part standard and returns -1 from read (0) with errno==EIO
6750 when the control tty is taken away.
6751 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6752 if (nread
== -1 && errno
== EIO
)
6754 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6755 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6756 This looks incorrect, but it isn't, because _BSD causes
6757 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6758 and that causes a value other than 0 when there is no input. */
6764 /* We used to retry the read if it was interrupted.
6765 But this does the wrong thing when O_NDELAY causes
6766 an EAGAIN error. Does anybody know of a situation
6767 where a retry is actually needed? */
6769 nread
< 0 && (errno
== EAGAIN
6783 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6784 fcntl (input_fd
, F_SETFL
, 0);
6785 #endif /* USG or DGUX or CYGWIN */
6786 #endif /* no FIONREAD */
6787 for (i
= 0; i
< nread
; i
++)
6789 struct input_event buf
;
6791 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6793 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6794 buf
.modifiers
= meta_modifier
;
6799 buf
.frame_or_window
= selected_frame
;
6802 kbd_buffer_store_event (&buf
);
6803 /* Don't look at input that follows a C-g too closely.
6804 This reduces lossage due to autorepeat on C-g. */
6805 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6806 && buf
.code
== quit_char
)
6813 #endif /* not VMS */
6816 handle_async_input ()
6819 extern int select_alarmed
;
6821 interrupt_input_pending
= 0;
6826 nread
= read_avail_input (1);
6827 /* -1 means it's not ok to read the input now.
6828 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6829 0 means there was no keyboard input available. */
6834 select_alarmed
= 1; /* Force the select emulator back to life */
6839 #ifdef SIGIO /* for entire page */
6840 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6843 input_available_signal (signo
)
6846 /* Must preserve main program's value of errno. */
6847 int old_errno
= errno
;
6849 #if defined (USG) && !defined (POSIX_SIGNALS)
6850 /* USG systems forget handlers when they are used;
6851 must reestablish each time */
6852 signal (signo
, input_available_signal
);
6859 if (input_available_clear_time
)
6860 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6863 interrupt_input_pending
= 1;
6865 handle_async_input ();
6875 /* Send ourselves a SIGIO.
6877 This function exists so that the UNBLOCK_INPUT macro in
6878 blockinput.h can have some way to take care of input we put off
6879 dealing with, without assuming that every file which uses
6880 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6882 reinvoke_input_signal ()
6885 handle_async_input ();
6891 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6892 static Lisp_Object menu_bar_one_keymap_changed_items
;
6894 /* These variables hold the vector under construction within
6895 menu_bar_items and its subroutines, and the current index
6896 for storing into that vector. */
6897 static Lisp_Object menu_bar_items_vector
;
6898 static int menu_bar_items_index
;
6900 /* Return a vector of menu items for a menu bar, appropriate
6901 to the current buffer. Each item has three elements in the vector:
6904 OLD is an old vector we can optionally reuse, or nil. */
6907 menu_bar_items (old
)
6910 /* The number of keymaps we're scanning right now, and the number of
6911 keymaps we have allocated space for. */
6914 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6915 in the current keymaps, or nil where it is not a prefix. */
6918 Lisp_Object def
, tail
;
6927 struct gcpro gcpro1
;
6929 /* In order to build the menus, we need to call the keymap
6930 accessors. They all call QUIT. But this function is called
6931 during redisplay, during which a quit is fatal. So inhibit
6932 quitting while building the menus.
6933 We do this instead of specbind because (1) errors will clear it anyway
6934 and (2) this avoids risk of specpdl overflow. */
6935 oquit
= Vinhibit_quit
;
6939 menu_bar_items_vector
= old
;
6941 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6942 menu_bar_items_index
= 0;
6944 GCPRO1 (menu_bar_items_vector
);
6946 /* Build our list of keymaps.
6947 If we recognize a function key and replace its escape sequence in
6948 keybuf with its symbol, or if the sequence starts with a mouse
6949 click and we need to switch buffers, we jump back here to rebuild
6950 the initial keymaps from the current buffer. */
6954 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6955 if (!NILP (Voverriding_local_map_menu_flag
))
6957 /* Yes, use them (if non-nil) as well as the global map. */
6958 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6960 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6961 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6962 if (!NILP (Voverriding_local_map
))
6963 maps
[nmaps
++] = Voverriding_local_map
;
6967 /* No, so use major and minor mode keymaps and keymap property.
6968 Note that menu-bar bindings in the local-map and keymap
6969 properties may not work reliable, as they are only
6970 recognized when the menu-bar (or mode-line) is updated,
6971 which does not normally happen after every command. */
6974 nminor
= current_minor_maps (NULL
, &tmaps
);
6975 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6977 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6978 maps
[nmaps
++] = tem
;
6979 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6981 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6983 maps
[nmaps
++] = current_global_map
;
6986 /* Look up in each map the dummy prefix key `menu-bar'. */
6990 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6991 if (!NILP (maps
[mapno
]))
6993 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6997 menu_bar_one_keymap_changed_items
= Qnil
;
6998 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7002 /* Move to the end those items that should be at the end. */
7004 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7007 int end
= menu_bar_items_index
;
7009 for (i
= 0; i
< end
; i
+= 4)
7010 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7012 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7013 /* Move the item at index I to the end,
7014 shifting all the others forward. */
7015 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7016 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7017 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7018 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7020 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7021 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7022 (end
- i
- 4) * sizeof (Lisp_Object
));
7023 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7024 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7025 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7026 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7031 /* Add nil, nil, nil, nil at the end. */
7032 i
= menu_bar_items_index
;
7033 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7036 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7037 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7038 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7039 menu_bar_items_vector
= tem
;
7041 /* Add this item. */
7042 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7043 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7044 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7045 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7046 menu_bar_items_index
= i
;
7048 Vinhibit_quit
= oquit
;
7050 return menu_bar_items_vector
;
7053 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7054 If there's already an item for KEY, add this DEF to it. */
7056 Lisp_Object item_properties
;
7059 menu_bar_item (key
, item
, dummy1
, dummy2
)
7060 Lisp_Object key
, item
, dummy1
;
7063 struct gcpro gcpro1
;
7067 if (EQ (item
, Qundefined
))
7069 /* If a map has an explicit `undefined' as definition,
7070 discard any previously made menu bar item. */
7072 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7073 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7075 if (menu_bar_items_index
> i
+ 4)
7076 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7077 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7078 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7079 menu_bar_items_index
-= 4;
7083 /* If this keymap has already contributed to this KEY,
7084 don't contribute to it a second time. */
7085 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7086 if (!NILP (tem
) || NILP (item
))
7089 menu_bar_one_keymap_changed_items
7090 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7092 /* We add to menu_bar_one_keymap_changed_items before doing the
7093 parse_menu_item, so that if it turns out it wasn't a menu item,
7094 it still correctly hides any further menu item. */
7096 i
= parse_menu_item (item
, 0, 1);
7101 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7103 /* Find any existing item for this KEY. */
7104 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7105 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7108 /* If we did not find this KEY, add it at the end. */
7109 if (i
== menu_bar_items_index
)
7111 /* If vector is too small, get a bigger one. */
7112 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7115 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7116 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7117 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7118 menu_bar_items_vector
= tem
;
7121 /* Add this item. */
7122 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7123 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7124 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7125 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7126 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7127 menu_bar_items_index
= i
;
7129 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7133 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7134 /* If the new and the old items are not both keymaps,
7135 the lookup will only find `item'. */
7136 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7137 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7141 /* This is used as the handler when calling menu_item_eval_property. */
7143 menu_item_eval_property_1 (arg
)
7146 /* If we got a quit from within the menu computation,
7147 quit all the way out of it. This takes care of C-] in the debugger. */
7148 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7149 Fsignal (Qquit
, Qnil
);
7154 /* Evaluate an expression and return the result (or nil if something
7155 went wrong). Used to evaluate dynamic parts of menu items. */
7157 menu_item_eval_property (sexpr
)
7160 int count
= SPECPDL_INDEX ();
7162 specbind (Qinhibit_redisplay
, Qt
);
7163 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7164 menu_item_eval_property_1
);
7165 return unbind_to (count
, val
);
7168 /* This function parses a menu item and leaves the result in the
7169 vector item_properties.
7170 ITEM is a key binding, a possible menu item.
7171 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7172 evaluate dynamic expressions in the menu item.
7173 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7175 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7176 parse_menu_item returns true if the item is a menu item and false
7180 parse_menu_item (item
, notreal
, inmenubar
)
7182 int notreal
, inmenubar
;
7184 Lisp_Object def
, tem
, item_string
, start
;
7185 Lisp_Object cachelist
;
7187 Lisp_Object keyhint
;
7198 /* Create item_properties vector if necessary. */
7199 if (NILP (item_properties
))
7201 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7203 /* Initialize optional entries. */
7204 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7205 AREF (item_properties
, i
) = Qnil
;
7206 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7208 /* Save the item here to protect it from GC. */
7209 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7211 item_string
= XCAR (item
);
7215 if (STRINGP (item_string
))
7217 /* Old format menu item. */
7218 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7220 /* Maybe help string. */
7221 if (CONSP (item
) && STRINGP (XCAR (item
)))
7223 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7228 /* Maybe key binding cache. */
7229 if (CONSP (item
) && CONSP (XCAR (item
))
7230 && (NILP (XCAR (XCAR (item
)))
7231 || VECTORP (XCAR (XCAR (item
)))))
7233 cachelist
= XCAR (item
);
7237 /* This is the real definition--the function to run. */
7238 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7240 /* Get enable property, if any. */
7243 tem
= Fget (item
, Qmenu_enable
);
7245 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7248 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7250 /* New format menu item. */
7251 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7252 start
= XCDR (item
);
7255 /* We have a real binding. */
7256 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7258 item
= XCDR (start
);
7259 /* Is there a cache list with key equivalences. */
7260 if (CONSP (item
) && CONSP (XCAR (item
)))
7262 cachelist
= XCAR (item
);
7266 /* Parse properties. */
7267 while (CONSP (item
) && CONSP (XCDR (item
)))
7272 if (EQ (tem
, QCenable
))
7273 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7274 else if (EQ (tem
, QCvisible
) && !notreal
)
7276 /* If got a visible property and that evaluates to nil
7277 then ignore this item. */
7278 tem
= menu_item_eval_property (XCAR (item
));
7282 else if (EQ (tem
, QChelp
))
7283 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7284 else if (EQ (tem
, QCfilter
))
7286 else if (EQ (tem
, QCkey_sequence
))
7289 if (NILP (cachelist
)
7290 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7291 /* Be GC protected. Set keyhint to item instead of tem. */
7294 else if (EQ (tem
, QCkeys
))
7297 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7298 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7300 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7305 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7307 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7309 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7316 else if (inmenubar
|| !NILP (start
))
7320 return 0; /* not a menu item */
7322 /* If item string is not a string, evaluate it to get string.
7323 If we don't get a string, skip this item. */
7324 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7325 if (!(STRINGP (item_string
) || notreal
))
7327 item_string
= menu_item_eval_property (item_string
);
7328 if (!STRINGP (item_string
))
7330 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7333 /* If got a filter apply it on definition. */
7334 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7337 def
= menu_item_eval_property (list2 (XCAR (filter
),
7338 list2 (Qquote
, def
)));
7340 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7343 /* Enable or disable selection of item. */
7344 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7350 tem
= menu_item_eval_property (tem
);
7351 if (inmenubar
&& NILP (tem
))
7352 return 0; /* Ignore disabled items in menu bar. */
7353 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7356 /* If we got no definition, this item is just unselectable text which
7357 is OK in a submenu but not in the menubar. */
7359 return (inmenubar
? 0 : 1);
7361 /* See if this is a separate pane or a submenu. */
7362 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7363 tem
= get_keymap (def
, 0, 1);
7364 /* For a subkeymap, just record its details and exit. */
7367 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7368 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7372 /* At the top level in the menu bar, do likewise for commands also.
7373 The menu bar does not display equivalent key bindings anyway.
7374 ITEM_PROPERTY_DEF is already set up properly. */
7378 /* This is a command. See if there is an equivalent key binding. */
7379 if (NILP (cachelist
))
7381 /* We have to create a cachelist. */
7382 CHECK_IMPURE (start
);
7383 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7384 cachelist
= XCAR (XCDR (start
));
7386 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7387 if (!NILP (keyhint
))
7389 XSETCAR (cachelist
, XCAR (keyhint
));
7392 else if (STRINGP (tem
))
7394 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7395 XSETCAR (cachelist
, Qt
);
7399 tem
= XCAR (cachelist
);
7406 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7408 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7411 def
= XCAR (prefix
);
7412 prefix
= XCDR (prefix
);
7415 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7417 if (!update_menu_bindings
)
7419 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7421 if (newcache
/* Always check first time. */
7422 /* Should we check everything when precomputing key
7424 /* If something had no key binding before, don't recheck it
7425 because that is too slow--except if we have a list of
7426 rebound commands in Vdefine_key_rebound_commands, do
7427 recheck any command that appears in that list. */
7428 || (CONSP (Vdefine_key_rebound_commands
)
7429 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7432 /* We had a saved key. Is it still bound to the command? */
7435 /* If the command is an alias for another
7436 (such as lmenu.el set it up), check if the
7437 original command matches the cached command. */
7438 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7439 chkcache
= 1; /* Need to recompute key binding. */
7443 /* Recompute equivalent key binding. If the command is an alias
7444 for another (such as lmenu.el set it up), see if the original
7445 command name has equivalent keys. Otherwise look up the
7446 specified command itself. We don't try both, because that
7447 makes lmenu menus slow. */
7449 && SYMBOLP (XSYMBOL (def
)->function
)
7450 && ! NILP (Fget (def
, Qmenu_alias
)))
7451 def
= XSYMBOL (def
)->function
;
7452 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7453 XSETCAR (cachelist
, tem
);
7456 XSETCDR (cachelist
, Qnil
);
7460 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7462 tem
= XCAR (cachelist
);
7466 newcache
= chkcache
;
7469 tem
= Fkey_description (tem
, Qnil
);
7472 if (STRINGP (XCAR (prefix
)))
7473 tem
= concat2 (XCAR (prefix
), tem
);
7474 if (STRINGP (XCDR (prefix
)))
7475 tem
= concat2 (tem
, XCDR (prefix
));
7477 XSETCDR (cachelist
, tem
);
7481 tem
= XCDR (cachelist
);
7482 if (newcache
&& !NILP (tem
))
7484 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7485 XSETCDR (cachelist
, tem
);
7488 /* If we only want to precompute equivalent key bindings, stop here. */
7492 /* If we have an equivalent key binding, use that. */
7493 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7495 /* Include this when menu help is implemented.
7496 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7497 if (!(NILP (tem) || STRINGP (tem)))
7499 tem = menu_item_eval_property (tem);
7502 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7506 /* Handle radio buttons or toggle boxes. */
7507 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7509 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7510 = menu_item_eval_property (tem
);
7517 /***********************************************************************
7519 ***********************************************************************/
7521 /* A vector holding tool bar items while they are parsed in function
7522 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7525 static Lisp_Object tool_bar_items_vector
;
7527 /* A vector holding the result of parse_tool_bar_item. Layout is like
7528 the one for a single item in tool_bar_items_vector. */
7530 static Lisp_Object tool_bar_item_properties
;
7532 /* Next free index in tool_bar_items_vector. */
7534 static int ntool_bar_items
;
7536 /* The symbols `tool-bar', and `:image'. */
7538 extern Lisp_Object Qtool_bar
;
7539 Lisp_Object QCimage
;
7541 /* Function prototypes. */
7543 static void init_tool_bar_items
P_ ((Lisp_Object
));
7544 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7545 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7546 static void append_tool_bar_item
P_ ((void));
7549 /* Return a vector of tool bar items for keymaps currently in effect.
7550 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7551 tool bar items found. */
7554 tool_bar_items (reuse
, nitems
)
7565 /* In order to build the menus, we need to call the keymap
7566 accessors. They all call QUIT. But this function is called
7567 during redisplay, during which a quit is fatal. So inhibit
7568 quitting while building the menus. We do this instead of
7569 specbind because (1) errors will clear it anyway and (2) this
7570 avoids risk of specpdl overflow. */
7571 oquit
= Vinhibit_quit
;
7574 /* Initialize tool_bar_items_vector and protect it from GC. */
7575 init_tool_bar_items (reuse
);
7577 /* Build list of keymaps in maps. Set nmaps to the number of maps
7580 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7581 if (!NILP (Voverriding_local_map_menu_flag
))
7583 /* Yes, use them (if non-nil) as well as the global map. */
7584 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7586 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7587 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7588 if (!NILP (Voverriding_local_map
))
7589 maps
[nmaps
++] = Voverriding_local_map
;
7593 /* No, so use major and minor mode keymaps and keymap property.
7594 Note that tool-bar bindings in the local-map and keymap
7595 properties may not work reliable, as they are only
7596 recognized when the tool-bar (or mode-line) is updated,
7597 which does not normally happen after every command. */
7600 nminor
= current_minor_maps (NULL
, &tmaps
);
7601 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7603 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7604 maps
[nmaps
++] = tem
;
7605 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7607 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7610 /* Add global keymap at the end. */
7611 maps
[nmaps
++] = current_global_map
;
7613 /* Process maps in reverse order and look up in each map the prefix
7615 for (i
= nmaps
- 1; i
>= 0; --i
)
7616 if (!NILP (maps
[i
]))
7620 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7625 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7626 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7628 Lisp_Object keydef
= XCAR (tail
);
7630 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7635 Vinhibit_quit
= oquit
;
7636 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7637 return tool_bar_items_vector
;
7641 /* Process the definition of KEY which is DEF. */
7644 process_tool_bar_item (key
, def
)
7645 Lisp_Object key
, def
;
7648 extern Lisp_Object Qundefined
;
7649 struct gcpro gcpro1
, gcpro2
;
7651 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7655 if (EQ (def
, Qundefined
))
7657 /* If a map has an explicit `undefined' as definition,
7658 discard any previously made item. */
7659 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7661 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7663 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7665 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7666 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7667 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7668 * sizeof (Lisp_Object
)));
7669 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7674 else if (parse_tool_bar_item (key
, def
))
7675 /* Append a new tool bar item to tool_bar_items_vector. Accept
7676 more than one definition for the same key. */
7677 append_tool_bar_item ();
7683 /* Parse a tool bar item specification ITEM for key KEY and return the
7684 result in tool_bar_item_properties. Value is zero if ITEM is
7687 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7689 CAPTION is the caption of the item, If it's not a string, it is
7690 evaluated to get a string.
7692 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7693 as binding are currently ignored.
7695 The following properties are recognized:
7699 FORM is evaluated and specifies whether the tool bar item is
7700 enabled or disabled.
7704 FORM is evaluated and specifies whether the tool bar item is visible.
7706 - `:filter FUNCTION'
7708 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7709 result is stored as the new binding.
7711 - `:button (TYPE SELECTED)'
7713 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7714 and specifies whether the button is selected (pressed) or not.
7718 IMAGES is either a single image specification or a vector of four
7719 image specifications. See enum tool_bar_item_images.
7721 - `:help HELP-STRING'.
7723 Gives a help string to display for the tool bar item. */
7726 parse_tool_bar_item (key
, item
)
7727 Lisp_Object key
, item
;
7729 /* Access slot with index IDX of vector tool_bar_item_properties. */
7730 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7732 Lisp_Object filter
= Qnil
;
7733 Lisp_Object caption
;
7736 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7737 Rule out items that aren't lists, don't start with
7738 `menu-item' or whose rest following `tool-bar-item' is not a
7741 || !EQ (XCAR (item
), Qmenu_item
)
7742 || (item
= XCDR (item
),
7746 /* Create tool_bar_item_properties vector if necessary. Reset it to
7748 if (VECTORP (tool_bar_item_properties
))
7750 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7754 tool_bar_item_properties
7755 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7758 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7759 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7761 /* Get the caption of the item. If the caption is not a string,
7762 evaluate it to get a string. If we don't get a string, skip this
7764 caption
= XCAR (item
);
7765 if (!STRINGP (caption
))
7767 caption
= menu_item_eval_property (caption
);
7768 if (!STRINGP (caption
))
7771 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7773 /* Give up if rest following the caption is not a list. */
7778 /* Store the binding. */
7779 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7782 /* Ignore cached key binding, if any. */
7783 if (CONSP (item
) && CONSP (XCAR (item
)))
7786 /* Process the rest of the properties. */
7787 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7789 Lisp_Object key
, value
;
7792 value
= XCAR (XCDR (item
));
7794 if (EQ (key
, QCenable
))
7795 /* `:enable FORM'. */
7796 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7797 else if (EQ (key
, QCvisible
))
7799 /* `:visible FORM'. If got a visible property and that
7800 evaluates to nil then ignore this item. */
7801 if (NILP (menu_item_eval_property (value
)))
7804 else if (EQ (key
, QChelp
))
7805 /* `:help HELP-STRING'. */
7806 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7807 else if (EQ (key
, QCfilter
))
7808 /* ':filter FORM'. */
7810 else if (EQ (key
, QCbutton
) && CONSP (value
))
7812 /* `:button (TYPE . SELECTED)'. */
7813 Lisp_Object type
, selected
;
7815 type
= XCAR (value
);
7816 selected
= XCDR (value
);
7817 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7819 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7820 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7823 else if (EQ (key
, QCimage
)
7825 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7826 /* Value is either a single image specification or a vector
7827 of 4 such specifications for the different button states. */
7828 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7831 /* If got a filter apply it on binding. */
7833 PROP (TOOL_BAR_ITEM_BINDING
)
7834 = menu_item_eval_property (list2 (filter
,
7836 PROP (TOOL_BAR_ITEM_BINDING
))));
7838 /* See if the binding is a keymap. Give up if it is. */
7839 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7842 /* Enable or disable selection of item. */
7843 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7844 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7845 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7847 /* Handle radio buttons or toggle boxes. */
7848 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7849 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7850 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7858 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7859 that can be reused. */
7862 init_tool_bar_items (reuse
)
7865 if (VECTORP (reuse
))
7866 tool_bar_items_vector
= reuse
;
7868 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7869 ntool_bar_items
= 0;
7873 /* Append parsed tool bar item properties from
7874 tool_bar_item_properties */
7877 append_tool_bar_item ()
7879 Lisp_Object
*to
, *from
;
7881 /* Enlarge tool_bar_items_vector if necessary. */
7882 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7883 >= XVECTOR (tool_bar_items_vector
)->size
)
7885 Lisp_Object new_vector
;
7886 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7888 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7889 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7890 XVECTOR (new_vector
)->contents
,
7891 old_size
* sizeof (Lisp_Object
));
7892 tool_bar_items_vector
= new_vector
;
7895 /* Append entries from tool_bar_item_properties to the end of
7896 tool_bar_items_vector. */
7897 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7898 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7899 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7900 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7907 /* Read a character using menus based on maps in the array MAPS.
7908 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7909 Return t if we displayed a menu but the user rejected it.
7911 PREV_EVENT is the previous input event, or nil if we are reading
7912 the first event of a key sequence.
7914 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7915 if we used a mouse menu to read the input, or zero otherwise. If
7916 USED_MOUSE_MENU is null, we don't dereference it.
7918 The prompting is done based on the prompt-string of the map
7919 and the strings associated with various map elements.
7921 This can be done with X menus or with menus put in the minibuf.
7922 These are done in different ways, depending on how the input will be read.
7923 Menus using X are done after auto-saving in read-char, getting the input
7924 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7925 and do auto-saving in the inner call of read_char. */
7928 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7931 Lisp_Object prev_event
;
7932 int *used_mouse_menu
;
7935 register Lisp_Object name
= Qnil
;
7937 if (used_mouse_menu
)
7938 *used_mouse_menu
= 0;
7940 /* Use local over global Menu maps */
7942 if (! menu_prompting
)
7945 /* Optionally disregard all but the global map. */
7946 if (inhibit_local_menu_bar_menus
)
7948 maps
+= (nmaps
- 1);
7952 /* Get the menu name from the first map that has one (a prompt string). */
7953 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7955 name
= Fkeymap_prompt (maps
[mapno
]);
7960 /* If we don't have any menus, just read a character normally. */
7961 if (!STRINGP (name
))
7965 /* If we got to this point via a mouse click,
7966 use a real menu for mouse selection. */
7967 if (EVENT_HAS_PARAMETERS (prev_event
)
7968 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7969 && !EQ (XCAR (prev_event
), Qtool_bar
))
7971 /* Display the menu and get the selection. */
7972 Lisp_Object
*realmaps
7973 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7977 /* Use the maps that are not nil. */
7978 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7979 if (!NILP (maps
[mapno
]))
7980 realmaps
[nmaps1
++] = maps
[mapno
];
7982 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7987 record_menu_key (XCAR (value
));
7989 /* If we got multiple events, unread all but
7991 There is no way to prevent those unread events
7992 from showing up later in last_nonmenu_event.
7993 So turn symbol and integer events into lists,
7994 to indicate that they came from a mouse menu,
7995 so that when present in last_nonmenu_event
7996 they won't confuse things. */
7997 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7999 record_menu_key (XCAR (tem
));
8000 if (SYMBOLP (XCAR (tem
))
8001 || INTEGERP (XCAR (tem
)))
8002 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8005 /* If we got more than one event, put all but the first
8006 onto this list to be read later.
8007 Return just the first event now. */
8008 Vunread_command_events
8009 = nconc2 (XCDR (value
), Vunread_command_events
);
8010 value
= XCAR (value
);
8012 else if (NILP (value
))
8014 if (used_mouse_menu
)
8015 *used_mouse_menu
= 1;
8018 #endif /* HAVE_MENUS */
8022 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8023 We make this bigger when necessary, and never free it. */
8024 static char *read_char_minibuf_menu_text
;
8025 /* Size of that buffer. */
8026 static int read_char_minibuf_menu_width
;
8029 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8035 register Lisp_Object name
;
8037 /* FIXME: Use the minibuffer's frame width. */
8038 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8041 Lisp_Object rest
, vector
;
8047 if (! menu_prompting
)
8050 /* Make sure we have a big enough buffer for the menu text. */
8051 if (read_char_minibuf_menu_text
== 0)
8053 read_char_minibuf_menu_width
= width
+ 4;
8054 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8056 else if (width
+ 4 > read_char_minibuf_menu_width
)
8058 read_char_minibuf_menu_width
= width
+ 4;
8059 read_char_minibuf_menu_text
8060 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8062 menu
= read_char_minibuf_menu_text
;
8064 /* Get the menu name from the first map that has one (a prompt string). */
8065 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8067 name
= Fkeymap_prompt (maps
[mapno
]);
8072 /* If we don't have any menus, just read a character normally. */
8073 if (!STRINGP (name
))
8076 /* Prompt string always starts with map's prompt, and a space. */
8077 strcpy (menu
, SDATA (name
));
8078 nlength
= SBYTES (name
);
8079 menu
[nlength
++] = ':';
8080 menu
[nlength
++] = ' ';
8083 /* Start prompting at start of first map. */
8087 /* Present the documented bindings, a line at a time. */
8094 Lisp_Object orig_defn_macro
;
8096 /* Loop over elements of map. */
8101 /* If reached end of map, start at beginning of next map. */
8105 /* At end of last map, wrap around to first map if just starting,
8106 or end this line if already have something on it. */
8110 if (notfirst
|| nobindings
) break;
8115 /* Look at the next element of the map. */
8117 elt
= XVECTOR (vector
)->contents
[idx
];
8119 elt
= Fcar_safe (rest
);
8121 if (idx
< 0 && VECTORP (elt
))
8123 /* If we found a dense table in the keymap,
8124 advanced past it, but start scanning its contents. */
8125 rest
= Fcdr_safe (rest
);
8131 /* An ordinary element. */
8132 Lisp_Object event
, tem
;
8136 event
= Fcar_safe (elt
); /* alist */
8137 elt
= Fcdr_safe (elt
);
8141 XSETINT (event
, idx
); /* vector */
8144 /* Ignore the element if it has no prompt string. */
8145 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8147 /* 1 if the char to type matches the string. */
8149 Lisp_Object upcased_event
, downcased_event
;
8150 Lisp_Object desc
= Qnil
;
8152 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8154 upcased_event
= Fupcase (event
);
8155 downcased_event
= Fdowncase (event
);
8156 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8157 || XINT (downcased_event
) == SREF (s
, 0));
8159 desc
= Fsingle_key_description (event
, Qnil
);
8161 #if 0 /* It is redundant to list the equivalent key bindings because
8162 the prefix is what the user has already typed. */
8164 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8166 /* Insert equivalent keybinding. */
8167 s
= concat2 (s
, tem
);
8170 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8171 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8173 /* Insert button prefix. */
8174 Lisp_Object selected
8175 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8176 if (EQ (tem
, QCradio
))
8177 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8179 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8180 s
= concat2 (tem
, s
);
8184 /* If we have room for the prompt string, add it to this line.
8185 If this is the first on the line, always add it. */
8186 if ((SCHARS (s
) + i
+ 2
8187 + (char_matches
? 0 : SCHARS (desc
) + 3))
8193 /* Punctuate between strings. */
8196 strcpy (menu
+ i
, ", ");
8202 /* If the char to type doesn't match the string's
8203 first char, explicitly show what char to type. */
8206 /* Add as much of string as fits. */
8207 thiswidth
= SCHARS (desc
);
8208 if (thiswidth
+ i
> width
)
8209 thiswidth
= width
- i
;
8210 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8212 strcpy (menu
+ i
, " = ");
8216 /* Add as much of string as fits. */
8217 thiswidth
= SCHARS (s
);
8218 if (thiswidth
+ i
> width
)
8219 thiswidth
= width
- i
;
8220 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8226 /* If this element does not fit, end the line now,
8227 and save the element for the next line. */
8228 strcpy (menu
+ i
, "...");
8233 /* Move past this element. */
8234 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8235 /* Handle reaching end of dense table. */
8240 rest
= Fcdr_safe (rest
);
8244 /* Prompt with that and read response. */
8245 message2_nolog (menu
, strlen (menu
),
8246 ! NILP (current_buffer
->enable_multibyte_characters
));
8248 /* Make believe its not a keyboard macro in case the help char
8249 is pressed. Help characters are not recorded because menu prompting
8250 is not used on replay.
8252 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8253 current_kboard
->defining_kbd_macro
= Qnil
;
8255 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8256 while (BUFFERP (obj
));
8257 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8259 if (!INTEGERP (obj
))
8264 if (! EQ (obj
, menu_prompt_more_char
)
8265 && (!INTEGERP (menu_prompt_more_char
)
8266 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8268 if (!NILP (current_kboard
->defining_kbd_macro
))
8269 store_kbd_macro_char (obj
);
8272 /* Help char - go round again */
8276 /* Reading key sequences. */
8278 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8279 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8280 keymap, or nil otherwise. Return the index of the first keymap in
8281 which KEY has any binding, or NMAPS if no map has a binding.
8283 If KEY is a meta ASCII character, treat it like meta-prefix-char
8284 followed by the corresponding non-meta character. Keymaps in
8285 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8288 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8291 NEXT may be the same array as CURRENT. */
8294 follow_key (key
, nmaps
, current
, defs
, next
)
8296 Lisp_Object
*current
, *defs
, *next
;
8299 int i
, first_binding
;
8301 first_binding
= nmaps
;
8302 for (i
= nmaps
- 1; i
>= 0; i
--)
8304 if (! NILP (current
[i
]))
8306 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8307 if (! NILP (defs
[i
]))
8314 /* Given the set of bindings we've found, produce the next set of maps. */
8315 if (first_binding
< nmaps
)
8316 for (i
= 0; i
< nmaps
; i
++)
8317 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8319 return first_binding
;
8322 /* Structure used to keep track of partial application of key remapping
8323 such as Vfunction_key_map and Vkey_translation_map. */
8324 typedef struct keyremap
8326 Lisp_Object map
, parent
;
8330 /* Lookup KEY in MAP.
8331 MAP is a keymap mapping keys to key vectors or functions.
8332 If the mapping is a function and DO_FUNCTION is non-zero, then
8333 the function is called with PROMPT as parameter and its return
8334 value is used as the return value of this function (after checking
8335 that it is indeed a vector). */
8338 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8339 Lisp_Object map
, key
, prompt
;
8344 next
= access_keymap (map
, key
, 1, 0, 1);
8346 /* Handle symbol with autoload definition. */
8347 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8348 && CONSP (XSYMBOL (next
)->function
)
8349 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8350 do_autoload (XSYMBOL (next
)->function
, next
);
8352 /* Handle a symbol whose function definition is a keymap
8354 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8355 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8356 || KEYMAPP (XSYMBOL (next
)->function
)))
8357 next
= XSYMBOL (next
)->function
;
8359 /* If the keymap gives a function, not an
8360 array, then call the function with one arg and use
8361 its value instead. */
8362 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8367 next
= call1 (next
, prompt
);
8368 /* If the function returned something invalid,
8369 barf--don't ignore it.
8370 (To ignore it safely, we would need to gcpro a bunch of
8371 other variables.) */
8372 if (! (VECTORP (next
) || STRINGP (next
)))
8373 error ("Function %s returns invalid key sequence", tem
);
8378 /* Do one step of the key remapping used for function-key-map and
8379 key-translation-map:
8380 KEYBUF is the buffer holding the input events.
8381 BUFSIZE is its maximum size.
8382 FKEY is a pointer to the keyremap structure to use.
8383 INPUT is the index of the last element in KEYBUF.
8384 DOIT if non-zero says that the remapping can actually take place.
8385 DIFF is used to return the number of keys added/removed by the remapping.
8386 PARENT is the root of the keymap.
8387 PROMPT is the prompt to use if the remapping happens through a function.
8388 The return value is non-zero if the remapping actually took place. */
8391 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8392 Lisp_Object
*keybuf
, prompt
;
8394 int input
, doit
, *diff
, bufsize
;
8396 Lisp_Object next
, key
;
8398 key
= keybuf
[fkey
->end
++];
8399 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8401 /* If keybuf[fkey->start..fkey->end] is bound in the
8402 map and we're in a position to do the key remapping, replace it with
8403 the binding and restart with fkey->start at the end. */
8404 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8406 int len
= XFASTINT (Flength (next
));
8409 *diff
= len
- (fkey
->end
- fkey
->start
);
8411 if (input
+ *diff
>= bufsize
)
8412 error ("Key sequence too long");
8414 /* Shift the keys that follow fkey->end. */
8416 for (i
= fkey
->end
; i
< input
; i
++)
8417 keybuf
[i
+ *diff
] = keybuf
[i
];
8419 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8420 keybuf
[i
+ *diff
] = keybuf
[i
];
8421 /* Overwrite the old keys with the new ones. */
8422 for (i
= 0; i
< len
; i
++)
8423 keybuf
[fkey
->start
+ i
]
8424 = Faref (next
, make_number (i
));
8426 fkey
->start
= fkey
->end
+= *diff
;
8427 fkey
->map
= fkey
->parent
;
8432 fkey
->map
= get_keymap (next
, 0, 1);
8434 /* If we no longer have a bound suffix, try a new position for
8436 if (!CONSP (fkey
->map
))
8438 fkey
->end
= ++fkey
->start
;
8439 fkey
->map
= fkey
->parent
;
8444 /* Read a sequence of keys that ends with a non prefix character,
8445 storing it in KEYBUF, a buffer of size BUFSIZE.
8447 Return the length of the key sequence stored.
8448 Return -1 if the user rejected a command menu.
8450 Echo starting immediately unless `prompt' is 0.
8452 Where a key sequence ends depends on the currently active keymaps.
8453 These include any minor mode keymaps active in the current buffer,
8454 the current buffer's local map, and the global map.
8456 If a key sequence has no other bindings, we check Vfunction_key_map
8457 to see if some trailing subsequence might be the beginning of a
8458 function key's sequence. If so, we try to read the whole function
8459 key, and substitute its symbolic name into the key sequence.
8461 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8462 `double-' events into similar click events, if that would make them
8463 bound. We try to turn `triple-' events first into `double-' events,
8466 If we get a mouse click in a mode line, vertical divider, or other
8467 non-text area, we treat the click as if it were prefixed by the
8468 symbol denoting that area - `mode-line', `vertical-line', or
8471 If the sequence starts with a mouse click, we read the key sequence
8472 with respect to the buffer clicked on, not the current buffer.
8474 If the user switches frames in the midst of a key sequence, we put
8475 off the switch-frame event until later; the next call to
8476 read_char will return it.
8478 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8479 from the selected window's buffer. */
8482 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8483 can_return_switch_frame
, fix_current_buffer
)
8484 Lisp_Object
*keybuf
;
8487 int dont_downcase_last
;
8488 int can_return_switch_frame
;
8489 int fix_current_buffer
;
8491 volatile Lisp_Object from_string
;
8492 volatile int count
= SPECPDL_INDEX ();
8494 /* How many keys there are in the current key sequence. */
8497 /* The length of the echo buffer when we started reading, and
8498 the length of this_command_keys when we started reading. */
8499 volatile int echo_start
;
8500 volatile int keys_start
;
8502 /* The number of keymaps we're scanning right now, and the number of
8503 keymaps we have allocated space for. */
8505 volatile int nmaps_allocated
= 0;
8507 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8508 the current keymaps. */
8509 Lisp_Object
*volatile defs
= NULL
;
8511 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8512 in the current keymaps, or nil where it is not a prefix. */
8513 Lisp_Object
*volatile submaps
= NULL
;
8515 /* The local map to start out with at start of key sequence. */
8516 volatile Lisp_Object orig_local_map
;
8518 /* The map from the `keymap' property to start out with at start of
8520 volatile Lisp_Object orig_keymap
;
8522 /* 1 if we have already considered switching to the local-map property
8523 of the place where a mouse click occurred. */
8524 volatile int localized_local_map
= 0;
8526 /* The index in defs[] of the first keymap that has a binding for
8527 this key sequence. In other words, the lowest i such that
8528 defs[i] is non-nil. */
8529 volatile int first_binding
;
8530 /* Index of the first key that has no binding.
8531 It is useless to try fkey.start larger than that. */
8532 volatile int first_unbound
;
8534 /* If t < mock_input, then KEYBUF[t] should be read as the next
8537 We use this to recover after recognizing a function key. Once we
8538 realize that a suffix of the current key sequence is actually a
8539 function key's escape sequence, we replace the suffix with the
8540 function key's binding from Vfunction_key_map. Now keybuf
8541 contains a new and different key sequence, so the echo area,
8542 this_command_keys, and the submaps and defs arrays are wrong. In
8543 this situation, we set mock_input to t, set t to 0, and jump to
8544 restart_sequence; the loop will read keys from keybuf up until
8545 mock_input, thus rebuilding the state; and then it will resume
8546 reading characters from the keyboard. */
8547 volatile int mock_input
= 0;
8549 /* If the sequence is unbound in submaps[], then
8550 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8551 and fkey.map is its binding.
8553 These might be > t, indicating that all function key scanning
8554 should hold off until t reaches them. We do this when we've just
8555 recognized a function key, to avoid searching for the function
8556 key's again in Vfunction_key_map. */
8557 volatile keyremap fkey
;
8559 /* Likewise, for key_translation_map. */
8560 volatile keyremap keytran
;
8562 /* If we receive a `switch-frame' or `select-window' event in the middle of
8563 a key sequence, we put it off for later.
8564 While we're reading, we keep the event here. */
8565 volatile Lisp_Object delayed_switch_frame
;
8567 /* See the comment below... */
8568 #if defined (GOBBLE_FIRST_EVENT)
8569 Lisp_Object first_event
;
8572 volatile Lisp_Object original_uppercase
;
8573 volatile int original_uppercase_position
= -1;
8575 /* Gets around Microsoft compiler limitations. */
8578 struct buffer
*starting_buffer
;
8580 /* List of events for which a fake prefix key has been generated. */
8581 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8583 #if defined (GOBBLE_FIRST_EVENT)
8587 struct gcpro gcpro1
;
8589 GCPRO1 (fake_prefixed_keys
);
8590 raw_keybuf_count
= 0;
8592 last_nonmenu_event
= Qnil
;
8594 delayed_switch_frame
= Qnil
;
8595 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8596 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8597 /* If there is no translation-map, turn off scanning. */
8598 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8599 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8604 echo_prompt (prompt
);
8605 else if (cursor_in_echo_area
8606 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8607 && NILP (Fzerop (Vecho_keystrokes
)))
8608 /* This doesn't put in a dash if the echo buffer is empty, so
8609 you don't always see a dash hanging out in the minibuffer. */
8613 /* Record the initial state of the echo area and this_command_keys;
8614 we will need to restore them if we replay a key sequence. */
8616 echo_start
= echo_length ();
8617 keys_start
= this_command_key_count
;
8618 this_single_command_key_start
= keys_start
;
8620 #if defined (GOBBLE_FIRST_EVENT)
8621 /* This doesn't quite work, because some of the things that read_char
8622 does cannot safely be bypassed. It seems too risky to try to make
8625 /* Read the first char of the sequence specially, before setting
8626 up any keymaps, in case a filter runs and switches buffers on us. */
8627 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8629 #endif /* GOBBLE_FIRST_EVENT */
8631 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8632 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8635 /* We jump here when the key sequence has been thoroughly changed, and
8636 we need to rescan it starting from the beginning. When we jump here,
8637 keybuf[0..mock_input] holds the sequence we should reread. */
8640 starting_buffer
= current_buffer
;
8641 first_unbound
= bufsize
+ 1;
8643 /* Build our list of keymaps.
8644 If we recognize a function key and replace its escape sequence in
8645 keybuf with its symbol, or if the sequence starts with a mouse
8646 click and we need to switch buffers, we jump back here to rebuild
8647 the initial keymaps from the current buffer. */
8650 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8651 || !NILP (Voverriding_local_map
))
8653 if (3 > nmaps_allocated
)
8655 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8656 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8657 nmaps_allocated
= 3;
8659 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8660 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8661 if (!NILP (Voverriding_local_map
))
8662 submaps
[nmaps
++] = Voverriding_local_map
;
8670 nminor
= current_minor_maps (0, &maps
);
8671 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8673 if (total
> nmaps_allocated
)
8675 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8676 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8677 nmaps_allocated
= total
;
8680 if (!NILP (orig_keymap
))
8681 submaps
[nmaps
++] = orig_keymap
;
8683 bcopy (maps
, (void *) (submaps
+ nmaps
),
8684 nminor
* sizeof (submaps
[0]));
8688 submaps
[nmaps
++] = orig_local_map
;
8690 submaps
[nmaps
++] = current_global_map
;
8692 /* Find an accurate initial value for first_binding. */
8693 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8694 if (! NILP (submaps
[first_binding
]))
8697 /* Start from the beginning in keybuf. */
8700 /* These are no-ops the first time through, but if we restart, they
8701 revert the echo area and this_command_keys to their original state. */
8702 this_command_key_count
= keys_start
;
8703 if (INTERACTIVE
&& t
< mock_input
)
8704 echo_truncate (echo_start
);
8706 /* If the best binding for the current key sequence is a keymap, or
8707 we may be looking at a function key's escape sequence, keep on
8709 while (first_binding
< nmaps
8710 /* Keep reading as long as there's a prefix binding. */
8711 ? !NILP (submaps
[first_binding
])
8712 /* Don't return in the middle of a possible function key sequence,
8713 if the only bindings we found were via case conversion.
8714 Thus, if ESC O a has a function-key-map translation
8715 and ESC o has a binding, don't return after ESC O,
8716 so that we can translate ESC O plus the next character. */
8717 : (fkey
.start
< t
|| keytran
.start
< t
))
8720 int used_mouse_menu
= 0;
8722 /* Where the last real key started. If we need to throw away a
8723 key that has expanded into more than one element of keybuf
8724 (say, a mouse click on the mode line which is being treated
8725 as [mode-line (mouse-...)], then we backtrack to this point
8727 volatile int last_real_key_start
;
8729 /* These variables are analogous to echo_start and keys_start;
8730 while those allow us to restart the entire key sequence,
8731 echo_local_start and keys_local_start allow us to throw away
8733 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8735 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8736 eassert (fkey
.start
<= fkey
.end
);
8737 eassert (keytran
.start
<= keytran
.end
);
8738 /* key-translation-map is applied *after* function-key-map. */
8739 eassert (keytran
.end
<= fkey
.start
);
8741 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8742 { /* The prefix upto first_unbound has no binding and has
8743 no translation left to do either, so we know it's unbound.
8744 If we don't stop now, we risk staying here indefinitely
8745 (if the user keeps entering fkey or keytran prefixes
8746 like C-c ESC ESC ESC ESC ...) */
8748 for (i
= first_unbound
+ 1; i
< t
; i
++)
8749 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8750 mock_input
= t
- first_unbound
- 1;
8751 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8752 fkey
.map
= fkey
.parent
;
8753 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8754 keytran
.map
= keytran
.parent
;
8755 goto replay_sequence
;
8759 error ("Key sequence too long");
8762 echo_local_start
= echo_length ();
8763 keys_local_start
= this_command_key_count
;
8764 local_first_binding
= first_binding
;
8767 /* These are no-ops, unless we throw away a keystroke below and
8768 jumped back up to replay_key; in that case, these restore the
8769 variables to their original state, allowing us to replay the
8771 if (INTERACTIVE
&& t
< mock_input
)
8772 echo_truncate (echo_local_start
);
8773 this_command_key_count
= keys_local_start
;
8774 first_binding
= local_first_binding
;
8776 /* By default, assume each event is "real". */
8777 last_real_key_start
= t
;
8779 /* Does mock_input indicate that we are re-reading a key sequence? */
8783 add_command_key (key
);
8784 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8785 && NILP (Fzerop (Vecho_keystrokes
)))
8789 /* If not, we should actually read a character. */
8794 KBOARD
*interrupted_kboard
= current_kboard
;
8795 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8796 if (setjmp (wrong_kboard_jmpbuf
))
8798 if (!NILP (delayed_switch_frame
))
8800 interrupted_kboard
->kbd_queue
8801 = Fcons (delayed_switch_frame
,
8802 interrupted_kboard
->kbd_queue
);
8803 delayed_switch_frame
= Qnil
;
8806 interrupted_kboard
->kbd_queue
8807 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8809 /* If the side queue is non-empty, ensure it begins with a
8810 switch-frame, so we'll replay it in the right context. */
8811 if (CONSP (interrupted_kboard
->kbd_queue
)
8812 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8813 !(EVENT_HAS_PARAMETERS (key
)
8814 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8818 XSETFRAME (frame
, interrupted_frame
);
8819 interrupted_kboard
->kbd_queue
8820 = Fcons (make_lispy_switch_frame (frame
),
8821 interrupted_kboard
->kbd_queue
);
8824 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8825 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8826 goto replay_sequence
;
8829 key
= read_char (NILP (prompt
), nmaps
,
8830 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8834 /* read_char returns t when it shows a menu and the user rejects it.
8838 unbind_to (count
, Qnil
);
8843 /* read_char returns -1 at the end of a macro.
8844 Emacs 18 handles this by returning immediately with a
8845 zero, so that's what we'll do. */
8846 if (INTEGERP (key
) && XINT (key
) == -1)
8849 /* The Microsoft C compiler can't handle the goto that
8855 /* If the current buffer has been changed from under us, the
8856 keymap may have changed, so replay the sequence. */
8859 timer_resume_idle ();
8862 /* Reset the current buffer from the selected window
8863 in case something changed the former and not the latter.
8864 This is to be more consistent with the behavior
8865 of the command_loop_1. */
8866 if (fix_current_buffer
)
8868 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8870 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8871 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8874 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8875 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8876 goto replay_sequence
;
8879 /* If we have a quit that was typed in another frame, and
8880 quit_throw_to_read_char switched buffers,
8881 replay to get the right keymap. */
8883 && XINT (key
) == quit_char
8884 && current_buffer
!= starting_buffer
)
8887 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8891 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8892 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8893 goto replay_sequence
;
8898 if (EVENT_HAS_PARAMETERS (key
)
8899 /* Either a `switch-frame' or a `select-window' event. */
8900 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8902 /* If we're at the beginning of a key sequence, and the caller
8903 says it's okay, go ahead and return this event. If we're
8904 in the midst of a key sequence, delay it until the end. */
8905 if (t
> 0 || !can_return_switch_frame
)
8907 delayed_switch_frame
= key
;
8913 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8916 /* Clicks in non-text areas get prefixed by the symbol
8917 in their CHAR-ADDRESS field. For example, a click on
8918 the mode line is prefixed by the symbol `mode-line'.
8920 Furthermore, key sequences beginning with mouse clicks
8921 are read using the keymaps of the buffer clicked on, not
8922 the current buffer. So we may have to switch the buffer
8925 When we turn one event into two events, we must make sure
8926 that neither of the two looks like the original--so that,
8927 if we replay the events, they won't be expanded again.
8928 If not for this, such reexpansion could happen either here
8929 or when user programs play with this-command-keys. */
8930 if (EVENT_HAS_PARAMETERS (key
))
8935 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8936 if (EQ (kind
, Qmouse_click
))
8938 Lisp_Object window
, posn
;
8940 window
= POSN_WINDOW (EVENT_START (key
));
8941 posn
= POSN_POSN (EVENT_START (key
));
8944 || (!NILP (fake_prefixed_keys
)
8945 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8947 /* We're looking a second time at an event for which
8948 we generated a fake prefix key. Set
8949 last_real_key_start appropriately. */
8951 last_real_key_start
= t
- 1;
8954 /* Key sequences beginning with mouse clicks are
8955 read using the keymaps in the buffer clicked on,
8956 not the current buffer. If we're at the
8957 beginning of a key sequence, switch buffers. */
8958 if (last_real_key_start
== 0
8960 && BUFFERP (XWINDOW (window
)->buffer
)
8961 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8963 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8967 /* Arrange to go back to the original buffer once we're
8968 done reading the key sequence. Note that we can't
8969 use save_excursion_{save,restore} here, because they
8970 save point as well as the current buffer; we don't
8971 want to save point, because redisplay may change it,
8972 to accommodate a Fset_window_start or something. We
8973 don't want to do this at the top of the function,
8974 because we may get input from a subprocess which
8975 wants to change the selected window and stuff (say,
8977 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8979 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8981 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8982 orig_local_map
= get_local_map (PT
, current_buffer
,
8984 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8985 goto replay_sequence
;
8988 /* For a mouse click, get the local text-property keymap
8989 of the place clicked on, rather than point. */
8990 if (last_real_key_start
== 0
8991 && CONSP (XCDR (key
))
8992 && ! localized_local_map
)
8994 Lisp_Object map_here
, start
, pos
;
8996 localized_local_map
= 1;
8997 start
= EVENT_START (key
);
8999 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9001 pos
= POSN_BUFFER_POSN (start
);
9003 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9005 map_here
= get_local_map (XINT (pos
),
9006 current_buffer
, Qlocal_map
);
9007 if (!EQ (map_here
, orig_local_map
))
9009 orig_local_map
= map_here
;
9013 goto replay_sequence
;
9015 map_here
= get_local_map (XINT (pos
),
9016 current_buffer
, Qkeymap
);
9017 if (!EQ (map_here
, orig_keymap
))
9019 orig_keymap
= map_here
;
9023 goto replay_sequence
;
9029 /* Expand mode-line and scroll-bar events into two events:
9030 use posn as a fake prefix key. */
9032 && (NILP (fake_prefixed_keys
)
9033 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9035 if (t
+ 1 >= bufsize
)
9036 error ("Key sequence too long");
9039 keybuf
[t
+ 1] = key
;
9042 /* Record that a fake prefix key has been generated
9043 for KEY. Don't modify the event; this would
9044 prevent proper action when the event is pushed
9045 back into unread-command-events. */
9046 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9048 /* If on a mode line string with a local keymap,
9049 reconsider the key sequence with that keymap. */
9050 if (string
= POSN_STRING (EVENT_START (key
)),
9051 (CONSP (string
) && STRINGP (XCAR (string
))))
9053 Lisp_Object pos
, map
, map2
;
9055 pos
= XCDR (string
);
9056 string
= XCAR (string
);
9058 && XINT (pos
) < SCHARS (string
))
9060 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9062 orig_local_map
= map
;
9063 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9066 if (!NILP (map
) || !NILP (map2
))
9067 goto replay_sequence
;
9073 else if (NILP (from_string
)
9074 && (string
= POSN_STRING (EVENT_START (key
)),
9075 (CONSP (string
) && STRINGP (XCAR (string
)))))
9077 /* For a click on a string, i.e. overlay string or a
9078 string displayed via the `display' property,
9079 consider `local-map' and `keymap' properties of
9081 Lisp_Object pos
, map
, map2
;
9083 pos
= XCDR (string
);
9084 string
= XCAR (string
);
9086 && XINT (pos
) < SCHARS (string
))
9088 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9090 orig_local_map
= map
;
9091 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9095 if (!NILP (map
) || !NILP (map2
))
9097 from_string
= string
;
9098 goto replay_sequence
;
9103 else if (CONSP (XCDR (key
))
9104 && CONSP (EVENT_START (key
))
9105 && CONSP (XCDR (EVENT_START (key
))))
9109 posn
= POSN_POSN (EVENT_START (key
));
9110 /* Handle menu-bar events:
9111 insert the dummy prefix event `menu-bar'. */
9112 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9114 if (t
+ 1 >= bufsize
)
9115 error ("Key sequence too long");
9119 /* Zap the position in key, so we know that we've
9120 expanded it, and don't try to do so again. */
9121 POSN_SET_POSN (EVENT_START (key
),
9122 Fcons (posn
, Qnil
));
9125 goto replay_sequence
;
9127 else if (CONSP (posn
))
9129 /* We're looking at the second event of a
9130 sequence which we expanded before. Set
9131 last_real_key_start appropriately. */
9132 if (last_real_key_start
== t
&& t
> 0)
9133 last_real_key_start
= t
- 1;
9138 /* We have finally decided that KEY is something we might want
9140 first_binding
= (follow_key (key
,
9141 nmaps
- first_binding
,
9142 submaps
+ first_binding
,
9143 defs
+ first_binding
,
9144 submaps
+ first_binding
)
9147 /* If KEY wasn't bound, we'll try some fallbacks. */
9148 if (first_binding
< nmaps
)
9149 /* This is needed for the following scenario:
9150 event 0: a down-event that gets dropped by calling replay_key.
9151 event 1: some normal prefix like C-h.
9152 After event 0, first_unbound is 0, after event 1 fkey.start
9153 and keytran.start are both 1, so when we see that C-h is bound,
9154 we need to update first_unbound. */
9155 first_unbound
= max (t
+ 1, first_unbound
);
9160 /* Remember the position to put an upper bound on fkey.start. */
9161 first_unbound
= min (t
, first_unbound
);
9163 head
= EVENT_HEAD (key
);
9164 if (help_char_p (head
) && t
> 0)
9166 read_key_sequence_cmd
= Vprefix_help_command
;
9168 last_nonmenu_event
= key
;
9169 /* The Microsoft C compiler can't handle the goto that
9177 Lisp_Object breakdown
;
9180 breakdown
= parse_modifiers (head
);
9181 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9182 /* Attempt to reduce an unbound mouse event to a simpler
9183 event that is bound:
9184 Drags reduce to clicks.
9185 Double-clicks reduce to clicks.
9186 Triple-clicks reduce to double-clicks, then to clicks.
9187 Down-clicks are eliminated.
9188 Double-downs reduce to downs, then are eliminated.
9189 Triple-downs reduce to double-downs, then to downs,
9190 then are eliminated. */
9191 if (modifiers
& (down_modifier
| drag_modifier
9192 | double_modifier
| triple_modifier
))
9194 while (modifiers
& (down_modifier
| drag_modifier
9195 | double_modifier
| triple_modifier
))
9197 Lisp_Object new_head
, new_click
;
9198 if (modifiers
& triple_modifier
)
9199 modifiers
^= (double_modifier
| triple_modifier
);
9200 else if (modifiers
& double_modifier
)
9201 modifiers
&= ~double_modifier
;
9202 else if (modifiers
& drag_modifier
)
9203 modifiers
&= ~drag_modifier
;
9206 /* Dispose of this `down' event by simply jumping
9207 back to replay_key, to get another event.
9209 Note that if this event came from mock input,
9210 then just jumping back to replay_key will just
9211 hand it to us again. So we have to wipe out any
9214 We could delete keybuf[t] and shift everything
9215 after that to the left by one spot, but we'd also
9216 have to fix up any variable that points into
9217 keybuf, and shifting isn't really necessary
9220 Adding prefixes for non-textual mouse clicks
9221 creates two characters of mock input, and both
9222 must be thrown away. If we're only looking at
9223 the prefix now, we can just jump back to
9224 replay_key. On the other hand, if we've already
9225 processed the prefix, and now the actual click
9226 itself is giving us trouble, then we've lost the
9227 state of the keymaps we want to backtrack to, and
9228 we need to replay the whole sequence to rebuild
9231 Beyond that, only function key expansion could
9232 create more than two keys, but that should never
9233 generate mouse events, so it's okay to zero
9234 mock_input in that case too.
9236 FIXME: The above paragraph seems just plain
9237 wrong, if you consider things like
9238 xterm-mouse-mode. -stef
9240 Isn't this just the most wonderful code ever? */
9242 /* If mock_input > t + 1, the above simplification
9243 will actually end up dropping keys on the floor.
9244 This is probably OK for now, but even
9245 if mock_input <= t + 1, we need to adjust fkey
9247 Typical case [header-line down-mouse-N]:
9248 mock_input = 2, t = 1, fkey.end = 1,
9249 last_real_key_start = 0. */
9250 if (fkey
.end
> last_real_key_start
)
9252 fkey
.end
= fkey
.start
9253 = min (last_real_key_start
, fkey
.start
);
9254 fkey
.map
= fkey
.parent
;
9255 if (keytran
.end
> last_real_key_start
)
9257 keytran
.end
= keytran
.start
9258 = min (last_real_key_start
, keytran
.start
);
9259 keytran
.map
= keytran
.parent
;
9262 if (t
== last_real_key_start
)
9269 mock_input
= last_real_key_start
;
9270 goto replay_sequence
;
9275 = apply_modifiers (modifiers
, XCAR (breakdown
));
9277 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9279 /* Look for a binding for this new key. follow_key
9280 promises that it didn't munge submaps the
9281 last time we called it, since key was unbound. */
9283 = (follow_key (new_click
,
9284 nmaps
- local_first_binding
,
9285 submaps
+ local_first_binding
,
9286 defs
+ local_first_binding
,
9287 submaps
+ local_first_binding
)
9288 + local_first_binding
);
9290 /* If that click is bound, go for it. */
9291 if (first_binding
< nmaps
)
9296 /* Otherwise, we'll leave key set to the drag event. */
9303 /* Normally, last_nonmenu_event gets the previous key we read.
9304 But when a mouse popup menu is being used,
9305 we don't update last_nonmenu_event; it continues to hold the mouse
9306 event that preceded the first level of menu. */
9307 if (!used_mouse_menu
)
9308 last_nonmenu_event
= key
;
9310 /* Record what part of this_command_keys is the current key sequence. */
9311 this_single_command_key_start
= this_command_key_count
- t
;
9313 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9314 /* There is a binding and it's not a prefix.
9315 There is thus no function-key in this sequence.
9316 Moving fkey.start is important in this case to allow keytran.start
9317 to go over the sequence before we return (since we keep the
9318 invariant that keytran.end <= fkey.start). */
9321 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9324 /* If the sequence is unbound, see if we can hang a function key
9325 off the end of it. */
9326 /* Continue scan from fkey.end until we find a bound suffix. */
9327 while (fkey
.end
< t
)
9329 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9332 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9333 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9334 max (t
, mock_input
),
9335 /* If there's a binding (i.e.
9336 first_binding >= nmaps) we don't want
9337 to apply this function-key-mapping. */
9338 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9343 mock_input
= diff
+ max (t
, mock_input
);
9344 goto replay_sequence
;
9348 /* Look for this sequence in key-translation-map.
9349 Scan from keytran.end until we find a bound suffix. */
9350 while (keytran
.end
< fkey
.start
)
9352 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9355 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9356 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9361 mock_input
= diff
+ max (t
, mock_input
);
9362 /* Adjust the function-key-map counters. */
9366 goto replay_sequence
;
9370 /* If KEY is not defined in any of the keymaps,
9371 and cannot be part of a function key or translation,
9372 and is an upper case letter
9373 use the corresponding lower-case letter instead. */
9374 if (first_binding
>= nmaps
9375 && fkey
.start
>= t
&& keytran
.start
>= t
9377 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9378 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9379 || (XINT (key
) & shift_modifier
)))
9381 Lisp_Object new_key
;
9383 original_uppercase
= key
;
9384 original_uppercase_position
= t
- 1;
9386 if (XINT (key
) & shift_modifier
)
9387 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9389 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9390 | (XINT (key
) & ~CHAR_MODIFIER_MASK
)));
9392 /* We have to do this unconditionally, regardless of whether
9393 the lower-case char is defined in the keymaps, because they
9394 might get translated through function-key-map. */
9395 keybuf
[t
- 1] = new_key
;
9396 mock_input
= max (t
, mock_input
);
9398 goto replay_sequence
;
9400 /* If KEY is not defined in any of the keymaps,
9401 and cannot be part of a function key or translation,
9402 and is a shifted function key,
9403 use the corresponding unshifted function key instead. */
9404 if (first_binding
>= nmaps
9405 && fkey
.start
>= t
&& keytran
.start
>= t
9408 Lisp_Object breakdown
;
9411 breakdown
= parse_modifiers (key
);
9412 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9413 if (modifiers
& shift_modifier
)
9415 Lisp_Object new_key
;
9417 original_uppercase
= key
;
9418 original_uppercase_position
= t
- 1;
9420 modifiers
&= ~shift_modifier
;
9421 new_key
= apply_modifiers (modifiers
,
9424 keybuf
[t
- 1] = new_key
;
9425 mock_input
= max (t
, mock_input
);
9426 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9427 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9429 goto replay_sequence
;
9435 read_key_sequence_cmd
= (first_binding
< nmaps
9436 ? defs
[first_binding
]
9439 unread_switch_frame
= delayed_switch_frame
;
9440 unbind_to (count
, Qnil
);
9442 /* Don't downcase the last character if the caller says don't.
9443 Don't downcase it if the result is undefined, either. */
9444 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9445 && t
- 1 == original_uppercase_position
)
9446 keybuf
[t
- 1] = original_uppercase
;
9448 /* Occasionally we fabricate events, perhaps by expanding something
9449 according to function-key-map, or by adding a prefix symbol to a
9450 mouse click in the scroll bar or modeline. In this cases, return
9451 the entire generated key sequence, even if we hit an unbound
9452 prefix or a definition before the end. This means that you will
9453 be able to push back the event properly, and also means that
9454 read-key-sequence will always return a logical unit.
9457 for (; t
< mock_input
; t
++)
9459 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9460 && NILP (Fzerop (Vecho_keystrokes
)))
9461 echo_char (keybuf
[t
]);
9462 add_command_key (keybuf
[t
]);
9471 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9472 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9473 The sequence is sufficient to specify a non-prefix command in the
9474 current local and global maps.
9476 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9477 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9478 as a continuation of the previous key.
9480 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9481 convert the last event to lower case. (Normally any upper case event
9482 is converted to lower case if the original event is undefined and the lower
9483 case equivalent is defined.) A non-nil value is appropriate for reading
9484 a key sequence to be defined.
9486 A C-g typed while in this function is treated like any other character,
9487 and `quit-flag' is not set.
9489 If the key sequence starts with a mouse click, then the sequence is read
9490 using the keymaps of the buffer of the window clicked in, not the buffer
9491 of the selected window as normal.
9493 `read-key-sequence' drops unbound button-down events, since you normally
9494 only care about the click or drag events which follow them. If a drag
9495 or multi-click event is unbound, but the corresponding click event would
9496 be bound, `read-key-sequence' turns the event into a click event at the
9497 drag's starting position. This means that you don't have to distinguish
9498 between click and drag, double, or triple events unless you want to.
9500 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9501 lines separating windows, and scroll bars with imaginary keys
9502 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9504 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9505 function will process a switch-frame event if the user switches frames
9506 before typing anything. If the user switches frames in the middle of a
9507 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9508 is nil, then the event will be put off until after the current key sequence.
9510 `read-key-sequence' checks `function-key-map' for function key
9511 sequences, where they wouldn't conflict with ordinary bindings. See
9512 `function-key-map' for more details.
9514 The optional fifth argument COMMAND-LOOP, if non-nil, means
9515 that this key sequence is being read by something that will
9516 read commands one after another. It should be nil if the caller
9517 will read just one key sequence. */)
9518 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9520 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9521 Lisp_Object can_return_switch_frame
, command_loop
;
9523 Lisp_Object keybuf
[30];
9525 struct gcpro gcpro1
;
9526 int count
= SPECPDL_INDEX ();
9529 CHECK_STRING (prompt
);
9532 specbind (Qinput_method_exit_on_first_char
,
9533 (NILP (command_loop
) ? Qt
: Qnil
));
9534 specbind (Qinput_method_use_echo_area
,
9535 (NILP (command_loop
) ? Qt
: Qnil
));
9537 bzero (keybuf
, sizeof keybuf
);
9539 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9541 if (NILP (continue_echo
))
9543 this_command_key_count
= 0;
9544 this_command_key_count_reset
= 0;
9545 this_single_command_key_start
= 0;
9548 #ifdef HAVE_X_WINDOWS
9549 if (display_hourglass_p
)
9550 cancel_hourglass ();
9553 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9554 prompt
, ! NILP (dont_downcase_last
),
9555 ! NILP (can_return_switch_frame
), 0);
9557 #if 0 /* The following is fine for code reading a key sequence and
9558 then proceeding with a lenghty computation, but it's not good
9559 for code reading keys in a loop, like an input method. */
9560 #ifdef HAVE_X_WINDOWS
9561 if (display_hourglass_p
)
9572 return unbind_to (count
, make_event_array (i
, keybuf
));
9575 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9576 Sread_key_sequence_vector
, 1, 5, 0,
9577 doc
: /* Like `read-key-sequence' but always return a vector. */)
9578 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9580 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9581 Lisp_Object can_return_switch_frame
, command_loop
;
9583 Lisp_Object keybuf
[30];
9585 struct gcpro gcpro1
;
9586 int count
= SPECPDL_INDEX ();
9589 CHECK_STRING (prompt
);
9592 specbind (Qinput_method_exit_on_first_char
,
9593 (NILP (command_loop
) ? Qt
: Qnil
));
9594 specbind (Qinput_method_use_echo_area
,
9595 (NILP (command_loop
) ? Qt
: Qnil
));
9597 bzero (keybuf
, sizeof keybuf
);
9599 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9601 if (NILP (continue_echo
))
9603 this_command_key_count
= 0;
9604 this_command_key_count_reset
= 0;
9605 this_single_command_key_start
= 0;
9608 #ifdef HAVE_X_WINDOWS
9609 if (display_hourglass_p
)
9610 cancel_hourglass ();
9613 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9614 prompt
, ! NILP (dont_downcase_last
),
9615 ! NILP (can_return_switch_frame
), 0);
9617 #ifdef HAVE_X_WINDOWS
9618 if (display_hourglass_p
)
9628 return unbind_to (count
, Fvector (i
, keybuf
));
9631 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9632 doc
: /* Execute CMD as an editor command.
9633 CMD must be a symbol that satisfies the `commandp' predicate.
9634 Optional second arg RECORD-FLAG non-nil
9635 means unconditionally put this command in `command-history'.
9636 Otherwise, that is done only if an arg is read using the minibuffer.
9637 The argument KEYS specifies the value to use instead of (this-command-keys)
9638 when reading the arguments; if it is nil, (this-command-keys) is used.
9639 The argument SPECIAL, if non-nil, means that this command is executing
9640 a special event, so ignore the prefix argument and don't clear it. */)
9641 (cmd
, record_flag
, keys
, special
)
9642 Lisp_Object cmd
, record_flag
, keys
, special
;
9644 register Lisp_Object final
;
9645 register Lisp_Object tem
;
9646 Lisp_Object prefixarg
;
9647 struct backtrace backtrace
;
9648 extern int debug_on_next_call
;
9650 debug_on_next_call
= 0;
9654 prefixarg
= current_kboard
->Vprefix_arg
;
9655 Vcurrent_prefix_arg
= prefixarg
;
9656 current_kboard
->Vprefix_arg
= Qnil
;
9663 tem
= Fget (cmd
, Qdisabled
);
9664 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9666 tem
= Fsymbol_value (Qdisabled_command_function
);
9668 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9674 final
= Findirect_function (cmd
);
9676 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9678 struct gcpro gcpro1
, gcpro2
;
9680 GCPRO2 (cmd
, prefixarg
);
9681 do_autoload (final
, cmd
);
9688 if (STRINGP (final
) || VECTORP (final
))
9690 /* If requested, place the macro in the command history. For
9691 other sorts of commands, call-interactively takes care of
9693 if (!NILP (record_flag
))
9696 = Fcons (Fcons (Qexecute_kbd_macro
,
9697 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9700 /* Don't keep command history around forever. */
9701 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9703 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9705 XSETCDR (tem
, Qnil
);
9709 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9712 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9714 backtrace
.next
= backtrace_list
;
9715 backtrace_list
= &backtrace
;
9716 backtrace
.function
= &Qcall_interactively
;
9717 backtrace
.args
= &cmd
;
9718 backtrace
.nargs
= 1;
9719 backtrace
.evalargs
= 0;
9720 backtrace
.debug_on_exit
= 0;
9722 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9724 backtrace_list
= backtrace
.next
;
9732 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9734 doc
: /* Read function name, then read its arguments and call it. */)
9736 Lisp_Object prefixarg
;
9738 Lisp_Object function
;
9740 int saved_last_point_position
;
9741 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9742 Lisp_Object bindings
, value
;
9743 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9745 saved_keys
= Fvector (this_command_key_count
,
9746 XVECTOR (this_command_keys
)->contents
);
9747 saved_last_point_position_buffer
= last_point_position_buffer
;
9748 saved_last_point_position
= last_point_position
;
9750 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9752 if (EQ (prefixarg
, Qminus
))
9754 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9755 strcpy (buf
, "C-u ");
9756 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9757 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9758 else if (INTEGERP (prefixarg
))
9759 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9761 /* This isn't strictly correct if execute-extended-command
9762 is bound to anything else. Perhaps it should use
9763 this_command_keys? */
9764 strcat (buf
, "M-x ");
9766 /* Prompt with buf, and then read a string, completing from and
9767 restricting to the set of all defined commands. Don't provide
9768 any initial input. Save the command read on the extended-command
9770 function
= Fcompleting_read (build_string (buf
),
9771 Vobarray
, Qcommandp
,
9772 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9775 if (STRINGP (function
) && SCHARS (function
) == 0)
9776 error ("No command name given");
9778 /* Set this_command_keys to the concatenation of saved_keys and
9779 function, followed by a RET. */
9784 this_command_key_count
= 0;
9785 this_command_key_count_reset
= 0;
9786 this_single_command_key_start
= 0;
9788 keys
= XVECTOR (saved_keys
)->contents
;
9789 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9790 add_command_key (keys
[i
]);
9792 for (i
= 0; i
< SCHARS (function
); i
++)
9793 add_command_key (Faref (function
, make_number (i
)));
9795 add_command_key (make_number ('\015'));
9798 last_point_position
= saved_last_point_position
;
9799 last_point_position_buffer
= saved_last_point_position_buffer
;
9803 function
= Fintern (function
, Qnil
);
9804 current_kboard
->Vprefix_arg
= prefixarg
;
9805 Vthis_command
= function
;
9806 real_this_command
= function
;
9808 /* If enabled, show which key runs this command. */
9809 if (!NILP (Vsuggest_key_bindings
)
9810 && NILP (Vexecuting_macro
)
9811 && SYMBOLP (function
))
9812 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9818 GCPRO2 (bindings
, value
);
9819 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9821 /* If the command has a key binding, print it now. */
9822 if (!NILP (bindings
)
9823 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9826 /* But first wait, and skip the message if there is input. */
9828 if (!NILP (echo_area_buffer
[0]))
9829 /* This command displayed something in the echo area;
9830 so wait a few seconds, then display our suggestion message. */
9831 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9832 ? XINT (Vsuggest_key_bindings
) : 2);
9834 /* This command left the echo area empty,
9835 so display our message immediately. */
9838 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9839 && ! CONSP (Vunread_command_events
))
9841 Lisp_Object binding
;
9843 int message_p
= push_message ();
9844 int count
= SPECPDL_INDEX ();
9846 record_unwind_protect (pop_message_unwind
, Qnil
);
9847 binding
= Fkey_description (bindings
, Qnil
);
9850 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9853 sprintf (newmessage
, "You can run the command `%s' with %s",
9854 SDATA (SYMBOL_NAME (function
)),
9856 message2_nolog (newmessage
,
9857 strlen (newmessage
),
9858 STRING_MULTIBYTE (binding
));
9859 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9860 ? Vsuggest_key_bindings
: make_number (2)),
9865 unbind_to (count
, Qnil
);
9869 RETURN_UNGCPRO (value
);
9873 /* Return nonzero if input events are pending. */
9876 detect_input_pending ()
9879 get_input_pending (&input_pending
, 0);
9881 return input_pending
;
9884 /* Return nonzero if input events are pending, and run any pending timers. */
9887 detect_input_pending_run_timers (do_display
)
9890 int old_timers_run
= timers_run
;
9893 get_input_pending (&input_pending
, 1);
9895 if (old_timers_run
!= timers_run
&& do_display
)
9897 redisplay_preserve_echo_area (8);
9898 /* The following fixes a bug when using lazy-lock with
9899 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9900 from an idle timer function. The symptom of the bug is that
9901 the cursor sometimes doesn't become visible until the next X
9902 event is processed. --gerd. */
9904 rif
->flush_display (NULL
);
9907 return input_pending
;
9910 /* This is called in some cases before a possible quit.
9911 It cases the next call to detect_input_pending to recompute input_pending.
9912 So calling this function unnecessarily can't do any harm. */
9915 clear_input_pending ()
9920 /* Return nonzero if there are pending requeued events.
9921 This isn't used yet. The hope is to make wait_reading_process_output
9922 call it, and return if it runs Lisp code that unreads something.
9923 The problem is, kbd_buffer_get_event needs to be fixed to know what
9924 to do in that case. It isn't trivial. */
9927 requeued_events_pending_p ()
9929 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9933 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9934 doc
: /* Return t if command input is currently available with no wait.
9935 Actually, the value is nil only if we can be sure that no input is available;
9936 if there is a doubt, the value is t. */)
9939 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9942 get_filtered_input_pending (&input_pending
, 1, 1);
9943 return input_pending
> 0 ? Qt
: Qnil
;
9946 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9947 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9950 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9953 if (total_keys
< NUM_RECENT_KEYS
)
9954 return Fvector (total_keys
, keys
);
9957 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9958 bcopy (keys
+ recent_keys_index
,
9959 XVECTOR (val
)->contents
,
9960 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9962 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9963 recent_keys_index
* sizeof (Lisp_Object
));
9968 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9969 doc
: /* Return the key sequence that invoked this command.
9970 However, if the command has called `read-key-sequence', it returns
9971 the last key sequence that has been read.
9972 The value is a string or a vector. */)
9975 return make_event_array (this_command_key_count
,
9976 XVECTOR (this_command_keys
)->contents
);
9979 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9980 doc
: /* Return the key sequence that invoked this command, as a vector.
9981 However, if the command has called `read-key-sequence', it returns
9982 the last key sequence that has been read. */)
9985 return Fvector (this_command_key_count
,
9986 XVECTOR (this_command_keys
)->contents
);
9989 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9990 Sthis_single_command_keys
, 0, 0, 0,
9991 doc
: /* Return the key sequence that invoked this command.
9992 More generally, it returns the last key sequence read, either by
9993 the command loop or by `read-key-sequence'.
9994 Unlike `this-command-keys', this function's value
9995 does not include prefix arguments.
9996 The value is always a vector. */)
9999 return Fvector (this_command_key_count
10000 - this_single_command_key_start
,
10001 (XVECTOR (this_command_keys
)->contents
10002 + this_single_command_key_start
));
10005 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10006 Sthis_single_command_raw_keys
, 0, 0, 0,
10007 doc
: /* Return the raw events that were read for this command.
10008 More generally, it returns the last key sequence read, either by
10009 the command loop or by `read-key-sequence'.
10010 Unlike `this-single-command-keys', this function's value
10011 shows the events before all translations (except for input methods).
10012 The value is always a vector. */)
10015 return Fvector (raw_keybuf_count
,
10016 (XVECTOR (raw_keybuf
)->contents
));
10019 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10020 Sreset_this_command_lengths
, 0, 0, 0,
10021 doc
: /* Make the unread events replace the last command and echo.
10022 Used in `universal-argument-other-key'.
10024 `universal-argument-other-key' rereads the event just typed.
10025 It then gets translated through `function-key-map'.
10026 The translated event has to replace the real events,
10027 both in the value of (this-command-keys) and in echoing.
10028 To achieve this, `universal-argument-other-key' calls
10029 `reset-this-command-lengths', which discards the record of reading
10030 these events the first time. */)
10033 this_command_key_count
= before_command_key_count
;
10034 if (this_command_key_count
< this_single_command_key_start
)
10035 this_single_command_key_start
= this_command_key_count
;
10037 echo_truncate (before_command_echo_length
);
10039 /* Cause whatever we put into unread-command-events
10040 to echo as if it were being freshly read from the keyboard. */
10041 this_command_key_count_reset
= 1;
10046 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10047 Sclear_this_command_keys
, 0, 1, 0,
10048 doc
: /* Clear out the vector that `this-command-keys' returns.
10049 Also clear the record of the last 100 events, unless optional arg
10050 KEEP-RECORD is non-nil. */)
10052 Lisp_Object keep_record
;
10056 this_command_key_count
= 0;
10057 this_command_key_count_reset
= 0;
10059 if (NILP (keep_record
))
10061 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10062 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10064 recent_keys_index
= 0;
10069 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10070 doc
: /* Return the current depth in recursive edits. */)
10074 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10078 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10079 "FOpen dribble file: ",
10080 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10081 If FILE is nil, close any open dribble file. */)
10092 file
= Fexpand_file_name (file
, Qnil
);
10093 dribble
= fopen (SDATA (file
), "w");
10095 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10100 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10101 doc
: /* Discard the contents of the terminal input buffer.
10102 Also end any kbd macro being defined. */)
10105 if (!NILP (current_kboard
->defining_kbd_macro
))
10107 /* Discard the last command from the macro. */
10108 Fcancel_kbd_macro_events ();
10112 update_mode_lines
++;
10114 Vunread_command_events
= Qnil
;
10115 unread_command_char
= -1;
10117 discard_tty_input ();
10119 kbd_fetch_ptr
= kbd_store_ptr
;
10125 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10126 doc
: /* Stop Emacs and return to superior process. You can resume later.
10127 If `cannot-suspend' is non-nil, or if the system doesn't support job
10128 control, run a subshell instead.
10130 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10131 to be read as terminal input by Emacs's parent, after suspension.
10133 Before suspending, run the normal hook `suspend-hook'.
10134 After resumption run the normal hook `suspend-resume-hook'.
10136 Some operating systems cannot stop the Emacs process and resume it later.
10137 On such systems, Emacs starts a subshell instead of suspending. */)
10139 Lisp_Object stuffstring
;
10141 int count
= SPECPDL_INDEX ();
10142 int old_height
, old_width
;
10144 struct gcpro gcpro1
;
10146 if (!NILP (stuffstring
))
10147 CHECK_STRING (stuffstring
);
10149 /* Run the functions in suspend-hook. */
10150 if (!NILP (Vrun_hooks
))
10151 call1 (Vrun_hooks
, intern ("suspend-hook"));
10153 GCPRO1 (stuffstring
);
10154 get_frame_size (&old_width
, &old_height
);
10155 reset_sys_modes ();
10156 /* sys_suspend can get an error if it tries to fork a subshell
10157 and the system resources aren't available for that. */
10158 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10160 stuff_buffered_input (stuffstring
);
10161 if (cannot_suspend
)
10165 unbind_to (count
, Qnil
);
10167 /* Check if terminal/window size has changed.
10168 Note that this is not useful when we are running directly
10169 with a window system; but suspend should be disabled in that case. */
10170 get_frame_size (&width
, &height
);
10171 if (width
!= old_width
|| height
!= old_height
)
10172 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10174 /* Run suspend-resume-hook. */
10175 if (!NILP (Vrun_hooks
))
10176 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10182 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10183 Then in any case stuff anything Emacs has read ahead and not used. */
10186 stuff_buffered_input (stuffstring
)
10187 Lisp_Object stuffstring
;
10189 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10190 register unsigned char *p
;
10192 if (STRINGP (stuffstring
))
10194 register int count
;
10196 p
= SDATA (stuffstring
);
10197 count
= SBYTES (stuffstring
);
10198 while (count
-- > 0)
10203 /* Anything we have read ahead, put back for the shell to read. */
10204 /* ?? What should this do when we have multiple keyboards??
10205 Should we ignore anything that was typed in at the "wrong" kboard?
10207 rms: we should stuff everything back into the kboard
10209 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10212 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10213 kbd_fetch_ptr
= kbd_buffer
;
10214 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10215 stuff_char (kbd_fetch_ptr
->code
);
10217 clear_event (kbd_fetch_ptr
);
10221 #endif /* SIGTSTP */
10225 set_waiting_for_input (time_to_clear
)
10226 EMACS_TIME
*time_to_clear
;
10228 input_available_clear_time
= time_to_clear
;
10230 /* Tell interrupt_signal to throw back to read_char, */
10231 waiting_for_input
= 1;
10233 /* If interrupt_signal was called before and buffered a C-g,
10234 make it run again now, to avoid timing error. */
10235 if (!NILP (Vquit_flag
))
10236 quit_throw_to_read_char ();
10240 clear_waiting_for_input ()
10242 /* Tell interrupt_signal not to throw back to read_char, */
10243 waiting_for_input
= 0;
10244 input_available_clear_time
= 0;
10247 /* This routine is called at interrupt level in response to C-g.
10249 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10250 is called from kbd_buffer_store_event, in handling SIGIO or
10253 If `waiting_for_input' is non zero, then unless `echoing' is
10254 nonzero, immediately throw back to read_char.
10256 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10257 eval to throw, when it gets a chance. If quit-flag is already
10258 non-nil, it stops the job right away. */
10261 interrupt_signal (signalnum
) /* If we don't have an argument, */
10262 int signalnum
; /* some compilers complain in signal calls. */
10265 /* Must preserve main program's value of errno. */
10266 int old_errno
= errno
;
10267 struct frame
*sf
= SELECTED_FRAME ();
10269 #if defined (USG) && !defined (POSIX_SIGNALS)
10270 if (!read_socket_hook
&& NILP (Vwindow_system
))
10272 /* USG systems forget handlers when they are used;
10273 must reestablish each time */
10274 signal (SIGINT
, interrupt_signal
);
10275 signal (SIGQUIT
, interrupt_signal
);
10281 if (!NILP (Vquit_flag
)
10282 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10284 /* If SIGINT isn't blocked, don't let us be interrupted by
10285 another SIGINT, it might be harmful due to non-reentrancy
10286 in I/O functions. */
10287 sigblock (sigmask (SIGINT
));
10290 reset_sys_modes ();
10292 #ifdef SIGTSTP /* Support possible in later USG versions */
10294 * On systems which can suspend the current process and return to the original
10295 * shell, this command causes the user to end up back at the shell.
10296 * The "Auto-save" and "Abort" questions are not asked until
10297 * the user elects to return to emacs, at which point he can save the current
10298 * job and either dump core or continue.
10303 if (sys_suspend () == -1)
10305 printf ("Not running as a subprocess;\n");
10306 printf ("you can continue or abort.\n");
10308 #else /* not VMS */
10309 /* Perhaps should really fork an inferior shell?
10310 But that would not provide any way to get back
10311 to the original shell, ever. */
10312 printf ("No support for stopping a process on this operating system;\n");
10313 printf ("you can continue or abort.\n");
10314 #endif /* not VMS */
10315 #endif /* not SIGTSTP */
10317 /* We must remain inside the screen area when the internal terminal
10318 is used. Note that [Enter] is not echoed by dos. */
10321 /* It doesn't work to autosave while GC is in progress;
10322 the code used for auto-saving doesn't cope with the mark bit. */
10323 if (!gc_in_progress
)
10325 printf ("Auto-save? (y or n) ");
10327 if (((c
= getchar ()) & ~040) == 'Y')
10329 Fdo_auto_save (Qt
, Qnil
);
10331 printf ("\r\nAuto-save done");
10332 #else /* not MSDOS */
10333 printf ("Auto-save done\n");
10334 #endif /* not MSDOS */
10336 while (c
!= '\n') c
= getchar ();
10340 /* During GC, it must be safe to reenable quitting again. */
10341 Vinhibit_quit
= Qnil
;
10344 #endif /* not MSDOS */
10345 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10346 printf ("but will instead do a real quit after garbage collection ends\r\n");
10351 printf ("\r\nAbort? (y or n) ");
10352 #else /* not MSDOS */
10354 printf ("Abort (and enter debugger)? (y or n) ");
10355 #else /* not VMS */
10356 printf ("Abort (and dump core)? (y or n) ");
10357 #endif /* not VMS */
10358 #endif /* not MSDOS */
10360 if (((c
= getchar ()) & ~040) == 'Y')
10362 while (c
!= '\n') c
= getchar ();
10364 printf ("\r\nContinuing...\r\n");
10365 #else /* not MSDOS */
10366 printf ("Continuing...\n");
10367 #endif /* not MSDOS */
10374 /* If executing a function that wants to be interrupted out of
10375 and the user has not deferred quitting by binding `inhibit-quit'
10376 then quit right away. */
10377 if (immediate_quit
&& NILP (Vinhibit_quit
))
10379 struct gl_state_s saved
;
10380 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10382 immediate_quit
= 0;
10385 GCPRO4 (saved
.object
, saved
.global_code
,
10386 saved
.current_syntax_table
, saved
.old_prop
);
10387 Fsignal (Qquit
, Qnil
);
10392 /* Else request quit when it's safe */
10396 if (waiting_for_input
&& !echoing
)
10397 quit_throw_to_read_char ();
10402 /* Handle a C-g by making read_char return C-g. */
10405 quit_throw_to_read_char ()
10408 /* Prevent another signal from doing this before we finish. */
10409 clear_waiting_for_input ();
10412 Vunread_command_events
= Qnil
;
10413 unread_command_char
= -1;
10415 #if 0 /* Currently, sit_for is called from read_char without turning
10416 off polling. And that can call set_waiting_for_input.
10417 It seems to be harmless. */
10418 #ifdef POLL_FOR_INPUT
10419 /* May be > 1 if in recursive minibuffer. */
10420 if (poll_suppress_count
== 0)
10424 if (FRAMEP (internal_last_event_frame
)
10425 && !EQ (internal_last_event_frame
, selected_frame
))
10426 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10429 _longjmp (getcjmp
, 1);
10432 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10433 doc
: /* Set mode of reading keyboard input.
10434 First arg INTERRUPT non-nil means use input interrupts;
10435 nil means use CBREAK mode.
10436 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10437 (no effect except in CBREAK mode).
10438 Third arg META t means accept 8-bit input (for a Meta key).
10439 META nil means ignore the top bit, on the assumption it is parity.
10440 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10441 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10442 See also `current-input-mode'. */)
10443 (interrupt
, flow
, meta
, quit
)
10444 Lisp_Object interrupt
, flow
, meta
, quit
;
10447 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10448 error ("set-input-mode: QUIT must be an ASCII character");
10450 #ifdef POLL_FOR_INPUT
10455 /* this causes startup screen to be restored and messes with the mouse */
10456 reset_sys_modes ();
10460 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10461 if (read_socket_hook
)
10463 /* When using X, don't give the user a real choice,
10464 because we haven't implemented the mechanisms to support it. */
10465 #ifdef NO_SOCK_SIGIO
10466 interrupt_input
= 0;
10467 #else /* not NO_SOCK_SIGIO */
10468 interrupt_input
= 1;
10469 #endif /* NO_SOCK_SIGIO */
10472 interrupt_input
= !NILP (interrupt
);
10473 #else /* not SIGIO */
10474 interrupt_input
= 0;
10475 #endif /* not SIGIO */
10477 /* Our VMS input only works by interrupts, as of now. */
10479 interrupt_input
= 1;
10482 flow_control
= !NILP (flow
);
10485 else if (EQ (meta
, Qt
))
10490 /* Don't let this value be out of range. */
10491 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10497 #ifdef POLL_FOR_INPUT
10498 poll_suppress_count
= 1;
10504 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10505 doc
: /* Return information about the way Emacs currently reads keyboard input.
10506 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10507 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10508 nil, Emacs is using CBREAK mode.
10509 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10510 terminal; this does not apply if Emacs uses interrupt-driven input.
10511 META is t if accepting 8-bit input with 8th bit as Meta flag.
10512 META nil means ignoring the top bit, on the assumption it is parity.
10513 META is neither t nor nil if accepting 8-bit input and using
10514 all 8 bits as the character code.
10515 QUIT is the character Emacs currently uses to quit.
10516 The elements of this list correspond to the arguments of
10517 `set-input-mode'. */)
10520 Lisp_Object val
[4];
10522 val
[0] = interrupt_input
? Qt
: Qnil
;
10523 val
[1] = flow_control
? Qt
: Qnil
;
10524 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10525 XSETFASTINT (val
[3], quit_char
);
10527 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10530 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 3, 0,
10531 doc
: /* Return position information for pixel coordinates X and Y.
10532 By default, X and Y are relative to text area of the selected window.
10533 Optional third arg FRAME_OR_WINDOW non-nil specifies frame or window.
10535 The return value is similar to a mouse click position:
10536 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10537 IMAGE (DX . DY) (WIDTH . HEIGHT))
10538 The `posn-' functions access elements of such lists. */)
10539 (x
, y
, frame_or_window
)
10540 Lisp_Object x
, y
, frame_or_window
;
10542 if (NILP (frame_or_window
))
10543 frame_or_window
= selected_window
;
10545 if (WINDOWP (frame_or_window
))
10549 CHECK_LIVE_WINDOW (frame_or_window
);
10551 w
= XWINDOW (frame_or_window
);
10552 XSETINT (x
, (WINDOW_TO_FRAME_PIXEL_X (w
, XINT (x
))
10553 + window_box_left_offset (w
, TEXT_AREA
)));
10554 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10555 frame_or_window
= w
->frame
;
10558 CHECK_LIVE_FRAME (frame_or_window
);
10560 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10563 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10564 doc
: /* Return position information for buffer POS in WINDOW.
10565 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10567 Return nil if position is not visible in window. Otherwise,
10568 the return value is similar to that returned by `event-start' for
10569 a mouse click at the upper left corner of the glyph corresponding
10570 to the given buffer position:
10571 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10572 IMAGE (DX . DY) (WIDTH . HEIGHT))
10573 The `posn-' functions access elements of such lists. */*/
)
10575 Lisp_Object pos
, window
;
10579 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10581 tem
= Fposn_at_x_y (XCAR (tem
), XCAR (XCDR (tem
)), window
);
10587 * Set up a new kboard object with reasonable initial values.
10593 kb
->Voverriding_terminal_local_map
= Qnil
;
10594 kb
->Vlast_command
= Qnil
;
10595 kb
->Vreal_last_command
= Qnil
;
10596 kb
->Vprefix_arg
= Qnil
;
10597 kb
->Vlast_prefix_arg
= Qnil
;
10598 kb
->kbd_queue
= Qnil
;
10599 kb
->kbd_queue_has_data
= 0;
10600 kb
->immediate_echo
= 0;
10601 kb
->echo_string
= Qnil
;
10602 kb
->echo_after_prompt
= -1;
10603 kb
->kbd_macro_buffer
= 0;
10604 kb
->kbd_macro_bufsize
= 0;
10605 kb
->defining_kbd_macro
= Qnil
;
10606 kb
->Vlast_kbd_macro
= Qnil
;
10607 kb
->reference_count
= 0;
10608 kb
->Vsystem_key_alist
= Qnil
;
10609 kb
->system_key_syms
= Qnil
;
10610 kb
->Vdefault_minibuffer_frame
= Qnil
;
10614 * Destroy the contents of a kboard object, but not the object itself.
10615 * We use this just before deleting it, or if we're going to initialize
10616 * it a second time.
10622 if (kb
->kbd_macro_buffer
)
10623 xfree (kb
->kbd_macro_buffer
);
10626 #ifdef MULTI_KBOARD
10628 /* Free KB and memory referenced from it. */
10636 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10639 *kbp
= kb
->next_kboard
;
10641 /* Prevent a dangling reference to KB. */
10642 if (kb
== current_kboard
10643 && FRAMEP (selected_frame
)
10644 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10646 current_kboard
= XFRAME (selected_frame
)->kboard
;
10647 if (current_kboard
== kb
)
10655 #endif /* MULTI_KBOARD */
10660 /* This is correct before outermost invocation of the editor loop */
10661 command_loop_level
= -1;
10662 immediate_quit
= 0;
10663 quit_char
= Ctl ('g');
10664 Vunread_command_events
= Qnil
;
10665 unread_command_char
= -1;
10666 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10668 recent_keys_index
= 0;
10669 kbd_fetch_ptr
= kbd_buffer
;
10670 kbd_store_ptr
= kbd_buffer
;
10672 do_mouse_tracking
= Qnil
;
10676 /* This means that command_loop_1 won't try to select anything the first
10678 internal_last_event_frame
= Qnil
;
10679 Vlast_event_frame
= internal_last_event_frame
;
10681 #ifdef MULTI_KBOARD
10682 current_kboard
= initial_kboard
;
10684 wipe_kboard (current_kboard
);
10685 init_kboard (current_kboard
);
10687 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10689 signal (SIGINT
, interrupt_signal
);
10690 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10691 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10692 SIGQUIT and we can't tell which one it will give us. */
10693 signal (SIGQUIT
, interrupt_signal
);
10694 #endif /* HAVE_TERMIO */
10696 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10698 if (!noninteractive
)
10699 signal (SIGIO
, input_available_signal
);
10702 /* Use interrupt input by default, if it works and noninterrupt input
10703 has deficiencies. */
10705 #ifdef INTERRUPT_INPUT
10706 interrupt_input
= 1;
10708 interrupt_input
= 0;
10711 /* Our VMS input only works by interrupts, as of now. */
10713 interrupt_input
= 1;
10719 if (keyboard_init_hook
)
10720 (*keyboard_init_hook
) ();
10722 #ifdef POLL_FOR_INPUT
10723 poll_suppress_count
= 1;
10728 /* At least provide an escape route since C-g doesn't work. */
10729 signal (SIGINT
, interrupt_signal
);
10733 /* This type's only use is in syms_of_keyboard, to initialize the
10734 event header symbols and put properties on them. */
10735 struct event_head
{
10741 struct event_head head_table
[] = {
10742 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10743 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10744 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10745 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10746 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10747 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10748 /* `select-window' should be handled just like `switch-frame'
10749 in read_key_sequence. */
10750 {&Qselect_window
, "select-window", &Qswitch_frame
}
10754 syms_of_keyboard ()
10756 Vpre_help_message
= Qnil
;
10757 staticpro (&Vpre_help_message
);
10759 Vlispy_mouse_stem
= build_string ("mouse");
10760 staticpro (&Vlispy_mouse_stem
);
10763 QCimage
= intern (":image");
10764 staticpro (&QCimage
);
10766 staticpro (&Qhelp_echo
);
10767 Qhelp_echo
= intern ("help-echo");
10769 staticpro (&item_properties
);
10770 item_properties
= Qnil
;
10772 staticpro (&tool_bar_item_properties
);
10773 tool_bar_item_properties
= Qnil
;
10774 staticpro (&tool_bar_items_vector
);
10775 tool_bar_items_vector
= Qnil
;
10777 staticpro (&real_this_command
);
10778 real_this_command
= Qnil
;
10780 Qtimer_event_handler
= intern ("timer-event-handler");
10781 staticpro (&Qtimer_event_handler
);
10783 Qdisabled_command_function
= intern ("disabled-command-function");
10784 staticpro (&Qdisabled_command_function
);
10786 Qself_insert_command
= intern ("self-insert-command");
10787 staticpro (&Qself_insert_command
);
10789 Qforward_char
= intern ("forward-char");
10790 staticpro (&Qforward_char
);
10792 Qbackward_char
= intern ("backward-char");
10793 staticpro (&Qbackward_char
);
10795 Qdisabled
= intern ("disabled");
10796 staticpro (&Qdisabled
);
10798 Qundefined
= intern ("undefined");
10799 staticpro (&Qundefined
);
10801 Qpre_command_hook
= intern ("pre-command-hook");
10802 staticpro (&Qpre_command_hook
);
10804 Qpost_command_hook
= intern ("post-command-hook");
10805 staticpro (&Qpost_command_hook
);
10807 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10808 staticpro (&Qpost_command_idle_hook
);
10810 Qdeferred_action_function
= intern ("deferred-action-function");
10811 staticpro (&Qdeferred_action_function
);
10813 Qcommand_hook_internal
= intern ("command-hook-internal");
10814 staticpro (&Qcommand_hook_internal
);
10816 Qfunction_key
= intern ("function-key");
10817 staticpro (&Qfunction_key
);
10818 Qmouse_click
= intern ("mouse-click");
10819 staticpro (&Qmouse_click
);
10821 Qlanguage_change
= intern ("language-change");
10822 staticpro (&Qlanguage_change
);
10824 Qdrag_n_drop
= intern ("drag-n-drop");
10825 staticpro (&Qdrag_n_drop
);
10827 Qsave_session
= intern ("save-session");
10828 staticpro(&Qsave_session
);
10830 Qusr1_signal
= intern ("usr1-signal");
10831 staticpro (&Qusr1_signal
);
10832 Qusr2_signal
= intern ("usr2-signal");
10833 staticpro (&Qusr2_signal
);
10835 Qmenu_enable
= intern ("menu-enable");
10836 staticpro (&Qmenu_enable
);
10837 Qmenu_alias
= intern ("menu-alias");
10838 staticpro (&Qmenu_alias
);
10839 QCenable
= intern (":enable");
10840 staticpro (&QCenable
);
10841 QCvisible
= intern (":visible");
10842 staticpro (&QCvisible
);
10843 QChelp
= intern (":help");
10844 staticpro (&QChelp
);
10845 QCfilter
= intern (":filter");
10846 staticpro (&QCfilter
);
10847 QCbutton
= intern (":button");
10848 staticpro (&QCbutton
);
10849 QCkeys
= intern (":keys");
10850 staticpro (&QCkeys
);
10851 QCkey_sequence
= intern (":key-sequence");
10852 staticpro (&QCkey_sequence
);
10853 QCtoggle
= intern (":toggle");
10854 staticpro (&QCtoggle
);
10855 QCradio
= intern (":radio");
10856 staticpro (&QCradio
);
10858 Qmode_line
= intern ("mode-line");
10859 staticpro (&Qmode_line
);
10860 Qvertical_line
= intern ("vertical-line");
10861 staticpro (&Qvertical_line
);
10862 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10863 staticpro (&Qvertical_scroll_bar
);
10864 Qmenu_bar
= intern ("menu-bar");
10865 staticpro (&Qmenu_bar
);
10867 Qabove_handle
= intern ("above-handle");
10868 staticpro (&Qabove_handle
);
10869 Qhandle
= intern ("handle");
10870 staticpro (&Qhandle
);
10871 Qbelow_handle
= intern ("below-handle");
10872 staticpro (&Qbelow_handle
);
10873 Qup
= intern ("up");
10875 Qdown
= intern ("down");
10876 staticpro (&Qdown
);
10877 Qtop
= intern ("top");
10879 Qbottom
= intern ("bottom");
10880 staticpro (&Qbottom
);
10881 Qend_scroll
= intern ("end-scroll");
10882 staticpro (&Qend_scroll
);
10883 Qratio
= intern ("ratio");
10884 staticpro (&Qratio
);
10886 Qevent_kind
= intern ("event-kind");
10887 staticpro (&Qevent_kind
);
10888 Qevent_symbol_elements
= intern ("event-symbol-elements");
10889 staticpro (&Qevent_symbol_elements
);
10890 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10891 staticpro (&Qevent_symbol_element_mask
);
10892 Qmodifier_cache
= intern ("modifier-cache");
10893 staticpro (&Qmodifier_cache
);
10895 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10896 staticpro (&Qrecompute_lucid_menubar
);
10897 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10898 staticpro (&Qactivate_menubar_hook
);
10900 Qpolling_period
= intern ("polling-period");
10901 staticpro (&Qpolling_period
);
10903 Qinput_method_function
= intern ("input-method-function");
10904 staticpro (&Qinput_method_function
);
10906 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10907 staticpro (&Qinput_method_exit_on_first_char
);
10908 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10909 staticpro (&Qinput_method_use_echo_area
);
10911 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10912 Fset (Qinput_method_use_echo_area
, Qnil
);
10914 last_point_position_buffer
= Qnil
;
10917 struct event_head
*p
;
10919 for (p
= head_table
;
10920 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10923 *p
->var
= intern (p
->name
);
10924 staticpro (p
->var
);
10925 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10926 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10930 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10931 staticpro (&button_down_location
);
10932 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10933 staticpro (&mouse_syms
);
10934 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
10935 staticpro (&wheel_syms
);
10939 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10941 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10942 for (i
= 0; i
< len
; i
++)
10943 if (modifier_names
[i
])
10944 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10945 staticpro (&modifier_symbols
);
10948 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10949 staticpro (&recent_keys
);
10951 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10952 staticpro (&this_command_keys
);
10954 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10955 staticpro (&raw_keybuf
);
10957 Qextended_command_history
= intern ("extended-command-history");
10958 Fset (Qextended_command_history
, Qnil
);
10959 staticpro (&Qextended_command_history
);
10961 accent_key_syms
= Qnil
;
10962 staticpro (&accent_key_syms
);
10964 func_key_syms
= Qnil
;
10965 staticpro (&func_key_syms
);
10967 drag_n_drop_syms
= Qnil
;
10968 staticpro (&drag_n_drop_syms
);
10970 unread_switch_frame
= Qnil
;
10971 staticpro (&unread_switch_frame
);
10973 internal_last_event_frame
= Qnil
;
10974 staticpro (&internal_last_event_frame
);
10976 read_key_sequence_cmd
= Qnil
;
10977 staticpro (&read_key_sequence_cmd
);
10979 menu_bar_one_keymap_changed_items
= Qnil
;
10980 staticpro (&menu_bar_one_keymap_changed_items
);
10982 defsubr (&Sevent_convert_list
);
10983 defsubr (&Sread_key_sequence
);
10984 defsubr (&Sread_key_sequence_vector
);
10985 defsubr (&Srecursive_edit
);
10987 defsubr (&Strack_mouse
);
10989 defsubr (&Sinput_pending_p
);
10990 defsubr (&Scommand_execute
);
10991 defsubr (&Srecent_keys
);
10992 defsubr (&Sthis_command_keys
);
10993 defsubr (&Sthis_command_keys_vector
);
10994 defsubr (&Sthis_single_command_keys
);
10995 defsubr (&Sthis_single_command_raw_keys
);
10996 defsubr (&Sreset_this_command_lengths
);
10997 defsubr (&Sclear_this_command_keys
);
10998 defsubr (&Ssuspend_emacs
);
10999 defsubr (&Sabort_recursive_edit
);
11000 defsubr (&Sexit_recursive_edit
);
11001 defsubr (&Srecursion_depth
);
11002 defsubr (&Stop_level
);
11003 defsubr (&Sdiscard_input
);
11004 defsubr (&Sopen_dribble_file
);
11005 defsubr (&Sset_input_mode
);
11006 defsubr (&Scurrent_input_mode
);
11007 defsubr (&Sexecute_extended_command
);
11008 defsubr (&Sposn_at_point
);
11009 defsubr (&Sposn_at_x_y
);
11011 DEFVAR_LISP ("last-command-char", &last_command_char
,
11012 doc
: /* Last input event that was part of a command. */);
11014 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11015 doc
: /* Last input event that was part of a command. */);
11017 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11018 doc
: /* Last input event in a command, except for mouse menu events.
11019 Mouse menus give back keys that don't look like mouse events;
11020 this variable holds the actual mouse event that led to the menu,
11021 so that you can determine whether the command was run by mouse or not. */);
11023 DEFVAR_LISP ("last-input-char", &last_input_char
,
11024 doc
: /* Last input event. */);
11026 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11027 doc
: /* Last input event. */);
11029 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11030 doc
: /* List of events to be read as the command input.
11031 These events are processed first, before actual keyboard input. */);
11032 Vunread_command_events
= Qnil
;
11034 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11035 doc
: /* If not -1, an object to be read as next command input event. */);
11037 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11038 doc
: /* List of events to be processed as input by input methods.
11039 These events are processed after `unread-command-events', but
11040 before actual keyboard input. */);
11041 Vunread_post_input_method_events
= Qnil
;
11043 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11044 doc
: /* List of events to be processed as input by input methods.
11045 These events are processed after `unread-command-events', but
11046 before actual keyboard input. */);
11047 Vunread_input_method_events
= Qnil
;
11049 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11050 doc
: /* Meta-prefix character code.
11051 Meta-foo as command input turns into this character followed by foo. */);
11052 XSETINT (meta_prefix_char
, 033);
11054 DEFVAR_KBOARD ("last-command", Vlast_command
,
11055 doc
: /* The last command executed.
11056 Normally a symbol with a function definition, but can be whatever was found
11057 in the keymap, or whatever the variable `this-command' was set to by that
11060 The value `mode-exit' is special; it means that the previous command
11061 read an event that told it to exit, and it did so and unread that event.
11062 In other words, the present command is the event that made the previous
11065 The value `kill-region' is special; it means that the previous command
11066 was a kill command. */);
11068 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11069 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11071 DEFVAR_LISP ("this-command", &Vthis_command
,
11072 doc
: /* The command now being executed.
11073 The command can set this variable; whatever is put here
11074 will be in `last-command' during the following command. */);
11075 Vthis_command
= Qnil
;
11077 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11078 doc
: /* The command bound to the current key sequence before remapping.
11079 It equals `this-command' if the original command was not remapped through
11080 any of the active keymaps. Otherwise, the value of `this-command' is the
11081 result of looking up the original command in the active keymaps. */);
11082 Vthis_original_command
= Qnil
;
11084 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11085 doc
: /* *Number of input events between auto-saves.
11086 Zero means disable autosaving due to number of characters typed. */);
11087 auto_save_interval
= 300;
11089 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11090 doc
: /* *Number of seconds idle time before auto-save.
11091 Zero or nil means disable auto-saving due to idleness.
11092 After auto-saving due to this many seconds of idle time,
11093 Emacs also does a garbage collection if that seems to be warranted. */);
11094 XSETFASTINT (Vauto_save_timeout
, 30);
11096 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11097 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11098 The value may be integer or floating point. */);
11099 Vecho_keystrokes
= make_number (1);
11101 DEFVAR_INT ("polling-period", &polling_period
,
11102 doc
: /* *Interval between polling for input during Lisp execution.
11103 The reason for polling is to make C-g work to stop a running program.
11104 Polling is needed only when using X windows and SIGIO does not work.
11105 Polling is automatically disabled in all other cases. */);
11106 polling_period
= 2;
11108 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11109 doc
: /* *Maximum time between mouse clicks to make a double-click.
11110 Measured in milliseconds. nil means disable double-click recognition;
11111 t means double-clicks have no time limit and are detected
11112 by position only. */);
11113 Vdouble_click_time
= make_number (500);
11115 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11116 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11117 On window-system frames, value is the number of pixels the mouse may have
11118 moved horizontally or vertically between two clicks to make a double-click.
11119 On non window-system frames, value is interpreted in units of 1/8 characters
11122 This variable is also the threshold for motion of the mouse
11123 to count as a drag. */);
11124 double_click_fuzz
= 3;
11126 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11127 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11128 inhibit_local_menu_bar_menus
= 0;
11130 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11131 doc
: /* Number of complete key sequences read as input so far.
11132 This includes key sequences read from keyboard macros.
11133 The number is effectively the number of interactive command invocations. */);
11134 num_input_keys
= 0;
11136 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11137 doc
: /* Number of input events read from the keyboard so far.
11138 This does not include events generated by keyboard macros. */);
11139 num_nonmacro_input_events
= 0;
11141 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11142 doc
: /* The frame in which the most recently read event occurred.
11143 If the last event came from a keyboard macro, this is set to `macro'. */);
11144 Vlast_event_frame
= Qnil
;
11146 /* This variable is set up in sysdep.c. */
11147 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11148 doc
: /* The ERASE character as set by the user with stty. */);
11150 DEFVAR_LISP ("help-char", &Vhelp_char
,
11151 doc
: /* Character to recognize as meaning Help.
11152 When it is read, do `(eval help-form)', and display result if it's a string.
11153 If the value of `help-form' is nil, this char can be read normally. */);
11154 XSETINT (Vhelp_char
, Ctl ('H'));
11156 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11157 doc
: /* List of input events to recognize as meaning Help.
11158 These work just like the value of `help-char' (see that). */);
11159 Vhelp_event_list
= Qnil
;
11161 DEFVAR_LISP ("help-form", &Vhelp_form
,
11162 doc
: /* Form to execute when character `help-char' is read.
11163 If the form returns a string, that string is displayed.
11164 If `help-form' is nil, the help char is not recognized. */);
11167 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11168 doc
: /* Command to run when `help-char' character follows a prefix key.
11169 This command is used only when there is no actual binding
11170 for that character after that prefix key. */);
11171 Vprefix_help_command
= Qnil
;
11173 DEFVAR_LISP ("top-level", &Vtop_level
,
11174 doc
: /* Form to evaluate when Emacs starts up.
11175 Useful to set before you dump a modified Emacs. */);
11178 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11179 doc
: /* Translate table for keyboard input, or nil.
11180 If non-nil, the value should be a char-table. Each character read
11181 from the keyboard is looked up in this char-table. If the value found
11182 there is non-nil, then it is used instead of the actual input character.
11184 The value can also be a string or vector, but this is considered obsolete.
11185 If it is a string or vector of length N, character codes N and up are left
11186 untranslated. In a vector, an element which is nil means "no translation".
11188 This is applied to the characters supplied to input methods, not their
11189 output. See also `translation-table-for-input'. */);
11190 Vkeyboard_translate_table
= Qnil
;
11192 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11193 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11194 \(Even if the operating system has support for stopping a process.\) */);
11195 cannot_suspend
= 0;
11197 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11198 doc
: /* Non-nil means prompt with menus when appropriate.
11199 This is done when reading from a keymap that has a prompt string,
11200 for elements that have prompt strings.
11201 The menu is displayed on the screen
11202 if X menus were enabled at configuration
11203 time and the previous event was a mouse click prefix key.
11204 Otherwise, menu prompting uses the echo area. */);
11205 menu_prompting
= 1;
11207 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11208 doc
: /* Character to see next line of menu prompt.
11209 Type this character while in a menu prompt to rotate around the lines of it. */);
11210 XSETINT (menu_prompt_more_char
, ' ');
11212 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11213 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11214 Emacs applies the modifiers of the character stored here to each keyboard
11215 character it reads. For example, after evaluating the expression
11216 (setq extra-keyboard-modifiers ?\\C-x)
11217 all input characters will have the control modifier applied to them.
11219 Note that the character ?\\C-@, equivalent to the integer zero, does
11220 not count as a control character; rather, it counts as a character
11221 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11222 cancels any modification. */);
11223 extra_keyboard_modifiers
= 0;
11225 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11226 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11227 The command loop sets this to nil before each command,
11228 and tests the value when the command returns.
11229 Buffer modification stores t in this variable. */);
11230 Vdeactivate_mark
= Qnil
;
11232 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11233 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11234 Vcommand_hook_internal
= Qnil
;
11236 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11237 doc
: /* Normal hook run before each command is executed.
11238 If an unhandled error happens in running this hook,
11239 the hook value is set to nil, since otherwise the error
11240 might happen repeatedly and make Emacs nonfunctional. */);
11241 Vpre_command_hook
= Qnil
;
11243 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11244 doc
: /* Normal hook run after each command is executed.
11245 If an unhandled error happens in running this hook,
11246 the hook value is set to nil, since otherwise the error
11247 might happen repeatedly and make Emacs nonfunctional. */);
11248 Vpost_command_hook
= Qnil
;
11250 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11251 doc
: /* Normal hook run after each command is executed, if idle.
11252 Errors running the hook are caught and ignored. */);
11253 Vpost_command_idle_hook
= Qnil
;
11255 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11256 doc
: /* Delay time before running `post-command-idle-hook'.
11257 This is measured in microseconds. */);
11258 post_command_idle_delay
= 100000;
11261 DEFVAR_LISP ("echo-area-clear-hook", ...,
11262 doc
: /* Normal hook run when clearing the echo area. */);
11264 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11265 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11267 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11268 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11269 Vlucid_menu_bar_dirty_flag
= Qnil
;
11271 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11272 doc
: /* List of menu bar items to move to the end of the menu bar.
11273 The elements of the list are event types that may have menu bar bindings. */);
11274 Vmenu_bar_final_items
= Qnil
;
11276 DEFVAR_KBOARD ("overriding-terminal-local-map",
11277 Voverriding_terminal_local_map
,
11278 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11279 If this variable is non-nil, it is used as a keymap instead of the
11280 buffer's local map, and the minor mode keymaps and text property keymaps.
11281 It also overrides `overriding-local-map'.
11282 This variable is intended to let commands such as `universal-argument'
11283 set up a different keymap for reading the next command. */);
11285 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11286 doc
: /* Keymap that overrides all other local keymaps.
11287 If this variable is non-nil, it is used as a keymap instead of the
11288 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11289 Voverriding_local_map
= Qnil
;
11291 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11292 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11293 Otherwise, the menu bar continues to reflect the buffer's local map
11294 and the minor mode maps regardless of `overriding-local-map'. */);
11295 Voverriding_local_map_menu_flag
= Qnil
;
11297 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11298 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11299 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11301 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11302 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11304 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11305 doc
: /* Alist of system-specific X windows key symbols.
11306 Each element should have the form (N . SYMBOL) where N is the
11307 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11308 and SYMBOL is its name. */);
11310 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11311 doc
: /* List of deferred actions to be performed at a later time.
11312 The precise format isn't relevant here; we just check whether it is nil. */);
11313 Vdeferred_action_list
= Qnil
;
11315 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11316 doc
: /* Function to call to handle deferred actions, after each command.
11317 This function is called with no arguments after each command
11318 whenever `deferred-action-list' is non-nil. */);
11319 Vdeferred_action_function
= Qnil
;
11321 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11322 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11323 The value can be a length of time to show the message for.
11324 If the value is non-nil and not a number, we wait 2 seconds. */);
11325 Vsuggest_key_bindings
= Qt
;
11327 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11328 doc
: /* List of active absolute time timers in order of increasing time. */);
11329 Vtimer_list
= Qnil
;
11331 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11332 doc
: /* List of active idle-time timers in order of increasing time. */);
11333 Vtimer_idle_list
= Qnil
;
11335 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11336 doc
: /* If non-nil, the function that implements the current input method.
11337 It's called with one argument, a printing character that was just read.
11338 \(That means a character with code 040...0176.)
11339 Typically this function uses `read-event' to read additional events.
11340 When it does so, it should first bind `input-method-function' to nil
11341 so it will not be called recursively.
11343 The function should return a list of zero or more events
11344 to be used as input. If it wants to put back some events
11345 to be reconsidered, separately, by the input method,
11346 it can add them to the beginning of `unread-command-events'.
11348 The input method function can find in `input-method-previous-method'
11349 the previous echo area message.
11351 The input method function should refer to the variables
11352 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11353 for guidance on what to do. */);
11354 Vinput_method_function
= Qnil
;
11356 DEFVAR_LISP ("input-method-previous-message",
11357 &Vinput_method_previous_message
,
11358 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11359 This variable exists because `read-event' clears the echo area
11360 before running the input method. It is nil if there was no message. */);
11361 Vinput_method_previous_message
= Qnil
;
11363 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11364 doc
: /* If non-nil, the function that implements the display of help.
11365 It's called with one argument, the help string to display. */);
11366 Vshow_help_function
= Qnil
;
11368 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11369 doc
: /* If non-nil, suppress point adjustment after executing a command.
11371 After a command is executed, if point is moved into a region that has
11372 special properties (e.g. composition, display), we adjust point to
11373 the boundary of the region. But, when a command sets this variable to
11374 non-nil, we suppress the point adjustment.
11376 This variable is set to nil before reading a command, and is checked
11377 just after executing the command. */);
11378 Vdisable_point_adjustment
= Qnil
;
11380 DEFVAR_LISP ("global-disable-point-adjustment",
11381 &Vglobal_disable_point_adjustment
,
11382 doc
: /* *If non-nil, always suppress point adjustment.
11384 The default value is nil, in which case, point adjustment are
11385 suppressed only after special commands that set
11386 `disable-point-adjustment' (which see) to non-nil. */);
11387 Vglobal_disable_point_adjustment
= Qnil
;
11389 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11390 doc
: /* Non-nil means updating menu bindings is allowed.
11391 A value of nil means menu bindings should not be updated.
11392 Used during Emacs' startup. */);
11393 update_menu_bindings
= 1;
11395 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11396 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11397 If the value is not a number, such messages don't time out. */);
11398 Vminibuffer_message_timeout
= make_number (2);
11402 keys_of_keyboard ()
11404 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11405 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11406 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11407 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11408 initial_define_key (meta_map
, 'x', "execute-extended-command");
11410 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11411 "handle-delete-frame");
11412 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11414 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11416 /* Handling it at such a low-level causes read_key_sequence to get
11417 * confused because it doesn't realize that the current_buffer was
11418 * changed by read_char.
11420 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11421 * "handle-select-window"); */
11422 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11423 "handle-save-session");
11426 /* Mark the pointers in the kboard objects.
11427 Called by the Fgarbage_collector. */
11433 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11435 if (kb
->kbd_macro_buffer
)
11436 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11438 mark_object (kb
->Voverriding_terminal_local_map
);
11439 mark_object (kb
->Vlast_command
);
11440 mark_object (kb
->Vreal_last_command
);
11441 mark_object (kb
->Vprefix_arg
);
11442 mark_object (kb
->Vlast_prefix_arg
);
11443 mark_object (kb
->kbd_queue
);
11444 mark_object (kb
->defining_kbd_macro
);
11445 mark_object (kb
->Vlast_kbd_macro
);
11446 mark_object (kb
->Vsystem_key_alist
);
11447 mark_object (kb
->system_key_syms
);
11448 mark_object (kb
->Vdefault_minibuffer_frame
);
11449 mark_object (kb
->echo_string
);
11452 struct input_event
*event
;
11453 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11455 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11456 event
= kbd_buffer
;
11457 if (event
->kind
!= SELECTION_REQUEST_EVENT
)
11459 mark_object (event
->x
);
11460 mark_object (event
->y
);
11462 mark_object (event
->frame_or_window
);
11463 mark_object (event
->arg
);
11468 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11469 (do not change this comment) */