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
);
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
;
1510 Vthis_original_command
= Qnil
;
1512 /* Read next key sequence; i gets its length. */
1513 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1516 /* A filter may have run while we were reading the input. */
1517 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1519 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1520 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1524 /* Now we have read a key sequence of length I,
1525 or else I is 0 and we found end of file. */
1527 if (i
== 0) /* End of file -- happens only in */
1528 return Qnil
; /* a kbd macro, at the end. */
1529 /* -1 means read_key_sequence got a menu that was rejected.
1530 Just loop around and read another command. */
1534 this_command_key_count
= 0;
1535 this_command_key_count_reset
= 0;
1536 this_single_command_key_start
= 0;
1540 last_command_char
= keybuf
[i
- 1];
1542 /* If the previous command tried to force a specific window-start,
1543 forget about that, in case this command moves point far away
1544 from that position. But also throw away beg_unchanged and
1545 end_unchanged information in that case, so that redisplay will
1546 update the whole window properly. */
1547 if (!NILP (XWINDOW (selected_window
)->force_start
))
1550 XWINDOW (selected_window
)->force_start
= Qnil
;
1551 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1552 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1555 cmd
= read_key_sequence_cmd
;
1556 if (!NILP (Vexecuting_kbd_macro
))
1558 if (!NILP (Vquit_flag
))
1560 Vexecuting_kbd_macro
= Qt
;
1561 QUIT
; /* Make some noise. */
1562 /* Will return since macro now empty. */
1566 /* Do redisplay processing after this command except in special
1567 cases identified below. */
1568 prev_buffer
= current_buffer
;
1569 prev_modiff
= MODIFF
;
1570 last_point_position
= PT
;
1571 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1573 /* By default, we adjust point to a boundary of a region that
1574 has such a property that should be treated intangible
1575 (e.g. composition, display). But, some commands will set
1576 this variable differently. */
1577 Vdisable_point_adjustment
= Qnil
;
1579 /* Process filters and timers may have messed with deactivate-mark.
1580 reset it before we execute the command. */
1581 Vdeactivate_mark
= Qnil
;
1583 /* Remap command through active keymaps */
1584 Vthis_original_command
= cmd
;
1588 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1592 /* Execute the command. */
1594 Vthis_command
= cmd
;
1595 real_this_command
= cmd
;
1596 /* Note that the value cell will never directly contain nil
1597 if the symbol is a local variable. */
1598 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1599 safe_run_hooks (Qpre_command_hook
);
1601 already_adjusted
= 0;
1603 if (NILP (Vthis_command
))
1605 /* nil means key is undefined. */
1606 Lisp_Object keys
= Fvector (i
, keybuf
);
1607 keys
= Fkey_description (keys
, Qnil
);
1609 message_with_string ("%s is undefined", keys
, 0);
1610 current_kboard
->defining_kbd_macro
= Qnil
;
1611 update_mode_lines
= 1;
1612 current_kboard
->Vprefix_arg
= Qnil
;
1616 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1618 /* In case we jump to directly_done. */
1619 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1621 /* Recognize some common commands in common situations and
1622 do them directly. */
1623 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1625 struct Lisp_Char_Table
*dp
1626 = window_display_table (XWINDOW (selected_window
));
1627 lose
= FETCH_CHAR (PT_BYTE
);
1629 if (! NILP (Vpost_command_hook
))
1630 /* Put this before calling adjust_point_for_property
1631 so it will only get called once in any case. */
1633 if (current_buffer
== prev_buffer
1634 && last_point_position
!= PT
1635 && NILP (Vdisable_point_adjustment
)
1636 && NILP (Vglobal_disable_point_adjustment
))
1637 adjust_point_for_property (last_point_position
, 0);
1638 already_adjusted
= 1;
1639 if (PT
== last_point_position
+ 1
1641 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1642 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1643 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1644 && (lose
>= 0x20 && lose
< 0x7f)))
1645 : (lose
>= 0x20 && lose
< 0x7f))
1646 /* To extract the case of continuation on
1647 wide-column characters. */
1648 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1649 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1651 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1653 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1655 && !windows_or_buffers_changed
1656 && EQ (current_buffer
->selective_display
, Qnil
)
1657 && !detect_input_pending ()
1658 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1659 && NILP (Vexecuting_kbd_macro
))
1660 direct_output_forward_char (1);
1663 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1665 struct Lisp_Char_Table
*dp
1666 = window_display_table (XWINDOW (selected_window
));
1668 lose
= FETCH_CHAR (PT_BYTE
);
1669 if (! NILP (Vpost_command_hook
))
1671 if (current_buffer
== prev_buffer
1672 && last_point_position
!= PT
1673 && NILP (Vdisable_point_adjustment
)
1674 && NILP (Vglobal_disable_point_adjustment
))
1675 adjust_point_for_property (last_point_position
, 0);
1676 already_adjusted
= 1;
1677 if (PT
== last_point_position
- 1
1679 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1680 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1681 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1682 && (lose
>= 0x20 && lose
< 0x7f)))
1683 : (lose
>= 0x20 && lose
< 0x7f))
1684 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1686 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1688 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1690 && !windows_or_buffers_changed
1691 && EQ (current_buffer
->selective_display
, Qnil
)
1692 && !detect_input_pending ()
1693 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1694 && NILP (Vexecuting_kbd_macro
))
1695 direct_output_forward_char (-1);
1698 else if (EQ (Vthis_command
, Qself_insert_command
)
1699 /* Try this optimization only on char keystrokes. */
1700 && NATNUMP (last_command_char
)
1701 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1704 = translate_char (Vtranslation_table_for_input
,
1705 XFASTINT (last_command_char
), 0, 0, 0);
1707 if (NILP (Vexecuting_kbd_macro
)
1708 && !EQ (minibuf_window
, selected_window
))
1710 if (!nonundocount
|| nonundocount
>= 20)
1718 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1720 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1722 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1724 || MODIFF
<= SAVE_MODIFF
1725 || windows_or_buffers_changed
1726 || !EQ (current_buffer
->selective_display
, Qnil
)
1727 || detect_input_pending ()
1728 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1729 || !NILP (Vexecuting_kbd_macro
));
1731 value
= internal_self_insert (c
, 0);
1736 if (! NILP (Vpost_command_hook
))
1737 /* Put this before calling adjust_point_for_property
1738 so it will only get called once in any case. */
1741 /* VALUE == 1 when AFTER-CHANGE functions are
1742 installed which is the case most of the time
1743 because FONT-LOCK installs one. */
1744 if (!lose
&& !value
)
1745 direct_output_for_insert (c
);
1750 /* Here for a command that isn't executed directly */
1753 #ifdef HAVE_X_WINDOWS
1754 int scount
= SPECPDL_INDEX ();
1756 if (display_hourglass_p
1757 && NILP (Vexecuting_kbd_macro
))
1759 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1765 if (NILP (current_kboard
->Vprefix_arg
))
1767 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1769 #ifdef HAVE_X_WINDOWS
1770 /* Do not check display_hourglass_p here, because
1771 Fcommand_execute could change it, but we should cancel
1772 hourglass cursor anyway.
1773 But don't cancel the hourglass within a macro
1774 just because a command in the macro finishes. */
1775 if (NILP (Vexecuting_kbd_macro
))
1776 unbind_to (scount
, Qnil
);
1781 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1783 /* Note that the value cell will never directly contain nil
1784 if the symbol is a local variable. */
1785 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1786 safe_run_hooks (Qpost_command_hook
);
1788 /* If displaying a message, resize the echo area window to fit
1789 that message's size exactly. */
1790 if (!NILP (echo_area_buffer
[0]))
1791 resize_echo_area_exactly ();
1793 if (!NILP (Vdeferred_action_list
))
1794 safe_run_hooks (Qdeferred_action_function
);
1796 /* If there is a prefix argument,
1797 1) We don't want Vlast_command to be ``universal-argument''
1798 (that would be dumb), so don't set Vlast_command,
1799 2) we want to leave echoing on so that the prefix will be
1800 echoed as part of this key sequence, so don't call
1802 3) we want to leave this_command_key_count non-zero, so that
1803 read_char will realize that it is re-reading a character, and
1804 not echo it a second time.
1806 If the command didn't actually create a prefix arg,
1807 but is merely a frame event that is transparent to prefix args,
1808 then the above doesn't apply. */
1809 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1811 current_kboard
->Vlast_command
= Vthis_command
;
1812 current_kboard
->Vreal_last_command
= real_this_command
;
1814 this_command_key_count
= 0;
1815 this_command_key_count_reset
= 0;
1816 this_single_command_key_start
= 0;
1819 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1821 /* Setting transient-mark-mode to `only' is a way of
1822 turning it on for just one command. */
1824 if (EQ (Vtransient_mark_mode
, Qidentity
))
1825 Vtransient_mark_mode
= Qnil
;
1826 if (EQ (Vtransient_mark_mode
, Qonly
))
1827 Vtransient_mark_mode
= Qidentity
;
1829 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1831 /* We could also call `deactivate'mark'. */
1832 if (EQ (Vtransient_mark_mode
, Qlambda
))
1833 Vtransient_mark_mode
= Qnil
;
1836 current_buffer
->mark_active
= Qnil
;
1837 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1840 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1841 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1846 if (current_buffer
== prev_buffer
1847 && last_point_position
!= PT
1848 && NILP (Vdisable_point_adjustment
)
1849 && NILP (Vglobal_disable_point_adjustment
)
1850 && !already_adjusted
)
1851 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1853 /* Install chars successfully executed in kbd macro. */
1855 if (!NILP (current_kboard
->defining_kbd_macro
)
1856 && NILP (current_kboard
->Vprefix_arg
))
1857 finalize_kbd_macro_chars ();
1861 any_kboard_state ();
1866 extern Lisp_Object Qcomposition
, Qdisplay
;
1868 /* Adjust point to a boundary of a region that has such a property
1869 that should be treated intangible. For the moment, we check
1870 `composition', `display' and `invisible' properties.
1871 LAST_PT is the last position of point. */
1873 extern Lisp_Object Qafter_string
, Qbefore_string
;
1874 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1877 adjust_point_for_property (last_pt
, modified
)
1882 Lisp_Object val
, overlay
, tmp
;
1883 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1886 /* FIXME: cycling is probably not necessary because these properties
1887 can't be usefully combined anyway. */
1888 while (check_composition
|| check_display
|| check_invisible
)
1890 if (check_composition
1891 && PT
> BEGV
&& PT
< ZV
1892 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1893 && COMPOSITION_VALID_P (beg
, end
, val
)
1894 && beg
< PT
/* && end > PT <- It's always the case. */
1895 && (last_pt
<= beg
|| last_pt
>= end
))
1898 SET_PT (PT
< last_pt
? beg
: end
);
1899 check_display
= check_invisible
= 1;
1901 check_composition
= 0;
1903 && PT
> BEGV
&& PT
< ZV
1904 && !NILP (val
= get_char_property_and_overlay
1905 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1906 && display_prop_intangible_p (val
)
1907 && (!OVERLAYP (overlay
)
1908 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1909 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1910 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1911 && (beg
< PT
/* && end > PT <- It's always the case. */
1912 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1915 SET_PT (PT
< last_pt
1916 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1918 check_composition
= check_invisible
= 1;
1921 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1923 int inv
, ellipsis
= 0;
1926 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1928 && !NILP (val
= get_char_property_and_overlay
1929 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1930 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1932 ellipsis
= ellipsis
|| inv
> 1
1933 || (OVERLAYP (overlay
)
1934 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1935 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1936 tmp
= Fnext_single_char_property_change
1937 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1938 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1941 && !NILP (val
= get_char_property_and_overlay
1942 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1943 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1945 ellipsis
= ellipsis
|| inv
> 1
1946 || (OVERLAYP (overlay
)
1947 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1948 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1949 tmp
= Fprevious_single_char_property_change
1950 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1951 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1954 /* Move away from the inside area. */
1955 if (beg
< PT
&& end
> PT
)
1957 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1958 /* We haven't moved yet (so we don't need to fear
1959 infinite-looping) and we were outside the range
1960 before (so either end of the range still corresponds
1961 to a move in the right direction): pretend we moved
1962 less than we actually did, so that we still have
1963 more freedom below in choosing which end of the range
1965 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1966 /* We either have moved already or the last point
1967 was already in the range: we don't get to choose
1968 which end of the range we have to go to. */
1969 : (PT
< last_pt
? beg
: end
));
1970 check_composition
= check_display
= 1;
1972 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1973 the point to something other than its argument, due to
1974 point-motion hooks, intangibility, etc. */
1975 xassert (PT
== beg
|| PT
== end
);
1978 /* Pretend the area doesn't exist if the buffer is not
1980 if (!modified
&& !ellipsis
&& beg
< end
)
1982 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1983 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1984 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1985 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1986 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1987 /* We've already moved as far as we can. Trying to go
1988 to the other end would mean moving backwards and thus
1989 could lead to an infinite loop. */
1991 else if (val
= get_pos_property (make_number (PT
),
1993 TEXT_PROP_MEANS_INVISIBLE (val
)
1994 && (val
= get_pos_property
1995 (make_number (PT
== beg
? end
: beg
),
1997 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1998 (check_composition
= check_display
= 1,
1999 SET_PT (PT
== beg
? end
: beg
));
2002 check_invisible
= 0;
2006 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2009 safe_run_hooks_1 (hook
)
2012 return call1 (Vrun_hooks
, Vinhibit_quit
);
2015 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2018 safe_run_hooks_error (data
)
2021 Lisp_Object args
[3];
2022 args
[0] = build_string ("Error in %s: %s");
2023 args
[1] = Vinhibit_quit
;
2026 return Fset (Vinhibit_quit
, Qnil
);
2029 /* If we get an error while running the hook, cause the hook variable
2030 to be nil. Also inhibit quits, so that C-g won't cause the hook
2031 to mysteriously evaporate. */
2034 safe_run_hooks (hook
)
2037 int count
= SPECPDL_INDEX ();
2038 specbind (Qinhibit_quit
, hook
);
2040 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2042 unbind_to (count
, Qnil
);
2046 /* Number of seconds between polling for input. This is a Lisp
2047 variable that can be bound. */
2049 EMACS_INT polling_period
;
2051 /* Nonzero means polling for input is temporarily suppressed. */
2053 int poll_suppress_count
;
2055 /* Asynchronous timer for polling. */
2057 struct atimer
*poll_timer
;
2060 #ifdef POLL_FOR_INPUT
2062 /* Poll for input, so what we catch a C-g if it comes in. This
2063 function is called from x_make_frame_visible, see comment
2069 if (interrupt_input_blocked
== 0
2070 && !waiting_for_input
)
2071 read_avail_input (0);
2074 /* Timer callback function for poll_timer. TIMER is equal to
2078 poll_for_input (timer
)
2079 struct atimer
*timer
;
2081 if (poll_suppress_count
== 0)
2083 interrupt_input_pending
= 1;
2085 poll_for_input_1 ();
2089 #endif /* POLL_FOR_INPUT */
2091 /* Begin signals to poll for input, if they are appropriate.
2092 This function is called unconditionally from various places. */
2097 #ifdef POLL_FOR_INPUT
2098 /* XXX This condition was (read_socket_hook && !interrupt_input),
2099 but read_socket_hook is not global anymore. Let's pretend that
2101 if (!interrupt_input
)
2103 /* Turn alarm handling on unconditionally. It might have
2104 been turned off in process.c. */
2105 turn_on_atimers (1);
2107 /* If poll timer doesn't exist, are we need one with
2108 a different interval, start a new one. */
2109 if (poll_timer
== NULL
2110 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2112 EMACS_TIME interval
;
2115 cancel_atimer (poll_timer
);
2117 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2118 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2119 poll_for_input
, NULL
);
2122 /* Let the timer's callback function poll for input
2123 if this becomes zero. */
2124 --poll_suppress_count
;
2129 /* Nonzero if we are using polling to handle input asynchronously. */
2132 input_polling_used ()
2134 #ifdef POLL_FOR_INPUT
2135 /* XXX This condition was (read_socket_hook && !interrupt_input),
2136 but read_socket_hook is not global anymore. Let's pretend that
2138 return !interrupt_input
;
2144 /* Turn off polling. */
2149 #ifdef POLL_FOR_INPUT
2150 /* XXX This condition was (read_socket_hook && !interrupt_input),
2151 but read_socket_hook is not global anymore. Let's pretend that
2153 if (!interrupt_input
)
2154 ++poll_suppress_count
;
2158 /* Set the value of poll_suppress_count to COUNT
2159 and start or stop polling accordingly. */
2162 set_poll_suppress_count (count
)
2165 #ifdef POLL_FOR_INPUT
2166 if (count
== 0 && poll_suppress_count
!= 0)
2168 poll_suppress_count
= 1;
2171 else if (count
!= 0 && poll_suppress_count
== 0)
2175 poll_suppress_count
= count
;
2179 /* Bind polling_period to a value at least N.
2180 But don't decrease it. */
2183 bind_polling_period (n
)
2186 #ifdef POLL_FOR_INPUT
2187 int new = polling_period
;
2192 stop_other_atimers (poll_timer
);
2194 specbind (Qpolling_period
, make_number (new));
2195 /* Start a new alarm with the new period. */
2200 /* Apply the control modifier to CHARACTER. */
2206 /* Save the upper bits here. */
2207 int upper
= c
& ~0177;
2211 /* Everything in the columns containing the upper-case letters
2212 denotes a control character. */
2213 if (c
>= 0100 && c
< 0140)
2217 /* Set the shift modifier for a control char
2218 made from a shifted letter. But only for letters! */
2219 if (oc
>= 'A' && oc
<= 'Z')
2220 c
|= shift_modifier
;
2223 /* The lower-case letters denote control characters too. */
2224 else if (c
>= 'a' && c
<= 'z')
2227 /* Include the bits for control and shift
2228 only if the basic ASCII code can't indicate them. */
2232 /* Replace the high bits. */
2233 c
|= (upper
& ~ctrl_modifier
);
2238 /* Display the help-echo property of the character after the mouse pointer.
2239 Either show it in the echo area, or call show-help-function to display
2240 it by other means (maybe in a tooltip).
2242 If HELP is nil, that means clear the previous help echo.
2244 If HELP is a string, display that string. If HELP is a function,
2245 call it with OBJECT and POS as arguments; the function should
2246 return a help string or nil for none. For all other types of HELP,
2247 evaluate it to obtain a string.
2249 WINDOW is the window in which the help was generated, if any.
2250 It is nil if not in a window.
2252 If OBJECT is a buffer, POS is the position in the buffer where the
2253 `help-echo' text property was found.
2255 If OBJECT is an overlay, that overlay has a `help-echo' property,
2256 and POS is the position in the overlay's buffer under the mouse.
2258 If OBJECT is a string (an overlay string or a string displayed with
2259 the `display' property). POS is the position in that string under
2262 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2263 echo overwrites a keystroke echo currently displayed in the echo
2266 Note: this function may only be called with HELP nil or a string
2267 from X code running asynchronously. */
2270 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2271 Lisp_Object help
, window
, object
, pos
;
2272 int ok_to_overwrite_keystroke_echo
;
2274 if (!NILP (help
) && !STRINGP (help
))
2276 if (FUNCTIONP (help
))
2278 Lisp_Object args
[4];
2283 help
= safe_call (4, args
);
2286 help
= safe_eval (help
);
2288 if (!STRINGP (help
))
2293 if (!noninteractive
&& STRINGP (help
))
2294 help
= call1 (Qmouse_fixup_help_message
, help
);
2297 if (STRINGP (help
) || NILP (help
))
2299 if (!NILP (Vshow_help_function
))
2300 call1 (Vshow_help_function
, help
);
2301 else if (/* Don't overwrite minibuffer contents. */
2302 !MINI_WINDOW_P (XWINDOW (selected_window
))
2303 /* Don't overwrite a keystroke echo. */
2304 && (NILP (echo_message_buffer
)
2305 || ok_to_overwrite_keystroke_echo
)
2306 /* Don't overwrite a prompt. */
2307 && !cursor_in_echo_area
)
2311 int count
= SPECPDL_INDEX ();
2313 if (!help_echo_showing_p
)
2314 Vpre_help_message
= current_message ();
2316 specbind (Qmessage_truncate_lines
, Qt
);
2317 message3_nolog (help
, SBYTES (help
),
2318 STRING_MULTIBYTE (help
));
2319 unbind_to (count
, Qnil
);
2321 else if (STRINGP (Vpre_help_message
))
2323 message3_nolog (Vpre_help_message
,
2324 SBYTES (Vpre_help_message
),
2325 STRING_MULTIBYTE (Vpre_help_message
));
2326 Vpre_help_message
= Qnil
;
2332 help_echo_showing_p
= STRINGP (help
);
2338 /* Input of single characters from keyboard */
2340 Lisp_Object
print_help ();
2341 static Lisp_Object
kbd_buffer_get_event ();
2342 static void record_char ();
2345 static jmp_buf wrong_kboard_jmpbuf
;
2348 #define STOP_POLLING \
2349 do { if (! polling_stopped_here) stop_polling (); \
2350 polling_stopped_here = 1; } while (0)
2352 #define RESUME_POLLING \
2353 do { if (polling_stopped_here) start_polling (); \
2354 polling_stopped_here = 0; } while (0)
2356 /* read a character from the keyboard; call the redisplay if needed */
2357 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2358 -1 means do not do redisplay, but do do autosaving.
2361 /* The arguments MAPS and NMAPS are for menu prompting.
2362 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2364 PREV_EVENT is the previous input event, or nil if we are reading
2365 the first event of a key sequence (or not reading a key sequence).
2366 If PREV_EVENT is t, that is a "magic" value that says
2367 not to run input methods, but in other respects to act as if
2368 not reading a key sequence.
2370 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2371 if we used a mouse menu to read the input, or zero otherwise. If
2372 USED_MOUSE_MENU is null, we don't dereference it.
2374 Value is t if we showed a menu and the user rejected it. */
2377 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2381 Lisp_Object prev_event
;
2382 int *used_mouse_menu
;
2384 volatile Lisp_Object c
;
2386 jmp_buf local_getcjmp
;
2388 volatile int key_already_recorded
= 0;
2389 Lisp_Object tem
, save
;
2390 volatile Lisp_Object previous_echo_area_message
;
2391 volatile Lisp_Object also_record
;
2392 volatile int reread
;
2393 struct gcpro gcpro1
, gcpro2
;
2394 int polling_stopped_here
= 0;
2398 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2399 before_command_key_count
= this_command_key_count
;
2400 before_command_echo_length
= echo_length ();
2403 previous_echo_area_message
= Qnil
;
2405 GCPRO2 (c
, previous_echo_area_message
);
2410 if (CONSP (Vunread_post_input_method_events
))
2412 c
= XCAR (Vunread_post_input_method_events
);
2413 Vunread_post_input_method_events
2414 = XCDR (Vunread_post_input_method_events
);
2416 /* Undo what read_char_x_menu_prompt did when it unread
2417 additional keys returned by Fx_popup_menu. */
2419 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2427 if (unread_command_char
!= -1)
2429 XSETINT (c
, unread_command_char
);
2430 unread_command_char
= -1;
2436 if (CONSP (Vunread_command_events
))
2438 c
= XCAR (Vunread_command_events
);
2439 Vunread_command_events
= XCDR (Vunread_command_events
);
2441 /* Undo what read_char_x_menu_prompt did when it unread
2442 additional keys returned by Fx_popup_menu. */
2444 && EQ (XCDR (c
), Qdisabled
)
2445 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2448 /* If the queued event is something that used the mouse,
2449 set used_mouse_menu accordingly. */
2451 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2452 *used_mouse_menu
= 1;
2455 goto reread_for_input_method
;
2458 if (CONSP (Vunread_input_method_events
))
2460 c
= XCAR (Vunread_input_method_events
);
2461 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2463 /* Undo what read_char_x_menu_prompt did when it unread
2464 additional keys returned by Fx_popup_menu. */
2466 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2470 goto reread_for_input_method
;
2473 this_command_key_count_reset
= 0;
2475 if (!NILP (Vexecuting_kbd_macro
))
2477 /* We set this to Qmacro; since that's not a frame, nobody will
2478 try to switch frames on us, and the selected window will
2481 Since this event came from a macro, it would be misleading to
2482 leave internal_last_event_frame set to wherever the last
2483 real event came from. Normally, a switch-frame event selects
2484 internal_last_event_frame after each command is read, but
2485 events read from a macro should never cause a new frame to be
2487 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2489 /* Exit the macro if we are at the end.
2490 Also, some things replace the macro with t
2491 to force an early exit. */
2492 if (EQ (Vexecuting_kbd_macro
, Qt
)
2493 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2499 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2500 if (STRINGP (Vexecuting_kbd_macro
)
2501 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2502 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2504 executing_kbd_macro_index
++;
2509 if (!NILP (unread_switch_frame
))
2511 c
= unread_switch_frame
;
2512 unread_switch_frame
= Qnil
;
2514 /* This event should make it into this_command_keys, and get echoed
2515 again, so we do not set `reread'. */
2519 /* if redisplay was requested */
2520 if (commandflag
>= 0)
2522 /* If there is pending input, process any events which are not
2523 user-visible, such as X selection_request events. */
2525 || detect_input_pending_run_timers (0))
2526 swallow_events (0); /* may clear input_pending */
2528 /* Redisplay if no pending input. */
2529 while (!input_pending
)
2531 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2532 redisplay_preserve_echo_area (5);
2537 /* Normal case: no input arrived during redisplay. */
2540 /* Input arrived and pre-empted redisplay.
2541 Process any events which are not user-visible. */
2543 /* If that cleared input_pending, try again to redisplay. */
2547 /* Message turns off echoing unless more keystrokes turn it on again.
2549 The code in 20.x for the condition was
2551 1. echo_area_glyphs && *echo_area_glyphs
2552 2. && echo_area_glyphs != current_kboard->echobuf
2553 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2555 (1) means there's a current message displayed
2557 (2) means it's not the message from echoing from the current
2560 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2561 is set to a non-null value. This is done in read_char and it is
2562 set to echo_area_glyphs after a call to echo_char. That means
2563 ok_to_echo_at_next_pause is either null or
2564 current_kboard->echobuf with the appropriate current_kboard at
2567 So, condition (3) means in clear text ok_to_echo_at_next_pause
2568 must be either null, or the current message isn't from echoing at
2569 all, or it's from echoing from a different kboard than the
2572 if (/* There currently is something in the echo area. */
2573 !NILP (echo_area_buffer
[0])
2574 && (/* And it's either not from echoing. */
2575 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2576 /* Or it's an echo from a different kboard. */
2577 || echo_kboard
!= current_kboard
2578 /* Or we explicitly allow overwriting whatever there is. */
2579 || ok_to_echo_at_next_pause
== NULL
))
2584 /* Try reading a character via menu prompting in the minibuf.
2585 Try this before the sit-for, because the sit-for
2586 would do the wrong thing if we are supposed to do
2587 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2588 after a mouse event so don't try a minibuf menu. */
2590 if (nmaps
> 0 && INTERACTIVE
2591 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2592 /* Don't bring up a menu if we already have another event. */
2593 && NILP (Vunread_command_events
)
2594 && unread_command_char
< 0
2595 && !detect_input_pending_run_timers (0))
2597 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2600 key_already_recorded
= 1;
2605 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2606 We will do that below, temporarily for short sections of code,
2607 when appropriate. local_getcjmp must be in effect
2608 around any call to sit_for or kbd_buffer_get_event;
2609 it *must not* be in effect when we call redisplay. */
2611 if (_setjmp (local_getcjmp
))
2613 /* We must have saved the outer value of getcjmp here,
2614 so restore it now. */
2615 restore_getcjmp (save_jump
);
2616 XSETINT (c
, quit_char
);
2617 internal_last_event_frame
= selected_frame
;
2618 Vlast_event_frame
= internal_last_event_frame
;
2619 /* If we report the quit char as an event,
2620 don't do so more than once. */
2621 if (!NILP (Vinhibit_quit
))
2626 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2627 if (kb
!= current_kboard
)
2629 Lisp_Object link
= kb
->kbd_queue
;
2630 /* We shouldn't get here if we were in single-kboard mode! */
2635 while (CONSP (XCDR (link
)))
2637 if (!NILP (XCDR (link
)))
2641 kb
->kbd_queue
= Fcons (c
, Qnil
);
2643 XSETCDR (link
, Fcons (c
, Qnil
));
2644 kb
->kbd_queue_has_data
= 1;
2645 current_kboard
= kb
;
2646 /* This is going to exit from read_char
2647 so we had better get rid of this frame's stuff. */
2649 longjmp (wrong_kboard_jmpbuf
, 1);
2656 timer_start_idle ();
2658 /* If in middle of key sequence and minibuffer not active,
2659 start echoing if enough time elapses. */
2661 if (minibuf_level
== 0
2662 && !current_kboard
->immediate_echo
2663 && this_command_key_count
> 0
2665 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2666 && NILP (Fzerop (Vecho_keystrokes
))
2667 && (/* No message. */
2668 NILP (echo_area_buffer
[0])
2669 /* Or empty message. */
2670 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2671 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2672 /* Or already echoing from same kboard. */
2673 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2674 /* Or not echoing before and echoing allowed. */
2675 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2679 /* After a mouse event, start echoing right away.
2680 This is because we are probably about to display a menu,
2681 and we don't want to delay before doing so. */
2682 if (EVENT_HAS_PARAMETERS (prev_event
))
2687 double duration
= extract_float (Vecho_keystrokes
);
2688 sec
= (int) duration
;
2689 usec
= (duration
- sec
) * 1000000;
2690 save_getcjmp (save_jump
);
2691 restore_getcjmp (local_getcjmp
);
2692 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2693 restore_getcjmp (save_jump
);
2695 && ! CONSP (Vunread_command_events
))
2700 /* Maybe auto save due to number of keystrokes. */
2702 if (commandflag
!= 0
2703 && auto_save_interval
> 0
2704 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2705 && !detect_input_pending_run_timers (0))
2707 Fdo_auto_save (Qnil
, Qnil
);
2708 /* Hooks can actually change some buffers in auto save. */
2712 /* Try reading using an X menu.
2713 This is never confused with reading using the minibuf
2714 because the recursive call of read_char in read_char_minibuf_menu_prompt
2715 does not pass on any keymaps. */
2717 if (nmaps
> 0 && INTERACTIVE
2718 && !NILP (prev_event
)
2719 && EVENT_HAS_PARAMETERS (prev_event
)
2720 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2721 && !EQ (XCAR (prev_event
), Qtool_bar
)
2722 /* Don't bring up a menu if we already have another event. */
2723 && NILP (Vunread_command_events
)
2724 && unread_command_char
< 0)
2726 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2728 /* Now that we have read an event, Emacs is not idle. */
2734 /* Maybe autosave and/or garbage collect due to idleness. */
2736 if (INTERACTIVE
&& NILP (c
))
2738 int delay_level
, buffer_size
;
2740 /* Slow down auto saves logarithmically in size of current buffer,
2741 and garbage collect while we're at it. */
2742 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2743 last_non_minibuf_size
= Z
- BEG
;
2744 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2746 while (buffer_size
> 64)
2747 delay_level
++, buffer_size
-= buffer_size
>> 2;
2748 if (delay_level
< 4) delay_level
= 4;
2749 /* delay_level is 4 for files under around 50k, 7 at 100k,
2750 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2752 /* Auto save if enough time goes by without input. */
2753 if (commandflag
!= 0
2754 && num_nonmacro_input_events
> last_auto_save
2755 && INTEGERP (Vauto_save_timeout
)
2756 && XINT (Vauto_save_timeout
) > 0)
2760 save_getcjmp (save_jump
);
2761 restore_getcjmp (local_getcjmp
);
2762 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2764 restore_getcjmp (save_jump
);
2767 && ! CONSP (Vunread_command_events
))
2769 Fdo_auto_save (Qnil
, Qnil
);
2771 /* If we have auto-saved and there is still no input
2772 available, garbage collect if there has been enough
2773 consing going on to make it worthwhile. */
2774 if (!detect_input_pending_run_timers (0)
2775 && consing_since_gc
> gc_cons_threshold
/ 2)
2776 Fgarbage_collect ();
2783 /* If this has become non-nil here, it has been set by a timer
2784 or sentinel or filter. */
2785 if (CONSP (Vunread_command_events
))
2787 c
= XCAR (Vunread_command_events
);
2788 Vunread_command_events
= XCDR (Vunread_command_events
);
2791 /* Read something from current KBOARD's side queue, if possible. */
2795 if (current_kboard
->kbd_queue_has_data
)
2797 if (!CONSP (current_kboard
->kbd_queue
))
2799 c
= XCAR (current_kboard
->kbd_queue
);
2800 current_kboard
->kbd_queue
2801 = XCDR (current_kboard
->kbd_queue
);
2802 if (NILP (current_kboard
->kbd_queue
))
2803 current_kboard
->kbd_queue_has_data
= 0;
2804 input_pending
= readable_events (0);
2805 if (EVENT_HAS_PARAMETERS (c
)
2806 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2807 internal_last_event_frame
= XCAR (XCDR (c
));
2808 Vlast_event_frame
= internal_last_event_frame
;
2813 /* If current_kboard's side queue is empty check the other kboards.
2814 If one of them has data that we have not yet seen here,
2815 switch to it and process the data waiting for it.
2817 Note: if the events queued up for another kboard
2818 have already been seen here, and therefore are not a complete command,
2819 the kbd_queue_has_data field is 0, so we skip that kboard here.
2820 That's to avoid an infinite loop switching between kboards here. */
2821 if (NILP (c
) && !single_kboard
)
2824 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2825 if (kb
->kbd_queue_has_data
)
2827 current_kboard
= kb
;
2828 /* This is going to exit from read_char
2829 so we had better get rid of this frame's stuff. */
2831 longjmp (wrong_kboard_jmpbuf
, 1);
2840 /* Finally, we read from the main queue,
2841 and if that gives us something we can't use yet, we put it on the
2842 appropriate side queue and try again. */
2848 /* Actually read a character, waiting if necessary. */
2849 save_getcjmp (save_jump
);
2850 restore_getcjmp (local_getcjmp
);
2851 timer_start_idle ();
2852 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2853 restore_getcjmp (save_jump
);
2856 if (! NILP (c
) && (kb
!= current_kboard
))
2858 Lisp_Object link
= kb
->kbd_queue
;
2861 while (CONSP (XCDR (link
)))
2863 if (!NILP (XCDR (link
)))
2867 kb
->kbd_queue
= Fcons (c
, Qnil
);
2869 XSETCDR (link
, Fcons (c
, Qnil
));
2870 kb
->kbd_queue_has_data
= 1;
2874 current_kboard
= kb
;
2875 /* This is going to exit from read_char
2876 so we had better get rid of this frame's stuff. */
2878 longjmp (wrong_kboard_jmpbuf
, 1);
2883 /* Terminate Emacs in batch mode if at eof. */
2884 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2885 Fkill_emacs (make_number (1));
2889 /* Add in any extra modifiers, where appropriate. */
2890 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2891 || ((extra_keyboard_modifiers
& 0177) < ' '
2892 && (extra_keyboard_modifiers
& 0177) != 0))
2893 XSETINT (c
, make_ctrl_char (XINT (c
)));
2895 /* Transfer any other modifier bits directly from
2896 extra_keyboard_modifiers to c. Ignore the actual character code
2897 in the low 16 bits of extra_keyboard_modifiers. */
2898 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2908 if (commandflag
>= 0
2909 && !input_pending
&& !detect_input_pending_run_timers (0))
2917 /* Buffer switch events are only for internal wakeups
2918 so don't show them to the user.
2919 Also, don't record a key if we already did. */
2920 if (BUFFERP (c
) || key_already_recorded
)
2923 /* Process special events within read_char
2924 and loop around to read another event. */
2927 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2932 int was_locked
= single_kboard
;
2934 last_input_char
= c
;
2935 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2937 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2938 /* We stopped being idle for this event; undo that. This
2939 prevents automatic window selection (under
2940 mouse_autoselect_window from acting as a real input event, for
2941 example banishing the mouse under mouse-avoidance-mode. */
2942 timer_resume_idle ();
2944 /* Resume allowing input from any kboard, if that was true before. */
2946 any_kboard_state ();
2951 /* Handle things that only apply to characters. */
2954 /* If kbd_buffer_get_event gave us an EOF, return that. */
2958 if ((STRINGP (Vkeyboard_translate_table
)
2959 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2960 || (VECTORP (Vkeyboard_translate_table
)
2961 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2962 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2963 && CHAR_VALID_P (XINT (c
), 0)))
2966 d
= Faref (Vkeyboard_translate_table
, c
);
2967 /* nil in keyboard-translate-table means no translation. */
2973 /* If this event is a mouse click in the menu bar,
2974 return just menu-bar for now. Modify the mouse click event
2975 so we won't do this twice, then queue it up. */
2976 if (EVENT_HAS_PARAMETERS (c
)
2978 && CONSP (EVENT_START (c
))
2979 && CONSP (XCDR (EVENT_START (c
))))
2983 posn
= POSN_POSN (EVENT_START (c
));
2984 /* Handle menu-bar events:
2985 insert the dummy prefix event `menu-bar'. */
2986 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2988 /* Change menu-bar to (menu-bar) as the event "position". */
2989 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2992 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2997 /* Store these characters into recent_keys, the dribble file if any,
2998 and the keyboard macro being defined, if any. */
3000 if (! NILP (also_record
))
3001 record_char (also_record
);
3003 /* Wipe the echo area.
3004 But first, if we are about to use an input method,
3005 save the echo area contents for it to refer to. */
3007 && ! NILP (Vinput_method_function
)
3008 && (unsigned) XINT (c
) >= ' '
3009 && (unsigned) XINT (c
) != 127
3010 && (unsigned) XINT (c
) < 256)
3012 previous_echo_area_message
= Fcurrent_message ();
3013 Vinput_method_previous_message
= previous_echo_area_message
;
3016 /* Now wipe the echo area, except for help events which do their
3017 own stuff with the echo area. */
3019 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3020 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3022 if (!NILP (echo_area_buffer
[0]))
3023 safe_run_hooks (Qecho_area_clear_hook
);
3024 clear_message (1, 0);
3027 reread_for_input_method
:
3029 /* Pass this to the input method, if appropriate. */
3031 && ! NILP (Vinput_method_function
)
3032 /* Don't run the input method within a key sequence,
3033 after the first event of the key sequence. */
3034 && NILP (prev_event
)
3035 && (unsigned) XINT (c
) >= ' '
3036 && (unsigned) XINT (c
) != 127
3037 && (unsigned) XINT (c
) < 256)
3040 int key_count
, key_count_reset
;
3041 struct gcpro gcpro1
;
3042 int count
= SPECPDL_INDEX ();
3044 /* Save the echo status. */
3045 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3046 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3047 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3048 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3051 if (before_command_restore_flag
)
3053 this_command_key_count
= before_command_key_count_1
;
3054 if (this_command_key_count
< this_single_command_key_start
)
3055 this_single_command_key_start
= this_command_key_count
;
3056 echo_truncate (before_command_echo_length_1
);
3057 before_command_restore_flag
= 0;
3061 /* Save the this_command_keys status. */
3062 key_count
= this_command_key_count
;
3063 key_count_reset
= this_command_key_count_reset
;
3066 keys
= Fcopy_sequence (this_command_keys
);
3071 /* Clear out this_command_keys. */
3072 this_command_key_count
= 0;
3073 this_command_key_count_reset
= 0;
3075 /* Now wipe the echo area. */
3076 if (!NILP (echo_area_buffer
[0]))
3077 safe_run_hooks (Qecho_area_clear_hook
);
3078 clear_message (1, 0);
3081 /* If we are not reading a key sequence,
3082 never use the echo area. */
3085 specbind (Qinput_method_use_echo_area
, Qt
);
3088 /* Call the input method. */
3089 tem
= call1 (Vinput_method_function
, c
);
3091 tem
= unbind_to (count
, tem
);
3093 /* Restore the saved echoing state
3094 and this_command_keys state. */
3095 this_command_key_count
= key_count
;
3096 this_command_key_count_reset
= key_count_reset
;
3098 this_command_keys
= keys
;
3101 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3102 current_kboard
->echo_string
= saved_echo_string
;
3103 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3104 if (saved_immediate_echo
)
3109 /* The input method can return no events. */
3112 /* Bring back the previous message, if any. */
3113 if (! NILP (previous_echo_area_message
))
3114 message_with_string ("%s", previous_echo_area_message
, 0);
3117 /* It returned one event or more. */
3119 Vunread_post_input_method_events
3120 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3125 /* Display help if not echoing. */
3126 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3128 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3129 Lisp_Object help
, object
, position
, window
, tem
;
3131 tem
= Fcdr (XCDR (c
));
3134 window
= Fcar (tem
);
3136 object
= Fcar (tem
);
3138 position
= Fcar (tem
);
3140 show_help_echo (help
, window
, object
, position
, 0);
3142 /* We stopped being idle for this event; undo that. */
3143 timer_resume_idle ();
3147 if (! reread
|| this_command_key_count
== 0
3148 || this_command_key_count_reset
)
3151 /* Don't echo mouse motion events. */
3152 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3153 && NILP (Fzerop (Vecho_keystrokes
))
3154 && ! (EVENT_HAS_PARAMETERS (c
)
3155 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3158 if (! NILP (also_record
))
3159 echo_char (also_record
);
3160 /* Once we reread a character, echoing can happen
3161 the next time we pause to read a new one. */
3162 ok_to_echo_at_next_pause
= current_kboard
;
3165 /* Record this character as part of the current key. */
3166 add_command_key (c
);
3167 if (! NILP (also_record
))
3168 add_command_key (also_record
);
3171 last_input_char
= c
;
3174 /* Process the help character specially if enabled */
3175 if (!NILP (Vhelp_form
) && help_char_p (c
))
3178 count
= SPECPDL_INDEX ();
3180 record_unwind_protect (Fset_window_configuration
,
3181 Fcurrent_window_configuration (Qnil
));
3183 tem0
= Feval (Vhelp_form
);
3185 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3189 c
= read_char (0, 0, 0, Qnil
, 0);
3190 while (BUFFERP (c
));
3191 /* Remove the help from the frame */
3192 unbind_to (count
, Qnil
);
3195 if (EQ (c
, make_number (040)))
3199 c
= read_char (0, 0, 0, Qnil
, 0);
3200 while (BUFFERP (c
));
3209 /* Record a key that came from a mouse menu.
3210 Record it for echoing, for this-command-keys, and so on. */
3216 /* Wipe the echo area. */
3217 clear_message (1, 0);
3222 before_command_key_count
= this_command_key_count
;
3223 before_command_echo_length
= echo_length ();
3226 /* Don't echo mouse motion events. */
3227 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3228 && NILP (Fzerop (Vecho_keystrokes
)))
3232 /* Once we reread a character, echoing can happen
3233 the next time we pause to read a new one. */
3234 ok_to_echo_at_next_pause
= 0;
3237 /* Record this character as part of the current key. */
3238 add_command_key (c
);
3240 /* Re-reading in the middle of a command */
3241 last_input_char
= c
;
3245 /* Return 1 if should recognize C as "the help character". */
3253 if (EQ (c
, Vhelp_char
))
3255 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3256 if (EQ (c
, XCAR (tail
)))
3261 /* Record the input event C in various ways. */
3269 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3271 /* To avoid filling recent_keys with help-echo and mouse-movement
3272 events, we filter out repeated help-echo events, only store the
3273 first and last in a series of mouse-movement events, and don't
3274 store repeated help-echo events which are only separated by
3275 mouse-movement events. */
3277 Lisp_Object ev1
, ev2
, ev3
;
3280 if ((ix1
= recent_keys_index
- 1) < 0)
3281 ix1
= NUM_RECENT_KEYS
- 1;
3282 ev1
= AREF (recent_keys
, ix1
);
3284 if ((ix2
= ix1
- 1) < 0)
3285 ix2
= NUM_RECENT_KEYS
- 1;
3286 ev2
= AREF (recent_keys
, ix2
);
3288 if ((ix3
= ix2
- 1) < 0)
3289 ix3
= NUM_RECENT_KEYS
- 1;
3290 ev3
= AREF (recent_keys
, ix3
);
3292 if (EQ (XCAR (c
), Qhelp_echo
))
3294 /* Don't record `help-echo' in recent_keys unless it shows some help
3295 message, and a different help than the previously recorded
3297 Lisp_Object help
, last_help
;
3299 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3300 if (!STRINGP (help
))
3302 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3303 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3305 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3306 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3307 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3309 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3310 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3311 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3312 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3315 else if (EQ (XCAR (c
), Qmouse_movement
))
3317 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3318 So additional mouse movement events replace the last element. */
3319 Lisp_Object last_window
, window
;
3321 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3322 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3323 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3324 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3325 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3327 ASET (recent_keys
, ix1
, c
);
3333 store_kbd_macro_char (c
);
3338 ASET (recent_keys
, recent_keys_index
, c
);
3339 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3340 recent_keys_index
= 0;
3342 else if (recorded
< 0)
3344 /* We need to remove one or two events from recent_keys.
3345 To do this, we simply put nil at those events and move the
3346 recent_keys_index backwards over those events. Usually,
3347 users will never see those nil events, as they will be
3348 overwritten by the command keys entered to see recent_keys
3351 while (recorded
++ < 0 && total_keys
> 0)
3353 if (total_keys
< NUM_RECENT_KEYS
)
3355 if (--recent_keys_index
< 0)
3356 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3357 ASET (recent_keys
, recent_keys_index
, Qnil
);
3361 num_nonmacro_input_events
++;
3363 /* Write c to the dribble file. If c is a lispy event, write
3364 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3365 If you, dear reader, have a better idea, you've got the source. :-) */
3370 if (XUINT (c
) < 0x100)
3371 putc (XINT (c
), dribble
);
3373 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3377 Lisp_Object dribblee
;
3379 /* If it's a structured event, take the event header. */
3380 dribblee
= EVENT_HEAD (c
);
3382 if (SYMBOLP (dribblee
))
3384 putc ('<', dribble
);
3385 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3386 SBYTES (SYMBOL_NAME (dribblee
)),
3388 putc ('>', dribble
);
3400 struct buffer
*old
= current_buffer
;
3401 Fprinc (object
, Qnil
);
3402 set_buffer_internal (XBUFFER (Vstandard_output
));
3403 call0 (intern ("help-mode"));
3404 set_buffer_internal (old
);
3408 /* Copy out or in the info on where C-g should throw to.
3409 This is used when running Lisp code from within get_char,
3410 in case get_char is called recursively.
3411 See read_process_output. */
3417 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3421 restore_getcjmp (temp
)
3424 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3429 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3430 of this function. */
3433 tracking_off (old_value
)
3434 Lisp_Object old_value
;
3436 do_mouse_tracking
= old_value
;
3437 if (NILP (old_value
))
3439 /* Redisplay may have been preempted because there was input
3440 available, and it assumes it will be called again after the
3441 input has been processed. If the only input available was
3442 the sort that we have just disabled, then we need to call
3444 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3446 redisplay_preserve_echo_area (6);
3447 get_input_pending (&input_pending
,
3448 READABLE_EVENTS_DO_TIMERS_NOW
);
3454 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3455 doc
: /* Evaluate BODY with mouse movement events enabled.
3456 Within a `track-mouse' form, mouse motion generates input events that
3457 you can read with `read-event'.
3458 Normally, mouse motion is ignored.
3459 usage: (track-mouse BODY ...) */)
3463 int count
= SPECPDL_INDEX ();
3466 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3468 do_mouse_tracking
= Qt
;
3470 val
= Fprogn (args
);
3471 return unbind_to (count
, val
);
3474 /* If mouse has moved on some frame, return one of those frames.
3475 Return 0 otherwise. */
3480 Lisp_Object tail
, frame
;
3482 FOR_EACH_FRAME (tail
, frame
)
3484 if (XFRAME (frame
)->mouse_moved
)
3485 return XFRAME (frame
);
3491 #endif /* HAVE_MOUSE */
3493 /* Low level keyboard/mouse input.
3494 kbd_buffer_store_event places events in kbd_buffer, and
3495 kbd_buffer_get_event retrieves them. */
3497 /* Return true iff there are any events in the queue that read-char
3498 would return. If this returns false, a read-char would block. */
3500 readable_events (flags
)
3503 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3506 /* If the buffer contains only FOCUS_IN_EVENT events, and
3507 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3508 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3510 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3511 #ifdef USE_TOOLKIT_SCROLL_BARS
3512 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3516 struct input_event
*event
;
3518 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3525 #ifdef USE_TOOLKIT_SCROLL_BARS
3526 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3528 event
->kind
== FOCUS_IN_EVENT
)
3529 #ifdef USE_TOOLKIT_SCROLL_BARS
3530 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3531 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3532 && event
->part
== scroll_bar_handle
3533 && event
->modifiers
== 0)
3538 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3541 while (event
!= kbd_store_ptr
);
3548 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3549 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3554 if (current_kboard
->kbd_queue_has_data
)
3560 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3561 if (kb
->kbd_queue_has_data
)
3567 /* Set this for debugging, to have a way to get out */
3572 event_to_kboard (event
)
3573 struct input_event
*event
;
3576 frame
= event
->frame_or_window
;
3578 frame
= XCAR (frame
);
3579 else if (WINDOWP (frame
))
3580 frame
= WINDOW_FRAME (XWINDOW (frame
));
3582 /* There are still some events that don't set this field.
3583 For now, just ignore the problem.
3584 Also ignore dead frames here. */
3585 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3588 return FRAME_KBOARD (XFRAME (frame
));
3593 Lisp_Object Vthrow_on_input
;
3595 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3598 kbd_buffer_store_event (event
)
3599 register struct input_event
*event
;
3601 kbd_buffer_store_event_hold (event
, 0);
3604 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3606 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3607 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3608 Else, if EVENT is a quit event, store the quit event
3609 in HOLD_QUIT, and return (thus ignoring further events).
3611 This is used in read_avail_input to postpone the processing
3612 of the quit event until all subsequent input events have been
3613 parsed (and discarded).
3617 kbd_buffer_store_event_hold (event
, hold_quit
)
3618 register struct input_event
*event
;
3619 struct input_event
*hold_quit
;
3621 if (event
->kind
== NO_EVENT
)
3624 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3627 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3629 register int c
= event
->code
& 0377;
3631 if (event
->modifiers
& ctrl_modifier
)
3632 c
= make_ctrl_char (c
);
3634 c
|= (event
->modifiers
3635 & (meta_modifier
| alt_modifier
3636 | hyper_modifier
| super_modifier
));
3642 struct input_event
*sp
;
3645 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3646 kb
!= current_kboard
))
3649 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3650 Fcons (make_number (c
), Qnil
));
3651 kb
->kbd_queue_has_data
= 1;
3652 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3654 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3657 if (event_to_kboard (sp
) == kb
)
3659 sp
->kind
= NO_EVENT
;
3660 sp
->frame_or_window
= Qnil
;
3670 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3674 /* If this results in a quit_char being returned to Emacs as
3675 input, set Vlast_event_frame properly. If this doesn't
3676 get returned to Emacs as an event, the next event read
3677 will set Vlast_event_frame again, so this is safe to do. */
3681 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3683 focus
= event
->frame_or_window
;
3684 internal_last_event_frame
= focus
;
3685 Vlast_event_frame
= focus
;
3688 last_event_timestamp
= event
->timestamp
;
3689 handle_interrupt ();
3693 if (c
&& c
== stop_character
)
3699 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3700 Just ignore the second one. */
3701 else if (event
->kind
== BUFFER_SWITCH_EVENT
3702 && kbd_fetch_ptr
!= kbd_store_ptr
3703 && ((kbd_store_ptr
== kbd_buffer
3704 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3705 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3708 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3709 kbd_store_ptr
= kbd_buffer
;
3711 /* Don't let the very last slot in the buffer become full,
3712 since that would make the two pointers equal,
3713 and that is indistinguishable from an empty buffer.
3714 Discard the event if it would fill the last slot. */
3715 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3717 *kbd_store_ptr
= *event
;
3721 /* If we're inside while-no-input, and this event qualifies
3722 as input, set quit-flag to cause an interrupt. */
3723 if (!NILP (Vthrow_on_input
)
3724 && event
->kind
!= FOCUS_IN_EVENT
3725 && event
->kind
!= HELP_EVENT
3726 && event
->kind
!= DEICONIFY_EVENT
)
3728 Vquit_flag
= Vthrow_on_input
;
3729 /* If we're inside a function that wants immediate quits,
3731 if (immediate_quit
&& NILP (Vinhibit_quit
))
3741 /* Put an input event back in the head of the event queue. */
3744 kbd_buffer_unget_event (event
)
3745 register struct input_event
*event
;
3747 if (kbd_fetch_ptr
== kbd_buffer
)
3748 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3750 /* Don't let the very last slot in the buffer become full, */
3751 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3754 *kbd_fetch_ptr
= *event
;
3759 /* Generate HELP_EVENT input_events in BUFP which has room for
3760 SIZE events. If there's not enough room in BUFP, ignore this
3763 HELP is the help form.
3765 FRAME is the frame on which the help is generated. OBJECT is the
3766 Lisp object where the help was found (a buffer, a string, an
3767 overlay, or nil if neither from a string nor from a buffer. POS is
3768 the position within OBJECT where the help was found.
3770 Value is the number of input_events generated. */
3773 gen_help_event (help
, frame
, window
, object
, pos
)
3774 Lisp_Object help
, frame
, object
, window
;
3777 struct input_event event
;
3781 event
.kind
= HELP_EVENT
;
3782 event
.frame_or_window
= frame
;
3784 event
.x
= WINDOWP (window
) ? window
: frame
;
3787 kbd_buffer_store_event (&event
);
3791 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3794 kbd_buffer_store_help_event (frame
, help
)
3795 Lisp_Object frame
, help
;
3797 struct input_event event
;
3799 event
.kind
= HELP_EVENT
;
3800 event
.frame_or_window
= frame
;
3805 kbd_buffer_store_event (&event
);
3809 /* Discard any mouse events in the event buffer by setting them to
3812 discard_mouse_events ()
3814 struct input_event
*sp
;
3815 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3817 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3820 if (sp
->kind
== MOUSE_CLICK_EVENT
3821 || sp
->kind
== WHEEL_EVENT
3823 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3825 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3827 sp
->kind
= NO_EVENT
;
3833 /* Return non-zero if there are any real events waiting in the event
3834 buffer, not counting `NO_EVENT's.
3836 If DISCARD is non-zero, discard NO_EVENT events at the front of
3837 the input queue, possibly leaving the input queue empty if there
3838 are no real input events. */
3841 kbd_buffer_events_waiting (discard
)
3844 struct input_event
*sp
;
3846 for (sp
= kbd_fetch_ptr
;
3847 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3850 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3857 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3861 /* Clear input event EVENT. */
3865 struct input_event
*event
;
3867 event
->kind
= NO_EVENT
;
3871 /* Read one event from the event buffer, waiting if necessary.
3872 The value is a Lisp object representing the event.
3873 The value is nil for an event that should be ignored,
3874 or that was handled here.
3875 We always read and discard one event. */
3878 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3880 int *used_mouse_menu
;
3889 *kbp
= current_kboard
;
3893 /* Wait until there is input available. */
3896 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3899 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3903 /* If the quit flag is set, then read_char will return
3904 quit_char, so that counts as "available input." */
3905 if (!NILP (Vquit_flag
))
3906 quit_throw_to_read_char ();
3908 /* One way or another, wait until input is available; then, if
3909 interrupt handlers have not read it, read it now. */
3912 wait_for_kbd_input ();
3914 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3918 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3921 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3925 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3927 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3928 /* Pass 1 for EXPECT since we just waited to have input. */
3929 read_avail_input (1);
3931 #endif /* not VMS */
3934 if (CONSP (Vunread_command_events
))
3937 first
= XCAR (Vunread_command_events
);
3938 Vunread_command_events
= XCDR (Vunread_command_events
);
3939 *kbp
= current_kboard
;
3943 /* At this point, we know that there is a readable event available
3944 somewhere. If the event queue is empty, then there must be a
3945 mouse movement enabled and available. */
3946 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3948 struct input_event
*event
;
3950 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3954 last_event_timestamp
= event
->timestamp
;
3957 *kbp
= event_to_kboard (event
);
3959 *kbp
= current_kboard
; /* Better than returning null ptr? */
3961 *kbp
= &the_only_kboard
;
3966 /* These two kinds of events get special handling
3967 and don't actually appear to the command loop.
3968 We return nil for them. */
3969 if (event
->kind
== SELECTION_REQUEST_EVENT
3970 || event
->kind
== SELECTION_CLEAR_EVENT
)
3973 struct input_event copy
;
3975 /* Remove it from the buffer before processing it,
3976 since otherwise swallow_events will see it
3977 and process it again. */
3979 kbd_fetch_ptr
= event
+ 1;
3980 input_pending
= readable_events (0);
3981 x_handle_selection_event (©
);
3983 /* We're getting selection request events, but we don't have
3989 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3990 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3992 /* Make an event (delete-frame (FRAME)). */
3993 obj
= Fcons (event
->frame_or_window
, Qnil
);
3994 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3995 kbd_fetch_ptr
= event
+ 1;
3998 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3999 else if (event
->kind
== ICONIFY_EVENT
)
4001 /* Make an event (iconify-frame (FRAME)). */
4002 obj
= Fcons (event
->frame_or_window
, Qnil
);
4003 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4004 kbd_fetch_ptr
= event
+ 1;
4006 else if (event
->kind
== DEICONIFY_EVENT
)
4008 /* Make an event (make-frame-visible (FRAME)). */
4009 obj
= Fcons (event
->frame_or_window
, Qnil
);
4010 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4011 kbd_fetch_ptr
= event
+ 1;
4014 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4016 /* The value doesn't matter here; only the type is tested. */
4017 XSETBUFFER (obj
, current_buffer
);
4018 kbd_fetch_ptr
= event
+ 1;
4020 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4021 || defined (USE_GTK)
4022 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4024 kbd_fetch_ptr
= event
+ 1;
4025 input_pending
= readable_events (0);
4026 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4027 x_activate_menubar (XFRAME (event
->frame_or_window
));
4030 #if defined (WINDOWSNT) || defined (MAC_OS)
4031 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4034 /* Make an event (language-change (KEY_SCRIPT)). */
4035 obj
= Fcons (make_number (event
->code
), Qnil
);
4037 /* Make an event (language-change (FRAME CHARSET LCID)). */
4038 obj
= Fcons (event
->frame_or_window
, Qnil
);
4040 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4041 kbd_fetch_ptr
= event
+ 1;
4044 else if (event
->kind
== SAVE_SESSION_EVENT
)
4046 obj
= Fcons (Qsave_session
, Qnil
);
4047 kbd_fetch_ptr
= event
+ 1;
4049 /* Just discard these, by returning nil.
4050 With MULTI_KBOARD, these events are used as placeholders
4051 when we need to randomly delete events from the queue.
4052 (They shouldn't otherwise be found in the buffer,
4053 but on some machines it appears they do show up
4054 even without MULTI_KBOARD.) */
4055 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4056 mouse events during a popup-menu call. */
4057 else if (event
->kind
== NO_EVENT
)
4058 kbd_fetch_ptr
= event
+ 1;
4059 else if (event
->kind
== HELP_EVENT
)
4061 Lisp_Object object
, position
, help
, frame
, window
;
4063 frame
= event
->frame_or_window
;
4064 object
= event
->arg
;
4065 position
= make_number (event
->code
);
4068 clear_event (event
);
4070 kbd_fetch_ptr
= event
+ 1;
4071 if (!WINDOWP (window
))
4073 obj
= Fcons (Qhelp_echo
,
4074 list5 (frame
, help
, window
, object
, position
));
4076 else if (event
->kind
== FOCUS_IN_EVENT
)
4078 /* Notification of a FocusIn event. The frame receiving the
4079 focus is in event->frame_or_window. Generate a
4080 switch-frame event if necessary. */
4081 Lisp_Object frame
, focus
;
4083 frame
= event
->frame_or_window
;
4084 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4088 if (!EQ (frame
, internal_last_event_frame
)
4089 && !EQ (frame
, selected_frame
))
4090 obj
= make_lispy_switch_frame (frame
);
4091 internal_last_event_frame
= frame
;
4092 kbd_fetch_ptr
= event
+ 1;
4096 /* If this event is on a different frame, return a switch-frame this
4097 time, and leave the event in the queue for next time. */
4101 frame
= event
->frame_or_window
;
4103 frame
= XCAR (frame
);
4104 else if (WINDOWP (frame
))
4105 frame
= WINDOW_FRAME (XWINDOW (frame
));
4107 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4111 if (! EQ (frame
, internal_last_event_frame
)
4112 && !EQ (frame
, selected_frame
))
4113 obj
= make_lispy_switch_frame (frame
);
4114 internal_last_event_frame
= frame
;
4116 /* If we didn't decide to make a switch-frame event, go ahead
4117 and build a real event from the queue entry. */
4121 obj
= make_lispy_event (event
);
4123 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4124 || defined (USE_GTK)
4125 /* If this was a menu selection, then set the flag to inhibit
4126 writing to last_nonmenu_event. Don't do this if the event
4127 we're returning is (menu-bar), though; that indicates the
4128 beginning of the menu sequence, and we might as well leave
4129 that as the `event with parameters' for this selection. */
4131 && !EQ (event
->frame_or_window
, event
->arg
)
4132 && (event
->kind
== MENU_BAR_EVENT
4133 || event
->kind
== TOOL_BAR_EVENT
))
4134 *used_mouse_menu
= 1;
4137 /* Wipe out this event, to catch bugs. */
4138 clear_event (event
);
4139 kbd_fetch_ptr
= event
+ 1;
4144 /* Try generating a mouse motion event. */
4145 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4147 FRAME_PTR f
= some_mouse_moved ();
4148 Lisp_Object bar_window
;
4149 enum scroll_bar_part part
;
4153 *kbp
= current_kboard
;
4154 /* Note that this uses F to determine which display to look at.
4155 If there is no valid info, it does not store anything
4156 so x remains nil. */
4159 /* XXX Can f or mouse_position_hook be NULL here? */
4160 if (f
&& FRAME_DISPLAY (f
)->mouse_position_hook
)
4161 (*FRAME_DISPLAY (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4162 &part
, &x
, &y
, &time
);
4166 /* Decide if we should generate a switch-frame event. Don't
4167 generate switch-frame events for motion outside of all Emacs
4173 frame
= FRAME_FOCUS_FRAME (f
);
4175 XSETFRAME (frame
, f
);
4177 if (! EQ (frame
, internal_last_event_frame
)
4178 && !EQ (frame
, selected_frame
))
4179 obj
= make_lispy_switch_frame (frame
);
4180 internal_last_event_frame
= frame
;
4183 /* If we didn't decide to make a switch-frame event, go ahead and
4184 return a mouse-motion event. */
4185 if (!NILP (x
) && NILP (obj
))
4186 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4188 #endif /* HAVE_MOUSE */
4190 /* We were promised by the above while loop that there was
4191 something for us to read! */
4194 input_pending
= readable_events (0);
4196 Vlast_event_frame
= internal_last_event_frame
;
4201 /* Process any events that are not user-visible,
4202 then return, without reading any user-visible events. */
4205 swallow_events (do_display
)
4210 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4212 struct input_event
*event
;
4214 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4218 last_event_timestamp
= event
->timestamp
;
4220 /* These two kinds of events get special handling
4221 and don't actually appear to the command loop. */
4222 if (event
->kind
== SELECTION_REQUEST_EVENT
4223 || event
->kind
== SELECTION_CLEAR_EVENT
)
4226 struct input_event copy
;
4228 /* Remove it from the buffer before processing it,
4229 since otherwise swallow_events called recursively could see it
4230 and process it again. */
4232 kbd_fetch_ptr
= event
+ 1;
4233 input_pending
= readable_events (0);
4234 x_handle_selection_event (©
);
4236 /* We're getting selection request events, but we don't have
4245 old_timers_run
= timers_run
;
4246 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4248 if (timers_run
!= old_timers_run
&& do_display
)
4249 redisplay_preserve_echo_area (7);
4252 /* Record the start of when Emacs is idle,
4253 for the sake of running idle-time timers. */
4260 /* If we are already in the idle state, do nothing. */
4261 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4264 EMACS_GET_TIME (timer_idleness_start_time
);
4266 timer_last_idleness_start_time
= timer_idleness_start_time
;
4268 /* Mark all idle-time timers as once again candidates for running. */
4269 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4273 timer
= XCAR (timers
);
4275 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4277 XVECTOR (timer
)->contents
[0] = Qnil
;
4281 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4286 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4289 /* Resume idle timer from last idle start time. */
4292 timer_resume_idle ()
4294 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4297 timer_idleness_start_time
= timer_last_idleness_start_time
;
4300 /* This is only for debugging. */
4301 struct input_event last_timer_event
;
4303 /* Check whether a timer has fired. To prevent larger problems we simply
4304 disregard elements that are not proper timers. Do not make a circular
4305 timer list for the time being.
4307 Returns the number of seconds to wait until the next timer fires. If a
4308 timer is triggering now, return zero seconds.
4309 If no timer is active, return -1 seconds.
4311 If a timer is ripe, we run it, with quitting turned off.
4313 DO_IT_NOW is now ignored. It used to mean that we should
4314 run the timer directly instead of queueing a timer-event.
4315 Now we always run timers directly. */
4318 timer_check (do_it_now
)
4321 EMACS_TIME nexttime
;
4322 EMACS_TIME now
, idleness_now
;
4323 Lisp_Object timers
, idle_timers
, chosen_timer
;
4324 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4326 EMACS_SET_SECS (nexttime
, -1);
4327 EMACS_SET_USECS (nexttime
, -1);
4329 /* Always consider the ordinary timers. */
4330 timers
= Vtimer_list
;
4331 /* Consider the idle timers only if Emacs is idle. */
4332 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4333 idle_timers
= Vtimer_idle_list
;
4336 chosen_timer
= Qnil
;
4337 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4339 if (CONSP (timers
) || CONSP (idle_timers
))
4341 EMACS_GET_TIME (now
);
4342 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4343 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4346 while (CONSP (timers
) || CONSP (idle_timers
))
4348 Lisp_Object
*vector
;
4349 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4350 EMACS_TIME timer_time
, idle_timer_time
;
4351 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4353 /* Skip past invalid timers and timers already handled. */
4356 timer
= XCAR (timers
);
4357 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4359 timers
= XCDR (timers
);
4362 vector
= XVECTOR (timer
)->contents
;
4364 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4365 || !INTEGERP (vector
[3])
4366 || ! NILP (vector
[0]))
4368 timers
= XCDR (timers
);
4372 if (!NILP (idle_timers
))
4374 timer
= XCAR (idle_timers
);
4375 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4377 idle_timers
= XCDR (idle_timers
);
4380 vector
= XVECTOR (timer
)->contents
;
4382 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4383 || !INTEGERP (vector
[3])
4384 || ! NILP (vector
[0]))
4386 idle_timers
= XCDR (idle_timers
);
4391 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4392 based on the next ordinary timer.
4393 TIMER_DIFFERENCE is the distance in time from NOW to when
4394 this timer becomes ripe (negative if it's already ripe). */
4397 timer
= XCAR (timers
);
4398 vector
= XVECTOR (timer
)->contents
;
4399 EMACS_SET_SECS (timer_time
,
4400 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4401 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4402 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4405 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4406 based on the next idle timer. */
4407 if (!NILP (idle_timers
))
4409 idle_timer
= XCAR (idle_timers
);
4410 vector
= XVECTOR (idle_timer
)->contents
;
4411 EMACS_SET_SECS (idle_timer_time
,
4412 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4413 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4414 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4417 /* Decide which timer is the next timer,
4418 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4419 Also step down the list where we found that timer. */
4421 if (! NILP (timers
) && ! NILP (idle_timers
))
4424 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4425 if (EMACS_TIME_NEG_P (temp
))
4427 chosen_timer
= timer
;
4428 timers
= XCDR (timers
);
4429 difference
= timer_difference
;
4433 chosen_timer
= idle_timer
;
4434 idle_timers
= XCDR (idle_timers
);
4435 difference
= idle_timer_difference
;
4438 else if (! NILP (timers
))
4440 chosen_timer
= timer
;
4441 timers
= XCDR (timers
);
4442 difference
= timer_difference
;
4446 chosen_timer
= idle_timer
;
4447 idle_timers
= XCDR (idle_timers
);
4448 difference
= idle_timer_difference
;
4450 vector
= XVECTOR (chosen_timer
)->contents
;
4452 /* If timer is ripe, run it if it hasn't been run. */
4453 if (EMACS_TIME_NEG_P (difference
)
4454 || (EMACS_SECS (difference
) == 0
4455 && EMACS_USECS (difference
) == 0))
4457 if (NILP (vector
[0]))
4459 int was_locked
= single_kboard
;
4460 int count
= SPECPDL_INDEX ();
4461 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4463 /* Mark the timer as triggered to prevent problems if the lisp
4464 code fails to reschedule it right. */
4467 specbind (Qinhibit_quit
, Qt
);
4469 call1 (Qtimer_event_handler
, chosen_timer
);
4470 Vdeactivate_mark
= old_deactivate_mark
;
4472 unbind_to (count
, Qnil
);
4474 /* Resume allowing input from any kboard, if that was true before. */
4476 any_kboard_state ();
4478 /* Since we have handled the event,
4479 we don't need to tell the caller to wake up and do it. */
4483 /* When we encounter a timer that is still waiting,
4484 return the amount of time to wait before it is ripe. */
4491 /* No timers are pending in the future. */
4492 /* Return 0 if we generated an event, and -1 if not. */
4497 /* Caches for modify_event_symbol. */
4498 static Lisp_Object accent_key_syms
;
4499 static Lisp_Object func_key_syms
;
4500 static Lisp_Object mouse_syms
;
4501 static Lisp_Object wheel_syms
;
4502 static Lisp_Object drag_n_drop_syms
;
4504 /* This is a list of keysym codes for special "accent" characters.
4505 It parallels lispy_accent_keys. */
4507 static int lispy_accent_codes
[] =
4509 #ifdef XK_dead_circumflex
4514 #ifdef XK_dead_grave
4519 #ifdef XK_dead_tilde
4524 #ifdef XK_dead_diaeresis
4529 #ifdef XK_dead_macron
4534 #ifdef XK_dead_degree
4539 #ifdef XK_dead_acute
4544 #ifdef XK_dead_cedilla
4549 #ifdef XK_dead_breve
4554 #ifdef XK_dead_ogonek
4559 #ifdef XK_dead_caron
4564 #ifdef XK_dead_doubleacute
4565 XK_dead_doubleacute
,
4569 #ifdef XK_dead_abovedot
4574 #ifdef XK_dead_abovering
4584 #ifdef XK_dead_belowdot
4589 #ifdef XK_dead_voiced_sound
4590 XK_dead_voiced_sound
,
4594 #ifdef XK_dead_semivoiced_sound
4595 XK_dead_semivoiced_sound
,
4611 /* This is a list of Lisp names for special "accent" characters.
4612 It parallels lispy_accent_codes. */
4614 static char *lispy_accent_keys
[] =
4632 "dead-voiced-sound",
4633 "dead-semivoiced-sound",
4639 #define FUNCTION_KEY_OFFSET 0x0
4641 char *lispy_function_keys
[] =
4645 0, /* VK_LBUTTON 0x01 */
4646 0, /* VK_RBUTTON 0x02 */
4647 "cancel", /* VK_CANCEL 0x03 */
4648 0, /* VK_MBUTTON 0x04 */
4650 0, 0, 0, /* 0x05 .. 0x07 */
4652 "backspace", /* VK_BACK 0x08 */
4653 "tab", /* VK_TAB 0x09 */
4655 0, 0, /* 0x0A .. 0x0B */
4657 "clear", /* VK_CLEAR 0x0C */
4658 "return", /* VK_RETURN 0x0D */
4660 0, 0, /* 0x0E .. 0x0F */
4662 0, /* VK_SHIFT 0x10 */
4663 0, /* VK_CONTROL 0x11 */
4664 0, /* VK_MENU 0x12 */
4665 "pause", /* VK_PAUSE 0x13 */
4666 "capslock", /* VK_CAPITAL 0x14 */
4668 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4670 "escape", /* VK_ESCAPE 0x1B */
4672 0, 0, 0, 0, /* 0x1C .. 0x1F */
4674 0, /* VK_SPACE 0x20 */
4675 "prior", /* VK_PRIOR 0x21 */
4676 "next", /* VK_NEXT 0x22 */
4677 "end", /* VK_END 0x23 */
4678 "home", /* VK_HOME 0x24 */
4679 "left", /* VK_LEFT 0x25 */
4680 "up", /* VK_UP 0x26 */
4681 "right", /* VK_RIGHT 0x27 */
4682 "down", /* VK_DOWN 0x28 */
4683 "select", /* VK_SELECT 0x29 */
4684 "print", /* VK_PRINT 0x2A */
4685 "execute", /* VK_EXECUTE 0x2B */
4686 "snapshot", /* VK_SNAPSHOT 0x2C */
4687 "insert", /* VK_INSERT 0x2D */
4688 "delete", /* VK_DELETE 0x2E */
4689 "help", /* VK_HELP 0x2F */
4691 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4693 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4695 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4697 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4699 0, 0, 0, 0, 0, 0, 0, 0, 0,
4700 0, 0, 0, 0, 0, 0, 0, 0, 0,
4701 0, 0, 0, 0, 0, 0, 0, 0,
4703 "lwindow", /* VK_LWIN 0x5B */
4704 "rwindow", /* VK_RWIN 0x5C */
4705 "apps", /* VK_APPS 0x5D */
4707 0, 0, /* 0x5E .. 0x5F */
4709 "kp-0", /* VK_NUMPAD0 0x60 */
4710 "kp-1", /* VK_NUMPAD1 0x61 */
4711 "kp-2", /* VK_NUMPAD2 0x62 */
4712 "kp-3", /* VK_NUMPAD3 0x63 */
4713 "kp-4", /* VK_NUMPAD4 0x64 */
4714 "kp-5", /* VK_NUMPAD5 0x65 */
4715 "kp-6", /* VK_NUMPAD6 0x66 */
4716 "kp-7", /* VK_NUMPAD7 0x67 */
4717 "kp-8", /* VK_NUMPAD8 0x68 */
4718 "kp-9", /* VK_NUMPAD9 0x69 */
4719 "kp-multiply", /* VK_MULTIPLY 0x6A */
4720 "kp-add", /* VK_ADD 0x6B */
4721 "kp-separator", /* VK_SEPARATOR 0x6C */
4722 "kp-subtract", /* VK_SUBTRACT 0x6D */
4723 "kp-decimal", /* VK_DECIMAL 0x6E */
4724 "kp-divide", /* VK_DIVIDE 0x6F */
4725 "f1", /* VK_F1 0x70 */
4726 "f2", /* VK_F2 0x71 */
4727 "f3", /* VK_F3 0x72 */
4728 "f4", /* VK_F4 0x73 */
4729 "f5", /* VK_F5 0x74 */
4730 "f6", /* VK_F6 0x75 */
4731 "f7", /* VK_F7 0x76 */
4732 "f8", /* VK_F8 0x77 */
4733 "f9", /* VK_F9 0x78 */
4734 "f10", /* VK_F10 0x79 */
4735 "f11", /* VK_F11 0x7A */
4736 "f12", /* VK_F12 0x7B */
4737 "f13", /* VK_F13 0x7C */
4738 "f14", /* VK_F14 0x7D */
4739 "f15", /* VK_F15 0x7E */
4740 "f16", /* VK_F16 0x7F */
4741 "f17", /* VK_F17 0x80 */
4742 "f18", /* VK_F18 0x81 */
4743 "f19", /* VK_F19 0x82 */
4744 "f20", /* VK_F20 0x83 */
4745 "f21", /* VK_F21 0x84 */
4746 "f22", /* VK_F22 0x85 */
4747 "f23", /* VK_F23 0x86 */
4748 "f24", /* VK_F24 0x87 */
4750 0, 0, 0, 0, /* 0x88 .. 0x8B */
4751 0, 0, 0, 0, /* 0x8C .. 0x8F */
4753 "kp-numlock", /* VK_NUMLOCK 0x90 */
4754 "scroll", /* VK_SCROLL 0x91 */
4756 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4757 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4758 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4759 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4760 "kp-end", /* VK_NUMPAD_END 0x96 */
4761 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4762 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4763 "kp-up", /* VK_NUMPAD_UP 0x99 */
4764 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4765 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4766 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4767 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4769 0, 0, /* 0x9E .. 0x9F */
4772 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4773 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4774 * No other API or message will distinguish left and right keys this way.
4778 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4779 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4780 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4781 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4782 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4788 "attn", /* VK_ATTN 0xF6 */
4789 "crsel", /* VK_CRSEL 0xF7 */
4790 "exsel", /* VK_EXSEL 0xF8 */
4791 "ereof", /* VK_EREOF 0xF9 */
4792 "play", /* VK_PLAY 0xFA */
4793 "zoom", /* VK_ZOOM 0xFB */
4794 "noname", /* VK_NONAME 0xFC */
4795 "pa1", /* VK_PA1 0xFD */
4796 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4800 #else /* not HAVE_NTGUI */
4802 /* This should be dealt with in XTread_socket now, and that doesn't
4803 depend on the client system having the Kana syms defined. See also
4804 the XK_kana_A case below. */
4807 static char *lispy_kana_keys
[] =
4809 /* X Keysym value */
4810 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4811 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4812 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4813 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4814 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4815 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4816 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4817 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4818 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4819 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4820 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4821 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4822 "kana-i", "kana-u", "kana-e", "kana-o",
4823 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4824 "prolongedsound", "kana-A", "kana-I", "kana-U",
4825 "kana-E", "kana-O", "kana-KA", "kana-KI",
4826 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4827 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4828 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4829 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4830 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4831 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4832 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4833 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4834 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4835 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4836 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4837 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4839 #endif /* XK_kana_A */
4842 #define FUNCTION_KEY_OFFSET 0xff00
4844 /* You'll notice that this table is arranged to be conveniently
4845 indexed by X Windows keysym values. */
4846 static char *lispy_function_keys
[] =
4848 /* X Keysym value */
4850 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4851 "backspace", "tab", "linefeed", "clear",
4853 0, 0, 0, "pause", /* 0xff10...1f */
4854 0, 0, 0, 0, 0, 0, 0, "escape",
4856 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4857 "romaji", "hiragana", "katakana", "hiragana-katakana",
4858 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4859 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4860 "eisu-toggle", /* 0xff30...3f */
4861 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4862 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4864 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4865 "down", "prior", "next", "end",
4866 "begin", 0, 0, 0, 0, 0, 0, 0,
4867 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4878 "break", /* 0xff6b */
4881 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4882 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4883 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4884 0, 0, 0, 0, 0, 0, 0, 0,
4885 "kp-tab", /* 0xff89 */
4887 "kp-enter", /* 0xff8d */
4889 "kp-f1", /* 0xff91 */
4893 "kp-home", /* 0xff95 */
4898 "kp-prior", /* kp-page-up */
4899 "kp-next", /* kp-page-down */
4905 0, 0, 0, 0, 0, 0, 0, 0, 0,
4906 "kp-multiply", /* 0xffaa */
4911 "kp-divide", /* 0xffaf */
4912 "kp-0", /* 0xffb0 */
4913 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4916 "kp-equal", /* 0xffbd */
4917 "f1", /* 0xffbe */ /* IsFunctionKey */
4919 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4920 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4921 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4922 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4923 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4924 0, 0, 0, 0, 0, 0, 0, 0,
4925 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4926 0, 0, 0, 0, 0, 0, 0, "delete"
4929 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4930 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4932 static char *iso_lispy_function_keys
[] =
4934 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4935 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4936 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4937 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4938 "iso-lefttab", /* 0xfe20 */
4939 "iso-move-line-up", "iso-move-line-down",
4940 "iso-partial-line-up", "iso-partial-line-down",
4941 "iso-partial-space-left", "iso-partial-space-right",
4942 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4943 "iso-release-margin-left", "iso-release-margin-right",
4944 "iso-release-both-margins",
4945 "iso-fast-cursor-left", "iso-fast-cursor-right",
4946 "iso-fast-cursor-up", "iso-fast-cursor-down",
4947 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4948 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4951 #endif /* not HAVE_NTGUI */
4953 Lisp_Object Vlispy_mouse_stem
;
4955 static char *lispy_wheel_names
[] =
4957 "wheel-up", "wheel-down"
4960 /* drag-n-drop events are generated when a set of selected files are
4961 dragged from another application and dropped onto an Emacs window. */
4962 static char *lispy_drag_n_drop_names
[] =
4967 /* Scroll bar parts. */
4968 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4969 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4970 Lisp_Object Qtop
, Qratio
;
4972 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4973 Lisp_Object
*scroll_bar_parts
[] = {
4974 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4975 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4978 /* User signal events. */
4979 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4981 Lisp_Object
*lispy_user_signals
[] =
4983 &Qusr1_signal
, &Qusr2_signal
4987 /* A vector, indexed by button number, giving the down-going location
4988 of currently depressed buttons, both scroll bar and non-scroll bar.
4990 The elements have the form
4991 (BUTTON-NUMBER MODIFIER-MASK . REST)
4992 where REST is the cdr of a position as it would be reported in the event.
4994 The make_lispy_event function stores positions here to tell the
4995 difference between click and drag events, and to store the starting
4996 location to be included in drag events. */
4998 static Lisp_Object button_down_location
;
5000 /* Information about the most recent up-going button event: Which
5001 button, what location, and what time. */
5003 static int last_mouse_button
;
5004 static int last_mouse_x
;
5005 static int last_mouse_y
;
5006 static unsigned long button_down_time
;
5008 /* The maximum time between clicks to make a double-click, or Qnil to
5009 disable double-click detection, or Qt for no time limit. */
5011 Lisp_Object Vdouble_click_time
;
5013 /* Maximum number of pixels the mouse may be moved between clicks
5014 to make a double-click. */
5016 EMACS_INT double_click_fuzz
;
5018 /* The number of clicks in this multiple-click. */
5020 int double_click_count
;
5022 /* Return position of a mouse click or wheel event */
5025 make_lispy_position (f
, x
, y
, time
)
5031 enum window_part part
;
5032 Lisp_Object posn
= Qnil
;
5033 Lisp_Object extra_info
= Qnil
;
5036 /* Set `window' to the window under frame pixel coordinates (x,y) */
5038 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5039 &part
, &wx
, &wy
, 0);
5043 if (WINDOWP (window
))
5045 /* It's a click in window window at frame coordinates (x,y) */
5046 struct window
*w
= XWINDOW (window
);
5047 Lisp_Object string_info
= Qnil
;
5048 int textpos
= -1, rx
= -1, ry
= -1;
5049 int dx
= -1, dy
= -1;
5050 int width
= -1, height
= -1;
5051 Lisp_Object object
= Qnil
;
5053 /* Set event coordinates to window-relative coordinates
5054 for constructing the Lisp event below. */
5058 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5060 /* Mode line or header line. Look for a string under
5061 the mouse that may have a `local-map' property. */
5065 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5067 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5068 &object
, &dx
, &dy
, &width
, &height
);
5069 if (STRINGP (string
))
5070 string_info
= Fcons (string
, make_number (charpos
));
5071 if (w
== XWINDOW (selected_window
))
5074 textpos
= XMARKER (w
->pointm
)->charpos
;
5076 else if (part
== ON_VERTICAL_BORDER
)
5078 posn
= Qvertical_line
;
5083 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5088 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5090 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5091 &object
, &dx
, &dy
, &width
, &height
);
5092 if (STRINGP (string
))
5093 string_info
= Fcons (string
, make_number (charpos
));
5095 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
5097 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
5100 if (part
== ON_RIGHT_FRINGE
)
5101 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5102 + window_box_width (w
, TEXT_AREA
)
5103 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5104 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5106 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5107 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5112 Lisp_Object string2
, object2
= Qnil
;
5113 struct display_pos p
;
5115 int width2
, height2
;
5116 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5117 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5118 &object2
, &dx2
, &dy2
,
5120 textpos
= CHARPOS (p
.pos
);
5121 if (rx
< 0) rx
= wx
;
5122 if (ry
< 0) ry
= wy
;
5123 if (dx
< 0) dx
= dx2
;
5124 if (dy
< 0) dy
= dy2
;
5125 if (width
< 0) width
= width2
;
5126 if (height
< 0) height
= height2
;
5130 posn
= make_number (textpos
);
5131 if (STRINGP (string2
))
5132 string_info
= Fcons (string2
,
5133 make_number (CHARPOS (p
.string_pos
)));
5139 #ifdef HAVE_WINDOW_SYSTEM
5140 if (IMAGEP (object
))
5142 Lisp_Object image_map
, hotspot
;
5143 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5145 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5147 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5148 posn
= XCAR (hotspot
);
5153 extra_info
= Fcons (object
,
5154 Fcons (Fcons (make_number (dx
),
5156 Fcons (Fcons (make_number (width
),
5157 make_number (height
)),
5161 extra_info
= Fcons (string_info
,
5162 Fcons (make_number (textpos
),
5163 Fcons (Fcons (make_number (rx
),
5169 XSETFRAME (window
, f
);
5174 XSETFASTINT (*x
, 0);
5175 XSETFASTINT (*y
, 0);
5178 return Fcons (window
,
5180 Fcons (Fcons (*x
, *y
),
5181 Fcons (make_number (time
),
5185 /* Given a struct input_event, build the lisp event which represents
5186 it. If EVENT is 0, build a mouse movement event from the mouse
5187 movement buffer, which should have a movement event in it.
5189 Note that events must be passed to this function in the order they
5190 are received; this function stores the location of button presses
5191 in order to build drag events when the button is released. */
5194 make_lispy_event (event
)
5195 struct input_event
*event
;
5199 switch (SWITCH_ENUM_CAST (event
->kind
))
5201 /* A simple keystroke. */
5202 case ASCII_KEYSTROKE_EVENT
:
5204 Lisp_Object lispy_c
;
5205 int c
= event
->code
& 0377;
5206 /* Turn ASCII characters into control characters
5208 if (event
->modifiers
& ctrl_modifier
)
5209 c
= make_ctrl_char (c
);
5211 /* Add in the other modifier bits. We took care of ctrl_modifier
5212 just above, and the shift key was taken care of by the X code,
5213 and applied to control characters by make_ctrl_char. */
5214 c
|= (event
->modifiers
5215 & (meta_modifier
| alt_modifier
5216 | hyper_modifier
| super_modifier
));
5217 /* Distinguish Shift-SPC from SPC. */
5218 if ((event
->code
& 0377) == 040
5219 && event
->modifiers
& shift_modifier
)
5220 c
|= shift_modifier
;
5221 button_down_time
= 0;
5222 XSETFASTINT (lispy_c
, c
);
5226 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5228 Lisp_Object lispy_c
;
5229 int c
= event
->code
;
5231 /* Add in the other modifier bits. We took care of ctrl_modifier
5232 just above, and the shift key was taken care of by the X code,
5233 and applied to control characters by make_ctrl_char. */
5234 c
|= (event
->modifiers
5235 & (meta_modifier
| alt_modifier
5236 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5237 /* What about the `shift' modifier ? */
5238 button_down_time
= 0;
5239 XSETFASTINT (lispy_c
, c
);
5243 /* A function key. The symbol may need to have modifier prefixes
5245 case NON_ASCII_KEYSTROKE_EVENT
:
5246 button_down_time
= 0;
5248 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5249 if (event
->code
== lispy_accent_codes
[i
])
5250 return modify_event_symbol (i
,
5252 Qfunction_key
, Qnil
,
5253 lispy_accent_keys
, &accent_key_syms
,
5254 (sizeof (lispy_accent_keys
)
5255 / sizeof (lispy_accent_keys
[0])));
5259 if (event
->code
>= 0x400 && event
->code
< 0x500)
5260 return modify_event_symbol (event
->code
- 0x400,
5261 event
->modifiers
& ~shift_modifier
,
5262 Qfunction_key
, Qnil
,
5263 lispy_kana_keys
, &func_key_syms
,
5264 (sizeof (lispy_kana_keys
)
5265 / sizeof (lispy_kana_keys
[0])));
5266 #endif /* XK_kana_A */
5269 #ifdef ISO_FUNCTION_KEY_OFFSET
5270 if (event
->code
< FUNCTION_KEY_OFFSET
5271 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5272 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5274 Qfunction_key
, Qnil
,
5275 iso_lispy_function_keys
, &func_key_syms
,
5276 (sizeof (iso_lispy_function_keys
)
5277 / sizeof (iso_lispy_function_keys
[0])));
5280 /* Handle system-specific or unknown keysyms. */
5281 if (event
->code
& (1 << 28)
5282 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5283 || (event
->code
- FUNCTION_KEY_OFFSET
5284 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5285 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5287 /* We need to use an alist rather than a vector as the cache
5288 since we can't make a vector long enuf. */
5289 if (NILP (current_kboard
->system_key_syms
))
5290 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5291 return modify_event_symbol (event
->code
,
5294 current_kboard
->Vsystem_key_alist
,
5295 0, ¤t_kboard
->system_key_syms
,
5299 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5301 Qfunction_key
, Qnil
,
5302 lispy_function_keys
, &func_key_syms
,
5303 (sizeof (lispy_function_keys
)
5304 / sizeof (lispy_function_keys
[0])));
5307 /* A mouse click. Figure out where it is, decide whether it's
5308 a press, click or drag, and build the appropriate structure. */
5309 case MOUSE_CLICK_EVENT
:
5310 #ifndef USE_TOOLKIT_SCROLL_BARS
5311 case SCROLL_BAR_CLICK_EVENT
:
5314 int button
= event
->code
;
5316 Lisp_Object position
;
5317 Lisp_Object
*start_pos_ptr
;
5318 Lisp_Object start_pos
;
5322 /* Build the position as appropriate for this mouse click. */
5323 if (event
->kind
== MOUSE_CLICK_EVENT
)
5325 struct frame
*f
= XFRAME (event
->frame_or_window
);
5326 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5330 /* Ignore mouse events that were made on frame that
5331 have been deleted. */
5332 if (! FRAME_LIVE_P (f
))
5335 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5336 /* EVENT->x and EVENT->y are frame-relative pixel
5337 coordinates at this place. Under old redisplay, COLUMN
5338 and ROW are set to frame relative glyph coordinates
5339 which are then used to determine whether this click is
5340 in a menu (non-toolkit version). */
5341 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5342 &column
, &row
, NULL
, 1);
5344 /* In the non-toolkit version, clicks on the menu bar
5345 are ordinary button events in the event buffer.
5346 Distinguish them, and invoke the menu.
5348 (In the toolkit version, the toolkit handles the menu bar
5349 and Emacs doesn't know about it until after the user
5350 makes a selection.) */
5351 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5352 && (event
->modifiers
& down_modifier
))
5354 Lisp_Object items
, item
;
5359 /* Activate the menu bar on the down event. If the
5360 up event comes in before the menu code can deal with it,
5362 if (! (event
->modifiers
& down_modifier
))
5366 /* Find the menu bar item under `column'. */
5368 items
= FRAME_MENU_BAR_ITEMS (f
);
5369 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5371 Lisp_Object pos
, string
;
5372 string
= AREF (items
, i
+ 1);
5373 pos
= AREF (items
, i
+ 3);
5376 if (column
>= XINT (pos
)
5377 && column
< XINT (pos
) + SCHARS (string
))
5379 item
= AREF (items
, i
);
5384 /* ELisp manual 2.4b says (x y) are window relative but
5385 code says they are frame-relative. */
5387 = Fcons (event
->frame_or_window
,
5389 Fcons (Fcons (event
->x
, event
->y
),
5390 Fcons (make_number (event
->timestamp
),
5393 return Fcons (item
, Fcons (position
, Qnil
));
5395 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5397 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5400 #ifndef USE_TOOLKIT_SCROLL_BARS
5403 /* It's a scrollbar click. */
5405 Lisp_Object portion_whole
;
5408 window
= event
->frame_or_window
;
5409 portion_whole
= Fcons (event
->x
, event
->y
);
5410 part
= *scroll_bar_parts
[(int) event
->part
];
5414 Fcons (Qvertical_scroll_bar
,
5415 Fcons (portion_whole
,
5416 Fcons (make_number (event
->timestamp
),
5417 Fcons (part
, Qnil
)))));
5419 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5421 if (button
>= ASIZE (button_down_location
))
5423 button_down_location
= larger_vector (button_down_location
,
5425 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5428 start_pos_ptr
= &AREF (button_down_location
, button
);
5429 start_pos
= *start_pos_ptr
;
5430 *start_pos_ptr
= Qnil
;
5433 /* On window-system frames, use the value of
5434 double-click-fuzz as is. On other frames, interpret it
5435 as a multiple of 1/8 characters. */
5439 if (WINDOWP (event
->frame_or_window
))
5440 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5441 else if (FRAMEP (event
->frame_or_window
))
5442 f
= XFRAME (event
->frame_or_window
);
5446 if (FRAME_WINDOW_P (f
))
5447 fuzz
= double_click_fuzz
;
5449 fuzz
= double_click_fuzz
/ 8;
5451 is_double
= (button
== last_mouse_button
5452 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5453 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5454 && button_down_time
!= 0
5455 && (EQ (Vdouble_click_time
, Qt
)
5456 || (INTEGERP (Vdouble_click_time
)
5457 && ((int)(event
->timestamp
- button_down_time
)
5458 < XINT (Vdouble_click_time
)))));
5461 last_mouse_button
= button
;
5462 last_mouse_x
= XINT (event
->x
);
5463 last_mouse_y
= XINT (event
->y
);
5465 /* If this is a button press, squirrel away the location, so
5466 we can decide later whether it was a click or a drag. */
5467 if (event
->modifiers
& down_modifier
)
5471 double_click_count
++;
5472 event
->modifiers
|= ((double_click_count
> 2)
5477 double_click_count
= 1;
5478 button_down_time
= event
->timestamp
;
5479 *start_pos_ptr
= Fcopy_alist (position
);
5482 /* Now we're releasing a button - check the co-ordinates to
5483 see if this was a click or a drag. */
5484 else if (event
->modifiers
& up_modifier
)
5486 /* If we did not see a down before this up, ignore the up.
5487 Probably this happened because the down event chose a
5488 menu item. It would be an annoyance to treat the
5489 release of the button that chose the menu item as a
5492 if (!CONSP (start_pos
))
5495 event
->modifiers
&= ~up_modifier
;
5496 #if 0 /* Formerly we treated an up with no down as a click event. */
5497 if (!CONSP (start_pos
))
5498 event
->modifiers
|= click_modifier
;
5503 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5505 /* The third element of every position
5506 should be the (x,y) pair. */
5507 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5509 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5511 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5512 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5515 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5516 && ydiff
< double_click_fuzz
5517 && ydiff
> - double_click_fuzz
)
5518 /* Mouse hasn't moved (much). */
5519 event
->modifiers
|= click_modifier
;
5522 button_down_time
= 0;
5523 event
->modifiers
|= drag_modifier
;
5526 /* Don't check is_double; treat this as multiple
5527 if the down-event was multiple. */
5528 if (double_click_count
> 1)
5529 event
->modifiers
|= ((double_click_count
> 2)
5535 /* Every mouse event should either have the down_modifier or
5536 the up_modifier set. */
5540 /* Get the symbol we should use for the mouse click. */
5543 head
= modify_event_symbol (button
,
5545 Qmouse_click
, Vlispy_mouse_stem
,
5548 XVECTOR (mouse_syms
)->size
);
5549 if (event
->modifiers
& drag_modifier
)
5554 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5557 Fcons (make_number (double_click_count
),
5568 Lisp_Object position
;
5571 /* Build the position as appropriate for this mouse click. */
5572 struct frame
*f
= XFRAME (event
->frame_or_window
);
5574 /* Ignore wheel events that were made on frame that have been
5576 if (! FRAME_LIVE_P (f
))
5579 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5582 /* Set double or triple modifiers to indicate the wheel speed. */
5584 /* On window-system frames, use the value of
5585 double-click-fuzz as is. On other frames, interpret it
5586 as a multiple of 1/8 characters. */
5591 if (WINDOWP (event
->frame_or_window
))
5592 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5593 else if (FRAMEP (event
->frame_or_window
))
5594 f
= XFRAME (event
->frame_or_window
);
5598 if (FRAME_WINDOW_P (f
))
5599 fuzz
= double_click_fuzz
;
5601 fuzz
= double_click_fuzz
/ 8;
5603 is_double
= (last_mouse_button
< 0
5604 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5605 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5606 && button_down_time
!= 0
5607 && (EQ (Vdouble_click_time
, Qt
)
5608 || (INTEGERP (Vdouble_click_time
)
5609 && ((int)(event
->timestamp
- button_down_time
)
5610 < XINT (Vdouble_click_time
)))));
5613 double_click_count
++;
5614 event
->modifiers
|= ((double_click_count
> 2)
5620 double_click_count
= 1;
5621 event
->modifiers
|= click_modifier
;
5624 button_down_time
= event
->timestamp
;
5625 /* Use a negative value to distinguish wheel from mouse button. */
5626 last_mouse_button
= -1;
5627 last_mouse_x
= XINT (event
->x
);
5628 last_mouse_y
= XINT (event
->y
);
5634 if (event
->modifiers
& up_modifier
)
5636 /* Emit a wheel-up event. */
5637 event
->modifiers
&= ~up_modifier
;
5640 else if (event
->modifiers
& down_modifier
)
5642 /* Emit a wheel-down event. */
5643 event
->modifiers
&= ~down_modifier
;
5647 /* Every wheel event should either have the down_modifier or
5648 the up_modifier set. */
5651 /* Get the symbol we should use for the wheel event. */
5652 head
= modify_event_symbol (symbol_num
,
5658 ASIZE (wheel_syms
));
5661 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5664 Fcons (make_number (double_click_count
),
5673 #ifdef USE_TOOLKIT_SCROLL_BARS
5675 /* We don't have down and up events if using toolkit scroll bars,
5676 so make this always a click event. Store in the `part' of
5677 the Lisp event a symbol which maps to the following actions:
5679 `above_handle' page up
5680 `below_handle' page down
5684 `bottom' bottom of buffer
5685 `handle' thumb has been dragged.
5686 `end-scroll' end of interaction with scroll bar
5688 The incoming input_event contains in its `part' member an
5689 index of type `enum scroll_bar_part' which we can use as an
5690 index in scroll_bar_parts to get the appropriate symbol. */
5692 case SCROLL_BAR_CLICK_EVENT
:
5694 Lisp_Object position
, head
, window
, portion_whole
, part
;
5696 window
= event
->frame_or_window
;
5697 portion_whole
= Fcons (event
->x
, event
->y
);
5698 part
= *scroll_bar_parts
[(int) event
->part
];
5702 Fcons (Qvertical_scroll_bar
,
5703 Fcons (portion_whole
,
5704 Fcons (make_number (event
->timestamp
),
5705 Fcons (part
, Qnil
)))));
5707 /* Always treat scroll bar events as clicks. */
5708 event
->modifiers
|= click_modifier
;
5709 event
->modifiers
&= ~up_modifier
;
5711 if (event
->code
>= ASIZE (mouse_syms
))
5712 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5714 /* Get the symbol we should use for the mouse click. */
5715 head
= modify_event_symbol (event
->code
,
5720 XVECTOR (mouse_syms
)->size
);
5721 return Fcons (head
, Fcons (position
, Qnil
));
5724 #endif /* USE_TOOLKIT_SCROLL_BARS */
5727 case W32_SCROLL_BAR_CLICK_EVENT
:
5729 int button
= event
->code
;
5731 Lisp_Object position
;
5732 Lisp_Object
*start_pos_ptr
;
5733 Lisp_Object start_pos
;
5737 Lisp_Object portion_whole
;
5740 window
= event
->frame_or_window
;
5741 portion_whole
= Fcons (event
->x
, event
->y
);
5742 part
= *scroll_bar_parts
[(int) event
->part
];
5746 Fcons (Qvertical_scroll_bar
,
5747 Fcons (portion_whole
,
5748 Fcons (make_number (event
->timestamp
),
5749 Fcons (part
, Qnil
)))));
5752 /* Always treat W32 scroll bar events as clicks. */
5753 event
->modifiers
|= click_modifier
;
5756 /* Get the symbol we should use for the mouse click. */
5759 head
= modify_event_symbol (button
,
5764 XVECTOR (mouse_syms
)->size
);
5770 #endif /* WINDOWSNT */
5772 case DRAG_N_DROP_EVENT
:
5775 Lisp_Object head
, position
;
5778 /* The frame_or_window field should be a cons of the frame in
5779 which the event occurred and a list of the filenames
5781 if (! CONSP (event
->frame_or_window
))
5784 f
= XFRAME (XCAR (event
->frame_or_window
));
5785 files
= XCDR (event
->frame_or_window
);
5787 /* Ignore mouse events that were made on frames that
5788 have been deleted. */
5789 if (! FRAME_LIVE_P (f
))
5792 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5795 head
= modify_event_symbol (0, event
->modifiers
,
5797 lispy_drag_n_drop_names
,
5798 &drag_n_drop_syms
, 1);
5804 #endif /* HAVE_MOUSE */
5806 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5807 || defined (USE_GTK)
5808 case MENU_BAR_EVENT
:
5809 if (EQ (event
->arg
, event
->frame_or_window
))
5810 /* This is the prefix key. We translate this to
5811 `(menu_bar)' because the code in keyboard.c for menu
5812 events, which we use, relies on this. */
5813 return Fcons (Qmenu_bar
, Qnil
);
5817 case SELECT_WINDOW_EVENT
:
5818 /* Make an event (select-window (WINDOW)). */
5819 return Fcons (Qselect_window
,
5820 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5823 case TOOL_BAR_EVENT
:
5824 if (EQ (event
->arg
, event
->frame_or_window
))
5825 /* This is the prefix key. We translate this to
5826 `(tool_bar)' because the code in keyboard.c for tool bar
5827 events, which we use, relies on this. */
5828 return Fcons (Qtool_bar
, Qnil
);
5829 else if (SYMBOLP (event
->arg
))
5830 return apply_modifiers (event
->modifiers
, event
->arg
);
5833 case USER_SIGNAL_EVENT
:
5834 /* A user signal. */
5835 return *lispy_user_signals
[event
->code
];
5837 case SAVE_SESSION_EVENT
:
5838 return Qsave_session
;
5840 /* The 'kind' field of the event is something we don't recognize. */
5849 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5851 Lisp_Object bar_window
;
5852 enum scroll_bar_part part
;
5856 /* Is it a scroll bar movement? */
5857 if (frame
&& ! NILP (bar_window
))
5859 Lisp_Object part_sym
;
5861 part_sym
= *scroll_bar_parts
[(int) part
];
5862 return Fcons (Qscroll_bar_movement
,
5863 (Fcons (Fcons (bar_window
,
5864 Fcons (Qvertical_scroll_bar
,
5865 Fcons (Fcons (x
, y
),
5866 Fcons (make_number (time
),
5872 /* Or is it an ordinary mouse movement? */
5875 Lisp_Object position
;
5877 position
= make_lispy_position (frame
, &x
, &y
, time
);
5879 return Fcons (Qmouse_movement
,
5885 #endif /* HAVE_MOUSE */
5887 /* Construct a switch frame event. */
5889 make_lispy_switch_frame (frame
)
5892 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5895 /* Manipulating modifiers. */
5897 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5899 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5900 SYMBOL's name of the end of the modifiers; the string from this
5901 position is the unmodified symbol name.
5903 This doesn't use any caches. */
5906 parse_modifiers_uncached (symbol
, modifier_end
)
5914 CHECK_SYMBOL (symbol
);
5917 name
= SYMBOL_NAME (symbol
);
5919 for (i
= 0; i
+2 <= SBYTES (name
); )
5921 int this_mod_end
= 0;
5924 /* See if the name continues with a modifier word.
5925 Check that the word appears, but don't check what follows it.
5926 Set this_mod and this_mod_end to record what we find. */
5928 switch (SREF (name
, i
))
5930 #define SINGLE_LETTER_MOD(BIT) \
5931 (this_mod_end = i + 1, this_mod = BIT)
5934 SINGLE_LETTER_MOD (alt_modifier
);
5938 SINGLE_LETTER_MOD (ctrl_modifier
);
5942 SINGLE_LETTER_MOD (hyper_modifier
);
5946 SINGLE_LETTER_MOD (meta_modifier
);
5950 SINGLE_LETTER_MOD (shift_modifier
);
5954 SINGLE_LETTER_MOD (super_modifier
);
5957 #undef SINGLE_LETTER_MOD
5959 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5960 if (i + LEN + 1 <= SBYTES (name) \
5961 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5963 this_mod_end = i + LEN; \
5968 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5969 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5970 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5974 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5976 #undef MULTI_LETTER_MOD
5980 /* If we found no modifier, stop looking for them. */
5981 if (this_mod_end
== 0)
5984 /* Check there is a dash after the modifier, so that it
5985 really is a modifier. */
5986 if (this_mod_end
>= SBYTES (name
)
5987 || SREF (name
, this_mod_end
) != '-')
5990 /* This modifier is real; look for another. */
5991 modifiers
|= this_mod
;
5992 i
= this_mod_end
+ 1;
5995 /* Should we include the `click' modifier? */
5996 if (! (modifiers
& (down_modifier
| drag_modifier
5997 | double_modifier
| triple_modifier
))
5998 && i
+ 7 == SBYTES (name
)
5999 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6000 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6001 modifiers
|= click_modifier
;
6009 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6010 prepended to the string BASE[0..BASE_LEN-1].
6011 This doesn't use any caches. */
6013 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6016 int base_len
, base_len_byte
;
6018 /* Since BASE could contain nulls, we can't use intern here; we have
6019 to use Fintern, which expects a genuine Lisp_String, and keeps a
6022 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6028 /* Only the event queue may use the `up' modifier; it should always
6029 be turned into a click or drag event before presented to lisp code. */
6030 if (modifiers
& up_modifier
)
6033 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6034 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6035 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6036 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6037 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6038 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6039 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6040 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6041 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6042 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6043 /* The click modifier is denoted by the absence of other modifiers. */
6047 mod_len
= p
- new_mods
;
6051 Lisp_Object new_name
;
6053 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6054 mod_len
+ base_len_byte
);
6055 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6056 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6058 return Fintern (new_name
, Qnil
);
6063 static char *modifier_names
[] =
6065 "up", "down", "drag", "click", "double", "triple", 0, 0,
6066 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6067 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6069 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6071 static Lisp_Object modifier_symbols
;
6073 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6075 lispy_modifier_list (modifiers
)
6078 Lisp_Object modifier_list
;
6081 modifier_list
= Qnil
;
6082 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6083 if (modifiers
& (1<<i
))
6084 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6087 return modifier_list
;
6091 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6092 where UNMODIFIED is the unmodified form of SYMBOL,
6093 MASK is the set of modifiers present in SYMBOL's name.
6094 This is similar to parse_modifiers_uncached, but uses the cache in
6095 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6096 Qevent_symbol_elements property. */
6099 parse_modifiers (symbol
)
6102 Lisp_Object elements
;
6104 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6105 if (CONSP (elements
))
6110 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6111 Lisp_Object unmodified
;
6114 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6115 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6118 if (modifiers
& ~INTMASK
)
6120 XSETFASTINT (mask
, modifiers
);
6121 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6123 /* Cache the parsing results on SYMBOL. */
6124 Fput (symbol
, Qevent_symbol_element_mask
,
6126 Fput (symbol
, Qevent_symbol_elements
,
6127 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6129 /* Since we know that SYMBOL is modifiers applied to unmodified,
6130 it would be nice to put that in unmodified's cache.
6131 But we can't, since we're not sure that parse_modifiers is
6138 /* Apply the modifiers MODIFIERS to the symbol BASE.
6139 BASE must be unmodified.
6141 This is like apply_modifiers_uncached, but uses BASE's
6142 Qmodifier_cache property, if present. It also builds
6143 Qevent_symbol_elements properties, since it has that info anyway.
6145 apply_modifiers copies the value of BASE's Qevent_kind property to
6146 the modified symbol. */
6148 apply_modifiers (modifiers
, base
)
6152 Lisp_Object cache
, index
, entry
, new_symbol
;
6154 /* Mask out upper bits. We don't know where this value's been. */
6155 modifiers
&= INTMASK
;
6157 /* The click modifier never figures into cache indices. */
6158 cache
= Fget (base
, Qmodifier_cache
);
6159 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6160 entry
= assq_no_quit (index
, cache
);
6163 new_symbol
= XCDR (entry
);
6166 /* We have to create the symbol ourselves. */
6167 new_symbol
= apply_modifiers_uncached (modifiers
,
6168 SDATA (SYMBOL_NAME (base
)),
6169 SCHARS (SYMBOL_NAME (base
)),
6170 SBYTES (SYMBOL_NAME (base
)));
6172 /* Add the new symbol to the base's cache. */
6173 entry
= Fcons (index
, new_symbol
);
6174 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6176 /* We have the parsing info now for free, so we could add it to
6178 XSETFASTINT (index, modifiers);
6179 Fput (new_symbol, Qevent_symbol_element_mask,
6180 Fcons (base, Fcons (index, Qnil)));
6181 Fput (new_symbol, Qevent_symbol_elements,
6182 Fcons (base, lispy_modifier_list (modifiers)));
6183 Sadly, this is only correct if `base' is indeed a base event,
6184 which is not necessarily the case. -stef */
6187 /* Make sure this symbol is of the same kind as BASE.
6189 You'd think we could just set this once and for all when we
6190 intern the symbol above, but reorder_modifiers may call us when
6191 BASE's property isn't set right; we can't assume that just
6192 because it has a Qmodifier_cache property it must have its
6193 Qevent_kind set right as well. */
6194 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6198 kind
= Fget (base
, Qevent_kind
);
6200 Fput (new_symbol
, Qevent_kind
, kind
);
6207 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6208 return a symbol with the modifiers placed in the canonical order.
6209 Canonical order is alphabetical, except for down and drag, which
6210 always come last. The 'click' modifier is never written out.
6212 Fdefine_key calls this to make sure that (for example) C-M-foo
6213 and M-C-foo end up being equivalent in the keymap. */
6216 reorder_modifiers (symbol
)
6219 /* It's hopefully okay to write the code this way, since everything
6220 will soon be in caches, and no consing will be done at all. */
6223 parsed
= parse_modifiers (symbol
);
6224 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6229 /* For handling events, we often want to produce a symbol whose name
6230 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6231 to some base, like the name of a function key or mouse button.
6232 modify_event_symbol produces symbols of this sort.
6234 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6235 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6238 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6239 into symbol names, or a string specifying a name stem used to
6240 construct a symbol name or the form `STEM-N', where N is the decimal
6241 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6242 non-nil; otherwise NAME_TABLE is used.
6244 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6245 persist between calls to modify_event_symbol that it can use to
6246 store a cache of the symbols it's generated for this NAME_TABLE
6247 before. The object stored there may be a vector or an alist.
6249 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6251 MODIFIERS is a set of modifier bits (as given in struct input_events)
6252 whose prefixes should be applied to the symbol name.
6254 SYMBOL_KIND is the value to be placed in the event_kind property of
6255 the returned symbol.
6257 The symbols we create are supposed to have an
6258 `event-symbol-elements' property, which lists the modifiers present
6259 in the symbol's name. */
6262 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6263 name_table
, symbol_table
, table_size
)
6266 Lisp_Object symbol_kind
;
6267 Lisp_Object name_alist_or_stem
;
6269 Lisp_Object
*symbol_table
;
6270 unsigned int table_size
;
6273 Lisp_Object symbol_int
;
6275 /* Get rid of the "vendor-specific" bit here. */
6276 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6278 /* Is this a request for a valid symbol? */
6279 if (symbol_num
< 0 || symbol_num
>= table_size
)
6282 if (CONSP (*symbol_table
))
6283 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6285 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6286 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6287 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6288 we've never used that symbol before. */
6291 if (! VECTORP (*symbol_table
)
6292 || XVECTOR (*symbol_table
)->size
!= table_size
)
6296 XSETFASTINT (size
, table_size
);
6297 *symbol_table
= Fmake_vector (size
, Qnil
);
6300 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6303 /* Have we already used this symbol before? */
6306 /* No; let's create it. */
6307 if (CONSP (name_alist_or_stem
))
6308 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6309 else if (STRINGP (name_alist_or_stem
))
6311 int len
= SBYTES (name_alist_or_stem
);
6312 char *buf
= (char *) alloca (len
+ 50);
6313 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6314 (long) XINT (symbol_int
) + 1);
6315 value
= intern (buf
);
6317 else if (name_table
!= 0 && name_table
[symbol_num
])
6318 value
= intern (name_table
[symbol_num
]);
6320 #ifdef HAVE_WINDOW_SYSTEM
6323 char *name
= x_get_keysym_name (symbol_num
);
6325 value
= intern (name
);
6332 sprintf (buf
, "key-%d", symbol_num
);
6333 value
= intern (buf
);
6336 if (CONSP (*symbol_table
))
6337 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6339 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6341 /* Fill in the cache entries for this symbol; this also
6342 builds the Qevent_symbol_elements property, which the user
6344 apply_modifiers (modifiers
& click_modifier
, value
);
6345 Fput (value
, Qevent_kind
, symbol_kind
);
6348 /* Apply modifiers to that symbol. */
6349 return apply_modifiers (modifiers
, value
);
6352 /* Convert a list that represents an event type,
6353 such as (ctrl meta backspace), into the usual representation of that
6354 event type as a number or a symbol. */
6356 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6357 doc
: /* Convert the event description list EVENT-DESC to an event type.
6358 EVENT-DESC should contain one base event type (a character or symbol)
6359 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6360 drag, down, double or triple). The base must be last.
6361 The return value is an event type (a character or symbol) which
6362 has the same base event type and all the specified modifiers. */)
6364 Lisp_Object event_desc
;
6372 while (CONSP (rest
))
6380 /* Given a symbol, see if it is a modifier name. */
6381 if (SYMBOLP (elt
) && CONSP (rest
))
6382 this = parse_solitary_modifier (elt
);
6386 else if (!NILP (base
))
6387 error ("Two bases given in one event");
6393 /* Let the symbol A refer to the character A. */
6394 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6395 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6397 if (INTEGERP (base
))
6399 /* Turn (shift a) into A. */
6400 if ((modifiers
& shift_modifier
) != 0
6401 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6403 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6404 modifiers
&= ~shift_modifier
;
6407 /* Turn (control a) into C-a. */
6408 if (modifiers
& ctrl_modifier
)
6409 return make_number ((modifiers
& ~ctrl_modifier
)
6410 | make_ctrl_char (XINT (base
)));
6412 return make_number (modifiers
| XINT (base
));
6414 else if (SYMBOLP (base
))
6415 return apply_modifiers (modifiers
, base
);
6418 error ("Invalid base event");
6423 /* Try to recognize SYMBOL as a modifier name.
6424 Return the modifier flag bit, or 0 if not recognized. */
6427 parse_solitary_modifier (symbol
)
6430 Lisp_Object name
= SYMBOL_NAME (symbol
);
6432 switch (SREF (name
, 0))
6434 #define SINGLE_LETTER_MOD(BIT) \
6435 if (SBYTES (name) == 1) \
6438 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6439 if (LEN == SBYTES (name) \
6440 && ! strncmp (SDATA (name), NAME, LEN)) \
6444 SINGLE_LETTER_MOD (alt_modifier
);
6448 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6452 SINGLE_LETTER_MOD (ctrl_modifier
);
6456 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6457 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6461 SINGLE_LETTER_MOD (hyper_modifier
);
6465 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6469 SINGLE_LETTER_MOD (meta_modifier
);
6473 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6477 SINGLE_LETTER_MOD (shift_modifier
);
6481 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6482 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6483 SINGLE_LETTER_MOD (super_modifier
);
6487 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6488 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6489 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6493 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6496 #undef SINGLE_LETTER_MOD
6497 #undef MULTI_LETTER_MOD
6503 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6504 Such a list is not valid as an event,
6505 but it can be a Lucid-style event type list. */
6508 lucid_event_type_list_p (object
)
6513 if (! CONSP (object
))
6516 if (EQ (XCAR (object
), Qhelp_echo
)
6517 || EQ (XCAR (object
), Qvertical_line
)
6518 || EQ (XCAR (object
), Qmode_line
)
6519 || EQ (XCAR (object
), Qheader_line
))
6522 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6526 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6533 /* Store into *addr a value nonzero if terminal input chars are available.
6534 Serves the purpose of ioctl (0, FIONREAD, addr)
6535 but works even if FIONREAD does not exist.
6536 (In fact, this may actually read some input.)
6538 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6539 timer events that are ripe.
6540 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6541 events (FOCUS_IN_EVENT).
6542 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6543 movements and toolkit scroll bar thumb drags. */
6546 get_input_pending (addr
, flags
)
6550 /* First of all, have we already counted some input? */
6551 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6553 /* If input is being read as it arrives, and we have none, there is none. */
6554 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6557 /* Try to read some input and see how much we get. */
6559 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6562 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6565 gobble_input (expected
)
6570 if (interrupt_input
)
6573 mask
= sigblock (sigmask (SIGIO
));
6574 read_avail_input (expected
);
6578 #ifdef POLL_FOR_INPUT
6579 /* XXX This condition was (read_socket_hook && !interrupt_input),
6580 but read_socket_hook is not global anymore. Let's pretend that
6582 if (!interrupt_input
&& poll_suppress_count
== 0)
6585 mask
= sigblock (sigmask (SIGALRM
));
6586 read_avail_input (expected
);
6592 read_avail_input (expected
);
6596 /* Put a BUFFER_SWITCH_EVENT in the buffer
6597 so that read_key_sequence will notice the new current buffer. */
6600 record_asynch_buffer_change ()
6602 struct input_event event
;
6606 event
.kind
= BUFFER_SWITCH_EVENT
;
6607 event
.frame_or_window
= Qnil
;
6611 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6612 The purpose of the event is to make read_key_sequence look up the
6613 keymaps again. If we aren't in read_key_sequence, we don't need one,
6614 and the event could cause trouble by messing up (input-pending-p). */
6615 tem
= Fwaiting_for_user_input_p ();
6619 /* We never need these events if we have no asynchronous subprocesses. */
6623 /* Make sure no interrupt happens while storing the event. */
6625 if (interrupt_input
)
6628 mask
= sigblock (sigmask (SIGIO
));
6629 kbd_buffer_store_event (&event
);
6636 kbd_buffer_store_event (&event
);
6643 /* Read any terminal input already buffered up by the system
6644 into the kbd_buffer, but do not wait.
6646 EXPECTED should be nonzero if the caller knows there is some input.
6648 Except on VMS, all input is read by this function.
6649 If interrupt_input is nonzero, this function MUST be called
6650 only when SIGIO is blocked.
6652 Returns the number of keyboard chars read, or -1 meaning
6653 this is a bad time to try to read input. */
6656 read_avail_input (expected
)
6663 /* Loop through the available displays, and call their input hooks. */
6667 struct display
*next
= d
->next_display
;
6669 if (d
->read_socket_hook
)
6672 struct input_event hold_quit
;
6674 EVENT_INIT (hold_quit
);
6675 hold_quit
.kind
= NO_EVENT
;
6677 /* No need for FIONREAD or fcntl; just say don't wait. */
6678 while (nr
= (*d
->read_socket_hook
) (d
, expected
, &hold_quit
), nr
> 0)
6684 if (nr
== -1) /* Not OK to read input now. */
6688 else if (nr
== -2) /* Non-transient error. */
6690 /* The display device terminated; it should be closed. */
6692 /* Kill Emacs if this was our last display. */
6693 if (! display_list
->next_display
)
6694 /* Formerly simply reported no input, but that
6695 sometimes led to a failure of Emacs to terminate.
6696 SIGHUP seems appropriate if we can't reach the
6698 /* ??? Is it really right to send the signal just to
6699 this process rather than to the whole process
6700 group? Perhaps on systems with FIONREAD Emacs is
6701 alone in its group. */
6702 kill (getpid (), SIGHUP
);
6704 /* XXX Is calling delete_display safe here? It calls Fdelete_frame. */
6705 if (d
->delete_display_hook
)
6706 (*d
->delete_display_hook
) (d
);
6711 if (hold_quit
.kind
!= NO_EVENT
)
6712 kbd_buffer_store_event (&hold_quit
);
6724 /* This is the tty way of reading available input.
6726 Note that each terminal device has its own `struct display' object,
6727 and so this function is called once for each individual termcap
6728 display. The first parameter indicates which device to read from. */
6731 tty_read_avail_input (struct display
*display
,
6733 struct input_event
*hold_quit
)
6735 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6736 the kbd_buffer can really hold. That may prevent loss
6737 of characters on some systems when input is stuffed at us. */
6738 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6740 struct tty_display_info
*tty
= display
->display_info
.tty
;
6743 if (display
->type
!= output_termcap
)
6746 /* XXX I think the following code should be moved to separate hook
6747 functions in system-dependent files. */
6750 #else /* not WINDOWSNT */
6752 n_to_read
= dos_keysns ();
6756 cbuf
[0] = dos_keyread ();
6759 #else /* not MSDOS */
6761 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6765 return 0; /* The terminal is suspended. */
6767 /* Determine how many characters we should *try* to read. */
6769 /* Find out how much input is available. */
6770 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6772 if (! noninteractive
)
6773 return -2; /* Close this display. */
6779 if (n_to_read
> sizeof cbuf
)
6780 n_to_read
= sizeof cbuf
;
6781 #else /* no FIONREAD */
6782 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6783 /* Read some input if available, but don't wait. */
6784 n_to_read
= sizeof cbuf
;
6785 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6791 /* Now read; for one reason or another, this will not block.
6792 NREAD is set to the number of chars read. */
6795 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
6796 /* POSIX infers that processes which are not in the session leader's
6797 process group won't get SIGHUP's at logout time. BSDI adheres to
6798 this part standard and returns -1 from read (0) with errno==EIO
6799 when the control tty is taken away.
6800 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6801 if (nread
== -1 && errno
== EIO
)
6802 return -2; /* Close this display. */
6803 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6804 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6805 This looks incorrect, but it isn't, because _BSD causes
6806 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6807 and that causes a value other than 0 when there is no input. */
6809 return -2; /* Close this display. */
6813 /* We used to retry the read if it was interrupted.
6814 But this does the wrong thing when O_NDELAY causes
6815 an EAGAIN error. Does anybody know of a situation
6816 where a retry is actually needed? */
6818 nread
< 0 && (errno
== EAGAIN
6832 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6833 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6834 #endif /* USG or DGUX or CYGWIN */
6835 #endif /* no FIONREAD */
6840 #endif /* not MSDOS */
6841 #endif /* not WINDOWSNT */
6843 for (i
= 0; i
< nread
; i
++)
6845 struct input_event buf
;
6847 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6849 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
6850 buf
.modifiers
= meta_modifier
;
6851 if (tty
->meta_key
!= 2)
6855 /* Set the frame corresponding to the active tty. Note that the
6856 value of selected_frame is not reliable here, redisplay tends
6857 to temporarily change it. */
6858 buf
.frame_or_window
= tty
->top_frame
;
6861 kbd_buffer_store_event (&buf
);
6862 /* Don't look at input that follows a C-g too closely.
6863 This reduces lossage due to autorepeat on C-g. */
6864 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6865 && buf
.code
== quit_char
)
6871 #endif /* not VMS */
6874 handle_async_input ()
6877 extern int select_alarmed
;
6880 interrupt_input_pending
= 0;
6885 nread
= read_avail_input (1);
6886 /* -1 means it's not ok to read the input now.
6887 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6888 0 means there was no keyboard input available. */
6893 select_alarmed
= 1; /* Force the select emulator back to life */
6898 #ifdef SIGIO /* for entire page */
6899 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6902 input_available_signal (signo
)
6905 /* Must preserve main program's value of errno. */
6906 int old_errno
= errno
;
6907 #if defined (USG) && !defined (POSIX_SIGNALS)
6908 /* USG systems forget handlers when they are used;
6909 must reestablish each time */
6910 signal (signo
, input_available_signal
);
6918 interrupt_input_pending
= 1;
6920 SIGNAL_THREAD_CHECK (signo
);
6923 if (input_available_clear_time
)
6924 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6927 handle_async_input ();
6937 /* Send ourselves a SIGIO.
6939 This function exists so that the UNBLOCK_INPUT macro in
6940 blockinput.h can have some way to take care of input we put off
6941 dealing with, without assuming that every file which uses
6942 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6944 reinvoke_input_signal ()
6947 handle_async_input ();
6953 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6954 static Lisp_Object menu_bar_one_keymap_changed_items
;
6956 /* These variables hold the vector under construction within
6957 menu_bar_items and its subroutines, and the current index
6958 for storing into that vector. */
6959 static Lisp_Object menu_bar_items_vector
;
6960 static int menu_bar_items_index
;
6962 /* Return a vector of menu items for a menu bar, appropriate
6963 to the current buffer. Each item has three elements in the vector:
6966 OLD is an old vector we can optionally reuse, or nil. */
6969 menu_bar_items (old
)
6972 /* The number of keymaps we're scanning right now, and the number of
6973 keymaps we have allocated space for. */
6976 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6977 in the current keymaps, or nil where it is not a prefix. */
6980 Lisp_Object def
, tail
;
6989 struct gcpro gcpro1
;
6991 /* In order to build the menus, we need to call the keymap
6992 accessors. They all call QUIT. But this function is called
6993 during redisplay, during which a quit is fatal. So inhibit
6994 quitting while building the menus.
6995 We do this instead of specbind because (1) errors will clear it anyway
6996 and (2) this avoids risk of specpdl overflow. */
6997 oquit
= Vinhibit_quit
;
7001 menu_bar_items_vector
= old
;
7003 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7004 menu_bar_items_index
= 0;
7006 GCPRO1 (menu_bar_items_vector
);
7008 /* Build our list of keymaps.
7009 If we recognize a function key and replace its escape sequence in
7010 keybuf with its symbol, or if the sequence starts with a mouse
7011 click and we need to switch buffers, we jump back here to rebuild
7012 the initial keymaps from the current buffer. */
7016 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7017 if (!NILP (Voverriding_local_map_menu_flag
))
7019 /* Yes, use them (if non-nil) as well as the global map. */
7020 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7022 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7023 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7024 if (!NILP (Voverriding_local_map
))
7025 maps
[nmaps
++] = Voverriding_local_map
;
7029 /* No, so use major and minor mode keymaps and keymap property.
7030 Note that menu-bar bindings in the local-map and keymap
7031 properties may not work reliable, as they are only
7032 recognized when the menu-bar (or mode-line) is updated,
7033 which does not normally happen after every command. */
7036 nminor
= current_minor_maps (NULL
, &tmaps
);
7037 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7039 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7040 maps
[nmaps
++] = tem
;
7041 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7043 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7045 maps
[nmaps
++] = current_global_map
;
7048 /* Look up in each map the dummy prefix key `menu-bar'. */
7052 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7053 if (!NILP (maps
[mapno
]))
7055 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7059 menu_bar_one_keymap_changed_items
= Qnil
;
7060 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7064 /* Move to the end those items that should be at the end. */
7066 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7069 int end
= menu_bar_items_index
;
7071 for (i
= 0; i
< end
; i
+= 4)
7072 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7074 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7075 /* Move the item at index I to the end,
7076 shifting all the others forward. */
7077 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7078 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7079 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7080 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7082 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7083 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7084 (end
- i
- 4) * sizeof (Lisp_Object
));
7085 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7086 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7087 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7088 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7093 /* Add nil, nil, nil, nil at the end. */
7094 i
= menu_bar_items_index
;
7095 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7098 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7099 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7100 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7101 menu_bar_items_vector
= tem
;
7103 /* Add this item. */
7104 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7105 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7106 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7107 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7108 menu_bar_items_index
= i
;
7110 Vinhibit_quit
= oquit
;
7112 return menu_bar_items_vector
;
7115 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7116 If there's already an item for KEY, add this DEF to it. */
7118 Lisp_Object item_properties
;
7121 menu_bar_item (key
, item
, dummy1
, dummy2
)
7122 Lisp_Object key
, item
, dummy1
;
7125 struct gcpro gcpro1
;
7129 if (EQ (item
, Qundefined
))
7131 /* If a map has an explicit `undefined' as definition,
7132 discard any previously made menu bar item. */
7134 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7135 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7137 if (menu_bar_items_index
> i
+ 4)
7138 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7139 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7140 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7141 menu_bar_items_index
-= 4;
7145 /* If this keymap has already contributed to this KEY,
7146 don't contribute to it a second time. */
7147 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7148 if (!NILP (tem
) || NILP (item
))
7151 menu_bar_one_keymap_changed_items
7152 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7154 /* We add to menu_bar_one_keymap_changed_items before doing the
7155 parse_menu_item, so that if it turns out it wasn't a menu item,
7156 it still correctly hides any further menu item. */
7158 i
= parse_menu_item (item
, 0, 1);
7163 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7165 /* Find any existing item for this KEY. */
7166 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7167 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7170 /* If we did not find this KEY, add it at the end. */
7171 if (i
== menu_bar_items_index
)
7173 /* If vector is too small, get a bigger one. */
7174 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7177 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7178 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7179 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7180 menu_bar_items_vector
= tem
;
7183 /* Add this item. */
7184 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7185 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7186 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7187 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7188 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7189 menu_bar_items_index
= i
;
7191 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7195 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7196 /* If the new and the old items are not both keymaps,
7197 the lookup will only find `item'. */
7198 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7199 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7203 /* This is used as the handler when calling menu_item_eval_property. */
7205 menu_item_eval_property_1 (arg
)
7208 /* If we got a quit from within the menu computation,
7209 quit all the way out of it. This takes care of C-] in the debugger. */
7210 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7211 Fsignal (Qquit
, Qnil
);
7216 /* Evaluate an expression and return the result (or nil if something
7217 went wrong). Used to evaluate dynamic parts of menu items. */
7219 menu_item_eval_property (sexpr
)
7222 int count
= SPECPDL_INDEX ();
7224 specbind (Qinhibit_redisplay
, Qt
);
7225 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7226 menu_item_eval_property_1
);
7227 return unbind_to (count
, val
);
7230 /* This function parses a menu item and leaves the result in the
7231 vector item_properties.
7232 ITEM is a key binding, a possible menu item.
7233 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7234 evaluate dynamic expressions in the menu item.
7235 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7237 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7238 parse_menu_item returns true if the item is a menu item and false
7242 parse_menu_item (item
, notreal
, inmenubar
)
7244 int notreal
, inmenubar
;
7246 Lisp_Object def
, tem
, item_string
, start
;
7247 Lisp_Object cachelist
;
7249 Lisp_Object keyhint
;
7260 /* Create item_properties vector if necessary. */
7261 if (NILP (item_properties
))
7263 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7265 /* Initialize optional entries. */
7266 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7267 AREF (item_properties
, i
) = Qnil
;
7268 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7270 /* Save the item here to protect it from GC. */
7271 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7273 item_string
= XCAR (item
);
7277 if (STRINGP (item_string
))
7279 /* Old format menu item. */
7280 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7282 /* Maybe help string. */
7283 if (CONSP (item
) && STRINGP (XCAR (item
)))
7285 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7290 /* Maybe key binding cache. */
7291 if (CONSP (item
) && CONSP (XCAR (item
))
7292 && (NILP (XCAR (XCAR (item
)))
7293 || VECTORP (XCAR (XCAR (item
)))))
7295 cachelist
= XCAR (item
);
7299 /* This is the real definition--the function to run. */
7300 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7302 /* Get enable property, if any. */
7305 tem
= Fget (item
, Qmenu_enable
);
7307 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7310 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7312 /* New format menu item. */
7313 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7314 start
= XCDR (item
);
7317 /* We have a real binding. */
7318 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7320 item
= XCDR (start
);
7321 /* Is there a cache list with key equivalences. */
7322 if (CONSP (item
) && CONSP (XCAR (item
)))
7324 cachelist
= XCAR (item
);
7328 /* Parse properties. */
7329 while (CONSP (item
) && CONSP (XCDR (item
)))
7334 if (EQ (tem
, QCenable
))
7335 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7336 else if (EQ (tem
, QCvisible
) && !notreal
)
7338 /* If got a visible property and that evaluates to nil
7339 then ignore this item. */
7340 tem
= menu_item_eval_property (XCAR (item
));
7344 else if (EQ (tem
, QChelp
))
7345 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7346 else if (EQ (tem
, QCfilter
))
7348 else if (EQ (tem
, QCkey_sequence
))
7351 if (NILP (cachelist
)
7352 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7353 /* Be GC protected. Set keyhint to item instead of tem. */
7356 else if (EQ (tem
, QCkeys
))
7359 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7360 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7362 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7367 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7369 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7371 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7378 else if (inmenubar
|| !NILP (start
))
7382 return 0; /* not a menu item */
7384 /* If item string is not a string, evaluate it to get string.
7385 If we don't get a string, skip this item. */
7386 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7387 if (!(STRINGP (item_string
) || notreal
))
7389 item_string
= menu_item_eval_property (item_string
);
7390 if (!STRINGP (item_string
))
7392 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7395 /* If got a filter apply it on definition. */
7396 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7399 def
= menu_item_eval_property (list2 (XCAR (filter
),
7400 list2 (Qquote
, def
)));
7402 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7405 /* Enable or disable selection of item. */
7406 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7412 tem
= menu_item_eval_property (tem
);
7413 if (inmenubar
&& NILP (tem
))
7414 return 0; /* Ignore disabled items in menu bar. */
7415 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7418 /* If we got no definition, this item is just unselectable text which
7419 is OK in a submenu but not in the menubar. */
7421 return (inmenubar
? 0 : 1);
7423 /* See if this is a separate pane or a submenu. */
7424 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7425 tem
= get_keymap (def
, 0, 1);
7426 /* For a subkeymap, just record its details and exit. */
7429 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7430 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7434 /* At the top level in the menu bar, do likewise for commands also.
7435 The menu bar does not display equivalent key bindings anyway.
7436 ITEM_PROPERTY_DEF is already set up properly. */
7440 /* This is a command. See if there is an equivalent key binding. */
7441 if (NILP (cachelist
))
7443 /* We have to create a cachelist. */
7444 CHECK_IMPURE (start
);
7445 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7446 cachelist
= XCAR (XCDR (start
));
7448 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7449 if (!NILP (keyhint
))
7451 XSETCAR (cachelist
, XCAR (keyhint
));
7454 else if (STRINGP (tem
))
7456 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7457 XSETCAR (cachelist
, Qt
);
7461 tem
= XCAR (cachelist
);
7468 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7470 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7473 def
= XCAR (prefix
);
7474 prefix
= XCDR (prefix
);
7477 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7479 if (!update_menu_bindings
)
7481 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7483 if (newcache
/* Always check first time. */
7484 /* Should we check everything when precomputing key
7486 /* If something had no key binding before, don't recheck it
7487 because that is too slow--except if we have a list of
7488 rebound commands in Vdefine_key_rebound_commands, do
7489 recheck any command that appears in that list. */
7490 || (CONSP (Vdefine_key_rebound_commands
)
7491 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7494 /* We had a saved key. Is it still bound to the command? */
7497 /* If the command is an alias for another
7498 (such as lmenu.el set it up), check if the
7499 original command matches the cached command. */
7500 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7501 chkcache
= 1; /* Need to recompute key binding. */
7505 /* Recompute equivalent key binding. If the command is an alias
7506 for another (such as lmenu.el set it up), see if the original
7507 command name has equivalent keys. Otherwise look up the
7508 specified command itself. We don't try both, because that
7509 makes lmenu menus slow. */
7511 && SYMBOLP (XSYMBOL (def
)->function
)
7512 && ! NILP (Fget (def
, Qmenu_alias
)))
7513 def
= XSYMBOL (def
)->function
;
7514 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7515 XSETCAR (cachelist
, tem
);
7518 XSETCDR (cachelist
, Qnil
);
7522 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7524 tem
= XCAR (cachelist
);
7528 newcache
= chkcache
;
7531 tem
= Fkey_description (tem
, Qnil
);
7534 if (STRINGP (XCAR (prefix
)))
7535 tem
= concat2 (XCAR (prefix
), tem
);
7536 if (STRINGP (XCDR (prefix
)))
7537 tem
= concat2 (tem
, XCDR (prefix
));
7539 XSETCDR (cachelist
, tem
);
7543 tem
= XCDR (cachelist
);
7544 if (newcache
&& !NILP (tem
))
7546 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7547 XSETCDR (cachelist
, tem
);
7550 /* If we only want to precompute equivalent key bindings, stop here. */
7554 /* If we have an equivalent key binding, use that. */
7555 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7557 /* Include this when menu help is implemented.
7558 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7559 if (!(NILP (tem) || STRINGP (tem)))
7561 tem = menu_item_eval_property (tem);
7564 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7568 /* Handle radio buttons or toggle boxes. */
7569 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7571 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7572 = menu_item_eval_property (tem
);
7579 /***********************************************************************
7581 ***********************************************************************/
7583 /* A vector holding tool bar items while they are parsed in function
7584 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7587 static Lisp_Object tool_bar_items_vector
;
7589 /* A vector holding the result of parse_tool_bar_item. Layout is like
7590 the one for a single item in tool_bar_items_vector. */
7592 static Lisp_Object tool_bar_item_properties
;
7594 /* Next free index in tool_bar_items_vector. */
7596 static int ntool_bar_items
;
7598 /* The symbols `tool-bar', and `:image'. */
7600 extern Lisp_Object Qtool_bar
;
7601 Lisp_Object QCimage
;
7603 /* Function prototypes. */
7605 static void init_tool_bar_items
P_ ((Lisp_Object
));
7606 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7607 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7608 static void append_tool_bar_item
P_ ((void));
7611 /* Return a vector of tool bar items for keymaps currently in effect.
7612 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7613 tool bar items found. */
7616 tool_bar_items (reuse
, nitems
)
7627 /* In order to build the menus, we need to call the keymap
7628 accessors. They all call QUIT. But this function is called
7629 during redisplay, during which a quit is fatal. So inhibit
7630 quitting while building the menus. We do this instead of
7631 specbind because (1) errors will clear it anyway and (2) this
7632 avoids risk of specpdl overflow. */
7633 oquit
= Vinhibit_quit
;
7636 /* Initialize tool_bar_items_vector and protect it from GC. */
7637 init_tool_bar_items (reuse
);
7639 /* Build list of keymaps in maps. Set nmaps to the number of maps
7642 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7643 if (!NILP (Voverriding_local_map_menu_flag
))
7645 /* Yes, use them (if non-nil) as well as the global map. */
7646 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7648 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7649 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7650 if (!NILP (Voverriding_local_map
))
7651 maps
[nmaps
++] = Voverriding_local_map
;
7655 /* No, so use major and minor mode keymaps and keymap property.
7656 Note that tool-bar bindings in the local-map and keymap
7657 properties may not work reliable, as they are only
7658 recognized when the tool-bar (or mode-line) is updated,
7659 which does not normally happen after every command. */
7662 nminor
= current_minor_maps (NULL
, &tmaps
);
7663 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7665 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7666 maps
[nmaps
++] = tem
;
7667 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7669 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7672 /* Add global keymap at the end. */
7673 maps
[nmaps
++] = current_global_map
;
7675 /* Process maps in reverse order and look up in each map the prefix
7677 for (i
= nmaps
- 1; i
>= 0; --i
)
7678 if (!NILP (maps
[i
]))
7682 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7687 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7688 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7690 Lisp_Object keydef
= XCAR (tail
);
7692 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7697 Vinhibit_quit
= oquit
;
7698 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7699 return tool_bar_items_vector
;
7703 /* Process the definition of KEY which is DEF. */
7706 process_tool_bar_item (key
, def
)
7707 Lisp_Object key
, def
;
7710 extern Lisp_Object Qundefined
;
7711 struct gcpro gcpro1
, gcpro2
;
7713 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7717 if (EQ (def
, Qundefined
))
7719 /* If a map has an explicit `undefined' as definition,
7720 discard any previously made item. */
7721 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7723 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7725 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7727 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7728 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7729 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7730 * sizeof (Lisp_Object
)));
7731 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7736 else if (parse_tool_bar_item (key
, def
))
7737 /* Append a new tool bar item to tool_bar_items_vector. Accept
7738 more than one definition for the same key. */
7739 append_tool_bar_item ();
7745 /* Parse a tool bar item specification ITEM for key KEY and return the
7746 result in tool_bar_item_properties. Value is zero if ITEM is
7749 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7751 CAPTION is the caption of the item, If it's not a string, it is
7752 evaluated to get a string.
7754 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7755 as binding are currently ignored.
7757 The following properties are recognized:
7761 FORM is evaluated and specifies whether the tool bar item is
7762 enabled or disabled.
7766 FORM is evaluated and specifies whether the tool bar item is visible.
7768 - `:filter FUNCTION'
7770 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7771 result is stored as the new binding.
7773 - `:button (TYPE SELECTED)'
7775 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7776 and specifies whether the button is selected (pressed) or not.
7780 IMAGES is either a single image specification or a vector of four
7781 image specifications. See enum tool_bar_item_images.
7783 - `:help HELP-STRING'.
7785 Gives a help string to display for the tool bar item. */
7788 parse_tool_bar_item (key
, item
)
7789 Lisp_Object key
, item
;
7791 /* Access slot with index IDX of vector tool_bar_item_properties. */
7792 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7794 Lisp_Object filter
= Qnil
;
7795 Lisp_Object caption
;
7798 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7799 Rule out items that aren't lists, don't start with
7800 `menu-item' or whose rest following `tool-bar-item' is not a
7803 || !EQ (XCAR (item
), Qmenu_item
)
7804 || (item
= XCDR (item
),
7808 /* Create tool_bar_item_properties vector if necessary. Reset it to
7810 if (VECTORP (tool_bar_item_properties
))
7812 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7816 tool_bar_item_properties
7817 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7820 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7821 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7823 /* Get the caption of the item. If the caption is not a string,
7824 evaluate it to get a string. If we don't get a string, skip this
7826 caption
= XCAR (item
);
7827 if (!STRINGP (caption
))
7829 caption
= menu_item_eval_property (caption
);
7830 if (!STRINGP (caption
))
7833 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7835 /* Give up if rest following the caption is not a list. */
7840 /* Store the binding. */
7841 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7844 /* Ignore cached key binding, if any. */
7845 if (CONSP (item
) && CONSP (XCAR (item
)))
7848 /* Process the rest of the properties. */
7849 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7851 Lisp_Object key
, value
;
7854 value
= XCAR (XCDR (item
));
7856 if (EQ (key
, QCenable
))
7857 /* `:enable FORM'. */
7858 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7859 else if (EQ (key
, QCvisible
))
7861 /* `:visible FORM'. If got a visible property and that
7862 evaluates to nil then ignore this item. */
7863 if (NILP (menu_item_eval_property (value
)))
7866 else if (EQ (key
, QChelp
))
7867 /* `:help HELP-STRING'. */
7868 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7869 else if (EQ (key
, QCfilter
))
7870 /* ':filter FORM'. */
7872 else if (EQ (key
, QCbutton
) && CONSP (value
))
7874 /* `:button (TYPE . SELECTED)'. */
7875 Lisp_Object type
, selected
;
7877 type
= XCAR (value
);
7878 selected
= XCDR (value
);
7879 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7881 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7882 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7885 else if (EQ (key
, QCimage
)
7887 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7888 /* Value is either a single image specification or a vector
7889 of 4 such specifications for the different button states. */
7890 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7893 /* If got a filter apply it on binding. */
7895 PROP (TOOL_BAR_ITEM_BINDING
)
7896 = menu_item_eval_property (list2 (filter
,
7898 PROP (TOOL_BAR_ITEM_BINDING
))));
7900 /* See if the binding is a keymap. Give up if it is. */
7901 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7904 /* Enable or disable selection of item. */
7905 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7906 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7907 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7909 /* Handle radio buttons or toggle boxes. */
7910 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7911 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7912 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7920 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7921 that can be reused. */
7924 init_tool_bar_items (reuse
)
7927 if (VECTORP (reuse
))
7928 tool_bar_items_vector
= reuse
;
7930 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7931 ntool_bar_items
= 0;
7935 /* Append parsed tool bar item properties from
7936 tool_bar_item_properties */
7939 append_tool_bar_item ()
7941 Lisp_Object
*to
, *from
;
7943 /* Enlarge tool_bar_items_vector if necessary. */
7944 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7945 >= XVECTOR (tool_bar_items_vector
)->size
)
7947 Lisp_Object new_vector
;
7948 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7950 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7951 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7952 XVECTOR (new_vector
)->contents
,
7953 old_size
* sizeof (Lisp_Object
));
7954 tool_bar_items_vector
= new_vector
;
7957 /* Append entries from tool_bar_item_properties to the end of
7958 tool_bar_items_vector. */
7959 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7960 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7961 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7962 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7969 /* Read a character using menus based on maps in the array MAPS.
7970 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7971 Return t if we displayed a menu but the user rejected it.
7973 PREV_EVENT is the previous input event, or nil if we are reading
7974 the first event of a key sequence.
7976 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7977 if we used a mouse menu to read the input, or zero otherwise. If
7978 USED_MOUSE_MENU is null, we don't dereference it.
7980 The prompting is done based on the prompt-string of the map
7981 and the strings associated with various map elements.
7983 This can be done with X menus or with menus put in the minibuf.
7984 These are done in different ways, depending on how the input will be read.
7985 Menus using X are done after auto-saving in read-char, getting the input
7986 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7987 and do auto-saving in the inner call of read_char. */
7990 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7993 Lisp_Object prev_event
;
7994 int *used_mouse_menu
;
7997 register Lisp_Object name
= Qnil
;
7999 if (used_mouse_menu
)
8000 *used_mouse_menu
= 0;
8002 /* Use local over global Menu maps */
8004 if (! menu_prompting
)
8007 /* Optionally disregard all but the global map. */
8008 if (inhibit_local_menu_bar_menus
)
8010 maps
+= (nmaps
- 1);
8014 /* Get the menu name from the first map that has one (a prompt string). */
8015 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8017 name
= Fkeymap_prompt (maps
[mapno
]);
8022 /* If we don't have any menus, just read a character normally. */
8023 if (!STRINGP (name
))
8027 /* If we got to this point via a mouse click,
8028 use a real menu for mouse selection. */
8029 if (EVENT_HAS_PARAMETERS (prev_event
)
8030 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8031 && !EQ (XCAR (prev_event
), Qtool_bar
))
8033 /* Display the menu and get the selection. */
8034 Lisp_Object
*realmaps
8035 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8039 /* Use the maps that are not nil. */
8040 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8041 if (!NILP (maps
[mapno
]))
8042 realmaps
[nmaps1
++] = maps
[mapno
];
8044 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8049 record_menu_key (XCAR (value
));
8051 /* If we got multiple events, unread all but
8053 There is no way to prevent those unread events
8054 from showing up later in last_nonmenu_event.
8055 So turn symbol and integer events into lists,
8056 to indicate that they came from a mouse menu,
8057 so that when present in last_nonmenu_event
8058 they won't confuse things. */
8059 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8061 record_menu_key (XCAR (tem
));
8062 if (SYMBOLP (XCAR (tem
))
8063 || INTEGERP (XCAR (tem
)))
8064 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8067 /* If we got more than one event, put all but the first
8068 onto this list to be read later.
8069 Return just the first event now. */
8070 Vunread_command_events
8071 = nconc2 (XCDR (value
), Vunread_command_events
);
8072 value
= XCAR (value
);
8074 else if (NILP (value
))
8076 if (used_mouse_menu
)
8077 *used_mouse_menu
= 1;
8080 #endif /* HAVE_MENUS */
8084 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8085 We make this bigger when necessary, and never free it. */
8086 static char *read_char_minibuf_menu_text
;
8087 /* Size of that buffer. */
8088 static int read_char_minibuf_menu_width
;
8091 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8097 register Lisp_Object name
;
8099 /* FIXME: Use the minibuffer's frame width. */
8100 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8103 Lisp_Object rest
, vector
;
8109 if (! menu_prompting
)
8112 /* Make sure we have a big enough buffer for the menu text. */
8113 if (read_char_minibuf_menu_text
== 0)
8115 read_char_minibuf_menu_width
= width
+ 4;
8116 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8118 else if (width
+ 4 > read_char_minibuf_menu_width
)
8120 read_char_minibuf_menu_width
= width
+ 4;
8121 read_char_minibuf_menu_text
8122 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8124 menu
= read_char_minibuf_menu_text
;
8126 /* Get the menu name from the first map that has one (a prompt string). */
8127 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8129 name
= Fkeymap_prompt (maps
[mapno
]);
8134 /* If we don't have any menus, just read a character normally. */
8135 if (!STRINGP (name
))
8138 /* Prompt string always starts with map's prompt, and a space. */
8139 strcpy (menu
, SDATA (name
));
8140 nlength
= SBYTES (name
);
8141 menu
[nlength
++] = ':';
8142 menu
[nlength
++] = ' ';
8145 /* Start prompting at start of first map. */
8149 /* Present the documented bindings, a line at a time. */
8156 Lisp_Object orig_defn_macro
;
8158 /* Loop over elements of map. */
8163 /* If reached end of map, start at beginning of next map. */
8167 /* At end of last map, wrap around to first map if just starting,
8168 or end this line if already have something on it. */
8172 if (notfirst
|| nobindings
) break;
8177 /* Look at the next element of the map. */
8179 elt
= XVECTOR (vector
)->contents
[idx
];
8181 elt
= Fcar_safe (rest
);
8183 if (idx
< 0 && VECTORP (elt
))
8185 /* If we found a dense table in the keymap,
8186 advanced past it, but start scanning its contents. */
8187 rest
= Fcdr_safe (rest
);
8193 /* An ordinary element. */
8194 Lisp_Object event
, tem
;
8198 event
= Fcar_safe (elt
); /* alist */
8199 elt
= Fcdr_safe (elt
);
8203 XSETINT (event
, idx
); /* vector */
8206 /* Ignore the element if it has no prompt string. */
8207 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8209 /* 1 if the char to type matches the string. */
8211 Lisp_Object upcased_event
, downcased_event
;
8212 Lisp_Object desc
= Qnil
;
8214 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8216 upcased_event
= Fupcase (event
);
8217 downcased_event
= Fdowncase (event
);
8218 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8219 || XINT (downcased_event
) == SREF (s
, 0));
8221 desc
= Fsingle_key_description (event
, Qnil
);
8223 #if 0 /* It is redundant to list the equivalent key bindings because
8224 the prefix is what the user has already typed. */
8226 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8228 /* Insert equivalent keybinding. */
8229 s
= concat2 (s
, tem
);
8232 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8233 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8235 /* Insert button prefix. */
8236 Lisp_Object selected
8237 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8238 if (EQ (tem
, QCradio
))
8239 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8241 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8242 s
= concat2 (tem
, s
);
8246 /* If we have room for the prompt string, add it to this line.
8247 If this is the first on the line, always add it. */
8248 if ((SCHARS (s
) + i
+ 2
8249 + (char_matches
? 0 : SCHARS (desc
) + 3))
8255 /* Punctuate between strings. */
8258 strcpy (menu
+ i
, ", ");
8264 /* If the char to type doesn't match the string's
8265 first char, explicitly show what char to type. */
8268 /* Add as much of string as fits. */
8269 thiswidth
= SCHARS (desc
);
8270 if (thiswidth
+ i
> width
)
8271 thiswidth
= width
- i
;
8272 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8274 strcpy (menu
+ i
, " = ");
8278 /* Add as much of string as fits. */
8279 thiswidth
= SCHARS (s
);
8280 if (thiswidth
+ i
> width
)
8281 thiswidth
= width
- i
;
8282 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8288 /* If this element does not fit, end the line now,
8289 and save the element for the next line. */
8290 strcpy (menu
+ i
, "...");
8295 /* Move past this element. */
8296 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8297 /* Handle reaching end of dense table. */
8302 rest
= Fcdr_safe (rest
);
8306 /* Prompt with that and read response. */
8307 message2_nolog (menu
, strlen (menu
),
8308 ! NILP (current_buffer
->enable_multibyte_characters
));
8310 /* Make believe its not a keyboard macro in case the help char
8311 is pressed. Help characters are not recorded because menu prompting
8312 is not used on replay.
8314 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8315 current_kboard
->defining_kbd_macro
= Qnil
;
8317 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8318 while (BUFFERP (obj
));
8319 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8321 if (!INTEGERP (obj
))
8326 if (! EQ (obj
, menu_prompt_more_char
)
8327 && (!INTEGERP (menu_prompt_more_char
)
8328 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8330 if (!NILP (current_kboard
->defining_kbd_macro
))
8331 store_kbd_macro_char (obj
);
8334 /* Help char - go round again */
8338 /* Reading key sequences. */
8340 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8341 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8342 keymap, or nil otherwise. Return the index of the first keymap in
8343 which KEY has any binding, or NMAPS if no map has a binding.
8345 If KEY is a meta ASCII character, treat it like meta-prefix-char
8346 followed by the corresponding non-meta character. Keymaps in
8347 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8350 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8353 NEXT may be the same array as CURRENT. */
8356 follow_key (key
, nmaps
, current
, defs
, next
)
8358 Lisp_Object
*current
, *defs
, *next
;
8361 int i
, first_binding
;
8363 first_binding
= nmaps
;
8364 for (i
= nmaps
- 1; i
>= 0; i
--)
8366 if (! NILP (current
[i
]))
8368 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8369 if (! NILP (defs
[i
]))
8376 /* Given the set of bindings we've found, produce the next set of maps. */
8377 if (first_binding
< nmaps
)
8378 for (i
= 0; i
< nmaps
; i
++)
8379 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8381 return first_binding
;
8384 /* Structure used to keep track of partial application of key remapping
8385 such as Vfunction_key_map and Vkey_translation_map. */
8386 typedef struct keyremap
8388 Lisp_Object map
, parent
;
8392 /* Lookup KEY in MAP.
8393 MAP is a keymap mapping keys to key vectors or functions.
8394 If the mapping is a function and DO_FUNCTION is non-zero, then
8395 the function is called with PROMPT as parameter and its return
8396 value is used as the return value of this function (after checking
8397 that it is indeed a vector). */
8400 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8401 Lisp_Object map
, key
, prompt
;
8406 next
= access_keymap (map
, key
, 1, 0, 1);
8408 /* Handle symbol with autoload definition. */
8409 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8410 && CONSP (XSYMBOL (next
)->function
)
8411 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8412 do_autoload (XSYMBOL (next
)->function
, next
);
8414 /* Handle a symbol whose function definition is a keymap
8416 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8417 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8418 || KEYMAPP (XSYMBOL (next
)->function
)))
8419 next
= XSYMBOL (next
)->function
;
8421 /* If the keymap gives a function, not an
8422 array, then call the function with one arg and use
8423 its value instead. */
8424 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8429 next
= call1 (next
, prompt
);
8430 /* If the function returned something invalid,
8431 barf--don't ignore it.
8432 (To ignore it safely, we would need to gcpro a bunch of
8433 other variables.) */
8434 if (! (VECTORP (next
) || STRINGP (next
)))
8435 error ("Function %s returns invalid key sequence", tem
);
8440 /* Do one step of the key remapping used for function-key-map and
8441 key-translation-map:
8442 KEYBUF is the buffer holding the input events.
8443 BUFSIZE is its maximum size.
8444 FKEY is a pointer to the keyremap structure to use.
8445 INPUT is the index of the last element in KEYBUF.
8446 DOIT if non-zero says that the remapping can actually take place.
8447 DIFF is used to return the number of keys added/removed by the remapping.
8448 PARENT is the root of the keymap.
8449 PROMPT is the prompt to use if the remapping happens through a function.
8450 The return value is non-zero if the remapping actually took place. */
8453 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8454 Lisp_Object
*keybuf
, prompt
;
8456 int input
, doit
, *diff
, bufsize
;
8458 Lisp_Object next
, key
;
8460 key
= keybuf
[fkey
->end
++];
8461 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8463 /* If keybuf[fkey->start..fkey->end] is bound in the
8464 map and we're in a position to do the key remapping, replace it with
8465 the binding and restart with fkey->start at the end. */
8466 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8468 int len
= XFASTINT (Flength (next
));
8471 *diff
= len
- (fkey
->end
- fkey
->start
);
8473 if (input
+ *diff
>= bufsize
)
8474 error ("Key sequence too long");
8476 /* Shift the keys that follow fkey->end. */
8478 for (i
= fkey
->end
; i
< input
; i
++)
8479 keybuf
[i
+ *diff
] = keybuf
[i
];
8481 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8482 keybuf
[i
+ *diff
] = keybuf
[i
];
8483 /* Overwrite the old keys with the new ones. */
8484 for (i
= 0; i
< len
; i
++)
8485 keybuf
[fkey
->start
+ i
]
8486 = Faref (next
, make_number (i
));
8488 fkey
->start
= fkey
->end
+= *diff
;
8489 fkey
->map
= fkey
->parent
;
8494 fkey
->map
= get_keymap (next
, 0, 1);
8496 /* If we no longer have a bound suffix, try a new position for
8498 if (!CONSP (fkey
->map
))
8500 fkey
->end
= ++fkey
->start
;
8501 fkey
->map
= fkey
->parent
;
8506 /* Read a sequence of keys that ends with a non prefix character,
8507 storing it in KEYBUF, a buffer of size BUFSIZE.
8509 Return the length of the key sequence stored.
8510 Return -1 if the user rejected a command menu.
8512 Echo starting immediately unless `prompt' is 0.
8514 Where a key sequence ends depends on the currently active keymaps.
8515 These include any minor mode keymaps active in the current buffer,
8516 the current buffer's local map, and the global map.
8518 If a key sequence has no other bindings, we check Vfunction_key_map
8519 to see if some trailing subsequence might be the beginning of a
8520 function key's sequence. If so, we try to read the whole function
8521 key, and substitute its symbolic name into the key sequence.
8523 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8524 `double-' events into similar click events, if that would make them
8525 bound. We try to turn `triple-' events first into `double-' events,
8528 If we get a mouse click in a mode line, vertical divider, or other
8529 non-text area, we treat the click as if it were prefixed by the
8530 symbol denoting that area - `mode-line', `vertical-line', or
8533 If the sequence starts with a mouse click, we read the key sequence
8534 with respect to the buffer clicked on, not the current buffer.
8536 If the user switches frames in the midst of a key sequence, we put
8537 off the switch-frame event until later; the next call to
8538 read_char will return it.
8540 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8541 from the selected window's buffer. */
8544 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8545 can_return_switch_frame
, fix_current_buffer
)
8546 Lisp_Object
*keybuf
;
8549 int dont_downcase_last
;
8550 int can_return_switch_frame
;
8551 int fix_current_buffer
;
8553 volatile Lisp_Object from_string
;
8554 volatile int count
= SPECPDL_INDEX ();
8556 /* How many keys there are in the current key sequence. */
8559 /* The length of the echo buffer when we started reading, and
8560 the length of this_command_keys when we started reading. */
8561 volatile int echo_start
;
8562 volatile int keys_start
;
8564 /* The number of keymaps we're scanning right now, and the number of
8565 keymaps we have allocated space for. */
8567 volatile int nmaps_allocated
= 0;
8569 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8570 the current keymaps. */
8571 Lisp_Object
*volatile defs
= NULL
;
8573 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8574 in the current keymaps, or nil where it is not a prefix. */
8575 Lisp_Object
*volatile submaps
= NULL
;
8577 /* The local map to start out with at start of key sequence. */
8578 volatile Lisp_Object orig_local_map
;
8580 /* The map from the `keymap' property to start out with at start of
8582 volatile Lisp_Object orig_keymap
;
8584 /* 1 if we have already considered switching to the local-map property
8585 of the place where a mouse click occurred. */
8586 volatile int localized_local_map
= 0;
8588 /* The index in defs[] of the first keymap that has a binding for
8589 this key sequence. In other words, the lowest i such that
8590 defs[i] is non-nil. */
8591 volatile int first_binding
;
8592 /* Index of the first key that has no binding.
8593 It is useless to try fkey.start larger than that. */
8594 volatile int first_unbound
;
8596 /* If t < mock_input, then KEYBUF[t] should be read as the next
8599 We use this to recover after recognizing a function key. Once we
8600 realize that a suffix of the current key sequence is actually a
8601 function key's escape sequence, we replace the suffix with the
8602 function key's binding from Vfunction_key_map. Now keybuf
8603 contains a new and different key sequence, so the echo area,
8604 this_command_keys, and the submaps and defs arrays are wrong. In
8605 this situation, we set mock_input to t, set t to 0, and jump to
8606 restart_sequence; the loop will read keys from keybuf up until
8607 mock_input, thus rebuilding the state; and then it will resume
8608 reading characters from the keyboard. */
8609 volatile int mock_input
= 0;
8611 /* If the sequence is unbound in submaps[], then
8612 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8613 and fkey.map is its binding.
8615 These might be > t, indicating that all function key scanning
8616 should hold off until t reaches them. We do this when we've just
8617 recognized a function key, to avoid searching for the function
8618 key's again in Vfunction_key_map. */
8619 volatile keyremap fkey
;
8621 /* Likewise, for key_translation_map. */
8622 volatile keyremap keytran
;
8624 /* If we receive a `switch-frame' or `select-window' event in the middle of
8625 a key sequence, we put it off for later.
8626 While we're reading, we keep the event here. */
8627 volatile Lisp_Object delayed_switch_frame
;
8629 /* See the comment below... */
8630 #if defined (GOBBLE_FIRST_EVENT)
8631 Lisp_Object first_event
;
8634 volatile Lisp_Object original_uppercase
;
8635 volatile int original_uppercase_position
= -1;
8637 /* Gets around Microsoft compiler limitations. */
8640 struct buffer
*starting_buffer
;
8642 /* List of events for which a fake prefix key has been generated. */
8643 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8645 #if defined (GOBBLE_FIRST_EVENT)
8649 struct gcpro gcpro1
;
8651 GCPRO1 (fake_prefixed_keys
);
8652 raw_keybuf_count
= 0;
8654 last_nonmenu_event
= Qnil
;
8656 delayed_switch_frame
= Qnil
;
8657 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8658 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8659 /* If there is no translation-map, turn off scanning. */
8660 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8661 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8666 echo_prompt (prompt
);
8667 else if (cursor_in_echo_area
8668 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8669 && NILP (Fzerop (Vecho_keystrokes
)))
8670 /* This doesn't put in a dash if the echo buffer is empty, so
8671 you don't always see a dash hanging out in the minibuffer. */
8675 /* Record the initial state of the echo area and this_command_keys;
8676 we will need to restore them if we replay a key sequence. */
8678 echo_start
= echo_length ();
8679 keys_start
= this_command_key_count
;
8680 this_single_command_key_start
= keys_start
;
8682 #if defined (GOBBLE_FIRST_EVENT)
8683 /* This doesn't quite work, because some of the things that read_char
8684 does cannot safely be bypassed. It seems too risky to try to make
8687 /* Read the first char of the sequence specially, before setting
8688 up any keymaps, in case a filter runs and switches buffers on us. */
8689 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8691 #endif /* GOBBLE_FIRST_EVENT */
8693 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8694 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8697 /* We jump here when the key sequence has been thoroughly changed, and
8698 we need to rescan it starting from the beginning. When we jump here,
8699 keybuf[0..mock_input] holds the sequence we should reread. */
8702 starting_buffer
= current_buffer
;
8703 first_unbound
= bufsize
+ 1;
8705 /* Build our list of keymaps.
8706 If we recognize a function key and replace its escape sequence in
8707 keybuf with its symbol, or if the sequence starts with a mouse
8708 click and we need to switch buffers, we jump back here to rebuild
8709 the initial keymaps from the current buffer. */
8712 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8713 || !NILP (Voverriding_local_map
))
8715 if (3 > nmaps_allocated
)
8717 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8718 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8719 nmaps_allocated
= 3;
8721 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8722 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8723 if (!NILP (Voverriding_local_map
))
8724 submaps
[nmaps
++] = Voverriding_local_map
;
8732 nminor
= current_minor_maps (0, &maps
);
8733 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8735 if (total
> nmaps_allocated
)
8737 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8738 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8739 nmaps_allocated
= total
;
8742 if (!NILP (orig_keymap
))
8743 submaps
[nmaps
++] = orig_keymap
;
8745 bcopy (maps
, (void *) (submaps
+ nmaps
),
8746 nminor
* sizeof (submaps
[0]));
8750 submaps
[nmaps
++] = orig_local_map
;
8752 submaps
[nmaps
++] = current_global_map
;
8754 /* Find an accurate initial value for first_binding. */
8755 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8756 if (! NILP (submaps
[first_binding
]))
8759 /* Start from the beginning in keybuf. */
8762 /* These are no-ops the first time through, but if we restart, they
8763 revert the echo area and this_command_keys to their original state. */
8764 this_command_key_count
= keys_start
;
8765 if (INTERACTIVE
&& t
< mock_input
)
8766 echo_truncate (echo_start
);
8768 /* If the best binding for the current key sequence is a keymap, or
8769 we may be looking at a function key's escape sequence, keep on
8771 while (first_binding
< nmaps
8772 /* Keep reading as long as there's a prefix binding. */
8773 ? !NILP (submaps
[first_binding
])
8774 /* Don't return in the middle of a possible function key sequence,
8775 if the only bindings we found were via case conversion.
8776 Thus, if ESC O a has a function-key-map translation
8777 and ESC o has a binding, don't return after ESC O,
8778 so that we can translate ESC O plus the next character. */
8779 : (fkey
.start
< t
|| keytran
.start
< t
))
8782 int used_mouse_menu
= 0;
8784 /* Where the last real key started. If we need to throw away a
8785 key that has expanded into more than one element of keybuf
8786 (say, a mouse click on the mode line which is being treated
8787 as [mode-line (mouse-...)], then we backtrack to this point
8789 volatile int last_real_key_start
;
8791 /* These variables are analogous to echo_start and keys_start;
8792 while those allow us to restart the entire key sequence,
8793 echo_local_start and keys_local_start allow us to throw away
8795 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8797 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8798 eassert (fkey
.start
<= fkey
.end
);
8799 eassert (keytran
.start
<= keytran
.end
);
8800 /* key-translation-map is applied *after* function-key-map. */
8801 eassert (keytran
.end
<= fkey
.start
);
8803 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8804 { /* The prefix upto first_unbound has no binding and has
8805 no translation left to do either, so we know it's unbound.
8806 If we don't stop now, we risk staying here indefinitely
8807 (if the user keeps entering fkey or keytran prefixes
8808 like C-c ESC ESC ESC ESC ...) */
8810 for (i
= first_unbound
+ 1; i
< t
; i
++)
8811 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8812 mock_input
= t
- first_unbound
- 1;
8813 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8814 fkey
.map
= fkey
.parent
;
8815 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8816 keytran
.map
= keytran
.parent
;
8817 goto replay_sequence
;
8821 error ("Key sequence too long");
8824 echo_local_start
= echo_length ();
8825 keys_local_start
= this_command_key_count
;
8826 local_first_binding
= first_binding
;
8829 /* These are no-ops, unless we throw away a keystroke below and
8830 jumped back up to replay_key; in that case, these restore the
8831 variables to their original state, allowing us to replay the
8833 if (INTERACTIVE
&& t
< mock_input
)
8834 echo_truncate (echo_local_start
);
8835 this_command_key_count
= keys_local_start
;
8836 first_binding
= local_first_binding
;
8838 /* By default, assume each event is "real". */
8839 last_real_key_start
= t
;
8841 /* Does mock_input indicate that we are re-reading a key sequence? */
8845 add_command_key (key
);
8846 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8847 && NILP (Fzerop (Vecho_keystrokes
)))
8851 /* If not, we should actually read a character. */
8856 KBOARD
*interrupted_kboard
= current_kboard
;
8857 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8858 if (setjmp (wrong_kboard_jmpbuf
))
8860 if (!NILP (delayed_switch_frame
))
8862 interrupted_kboard
->kbd_queue
8863 = Fcons (delayed_switch_frame
,
8864 interrupted_kboard
->kbd_queue
);
8865 delayed_switch_frame
= Qnil
;
8868 interrupted_kboard
->kbd_queue
8869 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8871 /* If the side queue is non-empty, ensure it begins with a
8872 switch-frame, so we'll replay it in the right context. */
8873 if (CONSP (interrupted_kboard
->kbd_queue
)
8874 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8875 !(EVENT_HAS_PARAMETERS (key
)
8876 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8880 XSETFRAME (frame
, interrupted_frame
);
8881 interrupted_kboard
->kbd_queue
8882 = Fcons (make_lispy_switch_frame (frame
),
8883 interrupted_kboard
->kbd_queue
);
8886 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8887 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8888 goto replay_sequence
;
8891 key
= read_char (NILP (prompt
), nmaps
,
8892 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8896 /* read_char returns t when it shows a menu and the user rejects it.
8900 unbind_to (count
, Qnil
);
8905 /* read_char returns -1 at the end of a macro.
8906 Emacs 18 handles this by returning immediately with a
8907 zero, so that's what we'll do. */
8908 if (INTEGERP (key
) && XINT (key
) == -1)
8911 /* The Microsoft C compiler can't handle the goto that
8917 /* If the current buffer has been changed from under us, the
8918 keymap may have changed, so replay the sequence. */
8921 timer_resume_idle ();
8924 /* Reset the current buffer from the selected window
8925 in case something changed the former and not the latter.
8926 This is to be more consistent with the behavior
8927 of the command_loop_1. */
8928 if (fix_current_buffer
)
8930 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8932 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8933 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8936 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8937 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8938 goto replay_sequence
;
8941 /* If we have a quit that was typed in another frame, and
8942 quit_throw_to_read_char switched buffers,
8943 replay to get the right keymap. */
8945 && XINT (key
) == quit_char
8946 && current_buffer
!= starting_buffer
)
8949 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8953 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8954 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8955 goto replay_sequence
;
8960 if (EVENT_HAS_PARAMETERS (key
)
8961 /* Either a `switch-frame' or a `select-window' event. */
8962 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8964 /* If we're at the beginning of a key sequence, and the caller
8965 says it's okay, go ahead and return this event. If we're
8966 in the midst of a key sequence, delay it until the end. */
8967 if (t
> 0 || !can_return_switch_frame
)
8969 delayed_switch_frame
= key
;
8975 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8978 /* Clicks in non-text areas get prefixed by the symbol
8979 in their CHAR-ADDRESS field. For example, a click on
8980 the mode line is prefixed by the symbol `mode-line'.
8982 Furthermore, key sequences beginning with mouse clicks
8983 are read using the keymaps of the buffer clicked on, not
8984 the current buffer. So we may have to switch the buffer
8987 When we turn one event into two events, we must make sure
8988 that neither of the two looks like the original--so that,
8989 if we replay the events, they won't be expanded again.
8990 If not for this, such reexpansion could happen either here
8991 or when user programs play with this-command-keys. */
8992 if (EVENT_HAS_PARAMETERS (key
))
8997 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8998 if (EQ (kind
, Qmouse_click
))
9000 Lisp_Object window
, posn
;
9002 window
= POSN_WINDOW (EVENT_START (key
));
9003 posn
= POSN_POSN (EVENT_START (key
));
9006 || (!NILP (fake_prefixed_keys
)
9007 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9009 /* We're looking a second time at an event for which
9010 we generated a fake prefix key. Set
9011 last_real_key_start appropriately. */
9013 last_real_key_start
= t
- 1;
9016 /* Key sequences beginning with mouse clicks are
9017 read using the keymaps in the buffer clicked on,
9018 not the current buffer. If we're at the
9019 beginning of a key sequence, switch buffers. */
9020 if (last_real_key_start
== 0
9022 && BUFFERP (XWINDOW (window
)->buffer
)
9023 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9025 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9029 /* Arrange to go back to the original buffer once we're
9030 done reading the key sequence. Note that we can't
9031 use save_excursion_{save,restore} here, because they
9032 save point as well as the current buffer; we don't
9033 want to save point, because redisplay may change it,
9034 to accommodate a Fset_window_start or something. We
9035 don't want to do this at the top of the function,
9036 because we may get input from a subprocess which
9037 wants to change the selected window and stuff (say,
9039 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9041 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9043 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9044 orig_local_map
= get_local_map (PT
, current_buffer
,
9046 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9047 goto replay_sequence
;
9050 /* For a mouse click, get the local text-property keymap
9051 of the place clicked on, rather than point. */
9052 if (last_real_key_start
== 0
9053 && CONSP (XCDR (key
))
9054 && ! localized_local_map
)
9056 Lisp_Object map_here
, start
, pos
;
9058 localized_local_map
= 1;
9059 start
= EVENT_START (key
);
9061 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9063 pos
= POSN_BUFFER_POSN (start
);
9065 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9067 map_here
= get_local_map (XINT (pos
),
9068 current_buffer
, Qlocal_map
);
9069 if (!EQ (map_here
, orig_local_map
))
9071 orig_local_map
= map_here
;
9075 goto replay_sequence
;
9077 map_here
= get_local_map (XINT (pos
),
9078 current_buffer
, Qkeymap
);
9079 if (!EQ (map_here
, orig_keymap
))
9081 orig_keymap
= map_here
;
9085 goto replay_sequence
;
9091 /* Expand mode-line and scroll-bar events into two events:
9092 use posn as a fake prefix key. */
9094 && (NILP (fake_prefixed_keys
)
9095 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9097 if (t
+ 1 >= bufsize
)
9098 error ("Key sequence too long");
9101 keybuf
[t
+ 1] = key
;
9104 /* Record that a fake prefix key has been generated
9105 for KEY. Don't modify the event; this would
9106 prevent proper action when the event is pushed
9107 back into unread-command-events. */
9108 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9110 /* If on a mode line string with a local keymap,
9111 reconsider the key sequence with that keymap. */
9112 if (string
= POSN_STRING (EVENT_START (key
)),
9113 (CONSP (string
) && STRINGP (XCAR (string
))))
9115 Lisp_Object pos
, map
, map2
;
9117 pos
= XCDR (string
);
9118 string
= XCAR (string
);
9120 && XINT (pos
) < SCHARS (string
))
9122 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9124 orig_local_map
= map
;
9125 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9128 if (!NILP (map
) || !NILP (map2
))
9129 goto replay_sequence
;
9135 else if (NILP (from_string
)
9136 && (string
= POSN_STRING (EVENT_START (key
)),
9137 (CONSP (string
) && STRINGP (XCAR (string
)))))
9139 /* For a click on a string, i.e. overlay string or a
9140 string displayed via the `display' property,
9141 consider `local-map' and `keymap' properties of
9143 Lisp_Object pos
, map
, map2
;
9145 pos
= XCDR (string
);
9146 string
= XCAR (string
);
9148 && XINT (pos
) < SCHARS (string
))
9150 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9152 orig_local_map
= map
;
9153 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9157 if (!NILP (map
) || !NILP (map2
))
9159 from_string
= string
;
9160 goto replay_sequence
;
9165 else if (CONSP (XCDR (key
))
9166 && CONSP (EVENT_START (key
))
9167 && CONSP (XCDR (EVENT_START (key
))))
9171 posn
= POSN_POSN (EVENT_START (key
));
9172 /* Handle menu-bar events:
9173 insert the dummy prefix event `menu-bar'. */
9174 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9176 if (t
+ 1 >= bufsize
)
9177 error ("Key sequence too long");
9181 /* Zap the position in key, so we know that we've
9182 expanded it, and don't try to do so again. */
9183 POSN_SET_POSN (EVENT_START (key
),
9184 Fcons (posn
, Qnil
));
9187 goto replay_sequence
;
9189 else if (CONSP (posn
))
9191 /* We're looking at the second event of a
9192 sequence which we expanded before. Set
9193 last_real_key_start appropriately. */
9194 if (last_real_key_start
== t
&& t
> 0)
9195 last_real_key_start
= t
- 1;
9200 /* We have finally decided that KEY is something we might want
9202 first_binding
= (follow_key (key
,
9203 nmaps
- first_binding
,
9204 submaps
+ first_binding
,
9205 defs
+ first_binding
,
9206 submaps
+ first_binding
)
9209 /* If KEY wasn't bound, we'll try some fallbacks. */
9210 if (first_binding
< nmaps
)
9211 /* This is needed for the following scenario:
9212 event 0: a down-event that gets dropped by calling replay_key.
9213 event 1: some normal prefix like C-h.
9214 After event 0, first_unbound is 0, after event 1 fkey.start
9215 and keytran.start are both 1, so when we see that C-h is bound,
9216 we need to update first_unbound. */
9217 first_unbound
= max (t
+ 1, first_unbound
);
9222 /* Remember the position to put an upper bound on fkey.start. */
9223 first_unbound
= min (t
, first_unbound
);
9225 head
= EVENT_HEAD (key
);
9226 if (help_char_p (head
) && t
> 0)
9228 read_key_sequence_cmd
= Vprefix_help_command
;
9230 last_nonmenu_event
= key
;
9231 /* The Microsoft C compiler can't handle the goto that
9239 Lisp_Object breakdown
;
9242 breakdown
= parse_modifiers (head
);
9243 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9244 /* Attempt to reduce an unbound mouse event to a simpler
9245 event that is bound:
9246 Drags reduce to clicks.
9247 Double-clicks reduce to clicks.
9248 Triple-clicks reduce to double-clicks, then to clicks.
9249 Down-clicks are eliminated.
9250 Double-downs reduce to downs, then are eliminated.
9251 Triple-downs reduce to double-downs, then to downs,
9252 then are eliminated. */
9253 if (modifiers
& (down_modifier
| drag_modifier
9254 | double_modifier
| triple_modifier
))
9256 while (modifiers
& (down_modifier
| drag_modifier
9257 | double_modifier
| triple_modifier
))
9259 Lisp_Object new_head
, new_click
;
9260 if (modifiers
& triple_modifier
)
9261 modifiers
^= (double_modifier
| triple_modifier
);
9262 else if (modifiers
& double_modifier
)
9263 modifiers
&= ~double_modifier
;
9264 else if (modifiers
& drag_modifier
)
9265 modifiers
&= ~drag_modifier
;
9268 /* Dispose of this `down' event by simply jumping
9269 back to replay_key, to get another event.
9271 Note that if this event came from mock input,
9272 then just jumping back to replay_key will just
9273 hand it to us again. So we have to wipe out any
9276 We could delete keybuf[t] and shift everything
9277 after that to the left by one spot, but we'd also
9278 have to fix up any variable that points into
9279 keybuf, and shifting isn't really necessary
9282 Adding prefixes for non-textual mouse clicks
9283 creates two characters of mock input, and both
9284 must be thrown away. If we're only looking at
9285 the prefix now, we can just jump back to
9286 replay_key. On the other hand, if we've already
9287 processed the prefix, and now the actual click
9288 itself is giving us trouble, then we've lost the
9289 state of the keymaps we want to backtrack to, and
9290 we need to replay the whole sequence to rebuild
9293 Beyond that, only function key expansion could
9294 create more than two keys, but that should never
9295 generate mouse events, so it's okay to zero
9296 mock_input in that case too.
9298 FIXME: The above paragraph seems just plain
9299 wrong, if you consider things like
9300 xterm-mouse-mode. -stef
9302 Isn't this just the most wonderful code ever? */
9304 /* If mock_input > t + 1, the above simplification
9305 will actually end up dropping keys on the floor.
9306 This is probably OK for now, but even
9307 if mock_input <= t + 1, we need to adjust fkey
9309 Typical case [header-line down-mouse-N]:
9310 mock_input = 2, t = 1, fkey.end = 1,
9311 last_real_key_start = 0. */
9312 if (fkey
.end
> last_real_key_start
)
9314 fkey
.end
= fkey
.start
9315 = min (last_real_key_start
, fkey
.start
);
9316 fkey
.map
= fkey
.parent
;
9317 if (keytran
.end
> last_real_key_start
)
9319 keytran
.end
= keytran
.start
9320 = min (last_real_key_start
, keytran
.start
);
9321 keytran
.map
= keytran
.parent
;
9324 if (t
== last_real_key_start
)
9331 mock_input
= last_real_key_start
;
9332 goto replay_sequence
;
9337 = apply_modifiers (modifiers
, XCAR (breakdown
));
9339 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9341 /* Look for a binding for this new key. follow_key
9342 promises that it didn't munge submaps the
9343 last time we called it, since key was unbound. */
9345 = (follow_key (new_click
,
9346 nmaps
- local_first_binding
,
9347 submaps
+ local_first_binding
,
9348 defs
+ local_first_binding
,
9349 submaps
+ local_first_binding
)
9350 + local_first_binding
);
9352 /* If that click is bound, go for it. */
9353 if (first_binding
< nmaps
)
9358 /* Otherwise, we'll leave key set to the drag event. */
9365 /* Normally, last_nonmenu_event gets the previous key we read.
9366 But when a mouse popup menu is being used,
9367 we don't update last_nonmenu_event; it continues to hold the mouse
9368 event that preceded the first level of menu. */
9369 if (!used_mouse_menu
)
9370 last_nonmenu_event
= key
;
9372 /* Record what part of this_command_keys is the current key sequence. */
9373 this_single_command_key_start
= this_command_key_count
- t
;
9375 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9376 /* There is a binding and it's not a prefix.
9377 There is thus no function-key in this sequence.
9378 Moving fkey.start is important in this case to allow keytran.start
9379 to go over the sequence before we return (since we keep the
9380 invariant that keytran.end <= fkey.start). */
9383 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9386 /* If the sequence is unbound, see if we can hang a function key
9387 off the end of it. */
9388 /* Continue scan from fkey.end until we find a bound suffix. */
9389 while (fkey
.end
< t
)
9391 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9394 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9395 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9396 max (t
, mock_input
),
9397 /* If there's a binding (i.e.
9398 first_binding >= nmaps) we don't want
9399 to apply this function-key-mapping. */
9400 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9405 mock_input
= diff
+ max (t
, mock_input
);
9406 goto replay_sequence
;
9410 /* Look for this sequence in key-translation-map.
9411 Scan from keytran.end until we find a bound suffix. */
9412 while (keytran
.end
< fkey
.start
)
9414 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9417 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9418 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9423 mock_input
= diff
+ max (t
, mock_input
);
9424 /* Adjust the function-key-map counters. */
9428 goto replay_sequence
;
9432 /* If KEY is not defined in any of the keymaps,
9433 and cannot be part of a function key or translation,
9434 and is an upper case letter
9435 use the corresponding lower-case letter instead. */
9436 if (first_binding
>= nmaps
9437 && fkey
.start
>= t
&& keytran
.start
>= t
9439 && ((((XINT (key
) & 0x3ffff)
9440 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9441 && UPPERCASEP (XINT (key
) & 0x3ffff))
9442 || (XINT (key
) & shift_modifier
)))
9444 Lisp_Object new_key
;
9446 original_uppercase
= key
;
9447 original_uppercase_position
= t
- 1;
9449 if (XINT (key
) & shift_modifier
)
9450 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9452 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9453 | (XINT (key
) & ~0x3ffff)));
9455 /* We have to do this unconditionally, regardless of whether
9456 the lower-case char is defined in the keymaps, because they
9457 might get translated through function-key-map. */
9458 keybuf
[t
- 1] = new_key
;
9459 mock_input
= max (t
, mock_input
);
9461 goto replay_sequence
;
9463 /* If KEY is not defined in any of the keymaps,
9464 and cannot be part of a function key or translation,
9465 and is a shifted function key,
9466 use the corresponding unshifted function key instead. */
9467 if (first_binding
>= nmaps
9468 && fkey
.start
>= t
&& keytran
.start
>= t
9471 Lisp_Object breakdown
;
9474 breakdown
= parse_modifiers (key
);
9475 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9476 if (modifiers
& shift_modifier
)
9478 Lisp_Object new_key
;
9480 original_uppercase
= key
;
9481 original_uppercase_position
= t
- 1;
9483 modifiers
&= ~shift_modifier
;
9484 new_key
= apply_modifiers (modifiers
,
9487 keybuf
[t
- 1] = new_key
;
9488 mock_input
= max (t
, mock_input
);
9489 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9490 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9492 goto replay_sequence
;
9498 read_key_sequence_cmd
= (first_binding
< nmaps
9499 ? defs
[first_binding
]
9502 unread_switch_frame
= delayed_switch_frame
;
9503 unbind_to (count
, Qnil
);
9505 /* Don't downcase the last character if the caller says don't.
9506 Don't downcase it if the result is undefined, either. */
9507 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9508 && t
- 1 == original_uppercase_position
)
9509 keybuf
[t
- 1] = original_uppercase
;
9511 /* Occasionally we fabricate events, perhaps by expanding something
9512 according to function-key-map, or by adding a prefix symbol to a
9513 mouse click in the scroll bar or modeline. In this cases, return
9514 the entire generated key sequence, even if we hit an unbound
9515 prefix or a definition before the end. This means that you will
9516 be able to push back the event properly, and also means that
9517 read-key-sequence will always return a logical unit.
9520 for (; t
< mock_input
; t
++)
9522 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9523 && NILP (Fzerop (Vecho_keystrokes
)))
9524 echo_char (keybuf
[t
]);
9525 add_command_key (keybuf
[t
]);
9534 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9535 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9536 The sequence is sufficient to specify a non-prefix command in the
9537 current local and global maps.
9539 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9540 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9541 as a continuation of the previous key.
9543 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9544 convert the last event to lower case. (Normally any upper case event
9545 is converted to lower case if the original event is undefined and the lower
9546 case equivalent is defined.) A non-nil value is appropriate for reading
9547 a key sequence to be defined.
9549 A C-g typed while in this function is treated like any other character,
9550 and `quit-flag' is not set.
9552 If the key sequence starts with a mouse click, then the sequence is read
9553 using the keymaps of the buffer of the window clicked in, not the buffer
9554 of the selected window as normal.
9556 `read-key-sequence' drops unbound button-down events, since you normally
9557 only care about the click or drag events which follow them. If a drag
9558 or multi-click event is unbound, but the corresponding click event would
9559 be bound, `read-key-sequence' turns the event into a click event at the
9560 drag's starting position. This means that you don't have to distinguish
9561 between click and drag, double, or triple events unless you want to.
9563 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9564 lines separating windows, and scroll bars with imaginary keys
9565 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9567 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9568 function will process a switch-frame event if the user switches frames
9569 before typing anything. If the user switches frames in the middle of a
9570 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9571 is nil, then the event will be put off until after the current key sequence.
9573 `read-key-sequence' checks `function-key-map' for function key
9574 sequences, where they wouldn't conflict with ordinary bindings. See
9575 `function-key-map' for more details.
9577 The optional fifth argument COMMAND-LOOP, if non-nil, means
9578 that this key sequence is being read by something that will
9579 read commands one after another. It should be nil if the caller
9580 will read just one key sequence. */)
9581 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9583 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9584 Lisp_Object can_return_switch_frame
, command_loop
;
9586 Lisp_Object keybuf
[30];
9588 struct gcpro gcpro1
;
9589 int count
= SPECPDL_INDEX ();
9592 CHECK_STRING (prompt
);
9595 specbind (Qinput_method_exit_on_first_char
,
9596 (NILP (command_loop
) ? Qt
: Qnil
));
9597 specbind (Qinput_method_use_echo_area
,
9598 (NILP (command_loop
) ? Qt
: Qnil
));
9600 bzero (keybuf
, sizeof keybuf
);
9602 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9604 if (NILP (continue_echo
))
9606 this_command_key_count
= 0;
9607 this_command_key_count_reset
= 0;
9608 this_single_command_key_start
= 0;
9611 #ifdef HAVE_X_WINDOWS
9612 if (display_hourglass_p
)
9613 cancel_hourglass ();
9616 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9617 prompt
, ! NILP (dont_downcase_last
),
9618 ! NILP (can_return_switch_frame
), 0);
9620 #if 0 /* The following is fine for code reading a key sequence and
9621 then proceeding with a lenghty computation, but it's not good
9622 for code reading keys in a loop, like an input method. */
9623 #ifdef HAVE_X_WINDOWS
9624 if (display_hourglass_p
)
9635 return unbind_to (count
, make_event_array (i
, keybuf
));
9638 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9639 Sread_key_sequence_vector
, 1, 5, 0,
9640 doc
: /* Like `read-key-sequence' but always return a vector. */)
9641 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9643 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9644 Lisp_Object can_return_switch_frame
, command_loop
;
9646 Lisp_Object keybuf
[30];
9648 struct gcpro gcpro1
;
9649 int count
= SPECPDL_INDEX ();
9652 CHECK_STRING (prompt
);
9655 specbind (Qinput_method_exit_on_first_char
,
9656 (NILP (command_loop
) ? Qt
: Qnil
));
9657 specbind (Qinput_method_use_echo_area
,
9658 (NILP (command_loop
) ? Qt
: Qnil
));
9660 bzero (keybuf
, sizeof keybuf
);
9662 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9664 if (NILP (continue_echo
))
9666 this_command_key_count
= 0;
9667 this_command_key_count_reset
= 0;
9668 this_single_command_key_start
= 0;
9671 #ifdef HAVE_X_WINDOWS
9672 if (display_hourglass_p
)
9673 cancel_hourglass ();
9676 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9677 prompt
, ! NILP (dont_downcase_last
),
9678 ! NILP (can_return_switch_frame
), 0);
9680 #ifdef HAVE_X_WINDOWS
9681 if (display_hourglass_p
)
9691 return unbind_to (count
, Fvector (i
, keybuf
));
9694 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9695 doc
: /* Execute CMD as an editor command.
9696 CMD must be a symbol that satisfies the `commandp' predicate.
9697 Optional second arg RECORD-FLAG non-nil
9698 means unconditionally put this command in `command-history'.
9699 Otherwise, that is done only if an arg is read using the minibuffer.
9700 The argument KEYS specifies the value to use instead of (this-command-keys)
9701 when reading the arguments; if it is nil, (this-command-keys) is used.
9702 The argument SPECIAL, if non-nil, means that this command is executing
9703 a special event, so ignore the prefix argument and don't clear it. */)
9704 (cmd
, record_flag
, keys
, special
)
9705 Lisp_Object cmd
, record_flag
, keys
, special
;
9707 register Lisp_Object final
;
9708 register Lisp_Object tem
;
9709 Lisp_Object prefixarg
;
9710 struct backtrace backtrace
;
9711 extern int debug_on_next_call
;
9713 debug_on_next_call
= 0;
9717 prefixarg
= current_kboard
->Vprefix_arg
;
9718 Vcurrent_prefix_arg
= prefixarg
;
9719 current_kboard
->Vprefix_arg
= Qnil
;
9726 tem
= Fget (cmd
, Qdisabled
);
9727 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9729 tem
= Fsymbol_value (Qdisabled_command_function
);
9731 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9737 final
= Findirect_function (cmd
);
9739 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9741 struct gcpro gcpro1
, gcpro2
;
9743 GCPRO2 (cmd
, prefixarg
);
9744 do_autoload (final
, cmd
);
9751 if (STRINGP (final
) || VECTORP (final
))
9753 /* If requested, place the macro in the command history. For
9754 other sorts of commands, call-interactively takes care of
9756 if (!NILP (record_flag
))
9759 = Fcons (Fcons (Qexecute_kbd_macro
,
9760 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9763 /* Don't keep command history around forever. */
9764 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9766 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9768 XSETCDR (tem
, Qnil
);
9772 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9775 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9777 backtrace
.next
= backtrace_list
;
9778 backtrace_list
= &backtrace
;
9779 backtrace
.function
= &Qcall_interactively
;
9780 backtrace
.args
= &cmd
;
9781 backtrace
.nargs
= 1;
9782 backtrace
.evalargs
= 0;
9783 backtrace
.debug_on_exit
= 0;
9785 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9787 backtrace_list
= backtrace
.next
;
9795 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9797 doc
: /* Read function name, then read its arguments and call it. */)
9799 Lisp_Object prefixarg
;
9801 Lisp_Object function
;
9803 int saved_last_point_position
;
9804 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9805 Lisp_Object bindings
, value
;
9806 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9807 #ifdef HAVE_X_WINDOWS
9808 /* The call to Fcompleting_read wil start and cancel the hourglass,
9809 but if the hourglass was already scheduled, this means that no
9810 hourglass will be shown for the actual M-x command itself.
9811 So we restart it if it is already scheduled. Note that checking
9812 hourglass_shown_p is not enough, normally the hourglass is not shown,
9813 just scheduled to be shown. */
9814 int hstarted
= hourglass_started ();
9817 saved_keys
= Fvector (this_command_key_count
,
9818 XVECTOR (this_command_keys
)->contents
);
9819 saved_last_point_position_buffer
= last_point_position_buffer
;
9820 saved_last_point_position
= last_point_position
;
9822 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9824 if (EQ (prefixarg
, Qminus
))
9826 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9827 strcpy (buf
, "C-u ");
9828 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9829 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9830 else if (INTEGERP (prefixarg
))
9831 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9833 /* This isn't strictly correct if execute-extended-command
9834 is bound to anything else. Perhaps it should use
9835 this_command_keys? */
9836 strcat (buf
, "M-x ");
9838 /* Prompt with buf, and then read a string, completing from and
9839 restricting to the set of all defined commands. Don't provide
9840 any initial input. Save the command read on the extended-command
9842 function
= Fcompleting_read (build_string (buf
),
9843 Vobarray
, Qcommandp
,
9844 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9847 #ifdef HAVE_X_WINDOWS
9848 if (hstarted
) start_hourglass ();
9851 if (STRINGP (function
) && SCHARS (function
) == 0)
9852 error ("No command name given");
9854 /* Set this_command_keys to the concatenation of saved_keys and
9855 function, followed by a RET. */
9860 this_command_key_count
= 0;
9861 this_command_key_count_reset
= 0;
9862 this_single_command_key_start
= 0;
9864 keys
= XVECTOR (saved_keys
)->contents
;
9865 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9866 add_command_key (keys
[i
]);
9868 for (i
= 0; i
< SCHARS (function
); i
++)
9869 add_command_key (Faref (function
, make_number (i
)));
9871 add_command_key (make_number ('\015'));
9874 last_point_position
= saved_last_point_position
;
9875 last_point_position_buffer
= saved_last_point_position_buffer
;
9879 function
= Fintern (function
, Qnil
);
9880 current_kboard
->Vprefix_arg
= prefixarg
;
9881 Vthis_command
= function
;
9882 real_this_command
= function
;
9884 /* If enabled, show which key runs this command. */
9885 if (!NILP (Vsuggest_key_bindings
)
9886 && NILP (Vexecuting_kbd_macro
)
9887 && SYMBOLP (function
))
9888 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9894 GCPRO2 (bindings
, value
);
9895 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9897 /* If the command has a key binding, print it now. */
9898 if (!NILP (bindings
)
9899 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9902 /* But first wait, and skip the message if there is input. */
9904 if (!NILP (echo_area_buffer
[0]))
9905 /* This command displayed something in the echo area;
9906 so wait a few seconds, then display our suggestion message. */
9907 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9908 ? XINT (Vsuggest_key_bindings
) : 2);
9910 /* This command left the echo area empty,
9911 so display our message immediately. */
9914 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9915 && ! CONSP (Vunread_command_events
))
9917 Lisp_Object binding
;
9919 int message_p
= push_message ();
9920 int count
= SPECPDL_INDEX ();
9922 record_unwind_protect (pop_message_unwind
, Qnil
);
9923 binding
= Fkey_description (bindings
, Qnil
);
9926 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9929 sprintf (newmessage
, "You can run the command `%s' with %s",
9930 SDATA (SYMBOL_NAME (function
)),
9932 message2_nolog (newmessage
,
9933 strlen (newmessage
),
9934 STRING_MULTIBYTE (binding
));
9935 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9936 ? Vsuggest_key_bindings
: make_number (2)),
9941 unbind_to (count
, Qnil
);
9945 RETURN_UNGCPRO (value
);
9949 /* Return nonzero if input events are pending. */
9952 detect_input_pending ()
9955 get_input_pending (&input_pending
, 0);
9957 return input_pending
;
9960 /* Return nonzero if input events other than mouse movements are
9964 detect_input_pending_ignore_squeezables ()
9967 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9969 return input_pending
;
9972 /* Return nonzero if input events are pending, and run any pending timers. */
9975 detect_input_pending_run_timers (do_display
)
9978 int old_timers_run
= timers_run
;
9981 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
9983 if (old_timers_run
!= timers_run
&& do_display
)
9985 redisplay_preserve_echo_area (8);
9986 /* The following fixes a bug when using lazy-lock with
9987 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9988 from an idle timer function. The symptom of the bug is that
9989 the cursor sometimes doesn't become visible until the next X
9990 event is processed. --gerd. */
9992 Lisp_Object tail
, frame
;
9993 FOR_EACH_FRAME (tail
, frame
)
9994 if (FRAME_RIF (XFRAME (frame
)))
9995 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
9999 return input_pending
;
10002 /* This is called in some cases before a possible quit.
10003 It cases the next call to detect_input_pending to recompute input_pending.
10004 So calling this function unnecessarily can't do any harm. */
10007 clear_input_pending ()
10012 /* Return nonzero if there are pending requeued events.
10013 This isn't used yet. The hope is to make wait_reading_process_output
10014 call it, and return if it runs Lisp code that unreads something.
10015 The problem is, kbd_buffer_get_event needs to be fixed to know what
10016 to do in that case. It isn't trivial. */
10019 requeued_events_pending_p ()
10021 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10025 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10026 doc
: /* Return t if command input is currently available with no wait.
10027 Actually, the value is nil only if we can be sure that no input is available;
10028 if there is a doubt, the value is t. */)
10031 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
10034 get_input_pending (&input_pending
,
10035 READABLE_EVENTS_DO_TIMERS_NOW
10036 | READABLE_EVENTS_FILTER_EVENTS
);
10037 return input_pending
> 0 ? Qt
: Qnil
;
10040 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10041 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10044 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10047 if (total_keys
< NUM_RECENT_KEYS
)
10048 return Fvector (total_keys
, keys
);
10051 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10052 bcopy (keys
+ recent_keys_index
,
10053 XVECTOR (val
)->contents
,
10054 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10056 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10057 recent_keys_index
* sizeof (Lisp_Object
));
10062 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10063 doc
: /* Return the key sequence that invoked this command.
10064 However, if the command has called `read-key-sequence', it returns
10065 the last key sequence that has been read.
10066 The value is a string or a vector. */)
10069 return make_event_array (this_command_key_count
,
10070 XVECTOR (this_command_keys
)->contents
);
10073 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10074 doc
: /* Return the key sequence that invoked this command, as a vector.
10075 However, if the command has called `read-key-sequence', it returns
10076 the last key sequence that has been read. */)
10079 return Fvector (this_command_key_count
,
10080 XVECTOR (this_command_keys
)->contents
);
10083 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10084 Sthis_single_command_keys
, 0, 0, 0,
10085 doc
: /* Return the key sequence that invoked this command.
10086 More generally, it returns the last key sequence read, either by
10087 the command loop or by `read-key-sequence'.
10088 Unlike `this-command-keys', this function's value
10089 does not include prefix arguments.
10090 The value is always a vector. */)
10093 return Fvector (this_command_key_count
10094 - this_single_command_key_start
,
10095 (XVECTOR (this_command_keys
)->contents
10096 + this_single_command_key_start
));
10099 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10100 Sthis_single_command_raw_keys
, 0, 0, 0,
10101 doc
: /* Return the raw events that were read for this command.
10102 More generally, it returns the last key sequence read, either by
10103 the command loop or by `read-key-sequence'.
10104 Unlike `this-single-command-keys', this function's value
10105 shows the events before all translations (except for input methods).
10106 The value is always a vector. */)
10109 return Fvector (raw_keybuf_count
,
10110 (XVECTOR (raw_keybuf
)->contents
));
10113 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10114 Sreset_this_command_lengths
, 0, 0, 0,
10115 doc
: /* Make the unread events replace the last command and echo.
10116 Used in `universal-argument-other-key'.
10118 `universal-argument-other-key' rereads the event just typed.
10119 It then gets translated through `function-key-map'.
10120 The translated event has to replace the real events,
10121 both in the value of (this-command-keys) and in echoing.
10122 To achieve this, `universal-argument-other-key' calls
10123 `reset-this-command-lengths', which discards the record of reading
10124 these events the first time. */)
10127 this_command_key_count
= before_command_key_count
;
10128 if (this_command_key_count
< this_single_command_key_start
)
10129 this_single_command_key_start
= this_command_key_count
;
10131 echo_truncate (before_command_echo_length
);
10133 /* Cause whatever we put into unread-command-events
10134 to echo as if it were being freshly read from the keyboard. */
10135 this_command_key_count_reset
= 1;
10140 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10141 Sclear_this_command_keys
, 0, 1, 0,
10142 doc
: /* Clear out the vector that `this-command-keys' returns.
10143 Also clear the record of the last 100 events, unless optional arg
10144 KEEP-RECORD is non-nil. */)
10146 Lisp_Object keep_record
;
10150 this_command_key_count
= 0;
10151 this_command_key_count_reset
= 0;
10153 if (NILP (keep_record
))
10155 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10156 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10158 recent_keys_index
= 0;
10163 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10164 doc
: /* Return the current depth in recursive edits. */)
10168 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10172 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10173 "FOpen dribble file: ",
10174 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10175 If FILE is nil, close any open dribble file. */)
10186 file
= Fexpand_file_name (file
, Qnil
);
10187 dribble
= fopen (SDATA (file
), "w");
10189 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10194 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10195 doc
: /* Discard the contents of the terminal input buffer.
10196 Also end any kbd macro being defined. */)
10199 if (!NILP (current_kboard
->defining_kbd_macro
))
10201 /* Discard the last command from the macro. */
10202 Fcancel_kbd_macro_events ();
10206 update_mode_lines
++;
10208 Vunread_command_events
= Qnil
;
10209 unread_command_char
= -1;
10211 discard_tty_input ();
10213 kbd_fetch_ptr
= kbd_store_ptr
;
10219 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10220 doc
: /* Stop Emacs and return to superior process. You can resume later.
10221 If `cannot-suspend' is non-nil, or if the system doesn't support job
10222 control, run a subshell instead.
10224 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10225 to be read as terminal input by Emacs's parent, after suspension.
10227 Before suspending, run the normal hook `suspend-hook'.
10228 After resumption run the normal hook `suspend-resume-hook'.
10230 Some operating systems cannot stop the Emacs process and resume it later.
10231 On such systems, Emacs starts a subshell instead of suspending. */)
10233 Lisp_Object stuffstring
;
10235 int count
= SPECPDL_INDEX ();
10236 int old_height
, old_width
;
10238 struct gcpro gcpro1
;
10240 if (tty_list
&& tty_list
->next
)
10241 error ("There are other tty frames open; close them before suspending Emacs");
10243 if (!NILP (stuffstring
))
10244 CHECK_STRING (stuffstring
);
10246 /* Run the functions in suspend-hook. */
10247 if (!NILP (Vrun_hooks
))
10248 call1 (Vrun_hooks
, intern ("suspend-hook"));
10250 GCPRO1 (stuffstring
);
10251 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10252 reset_all_sys_modes ();
10253 /* sys_suspend can get an error if it tries to fork a subshell
10254 and the system resources aren't available for that. */
10255 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10257 stuff_buffered_input (stuffstring
);
10258 if (cannot_suspend
)
10262 unbind_to (count
, Qnil
);
10264 /* Check if terminal/window size has changed.
10265 Note that this is not useful when we are running directly
10266 with a window system; but suspend should be disabled in that case. */
10267 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10268 if (width
!= old_width
|| height
!= old_height
)
10269 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10271 /* Run suspend-resume-hook. */
10272 if (!NILP (Vrun_hooks
))
10273 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10279 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10280 Then in any case stuff anything Emacs has read ahead and not used. */
10283 stuff_buffered_input (stuffstring
)
10284 Lisp_Object stuffstring
;
10286 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10287 register unsigned char *p
;
10289 if (STRINGP (stuffstring
))
10291 register int count
;
10293 p
= SDATA (stuffstring
);
10294 count
= SBYTES (stuffstring
);
10295 while (count
-- > 0)
10300 /* Anything we have read ahead, put back for the shell to read. */
10301 /* ?? What should this do when we have multiple keyboards??
10302 Should we ignore anything that was typed in at the "wrong" kboard?
10304 rms: we should stuff everything back into the kboard
10306 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10309 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10310 kbd_fetch_ptr
= kbd_buffer
;
10311 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10312 stuff_char (kbd_fetch_ptr
->code
);
10314 clear_event (kbd_fetch_ptr
);
10318 #endif /* SIGTSTP */
10322 set_waiting_for_input (time_to_clear
)
10323 EMACS_TIME
*time_to_clear
;
10325 input_available_clear_time
= time_to_clear
;
10327 /* Tell handle_interrupt to throw back to read_char, */
10328 waiting_for_input
= 1;
10330 /* If handle_interrupt was called before and buffered a C-g,
10331 make it run again now, to avoid timing error. */
10332 if (!NILP (Vquit_flag
))
10333 quit_throw_to_read_char ();
10337 clear_waiting_for_input ()
10339 /* Tell handle_interrupt not to throw back to read_char, */
10340 waiting_for_input
= 0;
10341 input_available_clear_time
= 0;
10344 /* The SIGINT handler.
10346 If we have a frame on the controlling tty, we assume that the
10347 SIGINT was generated by C-g, so we call handle_interrupt.
10348 Otherwise, the handler kills Emacs. */
10351 interrupt_signal (signalnum
) /* If we don't have an argument, */
10352 int signalnum
; /* some compilers complain in signal calls. */
10354 /* Must preserve main program's value of errno. */
10355 int old_errno
= errno
;
10356 struct display
*display
;
10358 #if defined (USG) && !defined (POSIX_SIGNALS)
10359 /* USG systems forget handlers when they are used;
10360 must reestablish each time */
10361 signal (SIGINT
, interrupt_signal
);
10362 signal (SIGQUIT
, interrupt_signal
);
10365 SIGNAL_THREAD_CHECK (signalnum
);
10367 /* See if we have an active display on our controlling terminal. */
10368 display
= get_named_tty_display (NULL
);
10371 /* If there are no frames there, let's pretend that we are a
10372 well-behaving UN*X program and quit. */
10373 fatal_error_signal (SIGTERM
);
10377 /* Otherwise, the SIGINT was probably generated by C-g. */
10379 /* Set internal_last_event_frame to the top frame of the
10380 controlling tty, if we have a frame there. We disable the
10381 interrupt key on secondary ttys, so the SIGINT must have come
10382 from the controlling tty. */
10383 internal_last_event_frame
= display
->display_info
.tty
->top_frame
;
10385 handle_interrupt ();
10391 /* This routine is called at interrupt level in response to C-g.
10393 It is called from the SIGINT handler or kbd_buffer_store_event.
10395 If `waiting_for_input' is non zero, then unless `echoing' is
10396 nonzero, immediately throw back to read_char.
10398 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10399 eval to throw, when it gets a chance. If quit-flag is already
10400 non-nil, it stops the job right away. */
10403 handle_interrupt ()
10409 /* XXX This code needs to be revised for multi-tty support. */
10410 if (!NILP (Vquit_flag
)
10412 && get_named_tty_display (NULL
)
10416 /* If SIGINT isn't blocked, don't let us be interrupted by
10417 another SIGINT, it might be harmful due to non-reentrancy
10418 in I/O functions. */
10419 sigblock (sigmask (SIGINT
));
10422 reset_all_sys_modes ();
10424 #ifdef SIGTSTP /* Support possible in later USG versions */
10426 * On systems which can suspend the current process and return to the original
10427 * shell, this command causes the user to end up back at the shell.
10428 * The "Auto-save" and "Abort" questions are not asked until
10429 * the user elects to return to emacs, at which point he can save the current
10430 * job and either dump core or continue.
10435 if (sys_suspend () == -1)
10437 printf ("Not running as a subprocess;\n");
10438 printf ("you can continue or abort.\n");
10440 #else /* not VMS */
10441 /* Perhaps should really fork an inferior shell?
10442 But that would not provide any way to get back
10443 to the original shell, ever. */
10444 printf ("No support for stopping a process on this operating system;\n");
10445 printf ("you can continue or abort.\n");
10446 #endif /* not VMS */
10447 #endif /* not SIGTSTP */
10449 /* We must remain inside the screen area when the internal terminal
10450 is used. Note that [Enter] is not echoed by dos. */
10453 /* It doesn't work to autosave while GC is in progress;
10454 the code used for auto-saving doesn't cope with the mark bit. */
10455 if (!gc_in_progress
)
10457 printf ("Auto-save? (y or n) ");
10459 if (((c
= getchar ()) & ~040) == 'Y')
10461 Fdo_auto_save (Qt
, Qnil
);
10463 printf ("\r\nAuto-save done");
10464 #else /* not MSDOS */
10465 printf ("Auto-save done\n");
10466 #endif /* not MSDOS */
10468 while (c
!= '\n') c
= getchar ();
10472 /* During GC, it must be safe to reenable quitting again. */
10473 Vinhibit_quit
= Qnil
;
10476 #endif /* not MSDOS */
10477 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10478 printf ("but will instead do a real quit after garbage collection ends\r\n");
10483 printf ("\r\nAbort? (y or n) ");
10484 #else /* not MSDOS */
10486 printf ("Abort (and enter debugger)? (y or n) ");
10487 #else /* not VMS */
10488 printf ("Abort (and dump core)? (y or n) ");
10489 #endif /* not VMS */
10490 #endif /* not MSDOS */
10492 if (((c
= getchar ()) & ~040) == 'Y')
10494 while (c
!= '\n') c
= getchar ();
10496 printf ("\r\nContinuing...\r\n");
10497 #else /* not MSDOS */
10498 printf ("Continuing...\n");
10499 #endif /* not MSDOS */
10501 init_all_sys_modes ();
10506 /* If executing a function that wants to be interrupted out of
10507 and the user has not deferred quitting by binding `inhibit-quit'
10508 then quit right away. */
10509 if (immediate_quit
&& NILP (Vinhibit_quit
))
10511 struct gl_state_s saved
;
10512 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10514 immediate_quit
= 0;
10517 GCPRO4 (saved
.object
, saved
.global_code
,
10518 saved
.current_syntax_table
, saved
.old_prop
);
10519 Fsignal (Qquit
, Qnil
);
10524 /* Else request quit when it's safe */
10528 if (waiting_for_input
&& !echoing
)
10529 quit_throw_to_read_char ();
10532 /* Handle a C-g by making read_char return C-g. */
10535 quit_throw_to_read_char ()
10538 /* Prevent another signal from doing this before we finish. */
10539 clear_waiting_for_input ();
10542 Vunread_command_events
= Qnil
;
10543 unread_command_char
= -1;
10545 #if 0 /* Currently, sit_for is called from read_char without turning
10546 off polling. And that can call set_waiting_for_input.
10547 It seems to be harmless. */
10548 #ifdef POLL_FOR_INPUT
10549 /* May be > 1 if in recursive minibuffer. */
10550 if (poll_suppress_count
== 0)
10554 if (FRAMEP (internal_last_event_frame
)
10555 && !EQ (internal_last_event_frame
, selected_frame
))
10556 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10559 _longjmp (getcjmp
, 1);
10562 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10563 doc
: /* Set mode of reading keyboard input.
10564 First arg INTERRUPT non-nil means use input interrupts;
10565 nil means use CBREAK mode.
10566 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10567 (no effect except in CBREAK mode).
10568 Third arg META t means accept 8-bit input (for a Meta key).
10569 META nil means ignore the top bit, on the assumption it is parity.
10570 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10571 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10572 See also `current-input-mode'. */)
10573 (interrupt
, flow
, meta
, quit
)
10574 Lisp_Object interrupt
, flow
, meta
, quit
;
10576 /* XXX This function needs to be revised for multi-device support.
10577 Currently it compiles fine, but its semantics are wrong. It sets
10578 global parameters (e.g. interrupt_input) based on only the
10579 current frame's device. */
10582 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10583 error ("set-input-mode: QUIT must be an ASCII character");
10585 #ifdef POLL_FOR_INPUT
10590 /* this causes startup screen to be restored and messes with the mouse */
10591 reset_all_sys_modes ();
10595 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10596 if (FRAME_DISPLAY (SELECTED_FRAME ())->read_socket_hook
)
10598 /* When using X, don't give the user a real choice,
10599 because we haven't implemented the mechanisms to support it. */
10600 #ifdef NO_SOCK_SIGIO
10601 interrupt_input
= 0;
10602 #else /* not NO_SOCK_SIGIO */
10603 interrupt_input
= 1;
10604 #endif /* NO_SOCK_SIGIO */
10607 interrupt_input
= !NILP (interrupt
);
10608 #else /* not SIGIO */
10609 interrupt_input
= 0;
10610 #endif /* not SIGIO */
10612 /* Our VMS input only works by interrupts, as of now. */
10614 interrupt_input
= 1;
10617 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10619 struct tty_display_info
*tty
= CURTTY ();
10620 tty
->flow_control
= !NILP (flow
);
10623 else if (EQ (meta
, Qt
))
10630 /* Don't let this value be out of range. */
10631 quit_char
= XINT (quit
) & (NILP (meta
) ? 0177 : 0377);
10634 init_all_sys_modes ();
10637 #ifdef POLL_FOR_INPUT
10638 poll_suppress_count
= 1;
10644 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10645 doc
: /* Return information about the way Emacs currently reads keyboard input.
10646 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10647 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10648 nil, Emacs is using CBREAK mode.
10649 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10650 terminal; this does not apply if Emacs uses interrupt-driven input.
10651 META is t if accepting 8-bit input with 8th bit as Meta flag.
10652 META nil means ignoring the top bit, on the assumption it is parity.
10653 META is neither t nor nil if accepting 8-bit input and using
10654 all 8 bits as the character code.
10655 QUIT is the character Emacs currently uses to quit.
10656 The elements of this list correspond to the arguments of
10657 `set-input-mode'. */)
10660 Lisp_Object val
[4];
10661 struct frame
*sf
= XFRAME (selected_frame
);
10663 val
[0] = interrupt_input
? Qt
: Qnil
;
10664 if (FRAME_TERMCAP_P (sf
))
10666 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10667 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10669 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10676 XSETFASTINT (val
[3], quit_char
);
10678 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10681 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10682 doc
: /* Return position information for pixel coordinates X and Y.
10683 By default, X and Y are relative to text area of the selected window.
10684 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10685 If optional fourth arg WHOLE is non-nil, X is relative to the left
10686 edge of the window.
10688 The return value is similar to a mouse click position:
10689 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10690 IMAGE (DX . DY) (WIDTH . HEIGHT))
10691 The `posn-' functions access elements of such lists. */)
10692 (x
, y
, frame_or_window
, whole
)
10693 Lisp_Object x
, y
, frame_or_window
, whole
;
10698 if (NILP (frame_or_window
))
10699 frame_or_window
= selected_window
;
10701 if (WINDOWP (frame_or_window
))
10705 CHECK_LIVE_WINDOW (frame_or_window
);
10707 w
= XWINDOW (frame_or_window
);
10708 XSETINT (x
, (WINDOW_TO_FRAME_PIXEL_X (w
, XINT (x
))
10710 ? window_box_left_offset (w
, TEXT_AREA
)
10711 : - (WINDOW_LEFT_SCROLL_BAR_COLS (w
)
10712 * WINDOW_FRAME_COLUMN_WIDTH (w
)))));
10713 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10714 frame_or_window
= w
->frame
;
10717 CHECK_LIVE_FRAME (frame_or_window
);
10719 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10722 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10723 doc
: /* Return position information for buffer POS in WINDOW.
10724 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10726 Return nil if position is not visible in window. Otherwise,
10727 the return value is similar to that returned by `event-start' for
10728 a mouse click at the upper left corner of the glyph corresponding
10729 to the given buffer position:
10730 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10731 IMAGE (DX . DY) (WIDTH . HEIGHT))
10732 The `posn-' functions access elements of such lists. */)
10734 Lisp_Object pos
, window
;
10738 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10740 tem
= Fposn_at_x_y (XCAR (tem
), XCAR (XCDR (tem
)), window
, Qnil
);
10746 * Set up a new kboard object with reasonable initial values.
10752 kb
->Voverriding_terminal_local_map
= Qnil
;
10753 kb
->Vlast_command
= Qnil
;
10754 kb
->Vreal_last_command
= Qnil
;
10755 kb
->Vprefix_arg
= Qnil
;
10756 kb
->Vlast_prefix_arg
= Qnil
;
10757 kb
->kbd_queue
= Qnil
;
10758 kb
->kbd_queue_has_data
= 0;
10759 kb
->immediate_echo
= 0;
10760 kb
->echo_string
= Qnil
;
10761 kb
->echo_after_prompt
= -1;
10762 kb
->kbd_macro_buffer
= 0;
10763 kb
->kbd_macro_bufsize
= 0;
10764 kb
->defining_kbd_macro
= Qnil
;
10765 kb
->Vlast_kbd_macro
= Qnil
;
10766 kb
->reference_count
= 0;
10767 kb
->Vsystem_key_alist
= Qnil
;
10768 kb
->system_key_syms
= Qnil
;
10769 kb
->Vdefault_minibuffer_frame
= Qnil
;
10773 * Destroy the contents of a kboard object, but not the object itself.
10774 * We use this just before deleting it, or if we're going to initialize
10775 * it a second time.
10781 if (kb
->kbd_macro_buffer
)
10782 xfree (kb
->kbd_macro_buffer
);
10785 #ifdef MULTI_KBOARD
10787 /* Free KB and memory referenced from it. */
10795 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10798 *kbp
= kb
->next_kboard
;
10800 /* Prevent a dangling reference to KB. */
10801 if (kb
== current_kboard
10802 && FRAMEP (selected_frame
)
10803 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10805 current_kboard
= XFRAME (selected_frame
)->kboard
;
10806 if (current_kboard
== kb
)
10814 #endif /* MULTI_KBOARD */
10819 /* This is correct before outermost invocation of the editor loop */
10820 command_loop_level
= -1;
10821 immediate_quit
= 0;
10822 quit_char
= Ctl ('g');
10823 Vunread_command_events
= Qnil
;
10824 unread_command_char
= -1;
10825 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10827 recent_keys_index
= 0;
10828 kbd_fetch_ptr
= kbd_buffer
;
10829 kbd_store_ptr
= kbd_buffer
;
10831 do_mouse_tracking
= Qnil
;
10835 /* This means that command_loop_1 won't try to select anything the first
10837 internal_last_event_frame
= Qnil
;
10838 Vlast_event_frame
= internal_last_event_frame
;
10840 #ifdef MULTI_KBOARD
10841 current_kboard
= initial_kboard
;
10843 wipe_kboard (current_kboard
);
10844 init_kboard (current_kboard
);
10846 if (!noninteractive
)
10848 /* Before multi-tty support, these handlers used to be installed
10849 only if the current session was a tty session. Now an Emacs
10850 session may have multiple display types, so we always handle
10851 SIGINT. There is special code in interrupt_signal to exit
10852 Emacs on SIGINT when there are no termcap frames on the
10853 controlling terminal. */
10854 signal (SIGINT
, interrupt_signal
);
10855 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10856 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10857 SIGQUIT and we can't tell which one it will give us. */
10858 signal (SIGQUIT
, interrupt_signal
);
10859 #endif /* HAVE_TERMIO */
10861 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10863 if (!noninteractive
)
10864 signal (SIGIO
, input_available_signal
);
10867 /* Use interrupt input by default, if it works and noninterrupt input
10868 has deficiencies. */
10870 #ifdef INTERRUPT_INPUT
10871 interrupt_input
= 1;
10873 interrupt_input
= 0;
10876 /* Our VMS input only works by interrupts, as of now. */
10878 interrupt_input
= 1;
10884 if (keyboard_init_hook
)
10885 (*keyboard_init_hook
) ();
10887 #ifdef POLL_FOR_INPUT
10888 poll_suppress_count
= 1;
10893 /* At least provide an escape route since C-g doesn't work. */
10894 signal (SIGINT
, interrupt_signal
);
10898 /* This type's only use is in syms_of_keyboard, to initialize the
10899 event header symbols and put properties on them. */
10900 struct event_head
{
10906 struct event_head head_table
[] = {
10907 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10908 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10909 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10910 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10911 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10912 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10913 /* `select-window' should be handled just like `switch-frame'
10914 in read_key_sequence. */
10915 {&Qselect_window
, "select-window", &Qswitch_frame
}
10919 syms_of_keyboard ()
10921 Vpre_help_message
= Qnil
;
10922 staticpro (&Vpre_help_message
);
10924 Vlispy_mouse_stem
= build_string ("mouse");
10925 staticpro (&Vlispy_mouse_stem
);
10928 QCimage
= intern (":image");
10929 staticpro (&QCimage
);
10931 staticpro (&Qhelp_echo
);
10932 Qhelp_echo
= intern ("help-echo");
10934 staticpro (&item_properties
);
10935 item_properties
= Qnil
;
10937 staticpro (&tool_bar_item_properties
);
10938 tool_bar_item_properties
= Qnil
;
10939 staticpro (&tool_bar_items_vector
);
10940 tool_bar_items_vector
= Qnil
;
10942 staticpro (&real_this_command
);
10943 real_this_command
= Qnil
;
10945 Qtimer_event_handler
= intern ("timer-event-handler");
10946 staticpro (&Qtimer_event_handler
);
10948 Qdisabled_command_function
= intern ("disabled-command-function");
10949 staticpro (&Qdisabled_command_function
);
10951 Qself_insert_command
= intern ("self-insert-command");
10952 staticpro (&Qself_insert_command
);
10954 Qforward_char
= intern ("forward-char");
10955 staticpro (&Qforward_char
);
10957 Qbackward_char
= intern ("backward-char");
10958 staticpro (&Qbackward_char
);
10960 Qdisabled
= intern ("disabled");
10961 staticpro (&Qdisabled
);
10963 Qundefined
= intern ("undefined");
10964 staticpro (&Qundefined
);
10966 Qpre_command_hook
= intern ("pre-command-hook");
10967 staticpro (&Qpre_command_hook
);
10969 Qpost_command_hook
= intern ("post-command-hook");
10970 staticpro (&Qpost_command_hook
);
10972 Qdeferred_action_function
= intern ("deferred-action-function");
10973 staticpro (&Qdeferred_action_function
);
10975 Qcommand_hook_internal
= intern ("command-hook-internal");
10976 staticpro (&Qcommand_hook_internal
);
10978 Qfunction_key
= intern ("function-key");
10979 staticpro (&Qfunction_key
);
10980 Qmouse_click
= intern ("mouse-click");
10981 staticpro (&Qmouse_click
);
10982 #if defined (WINDOWSNT) || defined (MAC_OS)
10983 Qlanguage_change
= intern ("language-change");
10984 staticpro (&Qlanguage_change
);
10986 Qdrag_n_drop
= intern ("drag-n-drop");
10987 staticpro (&Qdrag_n_drop
);
10989 Qsave_session
= intern ("save-session");
10990 staticpro (&Qsave_session
);
10992 Qusr1_signal
= intern ("usr1-signal");
10993 staticpro (&Qusr1_signal
);
10994 Qusr2_signal
= intern ("usr2-signal");
10995 staticpro (&Qusr2_signal
);
10997 Qmenu_enable
= intern ("menu-enable");
10998 staticpro (&Qmenu_enable
);
10999 Qmenu_alias
= intern ("menu-alias");
11000 staticpro (&Qmenu_alias
);
11001 QCenable
= intern (":enable");
11002 staticpro (&QCenable
);
11003 QCvisible
= intern (":visible");
11004 staticpro (&QCvisible
);
11005 QChelp
= intern (":help");
11006 staticpro (&QChelp
);
11007 QCfilter
= intern (":filter");
11008 staticpro (&QCfilter
);
11009 QCbutton
= intern (":button");
11010 staticpro (&QCbutton
);
11011 QCkeys
= intern (":keys");
11012 staticpro (&QCkeys
);
11013 QCkey_sequence
= intern (":key-sequence");
11014 staticpro (&QCkey_sequence
);
11015 QCtoggle
= intern (":toggle");
11016 staticpro (&QCtoggle
);
11017 QCradio
= intern (":radio");
11018 staticpro (&QCradio
);
11020 Qmode_line
= intern ("mode-line");
11021 staticpro (&Qmode_line
);
11022 Qvertical_line
= intern ("vertical-line");
11023 staticpro (&Qvertical_line
);
11024 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11025 staticpro (&Qvertical_scroll_bar
);
11026 Qmenu_bar
= intern ("menu-bar");
11027 staticpro (&Qmenu_bar
);
11030 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11031 staticpro (&Qmouse_fixup_help_message
);
11034 Qabove_handle
= intern ("above-handle");
11035 staticpro (&Qabove_handle
);
11036 Qhandle
= intern ("handle");
11037 staticpro (&Qhandle
);
11038 Qbelow_handle
= intern ("below-handle");
11039 staticpro (&Qbelow_handle
);
11040 Qup
= intern ("up");
11042 Qdown
= intern ("down");
11043 staticpro (&Qdown
);
11044 Qtop
= intern ("top");
11046 Qbottom
= intern ("bottom");
11047 staticpro (&Qbottom
);
11048 Qend_scroll
= intern ("end-scroll");
11049 staticpro (&Qend_scroll
);
11050 Qratio
= intern ("ratio");
11051 staticpro (&Qratio
);
11053 Qevent_kind
= intern ("event-kind");
11054 staticpro (&Qevent_kind
);
11055 Qevent_symbol_elements
= intern ("event-symbol-elements");
11056 staticpro (&Qevent_symbol_elements
);
11057 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11058 staticpro (&Qevent_symbol_element_mask
);
11059 Qmodifier_cache
= intern ("modifier-cache");
11060 staticpro (&Qmodifier_cache
);
11062 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11063 staticpro (&Qrecompute_lucid_menubar
);
11064 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11065 staticpro (&Qactivate_menubar_hook
);
11067 Qpolling_period
= intern ("polling-period");
11068 staticpro (&Qpolling_period
);
11070 Qinput_method_function
= intern ("input-method-function");
11071 staticpro (&Qinput_method_function
);
11073 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11074 staticpro (&Qinput_method_exit_on_first_char
);
11075 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11076 staticpro (&Qinput_method_use_echo_area
);
11078 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11079 Fset (Qinput_method_use_echo_area
, Qnil
);
11081 last_point_position_buffer
= Qnil
;
11084 struct event_head
*p
;
11086 for (p
= head_table
;
11087 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11090 *p
->var
= intern (p
->name
);
11091 staticpro (p
->var
);
11092 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11093 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11097 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11098 staticpro (&button_down_location
);
11099 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11100 staticpro (&mouse_syms
);
11101 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11102 staticpro (&wheel_syms
);
11106 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11108 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11109 for (i
= 0; i
< len
; i
++)
11110 if (modifier_names
[i
])
11111 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11112 staticpro (&modifier_symbols
);
11115 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11116 staticpro (&recent_keys
);
11118 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11119 staticpro (&this_command_keys
);
11121 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11122 staticpro (&raw_keybuf
);
11124 Qextended_command_history
= intern ("extended-command-history");
11125 Fset (Qextended_command_history
, Qnil
);
11126 staticpro (&Qextended_command_history
);
11128 accent_key_syms
= Qnil
;
11129 staticpro (&accent_key_syms
);
11131 func_key_syms
= Qnil
;
11132 staticpro (&func_key_syms
);
11134 drag_n_drop_syms
= Qnil
;
11135 staticpro (&drag_n_drop_syms
);
11137 unread_switch_frame
= Qnil
;
11138 staticpro (&unread_switch_frame
);
11140 internal_last_event_frame
= Qnil
;
11141 staticpro (&internal_last_event_frame
);
11143 read_key_sequence_cmd
= Qnil
;
11144 staticpro (&read_key_sequence_cmd
);
11146 menu_bar_one_keymap_changed_items
= Qnil
;
11147 staticpro (&menu_bar_one_keymap_changed_items
);
11149 defsubr (&Sevent_convert_list
);
11150 defsubr (&Sread_key_sequence
);
11151 defsubr (&Sread_key_sequence_vector
);
11152 defsubr (&Srecursive_edit
);
11154 defsubr (&Strack_mouse
);
11156 defsubr (&Sinput_pending_p
);
11157 defsubr (&Scommand_execute
);
11158 defsubr (&Srecent_keys
);
11159 defsubr (&Sthis_command_keys
);
11160 defsubr (&Sthis_command_keys_vector
);
11161 defsubr (&Sthis_single_command_keys
);
11162 defsubr (&Sthis_single_command_raw_keys
);
11163 defsubr (&Sreset_this_command_lengths
);
11164 defsubr (&Sclear_this_command_keys
);
11165 defsubr (&Ssuspend_emacs
);
11166 defsubr (&Sabort_recursive_edit
);
11167 defsubr (&Sexit_recursive_edit
);
11168 defsubr (&Srecursion_depth
);
11169 defsubr (&Stop_level
);
11170 defsubr (&Sdiscard_input
);
11171 defsubr (&Sopen_dribble_file
);
11172 defsubr (&Sset_input_mode
);
11173 defsubr (&Scurrent_input_mode
);
11174 defsubr (&Sexecute_extended_command
);
11175 defsubr (&Sposn_at_point
);
11176 defsubr (&Sposn_at_x_y
);
11178 DEFVAR_LISP ("last-command-char", &last_command_char
,
11179 doc
: /* Last input event that was part of a command. */);
11181 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11182 doc
: /* Last input event that was part of a command. */);
11184 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11185 doc
: /* Last input event in a command, except for mouse menu events.
11186 Mouse menus give back keys that don't look like mouse events;
11187 this variable holds the actual mouse event that led to the menu,
11188 so that you can determine whether the command was run by mouse or not. */);
11190 DEFVAR_LISP ("last-input-char", &last_input_char
,
11191 doc
: /* Last input event. */);
11193 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11194 doc
: /* Last input event. */);
11196 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11197 doc
: /* List of events to be read as the command input.
11198 These events are processed first, before actual keyboard input. */);
11199 Vunread_command_events
= Qnil
;
11201 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11202 doc
: /* If not -1, an object to be read as next command input event. */);
11204 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11205 doc
: /* List of events to be processed as input by input methods.
11206 These events are processed after `unread-command-events', but
11207 before actual keyboard input. */);
11208 Vunread_post_input_method_events
= Qnil
;
11210 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11211 doc
: /* List of events to be processed as input by input methods.
11212 These events are processed after `unread-command-events', but
11213 before actual keyboard input. */);
11214 Vunread_input_method_events
= Qnil
;
11216 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11217 doc
: /* Meta-prefix character code.
11218 Meta-foo as command input turns into this character followed by foo. */);
11219 XSETINT (meta_prefix_char
, 033);
11221 DEFVAR_KBOARD ("last-command", Vlast_command
,
11222 doc
: /* The last command executed.
11223 Normally a symbol with a function definition, but can be whatever was found
11224 in the keymap, or whatever the variable `this-command' was set to by that
11227 The value `mode-exit' is special; it means that the previous command
11228 read an event that told it to exit, and it did so and unread that event.
11229 In other words, the present command is the event that made the previous
11232 The value `kill-region' is special; it means that the previous command
11233 was a kill command. */);
11235 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11236 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11238 DEFVAR_LISP ("this-command", &Vthis_command
,
11239 doc
: /* The command now being executed.
11240 The command can set this variable; whatever is put here
11241 will be in `last-command' during the following command. */);
11242 Vthis_command
= Qnil
;
11244 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11245 doc
: /* The command bound to the current key sequence before remapping.
11246 It equals `this-command' if the original command was not remapped through
11247 any of the active keymaps. Otherwise, the value of `this-command' is the
11248 result of looking up the original command in the active keymaps. */);
11249 Vthis_original_command
= Qnil
;
11251 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11252 doc
: /* *Number of input events between auto-saves.
11253 Zero means disable autosaving due to number of characters typed. */);
11254 auto_save_interval
= 300;
11256 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11257 doc
: /* *Number of seconds idle time before auto-save.
11258 Zero or nil means disable auto-saving due to idleness.
11259 After auto-saving due to this many seconds of idle time,
11260 Emacs also does a garbage collection if that seems to be warranted. */);
11261 XSETFASTINT (Vauto_save_timeout
, 30);
11263 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11264 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11265 The value may be integer or floating point. */);
11266 Vecho_keystrokes
= make_number (1);
11268 DEFVAR_INT ("polling-period", &polling_period
,
11269 doc
: /* *Interval between polling for input during Lisp execution.
11270 The reason for polling is to make C-g work to stop a running program.
11271 Polling is needed only when using X windows and SIGIO does not work.
11272 Polling is automatically disabled in all other cases. */);
11273 polling_period
= 2;
11275 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11276 doc
: /* *Maximum time between mouse clicks to make a double-click.
11277 Measured in milliseconds. nil means disable double-click recognition;
11278 t means double-clicks have no time limit and are detected
11279 by position only. */);
11280 Vdouble_click_time
= make_number (500);
11282 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11283 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11284 On window-system frames, value is the number of pixels the mouse may have
11285 moved horizontally or vertically between two clicks to make a double-click.
11286 On non window-system frames, value is interpreted in units of 1/8 characters
11289 This variable is also the threshold for motion of the mouse
11290 to count as a drag. */);
11291 double_click_fuzz
= 3;
11293 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11294 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11295 inhibit_local_menu_bar_menus
= 0;
11297 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11298 doc
: /* Number of complete key sequences read as input so far.
11299 This includes key sequences read from keyboard macros.
11300 The number is effectively the number of interactive command invocations. */);
11301 num_input_keys
= 0;
11303 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11304 doc
: /* Number of input events read from the keyboard so far.
11305 This does not include events generated by keyboard macros. */);
11306 num_nonmacro_input_events
= 0;
11308 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11309 doc
: /* The frame in which the most recently read event occurred.
11310 If the last event came from a keyboard macro, this is set to `macro'. */);
11311 Vlast_event_frame
= Qnil
;
11313 /* This variable is set up in sysdep.c. */
11314 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11315 doc
: /* The ERASE character as set by the user with stty. */);
11317 DEFVAR_LISP ("help-char", &Vhelp_char
,
11318 doc
: /* Character to recognize as meaning Help.
11319 When it is read, do `(eval help-form)', and display result if it's a string.
11320 If the value of `help-form' is nil, this char can be read normally. */);
11321 XSETINT (Vhelp_char
, Ctl ('H'));
11323 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11324 doc
: /* List of input events to recognize as meaning Help.
11325 These work just like the value of `help-char' (see that). */);
11326 Vhelp_event_list
= Qnil
;
11328 DEFVAR_LISP ("help-form", &Vhelp_form
,
11329 doc
: /* Form to execute when character `help-char' is read.
11330 If the form returns a string, that string is displayed.
11331 If `help-form' is nil, the help char is not recognized. */);
11334 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11335 doc
: /* Command to run when `help-char' character follows a prefix key.
11336 This command is used only when there is no actual binding
11337 for that character after that prefix key. */);
11338 Vprefix_help_command
= Qnil
;
11340 DEFVAR_LISP ("top-level", &Vtop_level
,
11341 doc
: /* Form to evaluate when Emacs starts up.
11342 Useful to set before you dump a modified Emacs. */);
11345 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11346 doc
: /* Translate table for keyboard input, or nil.
11347 If non-nil, the value should be a char-table. Each character read
11348 from the keyboard is looked up in this char-table. If the value found
11349 there is non-nil, then it is used instead of the actual input character.
11351 The value can also be a string or vector, but this is considered obsolete.
11352 If it is a string or vector of length N, character codes N and up are left
11353 untranslated. In a vector, an element which is nil means "no translation".
11355 This is applied to the characters supplied to input methods, not their
11356 output. See also `translation-table-for-input'. */);
11357 Vkeyboard_translate_table
= Qnil
;
11359 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11360 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11361 \(Even if the operating system has support for stopping a process.\) */);
11362 cannot_suspend
= 0;
11364 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11365 doc
: /* Non-nil means prompt with menus when appropriate.
11366 This is done when reading from a keymap that has a prompt string,
11367 for elements that have prompt strings.
11368 The menu is displayed on the screen
11369 if X menus were enabled at configuration
11370 time and the previous event was a mouse click prefix key.
11371 Otherwise, menu prompting uses the echo area. */);
11372 menu_prompting
= 1;
11374 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11375 doc
: /* Character to see next line of menu prompt.
11376 Type this character while in a menu prompt to rotate around the lines of it. */);
11377 XSETINT (menu_prompt_more_char
, ' ');
11379 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11380 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11381 Emacs applies the modifiers of the character stored here to each keyboard
11382 character it reads. For example, after evaluating the expression
11383 (setq extra-keyboard-modifiers ?\\C-x)
11384 all input characters will have the control modifier applied to them.
11386 Note that the character ?\\C-@, equivalent to the integer zero, does
11387 not count as a control character; rather, it counts as a character
11388 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11389 cancels any modification. */);
11390 extra_keyboard_modifiers
= 0;
11392 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11393 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11394 The command loop sets this to nil before each command,
11395 and tests the value when the command returns.
11396 Buffer modification stores t in this variable. */);
11397 Vdeactivate_mark
= Qnil
;
11399 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11400 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11401 Vcommand_hook_internal
= Qnil
;
11403 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11404 doc
: /* Normal hook run before each command is executed.
11405 If an unhandled error happens in running this hook,
11406 the hook value is set to nil, since otherwise the error
11407 might happen repeatedly and make Emacs nonfunctional. */);
11408 Vpre_command_hook
= Qnil
;
11410 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11411 doc
: /* Normal hook run after each command is executed.
11412 If an unhandled error happens in running this hook,
11413 the hook value is set to nil, since otherwise the error
11414 might happen repeatedly and make Emacs nonfunctional. */);
11415 Vpost_command_hook
= Qnil
;
11418 DEFVAR_LISP ("echo-area-clear-hook", ...,
11419 doc
: /* Normal hook run when clearing the echo area. */);
11421 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11422 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11424 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11425 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11426 Vlucid_menu_bar_dirty_flag
= Qnil
;
11428 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11429 doc
: /* List of menu bar items to move to the end of the menu bar.
11430 The elements of the list are event types that may have menu bar bindings. */);
11431 Vmenu_bar_final_items
= Qnil
;
11433 DEFVAR_KBOARD ("overriding-terminal-local-map",
11434 Voverriding_terminal_local_map
,
11435 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11436 If this variable is non-nil, it is used as a keymap instead of the
11437 buffer's local map, and the minor mode keymaps and text property keymaps.
11438 It also replaces `overriding-local-map'.
11440 This variable is intended to let commands such as `universal-argument'
11441 set up a different keymap for reading the next command. */);
11443 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11444 doc
: /* Keymap that overrides all other local keymaps.
11445 If this variable is non-nil, it is used as a keymap--replacing the
11446 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11447 Voverriding_local_map
= Qnil
;
11449 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11450 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11451 Otherwise, the menu bar continues to reflect the buffer's local map
11452 and the minor mode maps regardless of `overriding-local-map'. */);
11453 Voverriding_local_map_menu_flag
= Qnil
;
11455 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11456 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11457 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11459 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11460 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11462 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11463 doc
: /* Alist of system-specific X windows key symbols.
11464 Each element should have the form (N . SYMBOL) where N is the
11465 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11466 and SYMBOL is its name. */);
11468 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11469 doc
: /* List of deferred actions to be performed at a later time.
11470 The precise format isn't relevant here; we just check whether it is nil. */);
11471 Vdeferred_action_list
= Qnil
;
11473 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11474 doc
: /* Function to call to handle deferred actions, after each command.
11475 This function is called with no arguments after each command
11476 whenever `deferred-action-list' is non-nil. */);
11477 Vdeferred_action_function
= Qnil
;
11479 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11480 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11481 The value can be a length of time to show the message for.
11482 If the value is non-nil and not a number, we wait 2 seconds. */);
11483 Vsuggest_key_bindings
= Qt
;
11485 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11486 doc
: /* List of active absolute time timers in order of increasing time. */);
11487 Vtimer_list
= Qnil
;
11489 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11490 doc
: /* List of active idle-time timers in order of increasing time. */);
11491 Vtimer_idle_list
= Qnil
;
11493 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11494 doc
: /* If non-nil, the function that implements the current input method.
11495 It's called with one argument, a printing character that was just read.
11496 \(That means a character with code 040...0176.)
11497 Typically this function uses `read-event' to read additional events.
11498 When it does so, it should first bind `input-method-function' to nil
11499 so it will not be called recursively.
11501 The function should return a list of zero or more events
11502 to be used as input. If it wants to put back some events
11503 to be reconsidered, separately, by the input method,
11504 it can add them to the beginning of `unread-command-events'.
11506 The input method function can find in `input-method-previous-method'
11507 the previous echo area message.
11509 The input method function should refer to the variables
11510 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11511 for guidance on what to do. */);
11512 Vinput_method_function
= Qnil
;
11514 DEFVAR_LISP ("input-method-previous-message",
11515 &Vinput_method_previous_message
,
11516 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11517 This variable exists because `read-event' clears the echo area
11518 before running the input method. It is nil if there was no message. */);
11519 Vinput_method_previous_message
= Qnil
;
11521 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11522 doc
: /* If non-nil, the function that implements the display of help.
11523 It's called with one argument, the help string to display. */);
11524 Vshow_help_function
= Qnil
;
11526 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11527 doc
: /* If non-nil, suppress point adjustment after executing a command.
11529 After a command is executed, if point is moved into a region that has
11530 special properties (e.g. composition, display), we adjust point to
11531 the boundary of the region. But, when a command sets this variable to
11532 non-nil, we suppress the point adjustment.
11534 This variable is set to nil before reading a command, and is checked
11535 just after executing the command. */);
11536 Vdisable_point_adjustment
= Qnil
;
11538 DEFVAR_LISP ("global-disable-point-adjustment",
11539 &Vglobal_disable_point_adjustment
,
11540 doc
: /* *If non-nil, always suppress point adjustment.
11542 The default value is nil, in which case, point adjustment are
11543 suppressed only after special commands that set
11544 `disable-point-adjustment' (which see) to non-nil. */);
11545 Vglobal_disable_point_adjustment
= Qnil
;
11547 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11548 doc
: /* Non-nil means updating menu bindings is allowed.
11549 A value of nil means menu bindings should not be updated.
11550 Used during Emacs' startup. */);
11551 update_menu_bindings
= 1;
11553 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11554 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11555 If the value is not a number, such messages don't time out. */);
11556 Vminibuffer_message_timeout
= make_number (2);
11558 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11559 doc
: /* If non-nil, any keyboard input throws to this symbol.
11560 The value of that variable is passed to `quit-flag' and later causes a
11561 peculiar kind of quitting. */);
11562 Vthrow_on_input
= Qnil
;
11566 keys_of_keyboard ()
11568 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11569 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11570 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11571 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11572 initial_define_key (meta_map
, 'x', "execute-extended-command");
11574 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11575 "handle-delete-frame");
11576 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11577 current-prefix-arg, as is done in `handle-switch-frame'.
11578 But `handle-switch-frame is not run from the special-map.
11579 Commands from that map are run in a special way that automatically
11580 preserves the prefix-arg. Restoring the prefix arg here is not just
11581 redundant but harmful:
11583 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11584 - after the first prompt, the exit-minibuffer-hook is run which may
11585 iconify a frame and thus push a `iconify-frame' event.
11586 - after running exit-minibuffer-hook, current-prefix-arg is
11587 restored to the non-nil value it had before the prompt.
11588 - we enter the second prompt.
11589 current-prefix-arg is non-nil, prefix-arg is nil.
11590 - before running the first real event, we run the special iconify-frame
11591 event, but we pass the `special' arg to execute-command so
11592 current-prefix-arg and prefix-arg are left untouched.
11593 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11594 - the next key event will have a spuriously non-nil current-prefix-arg. */
11595 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11597 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11599 /* Handling it at such a low-level causes read_key_sequence to get
11600 * confused because it doesn't realize that the current_buffer was
11601 * changed by read_char.
11603 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11604 * "handle-select-window"); */
11605 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11606 "handle-save-session");
11609 /* Mark the pointers in the kboard objects.
11610 Called by the Fgarbage_collector. */
11616 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11618 if (kb
->kbd_macro_buffer
)
11619 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11621 mark_object (kb
->Voverriding_terminal_local_map
);
11622 mark_object (kb
->Vlast_command
);
11623 mark_object (kb
->Vreal_last_command
);
11624 mark_object (kb
->Vprefix_arg
);
11625 mark_object (kb
->Vlast_prefix_arg
);
11626 mark_object (kb
->kbd_queue
);
11627 mark_object (kb
->defining_kbd_macro
);
11628 mark_object (kb
->Vlast_kbd_macro
);
11629 mark_object (kb
->Vsystem_key_alist
);
11630 mark_object (kb
->system_key_syms
);
11631 mark_object (kb
->Vdefault_minibuffer_frame
);
11632 mark_object (kb
->echo_string
);
11635 struct input_event
*event
;
11636 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11638 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11639 event
= kbd_buffer
;
11640 if (event
->kind
!= SELECTION_REQUEST_EVENT
11641 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11643 mark_object (event
->x
);
11644 mark_object (event
->y
);
11646 mark_object (event
->frame_or_window
);
11647 mark_object (event
->arg
);
11652 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11653 (do not change this comment) */