1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995, 1996, 1997,
3 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
29 #include "termhooks.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
48 #ifdef HAVE_GTK_AND_PTHREAD
56 #include <sys/ioctl.h>
58 #endif /* not MSDOS */
60 #include "syssignal.h"
62 #include <sys/types.h>
71 /* This is to get the definitions of the XK_ symbols. */
78 #endif /* HAVE_NTGUI */
88 /* Variables for blockinput.h: */
90 /* Non-zero if interrupt input is blocked right now. */
91 int interrupt_input_blocked
;
93 /* Nonzero means an input interrupt has arrived
94 during the current critical section. */
95 int interrupt_input_pending
;
98 #ifdef HAVE_WINDOW_SYSTEM
99 /* Make all keyboard buffers much bigger when using X windows. */
101 /* But not too big (local data > 32K error) if on Mac OS Classic. */
102 #define KBD_BUFFER_SIZE 512
104 #define KBD_BUFFER_SIZE 4096
106 #else /* No X-windows, character input */
107 #define KBD_BUFFER_SIZE 4096
108 #endif /* No X-windows */
110 #define abs(x) ((x) >= 0 ? (x) : -(x))
112 /* Following definition copied from eval.c */
116 struct backtrace
*next
;
117 Lisp_Object
*function
;
118 Lisp_Object
*args
; /* Points to vector of args. */
119 int nargs
; /* length of vector. If nargs is UNEVALLED,
120 args points to slot holding list of
123 /* Nonzero means call value of debugger when done with this operation. */
128 KBOARD
*initial_kboard
;
129 KBOARD
*current_kboard
;
133 KBOARD the_only_kboard
;
136 /* Non-nil disable property on a command means
137 do not execute it; call disabled-command-function's value instead. */
138 Lisp_Object Qdisabled
, Qdisabled_command_function
;
140 #define NUM_RECENT_KEYS (100)
141 int recent_keys_index
; /* Index for storing next element into recent_keys */
142 int total_keys
; /* Total number of elements stored into recent_keys */
143 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
145 /* Vector holding the key sequence that invoked the current command.
146 It is reused for each command, and it may be longer than the current
147 sequence; this_command_key_count indicates how many elements
148 actually mean something.
149 It's easier to staticpro a single Lisp_Object than an array. */
150 Lisp_Object this_command_keys
;
151 int this_command_key_count
;
153 /* 1 after calling Freset_this_command_lengths.
155 int this_command_key_count_reset
;
157 /* This vector is used as a buffer to record the events that were actually read
158 by read_key_sequence. */
159 Lisp_Object raw_keybuf
;
160 int raw_keybuf_count
;
162 #define GROW_RAW_KEYBUF \
163 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
165 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
167 new = Fmake_vector (make_number (newsize), Qnil); \
168 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
169 raw_keybuf_count * sizeof (Lisp_Object)); \
173 /* Number of elements of this_command_keys
174 that precede this key sequence. */
175 int this_single_command_key_start
;
177 /* Record values of this_command_key_count and echo_length ()
178 before this command was read. */
179 static int before_command_key_count
;
180 static int before_command_echo_length
;
182 extern int minbuf_level
;
184 extern int message_enable_multibyte
;
186 extern struct backtrace
*backtrace_list
;
188 /* If non-nil, the function that implements the display of help.
189 It's called with one argument, the help string to display. */
191 Lisp_Object Vshow_help_function
;
193 /* If a string, the message displayed before displaying a help-echo
196 Lisp_Object Vpre_help_message
;
198 /* Nonzero means do menu prompting. */
200 static int menu_prompting
;
202 /* Character to see next line of menu prompt. */
204 static Lisp_Object menu_prompt_more_char
;
206 /* For longjmp to where kbd input is being done. */
208 static jmp_buf getcjmp
;
210 /* True while doing kbd input. */
211 int waiting_for_input
;
213 /* True while displaying for echoing. Delays C-g throwing. */
217 /* Non-null means we can start echoing at the next input pause even
218 though there is something in the echo area. */
220 static struct kboard
*ok_to_echo_at_next_pause
;
222 /* The kboard last echoing, or null for none. Reset to 0 in
223 cancel_echoing. If non-null, and a current echo area message
224 exists, and echo_message_buffer is eq to the current message
225 buffer, we know that the message comes from echo_kboard. */
227 struct kboard
*echo_kboard
;
229 /* The buffer used for echoing. Set in echo_now, reset in
232 Lisp_Object echo_message_buffer
;
234 /* Nonzero means disregard local maps for the menu bar. */
235 static int inhibit_local_menu_bar_menus
;
237 /* Nonzero means C-g should cause immediate error-signal. */
240 /* The user's ERASE setting. */
241 Lisp_Object Vtty_erase_char
;
243 /* Character to recognize as the help char. */
244 Lisp_Object Vhelp_char
;
246 /* List of other event types to recognize as meaning "help". */
247 Lisp_Object Vhelp_event_list
;
249 /* Form to execute when help char is typed. */
250 Lisp_Object Vhelp_form
;
252 /* Command to run when the help character follows a prefix key. */
253 Lisp_Object Vprefix_help_command
;
255 /* List of items that should move to the end of the menu bar. */
256 Lisp_Object Vmenu_bar_final_items
;
258 /* Non-nil means show the equivalent key-binding for
259 any M-x command that has one.
260 The value can be a length of time to show the message for.
261 If the value is non-nil and not a number, we wait 2 seconds. */
262 Lisp_Object Vsuggest_key_bindings
;
264 /* How long to display an echo-area message when the minibuffer is active.
265 If the value is not a number, such messages don't time out. */
266 Lisp_Object Vminibuffer_message_timeout
;
268 /* Character that causes a quit. Normally C-g.
270 If we are running on an ordinary terminal, this must be an ordinary
271 ASCII char, since we want to make it our interrupt character.
273 If we are not running on an ordinary terminal, it still needs to be
274 an ordinary ASCII char. This character needs to be recognized in
275 the input interrupt handler. At this point, the keystroke is
276 represented as a struct input_event, while the desired quit
277 character is specified as a lispy event. The mapping from struct
278 input_events to lispy events cannot run in an interrupt handler,
279 and the reverse mapping is difficult for anything but ASCII
282 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
286 extern Lisp_Object current_global_map
;
287 extern int minibuf_level
;
289 /* If non-nil, this is a map that overrides all other local maps. */
290 Lisp_Object Voverriding_local_map
;
292 /* If non-nil, Voverriding_local_map applies to the menu bar. */
293 Lisp_Object Voverriding_local_map_menu_flag
;
295 /* Keymap that defines special misc events that should
296 be processed immediately at a low level. */
297 Lisp_Object Vspecial_event_map
;
299 /* Current depth in recursive edits. */
300 int command_loop_level
;
302 /* Total number of times command_loop has read a key sequence. */
303 EMACS_INT num_input_keys
;
305 /* Last input character read as a command. */
306 Lisp_Object last_command_char
;
308 /* Last input character read as a command, not counting menus
309 reached by the mouse. */
310 Lisp_Object last_nonmenu_event
;
312 /* Last input character read for any purpose. */
313 Lisp_Object last_input_char
;
315 /* If not Qnil, a list of objects to be read as subsequent command input. */
316 Lisp_Object Vunread_command_events
;
318 /* If not Qnil, a list of objects to be read as subsequent command input
319 including input method processing. */
320 Lisp_Object Vunread_input_method_events
;
322 /* If not Qnil, a list of objects to be read as subsequent command input
323 but NOT including input method processing. */
324 Lisp_Object Vunread_post_input_method_events
;
326 /* If not -1, an event to be read as subsequent command input. */
327 EMACS_INT unread_command_char
;
329 /* If not Qnil, this is a switch-frame event which we decided to put
330 off until the end of a key sequence. This should be read as the
331 next command input, after any unread_command_events.
333 read_key_sequence uses this to delay switch-frame events until the
334 end of the key sequence; Fread_char uses it to put off switch-frame
335 events until a non-ASCII event is acceptable as input. */
336 Lisp_Object unread_switch_frame
;
338 /* A mask of extra modifier bits to put into every keyboard char. */
339 EMACS_INT extra_keyboard_modifiers
;
341 /* Char to use as prefix when a meta character is typed in.
342 This is bound on entry to minibuffer in case ESC is changed there. */
344 Lisp_Object meta_prefix_char
;
346 /* Last size recorded for a current buffer which is not a minibuffer. */
347 static int last_non_minibuf_size
;
349 /* Number of idle seconds before an auto-save and garbage collection. */
350 static Lisp_Object Vauto_save_timeout
;
352 /* Total number of times read_char has returned. */
353 int num_input_events
;
355 /* Total number of times read_char has returned, outside of macros. */
356 EMACS_INT num_nonmacro_input_events
;
358 /* Auto-save automatically when this many characters have been typed
359 since the last time. */
361 static EMACS_INT auto_save_interval
;
363 /* Value of num_nonmacro_input_events as of last auto save. */
367 /* The command being executed by the command loop.
368 Commands may set this, and the value set will be copied into
369 current_kboard->Vlast_command instead of the actual command. */
370 Lisp_Object Vthis_command
;
372 /* This is like Vthis_command, except that commands never set it. */
373 Lisp_Object real_this_command
;
375 /* If the lookup of the command returns a binding, the original
376 command is stored in this-original-command. It is nil otherwise. */
377 Lisp_Object Vthis_original_command
;
379 /* The value of point when the last command was executed. */
380 int last_point_position
;
382 /* The buffer that was current when the last command was started. */
383 Lisp_Object last_point_position_buffer
;
385 /* The frame in which the last input event occurred, or Qmacro if the
386 last event came from a macro. We use this to determine when to
387 generate switch-frame events. This may be cleared by functions
388 like Fselect_frame, to make sure that a switch-frame event is
389 generated by the next character. */
390 Lisp_Object internal_last_event_frame
;
392 /* A user-visible version of the above, intended to allow users to
393 figure out where the last event came from, if the event doesn't
394 carry that information itself (i.e. if it was a character). */
395 Lisp_Object Vlast_event_frame
;
397 /* The timestamp of the last input event we received from the X server.
398 X Windows wants this for selection ownership. */
399 unsigned long last_event_timestamp
;
401 Lisp_Object Qself_insert_command
;
402 Lisp_Object Qforward_char
;
403 Lisp_Object Qbackward_char
;
404 Lisp_Object Qundefined
;
405 Lisp_Object Qtimer_event_handler
;
407 /* read_key_sequence stores here the command definition of the
408 key sequence that it reads. */
409 Lisp_Object read_key_sequence_cmd
;
411 /* Echo unfinished commands after this many seconds of pause. */
412 Lisp_Object Vecho_keystrokes
;
414 /* Form to evaluate (if non-nil) when Emacs is started. */
415 Lisp_Object Vtop_level
;
417 /* User-supplied table to translate input characters. */
418 Lisp_Object Vkeyboard_translate_table
;
420 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
421 extern Lisp_Object Vfunction_key_map
;
423 /* Another keymap that maps key sequences into key sequences.
424 This one takes precedence over ordinary definitions. */
425 extern Lisp_Object Vkey_translation_map
;
427 /* If non-nil, this implements the current input method. */
428 Lisp_Object Vinput_method_function
;
429 Lisp_Object Qinput_method_function
;
431 /* When we call Vinput_method_function,
432 this holds the echo area message that was just erased. */
433 Lisp_Object Vinput_method_previous_message
;
435 /* Non-nil means deactivate the mark at end of this command. */
436 Lisp_Object Vdeactivate_mark
;
438 /* Menu bar specified in Lucid Emacs fashion. */
440 Lisp_Object Vlucid_menu_bar_dirty_flag
;
441 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
443 Lisp_Object Qecho_area_clear_hook
;
445 /* Hooks to run before and after each command. */
446 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
447 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
448 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
450 /* List of deferred actions to be performed at a later time.
451 The precise format isn't relevant here; we just check whether it is nil. */
452 Lisp_Object Vdeferred_action_list
;
454 /* Function to call to handle deferred actions, when there are any. */
455 Lisp_Object Vdeferred_action_function
;
456 Lisp_Object Qdeferred_action_function
;
458 Lisp_Object Qinput_method_exit_on_first_char
;
459 Lisp_Object Qinput_method_use_echo_area
;
461 /* File in which we write all commands we read. */
464 /* Nonzero if input is available. */
467 /* Non-zero means force key bindings update in parse_menu_item. */
469 int update_menu_bindings
;
471 extern char *pending_malloc_warning
;
473 /* Circular buffer for pre-read keyboard input. */
475 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
477 /* Pointer to next available character in kbd_buffer.
478 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
479 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
480 next available char is in kbd_buffer[0]. */
481 static struct input_event
*kbd_fetch_ptr
;
483 /* Pointer to next place to store character in kbd_buffer. This
484 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
485 character should go in kbd_buffer[0]. */
486 static struct input_event
* volatile kbd_store_ptr
;
488 /* The above pair of variables forms a "queue empty" flag. When we
489 enqueue a non-hook event, we increment kbd_store_ptr. When we
490 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
491 there is input available iff the two pointers are not equal.
493 Why not just have a flag set and cleared by the enqueuing and
494 dequeuing functions? Such a flag could be screwed up by interrupts
495 at inopportune times. */
497 /* If this flag is non-nil, we check mouse_moved to see when the
498 mouse moves, and motion events will appear in the input stream.
499 Otherwise, mouse motion is ignored. */
500 Lisp_Object do_mouse_tracking
;
502 /* Symbols to head events. */
503 Lisp_Object Qmouse_movement
;
504 Lisp_Object Qscroll_bar_movement
;
505 Lisp_Object Qswitch_frame
;
506 Lisp_Object Qdelete_frame
;
507 Lisp_Object Qiconify_frame
;
508 Lisp_Object Qmake_frame_visible
;
509 Lisp_Object Qselect_window
;
510 Lisp_Object Qhelp_echo
;
513 Lisp_Object Qmouse_fixup_help_message
;
516 /* Symbols to denote kinds of events. */
517 Lisp_Object Qfunction_key
;
518 Lisp_Object Qmouse_click
;
519 #if defined (WINDOWSNT) || defined (MAC_OS)
520 Lisp_Object Qlanguage_change
;
522 Lisp_Object Qdrag_n_drop
;
523 Lisp_Object Qsave_session
;
525 /* Lisp_Object Qmouse_movement; - also an event header */
527 /* Properties of event headers. */
528 Lisp_Object Qevent_kind
;
529 Lisp_Object Qevent_symbol_elements
;
531 /* menu item parts */
532 Lisp_Object Qmenu_alias
;
533 Lisp_Object Qmenu_enable
;
534 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
535 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
536 extern Lisp_Object Vdefine_key_rebound_commands
;
537 extern Lisp_Object Qmenu_item
;
539 /* An event header symbol HEAD may have a property named
540 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
541 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
542 mask of modifiers applied to it. If present, this is used to help
543 speed up parse_modifiers. */
544 Lisp_Object Qevent_symbol_element_mask
;
546 /* An unmodified event header BASE may have a property named
547 Qmodifier_cache, which is an alist mapping modifier masks onto
548 modified versions of BASE. If present, this helps speed up
550 Lisp_Object Qmodifier_cache
;
552 /* Symbols to use for parts of windows. */
553 Lisp_Object Qmode_line
;
554 Lisp_Object Qvertical_line
;
555 Lisp_Object Qvertical_scroll_bar
;
556 Lisp_Object Qmenu_bar
;
557 extern Lisp_Object Qleft_margin
, Qright_margin
;
558 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
559 extern Lisp_Object QCmap
;
561 Lisp_Object
recursive_edit_unwind (), command_loop ();
562 Lisp_Object
Fthis_command_keys ();
563 Lisp_Object Qextended_command_history
;
564 EMACS_TIME
timer_check ();
566 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
568 extern char *x_get_keysym_name ();
570 static void record_menu_key ();
571 static int echo_length ();
573 Lisp_Object Qpolling_period
;
575 /* List of absolute timers. Appears in order of next scheduled event. */
576 Lisp_Object Vtimer_list
;
578 /* List of idle time timers. Appears in order of next scheduled event. */
579 Lisp_Object Vtimer_idle_list
;
581 /* Incremented whenever a timer is run. */
584 extern Lisp_Object Vprint_level
, Vprint_length
;
586 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
588 EMACS_TIME
*input_available_clear_time
;
590 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
591 Default is 1 if INTERRUPT_INPUT is defined. */
594 /* Nonzero while interrupts are temporarily deferred during redisplay. */
595 int interrupts_deferred
;
597 /* Allow m- file to inhibit use of FIONREAD. */
598 #ifdef BROKEN_FIONREAD
602 /* We are unable to use interrupts if FIONREAD is not available,
603 so flush SIGIO so we won't try. */
604 #if !defined (FIONREAD)
610 /* If we support a window system, turn on the code to poll periodically
611 to detect C-g. It isn't actually used when doing interrupt input. */
612 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
613 #define POLL_FOR_INPUT
616 /* After a command is executed, if point is moved into a region that
617 has specific properties (e.g. composition, display), we adjust
618 point to the boundary of the region. But, if a command sets this
619 variable to non-nil, we suppress this point adjustment. This
620 variable is set to nil before reading a command. */
622 Lisp_Object Vdisable_point_adjustment
;
624 /* If non-nil, always disable point adjustment. */
626 Lisp_Object Vglobal_disable_point_adjustment
;
628 /* The time when Emacs started being idle. */
630 static EMACS_TIME timer_idleness_start_time
;
632 /* After Emacs stops being idle, this saves the last value
633 of timer_idleness_start_time from when it was idle. */
635 static EMACS_TIME timer_last_idleness_start_time
;
638 /* Global variable declarations. */
640 /* Flags for readable_events. */
641 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
642 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
643 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
645 /* Function for init_keyboard to call with no args (if nonzero). */
646 void (*keyboard_init_hook
) ();
648 static int read_avail_input
P_ ((int));
649 static void get_input_pending
P_ ((int *, int));
650 static int readable_events
P_ ((int));
651 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
652 Lisp_Object
, int *));
653 static Lisp_Object
read_char_x_menu_prompt ();
654 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
656 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
658 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
659 enum scroll_bar_part
,
660 Lisp_Object
, Lisp_Object
,
663 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
664 Lisp_Object
, char **,
665 Lisp_Object
*, unsigned));
666 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
667 static int parse_solitary_modifier
P_ ((Lisp_Object
));
668 static int parse_solitary_modifier ();
669 static void save_getcjmp
P_ ((jmp_buf));
670 static void save_getcjmp ();
671 static void restore_getcjmp
P_ ((jmp_buf));
672 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
673 static void clear_event
P_ ((struct input_event
*));
674 static void any_kboard_state
P_ ((void));
675 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
676 static void handle_interrupt
P_ ((void));
677 static void timer_start_idle
P_ ((void));
678 static void timer_stop_idle
P_ ((void));
679 static void timer_resume_idle
P_ ((void));
681 /* Nonzero means don't try to suspend even if the operating system seems
683 static int cannot_suspend
;
685 extern Lisp_Object Qidentity
, Qonly
;
687 /* Install the string STR as the beginning of the string of echoing,
688 so that it serves as a prompt for the next character.
689 Also start echoing. */
695 current_kboard
->echo_string
= str
;
696 current_kboard
->echo_after_prompt
= SCHARS (str
);
700 /* Add C to the echo string, if echoing is going on.
701 C can be a character, which is printed prettily ("M-C-x" and all that
702 jazz), or a symbol, whose name is printed. */
708 if (current_kboard
->immediate_echo
)
710 int size
= KEY_DESCRIPTION_SIZE
+ 100;
711 char *buffer
= (char *) alloca (size
);
713 Lisp_Object echo_string
;
715 echo_string
= current_kboard
->echo_string
;
717 /* If someone has passed us a composite event, use its head symbol. */
722 ptr
= push_key_description (XINT (c
), ptr
, 1);
724 else if (SYMBOLP (c
))
726 Lisp_Object name
= SYMBOL_NAME (c
);
727 int nbytes
= SBYTES (name
);
729 if (size
- (ptr
- buffer
) < nbytes
)
731 int offset
= ptr
- buffer
;
732 size
= max (2 * size
, size
+ nbytes
);
733 buffer
= (char *) alloca (size
);
734 ptr
= buffer
+ offset
;
737 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
738 STRING_MULTIBYTE (name
), 1);
741 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
744 const char *text
= " (Type ? for further options)";
745 int len
= strlen (text
);
747 if (size
- (ptr
- buffer
) < len
)
749 int offset
= ptr
- buffer
;
751 buffer
= (char *) alloca (size
);
752 ptr
= buffer
+ offset
;
755 bcopy (text
, ptr
, len
);
759 /* Replace a dash from echo_dash with a space, otherwise
760 add a space at the end as a separator between keys. */
761 if (STRINGP (echo_string
)
762 && SCHARS (echo_string
) > 1)
764 Lisp_Object last_char
, prev_char
, idx
;
766 idx
= make_number (SCHARS (echo_string
) - 2);
767 prev_char
= Faref (echo_string
, idx
);
769 idx
= make_number (SCHARS (echo_string
) - 1);
770 last_char
= Faref (echo_string
, idx
);
772 /* We test PREV_CHAR to make sure this isn't the echoing
774 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
775 Faset (echo_string
, idx
, make_number (' '));
777 echo_string
= concat2 (echo_string
, build_string (" "));
780 current_kboard
->echo_string
781 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
787 /* Temporarily add a dash to the end of the echo string if it's not
788 empty, so that it serves as a mini-prompt for the very next character. */
793 /* Do nothing if not echoing at all. */
794 if (NILP (current_kboard
->echo_string
))
797 if (!current_kboard
->immediate_echo
798 && SCHARS (current_kboard
->echo_string
) == 0)
801 /* Do nothing if we just printed a prompt. */
802 if (current_kboard
->echo_after_prompt
803 == SCHARS (current_kboard
->echo_string
))
806 /* Do nothing if we have already put a dash at the end. */
807 if (SCHARS (current_kboard
->echo_string
) > 1)
809 Lisp_Object last_char
, prev_char
, idx
;
811 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
812 prev_char
= Faref (current_kboard
->echo_string
, idx
);
814 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
815 last_char
= Faref (current_kboard
->echo_string
, idx
);
817 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
821 /* Put a dash at the end of the buffer temporarily,
822 but make it go away when the next character is added. */
823 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
828 /* Display the current echo string, and begin echoing if not already
834 if (!current_kboard
->immediate_echo
)
837 current_kboard
->immediate_echo
= 1;
839 for (i
= 0; i
< this_command_key_count
; i
++)
843 /* Set before_command_echo_length to the value that would
844 have been saved before the start of this subcommand in
845 command_loop_1, if we had already been echoing then. */
846 if (i
== this_single_command_key_start
)
847 before_command_echo_length
= echo_length ();
849 c
= XVECTOR (this_command_keys
)->contents
[i
];
850 if (! (EVENT_HAS_PARAMETERS (c
)
851 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
855 /* Set before_command_echo_length to the value that would
856 have been saved before the start of this subcommand in
857 command_loop_1, if we had already been echoing then. */
858 if (this_command_key_count
== this_single_command_key_start
)
859 before_command_echo_length
= echo_length ();
861 /* Put a dash at the end to invite the user to type more. */
866 message3_nolog (current_kboard
->echo_string
,
867 SBYTES (current_kboard
->echo_string
),
868 STRING_MULTIBYTE (current_kboard
->echo_string
));
871 /* Record in what buffer we echoed, and from which kboard. */
872 echo_message_buffer
= echo_area_buffer
[0];
873 echo_kboard
= current_kboard
;
875 if (waiting_for_input
&& !NILP (Vquit_flag
))
876 quit_throw_to_read_char ();
879 /* Turn off echoing, for the start of a new command. */
884 current_kboard
->immediate_echo
= 0;
885 current_kboard
->echo_after_prompt
= -1;
886 current_kboard
->echo_string
= Qnil
;
887 ok_to_echo_at_next_pause
= NULL
;
889 echo_message_buffer
= Qnil
;
892 /* Return the length of the current echo string. */
897 return (STRINGP (current_kboard
->echo_string
)
898 ? SCHARS (current_kboard
->echo_string
)
902 /* Truncate the current echo message to its first LEN chars.
903 This and echo_char get used by read_key_sequence when the user
904 switches frames while entering a key sequence. */
907 echo_truncate (nchars
)
910 if (STRINGP (current_kboard
->echo_string
))
911 current_kboard
->echo_string
912 = Fsubstring (current_kboard
->echo_string
,
913 make_number (0), make_number (nchars
));
914 truncate_echo_area (nchars
);
918 /* Functions for manipulating this_command_keys. */
920 add_command_key (key
)
923 #if 0 /* Not needed after we made Freset_this_command_lengths
924 do the job immediately. */
925 /* If reset-this-command-length was called recently, obey it now.
926 See the doc string of that function for an explanation of why. */
927 if (before_command_restore_flag
)
929 this_command_key_count
= before_command_key_count_1
;
930 if (this_command_key_count
< this_single_command_key_start
)
931 this_single_command_key_start
= this_command_key_count
;
932 echo_truncate (before_command_echo_length_1
);
933 before_command_restore_flag
= 0;
937 if (this_command_key_count
>= ASIZE (this_command_keys
))
938 this_command_keys
= larger_vector (this_command_keys
,
939 2 * ASIZE (this_command_keys
),
942 AREF (this_command_keys
, this_command_key_count
) = key
;
943 ++this_command_key_count
;
950 int count
= SPECPDL_INDEX ();
953 if (command_loop_level
> 0)
955 specbind (Qstandard_output
, Qt
);
956 specbind (Qstandard_input
, Qt
);
959 #ifdef HAVE_X_WINDOWS
960 /* The command loop has started an hourglass timer, so we have to
961 cancel it here, otherwise it will fire because the recursive edit
962 can take some time. Do not check for display_hourglass_p here,
963 because it could already be nil. */
967 /* This function may have been called from a debugger called from
968 within redisplay, for instance by Edebugging a function called
969 from fontification-functions. We want to allow redisplay in
970 the debugging session.
972 The recursive edit is left with a `(throw exit ...)'. The `exit'
973 tag is not caught anywhere in redisplay, i.e. when we leave the
974 recursive edit, the original redisplay leading to the recursive
975 edit will be unwound. The outcome should therefore be safe. */
976 specbind (Qinhibit_redisplay
, Qnil
);
979 val
= command_loop ();
981 Fsignal (Qquit
, Qnil
);
982 /* Handle throw from read_minibuf when using minibuffer
983 while it's active but we're in another window. */
985 Fsignal (Qerror
, Fcons (val
, Qnil
));
987 return unbind_to (count
, Qnil
);
990 /* When an auto-save happens, record the "time", and don't do again soon. */
995 last_auto_save
= num_nonmacro_input_events
;
998 /* Make an auto save happen as soon as possible at command level. */
1001 force_auto_save_soon ()
1003 last_auto_save
= - auto_save_interval
- 1;
1005 record_asynch_buffer_change ();
1008 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1009 doc
: /* Invoke the editor command loop recursively.
1010 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1011 that tells this function to return.
1012 Alternatively, `(throw 'exit t)' makes this function signal an error.
1013 This function is called by the editor initialization to begin editing. */)
1016 int count
= SPECPDL_INDEX ();
1019 /* If we enter while input is blocked, don't lock up here.
1020 This may happen through the debugger during redisplay. */
1021 if (INPUT_BLOCKED_P
)
1024 command_loop_level
++;
1025 update_mode_lines
= 1;
1027 if (command_loop_level
1028 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1029 buffer
= Fcurrent_buffer ();
1033 /* If we leave recursive_edit_1 below with a `throw' for instance,
1034 like it is done in the splash screen display, we have to
1035 make sure that we restore single_kboard as command_loop_1
1036 would have done if it were left normally. */
1037 record_unwind_protect (recursive_edit_unwind
,
1038 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1040 recursive_edit_1 ();
1041 return unbind_to (count
, Qnil
);
1045 recursive_edit_unwind (info
)
1048 if (BUFFERP (XCAR (info
)))
1049 Fset_buffer (XCAR (info
));
1051 if (NILP (XCDR (info
)))
1052 any_kboard_state ();
1054 single_kboard_state ();
1056 command_loop_level
--;
1057 update_mode_lines
= 1;
1066 #if 0 /* Theory: if there's anything in Vunread_command_events,
1067 it will right away be read by read_key_sequence,
1068 and then if we do switch KBOARDS, it will go into the side
1069 queue then. So we don't need to do anything special here -- rms. */
1070 if (CONSP (Vunread_command_events
))
1072 current_kboard
->kbd_queue
1073 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1074 current_kboard
->kbd_queue_has_data
= 1;
1076 Vunread_command_events
= Qnil
;
1082 /* Switch to the single-kboard state, making current_kboard
1083 the only KBOARD from which further input is accepted. */
1086 single_kboard_state ()
1093 /* If we're in single_kboard state for kboard KBOARD,
1097 not_single_kboard_state (kboard
)
1101 if (kboard
== current_kboard
)
1106 /* Maintain a stack of kboards, so other parts of Emacs
1107 can switch temporarily to the kboard of a given frame
1108 and then revert to the previous status. */
1113 struct kboard_stack
*next
;
1116 static struct kboard_stack
*kboard_stack
;
1119 push_frame_kboard (f
)
1123 struct kboard_stack
*p
1124 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1126 p
->next
= kboard_stack
;
1127 p
->kboard
= current_kboard
;
1130 current_kboard
= FRAME_KBOARD (f
);
1138 struct kboard_stack
*p
= kboard_stack
;
1139 current_kboard
= p
->kboard
;
1140 kboard_stack
= p
->next
;
1145 /* Handle errors that are not handled at inner levels
1146 by printing an error message and returning to the editor command loop. */
1152 Lisp_Object old_level
, old_length
;
1153 char macroerror
[50];
1155 #ifdef HAVE_X_WINDOWS
1156 if (display_hourglass_p
)
1157 cancel_hourglass ();
1160 if (!NILP (executing_kbd_macro
))
1162 if (executing_kbd_macro_iterations
== 1)
1163 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1165 sprintf (macroerror
, "After %d kbd macro iterations: ",
1166 executing_kbd_macro_iterations
);
1171 Vstandard_output
= Qt
;
1172 Vstandard_input
= Qt
;
1173 Vexecuting_kbd_macro
= Qnil
;
1174 executing_kbd_macro
= Qnil
;
1175 current_kboard
->Vprefix_arg
= Qnil
;
1176 current_kboard
->Vlast_prefix_arg
= Qnil
;
1179 /* Avoid unquittable loop if data contains a circular list. */
1180 old_level
= Vprint_level
;
1181 old_length
= Vprint_length
;
1182 XSETFASTINT (Vprint_level
, 10);
1183 XSETFASTINT (Vprint_length
, 10);
1184 cmd_error_internal (data
, macroerror
);
1185 Vprint_level
= old_level
;
1186 Vprint_length
= old_length
;
1190 Vinhibit_quit
= Qnil
;
1192 if (command_loop_level
== 0 && minibuf_level
== 0)
1193 any_kboard_state ();
1196 return make_number (0);
1199 /* Take actions on handling an error. DATA is the data that describes
1202 CONTEXT is a C-string containing ASCII characters only which
1203 describes the context in which the error happened. If we need to
1204 generalize CONTEXT to allow multibyte characters, make it a Lisp
1208 cmd_error_internal (data
, context
)
1213 int kill_emacs_p
= 0;
1214 struct frame
*sf
= SELECTED_FRAME ();
1218 clear_message (1, 0);
1220 /* If the window system or terminal frame hasn't been initialized
1221 yet, or we're not interactive, it's best to dump this message out
1222 to stderr and exit. */
1223 if (!sf
->glyphs_initialized_p
1224 || FRAME_INITIAL_P (sf
)
1227 stream
= Qexternal_debugging_output
;
1233 message_log_maybe_newline ();
1238 /* The immediate context is not interesting for Quits,
1239 since they are asyncronous. */
1240 if (EQ (XCAR (data
), Qquit
))
1241 Vsignaling_function
= Qnil
;
1243 print_error_message (data
, stream
, context
, Vsignaling_function
);
1245 Vsignaling_function
= Qnil
;
1247 /* If the window system or terminal frame hasn't been initialized
1248 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1252 Fkill_emacs (make_number (-1));
1256 Lisp_Object
command_loop_1 ();
1257 Lisp_Object
command_loop_2 ();
1258 Lisp_Object
top_level_1 ();
1260 /* Entry to editor-command-loop.
1261 This level has the catches for exiting/returning to editor command loop.
1262 It returns nil to exit recursive edit, t to abort it. */
1267 if (command_loop_level
> 0 || minibuf_level
> 0)
1270 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1271 executing_kbd_macro
= Qnil
;
1277 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1278 /* Reset single_kboard in case top-level set it while
1279 evaluating an -f option, or we are stuck there for some
1281 any_kboard_state ();
1282 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1283 executing_kbd_macro
= Qnil
;
1285 /* End of file in -batch run causes exit here. */
1291 /* Here we catch errors in execution of commands within the
1292 editing loop, and reenter the editing loop.
1293 When there is an error, cmd_error runs and returns a non-nil
1294 value to us. A value of nil means that command_loop_1 itself
1295 returned due to end of file (or end of kbd macro). */
1300 register Lisp_Object val
;
1303 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1304 while (!NILP (val
));
1312 return Feval (Vtop_level
);
1318 /* On entry to the outer level, run the startup file */
1319 if (!NILP (Vtop_level
))
1320 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1321 else if (!NILP (Vpurify_flag
))
1322 message ("Bare impure Emacs (standard Lisp code not loaded)");
1324 message ("Bare Emacs (standard Lisp code not loaded)");
1328 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1329 doc
: /* Exit all recursive editing levels. */)
1332 #ifdef HAVE_X_WINDOWS
1333 if (display_hourglass_p
)
1334 cancel_hourglass ();
1337 /* Unblock input if we enter with input blocked. This may happen if
1338 redisplay traps e.g. during tool-bar update with input blocked. */
1339 while (INPUT_BLOCKED_P
)
1342 return Fthrow (Qtop_level
, Qnil
);
1345 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1346 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1349 if (command_loop_level
> 0 || minibuf_level
> 0)
1350 Fthrow (Qexit
, Qnil
);
1352 error ("No recursive edit is in progress");
1356 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1357 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1360 if (command_loop_level
> 0 || minibuf_level
> 0)
1363 error ("No recursive edit is in progress");
1367 /* This is the actual command reading loop,
1368 sans error-handling encapsulation. */
1370 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1372 void safe_run_hooks
P_ ((Lisp_Object
));
1373 static void adjust_point_for_property
P_ ((int, int));
1375 /* Cancel hourglass from protect_unwind.
1377 #ifdef HAVE_X_WINDOWS
1379 cancel_hourglass_unwind (arg
)
1382 cancel_hourglass ();
1393 Lisp_Object keybuf
[30];
1396 int prev_modiff
= 0;
1397 struct buffer
*prev_buffer
= NULL
;
1399 int was_locked
= single_kboard
;
1401 int already_adjusted
= 0;
1403 current_kboard
->Vprefix_arg
= Qnil
;
1404 current_kboard
->Vlast_prefix_arg
= Qnil
;
1405 Vdeactivate_mark
= Qnil
;
1406 waiting_for_input
= 0;
1410 this_command_key_count
= 0;
1411 this_command_key_count_reset
= 0;
1412 this_single_command_key_start
= 0;
1414 if (NILP (Vmemory_full
))
1416 /* Make sure this hook runs after commands that get errors and
1417 throw to top level. */
1418 /* Note that the value cell will never directly contain nil
1419 if the symbol is a local variable. */
1420 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1421 safe_run_hooks (Qpost_command_hook
);
1423 /* If displaying a message, resize the echo area window to fit
1424 that message's size exactly. */
1425 if (!NILP (echo_area_buffer
[0]))
1426 resize_echo_area_exactly ();
1428 if (!NILP (Vdeferred_action_list
))
1429 safe_run_hooks (Qdeferred_action_function
);
1432 Vmemory_full
= Qnil
;
1434 /* Do this after running Vpost_command_hook, for consistency. */
1435 current_kboard
->Vlast_command
= Vthis_command
;
1436 current_kboard
->Vreal_last_command
= real_this_command
;
1440 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1443 /* Make sure the current window's buffer is selected. */
1444 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1445 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1447 /* Display any malloc warning that just came out. Use while because
1448 displaying one warning can cause another. */
1450 while (pending_malloc_warning
)
1451 display_malloc_warning ();
1455 Vdeactivate_mark
= Qnil
;
1457 /* If minibuffer on and echo area in use,
1458 wait a short time and redraw minibuffer. */
1461 && !NILP (echo_area_buffer
[0])
1462 && EQ (minibuf_window
, echo_area_window
)
1463 && NUMBERP (Vminibuffer_message_timeout
))
1465 /* Bind inhibit-quit to t so that C-g gets read in
1466 rather than quitting back to the minibuffer. */
1467 int count
= SPECPDL_INDEX ();
1468 specbind (Qinhibit_quit
, Qt
);
1470 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1471 /* Clear the echo area. */
1473 safe_run_hooks (Qecho_area_clear_hook
);
1475 unbind_to (count
, Qnil
);
1477 /* If a C-g came in before, treat it as input now. */
1478 if (!NILP (Vquit_flag
))
1481 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1486 alloca (0); /* Cause a garbage collection now */
1487 /* Since we can free the most stuff here. */
1488 #endif /* C_ALLOCA */
1491 /* Select the frame that the last event came from. Usually,
1492 switch-frame events will take care of this, but if some lisp
1493 code swallows a switch-frame event, we'll fix things up here.
1494 Is this a good idea? */
1495 if (FRAMEP (internal_last_event_frame
)
1496 && !EQ (internal_last_event_frame
, selected_frame
))
1497 Fselect_frame (internal_last_event_frame
, Qnil
);
1499 /* If it has changed current-menubar from previous value,
1500 really recompute the menubar from the value. */
1501 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1502 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1503 call0 (Qrecompute_lucid_menubar
);
1505 before_command_key_count
= this_command_key_count
;
1506 before_command_echo_length
= echo_length ();
1508 Vthis_command
= Qnil
;
1509 real_this_command
= Qnil
;
1511 /* Read next key sequence; i gets its length. */
1512 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1515 /* A filter may have run while we were reading the input. */
1516 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1518 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1519 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1523 /* Now we have read a key sequence of length I,
1524 or else I is 0 and we found end of file. */
1526 if (i
== 0) /* End of file -- happens only in */
1527 return Qnil
; /* a kbd macro, at the end. */
1528 /* -1 means read_key_sequence got a menu that was rejected.
1529 Just loop around and read another command. */
1533 this_command_key_count
= 0;
1534 this_command_key_count_reset
= 0;
1535 this_single_command_key_start
= 0;
1539 last_command_char
= keybuf
[i
- 1];
1541 /* If the previous command tried to force a specific window-start,
1542 forget about that, in case this command moves point far away
1543 from that position. But also throw away beg_unchanged and
1544 end_unchanged information in that case, so that redisplay will
1545 update the whole window properly. */
1546 if (!NILP (XWINDOW (selected_window
)->force_start
))
1549 XWINDOW (selected_window
)->force_start
= Qnil
;
1550 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1551 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1554 cmd
= read_key_sequence_cmd
;
1555 if (!NILP (Vexecuting_kbd_macro
))
1557 if (!NILP (Vquit_flag
))
1559 Vexecuting_kbd_macro
= Qt
;
1560 QUIT
; /* Make some noise. */
1561 /* Will return since macro now empty. */
1565 /* Do redisplay processing after this command except in special
1566 cases identified below. */
1567 prev_buffer
= current_buffer
;
1568 prev_modiff
= MODIFF
;
1569 last_point_position
= PT
;
1570 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1572 /* By default, we adjust point to a boundary of a region that
1573 has such a property that should be treated intangible
1574 (e.g. composition, display). But, some commands will set
1575 this variable differently. */
1576 Vdisable_point_adjustment
= Qnil
;
1578 /* Process filters and timers may have messed with deactivate-mark.
1579 reset it before we execute the command. */
1580 Vdeactivate_mark
= Qnil
;
1582 /* Remap command through active keymaps */
1583 Vthis_original_command
= cmd
;
1587 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1591 /* Execute the command. */
1593 Vthis_command
= cmd
;
1594 real_this_command
= cmd
;
1595 /* Note that the value cell will never directly contain nil
1596 if the symbol is a local variable. */
1597 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1598 safe_run_hooks (Qpre_command_hook
);
1600 already_adjusted
= 0;
1602 if (NILP (Vthis_command
))
1604 /* nil means key is undefined. */
1605 Lisp_Object keys
= Fvector (i
, keybuf
);
1606 keys
= Fkey_description (keys
, Qnil
);
1608 message_with_string ("%s is undefined", keys
, 0);
1609 current_kboard
->defining_kbd_macro
= Qnil
;
1610 update_mode_lines
= 1;
1611 current_kboard
->Vprefix_arg
= Qnil
;
1615 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1617 /* In case we jump to directly_done. */
1618 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1620 /* Recognize some common commands in common situations and
1621 do them directly. */
1622 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1624 struct Lisp_Char_Table
*dp
1625 = window_display_table (XWINDOW (selected_window
));
1626 lose
= FETCH_CHAR (PT_BYTE
);
1628 if (! NILP (Vpost_command_hook
))
1629 /* Put this before calling adjust_point_for_property
1630 so it will only get called once in any case. */
1632 if (current_buffer
== prev_buffer
1633 && last_point_position
!= PT
1634 && NILP (Vdisable_point_adjustment
)
1635 && NILP (Vglobal_disable_point_adjustment
))
1636 adjust_point_for_property (last_point_position
, 0);
1637 already_adjusted
= 1;
1638 if (PT
== last_point_position
+ 1
1640 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1641 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1642 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1643 && (lose
>= 0x20 && lose
< 0x7f)))
1644 : (lose
>= 0x20 && lose
< 0x7f))
1645 /* To extract the case of continuation on
1646 wide-column characters. */
1647 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1648 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1650 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1652 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1654 && !windows_or_buffers_changed
1655 && EQ (current_buffer
->selective_display
, Qnil
)
1656 && !detect_input_pending ()
1657 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1658 && NILP (Vexecuting_kbd_macro
))
1659 direct_output_forward_char (1);
1662 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1664 struct Lisp_Char_Table
*dp
1665 = window_display_table (XWINDOW (selected_window
));
1667 lose
= FETCH_CHAR (PT_BYTE
);
1668 if (! NILP (Vpost_command_hook
))
1670 if (current_buffer
== prev_buffer
1671 && last_point_position
!= PT
1672 && NILP (Vdisable_point_adjustment
)
1673 && NILP (Vglobal_disable_point_adjustment
))
1674 adjust_point_for_property (last_point_position
, 0);
1675 already_adjusted
= 1;
1676 if (PT
== last_point_position
- 1
1678 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1679 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1680 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1681 && (lose
>= 0x20 && lose
< 0x7f)))
1682 : (lose
>= 0x20 && lose
< 0x7f))
1683 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1685 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1687 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1689 && !windows_or_buffers_changed
1690 && EQ (current_buffer
->selective_display
, Qnil
)
1691 && !detect_input_pending ()
1692 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1693 && NILP (Vexecuting_kbd_macro
))
1694 direct_output_forward_char (-1);
1697 else if (EQ (Vthis_command
, Qself_insert_command
)
1698 /* Try this optimization only on char keystrokes. */
1699 && NATNUMP (last_command_char
)
1700 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1703 = translate_char (Vtranslation_table_for_input
,
1704 XFASTINT (last_command_char
), 0, 0, 0);
1706 if (NILP (Vexecuting_kbd_macro
)
1707 && !EQ (minibuf_window
, selected_window
))
1709 if (!nonundocount
|| nonundocount
>= 20)
1717 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1719 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1721 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1723 || MODIFF
<= SAVE_MODIFF
1724 || windows_or_buffers_changed
1725 || !EQ (current_buffer
->selective_display
, Qnil
)
1726 || detect_input_pending ()
1727 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1728 || !NILP (Vexecuting_kbd_macro
));
1730 value
= internal_self_insert (c
, 0);
1735 if (! NILP (Vpost_command_hook
))
1736 /* Put this before calling adjust_point_for_property
1737 so it will only get called once in any case. */
1740 /* VALUE == 1 when AFTER-CHANGE functions are
1741 installed which is the case most of the time
1742 because FONT-LOCK installs one. */
1743 if (!lose
&& !value
)
1744 direct_output_for_insert (c
);
1749 /* Here for a command that isn't executed directly */
1752 #ifdef HAVE_X_WINDOWS
1753 int scount
= SPECPDL_INDEX ();
1755 if (display_hourglass_p
1756 && NILP (Vexecuting_kbd_macro
))
1758 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1764 if (NILP (current_kboard
->Vprefix_arg
))
1766 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1768 #ifdef HAVE_X_WINDOWS
1769 /* Do not check display_hourglass_p here, because
1770 Fcommand_execute could change it, but we should cancel
1771 hourglass cursor anyway.
1772 But don't cancel the hourglass within a macro
1773 just because a command in the macro finishes. */
1774 if (NILP (Vexecuting_kbd_macro
))
1775 unbind_to (scount
, Qnil
);
1780 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1782 /* Note that the value cell will never directly contain nil
1783 if the symbol is a local variable. */
1784 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1785 safe_run_hooks (Qpost_command_hook
);
1787 /* If displaying a message, resize the echo area window to fit
1788 that message's size exactly. */
1789 if (!NILP (echo_area_buffer
[0]))
1790 resize_echo_area_exactly ();
1792 if (!NILP (Vdeferred_action_list
))
1793 safe_run_hooks (Qdeferred_action_function
);
1795 /* If there is a prefix argument,
1796 1) We don't want Vlast_command to be ``universal-argument''
1797 (that would be dumb), so don't set Vlast_command,
1798 2) we want to leave echoing on so that the prefix will be
1799 echoed as part of this key sequence, so don't call
1801 3) we want to leave this_command_key_count non-zero, so that
1802 read_char will realize that it is re-reading a character, and
1803 not echo it a second time.
1805 If the command didn't actually create a prefix arg,
1806 but is merely a frame event that is transparent to prefix args,
1807 then the above doesn't apply. */
1808 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1810 current_kboard
->Vlast_command
= Vthis_command
;
1811 current_kboard
->Vreal_last_command
= real_this_command
;
1813 this_command_key_count
= 0;
1814 this_command_key_count_reset
= 0;
1815 this_single_command_key_start
= 0;
1818 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1820 /* Setting transient-mark-mode to `only' is a way of
1821 turning it on for just one command. */
1823 if (EQ (Vtransient_mark_mode
, Qidentity
))
1824 Vtransient_mark_mode
= Qnil
;
1825 if (EQ (Vtransient_mark_mode
, Qonly
))
1826 Vtransient_mark_mode
= Qidentity
;
1828 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1830 /* We could also call `deactivate'mark'. */
1831 if (EQ (Vtransient_mark_mode
, Qlambda
))
1832 Vtransient_mark_mode
= Qnil
;
1835 current_buffer
->mark_active
= Qnil
;
1836 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1839 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1840 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1845 if (current_buffer
== prev_buffer
1846 && last_point_position
!= PT
1847 && NILP (Vdisable_point_adjustment
)
1848 && NILP (Vglobal_disable_point_adjustment
)
1849 && !already_adjusted
)
1850 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1852 /* Install chars successfully executed in kbd macro. */
1854 if (!NILP (current_kboard
->defining_kbd_macro
)
1855 && NILP (current_kboard
->Vprefix_arg
))
1856 finalize_kbd_macro_chars ();
1860 any_kboard_state ();
1865 extern Lisp_Object Qcomposition
, Qdisplay
;
1867 /* Adjust point to a boundary of a region that has such a property
1868 that should be treated intangible. For the moment, we check
1869 `composition', `display' and `invisible' properties.
1870 LAST_PT is the last position of point. */
1872 extern Lisp_Object Qafter_string
, Qbefore_string
;
1873 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1876 adjust_point_for_property (last_pt
, modified
)
1881 Lisp_Object val
, overlay
, tmp
;
1882 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1885 /* FIXME: cycling is probably not necessary because these properties
1886 can't be usefully combined anyway. */
1887 while (check_composition
|| check_display
|| check_invisible
)
1889 if (check_composition
1890 && PT
> BEGV
&& PT
< ZV
1891 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1892 && COMPOSITION_VALID_P (beg
, end
, val
)
1893 && beg
< PT
/* && end > PT <- It's always the case. */
1894 && (last_pt
<= beg
|| last_pt
>= end
))
1897 SET_PT (PT
< last_pt
? beg
: end
);
1898 check_display
= check_invisible
= 1;
1900 check_composition
= 0;
1902 && PT
> BEGV
&& PT
< ZV
1903 && !NILP (val
= get_char_property_and_overlay
1904 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1905 && display_prop_intangible_p (val
)
1906 && (!OVERLAYP (overlay
)
1907 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1908 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1909 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1910 && (beg
< PT
/* && end > PT <- It's always the case. */
1911 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1914 SET_PT (PT
< last_pt
1915 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1917 check_composition
= check_invisible
= 1;
1920 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1922 int inv
, ellipsis
= 0;
1925 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1927 && !NILP (val
= get_char_property_and_overlay
1928 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1929 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1931 ellipsis
= ellipsis
|| inv
> 1
1932 || (OVERLAYP (overlay
)
1933 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1934 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1935 tmp
= Fnext_single_char_property_change
1936 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1937 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1940 && !NILP (val
= get_char_property_and_overlay
1941 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1942 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1944 ellipsis
= ellipsis
|| inv
> 1
1945 || (OVERLAYP (overlay
)
1946 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1947 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1948 tmp
= Fprevious_single_char_property_change
1949 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1950 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1953 /* Move away from the inside area. */
1954 if (beg
< PT
&& end
> PT
)
1956 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1957 /* We haven't moved yet (so we don't need to fear
1958 infinite-looping) and we were outside the range
1959 before (so either end of the range still corresponds
1960 to a move in the right direction): pretend we moved
1961 less than we actually did, so that we still have
1962 more freedom below in choosing which end of the range
1964 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1965 /* We either have moved already or the last point
1966 was already in the range: we don't get to choose
1967 which end of the range we have to go to. */
1968 : (PT
< last_pt
? beg
: end
));
1969 check_composition
= check_display
= 1;
1971 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1972 the point to something other than its argument, due to
1973 point-motion hooks, intangibility, etc. */
1974 xassert (PT
== beg
|| PT
== end
);
1977 /* Pretend the area doesn't exist if the buffer is not
1979 if (!modified
&& !ellipsis
&& beg
< end
)
1981 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1982 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1983 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1984 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1985 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1986 /* We've already moved as far as we can. Trying to go
1987 to the other end would mean moving backwards and thus
1988 could lead to an infinite loop. */
1990 else if (val
= get_pos_property (make_number (PT
),
1992 TEXT_PROP_MEANS_INVISIBLE (val
)
1993 && (val
= get_pos_property
1994 (make_number (PT
== beg
? end
: beg
),
1996 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1997 (check_composition
= check_display
= 1,
1998 SET_PT (PT
== beg
? end
: beg
));
2001 check_invisible
= 0;
2005 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2008 safe_run_hooks_1 (hook
)
2011 return call1 (Vrun_hooks
, Vinhibit_quit
);
2014 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2017 safe_run_hooks_error (data
)
2020 Lisp_Object args
[3];
2021 args
[0] = build_string ("Error in %s: %s");
2022 args
[1] = Vinhibit_quit
;
2025 return Fset (Vinhibit_quit
, Qnil
);
2028 /* If we get an error while running the hook, cause the hook variable
2029 to be nil. Also inhibit quits, so that C-g won't cause the hook
2030 to mysteriously evaporate. */
2033 safe_run_hooks (hook
)
2036 int count
= SPECPDL_INDEX ();
2037 specbind (Qinhibit_quit
, hook
);
2039 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2041 unbind_to (count
, Qnil
);
2045 /* Number of seconds between polling for input. This is a Lisp
2046 variable that can be bound. */
2048 EMACS_INT polling_period
;
2050 /* Nonzero means polling for input is temporarily suppressed. */
2052 int poll_suppress_count
;
2054 /* Asynchronous timer for polling. */
2056 struct atimer
*poll_timer
;
2059 #ifdef POLL_FOR_INPUT
2061 /* Poll for input, so what we catch a C-g if it comes in. This
2062 function is called from x_make_frame_visible, see comment
2068 if (interrupt_input_blocked
== 0
2069 && !waiting_for_input
)
2070 read_avail_input (0);
2073 /* Timer callback function for poll_timer. TIMER is equal to
2077 poll_for_input (timer
)
2078 struct atimer
*timer
;
2080 if (poll_suppress_count
== 0)
2082 interrupt_input_pending
= 1;
2084 poll_for_input_1 ();
2088 #endif /* POLL_FOR_INPUT */
2090 /* Begin signals to poll for input, if they are appropriate.
2091 This function is called unconditionally from various places. */
2096 #ifdef POLL_FOR_INPUT
2097 /* XXX This condition was (read_socket_hook && !interrupt_input),
2098 but read_socket_hook is not global anymore. Let's pretend that
2100 if (!interrupt_input
)
2102 /* Turn alarm handling on unconditionally. It might have
2103 been turned off in process.c. */
2104 turn_on_atimers (1);
2106 /* If poll timer doesn't exist, are we need one with
2107 a different interval, start a new one. */
2108 if (poll_timer
== NULL
2109 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2111 EMACS_TIME interval
;
2114 cancel_atimer (poll_timer
);
2116 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2117 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2118 poll_for_input
, NULL
);
2121 /* Let the timer's callback function poll for input
2122 if this becomes zero. */
2123 --poll_suppress_count
;
2128 /* Nonzero if we are using polling to handle input asynchronously. */
2131 input_polling_used ()
2133 #ifdef POLL_FOR_INPUT
2134 /* XXX This condition was (read_socket_hook && !interrupt_input),
2135 but read_socket_hook is not global anymore. Let's pretend that
2137 return !interrupt_input
;
2143 /* Turn off polling. */
2148 #ifdef POLL_FOR_INPUT
2149 /* XXX This condition was (read_socket_hook && !interrupt_input),
2150 but read_socket_hook is not global anymore. Let's pretend that
2152 if (!interrupt_input
)
2153 ++poll_suppress_count
;
2157 /* Set the value of poll_suppress_count to COUNT
2158 and start or stop polling accordingly. */
2161 set_poll_suppress_count (count
)
2164 #ifdef POLL_FOR_INPUT
2165 if (count
== 0 && poll_suppress_count
!= 0)
2167 poll_suppress_count
= 1;
2170 else if (count
!= 0 && poll_suppress_count
== 0)
2174 poll_suppress_count
= count
;
2178 /* Bind polling_period to a value at least N.
2179 But don't decrease it. */
2182 bind_polling_period (n
)
2185 #ifdef POLL_FOR_INPUT
2186 int new = polling_period
;
2191 stop_other_atimers (poll_timer
);
2193 specbind (Qpolling_period
, make_number (new));
2194 /* Start a new alarm with the new period. */
2199 /* Apply the control modifier to CHARACTER. */
2205 /* Save the upper bits here. */
2206 int upper
= c
& ~0177;
2210 /* Everything in the columns containing the upper-case letters
2211 denotes a control character. */
2212 if (c
>= 0100 && c
< 0140)
2216 /* Set the shift modifier for a control char
2217 made from a shifted letter. But only for letters! */
2218 if (oc
>= 'A' && oc
<= 'Z')
2219 c
|= shift_modifier
;
2222 /* The lower-case letters denote control characters too. */
2223 else if (c
>= 'a' && c
<= 'z')
2226 /* Include the bits for control and shift
2227 only if the basic ASCII code can't indicate them. */
2231 /* Replace the high bits. */
2232 c
|= (upper
& ~ctrl_modifier
);
2237 /* Display the help-echo property of the character after the mouse pointer.
2238 Either show it in the echo area, or call show-help-function to display
2239 it by other means (maybe in a tooltip).
2241 If HELP is nil, that means clear the previous help echo.
2243 If HELP is a string, display that string. If HELP is a function,
2244 call it with OBJECT and POS as arguments; the function should
2245 return a help string or nil for none. For all other types of HELP,
2246 evaluate it to obtain a string.
2248 WINDOW is the window in which the help was generated, if any.
2249 It is nil if not in a window.
2251 If OBJECT is a buffer, POS is the position in the buffer where the
2252 `help-echo' text property was found.
2254 If OBJECT is an overlay, that overlay has a `help-echo' property,
2255 and POS is the position in the overlay's buffer under the mouse.
2257 If OBJECT is a string (an overlay string or a string displayed with
2258 the `display' property). POS is the position in that string under
2261 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2262 echo overwrites a keystroke echo currently displayed in the echo
2265 Note: this function may only be called with HELP nil or a string
2266 from X code running asynchronously. */
2269 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2270 Lisp_Object help
, window
, object
, pos
;
2271 int ok_to_overwrite_keystroke_echo
;
2273 if (!NILP (help
) && !STRINGP (help
))
2275 if (FUNCTIONP (help
))
2277 Lisp_Object args
[4];
2282 help
= safe_call (4, args
);
2285 help
= safe_eval (help
);
2287 if (!STRINGP (help
))
2292 if (!noninteractive
&& STRINGP (help
))
2293 help
= call1 (Qmouse_fixup_help_message
, 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_kbd_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_kbd_macro
, Qt
)
2492 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2498 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2499 if (STRINGP (Vexecuting_kbd_macro
)
2500 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2501 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2503 executing_kbd_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
)
2959 && CHAR_VALID_P (XINT (c
), 0)))
2962 d
= Faref (Vkeyboard_translate_table
, c
);
2963 /* nil in keyboard-translate-table means no translation. */
2969 /* If this event is a mouse click in the menu bar,
2970 return just menu-bar for now. Modify the mouse click event
2971 so we won't do this twice, then queue it up. */
2972 if (EVENT_HAS_PARAMETERS (c
)
2974 && CONSP (EVENT_START (c
))
2975 && CONSP (XCDR (EVENT_START (c
))))
2979 posn
= POSN_POSN (EVENT_START (c
));
2980 /* Handle menu-bar events:
2981 insert the dummy prefix event `menu-bar'. */
2982 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2984 /* Change menu-bar to (menu-bar) as the event "position". */
2985 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2988 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2993 /* Store these characters into recent_keys, the dribble file if any,
2994 and the keyboard macro being defined, if any. */
2996 if (! NILP (also_record
))
2997 record_char (also_record
);
2999 /* Wipe the echo area.
3000 But first, if we are about to use an input method,
3001 save the echo area contents for it to refer to. */
3003 && ! NILP (Vinput_method_function
)
3004 && (unsigned) XINT (c
) >= ' '
3005 && (unsigned) XINT (c
) != 127
3006 && (unsigned) XINT (c
) < 256)
3008 previous_echo_area_message
= Fcurrent_message ();
3009 Vinput_method_previous_message
= previous_echo_area_message
;
3012 /* Now wipe the echo area, except for help events which do their
3013 own stuff with the echo area. */
3015 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3016 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3018 if (!NILP (echo_area_buffer
[0]))
3019 safe_run_hooks (Qecho_area_clear_hook
);
3020 clear_message (1, 0);
3023 reread_for_input_method
:
3025 /* Pass this to the input method, if appropriate. */
3027 && ! NILP (Vinput_method_function
)
3028 /* Don't run the input method within a key sequence,
3029 after the first event of the key sequence. */
3030 && NILP (prev_event
)
3031 && (unsigned) XINT (c
) >= ' '
3032 && (unsigned) XINT (c
) != 127
3033 && (unsigned) XINT (c
) < 256)
3036 int key_count
, key_count_reset
;
3037 struct gcpro gcpro1
;
3038 int count
= SPECPDL_INDEX ();
3040 /* Save the echo status. */
3041 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3042 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3043 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3044 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3047 if (before_command_restore_flag
)
3049 this_command_key_count
= before_command_key_count_1
;
3050 if (this_command_key_count
< this_single_command_key_start
)
3051 this_single_command_key_start
= this_command_key_count
;
3052 echo_truncate (before_command_echo_length_1
);
3053 before_command_restore_flag
= 0;
3057 /* Save the this_command_keys status. */
3058 key_count
= this_command_key_count
;
3059 key_count_reset
= this_command_key_count_reset
;
3062 keys
= Fcopy_sequence (this_command_keys
);
3067 /* Clear out this_command_keys. */
3068 this_command_key_count
= 0;
3069 this_command_key_count_reset
= 0;
3071 /* Now wipe the echo area. */
3072 if (!NILP (echo_area_buffer
[0]))
3073 safe_run_hooks (Qecho_area_clear_hook
);
3074 clear_message (1, 0);
3077 /* If we are not reading a key sequence,
3078 never use the echo area. */
3081 specbind (Qinput_method_use_echo_area
, Qt
);
3084 /* Call the input method. */
3085 tem
= call1 (Vinput_method_function
, c
);
3087 tem
= unbind_to (count
, tem
);
3089 /* Restore the saved echoing state
3090 and this_command_keys state. */
3091 this_command_key_count
= key_count
;
3092 this_command_key_count_reset
= key_count_reset
;
3094 this_command_keys
= keys
;
3097 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3098 current_kboard
->echo_string
= saved_echo_string
;
3099 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3100 if (saved_immediate_echo
)
3105 /* The input method can return no events. */
3108 /* Bring back the previous message, if any. */
3109 if (! NILP (previous_echo_area_message
))
3110 message_with_string ("%s", previous_echo_area_message
, 0);
3113 /* It returned one event or more. */
3115 Vunread_post_input_method_events
3116 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3121 /* Display help if not echoing. */
3122 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3124 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3125 Lisp_Object help
, object
, position
, window
, tem
;
3127 tem
= Fcdr (XCDR (c
));
3130 window
= Fcar (tem
);
3132 object
= Fcar (tem
);
3134 position
= Fcar (tem
);
3136 show_help_echo (help
, window
, object
, position
, 0);
3138 /* We stopped being idle for this event; undo that. */
3139 timer_resume_idle ();
3143 if (! reread
|| this_command_key_count
== 0
3144 || this_command_key_count_reset
)
3147 /* Don't echo mouse motion events. */
3148 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3149 && NILP (Fzerop (Vecho_keystrokes
))
3150 && ! (EVENT_HAS_PARAMETERS (c
)
3151 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3154 if (! NILP (also_record
))
3155 echo_char (also_record
);
3156 /* Once we reread a character, echoing can happen
3157 the next time we pause to read a new one. */
3158 ok_to_echo_at_next_pause
= current_kboard
;
3161 /* Record this character as part of the current key. */
3162 add_command_key (c
);
3163 if (! NILP (also_record
))
3164 add_command_key (also_record
);
3167 last_input_char
= c
;
3170 /* Process the help character specially if enabled */
3171 if (!NILP (Vhelp_form
) && help_char_p (c
))
3174 count
= SPECPDL_INDEX ();
3176 record_unwind_protect (Fset_window_configuration
,
3177 Fcurrent_window_configuration (Qnil
));
3179 tem0
= Feval (Vhelp_form
);
3181 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3185 c
= read_char (0, 0, 0, Qnil
, 0);
3186 while (BUFFERP (c
));
3187 /* Remove the help from the frame */
3188 unbind_to (count
, Qnil
);
3191 if (EQ (c
, make_number (040)))
3195 c
= read_char (0, 0, 0, Qnil
, 0);
3196 while (BUFFERP (c
));
3205 /* Record a key that came from a mouse menu.
3206 Record it for echoing, for this-command-keys, and so on. */
3212 /* Wipe the echo area. */
3213 clear_message (1, 0);
3218 before_command_key_count
= this_command_key_count
;
3219 before_command_echo_length
= echo_length ();
3222 /* Don't echo mouse motion events. */
3223 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3224 && NILP (Fzerop (Vecho_keystrokes
)))
3228 /* Once we reread a character, echoing can happen
3229 the next time we pause to read a new one. */
3230 ok_to_echo_at_next_pause
= 0;
3233 /* Record this character as part of the current key. */
3234 add_command_key (c
);
3236 /* Re-reading in the middle of a command */
3237 last_input_char
= c
;
3241 /* Return 1 if should recognize C as "the help character". */
3249 if (EQ (c
, Vhelp_char
))
3251 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3252 if (EQ (c
, XCAR (tail
)))
3257 /* Record the input event C in various ways. */
3265 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3267 /* To avoid filling recent_keys with help-echo and mouse-movement
3268 events, we filter out repeated help-echo events, only store the
3269 first and last in a series of mouse-movement events, and don't
3270 store repeated help-echo events which are only separated by
3271 mouse-movement events. */
3273 Lisp_Object ev1
, ev2
, ev3
;
3276 if ((ix1
= recent_keys_index
- 1) < 0)
3277 ix1
= NUM_RECENT_KEYS
- 1;
3278 ev1
= AREF (recent_keys
, ix1
);
3280 if ((ix2
= ix1
- 1) < 0)
3281 ix2
= NUM_RECENT_KEYS
- 1;
3282 ev2
= AREF (recent_keys
, ix2
);
3284 if ((ix3
= ix2
- 1) < 0)
3285 ix3
= NUM_RECENT_KEYS
- 1;
3286 ev3
= AREF (recent_keys
, ix3
);
3288 if (EQ (XCAR (c
), Qhelp_echo
))
3290 /* Don't record `help-echo' in recent_keys unless it shows some help
3291 message, and a different help than the previously recorded
3293 Lisp_Object help
, last_help
;
3295 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3296 if (!STRINGP (help
))
3298 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3299 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3301 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3302 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3303 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3305 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3306 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3307 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3308 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3311 else if (EQ (XCAR (c
), Qmouse_movement
))
3313 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3314 So additional mouse movement events replace the last element. */
3315 Lisp_Object last_window
, window
;
3317 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3318 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3319 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3320 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3321 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3323 ASET (recent_keys
, ix1
, c
);
3329 store_kbd_macro_char (c
);
3334 ASET (recent_keys
, recent_keys_index
, c
);
3335 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3336 recent_keys_index
= 0;
3338 else if (recorded
< 0)
3340 /* We need to remove one or two events from recent_keys.
3341 To do this, we simply put nil at those events and move the
3342 recent_keys_index backwards over those events. Usually,
3343 users will never see those nil events, as they will be
3344 overwritten by the command keys entered to see recent_keys
3347 while (recorded
++ < 0 && total_keys
> 0)
3349 if (total_keys
< NUM_RECENT_KEYS
)
3351 if (--recent_keys_index
< 0)
3352 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3353 ASET (recent_keys
, recent_keys_index
, Qnil
);
3357 num_nonmacro_input_events
++;
3359 /* Write c to the dribble file. If c is a lispy event, write
3360 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3361 If you, dear reader, have a better idea, you've got the source. :-) */
3366 if (XUINT (c
) < 0x100)
3367 putc (XINT (c
), dribble
);
3369 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3373 Lisp_Object dribblee
;
3375 /* If it's a structured event, take the event header. */
3376 dribblee
= EVENT_HEAD (c
);
3378 if (SYMBOLP (dribblee
))
3380 putc ('<', dribble
);
3381 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3382 SBYTES (SYMBOL_NAME (dribblee
)),
3384 putc ('>', dribble
);
3396 struct buffer
*old
= current_buffer
;
3397 Fprinc (object
, Qnil
);
3398 set_buffer_internal (XBUFFER (Vstandard_output
));
3399 call0 (intern ("help-mode"));
3400 set_buffer_internal (old
);
3404 /* Copy out or in the info on where C-g should throw to.
3405 This is used when running Lisp code from within get_char,
3406 in case get_char is called recursively.
3407 See read_process_output. */
3413 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3417 restore_getcjmp (temp
)
3420 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3425 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3426 of this function. */
3429 tracking_off (old_value
)
3430 Lisp_Object old_value
;
3432 do_mouse_tracking
= old_value
;
3433 if (NILP (old_value
))
3435 /* Redisplay may have been preempted because there was input
3436 available, and it assumes it will be called again after the
3437 input has been processed. If the only input available was
3438 the sort that we have just disabled, then we need to call
3440 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3442 redisplay_preserve_echo_area (6);
3443 get_input_pending (&input_pending
,
3444 READABLE_EVENTS_DO_TIMERS_NOW
);
3450 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3451 doc
: /* Evaluate BODY with mouse movement events enabled.
3452 Within a `track-mouse' form, mouse motion generates input events that
3453 you can read with `read-event'.
3454 Normally, mouse motion is ignored.
3455 usage: (track-mouse BODY ...) */)
3459 int count
= SPECPDL_INDEX ();
3462 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3464 do_mouse_tracking
= Qt
;
3466 val
= Fprogn (args
);
3467 return unbind_to (count
, val
);
3470 /* If mouse has moved on some frame, return one of those frames.
3471 Return 0 otherwise. */
3476 Lisp_Object tail
, frame
;
3478 FOR_EACH_FRAME (tail
, frame
)
3480 if (XFRAME (frame
)->mouse_moved
)
3481 return XFRAME (frame
);
3487 #endif /* HAVE_MOUSE */
3489 /* Low level keyboard/mouse input.
3490 kbd_buffer_store_event places events in kbd_buffer, and
3491 kbd_buffer_get_event retrieves them. */
3493 /* Return true iff there are any events in the queue that read-char
3494 would return. If this returns false, a read-char would block. */
3496 readable_events (flags
)
3499 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3502 /* If the buffer contains only FOCUS_IN_EVENT events, and
3503 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3504 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3506 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3507 #ifdef USE_TOOLKIT_SCROLL_BARS
3508 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3512 struct input_event
*event
;
3514 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3521 #ifdef USE_TOOLKIT_SCROLL_BARS
3522 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3524 event
->kind
== FOCUS_IN_EVENT
)
3525 #ifdef USE_TOOLKIT_SCROLL_BARS
3526 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3527 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3528 && event
->part
== scroll_bar_handle
3529 && event
->modifiers
== 0)
3534 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3537 while (event
!= kbd_store_ptr
);
3544 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3545 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3550 if (current_kboard
->kbd_queue_has_data
)
3556 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3557 if (kb
->kbd_queue_has_data
)
3563 /* Set this for debugging, to have a way to get out */
3568 event_to_kboard (event
)
3569 struct input_event
*event
;
3572 frame
= event
->frame_or_window
;
3574 frame
= XCAR (frame
);
3575 else if (WINDOWP (frame
))
3576 frame
= WINDOW_FRAME (XWINDOW (frame
));
3578 /* There are still some events that don't set this field.
3579 For now, just ignore the problem.
3580 Also ignore dead frames here. */
3581 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3584 return FRAME_KBOARD (XFRAME (frame
));
3589 Lisp_Object Vthrow_on_input
;
3591 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3594 kbd_buffer_store_event (event
)
3595 register struct input_event
*event
;
3597 kbd_buffer_store_event_hold (event
, 0);
3600 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3602 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3603 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3604 Else, if EVENT is a quit event, store the quit event
3605 in HOLD_QUIT, and return (thus ignoring further events).
3607 This is used in read_avail_input to postpone the processing
3608 of the quit event until all subsequent input events have been
3609 parsed (and discarded).
3613 kbd_buffer_store_event_hold (event
, hold_quit
)
3614 register struct input_event
*event
;
3615 struct input_event
*hold_quit
;
3617 if (event
->kind
== NO_EVENT
)
3620 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3623 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3625 register int c
= event
->code
& 0377;
3627 if (event
->modifiers
& ctrl_modifier
)
3628 c
= make_ctrl_char (c
);
3630 c
|= (event
->modifiers
3631 & (meta_modifier
| alt_modifier
3632 | hyper_modifier
| super_modifier
));
3638 struct input_event
*sp
;
3641 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3642 kb
!= current_kboard
))
3645 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3646 Fcons (make_number (c
), Qnil
));
3647 kb
->kbd_queue_has_data
= 1;
3648 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3650 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3653 if (event_to_kboard (sp
) == kb
)
3655 sp
->kind
= NO_EVENT
;
3656 sp
->frame_or_window
= Qnil
;
3666 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3670 /* If this results in a quit_char being returned to Emacs as
3671 input, set Vlast_event_frame properly. If this doesn't
3672 get returned to Emacs as an event, the next event read
3673 will set Vlast_event_frame again, so this is safe to do. */
3677 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3679 focus
= event
->frame_or_window
;
3680 internal_last_event_frame
= focus
;
3681 Vlast_event_frame
= focus
;
3684 last_event_timestamp
= event
->timestamp
;
3685 handle_interrupt ();
3689 if (c
&& c
== stop_character
)
3695 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3696 Just ignore the second one. */
3697 else if (event
->kind
== BUFFER_SWITCH_EVENT
3698 && kbd_fetch_ptr
!= kbd_store_ptr
3699 && ((kbd_store_ptr
== kbd_buffer
3700 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3701 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3704 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3705 kbd_store_ptr
= kbd_buffer
;
3707 /* Don't let the very last slot in the buffer become full,
3708 since that would make the two pointers equal,
3709 and that is indistinguishable from an empty buffer.
3710 Discard the event if it would fill the last slot. */
3711 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3713 *kbd_store_ptr
= *event
;
3717 /* If we're inside while-no-input, and this event qualifies
3718 as input, set quit-flag to cause an interrupt. */
3719 if (!NILP (Vthrow_on_input
)
3720 && event
->kind
!= FOCUS_IN_EVENT
3721 && event
->kind
!= HELP_EVENT
3722 && event
->kind
!= DEICONIFY_EVENT
)
3724 Vquit_flag
= Vthrow_on_input
;
3725 /* If we're inside a function that wants immediate quits,
3727 if (immediate_quit
&& NILP (Vinhibit_quit
))
3737 /* Put an input event back in the head of the event queue. */
3740 kbd_buffer_unget_event (event
)
3741 register struct input_event
*event
;
3743 if (kbd_fetch_ptr
== kbd_buffer
)
3744 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3746 /* Don't let the very last slot in the buffer become full, */
3747 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3750 *kbd_fetch_ptr
= *event
;
3755 /* Generate HELP_EVENT input_events in BUFP which has room for
3756 SIZE events. If there's not enough room in BUFP, ignore this
3759 HELP is the help form.
3761 FRAME is the frame on which the help is generated. OBJECT is the
3762 Lisp object where the help was found (a buffer, a string, an
3763 overlay, or nil if neither from a string nor from a buffer. POS is
3764 the position within OBJECT where the help was found.
3766 Value is the number of input_events generated. */
3769 gen_help_event (help
, frame
, window
, object
, pos
)
3770 Lisp_Object help
, frame
, object
, window
;
3773 struct input_event event
;
3777 event
.kind
= HELP_EVENT
;
3778 event
.frame_or_window
= frame
;
3780 event
.x
= WINDOWP (window
) ? window
: frame
;
3783 kbd_buffer_store_event (&event
);
3787 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3790 kbd_buffer_store_help_event (frame
, help
)
3791 Lisp_Object frame
, help
;
3793 struct input_event event
;
3795 event
.kind
= HELP_EVENT
;
3796 event
.frame_or_window
= frame
;
3801 kbd_buffer_store_event (&event
);
3805 /* Discard any mouse events in the event buffer by setting them to
3808 discard_mouse_events ()
3810 struct input_event
*sp
;
3811 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3813 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3816 if (sp
->kind
== MOUSE_CLICK_EVENT
3817 || sp
->kind
== WHEEL_EVENT
3819 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3821 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3823 sp
->kind
= NO_EVENT
;
3829 /* Return non-zero if there are any real events waiting in the event
3830 buffer, not counting `NO_EVENT's.
3832 If DISCARD is non-zero, discard NO_EVENT events at the front of
3833 the input queue, possibly leaving the input queue empty if there
3834 are no real input events. */
3837 kbd_buffer_events_waiting (discard
)
3840 struct input_event
*sp
;
3842 for (sp
= kbd_fetch_ptr
;
3843 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3846 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3853 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3857 /* Clear input event EVENT. */
3861 struct input_event
*event
;
3863 event
->kind
= NO_EVENT
;
3867 /* Read one event from the event buffer, waiting if necessary.
3868 The value is a Lisp object representing the event.
3869 The value is nil for an event that should be ignored,
3870 or that was handled here.
3871 We always read and discard one event. */
3874 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3876 int *used_mouse_menu
;
3885 *kbp
= current_kboard
;
3889 /* Wait until there is input available. */
3892 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3895 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3899 /* If the quit flag is set, then read_char will return
3900 quit_char, so that counts as "available input." */
3901 if (!NILP (Vquit_flag
))
3902 quit_throw_to_read_char ();
3904 /* One way or another, wait until input is available; then, if
3905 interrupt handlers have not read it, read it now. */
3908 wait_for_kbd_input ();
3910 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3914 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3917 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3921 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3923 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3924 /* Pass 1 for EXPECT since we just waited to have input. */
3925 read_avail_input (1);
3927 #endif /* not VMS */
3930 if (CONSP (Vunread_command_events
))
3933 first
= XCAR (Vunread_command_events
);
3934 Vunread_command_events
= XCDR (Vunread_command_events
);
3935 *kbp
= current_kboard
;
3939 /* At this point, we know that there is a readable event available
3940 somewhere. If the event queue is empty, then there must be a
3941 mouse movement enabled and available. */
3942 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3944 struct input_event
*event
;
3946 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3950 last_event_timestamp
= event
->timestamp
;
3953 *kbp
= event_to_kboard (event
);
3955 *kbp
= current_kboard
; /* Better than returning null ptr? */
3957 *kbp
= &the_only_kboard
;
3962 /* These two kinds of events get special handling
3963 and don't actually appear to the command loop.
3964 We return nil for them. */
3965 if (event
->kind
== SELECTION_REQUEST_EVENT
3966 || event
->kind
== SELECTION_CLEAR_EVENT
)
3969 struct input_event copy
;
3971 /* Remove it from the buffer before processing it,
3972 since otherwise swallow_events will see it
3973 and process it again. */
3975 kbd_fetch_ptr
= event
+ 1;
3976 input_pending
= readable_events (0);
3977 x_handle_selection_event (©
);
3979 /* We're getting selection request events, but we don't have
3985 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3986 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3988 /* Make an event (delete-frame (FRAME)). */
3989 obj
= Fcons (event
->frame_or_window
, Qnil
);
3990 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3991 kbd_fetch_ptr
= event
+ 1;
3994 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3995 else if (event
->kind
== ICONIFY_EVENT
)
3997 /* Make an event (iconify-frame (FRAME)). */
3998 obj
= Fcons (event
->frame_or_window
, Qnil
);
3999 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4000 kbd_fetch_ptr
= event
+ 1;
4002 else if (event
->kind
== DEICONIFY_EVENT
)
4004 /* Make an event (make-frame-visible (FRAME)). */
4005 obj
= Fcons (event
->frame_or_window
, Qnil
);
4006 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4007 kbd_fetch_ptr
= event
+ 1;
4010 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4012 /* The value doesn't matter here; only the type is tested. */
4013 XSETBUFFER (obj
, current_buffer
);
4014 kbd_fetch_ptr
= event
+ 1;
4016 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4017 || defined (USE_GTK)
4018 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4020 kbd_fetch_ptr
= event
+ 1;
4021 input_pending
= readable_events (0);
4022 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4023 x_activate_menubar (XFRAME (event
->frame_or_window
));
4026 #if defined (WINDOWSNT) || defined (MAC_OS)
4027 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4030 /* Make an event (language-change (KEY_SCRIPT)). */
4031 obj
= Fcons (make_number (event
->code
), Qnil
);
4033 /* Make an event (language-change (FRAME CHARSET LCID)). */
4034 obj
= Fcons (event
->frame_or_window
, Qnil
);
4036 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4037 kbd_fetch_ptr
= event
+ 1;
4040 else if (event
->kind
== SAVE_SESSION_EVENT
)
4042 obj
= Fcons (Qsave_session
, Qnil
);
4043 kbd_fetch_ptr
= event
+ 1;
4045 /* Just discard these, by returning nil.
4046 With MULTI_KBOARD, these events are used as placeholders
4047 when we need to randomly delete events from the queue.
4048 (They shouldn't otherwise be found in the buffer,
4049 but on some machines it appears they do show up
4050 even without MULTI_KBOARD.) */
4051 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4052 mouse events during a popup-menu call. */
4053 else if (event
->kind
== NO_EVENT
)
4054 kbd_fetch_ptr
= event
+ 1;
4055 else if (event
->kind
== HELP_EVENT
)
4057 Lisp_Object object
, position
, help
, frame
, window
;
4059 frame
= event
->frame_or_window
;
4060 object
= event
->arg
;
4061 position
= make_number (event
->code
);
4064 clear_event (event
);
4066 kbd_fetch_ptr
= event
+ 1;
4067 if (!WINDOWP (window
))
4069 obj
= Fcons (Qhelp_echo
,
4070 list5 (frame
, help
, window
, object
, position
));
4072 else if (event
->kind
== FOCUS_IN_EVENT
)
4074 /* Notification of a FocusIn event. The frame receiving the
4075 focus is in event->frame_or_window. Generate a
4076 switch-frame event if necessary. */
4077 Lisp_Object frame
, focus
;
4079 frame
= event
->frame_or_window
;
4080 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4084 if (!EQ (frame
, internal_last_event_frame
)
4085 && !EQ (frame
, selected_frame
))
4086 obj
= make_lispy_switch_frame (frame
);
4087 internal_last_event_frame
= frame
;
4088 kbd_fetch_ptr
= event
+ 1;
4092 /* If this event is on a different frame, return a switch-frame this
4093 time, and leave the event in the queue for next time. */
4097 frame
= event
->frame_or_window
;
4099 frame
= XCAR (frame
);
4100 else if (WINDOWP (frame
))
4101 frame
= WINDOW_FRAME (XWINDOW (frame
));
4103 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4107 if (! EQ (frame
, internal_last_event_frame
)
4108 && !EQ (frame
, selected_frame
))
4109 obj
= make_lispy_switch_frame (frame
);
4110 internal_last_event_frame
= frame
;
4112 /* If we didn't decide to make a switch-frame event, go ahead
4113 and build a real event from the queue entry. */
4117 obj
= make_lispy_event (event
);
4119 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4120 || defined (USE_GTK)
4121 /* If this was a menu selection, then set the flag to inhibit
4122 writing to last_nonmenu_event. Don't do this if the event
4123 we're returning is (menu-bar), though; that indicates the
4124 beginning of the menu sequence, and we might as well leave
4125 that as the `event with parameters' for this selection. */
4127 && !EQ (event
->frame_or_window
, event
->arg
)
4128 && (event
->kind
== MENU_BAR_EVENT
4129 || event
->kind
== TOOL_BAR_EVENT
))
4130 *used_mouse_menu
= 1;
4133 /* Wipe out this event, to catch bugs. */
4134 clear_event (event
);
4135 kbd_fetch_ptr
= event
+ 1;
4140 /* Try generating a mouse motion event. */
4141 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4143 FRAME_PTR f
= some_mouse_moved ();
4144 Lisp_Object bar_window
;
4145 enum scroll_bar_part part
;
4149 *kbp
= current_kboard
;
4150 /* Note that this uses F to determine which display to look at.
4151 If there is no valid info, it does not store anything
4152 so x remains nil. */
4155 /* XXX Can f or mouse_position_hook be NULL here? */
4156 if (f
&& FRAME_DISPLAY (f
)->mouse_position_hook
)
4157 (*FRAME_DISPLAY (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4158 &part
, &x
, &y
, &time
);
4162 /* Decide if we should generate a switch-frame event. Don't
4163 generate switch-frame events for motion outside of all Emacs
4169 frame
= FRAME_FOCUS_FRAME (f
);
4171 XSETFRAME (frame
, f
);
4173 if (! EQ (frame
, internal_last_event_frame
)
4174 && !EQ (frame
, selected_frame
))
4175 obj
= make_lispy_switch_frame (frame
);
4176 internal_last_event_frame
= frame
;
4179 /* If we didn't decide to make a switch-frame event, go ahead and
4180 return a mouse-motion event. */
4181 if (!NILP (x
) && NILP (obj
))
4182 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4184 #endif /* HAVE_MOUSE */
4186 /* We were promised by the above while loop that there was
4187 something for us to read! */
4190 input_pending
= readable_events (0);
4192 Vlast_event_frame
= internal_last_event_frame
;
4197 /* Process any events that are not user-visible,
4198 then return, without reading any user-visible events. */
4201 swallow_events (do_display
)
4206 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4208 struct input_event
*event
;
4210 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4214 last_event_timestamp
= event
->timestamp
;
4216 /* These two kinds of events get special handling
4217 and don't actually appear to the command loop. */
4218 if (event
->kind
== SELECTION_REQUEST_EVENT
4219 || event
->kind
== SELECTION_CLEAR_EVENT
)
4222 struct input_event copy
;
4224 /* Remove it from the buffer before processing it,
4225 since otherwise swallow_events called recursively could see it
4226 and process it again. */
4228 kbd_fetch_ptr
= event
+ 1;
4229 input_pending
= readable_events (0);
4230 x_handle_selection_event (©
);
4232 /* We're getting selection request events, but we don't have
4241 old_timers_run
= timers_run
;
4242 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4244 if (timers_run
!= old_timers_run
&& do_display
)
4245 redisplay_preserve_echo_area (7);
4248 /* Record the start of when Emacs is idle,
4249 for the sake of running idle-time timers. */
4256 /* If we are already in the idle state, do nothing. */
4257 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4260 EMACS_GET_TIME (timer_idleness_start_time
);
4262 timer_last_idleness_start_time
= timer_idleness_start_time
;
4264 /* Mark all idle-time timers as once again candidates for running. */
4265 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4269 timer
= XCAR (timers
);
4271 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4273 XVECTOR (timer
)->contents
[0] = Qnil
;
4277 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4282 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4285 /* Resume idle timer from last idle start time. */
4288 timer_resume_idle ()
4290 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4293 timer_idleness_start_time
= timer_last_idleness_start_time
;
4296 /* This is only for debugging. */
4297 struct input_event last_timer_event
;
4299 /* Check whether a timer has fired. To prevent larger problems we simply
4300 disregard elements that are not proper timers. Do not make a circular
4301 timer list for the time being.
4303 Returns the number of seconds to wait until the next timer fires. If a
4304 timer is triggering now, return zero seconds.
4305 If no timer is active, return -1 seconds.
4307 If a timer is ripe, we run it, with quitting turned off.
4309 DO_IT_NOW is now ignored. It used to mean that we should
4310 run the timer directly instead of queueing a timer-event.
4311 Now we always run timers directly. */
4314 timer_check (do_it_now
)
4317 EMACS_TIME nexttime
;
4318 EMACS_TIME now
, idleness_now
;
4319 Lisp_Object timers
, idle_timers
, chosen_timer
;
4320 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4322 EMACS_SET_SECS (nexttime
, -1);
4323 EMACS_SET_USECS (nexttime
, -1);
4325 /* Always consider the ordinary timers. */
4326 timers
= Vtimer_list
;
4327 /* Consider the idle timers only if Emacs is idle. */
4328 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4329 idle_timers
= Vtimer_idle_list
;
4332 chosen_timer
= Qnil
;
4333 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4335 if (CONSP (timers
) || CONSP (idle_timers
))
4337 EMACS_GET_TIME (now
);
4338 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4339 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4342 while (CONSP (timers
) || CONSP (idle_timers
))
4344 Lisp_Object
*vector
;
4345 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4346 EMACS_TIME timer_time
, idle_timer_time
;
4347 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4349 /* Skip past invalid timers and timers already handled. */
4352 timer
= XCAR (timers
);
4353 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4355 timers
= XCDR (timers
);
4358 vector
= XVECTOR (timer
)->contents
;
4360 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4361 || !INTEGERP (vector
[3])
4362 || ! NILP (vector
[0]))
4364 timers
= XCDR (timers
);
4368 if (!NILP (idle_timers
))
4370 timer
= XCAR (idle_timers
);
4371 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4373 idle_timers
= XCDR (idle_timers
);
4376 vector
= XVECTOR (timer
)->contents
;
4378 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4379 || !INTEGERP (vector
[3])
4380 || ! NILP (vector
[0]))
4382 idle_timers
= XCDR (idle_timers
);
4387 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4388 based on the next ordinary timer.
4389 TIMER_DIFFERENCE is the distance in time from NOW to when
4390 this timer becomes ripe (negative if it's already ripe). */
4393 timer
= XCAR (timers
);
4394 vector
= XVECTOR (timer
)->contents
;
4395 EMACS_SET_SECS (timer_time
,
4396 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4397 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4398 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4401 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4402 based on the next idle timer. */
4403 if (!NILP (idle_timers
))
4405 idle_timer
= XCAR (idle_timers
);
4406 vector
= XVECTOR (idle_timer
)->contents
;
4407 EMACS_SET_SECS (idle_timer_time
,
4408 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4409 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4410 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4413 /* Decide which timer is the next timer,
4414 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4415 Also step down the list where we found that timer. */
4417 if (! NILP (timers
) && ! NILP (idle_timers
))
4420 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4421 if (EMACS_TIME_NEG_P (temp
))
4423 chosen_timer
= timer
;
4424 timers
= XCDR (timers
);
4425 difference
= timer_difference
;
4429 chosen_timer
= idle_timer
;
4430 idle_timers
= XCDR (idle_timers
);
4431 difference
= idle_timer_difference
;
4434 else if (! NILP (timers
))
4436 chosen_timer
= timer
;
4437 timers
= XCDR (timers
);
4438 difference
= timer_difference
;
4442 chosen_timer
= idle_timer
;
4443 idle_timers
= XCDR (idle_timers
);
4444 difference
= idle_timer_difference
;
4446 vector
= XVECTOR (chosen_timer
)->contents
;
4448 /* If timer is ripe, run it if it hasn't been run. */
4449 if (EMACS_TIME_NEG_P (difference
)
4450 || (EMACS_SECS (difference
) == 0
4451 && EMACS_USECS (difference
) == 0))
4453 if (NILP (vector
[0]))
4455 int was_locked
= single_kboard
;
4456 int count
= SPECPDL_INDEX ();
4457 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4459 /* Mark the timer as triggered to prevent problems if the lisp
4460 code fails to reschedule it right. */
4463 specbind (Qinhibit_quit
, Qt
);
4465 call1 (Qtimer_event_handler
, chosen_timer
);
4466 Vdeactivate_mark
= old_deactivate_mark
;
4468 unbind_to (count
, Qnil
);
4470 /* Resume allowing input from any kboard, if that was true before. */
4472 any_kboard_state ();
4474 /* Since we have handled the event,
4475 we don't need to tell the caller to wake up and do it. */
4479 /* When we encounter a timer that is still waiting,
4480 return the amount of time to wait before it is ripe. */
4487 /* No timers are pending in the future. */
4488 /* Return 0 if we generated an event, and -1 if not. */
4493 /* Caches for modify_event_symbol. */
4494 static Lisp_Object accent_key_syms
;
4495 static Lisp_Object func_key_syms
;
4496 static Lisp_Object mouse_syms
;
4497 static Lisp_Object wheel_syms
;
4498 static Lisp_Object drag_n_drop_syms
;
4500 /* This is a list of keysym codes for special "accent" characters.
4501 It parallels lispy_accent_keys. */
4503 static int lispy_accent_codes
[] =
4505 #ifdef XK_dead_circumflex
4510 #ifdef XK_dead_grave
4515 #ifdef XK_dead_tilde
4520 #ifdef XK_dead_diaeresis
4525 #ifdef XK_dead_macron
4530 #ifdef XK_dead_degree
4535 #ifdef XK_dead_acute
4540 #ifdef XK_dead_cedilla
4545 #ifdef XK_dead_breve
4550 #ifdef XK_dead_ogonek
4555 #ifdef XK_dead_caron
4560 #ifdef XK_dead_doubleacute
4561 XK_dead_doubleacute
,
4565 #ifdef XK_dead_abovedot
4570 #ifdef XK_dead_abovering
4580 #ifdef XK_dead_belowdot
4585 #ifdef XK_dead_voiced_sound
4586 XK_dead_voiced_sound
,
4590 #ifdef XK_dead_semivoiced_sound
4591 XK_dead_semivoiced_sound
,
4607 /* This is a list of Lisp names for special "accent" characters.
4608 It parallels lispy_accent_codes. */
4610 static char *lispy_accent_keys
[] =
4628 "dead-voiced-sound",
4629 "dead-semivoiced-sound",
4635 #define FUNCTION_KEY_OFFSET 0x0
4637 char *lispy_function_keys
[] =
4641 0, /* VK_LBUTTON 0x01 */
4642 0, /* VK_RBUTTON 0x02 */
4643 "cancel", /* VK_CANCEL 0x03 */
4644 0, /* VK_MBUTTON 0x04 */
4646 0, 0, 0, /* 0x05 .. 0x07 */
4648 "backspace", /* VK_BACK 0x08 */
4649 "tab", /* VK_TAB 0x09 */
4651 0, 0, /* 0x0A .. 0x0B */
4653 "clear", /* VK_CLEAR 0x0C */
4654 "return", /* VK_RETURN 0x0D */
4656 0, 0, /* 0x0E .. 0x0F */
4658 0, /* VK_SHIFT 0x10 */
4659 0, /* VK_CONTROL 0x11 */
4660 0, /* VK_MENU 0x12 */
4661 "pause", /* VK_PAUSE 0x13 */
4662 "capslock", /* VK_CAPITAL 0x14 */
4664 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4666 "escape", /* VK_ESCAPE 0x1B */
4668 0, 0, 0, 0, /* 0x1C .. 0x1F */
4670 0, /* VK_SPACE 0x20 */
4671 "prior", /* VK_PRIOR 0x21 */
4672 "next", /* VK_NEXT 0x22 */
4673 "end", /* VK_END 0x23 */
4674 "home", /* VK_HOME 0x24 */
4675 "left", /* VK_LEFT 0x25 */
4676 "up", /* VK_UP 0x26 */
4677 "right", /* VK_RIGHT 0x27 */
4678 "down", /* VK_DOWN 0x28 */
4679 "select", /* VK_SELECT 0x29 */
4680 "print", /* VK_PRINT 0x2A */
4681 "execute", /* VK_EXECUTE 0x2B */
4682 "snapshot", /* VK_SNAPSHOT 0x2C */
4683 "insert", /* VK_INSERT 0x2D */
4684 "delete", /* VK_DELETE 0x2E */
4685 "help", /* VK_HELP 0x2F */
4687 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4689 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4691 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4693 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4695 0, 0, 0, 0, 0, 0, 0, 0, 0,
4696 0, 0, 0, 0, 0, 0, 0, 0, 0,
4697 0, 0, 0, 0, 0, 0, 0, 0,
4699 "lwindow", /* VK_LWIN 0x5B */
4700 "rwindow", /* VK_RWIN 0x5C */
4701 "apps", /* VK_APPS 0x5D */
4703 0, 0, /* 0x5E .. 0x5F */
4705 "kp-0", /* VK_NUMPAD0 0x60 */
4706 "kp-1", /* VK_NUMPAD1 0x61 */
4707 "kp-2", /* VK_NUMPAD2 0x62 */
4708 "kp-3", /* VK_NUMPAD3 0x63 */
4709 "kp-4", /* VK_NUMPAD4 0x64 */
4710 "kp-5", /* VK_NUMPAD5 0x65 */
4711 "kp-6", /* VK_NUMPAD6 0x66 */
4712 "kp-7", /* VK_NUMPAD7 0x67 */
4713 "kp-8", /* VK_NUMPAD8 0x68 */
4714 "kp-9", /* VK_NUMPAD9 0x69 */
4715 "kp-multiply", /* VK_MULTIPLY 0x6A */
4716 "kp-add", /* VK_ADD 0x6B */
4717 "kp-separator", /* VK_SEPARATOR 0x6C */
4718 "kp-subtract", /* VK_SUBTRACT 0x6D */
4719 "kp-decimal", /* VK_DECIMAL 0x6E */
4720 "kp-divide", /* VK_DIVIDE 0x6F */
4721 "f1", /* VK_F1 0x70 */
4722 "f2", /* VK_F2 0x71 */
4723 "f3", /* VK_F3 0x72 */
4724 "f4", /* VK_F4 0x73 */
4725 "f5", /* VK_F5 0x74 */
4726 "f6", /* VK_F6 0x75 */
4727 "f7", /* VK_F7 0x76 */
4728 "f8", /* VK_F8 0x77 */
4729 "f9", /* VK_F9 0x78 */
4730 "f10", /* VK_F10 0x79 */
4731 "f11", /* VK_F11 0x7A */
4732 "f12", /* VK_F12 0x7B */
4733 "f13", /* VK_F13 0x7C */
4734 "f14", /* VK_F14 0x7D */
4735 "f15", /* VK_F15 0x7E */
4736 "f16", /* VK_F16 0x7F */
4737 "f17", /* VK_F17 0x80 */
4738 "f18", /* VK_F18 0x81 */
4739 "f19", /* VK_F19 0x82 */
4740 "f20", /* VK_F20 0x83 */
4741 "f21", /* VK_F21 0x84 */
4742 "f22", /* VK_F22 0x85 */
4743 "f23", /* VK_F23 0x86 */
4744 "f24", /* VK_F24 0x87 */
4746 0, 0, 0, 0, /* 0x88 .. 0x8B */
4747 0, 0, 0, 0, /* 0x8C .. 0x8F */
4749 "kp-numlock", /* VK_NUMLOCK 0x90 */
4750 "scroll", /* VK_SCROLL 0x91 */
4752 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4753 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4754 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4755 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4756 "kp-end", /* VK_NUMPAD_END 0x96 */
4757 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4758 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4759 "kp-up", /* VK_NUMPAD_UP 0x99 */
4760 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4761 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4762 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4763 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4765 0, 0, /* 0x9E .. 0x9F */
4768 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4769 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4770 * No other API or message will distinguish left and right keys this way.
4774 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4775 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
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,
4784 "attn", /* VK_ATTN 0xF6 */
4785 "crsel", /* VK_CRSEL 0xF7 */
4786 "exsel", /* VK_EXSEL 0xF8 */
4787 "ereof", /* VK_EREOF 0xF9 */
4788 "play", /* VK_PLAY 0xFA */
4789 "zoom", /* VK_ZOOM 0xFB */
4790 "noname", /* VK_NONAME 0xFC */
4791 "pa1", /* VK_PA1 0xFD */
4792 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4796 #else /* not HAVE_NTGUI */
4798 /* This should be dealt with in XTread_socket now, and that doesn't
4799 depend on the client system having the Kana syms defined. See also
4800 the XK_kana_A case below. */
4803 static char *lispy_kana_keys
[] =
4805 /* X Keysym value */
4806 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4807 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4808 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4809 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4810 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4811 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4812 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4813 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4814 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4815 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4816 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4817 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4818 "kana-i", "kana-u", "kana-e", "kana-o",
4819 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4820 "prolongedsound", "kana-A", "kana-I", "kana-U",
4821 "kana-E", "kana-O", "kana-KA", "kana-KI",
4822 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4823 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4824 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4825 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4826 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4827 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4828 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4829 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4830 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4831 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4832 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4833 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4835 #endif /* XK_kana_A */
4838 #define FUNCTION_KEY_OFFSET 0xff00
4840 /* You'll notice that this table is arranged to be conveniently
4841 indexed by X Windows keysym values. */
4842 static char *lispy_function_keys
[] =
4844 /* X Keysym value */
4846 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4847 "backspace", "tab", "linefeed", "clear",
4849 0, 0, 0, "pause", /* 0xff10...1f */
4850 0, 0, 0, 0, 0, 0, 0, "escape",
4852 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4853 "romaji", "hiragana", "katakana", "hiragana-katakana",
4854 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4855 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4856 "eisu-toggle", /* 0xff30...3f */
4857 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4858 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4860 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4861 "down", "prior", "next", "end",
4862 "begin", 0, 0, 0, 0, 0, 0, 0,
4863 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4874 "break", /* 0xff6b */
4877 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4878 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4879 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4880 0, 0, 0, 0, 0, 0, 0, 0,
4881 "kp-tab", /* 0xff89 */
4883 "kp-enter", /* 0xff8d */
4885 "kp-f1", /* 0xff91 */
4889 "kp-home", /* 0xff95 */
4894 "kp-prior", /* kp-page-up */
4895 "kp-next", /* kp-page-down */
4901 0, 0, 0, 0, 0, 0, 0, 0, 0,
4902 "kp-multiply", /* 0xffaa */
4907 "kp-divide", /* 0xffaf */
4908 "kp-0", /* 0xffb0 */
4909 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4912 "kp-equal", /* 0xffbd */
4913 "f1", /* 0xffbe */ /* IsFunctionKey */
4915 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4916 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4917 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4918 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4919 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4920 0, 0, 0, 0, 0, 0, 0, 0,
4921 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4922 0, 0, 0, 0, 0, 0, 0, "delete"
4925 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4926 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4928 static char *iso_lispy_function_keys
[] =
4930 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4931 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4932 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4933 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4934 "iso-lefttab", /* 0xfe20 */
4935 "iso-move-line-up", "iso-move-line-down",
4936 "iso-partial-line-up", "iso-partial-line-down",
4937 "iso-partial-space-left", "iso-partial-space-right",
4938 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4939 "iso-release-margin-left", "iso-release-margin-right",
4940 "iso-release-both-margins",
4941 "iso-fast-cursor-left", "iso-fast-cursor-right",
4942 "iso-fast-cursor-up", "iso-fast-cursor-down",
4943 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4944 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4947 #endif /* not HAVE_NTGUI */
4949 Lisp_Object Vlispy_mouse_stem
;
4951 static char *lispy_wheel_names
[] =
4953 "wheel-up", "wheel-down"
4956 /* drag-n-drop events are generated when a set of selected files are
4957 dragged from another application and dropped onto an Emacs window. */
4958 static char *lispy_drag_n_drop_names
[] =
4963 /* Scroll bar parts. */
4964 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4965 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4966 Lisp_Object Qtop
, Qratio
;
4968 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4969 Lisp_Object
*scroll_bar_parts
[] = {
4970 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4971 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4974 /* User signal events. */
4975 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4977 Lisp_Object
*lispy_user_signals
[] =
4979 &Qusr1_signal
, &Qusr2_signal
4983 /* A vector, indexed by button number, giving the down-going location
4984 of currently depressed buttons, both scroll bar and non-scroll bar.
4986 The elements have the form
4987 (BUTTON-NUMBER MODIFIER-MASK . REST)
4988 where REST is the cdr of a position as it would be reported in the event.
4990 The make_lispy_event function stores positions here to tell the
4991 difference between click and drag events, and to store the starting
4992 location to be included in drag events. */
4994 static Lisp_Object button_down_location
;
4996 /* Information about the most recent up-going button event: Which
4997 button, what location, and what time. */
4999 static int last_mouse_button
;
5000 static int last_mouse_x
;
5001 static int last_mouse_y
;
5002 static unsigned long button_down_time
;
5004 /* The maximum time between clicks to make a double-click, or Qnil to
5005 disable double-click detection, or Qt for no time limit. */
5007 Lisp_Object Vdouble_click_time
;
5009 /* Maximum number of pixels the mouse may be moved between clicks
5010 to make a double-click. */
5012 EMACS_INT double_click_fuzz
;
5014 /* The number of clicks in this multiple-click. */
5016 int double_click_count
;
5018 /* Return position of a mouse click or wheel event */
5021 make_lispy_position (f
, x
, y
, time
)
5027 enum window_part part
;
5028 Lisp_Object posn
= Qnil
;
5029 Lisp_Object extra_info
= Qnil
;
5032 /* Set `window' to the window under frame pixel coordinates (x,y) */
5034 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5035 &part
, &wx
, &wy
, 0);
5039 if (WINDOWP (window
))
5041 /* It's a click in window window at frame coordinates (x,y) */
5042 struct window
*w
= XWINDOW (window
);
5043 Lisp_Object string_info
= Qnil
;
5044 int textpos
= -1, rx
= -1, ry
= -1;
5045 int dx
= -1, dy
= -1;
5046 int width
= -1, height
= -1;
5047 Lisp_Object object
= Qnil
;
5049 /* Set event coordinates to window-relative coordinates
5050 for constructing the Lisp event below. */
5054 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5056 /* Mode line or header line. Look for a string under
5057 the mouse that may have a `local-map' property. */
5061 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5063 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5064 &object
, &dx
, &dy
, &width
, &height
);
5065 if (STRINGP (string
))
5066 string_info
= Fcons (string
, make_number (charpos
));
5067 if (w
== XWINDOW (selected_window
))
5070 textpos
= XMARKER (w
->pointm
)->charpos
;
5072 else if (part
== ON_VERTICAL_BORDER
)
5074 posn
= Qvertical_line
;
5079 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5084 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5086 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5087 &object
, &dx
, &dy
, &width
, &height
);
5088 if (STRINGP (string
))
5089 string_info
= Fcons (string
, make_number (charpos
));
5091 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
5093 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
5096 if (part
== ON_RIGHT_FRINGE
)
5097 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5098 + window_box_width (w
, TEXT_AREA
)
5099 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5100 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5102 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5103 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5108 Lisp_Object string2
, object2
= Qnil
;
5109 struct display_pos p
;
5111 int width2
, height2
;
5112 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5113 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5114 &object2
, &dx2
, &dy2
,
5116 textpos
= CHARPOS (p
.pos
);
5117 if (rx
< 0) rx
= wx
;
5118 if (ry
< 0) ry
= wy
;
5119 if (dx
< 0) dx
= dx2
;
5120 if (dy
< 0) dy
= dy2
;
5121 if (width
< 0) width
= width2
;
5122 if (height
< 0) height
= height2
;
5126 posn
= make_number (textpos
);
5127 if (STRINGP (string2
))
5128 string_info
= Fcons (string2
,
5129 make_number (CHARPOS (p
.string_pos
)));
5135 #ifdef HAVE_WINDOW_SYSTEM
5136 if (IMAGEP (object
))
5138 Lisp_Object image_map
, hotspot
;
5139 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5141 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5143 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5144 posn
= XCAR (hotspot
);
5149 extra_info
= Fcons (object
,
5150 Fcons (Fcons (make_number (dx
),
5152 Fcons (Fcons (make_number (width
),
5153 make_number (height
)),
5157 extra_info
= Fcons (string_info
,
5158 Fcons (make_number (textpos
),
5159 Fcons (Fcons (make_number (rx
),
5165 XSETFRAME (window
, f
);
5170 XSETFASTINT (*x
, 0);
5171 XSETFASTINT (*y
, 0);
5174 return Fcons (window
,
5176 Fcons (Fcons (*x
, *y
),
5177 Fcons (make_number (time
),
5181 /* Given a struct input_event, build the lisp event which represents
5182 it. If EVENT is 0, build a mouse movement event from the mouse
5183 movement buffer, which should have a movement event in it.
5185 Note that events must be passed to this function in the order they
5186 are received; this function stores the location of button presses
5187 in order to build drag events when the button is released. */
5190 make_lispy_event (event
)
5191 struct input_event
*event
;
5195 switch (SWITCH_ENUM_CAST (event
->kind
))
5197 /* A simple keystroke. */
5198 case ASCII_KEYSTROKE_EVENT
:
5200 Lisp_Object lispy_c
;
5201 int c
= event
->code
& 0377;
5202 /* Turn ASCII characters into control characters
5204 if (event
->modifiers
& ctrl_modifier
)
5205 c
= make_ctrl_char (c
);
5207 /* Add in the other modifier bits. We took care of ctrl_modifier
5208 just above, and the shift key was taken care of by the X code,
5209 and applied to control characters by make_ctrl_char. */
5210 c
|= (event
->modifiers
5211 & (meta_modifier
| alt_modifier
5212 | hyper_modifier
| super_modifier
));
5213 /* Distinguish Shift-SPC from SPC. */
5214 if ((event
->code
& 0377) == 040
5215 && event
->modifiers
& shift_modifier
)
5216 c
|= shift_modifier
;
5217 button_down_time
= 0;
5218 XSETFASTINT (lispy_c
, c
);
5222 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5224 Lisp_Object lispy_c
;
5225 int c
= event
->code
;
5227 /* Add in the other modifier bits. We took care of ctrl_modifier
5228 just above, and the shift key was taken care of by the X code,
5229 and applied to control characters by make_ctrl_char. */
5230 c
|= (event
->modifiers
5231 & (meta_modifier
| alt_modifier
5232 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5233 /* What about the `shift' modifier ? */
5234 button_down_time
= 0;
5235 XSETFASTINT (lispy_c
, c
);
5239 /* A function key. The symbol may need to have modifier prefixes
5241 case NON_ASCII_KEYSTROKE_EVENT
:
5242 button_down_time
= 0;
5244 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5245 if (event
->code
== lispy_accent_codes
[i
])
5246 return modify_event_symbol (i
,
5248 Qfunction_key
, Qnil
,
5249 lispy_accent_keys
, &accent_key_syms
,
5250 (sizeof (lispy_accent_keys
)
5251 / sizeof (lispy_accent_keys
[0])));
5255 if (event
->code
>= 0x400 && event
->code
< 0x500)
5256 return modify_event_symbol (event
->code
- 0x400,
5257 event
->modifiers
& ~shift_modifier
,
5258 Qfunction_key
, Qnil
,
5259 lispy_kana_keys
, &func_key_syms
,
5260 (sizeof (lispy_kana_keys
)
5261 / sizeof (lispy_kana_keys
[0])));
5262 #endif /* XK_kana_A */
5265 #ifdef ISO_FUNCTION_KEY_OFFSET
5266 if (event
->code
< FUNCTION_KEY_OFFSET
5267 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5268 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5270 Qfunction_key
, Qnil
,
5271 iso_lispy_function_keys
, &func_key_syms
,
5272 (sizeof (iso_lispy_function_keys
)
5273 / sizeof (iso_lispy_function_keys
[0])));
5276 /* Handle system-specific or unknown keysyms. */
5277 if (event
->code
& (1 << 28)
5278 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5279 || (event
->code
- FUNCTION_KEY_OFFSET
5280 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5281 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5283 /* We need to use an alist rather than a vector as the cache
5284 since we can't make a vector long enuf. */
5285 if (NILP (current_kboard
->system_key_syms
))
5286 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5287 return modify_event_symbol (event
->code
,
5290 current_kboard
->Vsystem_key_alist
,
5291 0, ¤t_kboard
->system_key_syms
,
5295 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5297 Qfunction_key
, Qnil
,
5298 lispy_function_keys
, &func_key_syms
,
5299 (sizeof (lispy_function_keys
)
5300 / sizeof (lispy_function_keys
[0])));
5303 /* A mouse click. Figure out where it is, decide whether it's
5304 a press, click or drag, and build the appropriate structure. */
5305 case MOUSE_CLICK_EVENT
:
5306 #ifndef USE_TOOLKIT_SCROLL_BARS
5307 case SCROLL_BAR_CLICK_EVENT
:
5310 int button
= event
->code
;
5312 Lisp_Object position
;
5313 Lisp_Object
*start_pos_ptr
;
5314 Lisp_Object start_pos
;
5318 /* Build the position as appropriate for this mouse click. */
5319 if (event
->kind
== MOUSE_CLICK_EVENT
)
5321 struct frame
*f
= XFRAME (event
->frame_or_window
);
5322 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5326 /* Ignore mouse events that were made on frame that
5327 have been deleted. */
5328 if (! FRAME_LIVE_P (f
))
5331 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5332 /* EVENT->x and EVENT->y are frame-relative pixel
5333 coordinates at this place. Under old redisplay, COLUMN
5334 and ROW are set to frame relative glyph coordinates
5335 which are then used to determine whether this click is
5336 in a menu (non-toolkit version). */
5337 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5338 &column
, &row
, NULL
, 1);
5340 /* In the non-toolkit version, clicks on the menu bar
5341 are ordinary button events in the event buffer.
5342 Distinguish them, and invoke the menu.
5344 (In the toolkit version, the toolkit handles the menu bar
5345 and Emacs doesn't know about it until after the user
5346 makes a selection.) */
5347 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5348 && (event
->modifiers
& down_modifier
))
5350 Lisp_Object items
, item
;
5355 /* Activate the menu bar on the down event. If the
5356 up event comes in before the menu code can deal with it,
5358 if (! (event
->modifiers
& down_modifier
))
5362 /* Find the menu bar item under `column'. */
5364 items
= FRAME_MENU_BAR_ITEMS (f
);
5365 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5367 Lisp_Object pos
, string
;
5368 string
= AREF (items
, i
+ 1);
5369 pos
= AREF (items
, i
+ 3);
5372 if (column
>= XINT (pos
)
5373 && column
< XINT (pos
) + SCHARS (string
))
5375 item
= AREF (items
, i
);
5380 /* ELisp manual 2.4b says (x y) are window relative but
5381 code says they are frame-relative. */
5383 = Fcons (event
->frame_or_window
,
5385 Fcons (Fcons (event
->x
, event
->y
),
5386 Fcons (make_number (event
->timestamp
),
5389 return Fcons (item
, Fcons (position
, Qnil
));
5391 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5393 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5396 #ifndef USE_TOOLKIT_SCROLL_BARS
5399 /* It's a scrollbar click. */
5401 Lisp_Object portion_whole
;
5404 window
= event
->frame_or_window
;
5405 portion_whole
= Fcons (event
->x
, event
->y
);
5406 part
= *scroll_bar_parts
[(int) event
->part
];
5410 Fcons (Qvertical_scroll_bar
,
5411 Fcons (portion_whole
,
5412 Fcons (make_number (event
->timestamp
),
5413 Fcons (part
, Qnil
)))));
5415 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5417 if (button
>= ASIZE (button_down_location
))
5419 button_down_location
= larger_vector (button_down_location
,
5421 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5424 start_pos_ptr
= &AREF (button_down_location
, button
);
5425 start_pos
= *start_pos_ptr
;
5426 *start_pos_ptr
= Qnil
;
5429 /* On window-system frames, use the value of
5430 double-click-fuzz as is. On other frames, interpret it
5431 as a multiple of 1/8 characters. */
5435 if (WINDOWP (event
->frame_or_window
))
5436 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5437 else if (FRAMEP (event
->frame_or_window
))
5438 f
= XFRAME (event
->frame_or_window
);
5442 if (FRAME_WINDOW_P (f
))
5443 fuzz
= double_click_fuzz
;
5445 fuzz
= double_click_fuzz
/ 8;
5447 is_double
= (button
== last_mouse_button
5448 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5449 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5450 && button_down_time
!= 0
5451 && (EQ (Vdouble_click_time
, Qt
)
5452 || (INTEGERP (Vdouble_click_time
)
5453 && ((int)(event
->timestamp
- button_down_time
)
5454 < XINT (Vdouble_click_time
)))));
5457 last_mouse_button
= button
;
5458 last_mouse_x
= XINT (event
->x
);
5459 last_mouse_y
= XINT (event
->y
);
5461 /* If this is a button press, squirrel away the location, so
5462 we can decide later whether it was a click or a drag. */
5463 if (event
->modifiers
& down_modifier
)
5467 double_click_count
++;
5468 event
->modifiers
|= ((double_click_count
> 2)
5473 double_click_count
= 1;
5474 button_down_time
= event
->timestamp
;
5475 *start_pos_ptr
= Fcopy_alist (position
);
5478 /* Now we're releasing a button - check the co-ordinates to
5479 see if this was a click or a drag. */
5480 else if (event
->modifiers
& up_modifier
)
5482 /* If we did not see a down before this up, ignore the up.
5483 Probably this happened because the down event chose a
5484 menu item. It would be an annoyance to treat the
5485 release of the button that chose the menu item as a
5488 if (!CONSP (start_pos
))
5491 event
->modifiers
&= ~up_modifier
;
5492 #if 0 /* Formerly we treated an up with no down as a click event. */
5493 if (!CONSP (start_pos
))
5494 event
->modifiers
|= click_modifier
;
5499 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5501 /* The third element of every position
5502 should be the (x,y) pair. */
5503 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5505 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5507 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5508 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5511 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5512 && ydiff
< double_click_fuzz
5513 && ydiff
> - double_click_fuzz
)
5514 /* Mouse hasn't moved (much). */
5515 event
->modifiers
|= click_modifier
;
5518 button_down_time
= 0;
5519 event
->modifiers
|= drag_modifier
;
5522 /* Don't check is_double; treat this as multiple
5523 if the down-event was multiple. */
5524 if (double_click_count
> 1)
5525 event
->modifiers
|= ((double_click_count
> 2)
5531 /* Every mouse event should either have the down_modifier or
5532 the up_modifier set. */
5536 /* Get the symbol we should use for the mouse click. */
5539 head
= modify_event_symbol (button
,
5541 Qmouse_click
, Vlispy_mouse_stem
,
5544 XVECTOR (mouse_syms
)->size
);
5545 if (event
->modifiers
& drag_modifier
)
5550 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5553 Fcons (make_number (double_click_count
),
5564 Lisp_Object position
;
5567 /* Build the position as appropriate for this mouse click. */
5568 struct frame
*f
= XFRAME (event
->frame_or_window
);
5570 /* Ignore wheel events that were made on frame that have been
5572 if (! FRAME_LIVE_P (f
))
5575 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5578 /* Set double or triple modifiers to indicate the wheel speed. */
5580 /* On window-system frames, use the value of
5581 double-click-fuzz as is. On other frames, interpret it
5582 as a multiple of 1/8 characters. */
5587 if (WINDOWP (event
->frame_or_window
))
5588 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5589 else if (FRAMEP (event
->frame_or_window
))
5590 f
= XFRAME (event
->frame_or_window
);
5594 if (FRAME_WINDOW_P (f
))
5595 fuzz
= double_click_fuzz
;
5597 fuzz
= double_click_fuzz
/ 8;
5599 is_double
= (last_mouse_button
< 0
5600 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5601 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5602 && button_down_time
!= 0
5603 && (EQ (Vdouble_click_time
, Qt
)
5604 || (INTEGERP (Vdouble_click_time
)
5605 && ((int)(event
->timestamp
- button_down_time
)
5606 < XINT (Vdouble_click_time
)))));
5609 double_click_count
++;
5610 event
->modifiers
|= ((double_click_count
> 2)
5616 double_click_count
= 1;
5617 event
->modifiers
|= click_modifier
;
5620 button_down_time
= event
->timestamp
;
5621 /* Use a negative value to distinguish wheel from mouse button. */
5622 last_mouse_button
= -1;
5623 last_mouse_x
= XINT (event
->x
);
5624 last_mouse_y
= XINT (event
->y
);
5630 if (event
->modifiers
& up_modifier
)
5632 /* Emit a wheel-up event. */
5633 event
->modifiers
&= ~up_modifier
;
5636 else if (event
->modifiers
& down_modifier
)
5638 /* Emit a wheel-down event. */
5639 event
->modifiers
&= ~down_modifier
;
5643 /* Every wheel event should either have the down_modifier or
5644 the up_modifier set. */
5647 /* Get the symbol we should use for the wheel event. */
5648 head
= modify_event_symbol (symbol_num
,
5654 ASIZE (wheel_syms
));
5657 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5660 Fcons (make_number (double_click_count
),
5669 #ifdef USE_TOOLKIT_SCROLL_BARS
5671 /* We don't have down and up events if using toolkit scroll bars,
5672 so make this always a click event. Store in the `part' of
5673 the Lisp event a symbol which maps to the following actions:
5675 `above_handle' page up
5676 `below_handle' page down
5680 `bottom' bottom of buffer
5681 `handle' thumb has been dragged.
5682 `end-scroll' end of interaction with scroll bar
5684 The incoming input_event contains in its `part' member an
5685 index of type `enum scroll_bar_part' which we can use as an
5686 index in scroll_bar_parts to get the appropriate symbol. */
5688 case SCROLL_BAR_CLICK_EVENT
:
5690 Lisp_Object position
, head
, window
, portion_whole
, part
;
5692 window
= event
->frame_or_window
;
5693 portion_whole
= Fcons (event
->x
, event
->y
);
5694 part
= *scroll_bar_parts
[(int) event
->part
];
5698 Fcons (Qvertical_scroll_bar
,
5699 Fcons (portion_whole
,
5700 Fcons (make_number (event
->timestamp
),
5701 Fcons (part
, Qnil
)))));
5703 /* Always treat scroll bar events as clicks. */
5704 event
->modifiers
|= click_modifier
;
5705 event
->modifiers
&= ~up_modifier
;
5707 if (event
->code
>= ASIZE (mouse_syms
))
5708 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5710 /* Get the symbol we should use for the mouse click. */
5711 head
= modify_event_symbol (event
->code
,
5716 XVECTOR (mouse_syms
)->size
);
5717 return Fcons (head
, Fcons (position
, Qnil
));
5720 #endif /* USE_TOOLKIT_SCROLL_BARS */
5723 case W32_SCROLL_BAR_CLICK_EVENT
:
5725 int button
= event
->code
;
5727 Lisp_Object position
;
5728 Lisp_Object
*start_pos_ptr
;
5729 Lisp_Object start_pos
;
5733 Lisp_Object portion_whole
;
5736 window
= event
->frame_or_window
;
5737 portion_whole
= Fcons (event
->x
, event
->y
);
5738 part
= *scroll_bar_parts
[(int) event
->part
];
5742 Fcons (Qvertical_scroll_bar
,
5743 Fcons (portion_whole
,
5744 Fcons (make_number (event
->timestamp
),
5745 Fcons (part
, Qnil
)))));
5748 /* Always treat W32 scroll bar events as clicks. */
5749 event
->modifiers
|= click_modifier
;
5752 /* Get the symbol we should use for the mouse click. */
5755 head
= modify_event_symbol (button
,
5760 XVECTOR (mouse_syms
)->size
);
5766 #endif /* WINDOWSNT */
5768 case DRAG_N_DROP_EVENT
:
5771 Lisp_Object head
, position
;
5774 /* The frame_or_window field should be a cons of the frame in
5775 which the event occurred and a list of the filenames
5777 if (! CONSP (event
->frame_or_window
))
5780 f
= XFRAME (XCAR (event
->frame_or_window
));
5781 files
= XCDR (event
->frame_or_window
);
5783 /* Ignore mouse events that were made on frames that
5784 have been deleted. */
5785 if (! FRAME_LIVE_P (f
))
5788 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5791 head
= modify_event_symbol (0, event
->modifiers
,
5793 lispy_drag_n_drop_names
,
5794 &drag_n_drop_syms
, 1);
5800 #endif /* HAVE_MOUSE */
5802 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5803 || defined (USE_GTK)
5804 case MENU_BAR_EVENT
:
5805 if (EQ (event
->arg
, event
->frame_or_window
))
5806 /* This is the prefix key. We translate this to
5807 `(menu_bar)' because the code in keyboard.c for menu
5808 events, which we use, relies on this. */
5809 return Fcons (Qmenu_bar
, Qnil
);
5813 case SELECT_WINDOW_EVENT
:
5814 /* Make an event (select-window (WINDOW)). */
5815 return Fcons (Qselect_window
,
5816 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5819 case TOOL_BAR_EVENT
:
5820 if (EQ (event
->arg
, event
->frame_or_window
))
5821 /* This is the prefix key. We translate this to
5822 `(tool_bar)' because the code in keyboard.c for tool bar
5823 events, which we use, relies on this. */
5824 return Fcons (Qtool_bar
, Qnil
);
5825 else if (SYMBOLP (event
->arg
))
5826 return apply_modifiers (event
->modifiers
, event
->arg
);
5829 case USER_SIGNAL_EVENT
:
5830 /* A user signal. */
5831 return *lispy_user_signals
[event
->code
];
5833 case SAVE_SESSION_EVENT
:
5834 return Qsave_session
;
5836 /* The 'kind' field of the event is something we don't recognize. */
5845 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5847 Lisp_Object bar_window
;
5848 enum scroll_bar_part part
;
5852 /* Is it a scroll bar movement? */
5853 if (frame
&& ! NILP (bar_window
))
5855 Lisp_Object part_sym
;
5857 part_sym
= *scroll_bar_parts
[(int) part
];
5858 return Fcons (Qscroll_bar_movement
,
5859 (Fcons (Fcons (bar_window
,
5860 Fcons (Qvertical_scroll_bar
,
5861 Fcons (Fcons (x
, y
),
5862 Fcons (make_number (time
),
5868 /* Or is it an ordinary mouse movement? */
5871 Lisp_Object position
;
5873 position
= make_lispy_position (frame
, &x
, &y
, time
);
5875 return Fcons (Qmouse_movement
,
5881 #endif /* HAVE_MOUSE */
5883 /* Construct a switch frame event. */
5885 make_lispy_switch_frame (frame
)
5888 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5891 /* Manipulating modifiers. */
5893 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5895 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5896 SYMBOL's name of the end of the modifiers; the string from this
5897 position is the unmodified symbol name.
5899 This doesn't use any caches. */
5902 parse_modifiers_uncached (symbol
, modifier_end
)
5910 CHECK_SYMBOL (symbol
);
5913 name
= SYMBOL_NAME (symbol
);
5915 for (i
= 0; i
+2 <= SBYTES (name
); )
5917 int this_mod_end
= 0;
5920 /* See if the name continues with a modifier word.
5921 Check that the word appears, but don't check what follows it.
5922 Set this_mod and this_mod_end to record what we find. */
5924 switch (SREF (name
, i
))
5926 #define SINGLE_LETTER_MOD(BIT) \
5927 (this_mod_end = i + 1, this_mod = BIT)
5930 SINGLE_LETTER_MOD (alt_modifier
);
5934 SINGLE_LETTER_MOD (ctrl_modifier
);
5938 SINGLE_LETTER_MOD (hyper_modifier
);
5942 SINGLE_LETTER_MOD (meta_modifier
);
5946 SINGLE_LETTER_MOD (shift_modifier
);
5950 SINGLE_LETTER_MOD (super_modifier
);
5953 #undef SINGLE_LETTER_MOD
5955 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5956 if (i + LEN + 1 <= SBYTES (name) \
5957 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5959 this_mod_end = i + LEN; \
5964 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5965 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5966 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5970 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5972 #undef MULTI_LETTER_MOD
5976 /* If we found no modifier, stop looking for them. */
5977 if (this_mod_end
== 0)
5980 /* Check there is a dash after the modifier, so that it
5981 really is a modifier. */
5982 if (this_mod_end
>= SBYTES (name
)
5983 || SREF (name
, this_mod_end
) != '-')
5986 /* This modifier is real; look for another. */
5987 modifiers
|= this_mod
;
5988 i
= this_mod_end
+ 1;
5991 /* Should we include the `click' modifier? */
5992 if (! (modifiers
& (down_modifier
| drag_modifier
5993 | double_modifier
| triple_modifier
))
5994 && i
+ 7 == SBYTES (name
)
5995 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5996 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5997 modifiers
|= click_modifier
;
6005 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6006 prepended to the string BASE[0..BASE_LEN-1].
6007 This doesn't use any caches. */
6009 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6012 int base_len
, base_len_byte
;
6014 /* Since BASE could contain nulls, we can't use intern here; we have
6015 to use Fintern, which expects a genuine Lisp_String, and keeps a
6018 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6024 /* Only the event queue may use the `up' modifier; it should always
6025 be turned into a click or drag event before presented to lisp code. */
6026 if (modifiers
& up_modifier
)
6029 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6030 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6031 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6032 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6033 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6034 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6035 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6036 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6037 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6038 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6039 /* The click modifier is denoted by the absence of other modifiers. */
6043 mod_len
= p
- new_mods
;
6047 Lisp_Object new_name
;
6049 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6050 mod_len
+ base_len_byte
);
6051 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6052 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6054 return Fintern (new_name
, Qnil
);
6059 static char *modifier_names
[] =
6061 "up", "down", "drag", "click", "double", "triple", 0, 0,
6062 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6063 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6065 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6067 static Lisp_Object modifier_symbols
;
6069 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6071 lispy_modifier_list (modifiers
)
6074 Lisp_Object modifier_list
;
6077 modifier_list
= Qnil
;
6078 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6079 if (modifiers
& (1<<i
))
6080 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6083 return modifier_list
;
6087 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6088 where UNMODIFIED is the unmodified form of SYMBOL,
6089 MASK is the set of modifiers present in SYMBOL's name.
6090 This is similar to parse_modifiers_uncached, but uses the cache in
6091 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6092 Qevent_symbol_elements property. */
6095 parse_modifiers (symbol
)
6098 Lisp_Object elements
;
6100 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6101 if (CONSP (elements
))
6106 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6107 Lisp_Object unmodified
;
6110 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6111 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6114 if (modifiers
& ~INTMASK
)
6116 XSETFASTINT (mask
, modifiers
);
6117 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6119 /* Cache the parsing results on SYMBOL. */
6120 Fput (symbol
, Qevent_symbol_element_mask
,
6122 Fput (symbol
, Qevent_symbol_elements
,
6123 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6125 /* Since we know that SYMBOL is modifiers applied to unmodified,
6126 it would be nice to put that in unmodified's cache.
6127 But we can't, since we're not sure that parse_modifiers is
6134 /* Apply the modifiers MODIFIERS to the symbol BASE.
6135 BASE must be unmodified.
6137 This is like apply_modifiers_uncached, but uses BASE's
6138 Qmodifier_cache property, if present. It also builds
6139 Qevent_symbol_elements properties, since it has that info anyway.
6141 apply_modifiers copies the value of BASE's Qevent_kind property to
6142 the modified symbol. */
6144 apply_modifiers (modifiers
, base
)
6148 Lisp_Object cache
, index
, entry
, new_symbol
;
6150 /* Mask out upper bits. We don't know where this value's been. */
6151 modifiers
&= INTMASK
;
6153 /* The click modifier never figures into cache indices. */
6154 cache
= Fget (base
, Qmodifier_cache
);
6155 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6156 entry
= assq_no_quit (index
, cache
);
6159 new_symbol
= XCDR (entry
);
6162 /* We have to create the symbol ourselves. */
6163 new_symbol
= apply_modifiers_uncached (modifiers
,
6164 SDATA (SYMBOL_NAME (base
)),
6165 SCHARS (SYMBOL_NAME (base
)),
6166 SBYTES (SYMBOL_NAME (base
)));
6168 /* Add the new symbol to the base's cache. */
6169 entry
= Fcons (index
, new_symbol
);
6170 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6172 /* We have the parsing info now for free, so we could add it to
6174 XSETFASTINT (index, modifiers);
6175 Fput (new_symbol, Qevent_symbol_element_mask,
6176 Fcons (base, Fcons (index, Qnil)));
6177 Fput (new_symbol, Qevent_symbol_elements,
6178 Fcons (base, lispy_modifier_list (modifiers)));
6179 Sadly, this is only correct if `base' is indeed a base event,
6180 which is not necessarily the case. -stef */
6183 /* Make sure this symbol is of the same kind as BASE.
6185 You'd think we could just set this once and for all when we
6186 intern the symbol above, but reorder_modifiers may call us when
6187 BASE's property isn't set right; we can't assume that just
6188 because it has a Qmodifier_cache property it must have its
6189 Qevent_kind set right as well. */
6190 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6194 kind
= Fget (base
, Qevent_kind
);
6196 Fput (new_symbol
, Qevent_kind
, kind
);
6203 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6204 return a symbol with the modifiers placed in the canonical order.
6205 Canonical order is alphabetical, except for down and drag, which
6206 always come last. The 'click' modifier is never written out.
6208 Fdefine_key calls this to make sure that (for example) C-M-foo
6209 and M-C-foo end up being equivalent in the keymap. */
6212 reorder_modifiers (symbol
)
6215 /* It's hopefully okay to write the code this way, since everything
6216 will soon be in caches, and no consing will be done at all. */
6219 parsed
= parse_modifiers (symbol
);
6220 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6225 /* For handling events, we often want to produce a symbol whose name
6226 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6227 to some base, like the name of a function key or mouse button.
6228 modify_event_symbol produces symbols of this sort.
6230 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6231 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6234 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6235 into symbol names, or a string specifying a name stem used to
6236 construct a symbol name or the form `STEM-N', where N is the decimal
6237 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6238 non-nil; otherwise NAME_TABLE is used.
6240 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6241 persist between calls to modify_event_symbol that it can use to
6242 store a cache of the symbols it's generated for this NAME_TABLE
6243 before. The object stored there may be a vector or an alist.
6245 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6247 MODIFIERS is a set of modifier bits (as given in struct input_events)
6248 whose prefixes should be applied to the symbol name.
6250 SYMBOL_KIND is the value to be placed in the event_kind property of
6251 the returned symbol.
6253 The symbols we create are supposed to have an
6254 `event-symbol-elements' property, which lists the modifiers present
6255 in the symbol's name. */
6258 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6259 name_table
, symbol_table
, table_size
)
6262 Lisp_Object symbol_kind
;
6263 Lisp_Object name_alist_or_stem
;
6265 Lisp_Object
*symbol_table
;
6266 unsigned int table_size
;
6269 Lisp_Object symbol_int
;
6271 /* Get rid of the "vendor-specific" bit here. */
6272 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6274 /* Is this a request for a valid symbol? */
6275 if (symbol_num
< 0 || symbol_num
>= table_size
)
6278 if (CONSP (*symbol_table
))
6279 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6281 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6282 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6283 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6284 we've never used that symbol before. */
6287 if (! VECTORP (*symbol_table
)
6288 || XVECTOR (*symbol_table
)->size
!= table_size
)
6292 XSETFASTINT (size
, table_size
);
6293 *symbol_table
= Fmake_vector (size
, Qnil
);
6296 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6299 /* Have we already used this symbol before? */
6302 /* No; let's create it. */
6303 if (CONSP (name_alist_or_stem
))
6304 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6305 else if (STRINGP (name_alist_or_stem
))
6307 int len
= SBYTES (name_alist_or_stem
);
6308 char *buf
= (char *) alloca (len
+ 50);
6309 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6310 (long) XINT (symbol_int
) + 1);
6311 value
= intern (buf
);
6313 else if (name_table
!= 0 && name_table
[symbol_num
])
6314 value
= intern (name_table
[symbol_num
]);
6316 #ifdef HAVE_WINDOW_SYSTEM
6319 char *name
= x_get_keysym_name (symbol_num
);
6321 value
= intern (name
);
6328 sprintf (buf
, "key-%d", symbol_num
);
6329 value
= intern (buf
);
6332 if (CONSP (*symbol_table
))
6333 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6335 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6337 /* Fill in the cache entries for this symbol; this also
6338 builds the Qevent_symbol_elements property, which the user
6340 apply_modifiers (modifiers
& click_modifier
, value
);
6341 Fput (value
, Qevent_kind
, symbol_kind
);
6344 /* Apply modifiers to that symbol. */
6345 return apply_modifiers (modifiers
, value
);
6348 /* Convert a list that represents an event type,
6349 such as (ctrl meta backspace), into the usual representation of that
6350 event type as a number or a symbol. */
6352 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6353 doc
: /* Convert the event description list EVENT-DESC to an event type.
6354 EVENT-DESC should contain one base event type (a character or symbol)
6355 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6356 drag, down, double or triple). The base must be last.
6357 The return value is an event type (a character or symbol) which
6358 has the same base event type and all the specified modifiers. */)
6360 Lisp_Object event_desc
;
6368 while (CONSP (rest
))
6376 /* Given a symbol, see if it is a modifier name. */
6377 if (SYMBOLP (elt
) && CONSP (rest
))
6378 this = parse_solitary_modifier (elt
);
6382 else if (!NILP (base
))
6383 error ("Two bases given in one event");
6389 /* Let the symbol A refer to the character A. */
6390 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6391 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6393 if (INTEGERP (base
))
6395 /* Turn (shift a) into A. */
6396 if ((modifiers
& shift_modifier
) != 0
6397 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6399 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6400 modifiers
&= ~shift_modifier
;
6403 /* Turn (control a) into C-a. */
6404 if (modifiers
& ctrl_modifier
)
6405 return make_number ((modifiers
& ~ctrl_modifier
)
6406 | make_ctrl_char (XINT (base
)));
6408 return make_number (modifiers
| XINT (base
));
6410 else if (SYMBOLP (base
))
6411 return apply_modifiers (modifiers
, base
);
6414 error ("Invalid base event");
6419 /* Try to recognize SYMBOL as a modifier name.
6420 Return the modifier flag bit, or 0 if not recognized. */
6423 parse_solitary_modifier (symbol
)
6426 Lisp_Object name
= SYMBOL_NAME (symbol
);
6428 switch (SREF (name
, 0))
6430 #define SINGLE_LETTER_MOD(BIT) \
6431 if (SBYTES (name) == 1) \
6434 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6435 if (LEN == SBYTES (name) \
6436 && ! strncmp (SDATA (name), NAME, LEN)) \
6440 SINGLE_LETTER_MOD (alt_modifier
);
6444 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6448 SINGLE_LETTER_MOD (ctrl_modifier
);
6452 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6453 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6457 SINGLE_LETTER_MOD (hyper_modifier
);
6461 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6465 SINGLE_LETTER_MOD (meta_modifier
);
6469 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6473 SINGLE_LETTER_MOD (shift_modifier
);
6477 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6478 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6479 SINGLE_LETTER_MOD (super_modifier
);
6483 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6484 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6485 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6489 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6492 #undef SINGLE_LETTER_MOD
6493 #undef MULTI_LETTER_MOD
6499 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6500 Such a list is not valid as an event,
6501 but it can be a Lucid-style event type list. */
6504 lucid_event_type_list_p (object
)
6509 if (! CONSP (object
))
6512 if (EQ (XCAR (object
), Qhelp_echo
)
6513 || EQ (XCAR (object
), Qvertical_line
)
6514 || EQ (XCAR (object
), Qmode_line
)
6515 || EQ (XCAR (object
), Qheader_line
))
6518 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6522 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6529 /* Store into *addr a value nonzero if terminal input chars are available.
6530 Serves the purpose of ioctl (0, FIONREAD, addr)
6531 but works even if FIONREAD does not exist.
6532 (In fact, this may actually read some input.)
6534 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6535 timer events that are ripe.
6536 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6537 events (FOCUS_IN_EVENT).
6538 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6539 movements and toolkit scroll bar thumb drags. */
6542 get_input_pending (addr
, flags
)
6546 /* First of all, have we already counted some input? */
6547 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
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
) || readable_events (flags
));
6558 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6561 gobble_input (expected
)
6566 if (interrupt_input
)
6569 mask
= sigblock (sigmask (SIGIO
));
6570 read_avail_input (expected
);
6574 #ifdef POLL_FOR_INPUT
6575 /* XXX This condition was (read_socket_hook && !interrupt_input),
6576 but read_socket_hook is not global anymore. Let's pretend that
6578 if (!interrupt_input
&& poll_suppress_count
== 0)
6581 mask
= sigblock (sigmask (SIGALRM
));
6582 read_avail_input (expected
);
6588 read_avail_input (expected
);
6592 /* Put a BUFFER_SWITCH_EVENT in the buffer
6593 so that read_key_sequence will notice the new current buffer. */
6596 record_asynch_buffer_change ()
6598 struct input_event event
;
6602 event
.kind
= BUFFER_SWITCH_EVENT
;
6603 event
.frame_or_window
= Qnil
;
6607 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6608 The purpose of the event is to make read_key_sequence look up the
6609 keymaps again. If we aren't in read_key_sequence, we don't need one,
6610 and the event could cause trouble by messing up (input-pending-p). */
6611 tem
= Fwaiting_for_user_input_p ();
6615 /* We never need these events if we have no asynchronous subprocesses. */
6619 /* Make sure no interrupt happens while storing the event. */
6621 if (interrupt_input
)
6624 mask
= sigblock (sigmask (SIGIO
));
6625 kbd_buffer_store_event (&event
);
6632 kbd_buffer_store_event (&event
);
6639 /* Read any terminal input already buffered up by the system
6640 into the kbd_buffer, but do not wait.
6642 EXPECTED should be nonzero if the caller knows there is some input.
6644 Except on VMS, all input is read by this function.
6645 If interrupt_input is nonzero, this function MUST be called
6646 only when SIGIO is blocked.
6648 Returns the number of keyboard chars read, or -1 meaning
6649 this is a bad time to try to read input. */
6652 read_avail_input (expected
)
6659 /* Loop through the available displays, and call their input hooks. */
6663 struct display
*next
= d
->next_display
;
6665 if (d
->read_socket_hook
)
6668 struct input_event hold_quit
;
6670 EVENT_INIT (hold_quit
);
6671 hold_quit
.kind
= NO_EVENT
;
6673 /* No need for FIONREAD or fcntl; just say don't wait. */
6674 while (nr
= (*d
->read_socket_hook
) (d
, expected
, &hold_quit
), nr
> 0)
6680 if (nr
== -1) /* Not OK to read input now. */
6684 else if (nr
== -2) /* Non-transient error. */
6686 /* The display device terminated; it should be closed. */
6688 /* Kill Emacs if this was our last display. */
6689 if (! display_list
->next_display
)
6690 /* Formerly simply reported no input, but that
6691 sometimes led to a failure of Emacs to terminate.
6692 SIGHUP seems appropriate if we can't reach the
6694 /* ??? Is it really right to send the signal just to
6695 this process rather than to the whole process
6696 group? Perhaps on systems with FIONREAD Emacs is
6697 alone in its group. */
6698 kill (getpid (), SIGHUP
);
6700 /* XXX Is calling delete_display safe here? It calls Fdelete_frame. */
6701 if (d
->delete_display_hook
)
6702 (*d
->delete_display_hook
) (d
);
6707 if (hold_quit
.kind
!= NO_EVENT
)
6708 kbd_buffer_store_event (&hold_quit
);
6720 /* This is the tty way of reading available input.
6722 Note that each terminal device has its own `struct display' object,
6723 and so this function is called once for each individual termcap
6724 display. The first parameter indicates which device to read from. */
6727 tty_read_avail_input (struct display
*display
,
6729 struct input_event
*hold_quit
)
6731 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6732 the kbd_buffer can really hold. That may prevent loss
6733 of characters on some systems when input is stuffed at us. */
6734 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6736 struct tty_display_info
*tty
= display
->display_info
.tty
;
6739 if (display
->type
!= output_termcap
)
6742 /* XXX I think the following code should be moved to separate hook
6743 functions in system-dependent files. */
6746 #else /* not WINDOWSNT */
6748 n_to_read
= dos_keysns ();
6752 cbuf
[0] = dos_keyread ();
6755 #else /* not MSDOS */
6757 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6761 return 0; /* The terminal is suspended. */
6763 /* Determine how many characters we should *try* to read. */
6765 /* Find out how much input is available. */
6766 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6768 if (! noninteractive
)
6769 return -2; /* Close this display. */
6775 if (n_to_read
> sizeof cbuf
)
6776 n_to_read
= sizeof cbuf
;
6777 #else /* no FIONREAD */
6778 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6779 /* Read some input if available, but don't wait. */
6780 n_to_read
= sizeof cbuf
;
6781 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6787 /* Now read; for one reason or another, this will not block.
6788 NREAD is set to the number of chars read. */
6791 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
6792 /* POSIX infers that processes which are not in the session leader's
6793 process group won't get SIGHUP's at logout time. BSDI adheres to
6794 this part standard and returns -1 from read (0) with errno==EIO
6795 when the control tty is taken away.
6796 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6797 if (nread
== -1 && errno
== EIO
)
6798 return -2; /* Close this display. */
6799 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6800 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6801 This looks incorrect, but it isn't, because _BSD causes
6802 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6803 and that causes a value other than 0 when there is no input. */
6805 return -2; /* Close this display. */
6809 /* We used to retry the read if it was interrupted.
6810 But this does the wrong thing when O_NDELAY causes
6811 an EAGAIN error. Does anybody know of a situation
6812 where a retry is actually needed? */
6814 nread
< 0 && (errno
== EAGAIN
6828 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6829 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6830 #endif /* USG or DGUX or CYGWIN */
6831 #endif /* no FIONREAD */
6836 #endif /* not MSDOS */
6837 #endif /* not WINDOWSNT */
6839 for (i
= 0; i
< nread
; i
++)
6841 struct input_event buf
;
6843 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6845 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
6846 buf
.modifiers
= meta_modifier
;
6847 if (tty
->meta_key
!= 2)
6851 /* Set the frame corresponding to the active tty. Note that the
6852 value of selected_frame is not reliable here, redisplay tends
6853 to temporarily change it. */
6854 buf
.frame_or_window
= tty
->top_frame
;
6857 kbd_buffer_store_event (&buf
);
6858 /* Don't look at input that follows a C-g too closely.
6859 This reduces lossage due to autorepeat on C-g. */
6860 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6861 && buf
.code
== quit_char
)
6867 #endif /* not VMS */
6870 handle_async_input ()
6873 extern int select_alarmed
;
6876 interrupt_input_pending
= 0;
6881 nread
= read_avail_input (1);
6882 /* -1 means it's not ok to read the input now.
6883 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6884 0 means there was no keyboard input available. */
6889 select_alarmed
= 1; /* Force the select emulator back to life */
6894 #ifdef SIGIO /* for entire page */
6895 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6898 input_available_signal (signo
)
6901 /* Must preserve main program's value of errno. */
6902 int old_errno
= errno
;
6903 #if defined (USG) && !defined (POSIX_SIGNALS)
6904 /* USG systems forget handlers when they are used;
6905 must reestablish each time */
6906 signal (signo
, input_available_signal
);
6914 interrupt_input_pending
= 1;
6916 SIGNAL_THREAD_CHECK (signo
);
6919 if (input_available_clear_time
)
6920 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6923 handle_async_input ();
6933 /* Send ourselves a SIGIO.
6935 This function exists so that the UNBLOCK_INPUT macro in
6936 blockinput.h can have some way to take care of input we put off
6937 dealing with, without assuming that every file which uses
6938 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6940 reinvoke_input_signal ()
6943 handle_async_input ();
6949 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6950 static Lisp_Object menu_bar_one_keymap_changed_items
;
6952 /* These variables hold the vector under construction within
6953 menu_bar_items and its subroutines, and the current index
6954 for storing into that vector. */
6955 static Lisp_Object menu_bar_items_vector
;
6956 static int menu_bar_items_index
;
6958 /* Return a vector of menu items for a menu bar, appropriate
6959 to the current buffer. Each item has three elements in the vector:
6962 OLD is an old vector we can optionally reuse, or nil. */
6965 menu_bar_items (old
)
6968 /* The number of keymaps we're scanning right now, and the number of
6969 keymaps we have allocated space for. */
6972 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6973 in the current keymaps, or nil where it is not a prefix. */
6976 Lisp_Object def
, tail
;
6985 struct gcpro gcpro1
;
6987 /* In order to build the menus, we need to call the keymap
6988 accessors. They all call QUIT. But this function is called
6989 during redisplay, during which a quit is fatal. So inhibit
6990 quitting while building the menus.
6991 We do this instead of specbind because (1) errors will clear it anyway
6992 and (2) this avoids risk of specpdl overflow. */
6993 oquit
= Vinhibit_quit
;
6997 menu_bar_items_vector
= old
;
6999 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7000 menu_bar_items_index
= 0;
7002 GCPRO1 (menu_bar_items_vector
);
7004 /* Build our list of keymaps.
7005 If we recognize a function key and replace its escape sequence in
7006 keybuf with its symbol, or if the sequence starts with a mouse
7007 click and we need to switch buffers, we jump back here to rebuild
7008 the initial keymaps from the current buffer. */
7012 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7013 if (!NILP (Voverriding_local_map_menu_flag
))
7015 /* Yes, use them (if non-nil) as well as the global map. */
7016 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7018 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7019 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7020 if (!NILP (Voverriding_local_map
))
7021 maps
[nmaps
++] = Voverriding_local_map
;
7025 /* No, so use major and minor mode keymaps and keymap property.
7026 Note that menu-bar bindings in the local-map and keymap
7027 properties may not work reliable, as they are only
7028 recognized when the menu-bar (or mode-line) is updated,
7029 which does not normally happen after every command. */
7032 nminor
= current_minor_maps (NULL
, &tmaps
);
7033 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7035 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7036 maps
[nmaps
++] = tem
;
7037 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7039 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7041 maps
[nmaps
++] = current_global_map
;
7044 /* Look up in each map the dummy prefix key `menu-bar'. */
7048 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7049 if (!NILP (maps
[mapno
]))
7051 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7055 menu_bar_one_keymap_changed_items
= Qnil
;
7056 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7060 /* Move to the end those items that should be at the end. */
7062 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7065 int end
= menu_bar_items_index
;
7067 for (i
= 0; i
< end
; i
+= 4)
7068 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7070 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7071 /* Move the item at index I to the end,
7072 shifting all the others forward. */
7073 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7074 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7075 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7076 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7078 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7079 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7080 (end
- i
- 4) * sizeof (Lisp_Object
));
7081 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7082 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7083 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7084 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7089 /* Add nil, nil, nil, nil at the end. */
7090 i
= menu_bar_items_index
;
7091 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7094 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7095 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7096 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7097 menu_bar_items_vector
= tem
;
7099 /* Add this item. */
7100 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7101 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7102 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7103 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7104 menu_bar_items_index
= i
;
7106 Vinhibit_quit
= oquit
;
7108 return menu_bar_items_vector
;
7111 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7112 If there's already an item for KEY, add this DEF to it. */
7114 Lisp_Object item_properties
;
7117 menu_bar_item (key
, item
, dummy1
, dummy2
)
7118 Lisp_Object key
, item
, dummy1
;
7121 struct gcpro gcpro1
;
7125 if (EQ (item
, Qundefined
))
7127 /* If a map has an explicit `undefined' as definition,
7128 discard any previously made menu bar item. */
7130 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7131 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7133 if (menu_bar_items_index
> i
+ 4)
7134 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7135 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7136 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7137 menu_bar_items_index
-= 4;
7141 /* If this keymap has already contributed to this KEY,
7142 don't contribute to it a second time. */
7143 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7144 if (!NILP (tem
) || NILP (item
))
7147 menu_bar_one_keymap_changed_items
7148 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7150 /* We add to menu_bar_one_keymap_changed_items before doing the
7151 parse_menu_item, so that if it turns out it wasn't a menu item,
7152 it still correctly hides any further menu item. */
7154 i
= parse_menu_item (item
, 0, 1);
7159 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7161 /* Find any existing item for this KEY. */
7162 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7163 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7166 /* If we did not find this KEY, add it at the end. */
7167 if (i
== menu_bar_items_index
)
7169 /* If vector is too small, get a bigger one. */
7170 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7173 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7174 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7175 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7176 menu_bar_items_vector
= tem
;
7179 /* Add this item. */
7180 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7181 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7182 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7183 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7184 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7185 menu_bar_items_index
= i
;
7187 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7191 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7192 /* If the new and the old items are not both keymaps,
7193 the lookup will only find `item'. */
7194 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7195 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7199 /* This is used as the handler when calling menu_item_eval_property. */
7201 menu_item_eval_property_1 (arg
)
7204 /* If we got a quit from within the menu computation,
7205 quit all the way out of it. This takes care of C-] in the debugger. */
7206 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7207 Fsignal (Qquit
, Qnil
);
7212 /* Evaluate an expression and return the result (or nil if something
7213 went wrong). Used to evaluate dynamic parts of menu items. */
7215 menu_item_eval_property (sexpr
)
7218 int count
= SPECPDL_INDEX ();
7220 specbind (Qinhibit_redisplay
, Qt
);
7221 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7222 menu_item_eval_property_1
);
7223 return unbind_to (count
, val
);
7226 /* This function parses a menu item and leaves the result in the
7227 vector item_properties.
7228 ITEM is a key binding, a possible menu item.
7229 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7230 evaluate dynamic expressions in the menu item.
7231 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7233 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7234 parse_menu_item returns true if the item is a menu item and false
7238 parse_menu_item (item
, notreal
, inmenubar
)
7240 int notreal
, inmenubar
;
7242 Lisp_Object def
, tem
, item_string
, start
;
7243 Lisp_Object cachelist
;
7245 Lisp_Object keyhint
;
7256 /* Create item_properties vector if necessary. */
7257 if (NILP (item_properties
))
7259 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7261 /* Initialize optional entries. */
7262 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7263 AREF (item_properties
, i
) = Qnil
;
7264 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7266 /* Save the item here to protect it from GC. */
7267 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7269 item_string
= XCAR (item
);
7273 if (STRINGP (item_string
))
7275 /* Old format menu item. */
7276 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7278 /* Maybe help string. */
7279 if (CONSP (item
) && STRINGP (XCAR (item
)))
7281 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7286 /* Maybe key binding cache. */
7287 if (CONSP (item
) && CONSP (XCAR (item
))
7288 && (NILP (XCAR (XCAR (item
)))
7289 || VECTORP (XCAR (XCAR (item
)))))
7291 cachelist
= XCAR (item
);
7295 /* This is the real definition--the function to run. */
7296 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7298 /* Get enable property, if any. */
7301 tem
= Fget (item
, Qmenu_enable
);
7303 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7306 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7308 /* New format menu item. */
7309 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7310 start
= XCDR (item
);
7313 /* We have a real binding. */
7314 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7316 item
= XCDR (start
);
7317 /* Is there a cache list with key equivalences. */
7318 if (CONSP (item
) && CONSP (XCAR (item
)))
7320 cachelist
= XCAR (item
);
7324 /* Parse properties. */
7325 while (CONSP (item
) && CONSP (XCDR (item
)))
7330 if (EQ (tem
, QCenable
))
7331 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7332 else if (EQ (tem
, QCvisible
) && !notreal
)
7334 /* If got a visible property and that evaluates to nil
7335 then ignore this item. */
7336 tem
= menu_item_eval_property (XCAR (item
));
7340 else if (EQ (tem
, QChelp
))
7341 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7342 else if (EQ (tem
, QCfilter
))
7344 else if (EQ (tem
, QCkey_sequence
))
7347 if (NILP (cachelist
)
7348 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7349 /* Be GC protected. Set keyhint to item instead of tem. */
7352 else if (EQ (tem
, QCkeys
))
7355 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7356 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7358 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7363 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7365 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7367 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7374 else if (inmenubar
|| !NILP (start
))
7378 return 0; /* not a menu item */
7380 /* If item string is not a string, evaluate it to get string.
7381 If we don't get a string, skip this item. */
7382 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7383 if (!(STRINGP (item_string
) || notreal
))
7385 item_string
= menu_item_eval_property (item_string
);
7386 if (!STRINGP (item_string
))
7388 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7391 /* If got a filter apply it on definition. */
7392 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7395 def
= menu_item_eval_property (list2 (XCAR (filter
),
7396 list2 (Qquote
, def
)));
7398 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7401 /* Enable or disable selection of item. */
7402 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7408 tem
= menu_item_eval_property (tem
);
7409 if (inmenubar
&& NILP (tem
))
7410 return 0; /* Ignore disabled items in menu bar. */
7411 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7414 /* If we got no definition, this item is just unselectable text which
7415 is OK in a submenu but not in the menubar. */
7417 return (inmenubar
? 0 : 1);
7419 /* See if this is a separate pane or a submenu. */
7420 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7421 tem
= get_keymap (def
, 0, 1);
7422 /* For a subkeymap, just record its details and exit. */
7425 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7426 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7430 /* At the top level in the menu bar, do likewise for commands also.
7431 The menu bar does not display equivalent key bindings anyway.
7432 ITEM_PROPERTY_DEF is already set up properly. */
7436 /* This is a command. See if there is an equivalent key binding. */
7437 if (NILP (cachelist
))
7439 /* We have to create a cachelist. */
7440 CHECK_IMPURE (start
);
7441 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7442 cachelist
= XCAR (XCDR (start
));
7444 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7445 if (!NILP (keyhint
))
7447 XSETCAR (cachelist
, XCAR (keyhint
));
7450 else if (STRINGP (tem
))
7452 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7453 XSETCAR (cachelist
, Qt
);
7457 tem
= XCAR (cachelist
);
7464 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7466 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7469 def
= XCAR (prefix
);
7470 prefix
= XCDR (prefix
);
7473 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7475 if (!update_menu_bindings
)
7477 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7479 if (newcache
/* Always check first time. */
7480 /* Should we check everything when precomputing key
7482 /* If something had no key binding before, don't recheck it
7483 because that is too slow--except if we have a list of
7484 rebound commands in Vdefine_key_rebound_commands, do
7485 recheck any command that appears in that list. */
7486 || (CONSP (Vdefine_key_rebound_commands
)
7487 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7490 /* We had a saved key. Is it still bound to the command? */
7493 /* If the command is an alias for another
7494 (such as lmenu.el set it up), check if the
7495 original command matches the cached command. */
7496 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7497 chkcache
= 1; /* Need to recompute key binding. */
7501 /* Recompute equivalent key binding. If the command is an alias
7502 for another (such as lmenu.el set it up), see if the original
7503 command name has equivalent keys. Otherwise look up the
7504 specified command itself. We don't try both, because that
7505 makes lmenu menus slow. */
7507 && SYMBOLP (XSYMBOL (def
)->function
)
7508 && ! NILP (Fget (def
, Qmenu_alias
)))
7509 def
= XSYMBOL (def
)->function
;
7510 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7511 XSETCAR (cachelist
, tem
);
7514 XSETCDR (cachelist
, Qnil
);
7518 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7520 tem
= XCAR (cachelist
);
7524 newcache
= chkcache
;
7527 tem
= Fkey_description (tem
, Qnil
);
7530 if (STRINGP (XCAR (prefix
)))
7531 tem
= concat2 (XCAR (prefix
), tem
);
7532 if (STRINGP (XCDR (prefix
)))
7533 tem
= concat2 (tem
, XCDR (prefix
));
7535 XSETCDR (cachelist
, tem
);
7539 tem
= XCDR (cachelist
);
7540 if (newcache
&& !NILP (tem
))
7542 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7543 XSETCDR (cachelist
, tem
);
7546 /* If we only want to precompute equivalent key bindings, stop here. */
7550 /* If we have an equivalent key binding, use that. */
7551 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7553 /* Include this when menu help is implemented.
7554 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7555 if (!(NILP (tem) || STRINGP (tem)))
7557 tem = menu_item_eval_property (tem);
7560 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7564 /* Handle radio buttons or toggle boxes. */
7565 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7567 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7568 = menu_item_eval_property (tem
);
7575 /***********************************************************************
7577 ***********************************************************************/
7579 /* A vector holding tool bar items while they are parsed in function
7580 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7583 static Lisp_Object tool_bar_items_vector
;
7585 /* A vector holding the result of parse_tool_bar_item. Layout is like
7586 the one for a single item in tool_bar_items_vector. */
7588 static Lisp_Object tool_bar_item_properties
;
7590 /* Next free index in tool_bar_items_vector. */
7592 static int ntool_bar_items
;
7594 /* The symbols `tool-bar', and `:image'. */
7596 extern Lisp_Object Qtool_bar
;
7597 Lisp_Object QCimage
;
7599 /* Function prototypes. */
7601 static void init_tool_bar_items
P_ ((Lisp_Object
));
7602 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7603 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7604 static void append_tool_bar_item
P_ ((void));
7607 /* Return a vector of tool bar items for keymaps currently in effect.
7608 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7609 tool bar items found. */
7612 tool_bar_items (reuse
, nitems
)
7623 /* In order to build the menus, we need to call the keymap
7624 accessors. They all call QUIT. But this function is called
7625 during redisplay, during which a quit is fatal. So inhibit
7626 quitting while building the menus. We do this instead of
7627 specbind because (1) errors will clear it anyway and (2) this
7628 avoids risk of specpdl overflow. */
7629 oquit
= Vinhibit_quit
;
7632 /* Initialize tool_bar_items_vector and protect it from GC. */
7633 init_tool_bar_items (reuse
);
7635 /* Build list of keymaps in maps. Set nmaps to the number of maps
7638 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7639 if (!NILP (Voverriding_local_map_menu_flag
))
7641 /* Yes, use them (if non-nil) as well as the global map. */
7642 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7644 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7645 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7646 if (!NILP (Voverriding_local_map
))
7647 maps
[nmaps
++] = Voverriding_local_map
;
7651 /* No, so use major and minor mode keymaps and keymap property.
7652 Note that tool-bar bindings in the local-map and keymap
7653 properties may not work reliable, as they are only
7654 recognized when the tool-bar (or mode-line) is updated,
7655 which does not normally happen after every command. */
7658 nminor
= current_minor_maps (NULL
, &tmaps
);
7659 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7661 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7662 maps
[nmaps
++] = tem
;
7663 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7665 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7668 /* Add global keymap at the end. */
7669 maps
[nmaps
++] = current_global_map
;
7671 /* Process maps in reverse order and look up in each map the prefix
7673 for (i
= nmaps
- 1; i
>= 0; --i
)
7674 if (!NILP (maps
[i
]))
7678 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7683 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7684 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7686 Lisp_Object keydef
= XCAR (tail
);
7688 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7693 Vinhibit_quit
= oquit
;
7694 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7695 return tool_bar_items_vector
;
7699 /* Process the definition of KEY which is DEF. */
7702 process_tool_bar_item (key
, def
)
7703 Lisp_Object key
, def
;
7706 extern Lisp_Object Qundefined
;
7707 struct gcpro gcpro1
, gcpro2
;
7709 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7713 if (EQ (def
, Qundefined
))
7715 /* If a map has an explicit `undefined' as definition,
7716 discard any previously made item. */
7717 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7719 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7721 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7723 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7724 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7725 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7726 * sizeof (Lisp_Object
)));
7727 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7732 else if (parse_tool_bar_item (key
, def
))
7733 /* Append a new tool bar item to tool_bar_items_vector. Accept
7734 more than one definition for the same key. */
7735 append_tool_bar_item ();
7741 /* Parse a tool bar item specification ITEM for key KEY and return the
7742 result in tool_bar_item_properties. Value is zero if ITEM is
7745 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7747 CAPTION is the caption of the item, If it's not a string, it is
7748 evaluated to get a string.
7750 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7751 as binding are currently ignored.
7753 The following properties are recognized:
7757 FORM is evaluated and specifies whether the tool bar item is
7758 enabled or disabled.
7762 FORM is evaluated and specifies whether the tool bar item is visible.
7764 - `:filter FUNCTION'
7766 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7767 result is stored as the new binding.
7769 - `:button (TYPE SELECTED)'
7771 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7772 and specifies whether the button is selected (pressed) or not.
7776 IMAGES is either a single image specification or a vector of four
7777 image specifications. See enum tool_bar_item_images.
7779 - `:help HELP-STRING'.
7781 Gives a help string to display for the tool bar item. */
7784 parse_tool_bar_item (key
, item
)
7785 Lisp_Object key
, item
;
7787 /* Access slot with index IDX of vector tool_bar_item_properties. */
7788 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7790 Lisp_Object filter
= Qnil
;
7791 Lisp_Object caption
;
7794 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7795 Rule out items that aren't lists, don't start with
7796 `menu-item' or whose rest following `tool-bar-item' is not a
7799 || !EQ (XCAR (item
), Qmenu_item
)
7800 || (item
= XCDR (item
),
7804 /* Create tool_bar_item_properties vector if necessary. Reset it to
7806 if (VECTORP (tool_bar_item_properties
))
7808 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7812 tool_bar_item_properties
7813 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7816 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7817 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7819 /* Get the caption of the item. If the caption is not a string,
7820 evaluate it to get a string. If we don't get a string, skip this
7822 caption
= XCAR (item
);
7823 if (!STRINGP (caption
))
7825 caption
= menu_item_eval_property (caption
);
7826 if (!STRINGP (caption
))
7829 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7831 /* Give up if rest following the caption is not a list. */
7836 /* Store the binding. */
7837 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7840 /* Ignore cached key binding, if any. */
7841 if (CONSP (item
) && CONSP (XCAR (item
)))
7844 /* Process the rest of the properties. */
7845 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7847 Lisp_Object key
, value
;
7850 value
= XCAR (XCDR (item
));
7852 if (EQ (key
, QCenable
))
7853 /* `:enable FORM'. */
7854 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7855 else if (EQ (key
, QCvisible
))
7857 /* `:visible FORM'. If got a visible property and that
7858 evaluates to nil then ignore this item. */
7859 if (NILP (menu_item_eval_property (value
)))
7862 else if (EQ (key
, QChelp
))
7863 /* `:help HELP-STRING'. */
7864 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7865 else if (EQ (key
, QCfilter
))
7866 /* ':filter FORM'. */
7868 else if (EQ (key
, QCbutton
) && CONSP (value
))
7870 /* `:button (TYPE . SELECTED)'. */
7871 Lisp_Object type
, selected
;
7873 type
= XCAR (value
);
7874 selected
= XCDR (value
);
7875 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7877 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7878 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7881 else if (EQ (key
, QCimage
)
7883 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7884 /* Value is either a single image specification or a vector
7885 of 4 such specifications for the different button states. */
7886 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7889 /* If got a filter apply it on binding. */
7891 PROP (TOOL_BAR_ITEM_BINDING
)
7892 = menu_item_eval_property (list2 (filter
,
7894 PROP (TOOL_BAR_ITEM_BINDING
))));
7896 /* See if the binding is a keymap. Give up if it is. */
7897 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7900 /* Enable or disable selection of item. */
7901 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7902 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7903 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7905 /* Handle radio buttons or toggle boxes. */
7906 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7907 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7908 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7916 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7917 that can be reused. */
7920 init_tool_bar_items (reuse
)
7923 if (VECTORP (reuse
))
7924 tool_bar_items_vector
= reuse
;
7926 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7927 ntool_bar_items
= 0;
7931 /* Append parsed tool bar item properties from
7932 tool_bar_item_properties */
7935 append_tool_bar_item ()
7937 Lisp_Object
*to
, *from
;
7939 /* Enlarge tool_bar_items_vector if necessary. */
7940 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7941 >= XVECTOR (tool_bar_items_vector
)->size
)
7943 Lisp_Object new_vector
;
7944 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7946 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7947 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7948 XVECTOR (new_vector
)->contents
,
7949 old_size
* sizeof (Lisp_Object
));
7950 tool_bar_items_vector
= new_vector
;
7953 /* Append entries from tool_bar_item_properties to the end of
7954 tool_bar_items_vector. */
7955 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7956 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7957 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7958 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7965 /* Read a character using menus based on maps in the array MAPS.
7966 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7967 Return t if we displayed a menu but the user rejected it.
7969 PREV_EVENT is the previous input event, or nil if we are reading
7970 the first event of a key sequence.
7972 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7973 if we used a mouse menu to read the input, or zero otherwise. If
7974 USED_MOUSE_MENU is null, we don't dereference it.
7976 The prompting is done based on the prompt-string of the map
7977 and the strings associated with various map elements.
7979 This can be done with X menus or with menus put in the minibuf.
7980 These are done in different ways, depending on how the input will be read.
7981 Menus using X are done after auto-saving in read-char, getting the input
7982 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7983 and do auto-saving in the inner call of read_char. */
7986 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7989 Lisp_Object prev_event
;
7990 int *used_mouse_menu
;
7993 register Lisp_Object name
= Qnil
;
7995 if (used_mouse_menu
)
7996 *used_mouse_menu
= 0;
7998 /* Use local over global Menu maps */
8000 if (! menu_prompting
)
8003 /* Optionally disregard all but the global map. */
8004 if (inhibit_local_menu_bar_menus
)
8006 maps
+= (nmaps
- 1);
8010 /* Get the menu name from the first map that has one (a prompt string). */
8011 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8013 name
= Fkeymap_prompt (maps
[mapno
]);
8018 /* If we don't have any menus, just read a character normally. */
8019 if (!STRINGP (name
))
8023 /* If we got to this point via a mouse click,
8024 use a real menu for mouse selection. */
8025 if (EVENT_HAS_PARAMETERS (prev_event
)
8026 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8027 && !EQ (XCAR (prev_event
), Qtool_bar
))
8029 /* Display the menu and get the selection. */
8030 Lisp_Object
*realmaps
8031 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8035 /* Use the maps that are not nil. */
8036 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8037 if (!NILP (maps
[mapno
]))
8038 realmaps
[nmaps1
++] = maps
[mapno
];
8040 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8045 record_menu_key (XCAR (value
));
8047 /* If we got multiple events, unread all but
8049 There is no way to prevent those unread events
8050 from showing up later in last_nonmenu_event.
8051 So turn symbol and integer events into lists,
8052 to indicate that they came from a mouse menu,
8053 so that when present in last_nonmenu_event
8054 they won't confuse things. */
8055 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8057 record_menu_key (XCAR (tem
));
8058 if (SYMBOLP (XCAR (tem
))
8059 || INTEGERP (XCAR (tem
)))
8060 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8063 /* If we got more than one event, put all but the first
8064 onto this list to be read later.
8065 Return just the first event now. */
8066 Vunread_command_events
8067 = nconc2 (XCDR (value
), Vunread_command_events
);
8068 value
= XCAR (value
);
8070 else if (NILP (value
))
8072 if (used_mouse_menu
)
8073 *used_mouse_menu
= 1;
8076 #endif /* HAVE_MENUS */
8080 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8081 We make this bigger when necessary, and never free it. */
8082 static char *read_char_minibuf_menu_text
;
8083 /* Size of that buffer. */
8084 static int read_char_minibuf_menu_width
;
8087 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8093 register Lisp_Object name
;
8095 /* FIXME: Use the minibuffer's frame width. */
8096 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8099 Lisp_Object rest
, vector
;
8105 if (! menu_prompting
)
8108 /* Make sure we have a big enough buffer for the menu text. */
8109 if (read_char_minibuf_menu_text
== 0)
8111 read_char_minibuf_menu_width
= width
+ 4;
8112 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8114 else if (width
+ 4 > read_char_minibuf_menu_width
)
8116 read_char_minibuf_menu_width
= width
+ 4;
8117 read_char_minibuf_menu_text
8118 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8120 menu
= read_char_minibuf_menu_text
;
8122 /* Get the menu name from the first map that has one (a prompt string). */
8123 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8125 name
= Fkeymap_prompt (maps
[mapno
]);
8130 /* If we don't have any menus, just read a character normally. */
8131 if (!STRINGP (name
))
8134 /* Prompt string always starts with map's prompt, and a space. */
8135 strcpy (menu
, SDATA (name
));
8136 nlength
= SBYTES (name
);
8137 menu
[nlength
++] = ':';
8138 menu
[nlength
++] = ' ';
8141 /* Start prompting at start of first map. */
8145 /* Present the documented bindings, a line at a time. */
8152 Lisp_Object orig_defn_macro
;
8154 /* Loop over elements of map. */
8159 /* If reached end of map, start at beginning of next map. */
8163 /* At end of last map, wrap around to first map if just starting,
8164 or end this line if already have something on it. */
8168 if (notfirst
|| nobindings
) break;
8173 /* Look at the next element of the map. */
8175 elt
= XVECTOR (vector
)->contents
[idx
];
8177 elt
= Fcar_safe (rest
);
8179 if (idx
< 0 && VECTORP (elt
))
8181 /* If we found a dense table in the keymap,
8182 advanced past it, but start scanning its contents. */
8183 rest
= Fcdr_safe (rest
);
8189 /* An ordinary element. */
8190 Lisp_Object event
, tem
;
8194 event
= Fcar_safe (elt
); /* alist */
8195 elt
= Fcdr_safe (elt
);
8199 XSETINT (event
, idx
); /* vector */
8202 /* Ignore the element if it has no prompt string. */
8203 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8205 /* 1 if the char to type matches the string. */
8207 Lisp_Object upcased_event
, downcased_event
;
8208 Lisp_Object desc
= Qnil
;
8210 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8212 upcased_event
= Fupcase (event
);
8213 downcased_event
= Fdowncase (event
);
8214 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8215 || XINT (downcased_event
) == SREF (s
, 0));
8217 desc
= Fsingle_key_description (event
, Qnil
);
8219 #if 0 /* It is redundant to list the equivalent key bindings because
8220 the prefix is what the user has already typed. */
8222 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8224 /* Insert equivalent keybinding. */
8225 s
= concat2 (s
, tem
);
8228 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8229 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8231 /* Insert button prefix. */
8232 Lisp_Object selected
8233 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8234 if (EQ (tem
, QCradio
))
8235 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8237 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8238 s
= concat2 (tem
, s
);
8242 /* If we have room for the prompt string, add it to this line.
8243 If this is the first on the line, always add it. */
8244 if ((SCHARS (s
) + i
+ 2
8245 + (char_matches
? 0 : SCHARS (desc
) + 3))
8251 /* Punctuate between strings. */
8254 strcpy (menu
+ i
, ", ");
8260 /* If the char to type doesn't match the string's
8261 first char, explicitly show what char to type. */
8264 /* Add as much of string as fits. */
8265 thiswidth
= SCHARS (desc
);
8266 if (thiswidth
+ i
> width
)
8267 thiswidth
= width
- i
;
8268 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8270 strcpy (menu
+ i
, " = ");
8274 /* Add as much of string as fits. */
8275 thiswidth
= SCHARS (s
);
8276 if (thiswidth
+ i
> width
)
8277 thiswidth
= width
- i
;
8278 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8284 /* If this element does not fit, end the line now,
8285 and save the element for the next line. */
8286 strcpy (menu
+ i
, "...");
8291 /* Move past this element. */
8292 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8293 /* Handle reaching end of dense table. */
8298 rest
= Fcdr_safe (rest
);
8302 /* Prompt with that and read response. */
8303 message2_nolog (menu
, strlen (menu
),
8304 ! NILP (current_buffer
->enable_multibyte_characters
));
8306 /* Make believe its not a keyboard macro in case the help char
8307 is pressed. Help characters are not recorded because menu prompting
8308 is not used on replay.
8310 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8311 current_kboard
->defining_kbd_macro
= Qnil
;
8313 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8314 while (BUFFERP (obj
));
8315 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8317 if (!INTEGERP (obj
))
8322 if (! EQ (obj
, menu_prompt_more_char
)
8323 && (!INTEGERP (menu_prompt_more_char
)
8324 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8326 if (!NILP (current_kboard
->defining_kbd_macro
))
8327 store_kbd_macro_char (obj
);
8330 /* Help char - go round again */
8334 /* Reading key sequences. */
8336 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8337 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8338 keymap, or nil otherwise. Return the index of the first keymap in
8339 which KEY has any binding, or NMAPS if no map has a binding.
8341 If KEY is a meta ASCII character, treat it like meta-prefix-char
8342 followed by the corresponding non-meta character. Keymaps in
8343 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8346 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8349 NEXT may be the same array as CURRENT. */
8352 follow_key (key
, nmaps
, current
, defs
, next
)
8354 Lisp_Object
*current
, *defs
, *next
;
8357 int i
, first_binding
;
8359 first_binding
= nmaps
;
8360 for (i
= nmaps
- 1; i
>= 0; i
--)
8362 if (! NILP (current
[i
]))
8364 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8365 if (! NILP (defs
[i
]))
8372 /* Given the set of bindings we've found, produce the next set of maps. */
8373 if (first_binding
< nmaps
)
8374 for (i
= 0; i
< nmaps
; i
++)
8375 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8377 return first_binding
;
8380 /* Structure used to keep track of partial application of key remapping
8381 such as Vfunction_key_map and Vkey_translation_map. */
8382 typedef struct keyremap
8384 Lisp_Object map
, parent
;
8388 /* Lookup KEY in MAP.
8389 MAP is a keymap mapping keys to key vectors or functions.
8390 If the mapping is a function and DO_FUNCTION is non-zero, then
8391 the function is called with PROMPT as parameter and its return
8392 value is used as the return value of this function (after checking
8393 that it is indeed a vector). */
8396 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8397 Lisp_Object map
, key
, prompt
;
8402 next
= access_keymap (map
, key
, 1, 0, 1);
8404 /* Handle symbol with autoload definition. */
8405 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8406 && CONSP (XSYMBOL (next
)->function
)
8407 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8408 do_autoload (XSYMBOL (next
)->function
, next
);
8410 /* Handle a symbol whose function definition is a keymap
8412 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8413 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8414 || KEYMAPP (XSYMBOL (next
)->function
)))
8415 next
= XSYMBOL (next
)->function
;
8417 /* If the keymap gives a function, not an
8418 array, then call the function with one arg and use
8419 its value instead. */
8420 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8425 next
= call1 (next
, prompt
);
8426 /* If the function returned something invalid,
8427 barf--don't ignore it.
8428 (To ignore it safely, we would need to gcpro a bunch of
8429 other variables.) */
8430 if (! (VECTORP (next
) || STRINGP (next
)))
8431 error ("Function %s returns invalid key sequence", tem
);
8436 /* Do one step of the key remapping used for function-key-map and
8437 key-translation-map:
8438 KEYBUF is the buffer holding the input events.
8439 BUFSIZE is its maximum size.
8440 FKEY is a pointer to the keyremap structure to use.
8441 INPUT is the index of the last element in KEYBUF.
8442 DOIT if non-zero says that the remapping can actually take place.
8443 DIFF is used to return the number of keys added/removed by the remapping.
8444 PARENT is the root of the keymap.
8445 PROMPT is the prompt to use if the remapping happens through a function.
8446 The return value is non-zero if the remapping actually took place. */
8449 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8450 Lisp_Object
*keybuf
, prompt
;
8452 int input
, doit
, *diff
, bufsize
;
8454 Lisp_Object next
, key
;
8456 key
= keybuf
[fkey
->end
++];
8457 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8459 /* If keybuf[fkey->start..fkey->end] is bound in the
8460 map and we're in a position to do the key remapping, replace it with
8461 the binding and restart with fkey->start at the end. */
8462 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8464 int len
= XFASTINT (Flength (next
));
8467 *diff
= len
- (fkey
->end
- fkey
->start
);
8469 if (input
+ *diff
>= bufsize
)
8470 error ("Key sequence too long");
8472 /* Shift the keys that follow fkey->end. */
8474 for (i
= fkey
->end
; i
< input
; i
++)
8475 keybuf
[i
+ *diff
] = keybuf
[i
];
8477 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8478 keybuf
[i
+ *diff
] = keybuf
[i
];
8479 /* Overwrite the old keys with the new ones. */
8480 for (i
= 0; i
< len
; i
++)
8481 keybuf
[fkey
->start
+ i
]
8482 = Faref (next
, make_number (i
));
8484 fkey
->start
= fkey
->end
+= *diff
;
8485 fkey
->map
= fkey
->parent
;
8490 fkey
->map
= get_keymap (next
, 0, 1);
8492 /* If we no longer have a bound suffix, try a new position for
8494 if (!CONSP (fkey
->map
))
8496 fkey
->end
= ++fkey
->start
;
8497 fkey
->map
= fkey
->parent
;
8502 /* Read a sequence of keys that ends with a non prefix character,
8503 storing it in KEYBUF, a buffer of size BUFSIZE.
8505 Return the length of the key sequence stored.
8506 Return -1 if the user rejected a command menu.
8508 Echo starting immediately unless `prompt' is 0.
8510 Where a key sequence ends depends on the currently active keymaps.
8511 These include any minor mode keymaps active in the current buffer,
8512 the current buffer's local map, and the global map.
8514 If a key sequence has no other bindings, we check Vfunction_key_map
8515 to see if some trailing subsequence might be the beginning of a
8516 function key's sequence. If so, we try to read the whole function
8517 key, and substitute its symbolic name into the key sequence.
8519 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8520 `double-' events into similar click events, if that would make them
8521 bound. We try to turn `triple-' events first into `double-' events,
8524 If we get a mouse click in a mode line, vertical divider, or other
8525 non-text area, we treat the click as if it were prefixed by the
8526 symbol denoting that area - `mode-line', `vertical-line', or
8529 If the sequence starts with a mouse click, we read the key sequence
8530 with respect to the buffer clicked on, not the current buffer.
8532 If the user switches frames in the midst of a key sequence, we put
8533 off the switch-frame event until later; the next call to
8534 read_char will return it.
8536 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8537 from the selected window's buffer. */
8540 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8541 can_return_switch_frame
, fix_current_buffer
)
8542 Lisp_Object
*keybuf
;
8545 int dont_downcase_last
;
8546 int can_return_switch_frame
;
8547 int fix_current_buffer
;
8549 volatile Lisp_Object from_string
;
8550 volatile int count
= SPECPDL_INDEX ();
8552 /* How many keys there are in the current key sequence. */
8555 /* The length of the echo buffer when we started reading, and
8556 the length of this_command_keys when we started reading. */
8557 volatile int echo_start
;
8558 volatile int keys_start
;
8560 /* The number of keymaps we're scanning right now, and the number of
8561 keymaps we have allocated space for. */
8563 volatile int nmaps_allocated
= 0;
8565 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8566 the current keymaps. */
8567 Lisp_Object
*volatile defs
= NULL
;
8569 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8570 in the current keymaps, or nil where it is not a prefix. */
8571 Lisp_Object
*volatile submaps
= NULL
;
8573 /* The local map to start out with at start of key sequence. */
8574 volatile Lisp_Object orig_local_map
;
8576 /* The map from the `keymap' property to start out with at start of
8578 volatile Lisp_Object orig_keymap
;
8580 /* 1 if we have already considered switching to the local-map property
8581 of the place where a mouse click occurred. */
8582 volatile int localized_local_map
= 0;
8584 /* The index in defs[] of the first keymap that has a binding for
8585 this key sequence. In other words, the lowest i such that
8586 defs[i] is non-nil. */
8587 volatile int first_binding
;
8588 /* Index of the first key that has no binding.
8589 It is useless to try fkey.start larger than that. */
8590 volatile int first_unbound
;
8592 /* If t < mock_input, then KEYBUF[t] should be read as the next
8595 We use this to recover after recognizing a function key. Once we
8596 realize that a suffix of the current key sequence is actually a
8597 function key's escape sequence, we replace the suffix with the
8598 function key's binding from Vfunction_key_map. Now keybuf
8599 contains a new and different key sequence, so the echo area,
8600 this_command_keys, and the submaps and defs arrays are wrong. In
8601 this situation, we set mock_input to t, set t to 0, and jump to
8602 restart_sequence; the loop will read keys from keybuf up until
8603 mock_input, thus rebuilding the state; and then it will resume
8604 reading characters from the keyboard. */
8605 volatile int mock_input
= 0;
8607 /* If the sequence is unbound in submaps[], then
8608 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8609 and fkey.map is its binding.
8611 These might be > t, indicating that all function key scanning
8612 should hold off until t reaches them. We do this when we've just
8613 recognized a function key, to avoid searching for the function
8614 key's again in Vfunction_key_map. */
8615 volatile keyremap fkey
;
8617 /* Likewise, for key_translation_map. */
8618 volatile keyremap keytran
;
8620 /* If we receive a `switch-frame' or `select-window' event in the middle of
8621 a key sequence, we put it off for later.
8622 While we're reading, we keep the event here. */
8623 volatile Lisp_Object delayed_switch_frame
;
8625 /* See the comment below... */
8626 #if defined (GOBBLE_FIRST_EVENT)
8627 Lisp_Object first_event
;
8630 volatile Lisp_Object original_uppercase
;
8631 volatile int original_uppercase_position
= -1;
8633 /* Gets around Microsoft compiler limitations. */
8636 struct buffer
*starting_buffer
;
8638 /* List of events for which a fake prefix key has been generated. */
8639 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8641 #if defined (GOBBLE_FIRST_EVENT)
8645 struct gcpro gcpro1
;
8647 GCPRO1 (fake_prefixed_keys
);
8648 raw_keybuf_count
= 0;
8650 last_nonmenu_event
= Qnil
;
8652 delayed_switch_frame
= Qnil
;
8653 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8654 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8655 /* If there is no translation-map, turn off scanning. */
8656 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8657 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8662 echo_prompt (prompt
);
8663 else if (cursor_in_echo_area
8664 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8665 && NILP (Fzerop (Vecho_keystrokes
)))
8666 /* This doesn't put in a dash if the echo buffer is empty, so
8667 you don't always see a dash hanging out in the minibuffer. */
8671 /* Record the initial state of the echo area and this_command_keys;
8672 we will need to restore them if we replay a key sequence. */
8674 echo_start
= echo_length ();
8675 keys_start
= this_command_key_count
;
8676 this_single_command_key_start
= keys_start
;
8678 #if defined (GOBBLE_FIRST_EVENT)
8679 /* This doesn't quite work, because some of the things that read_char
8680 does cannot safely be bypassed. It seems too risky to try to make
8683 /* Read the first char of the sequence specially, before setting
8684 up any keymaps, in case a filter runs and switches buffers on us. */
8685 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8687 #endif /* GOBBLE_FIRST_EVENT */
8689 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8690 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8693 /* We jump here when the key sequence has been thoroughly changed, and
8694 we need to rescan it starting from the beginning. When we jump here,
8695 keybuf[0..mock_input] holds the sequence we should reread. */
8698 starting_buffer
= current_buffer
;
8699 first_unbound
= bufsize
+ 1;
8701 /* Build our list of keymaps.
8702 If we recognize a function key and replace its escape sequence in
8703 keybuf with its symbol, or if the sequence starts with a mouse
8704 click and we need to switch buffers, we jump back here to rebuild
8705 the initial keymaps from the current buffer. */
8708 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8709 || !NILP (Voverriding_local_map
))
8711 if (3 > nmaps_allocated
)
8713 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8714 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8715 nmaps_allocated
= 3;
8717 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8718 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8719 if (!NILP (Voverriding_local_map
))
8720 submaps
[nmaps
++] = Voverriding_local_map
;
8728 nminor
= current_minor_maps (0, &maps
);
8729 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8731 if (total
> nmaps_allocated
)
8733 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8734 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8735 nmaps_allocated
= total
;
8738 if (!NILP (orig_keymap
))
8739 submaps
[nmaps
++] = orig_keymap
;
8741 bcopy (maps
, (void *) (submaps
+ nmaps
),
8742 nminor
* sizeof (submaps
[0]));
8746 submaps
[nmaps
++] = orig_local_map
;
8748 submaps
[nmaps
++] = current_global_map
;
8750 /* Find an accurate initial value for first_binding. */
8751 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8752 if (! NILP (submaps
[first_binding
]))
8755 /* Start from the beginning in keybuf. */
8758 /* These are no-ops the first time through, but if we restart, they
8759 revert the echo area and this_command_keys to their original state. */
8760 this_command_key_count
= keys_start
;
8761 if (INTERACTIVE
&& t
< mock_input
)
8762 echo_truncate (echo_start
);
8764 /* If the best binding for the current key sequence is a keymap, or
8765 we may be looking at a function key's escape sequence, keep on
8767 while (first_binding
< nmaps
8768 /* Keep reading as long as there's a prefix binding. */
8769 ? !NILP (submaps
[first_binding
])
8770 /* Don't return in the middle of a possible function key sequence,
8771 if the only bindings we found were via case conversion.
8772 Thus, if ESC O a has a function-key-map translation
8773 and ESC o has a binding, don't return after ESC O,
8774 so that we can translate ESC O plus the next character. */
8775 : (fkey
.start
< t
|| keytran
.start
< t
))
8778 int used_mouse_menu
= 0;
8780 /* Where the last real key started. If we need to throw away a
8781 key that has expanded into more than one element of keybuf
8782 (say, a mouse click on the mode line which is being treated
8783 as [mode-line (mouse-...)], then we backtrack to this point
8785 volatile int last_real_key_start
;
8787 /* These variables are analogous to echo_start and keys_start;
8788 while those allow us to restart the entire key sequence,
8789 echo_local_start and keys_local_start allow us to throw away
8791 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8793 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8794 eassert (fkey
.start
<= fkey
.end
);
8795 eassert (keytran
.start
<= keytran
.end
);
8796 /* key-translation-map is applied *after* function-key-map. */
8797 eassert (keytran
.end
<= fkey
.start
);
8799 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8800 { /* The prefix upto first_unbound has no binding and has
8801 no translation left to do either, so we know it's unbound.
8802 If we don't stop now, we risk staying here indefinitely
8803 (if the user keeps entering fkey or keytran prefixes
8804 like C-c ESC ESC ESC ESC ...) */
8806 for (i
= first_unbound
+ 1; i
< t
; i
++)
8807 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8808 mock_input
= t
- first_unbound
- 1;
8809 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8810 fkey
.map
= fkey
.parent
;
8811 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8812 keytran
.map
= keytran
.parent
;
8813 goto replay_sequence
;
8817 error ("Key sequence too long");
8820 echo_local_start
= echo_length ();
8821 keys_local_start
= this_command_key_count
;
8822 local_first_binding
= first_binding
;
8825 /* These are no-ops, unless we throw away a keystroke below and
8826 jumped back up to replay_key; in that case, these restore the
8827 variables to their original state, allowing us to replay the
8829 if (INTERACTIVE
&& t
< mock_input
)
8830 echo_truncate (echo_local_start
);
8831 this_command_key_count
= keys_local_start
;
8832 first_binding
= local_first_binding
;
8834 /* By default, assume each event is "real". */
8835 last_real_key_start
= t
;
8837 /* Does mock_input indicate that we are re-reading a key sequence? */
8841 add_command_key (key
);
8842 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8843 && NILP (Fzerop (Vecho_keystrokes
)))
8847 /* If not, we should actually read a character. */
8852 KBOARD
*interrupted_kboard
= current_kboard
;
8853 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8854 if (setjmp (wrong_kboard_jmpbuf
))
8856 if (!NILP (delayed_switch_frame
))
8858 interrupted_kboard
->kbd_queue
8859 = Fcons (delayed_switch_frame
,
8860 interrupted_kboard
->kbd_queue
);
8861 delayed_switch_frame
= Qnil
;
8864 interrupted_kboard
->kbd_queue
8865 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8867 /* If the side queue is non-empty, ensure it begins with a
8868 switch-frame, so we'll replay it in the right context. */
8869 if (CONSP (interrupted_kboard
->kbd_queue
)
8870 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8871 !(EVENT_HAS_PARAMETERS (key
)
8872 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8876 XSETFRAME (frame
, interrupted_frame
);
8877 interrupted_kboard
->kbd_queue
8878 = Fcons (make_lispy_switch_frame (frame
),
8879 interrupted_kboard
->kbd_queue
);
8882 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8883 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8884 goto replay_sequence
;
8887 key
= read_char (NILP (prompt
), nmaps
,
8888 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8892 /* read_char returns t when it shows a menu and the user rejects it.
8896 unbind_to (count
, Qnil
);
8901 /* read_char returns -1 at the end of a macro.
8902 Emacs 18 handles this by returning immediately with a
8903 zero, so that's what we'll do. */
8904 if (INTEGERP (key
) && XINT (key
) == -1)
8907 /* The Microsoft C compiler can't handle the goto that
8913 /* If the current buffer has been changed from under us, the
8914 keymap may have changed, so replay the sequence. */
8917 timer_resume_idle ();
8920 /* Reset the current buffer from the selected window
8921 in case something changed the former and not the latter.
8922 This is to be more consistent with the behavior
8923 of the command_loop_1. */
8924 if (fix_current_buffer
)
8926 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8928 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8929 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8932 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8933 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8934 goto replay_sequence
;
8937 /* If we have a quit that was typed in another frame, and
8938 quit_throw_to_read_char switched buffers,
8939 replay to get the right keymap. */
8941 && XINT (key
) == quit_char
8942 && current_buffer
!= starting_buffer
)
8945 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8949 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8950 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8951 goto replay_sequence
;
8956 if (EVENT_HAS_PARAMETERS (key
)
8957 /* Either a `switch-frame' or a `select-window' event. */
8958 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8960 /* If we're at the beginning of a key sequence, and the caller
8961 says it's okay, go ahead and return this event. If we're
8962 in the midst of a key sequence, delay it until the end. */
8963 if (t
> 0 || !can_return_switch_frame
)
8965 delayed_switch_frame
= key
;
8971 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8974 /* Clicks in non-text areas get prefixed by the symbol
8975 in their CHAR-ADDRESS field. For example, a click on
8976 the mode line is prefixed by the symbol `mode-line'.
8978 Furthermore, key sequences beginning with mouse clicks
8979 are read using the keymaps of the buffer clicked on, not
8980 the current buffer. So we may have to switch the buffer
8983 When we turn one event into two events, we must make sure
8984 that neither of the two looks like the original--so that,
8985 if we replay the events, they won't be expanded again.
8986 If not for this, such reexpansion could happen either here
8987 or when user programs play with this-command-keys. */
8988 if (EVENT_HAS_PARAMETERS (key
))
8993 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8994 if (EQ (kind
, Qmouse_click
))
8996 Lisp_Object window
, posn
;
8998 window
= POSN_WINDOW (EVENT_START (key
));
8999 posn
= POSN_POSN (EVENT_START (key
));
9002 || (!NILP (fake_prefixed_keys
)
9003 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9005 /* We're looking a second time at an event for which
9006 we generated a fake prefix key. Set
9007 last_real_key_start appropriately. */
9009 last_real_key_start
= t
- 1;
9012 /* Key sequences beginning with mouse clicks are
9013 read using the keymaps in the buffer clicked on,
9014 not the current buffer. If we're at the
9015 beginning of a key sequence, switch buffers. */
9016 if (last_real_key_start
== 0
9018 && BUFFERP (XWINDOW (window
)->buffer
)
9019 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9021 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9025 /* Arrange to go back to the original buffer once we're
9026 done reading the key sequence. Note that we can't
9027 use save_excursion_{save,restore} here, because they
9028 save point as well as the current buffer; we don't
9029 want to save point, because redisplay may change it,
9030 to accommodate a Fset_window_start or something. We
9031 don't want to do this at the top of the function,
9032 because we may get input from a subprocess which
9033 wants to change the selected window and stuff (say,
9035 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9037 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9039 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9040 orig_local_map
= get_local_map (PT
, current_buffer
,
9042 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9043 goto replay_sequence
;
9046 /* For a mouse click, get the local text-property keymap
9047 of the place clicked on, rather than point. */
9048 if (last_real_key_start
== 0
9049 && CONSP (XCDR (key
))
9050 && ! localized_local_map
)
9052 Lisp_Object map_here
, start
, pos
;
9054 localized_local_map
= 1;
9055 start
= EVENT_START (key
);
9057 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9059 pos
= POSN_BUFFER_POSN (start
);
9061 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9063 map_here
= get_local_map (XINT (pos
),
9064 current_buffer
, Qlocal_map
);
9065 if (!EQ (map_here
, orig_local_map
))
9067 orig_local_map
= map_here
;
9071 goto replay_sequence
;
9073 map_here
= get_local_map (XINT (pos
),
9074 current_buffer
, Qkeymap
);
9075 if (!EQ (map_here
, orig_keymap
))
9077 orig_keymap
= map_here
;
9081 goto replay_sequence
;
9087 /* Expand mode-line and scroll-bar events into two events:
9088 use posn as a fake prefix key. */
9090 && (NILP (fake_prefixed_keys
)
9091 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9093 if (t
+ 1 >= bufsize
)
9094 error ("Key sequence too long");
9097 keybuf
[t
+ 1] = key
;
9100 /* Record that a fake prefix key has been generated
9101 for KEY. Don't modify the event; this would
9102 prevent proper action when the event is pushed
9103 back into unread-command-events. */
9104 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9106 /* If on a mode line string with a local keymap,
9107 reconsider the key sequence with that keymap. */
9108 if (string
= POSN_STRING (EVENT_START (key
)),
9109 (CONSP (string
) && STRINGP (XCAR (string
))))
9111 Lisp_Object pos
, map
, map2
;
9113 pos
= XCDR (string
);
9114 string
= XCAR (string
);
9116 && XINT (pos
) < SCHARS (string
))
9118 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9120 orig_local_map
= map
;
9121 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9124 if (!NILP (map
) || !NILP (map2
))
9125 goto replay_sequence
;
9131 else if (NILP (from_string
)
9132 && (string
= POSN_STRING (EVENT_START (key
)),
9133 (CONSP (string
) && STRINGP (XCAR (string
)))))
9135 /* For a click on a string, i.e. overlay string or a
9136 string displayed via the `display' property,
9137 consider `local-map' and `keymap' properties of
9139 Lisp_Object pos
, map
, map2
;
9141 pos
= XCDR (string
);
9142 string
= XCAR (string
);
9144 && XINT (pos
) < SCHARS (string
))
9146 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9148 orig_local_map
= map
;
9149 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9153 if (!NILP (map
) || !NILP (map2
))
9155 from_string
= string
;
9156 goto replay_sequence
;
9161 else if (CONSP (XCDR (key
))
9162 && CONSP (EVENT_START (key
))
9163 && CONSP (XCDR (EVENT_START (key
))))
9167 posn
= POSN_POSN (EVENT_START (key
));
9168 /* Handle menu-bar events:
9169 insert the dummy prefix event `menu-bar'. */
9170 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9172 if (t
+ 1 >= bufsize
)
9173 error ("Key sequence too long");
9177 /* Zap the position in key, so we know that we've
9178 expanded it, and don't try to do so again. */
9179 POSN_SET_POSN (EVENT_START (key
),
9180 Fcons (posn
, Qnil
));
9183 goto replay_sequence
;
9185 else if (CONSP (posn
))
9187 /* We're looking at the second event of a
9188 sequence which we expanded before. Set
9189 last_real_key_start appropriately. */
9190 if (last_real_key_start
== t
&& t
> 0)
9191 last_real_key_start
= t
- 1;
9196 /* We have finally decided that KEY is something we might want
9198 first_binding
= (follow_key (key
,
9199 nmaps
- first_binding
,
9200 submaps
+ first_binding
,
9201 defs
+ first_binding
,
9202 submaps
+ first_binding
)
9205 /* If KEY wasn't bound, we'll try some fallbacks. */
9206 if (first_binding
< nmaps
)
9207 /* This is needed for the following scenario:
9208 event 0: a down-event that gets dropped by calling replay_key.
9209 event 1: some normal prefix like C-h.
9210 After event 0, first_unbound is 0, after event 1 fkey.start
9211 and keytran.start are both 1, so when we see that C-h is bound,
9212 we need to update first_unbound. */
9213 first_unbound
= max (t
+ 1, first_unbound
);
9218 /* Remember the position to put an upper bound on fkey.start. */
9219 first_unbound
= min (t
, first_unbound
);
9221 head
= EVENT_HEAD (key
);
9222 if (help_char_p (head
) && t
> 0)
9224 read_key_sequence_cmd
= Vprefix_help_command
;
9226 last_nonmenu_event
= key
;
9227 /* The Microsoft C compiler can't handle the goto that
9235 Lisp_Object breakdown
;
9238 breakdown
= parse_modifiers (head
);
9239 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9240 /* Attempt to reduce an unbound mouse event to a simpler
9241 event that is bound:
9242 Drags reduce to clicks.
9243 Double-clicks reduce to clicks.
9244 Triple-clicks reduce to double-clicks, then to clicks.
9245 Down-clicks are eliminated.
9246 Double-downs reduce to downs, then are eliminated.
9247 Triple-downs reduce to double-downs, then to downs,
9248 then are eliminated. */
9249 if (modifiers
& (down_modifier
| drag_modifier
9250 | double_modifier
| triple_modifier
))
9252 while (modifiers
& (down_modifier
| drag_modifier
9253 | double_modifier
| triple_modifier
))
9255 Lisp_Object new_head
, new_click
;
9256 if (modifiers
& triple_modifier
)
9257 modifiers
^= (double_modifier
| triple_modifier
);
9258 else if (modifiers
& double_modifier
)
9259 modifiers
&= ~double_modifier
;
9260 else if (modifiers
& drag_modifier
)
9261 modifiers
&= ~drag_modifier
;
9264 /* Dispose of this `down' event by simply jumping
9265 back to replay_key, to get another event.
9267 Note that if this event came from mock input,
9268 then just jumping back to replay_key will just
9269 hand it to us again. So we have to wipe out any
9272 We could delete keybuf[t] and shift everything
9273 after that to the left by one spot, but we'd also
9274 have to fix up any variable that points into
9275 keybuf, and shifting isn't really necessary
9278 Adding prefixes for non-textual mouse clicks
9279 creates two characters of mock input, and both
9280 must be thrown away. If we're only looking at
9281 the prefix now, we can just jump back to
9282 replay_key. On the other hand, if we've already
9283 processed the prefix, and now the actual click
9284 itself is giving us trouble, then we've lost the
9285 state of the keymaps we want to backtrack to, and
9286 we need to replay the whole sequence to rebuild
9289 Beyond that, only function key expansion could
9290 create more than two keys, but that should never
9291 generate mouse events, so it's okay to zero
9292 mock_input in that case too.
9294 FIXME: The above paragraph seems just plain
9295 wrong, if you consider things like
9296 xterm-mouse-mode. -stef
9298 Isn't this just the most wonderful code ever? */
9300 /* If mock_input > t + 1, the above simplification
9301 will actually end up dropping keys on the floor.
9302 This is probably OK for now, but even
9303 if mock_input <= t + 1, we need to adjust fkey
9305 Typical case [header-line down-mouse-N]:
9306 mock_input = 2, t = 1, fkey.end = 1,
9307 last_real_key_start = 0. */
9308 if (fkey
.end
> last_real_key_start
)
9310 fkey
.end
= fkey
.start
9311 = min (last_real_key_start
, fkey
.start
);
9312 fkey
.map
= fkey
.parent
;
9313 if (keytran
.end
> last_real_key_start
)
9315 keytran
.end
= keytran
.start
9316 = min (last_real_key_start
, keytran
.start
);
9317 keytran
.map
= keytran
.parent
;
9320 if (t
== last_real_key_start
)
9327 mock_input
= last_real_key_start
;
9328 goto replay_sequence
;
9333 = apply_modifiers (modifiers
, XCAR (breakdown
));
9335 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9337 /* Look for a binding for this new key. follow_key
9338 promises that it didn't munge submaps the
9339 last time we called it, since key was unbound. */
9341 = (follow_key (new_click
,
9342 nmaps
- local_first_binding
,
9343 submaps
+ local_first_binding
,
9344 defs
+ local_first_binding
,
9345 submaps
+ local_first_binding
)
9346 + local_first_binding
);
9348 /* If that click is bound, go for it. */
9349 if (first_binding
< nmaps
)
9354 /* Otherwise, we'll leave key set to the drag event. */
9361 /* Normally, last_nonmenu_event gets the previous key we read.
9362 But when a mouse popup menu is being used,
9363 we don't update last_nonmenu_event; it continues to hold the mouse
9364 event that preceded the first level of menu. */
9365 if (!used_mouse_menu
)
9366 last_nonmenu_event
= key
;
9368 /* Record what part of this_command_keys is the current key sequence. */
9369 this_single_command_key_start
= this_command_key_count
- t
;
9371 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9372 /* There is a binding and it's not a prefix.
9373 There is thus no function-key in this sequence.
9374 Moving fkey.start is important in this case to allow keytran.start
9375 to go over the sequence before we return (since we keep the
9376 invariant that keytran.end <= fkey.start). */
9379 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9382 /* If the sequence is unbound, see if we can hang a function key
9383 off the end of it. */
9384 /* Continue scan from fkey.end until we find a bound suffix. */
9385 while (fkey
.end
< t
)
9387 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9390 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9391 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9392 max (t
, mock_input
),
9393 /* If there's a binding (i.e.
9394 first_binding >= nmaps) we don't want
9395 to apply this function-key-mapping. */
9396 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9401 mock_input
= diff
+ max (t
, mock_input
);
9402 goto replay_sequence
;
9406 /* Look for this sequence in key-translation-map.
9407 Scan from keytran.end until we find a bound suffix. */
9408 while (keytran
.end
< fkey
.start
)
9410 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9413 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9414 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9419 mock_input
= diff
+ max (t
, mock_input
);
9420 /* Adjust the function-key-map counters. */
9424 goto replay_sequence
;
9428 /* If KEY is not defined in any of the keymaps,
9429 and cannot be part of a function key or translation,
9430 and is an upper case letter
9431 use the corresponding lower-case letter instead. */
9432 if (first_binding
>= nmaps
9433 && fkey
.start
>= t
&& keytran
.start
>= t
9435 && ((((XINT (key
) & 0x3ffff)
9436 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9437 && UPPERCASEP (XINT (key
) & 0x3ffff))
9438 || (XINT (key
) & shift_modifier
)))
9440 Lisp_Object new_key
;
9442 original_uppercase
= key
;
9443 original_uppercase_position
= t
- 1;
9445 if (XINT (key
) & shift_modifier
)
9446 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9448 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9449 | (XINT (key
) & ~0x3ffff)));
9451 /* We have to do this unconditionally, regardless of whether
9452 the lower-case char is defined in the keymaps, because they
9453 might get translated through function-key-map. */
9454 keybuf
[t
- 1] = new_key
;
9455 mock_input
= max (t
, mock_input
);
9457 goto replay_sequence
;
9459 /* If KEY is not defined in any of the keymaps,
9460 and cannot be part of a function key or translation,
9461 and is a shifted function key,
9462 use the corresponding unshifted function key instead. */
9463 if (first_binding
>= nmaps
9464 && fkey
.start
>= t
&& keytran
.start
>= t
9467 Lisp_Object breakdown
;
9470 breakdown
= parse_modifiers (key
);
9471 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9472 if (modifiers
& shift_modifier
)
9474 Lisp_Object new_key
;
9476 original_uppercase
= key
;
9477 original_uppercase_position
= t
- 1;
9479 modifiers
&= ~shift_modifier
;
9480 new_key
= apply_modifiers (modifiers
,
9483 keybuf
[t
- 1] = new_key
;
9484 mock_input
= max (t
, mock_input
);
9485 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9486 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9488 goto replay_sequence
;
9494 read_key_sequence_cmd
= (first_binding
< nmaps
9495 ? defs
[first_binding
]
9498 unread_switch_frame
= delayed_switch_frame
;
9499 unbind_to (count
, Qnil
);
9501 /* Don't downcase the last character if the caller says don't.
9502 Don't downcase it if the result is undefined, either. */
9503 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9504 && t
- 1 == original_uppercase_position
)
9505 keybuf
[t
- 1] = original_uppercase
;
9507 /* Occasionally we fabricate events, perhaps by expanding something
9508 according to function-key-map, or by adding a prefix symbol to a
9509 mouse click in the scroll bar or modeline. In this cases, return
9510 the entire generated key sequence, even if we hit an unbound
9511 prefix or a definition before the end. This means that you will
9512 be able to push back the event properly, and also means that
9513 read-key-sequence will always return a logical unit.
9516 for (; t
< mock_input
; t
++)
9518 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9519 && NILP (Fzerop (Vecho_keystrokes
)))
9520 echo_char (keybuf
[t
]);
9521 add_command_key (keybuf
[t
]);
9530 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9531 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9532 The sequence is sufficient to specify a non-prefix command in the
9533 current local and global maps.
9535 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9536 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9537 as a continuation of the previous key.
9539 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9540 convert the last event to lower case. (Normally any upper case event
9541 is converted to lower case if the original event is undefined and the lower
9542 case equivalent is defined.) A non-nil value is appropriate for reading
9543 a key sequence to be defined.
9545 A C-g typed while in this function is treated like any other character,
9546 and `quit-flag' is not set.
9548 If the key sequence starts with a mouse click, then the sequence is read
9549 using the keymaps of the buffer of the window clicked in, not the buffer
9550 of the selected window as normal.
9552 `read-key-sequence' drops unbound button-down events, since you normally
9553 only care about the click or drag events which follow them. If a drag
9554 or multi-click event is unbound, but the corresponding click event would
9555 be bound, `read-key-sequence' turns the event into a click event at the
9556 drag's starting position. This means that you don't have to distinguish
9557 between click and drag, double, or triple events unless you want to.
9559 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9560 lines separating windows, and scroll bars with imaginary keys
9561 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9563 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9564 function will process a switch-frame event if the user switches frames
9565 before typing anything. If the user switches frames in the middle of a
9566 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9567 is nil, then the event will be put off until after the current key sequence.
9569 `read-key-sequence' checks `function-key-map' for function key
9570 sequences, where they wouldn't conflict with ordinary bindings. See
9571 `function-key-map' for more details.
9573 The optional fifth argument COMMAND-LOOP, if non-nil, means
9574 that this key sequence is being read by something that will
9575 read commands one after another. It should be nil if the caller
9576 will read just one key sequence. */)
9577 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9579 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9580 Lisp_Object can_return_switch_frame
, command_loop
;
9582 Lisp_Object keybuf
[30];
9584 struct gcpro gcpro1
;
9585 int count
= SPECPDL_INDEX ();
9588 CHECK_STRING (prompt
);
9591 specbind (Qinput_method_exit_on_first_char
,
9592 (NILP (command_loop
) ? Qt
: Qnil
));
9593 specbind (Qinput_method_use_echo_area
,
9594 (NILP (command_loop
) ? Qt
: Qnil
));
9596 bzero (keybuf
, sizeof keybuf
);
9598 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9600 if (NILP (continue_echo
))
9602 this_command_key_count
= 0;
9603 this_command_key_count_reset
= 0;
9604 this_single_command_key_start
= 0;
9607 #ifdef HAVE_X_WINDOWS
9608 if (display_hourglass_p
)
9609 cancel_hourglass ();
9612 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9613 prompt
, ! NILP (dont_downcase_last
),
9614 ! NILP (can_return_switch_frame
), 0);
9616 #if 0 /* The following is fine for code reading a key sequence and
9617 then proceeding with a lenghty computation, but it's not good
9618 for code reading keys in a loop, like an input method. */
9619 #ifdef HAVE_X_WINDOWS
9620 if (display_hourglass_p
)
9631 return unbind_to (count
, make_event_array (i
, keybuf
));
9634 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9635 Sread_key_sequence_vector
, 1, 5, 0,
9636 doc
: /* Like `read-key-sequence' but always return a vector. */)
9637 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9639 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9640 Lisp_Object can_return_switch_frame
, command_loop
;
9642 Lisp_Object keybuf
[30];
9644 struct gcpro gcpro1
;
9645 int count
= SPECPDL_INDEX ();
9648 CHECK_STRING (prompt
);
9651 specbind (Qinput_method_exit_on_first_char
,
9652 (NILP (command_loop
) ? Qt
: Qnil
));
9653 specbind (Qinput_method_use_echo_area
,
9654 (NILP (command_loop
) ? Qt
: Qnil
));
9656 bzero (keybuf
, sizeof keybuf
);
9658 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9660 if (NILP (continue_echo
))
9662 this_command_key_count
= 0;
9663 this_command_key_count_reset
= 0;
9664 this_single_command_key_start
= 0;
9667 #ifdef HAVE_X_WINDOWS
9668 if (display_hourglass_p
)
9669 cancel_hourglass ();
9672 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9673 prompt
, ! NILP (dont_downcase_last
),
9674 ! NILP (can_return_switch_frame
), 0);
9676 #ifdef HAVE_X_WINDOWS
9677 if (display_hourglass_p
)
9687 return unbind_to (count
, Fvector (i
, keybuf
));
9690 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9691 doc
: /* Execute CMD as an editor command.
9692 CMD must be a symbol that satisfies the `commandp' predicate.
9693 Optional second arg RECORD-FLAG non-nil
9694 means unconditionally put this command in `command-history'.
9695 Otherwise, that is done only if an arg is read using the minibuffer.
9696 The argument KEYS specifies the value to use instead of (this-command-keys)
9697 when reading the arguments; if it is nil, (this-command-keys) is used.
9698 The argument SPECIAL, if non-nil, means that this command is executing
9699 a special event, so ignore the prefix argument and don't clear it. */)
9700 (cmd
, record_flag
, keys
, special
)
9701 Lisp_Object cmd
, record_flag
, keys
, special
;
9703 register Lisp_Object final
;
9704 register Lisp_Object tem
;
9705 Lisp_Object prefixarg
;
9706 struct backtrace backtrace
;
9707 extern int debug_on_next_call
;
9709 debug_on_next_call
= 0;
9713 prefixarg
= current_kboard
->Vprefix_arg
;
9714 Vcurrent_prefix_arg
= prefixarg
;
9715 current_kboard
->Vprefix_arg
= Qnil
;
9722 tem
= Fget (cmd
, Qdisabled
);
9723 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9725 tem
= Fsymbol_value (Qdisabled_command_function
);
9727 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9733 final
= Findirect_function (cmd
);
9735 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9737 struct gcpro gcpro1
, gcpro2
;
9739 GCPRO2 (cmd
, prefixarg
);
9740 do_autoload (final
, cmd
);
9747 if (STRINGP (final
) || VECTORP (final
))
9749 /* If requested, place the macro in the command history. For
9750 other sorts of commands, call-interactively takes care of
9752 if (!NILP (record_flag
))
9755 = Fcons (Fcons (Qexecute_kbd_macro
,
9756 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9759 /* Don't keep command history around forever. */
9760 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9762 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9764 XSETCDR (tem
, Qnil
);
9768 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9771 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9773 backtrace
.next
= backtrace_list
;
9774 backtrace_list
= &backtrace
;
9775 backtrace
.function
= &Qcall_interactively
;
9776 backtrace
.args
= &cmd
;
9777 backtrace
.nargs
= 1;
9778 backtrace
.evalargs
= 0;
9779 backtrace
.debug_on_exit
= 0;
9781 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9783 backtrace_list
= backtrace
.next
;
9791 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9793 doc
: /* Read function name, then read its arguments and call it. */)
9795 Lisp_Object prefixarg
;
9797 Lisp_Object function
;
9799 int saved_last_point_position
;
9800 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9801 Lisp_Object bindings
, value
;
9802 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9803 #ifdef HAVE_X_WINDOWS
9804 /* The call to Fcompleting_read wil start and cancel the hourglass,
9805 but if the hourglass was already scheduled, this means that no
9806 hourglass will be shown for the actual M-x command itself.
9807 So we restart it if it is already scheduled. Note that checking
9808 hourglass_shown_p is not enough, normally the hourglass is not shown,
9809 just scheduled to be shown. */
9810 int hstarted
= hourglass_started ();
9813 saved_keys
= Fvector (this_command_key_count
,
9814 XVECTOR (this_command_keys
)->contents
);
9815 saved_last_point_position_buffer
= last_point_position_buffer
;
9816 saved_last_point_position
= last_point_position
;
9818 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9820 if (EQ (prefixarg
, Qminus
))
9822 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9823 strcpy (buf
, "C-u ");
9824 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9825 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9826 else if (INTEGERP (prefixarg
))
9827 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9829 /* This isn't strictly correct if execute-extended-command
9830 is bound to anything else. Perhaps it should use
9831 this_command_keys? */
9832 strcat (buf
, "M-x ");
9834 /* Prompt with buf, and then read a string, completing from and
9835 restricting to the set of all defined commands. Don't provide
9836 any initial input. Save the command read on the extended-command
9838 function
= Fcompleting_read (build_string (buf
),
9839 Vobarray
, Qcommandp
,
9840 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9843 #ifdef HAVE_X_WINDOWS
9844 if (hstarted
) start_hourglass ();
9847 if (STRINGP (function
) && SCHARS (function
) == 0)
9848 error ("No command name given");
9850 /* Set this_command_keys to the concatenation of saved_keys and
9851 function, followed by a RET. */
9856 this_command_key_count
= 0;
9857 this_command_key_count_reset
= 0;
9858 this_single_command_key_start
= 0;
9860 keys
= XVECTOR (saved_keys
)->contents
;
9861 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9862 add_command_key (keys
[i
]);
9864 for (i
= 0; i
< SCHARS (function
); i
++)
9865 add_command_key (Faref (function
, make_number (i
)));
9867 add_command_key (make_number ('\015'));
9870 last_point_position
= saved_last_point_position
;
9871 last_point_position_buffer
= saved_last_point_position_buffer
;
9875 function
= Fintern (function
, Qnil
);
9876 current_kboard
->Vprefix_arg
= prefixarg
;
9877 Vthis_command
= function
;
9878 real_this_command
= function
;
9880 /* If enabled, show which key runs this command. */
9881 if (!NILP (Vsuggest_key_bindings
)
9882 && NILP (Vexecuting_kbd_macro
)
9883 && SYMBOLP (function
))
9884 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9890 GCPRO2 (bindings
, value
);
9891 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9893 /* If the command has a key binding, print it now. */
9894 if (!NILP (bindings
)
9895 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9898 /* But first wait, and skip the message if there is input. */
9900 if (!NILP (echo_area_buffer
[0]))
9901 /* This command displayed something in the echo area;
9902 so wait a few seconds, then display our suggestion message. */
9903 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9904 ? XINT (Vsuggest_key_bindings
) : 2);
9906 /* This command left the echo area empty,
9907 so display our message immediately. */
9910 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9911 && ! CONSP (Vunread_command_events
))
9913 Lisp_Object binding
;
9915 int message_p
= push_message ();
9916 int count
= SPECPDL_INDEX ();
9918 record_unwind_protect (pop_message_unwind
, Qnil
);
9919 binding
= Fkey_description (bindings
, Qnil
);
9922 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9925 sprintf (newmessage
, "You can run the command `%s' with %s",
9926 SDATA (SYMBOL_NAME (function
)),
9928 message2_nolog (newmessage
,
9929 strlen (newmessage
),
9930 STRING_MULTIBYTE (binding
));
9931 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9932 ? Vsuggest_key_bindings
: make_number (2)),
9937 unbind_to (count
, Qnil
);
9941 RETURN_UNGCPRO (value
);
9945 /* Return nonzero if input events are pending. */
9948 detect_input_pending ()
9951 get_input_pending (&input_pending
, 0);
9953 return input_pending
;
9956 /* Return nonzero if input events other than mouse movements are
9960 detect_input_pending_ignore_squeezables ()
9963 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9965 return input_pending
;
9968 /* Return nonzero if input events are pending, and run any pending timers. */
9971 detect_input_pending_run_timers (do_display
)
9974 int old_timers_run
= timers_run
;
9977 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
9979 if (old_timers_run
!= timers_run
&& do_display
)
9981 redisplay_preserve_echo_area (8);
9982 /* The following fixes a bug when using lazy-lock with
9983 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9984 from an idle timer function. The symptom of the bug is that
9985 the cursor sometimes doesn't become visible until the next X
9986 event is processed. --gerd. */
9988 Lisp_Object tail
, frame
;
9989 FOR_EACH_FRAME (tail
, frame
)
9990 if (FRAME_RIF (XFRAME (frame
)))
9991 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
9995 return input_pending
;
9998 /* This is called in some cases before a possible quit.
9999 It cases the next call to detect_input_pending to recompute input_pending.
10000 So calling this function unnecessarily can't do any harm. */
10003 clear_input_pending ()
10008 /* Return nonzero if there are pending requeued events.
10009 This isn't used yet. The hope is to make wait_reading_process_output
10010 call it, and return if it runs Lisp code that unreads something.
10011 The problem is, kbd_buffer_get_event needs to be fixed to know what
10012 to do in that case. It isn't trivial. */
10015 requeued_events_pending_p ()
10017 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10021 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10022 doc
: /* Return t if command input is currently available with no wait.
10023 Actually, the value is nil only if we can be sure that no input is available;
10024 if there is a doubt, the value is t. */)
10027 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
10030 get_input_pending (&input_pending
,
10031 READABLE_EVENTS_DO_TIMERS_NOW
10032 | READABLE_EVENTS_FILTER_EVENTS
);
10033 return input_pending
> 0 ? Qt
: Qnil
;
10036 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10037 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10040 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10043 if (total_keys
< NUM_RECENT_KEYS
)
10044 return Fvector (total_keys
, keys
);
10047 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10048 bcopy (keys
+ recent_keys_index
,
10049 XVECTOR (val
)->contents
,
10050 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10052 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10053 recent_keys_index
* sizeof (Lisp_Object
));
10058 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10059 doc
: /* Return the key sequence that invoked this command.
10060 However, if the command has called `read-key-sequence', it returns
10061 the last key sequence that has been read.
10062 The value is a string or a vector. */)
10065 return make_event_array (this_command_key_count
,
10066 XVECTOR (this_command_keys
)->contents
);
10069 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10070 doc
: /* Return the key sequence that invoked this command, as a vector.
10071 However, if the command has called `read-key-sequence', it returns
10072 the last key sequence that has been read. */)
10075 return Fvector (this_command_key_count
,
10076 XVECTOR (this_command_keys
)->contents
);
10079 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10080 Sthis_single_command_keys
, 0, 0, 0,
10081 doc
: /* Return the key sequence that invoked this command.
10082 More generally, it returns the last key sequence read, either by
10083 the command loop or by `read-key-sequence'.
10084 Unlike `this-command-keys', this function's value
10085 does not include prefix arguments.
10086 The value is always a vector. */)
10089 return Fvector (this_command_key_count
10090 - this_single_command_key_start
,
10091 (XVECTOR (this_command_keys
)->contents
10092 + this_single_command_key_start
));
10095 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10096 Sthis_single_command_raw_keys
, 0, 0, 0,
10097 doc
: /* Return the raw events that were read for this command.
10098 More generally, it returns the last key sequence read, either by
10099 the command loop or by `read-key-sequence'.
10100 Unlike `this-single-command-keys', this function's value
10101 shows the events before all translations (except for input methods).
10102 The value is always a vector. */)
10105 return Fvector (raw_keybuf_count
,
10106 (XVECTOR (raw_keybuf
)->contents
));
10109 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10110 Sreset_this_command_lengths
, 0, 0, 0,
10111 doc
: /* Make the unread events replace the last command and echo.
10112 Used in `universal-argument-other-key'.
10114 `universal-argument-other-key' rereads the event just typed.
10115 It then gets translated through `function-key-map'.
10116 The translated event has to replace the real events,
10117 both in the value of (this-command-keys) and in echoing.
10118 To achieve this, `universal-argument-other-key' calls
10119 `reset-this-command-lengths', which discards the record of reading
10120 these events the first time. */)
10123 this_command_key_count
= before_command_key_count
;
10124 if (this_command_key_count
< this_single_command_key_start
)
10125 this_single_command_key_start
= this_command_key_count
;
10127 echo_truncate (before_command_echo_length
);
10129 /* Cause whatever we put into unread-command-events
10130 to echo as if it were being freshly read from the keyboard. */
10131 this_command_key_count_reset
= 1;
10136 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10137 Sclear_this_command_keys
, 0, 1, 0,
10138 doc
: /* Clear out the vector that `this-command-keys' returns.
10139 Also clear the record of the last 100 events, unless optional arg
10140 KEEP-RECORD is non-nil. */)
10142 Lisp_Object keep_record
;
10146 this_command_key_count
= 0;
10147 this_command_key_count_reset
= 0;
10149 if (NILP (keep_record
))
10151 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10152 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10154 recent_keys_index
= 0;
10159 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10160 doc
: /* Return the current depth in recursive edits. */)
10164 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10168 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10169 "FOpen dribble file: ",
10170 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10171 If FILE is nil, close any open dribble file. */)
10182 file
= Fexpand_file_name (file
, Qnil
);
10183 dribble
= fopen (SDATA (file
), "w");
10185 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10190 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10191 doc
: /* Discard the contents of the terminal input buffer.
10192 Also end any kbd macro being defined. */)
10195 if (!NILP (current_kboard
->defining_kbd_macro
))
10197 /* Discard the last command from the macro. */
10198 Fcancel_kbd_macro_events ();
10202 update_mode_lines
++;
10204 Vunread_command_events
= Qnil
;
10205 unread_command_char
= -1;
10207 discard_tty_input ();
10209 kbd_fetch_ptr
= kbd_store_ptr
;
10215 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10216 doc
: /* Stop Emacs and return to superior process. You can resume later.
10217 If `cannot-suspend' is non-nil, or if the system doesn't support job
10218 control, run a subshell instead.
10220 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10221 to be read as terminal input by Emacs's parent, after suspension.
10223 Before suspending, run the normal hook `suspend-hook'.
10224 After resumption run the normal hook `suspend-resume-hook'.
10226 Some operating systems cannot stop the Emacs process and resume it later.
10227 On such systems, Emacs starts a subshell instead of suspending. */)
10229 Lisp_Object stuffstring
;
10231 int count
= SPECPDL_INDEX ();
10232 int old_height
, old_width
;
10234 struct gcpro gcpro1
;
10236 if (tty_list
&& tty_list
->next
)
10237 error ("There are other tty frames open; close them before suspending Emacs");
10239 if (!NILP (stuffstring
))
10240 CHECK_STRING (stuffstring
);
10242 /* Run the functions in suspend-hook. */
10243 if (!NILP (Vrun_hooks
))
10244 call1 (Vrun_hooks
, intern ("suspend-hook"));
10246 GCPRO1 (stuffstring
);
10247 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10248 reset_all_sys_modes ();
10249 /* sys_suspend can get an error if it tries to fork a subshell
10250 and the system resources aren't available for that. */
10251 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10253 stuff_buffered_input (stuffstring
);
10254 if (cannot_suspend
)
10258 unbind_to (count
, Qnil
);
10260 /* Check if terminal/window size has changed.
10261 Note that this is not useful when we are running directly
10262 with a window system; but suspend should be disabled in that case. */
10263 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10264 if (width
!= old_width
|| height
!= old_height
)
10265 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10267 /* Run suspend-resume-hook. */
10268 if (!NILP (Vrun_hooks
))
10269 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10275 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10276 Then in any case stuff anything Emacs has read ahead and not used. */
10279 stuff_buffered_input (stuffstring
)
10280 Lisp_Object stuffstring
;
10282 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10283 register unsigned char *p
;
10285 if (STRINGP (stuffstring
))
10287 register int count
;
10289 p
= SDATA (stuffstring
);
10290 count
= SBYTES (stuffstring
);
10291 while (count
-- > 0)
10296 /* Anything we have read ahead, put back for the shell to read. */
10297 /* ?? What should this do when we have multiple keyboards??
10298 Should we ignore anything that was typed in at the "wrong" kboard?
10300 rms: we should stuff everything back into the kboard
10302 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10305 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10306 kbd_fetch_ptr
= kbd_buffer
;
10307 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10308 stuff_char (kbd_fetch_ptr
->code
);
10310 clear_event (kbd_fetch_ptr
);
10314 #endif /* SIGTSTP */
10318 set_waiting_for_input (time_to_clear
)
10319 EMACS_TIME
*time_to_clear
;
10321 input_available_clear_time
= time_to_clear
;
10323 /* Tell handle_interrupt to throw back to read_char, */
10324 waiting_for_input
= 1;
10326 /* If handle_interrupt was called before and buffered a C-g,
10327 make it run again now, to avoid timing error. */
10328 if (!NILP (Vquit_flag
))
10329 quit_throw_to_read_char ();
10333 clear_waiting_for_input ()
10335 /* Tell handle_interrupt not to throw back to read_char, */
10336 waiting_for_input
= 0;
10337 input_available_clear_time
= 0;
10340 /* The SIGINT handler.
10342 If we have a frame on the controlling tty, we assume that the
10343 SIGINT was generated by C-g, so we call handle_interrupt.
10344 Otherwise, the handler kills Emacs. */
10347 interrupt_signal (signalnum
) /* If we don't have an argument, */
10348 int signalnum
; /* some compilers complain in signal calls. */
10350 /* Must preserve main program's value of errno. */
10351 int old_errno
= errno
;
10352 struct display
*display
;
10354 #if defined (USG) && !defined (POSIX_SIGNALS)
10355 /* USG systems forget handlers when they are used;
10356 must reestablish each time */
10357 signal (SIGINT
, interrupt_signal
);
10358 signal (SIGQUIT
, interrupt_signal
);
10361 SIGNAL_THREAD_CHECK (signalnum
);
10363 /* See if we have an active display on our controlling terminal. */
10364 display
= get_named_tty_display (NULL
);
10367 /* If there are no frames there, let's pretend that we are a
10368 well-behaving UN*X program and quit. */
10369 fatal_error_signal (SIGTERM
);
10373 /* Otherwise, the SIGINT was probably generated by C-g. */
10375 /* Set internal_last_event_frame to the top frame of the
10376 controlling tty, if we have a frame there. We disable the
10377 interrupt key on secondary ttys, so the SIGINT must have come
10378 from the controlling tty. */
10379 internal_last_event_frame
= display
->display_info
.tty
->top_frame
;
10381 handle_interrupt ();
10387 /* This routine is called at interrupt level in response to C-g.
10389 It is called from the SIGINT handler or kbd_buffer_store_event.
10391 If `waiting_for_input' is non zero, then unless `echoing' is
10392 nonzero, immediately throw back to read_char.
10394 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10395 eval to throw, when it gets a chance. If quit-flag is already
10396 non-nil, it stops the job right away. */
10399 handle_interrupt ()
10405 /* XXX This code needs to be revised for multi-tty support. */
10406 if (!NILP (Vquit_flag
)
10408 && get_named_tty_display (NULL
)
10412 /* If SIGINT isn't blocked, don't let us be interrupted by
10413 another SIGINT, it might be harmful due to non-reentrancy
10414 in I/O functions. */
10415 sigblock (sigmask (SIGINT
));
10418 reset_all_sys_modes ();
10420 #ifdef SIGTSTP /* Support possible in later USG versions */
10422 * On systems which can suspend the current process and return to the original
10423 * shell, this command causes the user to end up back at the shell.
10424 * The "Auto-save" and "Abort" questions are not asked until
10425 * the user elects to return to emacs, at which point he can save the current
10426 * job and either dump core or continue.
10431 if (sys_suspend () == -1)
10433 printf ("Not running as a subprocess;\n");
10434 printf ("you can continue or abort.\n");
10436 #else /* not VMS */
10437 /* Perhaps should really fork an inferior shell?
10438 But that would not provide any way to get back
10439 to the original shell, ever. */
10440 printf ("No support for stopping a process on this operating system;\n");
10441 printf ("you can continue or abort.\n");
10442 #endif /* not VMS */
10443 #endif /* not SIGTSTP */
10445 /* We must remain inside the screen area when the internal terminal
10446 is used. Note that [Enter] is not echoed by dos. */
10449 /* It doesn't work to autosave while GC is in progress;
10450 the code used for auto-saving doesn't cope with the mark bit. */
10451 if (!gc_in_progress
)
10453 printf ("Auto-save? (y or n) ");
10455 if (((c
= getchar ()) & ~040) == 'Y')
10457 Fdo_auto_save (Qt
, Qnil
);
10459 printf ("\r\nAuto-save done");
10460 #else /* not MSDOS */
10461 printf ("Auto-save done\n");
10462 #endif /* not MSDOS */
10464 while (c
!= '\n') c
= getchar ();
10468 /* During GC, it must be safe to reenable quitting again. */
10469 Vinhibit_quit
= Qnil
;
10472 #endif /* not MSDOS */
10473 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10474 printf ("but will instead do a real quit after garbage collection ends\r\n");
10479 printf ("\r\nAbort? (y or n) ");
10480 #else /* not MSDOS */
10482 printf ("Abort (and enter debugger)? (y or n) ");
10483 #else /* not VMS */
10484 printf ("Abort (and dump core)? (y or n) ");
10485 #endif /* not VMS */
10486 #endif /* not MSDOS */
10488 if (((c
= getchar ()) & ~040) == 'Y')
10490 while (c
!= '\n') c
= getchar ();
10492 printf ("\r\nContinuing...\r\n");
10493 #else /* not MSDOS */
10494 printf ("Continuing...\n");
10495 #endif /* not MSDOS */
10497 init_all_sys_modes ();
10502 /* If executing a function that wants to be interrupted out of
10503 and the user has not deferred quitting by binding `inhibit-quit'
10504 then quit right away. */
10505 if (immediate_quit
&& NILP (Vinhibit_quit
))
10507 struct gl_state_s saved
;
10508 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10510 immediate_quit
= 0;
10513 GCPRO4 (saved
.object
, saved
.global_code
,
10514 saved
.current_syntax_table
, saved
.old_prop
);
10515 Fsignal (Qquit
, Qnil
);
10520 /* Else request quit when it's safe */
10524 if (waiting_for_input
&& !echoing
)
10525 quit_throw_to_read_char ();
10528 /* Handle a C-g by making read_char return C-g. */
10531 quit_throw_to_read_char ()
10534 /* Prevent another signal from doing this before we finish. */
10535 clear_waiting_for_input ();
10538 Vunread_command_events
= Qnil
;
10539 unread_command_char
= -1;
10541 #if 0 /* Currently, sit_for is called from read_char without turning
10542 off polling. And that can call set_waiting_for_input.
10543 It seems to be harmless. */
10544 #ifdef POLL_FOR_INPUT
10545 /* May be > 1 if in recursive minibuffer. */
10546 if (poll_suppress_count
== 0)
10550 if (FRAMEP (internal_last_event_frame
)
10551 && !EQ (internal_last_event_frame
, selected_frame
))
10552 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10555 _longjmp (getcjmp
, 1);
10558 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10559 doc
: /* Set mode of reading keyboard input.
10560 First arg INTERRUPT non-nil means use input interrupts;
10561 nil means use CBREAK mode.
10562 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10563 (no effect except in CBREAK mode).
10564 Third arg META t means accept 8-bit input (for a Meta key).
10565 META nil means ignore the top bit, on the assumption it is parity.
10566 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10567 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10568 See also `current-input-mode'. */)
10569 (interrupt
, flow
, meta
, quit
)
10570 Lisp_Object interrupt
, flow
, meta
, quit
;
10572 /* XXX This function needs to be revised for multi-device support.
10573 Currently it compiles fine, but its semantics are wrong. It sets
10574 global parameters (e.g. interrupt_input) based on only the
10575 current frame's device. */
10578 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10579 error ("set-input-mode: QUIT must be an ASCII character");
10581 #ifdef POLL_FOR_INPUT
10586 /* this causes startup screen to be restored and messes with the mouse */
10587 reset_all_sys_modes ();
10591 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10592 if (FRAME_DISPLAY (SELECTED_FRAME ())->read_socket_hook
)
10594 /* When using X, don't give the user a real choice,
10595 because we haven't implemented the mechanisms to support it. */
10596 #ifdef NO_SOCK_SIGIO
10597 interrupt_input
= 0;
10598 #else /* not NO_SOCK_SIGIO */
10599 interrupt_input
= 1;
10600 #endif /* NO_SOCK_SIGIO */
10603 interrupt_input
= !NILP (interrupt
);
10604 #else /* not SIGIO */
10605 interrupt_input
= 0;
10606 #endif /* not SIGIO */
10608 /* Our VMS input only works by interrupts, as of now. */
10610 interrupt_input
= 1;
10613 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10615 struct tty_display_info
*tty
= CURTTY ();
10616 tty
->flow_control
= !NILP (flow
);
10619 else if (EQ (meta
, Qt
))
10626 /* Don't let this value be out of range. */
10627 quit_char
= XINT (quit
) & (NILP (meta
) ? 0177 : 0377);
10630 init_all_sys_modes ();
10633 #ifdef POLL_FOR_INPUT
10634 poll_suppress_count
= 1;
10640 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10641 doc
: /* Return information about the way Emacs currently reads keyboard input.
10642 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10643 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10644 nil, Emacs is using CBREAK mode.
10645 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10646 terminal; this does not apply if Emacs uses interrupt-driven input.
10647 META is t if accepting 8-bit input with 8th bit as Meta flag.
10648 META nil means ignoring the top bit, on the assumption it is parity.
10649 META is neither t nor nil if accepting 8-bit input and using
10650 all 8 bits as the character code.
10651 QUIT is the character Emacs currently uses to quit.
10652 The elements of this list correspond to the arguments of
10653 `set-input-mode'. */)
10656 Lisp_Object val
[4];
10657 struct frame
*sf
= XFRAME (selected_frame
);
10659 val
[0] = interrupt_input
? Qt
: Qnil
;
10660 if (FRAME_TERMCAP_P (sf
))
10662 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10663 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10665 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10672 XSETFASTINT (val
[3], quit_char
);
10674 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10677 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10678 doc
: /* Return position information for pixel coordinates X and Y.
10679 By default, X and Y are relative to text area of the selected window.
10680 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10681 If optional fourth arg WHOLE is non-nil, X is relative to the left
10682 edge of the window.
10684 The return value is similar to a mouse click position:
10685 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10686 IMAGE (DX . DY) (WIDTH . HEIGHT))
10687 The `posn-' functions access elements of such lists. */)
10688 (x
, y
, frame_or_window
, whole
)
10689 Lisp_Object x
, y
, frame_or_window
, whole
;
10694 if (NILP (frame_or_window
))
10695 frame_or_window
= selected_window
;
10697 if (WINDOWP (frame_or_window
))
10701 CHECK_LIVE_WINDOW (frame_or_window
);
10703 w
= XWINDOW (frame_or_window
);
10704 XSETINT (x
, (WINDOW_TO_FRAME_PIXEL_X (w
, XINT (x
))
10706 ? window_box_left_offset (w
, TEXT_AREA
)
10707 : - (WINDOW_LEFT_SCROLL_BAR_COLS (w
)
10708 * WINDOW_FRAME_COLUMN_WIDTH (w
)))));
10709 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10710 frame_or_window
= w
->frame
;
10713 CHECK_LIVE_FRAME (frame_or_window
);
10715 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10718 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10719 doc
: /* Return position information for buffer POS in WINDOW.
10720 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10722 Return nil if position is not visible in window. Otherwise,
10723 the return value is similar to that returned by `event-start' for
10724 a mouse click at the upper left corner of the glyph corresponding
10725 to the given buffer position:
10726 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10727 IMAGE (DX . DY) (WIDTH . HEIGHT))
10728 The `posn-' functions access elements of such lists. */)
10730 Lisp_Object pos
, window
;
10734 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10736 tem
= Fposn_at_x_y (XCAR (tem
), XCAR (XCDR (tem
)), window
, Qnil
);
10742 * Set up a new kboard object with reasonable initial values.
10748 kb
->Voverriding_terminal_local_map
= Qnil
;
10749 kb
->Vlast_command
= Qnil
;
10750 kb
->Vreal_last_command
= Qnil
;
10751 kb
->Vprefix_arg
= Qnil
;
10752 kb
->Vlast_prefix_arg
= Qnil
;
10753 kb
->kbd_queue
= Qnil
;
10754 kb
->kbd_queue_has_data
= 0;
10755 kb
->immediate_echo
= 0;
10756 kb
->echo_string
= Qnil
;
10757 kb
->echo_after_prompt
= -1;
10758 kb
->kbd_macro_buffer
= 0;
10759 kb
->kbd_macro_bufsize
= 0;
10760 kb
->defining_kbd_macro
= Qnil
;
10761 kb
->Vlast_kbd_macro
= Qnil
;
10762 kb
->reference_count
= 0;
10763 kb
->Vsystem_key_alist
= Qnil
;
10764 kb
->system_key_syms
= Qnil
;
10765 kb
->Vdefault_minibuffer_frame
= Qnil
;
10769 * Destroy the contents of a kboard object, but not the object itself.
10770 * We use this just before deleting it, or if we're going to initialize
10771 * it a second time.
10777 if (kb
->kbd_macro_buffer
)
10778 xfree (kb
->kbd_macro_buffer
);
10781 #ifdef MULTI_KBOARD
10783 /* Free KB and memory referenced from it. */
10791 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10794 *kbp
= kb
->next_kboard
;
10796 /* Prevent a dangling reference to KB. */
10797 if (kb
== current_kboard
10798 && FRAMEP (selected_frame
)
10799 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10801 current_kboard
= XFRAME (selected_frame
)->kboard
;
10802 if (current_kboard
== kb
)
10810 #endif /* MULTI_KBOARD */
10815 /* This is correct before outermost invocation of the editor loop */
10816 command_loop_level
= -1;
10817 immediate_quit
= 0;
10818 quit_char
= Ctl ('g');
10819 Vunread_command_events
= Qnil
;
10820 unread_command_char
= -1;
10821 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10823 recent_keys_index
= 0;
10824 kbd_fetch_ptr
= kbd_buffer
;
10825 kbd_store_ptr
= kbd_buffer
;
10827 do_mouse_tracking
= Qnil
;
10831 /* This means that command_loop_1 won't try to select anything the first
10833 internal_last_event_frame
= Qnil
;
10834 Vlast_event_frame
= internal_last_event_frame
;
10836 #ifdef MULTI_KBOARD
10837 current_kboard
= initial_kboard
;
10839 wipe_kboard (current_kboard
);
10840 init_kboard (current_kboard
);
10842 if (!noninteractive
)
10844 /* Before multi-tty support, these handlers used to be installed
10845 only if the current session was a tty session. Now an Emacs
10846 session may have multiple display types, so we always handle
10847 SIGINT. There is special code in interrupt_signal to exit
10848 Emacs on SIGINT when there are no termcap frames on the
10849 controlling terminal. */
10850 signal (SIGINT
, interrupt_signal
);
10851 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10852 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10853 SIGQUIT and we can't tell which one it will give us. */
10854 signal (SIGQUIT
, interrupt_signal
);
10855 #endif /* HAVE_TERMIO */
10857 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10859 if (!noninteractive
)
10860 signal (SIGIO
, input_available_signal
);
10863 /* Use interrupt input by default, if it works and noninterrupt input
10864 has deficiencies. */
10866 #ifdef INTERRUPT_INPUT
10867 interrupt_input
= 1;
10869 interrupt_input
= 0;
10872 /* Our VMS input only works by interrupts, as of now. */
10874 interrupt_input
= 1;
10880 if (keyboard_init_hook
)
10881 (*keyboard_init_hook
) ();
10883 #ifdef POLL_FOR_INPUT
10884 poll_suppress_count
= 1;
10889 /* At least provide an escape route since C-g doesn't work. */
10890 signal (SIGINT
, interrupt_signal
);
10894 /* This type's only use is in syms_of_keyboard, to initialize the
10895 event header symbols and put properties on them. */
10896 struct event_head
{
10902 struct event_head head_table
[] = {
10903 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10904 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10905 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10906 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10907 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10908 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10909 /* `select-window' should be handled just like `switch-frame'
10910 in read_key_sequence. */
10911 {&Qselect_window
, "select-window", &Qswitch_frame
}
10915 syms_of_keyboard ()
10917 Vpre_help_message
= Qnil
;
10918 staticpro (&Vpre_help_message
);
10920 Vlispy_mouse_stem
= build_string ("mouse");
10921 staticpro (&Vlispy_mouse_stem
);
10924 QCimage
= intern (":image");
10925 staticpro (&QCimage
);
10927 staticpro (&Qhelp_echo
);
10928 Qhelp_echo
= intern ("help-echo");
10930 staticpro (&item_properties
);
10931 item_properties
= Qnil
;
10933 staticpro (&tool_bar_item_properties
);
10934 tool_bar_item_properties
= Qnil
;
10935 staticpro (&tool_bar_items_vector
);
10936 tool_bar_items_vector
= Qnil
;
10938 staticpro (&real_this_command
);
10939 real_this_command
= Qnil
;
10941 Qtimer_event_handler
= intern ("timer-event-handler");
10942 staticpro (&Qtimer_event_handler
);
10944 Qdisabled_command_function
= intern ("disabled-command-function");
10945 staticpro (&Qdisabled_command_function
);
10947 Qself_insert_command
= intern ("self-insert-command");
10948 staticpro (&Qself_insert_command
);
10950 Qforward_char
= intern ("forward-char");
10951 staticpro (&Qforward_char
);
10953 Qbackward_char
= intern ("backward-char");
10954 staticpro (&Qbackward_char
);
10956 Qdisabled
= intern ("disabled");
10957 staticpro (&Qdisabled
);
10959 Qundefined
= intern ("undefined");
10960 staticpro (&Qundefined
);
10962 Qpre_command_hook
= intern ("pre-command-hook");
10963 staticpro (&Qpre_command_hook
);
10965 Qpost_command_hook
= intern ("post-command-hook");
10966 staticpro (&Qpost_command_hook
);
10968 Qdeferred_action_function
= intern ("deferred-action-function");
10969 staticpro (&Qdeferred_action_function
);
10971 Qcommand_hook_internal
= intern ("command-hook-internal");
10972 staticpro (&Qcommand_hook_internal
);
10974 Qfunction_key
= intern ("function-key");
10975 staticpro (&Qfunction_key
);
10976 Qmouse_click
= intern ("mouse-click");
10977 staticpro (&Qmouse_click
);
10978 #if defined (WINDOWSNT) || defined (MAC_OS)
10979 Qlanguage_change
= intern ("language-change");
10980 staticpro (&Qlanguage_change
);
10982 Qdrag_n_drop
= intern ("drag-n-drop");
10983 staticpro (&Qdrag_n_drop
);
10985 Qsave_session
= intern ("save-session");
10986 staticpro (&Qsave_session
);
10988 Qusr1_signal
= intern ("usr1-signal");
10989 staticpro (&Qusr1_signal
);
10990 Qusr2_signal
= intern ("usr2-signal");
10991 staticpro (&Qusr2_signal
);
10993 Qmenu_enable
= intern ("menu-enable");
10994 staticpro (&Qmenu_enable
);
10995 Qmenu_alias
= intern ("menu-alias");
10996 staticpro (&Qmenu_alias
);
10997 QCenable
= intern (":enable");
10998 staticpro (&QCenable
);
10999 QCvisible
= intern (":visible");
11000 staticpro (&QCvisible
);
11001 QChelp
= intern (":help");
11002 staticpro (&QChelp
);
11003 QCfilter
= intern (":filter");
11004 staticpro (&QCfilter
);
11005 QCbutton
= intern (":button");
11006 staticpro (&QCbutton
);
11007 QCkeys
= intern (":keys");
11008 staticpro (&QCkeys
);
11009 QCkey_sequence
= intern (":key-sequence");
11010 staticpro (&QCkey_sequence
);
11011 QCtoggle
= intern (":toggle");
11012 staticpro (&QCtoggle
);
11013 QCradio
= intern (":radio");
11014 staticpro (&QCradio
);
11016 Qmode_line
= intern ("mode-line");
11017 staticpro (&Qmode_line
);
11018 Qvertical_line
= intern ("vertical-line");
11019 staticpro (&Qvertical_line
);
11020 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11021 staticpro (&Qvertical_scroll_bar
);
11022 Qmenu_bar
= intern ("menu-bar");
11023 staticpro (&Qmenu_bar
);
11026 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11027 staticpro (&Qmouse_fixup_help_message
);
11030 Qabove_handle
= intern ("above-handle");
11031 staticpro (&Qabove_handle
);
11032 Qhandle
= intern ("handle");
11033 staticpro (&Qhandle
);
11034 Qbelow_handle
= intern ("below-handle");
11035 staticpro (&Qbelow_handle
);
11036 Qup
= intern ("up");
11038 Qdown
= intern ("down");
11039 staticpro (&Qdown
);
11040 Qtop
= intern ("top");
11042 Qbottom
= intern ("bottom");
11043 staticpro (&Qbottom
);
11044 Qend_scroll
= intern ("end-scroll");
11045 staticpro (&Qend_scroll
);
11046 Qratio
= intern ("ratio");
11047 staticpro (&Qratio
);
11049 Qevent_kind
= intern ("event-kind");
11050 staticpro (&Qevent_kind
);
11051 Qevent_symbol_elements
= intern ("event-symbol-elements");
11052 staticpro (&Qevent_symbol_elements
);
11053 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11054 staticpro (&Qevent_symbol_element_mask
);
11055 Qmodifier_cache
= intern ("modifier-cache");
11056 staticpro (&Qmodifier_cache
);
11058 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11059 staticpro (&Qrecompute_lucid_menubar
);
11060 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11061 staticpro (&Qactivate_menubar_hook
);
11063 Qpolling_period
= intern ("polling-period");
11064 staticpro (&Qpolling_period
);
11066 Qinput_method_function
= intern ("input-method-function");
11067 staticpro (&Qinput_method_function
);
11069 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11070 staticpro (&Qinput_method_exit_on_first_char
);
11071 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11072 staticpro (&Qinput_method_use_echo_area
);
11074 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11075 Fset (Qinput_method_use_echo_area
, Qnil
);
11077 last_point_position_buffer
= Qnil
;
11080 struct event_head
*p
;
11082 for (p
= head_table
;
11083 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11086 *p
->var
= intern (p
->name
);
11087 staticpro (p
->var
);
11088 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11089 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11093 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11094 staticpro (&button_down_location
);
11095 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11096 staticpro (&mouse_syms
);
11097 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11098 staticpro (&wheel_syms
);
11102 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11104 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11105 for (i
= 0; i
< len
; i
++)
11106 if (modifier_names
[i
])
11107 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11108 staticpro (&modifier_symbols
);
11111 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11112 staticpro (&recent_keys
);
11114 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11115 staticpro (&this_command_keys
);
11117 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11118 staticpro (&raw_keybuf
);
11120 Qextended_command_history
= intern ("extended-command-history");
11121 Fset (Qextended_command_history
, Qnil
);
11122 staticpro (&Qextended_command_history
);
11124 accent_key_syms
= Qnil
;
11125 staticpro (&accent_key_syms
);
11127 func_key_syms
= Qnil
;
11128 staticpro (&func_key_syms
);
11130 drag_n_drop_syms
= Qnil
;
11131 staticpro (&drag_n_drop_syms
);
11133 unread_switch_frame
= Qnil
;
11134 staticpro (&unread_switch_frame
);
11136 internal_last_event_frame
= Qnil
;
11137 staticpro (&internal_last_event_frame
);
11139 read_key_sequence_cmd
= Qnil
;
11140 staticpro (&read_key_sequence_cmd
);
11142 menu_bar_one_keymap_changed_items
= Qnil
;
11143 staticpro (&menu_bar_one_keymap_changed_items
);
11145 defsubr (&Sevent_convert_list
);
11146 defsubr (&Sread_key_sequence
);
11147 defsubr (&Sread_key_sequence_vector
);
11148 defsubr (&Srecursive_edit
);
11150 defsubr (&Strack_mouse
);
11152 defsubr (&Sinput_pending_p
);
11153 defsubr (&Scommand_execute
);
11154 defsubr (&Srecent_keys
);
11155 defsubr (&Sthis_command_keys
);
11156 defsubr (&Sthis_command_keys_vector
);
11157 defsubr (&Sthis_single_command_keys
);
11158 defsubr (&Sthis_single_command_raw_keys
);
11159 defsubr (&Sreset_this_command_lengths
);
11160 defsubr (&Sclear_this_command_keys
);
11161 defsubr (&Ssuspend_emacs
);
11162 defsubr (&Sabort_recursive_edit
);
11163 defsubr (&Sexit_recursive_edit
);
11164 defsubr (&Srecursion_depth
);
11165 defsubr (&Stop_level
);
11166 defsubr (&Sdiscard_input
);
11167 defsubr (&Sopen_dribble_file
);
11168 defsubr (&Sset_input_mode
);
11169 defsubr (&Scurrent_input_mode
);
11170 defsubr (&Sexecute_extended_command
);
11171 defsubr (&Sposn_at_point
);
11172 defsubr (&Sposn_at_x_y
);
11174 DEFVAR_LISP ("last-command-char", &last_command_char
,
11175 doc
: /* Last input event that was part of a command. */);
11177 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11178 doc
: /* Last input event that was part of a command. */);
11180 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11181 doc
: /* Last input event in a command, except for mouse menu events.
11182 Mouse menus give back keys that don't look like mouse events;
11183 this variable holds the actual mouse event that led to the menu,
11184 so that you can determine whether the command was run by mouse or not. */);
11186 DEFVAR_LISP ("last-input-char", &last_input_char
,
11187 doc
: /* Last input event. */);
11189 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11190 doc
: /* Last input event. */);
11192 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11193 doc
: /* List of events to be read as the command input.
11194 These events are processed first, before actual keyboard input. */);
11195 Vunread_command_events
= Qnil
;
11197 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11198 doc
: /* If not -1, an object to be read as next command input event. */);
11200 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11201 doc
: /* List of events to be processed as input by input methods.
11202 These events are processed after `unread-command-events', but
11203 before actual keyboard input. */);
11204 Vunread_post_input_method_events
= Qnil
;
11206 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11207 doc
: /* List of events to be processed as input by input methods.
11208 These events are processed after `unread-command-events', but
11209 before actual keyboard input. */);
11210 Vunread_input_method_events
= Qnil
;
11212 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11213 doc
: /* Meta-prefix character code.
11214 Meta-foo as command input turns into this character followed by foo. */);
11215 XSETINT (meta_prefix_char
, 033);
11217 DEFVAR_KBOARD ("last-command", Vlast_command
,
11218 doc
: /* The last command executed.
11219 Normally a symbol with a function definition, but can be whatever was found
11220 in the keymap, or whatever the variable `this-command' was set to by that
11223 The value `mode-exit' is special; it means that the previous command
11224 read an event that told it to exit, and it did so and unread that event.
11225 In other words, the present command is the event that made the previous
11228 The value `kill-region' is special; it means that the previous command
11229 was a kill command. */);
11231 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11232 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11234 DEFVAR_LISP ("this-command", &Vthis_command
,
11235 doc
: /* The command now being executed.
11236 The command can set this variable; whatever is put here
11237 will be in `last-command' during the following command. */);
11238 Vthis_command
= Qnil
;
11240 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11241 doc
: /* The command bound to the current key sequence before remapping.
11242 It equals `this-command' if the original command was not remapped through
11243 any of the active keymaps. Otherwise, the value of `this-command' is the
11244 result of looking up the original command in the active keymaps. */);
11245 Vthis_original_command
= Qnil
;
11247 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11248 doc
: /* *Number of input events between auto-saves.
11249 Zero means disable autosaving due to number of characters typed. */);
11250 auto_save_interval
= 300;
11252 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11253 doc
: /* *Number of seconds idle time before auto-save.
11254 Zero or nil means disable auto-saving due to idleness.
11255 After auto-saving due to this many seconds of idle time,
11256 Emacs also does a garbage collection if that seems to be warranted. */);
11257 XSETFASTINT (Vauto_save_timeout
, 30);
11259 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11260 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11261 The value may be integer or floating point. */);
11262 Vecho_keystrokes
= make_number (1);
11264 DEFVAR_INT ("polling-period", &polling_period
,
11265 doc
: /* *Interval between polling for input during Lisp execution.
11266 The reason for polling is to make C-g work to stop a running program.
11267 Polling is needed only when using X windows and SIGIO does not work.
11268 Polling is automatically disabled in all other cases. */);
11269 polling_period
= 2;
11271 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11272 doc
: /* *Maximum time between mouse clicks to make a double-click.
11273 Measured in milliseconds. nil means disable double-click recognition;
11274 t means double-clicks have no time limit and are detected
11275 by position only. */);
11276 Vdouble_click_time
= make_number (500);
11278 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11279 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11280 On window-system frames, value is the number of pixels the mouse may have
11281 moved horizontally or vertically between two clicks to make a double-click.
11282 On non window-system frames, value is interpreted in units of 1/8 characters
11285 This variable is also the threshold for motion of the mouse
11286 to count as a drag. */);
11287 double_click_fuzz
= 3;
11289 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11290 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11291 inhibit_local_menu_bar_menus
= 0;
11293 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11294 doc
: /* Number of complete key sequences read as input so far.
11295 This includes key sequences read from keyboard macros.
11296 The number is effectively the number of interactive command invocations. */);
11297 num_input_keys
= 0;
11299 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11300 doc
: /* Number of input events read from the keyboard so far.
11301 This does not include events generated by keyboard macros. */);
11302 num_nonmacro_input_events
= 0;
11304 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11305 doc
: /* The frame in which the most recently read event occurred.
11306 If the last event came from a keyboard macro, this is set to `macro'. */);
11307 Vlast_event_frame
= Qnil
;
11309 /* This variable is set up in sysdep.c. */
11310 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11311 doc
: /* The ERASE character as set by the user with stty. */);
11313 DEFVAR_LISP ("help-char", &Vhelp_char
,
11314 doc
: /* Character to recognize as meaning Help.
11315 When it is read, do `(eval help-form)', and display result if it's a string.
11316 If the value of `help-form' is nil, this char can be read normally. */);
11317 XSETINT (Vhelp_char
, Ctl ('H'));
11319 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11320 doc
: /* List of input events to recognize as meaning Help.
11321 These work just like the value of `help-char' (see that). */);
11322 Vhelp_event_list
= Qnil
;
11324 DEFVAR_LISP ("help-form", &Vhelp_form
,
11325 doc
: /* Form to execute when character `help-char' is read.
11326 If the form returns a string, that string is displayed.
11327 If `help-form' is nil, the help char is not recognized. */);
11330 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11331 doc
: /* Command to run when `help-char' character follows a prefix key.
11332 This command is used only when there is no actual binding
11333 for that character after that prefix key. */);
11334 Vprefix_help_command
= Qnil
;
11336 DEFVAR_LISP ("top-level", &Vtop_level
,
11337 doc
: /* Form to evaluate when Emacs starts up.
11338 Useful to set before you dump a modified Emacs. */);
11341 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11342 doc
: /* Translate table for keyboard input, or nil.
11343 If non-nil, the value should be a char-table. Each character read
11344 from the keyboard is looked up in this char-table. If the value found
11345 there is non-nil, then it is used instead of the actual input character.
11347 The value can also be a string or vector, but this is considered obsolete.
11348 If it is a string or vector of length N, character codes N and up are left
11349 untranslated. In a vector, an element which is nil means "no translation".
11351 This is applied to the characters supplied to input methods, not their
11352 output. See also `translation-table-for-input'. */);
11353 Vkeyboard_translate_table
= Qnil
;
11355 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11356 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11357 \(Even if the operating system has support for stopping a process.\) */);
11358 cannot_suspend
= 0;
11360 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11361 doc
: /* Non-nil means prompt with menus when appropriate.
11362 This is done when reading from a keymap that has a prompt string,
11363 for elements that have prompt strings.
11364 The menu is displayed on the screen
11365 if X menus were enabled at configuration
11366 time and the previous event was a mouse click prefix key.
11367 Otherwise, menu prompting uses the echo area. */);
11368 menu_prompting
= 1;
11370 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11371 doc
: /* Character to see next line of menu prompt.
11372 Type this character while in a menu prompt to rotate around the lines of it. */);
11373 XSETINT (menu_prompt_more_char
, ' ');
11375 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11376 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11377 Emacs applies the modifiers of the character stored here to each keyboard
11378 character it reads. For example, after evaluating the expression
11379 (setq extra-keyboard-modifiers ?\\C-x)
11380 all input characters will have the control modifier applied to them.
11382 Note that the character ?\\C-@, equivalent to the integer zero, does
11383 not count as a control character; rather, it counts as a character
11384 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11385 cancels any modification. */);
11386 extra_keyboard_modifiers
= 0;
11388 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11389 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11390 The command loop sets this to nil before each command,
11391 and tests the value when the command returns.
11392 Buffer modification stores t in this variable. */);
11393 Vdeactivate_mark
= Qnil
;
11395 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11396 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11397 Vcommand_hook_internal
= Qnil
;
11399 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11400 doc
: /* Normal hook run before each command is executed.
11401 If an unhandled error happens in running this hook,
11402 the hook value is set to nil, since otherwise the error
11403 might happen repeatedly and make Emacs nonfunctional. */);
11404 Vpre_command_hook
= Qnil
;
11406 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11407 doc
: /* Normal hook run after each command is executed.
11408 If an unhandled error happens in running this hook,
11409 the hook value is set to nil, since otherwise the error
11410 might happen repeatedly and make Emacs nonfunctional. */);
11411 Vpost_command_hook
= Qnil
;
11414 DEFVAR_LISP ("echo-area-clear-hook", ...,
11415 doc
: /* Normal hook run when clearing the echo area. */);
11417 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11418 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11420 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11421 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11422 Vlucid_menu_bar_dirty_flag
= Qnil
;
11424 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11425 doc
: /* List of menu bar items to move to the end of the menu bar.
11426 The elements of the list are event types that may have menu bar bindings. */);
11427 Vmenu_bar_final_items
= Qnil
;
11429 DEFVAR_KBOARD ("overriding-terminal-local-map",
11430 Voverriding_terminal_local_map
,
11431 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11432 If this variable is non-nil, it is used as a keymap instead of the
11433 buffer's local map, and the minor mode keymaps and text property keymaps.
11434 It also replaces `overriding-local-map'.
11436 This variable is intended to let commands such as `universal-argument'
11437 set up a different keymap for reading the next command. */);
11439 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11440 doc
: /* Keymap that overrides all other local keymaps.
11441 If this variable is non-nil, it is used as a keymap--replacing the
11442 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11443 Voverriding_local_map
= Qnil
;
11445 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11446 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11447 Otherwise, the menu bar continues to reflect the buffer's local map
11448 and the minor mode maps regardless of `overriding-local-map'. */);
11449 Voverriding_local_map_menu_flag
= Qnil
;
11451 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11452 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11453 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11455 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11456 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11458 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11459 doc
: /* Alist of system-specific X windows key symbols.
11460 Each element should have the form (N . SYMBOL) where N is the
11461 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11462 and SYMBOL is its name. */);
11464 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11465 doc
: /* List of deferred actions to be performed at a later time.
11466 The precise format isn't relevant here; we just check whether it is nil. */);
11467 Vdeferred_action_list
= Qnil
;
11469 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11470 doc
: /* Function to call to handle deferred actions, after each command.
11471 This function is called with no arguments after each command
11472 whenever `deferred-action-list' is non-nil. */);
11473 Vdeferred_action_function
= Qnil
;
11475 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11476 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11477 The value can be a length of time to show the message for.
11478 If the value is non-nil and not a number, we wait 2 seconds. */);
11479 Vsuggest_key_bindings
= Qt
;
11481 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11482 doc
: /* List of active absolute time timers in order of increasing time. */);
11483 Vtimer_list
= Qnil
;
11485 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11486 doc
: /* List of active idle-time timers in order of increasing time. */);
11487 Vtimer_idle_list
= Qnil
;
11489 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11490 doc
: /* If non-nil, the function that implements the current input method.
11491 It's called with one argument, a printing character that was just read.
11492 \(That means a character with code 040...0176.)
11493 Typically this function uses `read-event' to read additional events.
11494 When it does so, it should first bind `input-method-function' to nil
11495 so it will not be called recursively.
11497 The function should return a list of zero or more events
11498 to be used as input. If it wants to put back some events
11499 to be reconsidered, separately, by the input method,
11500 it can add them to the beginning of `unread-command-events'.
11502 The input method function can find in `input-method-previous-method'
11503 the previous echo area message.
11505 The input method function should refer to the variables
11506 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11507 for guidance on what to do. */);
11508 Vinput_method_function
= Qnil
;
11510 DEFVAR_LISP ("input-method-previous-message",
11511 &Vinput_method_previous_message
,
11512 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11513 This variable exists because `read-event' clears the echo area
11514 before running the input method. It is nil if there was no message. */);
11515 Vinput_method_previous_message
= Qnil
;
11517 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11518 doc
: /* If non-nil, the function that implements the display of help.
11519 It's called with one argument, the help string to display. */);
11520 Vshow_help_function
= Qnil
;
11522 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11523 doc
: /* If non-nil, suppress point adjustment after executing a command.
11525 After a command is executed, if point is moved into a region that has
11526 special properties (e.g. composition, display), we adjust point to
11527 the boundary of the region. But, when a command sets this variable to
11528 non-nil, we suppress the point adjustment.
11530 This variable is set to nil before reading a command, and is checked
11531 just after executing the command. */);
11532 Vdisable_point_adjustment
= Qnil
;
11534 DEFVAR_LISP ("global-disable-point-adjustment",
11535 &Vglobal_disable_point_adjustment
,
11536 doc
: /* *If non-nil, always suppress point adjustment.
11538 The default value is nil, in which case, point adjustment are
11539 suppressed only after special commands that set
11540 `disable-point-adjustment' (which see) to non-nil. */);
11541 Vglobal_disable_point_adjustment
= Qnil
;
11543 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11544 doc
: /* Non-nil means updating menu bindings is allowed.
11545 A value of nil means menu bindings should not be updated.
11546 Used during Emacs' startup. */);
11547 update_menu_bindings
= 1;
11549 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11550 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11551 If the value is not a number, such messages don't time out. */);
11552 Vminibuffer_message_timeout
= make_number (2);
11554 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11555 doc
: /* If non-nil, any keyboard input throws to this symbol.
11556 The value of that variable is passed to `quit-flag' and later causes a
11557 peculiar kind of quitting. */);
11558 Vthrow_on_input
= Qnil
;
11562 keys_of_keyboard ()
11564 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11565 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11566 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11567 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11568 initial_define_key (meta_map
, 'x', "execute-extended-command");
11570 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11571 "handle-delete-frame");
11572 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11573 current-prefix-arg, as is done in `handle-switch-frame'.
11574 But `handle-switch-frame is not run from the special-map.
11575 Commands from that map are run in a special way that automatically
11576 preserves the prefix-arg. Restoring the prefix arg here is not just
11577 redundant but harmful:
11579 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11580 - after the first prompt, the exit-minibuffer-hook is run which may
11581 iconify a frame and thus push a `iconify-frame' event.
11582 - after running exit-minibuffer-hook, current-prefix-arg is
11583 restored to the non-nil value it had before the prompt.
11584 - we enter the second prompt.
11585 current-prefix-arg is non-nil, prefix-arg is nil.
11586 - before running the first real event, we run the special iconify-frame
11587 event, but we pass the `special' arg to execute-command so
11588 current-prefix-arg and prefix-arg are left untouched.
11589 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11590 - the next key event will have a spuriously non-nil current-prefix-arg. */
11591 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11593 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11595 /* Handling it at such a low-level causes read_key_sequence to get
11596 * confused because it doesn't realize that the current_buffer was
11597 * changed by read_char.
11599 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11600 * "handle-select-window"); */
11601 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11602 "handle-save-session");
11605 /* Mark the pointers in the kboard objects.
11606 Called by the Fgarbage_collector. */
11612 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11614 if (kb
->kbd_macro_buffer
)
11615 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11617 mark_object (kb
->Voverriding_terminal_local_map
);
11618 mark_object (kb
->Vlast_command
);
11619 mark_object (kb
->Vreal_last_command
);
11620 mark_object (kb
->Vprefix_arg
);
11621 mark_object (kb
->Vlast_prefix_arg
);
11622 mark_object (kb
->kbd_queue
);
11623 mark_object (kb
->defining_kbd_macro
);
11624 mark_object (kb
->Vlast_kbd_macro
);
11625 mark_object (kb
->Vsystem_key_alist
);
11626 mark_object (kb
->system_key_syms
);
11627 mark_object (kb
->Vdefault_minibuffer_frame
);
11628 mark_object (kb
->echo_string
);
11631 struct input_event
*event
;
11632 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11634 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11635 event
= kbd_buffer
;
11636 if (event
->kind
!= SELECTION_REQUEST_EVENT
11637 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11639 mark_object (event
->x
);
11640 mark_object (event
->y
);
11642 mark_object (event
->frame_or_window
);
11643 mark_object (event
->arg
);
11648 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11649 (do not change this comment) */