1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
3 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
29 #include "termhooks.h"
36 #include "character.h"
38 #include "dispextern.h"
40 #include "intervals.h"
42 #include "blockinput.h"
49 #ifdef HAVE_GTK_AND_PTHREAD
57 #include <sys/ioctl.h>
59 #endif /* not MSDOS */
61 #include "syssignal.h"
64 #include <sys/types.h>
73 /* This is to get the definitions of the XK_ symbols. */
80 #endif /* HAVE_NTGUI */
90 /* Variables for blockinput.h: */
92 /* Non-zero if interrupt input is blocked right now. */
93 int interrupt_input_blocked
;
95 /* Nonzero means an input interrupt has arrived
96 during the current critical section. */
97 int interrupt_input_pending
;
100 /* File descriptor to use for input. */
103 #ifdef HAVE_WINDOW_SYSTEM
104 /* Make all keyboard buffers much bigger when using X windows. */
106 /* But not too big (local data > 32K error) if on Mac OS Classic. */
107 #define KBD_BUFFER_SIZE 512
109 #define KBD_BUFFER_SIZE 4096
111 #else /* No X-windows, character input */
112 #define KBD_BUFFER_SIZE 4096
113 #endif /* No X-windows */
115 #define abs(x) ((x) >= 0 ? (x) : -(x))
117 /* Following definition copied from eval.c */
121 struct backtrace
*next
;
122 Lisp_Object
*function
;
123 Lisp_Object
*args
; /* Points to vector of args. */
124 int nargs
; /* length of vector. If nargs is UNEVALLED,
125 args points to slot holding list of
128 /* Nonzero means call value of debugger when done with this operation. */
133 KBOARD
*initial_kboard
;
134 KBOARD
*current_kboard
;
138 KBOARD the_only_kboard
;
141 /* Non-nil disable property on a command means
142 do not execute it; call disabled-command-function's value instead. */
143 Lisp_Object Qdisabled
, Qdisabled_command_function
;
145 #define NUM_RECENT_KEYS (100)
146 int recent_keys_index
; /* Index for storing next element into recent_keys */
147 int total_keys
; /* Total number of elements stored into recent_keys */
148 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
150 /* Vector holding the key sequence that invoked the current command.
151 It is reused for each command, and it may be longer than the current
152 sequence; this_command_key_count indicates how many elements
153 actually mean something.
154 It's easier to staticpro a single Lisp_Object than an array. */
155 Lisp_Object this_command_keys
;
156 int this_command_key_count
;
158 /* 1 after calling Freset_this_command_lengths.
160 int this_command_key_count_reset
;
162 /* This vector is used as a buffer to record the events that were actually read
163 by read_key_sequence. */
164 Lisp_Object raw_keybuf
;
165 int raw_keybuf_count
;
167 #define GROW_RAW_KEYBUF \
168 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
170 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
172 new = Fmake_vector (make_number (newsize), Qnil); \
173 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
174 raw_keybuf_count * sizeof (Lisp_Object)); \
178 /* Number of elements of this_command_keys
179 that precede this key sequence. */
180 int this_single_command_key_start
;
182 /* Record values of this_command_key_count and echo_length ()
183 before this command was read. */
184 static int before_command_key_count
;
185 static int before_command_echo_length
;
187 extern int minbuf_level
;
189 extern int message_enable_multibyte
;
191 extern struct backtrace
*backtrace_list
;
193 /* If non-nil, the function that implements the display of help.
194 It's called with one argument, the help string to display. */
196 Lisp_Object Vshow_help_function
;
198 /* If a string, the message displayed before displaying a help-echo
201 Lisp_Object Vpre_help_message
;
203 /* Nonzero means do menu prompting. */
205 static int menu_prompting
;
207 /* Character to see next line of menu prompt. */
209 static Lisp_Object menu_prompt_more_char
;
211 /* For longjmp to where kbd input is being done. */
213 static jmp_buf getcjmp
;
215 /* True while doing kbd input. */
216 int waiting_for_input
;
218 /* True while displaying for echoing. Delays C-g throwing. */
222 /* Non-null means we can start echoing at the next input pause even
223 though there is something in the echo area. */
225 static struct kboard
*ok_to_echo_at_next_pause
;
227 /* The kboard last echoing, or null for none. Reset to 0 in
228 cancel_echoing. If non-null, and a current echo area message
229 exists, and echo_message_buffer is eq to the current message
230 buffer, we know that the message comes from echo_kboard. */
232 struct kboard
*echo_kboard
;
234 /* The buffer used for echoing. Set in echo_now, reset in
237 Lisp_Object echo_message_buffer
;
239 /* Nonzero means disregard local maps for the menu bar. */
240 static int inhibit_local_menu_bar_menus
;
242 /* Nonzero means C-g should cause immediate error-signal. */
245 /* The user's ERASE setting. */
246 Lisp_Object Vtty_erase_char
;
248 /* Character to recognize as the help char. */
249 Lisp_Object Vhelp_char
;
251 /* List of other event types to recognize as meaning "help". */
252 Lisp_Object Vhelp_event_list
;
254 /* Form to execute when help char is typed. */
255 Lisp_Object Vhelp_form
;
257 /* Command to run when the help character follows a prefix key. */
258 Lisp_Object Vprefix_help_command
;
260 /* List of items that should move to the end of the menu bar. */
261 Lisp_Object Vmenu_bar_final_items
;
263 /* Non-nil means show the equivalent key-binding for
264 any M-x command that has one.
265 The value can be a length of time to show the message for.
266 If the value is non-nil and not a number, we wait 2 seconds. */
267 Lisp_Object Vsuggest_key_bindings
;
269 /* How long to display an echo-area message when the minibuffer is active.
270 If the value is not a number, such messages don't time out. */
271 Lisp_Object Vminibuffer_message_timeout
;
273 /* Character that causes a quit. Normally C-g.
275 If we are running on an ordinary terminal, this must be an ordinary
276 ASCII char, since we want to make it our interrupt character.
278 If we are not running on an ordinary terminal, it still needs to be
279 an ordinary ASCII char. This character needs to be recognized in
280 the input interrupt handler. At this point, the keystroke is
281 represented as a struct input_event, while the desired quit
282 character is specified as a lispy event. The mapping from struct
283 input_events to lispy events cannot run in an interrupt handler,
284 and the reverse mapping is difficult for anything but ASCII
287 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
291 extern Lisp_Object current_global_map
;
292 extern int minibuf_level
;
294 /* If non-nil, this is a map that overrides all other local maps. */
295 Lisp_Object Voverriding_local_map
;
297 /* If non-nil, Voverriding_local_map applies to the menu bar. */
298 Lisp_Object Voverriding_local_map_menu_flag
;
300 /* Keymap that defines special misc events that should
301 be processed immediately at a low level. */
302 Lisp_Object Vspecial_event_map
;
304 /* Current depth in recursive edits. */
305 int command_loop_level
;
307 /* Total number of times command_loop has read a key sequence. */
308 EMACS_INT num_input_keys
;
310 /* Last input character read as a command. */
311 Lisp_Object last_command_char
;
313 /* Last input character read as a command, not counting menus
314 reached by the mouse. */
315 Lisp_Object last_nonmenu_event
;
317 /* Last input character read for any purpose. */
318 Lisp_Object last_input_char
;
320 /* If not Qnil, a list of objects to be read as subsequent command input. */
321 Lisp_Object Vunread_command_events
;
323 /* If not Qnil, a list of objects to be read as subsequent command input
324 including input method processing. */
325 Lisp_Object Vunread_input_method_events
;
327 /* If not Qnil, a list of objects to be read as subsequent command input
328 but NOT including input method processing. */
329 Lisp_Object Vunread_post_input_method_events
;
331 /* If not -1, an event to be read as subsequent command input. */
332 EMACS_INT unread_command_char
;
334 /* If not Qnil, this is a switch-frame event which we decided to put
335 off until the end of a key sequence. This should be read as the
336 next command input, after any unread_command_events.
338 read_key_sequence uses this to delay switch-frame events until the
339 end of the key sequence; Fread_char uses it to put off switch-frame
340 events until a non-ASCII event is acceptable as input. */
341 Lisp_Object unread_switch_frame
;
343 /* A mask of extra modifier bits to put into every keyboard char. */
344 EMACS_INT extra_keyboard_modifiers
;
346 /* Char to use as prefix when a meta character is typed in.
347 This is bound on entry to minibuffer in case ESC is changed there. */
349 Lisp_Object meta_prefix_char
;
351 /* Last size recorded for a current buffer which is not a minibuffer. */
352 static int last_non_minibuf_size
;
354 /* Number of idle seconds before an auto-save and garbage collection. */
355 static Lisp_Object Vauto_save_timeout
;
357 /* Total number of times read_char has returned. */
358 int num_input_events
;
360 /* Total number of times read_char has returned, outside of macros. */
361 EMACS_INT num_nonmacro_input_events
;
363 /* Auto-save automatically when this many characters have been typed
364 since the last time. */
366 static EMACS_INT auto_save_interval
;
368 /* Value of num_nonmacro_input_events as of last auto save. */
372 /* The command being executed by the command loop.
373 Commands may set this, and the value set will be copied into
374 current_kboard->Vlast_command instead of the actual command. */
375 Lisp_Object Vthis_command
;
377 /* This is like Vthis_command, except that commands never set it. */
378 Lisp_Object real_this_command
;
380 /* If the lookup of the command returns a binding, the original
381 command is stored in this-original-command. It is nil otherwise. */
382 Lisp_Object Vthis_original_command
;
384 /* The value of point when the last command was started. */
385 int last_point_position
;
387 /* The buffer that was current when the last command was started. */
388 Lisp_Object last_point_position_buffer
;
390 /* The window that was selected when the last command was started. */
391 Lisp_Object last_point_position_window
;
393 /* The frame in which the last input event occurred, or Qmacro if the
394 last event came from a macro. We use this to determine when to
395 generate switch-frame events. This may be cleared by functions
396 like Fselect_frame, to make sure that a switch-frame event is
397 generated by the next character. */
398 Lisp_Object internal_last_event_frame
;
400 /* A user-visible version of the above, intended to allow users to
401 figure out where the last event came from, if the event doesn't
402 carry that information itself (i.e. if it was a character). */
403 Lisp_Object Vlast_event_frame
;
405 /* The timestamp of the last input event we received from the X server.
406 X Windows wants this for selection ownership. */
407 unsigned long last_event_timestamp
;
409 Lisp_Object Qself_insert_command
;
410 Lisp_Object Qforward_char
;
411 Lisp_Object Qbackward_char
;
412 Lisp_Object Qundefined
;
413 Lisp_Object Qtimer_event_handler
;
415 /* read_key_sequence stores here the command definition of the
416 key sequence that it reads. */
417 Lisp_Object read_key_sequence_cmd
;
419 /* Echo unfinished commands after this many seconds of pause. */
420 Lisp_Object Vecho_keystrokes
;
422 /* Form to evaluate (if non-nil) when Emacs is started. */
423 Lisp_Object Vtop_level
;
425 /* User-supplied table to translate input characters. */
426 Lisp_Object Vkeyboard_translate_table
;
428 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
429 extern Lisp_Object Vfunction_key_map
;
431 /* Another keymap that maps key sequences into key sequences.
432 This one takes precedence over ordinary definitions. */
433 extern Lisp_Object Vkey_translation_map
;
435 /* If non-nil, this implements the current input method. */
436 Lisp_Object Vinput_method_function
;
437 Lisp_Object Qinput_method_function
;
439 /* When we call Vinput_method_function,
440 this holds the echo area message that was just erased. */
441 Lisp_Object Vinput_method_previous_message
;
443 /* Non-nil means deactivate the mark at end of this command. */
444 Lisp_Object Vdeactivate_mark
;
446 /* Menu bar specified in Lucid Emacs fashion. */
448 Lisp_Object Vlucid_menu_bar_dirty_flag
;
449 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
451 Lisp_Object Qecho_area_clear_hook
;
453 /* Hooks to run before and after each command. */
454 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
455 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
456 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
458 /* List of deferred actions to be performed at a later time.
459 The precise format isn't relevant here; we just check whether it is nil. */
460 Lisp_Object Vdeferred_action_list
;
462 /* Function to call to handle deferred actions, when there are any. */
463 Lisp_Object Vdeferred_action_function
;
464 Lisp_Object Qdeferred_action_function
;
466 Lisp_Object Qinput_method_exit_on_first_char
;
467 Lisp_Object Qinput_method_use_echo_area
;
469 /* File in which we write all commands we read. */
472 /* Nonzero if input is available. */
475 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
476 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
480 extern char *pending_malloc_warning
;
482 /* Circular buffer for pre-read keyboard input. */
484 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
486 /* Pointer to next available character in kbd_buffer.
487 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
488 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
489 next available char is in kbd_buffer[0]. */
490 static struct input_event
*kbd_fetch_ptr
;
492 /* Pointer to next place to store character in kbd_buffer. This
493 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
494 character should go in kbd_buffer[0]. */
495 static struct input_event
* volatile kbd_store_ptr
;
497 /* The above pair of variables forms a "queue empty" flag. When we
498 enqueue a non-hook event, we increment kbd_store_ptr. When we
499 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
500 there is input available iff the two pointers are not equal.
502 Why not just have a flag set and cleared by the enqueuing and
503 dequeuing functions? Such a flag could be screwed up by interrupts
504 at inopportune times. */
506 /* If this flag is non-nil, we check mouse_moved to see when the
507 mouse moves, and motion events will appear in the input stream.
508 Otherwise, mouse motion is ignored. */
509 Lisp_Object do_mouse_tracking
;
511 /* Symbols to head events. */
512 Lisp_Object Qmouse_movement
;
513 Lisp_Object Qscroll_bar_movement
;
514 Lisp_Object Qswitch_frame
;
515 Lisp_Object Qdelete_frame
;
516 Lisp_Object Qiconify_frame
;
517 Lisp_Object Qmake_frame_visible
;
518 Lisp_Object Qselect_window
;
519 Lisp_Object Qhelp_echo
;
522 Lisp_Object Qmouse_fixup_help_message
;
525 /* Symbols to denote kinds of events. */
526 Lisp_Object Qfunction_key
;
527 Lisp_Object Qmouse_click
;
528 #if defined (WINDOWSNT) || defined (MAC_OS)
529 Lisp_Object Qlanguage_change
;
531 Lisp_Object Qdrag_n_drop
;
532 Lisp_Object Qsave_session
;
534 Lisp_Object Qmac_apple_event
;
537 /* Lisp_Object Qmouse_movement; - also an event header */
539 /* Properties of event headers. */
540 Lisp_Object Qevent_kind
;
541 Lisp_Object Qevent_symbol_elements
;
543 /* menu item parts */
544 Lisp_Object Qmenu_alias
;
545 Lisp_Object Qmenu_enable
;
546 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
547 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
548 extern Lisp_Object Vdefine_key_rebound_commands
;
549 extern Lisp_Object Qmenu_item
;
551 /* An event header symbol HEAD may have a property named
552 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
553 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
554 mask of modifiers applied to it. If present, this is used to help
555 speed up parse_modifiers. */
556 Lisp_Object Qevent_symbol_element_mask
;
558 /* An unmodified event header BASE may have a property named
559 Qmodifier_cache, which is an alist mapping modifier masks onto
560 modified versions of BASE. If present, this helps speed up
562 Lisp_Object Qmodifier_cache
;
564 /* Symbols to use for parts of windows. */
565 Lisp_Object Qmode_line
;
566 Lisp_Object Qvertical_line
;
567 Lisp_Object Qvertical_scroll_bar
;
568 Lisp_Object Qmenu_bar
;
569 extern Lisp_Object Qleft_margin
, Qright_margin
;
570 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
571 extern Lisp_Object QCmap
;
573 Lisp_Object
recursive_edit_unwind (), command_loop ();
574 Lisp_Object
Fthis_command_keys ();
575 Lisp_Object Qextended_command_history
;
576 EMACS_TIME
timer_check ();
578 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
580 extern char *x_get_keysym_name ();
582 static void record_menu_key ();
583 static int echo_length ();
585 Lisp_Object Qpolling_period
;
587 /* List of absolute timers. Appears in order of next scheduled event. */
588 Lisp_Object Vtimer_list
;
590 /* List of idle time timers. Appears in order of next scheduled event. */
591 Lisp_Object Vtimer_idle_list
;
593 /* Incremented whenever a timer is run. */
596 extern Lisp_Object Vprint_level
, Vprint_length
;
598 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
600 EMACS_TIME
*input_available_clear_time
;
602 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
603 Default is 1 if INTERRUPT_INPUT is defined. */
606 /* Nonzero while interrupts are temporarily deferred during redisplay. */
607 int interrupts_deferred
;
609 /* Nonzero means use ^S/^Q for flow control. */
612 /* Allow m- file to inhibit use of FIONREAD. */
613 #ifdef BROKEN_FIONREAD
617 /* We are unable to use interrupts if FIONREAD is not available,
618 so flush SIGIO so we won't try. */
619 #if !defined (FIONREAD)
625 /* If we support a window system, turn on the code to poll periodically
626 to detect C-g. It isn't actually used when doing interrupt input. */
627 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
628 #define POLL_FOR_INPUT
631 /* After a command is executed, if point is moved into a region that
632 has specific properties (e.g. composition, display), we adjust
633 point to the boundary of the region. But, if a command sets this
634 variable to non-nil, we suppress this point adjustment. This
635 variable is set to nil before reading a command. */
637 Lisp_Object Vdisable_point_adjustment
;
639 /* If non-nil, always disable point adjustment. */
641 Lisp_Object Vglobal_disable_point_adjustment
;
643 /* The time when Emacs started being idle. */
645 static EMACS_TIME timer_idleness_start_time
;
647 /* After Emacs stops being idle, this saves the last value
648 of timer_idleness_start_time from when it was idle. */
650 static EMACS_TIME timer_last_idleness_start_time
;
652 /* If non-nil, events produced by disabled menu items and tool-bar
653 buttons are not ignored. Help functions bind this to allow help on
654 those items and buttons. */
655 Lisp_Object Venable_disabled_menus_and_buttons
;
658 /* Global variable declarations. */
660 /* Flags for readable_events. */
661 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
662 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
663 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
665 /* Function for init_keyboard to call with no args (if nonzero). */
666 void (*keyboard_init_hook
) ();
668 static int read_avail_input
P_ ((int));
669 static void get_input_pending
P_ ((int *, int));
670 static int readable_events
P_ ((int));
671 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
672 Lisp_Object
, int *));
673 static Lisp_Object
read_char_x_menu_prompt ();
674 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
676 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
678 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
679 enum scroll_bar_part
,
680 Lisp_Object
, Lisp_Object
,
683 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
684 Lisp_Object
, char **,
685 Lisp_Object
*, unsigned));
686 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
687 static int parse_solitary_modifier
P_ ((Lisp_Object
));
688 static int parse_solitary_modifier ();
689 static void save_getcjmp
P_ ((jmp_buf));
690 static void save_getcjmp ();
691 static void restore_getcjmp
P_ ((jmp_buf));
692 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
693 static void clear_event
P_ ((struct input_event
*));
694 static void any_kboard_state
P_ ((void));
695 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
696 static void timer_start_idle
P_ ((void));
697 static void timer_stop_idle
P_ ((void));
698 static void timer_resume_idle
P_ ((void));
700 /* Nonzero means don't try to suspend even if the operating system seems
702 static int cannot_suspend
;
704 extern Lisp_Object Qidentity
, Qonly
;
706 /* Install the string STR as the beginning of the string of echoing,
707 so that it serves as a prompt for the next character.
708 Also start echoing. */
714 current_kboard
->echo_string
= str
;
715 current_kboard
->echo_after_prompt
= SCHARS (str
);
719 /* Add C to the echo string, if echoing is going on.
720 C can be a character, which is printed prettily ("M-C-x" and all that
721 jazz), or a symbol, whose name is printed. */
727 if (current_kboard
->immediate_echo
)
729 int size
= KEY_DESCRIPTION_SIZE
+ 100;
730 char *buffer
= (char *) alloca (size
);
732 Lisp_Object echo_string
;
734 echo_string
= current_kboard
->echo_string
;
736 /* If someone has passed us a composite event, use its head symbol. */
741 ptr
= push_key_description (XINT (c
), ptr
, 1);
743 else if (SYMBOLP (c
))
745 Lisp_Object name
= SYMBOL_NAME (c
);
746 int nbytes
= SBYTES (name
);
748 if (size
- (ptr
- buffer
) < nbytes
)
750 int offset
= ptr
- buffer
;
751 size
= max (2 * size
, size
+ nbytes
);
752 buffer
= (char *) alloca (size
);
753 ptr
= buffer
+ offset
;
756 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
757 STRING_MULTIBYTE (name
), 1);
760 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
763 const char *text
= " (Type ? for further options)";
764 int len
= strlen (text
);
766 if (size
- (ptr
- buffer
) < len
)
768 int offset
= ptr
- buffer
;
770 buffer
= (char *) alloca (size
);
771 ptr
= buffer
+ offset
;
774 bcopy (text
, ptr
, len
);
778 /* Replace a dash from echo_dash with a space, otherwise
779 add a space at the end as a separator between keys. */
780 if (STRINGP (echo_string
)
781 && SCHARS (echo_string
) > 1)
783 Lisp_Object last_char
, prev_char
, idx
;
785 idx
= make_number (SCHARS (echo_string
) - 2);
786 prev_char
= Faref (echo_string
, idx
);
788 idx
= make_number (SCHARS (echo_string
) - 1);
789 last_char
= Faref (echo_string
, idx
);
791 /* We test PREV_CHAR to make sure this isn't the echoing
793 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
794 Faset (echo_string
, idx
, make_number (' '));
796 echo_string
= concat2 (echo_string
, build_string (" "));
798 else if (STRINGP (echo_string
))
799 echo_string
= concat2 (echo_string
, build_string (" "));
801 current_kboard
->echo_string
802 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
808 /* Temporarily add a dash to the end of the echo string if it's not
809 empty, so that it serves as a mini-prompt for the very next character. */
814 /* Do nothing if not echoing at all. */
815 if (NILP (current_kboard
->echo_string
))
818 if (!current_kboard
->immediate_echo
819 && SCHARS (current_kboard
->echo_string
) == 0)
822 /* Do nothing if we just printed a prompt. */
823 if (current_kboard
->echo_after_prompt
824 == SCHARS (current_kboard
->echo_string
))
827 /* Do nothing if we have already put a dash at the end. */
828 if (SCHARS (current_kboard
->echo_string
) > 1)
830 Lisp_Object last_char
, prev_char
, idx
;
832 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
833 prev_char
= Faref (current_kboard
->echo_string
, idx
);
835 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
836 last_char
= Faref (current_kboard
->echo_string
, idx
);
838 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
842 /* Put a dash at the end of the buffer temporarily,
843 but make it go away when the next character is added. */
844 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
849 /* Display the current echo string, and begin echoing if not already
855 if (!current_kboard
->immediate_echo
)
858 current_kboard
->immediate_echo
= 1;
860 for (i
= 0; i
< this_command_key_count
; i
++)
864 /* Set before_command_echo_length to the value that would
865 have been saved before the start of this subcommand in
866 command_loop_1, if we had already been echoing then. */
867 if (i
== this_single_command_key_start
)
868 before_command_echo_length
= echo_length ();
870 c
= XVECTOR (this_command_keys
)->contents
[i
];
871 if (! (EVENT_HAS_PARAMETERS (c
)
872 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
876 /* Set before_command_echo_length to the value that would
877 have been saved before the start of this subcommand in
878 command_loop_1, if we had already been echoing then. */
879 if (this_command_key_count
== this_single_command_key_start
)
880 before_command_echo_length
= echo_length ();
882 /* Put a dash at the end to invite the user to type more. */
887 message3_nolog (current_kboard
->echo_string
,
888 SBYTES (current_kboard
->echo_string
),
889 STRING_MULTIBYTE (current_kboard
->echo_string
));
892 /* Record in what buffer we echoed, and from which kboard. */
893 echo_message_buffer
= echo_area_buffer
[0];
894 echo_kboard
= current_kboard
;
896 if (waiting_for_input
&& !NILP (Vquit_flag
))
897 quit_throw_to_read_char ();
900 /* Turn off echoing, for the start of a new command. */
905 current_kboard
->immediate_echo
= 0;
906 current_kboard
->echo_after_prompt
= -1;
907 current_kboard
->echo_string
= Qnil
;
908 ok_to_echo_at_next_pause
= NULL
;
910 echo_message_buffer
= Qnil
;
913 /* Return the length of the current echo string. */
918 return (STRINGP (current_kboard
->echo_string
)
919 ? SCHARS (current_kboard
->echo_string
)
923 /* Truncate the current echo message to its first LEN chars.
924 This and echo_char get used by read_key_sequence when the user
925 switches frames while entering a key sequence. */
928 echo_truncate (nchars
)
931 if (STRINGP (current_kboard
->echo_string
))
932 current_kboard
->echo_string
933 = Fsubstring (current_kboard
->echo_string
,
934 make_number (0), make_number (nchars
));
935 truncate_echo_area (nchars
);
939 /* Functions for manipulating this_command_keys. */
941 add_command_key (key
)
944 #if 0 /* Not needed after we made Freset_this_command_lengths
945 do the job immediately. */
946 /* If reset-this-command-length was called recently, obey it now.
947 See the doc string of that function for an explanation of why. */
948 if (before_command_restore_flag
)
950 this_command_key_count
= before_command_key_count_1
;
951 if (this_command_key_count
< this_single_command_key_start
)
952 this_single_command_key_start
= this_command_key_count
;
953 echo_truncate (before_command_echo_length_1
);
954 before_command_restore_flag
= 0;
958 if (this_command_key_count
>= ASIZE (this_command_keys
))
959 this_command_keys
= larger_vector (this_command_keys
,
960 2 * ASIZE (this_command_keys
),
963 AREF (this_command_keys
, this_command_key_count
) = key
;
964 ++this_command_key_count
;
971 int count
= SPECPDL_INDEX ();
974 if (command_loop_level
> 0)
976 specbind (Qstandard_output
, Qt
);
977 specbind (Qstandard_input
, Qt
);
980 #ifdef HAVE_X_WINDOWS
981 /* The command loop has started an hourglass timer, so we have to
982 cancel it here, otherwise it will fire because the recursive edit
983 can take some time. Do not check for display_hourglass_p here,
984 because it could already be nil. */
988 /* This function may have been called from a debugger called from
989 within redisplay, for instance by Edebugging a function called
990 from fontification-functions. We want to allow redisplay in
991 the debugging session.
993 The recursive edit is left with a `(throw exit ...)'. The `exit'
994 tag is not caught anywhere in redisplay, i.e. when we leave the
995 recursive edit, the original redisplay leading to the recursive
996 edit will be unwound. The outcome should therefore be safe. */
997 specbind (Qinhibit_redisplay
, Qnil
);
1000 val
= command_loop ();
1002 Fsignal (Qquit
, Qnil
);
1003 /* Handle throw from read_minibuf when using minibuffer
1004 while it's active but we're in another window. */
1006 Fsignal (Qerror
, Fcons (val
, Qnil
));
1008 return unbind_to (count
, Qnil
);
1011 /* When an auto-save happens, record the "time", and don't do again soon. */
1016 last_auto_save
= num_nonmacro_input_events
;
1019 /* Make an auto save happen as soon as possible at command level. */
1022 force_auto_save_soon ()
1024 last_auto_save
= - auto_save_interval
- 1;
1026 record_asynch_buffer_change ();
1029 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1030 doc
: /* Invoke the editor command loop recursively.
1031 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1032 that tells this function to return.
1033 Alternatively, `(throw 'exit t)' makes this function signal an error.
1034 This function is called by the editor initialization to begin editing. */)
1037 int count
= SPECPDL_INDEX ();
1040 /* If we enter while input is blocked, don't lock up here.
1041 This may happen through the debugger during redisplay. */
1042 if (INPUT_BLOCKED_P
)
1045 command_loop_level
++;
1046 update_mode_lines
= 1;
1048 if (command_loop_level
1049 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1050 buffer
= Fcurrent_buffer ();
1054 /* If we leave recursive_edit_1 below with a `throw' for instance,
1055 like it is done in the splash screen display, we have to
1056 make sure that we restore single_kboard as command_loop_1
1057 would have done if it were left normally. */
1058 record_unwind_protect (recursive_edit_unwind
,
1059 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1061 recursive_edit_1 ();
1062 return unbind_to (count
, Qnil
);
1066 recursive_edit_unwind (info
)
1069 if (BUFFERP (XCAR (info
)))
1070 Fset_buffer (XCAR (info
));
1072 if (NILP (XCDR (info
)))
1073 any_kboard_state ();
1075 single_kboard_state ();
1077 command_loop_level
--;
1078 update_mode_lines
= 1;
1087 #if 0 /* Theory: if there's anything in Vunread_command_events,
1088 it will right away be read by read_key_sequence,
1089 and then if we do switch KBOARDS, it will go into the side
1090 queue then. So we don't need to do anything special here -- rms. */
1091 if (CONSP (Vunread_command_events
))
1093 current_kboard
->kbd_queue
1094 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1095 current_kboard
->kbd_queue_has_data
= 1;
1097 Vunread_command_events
= Qnil
;
1103 /* Switch to the single-kboard state, making current_kboard
1104 the only KBOARD from which further input is accepted. */
1107 single_kboard_state ()
1114 /* If we're in single_kboard state for kboard KBOARD,
1118 not_single_kboard_state (kboard
)
1122 if (kboard
== current_kboard
)
1127 /* Maintain a stack of kboards, so other parts of Emacs
1128 can switch temporarily to the kboard of a given frame
1129 and then revert to the previous status. */
1134 struct kboard_stack
*next
;
1137 static struct kboard_stack
*kboard_stack
;
1140 push_frame_kboard (f
)
1144 struct kboard_stack
*p
1145 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1147 p
->next
= kboard_stack
;
1148 p
->kboard
= current_kboard
;
1151 current_kboard
= FRAME_KBOARD (f
);
1159 struct kboard_stack
*p
= kboard_stack
;
1160 current_kboard
= p
->kboard
;
1161 kboard_stack
= p
->next
;
1166 /* Handle errors that are not handled at inner levels
1167 by printing an error message and returning to the editor command loop. */
1173 Lisp_Object old_level
, old_length
;
1174 char macroerror
[50];
1176 #ifdef HAVE_X_WINDOWS
1177 if (display_hourglass_p
)
1178 cancel_hourglass ();
1181 if (!NILP (executing_kbd_macro
))
1183 if (executing_kbd_macro_iterations
== 1)
1184 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1186 sprintf (macroerror
, "After %d kbd macro iterations: ",
1187 executing_kbd_macro_iterations
);
1192 Vstandard_output
= Qt
;
1193 Vstandard_input
= Qt
;
1194 Vexecuting_kbd_macro
= Qnil
;
1195 executing_kbd_macro
= Qnil
;
1196 current_kboard
->Vprefix_arg
= Qnil
;
1197 current_kboard
->Vlast_prefix_arg
= Qnil
;
1200 /* Avoid unquittable loop if data contains a circular list. */
1201 old_level
= Vprint_level
;
1202 old_length
= Vprint_length
;
1203 XSETFASTINT (Vprint_level
, 10);
1204 XSETFASTINT (Vprint_length
, 10);
1205 cmd_error_internal (data
, macroerror
);
1206 Vprint_level
= old_level
;
1207 Vprint_length
= old_length
;
1211 Vinhibit_quit
= Qnil
;
1213 if (command_loop_level
== 0 && minibuf_level
== 0)
1214 any_kboard_state ();
1217 return make_number (0);
1220 /* Take actions on handling an error. DATA is the data that describes
1223 CONTEXT is a C-string containing ASCII characters only which
1224 describes the context in which the error happened. If we need to
1225 generalize CONTEXT to allow multibyte characters, make it a Lisp
1229 cmd_error_internal (data
, context
)
1234 int kill_emacs_p
= 0;
1235 struct frame
*sf
= SELECTED_FRAME ();
1239 clear_message (1, 0);
1241 /* If the window system or terminal frame hasn't been initialized
1242 yet, or we're not interactive, it's best to dump this message out
1243 to stderr and exit. */
1244 if (!sf
->glyphs_initialized_p
1245 /* This is the case of the frame dumped with Emacs, when we're
1246 running under a window system. */
1247 || (!NILP (Vwindow_system
)
1248 && !inhibit_window_system
1249 && FRAME_TERMCAP_P (sf
))
1252 stream
= Qexternal_debugging_output
;
1258 message_log_maybe_newline ();
1263 /* The immediate context is not interesting for Quits,
1264 since they are asyncronous. */
1265 if (EQ (XCAR (data
), Qquit
))
1266 Vsignaling_function
= Qnil
;
1268 print_error_message (data
, stream
, context
, Vsignaling_function
);
1270 Vsignaling_function
= Qnil
;
1272 /* If the window system or terminal frame hasn't been initialized
1273 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1277 Fkill_emacs (make_number (-1));
1281 Lisp_Object
command_loop_1 ();
1282 Lisp_Object
command_loop_2 ();
1283 Lisp_Object
top_level_1 ();
1285 /* Entry to editor-command-loop.
1286 This level has the catches for exiting/returning to editor command loop.
1287 It returns nil to exit recursive edit, t to abort it. */
1292 if (command_loop_level
> 0 || minibuf_level
> 0)
1295 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1296 executing_kbd_macro
= Qnil
;
1302 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1303 /* Reset single_kboard in case top-level set it while
1304 evaluating an -f option, or we are stuck there for some
1306 any_kboard_state ();
1307 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1308 executing_kbd_macro
= Qnil
;
1310 /* End of file in -batch run causes exit here. */
1316 /* Here we catch errors in execution of commands within the
1317 editing loop, and reenter the editing loop.
1318 When there is an error, cmd_error runs and returns a non-nil
1319 value to us. A value of nil means that command_loop_1 itself
1320 returned due to end of file (or end of kbd macro). */
1325 register Lisp_Object val
;
1328 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1329 while (!NILP (val
));
1337 return Feval (Vtop_level
);
1343 /* On entry to the outer level, run the startup file */
1344 if (!NILP (Vtop_level
))
1345 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1346 else if (!NILP (Vpurify_flag
))
1347 message ("Bare impure Emacs (standard Lisp code not loaded)");
1349 message ("Bare Emacs (standard Lisp code not loaded)");
1353 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1354 doc
: /* Exit all recursive editing levels. */)
1357 #ifdef HAVE_X_WINDOWS
1358 if (display_hourglass_p
)
1359 cancel_hourglass ();
1362 /* Unblock input if we enter with input blocked. This may happen if
1363 redisplay traps e.g. during tool-bar update with input blocked. */
1364 while (INPUT_BLOCKED_P
)
1367 return Fthrow (Qtop_level
, Qnil
);
1370 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1371 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1374 if (command_loop_level
> 0 || minibuf_level
> 0)
1375 Fthrow (Qexit
, Qnil
);
1377 error ("No recursive edit is in progress");
1381 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1382 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1385 if (command_loop_level
> 0 || minibuf_level
> 0)
1388 error ("No recursive edit is in progress");
1392 /* This is the actual command reading loop,
1393 sans error-handling encapsulation. */
1395 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1397 void safe_run_hooks
P_ ((Lisp_Object
));
1398 static void adjust_point_for_property
P_ ((int, int));
1400 /* Cancel hourglass from protect_unwind.
1402 #ifdef HAVE_X_WINDOWS
1404 cancel_hourglass_unwind (arg
)
1407 cancel_hourglass ();
1418 Lisp_Object keybuf
[30];
1422 struct buffer
*prev_buffer
= NULL
;
1424 int was_locked
= single_kboard
;
1426 int already_adjusted
;
1428 current_kboard
->Vprefix_arg
= Qnil
;
1429 current_kboard
->Vlast_prefix_arg
= Qnil
;
1430 Vdeactivate_mark
= Qnil
;
1431 waiting_for_input
= 0;
1435 this_command_key_count
= 0;
1436 this_command_key_count_reset
= 0;
1437 this_single_command_key_start
= 0;
1439 if (NILP (Vmemory_full
))
1441 /* Make sure this hook runs after commands that get errors and
1442 throw to top level. */
1443 /* Note that the value cell will never directly contain nil
1444 if the symbol is a local variable. */
1445 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1446 safe_run_hooks (Qpost_command_hook
);
1448 /* If displaying a message, resize the echo area window to fit
1449 that message's size exactly. */
1450 if (!NILP (echo_area_buffer
[0]))
1451 resize_echo_area_exactly ();
1453 if (!NILP (Vdeferred_action_list
))
1454 safe_run_hooks (Qdeferred_action_function
);
1457 /* Do this after running Vpost_command_hook, for consistency. */
1458 current_kboard
->Vlast_command
= Vthis_command
;
1459 current_kboard
->Vreal_last_command
= real_this_command
;
1463 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1466 /* Make sure the current window's buffer is selected. */
1467 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1468 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1470 /* Display any malloc warning that just came out. Use while because
1471 displaying one warning can cause another. */
1473 while (pending_malloc_warning
)
1474 display_malloc_warning ();
1478 Vdeactivate_mark
= Qnil
;
1480 /* If minibuffer on and echo area in use,
1481 wait a short time and redraw minibuffer. */
1484 && !NILP (echo_area_buffer
[0])
1485 && EQ (minibuf_window
, echo_area_window
)
1486 && NUMBERP (Vminibuffer_message_timeout
))
1488 /* Bind inhibit-quit to t so that C-g gets read in
1489 rather than quitting back to the minibuffer. */
1490 int count
= SPECPDL_INDEX ();
1491 specbind (Qinhibit_quit
, Qt
);
1493 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1494 /* Clear the echo area. */
1496 safe_run_hooks (Qecho_area_clear_hook
);
1498 unbind_to (count
, Qnil
);
1500 /* If a C-g came in before, treat it as input now. */
1501 if (!NILP (Vquit_flag
))
1504 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1509 alloca (0); /* Cause a garbage collection now */
1510 /* Since we can free the most stuff here. */
1511 #endif /* C_ALLOCA */
1514 /* Select the frame that the last event came from. Usually,
1515 switch-frame events will take care of this, but if some lisp
1516 code swallows a switch-frame event, we'll fix things up here.
1517 Is this a good idea? */
1518 if (FRAMEP (internal_last_event_frame
)
1519 && !EQ (internal_last_event_frame
, selected_frame
))
1520 Fselect_frame (internal_last_event_frame
);
1522 /* If it has changed current-menubar from previous value,
1523 really recompute the menubar from the value. */
1524 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1525 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1526 call0 (Qrecompute_lucid_menubar
);
1528 before_command_key_count
= this_command_key_count
;
1529 before_command_echo_length
= echo_length ();
1531 Vthis_command
= Qnil
;
1532 real_this_command
= Qnil
;
1533 Vthis_original_command
= Qnil
;
1535 /* Read next key sequence; i gets its length. */
1536 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1539 /* A filter may have run while we were reading the input. */
1540 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1542 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1543 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1547 /* Now we have read a key sequence of length I,
1548 or else I is 0 and we found end of file. */
1550 if (i
== 0) /* End of file -- happens only in */
1551 return Qnil
; /* a kbd macro, at the end. */
1552 /* -1 means read_key_sequence got a menu that was rejected.
1553 Just loop around and read another command. */
1557 this_command_key_count
= 0;
1558 this_command_key_count_reset
= 0;
1559 this_single_command_key_start
= 0;
1563 last_command_char
= keybuf
[i
- 1];
1565 /* If the previous command tried to force a specific window-start,
1566 forget about that, in case this command moves point far away
1567 from that position. But also throw away beg_unchanged and
1568 end_unchanged information in that case, so that redisplay will
1569 update the whole window properly. */
1570 if (!NILP (XWINDOW (selected_window
)->force_start
))
1573 XWINDOW (selected_window
)->force_start
= Qnil
;
1574 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1575 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1578 cmd
= read_key_sequence_cmd
;
1579 if (!NILP (Vexecuting_kbd_macro
))
1581 if (!NILP (Vquit_flag
))
1583 Vexecuting_kbd_macro
= Qt
;
1584 QUIT
; /* Make some noise. */
1585 /* Will return since macro now empty. */
1589 /* Do redisplay processing after this command except in special
1590 cases identified below. */
1591 prev_buffer
= current_buffer
;
1592 prev_modiff
= MODIFF
;
1593 last_point_position
= PT
;
1594 last_point_position_window
= selected_window
;
1595 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1597 /* By default, we adjust point to a boundary of a region that
1598 has such a property that should be treated intangible
1599 (e.g. composition, display). But, some commands will set
1600 this variable differently. */
1601 Vdisable_point_adjustment
= Qnil
;
1603 /* Process filters and timers may have messed with deactivate-mark.
1604 reset it before we execute the command. */
1605 Vdeactivate_mark
= Qnil
;
1607 /* Remap command through active keymaps */
1608 Vthis_original_command
= cmd
;
1612 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1616 /* Execute the command. */
1618 Vthis_command
= cmd
;
1619 real_this_command
= cmd
;
1620 /* Note that the value cell will never directly contain nil
1621 if the symbol is a local variable. */
1622 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1623 safe_run_hooks (Qpre_command_hook
);
1625 already_adjusted
= 0;
1627 if (NILP (Vthis_command
))
1629 /* nil means key is undefined. */
1630 Lisp_Object keys
= Fvector (i
, keybuf
);
1631 keys
= Fkey_description (keys
, Qnil
);
1633 message_with_string ("%s is undefined", keys
, 0);
1634 current_kboard
->defining_kbd_macro
= Qnil
;
1635 update_mode_lines
= 1;
1636 current_kboard
->Vprefix_arg
= Qnil
;
1640 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1642 /* In case we jump to directly_done. */
1643 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1645 /* Recognize some common commands in common situations and
1646 do them directly. */
1647 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1649 struct Lisp_Char_Table
*dp
1650 = window_display_table (XWINDOW (selected_window
));
1651 lose
= FETCH_CHAR (PT_BYTE
);
1653 if (! NILP (Vpost_command_hook
))
1654 /* Put this before calling adjust_point_for_property
1655 so it will only get called once in any case. */
1657 if (current_buffer
== prev_buffer
1658 && last_point_position
!= PT
1659 && NILP (Vdisable_point_adjustment
)
1660 && NILP (Vglobal_disable_point_adjustment
))
1661 adjust_point_for_property (last_point_position
, 0);
1662 already_adjusted
= 1;
1663 if (PT
== last_point_position
+ 1
1665 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1666 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1667 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1668 && (lose
>= 0x20 && lose
< 0x7f)))
1669 : (lose
>= 0x20 && lose
< 0x7f))
1670 /* To extract the case of continuation on
1671 wide-column characters. */
1672 && ASCII_BYTE_P (lose
)
1673 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1675 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1677 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1679 && !windows_or_buffers_changed
1680 && EQ (current_buffer
->selective_display
, Qnil
)
1681 && !detect_input_pending ()
1682 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1683 && NILP (Vexecuting_kbd_macro
))
1684 direct_output_forward_char (1);
1687 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1689 struct Lisp_Char_Table
*dp
1690 = window_display_table (XWINDOW (selected_window
));
1692 lose
= FETCH_CHAR (PT_BYTE
);
1693 if (! NILP (Vpost_command_hook
))
1695 if (current_buffer
== prev_buffer
1696 && last_point_position
!= PT
1697 && NILP (Vdisable_point_adjustment
)
1698 && NILP (Vglobal_disable_point_adjustment
))
1699 adjust_point_for_property (last_point_position
, 0);
1700 already_adjusted
= 1;
1701 if (PT
== last_point_position
- 1
1703 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1704 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1705 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1706 && (lose
>= 0x20 && lose
< 0x7f)))
1707 : (lose
>= 0x20 && lose
< 0x7f))
1708 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1710 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1712 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1714 && !windows_or_buffers_changed
1715 && EQ (current_buffer
->selective_display
, Qnil
)
1716 && !detect_input_pending ()
1717 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1718 && NILP (Vexecuting_kbd_macro
))
1719 direct_output_forward_char (-1);
1722 else if (EQ (Vthis_command
, Qself_insert_command
)
1723 /* Try this optimization only on char keystrokes. */
1724 && NATNUMP (last_command_char
)
1725 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1728 = translate_char (Vtranslation_table_for_input
,
1729 XFASTINT (last_command_char
));
1731 if (NILP (Vexecuting_kbd_macro
)
1732 && !EQ (minibuf_window
, selected_window
))
1734 if (!nonundocount
|| nonundocount
>= 20)
1742 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1744 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1746 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1748 || MODIFF
<= SAVE_MODIFF
1749 || windows_or_buffers_changed
1750 || !EQ (current_buffer
->selective_display
, Qnil
)
1751 || detect_input_pending ()
1752 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1753 || !NILP (Vexecuting_kbd_macro
));
1755 value
= internal_self_insert (c
, 0);
1760 if (! NILP (Vpost_command_hook
))
1761 /* Put this before calling adjust_point_for_property
1762 so it will only get called once in any case. */
1765 /* VALUE == 1 when AFTER-CHANGE functions are
1766 installed which is the case most of the time
1767 because FONT-LOCK installs one. */
1768 if (!lose
&& !value
)
1769 direct_output_for_insert (c
);
1774 /* Here for a command that isn't executed directly */
1777 #ifdef HAVE_X_WINDOWS
1778 int scount
= SPECPDL_INDEX ();
1780 if (display_hourglass_p
1781 && NILP (Vexecuting_kbd_macro
))
1783 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1789 if (NILP (current_kboard
->Vprefix_arg
))
1791 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1793 #ifdef HAVE_X_WINDOWS
1794 /* Do not check display_hourglass_p here, because
1795 Fcommand_execute could change it, but we should cancel
1796 hourglass cursor anyway.
1797 But don't cancel the hourglass within a macro
1798 just because a command in the macro finishes. */
1799 if (NILP (Vexecuting_kbd_macro
))
1800 unbind_to (scount
, Qnil
);
1805 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1807 /* Note that the value cell will never directly contain nil
1808 if the symbol is a local variable. */
1809 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1810 safe_run_hooks (Qpost_command_hook
);
1812 /* If displaying a message, resize the echo area window to fit
1813 that message's size exactly. */
1814 if (!NILP (echo_area_buffer
[0]))
1815 resize_echo_area_exactly ();
1817 if (!NILP (Vdeferred_action_list
))
1818 safe_run_hooks (Qdeferred_action_function
);
1820 /* If there is a prefix argument,
1821 1) We don't want Vlast_command to be ``universal-argument''
1822 (that would be dumb), so don't set Vlast_command,
1823 2) we want to leave echoing on so that the prefix will be
1824 echoed as part of this key sequence, so don't call
1826 3) we want to leave this_command_key_count non-zero, so that
1827 read_char will realize that it is re-reading a character, and
1828 not echo it a second time.
1830 If the command didn't actually create a prefix arg,
1831 but is merely a frame event that is transparent to prefix args,
1832 then the above doesn't apply. */
1833 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1835 current_kboard
->Vlast_command
= Vthis_command
;
1836 current_kboard
->Vreal_last_command
= real_this_command
;
1838 this_command_key_count
= 0;
1839 this_command_key_count_reset
= 0;
1840 this_single_command_key_start
= 0;
1843 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1845 /* Setting transient-mark-mode to `only' is a way of
1846 turning it on for just one command. */
1848 if (EQ (Vtransient_mark_mode
, Qidentity
))
1849 Vtransient_mark_mode
= Qnil
;
1850 if (EQ (Vtransient_mark_mode
, Qonly
))
1851 Vtransient_mark_mode
= Qidentity
;
1853 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1855 /* We could also call `deactivate'mark'. */
1856 if (EQ (Vtransient_mark_mode
, Qlambda
))
1857 Vtransient_mark_mode
= Qnil
;
1860 current_buffer
->mark_active
= Qnil
;
1861 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1864 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1865 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1870 if (current_buffer
== prev_buffer
1871 && last_point_position
!= PT
1872 && NILP (Vdisable_point_adjustment
)
1873 && NILP (Vglobal_disable_point_adjustment
)
1874 && !already_adjusted
)
1875 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1877 /* Install chars successfully executed in kbd macro. */
1879 if (!NILP (current_kboard
->defining_kbd_macro
)
1880 && NILP (current_kboard
->Vprefix_arg
))
1881 finalize_kbd_macro_chars ();
1885 any_kboard_state ();
1890 extern Lisp_Object Qcomposition
, Qdisplay
;
1892 /* Adjust point to a boundary of a region that has such a property
1893 that should be treated intangible. For the moment, we check
1894 `composition', `display' and `invisible' properties.
1895 LAST_PT is the last position of point. */
1897 extern Lisp_Object Qafter_string
, Qbefore_string
;
1898 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1901 adjust_point_for_property (last_pt
, modified
)
1906 Lisp_Object val
, overlay
, tmp
;
1907 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1910 /* FIXME: cycling is probably not necessary because these properties
1911 can't be usefully combined anyway. */
1912 while (check_composition
|| check_display
|| check_invisible
)
1914 if (check_composition
1915 && PT
> BEGV
&& PT
< ZV
1916 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1917 && COMPOSITION_VALID_P (beg
, end
, val
)
1918 && beg
< PT
/* && end > PT <- It's always the case. */
1919 && (last_pt
<= beg
|| last_pt
>= end
))
1922 SET_PT (PT
< last_pt
? beg
: end
);
1923 check_display
= check_invisible
= 1;
1925 check_composition
= 0;
1927 && PT
> BEGV
&& PT
< ZV
1928 && !NILP (val
= get_char_property_and_overlay
1929 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1930 && display_prop_intangible_p (val
)
1931 && (!OVERLAYP (overlay
)
1932 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1933 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1934 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1935 && (beg
< PT
/* && end > PT <- It's always the case. */
1936 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1939 SET_PT (PT
< last_pt
1940 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1942 check_composition
= check_invisible
= 1;
1945 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1947 int inv
, ellipsis
= 0;
1950 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1952 && !NILP (val
= get_char_property_and_overlay
1953 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1954 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1956 ellipsis
= ellipsis
|| inv
> 1
1957 || (OVERLAYP (overlay
)
1958 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1959 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1960 tmp
= Fnext_single_char_property_change
1961 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1962 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1965 && !NILP (val
= get_char_property_and_overlay
1966 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1967 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1969 ellipsis
= ellipsis
|| inv
> 1
1970 || (OVERLAYP (overlay
)
1971 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1972 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1973 tmp
= Fprevious_single_char_property_change
1974 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1975 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1978 /* Move away from the inside area. */
1979 if (beg
< PT
&& end
> PT
)
1981 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1982 /* We haven't moved yet (so we don't need to fear
1983 infinite-looping) and we were outside the range
1984 before (so either end of the range still corresponds
1985 to a move in the right direction): pretend we moved
1986 less than we actually did, so that we still have
1987 more freedom below in choosing which end of the range
1989 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1990 /* We either have moved already or the last point
1991 was already in the range: we don't get to choose
1992 which end of the range we have to go to. */
1993 : (PT
< last_pt
? beg
: end
));
1994 check_composition
= check_display
= 1;
1996 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1997 the point to something other than its argument, due to
1998 point-motion hooks, intangibility, etc. */
1999 xassert (PT
== beg
|| PT
== end
);
2002 /* Pretend the area doesn't exist if the buffer is not
2004 if (!modified
&& !ellipsis
&& beg
< end
)
2006 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2007 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2008 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2009 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2010 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2011 /* We've already moved as far as we can. Trying to go
2012 to the other end would mean moving backwards and thus
2013 could lead to an infinite loop. */
2015 else if (val
= get_pos_property (make_number (PT
),
2017 TEXT_PROP_MEANS_INVISIBLE (val
)
2018 && (val
= get_pos_property
2019 (make_number (PT
== beg
? end
: beg
),
2021 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2022 (check_composition
= check_display
= 1,
2023 SET_PT (PT
== beg
? end
: beg
));
2026 check_invisible
= 0;
2030 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2033 safe_run_hooks_1 (hook
)
2036 return call1 (Vrun_hooks
, Vinhibit_quit
);
2039 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2042 safe_run_hooks_error (data
)
2045 Lisp_Object args
[3];
2046 args
[0] = build_string ("Error in %s: %s");
2047 args
[1] = Vinhibit_quit
;
2050 return Fset (Vinhibit_quit
, Qnil
);
2053 /* If we get an error while running the hook, cause the hook variable
2054 to be nil. Also inhibit quits, so that C-g won't cause the hook
2055 to mysteriously evaporate. */
2058 safe_run_hooks (hook
)
2061 int count
= SPECPDL_INDEX ();
2062 specbind (Qinhibit_quit
, hook
);
2064 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2066 unbind_to (count
, Qnil
);
2070 /* Number of seconds between polling for input. This is a Lisp
2071 variable that can be bound. */
2073 EMACS_INT polling_period
;
2075 /* Nonzero means polling for input is temporarily suppressed. */
2077 int poll_suppress_count
;
2079 /* Asynchronous timer for polling. */
2081 struct atimer
*poll_timer
;
2084 #ifdef POLL_FOR_INPUT
2086 /* Poll for input, so what we catch a C-g if it comes in. This
2087 function is called from x_make_frame_visible, see comment
2093 if (interrupt_input_blocked
== 0
2094 && !waiting_for_input
)
2095 read_avail_input (0);
2098 /* Timer callback function for poll_timer. TIMER is equal to
2102 poll_for_input (timer
)
2103 struct atimer
*timer
;
2105 if (poll_suppress_count
== 0)
2107 interrupt_input_pending
= 1;
2109 poll_for_input_1 ();
2113 #endif /* POLL_FOR_INPUT */
2115 /* Begin signals to poll for input, if they are appropriate.
2116 This function is called unconditionally from various places. */
2121 #ifdef POLL_FOR_INPUT
2122 if (read_socket_hook
&& !interrupt_input
)
2124 /* Turn alarm handling on unconditionally. It might have
2125 been turned off in process.c. */
2126 turn_on_atimers (1);
2128 /* If poll timer doesn't exist, are we need one with
2129 a different interval, start a new one. */
2130 if (poll_timer
== NULL
2131 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2133 EMACS_TIME interval
;
2136 cancel_atimer (poll_timer
);
2138 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2139 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2140 poll_for_input
, NULL
);
2143 /* Let the timer's callback function poll for input
2144 if this becomes zero. */
2145 --poll_suppress_count
;
2150 /* Nonzero if we are using polling to handle input asynchronously. */
2153 input_polling_used ()
2155 #ifdef POLL_FOR_INPUT
2156 return read_socket_hook
&& !interrupt_input
;
2162 /* Turn off polling. */
2167 #ifdef POLL_FOR_INPUT
2168 if (read_socket_hook
&& !interrupt_input
)
2169 ++poll_suppress_count
;
2173 /* Set the value of poll_suppress_count to COUNT
2174 and start or stop polling accordingly. */
2177 set_poll_suppress_count (count
)
2180 #ifdef POLL_FOR_INPUT
2181 if (count
== 0 && poll_suppress_count
!= 0)
2183 poll_suppress_count
= 1;
2186 else if (count
!= 0 && poll_suppress_count
== 0)
2190 poll_suppress_count
= count
;
2194 /* Bind polling_period to a value at least N.
2195 But don't decrease it. */
2198 bind_polling_period (n
)
2201 #ifdef POLL_FOR_INPUT
2202 int new = polling_period
;
2207 stop_other_atimers (poll_timer
);
2209 specbind (Qpolling_period
, make_number (new));
2210 /* Start a new alarm with the new period. */
2215 /* Apply the control modifier to CHARACTER. */
2221 /* Save the upper bits here. */
2222 int upper
= c
& ~0177;
2226 /* Everything in the columns containing the upper-case letters
2227 denotes a control character. */
2228 if (c
>= 0100 && c
< 0140)
2232 /* Set the shift modifier for a control char
2233 made from a shifted letter. But only for letters! */
2234 if (oc
>= 'A' && oc
<= 'Z')
2235 c
|= shift_modifier
;
2238 /* The lower-case letters denote control characters too. */
2239 else if (c
>= 'a' && c
<= 'z')
2242 /* Include the bits for control and shift
2243 only if the basic ASCII code can't indicate them. */
2247 /* Replace the high bits. */
2248 c
|= (upper
& ~ctrl_modifier
);
2253 /* Display the help-echo property of the character after the mouse pointer.
2254 Either show it in the echo area, or call show-help-function to display
2255 it by other means (maybe in a tooltip).
2257 If HELP is nil, that means clear the previous help echo.
2259 If HELP is a string, display that string. If HELP is a function,
2260 call it with OBJECT and POS as arguments; the function should
2261 return a help string or nil for none. For all other types of HELP,
2262 evaluate it to obtain a string.
2264 WINDOW is the window in which the help was generated, if any.
2265 It is nil if not in a window.
2267 If OBJECT is a buffer, POS is the position in the buffer where the
2268 `help-echo' text property was found.
2270 If OBJECT is an overlay, that overlay has a `help-echo' property,
2271 and POS is the position in the overlay's buffer under the mouse.
2273 If OBJECT is a string (an overlay string or a string displayed with
2274 the `display' property). POS is the position in that string under
2277 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2278 echo overwrites a keystroke echo currently displayed in the echo
2281 Note: this function may only be called with HELP nil or a string
2282 from X code running asynchronously. */
2285 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2286 Lisp_Object help
, window
, object
, pos
;
2287 int ok_to_overwrite_keystroke_echo
;
2289 if (!NILP (help
) && !STRINGP (help
))
2291 if (FUNCTIONP (help
))
2293 Lisp_Object args
[4];
2298 help
= safe_call (4, args
);
2301 help
= safe_eval (help
);
2303 if (!STRINGP (help
))
2308 if (!noninteractive
&& STRINGP (help
))
2309 help
= call1 (Qmouse_fixup_help_message
, help
);
2312 if (STRINGP (help
) || NILP (help
))
2314 if (!NILP (Vshow_help_function
))
2315 call1 (Vshow_help_function
, help
);
2316 else if (/* Don't overwrite minibuffer contents. */
2317 !MINI_WINDOW_P (XWINDOW (selected_window
))
2318 /* Don't overwrite a keystroke echo. */
2319 && (NILP (echo_message_buffer
)
2320 || ok_to_overwrite_keystroke_echo
)
2321 /* Don't overwrite a prompt. */
2322 && !cursor_in_echo_area
)
2326 int count
= SPECPDL_INDEX ();
2328 if (!help_echo_showing_p
)
2329 Vpre_help_message
= current_message ();
2331 specbind (Qmessage_truncate_lines
, Qt
);
2332 message3_nolog (help
, SBYTES (help
),
2333 STRING_MULTIBYTE (help
));
2334 unbind_to (count
, Qnil
);
2336 else if (STRINGP (Vpre_help_message
))
2338 message3_nolog (Vpre_help_message
,
2339 SBYTES (Vpre_help_message
),
2340 STRING_MULTIBYTE (Vpre_help_message
));
2341 Vpre_help_message
= Qnil
;
2347 help_echo_showing_p
= STRINGP (help
);
2353 /* Input of single characters from keyboard */
2355 Lisp_Object
print_help ();
2356 static Lisp_Object
kbd_buffer_get_event ();
2357 static void record_char ();
2360 static jmp_buf wrong_kboard_jmpbuf
;
2363 #define STOP_POLLING \
2364 do { if (! polling_stopped_here) stop_polling (); \
2365 polling_stopped_here = 1; } while (0)
2367 #define RESUME_POLLING \
2368 do { if (polling_stopped_here) start_polling (); \
2369 polling_stopped_here = 0; } while (0)
2371 /* read a character from the keyboard; call the redisplay if needed */
2372 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2373 -1 means do not do redisplay, but do do autosaving.
2376 /* The arguments MAPS and NMAPS are for menu prompting.
2377 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2379 PREV_EVENT is the previous input event, or nil if we are reading
2380 the first event of a key sequence (or not reading a key sequence).
2381 If PREV_EVENT is t, that is a "magic" value that says
2382 not to run input methods, but in other respects to act as if
2383 not reading a key sequence.
2385 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2386 if we used a mouse menu to read the input, or zero otherwise. If
2387 USED_MOUSE_MENU is null, we don't dereference it.
2389 Value is t if we showed a menu and the user rejected it. */
2392 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2396 Lisp_Object prev_event
;
2397 int *used_mouse_menu
;
2399 volatile Lisp_Object c
;
2401 jmp_buf local_getcjmp
;
2403 volatile int key_already_recorded
= 0;
2404 Lisp_Object tem
, save
;
2405 volatile Lisp_Object previous_echo_area_message
;
2406 volatile Lisp_Object also_record
;
2407 volatile int reread
;
2408 struct gcpro gcpro1
, gcpro2
;
2409 int polling_stopped_here
= 0;
2413 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2414 before_command_key_count
= this_command_key_count
;
2415 before_command_echo_length
= echo_length ();
2418 previous_echo_area_message
= Qnil
;
2420 GCPRO2 (c
, previous_echo_area_message
);
2425 if (CONSP (Vunread_post_input_method_events
))
2427 c
= XCAR (Vunread_post_input_method_events
);
2428 Vunread_post_input_method_events
2429 = XCDR (Vunread_post_input_method_events
);
2431 /* Undo what read_char_x_menu_prompt did when it unread
2432 additional keys returned by Fx_popup_menu. */
2434 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2442 if (unread_command_char
!= -1)
2444 XSETINT (c
, unread_command_char
);
2445 unread_command_char
= -1;
2451 if (CONSP (Vunread_command_events
))
2453 c
= XCAR (Vunread_command_events
);
2454 Vunread_command_events
= XCDR (Vunread_command_events
);
2456 /* Undo what read_char_x_menu_prompt did when it unread
2457 additional keys returned by Fx_popup_menu. */
2459 && EQ (XCDR (c
), Qdisabled
)
2460 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2463 /* If the queued event is something that used the mouse,
2464 set used_mouse_menu accordingly. */
2466 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2467 *used_mouse_menu
= 1;
2470 goto reread_for_input_method
;
2473 if (CONSP (Vunread_input_method_events
))
2475 c
= XCAR (Vunread_input_method_events
);
2476 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2478 /* Undo what read_char_x_menu_prompt did when it unread
2479 additional keys returned by Fx_popup_menu. */
2481 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2485 goto reread_for_input_method
;
2488 this_command_key_count_reset
= 0;
2490 if (!NILP (Vexecuting_kbd_macro
))
2492 /* We set this to Qmacro; since that's not a frame, nobody will
2493 try to switch frames on us, and the selected window will
2496 Since this event came from a macro, it would be misleading to
2497 leave internal_last_event_frame set to wherever the last
2498 real event came from. Normally, a switch-frame event selects
2499 internal_last_event_frame after each command is read, but
2500 events read from a macro should never cause a new frame to be
2502 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2504 /* Exit the macro if we are at the end.
2505 Also, some things replace the macro with t
2506 to force an early exit. */
2507 if (EQ (Vexecuting_kbd_macro
, Qt
)
2508 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2514 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2515 if (STRINGP (Vexecuting_kbd_macro
)
2516 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2517 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2519 executing_kbd_macro_index
++;
2524 if (!NILP (unread_switch_frame
))
2526 c
= unread_switch_frame
;
2527 unread_switch_frame
= Qnil
;
2529 /* This event should make it into this_command_keys, and get echoed
2530 again, so we do not set `reread'. */
2534 /* if redisplay was requested */
2535 if (commandflag
>= 0)
2537 /* If there is pending input, process any events which are not
2538 user-visible, such as X selection_request events. */
2540 || detect_input_pending_run_timers (0))
2541 swallow_events (0); /* may clear input_pending */
2543 /* Redisplay if no pending input. */
2544 while (!input_pending
)
2546 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2547 redisplay_preserve_echo_area (5);
2552 /* Normal case: no input arrived during redisplay. */
2555 /* Input arrived and pre-empted redisplay.
2556 Process any events which are not user-visible. */
2558 /* If that cleared input_pending, try again to redisplay. */
2562 /* Message turns off echoing unless more keystrokes turn it on again.
2564 The code in 20.x for the condition was
2566 1. echo_area_glyphs && *echo_area_glyphs
2567 2. && echo_area_glyphs != current_kboard->echobuf
2568 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2570 (1) means there's a current message displayed
2572 (2) means it's not the message from echoing from the current
2575 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2576 is set to a non-null value. This is done in read_char and it is
2577 set to echo_area_glyphs after a call to echo_char. That means
2578 ok_to_echo_at_next_pause is either null or
2579 current_kboard->echobuf with the appropriate current_kboard at
2582 So, condition (3) means in clear text ok_to_echo_at_next_pause
2583 must be either null, or the current message isn't from echoing at
2584 all, or it's from echoing from a different kboard than the
2587 if (/* There currently is something in the echo area. */
2588 !NILP (echo_area_buffer
[0])
2589 && (/* And it's either not from echoing. */
2590 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2591 /* Or it's an echo from a different kboard. */
2592 || echo_kboard
!= current_kboard
2593 /* Or we explicitly allow overwriting whatever there is. */
2594 || ok_to_echo_at_next_pause
== NULL
))
2599 /* Try reading a character via menu prompting in the minibuf.
2600 Try this before the sit-for, because the sit-for
2601 would do the wrong thing if we are supposed to do
2602 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2603 after a mouse event so don't try a minibuf menu. */
2605 if (nmaps
> 0 && INTERACTIVE
2606 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2607 /* Don't bring up a menu if we already have another event. */
2608 && NILP (Vunread_command_events
)
2609 && unread_command_char
< 0
2610 && !detect_input_pending_run_timers (0))
2612 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2615 key_already_recorded
= 1;
2620 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2621 We will do that below, temporarily for short sections of code,
2622 when appropriate. local_getcjmp must be in effect
2623 around any call to sit_for or kbd_buffer_get_event;
2624 it *must not* be in effect when we call redisplay. */
2626 if (_setjmp (local_getcjmp
))
2628 /* We must have saved the outer value of getcjmp here,
2629 so restore it now. */
2630 restore_getcjmp (save_jump
);
2631 XSETINT (c
, quit_char
);
2632 internal_last_event_frame
= selected_frame
;
2633 Vlast_event_frame
= internal_last_event_frame
;
2634 /* If we report the quit char as an event,
2635 don't do so more than once. */
2636 if (!NILP (Vinhibit_quit
))
2641 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2642 if (kb
!= current_kboard
)
2644 Lisp_Object link
= kb
->kbd_queue
;
2645 /* We shouldn't get here if we were in single-kboard mode! */
2650 while (CONSP (XCDR (link
)))
2652 if (!NILP (XCDR (link
)))
2656 kb
->kbd_queue
= Fcons (c
, Qnil
);
2658 XSETCDR (link
, Fcons (c
, Qnil
));
2659 kb
->kbd_queue_has_data
= 1;
2660 current_kboard
= kb
;
2661 /* This is going to exit from read_char
2662 so we had better get rid of this frame's stuff. */
2664 longjmp (wrong_kboard_jmpbuf
, 1);
2671 timer_start_idle ();
2673 /* If in middle of key sequence and minibuffer not active,
2674 start echoing if enough time elapses. */
2676 if (minibuf_level
== 0
2677 && !current_kboard
->immediate_echo
2678 && this_command_key_count
> 0
2680 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2681 && NILP (Fzerop (Vecho_keystrokes
))
2682 && (/* No message. */
2683 NILP (echo_area_buffer
[0])
2684 /* Or empty message. */
2685 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2686 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2687 /* Or already echoing from same kboard. */
2688 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2689 /* Or not echoing before and echoing allowed. */
2690 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2694 /* After a mouse event, start echoing right away.
2695 This is because we are probably about to display a menu,
2696 and we don't want to delay before doing so. */
2697 if (EVENT_HAS_PARAMETERS (prev_event
))
2702 double duration
= extract_float (Vecho_keystrokes
);
2703 sec
= (int) duration
;
2704 usec
= (duration
- sec
) * 1000000;
2705 save_getcjmp (save_jump
);
2706 restore_getcjmp (local_getcjmp
);
2707 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2708 restore_getcjmp (save_jump
);
2710 && ! CONSP (Vunread_command_events
))
2715 /* Maybe auto save due to number of keystrokes. */
2717 if (commandflag
!= 0
2718 && auto_save_interval
> 0
2719 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2720 && !detect_input_pending_run_timers (0))
2722 Fdo_auto_save (Qnil
, Qnil
);
2723 /* Hooks can actually change some buffers in auto save. */
2727 /* Try reading using an X menu.
2728 This is never confused with reading using the minibuf
2729 because the recursive call of read_char in read_char_minibuf_menu_prompt
2730 does not pass on any keymaps. */
2732 if (nmaps
> 0 && INTERACTIVE
2733 && !NILP (prev_event
)
2734 && EVENT_HAS_PARAMETERS (prev_event
)
2735 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2736 && !EQ (XCAR (prev_event
), Qtool_bar
)
2737 /* Don't bring up a menu if we already have another event. */
2738 && NILP (Vunread_command_events
)
2739 && unread_command_char
< 0)
2741 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2743 /* Now that we have read an event, Emacs is not idle. */
2749 /* Maybe autosave and/or garbage collect due to idleness. */
2751 if (INTERACTIVE
&& NILP (c
))
2753 int delay_level
, buffer_size
;
2755 /* Slow down auto saves logarithmically in size of current buffer,
2756 and garbage collect while we're at it. */
2757 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2758 last_non_minibuf_size
= Z
- BEG
;
2759 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2761 while (buffer_size
> 64)
2762 delay_level
++, buffer_size
-= buffer_size
>> 2;
2763 if (delay_level
< 4) delay_level
= 4;
2764 /* delay_level is 4 for files under around 50k, 7 at 100k,
2765 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2767 /* Auto save if enough time goes by without input. */
2768 if (commandflag
!= 0
2769 && num_nonmacro_input_events
> last_auto_save
2770 && INTEGERP (Vauto_save_timeout
)
2771 && XINT (Vauto_save_timeout
) > 0)
2775 save_getcjmp (save_jump
);
2776 restore_getcjmp (local_getcjmp
);
2777 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2779 restore_getcjmp (save_jump
);
2782 && ! CONSP (Vunread_command_events
))
2784 Fdo_auto_save (Qnil
, Qnil
);
2786 /* If we have auto-saved and there is still no input
2787 available, garbage collect if there has been enough
2788 consing going on to make it worthwhile. */
2789 if (!detect_input_pending_run_timers (0)
2790 && consing_since_gc
> gc_cons_threshold
/ 2)
2791 Fgarbage_collect ();
2798 /* If this has become non-nil here, it has been set by a timer
2799 or sentinel or filter. */
2800 if (CONSP (Vunread_command_events
))
2802 c
= XCAR (Vunread_command_events
);
2803 Vunread_command_events
= XCDR (Vunread_command_events
);
2806 /* Read something from current KBOARD's side queue, if possible. */
2810 if (current_kboard
->kbd_queue_has_data
)
2812 if (!CONSP (current_kboard
->kbd_queue
))
2814 c
= XCAR (current_kboard
->kbd_queue
);
2815 current_kboard
->kbd_queue
2816 = XCDR (current_kboard
->kbd_queue
);
2817 if (NILP (current_kboard
->kbd_queue
))
2818 current_kboard
->kbd_queue_has_data
= 0;
2819 input_pending
= readable_events (0);
2820 if (EVENT_HAS_PARAMETERS (c
)
2821 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2822 internal_last_event_frame
= XCAR (XCDR (c
));
2823 Vlast_event_frame
= internal_last_event_frame
;
2828 /* If current_kboard's side queue is empty check the other kboards.
2829 If one of them has data that we have not yet seen here,
2830 switch to it and process the data waiting for it.
2832 Note: if the events queued up for another kboard
2833 have already been seen here, and therefore are not a complete command,
2834 the kbd_queue_has_data field is 0, so we skip that kboard here.
2835 That's to avoid an infinite loop switching between kboards here. */
2836 if (NILP (c
) && !single_kboard
)
2839 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2840 if (kb
->kbd_queue_has_data
)
2842 current_kboard
= kb
;
2843 /* This is going to exit from read_char
2844 so we had better get rid of this frame's stuff. */
2846 longjmp (wrong_kboard_jmpbuf
, 1);
2855 /* Finally, we read from the main queue,
2856 and if that gives us something we can't use yet, we put it on the
2857 appropriate side queue and try again. */
2863 /* Actually read a character, waiting if necessary. */
2864 save_getcjmp (save_jump
);
2865 restore_getcjmp (local_getcjmp
);
2866 timer_start_idle ();
2867 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2868 restore_getcjmp (save_jump
);
2871 if (! NILP (c
) && (kb
!= current_kboard
))
2873 Lisp_Object link
= kb
->kbd_queue
;
2876 while (CONSP (XCDR (link
)))
2878 if (!NILP (XCDR (link
)))
2882 kb
->kbd_queue
= Fcons (c
, Qnil
);
2884 XSETCDR (link
, Fcons (c
, Qnil
));
2885 kb
->kbd_queue_has_data
= 1;
2889 current_kboard
= kb
;
2890 /* This is going to exit from read_char
2891 so we had better get rid of this frame's stuff. */
2893 longjmp (wrong_kboard_jmpbuf
, 1);
2898 /* Terminate Emacs in batch mode if at eof. */
2899 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2900 Fkill_emacs (make_number (1));
2904 /* Add in any extra modifiers, where appropriate. */
2905 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2906 || ((extra_keyboard_modifiers
& 0177) < ' '
2907 && (extra_keyboard_modifiers
& 0177) != 0))
2908 XSETINT (c
, make_ctrl_char (XINT (c
)));
2910 /* Transfer any other modifier bits directly from
2911 extra_keyboard_modifiers to c. Ignore the actual character code
2912 in the low 16 bits of extra_keyboard_modifiers. */
2913 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2923 if (commandflag
>= 0
2924 && !input_pending
&& !detect_input_pending_run_timers (0))
2932 /* Buffer switch events are only for internal wakeups
2933 so don't show them to the user.
2934 Also, don't record a key if we already did. */
2935 if (BUFFERP (c
) || key_already_recorded
)
2938 /* Process special events within read_char
2939 and loop around to read another event. */
2942 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2947 int was_locked
= single_kboard
;
2949 last_input_char
= c
;
2950 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2952 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2953 /* We stopped being idle for this event; undo that. This
2954 prevents automatic window selection (under
2955 mouse_autoselect_window from acting as a real input event, for
2956 example banishing the mouse under mouse-avoidance-mode. */
2957 timer_resume_idle ();
2959 /* Resume allowing input from any kboard, if that was true before. */
2961 any_kboard_state ();
2966 /* Handle things that only apply to characters. */
2969 /* If kbd_buffer_get_event gave us an EOF, return that. */
2973 if ((STRINGP (Vkeyboard_translate_table
)
2974 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2975 || (VECTORP (Vkeyboard_translate_table
)
2976 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2977 || CHAR_TABLE_P (Vkeyboard_translate_table
))
2980 d
= Faref (Vkeyboard_translate_table
, c
);
2981 /* nil in keyboard-translate-table means no translation. */
2987 /* If this event is a mouse click in the menu bar,
2988 return just menu-bar for now. Modify the mouse click event
2989 so we won't do this twice, then queue it up. */
2990 if (EVENT_HAS_PARAMETERS (c
)
2992 && CONSP (EVENT_START (c
))
2993 && CONSP (XCDR (EVENT_START (c
))))
2997 posn
= POSN_POSN (EVENT_START (c
));
2998 /* Handle menu-bar events:
2999 insert the dummy prefix event `menu-bar'. */
3000 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3002 /* Change menu-bar to (menu-bar) as the event "position". */
3003 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3006 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3011 /* Store these characters into recent_keys, the dribble file if any,
3012 and the keyboard macro being defined, if any. */
3014 if (! NILP (also_record
))
3015 record_char (also_record
);
3017 /* Wipe the echo area.
3018 But first, if we are about to use an input method,
3019 save the echo area contents for it to refer to. */
3021 && ! NILP (Vinput_method_function
)
3022 && (unsigned) XINT (c
) >= ' '
3023 && (unsigned) XINT (c
) != 127
3024 && (unsigned) XINT (c
) < 256)
3026 previous_echo_area_message
= Fcurrent_message ();
3027 Vinput_method_previous_message
= previous_echo_area_message
;
3030 /* Now wipe the echo area, except for help events which do their
3031 own stuff with the echo area. */
3033 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3034 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3036 if (!NILP (echo_area_buffer
[0]))
3037 safe_run_hooks (Qecho_area_clear_hook
);
3038 clear_message (1, 0);
3041 reread_for_input_method
:
3043 /* Pass this to the input method, if appropriate. */
3045 && ! NILP (Vinput_method_function
)
3046 /* Don't run the input method within a key sequence,
3047 after the first event of the key sequence. */
3048 && NILP (prev_event
)
3049 && (unsigned) XINT (c
) >= ' '
3050 && (unsigned) XINT (c
) != 127
3051 && (unsigned) XINT (c
) < 256)
3054 int key_count
, key_count_reset
;
3055 struct gcpro gcpro1
;
3056 int count
= SPECPDL_INDEX ();
3058 /* Save the echo status. */
3059 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3060 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3061 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3062 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3065 if (before_command_restore_flag
)
3067 this_command_key_count
= before_command_key_count_1
;
3068 if (this_command_key_count
< this_single_command_key_start
)
3069 this_single_command_key_start
= this_command_key_count
;
3070 echo_truncate (before_command_echo_length_1
);
3071 before_command_restore_flag
= 0;
3075 /* Save the this_command_keys status. */
3076 key_count
= this_command_key_count
;
3077 key_count_reset
= this_command_key_count_reset
;
3080 keys
= Fcopy_sequence (this_command_keys
);
3085 /* Clear out this_command_keys. */
3086 this_command_key_count
= 0;
3087 this_command_key_count_reset
= 0;
3089 /* Now wipe the echo area. */
3090 if (!NILP (echo_area_buffer
[0]))
3091 safe_run_hooks (Qecho_area_clear_hook
);
3092 clear_message (1, 0);
3095 /* If we are not reading a key sequence,
3096 never use the echo area. */
3099 specbind (Qinput_method_use_echo_area
, Qt
);
3102 /* Call the input method. */
3103 tem
= call1 (Vinput_method_function
, c
);
3105 tem
= unbind_to (count
, tem
);
3107 /* Restore the saved echoing state
3108 and this_command_keys state. */
3109 this_command_key_count
= key_count
;
3110 this_command_key_count_reset
= key_count_reset
;
3112 this_command_keys
= keys
;
3115 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3116 current_kboard
->echo_string
= saved_echo_string
;
3117 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3118 if (saved_immediate_echo
)
3123 /* The input method can return no events. */
3126 /* Bring back the previous message, if any. */
3127 if (! NILP (previous_echo_area_message
))
3128 message_with_string ("%s", previous_echo_area_message
, 0);
3131 /* It returned one event or more. */
3133 Vunread_post_input_method_events
3134 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3139 /* Display help if not echoing. */
3140 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3142 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3143 Lisp_Object help
, object
, position
, window
, tem
;
3145 tem
= Fcdr (XCDR (c
));
3148 window
= Fcar (tem
);
3150 object
= Fcar (tem
);
3152 position
= Fcar (tem
);
3154 show_help_echo (help
, window
, object
, position
, 0);
3156 /* We stopped being idle for this event; undo that. */
3157 timer_resume_idle ();
3161 if (! reread
|| this_command_key_count
== 0
3162 || this_command_key_count_reset
)
3165 /* Don't echo mouse motion events. */
3166 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3167 && NILP (Fzerop (Vecho_keystrokes
))
3168 && ! (EVENT_HAS_PARAMETERS (c
)
3169 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3172 if (! NILP (also_record
))
3173 echo_char (also_record
);
3174 /* Once we reread a character, echoing can happen
3175 the next time we pause to read a new one. */
3176 ok_to_echo_at_next_pause
= current_kboard
;
3179 /* Record this character as part of the current key. */
3180 add_command_key (c
);
3181 if (! NILP (also_record
))
3182 add_command_key (also_record
);
3185 last_input_char
= c
;
3188 /* Process the help character specially if enabled */
3189 if (!NILP (Vhelp_form
) && help_char_p (c
))
3192 count
= SPECPDL_INDEX ();
3194 record_unwind_protect (Fset_window_configuration
,
3195 Fcurrent_window_configuration (Qnil
));
3197 tem0
= Feval (Vhelp_form
);
3199 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3203 c
= read_char (0, 0, 0, Qnil
, 0);
3204 while (BUFFERP (c
));
3205 /* Remove the help from the frame */
3206 unbind_to (count
, Qnil
);
3209 if (EQ (c
, make_number (040)))
3213 c
= read_char (0, 0, 0, Qnil
, 0);
3214 while (BUFFERP (c
));
3223 /* Record a key that came from a mouse menu.
3224 Record it for echoing, for this-command-keys, and so on. */
3230 /* Wipe the echo area. */
3231 clear_message (1, 0);
3236 before_command_key_count
= this_command_key_count
;
3237 before_command_echo_length
= echo_length ();
3240 /* Don't echo mouse motion events. */
3241 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3242 && NILP (Fzerop (Vecho_keystrokes
)))
3246 /* Once we reread a character, echoing can happen
3247 the next time we pause to read a new one. */
3248 ok_to_echo_at_next_pause
= 0;
3251 /* Record this character as part of the current key. */
3252 add_command_key (c
);
3254 /* Re-reading in the middle of a command */
3255 last_input_char
= c
;
3259 /* Return 1 if should recognize C as "the help character". */
3267 if (EQ (c
, Vhelp_char
))
3269 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3270 if (EQ (c
, XCAR (tail
)))
3275 /* Record the input event C in various ways. */
3283 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3285 /* To avoid filling recent_keys with help-echo and mouse-movement
3286 events, we filter out repeated help-echo events, only store the
3287 first and last in a series of mouse-movement events, and don't
3288 store repeated help-echo events which are only separated by
3289 mouse-movement events. */
3291 Lisp_Object ev1
, ev2
, ev3
;
3294 if ((ix1
= recent_keys_index
- 1) < 0)
3295 ix1
= NUM_RECENT_KEYS
- 1;
3296 ev1
= AREF (recent_keys
, ix1
);
3298 if ((ix2
= ix1
- 1) < 0)
3299 ix2
= NUM_RECENT_KEYS
- 1;
3300 ev2
= AREF (recent_keys
, ix2
);
3302 if ((ix3
= ix2
- 1) < 0)
3303 ix3
= NUM_RECENT_KEYS
- 1;
3304 ev3
= AREF (recent_keys
, ix3
);
3306 if (EQ (XCAR (c
), Qhelp_echo
))
3308 /* Don't record `help-echo' in recent_keys unless it shows some help
3309 message, and a different help than the previously recorded
3311 Lisp_Object help
, last_help
;
3313 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3314 if (!STRINGP (help
))
3316 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3317 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3319 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3320 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3321 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3323 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3324 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3325 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3326 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3329 else if (EQ (XCAR (c
), Qmouse_movement
))
3331 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3332 So additional mouse movement events replace the last element. */
3333 Lisp_Object last_window
, window
;
3335 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3336 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3337 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3338 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3339 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3341 ASET (recent_keys
, ix1
, c
);
3347 store_kbd_macro_char (c
);
3352 ASET (recent_keys
, recent_keys_index
, c
);
3353 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3354 recent_keys_index
= 0;
3356 else if (recorded
< 0)
3358 /* We need to remove one or two events from recent_keys.
3359 To do this, we simply put nil at those events and move the
3360 recent_keys_index backwards over those events. Usually,
3361 users will never see those nil events, as they will be
3362 overwritten by the command keys entered to see recent_keys
3365 while (recorded
++ < 0 && total_keys
> 0)
3367 if (total_keys
< NUM_RECENT_KEYS
)
3369 if (--recent_keys_index
< 0)
3370 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3371 ASET (recent_keys
, recent_keys_index
, Qnil
);
3375 num_nonmacro_input_events
++;
3377 /* Write c to the dribble file. If c is a lispy event, write
3378 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3379 If you, dear reader, have a better idea, you've got the source. :-) */
3384 if (XUINT (c
) < 0x100)
3385 putc (XINT (c
), dribble
);
3387 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3391 Lisp_Object dribblee
;
3393 /* If it's a structured event, take the event header. */
3394 dribblee
= EVENT_HEAD (c
);
3396 if (SYMBOLP (dribblee
))
3398 putc ('<', dribble
);
3399 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3400 SBYTES (SYMBOL_NAME (dribblee
)),
3402 putc ('>', dribble
);
3414 struct buffer
*old
= current_buffer
;
3415 Fprinc (object
, Qnil
);
3416 set_buffer_internal (XBUFFER (Vstandard_output
));
3417 call0 (intern ("help-mode"));
3418 set_buffer_internal (old
);
3422 /* Copy out or in the info on where C-g should throw to.
3423 This is used when running Lisp code from within get_char,
3424 in case get_char is called recursively.
3425 See read_process_output. */
3431 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3435 restore_getcjmp (temp
)
3438 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3443 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3444 of this function. */
3447 tracking_off (old_value
)
3448 Lisp_Object old_value
;
3450 do_mouse_tracking
= old_value
;
3451 if (NILP (old_value
))
3453 /* Redisplay may have been preempted because there was input
3454 available, and it assumes it will be called again after the
3455 input has been processed. If the only input available was
3456 the sort that we have just disabled, then we need to call
3458 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3460 redisplay_preserve_echo_area (6);
3461 get_input_pending (&input_pending
,
3462 READABLE_EVENTS_DO_TIMERS_NOW
);
3468 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3469 doc
: /* Evaluate BODY with mouse movement events enabled.
3470 Within a `track-mouse' form, mouse motion generates input events that
3471 you can read with `read-event'.
3472 Normally, mouse motion is ignored.
3473 usage: (track-mouse BODY ...) */)
3477 int count
= SPECPDL_INDEX ();
3480 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3482 do_mouse_tracking
= Qt
;
3484 val
= Fprogn (args
);
3485 return unbind_to (count
, val
);
3488 /* If mouse has moved on some frame, return one of those frames.
3489 Return 0 otherwise. */
3494 Lisp_Object tail
, frame
;
3496 FOR_EACH_FRAME (tail
, frame
)
3498 if (XFRAME (frame
)->mouse_moved
)
3499 return XFRAME (frame
);
3505 #endif /* HAVE_MOUSE */
3507 /* Low level keyboard/mouse input.
3508 kbd_buffer_store_event places events in kbd_buffer, and
3509 kbd_buffer_get_event retrieves them. */
3511 /* Return true iff there are any events in the queue that read-char
3512 would return. If this returns false, a read-char would block. */
3514 readable_events (flags
)
3517 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3520 /* If the buffer contains only FOCUS_IN_EVENT events, and
3521 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3522 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3524 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3525 #ifdef USE_TOOLKIT_SCROLL_BARS
3526 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3530 struct input_event
*event
;
3532 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3539 #ifdef USE_TOOLKIT_SCROLL_BARS
3540 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3542 event
->kind
== FOCUS_IN_EVENT
)
3543 #ifdef USE_TOOLKIT_SCROLL_BARS
3544 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3545 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3546 && event
->part
== scroll_bar_handle
3547 && event
->modifiers
== 0)
3552 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3555 while (event
!= kbd_store_ptr
);
3562 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3563 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3568 if (current_kboard
->kbd_queue_has_data
)
3574 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3575 if (kb
->kbd_queue_has_data
)
3581 /* Set this for debugging, to have a way to get out */
3586 event_to_kboard (event
)
3587 struct input_event
*event
;
3590 frame
= event
->frame_or_window
;
3592 frame
= XCAR (frame
);
3593 else if (WINDOWP (frame
))
3594 frame
= WINDOW_FRAME (XWINDOW (frame
));
3596 /* There are still some events that don't set this field.
3597 For now, just ignore the problem.
3598 Also ignore dead frames here. */
3599 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3602 return FRAME_KBOARD (XFRAME (frame
));
3607 Lisp_Object Vthrow_on_input
;
3609 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3612 kbd_buffer_store_event (event
)
3613 register struct input_event
*event
;
3615 kbd_buffer_store_event_hold (event
, 0);
3618 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3620 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3621 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3622 Else, if EVENT is a quit event, store the quit event
3623 in HOLD_QUIT, and return (thus ignoring further events).
3625 This is used in read_avail_input to postpone the processing
3626 of the quit event until all subsequent input events have been
3627 parsed (and discarded).
3631 kbd_buffer_store_event_hold (event
, hold_quit
)
3632 register struct input_event
*event
;
3633 struct input_event
*hold_quit
;
3635 if (event
->kind
== NO_EVENT
)
3638 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3641 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3643 register int c
= event
->code
& 0377;
3645 if (event
->modifiers
& ctrl_modifier
)
3646 c
= make_ctrl_char (c
);
3648 c
|= (event
->modifiers
3649 & (meta_modifier
| alt_modifier
3650 | hyper_modifier
| super_modifier
));
3656 struct input_event
*sp
;
3659 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3660 kb
!= current_kboard
))
3663 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3664 Fcons (make_number (c
), Qnil
));
3665 kb
->kbd_queue_has_data
= 1;
3666 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3668 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3671 if (event_to_kboard (sp
) == kb
)
3673 sp
->kind
= NO_EVENT
;
3674 sp
->frame_or_window
= Qnil
;
3684 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3688 /* If this results in a quit_char being returned to Emacs as
3689 input, set Vlast_event_frame properly. If this doesn't
3690 get returned to Emacs as an event, the next event read
3691 will set Vlast_event_frame again, so this is safe to do. */
3695 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3697 focus
= event
->frame_or_window
;
3698 internal_last_event_frame
= focus
;
3699 Vlast_event_frame
= focus
;
3702 last_event_timestamp
= event
->timestamp
;
3703 interrupt_signal (0 /* dummy */);
3707 if (c
&& c
== stop_character
)
3713 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3714 Just ignore the second one. */
3715 else if (event
->kind
== BUFFER_SWITCH_EVENT
3716 && kbd_fetch_ptr
!= kbd_store_ptr
3717 && ((kbd_store_ptr
== kbd_buffer
3718 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3719 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3722 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3723 kbd_store_ptr
= kbd_buffer
;
3725 /* Don't let the very last slot in the buffer become full,
3726 since that would make the two pointers equal,
3727 and that is indistinguishable from an empty buffer.
3728 Discard the event if it would fill the last slot. */
3729 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3731 *kbd_store_ptr
= *event
;
3735 /* If we're inside while-no-input, and this event qualifies
3736 as input, set quit-flag to cause an interrupt. */
3737 if (!NILP (Vthrow_on_input
)
3738 && event
->kind
!= FOCUS_IN_EVENT
3739 && event
->kind
!= HELP_EVENT
3740 && event
->kind
!= DEICONIFY_EVENT
)
3742 Vquit_flag
= Vthrow_on_input
;
3743 /* If we're inside a function that wants immediate quits,
3745 if (immediate_quit
&& NILP (Vinhibit_quit
))
3755 /* Put an input event back in the head of the event queue. */
3758 kbd_buffer_unget_event (event
)
3759 register struct input_event
*event
;
3761 if (kbd_fetch_ptr
== kbd_buffer
)
3762 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3764 /* Don't let the very last slot in the buffer become full, */
3765 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3768 *kbd_fetch_ptr
= *event
;
3773 /* Generate HELP_EVENT input_events in BUFP which has room for
3774 SIZE events. If there's not enough room in BUFP, ignore this
3777 HELP is the help form.
3779 FRAME is the frame on which the help is generated. OBJECT is the
3780 Lisp object where the help was found (a buffer, a string, an
3781 overlay, or nil if neither from a string nor from a buffer. POS is
3782 the position within OBJECT where the help was found.
3784 Value is the number of input_events generated. */
3787 gen_help_event (help
, frame
, window
, object
, pos
)
3788 Lisp_Object help
, frame
, object
, window
;
3791 struct input_event event
;
3795 event
.kind
= HELP_EVENT
;
3796 event
.frame_or_window
= frame
;
3798 event
.x
= WINDOWP (window
) ? window
: frame
;
3801 kbd_buffer_store_event (&event
);
3805 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3808 kbd_buffer_store_help_event (frame
, help
)
3809 Lisp_Object frame
, help
;
3811 struct input_event event
;
3813 event
.kind
= HELP_EVENT
;
3814 event
.frame_or_window
= frame
;
3819 kbd_buffer_store_event (&event
);
3823 /* Discard any mouse events in the event buffer by setting them to
3826 discard_mouse_events ()
3828 struct input_event
*sp
;
3829 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3831 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3834 if (sp
->kind
== MOUSE_CLICK_EVENT
3835 || sp
->kind
== WHEEL_EVENT
3837 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3839 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3841 sp
->kind
= NO_EVENT
;
3847 /* Return non-zero if there are any real events waiting in the event
3848 buffer, not counting `NO_EVENT's.
3850 If DISCARD is non-zero, discard NO_EVENT events at the front of
3851 the input queue, possibly leaving the input queue empty if there
3852 are no real input events. */
3855 kbd_buffer_events_waiting (discard
)
3858 struct input_event
*sp
;
3860 for (sp
= kbd_fetch_ptr
;
3861 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3864 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3871 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3875 /* Clear input event EVENT. */
3879 struct input_event
*event
;
3881 event
->kind
= NO_EVENT
;
3885 /* Read one event from the event buffer, waiting if necessary.
3886 The value is a Lisp object representing the event.
3887 The value is nil for an event that should be ignored,
3888 or that was handled here.
3889 We always read and discard one event. */
3892 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3894 int *used_mouse_menu
;
3903 *kbp
= current_kboard
;
3907 /* Wait until there is input available. */
3910 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3913 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3917 /* If the quit flag is set, then read_char will return
3918 quit_char, so that counts as "available input." */
3919 if (!NILP (Vquit_flag
))
3920 quit_throw_to_read_char ();
3922 /* One way or another, wait until input is available; then, if
3923 interrupt handlers have not read it, read it now. */
3926 wait_for_kbd_input ();
3928 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3932 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3935 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3939 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3941 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3942 /* Pass 1 for EXPECT since we just waited to have input. */
3943 read_avail_input (1);
3945 #endif /* not VMS */
3948 if (CONSP (Vunread_command_events
))
3951 first
= XCAR (Vunread_command_events
);
3952 Vunread_command_events
= XCDR (Vunread_command_events
);
3953 *kbp
= current_kboard
;
3957 /* At this point, we know that there is a readable event available
3958 somewhere. If the event queue is empty, then there must be a
3959 mouse movement enabled and available. */
3960 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3962 struct input_event
*event
;
3964 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3968 last_event_timestamp
= event
->timestamp
;
3971 *kbp
= event_to_kboard (event
);
3973 *kbp
= current_kboard
; /* Better than returning null ptr? */
3975 *kbp
= &the_only_kboard
;
3980 /* These two kinds of events get special handling
3981 and don't actually appear to the command loop.
3982 We return nil for them. */
3983 if (event
->kind
== SELECTION_REQUEST_EVENT
3984 || event
->kind
== SELECTION_CLEAR_EVENT
)
3987 struct input_event copy
;
3989 /* Remove it from the buffer before processing it,
3990 since otherwise swallow_events will see it
3991 and process it again. */
3993 kbd_fetch_ptr
= event
+ 1;
3994 input_pending
= readable_events (0);
3995 x_handle_selection_event (©
);
3997 /* We're getting selection request events, but we don't have
4003 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4004 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4006 /* Make an event (delete-frame (FRAME)). */
4007 obj
= Fcons (event
->frame_or_window
, Qnil
);
4008 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4009 kbd_fetch_ptr
= event
+ 1;
4012 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4013 else if (event
->kind
== ICONIFY_EVENT
)
4015 /* Make an event (iconify-frame (FRAME)). */
4016 obj
= Fcons (event
->frame_or_window
, Qnil
);
4017 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4018 kbd_fetch_ptr
= event
+ 1;
4020 else if (event
->kind
== DEICONIFY_EVENT
)
4022 /* Make an event (make-frame-visible (FRAME)). */
4023 obj
= Fcons (event
->frame_or_window
, Qnil
);
4024 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4025 kbd_fetch_ptr
= event
+ 1;
4028 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4030 /* The value doesn't matter here; only the type is tested. */
4031 XSETBUFFER (obj
, current_buffer
);
4032 kbd_fetch_ptr
= event
+ 1;
4034 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4035 || defined (USE_GTK)
4036 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4038 kbd_fetch_ptr
= event
+ 1;
4039 input_pending
= readable_events (0);
4040 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4041 x_activate_menubar (XFRAME (event
->frame_or_window
));
4044 #if defined (WINDOWSNT) || defined (MAC_OS)
4045 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4048 /* Make an event (language-change (KEY_SCRIPT)). */
4049 obj
= Fcons (make_number (event
->code
), Qnil
);
4051 /* Make an event (language-change (FRAME CHARSET LCID)). */
4052 obj
= Fcons (event
->frame_or_window
, Qnil
);
4054 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4055 kbd_fetch_ptr
= event
+ 1;
4058 else if (event
->kind
== SAVE_SESSION_EVENT
)
4060 obj
= Fcons (Qsave_session
, Qnil
);
4061 kbd_fetch_ptr
= event
+ 1;
4063 /* Just discard these, by returning nil.
4064 With MULTI_KBOARD, these events are used as placeholders
4065 when we need to randomly delete events from the queue.
4066 (They shouldn't otherwise be found in the buffer,
4067 but on some machines it appears they do show up
4068 even without MULTI_KBOARD.) */
4069 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4070 mouse events during a popup-menu call. */
4071 else if (event
->kind
== NO_EVENT
)
4072 kbd_fetch_ptr
= event
+ 1;
4073 else if (event
->kind
== HELP_EVENT
)
4075 Lisp_Object object
, position
, help
, frame
, window
;
4077 frame
= event
->frame_or_window
;
4078 object
= event
->arg
;
4079 position
= make_number (event
->code
);
4082 clear_event (event
);
4084 kbd_fetch_ptr
= event
+ 1;
4085 if (!WINDOWP (window
))
4087 obj
= Fcons (Qhelp_echo
,
4088 list5 (frame
, help
, window
, object
, position
));
4090 else if (event
->kind
== FOCUS_IN_EVENT
)
4092 /* Notification of a FocusIn event. The frame receiving the
4093 focus is in event->frame_or_window. Generate a
4094 switch-frame event if necessary. */
4095 Lisp_Object frame
, focus
;
4097 frame
= event
->frame_or_window
;
4098 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4102 if (!EQ (frame
, internal_last_event_frame
)
4103 && !EQ (frame
, selected_frame
))
4104 obj
= make_lispy_switch_frame (frame
);
4105 internal_last_event_frame
= frame
;
4106 kbd_fetch_ptr
= event
+ 1;
4110 /* If this event is on a different frame, return a switch-frame this
4111 time, and leave the event in the queue for next time. */
4115 frame
= event
->frame_or_window
;
4117 frame
= XCAR (frame
);
4118 else if (WINDOWP (frame
))
4119 frame
= WINDOW_FRAME (XWINDOW (frame
));
4121 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4125 if (! EQ (frame
, internal_last_event_frame
)
4126 && !EQ (frame
, selected_frame
))
4127 obj
= make_lispy_switch_frame (frame
);
4128 internal_last_event_frame
= frame
;
4130 /* If we didn't decide to make a switch-frame event, go ahead
4131 and build a real event from the queue entry. */
4135 obj
= make_lispy_event (event
);
4137 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4138 || defined (USE_GTK)
4139 /* If this was a menu selection, then set the flag to inhibit
4140 writing to last_nonmenu_event. Don't do this if the event
4141 we're returning is (menu-bar), though; that indicates the
4142 beginning of the menu sequence, and we might as well leave
4143 that as the `event with parameters' for this selection. */
4145 && !EQ (event
->frame_or_window
, event
->arg
)
4146 && (event
->kind
== MENU_BAR_EVENT
4147 || event
->kind
== TOOL_BAR_EVENT
))
4148 *used_mouse_menu
= 1;
4151 /* Wipe out this event, to catch bugs. */
4152 clear_event (event
);
4153 kbd_fetch_ptr
= event
+ 1;
4158 /* Try generating a mouse motion event. */
4159 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4161 FRAME_PTR f
= some_mouse_moved ();
4162 Lisp_Object bar_window
;
4163 enum scroll_bar_part part
;
4167 *kbp
= current_kboard
;
4168 /* Note that this uses F to determine which display to look at.
4169 If there is no valid info, it does not store anything
4170 so x remains nil. */
4172 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4176 /* Decide if we should generate a switch-frame event. Don't
4177 generate switch-frame events for motion outside of all Emacs
4183 frame
= FRAME_FOCUS_FRAME (f
);
4185 XSETFRAME (frame
, f
);
4187 if (! EQ (frame
, internal_last_event_frame
)
4188 && !EQ (frame
, selected_frame
))
4189 obj
= make_lispy_switch_frame (frame
);
4190 internal_last_event_frame
= frame
;
4193 /* If we didn't decide to make a switch-frame event, go ahead and
4194 return a mouse-motion event. */
4195 if (!NILP (x
) && NILP (obj
))
4196 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4198 #endif /* HAVE_MOUSE */
4200 /* We were promised by the above while loop that there was
4201 something for us to read! */
4204 input_pending
= readable_events (0);
4206 Vlast_event_frame
= internal_last_event_frame
;
4211 /* Process any events that are not user-visible,
4212 then return, without reading any user-visible events. */
4215 swallow_events (do_display
)
4220 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4222 struct input_event
*event
;
4224 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4228 last_event_timestamp
= event
->timestamp
;
4230 /* These two kinds of events get special handling
4231 and don't actually appear to the command loop. */
4232 if (event
->kind
== SELECTION_REQUEST_EVENT
4233 || event
->kind
== SELECTION_CLEAR_EVENT
)
4236 struct input_event copy
;
4238 /* Remove it from the buffer before processing it,
4239 since otherwise swallow_events called recursively could see it
4240 and process it again. */
4242 kbd_fetch_ptr
= event
+ 1;
4243 input_pending
= readable_events (0);
4244 x_handle_selection_event (©
);
4246 /* We're getting selection request events, but we don't have
4255 old_timers_run
= timers_run
;
4256 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4258 if (timers_run
!= old_timers_run
&& do_display
)
4259 redisplay_preserve_echo_area (7);
4262 /* Record the start of when Emacs is idle,
4263 for the sake of running idle-time timers. */
4270 /* If we are already in the idle state, do nothing. */
4271 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4274 EMACS_GET_TIME (timer_idleness_start_time
);
4276 timer_last_idleness_start_time
= timer_idleness_start_time
;
4278 /* Mark all idle-time timers as once again candidates for running. */
4279 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4283 timer
= XCAR (timers
);
4285 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4287 XVECTOR (timer
)->contents
[0] = Qnil
;
4291 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4296 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4299 /* Resume idle timer from last idle start time. */
4302 timer_resume_idle ()
4304 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4307 timer_idleness_start_time
= timer_last_idleness_start_time
;
4310 /* This is only for debugging. */
4311 struct input_event last_timer_event
;
4313 /* Check whether a timer has fired. To prevent larger problems we simply
4314 disregard elements that are not proper timers. Do not make a circular
4315 timer list for the time being.
4317 Returns the number of seconds to wait until the next timer fires. If a
4318 timer is triggering now, return zero seconds.
4319 If no timer is active, return -1 seconds.
4321 If a timer is ripe, we run it, with quitting turned off.
4323 DO_IT_NOW is now ignored. It used to mean that we should
4324 run the timer directly instead of queueing a timer-event.
4325 Now we always run timers directly. */
4328 timer_check (do_it_now
)
4331 EMACS_TIME nexttime
;
4332 EMACS_TIME now
, idleness_now
;
4333 Lisp_Object timers
, idle_timers
, chosen_timer
;
4334 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4336 EMACS_SET_SECS (nexttime
, -1);
4337 EMACS_SET_USECS (nexttime
, -1);
4339 /* Always consider the ordinary timers. */
4340 timers
= Vtimer_list
;
4341 /* Consider the idle timers only if Emacs is idle. */
4342 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4343 idle_timers
= Vtimer_idle_list
;
4346 chosen_timer
= Qnil
;
4347 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4349 if (CONSP (timers
) || CONSP (idle_timers
))
4351 EMACS_GET_TIME (now
);
4352 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4353 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4356 while (CONSP (timers
) || CONSP (idle_timers
))
4358 Lisp_Object
*vector
;
4359 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4360 EMACS_TIME timer_time
, idle_timer_time
;
4361 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4363 /* Skip past invalid timers and timers already handled. */
4366 timer
= XCAR (timers
);
4367 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4369 timers
= XCDR (timers
);
4372 vector
= XVECTOR (timer
)->contents
;
4374 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4375 || !INTEGERP (vector
[3])
4376 || ! NILP (vector
[0]))
4378 timers
= XCDR (timers
);
4382 if (!NILP (idle_timers
))
4384 timer
= XCAR (idle_timers
);
4385 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4387 idle_timers
= XCDR (idle_timers
);
4390 vector
= XVECTOR (timer
)->contents
;
4392 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4393 || !INTEGERP (vector
[3])
4394 || ! NILP (vector
[0]))
4396 idle_timers
= XCDR (idle_timers
);
4401 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4402 based on the next ordinary timer.
4403 TIMER_DIFFERENCE is the distance in time from NOW to when
4404 this timer becomes ripe (negative if it's already ripe). */
4407 timer
= XCAR (timers
);
4408 vector
= XVECTOR (timer
)->contents
;
4409 EMACS_SET_SECS (timer_time
,
4410 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4411 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4412 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4415 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4416 based on the next idle timer. */
4417 if (!NILP (idle_timers
))
4419 idle_timer
= XCAR (idle_timers
);
4420 vector
= XVECTOR (idle_timer
)->contents
;
4421 EMACS_SET_SECS (idle_timer_time
,
4422 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4423 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4424 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4427 /* Decide which timer is the next timer,
4428 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4429 Also step down the list where we found that timer. */
4431 if (! NILP (timers
) && ! NILP (idle_timers
))
4434 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4435 if (EMACS_TIME_NEG_P (temp
))
4437 chosen_timer
= timer
;
4438 timers
= XCDR (timers
);
4439 difference
= timer_difference
;
4443 chosen_timer
= idle_timer
;
4444 idle_timers
= XCDR (idle_timers
);
4445 difference
= idle_timer_difference
;
4448 else if (! NILP (timers
))
4450 chosen_timer
= timer
;
4451 timers
= XCDR (timers
);
4452 difference
= timer_difference
;
4456 chosen_timer
= idle_timer
;
4457 idle_timers
= XCDR (idle_timers
);
4458 difference
= idle_timer_difference
;
4460 vector
= XVECTOR (chosen_timer
)->contents
;
4462 /* If timer is ripe, run it if it hasn't been run. */
4463 if (EMACS_TIME_NEG_P (difference
)
4464 || (EMACS_SECS (difference
) == 0
4465 && EMACS_USECS (difference
) == 0))
4467 if (NILP (vector
[0]))
4469 int was_locked
= single_kboard
;
4470 int count
= SPECPDL_INDEX ();
4471 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4473 /* Mark the timer as triggered to prevent problems if the lisp
4474 code fails to reschedule it right. */
4477 specbind (Qinhibit_quit
, Qt
);
4479 call1 (Qtimer_event_handler
, chosen_timer
);
4480 Vdeactivate_mark
= old_deactivate_mark
;
4482 unbind_to (count
, Qnil
);
4484 /* Resume allowing input from any kboard, if that was true before. */
4486 any_kboard_state ();
4488 /* Since we have handled the event,
4489 we don't need to tell the caller to wake up and do it. */
4493 /* When we encounter a timer that is still waiting,
4494 return the amount of time to wait before it is ripe. */
4501 /* No timers are pending in the future. */
4502 /* Return 0 if we generated an event, and -1 if not. */
4507 /* Caches for modify_event_symbol. */
4508 static Lisp_Object accent_key_syms
;
4509 static Lisp_Object func_key_syms
;
4510 static Lisp_Object mouse_syms
;
4511 static Lisp_Object wheel_syms
;
4512 static Lisp_Object drag_n_drop_syms
;
4514 /* This is a list of keysym codes for special "accent" characters.
4515 It parallels lispy_accent_keys. */
4517 static int lispy_accent_codes
[] =
4519 #ifdef XK_dead_circumflex
4524 #ifdef XK_dead_grave
4529 #ifdef XK_dead_tilde
4534 #ifdef XK_dead_diaeresis
4539 #ifdef XK_dead_macron
4544 #ifdef XK_dead_degree
4549 #ifdef XK_dead_acute
4554 #ifdef XK_dead_cedilla
4559 #ifdef XK_dead_breve
4564 #ifdef XK_dead_ogonek
4569 #ifdef XK_dead_caron
4574 #ifdef XK_dead_doubleacute
4575 XK_dead_doubleacute
,
4579 #ifdef XK_dead_abovedot
4584 #ifdef XK_dead_abovering
4594 #ifdef XK_dead_belowdot
4599 #ifdef XK_dead_voiced_sound
4600 XK_dead_voiced_sound
,
4604 #ifdef XK_dead_semivoiced_sound
4605 XK_dead_semivoiced_sound
,
4621 /* This is a list of Lisp names for special "accent" characters.
4622 It parallels lispy_accent_codes. */
4624 static char *lispy_accent_keys
[] =
4642 "dead-voiced-sound",
4643 "dead-semivoiced-sound",
4649 #define FUNCTION_KEY_OFFSET 0x0
4651 char *lispy_function_keys
[] =
4655 0, /* VK_LBUTTON 0x01 */
4656 0, /* VK_RBUTTON 0x02 */
4657 "cancel", /* VK_CANCEL 0x03 */
4658 0, /* VK_MBUTTON 0x04 */
4660 0, 0, 0, /* 0x05 .. 0x07 */
4662 "backspace", /* VK_BACK 0x08 */
4663 "tab", /* VK_TAB 0x09 */
4665 0, 0, /* 0x0A .. 0x0B */
4667 "clear", /* VK_CLEAR 0x0C */
4668 "return", /* VK_RETURN 0x0D */
4670 0, 0, /* 0x0E .. 0x0F */
4672 0, /* VK_SHIFT 0x10 */
4673 0, /* VK_CONTROL 0x11 */
4674 0, /* VK_MENU 0x12 */
4675 "pause", /* VK_PAUSE 0x13 */
4676 "capslock", /* VK_CAPITAL 0x14 */
4678 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4680 "escape", /* VK_ESCAPE 0x1B */
4682 0, 0, 0, 0, /* 0x1C .. 0x1F */
4684 0, /* VK_SPACE 0x20 */
4685 "prior", /* VK_PRIOR 0x21 */
4686 "next", /* VK_NEXT 0x22 */
4687 "end", /* VK_END 0x23 */
4688 "home", /* VK_HOME 0x24 */
4689 "left", /* VK_LEFT 0x25 */
4690 "up", /* VK_UP 0x26 */
4691 "right", /* VK_RIGHT 0x27 */
4692 "down", /* VK_DOWN 0x28 */
4693 "select", /* VK_SELECT 0x29 */
4694 "print", /* VK_PRINT 0x2A */
4695 "execute", /* VK_EXECUTE 0x2B */
4696 "snapshot", /* VK_SNAPSHOT 0x2C */
4697 "insert", /* VK_INSERT 0x2D */
4698 "delete", /* VK_DELETE 0x2E */
4699 "help", /* VK_HELP 0x2F */
4701 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4703 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4705 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4707 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4709 0, 0, 0, 0, 0, 0, 0, 0, 0,
4710 0, 0, 0, 0, 0, 0, 0, 0, 0,
4711 0, 0, 0, 0, 0, 0, 0, 0,
4713 "lwindow", /* VK_LWIN 0x5B */
4714 "rwindow", /* VK_RWIN 0x5C */
4715 "apps", /* VK_APPS 0x5D */
4717 0, 0, /* 0x5E .. 0x5F */
4719 "kp-0", /* VK_NUMPAD0 0x60 */
4720 "kp-1", /* VK_NUMPAD1 0x61 */
4721 "kp-2", /* VK_NUMPAD2 0x62 */
4722 "kp-3", /* VK_NUMPAD3 0x63 */
4723 "kp-4", /* VK_NUMPAD4 0x64 */
4724 "kp-5", /* VK_NUMPAD5 0x65 */
4725 "kp-6", /* VK_NUMPAD6 0x66 */
4726 "kp-7", /* VK_NUMPAD7 0x67 */
4727 "kp-8", /* VK_NUMPAD8 0x68 */
4728 "kp-9", /* VK_NUMPAD9 0x69 */
4729 "kp-multiply", /* VK_MULTIPLY 0x6A */
4730 "kp-add", /* VK_ADD 0x6B */
4731 "kp-separator", /* VK_SEPARATOR 0x6C */
4732 "kp-subtract", /* VK_SUBTRACT 0x6D */
4733 "kp-decimal", /* VK_DECIMAL 0x6E */
4734 "kp-divide", /* VK_DIVIDE 0x6F */
4735 "f1", /* VK_F1 0x70 */
4736 "f2", /* VK_F2 0x71 */
4737 "f3", /* VK_F3 0x72 */
4738 "f4", /* VK_F4 0x73 */
4739 "f5", /* VK_F5 0x74 */
4740 "f6", /* VK_F6 0x75 */
4741 "f7", /* VK_F7 0x76 */
4742 "f8", /* VK_F8 0x77 */
4743 "f9", /* VK_F9 0x78 */
4744 "f10", /* VK_F10 0x79 */
4745 "f11", /* VK_F11 0x7A */
4746 "f12", /* VK_F12 0x7B */
4747 "f13", /* VK_F13 0x7C */
4748 "f14", /* VK_F14 0x7D */
4749 "f15", /* VK_F15 0x7E */
4750 "f16", /* VK_F16 0x7F */
4751 "f17", /* VK_F17 0x80 */
4752 "f18", /* VK_F18 0x81 */
4753 "f19", /* VK_F19 0x82 */
4754 "f20", /* VK_F20 0x83 */
4755 "f21", /* VK_F21 0x84 */
4756 "f22", /* VK_F22 0x85 */
4757 "f23", /* VK_F23 0x86 */
4758 "f24", /* VK_F24 0x87 */
4760 0, 0, 0, 0, /* 0x88 .. 0x8B */
4761 0, 0, 0, 0, /* 0x8C .. 0x8F */
4763 "kp-numlock", /* VK_NUMLOCK 0x90 */
4764 "scroll", /* VK_SCROLL 0x91 */
4766 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4767 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4768 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4769 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4770 "kp-end", /* VK_NUMPAD_END 0x96 */
4771 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4772 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4773 "kp-up", /* VK_NUMPAD_UP 0x99 */
4774 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4775 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4776 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4777 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4779 0, 0, /* 0x9E .. 0x9F */
4782 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4783 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4784 * No other API or message will distinguish left and right keys this way.
4788 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4789 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4790 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4791 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4792 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4798 "attn", /* VK_ATTN 0xF6 */
4799 "crsel", /* VK_CRSEL 0xF7 */
4800 "exsel", /* VK_EXSEL 0xF8 */
4801 "ereof", /* VK_EREOF 0xF9 */
4802 "play", /* VK_PLAY 0xFA */
4803 "zoom", /* VK_ZOOM 0xFB */
4804 "noname", /* VK_NONAME 0xFC */
4805 "pa1", /* VK_PA1 0xFD */
4806 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4810 #else /* not HAVE_NTGUI */
4812 /* This should be dealt with in XTread_socket now, and that doesn't
4813 depend on the client system having the Kana syms defined. See also
4814 the XK_kana_A case below. */
4817 static char *lispy_kana_keys
[] =
4819 /* X Keysym value */
4820 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4821 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4822 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4823 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4824 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4825 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4826 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4827 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4828 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4829 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4830 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4831 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4832 "kana-i", "kana-u", "kana-e", "kana-o",
4833 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4834 "prolongedsound", "kana-A", "kana-I", "kana-U",
4835 "kana-E", "kana-O", "kana-KA", "kana-KI",
4836 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4837 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4838 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4839 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4840 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4841 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4842 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4843 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4844 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4845 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4846 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4847 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4849 #endif /* XK_kana_A */
4852 #define FUNCTION_KEY_OFFSET 0xff00
4854 /* You'll notice that this table is arranged to be conveniently
4855 indexed by X Windows keysym values. */
4856 static char *lispy_function_keys
[] =
4858 /* X Keysym value */
4860 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4861 "backspace", "tab", "linefeed", "clear",
4863 0, 0, 0, "pause", /* 0xff10...1f */
4864 0, 0, 0, 0, 0, 0, 0, "escape",
4866 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4867 "romaji", "hiragana", "katakana", "hiragana-katakana",
4868 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4869 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4870 "eisu-toggle", /* 0xff30...3f */
4871 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4872 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4874 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4875 "down", "prior", "next", "end",
4876 "begin", 0, 0, 0, 0, 0, 0, 0,
4877 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4888 "break", /* 0xff6b */
4891 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4892 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4893 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4894 0, 0, 0, 0, 0, 0, 0, 0,
4895 "kp-tab", /* 0xff89 */
4897 "kp-enter", /* 0xff8d */
4899 "kp-f1", /* 0xff91 */
4903 "kp-home", /* 0xff95 */
4908 "kp-prior", /* kp-page-up */
4909 "kp-next", /* kp-page-down */
4915 0, 0, 0, 0, 0, 0, 0, 0, 0,
4916 "kp-multiply", /* 0xffaa */
4921 "kp-divide", /* 0xffaf */
4922 "kp-0", /* 0xffb0 */
4923 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4926 "kp-equal", /* 0xffbd */
4927 "f1", /* 0xffbe */ /* IsFunctionKey */
4929 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4930 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4931 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4932 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4933 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4934 0, 0, 0, 0, 0, 0, 0, 0,
4935 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4936 0, 0, 0, 0, 0, 0, 0, "delete"
4939 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4940 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4942 static char *iso_lispy_function_keys
[] =
4944 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4945 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4946 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4947 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4948 "iso-lefttab", /* 0xfe20 */
4949 "iso-move-line-up", "iso-move-line-down",
4950 "iso-partial-line-up", "iso-partial-line-down",
4951 "iso-partial-space-left", "iso-partial-space-right",
4952 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4953 "iso-release-margin-left", "iso-release-margin-right",
4954 "iso-release-both-margins",
4955 "iso-fast-cursor-left", "iso-fast-cursor-right",
4956 "iso-fast-cursor-up", "iso-fast-cursor-down",
4957 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4958 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4961 #endif /* not HAVE_NTGUI */
4963 Lisp_Object Vlispy_mouse_stem
;
4965 static char *lispy_wheel_names
[] =
4967 "wheel-up", "wheel-down"
4970 /* drag-n-drop events are generated when a set of selected files are
4971 dragged from another application and dropped onto an Emacs window. */
4972 static char *lispy_drag_n_drop_names
[] =
4977 /* Scroll bar parts. */
4978 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4979 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4980 Lisp_Object Qtop
, Qratio
;
4982 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4983 Lisp_Object
*scroll_bar_parts
[] = {
4984 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4985 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4988 /* User signal events. */
4989 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4991 Lisp_Object
*lispy_user_signals
[] =
4993 &Qusr1_signal
, &Qusr2_signal
4997 /* A vector, indexed by button number, giving the down-going location
4998 of currently depressed buttons, both scroll bar and non-scroll bar.
5000 The elements have the form
5001 (BUTTON-NUMBER MODIFIER-MASK . REST)
5002 where REST is the cdr of a position as it would be reported in the event.
5004 The make_lispy_event function stores positions here to tell the
5005 difference between click and drag events, and to store the starting
5006 location to be included in drag events. */
5008 static Lisp_Object button_down_location
;
5010 /* Information about the most recent up-going button event: Which
5011 button, what location, and what time. */
5013 static int last_mouse_button
;
5014 static int last_mouse_x
;
5015 static int last_mouse_y
;
5016 static unsigned long button_down_time
;
5018 /* The maximum time between clicks to make a double-click, or Qnil to
5019 disable double-click detection, or Qt for no time limit. */
5021 Lisp_Object Vdouble_click_time
;
5023 /* Maximum number of pixels the mouse may be moved between clicks
5024 to make a double-click. */
5026 EMACS_INT double_click_fuzz
;
5028 /* The number of clicks in this multiple-click. */
5030 int double_click_count
;
5032 /* Return position of a mouse click or wheel event */
5035 make_lispy_position (f
, x
, y
, time
)
5041 enum window_part part
;
5042 Lisp_Object posn
= Qnil
;
5043 Lisp_Object extra_info
= Qnil
;
5046 /* Set `window' to the window under frame pixel coordinates (x,y) */
5048 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5049 &part
, &wx
, &wy
, 0);
5053 if (WINDOWP (window
))
5055 /* It's a click in window window at frame coordinates (x,y) */
5056 struct window
*w
= XWINDOW (window
);
5057 Lisp_Object string_info
= Qnil
;
5058 int textpos
= -1, rx
= -1, ry
= -1;
5059 int dx
= -1, dy
= -1;
5060 int width
= -1, height
= -1;
5061 Lisp_Object object
= Qnil
;
5063 /* Set event coordinates to window-relative coordinates
5064 for constructing the Lisp event below. */
5068 if (part
== ON_TEXT
)
5070 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5072 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5074 /* Mode line or header line. Look for a string under
5075 the mouse that may have a `local-map' property. */
5079 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5081 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5082 &object
, &dx
, &dy
, &width
, &height
);
5083 if (STRINGP (string
))
5084 string_info
= Fcons (string
, make_number (charpos
));
5085 if (w
== XWINDOW (selected_window
))
5088 textpos
= XMARKER (w
->pointm
)->charpos
;
5090 else if (part
== ON_VERTICAL_BORDER
)
5092 posn
= Qvertical_line
;
5097 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5102 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5104 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5105 &object
, &dx
, &dy
, &width
, &height
);
5106 if (STRINGP (string
))
5107 string_info
= Fcons (string
, make_number (charpos
));
5108 if (part
== ON_LEFT_MARGIN
)
5111 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5113 else if (part
== ON_LEFT_FRINGE
)
5115 posn
= Qleft_fringe
;
5118 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5120 : window_box_width (w
, LEFT_MARGIN_AREA
));
5123 else if (part
== ON_RIGHT_FRINGE
)
5125 posn
= Qright_fringe
;
5128 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5129 + window_box_width (w
, TEXT_AREA
)
5130 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5131 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5137 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5138 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5143 Lisp_Object string2
, object2
= Qnil
;
5144 struct display_pos p
;
5146 int width2
, height2
;
5147 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5148 &object2
, &dx2
, &dy2
,
5150 textpos
= CHARPOS (p
.pos
);
5151 if (rx
< 0) rx
= wx
;
5152 if (ry
< 0) ry
= wy
;
5153 if (dx
< 0) dx
= dx2
;
5154 if (dy
< 0) dy
= dy2
;
5155 if (width
< 0) width
= width2
;
5156 if (height
< 0) height
= height2
;
5160 posn
= make_number (textpos
);
5161 if (STRINGP (string2
))
5162 string_info
= Fcons (string2
,
5163 make_number (CHARPOS (p
.string_pos
)));
5169 #ifdef HAVE_WINDOW_SYSTEM
5170 if (IMAGEP (object
))
5172 Lisp_Object image_map
, hotspot
;
5173 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5175 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5177 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5178 posn
= XCAR (hotspot
);
5183 extra_info
= Fcons (object
,
5184 Fcons (Fcons (make_number (dx
),
5186 Fcons (Fcons (make_number (width
),
5187 make_number (height
)),
5191 extra_info
= Fcons (string_info
,
5192 Fcons (make_number (textpos
),
5193 Fcons (Fcons (make_number (rx
),
5199 XSETFRAME (window
, f
);
5204 XSETFASTINT (*x
, 0);
5205 XSETFASTINT (*y
, 0);
5208 return Fcons (window
,
5210 Fcons (Fcons (*x
, *y
),
5211 Fcons (make_number (time
),
5215 /* Given a struct input_event, build the lisp event which represents
5216 it. If EVENT is 0, build a mouse movement event from the mouse
5217 movement buffer, which should have a movement event in it.
5219 Note that events must be passed to this function in the order they
5220 are received; this function stores the location of button presses
5221 in order to build drag events when the button is released. */
5224 make_lispy_event (event
)
5225 struct input_event
*event
;
5229 switch (SWITCH_ENUM_CAST (event
->kind
))
5231 /* A simple keystroke. */
5232 case ASCII_KEYSTROKE_EVENT
:
5234 Lisp_Object lispy_c
;
5235 int c
= event
->code
& 0377;
5236 /* Turn ASCII characters into control characters
5238 if (event
->modifiers
& ctrl_modifier
)
5239 c
= make_ctrl_char (c
);
5241 /* Add in the other modifier bits. We took care of ctrl_modifier
5242 just above, and the shift key was taken care of by the X code,
5243 and applied to control characters by make_ctrl_char. */
5244 c
|= (event
->modifiers
5245 & (meta_modifier
| alt_modifier
5246 | hyper_modifier
| super_modifier
));
5247 /* Distinguish Shift-SPC from SPC. */
5248 if ((event
->code
& 0377) == 040
5249 && event
->modifiers
& shift_modifier
)
5250 c
|= shift_modifier
;
5251 button_down_time
= 0;
5252 XSETFASTINT (lispy_c
, c
);
5256 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5258 Lisp_Object lispy_c
;
5259 int c
= event
->code
;
5261 /* Add in the other modifier bits. We took care of ctrl_modifier
5262 just above, and the shift key was taken care of by the X code,
5263 and applied to control characters by make_ctrl_char. */
5264 c
|= (event
->modifiers
5265 & (meta_modifier
| alt_modifier
5266 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5267 /* What about the `shift' modifier ? */
5268 button_down_time
= 0;
5269 XSETFASTINT (lispy_c
, c
);
5273 /* A function key. The symbol may need to have modifier prefixes
5275 case NON_ASCII_KEYSTROKE_EVENT
:
5276 button_down_time
= 0;
5278 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5279 if (event
->code
== lispy_accent_codes
[i
])
5280 return modify_event_symbol (i
,
5282 Qfunction_key
, Qnil
,
5283 lispy_accent_keys
, &accent_key_syms
,
5284 (sizeof (lispy_accent_keys
)
5285 / sizeof (lispy_accent_keys
[0])));
5289 if (event
->code
>= 0x400 && event
->code
< 0x500)
5290 return modify_event_symbol (event
->code
- 0x400,
5291 event
->modifiers
& ~shift_modifier
,
5292 Qfunction_key
, Qnil
,
5293 lispy_kana_keys
, &func_key_syms
,
5294 (sizeof (lispy_kana_keys
)
5295 / sizeof (lispy_kana_keys
[0])));
5296 #endif /* XK_kana_A */
5299 #ifdef ISO_FUNCTION_KEY_OFFSET
5300 if (event
->code
< FUNCTION_KEY_OFFSET
5301 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5302 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5304 Qfunction_key
, Qnil
,
5305 iso_lispy_function_keys
, &func_key_syms
,
5306 (sizeof (iso_lispy_function_keys
)
5307 / sizeof (iso_lispy_function_keys
[0])));
5310 /* Handle system-specific or unknown keysyms. */
5311 if (event
->code
& (1 << 28)
5312 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5313 || (event
->code
- FUNCTION_KEY_OFFSET
5314 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5315 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5317 /* We need to use an alist rather than a vector as the cache
5318 since we can't make a vector long enuf. */
5319 if (NILP (current_kboard
->system_key_syms
))
5320 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5321 return modify_event_symbol (event
->code
,
5324 current_kboard
->Vsystem_key_alist
,
5325 0, ¤t_kboard
->system_key_syms
,
5329 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5331 Qfunction_key
, Qnil
,
5332 lispy_function_keys
, &func_key_syms
,
5333 (sizeof (lispy_function_keys
)
5334 / sizeof (lispy_function_keys
[0])));
5337 /* A mouse click. Figure out where it is, decide whether it's
5338 a press, click or drag, and build the appropriate structure. */
5339 case MOUSE_CLICK_EVENT
:
5340 #ifndef USE_TOOLKIT_SCROLL_BARS
5341 case SCROLL_BAR_CLICK_EVENT
:
5344 int button
= event
->code
;
5346 Lisp_Object position
;
5347 Lisp_Object
*start_pos_ptr
;
5348 Lisp_Object start_pos
;
5352 /* Build the position as appropriate for this mouse click. */
5353 if (event
->kind
== MOUSE_CLICK_EVENT
)
5355 struct frame
*f
= XFRAME (event
->frame_or_window
);
5356 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5360 /* Ignore mouse events that were made on frame that
5361 have been deleted. */
5362 if (! FRAME_LIVE_P (f
))
5365 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5366 /* EVENT->x and EVENT->y are frame-relative pixel
5367 coordinates at this place. Under old redisplay, COLUMN
5368 and ROW are set to frame relative glyph coordinates
5369 which are then used to determine whether this click is
5370 in a menu (non-toolkit version). */
5371 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5372 &column
, &row
, NULL
, 1);
5374 /* In the non-toolkit version, clicks on the menu bar
5375 are ordinary button events in the event buffer.
5376 Distinguish them, and invoke the menu.
5378 (In the toolkit version, the toolkit handles the menu bar
5379 and Emacs doesn't know about it until after the user
5380 makes a selection.) */
5381 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5382 && (event
->modifiers
& down_modifier
))
5384 Lisp_Object items
, item
;
5389 /* Activate the menu bar on the down event. If the
5390 up event comes in before the menu code can deal with it,
5392 if (! (event
->modifiers
& down_modifier
))
5396 /* Find the menu bar item under `column'. */
5398 items
= FRAME_MENU_BAR_ITEMS (f
);
5399 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5401 Lisp_Object pos
, string
;
5402 string
= AREF (items
, i
+ 1);
5403 pos
= AREF (items
, i
+ 3);
5406 if (column
>= XINT (pos
)
5407 && column
< XINT (pos
) + SCHARS (string
))
5409 item
= AREF (items
, i
);
5414 /* ELisp manual 2.4b says (x y) are window relative but
5415 code says they are frame-relative. */
5417 = Fcons (event
->frame_or_window
,
5419 Fcons (Fcons (event
->x
, event
->y
),
5420 Fcons (make_number (event
->timestamp
),
5423 return Fcons (item
, Fcons (position
, Qnil
));
5425 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5427 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5430 #ifndef USE_TOOLKIT_SCROLL_BARS
5433 /* It's a scrollbar click. */
5435 Lisp_Object portion_whole
;
5438 window
= event
->frame_or_window
;
5439 portion_whole
= Fcons (event
->x
, event
->y
);
5440 part
= *scroll_bar_parts
[(int) event
->part
];
5444 Fcons (Qvertical_scroll_bar
,
5445 Fcons (portion_whole
,
5446 Fcons (make_number (event
->timestamp
),
5447 Fcons (part
, Qnil
)))));
5449 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5451 if (button
>= ASIZE (button_down_location
))
5453 button_down_location
= larger_vector (button_down_location
,
5455 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5458 start_pos_ptr
= &AREF (button_down_location
, button
);
5459 start_pos
= *start_pos_ptr
;
5460 *start_pos_ptr
= Qnil
;
5463 /* On window-system frames, use the value of
5464 double-click-fuzz as is. On other frames, interpret it
5465 as a multiple of 1/8 characters. */
5469 if (WINDOWP (event
->frame_or_window
))
5470 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5471 else if (FRAMEP (event
->frame_or_window
))
5472 f
= XFRAME (event
->frame_or_window
);
5476 if (FRAME_WINDOW_P (f
))
5477 fuzz
= double_click_fuzz
;
5479 fuzz
= double_click_fuzz
/ 8;
5481 is_double
= (button
== last_mouse_button
5482 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5483 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5484 && button_down_time
!= 0
5485 && (EQ (Vdouble_click_time
, Qt
)
5486 || (INTEGERP (Vdouble_click_time
)
5487 && ((int)(event
->timestamp
- button_down_time
)
5488 < XINT (Vdouble_click_time
)))));
5491 last_mouse_button
= button
;
5492 last_mouse_x
= XINT (event
->x
);
5493 last_mouse_y
= XINT (event
->y
);
5495 /* If this is a button press, squirrel away the location, so
5496 we can decide later whether it was a click or a drag. */
5497 if (event
->modifiers
& down_modifier
)
5501 double_click_count
++;
5502 event
->modifiers
|= ((double_click_count
> 2)
5507 double_click_count
= 1;
5508 button_down_time
= event
->timestamp
;
5509 *start_pos_ptr
= Fcopy_alist (position
);
5512 /* Now we're releasing a button - check the co-ordinates to
5513 see if this was a click or a drag. */
5514 else if (event
->modifiers
& up_modifier
)
5516 /* If we did not see a down before this up, ignore the up.
5517 Probably this happened because the down event chose a
5518 menu item. It would be an annoyance to treat the
5519 release of the button that chose the menu item as a
5522 if (!CONSP (start_pos
))
5525 event
->modifiers
&= ~up_modifier
;
5526 #if 0 /* Formerly we treated an up with no down as a click event. */
5527 if (!CONSP (start_pos
))
5528 event
->modifiers
|= click_modifier
;
5533 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5535 /* The third element of every position
5536 should be the (x,y) pair. */
5537 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5539 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5541 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5542 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5545 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5546 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5547 /* Maybe the mouse has moved a lot, caused scrolling, and
5548 eventually ended up at the same screen position (but
5549 not buffer position) in which case it is a drag, not
5551 /* FIXME: OTOH if the buffer position has changed
5552 because of a timer or process filter rather than
5553 because of mouse movement, it should be considered as
5554 a click. But mouse-drag-region completely ignores
5555 this case and it hasn't caused any real problem, so
5556 it's probably OK to ignore it as well. */
5557 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5558 /* Mouse hasn't moved (much). */
5559 event
->modifiers
|= click_modifier
;
5562 button_down_time
= 0;
5563 event
->modifiers
|= drag_modifier
;
5566 /* Don't check is_double; treat this as multiple
5567 if the down-event was multiple. */
5568 if (double_click_count
> 1)
5569 event
->modifiers
|= ((double_click_count
> 2)
5575 /* Every mouse event should either have the down_modifier or
5576 the up_modifier set. */
5580 /* Get the symbol we should use for the mouse click. */
5583 head
= modify_event_symbol (button
,
5585 Qmouse_click
, Vlispy_mouse_stem
,
5588 XVECTOR (mouse_syms
)->size
);
5589 if (event
->modifiers
& drag_modifier
)
5594 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5597 Fcons (make_number (double_click_count
),
5608 Lisp_Object position
;
5611 /* Build the position as appropriate for this mouse click. */
5612 struct frame
*f
= XFRAME (event
->frame_or_window
);
5614 /* Ignore wheel events that were made on frame that have been
5616 if (! FRAME_LIVE_P (f
))
5619 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5622 /* Set double or triple modifiers to indicate the wheel speed. */
5624 /* On window-system frames, use the value of
5625 double-click-fuzz as is. On other frames, interpret it
5626 as a multiple of 1/8 characters. */
5631 if (WINDOWP (event
->frame_or_window
))
5632 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5633 else if (FRAMEP (event
->frame_or_window
))
5634 f
= XFRAME (event
->frame_or_window
);
5638 if (FRAME_WINDOW_P (f
))
5639 fuzz
= double_click_fuzz
;
5641 fuzz
= double_click_fuzz
/ 8;
5643 is_double
= (last_mouse_button
< 0
5644 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5645 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5646 && button_down_time
!= 0
5647 && (EQ (Vdouble_click_time
, Qt
)
5648 || (INTEGERP (Vdouble_click_time
)
5649 && ((int)(event
->timestamp
- button_down_time
)
5650 < XINT (Vdouble_click_time
)))));
5653 double_click_count
++;
5654 event
->modifiers
|= ((double_click_count
> 2)
5660 double_click_count
= 1;
5661 event
->modifiers
|= click_modifier
;
5664 button_down_time
= event
->timestamp
;
5665 /* Use a negative value to distinguish wheel from mouse button. */
5666 last_mouse_button
= -1;
5667 last_mouse_x
= XINT (event
->x
);
5668 last_mouse_y
= XINT (event
->y
);
5674 if (event
->modifiers
& up_modifier
)
5676 /* Emit a wheel-up event. */
5677 event
->modifiers
&= ~up_modifier
;
5680 else if (event
->modifiers
& down_modifier
)
5682 /* Emit a wheel-down event. */
5683 event
->modifiers
&= ~down_modifier
;
5687 /* Every wheel event should either have the down_modifier or
5688 the up_modifier set. */
5691 /* Get the symbol we should use for the wheel event. */
5692 head
= modify_event_symbol (symbol_num
,
5698 ASIZE (wheel_syms
));
5701 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5704 Fcons (make_number (double_click_count
),
5713 #ifdef USE_TOOLKIT_SCROLL_BARS
5715 /* We don't have down and up events if using toolkit scroll bars,
5716 so make this always a click event. Store in the `part' of
5717 the Lisp event a symbol which maps to the following actions:
5719 `above_handle' page up
5720 `below_handle' page down
5724 `bottom' bottom of buffer
5725 `handle' thumb has been dragged.
5726 `end-scroll' end of interaction with scroll bar
5728 The incoming input_event contains in its `part' member an
5729 index of type `enum scroll_bar_part' which we can use as an
5730 index in scroll_bar_parts to get the appropriate symbol. */
5732 case SCROLL_BAR_CLICK_EVENT
:
5734 Lisp_Object position
, head
, window
, portion_whole
, part
;
5736 window
= event
->frame_or_window
;
5737 portion_whole
= Fcons (event
->x
, event
->y
);
5738 part
= *scroll_bar_parts
[(int) event
->part
];
5742 Fcons (Qvertical_scroll_bar
,
5743 Fcons (portion_whole
,
5744 Fcons (make_number (event
->timestamp
),
5745 Fcons (part
, Qnil
)))));
5747 /* Always treat scroll bar events as clicks. */
5748 event
->modifiers
|= click_modifier
;
5749 event
->modifiers
&= ~up_modifier
;
5751 if (event
->code
>= ASIZE (mouse_syms
))
5752 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5754 /* Get the symbol we should use for the mouse click. */
5755 head
= modify_event_symbol (event
->code
,
5760 XVECTOR (mouse_syms
)->size
);
5761 return Fcons (head
, Fcons (position
, Qnil
));
5764 #endif /* USE_TOOLKIT_SCROLL_BARS */
5767 case W32_SCROLL_BAR_CLICK_EVENT
:
5769 int button
= event
->code
;
5771 Lisp_Object position
;
5772 Lisp_Object
*start_pos_ptr
;
5773 Lisp_Object start_pos
;
5777 Lisp_Object portion_whole
;
5780 window
= event
->frame_or_window
;
5781 portion_whole
= Fcons (event
->x
, event
->y
);
5782 part
= *scroll_bar_parts
[(int) event
->part
];
5786 Fcons (Qvertical_scroll_bar
,
5787 Fcons (portion_whole
,
5788 Fcons (make_number (event
->timestamp
),
5789 Fcons (part
, Qnil
)))));
5792 /* Always treat W32 scroll bar events as clicks. */
5793 event
->modifiers
|= click_modifier
;
5796 /* Get the symbol we should use for the mouse click. */
5799 head
= modify_event_symbol (button
,
5804 XVECTOR (mouse_syms
)->size
);
5810 #endif /* WINDOWSNT */
5812 case DRAG_N_DROP_EVENT
:
5815 Lisp_Object head
, position
;
5818 f
= XFRAME (event
->frame_or_window
);
5821 /* Ignore mouse events that were made on frames that
5822 have been deleted. */
5823 if (! FRAME_LIVE_P (f
))
5826 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5829 head
= modify_event_symbol (0, event
->modifiers
,
5831 lispy_drag_n_drop_names
,
5832 &drag_n_drop_syms
, 1);
5838 #endif /* HAVE_MOUSE */
5840 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5841 || defined (USE_GTK)
5842 case MENU_BAR_EVENT
:
5843 if (EQ (event
->arg
, event
->frame_or_window
))
5844 /* This is the prefix key. We translate this to
5845 `(menu_bar)' because the code in keyboard.c for menu
5846 events, which we use, relies on this. */
5847 return Fcons (Qmenu_bar
, Qnil
);
5851 case SELECT_WINDOW_EVENT
:
5852 /* Make an event (select-window (WINDOW)). */
5853 return Fcons (Qselect_window
,
5854 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5857 case TOOL_BAR_EVENT
:
5858 if (EQ (event
->arg
, event
->frame_or_window
))
5859 /* This is the prefix key. We translate this to
5860 `(tool_bar)' because the code in keyboard.c for tool bar
5861 events, which we use, relies on this. */
5862 return Fcons (Qtool_bar
, Qnil
);
5863 else if (SYMBOLP (event
->arg
))
5864 return apply_modifiers (event
->modifiers
, event
->arg
);
5867 case USER_SIGNAL_EVENT
:
5868 /* A user signal. */
5869 return *lispy_user_signals
[event
->code
];
5871 case SAVE_SESSION_EVENT
:
5872 return Qsave_session
;
5875 case MAC_APPLE_EVENT
:
5877 Lisp_Object spec
[2];
5881 return Fcons (Qmac_apple_event
,
5882 Fcons (Fvector (2, spec
),
5883 Fcons (mac_make_lispy_event_code (event
->code
),
5888 /* The 'kind' field of the event is something we don't recognize. */
5897 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5899 Lisp_Object bar_window
;
5900 enum scroll_bar_part part
;
5904 /* Is it a scroll bar movement? */
5905 if (frame
&& ! NILP (bar_window
))
5907 Lisp_Object part_sym
;
5909 part_sym
= *scroll_bar_parts
[(int) part
];
5910 return Fcons (Qscroll_bar_movement
,
5911 (Fcons (Fcons (bar_window
,
5912 Fcons (Qvertical_scroll_bar
,
5913 Fcons (Fcons (x
, y
),
5914 Fcons (make_number (time
),
5920 /* Or is it an ordinary mouse movement? */
5923 Lisp_Object position
;
5925 position
= make_lispy_position (frame
, &x
, &y
, time
);
5927 return Fcons (Qmouse_movement
,
5933 #endif /* HAVE_MOUSE */
5935 /* Construct a switch frame event. */
5937 make_lispy_switch_frame (frame
)
5940 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5943 /* Manipulating modifiers. */
5945 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5947 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5948 SYMBOL's name of the end of the modifiers; the string from this
5949 position is the unmodified symbol name.
5951 This doesn't use any caches. */
5954 parse_modifiers_uncached (symbol
, modifier_end
)
5962 CHECK_SYMBOL (symbol
);
5965 name
= SYMBOL_NAME (symbol
);
5967 for (i
= 0; i
+2 <= SBYTES (name
); )
5969 int this_mod_end
= 0;
5972 /* See if the name continues with a modifier word.
5973 Check that the word appears, but don't check what follows it.
5974 Set this_mod and this_mod_end to record what we find. */
5976 switch (SREF (name
, i
))
5978 #define SINGLE_LETTER_MOD(BIT) \
5979 (this_mod_end = i + 1, this_mod = BIT)
5982 SINGLE_LETTER_MOD (alt_modifier
);
5986 SINGLE_LETTER_MOD (ctrl_modifier
);
5990 SINGLE_LETTER_MOD (hyper_modifier
);
5994 SINGLE_LETTER_MOD (meta_modifier
);
5998 SINGLE_LETTER_MOD (shift_modifier
);
6002 SINGLE_LETTER_MOD (super_modifier
);
6005 #undef SINGLE_LETTER_MOD
6007 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6008 if (i + LEN + 1 <= SBYTES (name) \
6009 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6011 this_mod_end = i + LEN; \
6016 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6017 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6018 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6022 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6024 #undef MULTI_LETTER_MOD
6028 /* If we found no modifier, stop looking for them. */
6029 if (this_mod_end
== 0)
6032 /* Check there is a dash after the modifier, so that it
6033 really is a modifier. */
6034 if (this_mod_end
>= SBYTES (name
)
6035 || SREF (name
, this_mod_end
) != '-')
6038 /* This modifier is real; look for another. */
6039 modifiers
|= this_mod
;
6040 i
= this_mod_end
+ 1;
6043 /* Should we include the `click' modifier? */
6044 if (! (modifiers
& (down_modifier
| drag_modifier
6045 | double_modifier
| triple_modifier
))
6046 && i
+ 7 == SBYTES (name
)
6047 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6048 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6049 modifiers
|= click_modifier
;
6057 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6058 prepended to the string BASE[0..BASE_LEN-1].
6059 This doesn't use any caches. */
6061 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6064 int base_len
, base_len_byte
;
6066 /* Since BASE could contain nulls, we can't use intern here; we have
6067 to use Fintern, which expects a genuine Lisp_String, and keeps a
6070 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6076 /* Only the event queue may use the `up' modifier; it should always
6077 be turned into a click or drag event before presented to lisp code. */
6078 if (modifiers
& up_modifier
)
6081 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6082 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6083 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6084 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6085 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6086 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6087 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6088 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6089 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6090 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6091 /* The click modifier is denoted by the absence of other modifiers. */
6095 mod_len
= p
- new_mods
;
6099 Lisp_Object new_name
;
6101 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6102 mod_len
+ base_len_byte
);
6103 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6104 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6106 return Fintern (new_name
, Qnil
);
6111 static char *modifier_names
[] =
6113 "up", "down", "drag", "click", "double", "triple", 0, 0,
6114 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6115 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6117 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6119 static Lisp_Object modifier_symbols
;
6121 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6123 lispy_modifier_list (modifiers
)
6126 Lisp_Object modifier_list
;
6129 modifier_list
= Qnil
;
6130 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6131 if (modifiers
& (1<<i
))
6132 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6135 return modifier_list
;
6139 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6140 where UNMODIFIED is the unmodified form of SYMBOL,
6141 MASK is the set of modifiers present in SYMBOL's name.
6142 This is similar to parse_modifiers_uncached, but uses the cache in
6143 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6144 Qevent_symbol_elements property. */
6147 parse_modifiers (symbol
)
6150 Lisp_Object elements
;
6152 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6153 if (CONSP (elements
))
6158 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6159 Lisp_Object unmodified
;
6162 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6163 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6166 if (modifiers
& ~INTMASK
)
6168 XSETFASTINT (mask
, modifiers
);
6169 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6171 /* Cache the parsing results on SYMBOL. */
6172 Fput (symbol
, Qevent_symbol_element_mask
,
6174 Fput (symbol
, Qevent_symbol_elements
,
6175 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6177 /* Since we know that SYMBOL is modifiers applied to unmodified,
6178 it would be nice to put that in unmodified's cache.
6179 But we can't, since we're not sure that parse_modifiers is
6186 /* Apply the modifiers MODIFIERS to the symbol BASE.
6187 BASE must be unmodified.
6189 This is like apply_modifiers_uncached, but uses BASE's
6190 Qmodifier_cache property, if present. It also builds
6191 Qevent_symbol_elements properties, since it has that info anyway.
6193 apply_modifiers copies the value of BASE's Qevent_kind property to
6194 the modified symbol. */
6196 apply_modifiers (modifiers
, base
)
6200 Lisp_Object cache
, index
, entry
, new_symbol
;
6202 /* Mask out upper bits. We don't know where this value's been. */
6203 modifiers
&= INTMASK
;
6205 /* The click modifier never figures into cache indices. */
6206 cache
= Fget (base
, Qmodifier_cache
);
6207 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6208 entry
= assq_no_quit (index
, cache
);
6211 new_symbol
= XCDR (entry
);
6214 /* We have to create the symbol ourselves. */
6215 new_symbol
= apply_modifiers_uncached (modifiers
,
6216 SDATA (SYMBOL_NAME (base
)),
6217 SCHARS (SYMBOL_NAME (base
)),
6218 SBYTES (SYMBOL_NAME (base
)));
6220 /* Add the new symbol to the base's cache. */
6221 entry
= Fcons (index
, new_symbol
);
6222 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6224 /* We have the parsing info now for free, so we could add it to
6226 XSETFASTINT (index, modifiers);
6227 Fput (new_symbol, Qevent_symbol_element_mask,
6228 Fcons (base, Fcons (index, Qnil)));
6229 Fput (new_symbol, Qevent_symbol_elements,
6230 Fcons (base, lispy_modifier_list (modifiers)));
6231 Sadly, this is only correct if `base' is indeed a base event,
6232 which is not necessarily the case. -stef */
6235 /* Make sure this symbol is of the same kind as BASE.
6237 You'd think we could just set this once and for all when we
6238 intern the symbol above, but reorder_modifiers may call us when
6239 BASE's property isn't set right; we can't assume that just
6240 because it has a Qmodifier_cache property it must have its
6241 Qevent_kind set right as well. */
6242 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6246 kind
= Fget (base
, Qevent_kind
);
6248 Fput (new_symbol
, Qevent_kind
, kind
);
6255 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6256 return a symbol with the modifiers placed in the canonical order.
6257 Canonical order is alphabetical, except for down and drag, which
6258 always come last. The 'click' modifier is never written out.
6260 Fdefine_key calls this to make sure that (for example) C-M-foo
6261 and M-C-foo end up being equivalent in the keymap. */
6264 reorder_modifiers (symbol
)
6267 /* It's hopefully okay to write the code this way, since everything
6268 will soon be in caches, and no consing will be done at all. */
6271 parsed
= parse_modifiers (symbol
);
6272 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6277 /* For handling events, we often want to produce a symbol whose name
6278 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6279 to some base, like the name of a function key or mouse button.
6280 modify_event_symbol produces symbols of this sort.
6282 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6283 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6286 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6287 into symbol names, or a string specifying a name stem used to
6288 construct a symbol name or the form `STEM-N', where N is the decimal
6289 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6290 non-nil; otherwise NAME_TABLE is used.
6292 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6293 persist between calls to modify_event_symbol that it can use to
6294 store a cache of the symbols it's generated for this NAME_TABLE
6295 before. The object stored there may be a vector or an alist.
6297 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6299 MODIFIERS is a set of modifier bits (as given in struct input_events)
6300 whose prefixes should be applied to the symbol name.
6302 SYMBOL_KIND is the value to be placed in the event_kind property of
6303 the returned symbol.
6305 The symbols we create are supposed to have an
6306 `event-symbol-elements' property, which lists the modifiers present
6307 in the symbol's name. */
6310 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6311 name_table
, symbol_table
, table_size
)
6314 Lisp_Object symbol_kind
;
6315 Lisp_Object name_alist_or_stem
;
6317 Lisp_Object
*symbol_table
;
6318 unsigned int table_size
;
6321 Lisp_Object symbol_int
;
6323 /* Get rid of the "vendor-specific" bit here. */
6324 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6326 /* Is this a request for a valid symbol? */
6327 if (symbol_num
< 0 || symbol_num
>= table_size
)
6330 if (CONSP (*symbol_table
))
6331 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6333 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6334 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6335 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6336 we've never used that symbol before. */
6339 if (! VECTORP (*symbol_table
)
6340 || XVECTOR (*symbol_table
)->size
!= table_size
)
6344 XSETFASTINT (size
, table_size
);
6345 *symbol_table
= Fmake_vector (size
, Qnil
);
6348 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6351 /* Have we already used this symbol before? */
6354 /* No; let's create it. */
6355 if (CONSP (name_alist_or_stem
))
6356 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6357 else if (STRINGP (name_alist_or_stem
))
6359 int len
= SBYTES (name_alist_or_stem
);
6360 char *buf
= (char *) alloca (len
+ 50);
6361 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6362 (long) XINT (symbol_int
) + 1);
6363 value
= intern (buf
);
6365 else if (name_table
!= 0 && name_table
[symbol_num
])
6366 value
= intern (name_table
[symbol_num
]);
6368 #ifdef HAVE_WINDOW_SYSTEM
6371 char *name
= x_get_keysym_name (symbol_num
);
6373 value
= intern (name
);
6380 sprintf (buf
, "key-%d", symbol_num
);
6381 value
= intern (buf
);
6384 if (CONSP (*symbol_table
))
6385 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6387 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6389 /* Fill in the cache entries for this symbol; this also
6390 builds the Qevent_symbol_elements property, which the user
6392 apply_modifiers (modifiers
& click_modifier
, value
);
6393 Fput (value
, Qevent_kind
, symbol_kind
);
6396 /* Apply modifiers to that symbol. */
6397 return apply_modifiers (modifiers
, value
);
6400 /* Convert a list that represents an event type,
6401 such as (ctrl meta backspace), into the usual representation of that
6402 event type as a number or a symbol. */
6404 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6405 doc
: /* Convert the event description list EVENT-DESC to an event type.
6406 EVENT-DESC should contain one base event type (a character or symbol)
6407 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6408 drag, down, double or triple). The base must be last.
6409 The return value is an event type (a character or symbol) which
6410 has the same base event type and all the specified modifiers. */)
6412 Lisp_Object event_desc
;
6420 while (CONSP (rest
))
6428 /* Given a symbol, see if it is a modifier name. */
6429 if (SYMBOLP (elt
) && CONSP (rest
))
6430 this = parse_solitary_modifier (elt
);
6434 else if (!NILP (base
))
6435 error ("Two bases given in one event");
6441 /* Let the symbol A refer to the character A. */
6442 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6443 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6445 if (INTEGERP (base
))
6447 /* Turn (shift a) into A. */
6448 if ((modifiers
& shift_modifier
) != 0
6449 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6451 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6452 modifiers
&= ~shift_modifier
;
6455 /* Turn (control a) into C-a. */
6456 if (modifiers
& ctrl_modifier
)
6457 return make_number ((modifiers
& ~ctrl_modifier
)
6458 | make_ctrl_char (XINT (base
)));
6460 return make_number (modifiers
| XINT (base
));
6462 else if (SYMBOLP (base
))
6463 return apply_modifiers (modifiers
, base
);
6466 error ("Invalid base event");
6471 /* Try to recognize SYMBOL as a modifier name.
6472 Return the modifier flag bit, or 0 if not recognized. */
6475 parse_solitary_modifier (symbol
)
6478 Lisp_Object name
= SYMBOL_NAME (symbol
);
6480 switch (SREF (name
, 0))
6482 #define SINGLE_LETTER_MOD(BIT) \
6483 if (SBYTES (name) == 1) \
6486 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6487 if (LEN == SBYTES (name) \
6488 && ! strncmp (SDATA (name), NAME, LEN)) \
6492 SINGLE_LETTER_MOD (alt_modifier
);
6496 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6500 SINGLE_LETTER_MOD (ctrl_modifier
);
6504 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6505 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6509 SINGLE_LETTER_MOD (hyper_modifier
);
6513 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6517 SINGLE_LETTER_MOD (meta_modifier
);
6521 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6525 SINGLE_LETTER_MOD (shift_modifier
);
6529 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6530 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6531 SINGLE_LETTER_MOD (super_modifier
);
6535 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6536 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6537 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6541 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6544 #undef SINGLE_LETTER_MOD
6545 #undef MULTI_LETTER_MOD
6551 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6552 Such a list is not valid as an event,
6553 but it can be a Lucid-style event type list. */
6556 lucid_event_type_list_p (object
)
6561 if (! CONSP (object
))
6564 if (EQ (XCAR (object
), Qhelp_echo
)
6565 || EQ (XCAR (object
), Qvertical_line
)
6566 || EQ (XCAR (object
), Qmode_line
)
6567 || EQ (XCAR (object
), Qheader_line
))
6570 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6574 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6581 /* Store into *addr a value nonzero if terminal input chars are available.
6582 Serves the purpose of ioctl (0, FIONREAD, addr)
6583 but works even if FIONREAD does not exist.
6584 (In fact, this may actually read some input.)
6586 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6587 timer events that are ripe.
6588 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6589 events (FOCUS_IN_EVENT).
6590 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6591 movements and toolkit scroll bar thumb drags. */
6594 get_input_pending (addr
, flags
)
6598 /* First of all, have we already counted some input? */
6599 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6601 /* If input is being read as it arrives, and we have none, there is none. */
6602 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6605 /* Try to read some input and see how much we get. */
6607 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6610 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6613 gobble_input (expected
)
6618 if (interrupt_input
)
6621 mask
= sigblock (sigmask (SIGIO
));
6622 read_avail_input (expected
);
6626 #ifdef POLL_FOR_INPUT
6627 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6630 mask
= sigblock (sigmask (SIGALRM
));
6631 read_avail_input (expected
);
6637 read_avail_input (expected
);
6641 /* Put a BUFFER_SWITCH_EVENT in the buffer
6642 so that read_key_sequence will notice the new current buffer. */
6645 record_asynch_buffer_change ()
6647 struct input_event event
;
6651 event
.kind
= BUFFER_SWITCH_EVENT
;
6652 event
.frame_or_window
= Qnil
;
6656 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6657 The purpose of the event is to make read_key_sequence look up the
6658 keymaps again. If we aren't in read_key_sequence, we don't need one,
6659 and the event could cause trouble by messing up (input-pending-p). */
6660 tem
= Fwaiting_for_user_input_p ();
6664 /* We never need these events if we have no asynchronous subprocesses. */
6668 /* Make sure no interrupt happens while storing the event. */
6670 if (interrupt_input
)
6673 mask
= sigblock (sigmask (SIGIO
));
6674 kbd_buffer_store_event (&event
);
6681 kbd_buffer_store_event (&event
);
6688 /* Read any terminal input already buffered up by the system
6689 into the kbd_buffer, but do not wait.
6691 EXPECTED should be nonzero if the caller knows there is some input.
6693 Except on VMS, all input is read by this function.
6694 If interrupt_input is nonzero, this function MUST be called
6695 only when SIGIO is blocked.
6697 Returns the number of keyboard chars read, or -1 meaning
6698 this is a bad time to try to read input. */
6701 read_avail_input (expected
)
6707 if (read_socket_hook
)
6710 struct input_event hold_quit
;
6712 EVENT_INIT (hold_quit
);
6713 hold_quit
.kind
= NO_EVENT
;
6715 /* No need for FIONREAD or fcntl; just say don't wait. */
6716 while (nr
= (*read_socket_hook
) (input_fd
, expected
, &hold_quit
), nr
> 0)
6721 if (hold_quit
.kind
!= NO_EVENT
)
6722 kbd_buffer_store_event (&hold_quit
);
6726 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6727 the kbd_buffer can really hold. That may prevent loss
6728 of characters on some systems when input is stuffed at us. */
6729 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6732 /* Determine how many characters we should *try* to read. */
6735 #else /* not WINDOWSNT */
6737 n_to_read
= dos_keysns ();
6740 #else /* not MSDOS */
6742 /* Find out how much input is available. */
6743 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6744 /* Formerly simply reported no input, but that sometimes led to
6745 a failure of Emacs to terminate.
6746 SIGHUP seems appropriate if we can't reach the terminal. */
6747 /* ??? Is it really right to send the signal just to this process
6748 rather than to the whole process group?
6749 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6751 if (! noninteractive
)
6752 kill (getpid (), SIGHUP
);
6758 if (n_to_read
> sizeof cbuf
)
6759 n_to_read
= sizeof cbuf
;
6760 #else /* no FIONREAD */
6761 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6762 /* Read some input if available, but don't wait. */
6763 n_to_read
= sizeof cbuf
;
6764 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6769 #endif /* not MSDOS */
6770 #endif /* not WINDOWSNT */
6772 /* Now read; for one reason or another, this will not block.
6773 NREAD is set to the number of chars read. */
6777 cbuf
[0] = dos_keyread ();
6780 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6782 /* POSIX infers that processes which are not in the session leader's
6783 process group won't get SIGHUP's at logout time. BSDI adheres to
6784 this part standard and returns -1 from read (0) with errno==EIO
6785 when the control tty is taken away.
6786 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6787 if (nread
== -1 && errno
== EIO
)
6789 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6790 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6791 This looks incorrect, but it isn't, because _BSD causes
6792 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6793 and that causes a value other than 0 when there is no input. */
6799 /* We used to retry the read if it was interrupted.
6800 But this does the wrong thing when O_NDELAY causes
6801 an EAGAIN error. Does anybody know of a situation
6802 where a retry is actually needed? */
6804 nread
< 0 && (errno
== EAGAIN
6818 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6819 fcntl (input_fd
, F_SETFL
, 0);
6820 #endif /* USG or DGUX or CYGWIN */
6821 #endif /* no FIONREAD */
6822 for (i
= 0; i
< nread
; i
++)
6824 struct input_event buf
;
6826 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6828 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6829 buf
.modifiers
= meta_modifier
;
6834 buf
.frame_or_window
= selected_frame
;
6837 kbd_buffer_store_event (&buf
);
6838 /* Don't look at input that follows a C-g too closely.
6839 This reduces lossage due to autorepeat on C-g. */
6840 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6841 && buf
.code
== quit_char
)
6848 #endif /* not VMS */
6851 handle_async_input ()
6854 extern int select_alarmed
;
6857 interrupt_input_pending
= 0;
6862 nread
= read_avail_input (1);
6863 /* -1 means it's not ok to read the input now.
6864 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6865 0 means there was no keyboard input available. */
6870 select_alarmed
= 1; /* Force the select emulator back to life */
6875 #ifdef SIGIO /* for entire page */
6876 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6879 input_available_signal (signo
)
6882 /* Must preserve main program's value of errno. */
6883 int old_errno
= errno
;
6884 #if defined (USG) && !defined (POSIX_SIGNALS)
6885 /* USG systems forget handlers when they are used;
6886 must reestablish each time */
6887 signal (signo
, input_available_signal
);
6895 interrupt_input_pending
= 1;
6897 SIGNAL_THREAD_CHECK (signo
);
6900 if (input_available_clear_time
)
6901 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6904 handle_async_input ();
6914 /* Send ourselves a SIGIO.
6916 This function exists so that the UNBLOCK_INPUT macro in
6917 blockinput.h can have some way to take care of input we put off
6918 dealing with, without assuming that every file which uses
6919 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6921 reinvoke_input_signal ()
6924 handle_async_input ();
6930 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6931 static Lisp_Object menu_bar_one_keymap_changed_items
;
6933 /* These variables hold the vector under construction within
6934 menu_bar_items and its subroutines, and the current index
6935 for storing into that vector. */
6936 static Lisp_Object menu_bar_items_vector
;
6937 static int menu_bar_items_index
;
6939 /* Return a vector of menu items for a menu bar, appropriate
6940 to the current buffer. Each item has three elements in the vector:
6943 OLD is an old vector we can optionally reuse, or nil. */
6946 menu_bar_items (old
)
6949 /* The number of keymaps we're scanning right now, and the number of
6950 keymaps we have allocated space for. */
6953 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6954 in the current keymaps, or nil where it is not a prefix. */
6957 Lisp_Object def
, tail
;
6966 /* In order to build the menus, we need to call the keymap
6967 accessors. They all call QUIT. But this function is called
6968 during redisplay, during which a quit is fatal. So inhibit
6969 quitting while building the menus.
6970 We do this instead of specbind because (1) errors will clear it anyway
6971 and (2) this avoids risk of specpdl overflow. */
6972 oquit
= Vinhibit_quit
;
6976 menu_bar_items_vector
= old
;
6978 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6979 menu_bar_items_index
= 0;
6981 /* Build our list of keymaps.
6982 If we recognize a function key and replace its escape sequence in
6983 keybuf with its symbol, or if the sequence starts with a mouse
6984 click and we need to switch buffers, we jump back here to rebuild
6985 the initial keymaps from the current buffer. */
6989 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6990 if (!NILP (Voverriding_local_map_menu_flag
))
6992 /* Yes, use them (if non-nil) as well as the global map. */
6993 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6995 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6996 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6997 if (!NILP (Voverriding_local_map
))
6998 maps
[nmaps
++] = Voverriding_local_map
;
7002 /* No, so use major and minor mode keymaps and keymap property.
7003 Note that menu-bar bindings in the local-map and keymap
7004 properties may not work reliable, as they are only
7005 recognized when the menu-bar (or mode-line) is updated,
7006 which does not normally happen after every command. */
7009 nminor
= current_minor_maps (NULL
, &tmaps
);
7010 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7012 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7013 maps
[nmaps
++] = tem
;
7014 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7016 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7018 maps
[nmaps
++] = current_global_map
;
7021 /* Look up in each map the dummy prefix key `menu-bar'. */
7025 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7026 if (!NILP (maps
[mapno
]))
7028 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7032 menu_bar_one_keymap_changed_items
= Qnil
;
7033 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7037 /* Move to the end those items that should be at the end. */
7039 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7042 int end
= menu_bar_items_index
;
7044 for (i
= 0; i
< end
; i
+= 4)
7045 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7047 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7048 /* Move the item at index I to the end,
7049 shifting all the others forward. */
7050 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7051 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7052 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7053 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7055 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7056 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7057 (end
- i
- 4) * sizeof (Lisp_Object
));
7058 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7059 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7060 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7061 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7066 /* Add nil, nil, nil, nil at the end. */
7067 i
= menu_bar_items_index
;
7068 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7071 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7072 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7073 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7074 menu_bar_items_vector
= tem
;
7076 /* Add this item. */
7077 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7078 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7079 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7080 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7081 menu_bar_items_index
= i
;
7083 Vinhibit_quit
= oquit
;
7084 return menu_bar_items_vector
;
7087 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7088 If there's already an item for KEY, add this DEF to it. */
7090 Lisp_Object item_properties
;
7093 menu_bar_item (key
, item
, dummy1
, dummy2
)
7094 Lisp_Object key
, item
, dummy1
;
7097 struct gcpro gcpro1
;
7101 if (EQ (item
, Qundefined
))
7103 /* If a map has an explicit `undefined' as definition,
7104 discard any previously made menu bar item. */
7106 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7107 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7109 if (menu_bar_items_index
> i
+ 4)
7110 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7111 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7112 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7113 menu_bar_items_index
-= 4;
7117 /* If this keymap has already contributed to this KEY,
7118 don't contribute to it a second time. */
7119 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7120 if (!NILP (tem
) || NILP (item
))
7123 menu_bar_one_keymap_changed_items
7124 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7126 /* We add to menu_bar_one_keymap_changed_items before doing the
7127 parse_menu_item, so that if it turns out it wasn't a menu item,
7128 it still correctly hides any further menu item. */
7130 i
= parse_menu_item (item
, 0, 1);
7135 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7137 /* Find any existing item for this KEY. */
7138 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7139 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7142 /* If we did not find this KEY, add it at the end. */
7143 if (i
== menu_bar_items_index
)
7145 /* If vector is too small, get a bigger one. */
7146 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7149 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7150 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7151 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7152 menu_bar_items_vector
= tem
;
7155 /* Add this item. */
7156 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7157 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7158 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7159 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7160 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7161 menu_bar_items_index
= i
;
7163 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7167 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7168 /* If the new and the old items are not both keymaps,
7169 the lookup will only find `item'. */
7170 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7171 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7175 /* This is used as the handler when calling menu_item_eval_property. */
7177 menu_item_eval_property_1 (arg
)
7180 /* If we got a quit from within the menu computation,
7181 quit all the way out of it. This takes care of C-] in the debugger. */
7182 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7183 Fsignal (Qquit
, Qnil
);
7188 /* Evaluate an expression and return the result (or nil if something
7189 went wrong). Used to evaluate dynamic parts of menu items. */
7191 menu_item_eval_property (sexpr
)
7194 int count
= SPECPDL_INDEX ();
7196 specbind (Qinhibit_redisplay
, Qt
);
7197 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7198 menu_item_eval_property_1
);
7199 return unbind_to (count
, val
);
7202 /* This function parses a menu item and leaves the result in the
7203 vector item_properties.
7204 ITEM is a key binding, a possible menu item.
7205 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7206 evaluate dynamic expressions in the menu item.
7207 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7209 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7210 parse_menu_item returns true if the item is a menu item and false
7214 parse_menu_item (item
, notreal
, inmenubar
)
7216 int notreal
, inmenubar
;
7218 Lisp_Object def
, tem
, item_string
, start
;
7219 Lisp_Object cachelist
;
7221 Lisp_Object keyhint
;
7232 /* Create item_properties vector if necessary. */
7233 if (NILP (item_properties
))
7235 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7237 /* Initialize optional entries. */
7238 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7239 AREF (item_properties
, i
) = Qnil
;
7240 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7242 /* Save the item here to protect it from GC. */
7243 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7245 item_string
= XCAR (item
);
7249 if (STRINGP (item_string
))
7251 /* Old format menu item. */
7252 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7254 /* Maybe help string. */
7255 if (CONSP (item
) && STRINGP (XCAR (item
)))
7257 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7262 /* Maybe key binding cache. */
7263 if (CONSP (item
) && CONSP (XCAR (item
))
7264 && (NILP (XCAR (XCAR (item
)))
7265 || VECTORP (XCAR (XCAR (item
)))))
7267 cachelist
= XCAR (item
);
7271 /* This is the real definition--the function to run. */
7272 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7274 /* Get enable property, if any. */
7277 tem
= Fget (item
, Qmenu_enable
);
7278 if (!NILP (Venable_disabled_menus_and_buttons
))
7279 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7280 else if (!NILP (tem
))
7281 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7284 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7286 /* New format menu item. */
7287 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7288 start
= XCDR (item
);
7291 /* We have a real binding. */
7292 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7294 item
= XCDR (start
);
7295 /* Is there a cache list with key equivalences. */
7296 if (CONSP (item
) && CONSP (XCAR (item
)))
7298 cachelist
= XCAR (item
);
7302 /* Parse properties. */
7303 while (CONSP (item
) && CONSP (XCDR (item
)))
7308 if (EQ (tem
, QCenable
))
7310 if (!NILP (Venable_disabled_menus_and_buttons
))
7311 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7313 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7315 else if (EQ (tem
, QCvisible
) && !notreal
)
7317 /* If got a visible property and that evaluates to nil
7318 then ignore this item. */
7319 tem
= menu_item_eval_property (XCAR (item
));
7323 else if (EQ (tem
, QChelp
))
7324 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7325 else if (EQ (tem
, QCfilter
))
7327 else if (EQ (tem
, QCkey_sequence
))
7330 if (NILP (cachelist
)
7331 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7332 /* Be GC protected. Set keyhint to item instead of tem. */
7335 else if (EQ (tem
, QCkeys
))
7338 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7339 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7341 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7346 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7348 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7350 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7357 else if (inmenubar
|| !NILP (start
))
7361 return 0; /* not a menu item */
7363 /* If item string is not a string, evaluate it to get string.
7364 If we don't get a string, skip this item. */
7365 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7366 if (!(STRINGP (item_string
) || notreal
))
7368 item_string
= menu_item_eval_property (item_string
);
7369 if (!STRINGP (item_string
))
7371 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7374 /* If got a filter apply it on definition. */
7375 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7378 def
= menu_item_eval_property (list2 (XCAR (filter
),
7379 list2 (Qquote
, def
)));
7381 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7384 /* Enable or disable selection of item. */
7385 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7391 tem
= menu_item_eval_property (tem
);
7392 if (inmenubar
&& NILP (tem
))
7393 return 0; /* Ignore disabled items in menu bar. */
7394 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7397 /* If we got no definition, this item is just unselectable text which
7398 is OK in a submenu but not in the menubar. */
7400 return (inmenubar
? 0 : 1);
7402 /* See if this is a separate pane or a submenu. */
7403 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7404 tem
= get_keymap (def
, 0, 1);
7405 /* For a subkeymap, just record its details and exit. */
7408 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7409 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7413 /* At the top level in the menu bar, do likewise for commands also.
7414 The menu bar does not display equivalent key bindings anyway.
7415 ITEM_PROPERTY_DEF is already set up properly. */
7419 /* This is a command. See if there is an equivalent key binding. */
7420 if (NILP (cachelist
))
7422 /* We have to create a cachelist. */
7423 CHECK_IMPURE (start
);
7424 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7425 cachelist
= XCAR (XCDR (start
));
7427 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7428 if (!NILP (keyhint
))
7430 XSETCAR (cachelist
, XCAR (keyhint
));
7433 else if (STRINGP (tem
))
7435 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7436 XSETCAR (cachelist
, Qt
);
7440 tem
= XCAR (cachelist
);
7447 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7449 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7452 def
= XCAR (prefix
);
7453 prefix
= XCDR (prefix
);
7456 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7458 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7460 if (newcache
/* Always check first time. */
7461 /* Should we check everything when precomputing key
7463 /* If something had no key binding before, don't recheck it
7464 because that is too slow--except if we have a list of
7465 rebound commands in Vdefine_key_rebound_commands, do
7466 recheck any command that appears in that list. */
7467 || (CONSP (Vdefine_key_rebound_commands
)
7468 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7471 /* We had a saved key. Is it still bound to the command? */
7474 /* If the command is an alias for another
7475 (such as lmenu.el set it up), check if the
7476 original command matches the cached command. */
7477 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7478 chkcache
= 1; /* Need to recompute key binding. */
7482 /* Recompute equivalent key binding. If the command is an alias
7483 for another (such as lmenu.el set it up), see if the original
7484 command name has equivalent keys. Otherwise look up the
7485 specified command itself. We don't try both, because that
7486 makes lmenu menus slow. */
7488 && SYMBOLP (XSYMBOL (def
)->function
)
7489 && ! NILP (Fget (def
, Qmenu_alias
)))
7490 def
= XSYMBOL (def
)->function
;
7491 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7492 XSETCAR (cachelist
, tem
);
7495 XSETCDR (cachelist
, Qnil
);
7499 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7501 tem
= XCAR (cachelist
);
7505 newcache
= chkcache
;
7508 tem
= Fkey_description (tem
, Qnil
);
7511 if (STRINGP (XCAR (prefix
)))
7512 tem
= concat2 (XCAR (prefix
), tem
);
7513 if (STRINGP (XCDR (prefix
)))
7514 tem
= concat2 (tem
, XCDR (prefix
));
7516 XSETCDR (cachelist
, tem
);
7520 tem
= XCDR (cachelist
);
7521 if (newcache
&& !NILP (tem
))
7523 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7524 XSETCDR (cachelist
, tem
);
7527 /* If we only want to precompute equivalent key bindings, stop here. */
7531 /* If we have an equivalent key binding, use that. */
7532 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7534 /* Include this when menu help is implemented.
7535 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7536 if (!(NILP (tem) || STRINGP (tem)))
7538 tem = menu_item_eval_property (tem);
7541 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7545 /* Handle radio buttons or toggle boxes. */
7546 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7548 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7549 = menu_item_eval_property (tem
);
7556 /***********************************************************************
7558 ***********************************************************************/
7560 /* A vector holding tool bar items while they are parsed in function
7561 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7564 static Lisp_Object tool_bar_items_vector
;
7566 /* A vector holding the result of parse_tool_bar_item. Layout is like
7567 the one for a single item in tool_bar_items_vector. */
7569 static Lisp_Object tool_bar_item_properties
;
7571 /* Next free index in tool_bar_items_vector. */
7573 static int ntool_bar_items
;
7575 /* The symbols `tool-bar', and `:image'. */
7577 extern Lisp_Object Qtool_bar
;
7578 Lisp_Object QCimage
;
7580 /* Function prototypes. */
7582 static void init_tool_bar_items
P_ ((Lisp_Object
));
7583 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7584 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7585 static void append_tool_bar_item
P_ ((void));
7588 /* Return a vector of tool bar items for keymaps currently in effect.
7589 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7590 tool bar items found. */
7593 tool_bar_items (reuse
, nitems
)
7604 /* In order to build the menus, we need to call the keymap
7605 accessors. They all call QUIT. But this function is called
7606 during redisplay, during which a quit is fatal. So inhibit
7607 quitting while building the menus. We do this instead of
7608 specbind because (1) errors will clear it anyway and (2) this
7609 avoids risk of specpdl overflow. */
7610 oquit
= Vinhibit_quit
;
7613 /* Initialize tool_bar_items_vector and protect it from GC. */
7614 init_tool_bar_items (reuse
);
7616 /* Build list of keymaps in maps. Set nmaps to the number of maps
7619 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7620 if (!NILP (Voverriding_local_map_menu_flag
))
7622 /* Yes, use them (if non-nil) as well as the global map. */
7623 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7625 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7626 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7627 if (!NILP (Voverriding_local_map
))
7628 maps
[nmaps
++] = Voverriding_local_map
;
7632 /* No, so use major and minor mode keymaps and keymap property.
7633 Note that tool-bar bindings in the local-map and keymap
7634 properties may not work reliable, as they are only
7635 recognized when the tool-bar (or mode-line) is updated,
7636 which does not normally happen after every command. */
7639 nminor
= current_minor_maps (NULL
, &tmaps
);
7640 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7642 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7643 maps
[nmaps
++] = tem
;
7644 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7646 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7649 /* Add global keymap at the end. */
7650 maps
[nmaps
++] = current_global_map
;
7652 /* Process maps in reverse order and look up in each map the prefix
7654 for (i
= nmaps
- 1; i
>= 0; --i
)
7655 if (!NILP (maps
[i
]))
7659 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7664 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7665 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7667 Lisp_Object keydef
= XCAR (tail
);
7669 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7674 Vinhibit_quit
= oquit
;
7675 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7676 return tool_bar_items_vector
;
7680 /* Process the definition of KEY which is DEF. */
7683 process_tool_bar_item (key
, def
)
7684 Lisp_Object key
, def
;
7687 extern Lisp_Object Qundefined
;
7688 struct gcpro gcpro1
, gcpro2
;
7690 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7694 if (EQ (def
, Qundefined
))
7696 /* If a map has an explicit `undefined' as definition,
7697 discard any previously made item. */
7698 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7700 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7702 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7704 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7705 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7706 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7707 * sizeof (Lisp_Object
)));
7708 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7713 else if (parse_tool_bar_item (key
, def
))
7714 /* Append a new tool bar item to tool_bar_items_vector. Accept
7715 more than one definition for the same key. */
7716 append_tool_bar_item ();
7722 /* Parse a tool bar item specification ITEM for key KEY and return the
7723 result in tool_bar_item_properties. Value is zero if ITEM is
7726 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7728 CAPTION is the caption of the item, If it's not a string, it is
7729 evaluated to get a string.
7731 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7732 as binding are currently ignored.
7734 The following properties are recognized:
7738 FORM is evaluated and specifies whether the tool bar item is
7739 enabled or disabled.
7743 FORM is evaluated and specifies whether the tool bar item is visible.
7745 - `:filter FUNCTION'
7747 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7748 result is stored as the new binding.
7750 - `:button (TYPE SELECTED)'
7752 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7753 and specifies whether the button is selected (pressed) or not.
7757 IMAGES is either a single image specification or a vector of four
7758 image specifications. See enum tool_bar_item_images.
7760 - `:help HELP-STRING'.
7762 Gives a help string to display for the tool bar item. */
7765 parse_tool_bar_item (key
, item
)
7766 Lisp_Object key
, item
;
7768 /* Access slot with index IDX of vector tool_bar_item_properties. */
7769 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7771 Lisp_Object filter
= Qnil
;
7772 Lisp_Object caption
;
7775 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7776 Rule out items that aren't lists, don't start with
7777 `menu-item' or whose rest following `tool-bar-item' is not a
7780 || !EQ (XCAR (item
), Qmenu_item
)
7781 || (item
= XCDR (item
),
7785 /* Create tool_bar_item_properties vector if necessary. Reset it to
7787 if (VECTORP (tool_bar_item_properties
))
7789 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7793 tool_bar_item_properties
7794 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7797 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7798 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7800 /* Get the caption of the item. If the caption is not a string,
7801 evaluate it to get a string. If we don't get a string, skip this
7803 caption
= XCAR (item
);
7804 if (!STRINGP (caption
))
7806 caption
= menu_item_eval_property (caption
);
7807 if (!STRINGP (caption
))
7810 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7812 /* Give up if rest following the caption is not a list. */
7817 /* Store the binding. */
7818 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7821 /* Ignore cached key binding, if any. */
7822 if (CONSP (item
) && CONSP (XCAR (item
)))
7825 /* Process the rest of the properties. */
7826 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7828 Lisp_Object key
, value
;
7831 value
= XCAR (XCDR (item
));
7833 if (EQ (key
, QCenable
))
7835 /* `:enable FORM'. */
7836 if (!NILP (Venable_disabled_menus_and_buttons
))
7837 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7839 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7841 else if (EQ (key
, QCvisible
))
7843 /* `:visible FORM'. If got a visible property and that
7844 evaluates to nil then ignore this item. */
7845 if (NILP (menu_item_eval_property (value
)))
7848 else if (EQ (key
, QChelp
))
7849 /* `:help HELP-STRING'. */
7850 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7851 else if (EQ (key
, QCfilter
))
7852 /* ':filter FORM'. */
7854 else if (EQ (key
, QCbutton
) && CONSP (value
))
7856 /* `:button (TYPE . SELECTED)'. */
7857 Lisp_Object type
, selected
;
7859 type
= XCAR (value
);
7860 selected
= XCDR (value
);
7861 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7863 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7864 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7867 else if (EQ (key
, QCimage
)
7869 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7870 /* Value is either a single image specification or a vector
7871 of 4 such specifications for the different button states. */
7872 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7875 /* If got a filter apply it on binding. */
7877 PROP (TOOL_BAR_ITEM_BINDING
)
7878 = menu_item_eval_property (list2 (filter
,
7880 PROP (TOOL_BAR_ITEM_BINDING
))));
7882 /* See if the binding is a keymap. Give up if it is. */
7883 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7886 /* Enable or disable selection of item. */
7887 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7888 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7889 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7891 /* Handle radio buttons or toggle boxes. */
7892 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7893 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7894 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7902 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7903 that can be reused. */
7906 init_tool_bar_items (reuse
)
7909 if (VECTORP (reuse
))
7910 tool_bar_items_vector
= reuse
;
7912 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7913 ntool_bar_items
= 0;
7917 /* Append parsed tool bar item properties from
7918 tool_bar_item_properties */
7921 append_tool_bar_item ()
7923 Lisp_Object
*to
, *from
;
7925 /* Enlarge tool_bar_items_vector if necessary. */
7926 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7927 >= XVECTOR (tool_bar_items_vector
)->size
)
7929 Lisp_Object new_vector
;
7930 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7932 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7933 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7934 XVECTOR (new_vector
)->contents
,
7935 old_size
* sizeof (Lisp_Object
));
7936 tool_bar_items_vector
= new_vector
;
7939 /* Append entries from tool_bar_item_properties to the end of
7940 tool_bar_items_vector. */
7941 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7942 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7943 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7944 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7951 /* Read a character using menus based on maps in the array MAPS.
7952 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7953 Return t if we displayed a menu but the user rejected it.
7955 PREV_EVENT is the previous input event, or nil if we are reading
7956 the first event of a key sequence.
7958 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7959 if we used a mouse menu to read the input, or zero otherwise. If
7960 USED_MOUSE_MENU is null, we don't dereference it.
7962 The prompting is done based on the prompt-string of the map
7963 and the strings associated with various map elements.
7965 This can be done with X menus or with menus put in the minibuf.
7966 These are done in different ways, depending on how the input will be read.
7967 Menus using X are done after auto-saving in read-char, getting the input
7968 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7969 and do auto-saving in the inner call of read_char. */
7972 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7975 Lisp_Object prev_event
;
7976 int *used_mouse_menu
;
7979 register Lisp_Object name
= Qnil
;
7981 if (used_mouse_menu
)
7982 *used_mouse_menu
= 0;
7984 /* Use local over global Menu maps */
7986 if (! menu_prompting
)
7989 /* Optionally disregard all but the global map. */
7990 if (inhibit_local_menu_bar_menus
)
7992 maps
+= (nmaps
- 1);
7996 /* Get the menu name from the first map that has one (a prompt string). */
7997 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7999 name
= Fkeymap_prompt (maps
[mapno
]);
8004 /* If we don't have any menus, just read a character normally. */
8005 if (!STRINGP (name
))
8009 /* If we got to this point via a mouse click,
8010 use a real menu for mouse selection. */
8011 if (EVENT_HAS_PARAMETERS (prev_event
)
8012 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8013 && !EQ (XCAR (prev_event
), Qtool_bar
))
8015 /* Display the menu and get the selection. */
8016 Lisp_Object
*realmaps
8017 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8021 /* Use the maps that are not nil. */
8022 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8023 if (!NILP (maps
[mapno
]))
8024 realmaps
[nmaps1
++] = maps
[mapno
];
8026 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8031 record_menu_key (XCAR (value
));
8033 /* If we got multiple events, unread all but
8035 There is no way to prevent those unread events
8036 from showing up later in last_nonmenu_event.
8037 So turn symbol and integer events into lists,
8038 to indicate that they came from a mouse menu,
8039 so that when present in last_nonmenu_event
8040 they won't confuse things. */
8041 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8043 record_menu_key (XCAR (tem
));
8044 if (SYMBOLP (XCAR (tem
))
8045 || INTEGERP (XCAR (tem
)))
8046 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8049 /* If we got more than one event, put all but the first
8050 onto this list to be read later.
8051 Return just the first event now. */
8052 Vunread_command_events
8053 = nconc2 (XCDR (value
), Vunread_command_events
);
8054 value
= XCAR (value
);
8056 else if (NILP (value
))
8058 if (used_mouse_menu
)
8059 *used_mouse_menu
= 1;
8062 #endif /* HAVE_MENUS */
8066 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8067 We make this bigger when necessary, and never free it. */
8068 static char *read_char_minibuf_menu_text
;
8069 /* Size of that buffer. */
8070 static int read_char_minibuf_menu_width
;
8073 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8079 register Lisp_Object name
;
8081 /* FIXME: Use the minibuffer's frame width. */
8082 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8085 Lisp_Object rest
, vector
;
8091 if (! menu_prompting
)
8094 /* Make sure we have a big enough buffer for the menu text. */
8095 if (read_char_minibuf_menu_text
== 0)
8097 read_char_minibuf_menu_width
= width
+ 4;
8098 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8100 else if (width
+ 4 > read_char_minibuf_menu_width
)
8102 read_char_minibuf_menu_width
= width
+ 4;
8103 read_char_minibuf_menu_text
8104 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8106 menu
= read_char_minibuf_menu_text
;
8108 /* Get the menu name from the first map that has one (a prompt string). */
8109 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8111 name
= Fkeymap_prompt (maps
[mapno
]);
8116 /* If we don't have any menus, just read a character normally. */
8117 if (!STRINGP (name
))
8120 /* Prompt string always starts with map's prompt, and a space. */
8121 strcpy (menu
, SDATA (name
));
8122 nlength
= SBYTES (name
);
8123 menu
[nlength
++] = ':';
8124 menu
[nlength
++] = ' ';
8127 /* Start prompting at start of first map. */
8131 /* Present the documented bindings, a line at a time. */
8138 Lisp_Object orig_defn_macro
;
8140 /* Loop over elements of map. */
8145 /* If reached end of map, start at beginning of next map. */
8149 /* At end of last map, wrap around to first map if just starting,
8150 or end this line if already have something on it. */
8154 if (notfirst
|| nobindings
) break;
8159 /* Look at the next element of the map. */
8161 elt
= XVECTOR (vector
)->contents
[idx
];
8163 elt
= Fcar_safe (rest
);
8165 if (idx
< 0 && VECTORP (elt
))
8167 /* If we found a dense table in the keymap,
8168 advanced past it, but start scanning its contents. */
8169 rest
= Fcdr_safe (rest
);
8175 /* An ordinary element. */
8176 Lisp_Object event
, tem
;
8180 event
= Fcar_safe (elt
); /* alist */
8181 elt
= Fcdr_safe (elt
);
8185 XSETINT (event
, idx
); /* vector */
8188 /* Ignore the element if it has no prompt string. */
8189 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8191 /* 1 if the char to type matches the string. */
8193 Lisp_Object upcased_event
, downcased_event
;
8194 Lisp_Object desc
= Qnil
;
8196 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8198 upcased_event
= Fupcase (event
);
8199 downcased_event
= Fdowncase (event
);
8200 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8201 || XINT (downcased_event
) == SREF (s
, 0));
8203 desc
= Fsingle_key_description (event
, Qnil
);
8205 #if 0 /* It is redundant to list the equivalent key bindings because
8206 the prefix is what the user has already typed. */
8208 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8210 /* Insert equivalent keybinding. */
8211 s
= concat2 (s
, tem
);
8214 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8215 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8217 /* Insert button prefix. */
8218 Lisp_Object selected
8219 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8220 if (EQ (tem
, QCradio
))
8221 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8223 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8224 s
= concat2 (tem
, s
);
8228 /* If we have room for the prompt string, add it to this line.
8229 If this is the first on the line, always add it. */
8230 if ((SCHARS (s
) + i
+ 2
8231 + (char_matches
? 0 : SCHARS (desc
) + 3))
8237 /* Punctuate between strings. */
8240 strcpy (menu
+ i
, ", ");
8246 /* If the char to type doesn't match the string's
8247 first char, explicitly show what char to type. */
8250 /* Add as much of string as fits. */
8251 thiswidth
= SCHARS (desc
);
8252 if (thiswidth
+ i
> width
)
8253 thiswidth
= width
- i
;
8254 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8256 strcpy (menu
+ i
, " = ");
8260 /* Add as much of string as fits. */
8261 thiswidth
= SCHARS (s
);
8262 if (thiswidth
+ i
> width
)
8263 thiswidth
= width
- i
;
8264 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8270 /* If this element does not fit, end the line now,
8271 and save the element for the next line. */
8272 strcpy (menu
+ i
, "...");
8277 /* Move past this element. */
8278 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8279 /* Handle reaching end of dense table. */
8284 rest
= Fcdr_safe (rest
);
8288 /* Prompt with that and read response. */
8289 message2_nolog (menu
, strlen (menu
),
8290 ! NILP (current_buffer
->enable_multibyte_characters
));
8292 /* Make believe its not a keyboard macro in case the help char
8293 is pressed. Help characters are not recorded because menu prompting
8294 is not used on replay.
8296 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8297 current_kboard
->defining_kbd_macro
= Qnil
;
8299 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8300 while (BUFFERP (obj
));
8301 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8303 if (!INTEGERP (obj
))
8308 if (! EQ (obj
, menu_prompt_more_char
)
8309 && (!INTEGERP (menu_prompt_more_char
)
8310 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8312 if (!NILP (current_kboard
->defining_kbd_macro
))
8313 store_kbd_macro_char (obj
);
8316 /* Help char - go round again */
8320 /* Reading key sequences. */
8322 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8323 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8324 keymap, or nil otherwise. Return the index of the first keymap in
8325 which KEY has any binding, or NMAPS if no map has a binding.
8327 If KEY is a meta ASCII character, treat it like meta-prefix-char
8328 followed by the corresponding non-meta character. Keymaps in
8329 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8332 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8335 NEXT may be the same array as CURRENT. */
8338 follow_key (key
, nmaps
, current
, defs
, next
)
8340 Lisp_Object
*current
, *defs
, *next
;
8343 int i
, first_binding
;
8345 first_binding
= nmaps
;
8346 for (i
= nmaps
- 1; i
>= 0; i
--)
8348 if (! NILP (current
[i
]))
8350 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8351 if (! NILP (defs
[i
]))
8358 /* Given the set of bindings we've found, produce the next set of maps. */
8359 if (first_binding
< nmaps
)
8360 for (i
= 0; i
< nmaps
; i
++)
8361 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8363 return first_binding
;
8366 /* Structure used to keep track of partial application of key remapping
8367 such as Vfunction_key_map and Vkey_translation_map. */
8368 typedef struct keyremap
8370 Lisp_Object map
, parent
;
8374 /* Lookup KEY in MAP.
8375 MAP is a keymap mapping keys to key vectors or functions.
8376 If the mapping is a function and DO_FUNCTION is non-zero, then
8377 the function is called with PROMPT as parameter and its return
8378 value is used as the return value of this function (after checking
8379 that it is indeed a vector). */
8382 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8383 Lisp_Object map
, key
, prompt
;
8388 next
= access_keymap (map
, key
, 1, 0, 1);
8390 /* Handle symbol with autoload definition. */
8391 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8392 && CONSP (XSYMBOL (next
)->function
)
8393 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8394 do_autoload (XSYMBOL (next
)->function
, next
);
8396 /* Handle a symbol whose function definition is a keymap
8398 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8399 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8400 || KEYMAPP (XSYMBOL (next
)->function
)))
8401 next
= XSYMBOL (next
)->function
;
8403 /* If the keymap gives a function, not an
8404 array, then call the function with one arg and use
8405 its value instead. */
8406 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8411 next
= call1 (next
, prompt
);
8412 /* If the function returned something invalid,
8413 barf--don't ignore it.
8414 (To ignore it safely, we would need to gcpro a bunch of
8415 other variables.) */
8416 if (! (VECTORP (next
) || STRINGP (next
)))
8417 error ("Function %s returns invalid key sequence", tem
);
8422 /* Do one step of the key remapping used for function-key-map and
8423 key-translation-map:
8424 KEYBUF is the buffer holding the input events.
8425 BUFSIZE is its maximum size.
8426 FKEY is a pointer to the keyremap structure to use.
8427 INPUT is the index of the last element in KEYBUF.
8428 DOIT if non-zero says that the remapping can actually take place.
8429 DIFF is used to return the number of keys added/removed by the remapping.
8430 PARENT is the root of the keymap.
8431 PROMPT is the prompt to use if the remapping happens through a function.
8432 The return value is non-zero if the remapping actually took place. */
8435 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8436 Lisp_Object
*keybuf
, prompt
;
8438 int input
, doit
, *diff
, bufsize
;
8440 Lisp_Object next
, key
;
8442 key
= keybuf
[fkey
->end
++];
8443 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8445 /* If keybuf[fkey->start..fkey->end] is bound in the
8446 map and we're in a position to do the key remapping, replace it with
8447 the binding and restart with fkey->start at the end. */
8448 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8450 int len
= XFASTINT (Flength (next
));
8453 *diff
= len
- (fkey
->end
- fkey
->start
);
8455 if (input
+ *diff
>= bufsize
)
8456 error ("Key sequence too long");
8458 /* Shift the keys that follow fkey->end. */
8460 for (i
= fkey
->end
; i
< input
; i
++)
8461 keybuf
[i
+ *diff
] = keybuf
[i
];
8463 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8464 keybuf
[i
+ *diff
] = keybuf
[i
];
8465 /* Overwrite the old keys with the new ones. */
8466 for (i
= 0; i
< len
; i
++)
8467 keybuf
[fkey
->start
+ i
]
8468 = Faref (next
, make_number (i
));
8470 fkey
->start
= fkey
->end
+= *diff
;
8471 fkey
->map
= fkey
->parent
;
8476 fkey
->map
= get_keymap (next
, 0, 1);
8478 /* If we no longer have a bound suffix, try a new position for
8480 if (!CONSP (fkey
->map
))
8482 fkey
->end
= ++fkey
->start
;
8483 fkey
->map
= fkey
->parent
;
8488 /* Read a sequence of keys that ends with a non prefix character,
8489 storing it in KEYBUF, a buffer of size BUFSIZE.
8491 Return the length of the key sequence stored.
8492 Return -1 if the user rejected a command menu.
8494 Echo starting immediately unless `prompt' is 0.
8496 Where a key sequence ends depends on the currently active keymaps.
8497 These include any minor mode keymaps active in the current buffer,
8498 the current buffer's local map, and the global map.
8500 If a key sequence has no other bindings, we check Vfunction_key_map
8501 to see if some trailing subsequence might be the beginning of a
8502 function key's sequence. If so, we try to read the whole function
8503 key, and substitute its symbolic name into the key sequence.
8505 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8506 `double-' events into similar click events, if that would make them
8507 bound. We try to turn `triple-' events first into `double-' events,
8510 If we get a mouse click in a mode line, vertical divider, or other
8511 non-text area, we treat the click as if it were prefixed by the
8512 symbol denoting that area - `mode-line', `vertical-line', or
8515 If the sequence starts with a mouse click, we read the key sequence
8516 with respect to the buffer clicked on, not the current buffer.
8518 If the user switches frames in the midst of a key sequence, we put
8519 off the switch-frame event until later; the next call to
8520 read_char will return it.
8522 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8523 from the selected window's buffer. */
8526 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8527 can_return_switch_frame
, fix_current_buffer
)
8528 Lisp_Object
*keybuf
;
8531 int dont_downcase_last
;
8532 int can_return_switch_frame
;
8533 int fix_current_buffer
;
8535 volatile Lisp_Object from_string
;
8536 volatile int count
= SPECPDL_INDEX ();
8538 /* How many keys there are in the current key sequence. */
8541 /* The length of the echo buffer when we started reading, and
8542 the length of this_command_keys when we started reading. */
8543 volatile int echo_start
;
8544 volatile int keys_start
;
8546 /* The number of keymaps we're scanning right now, and the number of
8547 keymaps we have allocated space for. */
8549 volatile int nmaps_allocated
= 0;
8551 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8552 the current keymaps. */
8553 Lisp_Object
*volatile defs
= NULL
;
8555 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8556 in the current keymaps, or nil where it is not a prefix. */
8557 Lisp_Object
*volatile submaps
= NULL
;
8559 /* The local map to start out with at start of key sequence. */
8560 volatile Lisp_Object orig_local_map
;
8562 /* The map from the `keymap' property to start out with at start of
8564 volatile Lisp_Object orig_keymap
;
8566 /* 1 if we have already considered switching to the local-map property
8567 of the place where a mouse click occurred. */
8568 volatile int localized_local_map
= 0;
8570 /* The index in defs[] of the first keymap that has a binding for
8571 this key sequence. In other words, the lowest i such that
8572 defs[i] is non-nil. */
8573 volatile int first_binding
;
8574 /* Index of the first key that has no binding.
8575 It is useless to try fkey.start larger than that. */
8576 volatile int first_unbound
;
8578 /* If t < mock_input, then KEYBUF[t] should be read as the next
8581 We use this to recover after recognizing a function key. Once we
8582 realize that a suffix of the current key sequence is actually a
8583 function key's escape sequence, we replace the suffix with the
8584 function key's binding from Vfunction_key_map. Now keybuf
8585 contains a new and different key sequence, so the echo area,
8586 this_command_keys, and the submaps and defs arrays are wrong. In
8587 this situation, we set mock_input to t, set t to 0, and jump to
8588 restart_sequence; the loop will read keys from keybuf up until
8589 mock_input, thus rebuilding the state; and then it will resume
8590 reading characters from the keyboard. */
8591 volatile int mock_input
= 0;
8593 /* If the sequence is unbound in submaps[], then
8594 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8595 and fkey.map is its binding.
8597 These might be > t, indicating that all function key scanning
8598 should hold off until t reaches them. We do this when we've just
8599 recognized a function key, to avoid searching for the function
8600 key's again in Vfunction_key_map. */
8601 volatile keyremap fkey
;
8603 /* Likewise, for key_translation_map. */
8604 volatile keyremap keytran
;
8606 /* If we receive a `switch-frame' or `select-window' event in the middle of
8607 a key sequence, we put it off for later.
8608 While we're reading, we keep the event here. */
8609 volatile Lisp_Object delayed_switch_frame
;
8611 /* See the comment below... */
8612 #if defined (GOBBLE_FIRST_EVENT)
8613 Lisp_Object first_event
;
8616 volatile Lisp_Object original_uppercase
;
8617 volatile int original_uppercase_position
= -1;
8619 /* Gets around Microsoft compiler limitations. */
8622 struct buffer
*starting_buffer
;
8624 /* List of events for which a fake prefix key has been generated. */
8625 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8627 #if defined (GOBBLE_FIRST_EVENT)
8631 struct gcpro gcpro1
;
8633 GCPRO1 (fake_prefixed_keys
);
8634 raw_keybuf_count
= 0;
8636 last_nonmenu_event
= Qnil
;
8638 delayed_switch_frame
= Qnil
;
8639 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8640 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8641 /* If there is no translation-map, turn off scanning. */
8642 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8643 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8648 echo_prompt (prompt
);
8649 else if (cursor_in_echo_area
8650 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8651 && NILP (Fzerop (Vecho_keystrokes
)))
8652 /* This doesn't put in a dash if the echo buffer is empty, so
8653 you don't always see a dash hanging out in the minibuffer. */
8657 /* Record the initial state of the echo area and this_command_keys;
8658 we will need to restore them if we replay a key sequence. */
8660 echo_start
= echo_length ();
8661 keys_start
= this_command_key_count
;
8662 this_single_command_key_start
= keys_start
;
8664 #if defined (GOBBLE_FIRST_EVENT)
8665 /* This doesn't quite work, because some of the things that read_char
8666 does cannot safely be bypassed. It seems too risky to try to make
8669 /* Read the first char of the sequence specially, before setting
8670 up any keymaps, in case a filter runs and switches buffers on us. */
8671 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8673 #endif /* GOBBLE_FIRST_EVENT */
8675 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8676 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8679 /* We jump here when the key sequence has been thoroughly changed, and
8680 we need to rescan it starting from the beginning. When we jump here,
8681 keybuf[0..mock_input] holds the sequence we should reread. */
8684 starting_buffer
= current_buffer
;
8685 first_unbound
= bufsize
+ 1;
8687 /* Build our list of keymaps.
8688 If we recognize a function key and replace its escape sequence in
8689 keybuf with its symbol, or if the sequence starts with a mouse
8690 click and we need to switch buffers, we jump back here to rebuild
8691 the initial keymaps from the current buffer. */
8694 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8695 || !NILP (Voverriding_local_map
))
8697 if (3 > nmaps_allocated
)
8699 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8700 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8701 nmaps_allocated
= 3;
8703 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8704 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8705 if (!NILP (Voverriding_local_map
))
8706 submaps
[nmaps
++] = Voverriding_local_map
;
8714 nminor
= current_minor_maps (0, &maps
);
8715 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8717 if (total
> nmaps_allocated
)
8719 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8720 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8721 nmaps_allocated
= total
;
8724 if (!NILP (orig_keymap
))
8725 submaps
[nmaps
++] = orig_keymap
;
8727 bcopy (maps
, (void *) (submaps
+ nmaps
),
8728 nminor
* sizeof (submaps
[0]));
8732 submaps
[nmaps
++] = orig_local_map
;
8734 submaps
[nmaps
++] = current_global_map
;
8736 /* Find an accurate initial value for first_binding. */
8737 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8738 if (! NILP (submaps
[first_binding
]))
8741 /* Start from the beginning in keybuf. */
8744 /* These are no-ops the first time through, but if we restart, they
8745 revert the echo area and this_command_keys to their original state. */
8746 this_command_key_count
= keys_start
;
8747 if (INTERACTIVE
&& t
< mock_input
)
8748 echo_truncate (echo_start
);
8750 /* If the best binding for the current key sequence is a keymap, or
8751 we may be looking at a function key's escape sequence, keep on
8753 while (first_binding
< nmaps
8754 /* Keep reading as long as there's a prefix binding. */
8755 ? !NILP (submaps
[first_binding
])
8756 /* Don't return in the middle of a possible function key sequence,
8757 if the only bindings we found were via case conversion.
8758 Thus, if ESC O a has a function-key-map translation
8759 and ESC o has a binding, don't return after ESC O,
8760 so that we can translate ESC O plus the next character. */
8761 : (fkey
.start
< t
|| keytran
.start
< t
))
8764 int used_mouse_menu
= 0;
8766 /* Where the last real key started. If we need to throw away a
8767 key that has expanded into more than one element of keybuf
8768 (say, a mouse click on the mode line which is being treated
8769 as [mode-line (mouse-...)], then we backtrack to this point
8771 volatile int last_real_key_start
;
8773 /* These variables are analogous to echo_start and keys_start;
8774 while those allow us to restart the entire key sequence,
8775 echo_local_start and keys_local_start allow us to throw away
8777 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8779 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8780 eassert (fkey
.start
<= fkey
.end
);
8781 eassert (keytran
.start
<= keytran
.end
);
8782 /* key-translation-map is applied *after* function-key-map. */
8783 eassert (keytran
.end
<= fkey
.start
);
8785 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8786 { /* The prefix upto first_unbound has no binding and has
8787 no translation left to do either, so we know it's unbound.
8788 If we don't stop now, we risk staying here indefinitely
8789 (if the user keeps entering fkey or keytran prefixes
8790 like C-c ESC ESC ESC ESC ...) */
8792 for (i
= first_unbound
+ 1; i
< t
; i
++)
8793 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8794 mock_input
= t
- first_unbound
- 1;
8795 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8796 fkey
.map
= fkey
.parent
;
8797 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8798 keytran
.map
= keytran
.parent
;
8799 goto replay_sequence
;
8803 error ("Key sequence too long");
8806 echo_local_start
= echo_length ();
8807 keys_local_start
= this_command_key_count
;
8808 local_first_binding
= first_binding
;
8811 /* These are no-ops, unless we throw away a keystroke below and
8812 jumped back up to replay_key; in that case, these restore the
8813 variables to their original state, allowing us to replay the
8815 if (INTERACTIVE
&& t
< mock_input
)
8816 echo_truncate (echo_local_start
);
8817 this_command_key_count
= keys_local_start
;
8818 first_binding
= local_first_binding
;
8820 /* By default, assume each event is "real". */
8821 last_real_key_start
= t
;
8823 /* Does mock_input indicate that we are re-reading a key sequence? */
8827 add_command_key (key
);
8828 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8829 && NILP (Fzerop (Vecho_keystrokes
)))
8833 /* If not, we should actually read a character. */
8838 KBOARD
*interrupted_kboard
= current_kboard
;
8839 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8840 if (setjmp (wrong_kboard_jmpbuf
))
8842 if (!NILP (delayed_switch_frame
))
8844 interrupted_kboard
->kbd_queue
8845 = Fcons (delayed_switch_frame
,
8846 interrupted_kboard
->kbd_queue
);
8847 delayed_switch_frame
= Qnil
;
8850 interrupted_kboard
->kbd_queue
8851 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8853 /* If the side queue is non-empty, ensure it begins with a
8854 switch-frame, so we'll replay it in the right context. */
8855 if (CONSP (interrupted_kboard
->kbd_queue
)
8856 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8857 !(EVENT_HAS_PARAMETERS (key
)
8858 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8862 XSETFRAME (frame
, interrupted_frame
);
8863 interrupted_kboard
->kbd_queue
8864 = Fcons (make_lispy_switch_frame (frame
),
8865 interrupted_kboard
->kbd_queue
);
8868 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8869 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8870 goto replay_sequence
;
8873 key
= read_char (NILP (prompt
), nmaps
,
8874 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8878 /* read_char returns t when it shows a menu and the user rejects it.
8882 unbind_to (count
, Qnil
);
8887 /* read_char returns -1 at the end of a macro.
8888 Emacs 18 handles this by returning immediately with a
8889 zero, so that's what we'll do. */
8890 if (INTEGERP (key
) && XINT (key
) == -1)
8893 /* The Microsoft C compiler can't handle the goto that
8899 /* If the current buffer has been changed from under us, the
8900 keymap may have changed, so replay the sequence. */
8903 timer_resume_idle ();
8906 /* Reset the current buffer from the selected window
8907 in case something changed the former and not the latter.
8908 This is to be more consistent with the behavior
8909 of the command_loop_1. */
8910 if (fix_current_buffer
)
8912 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8914 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8915 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8918 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8919 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8920 goto replay_sequence
;
8923 /* If we have a quit that was typed in another frame, and
8924 quit_throw_to_read_char switched buffers,
8925 replay to get the right keymap. */
8927 && XINT (key
) == quit_char
8928 && current_buffer
!= starting_buffer
)
8931 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8935 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8936 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8937 goto replay_sequence
;
8942 if (EVENT_HAS_PARAMETERS (key
)
8943 /* Either a `switch-frame' or a `select-window' event. */
8944 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8946 /* If we're at the beginning of a key sequence, and the caller
8947 says it's okay, go ahead and return this event. If we're
8948 in the midst of a key sequence, delay it until the end. */
8949 if (t
> 0 || !can_return_switch_frame
)
8951 delayed_switch_frame
= key
;
8957 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8960 /* Clicks in non-text areas get prefixed by the symbol
8961 in their CHAR-ADDRESS field. For example, a click on
8962 the mode line is prefixed by the symbol `mode-line'.
8964 Furthermore, key sequences beginning with mouse clicks
8965 are read using the keymaps of the buffer clicked on, not
8966 the current buffer. So we may have to switch the buffer
8969 When we turn one event into two events, we must make sure
8970 that neither of the two looks like the original--so that,
8971 if we replay the events, they won't be expanded again.
8972 If not for this, such reexpansion could happen either here
8973 or when user programs play with this-command-keys. */
8974 if (EVENT_HAS_PARAMETERS (key
))
8979 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8980 if (EQ (kind
, Qmouse_click
))
8982 Lisp_Object window
, posn
;
8984 window
= POSN_WINDOW (EVENT_START (key
));
8985 posn
= POSN_POSN (EVENT_START (key
));
8988 || (!NILP (fake_prefixed_keys
)
8989 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8991 /* We're looking a second time at an event for which
8992 we generated a fake prefix key. Set
8993 last_real_key_start appropriately. */
8995 last_real_key_start
= t
- 1;
8998 /* Key sequences beginning with mouse clicks are
8999 read using the keymaps in the buffer clicked on,
9000 not the current buffer. If we're at the
9001 beginning of a key sequence, switch buffers. */
9002 if (last_real_key_start
== 0
9004 && BUFFERP (XWINDOW (window
)->buffer
)
9005 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9007 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9011 /* Arrange to go back to the original buffer once we're
9012 done reading the key sequence. Note that we can't
9013 use save_excursion_{save,restore} here, because they
9014 save point as well as the current buffer; we don't
9015 want to save point, because redisplay may change it,
9016 to accommodate a Fset_window_start or something. We
9017 don't want to do this at the top of the function,
9018 because we may get input from a subprocess which
9019 wants to change the selected window and stuff (say,
9021 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9023 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9025 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9026 orig_local_map
= get_local_map (PT
, current_buffer
,
9028 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9029 goto replay_sequence
;
9032 /* For a mouse click, get the local text-property keymap
9033 of the place clicked on, rather than point. */
9034 if (last_real_key_start
== 0
9035 && CONSP (XCDR (key
))
9036 && ! localized_local_map
)
9038 Lisp_Object map_here
, start
, pos
;
9040 localized_local_map
= 1;
9041 start
= EVENT_START (key
);
9043 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9045 pos
= POSN_BUFFER_POSN (start
);
9047 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9049 map_here
= get_local_map (XINT (pos
),
9050 current_buffer
, Qlocal_map
);
9051 if (!EQ (map_here
, orig_local_map
))
9053 orig_local_map
= map_here
;
9057 goto replay_sequence
;
9059 map_here
= get_local_map (XINT (pos
),
9060 current_buffer
, Qkeymap
);
9061 if (!EQ (map_here
, orig_keymap
))
9063 orig_keymap
= map_here
;
9067 goto replay_sequence
;
9073 /* Expand mode-line and scroll-bar events into two events:
9074 use posn as a fake prefix key. */
9076 && (NILP (fake_prefixed_keys
)
9077 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9079 if (t
+ 1 >= bufsize
)
9080 error ("Key sequence too long");
9083 keybuf
[t
+ 1] = key
;
9086 /* Record that a fake prefix key has been generated
9087 for KEY. Don't modify the event; this would
9088 prevent proper action when the event is pushed
9089 back into unread-command-events. */
9090 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9092 /* If on a mode line string with a local keymap,
9093 reconsider the key sequence with that keymap. */
9094 if (string
= POSN_STRING (EVENT_START (key
)),
9095 (CONSP (string
) && STRINGP (XCAR (string
))))
9097 Lisp_Object pos
, map
, map2
;
9099 pos
= XCDR (string
);
9100 string
= XCAR (string
);
9102 && XINT (pos
) < SCHARS (string
))
9104 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9106 orig_local_map
= map
;
9107 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9110 if (!NILP (map
) || !NILP (map2
))
9111 goto replay_sequence
;
9117 else if (NILP (from_string
)
9118 && (string
= POSN_STRING (EVENT_START (key
)),
9119 (CONSP (string
) && STRINGP (XCAR (string
)))))
9121 /* For a click on a string, i.e. overlay string or a
9122 string displayed via the `display' property,
9123 consider `local-map' and `keymap' properties of
9125 Lisp_Object pos
, map
, map2
;
9127 pos
= XCDR (string
);
9128 string
= XCAR (string
);
9130 && XINT (pos
) < SCHARS (string
))
9132 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9134 orig_local_map
= map
;
9135 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9139 if (!NILP (map
) || !NILP (map2
))
9141 from_string
= string
;
9142 goto replay_sequence
;
9147 else if (CONSP (XCDR (key
))
9148 && CONSP (EVENT_START (key
))
9149 && CONSP (XCDR (EVENT_START (key
))))
9153 posn
= POSN_POSN (EVENT_START (key
));
9154 /* Handle menu-bar events:
9155 insert the dummy prefix event `menu-bar'. */
9156 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9158 if (t
+ 1 >= bufsize
)
9159 error ("Key sequence too long");
9163 /* Zap the position in key, so we know that we've
9164 expanded it, and don't try to do so again. */
9165 POSN_SET_POSN (EVENT_START (key
),
9166 Fcons (posn
, Qnil
));
9169 goto replay_sequence
;
9171 else if (CONSP (posn
))
9173 /* We're looking at the second event of a
9174 sequence which we expanded before. Set
9175 last_real_key_start appropriately. */
9176 if (last_real_key_start
== t
&& t
> 0)
9177 last_real_key_start
= t
- 1;
9182 /* We have finally decided that KEY is something we might want
9184 first_binding
= (follow_key (key
,
9185 nmaps
- first_binding
,
9186 submaps
+ first_binding
,
9187 defs
+ first_binding
,
9188 submaps
+ first_binding
)
9191 /* If KEY wasn't bound, we'll try some fallbacks. */
9192 if (first_binding
< nmaps
)
9193 /* This is needed for the following scenario:
9194 event 0: a down-event that gets dropped by calling replay_key.
9195 event 1: some normal prefix like C-h.
9196 After event 0, first_unbound is 0, after event 1 fkey.start
9197 and keytran.start are both 1, so when we see that C-h is bound,
9198 we need to update first_unbound. */
9199 first_unbound
= max (t
+ 1, first_unbound
);
9204 /* Remember the position to put an upper bound on fkey.start. */
9205 first_unbound
= min (t
, first_unbound
);
9207 head
= EVENT_HEAD (key
);
9208 if (help_char_p (head
) && t
> 0)
9210 read_key_sequence_cmd
= Vprefix_help_command
;
9212 last_nonmenu_event
= key
;
9213 /* The Microsoft C compiler can't handle the goto that
9221 Lisp_Object breakdown
;
9224 breakdown
= parse_modifiers (head
);
9225 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9226 /* Attempt to reduce an unbound mouse event to a simpler
9227 event that is bound:
9228 Drags reduce to clicks.
9229 Double-clicks reduce to clicks.
9230 Triple-clicks reduce to double-clicks, then to clicks.
9231 Down-clicks are eliminated.
9232 Double-downs reduce to downs, then are eliminated.
9233 Triple-downs reduce to double-downs, then to downs,
9234 then are eliminated. */
9235 if (modifiers
& (down_modifier
| drag_modifier
9236 | double_modifier
| triple_modifier
))
9238 while (modifiers
& (down_modifier
| drag_modifier
9239 | double_modifier
| triple_modifier
))
9241 Lisp_Object new_head
, new_click
;
9242 if (modifiers
& triple_modifier
)
9243 modifiers
^= (double_modifier
| triple_modifier
);
9244 else if (modifiers
& double_modifier
)
9245 modifiers
&= ~double_modifier
;
9246 else if (modifiers
& drag_modifier
)
9247 modifiers
&= ~drag_modifier
;
9250 /* Dispose of this `down' event by simply jumping
9251 back to replay_key, to get another event.
9253 Note that if this event came from mock input,
9254 then just jumping back to replay_key will just
9255 hand it to us again. So we have to wipe out any
9258 We could delete keybuf[t] and shift everything
9259 after that to the left by one spot, but we'd also
9260 have to fix up any variable that points into
9261 keybuf, and shifting isn't really necessary
9264 Adding prefixes for non-textual mouse clicks
9265 creates two characters of mock input, and both
9266 must be thrown away. If we're only looking at
9267 the prefix now, we can just jump back to
9268 replay_key. On the other hand, if we've already
9269 processed the prefix, and now the actual click
9270 itself is giving us trouble, then we've lost the
9271 state of the keymaps we want to backtrack to, and
9272 we need to replay the whole sequence to rebuild
9275 Beyond that, only function key expansion could
9276 create more than two keys, but that should never
9277 generate mouse events, so it's okay to zero
9278 mock_input in that case too.
9280 FIXME: The above paragraph seems just plain
9281 wrong, if you consider things like
9282 xterm-mouse-mode. -stef
9284 Isn't this just the most wonderful code ever? */
9286 /* If mock_input > t + 1, the above simplification
9287 will actually end up dropping keys on the floor.
9288 This is probably OK for now, but even
9289 if mock_input <= t + 1, we need to adjust fkey
9291 Typical case [header-line down-mouse-N]:
9292 mock_input = 2, t = 1, fkey.end = 1,
9293 last_real_key_start = 0. */
9294 if (fkey
.end
> last_real_key_start
)
9296 fkey
.end
= fkey
.start
9297 = min (last_real_key_start
, fkey
.start
);
9298 fkey
.map
= fkey
.parent
;
9299 if (keytran
.end
> last_real_key_start
)
9301 keytran
.end
= keytran
.start
9302 = min (last_real_key_start
, keytran
.start
);
9303 keytran
.map
= keytran
.parent
;
9306 if (t
== last_real_key_start
)
9313 mock_input
= last_real_key_start
;
9314 goto replay_sequence
;
9319 = apply_modifiers (modifiers
, XCAR (breakdown
));
9321 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9323 /* Look for a binding for this new key. follow_key
9324 promises that it didn't munge submaps the
9325 last time we called it, since key was unbound. */
9327 = (follow_key (new_click
,
9328 nmaps
- local_first_binding
,
9329 submaps
+ local_first_binding
,
9330 defs
+ local_first_binding
,
9331 submaps
+ local_first_binding
)
9332 + local_first_binding
);
9334 /* If that click is bound, go for it. */
9335 if (first_binding
< nmaps
)
9340 /* Otherwise, we'll leave key set to the drag event. */
9347 /* Normally, last_nonmenu_event gets the previous key we read.
9348 But when a mouse popup menu is being used,
9349 we don't update last_nonmenu_event; it continues to hold the mouse
9350 event that preceded the first level of menu. */
9351 if (!used_mouse_menu
)
9352 last_nonmenu_event
= key
;
9354 /* Record what part of this_command_keys is the current key sequence. */
9355 this_single_command_key_start
= this_command_key_count
- t
;
9357 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9358 /* There is a binding and it's not a prefix.
9359 There is thus no function-key in this sequence.
9360 Moving fkey.start is important in this case to allow keytran.start
9361 to go over the sequence before we return (since we keep the
9362 invariant that keytran.end <= fkey.start). */
9365 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9368 /* If the sequence is unbound, see if we can hang a function key
9369 off the end of it. */
9370 /* Continue scan from fkey.end until we find a bound suffix. */
9371 while (fkey
.end
< t
)
9373 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9376 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9377 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9378 max (t
, mock_input
),
9379 /* If there's a binding (i.e.
9380 first_binding >= nmaps) we don't want
9381 to apply this function-key-mapping. */
9382 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9387 mock_input
= diff
+ max (t
, mock_input
);
9388 goto replay_sequence
;
9392 /* Look for this sequence in key-translation-map.
9393 Scan from keytran.end until we find a bound suffix. */
9394 while (keytran
.end
< fkey
.start
)
9396 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9399 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9400 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9405 mock_input
= diff
+ max (t
, mock_input
);
9406 /* Adjust the function-key-map counters. */
9410 goto replay_sequence
;
9414 /* If KEY is not defined in any of the keymaps,
9415 and cannot be part of a function key or translation,
9416 and is an upper case letter
9417 use the corresponding lower-case letter instead. */
9418 if (first_binding
>= nmaps
9419 && fkey
.start
>= t
&& keytran
.start
>= t
9421 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9422 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9423 || (XINT (key
) & shift_modifier
)))
9425 Lisp_Object new_key
;
9427 original_uppercase
= key
;
9428 original_uppercase_position
= t
- 1;
9430 if (XINT (key
) & shift_modifier
)
9431 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9433 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9434 | (XINT (key
) & ~CHAR_MODIFIER_MASK
)));
9436 /* We have to do this unconditionally, regardless of whether
9437 the lower-case char is defined in the keymaps, because they
9438 might get translated through function-key-map. */
9439 keybuf
[t
- 1] = new_key
;
9440 mock_input
= max (t
, mock_input
);
9442 goto replay_sequence
;
9444 /* If KEY is not defined in any of the keymaps,
9445 and cannot be part of a function key or translation,
9446 and is a shifted function key,
9447 use the corresponding unshifted function key instead. */
9448 if (first_binding
>= nmaps
9449 && fkey
.start
>= t
&& keytran
.start
>= t
9452 Lisp_Object breakdown
;
9455 breakdown
= parse_modifiers (key
);
9456 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9457 if (modifiers
& shift_modifier
)
9459 Lisp_Object new_key
;
9461 original_uppercase
= key
;
9462 original_uppercase_position
= t
- 1;
9464 modifiers
&= ~shift_modifier
;
9465 new_key
= apply_modifiers (modifiers
,
9468 keybuf
[t
- 1] = new_key
;
9469 mock_input
= max (t
, mock_input
);
9470 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9471 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9473 goto replay_sequence
;
9479 read_key_sequence_cmd
= (first_binding
< nmaps
9480 ? defs
[first_binding
]
9483 unread_switch_frame
= delayed_switch_frame
;
9484 unbind_to (count
, Qnil
);
9486 /* Don't downcase the last character if the caller says don't.
9487 Don't downcase it if the result is undefined, either. */
9488 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9489 && t
- 1 == original_uppercase_position
)
9490 keybuf
[t
- 1] = original_uppercase
;
9492 /* Occasionally we fabricate events, perhaps by expanding something
9493 according to function-key-map, or by adding a prefix symbol to a
9494 mouse click in the scroll bar or modeline. In this cases, return
9495 the entire generated key sequence, even if we hit an unbound
9496 prefix or a definition before the end. This means that you will
9497 be able to push back the event properly, and also means that
9498 read-key-sequence will always return a logical unit.
9501 for (; t
< mock_input
; t
++)
9503 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9504 && NILP (Fzerop (Vecho_keystrokes
)))
9505 echo_char (keybuf
[t
]);
9506 add_command_key (keybuf
[t
]);
9515 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9516 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9517 The sequence is sufficient to specify a non-prefix command in the
9518 current local and global maps.
9520 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9521 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9522 as a continuation of the previous key.
9524 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9525 convert the last event to lower case. (Normally any upper case event
9526 is converted to lower case if the original event is undefined and the lower
9527 case equivalent is defined.) A non-nil value is appropriate for reading
9528 a key sequence to be defined.
9530 A C-g typed while in this function is treated like any other character,
9531 and `quit-flag' is not set.
9533 If the key sequence starts with a mouse click, then the sequence is read
9534 using the keymaps of the buffer of the window clicked in, not the buffer
9535 of the selected window as normal.
9537 `read-key-sequence' drops unbound button-down events, since you normally
9538 only care about the click or drag events which follow them. If a drag
9539 or multi-click event is unbound, but the corresponding click event would
9540 be bound, `read-key-sequence' turns the event into a click event at the
9541 drag's starting position. This means that you don't have to distinguish
9542 between click and drag, double, or triple events unless you want to.
9544 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9545 lines separating windows, and scroll bars with imaginary keys
9546 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9548 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9549 function will process a switch-frame event if the user switches frames
9550 before typing anything. If the user switches frames in the middle of a
9551 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9552 is nil, then the event will be put off until after the current key sequence.
9554 `read-key-sequence' checks `function-key-map' for function key
9555 sequences, where they wouldn't conflict with ordinary bindings. See
9556 `function-key-map' for more details.
9558 The optional fifth argument COMMAND-LOOP, if non-nil, means
9559 that this key sequence is being read by something that will
9560 read commands one after another. It should be nil if the caller
9561 will read just one key sequence. */)
9562 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9564 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9565 Lisp_Object can_return_switch_frame
, command_loop
;
9567 Lisp_Object keybuf
[30];
9569 struct gcpro gcpro1
;
9570 int count
= SPECPDL_INDEX ();
9573 CHECK_STRING (prompt
);
9576 specbind (Qinput_method_exit_on_first_char
,
9577 (NILP (command_loop
) ? Qt
: Qnil
));
9578 specbind (Qinput_method_use_echo_area
,
9579 (NILP (command_loop
) ? Qt
: Qnil
));
9581 bzero (keybuf
, sizeof keybuf
);
9583 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9585 if (NILP (continue_echo
))
9587 this_command_key_count
= 0;
9588 this_command_key_count_reset
= 0;
9589 this_single_command_key_start
= 0;
9592 #ifdef HAVE_X_WINDOWS
9593 if (display_hourglass_p
)
9594 cancel_hourglass ();
9597 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9598 prompt
, ! NILP (dont_downcase_last
),
9599 ! NILP (can_return_switch_frame
), 0);
9601 #if 0 /* The following is fine for code reading a key sequence and
9602 then proceeding with a lenghty computation, but it's not good
9603 for code reading keys in a loop, like an input method. */
9604 #ifdef HAVE_X_WINDOWS
9605 if (display_hourglass_p
)
9616 return unbind_to (count
, make_event_array (i
, keybuf
));
9619 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9620 Sread_key_sequence_vector
, 1, 5, 0,
9621 doc
: /* Like `read-key-sequence' but always return a vector. */)
9622 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9624 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9625 Lisp_Object can_return_switch_frame
, command_loop
;
9627 Lisp_Object keybuf
[30];
9629 struct gcpro gcpro1
;
9630 int count
= SPECPDL_INDEX ();
9633 CHECK_STRING (prompt
);
9636 specbind (Qinput_method_exit_on_first_char
,
9637 (NILP (command_loop
) ? Qt
: Qnil
));
9638 specbind (Qinput_method_use_echo_area
,
9639 (NILP (command_loop
) ? Qt
: Qnil
));
9641 bzero (keybuf
, sizeof keybuf
);
9643 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9645 if (NILP (continue_echo
))
9647 this_command_key_count
= 0;
9648 this_command_key_count_reset
= 0;
9649 this_single_command_key_start
= 0;
9652 #ifdef HAVE_X_WINDOWS
9653 if (display_hourglass_p
)
9654 cancel_hourglass ();
9657 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9658 prompt
, ! NILP (dont_downcase_last
),
9659 ! NILP (can_return_switch_frame
), 0);
9661 #ifdef HAVE_X_WINDOWS
9662 if (display_hourglass_p
)
9672 return unbind_to (count
, Fvector (i
, keybuf
));
9675 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9676 doc
: /* Execute CMD as an editor command.
9677 CMD must be a symbol that satisfies the `commandp' predicate.
9678 Optional second arg RECORD-FLAG non-nil
9679 means unconditionally put this command in `command-history'.
9680 Otherwise, that is done only if an arg is read using the minibuffer.
9681 The argument KEYS specifies the value to use instead of (this-command-keys)
9682 when reading the arguments; if it is nil, (this-command-keys) is used.
9683 The argument SPECIAL, if non-nil, means that this command is executing
9684 a special event, so ignore the prefix argument and don't clear it. */)
9685 (cmd
, record_flag
, keys
, special
)
9686 Lisp_Object cmd
, record_flag
, keys
, special
;
9688 register Lisp_Object final
;
9689 register Lisp_Object tem
;
9690 Lisp_Object prefixarg
;
9691 struct backtrace backtrace
;
9692 extern int debug_on_next_call
;
9694 debug_on_next_call
= 0;
9698 prefixarg
= current_kboard
->Vprefix_arg
;
9699 Vcurrent_prefix_arg
= prefixarg
;
9700 current_kboard
->Vprefix_arg
= Qnil
;
9707 tem
= Fget (cmd
, Qdisabled
);
9708 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9710 tem
= Fsymbol_value (Qdisabled_command_function
);
9712 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9718 final
= Findirect_function (cmd
, Qnil
);
9720 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9722 struct gcpro gcpro1
, gcpro2
;
9724 GCPRO2 (cmd
, prefixarg
);
9725 do_autoload (final
, cmd
);
9732 if (STRINGP (final
) || VECTORP (final
))
9734 /* If requested, place the macro in the command history. For
9735 other sorts of commands, call-interactively takes care of
9737 if (!NILP (record_flag
))
9740 = Fcons (Fcons (Qexecute_kbd_macro
,
9741 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9744 /* Don't keep command history around forever. */
9745 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9747 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9749 XSETCDR (tem
, Qnil
);
9753 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9756 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9758 backtrace
.next
= backtrace_list
;
9759 backtrace_list
= &backtrace
;
9760 backtrace
.function
= &Qcall_interactively
;
9761 backtrace
.args
= &cmd
;
9762 backtrace
.nargs
= 1;
9763 backtrace
.evalargs
= 0;
9764 backtrace
.debug_on_exit
= 0;
9766 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9768 backtrace_list
= backtrace
.next
;
9776 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9778 doc
: /* Read function name, then read its arguments and call it. */)
9780 Lisp_Object prefixarg
;
9782 Lisp_Object function
;
9784 int saved_last_point_position
;
9785 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9786 Lisp_Object bindings
, value
;
9787 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9788 #ifdef HAVE_X_WINDOWS
9789 /* The call to Fcompleting_read wil start and cancel the hourglass,
9790 but if the hourglass was already scheduled, this means that no
9791 hourglass will be shown for the actual M-x command itself.
9792 So we restart it if it is already scheduled. Note that checking
9793 hourglass_shown_p is not enough, normally the hourglass is not shown,
9794 just scheduled to be shown. */
9795 int hstarted
= hourglass_started ();
9798 saved_keys
= Fvector (this_command_key_count
,
9799 XVECTOR (this_command_keys
)->contents
);
9800 saved_last_point_position_buffer
= last_point_position_buffer
;
9801 saved_last_point_position
= last_point_position
;
9803 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9805 if (EQ (prefixarg
, Qminus
))
9807 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9808 strcpy (buf
, "C-u ");
9809 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9810 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9811 else if (INTEGERP (prefixarg
))
9812 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9814 /* This isn't strictly correct if execute-extended-command
9815 is bound to anything else. Perhaps it should use
9816 this_command_keys? */
9817 strcat (buf
, "M-x ");
9819 /* Prompt with buf, and then read a string, completing from and
9820 restricting to the set of all defined commands. Don't provide
9821 any initial input. Save the command read on the extended-command
9823 function
= Fcompleting_read (build_string (buf
),
9824 Vobarray
, Qcommandp
,
9825 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9828 #ifdef HAVE_X_WINDOWS
9829 if (hstarted
) start_hourglass ();
9832 if (STRINGP (function
) && SCHARS (function
) == 0)
9833 error ("No command name given");
9835 /* Set this_command_keys to the concatenation of saved_keys and
9836 function, followed by a RET. */
9841 this_command_key_count
= 0;
9842 this_command_key_count_reset
= 0;
9843 this_single_command_key_start
= 0;
9845 keys
= XVECTOR (saved_keys
)->contents
;
9846 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9847 add_command_key (keys
[i
]);
9849 for (i
= 0; i
< SCHARS (function
); i
++)
9850 add_command_key (Faref (function
, make_number (i
)));
9852 add_command_key (make_number ('\015'));
9855 last_point_position
= saved_last_point_position
;
9856 last_point_position_buffer
= saved_last_point_position_buffer
;
9860 function
= Fintern (function
, Qnil
);
9861 current_kboard
->Vprefix_arg
= prefixarg
;
9862 Vthis_command
= function
;
9863 real_this_command
= function
;
9865 /* If enabled, show which key runs this command. */
9866 if (!NILP (Vsuggest_key_bindings
)
9867 && NILP (Vexecuting_kbd_macro
)
9868 && SYMBOLP (function
))
9869 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9875 GCPRO2 (bindings
, value
);
9876 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9878 /* If the command has a key binding, print it now. */
9879 if (!NILP (bindings
)
9880 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9883 /* But first wait, and skip the message if there is input. */
9885 if (!NILP (echo_area_buffer
[0]))
9886 /* This command displayed something in the echo area;
9887 so wait a few seconds, then display our suggestion message. */
9888 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9889 ? XINT (Vsuggest_key_bindings
) : 2);
9891 /* This command left the echo area empty,
9892 so display our message immediately. */
9895 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9896 && ! CONSP (Vunread_command_events
))
9898 Lisp_Object binding
;
9900 int message_p
= push_message ();
9901 int count
= SPECPDL_INDEX ();
9903 record_unwind_protect (pop_message_unwind
, Qnil
);
9904 binding
= Fkey_description (bindings
, Qnil
);
9907 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9910 sprintf (newmessage
, "You can run the command `%s' with %s",
9911 SDATA (SYMBOL_NAME (function
)),
9913 message2_nolog (newmessage
,
9914 strlen (newmessage
),
9915 STRING_MULTIBYTE (binding
));
9916 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9917 ? Vsuggest_key_bindings
: make_number (2)),
9922 unbind_to (count
, Qnil
);
9926 RETURN_UNGCPRO (value
);
9930 /* Return nonzero if input events are pending. */
9933 detect_input_pending ()
9936 get_input_pending (&input_pending
, 0);
9938 return input_pending
;
9941 /* Return nonzero if input events other than mouse movements are
9945 detect_input_pending_ignore_squeezables ()
9948 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9950 return input_pending
;
9953 /* Return nonzero if input events are pending, and run any pending timers. */
9956 detect_input_pending_run_timers (do_display
)
9959 int old_timers_run
= timers_run
;
9962 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
9964 if (old_timers_run
!= timers_run
&& do_display
)
9966 redisplay_preserve_echo_area (8);
9967 /* The following fixes a bug when using lazy-lock with
9968 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9969 from an idle timer function. The symptom of the bug is that
9970 the cursor sometimes doesn't become visible until the next X
9971 event is processed. --gerd. */
9973 rif
->flush_display (NULL
);
9976 return input_pending
;
9979 /* This is called in some cases before a possible quit.
9980 It cases the next call to detect_input_pending to recompute input_pending.
9981 So calling this function unnecessarily can't do any harm. */
9984 clear_input_pending ()
9989 /* Return nonzero if there are pending requeued events.
9990 This isn't used yet. The hope is to make wait_reading_process_output
9991 call it, and return if it runs Lisp code that unreads something.
9992 The problem is, kbd_buffer_get_event needs to be fixed to know what
9993 to do in that case. It isn't trivial. */
9996 requeued_events_pending_p ()
9998 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10002 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10003 doc
: /* Return t if command input is currently available with no wait.
10004 Actually, the value is nil only if we can be sure that no input is available;
10005 if there is a doubt, the value is t. */)
10008 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
10011 get_input_pending (&input_pending
,
10012 READABLE_EVENTS_DO_TIMERS_NOW
10013 | READABLE_EVENTS_FILTER_EVENTS
);
10014 return input_pending
> 0 ? Qt
: Qnil
;
10017 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10018 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10021 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10024 if (total_keys
< NUM_RECENT_KEYS
)
10025 return Fvector (total_keys
, keys
);
10028 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10029 bcopy (keys
+ recent_keys_index
,
10030 XVECTOR (val
)->contents
,
10031 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10033 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10034 recent_keys_index
* sizeof (Lisp_Object
));
10039 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10040 doc
: /* Return the key sequence that invoked this command.
10041 However, if the command has called `read-key-sequence', it returns
10042 the last key sequence that has been read.
10043 The value is a string or a vector. */)
10046 return make_event_array (this_command_key_count
,
10047 XVECTOR (this_command_keys
)->contents
);
10050 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10051 doc
: /* Return the key sequence that invoked this command, as a vector.
10052 However, if the command has called `read-key-sequence', it returns
10053 the last key sequence that has been read. */)
10056 return Fvector (this_command_key_count
,
10057 XVECTOR (this_command_keys
)->contents
);
10060 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10061 Sthis_single_command_keys
, 0, 0, 0,
10062 doc
: /* Return the key sequence that invoked this command.
10063 More generally, it returns the last key sequence read, either by
10064 the command loop or by `read-key-sequence'.
10065 Unlike `this-command-keys', this function's value
10066 does not include prefix arguments.
10067 The value is always a vector. */)
10070 return Fvector (this_command_key_count
10071 - this_single_command_key_start
,
10072 (XVECTOR (this_command_keys
)->contents
10073 + this_single_command_key_start
));
10076 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10077 Sthis_single_command_raw_keys
, 0, 0, 0,
10078 doc
: /* Return the raw events that were read for this command.
10079 More generally, it returns the last key sequence read, either by
10080 the command loop or by `read-key-sequence'.
10081 Unlike `this-single-command-keys', this function's value
10082 shows the events before all translations (except for input methods).
10083 The value is always a vector. */)
10086 return Fvector (raw_keybuf_count
,
10087 (XVECTOR (raw_keybuf
)->contents
));
10090 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10091 Sreset_this_command_lengths
, 0, 0, 0,
10092 doc
: /* Make the unread events replace the last command and echo.
10093 Used in `universal-argument-other-key'.
10095 `universal-argument-other-key' rereads the event just typed.
10096 It then gets translated through `function-key-map'.
10097 The translated event has to replace the real events,
10098 both in the value of (this-command-keys) and in echoing.
10099 To achieve this, `universal-argument-other-key' calls
10100 `reset-this-command-lengths', which discards the record of reading
10101 these events the first time. */)
10104 this_command_key_count
= before_command_key_count
;
10105 if (this_command_key_count
< this_single_command_key_start
)
10106 this_single_command_key_start
= this_command_key_count
;
10108 echo_truncate (before_command_echo_length
);
10110 /* Cause whatever we put into unread-command-events
10111 to echo as if it were being freshly read from the keyboard. */
10112 this_command_key_count_reset
= 1;
10117 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10118 Sclear_this_command_keys
, 0, 1, 0,
10119 doc
: /* Clear out the vector that `this-command-keys' returns.
10120 Also clear the record of the last 100 events, unless optional arg
10121 KEEP-RECORD is non-nil. */)
10123 Lisp_Object keep_record
;
10127 this_command_key_count
= 0;
10128 this_command_key_count_reset
= 0;
10130 if (NILP (keep_record
))
10132 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10133 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10135 recent_keys_index
= 0;
10140 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10141 doc
: /* Return the current depth in recursive edits. */)
10145 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10149 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10150 "FOpen dribble file: ",
10151 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10152 If FILE is nil, close any open dribble file. */)
10163 file
= Fexpand_file_name (file
, Qnil
);
10164 dribble
= fopen (SDATA (file
), "w");
10166 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10171 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10172 doc
: /* Discard the contents of the terminal input buffer.
10173 Also end any kbd macro being defined. */)
10176 if (!NILP (current_kboard
->defining_kbd_macro
))
10178 /* Discard the last command from the macro. */
10179 Fcancel_kbd_macro_events ();
10183 update_mode_lines
++;
10185 Vunread_command_events
= Qnil
;
10186 unread_command_char
= -1;
10188 discard_tty_input ();
10190 kbd_fetch_ptr
= kbd_store_ptr
;
10196 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10197 doc
: /* Stop Emacs and return to superior process. You can resume later.
10198 If `cannot-suspend' is non-nil, or if the system doesn't support job
10199 control, run a subshell instead.
10201 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10202 to be read as terminal input by Emacs's parent, after suspension.
10204 Before suspending, run the normal hook `suspend-hook'.
10205 After resumption run the normal hook `suspend-resume-hook'.
10207 Some operating systems cannot stop the Emacs process and resume it later.
10208 On such systems, Emacs starts a subshell instead of suspending. */)
10210 Lisp_Object stuffstring
;
10212 int count
= SPECPDL_INDEX ();
10213 int old_height
, old_width
;
10215 struct gcpro gcpro1
;
10217 if (!NILP (stuffstring
))
10218 CHECK_STRING (stuffstring
);
10220 /* Run the functions in suspend-hook. */
10221 if (!NILP (Vrun_hooks
))
10222 call1 (Vrun_hooks
, intern ("suspend-hook"));
10224 GCPRO1 (stuffstring
);
10225 get_frame_size (&old_width
, &old_height
);
10226 reset_sys_modes ();
10227 /* sys_suspend can get an error if it tries to fork a subshell
10228 and the system resources aren't available for that. */
10229 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10231 stuff_buffered_input (stuffstring
);
10232 if (cannot_suspend
)
10236 unbind_to (count
, Qnil
);
10238 /* Check if terminal/window size has changed.
10239 Note that this is not useful when we are running directly
10240 with a window system; but suspend should be disabled in that case. */
10241 get_frame_size (&width
, &height
);
10242 if (width
!= old_width
|| height
!= old_height
)
10243 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10245 /* Run suspend-resume-hook. */
10246 if (!NILP (Vrun_hooks
))
10247 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10253 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10254 Then in any case stuff anything Emacs has read ahead and not used. */
10257 stuff_buffered_input (stuffstring
)
10258 Lisp_Object stuffstring
;
10260 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10261 register unsigned char *p
;
10263 if (STRINGP (stuffstring
))
10265 register int count
;
10267 p
= SDATA (stuffstring
);
10268 count
= SBYTES (stuffstring
);
10269 while (count
-- > 0)
10274 /* Anything we have read ahead, put back for the shell to read. */
10275 /* ?? What should this do when we have multiple keyboards??
10276 Should we ignore anything that was typed in at the "wrong" kboard?
10278 rms: we should stuff everything back into the kboard
10280 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10283 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10284 kbd_fetch_ptr
= kbd_buffer
;
10285 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10286 stuff_char (kbd_fetch_ptr
->code
);
10288 clear_event (kbd_fetch_ptr
);
10292 #endif /* SIGTSTP */
10296 set_waiting_for_input (time_to_clear
)
10297 EMACS_TIME
*time_to_clear
;
10299 input_available_clear_time
= time_to_clear
;
10301 /* Tell interrupt_signal to throw back to read_char, */
10302 waiting_for_input
= 1;
10304 /* If interrupt_signal was called before and buffered a C-g,
10305 make it run again now, to avoid timing error. */
10306 if (!NILP (Vquit_flag
))
10307 quit_throw_to_read_char ();
10311 clear_waiting_for_input ()
10313 /* Tell interrupt_signal not to throw back to read_char, */
10314 waiting_for_input
= 0;
10315 input_available_clear_time
= 0;
10318 /* This routine is called at interrupt level in response to C-g.
10320 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10321 is called from kbd_buffer_store_event, in handling SIGIO or
10324 If `waiting_for_input' is non zero, then unless `echoing' is
10325 nonzero, immediately throw back to read_char.
10327 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10328 eval to throw, when it gets a chance. If quit-flag is already
10329 non-nil, it stops the job right away. */
10332 interrupt_signal (signalnum
) /* If we don't have an argument, */
10333 int signalnum
; /* some compilers complain in signal calls. */
10336 /* Must preserve main program's value of errno. */
10337 int old_errno
= errno
;
10338 struct frame
*sf
= SELECTED_FRAME ();
10340 #if defined (USG) && !defined (POSIX_SIGNALS)
10341 if (!read_socket_hook
&& NILP (Vwindow_system
))
10343 /* USG systems forget handlers when they are used;
10344 must reestablish each time */
10345 signal (SIGINT
, interrupt_signal
);
10346 signal (SIGQUIT
, interrupt_signal
);
10350 SIGNAL_THREAD_CHECK (signalnum
);
10353 if (!NILP (Vquit_flag
)
10354 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10356 /* If SIGINT isn't blocked, don't let us be interrupted by
10357 another SIGINT, it might be harmful due to non-reentrancy
10358 in I/O functions. */
10359 sigblock (sigmask (SIGINT
));
10362 reset_sys_modes ();
10364 #ifdef SIGTSTP /* Support possible in later USG versions */
10366 * On systems which can suspend the current process and return to the original
10367 * shell, this command causes the user to end up back at the shell.
10368 * The "Auto-save" and "Abort" questions are not asked until
10369 * the user elects to return to emacs, at which point he can save the current
10370 * job and either dump core or continue.
10375 if (sys_suspend () == -1)
10377 printf ("Not running as a subprocess;\n");
10378 printf ("you can continue or abort.\n");
10380 #else /* not VMS */
10381 /* Perhaps should really fork an inferior shell?
10382 But that would not provide any way to get back
10383 to the original shell, ever. */
10384 printf ("No support for stopping a process on this operating system;\n");
10385 printf ("you can continue or abort.\n");
10386 #endif /* not VMS */
10387 #endif /* not SIGTSTP */
10389 /* We must remain inside the screen area when the internal terminal
10390 is used. Note that [Enter] is not echoed by dos. */
10393 /* It doesn't work to autosave while GC is in progress;
10394 the code used for auto-saving doesn't cope with the mark bit. */
10395 if (!gc_in_progress
)
10397 printf ("Auto-save? (y or n) ");
10399 if (((c
= getchar ()) & ~040) == 'Y')
10401 Fdo_auto_save (Qt
, Qnil
);
10403 printf ("\r\nAuto-save done");
10404 #else /* not MSDOS */
10405 printf ("Auto-save done\n");
10406 #endif /* not MSDOS */
10408 while (c
!= '\n') c
= getchar ();
10412 /* During GC, it must be safe to reenable quitting again. */
10413 Vinhibit_quit
= Qnil
;
10416 #endif /* not MSDOS */
10417 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10418 printf ("but will instead do a real quit after garbage collection ends\r\n");
10423 printf ("\r\nAbort? (y or n) ");
10424 #else /* not MSDOS */
10426 printf ("Abort (and enter debugger)? (y or n) ");
10427 #else /* not VMS */
10428 printf ("Abort (and dump core)? (y or n) ");
10429 #endif /* not VMS */
10430 #endif /* not MSDOS */
10432 if (((c
= getchar ()) & ~040) == 'Y')
10434 while (c
!= '\n') c
= getchar ();
10436 printf ("\r\nContinuing...\r\n");
10437 #else /* not MSDOS */
10438 printf ("Continuing...\n");
10439 #endif /* not MSDOS */
10446 /* If executing a function that wants to be interrupted out of
10447 and the user has not deferred quitting by binding `inhibit-quit'
10448 then quit right away. */
10449 if (immediate_quit
&& NILP (Vinhibit_quit
))
10451 struct gl_state_s saved
;
10452 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10454 immediate_quit
= 0;
10457 GCPRO4 (saved
.object
, saved
.global_code
,
10458 saved
.current_syntax_table
, saved
.old_prop
);
10459 Fsignal (Qquit
, Qnil
);
10464 /* Else request quit when it's safe */
10468 if (waiting_for_input
&& !echoing
)
10469 quit_throw_to_read_char ();
10474 /* Handle a C-g by making read_char return C-g. */
10477 quit_throw_to_read_char ()
10480 /* Prevent another signal from doing this before we finish. */
10481 clear_waiting_for_input ();
10484 Vunread_command_events
= Qnil
;
10485 unread_command_char
= -1;
10487 #if 0 /* Currently, sit_for is called from read_char without turning
10488 off polling. And that can call set_waiting_for_input.
10489 It seems to be harmless. */
10490 #ifdef POLL_FOR_INPUT
10491 /* May be > 1 if in recursive minibuffer. */
10492 if (poll_suppress_count
== 0)
10496 if (FRAMEP (internal_last_event_frame
)
10497 && !EQ (internal_last_event_frame
, selected_frame
))
10498 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10501 _longjmp (getcjmp
, 1);
10504 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10505 doc
: /* Set mode of reading keyboard input.
10506 First arg INTERRUPT non-nil means use input interrupts;
10507 nil means use CBREAK mode.
10508 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10509 (no effect except in CBREAK mode).
10510 Third arg META t means accept 8-bit input (for a Meta key).
10511 META nil means ignore the top bit, on the assumption it is parity.
10512 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10513 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10514 See also `current-input-mode'. */)
10515 (interrupt
, flow
, meta
, quit
)
10516 Lisp_Object interrupt
, flow
, meta
, quit
;
10519 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10520 error ("set-input-mode: QUIT must be an ASCII character");
10522 #ifdef POLL_FOR_INPUT
10527 /* this causes startup screen to be restored and messes with the mouse */
10528 reset_sys_modes ();
10532 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10533 if (read_socket_hook
)
10535 /* When using X, don't give the user a real choice,
10536 because we haven't implemented the mechanisms to support it. */
10537 #ifdef NO_SOCK_SIGIO
10538 interrupt_input
= 0;
10539 #else /* not NO_SOCK_SIGIO */
10540 interrupt_input
= 1;
10541 #endif /* NO_SOCK_SIGIO */
10544 interrupt_input
= !NILP (interrupt
);
10545 #else /* not SIGIO */
10546 interrupt_input
= 0;
10547 #endif /* not SIGIO */
10549 /* Our VMS input only works by interrupts, as of now. */
10551 interrupt_input
= 1;
10554 flow_control
= !NILP (flow
);
10557 else if (EQ (meta
, Qt
))
10562 /* Don't let this value be out of range. */
10563 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10569 #ifdef POLL_FOR_INPUT
10570 poll_suppress_count
= 1;
10576 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10577 doc
: /* Return information about the way Emacs currently reads keyboard input.
10578 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10579 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10580 nil, Emacs is using CBREAK mode.
10581 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10582 terminal; this does not apply if Emacs uses interrupt-driven input.
10583 META is t if accepting 8-bit input with 8th bit as Meta flag.
10584 META nil means ignoring the top bit, on the assumption it is parity.
10585 META is neither t nor nil if accepting 8-bit input and using
10586 all 8 bits as the character code.
10587 QUIT is the character Emacs currently uses to quit.
10588 The elements of this list correspond to the arguments of
10589 `set-input-mode'. */)
10592 Lisp_Object val
[4];
10594 val
[0] = interrupt_input
? Qt
: Qnil
;
10595 val
[1] = flow_control
? Qt
: Qnil
;
10596 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10597 XSETFASTINT (val
[3], quit_char
);
10599 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10602 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10603 doc
: /* Return position information for pixel coordinates X and Y.
10604 By default, X and Y are relative to text area of the selected window.
10605 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10606 If optional fourth arg WHOLE is non-nil, X is relative to the left
10607 edge of the window.
10609 The return value is similar to a mouse click position:
10610 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10611 IMAGE (DX . DY) (WIDTH . HEIGHT))
10612 The `posn-' functions access elements of such lists. */)
10613 (x
, y
, frame_or_window
, whole
)
10614 Lisp_Object x
, y
, frame_or_window
, whole
;
10619 if (NILP (frame_or_window
))
10620 frame_or_window
= selected_window
;
10622 if (WINDOWP (frame_or_window
))
10626 CHECK_LIVE_WINDOW (frame_or_window
);
10628 w
= XWINDOW (frame_or_window
);
10629 XSETINT (x
, (XINT (x
)
10630 + WINDOW_LEFT_EDGE_X (w
)
10632 ? window_box_left_offset (w
, TEXT_AREA
)
10634 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10635 frame_or_window
= w
->frame
;
10638 CHECK_LIVE_FRAME (frame_or_window
);
10640 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10643 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10644 doc
: /* Return position information for buffer POS in WINDOW.
10645 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10647 Return nil if position is not visible in window. Otherwise,
10648 the return value is similar to that returned by `event-start' for
10649 a mouse click at the upper left corner of the glyph corresponding
10650 to the given buffer position:
10651 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10652 IMAGE (DX . DY) (WIDTH . HEIGHT))
10653 The `posn-' functions access elements of such lists. */)
10655 Lisp_Object pos
, window
;
10660 window
= selected_window
;
10662 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10665 Lisp_Object x
= XCAR (tem
);
10666 Lisp_Object y
= XCAR (XCDR (tem
));
10668 /* Point invisible due to hscrolling? */
10671 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10679 * Set up a new kboard object with reasonable initial values.
10685 kb
->Voverriding_terminal_local_map
= Qnil
;
10686 kb
->Vlast_command
= Qnil
;
10687 kb
->Vreal_last_command
= Qnil
;
10688 kb
->Vprefix_arg
= Qnil
;
10689 kb
->Vlast_prefix_arg
= Qnil
;
10690 kb
->kbd_queue
= Qnil
;
10691 kb
->kbd_queue_has_data
= 0;
10692 kb
->immediate_echo
= 0;
10693 kb
->echo_string
= Qnil
;
10694 kb
->echo_after_prompt
= -1;
10695 kb
->kbd_macro_buffer
= 0;
10696 kb
->kbd_macro_bufsize
= 0;
10697 kb
->defining_kbd_macro
= Qnil
;
10698 kb
->Vlast_kbd_macro
= Qnil
;
10699 kb
->reference_count
= 0;
10700 kb
->Vsystem_key_alist
= Qnil
;
10701 kb
->system_key_syms
= Qnil
;
10702 kb
->Vdefault_minibuffer_frame
= Qnil
;
10706 * Destroy the contents of a kboard object, but not the object itself.
10707 * We use this just before deleting it, or if we're going to initialize
10708 * it a second time.
10714 if (kb
->kbd_macro_buffer
)
10715 xfree (kb
->kbd_macro_buffer
);
10718 #ifdef MULTI_KBOARD
10720 /* Free KB and memory referenced from it. */
10728 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10731 *kbp
= kb
->next_kboard
;
10733 /* Prevent a dangling reference to KB. */
10734 if (kb
== current_kboard
10735 && FRAMEP (selected_frame
)
10736 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10738 current_kboard
= XFRAME (selected_frame
)->kboard
;
10739 if (current_kboard
== kb
)
10747 #endif /* MULTI_KBOARD */
10752 /* This is correct before outermost invocation of the editor loop */
10753 command_loop_level
= -1;
10754 immediate_quit
= 0;
10755 quit_char
= Ctl ('g');
10756 Vunread_command_events
= Qnil
;
10757 unread_command_char
= -1;
10758 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10760 recent_keys_index
= 0;
10761 kbd_fetch_ptr
= kbd_buffer
;
10762 kbd_store_ptr
= kbd_buffer
;
10764 do_mouse_tracking
= Qnil
;
10768 /* This means that command_loop_1 won't try to select anything the first
10770 internal_last_event_frame
= Qnil
;
10771 Vlast_event_frame
= internal_last_event_frame
;
10773 #ifdef MULTI_KBOARD
10774 current_kboard
= initial_kboard
;
10776 wipe_kboard (current_kboard
);
10777 init_kboard (current_kboard
);
10779 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10781 signal (SIGINT
, interrupt_signal
);
10782 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10783 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10784 SIGQUIT and we can't tell which one it will give us. */
10785 signal (SIGQUIT
, interrupt_signal
);
10786 #endif /* HAVE_TERMIO */
10788 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10790 if (!noninteractive
)
10791 signal (SIGIO
, input_available_signal
);
10794 /* Use interrupt input by default, if it works and noninterrupt input
10795 has deficiencies. */
10797 #ifdef INTERRUPT_INPUT
10798 interrupt_input
= 1;
10800 interrupt_input
= 0;
10803 /* Our VMS input only works by interrupts, as of now. */
10805 interrupt_input
= 1;
10811 if (keyboard_init_hook
)
10812 (*keyboard_init_hook
) ();
10814 #ifdef POLL_FOR_INPUT
10815 poll_suppress_count
= 1;
10820 /* This type's only use is in syms_of_keyboard, to initialize the
10821 event header symbols and put properties on them. */
10822 struct event_head
{
10828 struct event_head head_table
[] = {
10829 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10830 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10831 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10832 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10833 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10834 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10835 /* `select-window' should be handled just like `switch-frame'
10836 in read_key_sequence. */
10837 {&Qselect_window
, "select-window", &Qswitch_frame
}
10841 syms_of_keyboard ()
10843 Vpre_help_message
= Qnil
;
10844 staticpro (&Vpre_help_message
);
10846 Vlispy_mouse_stem
= build_string ("mouse");
10847 staticpro (&Vlispy_mouse_stem
);
10850 QCimage
= intern (":image");
10851 staticpro (&QCimage
);
10853 staticpro (&Qhelp_echo
);
10854 Qhelp_echo
= intern ("help-echo");
10856 staticpro (&item_properties
);
10857 item_properties
= Qnil
;
10859 staticpro (&tool_bar_item_properties
);
10860 tool_bar_item_properties
= Qnil
;
10861 staticpro (&tool_bar_items_vector
);
10862 tool_bar_items_vector
= Qnil
;
10864 staticpro (&real_this_command
);
10865 real_this_command
= Qnil
;
10867 Qtimer_event_handler
= intern ("timer-event-handler");
10868 staticpro (&Qtimer_event_handler
);
10870 Qdisabled_command_function
= intern ("disabled-command-function");
10871 staticpro (&Qdisabled_command_function
);
10873 Qself_insert_command
= intern ("self-insert-command");
10874 staticpro (&Qself_insert_command
);
10876 Qforward_char
= intern ("forward-char");
10877 staticpro (&Qforward_char
);
10879 Qbackward_char
= intern ("backward-char");
10880 staticpro (&Qbackward_char
);
10882 Qdisabled
= intern ("disabled");
10883 staticpro (&Qdisabled
);
10885 Qundefined
= intern ("undefined");
10886 staticpro (&Qundefined
);
10888 Qpre_command_hook
= intern ("pre-command-hook");
10889 staticpro (&Qpre_command_hook
);
10891 Qpost_command_hook
= intern ("post-command-hook");
10892 staticpro (&Qpost_command_hook
);
10894 Qdeferred_action_function
= intern ("deferred-action-function");
10895 staticpro (&Qdeferred_action_function
);
10897 Qcommand_hook_internal
= intern ("command-hook-internal");
10898 staticpro (&Qcommand_hook_internal
);
10900 Qfunction_key
= intern ("function-key");
10901 staticpro (&Qfunction_key
);
10902 Qmouse_click
= intern ("mouse-click");
10903 staticpro (&Qmouse_click
);
10904 #if defined (WINDOWSNT) || defined (MAC_OS)
10905 Qlanguage_change
= intern ("language-change");
10906 staticpro (&Qlanguage_change
);
10908 Qdrag_n_drop
= intern ("drag-n-drop");
10909 staticpro (&Qdrag_n_drop
);
10911 Qsave_session
= intern ("save-session");
10912 staticpro (&Qsave_session
);
10915 Qmac_apple_event
= intern ("mac-apple-event");
10916 staticpro (&Qmac_apple_event
);
10919 Qusr1_signal
= intern ("usr1-signal");
10920 staticpro (&Qusr1_signal
);
10921 Qusr2_signal
= intern ("usr2-signal");
10922 staticpro (&Qusr2_signal
);
10924 Qmenu_enable
= intern ("menu-enable");
10925 staticpro (&Qmenu_enable
);
10926 Qmenu_alias
= intern ("menu-alias");
10927 staticpro (&Qmenu_alias
);
10928 QCenable
= intern (":enable");
10929 staticpro (&QCenable
);
10930 QCvisible
= intern (":visible");
10931 staticpro (&QCvisible
);
10932 QChelp
= intern (":help");
10933 staticpro (&QChelp
);
10934 QCfilter
= intern (":filter");
10935 staticpro (&QCfilter
);
10936 QCbutton
= intern (":button");
10937 staticpro (&QCbutton
);
10938 QCkeys
= intern (":keys");
10939 staticpro (&QCkeys
);
10940 QCkey_sequence
= intern (":key-sequence");
10941 staticpro (&QCkey_sequence
);
10942 QCtoggle
= intern (":toggle");
10943 staticpro (&QCtoggle
);
10944 QCradio
= intern (":radio");
10945 staticpro (&QCradio
);
10947 Qmode_line
= intern ("mode-line");
10948 staticpro (&Qmode_line
);
10949 Qvertical_line
= intern ("vertical-line");
10950 staticpro (&Qvertical_line
);
10951 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10952 staticpro (&Qvertical_scroll_bar
);
10953 Qmenu_bar
= intern ("menu-bar");
10954 staticpro (&Qmenu_bar
);
10957 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
10958 staticpro (&Qmouse_fixup_help_message
);
10961 Qabove_handle
= intern ("above-handle");
10962 staticpro (&Qabove_handle
);
10963 Qhandle
= intern ("handle");
10964 staticpro (&Qhandle
);
10965 Qbelow_handle
= intern ("below-handle");
10966 staticpro (&Qbelow_handle
);
10967 Qup
= intern ("up");
10969 Qdown
= intern ("down");
10970 staticpro (&Qdown
);
10971 Qtop
= intern ("top");
10973 Qbottom
= intern ("bottom");
10974 staticpro (&Qbottom
);
10975 Qend_scroll
= intern ("end-scroll");
10976 staticpro (&Qend_scroll
);
10977 Qratio
= intern ("ratio");
10978 staticpro (&Qratio
);
10980 Qevent_kind
= intern ("event-kind");
10981 staticpro (&Qevent_kind
);
10982 Qevent_symbol_elements
= intern ("event-symbol-elements");
10983 staticpro (&Qevent_symbol_elements
);
10984 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10985 staticpro (&Qevent_symbol_element_mask
);
10986 Qmodifier_cache
= intern ("modifier-cache");
10987 staticpro (&Qmodifier_cache
);
10989 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10990 staticpro (&Qrecompute_lucid_menubar
);
10991 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10992 staticpro (&Qactivate_menubar_hook
);
10994 Qpolling_period
= intern ("polling-period");
10995 staticpro (&Qpolling_period
);
10997 Qinput_method_function
= intern ("input-method-function");
10998 staticpro (&Qinput_method_function
);
11000 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11001 staticpro (&Qinput_method_exit_on_first_char
);
11002 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11003 staticpro (&Qinput_method_use_echo_area
);
11005 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11006 Fset (Qinput_method_use_echo_area
, Qnil
);
11008 last_point_position_buffer
= Qnil
;
11009 last_point_position_window
= Qnil
;
11012 struct event_head
*p
;
11014 for (p
= head_table
;
11015 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11018 *p
->var
= intern (p
->name
);
11019 staticpro (p
->var
);
11020 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11021 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11025 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11026 staticpro (&button_down_location
);
11027 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11028 staticpro (&mouse_syms
);
11029 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11030 staticpro (&wheel_syms
);
11034 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11036 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11037 for (i
= 0; i
< len
; i
++)
11038 if (modifier_names
[i
])
11039 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11040 staticpro (&modifier_symbols
);
11043 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11044 staticpro (&recent_keys
);
11046 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11047 staticpro (&this_command_keys
);
11049 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11050 staticpro (&raw_keybuf
);
11052 Qextended_command_history
= intern ("extended-command-history");
11053 Fset (Qextended_command_history
, Qnil
);
11054 staticpro (&Qextended_command_history
);
11056 accent_key_syms
= Qnil
;
11057 staticpro (&accent_key_syms
);
11059 func_key_syms
= Qnil
;
11060 staticpro (&func_key_syms
);
11062 drag_n_drop_syms
= Qnil
;
11063 staticpro (&drag_n_drop_syms
);
11065 unread_switch_frame
= Qnil
;
11066 staticpro (&unread_switch_frame
);
11068 internal_last_event_frame
= Qnil
;
11069 staticpro (&internal_last_event_frame
);
11071 read_key_sequence_cmd
= Qnil
;
11072 staticpro (&read_key_sequence_cmd
);
11074 menu_bar_one_keymap_changed_items
= Qnil
;
11075 staticpro (&menu_bar_one_keymap_changed_items
);
11077 menu_bar_items_vector
= Qnil
;
11078 staticpro (&menu_bar_items_vector
);
11080 defsubr (&Sevent_convert_list
);
11081 defsubr (&Sread_key_sequence
);
11082 defsubr (&Sread_key_sequence_vector
);
11083 defsubr (&Srecursive_edit
);
11085 defsubr (&Strack_mouse
);
11087 defsubr (&Sinput_pending_p
);
11088 defsubr (&Scommand_execute
);
11089 defsubr (&Srecent_keys
);
11090 defsubr (&Sthis_command_keys
);
11091 defsubr (&Sthis_command_keys_vector
);
11092 defsubr (&Sthis_single_command_keys
);
11093 defsubr (&Sthis_single_command_raw_keys
);
11094 defsubr (&Sreset_this_command_lengths
);
11095 defsubr (&Sclear_this_command_keys
);
11096 defsubr (&Ssuspend_emacs
);
11097 defsubr (&Sabort_recursive_edit
);
11098 defsubr (&Sexit_recursive_edit
);
11099 defsubr (&Srecursion_depth
);
11100 defsubr (&Stop_level
);
11101 defsubr (&Sdiscard_input
);
11102 defsubr (&Sopen_dribble_file
);
11103 defsubr (&Sset_input_mode
);
11104 defsubr (&Scurrent_input_mode
);
11105 defsubr (&Sexecute_extended_command
);
11106 defsubr (&Sposn_at_point
);
11107 defsubr (&Sposn_at_x_y
);
11109 DEFVAR_LISP ("last-command-char", &last_command_char
,
11110 doc
: /* Last input event that was part of a command. */);
11112 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11113 doc
: /* Last input event that was part of a command. */);
11115 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11116 doc
: /* Last input event in a command, except for mouse menu events.
11117 Mouse menus give back keys that don't look like mouse events;
11118 this variable holds the actual mouse event that led to the menu,
11119 so that you can determine whether the command was run by mouse or not. */);
11121 DEFVAR_LISP ("last-input-char", &last_input_char
,
11122 doc
: /* Last input event. */);
11124 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11125 doc
: /* Last input event. */);
11127 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11128 doc
: /* List of events to be read as the command input.
11129 These events are processed first, before actual keyboard input. */);
11130 Vunread_command_events
= Qnil
;
11132 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11133 doc
: /* If not -1, an object to be read as next command input event. */);
11135 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11136 doc
: /* List of events to be processed as input by input methods.
11137 These events are processed after `unread-command-events', but
11138 before actual keyboard input. */);
11139 Vunread_post_input_method_events
= Qnil
;
11141 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11142 doc
: /* List of events to be processed as input by input methods.
11143 These events are processed after `unread-command-events', but
11144 before actual keyboard input. */);
11145 Vunread_input_method_events
= Qnil
;
11147 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11148 doc
: /* Meta-prefix character code.
11149 Meta-foo as command input turns into this character followed by foo. */);
11150 XSETINT (meta_prefix_char
, 033);
11152 DEFVAR_KBOARD ("last-command", Vlast_command
,
11153 doc
: /* The last command executed.
11154 Normally a symbol with a function definition, but can be whatever was found
11155 in the keymap, or whatever the variable `this-command' was set to by that
11158 The value `mode-exit' is special; it means that the previous command
11159 read an event that told it to exit, and it did so and unread that event.
11160 In other words, the present command is the event that made the previous
11163 The value `kill-region' is special; it means that the previous command
11164 was a kill command. */);
11166 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11167 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11169 DEFVAR_LISP ("this-command", &Vthis_command
,
11170 doc
: /* The command now being executed.
11171 The command can set this variable; whatever is put here
11172 will be in `last-command' during the following command. */);
11173 Vthis_command
= Qnil
;
11175 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11176 doc
: /* The command bound to the current key sequence before remapping.
11177 It equals `this-command' if the original command was not remapped through
11178 any of the active keymaps. Otherwise, the value of `this-command' is the
11179 result of looking up the original command in the active keymaps. */);
11180 Vthis_original_command
= Qnil
;
11182 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11183 doc
: /* *Number of input events between auto-saves.
11184 Zero means disable autosaving due to number of characters typed. */);
11185 auto_save_interval
= 300;
11187 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11188 doc
: /* *Number of seconds idle time before auto-save.
11189 Zero or nil means disable auto-saving due to idleness.
11190 After auto-saving due to this many seconds of idle time,
11191 Emacs also does a garbage collection if that seems to be warranted. */);
11192 XSETFASTINT (Vauto_save_timeout
, 30);
11194 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11195 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11196 The value may be integer or floating point. */);
11197 Vecho_keystrokes
= make_number (1);
11199 DEFVAR_INT ("polling-period", &polling_period
,
11200 doc
: /* *Interval between polling for input during Lisp execution.
11201 The reason for polling is to make C-g work to stop a running program.
11202 Polling is needed only when using X windows and SIGIO does not work.
11203 Polling is automatically disabled in all other cases. */);
11204 polling_period
= 2;
11206 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11207 doc
: /* *Maximum time between mouse clicks to make a double-click.
11208 Measured in milliseconds. nil means disable double-click recognition;
11209 t means double-clicks have no time limit and are detected
11210 by position only. */);
11211 Vdouble_click_time
= make_number (500);
11213 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11214 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11215 On window-system frames, value is the number of pixels the mouse may have
11216 moved horizontally or vertically between two clicks to make a double-click.
11217 On non window-system frames, value is interpreted in units of 1/8 characters
11220 This variable is also the threshold for motion of the mouse
11221 to count as a drag. */);
11222 double_click_fuzz
= 3;
11224 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11225 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11226 inhibit_local_menu_bar_menus
= 0;
11228 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11229 doc
: /* Number of complete key sequences read as input so far.
11230 This includes key sequences read from keyboard macros.
11231 The number is effectively the number of interactive command invocations. */);
11232 num_input_keys
= 0;
11234 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11235 doc
: /* Number of input events read from the keyboard so far.
11236 This does not include events generated by keyboard macros. */);
11237 num_nonmacro_input_events
= 0;
11239 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11240 doc
: /* The frame in which the most recently read event occurred.
11241 If the last event came from a keyboard macro, this is set to `macro'. */);
11242 Vlast_event_frame
= Qnil
;
11244 /* This variable is set up in sysdep.c. */
11245 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11246 doc
: /* The ERASE character as set by the user with stty. */);
11248 DEFVAR_LISP ("help-char", &Vhelp_char
,
11249 doc
: /* Character to recognize as meaning Help.
11250 When it is read, do `(eval help-form)', and display result if it's a string.
11251 If the value of `help-form' is nil, this char can be read normally. */);
11252 XSETINT (Vhelp_char
, Ctl ('H'));
11254 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11255 doc
: /* List of input events to recognize as meaning Help.
11256 These work just like the value of `help-char' (see that). */);
11257 Vhelp_event_list
= Qnil
;
11259 DEFVAR_LISP ("help-form", &Vhelp_form
,
11260 doc
: /* Form to execute when character `help-char' is read.
11261 If the form returns a string, that string is displayed.
11262 If `help-form' is nil, the help char is not recognized. */);
11265 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11266 doc
: /* Command to run when `help-char' character follows a prefix key.
11267 This command is used only when there is no actual binding
11268 for that character after that prefix key. */);
11269 Vprefix_help_command
= Qnil
;
11271 DEFVAR_LISP ("top-level", &Vtop_level
,
11272 doc
: /* Form to evaluate when Emacs starts up.
11273 Useful to set before you dump a modified Emacs. */);
11276 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11277 doc
: /* Translate table for keyboard input, or nil.
11278 If non-nil, the value should be a char-table. Each character read
11279 from the keyboard is looked up in this char-table. If the value found
11280 there is non-nil, then it is used instead of the actual input character.
11282 The value can also be a string or vector, but this is considered obsolete.
11283 If it is a string or vector of length N, character codes N and up are left
11284 untranslated. In a vector, an element which is nil means "no translation".
11286 This is applied to the characters supplied to input methods, not their
11287 output. See also `translation-table-for-input'. */);
11288 Vkeyboard_translate_table
= Qnil
;
11290 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11291 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11292 \(Even if the operating system has support for stopping a process.\) */);
11293 cannot_suspend
= 0;
11295 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11296 doc
: /* Non-nil means prompt with menus when appropriate.
11297 This is done when reading from a keymap that has a prompt string,
11298 for elements that have prompt strings.
11299 The menu is displayed on the screen
11300 if X menus were enabled at configuration
11301 time and the previous event was a mouse click prefix key.
11302 Otherwise, menu prompting uses the echo area. */);
11303 menu_prompting
= 1;
11305 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11306 doc
: /* Character to see next line of menu prompt.
11307 Type this character while in a menu prompt to rotate around the lines of it. */);
11308 XSETINT (menu_prompt_more_char
, ' ');
11310 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11311 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11312 Emacs applies the modifiers of the character stored here to each keyboard
11313 character it reads. For example, after evaluating the expression
11314 (setq extra-keyboard-modifiers ?\\C-x)
11315 all input characters will have the control modifier applied to them.
11317 Note that the character ?\\C-@, equivalent to the integer zero, does
11318 not count as a control character; rather, it counts as a character
11319 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11320 cancels any modification. */);
11321 extra_keyboard_modifiers
= 0;
11323 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11324 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11325 The command loop sets this to nil before each command,
11326 and tests the value when the command returns.
11327 Buffer modification stores t in this variable. */);
11328 Vdeactivate_mark
= Qnil
;
11330 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11331 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11332 Vcommand_hook_internal
= Qnil
;
11334 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11335 doc
: /* Normal hook run before each command is executed.
11336 If an unhandled error happens in running this hook,
11337 the hook value is set to nil, since otherwise the error
11338 might happen repeatedly and make Emacs nonfunctional. */);
11339 Vpre_command_hook
= Qnil
;
11341 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11342 doc
: /* Normal hook run after each command is executed.
11343 If an unhandled error happens in running this hook,
11344 the hook value is set to nil, since otherwise the error
11345 might happen repeatedly and make Emacs nonfunctional. */);
11346 Vpost_command_hook
= Qnil
;
11349 DEFVAR_LISP ("echo-area-clear-hook", ...,
11350 doc
: /* Normal hook run when clearing the echo area. */);
11352 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11353 staticpro (&Qecho_area_clear_hook
);
11354 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11356 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11357 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11358 Vlucid_menu_bar_dirty_flag
= Qnil
;
11360 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11361 doc
: /* List of menu bar items to move to the end of the menu bar.
11362 The elements of the list are event types that may have menu bar bindings. */);
11363 Vmenu_bar_final_items
= Qnil
;
11365 DEFVAR_KBOARD ("overriding-terminal-local-map",
11366 Voverriding_terminal_local_map
,
11367 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11368 If this variable is non-nil, it is used as a keymap instead of the
11369 buffer's local map, and the minor mode keymaps and text property keymaps.
11370 It also replaces `overriding-local-map'.
11372 This variable is intended to let commands such as `universal-argument'
11373 set up a different keymap for reading the next command. */);
11375 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11376 doc
: /* Keymap that overrides all other local keymaps.
11377 If this variable is non-nil, it is used as a keymap--replacing the
11378 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11379 Voverriding_local_map
= Qnil
;
11381 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11382 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11383 Otherwise, the menu bar continues to reflect the buffer's local map
11384 and the minor mode maps regardless of `overriding-local-map'. */);
11385 Voverriding_local_map_menu_flag
= Qnil
;
11387 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11388 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11389 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11391 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11392 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11394 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11395 doc
: /* Alist of system-specific X windows key symbols.
11396 Each element should have the form (N . SYMBOL) where N is the
11397 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11398 and SYMBOL is its name. */);
11400 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11401 doc
: /* List of deferred actions to be performed at a later time.
11402 The precise format isn't relevant here; we just check whether it is nil. */);
11403 Vdeferred_action_list
= Qnil
;
11405 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11406 doc
: /* Function to call to handle deferred actions, after each command.
11407 This function is called with no arguments after each command
11408 whenever `deferred-action-list' is non-nil. */);
11409 Vdeferred_action_function
= Qnil
;
11411 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11412 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11413 The value can be a length of time to show the message for.
11414 If the value is non-nil and not a number, we wait 2 seconds. */);
11415 Vsuggest_key_bindings
= Qt
;
11417 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11418 doc
: /* List of active absolute time timers in order of increasing time. */);
11419 Vtimer_list
= Qnil
;
11421 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11422 doc
: /* List of active idle-time timers in order of increasing time. */);
11423 Vtimer_idle_list
= Qnil
;
11425 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11426 doc
: /* If non-nil, the function that implements the current input method.
11427 It's called with one argument, a printing character that was just read.
11428 \(That means a character with code 040...0176.)
11429 Typically this function uses `read-event' to read additional events.
11430 When it does so, it should first bind `input-method-function' to nil
11431 so it will not be called recursively.
11433 The function should return a list of zero or more events
11434 to be used as input. If it wants to put back some events
11435 to be reconsidered, separately, by the input method,
11436 it can add them to the beginning of `unread-command-events'.
11438 The input method function can find in `input-method-previous-method'
11439 the previous echo area message.
11441 The input method function should refer to the variables
11442 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11443 for guidance on what to do. */);
11444 Vinput_method_function
= Qnil
;
11446 DEFVAR_LISP ("input-method-previous-message",
11447 &Vinput_method_previous_message
,
11448 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11449 This variable exists because `read-event' clears the echo area
11450 before running the input method. It is nil if there was no message. */);
11451 Vinput_method_previous_message
= Qnil
;
11453 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11454 doc
: /* If non-nil, the function that implements the display of help.
11455 It's called with one argument, the help string to display. */);
11456 Vshow_help_function
= Qnil
;
11458 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11459 doc
: /* If non-nil, suppress point adjustment after executing a command.
11461 After a command is executed, if point is moved into a region that has
11462 special properties (e.g. composition, display), we adjust point to
11463 the boundary of the region. But, when a command sets this variable to
11464 non-nil, we suppress the point adjustment.
11466 This variable is set to nil before reading a command, and is checked
11467 just after executing the command. */);
11468 Vdisable_point_adjustment
= Qnil
;
11470 DEFVAR_LISP ("global-disable-point-adjustment",
11471 &Vglobal_disable_point_adjustment
,
11472 doc
: /* *If non-nil, always suppress point adjustment.
11474 The default value is nil, in which case, point adjustment are
11475 suppressed only after special commands that set
11476 `disable-point-adjustment' (which see) to non-nil. */);
11477 Vglobal_disable_point_adjustment
= Qnil
;
11479 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11480 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11481 If the value is not a number, such messages don't time out. */);
11482 Vminibuffer_message_timeout
= make_number (2);
11484 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11485 doc
: /* If non-nil, any keyboard input throws to this symbol.
11486 The value of that variable is passed to `quit-flag' and later causes a
11487 peculiar kind of quitting. */);
11488 Vthrow_on_input
= Qnil
;
11490 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11491 &Venable_disabled_menus_and_buttons
,
11492 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11494 Help functions bind this to allow help on disabled menu items
11495 and tool-bar buttons. */);
11496 Venable_disabled_menus_and_buttons
= Qnil
;
11500 keys_of_keyboard ()
11502 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11503 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11504 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11505 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11506 initial_define_key (meta_map
, 'x', "execute-extended-command");
11508 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11509 "handle-delete-frame");
11510 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11511 current-prefix-arg, as is done in `handle-switch-frame'.
11512 But `handle-switch-frame is not run from the special-map.
11513 Commands from that map are run in a special way that automatically
11514 preserves the prefix-arg. Restoring the prefix arg here is not just
11515 redundant but harmful:
11517 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11518 - after the first prompt, the exit-minibuffer-hook is run which may
11519 iconify a frame and thus push a `iconify-frame' event.
11520 - after running exit-minibuffer-hook, current-prefix-arg is
11521 restored to the non-nil value it had before the prompt.
11522 - we enter the second prompt.
11523 current-prefix-arg is non-nil, prefix-arg is nil.
11524 - before running the first real event, we run the special iconify-frame
11525 event, but we pass the `special' arg to execute-command so
11526 current-prefix-arg and prefix-arg are left untouched.
11527 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11528 - the next key event will have a spuriously non-nil current-prefix-arg. */
11529 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11531 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11533 /* Handling it at such a low-level causes read_key_sequence to get
11534 * confused because it doesn't realize that the current_buffer was
11535 * changed by read_char.
11537 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11538 * "handle-select-window"); */
11539 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11540 "handle-save-session");
11543 /* Mark the pointers in the kboard objects.
11544 Called by the Fgarbage_collector. */
11550 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11552 if (kb
->kbd_macro_buffer
)
11553 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11555 mark_object (kb
->Voverriding_terminal_local_map
);
11556 mark_object (kb
->Vlast_command
);
11557 mark_object (kb
->Vreal_last_command
);
11558 mark_object (kb
->Vprefix_arg
);
11559 mark_object (kb
->Vlast_prefix_arg
);
11560 mark_object (kb
->kbd_queue
);
11561 mark_object (kb
->defining_kbd_macro
);
11562 mark_object (kb
->Vlast_kbd_macro
);
11563 mark_object (kb
->Vsystem_key_alist
);
11564 mark_object (kb
->system_key_syms
);
11565 mark_object (kb
->Vdefault_minibuffer_frame
);
11566 mark_object (kb
->echo_string
);
11569 struct input_event
*event
;
11570 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11572 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11573 event
= kbd_buffer
;
11574 if (event
->kind
!= SELECTION_REQUEST_EVENT
11575 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11577 mark_object (event
->x
);
11578 mark_object (event
->y
);
11580 mark_object (event
->frame_or_window
);
11581 mark_object (event
->arg
);
11586 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11587 (do not change this comment) */