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
)
2981 d
= Faref (Vkeyboard_translate_table
, c
);
2982 /* nil in keyboard-translate-table means no translation. */
2988 /* If this event is a mouse click in the menu bar,
2989 return just menu-bar for now. Modify the mouse click event
2990 so we won't do this twice, then queue it up. */
2991 if (EVENT_HAS_PARAMETERS (c
)
2993 && CONSP (EVENT_START (c
))
2994 && CONSP (XCDR (EVENT_START (c
))))
2998 posn
= POSN_POSN (EVENT_START (c
));
2999 /* Handle menu-bar events:
3000 insert the dummy prefix event `menu-bar'. */
3001 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3003 /* Change menu-bar to (menu-bar) as the event "position". */
3004 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3007 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3012 /* Store these characters into recent_keys, the dribble file if any,
3013 and the keyboard macro being defined, if any. */
3015 if (! NILP (also_record
))
3016 record_char (also_record
);
3018 /* Wipe the echo area.
3019 But first, if we are about to use an input method,
3020 save the echo area contents for it to refer to. */
3022 && ! NILP (Vinput_method_function
)
3023 && (unsigned) XINT (c
) >= ' '
3024 && (unsigned) XINT (c
) != 127
3025 && (unsigned) XINT (c
) < 256)
3027 previous_echo_area_message
= Fcurrent_message ();
3028 Vinput_method_previous_message
= previous_echo_area_message
;
3031 /* Now wipe the echo area, except for help events which do their
3032 own stuff with the echo area. */
3034 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3035 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3037 if (!NILP (echo_area_buffer
[0]))
3038 safe_run_hooks (Qecho_area_clear_hook
);
3039 clear_message (1, 0);
3042 reread_for_input_method
:
3044 /* Pass this to the input method, if appropriate. */
3046 && ! NILP (Vinput_method_function
)
3047 /* Don't run the input method within a key sequence,
3048 after the first event of the key sequence. */
3049 && NILP (prev_event
)
3050 && (unsigned) XINT (c
) >= ' '
3051 && (unsigned) XINT (c
) != 127
3052 && (unsigned) XINT (c
) < 256)
3055 int key_count
, key_count_reset
;
3056 struct gcpro gcpro1
;
3057 int count
= SPECPDL_INDEX ();
3059 /* Save the echo status. */
3060 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3061 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3062 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3063 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3066 if (before_command_restore_flag
)
3068 this_command_key_count
= before_command_key_count_1
;
3069 if (this_command_key_count
< this_single_command_key_start
)
3070 this_single_command_key_start
= this_command_key_count
;
3071 echo_truncate (before_command_echo_length_1
);
3072 before_command_restore_flag
= 0;
3076 /* Save the this_command_keys status. */
3077 key_count
= this_command_key_count
;
3078 key_count_reset
= this_command_key_count_reset
;
3081 keys
= Fcopy_sequence (this_command_keys
);
3086 /* Clear out this_command_keys. */
3087 this_command_key_count
= 0;
3088 this_command_key_count_reset
= 0;
3090 /* Now wipe the echo area. */
3091 if (!NILP (echo_area_buffer
[0]))
3092 safe_run_hooks (Qecho_area_clear_hook
);
3093 clear_message (1, 0);
3096 /* If we are not reading a key sequence,
3097 never use the echo area. */
3100 specbind (Qinput_method_use_echo_area
, Qt
);
3103 /* Call the input method. */
3104 tem
= call1 (Vinput_method_function
, c
);
3106 tem
= unbind_to (count
, tem
);
3108 /* Restore the saved echoing state
3109 and this_command_keys state. */
3110 this_command_key_count
= key_count
;
3111 this_command_key_count_reset
= key_count_reset
;
3113 this_command_keys
= keys
;
3116 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3117 current_kboard
->echo_string
= saved_echo_string
;
3118 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3119 if (saved_immediate_echo
)
3124 /* The input method can return no events. */
3127 /* Bring back the previous message, if any. */
3128 if (! NILP (previous_echo_area_message
))
3129 message_with_string ("%s", previous_echo_area_message
, 0);
3132 /* It returned one event or more. */
3134 Vunread_post_input_method_events
3135 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3140 /* Display help if not echoing. */
3141 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3143 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3144 Lisp_Object help
, object
, position
, window
, tem
;
3146 tem
= Fcdr (XCDR (c
));
3149 window
= Fcar (tem
);
3151 object
= Fcar (tem
);
3153 position
= Fcar (tem
);
3155 show_help_echo (help
, window
, object
, position
, 0);
3157 /* We stopped being idle for this event; undo that. */
3158 timer_resume_idle ();
3162 if (! reread
|| this_command_key_count
== 0
3163 || this_command_key_count_reset
)
3166 /* Don't echo mouse motion events. */
3167 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3168 && NILP (Fzerop (Vecho_keystrokes
))
3169 && ! (EVENT_HAS_PARAMETERS (c
)
3170 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3173 if (! NILP (also_record
))
3174 echo_char (also_record
);
3175 /* Once we reread a character, echoing can happen
3176 the next time we pause to read a new one. */
3177 ok_to_echo_at_next_pause
= current_kboard
;
3180 /* Record this character as part of the current key. */
3181 add_command_key (c
);
3182 if (! NILP (also_record
))
3183 add_command_key (also_record
);
3186 last_input_char
= c
;
3189 /* Process the help character specially if enabled */
3190 if (!NILP (Vhelp_form
) && help_char_p (c
))
3193 count
= SPECPDL_INDEX ();
3195 record_unwind_protect (Fset_window_configuration
,
3196 Fcurrent_window_configuration (Qnil
));
3198 tem0
= Feval (Vhelp_form
);
3200 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3204 c
= read_char (0, 0, 0, Qnil
, 0);
3205 while (BUFFERP (c
));
3206 /* Remove the help from the frame */
3207 unbind_to (count
, Qnil
);
3210 if (EQ (c
, make_number (040)))
3214 c
= read_char (0, 0, 0, Qnil
, 0);
3215 while (BUFFERP (c
));
3224 /* Record a key that came from a mouse menu.
3225 Record it for echoing, for this-command-keys, and so on. */
3231 /* Wipe the echo area. */
3232 clear_message (1, 0);
3237 before_command_key_count
= this_command_key_count
;
3238 before_command_echo_length
= echo_length ();
3241 /* Don't echo mouse motion events. */
3242 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3243 && NILP (Fzerop (Vecho_keystrokes
)))
3247 /* Once we reread a character, echoing can happen
3248 the next time we pause to read a new one. */
3249 ok_to_echo_at_next_pause
= 0;
3252 /* Record this character as part of the current key. */
3253 add_command_key (c
);
3255 /* Re-reading in the middle of a command */
3256 last_input_char
= c
;
3260 /* Return 1 if should recognize C as "the help character". */
3268 if (EQ (c
, Vhelp_char
))
3270 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3271 if (EQ (c
, XCAR (tail
)))
3276 /* Record the input event C in various ways. */
3284 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3286 /* To avoid filling recent_keys with help-echo and mouse-movement
3287 events, we filter out repeated help-echo events, only store the
3288 first and last in a series of mouse-movement events, and don't
3289 store repeated help-echo events which are only separated by
3290 mouse-movement events. */
3292 Lisp_Object ev1
, ev2
, ev3
;
3295 if ((ix1
= recent_keys_index
- 1) < 0)
3296 ix1
= NUM_RECENT_KEYS
- 1;
3297 ev1
= AREF (recent_keys
, ix1
);
3299 if ((ix2
= ix1
- 1) < 0)
3300 ix2
= NUM_RECENT_KEYS
- 1;
3301 ev2
= AREF (recent_keys
, ix2
);
3303 if ((ix3
= ix2
- 1) < 0)
3304 ix3
= NUM_RECENT_KEYS
- 1;
3305 ev3
= AREF (recent_keys
, ix3
);
3307 if (EQ (XCAR (c
), Qhelp_echo
))
3309 /* Don't record `help-echo' in recent_keys unless it shows some help
3310 message, and a different help than the previously recorded
3312 Lisp_Object help
, last_help
;
3314 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3315 if (!STRINGP (help
))
3317 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3318 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3320 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3321 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3322 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3324 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3325 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3326 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3327 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3330 else if (EQ (XCAR (c
), Qmouse_movement
))
3332 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3333 So additional mouse movement events replace the last element. */
3334 Lisp_Object last_window
, window
;
3336 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3337 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3338 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3339 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3340 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3342 ASET (recent_keys
, ix1
, c
);
3348 store_kbd_macro_char (c
);
3353 ASET (recent_keys
, recent_keys_index
, c
);
3354 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3355 recent_keys_index
= 0;
3357 else if (recorded
< 0)
3359 /* We need to remove one or two events from recent_keys.
3360 To do this, we simply put nil at those events and move the
3361 recent_keys_index backwards over those events. Usually,
3362 users will never see those nil events, as they will be
3363 overwritten by the command keys entered to see recent_keys
3366 while (recorded
++ < 0 && total_keys
> 0)
3368 if (total_keys
< NUM_RECENT_KEYS
)
3370 if (--recent_keys_index
< 0)
3371 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3372 ASET (recent_keys
, recent_keys_index
, Qnil
);
3376 num_nonmacro_input_events
++;
3378 /* Write c to the dribble file. If c is a lispy event, write
3379 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3380 If you, dear reader, have a better idea, you've got the source. :-) */
3385 if (XUINT (c
) < 0x100)
3386 putc (XINT (c
), dribble
);
3388 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3392 Lisp_Object dribblee
;
3394 /* If it's a structured event, take the event header. */
3395 dribblee
= EVENT_HEAD (c
);
3397 if (SYMBOLP (dribblee
))
3399 putc ('<', dribble
);
3400 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3401 SBYTES (SYMBOL_NAME (dribblee
)),
3403 putc ('>', dribble
);
3415 struct buffer
*old
= current_buffer
;
3416 Fprinc (object
, Qnil
);
3417 set_buffer_internal (XBUFFER (Vstandard_output
));
3418 call0 (intern ("help-mode"));
3419 set_buffer_internal (old
);
3423 /* Copy out or in the info on where C-g should throw to.
3424 This is used when running Lisp code from within get_char,
3425 in case get_char is called recursively.
3426 See read_process_output. */
3432 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3436 restore_getcjmp (temp
)
3439 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3444 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3445 of this function. */
3448 tracking_off (old_value
)
3449 Lisp_Object old_value
;
3451 do_mouse_tracking
= old_value
;
3452 if (NILP (old_value
))
3454 /* Redisplay may have been preempted because there was input
3455 available, and it assumes it will be called again after the
3456 input has been processed. If the only input available was
3457 the sort that we have just disabled, then we need to call
3459 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3461 redisplay_preserve_echo_area (6);
3462 get_input_pending (&input_pending
,
3463 READABLE_EVENTS_DO_TIMERS_NOW
);
3469 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3470 doc
: /* Evaluate BODY with mouse movement events enabled.
3471 Within a `track-mouse' form, mouse motion generates input events that
3472 you can read with `read-event'.
3473 Normally, mouse motion is ignored.
3474 usage: (track-mouse BODY ...) */)
3478 int count
= SPECPDL_INDEX ();
3481 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3483 do_mouse_tracking
= Qt
;
3485 val
= Fprogn (args
);
3486 return unbind_to (count
, val
);
3489 /* If mouse has moved on some frame, return one of those frames.
3490 Return 0 otherwise. */
3495 Lisp_Object tail
, frame
;
3497 FOR_EACH_FRAME (tail
, frame
)
3499 if (XFRAME (frame
)->mouse_moved
)
3500 return XFRAME (frame
);
3506 #endif /* HAVE_MOUSE */
3508 /* Low level keyboard/mouse input.
3509 kbd_buffer_store_event places events in kbd_buffer, and
3510 kbd_buffer_get_event retrieves them. */
3512 /* Return true iff there are any events in the queue that read-char
3513 would return. If this returns false, a read-char would block. */
3515 readable_events (flags
)
3518 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3521 /* If the buffer contains only FOCUS_IN_EVENT events, and
3522 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3523 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3525 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3526 #ifdef USE_TOOLKIT_SCROLL_BARS
3527 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3531 struct input_event
*event
;
3533 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3540 #ifdef USE_TOOLKIT_SCROLL_BARS
3541 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3543 event
->kind
== FOCUS_IN_EVENT
)
3544 #ifdef USE_TOOLKIT_SCROLL_BARS
3545 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3546 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3547 && event
->part
== scroll_bar_handle
3548 && event
->modifiers
== 0)
3553 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3556 while (event
!= kbd_store_ptr
);
3563 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3564 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3569 if (current_kboard
->kbd_queue_has_data
)
3575 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3576 if (kb
->kbd_queue_has_data
)
3582 /* Set this for debugging, to have a way to get out */
3587 event_to_kboard (event
)
3588 struct input_event
*event
;
3591 frame
= event
->frame_or_window
;
3593 frame
= XCAR (frame
);
3594 else if (WINDOWP (frame
))
3595 frame
= WINDOW_FRAME (XWINDOW (frame
));
3597 /* There are still some events that don't set this field.
3598 For now, just ignore the problem.
3599 Also ignore dead frames here. */
3600 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3603 return FRAME_KBOARD (XFRAME (frame
));
3608 Lisp_Object Vthrow_on_input
;
3610 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3613 kbd_buffer_store_event (event
)
3614 register struct input_event
*event
;
3616 kbd_buffer_store_event_hold (event
, 0);
3619 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3621 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3622 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3623 Else, if EVENT is a quit event, store the quit event
3624 in HOLD_QUIT, and return (thus ignoring further events).
3626 This is used in read_avail_input to postpone the processing
3627 of the quit event until all subsequent input events have been
3628 parsed (and discarded).
3632 kbd_buffer_store_event_hold (event
, hold_quit
)
3633 register struct input_event
*event
;
3634 struct input_event
*hold_quit
;
3636 if (event
->kind
== NO_EVENT
)
3639 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3642 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3644 register int c
= event
->code
& 0377;
3646 if (event
->modifiers
& ctrl_modifier
)
3647 c
= make_ctrl_char (c
);
3649 c
|= (event
->modifiers
3650 & (meta_modifier
| alt_modifier
3651 | hyper_modifier
| super_modifier
));
3657 struct input_event
*sp
;
3660 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3661 kb
!= current_kboard
))
3664 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3665 Fcons (make_number (c
), Qnil
));
3666 kb
->kbd_queue_has_data
= 1;
3667 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3669 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3672 if (event_to_kboard (sp
) == kb
)
3674 sp
->kind
= NO_EVENT
;
3675 sp
->frame_or_window
= Qnil
;
3685 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3689 /* If this results in a quit_char being returned to Emacs as
3690 input, set Vlast_event_frame properly. If this doesn't
3691 get returned to Emacs as an event, the next event read
3692 will set Vlast_event_frame again, so this is safe to do. */
3696 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3698 focus
= event
->frame_or_window
;
3699 internal_last_event_frame
= focus
;
3700 Vlast_event_frame
= focus
;
3703 last_event_timestamp
= event
->timestamp
;
3704 interrupt_signal (0 /* dummy */);
3708 if (c
&& c
== stop_character
)
3714 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3715 Just ignore the second one. */
3716 else if (event
->kind
== BUFFER_SWITCH_EVENT
3717 && kbd_fetch_ptr
!= kbd_store_ptr
3718 && ((kbd_store_ptr
== kbd_buffer
3719 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3720 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3723 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3724 kbd_store_ptr
= kbd_buffer
;
3726 /* Don't let the very last slot in the buffer become full,
3727 since that would make the two pointers equal,
3728 and that is indistinguishable from an empty buffer.
3729 Discard the event if it would fill the last slot. */
3730 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3732 *kbd_store_ptr
= *event
;
3736 /* If we're inside while-no-input, and this event qualifies
3737 as input, set quit-flag to cause an interrupt. */
3738 if (!NILP (Vthrow_on_input
)
3739 && event
->kind
!= FOCUS_IN_EVENT
3740 && event
->kind
!= HELP_EVENT
3741 && event
->kind
!= DEICONIFY_EVENT
)
3743 Vquit_flag
= Vthrow_on_input
;
3744 /* If we're inside a function that wants immediate quits,
3746 if (immediate_quit
&& NILP (Vinhibit_quit
))
3756 /* Put an input event back in the head of the event queue. */
3759 kbd_buffer_unget_event (event
)
3760 register struct input_event
*event
;
3762 if (kbd_fetch_ptr
== kbd_buffer
)
3763 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3765 /* Don't let the very last slot in the buffer become full, */
3766 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3769 *kbd_fetch_ptr
= *event
;
3774 /* Generate HELP_EVENT input_events in BUFP which has room for
3775 SIZE events. If there's not enough room in BUFP, ignore this
3778 HELP is the help form.
3780 FRAME is the frame on which the help is generated. OBJECT is the
3781 Lisp object where the help was found (a buffer, a string, an
3782 overlay, or nil if neither from a string nor from a buffer. POS is
3783 the position within OBJECT where the help was found.
3785 Value is the number of input_events generated. */
3788 gen_help_event (help
, frame
, window
, object
, pos
)
3789 Lisp_Object help
, frame
, object
, window
;
3792 struct input_event event
;
3796 event
.kind
= HELP_EVENT
;
3797 event
.frame_or_window
= frame
;
3799 event
.x
= WINDOWP (window
) ? window
: frame
;
3802 kbd_buffer_store_event (&event
);
3806 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3809 kbd_buffer_store_help_event (frame
, help
)
3810 Lisp_Object frame
, help
;
3812 struct input_event event
;
3814 event
.kind
= HELP_EVENT
;
3815 event
.frame_or_window
= frame
;
3820 kbd_buffer_store_event (&event
);
3824 /* Discard any mouse events in the event buffer by setting them to
3827 discard_mouse_events ()
3829 struct input_event
*sp
;
3830 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3832 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3835 if (sp
->kind
== MOUSE_CLICK_EVENT
3836 || sp
->kind
== WHEEL_EVENT
3838 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3840 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3842 sp
->kind
= NO_EVENT
;
3848 /* Return non-zero if there are any real events waiting in the event
3849 buffer, not counting `NO_EVENT's.
3851 If DISCARD is non-zero, discard NO_EVENT events at the front of
3852 the input queue, possibly leaving the input queue empty if there
3853 are no real input events. */
3856 kbd_buffer_events_waiting (discard
)
3859 struct input_event
*sp
;
3861 for (sp
= kbd_fetch_ptr
;
3862 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3865 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3872 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3876 /* Clear input event EVENT. */
3880 struct input_event
*event
;
3882 event
->kind
= NO_EVENT
;
3886 /* Read one event from the event buffer, waiting if necessary.
3887 The value is a Lisp object representing the event.
3888 The value is nil for an event that should be ignored,
3889 or that was handled here.
3890 We always read and discard one event. */
3893 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3895 int *used_mouse_menu
;
3904 *kbp
= current_kboard
;
3908 /* Wait until there is input available. */
3911 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3914 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3918 /* If the quit flag is set, then read_char will return
3919 quit_char, so that counts as "available input." */
3920 if (!NILP (Vquit_flag
))
3921 quit_throw_to_read_char ();
3923 /* One way or another, wait until input is available; then, if
3924 interrupt handlers have not read it, read it now. */
3927 wait_for_kbd_input ();
3929 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3933 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3936 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3940 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3942 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3943 /* Pass 1 for EXPECT since we just waited to have input. */
3944 read_avail_input (1);
3946 #endif /* not VMS */
3949 if (CONSP (Vunread_command_events
))
3952 first
= XCAR (Vunread_command_events
);
3953 Vunread_command_events
= XCDR (Vunread_command_events
);
3954 *kbp
= current_kboard
;
3958 /* At this point, we know that there is a readable event available
3959 somewhere. If the event queue is empty, then there must be a
3960 mouse movement enabled and available. */
3961 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3963 struct input_event
*event
;
3965 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3969 last_event_timestamp
= event
->timestamp
;
3972 *kbp
= event_to_kboard (event
);
3974 *kbp
= current_kboard
; /* Better than returning null ptr? */
3976 *kbp
= &the_only_kboard
;
3981 /* These two kinds of events get special handling
3982 and don't actually appear to the command loop.
3983 We return nil for them. */
3984 if (event
->kind
== SELECTION_REQUEST_EVENT
3985 || event
->kind
== SELECTION_CLEAR_EVENT
)
3988 struct input_event copy
;
3990 /* Remove it from the buffer before processing it,
3991 since otherwise swallow_events will see it
3992 and process it again. */
3994 kbd_fetch_ptr
= event
+ 1;
3995 input_pending
= readable_events (0);
3996 x_handle_selection_event (©
);
3998 /* We're getting selection request events, but we don't have
4004 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4005 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4007 /* Make an event (delete-frame (FRAME)). */
4008 obj
= Fcons (event
->frame_or_window
, Qnil
);
4009 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4010 kbd_fetch_ptr
= event
+ 1;
4013 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4014 else if (event
->kind
== ICONIFY_EVENT
)
4016 /* Make an event (iconify-frame (FRAME)). */
4017 obj
= Fcons (event
->frame_or_window
, Qnil
);
4018 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4019 kbd_fetch_ptr
= event
+ 1;
4021 else if (event
->kind
== DEICONIFY_EVENT
)
4023 /* Make an event (make-frame-visible (FRAME)). */
4024 obj
= Fcons (event
->frame_or_window
, Qnil
);
4025 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4026 kbd_fetch_ptr
= event
+ 1;
4029 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4031 /* The value doesn't matter here; only the type is tested. */
4032 XSETBUFFER (obj
, current_buffer
);
4033 kbd_fetch_ptr
= event
+ 1;
4035 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4036 || defined (USE_GTK)
4037 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4039 kbd_fetch_ptr
= event
+ 1;
4040 input_pending
= readable_events (0);
4041 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4042 x_activate_menubar (XFRAME (event
->frame_or_window
));
4045 #if defined (WINDOWSNT) || defined (MAC_OS)
4046 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4049 /* Make an event (language-change (KEY_SCRIPT)). */
4050 obj
= Fcons (make_number (event
->code
), Qnil
);
4052 /* Make an event (language-change (FRAME CHARSET LCID)). */
4053 obj
= Fcons (event
->frame_or_window
, Qnil
);
4055 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4056 kbd_fetch_ptr
= event
+ 1;
4059 else if (event
->kind
== SAVE_SESSION_EVENT
)
4061 obj
= Fcons (Qsave_session
, Qnil
);
4062 kbd_fetch_ptr
= event
+ 1;
4064 /* Just discard these, by returning nil.
4065 With MULTI_KBOARD, these events are used as placeholders
4066 when we need to randomly delete events from the queue.
4067 (They shouldn't otherwise be found in the buffer,
4068 but on some machines it appears they do show up
4069 even without MULTI_KBOARD.) */
4070 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4071 mouse events during a popup-menu call. */
4072 else if (event
->kind
== NO_EVENT
)
4073 kbd_fetch_ptr
= event
+ 1;
4074 else if (event
->kind
== HELP_EVENT
)
4076 Lisp_Object object
, position
, help
, frame
, window
;
4078 frame
= event
->frame_or_window
;
4079 object
= event
->arg
;
4080 position
= make_number (event
->code
);
4083 clear_event (event
);
4085 kbd_fetch_ptr
= event
+ 1;
4086 if (!WINDOWP (window
))
4088 obj
= Fcons (Qhelp_echo
,
4089 list5 (frame
, help
, window
, object
, position
));
4091 else if (event
->kind
== FOCUS_IN_EVENT
)
4093 /* Notification of a FocusIn event. The frame receiving the
4094 focus is in event->frame_or_window. Generate a
4095 switch-frame event if necessary. */
4096 Lisp_Object frame
, focus
;
4098 frame
= event
->frame_or_window
;
4099 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4103 if (!EQ (frame
, internal_last_event_frame
)
4104 && !EQ (frame
, selected_frame
))
4105 obj
= make_lispy_switch_frame (frame
);
4106 internal_last_event_frame
= frame
;
4107 kbd_fetch_ptr
= event
+ 1;
4111 /* If this event is on a different frame, return a switch-frame this
4112 time, and leave the event in the queue for next time. */
4116 frame
= event
->frame_or_window
;
4118 frame
= XCAR (frame
);
4119 else if (WINDOWP (frame
))
4120 frame
= WINDOW_FRAME (XWINDOW (frame
));
4122 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4126 if (! EQ (frame
, internal_last_event_frame
)
4127 && !EQ (frame
, selected_frame
))
4128 obj
= make_lispy_switch_frame (frame
);
4129 internal_last_event_frame
= frame
;
4131 /* If we didn't decide to make a switch-frame event, go ahead
4132 and build a real event from the queue entry. */
4136 obj
= make_lispy_event (event
);
4138 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4139 || defined (USE_GTK)
4140 /* If this was a menu selection, then set the flag to inhibit
4141 writing to last_nonmenu_event. Don't do this if the event
4142 we're returning is (menu-bar), though; that indicates the
4143 beginning of the menu sequence, and we might as well leave
4144 that as the `event with parameters' for this selection. */
4146 && !EQ (event
->frame_or_window
, event
->arg
)
4147 && (event
->kind
== MENU_BAR_EVENT
4148 || event
->kind
== TOOL_BAR_EVENT
))
4149 *used_mouse_menu
= 1;
4152 /* Wipe out this event, to catch bugs. */
4153 clear_event (event
);
4154 kbd_fetch_ptr
= event
+ 1;
4159 /* Try generating a mouse motion event. */
4160 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4162 FRAME_PTR f
= some_mouse_moved ();
4163 Lisp_Object bar_window
;
4164 enum scroll_bar_part part
;
4168 *kbp
= current_kboard
;
4169 /* Note that this uses F to determine which display to look at.
4170 If there is no valid info, it does not store anything
4171 so x remains nil. */
4173 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4177 /* Decide if we should generate a switch-frame event. Don't
4178 generate switch-frame events for motion outside of all Emacs
4184 frame
= FRAME_FOCUS_FRAME (f
);
4186 XSETFRAME (frame
, f
);
4188 if (! EQ (frame
, internal_last_event_frame
)
4189 && !EQ (frame
, selected_frame
))
4190 obj
= make_lispy_switch_frame (frame
);
4191 internal_last_event_frame
= frame
;
4194 /* If we didn't decide to make a switch-frame event, go ahead and
4195 return a mouse-motion event. */
4196 if (!NILP (x
) && NILP (obj
))
4197 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4199 #endif /* HAVE_MOUSE */
4201 /* We were promised by the above while loop that there was
4202 something for us to read! */
4205 input_pending
= readable_events (0);
4207 Vlast_event_frame
= internal_last_event_frame
;
4212 /* Process any events that are not user-visible,
4213 then return, without reading any user-visible events. */
4216 swallow_events (do_display
)
4221 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4223 struct input_event
*event
;
4225 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4229 last_event_timestamp
= event
->timestamp
;
4231 /* These two kinds of events get special handling
4232 and don't actually appear to the command loop. */
4233 if (event
->kind
== SELECTION_REQUEST_EVENT
4234 || event
->kind
== SELECTION_CLEAR_EVENT
)
4237 struct input_event copy
;
4239 /* Remove it from the buffer before processing it,
4240 since otherwise swallow_events called recursively could see it
4241 and process it again. */
4243 kbd_fetch_ptr
= event
+ 1;
4244 input_pending
= readable_events (0);
4245 x_handle_selection_event (©
);
4247 /* We're getting selection request events, but we don't have
4256 old_timers_run
= timers_run
;
4257 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4259 if (timers_run
!= old_timers_run
&& do_display
)
4260 redisplay_preserve_echo_area (7);
4263 /* Record the start of when Emacs is idle,
4264 for the sake of running idle-time timers. */
4271 /* If we are already in the idle state, do nothing. */
4272 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4275 EMACS_GET_TIME (timer_idleness_start_time
);
4277 timer_last_idleness_start_time
= timer_idleness_start_time
;
4279 /* Mark all idle-time timers as once again candidates for running. */
4280 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4284 timer
= XCAR (timers
);
4286 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4288 XVECTOR (timer
)->contents
[0] = Qnil
;
4292 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4297 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4300 /* Resume idle timer from last idle start time. */
4303 timer_resume_idle ()
4305 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4308 timer_idleness_start_time
= timer_last_idleness_start_time
;
4311 /* This is only for debugging. */
4312 struct input_event last_timer_event
;
4314 /* Check whether a timer has fired. To prevent larger problems we simply
4315 disregard elements that are not proper timers. Do not make a circular
4316 timer list for the time being.
4318 Returns the number of seconds to wait until the next timer fires. If a
4319 timer is triggering now, return zero seconds.
4320 If no timer is active, return -1 seconds.
4322 If a timer is ripe, we run it, with quitting turned off.
4324 DO_IT_NOW is now ignored. It used to mean that we should
4325 run the timer directly instead of queueing a timer-event.
4326 Now we always run timers directly. */
4329 timer_check (do_it_now
)
4332 EMACS_TIME nexttime
;
4333 EMACS_TIME now
, idleness_now
;
4334 Lisp_Object timers
, idle_timers
, chosen_timer
;
4335 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4337 EMACS_SET_SECS (nexttime
, -1);
4338 EMACS_SET_USECS (nexttime
, -1);
4340 /* Always consider the ordinary timers. */
4341 timers
= Vtimer_list
;
4342 /* Consider the idle timers only if Emacs is idle. */
4343 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4344 idle_timers
= Vtimer_idle_list
;
4347 chosen_timer
= Qnil
;
4348 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4350 if (CONSP (timers
) || CONSP (idle_timers
))
4352 EMACS_GET_TIME (now
);
4353 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4354 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4357 while (CONSP (timers
) || CONSP (idle_timers
))
4359 Lisp_Object
*vector
;
4360 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4361 EMACS_TIME timer_time
, idle_timer_time
;
4362 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4364 /* Skip past invalid timers and timers already handled. */
4367 timer
= XCAR (timers
);
4368 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4370 timers
= XCDR (timers
);
4373 vector
= XVECTOR (timer
)->contents
;
4375 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4376 || !INTEGERP (vector
[3])
4377 || ! NILP (vector
[0]))
4379 timers
= XCDR (timers
);
4383 if (!NILP (idle_timers
))
4385 timer
= XCAR (idle_timers
);
4386 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4388 idle_timers
= XCDR (idle_timers
);
4391 vector
= XVECTOR (timer
)->contents
;
4393 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4394 || !INTEGERP (vector
[3])
4395 || ! NILP (vector
[0]))
4397 idle_timers
= XCDR (idle_timers
);
4402 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4403 based on the next ordinary timer.
4404 TIMER_DIFFERENCE is the distance in time from NOW to when
4405 this timer becomes ripe (negative if it's already ripe). */
4408 timer
= XCAR (timers
);
4409 vector
= XVECTOR (timer
)->contents
;
4410 EMACS_SET_SECS (timer_time
,
4411 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4412 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4413 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4416 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4417 based on the next idle timer. */
4418 if (!NILP (idle_timers
))
4420 idle_timer
= XCAR (idle_timers
);
4421 vector
= XVECTOR (idle_timer
)->contents
;
4422 EMACS_SET_SECS (idle_timer_time
,
4423 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4424 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4425 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4428 /* Decide which timer is the next timer,
4429 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4430 Also step down the list where we found that timer. */
4432 if (! NILP (timers
) && ! NILP (idle_timers
))
4435 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4436 if (EMACS_TIME_NEG_P (temp
))
4438 chosen_timer
= timer
;
4439 timers
= XCDR (timers
);
4440 difference
= timer_difference
;
4444 chosen_timer
= idle_timer
;
4445 idle_timers
= XCDR (idle_timers
);
4446 difference
= idle_timer_difference
;
4449 else if (! NILP (timers
))
4451 chosen_timer
= timer
;
4452 timers
= XCDR (timers
);
4453 difference
= timer_difference
;
4457 chosen_timer
= idle_timer
;
4458 idle_timers
= XCDR (idle_timers
);
4459 difference
= idle_timer_difference
;
4461 vector
= XVECTOR (chosen_timer
)->contents
;
4463 /* If timer is ripe, run it if it hasn't been run. */
4464 if (EMACS_TIME_NEG_P (difference
)
4465 || (EMACS_SECS (difference
) == 0
4466 && EMACS_USECS (difference
) == 0))
4468 if (NILP (vector
[0]))
4470 int was_locked
= single_kboard
;
4471 int count
= SPECPDL_INDEX ();
4472 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4474 /* Mark the timer as triggered to prevent problems if the lisp
4475 code fails to reschedule it right. */
4478 specbind (Qinhibit_quit
, Qt
);
4480 call1 (Qtimer_event_handler
, chosen_timer
);
4481 Vdeactivate_mark
= old_deactivate_mark
;
4483 unbind_to (count
, Qnil
);
4485 /* Resume allowing input from any kboard, if that was true before. */
4487 any_kboard_state ();
4489 /* Since we have handled the event,
4490 we don't need to tell the caller to wake up and do it. */
4494 /* When we encounter a timer that is still waiting,
4495 return the amount of time to wait before it is ripe. */
4502 /* No timers are pending in the future. */
4503 /* Return 0 if we generated an event, and -1 if not. */
4508 /* Caches for modify_event_symbol. */
4509 static Lisp_Object accent_key_syms
;
4510 static Lisp_Object func_key_syms
;
4511 static Lisp_Object mouse_syms
;
4512 static Lisp_Object wheel_syms
;
4513 static Lisp_Object drag_n_drop_syms
;
4515 /* This is a list of keysym codes for special "accent" characters.
4516 It parallels lispy_accent_keys. */
4518 static int lispy_accent_codes
[] =
4520 #ifdef XK_dead_circumflex
4525 #ifdef XK_dead_grave
4530 #ifdef XK_dead_tilde
4535 #ifdef XK_dead_diaeresis
4540 #ifdef XK_dead_macron
4545 #ifdef XK_dead_degree
4550 #ifdef XK_dead_acute
4555 #ifdef XK_dead_cedilla
4560 #ifdef XK_dead_breve
4565 #ifdef XK_dead_ogonek
4570 #ifdef XK_dead_caron
4575 #ifdef XK_dead_doubleacute
4576 XK_dead_doubleacute
,
4580 #ifdef XK_dead_abovedot
4585 #ifdef XK_dead_abovering
4595 #ifdef XK_dead_belowdot
4600 #ifdef XK_dead_voiced_sound
4601 XK_dead_voiced_sound
,
4605 #ifdef XK_dead_semivoiced_sound
4606 XK_dead_semivoiced_sound
,
4622 /* This is a list of Lisp names for special "accent" characters.
4623 It parallels lispy_accent_codes. */
4625 static char *lispy_accent_keys
[] =
4643 "dead-voiced-sound",
4644 "dead-semivoiced-sound",
4650 #define FUNCTION_KEY_OFFSET 0x0
4652 char *lispy_function_keys
[] =
4656 0, /* VK_LBUTTON 0x01 */
4657 0, /* VK_RBUTTON 0x02 */
4658 "cancel", /* VK_CANCEL 0x03 */
4659 0, /* VK_MBUTTON 0x04 */
4661 0, 0, 0, /* 0x05 .. 0x07 */
4663 "backspace", /* VK_BACK 0x08 */
4664 "tab", /* VK_TAB 0x09 */
4666 0, 0, /* 0x0A .. 0x0B */
4668 "clear", /* VK_CLEAR 0x0C */
4669 "return", /* VK_RETURN 0x0D */
4671 0, 0, /* 0x0E .. 0x0F */
4673 0, /* VK_SHIFT 0x10 */
4674 0, /* VK_CONTROL 0x11 */
4675 0, /* VK_MENU 0x12 */
4676 "pause", /* VK_PAUSE 0x13 */
4677 "capslock", /* VK_CAPITAL 0x14 */
4679 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4681 "escape", /* VK_ESCAPE 0x1B */
4683 0, 0, 0, 0, /* 0x1C .. 0x1F */
4685 0, /* VK_SPACE 0x20 */
4686 "prior", /* VK_PRIOR 0x21 */
4687 "next", /* VK_NEXT 0x22 */
4688 "end", /* VK_END 0x23 */
4689 "home", /* VK_HOME 0x24 */
4690 "left", /* VK_LEFT 0x25 */
4691 "up", /* VK_UP 0x26 */
4692 "right", /* VK_RIGHT 0x27 */
4693 "down", /* VK_DOWN 0x28 */
4694 "select", /* VK_SELECT 0x29 */
4695 "print", /* VK_PRINT 0x2A */
4696 "execute", /* VK_EXECUTE 0x2B */
4697 "snapshot", /* VK_SNAPSHOT 0x2C */
4698 "insert", /* VK_INSERT 0x2D */
4699 "delete", /* VK_DELETE 0x2E */
4700 "help", /* VK_HELP 0x2F */
4702 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4704 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4706 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4708 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4710 0, 0, 0, 0, 0, 0, 0, 0, 0,
4711 0, 0, 0, 0, 0, 0, 0, 0, 0,
4712 0, 0, 0, 0, 0, 0, 0, 0,
4714 "lwindow", /* VK_LWIN 0x5B */
4715 "rwindow", /* VK_RWIN 0x5C */
4716 "apps", /* VK_APPS 0x5D */
4718 0, 0, /* 0x5E .. 0x5F */
4720 "kp-0", /* VK_NUMPAD0 0x60 */
4721 "kp-1", /* VK_NUMPAD1 0x61 */
4722 "kp-2", /* VK_NUMPAD2 0x62 */
4723 "kp-3", /* VK_NUMPAD3 0x63 */
4724 "kp-4", /* VK_NUMPAD4 0x64 */
4725 "kp-5", /* VK_NUMPAD5 0x65 */
4726 "kp-6", /* VK_NUMPAD6 0x66 */
4727 "kp-7", /* VK_NUMPAD7 0x67 */
4728 "kp-8", /* VK_NUMPAD8 0x68 */
4729 "kp-9", /* VK_NUMPAD9 0x69 */
4730 "kp-multiply", /* VK_MULTIPLY 0x6A */
4731 "kp-add", /* VK_ADD 0x6B */
4732 "kp-separator", /* VK_SEPARATOR 0x6C */
4733 "kp-subtract", /* VK_SUBTRACT 0x6D */
4734 "kp-decimal", /* VK_DECIMAL 0x6E */
4735 "kp-divide", /* VK_DIVIDE 0x6F */
4736 "f1", /* VK_F1 0x70 */
4737 "f2", /* VK_F2 0x71 */
4738 "f3", /* VK_F3 0x72 */
4739 "f4", /* VK_F4 0x73 */
4740 "f5", /* VK_F5 0x74 */
4741 "f6", /* VK_F6 0x75 */
4742 "f7", /* VK_F7 0x76 */
4743 "f8", /* VK_F8 0x77 */
4744 "f9", /* VK_F9 0x78 */
4745 "f10", /* VK_F10 0x79 */
4746 "f11", /* VK_F11 0x7A */
4747 "f12", /* VK_F12 0x7B */
4748 "f13", /* VK_F13 0x7C */
4749 "f14", /* VK_F14 0x7D */
4750 "f15", /* VK_F15 0x7E */
4751 "f16", /* VK_F16 0x7F */
4752 "f17", /* VK_F17 0x80 */
4753 "f18", /* VK_F18 0x81 */
4754 "f19", /* VK_F19 0x82 */
4755 "f20", /* VK_F20 0x83 */
4756 "f21", /* VK_F21 0x84 */
4757 "f22", /* VK_F22 0x85 */
4758 "f23", /* VK_F23 0x86 */
4759 "f24", /* VK_F24 0x87 */
4761 0, 0, 0, 0, /* 0x88 .. 0x8B */
4762 0, 0, 0, 0, /* 0x8C .. 0x8F */
4764 "kp-numlock", /* VK_NUMLOCK 0x90 */
4765 "scroll", /* VK_SCROLL 0x91 */
4767 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4768 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4769 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4770 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4771 "kp-end", /* VK_NUMPAD_END 0x96 */
4772 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4773 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4774 "kp-up", /* VK_NUMPAD_UP 0x99 */
4775 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4776 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4777 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4778 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4780 0, 0, /* 0x9E .. 0x9F */
4783 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4784 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4785 * No other API or message will distinguish left and right keys this way.
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,
4793 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4799 "attn", /* VK_ATTN 0xF6 */
4800 "crsel", /* VK_CRSEL 0xF7 */
4801 "exsel", /* VK_EXSEL 0xF8 */
4802 "ereof", /* VK_EREOF 0xF9 */
4803 "play", /* VK_PLAY 0xFA */
4804 "zoom", /* VK_ZOOM 0xFB */
4805 "noname", /* VK_NONAME 0xFC */
4806 "pa1", /* VK_PA1 0xFD */
4807 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4811 #else /* not HAVE_NTGUI */
4813 /* This should be dealt with in XTread_socket now, and that doesn't
4814 depend on the client system having the Kana syms defined. See also
4815 the XK_kana_A case below. */
4818 static char *lispy_kana_keys
[] =
4820 /* X Keysym value */
4821 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4822 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4823 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4824 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4825 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4826 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4827 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4828 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4829 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4830 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4831 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4832 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4833 "kana-i", "kana-u", "kana-e", "kana-o",
4834 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4835 "prolongedsound", "kana-A", "kana-I", "kana-U",
4836 "kana-E", "kana-O", "kana-KA", "kana-KI",
4837 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4838 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4839 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4840 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4841 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4842 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4843 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4844 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4845 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4846 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4847 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4848 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4850 #endif /* XK_kana_A */
4853 #define FUNCTION_KEY_OFFSET 0xff00
4855 /* You'll notice that this table is arranged to be conveniently
4856 indexed by X Windows keysym values. */
4857 static char *lispy_function_keys
[] =
4859 /* X Keysym value */
4861 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4862 "backspace", "tab", "linefeed", "clear",
4864 0, 0, 0, "pause", /* 0xff10...1f */
4865 0, 0, 0, 0, 0, 0, 0, "escape",
4867 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4868 "romaji", "hiragana", "katakana", "hiragana-katakana",
4869 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4870 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4871 "eisu-toggle", /* 0xff30...3f */
4872 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4873 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4875 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4876 "down", "prior", "next", "end",
4877 "begin", 0, 0, 0, 0, 0, 0, 0,
4878 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4889 "break", /* 0xff6b */
4892 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4893 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4894 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4895 0, 0, 0, 0, 0, 0, 0, 0,
4896 "kp-tab", /* 0xff89 */
4898 "kp-enter", /* 0xff8d */
4900 "kp-f1", /* 0xff91 */
4904 "kp-home", /* 0xff95 */
4909 "kp-prior", /* kp-page-up */
4910 "kp-next", /* kp-page-down */
4916 0, 0, 0, 0, 0, 0, 0, 0, 0,
4917 "kp-multiply", /* 0xffaa */
4922 "kp-divide", /* 0xffaf */
4923 "kp-0", /* 0xffb0 */
4924 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4927 "kp-equal", /* 0xffbd */
4928 "f1", /* 0xffbe */ /* IsFunctionKey */
4930 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4931 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4932 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4933 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4934 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4935 0, 0, 0, 0, 0, 0, 0, 0,
4936 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4937 0, 0, 0, 0, 0, 0, 0, "delete"
4940 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4941 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4943 static char *iso_lispy_function_keys
[] =
4945 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4946 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4947 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4948 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4949 "iso-lefttab", /* 0xfe20 */
4950 "iso-move-line-up", "iso-move-line-down",
4951 "iso-partial-line-up", "iso-partial-line-down",
4952 "iso-partial-space-left", "iso-partial-space-right",
4953 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4954 "iso-release-margin-left", "iso-release-margin-right",
4955 "iso-release-both-margins",
4956 "iso-fast-cursor-left", "iso-fast-cursor-right",
4957 "iso-fast-cursor-up", "iso-fast-cursor-down",
4958 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4959 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4962 #endif /* not HAVE_NTGUI */
4964 Lisp_Object Vlispy_mouse_stem
;
4966 static char *lispy_wheel_names
[] =
4968 "wheel-up", "wheel-down"
4971 /* drag-n-drop events are generated when a set of selected files are
4972 dragged from another application and dropped onto an Emacs window. */
4973 static char *lispy_drag_n_drop_names
[] =
4978 /* Scroll bar parts. */
4979 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4980 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4981 Lisp_Object Qtop
, Qratio
;
4983 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4984 Lisp_Object
*scroll_bar_parts
[] = {
4985 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4986 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4989 /* User signal events. */
4990 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4992 Lisp_Object
*lispy_user_signals
[] =
4994 &Qusr1_signal
, &Qusr2_signal
4998 /* A vector, indexed by button number, giving the down-going location
4999 of currently depressed buttons, both scroll bar and non-scroll bar.
5001 The elements have the form
5002 (BUTTON-NUMBER MODIFIER-MASK . REST)
5003 where REST is the cdr of a position as it would be reported in the event.
5005 The make_lispy_event function stores positions here to tell the
5006 difference between click and drag events, and to store the starting
5007 location to be included in drag events. */
5009 static Lisp_Object button_down_location
;
5011 /* Information about the most recent up-going button event: Which
5012 button, what location, and what time. */
5014 static int last_mouse_button
;
5015 static int last_mouse_x
;
5016 static int last_mouse_y
;
5017 static unsigned long button_down_time
;
5019 /* The maximum time between clicks to make a double-click, or Qnil to
5020 disable double-click detection, or Qt for no time limit. */
5022 Lisp_Object Vdouble_click_time
;
5024 /* Maximum number of pixels the mouse may be moved between clicks
5025 to make a double-click. */
5027 EMACS_INT double_click_fuzz
;
5029 /* The number of clicks in this multiple-click. */
5031 int double_click_count
;
5033 /* Return position of a mouse click or wheel event */
5036 make_lispy_position (f
, x
, y
, time
)
5042 enum window_part part
;
5043 Lisp_Object posn
= Qnil
;
5044 Lisp_Object extra_info
= Qnil
;
5047 /* Set `window' to the window under frame pixel coordinates (x,y) */
5049 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5050 &part
, &wx
, &wy
, 0);
5054 if (WINDOWP (window
))
5056 /* It's a click in window window at frame coordinates (x,y) */
5057 struct window
*w
= XWINDOW (window
);
5058 Lisp_Object string_info
= Qnil
;
5059 int textpos
= -1, rx
= -1, ry
= -1;
5060 int dx
= -1, dy
= -1;
5061 int width
= -1, height
= -1;
5062 Lisp_Object object
= Qnil
;
5064 /* Set event coordinates to window-relative coordinates
5065 for constructing the Lisp event below. */
5069 if (part
== ON_TEXT
)
5071 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5073 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5075 /* Mode line or header line. Look for a string under
5076 the mouse that may have a `local-map' property. */
5080 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5082 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5083 &object
, &dx
, &dy
, &width
, &height
);
5084 if (STRINGP (string
))
5085 string_info
= Fcons (string
, make_number (charpos
));
5086 if (w
== XWINDOW (selected_window
))
5089 textpos
= XMARKER (w
->pointm
)->charpos
;
5091 else if (part
== ON_VERTICAL_BORDER
)
5093 posn
= Qvertical_line
;
5098 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5103 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5105 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5106 &object
, &dx
, &dy
, &width
, &height
);
5107 if (STRINGP (string
))
5108 string_info
= Fcons (string
, make_number (charpos
));
5109 if (part
== ON_LEFT_MARGIN
)
5112 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5114 else if (part
== ON_LEFT_FRINGE
)
5116 posn
= Qleft_fringe
;
5119 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5121 : window_box_width (w
, LEFT_MARGIN_AREA
));
5124 else if (part
== ON_RIGHT_FRINGE
)
5126 posn
= Qright_fringe
;
5129 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5130 + window_box_width (w
, TEXT_AREA
)
5131 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5132 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5138 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5139 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5144 Lisp_Object string2
, object2
= Qnil
;
5145 struct display_pos p
;
5147 int width2
, height2
;
5148 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5149 &object2
, &dx2
, &dy2
,
5151 textpos
= CHARPOS (p
.pos
);
5152 if (rx
< 0) rx
= wx
;
5153 if (ry
< 0) ry
= wy
;
5154 if (dx
< 0) dx
= dx2
;
5155 if (dy
< 0) dy
= dy2
;
5156 if (width
< 0) width
= width2
;
5157 if (height
< 0) height
= height2
;
5161 posn
= make_number (textpos
);
5162 if (STRINGP (string2
))
5163 string_info
= Fcons (string2
,
5164 make_number (CHARPOS (p
.string_pos
)));
5170 #ifdef HAVE_WINDOW_SYSTEM
5171 if (IMAGEP (object
))
5173 Lisp_Object image_map
, hotspot
;
5174 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5176 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5178 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5179 posn
= XCAR (hotspot
);
5184 extra_info
= Fcons (object
,
5185 Fcons (Fcons (make_number (dx
),
5187 Fcons (Fcons (make_number (width
),
5188 make_number (height
)),
5192 extra_info
= Fcons (string_info
,
5193 Fcons (make_number (textpos
),
5194 Fcons (Fcons (make_number (rx
),
5200 XSETFRAME (window
, f
);
5205 XSETFASTINT (*x
, 0);
5206 XSETFASTINT (*y
, 0);
5209 return Fcons (window
,
5211 Fcons (Fcons (*x
, *y
),
5212 Fcons (make_number (time
),
5216 /* Given a struct input_event, build the lisp event which represents
5217 it. If EVENT is 0, build a mouse movement event from the mouse
5218 movement buffer, which should have a movement event in it.
5220 Note that events must be passed to this function in the order they
5221 are received; this function stores the location of button presses
5222 in order to build drag events when the button is released. */
5225 make_lispy_event (event
)
5226 struct input_event
*event
;
5230 switch (SWITCH_ENUM_CAST (event
->kind
))
5232 /* A simple keystroke. */
5233 case ASCII_KEYSTROKE_EVENT
:
5235 Lisp_Object lispy_c
;
5236 int c
= event
->code
& 0377;
5237 /* Turn ASCII characters into control characters
5239 if (event
->modifiers
& ctrl_modifier
)
5240 c
= make_ctrl_char (c
);
5242 /* Add in the other modifier bits. We took care of ctrl_modifier
5243 just above, and the shift key was taken care of by the X code,
5244 and applied to control characters by make_ctrl_char. */
5245 c
|= (event
->modifiers
5246 & (meta_modifier
| alt_modifier
5247 | hyper_modifier
| super_modifier
));
5248 /* Distinguish Shift-SPC from SPC. */
5249 if ((event
->code
& 0377) == 040
5250 && event
->modifiers
& shift_modifier
)
5251 c
|= shift_modifier
;
5252 button_down_time
= 0;
5253 XSETFASTINT (lispy_c
, c
);
5257 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5259 Lisp_Object lispy_c
;
5260 int c
= event
->code
;
5262 /* Add in the other modifier bits. We took care of ctrl_modifier
5263 just above, and the shift key was taken care of by the X code,
5264 and applied to control characters by make_ctrl_char. */
5265 c
|= (event
->modifiers
5266 & (meta_modifier
| alt_modifier
5267 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5268 /* What about the `shift' modifier ? */
5269 button_down_time
= 0;
5270 XSETFASTINT (lispy_c
, c
);
5274 /* A function key. The symbol may need to have modifier prefixes
5276 case NON_ASCII_KEYSTROKE_EVENT
:
5277 button_down_time
= 0;
5279 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5280 if (event
->code
== lispy_accent_codes
[i
])
5281 return modify_event_symbol (i
,
5283 Qfunction_key
, Qnil
,
5284 lispy_accent_keys
, &accent_key_syms
,
5285 (sizeof (lispy_accent_keys
)
5286 / sizeof (lispy_accent_keys
[0])));
5290 if (event
->code
>= 0x400 && event
->code
< 0x500)
5291 return modify_event_symbol (event
->code
- 0x400,
5292 event
->modifiers
& ~shift_modifier
,
5293 Qfunction_key
, Qnil
,
5294 lispy_kana_keys
, &func_key_syms
,
5295 (sizeof (lispy_kana_keys
)
5296 / sizeof (lispy_kana_keys
[0])));
5297 #endif /* XK_kana_A */
5300 #ifdef ISO_FUNCTION_KEY_OFFSET
5301 if (event
->code
< FUNCTION_KEY_OFFSET
5302 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5303 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5305 Qfunction_key
, Qnil
,
5306 iso_lispy_function_keys
, &func_key_syms
,
5307 (sizeof (iso_lispy_function_keys
)
5308 / sizeof (iso_lispy_function_keys
[0])));
5311 /* Handle system-specific or unknown keysyms. */
5312 if (event
->code
& (1 << 28)
5313 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5314 || (event
->code
- FUNCTION_KEY_OFFSET
5315 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5316 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5318 /* We need to use an alist rather than a vector as the cache
5319 since we can't make a vector long enuf. */
5320 if (NILP (current_kboard
->system_key_syms
))
5321 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5322 return modify_event_symbol (event
->code
,
5325 current_kboard
->Vsystem_key_alist
,
5326 0, ¤t_kboard
->system_key_syms
,
5330 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5332 Qfunction_key
, Qnil
,
5333 lispy_function_keys
, &func_key_syms
,
5334 (sizeof (lispy_function_keys
)
5335 / sizeof (lispy_function_keys
[0])));
5338 /* A mouse click. Figure out where it is, decide whether it's
5339 a press, click or drag, and build the appropriate structure. */
5340 case MOUSE_CLICK_EVENT
:
5341 #ifndef USE_TOOLKIT_SCROLL_BARS
5342 case SCROLL_BAR_CLICK_EVENT
:
5345 int button
= event
->code
;
5347 Lisp_Object position
;
5348 Lisp_Object
*start_pos_ptr
;
5349 Lisp_Object start_pos
;
5353 /* Build the position as appropriate for this mouse click. */
5354 if (event
->kind
== MOUSE_CLICK_EVENT
)
5356 struct frame
*f
= XFRAME (event
->frame_or_window
);
5357 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5361 /* Ignore mouse events that were made on frame that
5362 have been deleted. */
5363 if (! FRAME_LIVE_P (f
))
5366 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5367 /* EVENT->x and EVENT->y are frame-relative pixel
5368 coordinates at this place. Under old redisplay, COLUMN
5369 and ROW are set to frame relative glyph coordinates
5370 which are then used to determine whether this click is
5371 in a menu (non-toolkit version). */
5372 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5373 &column
, &row
, NULL
, 1);
5375 /* In the non-toolkit version, clicks on the menu bar
5376 are ordinary button events in the event buffer.
5377 Distinguish them, and invoke the menu.
5379 (In the toolkit version, the toolkit handles the menu bar
5380 and Emacs doesn't know about it until after the user
5381 makes a selection.) */
5382 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5383 && (event
->modifiers
& down_modifier
))
5385 Lisp_Object items
, item
;
5390 /* Activate the menu bar on the down event. If the
5391 up event comes in before the menu code can deal with it,
5393 if (! (event
->modifiers
& down_modifier
))
5397 /* Find the menu bar item under `column'. */
5399 items
= FRAME_MENU_BAR_ITEMS (f
);
5400 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5402 Lisp_Object pos
, string
;
5403 string
= AREF (items
, i
+ 1);
5404 pos
= AREF (items
, i
+ 3);
5407 if (column
>= XINT (pos
)
5408 && column
< XINT (pos
) + SCHARS (string
))
5410 item
= AREF (items
, i
);
5415 /* ELisp manual 2.4b says (x y) are window relative but
5416 code says they are frame-relative. */
5418 = Fcons (event
->frame_or_window
,
5420 Fcons (Fcons (event
->x
, event
->y
),
5421 Fcons (make_number (event
->timestamp
),
5424 return Fcons (item
, Fcons (position
, Qnil
));
5426 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5428 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5431 #ifndef USE_TOOLKIT_SCROLL_BARS
5434 /* It's a scrollbar click. */
5436 Lisp_Object portion_whole
;
5439 window
= event
->frame_or_window
;
5440 portion_whole
= Fcons (event
->x
, event
->y
);
5441 part
= *scroll_bar_parts
[(int) event
->part
];
5445 Fcons (Qvertical_scroll_bar
,
5446 Fcons (portion_whole
,
5447 Fcons (make_number (event
->timestamp
),
5448 Fcons (part
, Qnil
)))));
5450 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5452 if (button
>= ASIZE (button_down_location
))
5454 button_down_location
= larger_vector (button_down_location
,
5456 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5459 start_pos_ptr
= &AREF (button_down_location
, button
);
5460 start_pos
= *start_pos_ptr
;
5461 *start_pos_ptr
= Qnil
;
5464 /* On window-system frames, use the value of
5465 double-click-fuzz as is. On other frames, interpret it
5466 as a multiple of 1/8 characters. */
5470 if (WINDOWP (event
->frame_or_window
))
5471 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5472 else if (FRAMEP (event
->frame_or_window
))
5473 f
= XFRAME (event
->frame_or_window
);
5477 if (FRAME_WINDOW_P (f
))
5478 fuzz
= double_click_fuzz
;
5480 fuzz
= double_click_fuzz
/ 8;
5482 is_double
= (button
== last_mouse_button
5483 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5484 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5485 && button_down_time
!= 0
5486 && (EQ (Vdouble_click_time
, Qt
)
5487 || (INTEGERP (Vdouble_click_time
)
5488 && ((int)(event
->timestamp
- button_down_time
)
5489 < XINT (Vdouble_click_time
)))));
5492 last_mouse_button
= button
;
5493 last_mouse_x
= XINT (event
->x
);
5494 last_mouse_y
= XINT (event
->y
);
5496 /* If this is a button press, squirrel away the location, so
5497 we can decide later whether it was a click or a drag. */
5498 if (event
->modifiers
& down_modifier
)
5502 double_click_count
++;
5503 event
->modifiers
|= ((double_click_count
> 2)
5508 double_click_count
= 1;
5509 button_down_time
= event
->timestamp
;
5510 *start_pos_ptr
= Fcopy_alist (position
);
5513 /* Now we're releasing a button - check the co-ordinates to
5514 see if this was a click or a drag. */
5515 else if (event
->modifiers
& up_modifier
)
5517 /* If we did not see a down before this up, ignore the up.
5518 Probably this happened because the down event chose a
5519 menu item. It would be an annoyance to treat the
5520 release of the button that chose the menu item as a
5523 if (!CONSP (start_pos
))
5526 event
->modifiers
&= ~up_modifier
;
5527 #if 0 /* Formerly we treated an up with no down as a click event. */
5528 if (!CONSP (start_pos
))
5529 event
->modifiers
|= click_modifier
;
5534 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5536 /* The third element of every position
5537 should be the (x,y) pair. */
5538 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5540 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5542 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5543 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5546 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5547 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5548 /* Maybe the mouse has moved a lot, caused scrolling, and
5549 eventually ended up at the same screen position (but
5550 not buffer position) in which case it is a drag, not
5552 /* FIXME: OTOH if the buffer position has changed
5553 because of a timer or process filter rather than
5554 because of mouse movement, it should be considered as
5555 a click. But mouse-drag-region completely ignores
5556 this case and it hasn't caused any real problem, so
5557 it's probably OK to ignore it as well. */
5558 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5559 /* Mouse hasn't moved (much). */
5560 event
->modifiers
|= click_modifier
;
5563 button_down_time
= 0;
5564 event
->modifiers
|= drag_modifier
;
5567 /* Don't check is_double; treat this as multiple
5568 if the down-event was multiple. */
5569 if (double_click_count
> 1)
5570 event
->modifiers
|= ((double_click_count
> 2)
5576 /* Every mouse event should either have the down_modifier or
5577 the up_modifier set. */
5581 /* Get the symbol we should use for the mouse click. */
5584 head
= modify_event_symbol (button
,
5586 Qmouse_click
, Vlispy_mouse_stem
,
5589 XVECTOR (mouse_syms
)->size
);
5590 if (event
->modifiers
& drag_modifier
)
5595 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5598 Fcons (make_number (double_click_count
),
5609 Lisp_Object position
;
5612 /* Build the position as appropriate for this mouse click. */
5613 struct frame
*f
= XFRAME (event
->frame_or_window
);
5615 /* Ignore wheel events that were made on frame that have been
5617 if (! FRAME_LIVE_P (f
))
5620 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5623 /* Set double or triple modifiers to indicate the wheel speed. */
5625 /* On window-system frames, use the value of
5626 double-click-fuzz as is. On other frames, interpret it
5627 as a multiple of 1/8 characters. */
5632 if (WINDOWP (event
->frame_or_window
))
5633 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5634 else if (FRAMEP (event
->frame_or_window
))
5635 f
= XFRAME (event
->frame_or_window
);
5639 if (FRAME_WINDOW_P (f
))
5640 fuzz
= double_click_fuzz
;
5642 fuzz
= double_click_fuzz
/ 8;
5644 is_double
= (last_mouse_button
< 0
5645 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5646 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5647 && button_down_time
!= 0
5648 && (EQ (Vdouble_click_time
, Qt
)
5649 || (INTEGERP (Vdouble_click_time
)
5650 && ((int)(event
->timestamp
- button_down_time
)
5651 < XINT (Vdouble_click_time
)))));
5654 double_click_count
++;
5655 event
->modifiers
|= ((double_click_count
> 2)
5661 double_click_count
= 1;
5662 event
->modifiers
|= click_modifier
;
5665 button_down_time
= event
->timestamp
;
5666 /* Use a negative value to distinguish wheel from mouse button. */
5667 last_mouse_button
= -1;
5668 last_mouse_x
= XINT (event
->x
);
5669 last_mouse_y
= XINT (event
->y
);
5675 if (event
->modifiers
& up_modifier
)
5677 /* Emit a wheel-up event. */
5678 event
->modifiers
&= ~up_modifier
;
5681 else if (event
->modifiers
& down_modifier
)
5683 /* Emit a wheel-down event. */
5684 event
->modifiers
&= ~down_modifier
;
5688 /* Every wheel event should either have the down_modifier or
5689 the up_modifier set. */
5692 /* Get the symbol we should use for the wheel event. */
5693 head
= modify_event_symbol (symbol_num
,
5699 ASIZE (wheel_syms
));
5702 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5705 Fcons (make_number (double_click_count
),
5714 #ifdef USE_TOOLKIT_SCROLL_BARS
5716 /* We don't have down and up events if using toolkit scroll bars,
5717 so make this always a click event. Store in the `part' of
5718 the Lisp event a symbol which maps to the following actions:
5720 `above_handle' page up
5721 `below_handle' page down
5725 `bottom' bottom of buffer
5726 `handle' thumb has been dragged.
5727 `end-scroll' end of interaction with scroll bar
5729 The incoming input_event contains in its `part' member an
5730 index of type `enum scroll_bar_part' which we can use as an
5731 index in scroll_bar_parts to get the appropriate symbol. */
5733 case SCROLL_BAR_CLICK_EVENT
:
5735 Lisp_Object position
, head
, window
, portion_whole
, part
;
5737 window
= event
->frame_or_window
;
5738 portion_whole
= Fcons (event
->x
, event
->y
);
5739 part
= *scroll_bar_parts
[(int) event
->part
];
5743 Fcons (Qvertical_scroll_bar
,
5744 Fcons (portion_whole
,
5745 Fcons (make_number (event
->timestamp
),
5746 Fcons (part
, Qnil
)))));
5748 /* Always treat scroll bar events as clicks. */
5749 event
->modifiers
|= click_modifier
;
5750 event
->modifiers
&= ~up_modifier
;
5752 if (event
->code
>= ASIZE (mouse_syms
))
5753 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5755 /* Get the symbol we should use for the mouse click. */
5756 head
= modify_event_symbol (event
->code
,
5761 XVECTOR (mouse_syms
)->size
);
5762 return Fcons (head
, Fcons (position
, Qnil
));
5765 #endif /* USE_TOOLKIT_SCROLL_BARS */
5768 case W32_SCROLL_BAR_CLICK_EVENT
:
5770 int button
= event
->code
;
5772 Lisp_Object position
;
5773 Lisp_Object
*start_pos_ptr
;
5774 Lisp_Object start_pos
;
5778 Lisp_Object portion_whole
;
5781 window
= event
->frame_or_window
;
5782 portion_whole
= Fcons (event
->x
, event
->y
);
5783 part
= *scroll_bar_parts
[(int) event
->part
];
5787 Fcons (Qvertical_scroll_bar
,
5788 Fcons (portion_whole
,
5789 Fcons (make_number (event
->timestamp
),
5790 Fcons (part
, Qnil
)))));
5793 /* Always treat W32 scroll bar events as clicks. */
5794 event
->modifiers
|= click_modifier
;
5797 /* Get the symbol we should use for the mouse click. */
5800 head
= modify_event_symbol (button
,
5805 XVECTOR (mouse_syms
)->size
);
5811 #endif /* WINDOWSNT */
5813 case DRAG_N_DROP_EVENT
:
5816 Lisp_Object head
, position
;
5819 f
= XFRAME (event
->frame_or_window
);
5822 /* Ignore mouse events that were made on frames that
5823 have been deleted. */
5824 if (! FRAME_LIVE_P (f
))
5827 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5830 head
= modify_event_symbol (0, event
->modifiers
,
5832 lispy_drag_n_drop_names
,
5833 &drag_n_drop_syms
, 1);
5839 #endif /* HAVE_MOUSE */
5841 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5842 || defined (USE_GTK)
5843 case MENU_BAR_EVENT
:
5844 if (EQ (event
->arg
, event
->frame_or_window
))
5845 /* This is the prefix key. We translate this to
5846 `(menu_bar)' because the code in keyboard.c for menu
5847 events, which we use, relies on this. */
5848 return Fcons (Qmenu_bar
, Qnil
);
5852 case SELECT_WINDOW_EVENT
:
5853 /* Make an event (select-window (WINDOW)). */
5854 return Fcons (Qselect_window
,
5855 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5858 case TOOL_BAR_EVENT
:
5859 if (EQ (event
->arg
, event
->frame_or_window
))
5860 /* This is the prefix key. We translate this to
5861 `(tool_bar)' because the code in keyboard.c for tool bar
5862 events, which we use, relies on this. */
5863 return Fcons (Qtool_bar
, Qnil
);
5864 else if (SYMBOLP (event
->arg
))
5865 return apply_modifiers (event
->modifiers
, event
->arg
);
5868 case USER_SIGNAL_EVENT
:
5869 /* A user signal. */
5870 return *lispy_user_signals
[event
->code
];
5872 case SAVE_SESSION_EVENT
:
5873 return Qsave_session
;
5876 case MAC_APPLE_EVENT
:
5878 Lisp_Object spec
[2];
5882 return Fcons (Qmac_apple_event
,
5883 Fcons (Fvector (2, spec
),
5884 Fcons (mac_make_lispy_event_code (event
->code
),
5889 /* The 'kind' field of the event is something we don't recognize. */
5898 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5900 Lisp_Object bar_window
;
5901 enum scroll_bar_part part
;
5905 /* Is it a scroll bar movement? */
5906 if (frame
&& ! NILP (bar_window
))
5908 Lisp_Object part_sym
;
5910 part_sym
= *scroll_bar_parts
[(int) part
];
5911 return Fcons (Qscroll_bar_movement
,
5912 (Fcons (Fcons (bar_window
,
5913 Fcons (Qvertical_scroll_bar
,
5914 Fcons (Fcons (x
, y
),
5915 Fcons (make_number (time
),
5921 /* Or is it an ordinary mouse movement? */
5924 Lisp_Object position
;
5926 position
= make_lispy_position (frame
, &x
, &y
, time
);
5928 return Fcons (Qmouse_movement
,
5934 #endif /* HAVE_MOUSE */
5936 /* Construct a switch frame event. */
5938 make_lispy_switch_frame (frame
)
5941 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5944 /* Manipulating modifiers. */
5946 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5948 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5949 SYMBOL's name of the end of the modifiers; the string from this
5950 position is the unmodified symbol name.
5952 This doesn't use any caches. */
5955 parse_modifiers_uncached (symbol
, modifier_end
)
5963 CHECK_SYMBOL (symbol
);
5966 name
= SYMBOL_NAME (symbol
);
5968 for (i
= 0; i
+2 <= SBYTES (name
); )
5970 int this_mod_end
= 0;
5973 /* See if the name continues with a modifier word.
5974 Check that the word appears, but don't check what follows it.
5975 Set this_mod and this_mod_end to record what we find. */
5977 switch (SREF (name
, i
))
5979 #define SINGLE_LETTER_MOD(BIT) \
5980 (this_mod_end = i + 1, this_mod = BIT)
5983 SINGLE_LETTER_MOD (alt_modifier
);
5987 SINGLE_LETTER_MOD (ctrl_modifier
);
5991 SINGLE_LETTER_MOD (hyper_modifier
);
5995 SINGLE_LETTER_MOD (meta_modifier
);
5999 SINGLE_LETTER_MOD (shift_modifier
);
6003 SINGLE_LETTER_MOD (super_modifier
);
6006 #undef SINGLE_LETTER_MOD
6008 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6009 if (i + LEN + 1 <= SBYTES (name) \
6010 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6012 this_mod_end = i + LEN; \
6017 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6018 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6019 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6023 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6025 #undef MULTI_LETTER_MOD
6029 /* If we found no modifier, stop looking for them. */
6030 if (this_mod_end
== 0)
6033 /* Check there is a dash after the modifier, so that it
6034 really is a modifier. */
6035 if (this_mod_end
>= SBYTES (name
)
6036 || SREF (name
, this_mod_end
) != '-')
6039 /* This modifier is real; look for another. */
6040 modifiers
|= this_mod
;
6041 i
= this_mod_end
+ 1;
6044 /* Should we include the `click' modifier? */
6045 if (! (modifiers
& (down_modifier
| drag_modifier
6046 | double_modifier
| triple_modifier
))
6047 && i
+ 7 == SBYTES (name
)
6048 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6049 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6050 modifiers
|= click_modifier
;
6058 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6059 prepended to the string BASE[0..BASE_LEN-1].
6060 This doesn't use any caches. */
6062 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6065 int base_len
, base_len_byte
;
6067 /* Since BASE could contain nulls, we can't use intern here; we have
6068 to use Fintern, which expects a genuine Lisp_String, and keeps a
6071 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6077 /* Only the event queue may use the `up' modifier; it should always
6078 be turned into a click or drag event before presented to lisp code. */
6079 if (modifiers
& up_modifier
)
6082 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6083 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6084 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6085 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6086 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6087 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6088 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6089 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6090 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6091 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6092 /* The click modifier is denoted by the absence of other modifiers. */
6096 mod_len
= p
- new_mods
;
6100 Lisp_Object new_name
;
6102 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6103 mod_len
+ base_len_byte
);
6104 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6105 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6107 return Fintern (new_name
, Qnil
);
6112 static char *modifier_names
[] =
6114 "up", "down", "drag", "click", "double", "triple", 0, 0,
6115 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6116 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6118 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6120 static Lisp_Object modifier_symbols
;
6122 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6124 lispy_modifier_list (modifiers
)
6127 Lisp_Object modifier_list
;
6130 modifier_list
= Qnil
;
6131 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6132 if (modifiers
& (1<<i
))
6133 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6136 return modifier_list
;
6140 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6141 where UNMODIFIED is the unmodified form of SYMBOL,
6142 MASK is the set of modifiers present in SYMBOL's name.
6143 This is similar to parse_modifiers_uncached, but uses the cache in
6144 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6145 Qevent_symbol_elements property. */
6148 parse_modifiers (symbol
)
6151 Lisp_Object elements
;
6153 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6154 if (CONSP (elements
))
6159 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6160 Lisp_Object unmodified
;
6163 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6164 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6167 if (modifiers
& ~INTMASK
)
6169 XSETFASTINT (mask
, modifiers
);
6170 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6172 /* Cache the parsing results on SYMBOL. */
6173 Fput (symbol
, Qevent_symbol_element_mask
,
6175 Fput (symbol
, Qevent_symbol_elements
,
6176 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6178 /* Since we know that SYMBOL is modifiers applied to unmodified,
6179 it would be nice to put that in unmodified's cache.
6180 But we can't, since we're not sure that parse_modifiers is
6187 /* Apply the modifiers MODIFIERS to the symbol BASE.
6188 BASE must be unmodified.
6190 This is like apply_modifiers_uncached, but uses BASE's
6191 Qmodifier_cache property, if present. It also builds
6192 Qevent_symbol_elements properties, since it has that info anyway.
6194 apply_modifiers copies the value of BASE's Qevent_kind property to
6195 the modified symbol. */
6197 apply_modifiers (modifiers
, base
)
6201 Lisp_Object cache
, index
, entry
, new_symbol
;
6203 /* Mask out upper bits. We don't know where this value's been. */
6204 modifiers
&= INTMASK
;
6206 /* The click modifier never figures into cache indices. */
6207 cache
= Fget (base
, Qmodifier_cache
);
6208 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6209 entry
= assq_no_quit (index
, cache
);
6212 new_symbol
= XCDR (entry
);
6215 /* We have to create the symbol ourselves. */
6216 new_symbol
= apply_modifiers_uncached (modifiers
,
6217 SDATA (SYMBOL_NAME (base
)),
6218 SCHARS (SYMBOL_NAME (base
)),
6219 SBYTES (SYMBOL_NAME (base
)));
6221 /* Add the new symbol to the base's cache. */
6222 entry
= Fcons (index
, new_symbol
);
6223 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6225 /* We have the parsing info now for free, so we could add it to
6227 XSETFASTINT (index, modifiers);
6228 Fput (new_symbol, Qevent_symbol_element_mask,
6229 Fcons (base, Fcons (index, Qnil)));
6230 Fput (new_symbol, Qevent_symbol_elements,
6231 Fcons (base, lispy_modifier_list (modifiers)));
6232 Sadly, this is only correct if `base' is indeed a base event,
6233 which is not necessarily the case. -stef */
6236 /* Make sure this symbol is of the same kind as BASE.
6238 You'd think we could just set this once and for all when we
6239 intern the symbol above, but reorder_modifiers may call us when
6240 BASE's property isn't set right; we can't assume that just
6241 because it has a Qmodifier_cache property it must have its
6242 Qevent_kind set right as well. */
6243 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6247 kind
= Fget (base
, Qevent_kind
);
6249 Fput (new_symbol
, Qevent_kind
, kind
);
6256 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6257 return a symbol with the modifiers placed in the canonical order.
6258 Canonical order is alphabetical, except for down and drag, which
6259 always come last. The 'click' modifier is never written out.
6261 Fdefine_key calls this to make sure that (for example) C-M-foo
6262 and M-C-foo end up being equivalent in the keymap. */
6265 reorder_modifiers (symbol
)
6268 /* It's hopefully okay to write the code this way, since everything
6269 will soon be in caches, and no consing will be done at all. */
6272 parsed
= parse_modifiers (symbol
);
6273 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6278 /* For handling events, we often want to produce a symbol whose name
6279 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6280 to some base, like the name of a function key or mouse button.
6281 modify_event_symbol produces symbols of this sort.
6283 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6284 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6287 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6288 into symbol names, or a string specifying a name stem used to
6289 construct a symbol name or the form `STEM-N', where N is the decimal
6290 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6291 non-nil; otherwise NAME_TABLE is used.
6293 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6294 persist between calls to modify_event_symbol that it can use to
6295 store a cache of the symbols it's generated for this NAME_TABLE
6296 before. The object stored there may be a vector or an alist.
6298 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6300 MODIFIERS is a set of modifier bits (as given in struct input_events)
6301 whose prefixes should be applied to the symbol name.
6303 SYMBOL_KIND is the value to be placed in the event_kind property of
6304 the returned symbol.
6306 The symbols we create are supposed to have an
6307 `event-symbol-elements' property, which lists the modifiers present
6308 in the symbol's name. */
6311 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6312 name_table
, symbol_table
, table_size
)
6315 Lisp_Object symbol_kind
;
6316 Lisp_Object name_alist_or_stem
;
6318 Lisp_Object
*symbol_table
;
6319 unsigned int table_size
;
6322 Lisp_Object symbol_int
;
6324 /* Get rid of the "vendor-specific" bit here. */
6325 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6327 /* Is this a request for a valid symbol? */
6328 if (symbol_num
< 0 || symbol_num
>= table_size
)
6331 if (CONSP (*symbol_table
))
6332 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6334 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6335 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6336 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6337 we've never used that symbol before. */
6340 if (! VECTORP (*symbol_table
)
6341 || XVECTOR (*symbol_table
)->size
!= table_size
)
6345 XSETFASTINT (size
, table_size
);
6346 *symbol_table
= Fmake_vector (size
, Qnil
);
6349 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6352 /* Have we already used this symbol before? */
6355 /* No; let's create it. */
6356 if (CONSP (name_alist_or_stem
))
6357 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6358 else if (STRINGP (name_alist_or_stem
))
6360 int len
= SBYTES (name_alist_or_stem
);
6361 char *buf
= (char *) alloca (len
+ 50);
6362 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6363 (long) XINT (symbol_int
) + 1);
6364 value
= intern (buf
);
6366 else if (name_table
!= 0 && name_table
[symbol_num
])
6367 value
= intern (name_table
[symbol_num
]);
6369 #ifdef HAVE_WINDOW_SYSTEM
6372 char *name
= x_get_keysym_name (symbol_num
);
6374 value
= intern (name
);
6381 sprintf (buf
, "key-%d", symbol_num
);
6382 value
= intern (buf
);
6385 if (CONSP (*symbol_table
))
6386 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6388 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6390 /* Fill in the cache entries for this symbol; this also
6391 builds the Qevent_symbol_elements property, which the user
6393 apply_modifiers (modifiers
& click_modifier
, value
);
6394 Fput (value
, Qevent_kind
, symbol_kind
);
6397 /* Apply modifiers to that symbol. */
6398 return apply_modifiers (modifiers
, value
);
6401 /* Convert a list that represents an event type,
6402 such as (ctrl meta backspace), into the usual representation of that
6403 event type as a number or a symbol. */
6405 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6406 doc
: /* Convert the event description list EVENT-DESC to an event type.
6407 EVENT-DESC should contain one base event type (a character or symbol)
6408 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6409 drag, down, double or triple). The base must be last.
6410 The return value is an event type (a character or symbol) which
6411 has the same base event type and all the specified modifiers. */)
6413 Lisp_Object event_desc
;
6421 while (CONSP (rest
))
6429 /* Given a symbol, see if it is a modifier name. */
6430 if (SYMBOLP (elt
) && CONSP (rest
))
6431 this = parse_solitary_modifier (elt
);
6435 else if (!NILP (base
))
6436 error ("Two bases given in one event");
6442 /* Let the symbol A refer to the character A. */
6443 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6444 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6446 if (INTEGERP (base
))
6448 /* Turn (shift a) into A. */
6449 if ((modifiers
& shift_modifier
) != 0
6450 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6452 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6453 modifiers
&= ~shift_modifier
;
6456 /* Turn (control a) into C-a. */
6457 if (modifiers
& ctrl_modifier
)
6458 return make_number ((modifiers
& ~ctrl_modifier
)
6459 | make_ctrl_char (XINT (base
)));
6461 return make_number (modifiers
| XINT (base
));
6463 else if (SYMBOLP (base
))
6464 return apply_modifiers (modifiers
, base
);
6467 error ("Invalid base event");
6472 /* Try to recognize SYMBOL as a modifier name.
6473 Return the modifier flag bit, or 0 if not recognized. */
6476 parse_solitary_modifier (symbol
)
6479 Lisp_Object name
= SYMBOL_NAME (symbol
);
6481 switch (SREF (name
, 0))
6483 #define SINGLE_LETTER_MOD(BIT) \
6484 if (SBYTES (name) == 1) \
6487 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6488 if (LEN == SBYTES (name) \
6489 && ! strncmp (SDATA (name), NAME, LEN)) \
6493 SINGLE_LETTER_MOD (alt_modifier
);
6497 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6501 SINGLE_LETTER_MOD (ctrl_modifier
);
6505 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6506 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6510 SINGLE_LETTER_MOD (hyper_modifier
);
6514 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6518 SINGLE_LETTER_MOD (meta_modifier
);
6522 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6526 SINGLE_LETTER_MOD (shift_modifier
);
6530 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6531 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6532 SINGLE_LETTER_MOD (super_modifier
);
6536 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6537 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6538 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6542 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6545 #undef SINGLE_LETTER_MOD
6546 #undef MULTI_LETTER_MOD
6552 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6553 Such a list is not valid as an event,
6554 but it can be a Lucid-style event type list. */
6557 lucid_event_type_list_p (object
)
6562 if (! CONSP (object
))
6565 if (EQ (XCAR (object
), Qhelp_echo
)
6566 || EQ (XCAR (object
), Qvertical_line
)
6567 || EQ (XCAR (object
), Qmode_line
)
6568 || EQ (XCAR (object
), Qheader_line
))
6571 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6575 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6582 /* Store into *addr a value nonzero if terminal input chars are available.
6583 Serves the purpose of ioctl (0, FIONREAD, addr)
6584 but works even if FIONREAD does not exist.
6585 (In fact, this may actually read some input.)
6587 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6588 timer events that are ripe.
6589 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6590 events (FOCUS_IN_EVENT).
6591 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6592 movements and toolkit scroll bar thumb drags. */
6595 get_input_pending (addr
, flags
)
6599 /* First of all, have we already counted some input? */
6600 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6602 /* If input is being read as it arrives, and we have none, there is none. */
6603 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6606 /* Try to read some input and see how much we get. */
6608 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6611 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6614 gobble_input (expected
)
6619 if (interrupt_input
)
6622 mask
= sigblock (sigmask (SIGIO
));
6623 read_avail_input (expected
);
6627 #ifdef POLL_FOR_INPUT
6628 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6631 mask
= sigblock (sigmask (SIGALRM
));
6632 read_avail_input (expected
);
6638 read_avail_input (expected
);
6642 /* Put a BUFFER_SWITCH_EVENT in the buffer
6643 so that read_key_sequence will notice the new current buffer. */
6646 record_asynch_buffer_change ()
6648 struct input_event event
;
6652 event
.kind
= BUFFER_SWITCH_EVENT
;
6653 event
.frame_or_window
= Qnil
;
6657 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6658 The purpose of the event is to make read_key_sequence look up the
6659 keymaps again. If we aren't in read_key_sequence, we don't need one,
6660 and the event could cause trouble by messing up (input-pending-p). */
6661 tem
= Fwaiting_for_user_input_p ();
6665 /* We never need these events if we have no asynchronous subprocesses. */
6669 /* Make sure no interrupt happens while storing the event. */
6671 if (interrupt_input
)
6674 mask
= sigblock (sigmask (SIGIO
));
6675 kbd_buffer_store_event (&event
);
6682 kbd_buffer_store_event (&event
);
6689 /* Read any terminal input already buffered up by the system
6690 into the kbd_buffer, but do not wait.
6692 EXPECTED should be nonzero if the caller knows there is some input.
6694 Except on VMS, all input is read by this function.
6695 If interrupt_input is nonzero, this function MUST be called
6696 only when SIGIO is blocked.
6698 Returns the number of keyboard chars read, or -1 meaning
6699 this is a bad time to try to read input. */
6702 read_avail_input (expected
)
6708 if (read_socket_hook
)
6711 struct input_event hold_quit
;
6713 EVENT_INIT (hold_quit
);
6714 hold_quit
.kind
= NO_EVENT
;
6716 /* No need for FIONREAD or fcntl; just say don't wait. */
6717 while (nr
= (*read_socket_hook
) (input_fd
, expected
, &hold_quit
), nr
> 0)
6722 if (hold_quit
.kind
!= NO_EVENT
)
6723 kbd_buffer_store_event (&hold_quit
);
6727 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6728 the kbd_buffer can really hold. That may prevent loss
6729 of characters on some systems when input is stuffed at us. */
6730 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6733 /* Determine how many characters we should *try* to read. */
6736 #else /* not WINDOWSNT */
6738 n_to_read
= dos_keysns ();
6741 #else /* not MSDOS */
6743 /* Find out how much input is available. */
6744 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6745 /* Formerly simply reported no input, but that sometimes led to
6746 a failure of Emacs to terminate.
6747 SIGHUP seems appropriate if we can't reach the terminal. */
6748 /* ??? Is it really right to send the signal just to this process
6749 rather than to the whole process group?
6750 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6752 if (! noninteractive
)
6753 kill (getpid (), SIGHUP
);
6759 if (n_to_read
> sizeof cbuf
)
6760 n_to_read
= sizeof cbuf
;
6761 #else /* no FIONREAD */
6762 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6763 /* Read some input if available, but don't wait. */
6764 n_to_read
= sizeof cbuf
;
6765 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6770 #endif /* not MSDOS */
6771 #endif /* not WINDOWSNT */
6773 /* Now read; for one reason or another, this will not block.
6774 NREAD is set to the number of chars read. */
6778 cbuf
[0] = dos_keyread ();
6781 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6783 /* POSIX infers that processes which are not in the session leader's
6784 process group won't get SIGHUP's at logout time. BSDI adheres to
6785 this part standard and returns -1 from read (0) with errno==EIO
6786 when the control tty is taken away.
6787 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6788 if (nread
== -1 && errno
== EIO
)
6790 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6791 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6792 This looks incorrect, but it isn't, because _BSD causes
6793 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6794 and that causes a value other than 0 when there is no input. */
6800 /* We used to retry the read if it was interrupted.
6801 But this does the wrong thing when O_NDELAY causes
6802 an EAGAIN error. Does anybody know of a situation
6803 where a retry is actually needed? */
6805 nread
< 0 && (errno
== EAGAIN
6819 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6820 fcntl (input_fd
, F_SETFL
, 0);
6821 #endif /* USG or DGUX or CYGWIN */
6822 #endif /* no FIONREAD */
6823 for (i
= 0; i
< nread
; i
++)
6825 struct input_event buf
;
6827 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6829 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6830 buf
.modifiers
= meta_modifier
;
6835 buf
.frame_or_window
= selected_frame
;
6838 kbd_buffer_store_event (&buf
);
6839 /* Don't look at input that follows a C-g too closely.
6840 This reduces lossage due to autorepeat on C-g. */
6841 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6842 && buf
.code
== quit_char
)
6849 #endif /* not VMS */
6852 handle_async_input ()
6855 extern int select_alarmed
;
6858 interrupt_input_pending
= 0;
6863 nread
= read_avail_input (1);
6864 /* -1 means it's not ok to read the input now.
6865 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6866 0 means there was no keyboard input available. */
6871 select_alarmed
= 1; /* Force the select emulator back to life */
6876 #ifdef SIGIO /* for entire page */
6877 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6880 input_available_signal (signo
)
6883 /* Must preserve main program's value of errno. */
6884 int old_errno
= errno
;
6885 #if defined (USG) && !defined (POSIX_SIGNALS)
6886 /* USG systems forget handlers when they are used;
6887 must reestablish each time */
6888 signal (signo
, input_available_signal
);
6896 interrupt_input_pending
= 1;
6898 SIGNAL_THREAD_CHECK (signo
);
6901 if (input_available_clear_time
)
6902 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6905 handle_async_input ();
6915 /* Send ourselves a SIGIO.
6917 This function exists so that the UNBLOCK_INPUT macro in
6918 blockinput.h can have some way to take care of input we put off
6919 dealing with, without assuming that every file which uses
6920 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6922 reinvoke_input_signal ()
6925 handle_async_input ();
6931 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6932 static Lisp_Object menu_bar_one_keymap_changed_items
;
6934 /* These variables hold the vector under construction within
6935 menu_bar_items and its subroutines, and the current index
6936 for storing into that vector. */
6937 static Lisp_Object menu_bar_items_vector
;
6938 static int menu_bar_items_index
;
6940 /* Return a vector of menu items for a menu bar, appropriate
6941 to the current buffer. Each item has three elements in the vector:
6944 OLD is an old vector we can optionally reuse, or nil. */
6947 menu_bar_items (old
)
6950 /* The number of keymaps we're scanning right now, and the number of
6951 keymaps we have allocated space for. */
6954 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6955 in the current keymaps, or nil where it is not a prefix. */
6958 Lisp_Object def
, tail
;
6967 /* In order to build the menus, we need to call the keymap
6968 accessors. They all call QUIT. But this function is called
6969 during redisplay, during which a quit is fatal. So inhibit
6970 quitting while building the menus.
6971 We do this instead of specbind because (1) errors will clear it anyway
6972 and (2) this avoids risk of specpdl overflow. */
6973 oquit
= Vinhibit_quit
;
6977 menu_bar_items_vector
= old
;
6979 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6980 menu_bar_items_index
= 0;
6982 /* Build our list of keymaps.
6983 If we recognize a function key and replace its escape sequence in
6984 keybuf with its symbol, or if the sequence starts with a mouse
6985 click and we need to switch buffers, we jump back here to rebuild
6986 the initial keymaps from the current buffer. */
6990 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6991 if (!NILP (Voverriding_local_map_menu_flag
))
6993 /* Yes, use them (if non-nil) as well as the global map. */
6994 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6996 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6997 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6998 if (!NILP (Voverriding_local_map
))
6999 maps
[nmaps
++] = Voverriding_local_map
;
7003 /* No, so use major and minor mode keymaps and keymap property.
7004 Note that menu-bar bindings in the local-map and keymap
7005 properties may not work reliable, as they are only
7006 recognized when the menu-bar (or mode-line) is updated,
7007 which does not normally happen after every command. */
7010 nminor
= current_minor_maps (NULL
, &tmaps
);
7011 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7013 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7014 maps
[nmaps
++] = tem
;
7015 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7017 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7019 maps
[nmaps
++] = current_global_map
;
7022 /* Look up in each map the dummy prefix key `menu-bar'. */
7026 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7027 if (!NILP (maps
[mapno
]))
7029 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7033 menu_bar_one_keymap_changed_items
= Qnil
;
7034 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7038 /* Move to the end those items that should be at the end. */
7040 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7043 int end
= menu_bar_items_index
;
7045 for (i
= 0; i
< end
; i
+= 4)
7046 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7048 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7049 /* Move the item at index I to the end,
7050 shifting all the others forward. */
7051 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7052 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7053 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7054 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7056 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7057 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7058 (end
- i
- 4) * sizeof (Lisp_Object
));
7059 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7060 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7061 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7062 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7067 /* Add nil, nil, nil, nil at the end. */
7068 i
= menu_bar_items_index
;
7069 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7072 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7073 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7074 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7075 menu_bar_items_vector
= tem
;
7077 /* Add this item. */
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 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7082 menu_bar_items_index
= i
;
7084 Vinhibit_quit
= oquit
;
7085 return menu_bar_items_vector
;
7088 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7089 If there's already an item for KEY, add this DEF to it. */
7091 Lisp_Object item_properties
;
7094 menu_bar_item (key
, item
, dummy1
, dummy2
)
7095 Lisp_Object key
, item
, dummy1
;
7098 struct gcpro gcpro1
;
7102 if (EQ (item
, Qundefined
))
7104 /* If a map has an explicit `undefined' as definition,
7105 discard any previously made menu bar item. */
7107 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7108 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7110 if (menu_bar_items_index
> i
+ 4)
7111 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7112 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7113 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7114 menu_bar_items_index
-= 4;
7118 /* If this keymap has already contributed to this KEY,
7119 don't contribute to it a second time. */
7120 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7121 if (!NILP (tem
) || NILP (item
))
7124 menu_bar_one_keymap_changed_items
7125 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7127 /* We add to menu_bar_one_keymap_changed_items before doing the
7128 parse_menu_item, so that if it turns out it wasn't a menu item,
7129 it still correctly hides any further menu item. */
7131 i
= parse_menu_item (item
, 0, 1);
7136 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7138 /* Find any existing item for this KEY. */
7139 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7140 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7143 /* If we did not find this KEY, add it at the end. */
7144 if (i
== menu_bar_items_index
)
7146 /* If vector is too small, get a bigger one. */
7147 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7150 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7151 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7152 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7153 menu_bar_items_vector
= tem
;
7156 /* Add this item. */
7157 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7158 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7159 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7160 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7161 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7162 menu_bar_items_index
= i
;
7164 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7168 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7169 /* If the new and the old items are not both keymaps,
7170 the lookup will only find `item'. */
7171 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7172 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7176 /* This is used as the handler when calling menu_item_eval_property. */
7178 menu_item_eval_property_1 (arg
)
7181 /* If we got a quit from within the menu computation,
7182 quit all the way out of it. This takes care of C-] in the debugger. */
7183 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7184 Fsignal (Qquit
, Qnil
);
7189 /* Evaluate an expression and return the result (or nil if something
7190 went wrong). Used to evaluate dynamic parts of menu items. */
7192 menu_item_eval_property (sexpr
)
7195 int count
= SPECPDL_INDEX ();
7197 specbind (Qinhibit_redisplay
, Qt
);
7198 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7199 menu_item_eval_property_1
);
7200 return unbind_to (count
, val
);
7203 /* This function parses a menu item and leaves the result in the
7204 vector item_properties.
7205 ITEM is a key binding, a possible menu item.
7206 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7207 evaluate dynamic expressions in the menu item.
7208 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7210 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7211 parse_menu_item returns true if the item is a menu item and false
7215 parse_menu_item (item
, notreal
, inmenubar
)
7217 int notreal
, inmenubar
;
7219 Lisp_Object def
, tem
, item_string
, start
;
7220 Lisp_Object cachelist
;
7222 Lisp_Object keyhint
;
7233 /* Create item_properties vector if necessary. */
7234 if (NILP (item_properties
))
7236 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7238 /* Initialize optional entries. */
7239 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7240 AREF (item_properties
, i
) = Qnil
;
7241 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7243 /* Save the item here to protect it from GC. */
7244 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7246 item_string
= XCAR (item
);
7250 if (STRINGP (item_string
))
7252 /* Old format menu item. */
7253 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7255 /* Maybe help string. */
7256 if (CONSP (item
) && STRINGP (XCAR (item
)))
7258 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7263 /* Maybe key binding cache. */
7264 if (CONSP (item
) && CONSP (XCAR (item
))
7265 && (NILP (XCAR (XCAR (item
)))
7266 || VECTORP (XCAR (XCAR (item
)))))
7268 cachelist
= XCAR (item
);
7272 /* This is the real definition--the function to run. */
7273 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7275 /* Get enable property, if any. */
7278 tem
= Fget (item
, Qmenu_enable
);
7279 if (!NILP (Venable_disabled_menus_and_buttons
))
7280 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7281 else if (!NILP (tem
))
7282 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7285 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7287 /* New format menu item. */
7288 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7289 start
= XCDR (item
);
7292 /* We have a real binding. */
7293 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7295 item
= XCDR (start
);
7296 /* Is there a cache list with key equivalences. */
7297 if (CONSP (item
) && CONSP (XCAR (item
)))
7299 cachelist
= XCAR (item
);
7303 /* Parse properties. */
7304 while (CONSP (item
) && CONSP (XCDR (item
)))
7309 if (EQ (tem
, QCenable
))
7311 if (!NILP (Venable_disabled_menus_and_buttons
))
7312 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7314 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7316 else if (EQ (tem
, QCvisible
) && !notreal
)
7318 /* If got a visible property and that evaluates to nil
7319 then ignore this item. */
7320 tem
= menu_item_eval_property (XCAR (item
));
7324 else if (EQ (tem
, QChelp
))
7325 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7326 else if (EQ (tem
, QCfilter
))
7328 else if (EQ (tem
, QCkey_sequence
))
7331 if (NILP (cachelist
)
7332 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7333 /* Be GC protected. Set keyhint to item instead of tem. */
7336 else if (EQ (tem
, QCkeys
))
7339 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7340 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7342 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7347 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7349 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7351 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7358 else if (inmenubar
|| !NILP (start
))
7362 return 0; /* not a menu item */
7364 /* If item string is not a string, evaluate it to get string.
7365 If we don't get a string, skip this item. */
7366 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7367 if (!(STRINGP (item_string
) || notreal
))
7369 item_string
= menu_item_eval_property (item_string
);
7370 if (!STRINGP (item_string
))
7372 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7375 /* If got a filter apply it on definition. */
7376 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7379 def
= menu_item_eval_property (list2 (XCAR (filter
),
7380 list2 (Qquote
, def
)));
7382 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7385 /* Enable or disable selection of item. */
7386 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7392 tem
= menu_item_eval_property (tem
);
7393 if (inmenubar
&& NILP (tem
))
7394 return 0; /* Ignore disabled items in menu bar. */
7395 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7398 /* If we got no definition, this item is just unselectable text which
7399 is OK in a submenu but not in the menubar. */
7401 return (inmenubar
? 0 : 1);
7403 /* See if this is a separate pane or a submenu. */
7404 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7405 tem
= get_keymap (def
, 0, 1);
7406 /* For a subkeymap, just record its details and exit. */
7409 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7410 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7414 /* At the top level in the menu bar, do likewise for commands also.
7415 The menu bar does not display equivalent key bindings anyway.
7416 ITEM_PROPERTY_DEF is already set up properly. */
7420 /* This is a command. See if there is an equivalent key binding. */
7421 if (NILP (cachelist
))
7423 /* We have to create a cachelist. */
7424 CHECK_IMPURE (start
);
7425 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7426 cachelist
= XCAR (XCDR (start
));
7428 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7429 if (!NILP (keyhint
))
7431 XSETCAR (cachelist
, XCAR (keyhint
));
7434 else if (STRINGP (tem
))
7436 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7437 XSETCAR (cachelist
, Qt
);
7441 tem
= XCAR (cachelist
);
7448 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7450 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7453 def
= XCAR (prefix
);
7454 prefix
= XCDR (prefix
);
7457 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7459 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7461 if (newcache
/* Always check first time. */
7462 /* Should we check everything when precomputing key
7464 /* If something had no key binding before, don't recheck it
7465 because that is too slow--except if we have a list of
7466 rebound commands in Vdefine_key_rebound_commands, do
7467 recheck any command that appears in that list. */
7468 || (CONSP (Vdefine_key_rebound_commands
)
7469 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7472 /* We had a saved key. Is it still bound to the command? */
7475 /* If the command is an alias for another
7476 (such as lmenu.el set it up), check if the
7477 original command matches the cached command. */
7478 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7479 chkcache
= 1; /* Need to recompute key binding. */
7483 /* Recompute equivalent key binding. If the command is an alias
7484 for another (such as lmenu.el set it up), see if the original
7485 command name has equivalent keys. Otherwise look up the
7486 specified command itself. We don't try both, because that
7487 makes lmenu menus slow. */
7489 && SYMBOLP (XSYMBOL (def
)->function
)
7490 && ! NILP (Fget (def
, Qmenu_alias
)))
7491 def
= XSYMBOL (def
)->function
;
7492 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7493 XSETCAR (cachelist
, tem
);
7496 XSETCDR (cachelist
, Qnil
);
7500 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7502 tem
= XCAR (cachelist
);
7506 newcache
= chkcache
;
7509 tem
= Fkey_description (tem
, Qnil
);
7512 if (STRINGP (XCAR (prefix
)))
7513 tem
= concat2 (XCAR (prefix
), tem
);
7514 if (STRINGP (XCDR (prefix
)))
7515 tem
= concat2 (tem
, XCDR (prefix
));
7517 XSETCDR (cachelist
, tem
);
7521 tem
= XCDR (cachelist
);
7522 if (newcache
&& !NILP (tem
))
7524 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7525 XSETCDR (cachelist
, tem
);
7528 /* If we only want to precompute equivalent key bindings, stop here. */
7532 /* If we have an equivalent key binding, use that. */
7533 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7535 /* Include this when menu help is implemented.
7536 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7537 if (!(NILP (tem) || STRINGP (tem)))
7539 tem = menu_item_eval_property (tem);
7542 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7546 /* Handle radio buttons or toggle boxes. */
7547 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7549 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7550 = menu_item_eval_property (tem
);
7557 /***********************************************************************
7559 ***********************************************************************/
7561 /* A vector holding tool bar items while they are parsed in function
7562 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7565 static Lisp_Object tool_bar_items_vector
;
7567 /* A vector holding the result of parse_tool_bar_item. Layout is like
7568 the one for a single item in tool_bar_items_vector. */
7570 static Lisp_Object tool_bar_item_properties
;
7572 /* Next free index in tool_bar_items_vector. */
7574 static int ntool_bar_items
;
7576 /* The symbols `tool-bar', and `:image'. */
7578 extern Lisp_Object Qtool_bar
;
7579 Lisp_Object QCimage
;
7581 /* Function prototypes. */
7583 static void init_tool_bar_items
P_ ((Lisp_Object
));
7584 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7585 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7586 static void append_tool_bar_item
P_ ((void));
7589 /* Return a vector of tool bar items for keymaps currently in effect.
7590 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7591 tool bar items found. */
7594 tool_bar_items (reuse
, nitems
)
7605 /* In order to build the menus, we need to call the keymap
7606 accessors. They all call QUIT. But this function is called
7607 during redisplay, during which a quit is fatal. So inhibit
7608 quitting while building the menus. We do this instead of
7609 specbind because (1) errors will clear it anyway and (2) this
7610 avoids risk of specpdl overflow. */
7611 oquit
= Vinhibit_quit
;
7614 /* Initialize tool_bar_items_vector and protect it from GC. */
7615 init_tool_bar_items (reuse
);
7617 /* Build list of keymaps in maps. Set nmaps to the number of maps
7620 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7621 if (!NILP (Voverriding_local_map_menu_flag
))
7623 /* Yes, use them (if non-nil) as well as the global map. */
7624 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7626 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7627 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7628 if (!NILP (Voverriding_local_map
))
7629 maps
[nmaps
++] = Voverriding_local_map
;
7633 /* No, so use major and minor mode keymaps and keymap property.
7634 Note that tool-bar bindings in the local-map and keymap
7635 properties may not work reliable, as they are only
7636 recognized when the tool-bar (or mode-line) is updated,
7637 which does not normally happen after every command. */
7640 nminor
= current_minor_maps (NULL
, &tmaps
);
7641 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7643 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7644 maps
[nmaps
++] = tem
;
7645 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7647 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7650 /* Add global keymap at the end. */
7651 maps
[nmaps
++] = current_global_map
;
7653 /* Process maps in reverse order and look up in each map the prefix
7655 for (i
= nmaps
- 1; i
>= 0; --i
)
7656 if (!NILP (maps
[i
]))
7660 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7665 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7666 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7668 Lisp_Object keydef
= XCAR (tail
);
7670 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7675 Vinhibit_quit
= oquit
;
7676 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7677 return tool_bar_items_vector
;
7681 /* Process the definition of KEY which is DEF. */
7684 process_tool_bar_item (key
, def
)
7685 Lisp_Object key
, def
;
7688 extern Lisp_Object Qundefined
;
7689 struct gcpro gcpro1
, gcpro2
;
7691 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7695 if (EQ (def
, Qundefined
))
7697 /* If a map has an explicit `undefined' as definition,
7698 discard any previously made item. */
7699 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7701 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7703 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7705 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7706 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7707 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7708 * sizeof (Lisp_Object
)));
7709 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7714 else if (parse_tool_bar_item (key
, def
))
7715 /* Append a new tool bar item to tool_bar_items_vector. Accept
7716 more than one definition for the same key. */
7717 append_tool_bar_item ();
7723 /* Parse a tool bar item specification ITEM for key KEY and return the
7724 result in tool_bar_item_properties. Value is zero if ITEM is
7727 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7729 CAPTION is the caption of the item, If it's not a string, it is
7730 evaluated to get a string.
7732 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7733 as binding are currently ignored.
7735 The following properties are recognized:
7739 FORM is evaluated and specifies whether the tool bar item is
7740 enabled or disabled.
7744 FORM is evaluated and specifies whether the tool bar item is visible.
7746 - `:filter FUNCTION'
7748 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7749 result is stored as the new binding.
7751 - `:button (TYPE SELECTED)'
7753 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7754 and specifies whether the button is selected (pressed) or not.
7758 IMAGES is either a single image specification or a vector of four
7759 image specifications. See enum tool_bar_item_images.
7761 - `:help HELP-STRING'.
7763 Gives a help string to display for the tool bar item. */
7766 parse_tool_bar_item (key
, item
)
7767 Lisp_Object key
, item
;
7769 /* Access slot with index IDX of vector tool_bar_item_properties. */
7770 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7772 Lisp_Object filter
= Qnil
;
7773 Lisp_Object caption
;
7776 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7777 Rule out items that aren't lists, don't start with
7778 `menu-item' or whose rest following `tool-bar-item' is not a
7781 || !EQ (XCAR (item
), Qmenu_item
)
7782 || (item
= XCDR (item
),
7786 /* Create tool_bar_item_properties vector if necessary. Reset it to
7788 if (VECTORP (tool_bar_item_properties
))
7790 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7794 tool_bar_item_properties
7795 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7798 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7799 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7801 /* Get the caption of the item. If the caption is not a string,
7802 evaluate it to get a string. If we don't get a string, skip this
7804 caption
= XCAR (item
);
7805 if (!STRINGP (caption
))
7807 caption
= menu_item_eval_property (caption
);
7808 if (!STRINGP (caption
))
7811 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7813 /* Give up if rest following the caption is not a list. */
7818 /* Store the binding. */
7819 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7822 /* Ignore cached key binding, if any. */
7823 if (CONSP (item
) && CONSP (XCAR (item
)))
7826 /* Process the rest of the properties. */
7827 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7829 Lisp_Object key
, value
;
7832 value
= XCAR (XCDR (item
));
7834 if (EQ (key
, QCenable
))
7836 /* `:enable FORM'. */
7837 if (!NILP (Venable_disabled_menus_and_buttons
))
7838 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7840 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7842 else if (EQ (key
, QCvisible
))
7844 /* `:visible FORM'. If got a visible property and that
7845 evaluates to nil then ignore this item. */
7846 if (NILP (menu_item_eval_property (value
)))
7849 else if (EQ (key
, QChelp
))
7850 /* `:help HELP-STRING'. */
7851 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7852 else if (EQ (key
, QCfilter
))
7853 /* ':filter FORM'. */
7855 else if (EQ (key
, QCbutton
) && CONSP (value
))
7857 /* `:button (TYPE . SELECTED)'. */
7858 Lisp_Object type
, selected
;
7860 type
= XCAR (value
);
7861 selected
= XCDR (value
);
7862 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7864 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7865 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7868 else if (EQ (key
, QCimage
)
7870 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7871 /* Value is either a single image specification or a vector
7872 of 4 such specifications for the different button states. */
7873 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7876 /* If got a filter apply it on binding. */
7878 PROP (TOOL_BAR_ITEM_BINDING
)
7879 = menu_item_eval_property (list2 (filter
,
7881 PROP (TOOL_BAR_ITEM_BINDING
))));
7883 /* See if the binding is a keymap. Give up if it is. */
7884 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7887 /* Enable or disable selection of item. */
7888 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7889 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7890 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7892 /* Handle radio buttons or toggle boxes. */
7893 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7894 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7895 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7903 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7904 that can be reused. */
7907 init_tool_bar_items (reuse
)
7910 if (VECTORP (reuse
))
7911 tool_bar_items_vector
= reuse
;
7913 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7914 ntool_bar_items
= 0;
7918 /* Append parsed tool bar item properties from
7919 tool_bar_item_properties */
7922 append_tool_bar_item ()
7924 Lisp_Object
*to
, *from
;
7926 /* Enlarge tool_bar_items_vector if necessary. */
7927 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7928 >= XVECTOR (tool_bar_items_vector
)->size
)
7930 Lisp_Object new_vector
;
7931 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7933 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7934 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7935 XVECTOR (new_vector
)->contents
,
7936 old_size
* sizeof (Lisp_Object
));
7937 tool_bar_items_vector
= new_vector
;
7940 /* Append entries from tool_bar_item_properties to the end of
7941 tool_bar_items_vector. */
7942 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7943 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7944 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7945 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7952 /* Read a character using menus based on maps in the array MAPS.
7953 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7954 Return t if we displayed a menu but the user rejected it.
7956 PREV_EVENT is the previous input event, or nil if we are reading
7957 the first event of a key sequence.
7959 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7960 if we used a mouse menu to read the input, or zero otherwise. If
7961 USED_MOUSE_MENU is null, we don't dereference it.
7963 The prompting is done based on the prompt-string of the map
7964 and the strings associated with various map elements.
7966 This can be done with X menus or with menus put in the minibuf.
7967 These are done in different ways, depending on how the input will be read.
7968 Menus using X are done after auto-saving in read-char, getting the input
7969 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7970 and do auto-saving in the inner call of read_char. */
7973 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7976 Lisp_Object prev_event
;
7977 int *used_mouse_menu
;
7980 register Lisp_Object name
= Qnil
;
7982 if (used_mouse_menu
)
7983 *used_mouse_menu
= 0;
7985 /* Use local over global Menu maps */
7987 if (! menu_prompting
)
7990 /* Optionally disregard all but the global map. */
7991 if (inhibit_local_menu_bar_menus
)
7993 maps
+= (nmaps
- 1);
7997 /* Get the menu name from the first map that has one (a prompt string). */
7998 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8000 name
= Fkeymap_prompt (maps
[mapno
]);
8005 /* If we don't have any menus, just read a character normally. */
8006 if (!STRINGP (name
))
8010 /* If we got to this point via a mouse click,
8011 use a real menu for mouse selection. */
8012 if (EVENT_HAS_PARAMETERS (prev_event
)
8013 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8014 && !EQ (XCAR (prev_event
), Qtool_bar
))
8016 /* Display the menu and get the selection. */
8017 Lisp_Object
*realmaps
8018 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8022 /* Use the maps that are not nil. */
8023 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8024 if (!NILP (maps
[mapno
]))
8025 realmaps
[nmaps1
++] = maps
[mapno
];
8027 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8032 record_menu_key (XCAR (value
));
8034 /* If we got multiple events, unread all but
8036 There is no way to prevent those unread events
8037 from showing up later in last_nonmenu_event.
8038 So turn symbol and integer events into lists,
8039 to indicate that they came from a mouse menu,
8040 so that when present in last_nonmenu_event
8041 they won't confuse things. */
8042 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8044 record_menu_key (XCAR (tem
));
8045 if (SYMBOLP (XCAR (tem
))
8046 || INTEGERP (XCAR (tem
)))
8047 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8050 /* If we got more than one event, put all but the first
8051 onto this list to be read later.
8052 Return just the first event now. */
8053 Vunread_command_events
8054 = nconc2 (XCDR (value
), Vunread_command_events
);
8055 value
= XCAR (value
);
8057 else if (NILP (value
))
8059 if (used_mouse_menu
)
8060 *used_mouse_menu
= 1;
8063 #endif /* HAVE_MENUS */
8067 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8068 We make this bigger when necessary, and never free it. */
8069 static char *read_char_minibuf_menu_text
;
8070 /* Size of that buffer. */
8071 static int read_char_minibuf_menu_width
;
8074 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8080 register Lisp_Object name
;
8082 /* FIXME: Use the minibuffer's frame width. */
8083 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8086 Lisp_Object rest
, vector
;
8092 if (! menu_prompting
)
8095 /* Make sure we have a big enough buffer for the menu text. */
8096 if (read_char_minibuf_menu_text
== 0)
8098 read_char_minibuf_menu_width
= width
+ 4;
8099 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8101 else if (width
+ 4 > read_char_minibuf_menu_width
)
8103 read_char_minibuf_menu_width
= width
+ 4;
8104 read_char_minibuf_menu_text
8105 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8107 menu
= read_char_minibuf_menu_text
;
8109 /* Get the menu name from the first map that has one (a prompt string). */
8110 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8112 name
= Fkeymap_prompt (maps
[mapno
]);
8117 /* If we don't have any menus, just read a character normally. */
8118 if (!STRINGP (name
))
8121 /* Prompt string always starts with map's prompt, and a space. */
8122 strcpy (menu
, SDATA (name
));
8123 nlength
= SBYTES (name
);
8124 menu
[nlength
++] = ':';
8125 menu
[nlength
++] = ' ';
8128 /* Start prompting at start of first map. */
8132 /* Present the documented bindings, a line at a time. */
8139 Lisp_Object orig_defn_macro
;
8141 /* Loop over elements of map. */
8146 /* If reached end of map, start at beginning of next map. */
8150 /* At end of last map, wrap around to first map if just starting,
8151 or end this line if already have something on it. */
8155 if (notfirst
|| nobindings
) break;
8160 /* Look at the next element of the map. */
8162 elt
= XVECTOR (vector
)->contents
[idx
];
8164 elt
= Fcar_safe (rest
);
8166 if (idx
< 0 && VECTORP (elt
))
8168 /* If we found a dense table in the keymap,
8169 advanced past it, but start scanning its contents. */
8170 rest
= Fcdr_safe (rest
);
8176 /* An ordinary element. */
8177 Lisp_Object event
, tem
;
8181 event
= Fcar_safe (elt
); /* alist */
8182 elt
= Fcdr_safe (elt
);
8186 XSETINT (event
, idx
); /* vector */
8189 /* Ignore the element if it has no prompt string. */
8190 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8192 /* 1 if the char to type matches the string. */
8194 Lisp_Object upcased_event
, downcased_event
;
8195 Lisp_Object desc
= Qnil
;
8197 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8199 upcased_event
= Fupcase (event
);
8200 downcased_event
= Fdowncase (event
);
8201 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8202 || XINT (downcased_event
) == SREF (s
, 0));
8204 desc
= Fsingle_key_description (event
, Qnil
);
8206 #if 0 /* It is redundant to list the equivalent key bindings because
8207 the prefix is what the user has already typed. */
8209 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8211 /* Insert equivalent keybinding. */
8212 s
= concat2 (s
, tem
);
8215 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8216 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8218 /* Insert button prefix. */
8219 Lisp_Object selected
8220 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8221 if (EQ (tem
, QCradio
))
8222 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8224 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8225 s
= concat2 (tem
, s
);
8229 /* If we have room for the prompt string, add it to this line.
8230 If this is the first on the line, always add it. */
8231 if ((SCHARS (s
) + i
+ 2
8232 + (char_matches
? 0 : SCHARS (desc
) + 3))
8238 /* Punctuate between strings. */
8241 strcpy (menu
+ i
, ", ");
8247 /* If the char to type doesn't match the string's
8248 first char, explicitly show what char to type. */
8251 /* Add as much of string as fits. */
8252 thiswidth
= SCHARS (desc
);
8253 if (thiswidth
+ i
> width
)
8254 thiswidth
= width
- i
;
8255 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8257 strcpy (menu
+ i
, " = ");
8261 /* Add as much of string as fits. */
8262 thiswidth
= SCHARS (s
);
8263 if (thiswidth
+ i
> width
)
8264 thiswidth
= width
- i
;
8265 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8271 /* If this element does not fit, end the line now,
8272 and save the element for the next line. */
8273 strcpy (menu
+ i
, "...");
8278 /* Move past this element. */
8279 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8280 /* Handle reaching end of dense table. */
8285 rest
= Fcdr_safe (rest
);
8289 /* Prompt with that and read response. */
8290 message2_nolog (menu
, strlen (menu
),
8291 ! NILP (current_buffer
->enable_multibyte_characters
));
8293 /* Make believe its not a keyboard macro in case the help char
8294 is pressed. Help characters are not recorded because menu prompting
8295 is not used on replay.
8297 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8298 current_kboard
->defining_kbd_macro
= Qnil
;
8300 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8301 while (BUFFERP (obj
));
8302 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8304 if (!INTEGERP (obj
))
8309 if (! EQ (obj
, menu_prompt_more_char
)
8310 && (!INTEGERP (menu_prompt_more_char
)
8311 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8313 if (!NILP (current_kboard
->defining_kbd_macro
))
8314 store_kbd_macro_char (obj
);
8317 /* Help char - go round again */
8321 /* Reading key sequences. */
8323 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8324 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8325 keymap, or nil otherwise. Return the index of the first keymap in
8326 which KEY has any binding, or NMAPS if no map has a binding.
8328 If KEY is a meta ASCII character, treat it like meta-prefix-char
8329 followed by the corresponding non-meta character. Keymaps in
8330 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8333 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8336 NEXT may be the same array as CURRENT. */
8339 follow_key (key
, nmaps
, current
, defs
, next
)
8341 Lisp_Object
*current
, *defs
, *next
;
8344 int i
, first_binding
;
8346 first_binding
= nmaps
;
8347 for (i
= nmaps
- 1; i
>= 0; i
--)
8349 if (! NILP (current
[i
]))
8351 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8352 if (! NILP (defs
[i
]))
8359 /* Given the set of bindings we've found, produce the next set of maps. */
8360 if (first_binding
< nmaps
)
8361 for (i
= 0; i
< nmaps
; i
++)
8362 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8364 return first_binding
;
8367 /* Structure used to keep track of partial application of key remapping
8368 such as Vfunction_key_map and Vkey_translation_map. */
8369 typedef struct keyremap
8371 Lisp_Object map
, parent
;
8375 /* Lookup KEY in MAP.
8376 MAP is a keymap mapping keys to key vectors or functions.
8377 If the mapping is a function and DO_FUNCTION is non-zero, then
8378 the function is called with PROMPT as parameter and its return
8379 value is used as the return value of this function (after checking
8380 that it is indeed a vector). */
8383 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8384 Lisp_Object map
, key
, prompt
;
8389 next
= access_keymap (map
, key
, 1, 0, 1);
8391 /* Handle symbol with autoload definition. */
8392 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8393 && CONSP (XSYMBOL (next
)->function
)
8394 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8395 do_autoload (XSYMBOL (next
)->function
, next
);
8397 /* Handle a symbol whose function definition is a keymap
8399 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8400 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8401 || KEYMAPP (XSYMBOL (next
)->function
)))
8402 next
= XSYMBOL (next
)->function
;
8404 /* If the keymap gives a function, not an
8405 array, then call the function with one arg and use
8406 its value instead. */
8407 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8412 next
= call1 (next
, prompt
);
8413 /* If the function returned something invalid,
8414 barf--don't ignore it.
8415 (To ignore it safely, we would need to gcpro a bunch of
8416 other variables.) */
8417 if (! (VECTORP (next
) || STRINGP (next
)))
8418 error ("Function %s returns invalid key sequence", tem
);
8423 /* Do one step of the key remapping used for function-key-map and
8424 key-translation-map:
8425 KEYBUF is the buffer holding the input events.
8426 BUFSIZE is its maximum size.
8427 FKEY is a pointer to the keyremap structure to use.
8428 INPUT is the index of the last element in KEYBUF.
8429 DOIT if non-zero says that the remapping can actually take place.
8430 DIFF is used to return the number of keys added/removed by the remapping.
8431 PARENT is the root of the keymap.
8432 PROMPT is the prompt to use if the remapping happens through a function.
8433 The return value is non-zero if the remapping actually took place. */
8436 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8437 Lisp_Object
*keybuf
, prompt
;
8439 int input
, doit
, *diff
, bufsize
;
8441 Lisp_Object next
, key
;
8443 key
= keybuf
[fkey
->end
++];
8444 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8446 /* If keybuf[fkey->start..fkey->end] is bound in the
8447 map and we're in a position to do the key remapping, replace it with
8448 the binding and restart with fkey->start at the end. */
8449 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8451 int len
= XFASTINT (Flength (next
));
8454 *diff
= len
- (fkey
->end
- fkey
->start
);
8456 if (input
+ *diff
>= bufsize
)
8457 error ("Key sequence too long");
8459 /* Shift the keys that follow fkey->end. */
8461 for (i
= fkey
->end
; i
< input
; i
++)
8462 keybuf
[i
+ *diff
] = keybuf
[i
];
8464 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8465 keybuf
[i
+ *diff
] = keybuf
[i
];
8466 /* Overwrite the old keys with the new ones. */
8467 for (i
= 0; i
< len
; i
++)
8468 keybuf
[fkey
->start
+ i
]
8469 = Faref (next
, make_number (i
));
8471 fkey
->start
= fkey
->end
+= *diff
;
8472 fkey
->map
= fkey
->parent
;
8477 fkey
->map
= get_keymap (next
, 0, 1);
8479 /* If we no longer have a bound suffix, try a new position for
8481 if (!CONSP (fkey
->map
))
8483 fkey
->end
= ++fkey
->start
;
8484 fkey
->map
= fkey
->parent
;
8489 /* Read a sequence of keys that ends with a non prefix character,
8490 storing it in KEYBUF, a buffer of size BUFSIZE.
8492 Return the length of the key sequence stored.
8493 Return -1 if the user rejected a command menu.
8495 Echo starting immediately unless `prompt' is 0.
8497 Where a key sequence ends depends on the currently active keymaps.
8498 These include any minor mode keymaps active in the current buffer,
8499 the current buffer's local map, and the global map.
8501 If a key sequence has no other bindings, we check Vfunction_key_map
8502 to see if some trailing subsequence might be the beginning of a
8503 function key's sequence. If so, we try to read the whole function
8504 key, and substitute its symbolic name into the key sequence.
8506 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8507 `double-' events into similar click events, if that would make them
8508 bound. We try to turn `triple-' events first into `double-' events,
8511 If we get a mouse click in a mode line, vertical divider, or other
8512 non-text area, we treat the click as if it were prefixed by the
8513 symbol denoting that area - `mode-line', `vertical-line', or
8516 If the sequence starts with a mouse click, we read the key sequence
8517 with respect to the buffer clicked on, not the current buffer.
8519 If the user switches frames in the midst of a key sequence, we put
8520 off the switch-frame event until later; the next call to
8521 read_char will return it.
8523 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8524 from the selected window's buffer. */
8527 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8528 can_return_switch_frame
, fix_current_buffer
)
8529 Lisp_Object
*keybuf
;
8532 int dont_downcase_last
;
8533 int can_return_switch_frame
;
8534 int fix_current_buffer
;
8536 volatile Lisp_Object from_string
;
8537 volatile int count
= SPECPDL_INDEX ();
8539 /* How many keys there are in the current key sequence. */
8542 /* The length of the echo buffer when we started reading, and
8543 the length of this_command_keys when we started reading. */
8544 volatile int echo_start
;
8545 volatile int keys_start
;
8547 /* The number of keymaps we're scanning right now, and the number of
8548 keymaps we have allocated space for. */
8550 volatile int nmaps_allocated
= 0;
8552 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8553 the current keymaps. */
8554 Lisp_Object
*volatile defs
= NULL
;
8556 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8557 in the current keymaps, or nil where it is not a prefix. */
8558 Lisp_Object
*volatile submaps
= NULL
;
8560 /* The local map to start out with at start of key sequence. */
8561 volatile Lisp_Object orig_local_map
;
8563 /* The map from the `keymap' property to start out with at start of
8565 volatile Lisp_Object orig_keymap
;
8567 /* 1 if we have already considered switching to the local-map property
8568 of the place where a mouse click occurred. */
8569 volatile int localized_local_map
= 0;
8571 /* The index in defs[] of the first keymap that has a binding for
8572 this key sequence. In other words, the lowest i such that
8573 defs[i] is non-nil. */
8574 volatile int first_binding
;
8575 /* Index of the first key that has no binding.
8576 It is useless to try fkey.start larger than that. */
8577 volatile int first_unbound
;
8579 /* If t < mock_input, then KEYBUF[t] should be read as the next
8582 We use this to recover after recognizing a function key. Once we
8583 realize that a suffix of the current key sequence is actually a
8584 function key's escape sequence, we replace the suffix with the
8585 function key's binding from Vfunction_key_map. Now keybuf
8586 contains a new and different key sequence, so the echo area,
8587 this_command_keys, and the submaps and defs arrays are wrong. In
8588 this situation, we set mock_input to t, set t to 0, and jump to
8589 restart_sequence; the loop will read keys from keybuf up until
8590 mock_input, thus rebuilding the state; and then it will resume
8591 reading characters from the keyboard. */
8592 volatile int mock_input
= 0;
8594 /* If the sequence is unbound in submaps[], then
8595 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8596 and fkey.map is its binding.
8598 These might be > t, indicating that all function key scanning
8599 should hold off until t reaches them. We do this when we've just
8600 recognized a function key, to avoid searching for the function
8601 key's again in Vfunction_key_map. */
8602 volatile keyremap fkey
;
8604 /* Likewise, for key_translation_map. */
8605 volatile keyremap keytran
;
8607 /* If we receive a `switch-frame' or `select-window' event in the middle of
8608 a key sequence, we put it off for later.
8609 While we're reading, we keep the event here. */
8610 volatile Lisp_Object delayed_switch_frame
;
8612 /* See the comment below... */
8613 #if defined (GOBBLE_FIRST_EVENT)
8614 Lisp_Object first_event
;
8617 volatile Lisp_Object original_uppercase
;
8618 volatile int original_uppercase_position
= -1;
8620 /* Gets around Microsoft compiler limitations. */
8623 struct buffer
*starting_buffer
;
8625 /* List of events for which a fake prefix key has been generated. */
8626 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8628 #if defined (GOBBLE_FIRST_EVENT)
8632 struct gcpro gcpro1
;
8634 GCPRO1 (fake_prefixed_keys
);
8635 raw_keybuf_count
= 0;
8637 last_nonmenu_event
= Qnil
;
8639 delayed_switch_frame
= Qnil
;
8640 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8641 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8642 /* If there is no translation-map, turn off scanning. */
8643 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8644 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8649 echo_prompt (prompt
);
8650 else if (cursor_in_echo_area
8651 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8652 && NILP (Fzerop (Vecho_keystrokes
)))
8653 /* This doesn't put in a dash if the echo buffer is empty, so
8654 you don't always see a dash hanging out in the minibuffer. */
8658 /* Record the initial state of the echo area and this_command_keys;
8659 we will need to restore them if we replay a key sequence. */
8661 echo_start
= echo_length ();
8662 keys_start
= this_command_key_count
;
8663 this_single_command_key_start
= keys_start
;
8665 #if defined (GOBBLE_FIRST_EVENT)
8666 /* This doesn't quite work, because some of the things that read_char
8667 does cannot safely be bypassed. It seems too risky to try to make
8670 /* Read the first char of the sequence specially, before setting
8671 up any keymaps, in case a filter runs and switches buffers on us. */
8672 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8674 #endif /* GOBBLE_FIRST_EVENT */
8676 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8677 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8680 /* We jump here when the key sequence has been thoroughly changed, and
8681 we need to rescan it starting from the beginning. When we jump here,
8682 keybuf[0..mock_input] holds the sequence we should reread. */
8685 starting_buffer
= current_buffer
;
8686 first_unbound
= bufsize
+ 1;
8688 /* Build our list of keymaps.
8689 If we recognize a function key and replace its escape sequence in
8690 keybuf with its symbol, or if the sequence starts with a mouse
8691 click and we need to switch buffers, we jump back here to rebuild
8692 the initial keymaps from the current buffer. */
8695 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8696 || !NILP (Voverriding_local_map
))
8698 if (3 > nmaps_allocated
)
8700 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8701 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8702 nmaps_allocated
= 3;
8704 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8705 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8706 if (!NILP (Voverriding_local_map
))
8707 submaps
[nmaps
++] = Voverriding_local_map
;
8715 nminor
= current_minor_maps (0, &maps
);
8716 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8718 if (total
> nmaps_allocated
)
8720 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8721 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8722 nmaps_allocated
= total
;
8725 if (!NILP (orig_keymap
))
8726 submaps
[nmaps
++] = orig_keymap
;
8728 bcopy (maps
, (void *) (submaps
+ nmaps
),
8729 nminor
* sizeof (submaps
[0]));
8733 submaps
[nmaps
++] = orig_local_map
;
8735 submaps
[nmaps
++] = current_global_map
;
8737 /* Find an accurate initial value for first_binding. */
8738 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8739 if (! NILP (submaps
[first_binding
]))
8742 /* Start from the beginning in keybuf. */
8745 /* These are no-ops the first time through, but if we restart, they
8746 revert the echo area and this_command_keys to their original state. */
8747 this_command_key_count
= keys_start
;
8748 if (INTERACTIVE
&& t
< mock_input
)
8749 echo_truncate (echo_start
);
8751 /* If the best binding for the current key sequence is a keymap, or
8752 we may be looking at a function key's escape sequence, keep on
8754 while (first_binding
< nmaps
8755 /* Keep reading as long as there's a prefix binding. */
8756 ? !NILP (submaps
[first_binding
])
8757 /* Don't return in the middle of a possible function key sequence,
8758 if the only bindings we found were via case conversion.
8759 Thus, if ESC O a has a function-key-map translation
8760 and ESC o has a binding, don't return after ESC O,
8761 so that we can translate ESC O plus the next character. */
8762 : (fkey
.start
< t
|| keytran
.start
< t
))
8765 int used_mouse_menu
= 0;
8767 /* Where the last real key started. If we need to throw away a
8768 key that has expanded into more than one element of keybuf
8769 (say, a mouse click on the mode line which is being treated
8770 as [mode-line (mouse-...)], then we backtrack to this point
8772 volatile int last_real_key_start
;
8774 /* These variables are analogous to echo_start and keys_start;
8775 while those allow us to restart the entire key sequence,
8776 echo_local_start and keys_local_start allow us to throw away
8778 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8780 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8781 eassert (fkey
.start
<= fkey
.end
);
8782 eassert (keytran
.start
<= keytran
.end
);
8783 /* key-translation-map is applied *after* function-key-map. */
8784 eassert (keytran
.end
<= fkey
.start
);
8786 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8787 { /* The prefix upto first_unbound has no binding and has
8788 no translation left to do either, so we know it's unbound.
8789 If we don't stop now, we risk staying here indefinitely
8790 (if the user keeps entering fkey or keytran prefixes
8791 like C-c ESC ESC ESC ESC ...) */
8793 for (i
= first_unbound
+ 1; i
< t
; i
++)
8794 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8795 mock_input
= t
- first_unbound
- 1;
8796 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8797 fkey
.map
= fkey
.parent
;
8798 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8799 keytran
.map
= keytran
.parent
;
8800 goto replay_sequence
;
8804 error ("Key sequence too long");
8807 echo_local_start
= echo_length ();
8808 keys_local_start
= this_command_key_count
;
8809 local_first_binding
= first_binding
;
8812 /* These are no-ops, unless we throw away a keystroke below and
8813 jumped back up to replay_key; in that case, these restore the
8814 variables to their original state, allowing us to replay the
8816 if (INTERACTIVE
&& t
< mock_input
)
8817 echo_truncate (echo_local_start
);
8818 this_command_key_count
= keys_local_start
;
8819 first_binding
= local_first_binding
;
8821 /* By default, assume each event is "real". */
8822 last_real_key_start
= t
;
8824 /* Does mock_input indicate that we are re-reading a key sequence? */
8828 add_command_key (key
);
8829 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8830 && NILP (Fzerop (Vecho_keystrokes
)))
8834 /* If not, we should actually read a character. */
8839 KBOARD
*interrupted_kboard
= current_kboard
;
8840 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8841 if (setjmp (wrong_kboard_jmpbuf
))
8843 if (!NILP (delayed_switch_frame
))
8845 interrupted_kboard
->kbd_queue
8846 = Fcons (delayed_switch_frame
,
8847 interrupted_kboard
->kbd_queue
);
8848 delayed_switch_frame
= Qnil
;
8851 interrupted_kboard
->kbd_queue
8852 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8854 /* If the side queue is non-empty, ensure it begins with a
8855 switch-frame, so we'll replay it in the right context. */
8856 if (CONSP (interrupted_kboard
->kbd_queue
)
8857 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8858 !(EVENT_HAS_PARAMETERS (key
)
8859 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8863 XSETFRAME (frame
, interrupted_frame
);
8864 interrupted_kboard
->kbd_queue
8865 = Fcons (make_lispy_switch_frame (frame
),
8866 interrupted_kboard
->kbd_queue
);
8869 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8870 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8871 goto replay_sequence
;
8874 key
= read_char (NILP (prompt
), nmaps
,
8875 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8879 /* read_char returns t when it shows a menu and the user rejects it.
8883 unbind_to (count
, Qnil
);
8888 /* read_char returns -1 at the end of a macro.
8889 Emacs 18 handles this by returning immediately with a
8890 zero, so that's what we'll do. */
8891 if (INTEGERP (key
) && XINT (key
) == -1)
8894 /* The Microsoft C compiler can't handle the goto that
8900 /* If the current buffer has been changed from under us, the
8901 keymap may have changed, so replay the sequence. */
8904 timer_resume_idle ();
8907 /* Reset the current buffer from the selected window
8908 in case something changed the former and not the latter.
8909 This is to be more consistent with the behavior
8910 of the command_loop_1. */
8911 if (fix_current_buffer
)
8913 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8915 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8916 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8919 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8920 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8921 goto replay_sequence
;
8924 /* If we have a quit that was typed in another frame, and
8925 quit_throw_to_read_char switched buffers,
8926 replay to get the right keymap. */
8928 && XINT (key
) == quit_char
8929 && current_buffer
!= starting_buffer
)
8932 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8936 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8937 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8938 goto replay_sequence
;
8943 if (EVENT_HAS_PARAMETERS (key
)
8944 /* Either a `switch-frame' or a `select-window' event. */
8945 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8947 /* If we're at the beginning of a key sequence, and the caller
8948 says it's okay, go ahead and return this event. If we're
8949 in the midst of a key sequence, delay it until the end. */
8950 if (t
> 0 || !can_return_switch_frame
)
8952 delayed_switch_frame
= key
;
8958 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8961 /* Clicks in non-text areas get prefixed by the symbol
8962 in their CHAR-ADDRESS field. For example, a click on
8963 the mode line is prefixed by the symbol `mode-line'.
8965 Furthermore, key sequences beginning with mouse clicks
8966 are read using the keymaps of the buffer clicked on, not
8967 the current buffer. So we may have to switch the buffer
8970 When we turn one event into two events, we must make sure
8971 that neither of the two looks like the original--so that,
8972 if we replay the events, they won't be expanded again.
8973 If not for this, such reexpansion could happen either here
8974 or when user programs play with this-command-keys. */
8975 if (EVENT_HAS_PARAMETERS (key
))
8980 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8981 if (EQ (kind
, Qmouse_click
))
8983 Lisp_Object window
, posn
;
8985 window
= POSN_WINDOW (EVENT_START (key
));
8986 posn
= POSN_POSN (EVENT_START (key
));
8989 || (!NILP (fake_prefixed_keys
)
8990 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8992 /* We're looking a second time at an event for which
8993 we generated a fake prefix key. Set
8994 last_real_key_start appropriately. */
8996 last_real_key_start
= t
- 1;
8999 /* Key sequences beginning with mouse clicks are
9000 read using the keymaps in the buffer clicked on,
9001 not the current buffer. If we're at the
9002 beginning of a key sequence, switch buffers. */
9003 if (last_real_key_start
== 0
9005 && BUFFERP (XWINDOW (window
)->buffer
)
9006 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9008 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9012 /* Arrange to go back to the original buffer once we're
9013 done reading the key sequence. Note that we can't
9014 use save_excursion_{save,restore} here, because they
9015 save point as well as the current buffer; we don't
9016 want to save point, because redisplay may change it,
9017 to accommodate a Fset_window_start or something. We
9018 don't want to do this at the top of the function,
9019 because we may get input from a subprocess which
9020 wants to change the selected window and stuff (say,
9022 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9024 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9026 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9027 orig_local_map
= get_local_map (PT
, current_buffer
,
9029 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9030 goto replay_sequence
;
9033 /* For a mouse click, get the local text-property keymap
9034 of the place clicked on, rather than point. */
9035 if (last_real_key_start
== 0
9036 && CONSP (XCDR (key
))
9037 && ! localized_local_map
)
9039 Lisp_Object map_here
, start
, pos
;
9041 localized_local_map
= 1;
9042 start
= EVENT_START (key
);
9044 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9046 pos
= POSN_BUFFER_POSN (start
);
9048 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9050 map_here
= get_local_map (XINT (pos
),
9051 current_buffer
, Qlocal_map
);
9052 if (!EQ (map_here
, orig_local_map
))
9054 orig_local_map
= map_here
;
9058 goto replay_sequence
;
9060 map_here
= get_local_map (XINT (pos
),
9061 current_buffer
, Qkeymap
);
9062 if (!EQ (map_here
, orig_keymap
))
9064 orig_keymap
= map_here
;
9068 goto replay_sequence
;
9074 /* Expand mode-line and scroll-bar events into two events:
9075 use posn as a fake prefix key. */
9077 && (NILP (fake_prefixed_keys
)
9078 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9080 if (t
+ 1 >= bufsize
)
9081 error ("Key sequence too long");
9084 keybuf
[t
+ 1] = key
;
9087 /* Record that a fake prefix key has been generated
9088 for KEY. Don't modify the event; this would
9089 prevent proper action when the event is pushed
9090 back into unread-command-events. */
9091 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9093 /* If on a mode line string with a local keymap,
9094 reconsider the key sequence with that keymap. */
9095 if (string
= POSN_STRING (EVENT_START (key
)),
9096 (CONSP (string
) && STRINGP (XCAR (string
))))
9098 Lisp_Object pos
, map
, map2
;
9100 pos
= XCDR (string
);
9101 string
= XCAR (string
);
9103 && XINT (pos
) < SCHARS (string
))
9105 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9107 orig_local_map
= map
;
9108 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9111 if (!NILP (map
) || !NILP (map2
))
9112 goto replay_sequence
;
9118 else if (NILP (from_string
)
9119 && (string
= POSN_STRING (EVENT_START (key
)),
9120 (CONSP (string
) && STRINGP (XCAR (string
)))))
9122 /* For a click on a string, i.e. overlay string or a
9123 string displayed via the `display' property,
9124 consider `local-map' and `keymap' properties of
9126 Lisp_Object pos
, map
, map2
;
9128 pos
= XCDR (string
);
9129 string
= XCAR (string
);
9131 && XINT (pos
) < SCHARS (string
))
9133 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9135 orig_local_map
= map
;
9136 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9140 if (!NILP (map
) || !NILP (map2
))
9142 from_string
= string
;
9143 goto replay_sequence
;
9148 else if (CONSP (XCDR (key
))
9149 && CONSP (EVENT_START (key
))
9150 && CONSP (XCDR (EVENT_START (key
))))
9154 posn
= POSN_POSN (EVENT_START (key
));
9155 /* Handle menu-bar events:
9156 insert the dummy prefix event `menu-bar'. */
9157 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9159 if (t
+ 1 >= bufsize
)
9160 error ("Key sequence too long");
9164 /* Zap the position in key, so we know that we've
9165 expanded it, and don't try to do so again. */
9166 POSN_SET_POSN (EVENT_START (key
),
9167 Fcons (posn
, Qnil
));
9170 goto replay_sequence
;
9172 else if (CONSP (posn
))
9174 /* We're looking at the second event of a
9175 sequence which we expanded before. Set
9176 last_real_key_start appropriately. */
9177 if (last_real_key_start
== t
&& t
> 0)
9178 last_real_key_start
= t
- 1;
9183 /* We have finally decided that KEY is something we might want
9185 first_binding
= (follow_key (key
,
9186 nmaps
- first_binding
,
9187 submaps
+ first_binding
,
9188 defs
+ first_binding
,
9189 submaps
+ first_binding
)
9192 /* If KEY wasn't bound, we'll try some fallbacks. */
9193 if (first_binding
< nmaps
)
9194 /* This is needed for the following scenario:
9195 event 0: a down-event that gets dropped by calling replay_key.
9196 event 1: some normal prefix like C-h.
9197 After event 0, first_unbound is 0, after event 1 fkey.start
9198 and keytran.start are both 1, so when we see that C-h is bound,
9199 we need to update first_unbound. */
9200 first_unbound
= max (t
+ 1, first_unbound
);
9205 /* Remember the position to put an upper bound on fkey.start. */
9206 first_unbound
= min (t
, first_unbound
);
9208 head
= EVENT_HEAD (key
);
9209 if (help_char_p (head
) && t
> 0)
9211 read_key_sequence_cmd
= Vprefix_help_command
;
9213 last_nonmenu_event
= key
;
9214 /* The Microsoft C compiler can't handle the goto that
9222 Lisp_Object breakdown
;
9225 breakdown
= parse_modifiers (head
);
9226 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9227 /* Attempt to reduce an unbound mouse event to a simpler
9228 event that is bound:
9229 Drags reduce to clicks.
9230 Double-clicks reduce to clicks.
9231 Triple-clicks reduce to double-clicks, then to clicks.
9232 Down-clicks are eliminated.
9233 Double-downs reduce to downs, then are eliminated.
9234 Triple-downs reduce to double-downs, then to downs,
9235 then are eliminated. */
9236 if (modifiers
& (down_modifier
| drag_modifier
9237 | double_modifier
| triple_modifier
))
9239 while (modifiers
& (down_modifier
| drag_modifier
9240 | double_modifier
| triple_modifier
))
9242 Lisp_Object new_head
, new_click
;
9243 if (modifiers
& triple_modifier
)
9244 modifiers
^= (double_modifier
| triple_modifier
);
9245 else if (modifiers
& double_modifier
)
9246 modifiers
&= ~double_modifier
;
9247 else if (modifiers
& drag_modifier
)
9248 modifiers
&= ~drag_modifier
;
9251 /* Dispose of this `down' event by simply jumping
9252 back to replay_key, to get another event.
9254 Note that if this event came from mock input,
9255 then just jumping back to replay_key will just
9256 hand it to us again. So we have to wipe out any
9259 We could delete keybuf[t] and shift everything
9260 after that to the left by one spot, but we'd also
9261 have to fix up any variable that points into
9262 keybuf, and shifting isn't really necessary
9265 Adding prefixes for non-textual mouse clicks
9266 creates two characters of mock input, and both
9267 must be thrown away. If we're only looking at
9268 the prefix now, we can just jump back to
9269 replay_key. On the other hand, if we've already
9270 processed the prefix, and now the actual click
9271 itself is giving us trouble, then we've lost the
9272 state of the keymaps we want to backtrack to, and
9273 we need to replay the whole sequence to rebuild
9276 Beyond that, only function key expansion could
9277 create more than two keys, but that should never
9278 generate mouse events, so it's okay to zero
9279 mock_input in that case too.
9281 FIXME: The above paragraph seems just plain
9282 wrong, if you consider things like
9283 xterm-mouse-mode. -stef
9285 Isn't this just the most wonderful code ever? */
9287 /* If mock_input > t + 1, the above simplification
9288 will actually end up dropping keys on the floor.
9289 This is probably OK for now, but even
9290 if mock_input <= t + 1, we need to adjust fkey
9292 Typical case [header-line down-mouse-N]:
9293 mock_input = 2, t = 1, fkey.end = 1,
9294 last_real_key_start = 0. */
9295 if (fkey
.end
> last_real_key_start
)
9297 fkey
.end
= fkey
.start
9298 = min (last_real_key_start
, fkey
.start
);
9299 fkey
.map
= fkey
.parent
;
9300 if (keytran
.end
> last_real_key_start
)
9302 keytran
.end
= keytran
.start
9303 = min (last_real_key_start
, keytran
.start
);
9304 keytran
.map
= keytran
.parent
;
9307 if (t
== last_real_key_start
)
9314 mock_input
= last_real_key_start
;
9315 goto replay_sequence
;
9320 = apply_modifiers (modifiers
, XCAR (breakdown
));
9322 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9324 /* Look for a binding for this new key. follow_key
9325 promises that it didn't munge submaps the
9326 last time we called it, since key was unbound. */
9328 = (follow_key (new_click
,
9329 nmaps
- local_first_binding
,
9330 submaps
+ local_first_binding
,
9331 defs
+ local_first_binding
,
9332 submaps
+ local_first_binding
)
9333 + local_first_binding
);
9335 /* If that click is bound, go for it. */
9336 if (first_binding
< nmaps
)
9341 /* Otherwise, we'll leave key set to the drag event. */
9348 /* Normally, last_nonmenu_event gets the previous key we read.
9349 But when a mouse popup menu is being used,
9350 we don't update last_nonmenu_event; it continues to hold the mouse
9351 event that preceded the first level of menu. */
9352 if (!used_mouse_menu
)
9353 last_nonmenu_event
= key
;
9355 /* Record what part of this_command_keys is the current key sequence. */
9356 this_single_command_key_start
= this_command_key_count
- t
;
9358 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9359 /* There is a binding and it's not a prefix.
9360 There is thus no function-key in this sequence.
9361 Moving fkey.start is important in this case to allow keytran.start
9362 to go over the sequence before we return (since we keep the
9363 invariant that keytran.end <= fkey.start). */
9366 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9369 /* If the sequence is unbound, see if we can hang a function key
9370 off the end of it. */
9371 /* Continue scan from fkey.end until we find a bound suffix. */
9372 while (fkey
.end
< t
)
9374 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9377 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9378 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9379 max (t
, mock_input
),
9380 /* If there's a binding (i.e.
9381 first_binding >= nmaps) we don't want
9382 to apply this function-key-mapping. */
9383 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9388 mock_input
= diff
+ max (t
, mock_input
);
9389 goto replay_sequence
;
9393 /* Look for this sequence in key-translation-map.
9394 Scan from keytran.end until we find a bound suffix. */
9395 while (keytran
.end
< fkey
.start
)
9397 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9400 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9401 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9406 mock_input
= diff
+ max (t
, mock_input
);
9407 /* Adjust the function-key-map counters. */
9411 goto replay_sequence
;
9415 /* If KEY is not defined in any of the keymaps,
9416 and cannot be part of a function key or translation,
9417 and is an upper case letter
9418 use the corresponding lower-case letter instead. */
9419 if (first_binding
>= nmaps
9420 && fkey
.start
>= t
&& keytran
.start
>= t
9422 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9423 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9424 || (XINT (key
) & shift_modifier
)))
9426 Lisp_Object new_key
;
9428 original_uppercase
= key
;
9429 original_uppercase_position
= t
- 1;
9431 if (XINT (key
) & shift_modifier
)
9432 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9434 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9435 | (XINT (key
) & ~CHAR_MODIFIER_MASK
)));
9437 /* We have to do this unconditionally, regardless of whether
9438 the lower-case char is defined in the keymaps, because they
9439 might get translated through function-key-map. */
9440 keybuf
[t
- 1] = new_key
;
9441 mock_input
= max (t
, mock_input
);
9443 goto replay_sequence
;
9445 /* If KEY is not defined in any of the keymaps,
9446 and cannot be part of a function key or translation,
9447 and is a shifted function key,
9448 use the corresponding unshifted function key instead. */
9449 if (first_binding
>= nmaps
9450 && fkey
.start
>= t
&& keytran
.start
>= t
9453 Lisp_Object breakdown
;
9456 breakdown
= parse_modifiers (key
);
9457 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9458 if (modifiers
& shift_modifier
)
9460 Lisp_Object new_key
;
9462 original_uppercase
= key
;
9463 original_uppercase_position
= t
- 1;
9465 modifiers
&= ~shift_modifier
;
9466 new_key
= apply_modifiers (modifiers
,
9469 keybuf
[t
- 1] = new_key
;
9470 mock_input
= max (t
, mock_input
);
9471 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9472 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9474 goto replay_sequence
;
9480 read_key_sequence_cmd
= (first_binding
< nmaps
9481 ? defs
[first_binding
]
9484 unread_switch_frame
= delayed_switch_frame
;
9485 unbind_to (count
, Qnil
);
9487 /* Don't downcase the last character if the caller says don't.
9488 Don't downcase it if the result is undefined, either. */
9489 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9490 && t
- 1 == original_uppercase_position
)
9491 keybuf
[t
- 1] = original_uppercase
;
9493 /* Occasionally we fabricate events, perhaps by expanding something
9494 according to function-key-map, or by adding a prefix symbol to a
9495 mouse click in the scroll bar or modeline. In this cases, return
9496 the entire generated key sequence, even if we hit an unbound
9497 prefix or a definition before the end. This means that you will
9498 be able to push back the event properly, and also means that
9499 read-key-sequence will always return a logical unit.
9502 for (; t
< mock_input
; t
++)
9504 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9505 && NILP (Fzerop (Vecho_keystrokes
)))
9506 echo_char (keybuf
[t
]);
9507 add_command_key (keybuf
[t
]);
9516 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9517 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9518 The sequence is sufficient to specify a non-prefix command in the
9519 current local and global maps.
9521 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9522 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9523 as a continuation of the previous key.
9525 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9526 convert the last event to lower case. (Normally any upper case event
9527 is converted to lower case if the original event is undefined and the lower
9528 case equivalent is defined.) A non-nil value is appropriate for reading
9529 a key sequence to be defined.
9531 A C-g typed while in this function is treated like any other character,
9532 and `quit-flag' is not set.
9534 If the key sequence starts with a mouse click, then the sequence is read
9535 using the keymaps of the buffer of the window clicked in, not the buffer
9536 of the selected window as normal.
9538 `read-key-sequence' drops unbound button-down events, since you normally
9539 only care about the click or drag events which follow them. If a drag
9540 or multi-click event is unbound, but the corresponding click event would
9541 be bound, `read-key-sequence' turns the event into a click event at the
9542 drag's starting position. This means that you don't have to distinguish
9543 between click and drag, double, or triple events unless you want to.
9545 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9546 lines separating windows, and scroll bars with imaginary keys
9547 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9549 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9550 function will process a switch-frame event if the user switches frames
9551 before typing anything. If the user switches frames in the middle of a
9552 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9553 is nil, then the event will be put off until after the current key sequence.
9555 `read-key-sequence' checks `function-key-map' for function key
9556 sequences, where they wouldn't conflict with ordinary bindings. See
9557 `function-key-map' for more details.
9559 The optional fifth argument COMMAND-LOOP, if non-nil, means
9560 that this key sequence is being read by something that will
9561 read commands one after another. It should be nil if the caller
9562 will read just one key sequence. */)
9563 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9565 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9566 Lisp_Object can_return_switch_frame
, command_loop
;
9568 Lisp_Object keybuf
[30];
9570 struct gcpro gcpro1
;
9571 int count
= SPECPDL_INDEX ();
9574 CHECK_STRING (prompt
);
9577 specbind (Qinput_method_exit_on_first_char
,
9578 (NILP (command_loop
) ? Qt
: Qnil
));
9579 specbind (Qinput_method_use_echo_area
,
9580 (NILP (command_loop
) ? Qt
: Qnil
));
9582 bzero (keybuf
, sizeof keybuf
);
9584 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9586 if (NILP (continue_echo
))
9588 this_command_key_count
= 0;
9589 this_command_key_count_reset
= 0;
9590 this_single_command_key_start
= 0;
9593 #ifdef HAVE_X_WINDOWS
9594 if (display_hourglass_p
)
9595 cancel_hourglass ();
9598 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9599 prompt
, ! NILP (dont_downcase_last
),
9600 ! NILP (can_return_switch_frame
), 0);
9602 #if 0 /* The following is fine for code reading a key sequence and
9603 then proceeding with a lenghty computation, but it's not good
9604 for code reading keys in a loop, like an input method. */
9605 #ifdef HAVE_X_WINDOWS
9606 if (display_hourglass_p
)
9617 return unbind_to (count
, make_event_array (i
, keybuf
));
9620 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9621 Sread_key_sequence_vector
, 1, 5, 0,
9622 doc
: /* Like `read-key-sequence' but always return a vector. */)
9623 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9625 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9626 Lisp_Object can_return_switch_frame
, command_loop
;
9628 Lisp_Object keybuf
[30];
9630 struct gcpro gcpro1
;
9631 int count
= SPECPDL_INDEX ();
9634 CHECK_STRING (prompt
);
9637 specbind (Qinput_method_exit_on_first_char
,
9638 (NILP (command_loop
) ? Qt
: Qnil
));
9639 specbind (Qinput_method_use_echo_area
,
9640 (NILP (command_loop
) ? Qt
: Qnil
));
9642 bzero (keybuf
, sizeof keybuf
);
9644 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9646 if (NILP (continue_echo
))
9648 this_command_key_count
= 0;
9649 this_command_key_count_reset
= 0;
9650 this_single_command_key_start
= 0;
9653 #ifdef HAVE_X_WINDOWS
9654 if (display_hourglass_p
)
9655 cancel_hourglass ();
9658 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9659 prompt
, ! NILP (dont_downcase_last
),
9660 ! NILP (can_return_switch_frame
), 0);
9662 #ifdef HAVE_X_WINDOWS
9663 if (display_hourglass_p
)
9673 return unbind_to (count
, Fvector (i
, keybuf
));
9676 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9677 doc
: /* Execute CMD as an editor command.
9678 CMD must be a symbol that satisfies the `commandp' predicate.
9679 Optional second arg RECORD-FLAG non-nil
9680 means unconditionally put this command in `command-history'.
9681 Otherwise, that is done only if an arg is read using the minibuffer.
9682 The argument KEYS specifies the value to use instead of (this-command-keys)
9683 when reading the arguments; if it is nil, (this-command-keys) is used.
9684 The argument SPECIAL, if non-nil, means that this command is executing
9685 a special event, so ignore the prefix argument and don't clear it. */)
9686 (cmd
, record_flag
, keys
, special
)
9687 Lisp_Object cmd
, record_flag
, keys
, special
;
9689 register Lisp_Object final
;
9690 register Lisp_Object tem
;
9691 Lisp_Object prefixarg
;
9692 struct backtrace backtrace
;
9693 extern int debug_on_next_call
;
9695 debug_on_next_call
= 0;
9699 prefixarg
= current_kboard
->Vprefix_arg
;
9700 Vcurrent_prefix_arg
= prefixarg
;
9701 current_kboard
->Vprefix_arg
= Qnil
;
9708 tem
= Fget (cmd
, Qdisabled
);
9709 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9711 tem
= Fsymbol_value (Qdisabled_command_function
);
9713 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9719 final
= Findirect_function (cmd
, Qnil
);
9721 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9723 struct gcpro gcpro1
, gcpro2
;
9725 GCPRO2 (cmd
, prefixarg
);
9726 do_autoload (final
, cmd
);
9733 if (STRINGP (final
) || VECTORP (final
))
9735 /* If requested, place the macro in the command history. For
9736 other sorts of commands, call-interactively takes care of
9738 if (!NILP (record_flag
))
9741 = Fcons (Fcons (Qexecute_kbd_macro
,
9742 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9745 /* Don't keep command history around forever. */
9746 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9748 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9750 XSETCDR (tem
, Qnil
);
9754 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9757 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9759 backtrace
.next
= backtrace_list
;
9760 backtrace_list
= &backtrace
;
9761 backtrace
.function
= &Qcall_interactively
;
9762 backtrace
.args
= &cmd
;
9763 backtrace
.nargs
= 1;
9764 backtrace
.evalargs
= 0;
9765 backtrace
.debug_on_exit
= 0;
9767 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9769 backtrace_list
= backtrace
.next
;
9777 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9779 doc
: /* Read function name, then read its arguments and call it. */)
9781 Lisp_Object prefixarg
;
9783 Lisp_Object function
;
9785 int saved_last_point_position
;
9786 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9787 Lisp_Object bindings
, value
;
9788 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9789 #ifdef HAVE_X_WINDOWS
9790 /* The call to Fcompleting_read wil start and cancel the hourglass,
9791 but if the hourglass was already scheduled, this means that no
9792 hourglass will be shown for the actual M-x command itself.
9793 So we restart it if it is already scheduled. Note that checking
9794 hourglass_shown_p is not enough, normally the hourglass is not shown,
9795 just scheduled to be shown. */
9796 int hstarted
= hourglass_started ();
9799 saved_keys
= Fvector (this_command_key_count
,
9800 XVECTOR (this_command_keys
)->contents
);
9801 saved_last_point_position_buffer
= last_point_position_buffer
;
9802 saved_last_point_position
= last_point_position
;
9804 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9806 if (EQ (prefixarg
, Qminus
))
9808 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9809 strcpy (buf
, "C-u ");
9810 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9811 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9812 else if (INTEGERP (prefixarg
))
9813 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9815 /* This isn't strictly correct if execute-extended-command
9816 is bound to anything else. Perhaps it should use
9817 this_command_keys? */
9818 strcat (buf
, "M-x ");
9820 /* Prompt with buf, and then read a string, completing from and
9821 restricting to the set of all defined commands. Don't provide
9822 any initial input. Save the command read on the extended-command
9824 function
= Fcompleting_read (build_string (buf
),
9825 Vobarray
, Qcommandp
,
9826 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9829 #ifdef HAVE_X_WINDOWS
9830 if (hstarted
) start_hourglass ();
9833 if (STRINGP (function
) && SCHARS (function
) == 0)
9834 error ("No command name given");
9836 /* Set this_command_keys to the concatenation of saved_keys and
9837 function, followed by a RET. */
9842 this_command_key_count
= 0;
9843 this_command_key_count_reset
= 0;
9844 this_single_command_key_start
= 0;
9846 keys
= XVECTOR (saved_keys
)->contents
;
9847 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9848 add_command_key (keys
[i
]);
9850 for (i
= 0; i
< SCHARS (function
); i
++)
9851 add_command_key (Faref (function
, make_number (i
)));
9853 add_command_key (make_number ('\015'));
9856 last_point_position
= saved_last_point_position
;
9857 last_point_position_buffer
= saved_last_point_position_buffer
;
9861 function
= Fintern (function
, Qnil
);
9862 current_kboard
->Vprefix_arg
= prefixarg
;
9863 Vthis_command
= function
;
9864 real_this_command
= function
;
9866 /* If enabled, show which key runs this command. */
9867 if (!NILP (Vsuggest_key_bindings
)
9868 && NILP (Vexecuting_kbd_macro
)
9869 && SYMBOLP (function
))
9870 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9876 GCPRO2 (bindings
, value
);
9877 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9879 /* If the command has a key binding, print it now. */
9880 if (!NILP (bindings
)
9881 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9884 /* But first wait, and skip the message if there is input. */
9886 if (!NILP (echo_area_buffer
[0]))
9887 /* This command displayed something in the echo area;
9888 so wait a few seconds, then display our suggestion message. */
9889 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9890 ? XINT (Vsuggest_key_bindings
) : 2);
9892 /* This command left the echo area empty,
9893 so display our message immediately. */
9896 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9897 && ! CONSP (Vunread_command_events
))
9899 Lisp_Object binding
;
9901 int message_p
= push_message ();
9902 int count
= SPECPDL_INDEX ();
9904 record_unwind_protect (pop_message_unwind
, Qnil
);
9905 binding
= Fkey_description (bindings
, Qnil
);
9908 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9911 sprintf (newmessage
, "You can run the command `%s' with %s",
9912 SDATA (SYMBOL_NAME (function
)),
9914 message2_nolog (newmessage
,
9915 strlen (newmessage
),
9916 STRING_MULTIBYTE (binding
));
9917 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9918 ? Vsuggest_key_bindings
: make_number (2)),
9923 unbind_to (count
, Qnil
);
9927 RETURN_UNGCPRO (value
);
9931 /* Return nonzero if input events are pending. */
9934 detect_input_pending ()
9937 get_input_pending (&input_pending
, 0);
9939 return input_pending
;
9942 /* Return nonzero if input events other than mouse movements are
9946 detect_input_pending_ignore_squeezables ()
9949 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9951 return input_pending
;
9954 /* Return nonzero if input events are pending, and run any pending timers. */
9957 detect_input_pending_run_timers (do_display
)
9960 int old_timers_run
= timers_run
;
9963 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
9965 if (old_timers_run
!= timers_run
&& do_display
)
9967 redisplay_preserve_echo_area (8);
9968 /* The following fixes a bug when using lazy-lock with
9969 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9970 from an idle timer function. The symptom of the bug is that
9971 the cursor sometimes doesn't become visible until the next X
9972 event is processed. --gerd. */
9974 rif
->flush_display (NULL
);
9977 return input_pending
;
9980 /* This is called in some cases before a possible quit.
9981 It cases the next call to detect_input_pending to recompute input_pending.
9982 So calling this function unnecessarily can't do any harm. */
9985 clear_input_pending ()
9990 /* Return nonzero if there are pending requeued events.
9991 This isn't used yet. The hope is to make wait_reading_process_output
9992 call it, and return if it runs Lisp code that unreads something.
9993 The problem is, kbd_buffer_get_event needs to be fixed to know what
9994 to do in that case. It isn't trivial. */
9997 requeued_events_pending_p ()
9999 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10003 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10004 doc
: /* Return t if command input is currently available with no wait.
10005 Actually, the value is nil only if we can be sure that no input is available;
10006 if there is a doubt, the value is t. */)
10009 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
10012 get_input_pending (&input_pending
,
10013 READABLE_EVENTS_DO_TIMERS_NOW
10014 | READABLE_EVENTS_FILTER_EVENTS
);
10015 return input_pending
> 0 ? Qt
: Qnil
;
10018 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10019 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10022 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10025 if (total_keys
< NUM_RECENT_KEYS
)
10026 return Fvector (total_keys
, keys
);
10029 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10030 bcopy (keys
+ recent_keys_index
,
10031 XVECTOR (val
)->contents
,
10032 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10034 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10035 recent_keys_index
* sizeof (Lisp_Object
));
10040 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10041 doc
: /* Return the key sequence that invoked this command.
10042 However, if the command has called `read-key-sequence', it returns
10043 the last key sequence that has been read.
10044 The value is a string or a vector. */)
10047 return make_event_array (this_command_key_count
,
10048 XVECTOR (this_command_keys
)->contents
);
10051 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10052 doc
: /* Return the key sequence that invoked this command, as a vector.
10053 However, if the command has called `read-key-sequence', it returns
10054 the last key sequence that has been read. */)
10057 return Fvector (this_command_key_count
,
10058 XVECTOR (this_command_keys
)->contents
);
10061 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10062 Sthis_single_command_keys
, 0, 0, 0,
10063 doc
: /* Return the key sequence that invoked this command.
10064 More generally, it returns the last key sequence read, either by
10065 the command loop or by `read-key-sequence'.
10066 Unlike `this-command-keys', this function's value
10067 does not include prefix arguments.
10068 The value is always a vector. */)
10071 return Fvector (this_command_key_count
10072 - this_single_command_key_start
,
10073 (XVECTOR (this_command_keys
)->contents
10074 + this_single_command_key_start
));
10077 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10078 Sthis_single_command_raw_keys
, 0, 0, 0,
10079 doc
: /* Return the raw events that were read for this command.
10080 More generally, it returns the last key sequence read, either by
10081 the command loop or by `read-key-sequence'.
10082 Unlike `this-single-command-keys', this function's value
10083 shows the events before all translations (except for input methods).
10084 The value is always a vector. */)
10087 return Fvector (raw_keybuf_count
,
10088 (XVECTOR (raw_keybuf
)->contents
));
10091 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10092 Sreset_this_command_lengths
, 0, 0, 0,
10093 doc
: /* Make the unread events replace the last command and echo.
10094 Used in `universal-argument-other-key'.
10096 `universal-argument-other-key' rereads the event just typed.
10097 It then gets translated through `function-key-map'.
10098 The translated event has to replace the real events,
10099 both in the value of (this-command-keys) and in echoing.
10100 To achieve this, `universal-argument-other-key' calls
10101 `reset-this-command-lengths', which discards the record of reading
10102 these events the first time. */)
10105 this_command_key_count
= before_command_key_count
;
10106 if (this_command_key_count
< this_single_command_key_start
)
10107 this_single_command_key_start
= this_command_key_count
;
10109 echo_truncate (before_command_echo_length
);
10111 /* Cause whatever we put into unread-command-events
10112 to echo as if it were being freshly read from the keyboard. */
10113 this_command_key_count_reset
= 1;
10118 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10119 Sclear_this_command_keys
, 0, 1, 0,
10120 doc
: /* Clear out the vector that `this-command-keys' returns.
10121 Also clear the record of the last 100 events, unless optional arg
10122 KEEP-RECORD is non-nil. */)
10124 Lisp_Object keep_record
;
10128 this_command_key_count
= 0;
10129 this_command_key_count_reset
= 0;
10131 if (NILP (keep_record
))
10133 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10134 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10136 recent_keys_index
= 0;
10141 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10142 doc
: /* Return the current depth in recursive edits. */)
10146 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10150 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10151 "FOpen dribble file: ",
10152 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10153 If FILE is nil, close any open dribble file. */)
10164 file
= Fexpand_file_name (file
, Qnil
);
10165 dribble
= fopen (SDATA (file
), "w");
10167 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10172 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10173 doc
: /* Discard the contents of the terminal input buffer.
10174 Also end any kbd macro being defined. */)
10177 if (!NILP (current_kboard
->defining_kbd_macro
))
10179 /* Discard the last command from the macro. */
10180 Fcancel_kbd_macro_events ();
10184 update_mode_lines
++;
10186 Vunread_command_events
= Qnil
;
10187 unread_command_char
= -1;
10189 discard_tty_input ();
10191 kbd_fetch_ptr
= kbd_store_ptr
;
10197 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10198 doc
: /* Stop Emacs and return to superior process. You can resume later.
10199 If `cannot-suspend' is non-nil, or if the system doesn't support job
10200 control, run a subshell instead.
10202 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10203 to be read as terminal input by Emacs's parent, after suspension.
10205 Before suspending, run the normal hook `suspend-hook'.
10206 After resumption run the normal hook `suspend-resume-hook'.
10208 Some operating systems cannot stop the Emacs process and resume it later.
10209 On such systems, Emacs starts a subshell instead of suspending. */)
10211 Lisp_Object stuffstring
;
10213 int count
= SPECPDL_INDEX ();
10214 int old_height
, old_width
;
10216 struct gcpro gcpro1
;
10218 if (!NILP (stuffstring
))
10219 CHECK_STRING (stuffstring
);
10221 /* Run the functions in suspend-hook. */
10222 if (!NILP (Vrun_hooks
))
10223 call1 (Vrun_hooks
, intern ("suspend-hook"));
10225 GCPRO1 (stuffstring
);
10226 get_frame_size (&old_width
, &old_height
);
10227 reset_sys_modes ();
10228 /* sys_suspend can get an error if it tries to fork a subshell
10229 and the system resources aren't available for that. */
10230 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10232 stuff_buffered_input (stuffstring
);
10233 if (cannot_suspend
)
10237 unbind_to (count
, Qnil
);
10239 /* Check if terminal/window size has changed.
10240 Note that this is not useful when we are running directly
10241 with a window system; but suspend should be disabled in that case. */
10242 get_frame_size (&width
, &height
);
10243 if (width
!= old_width
|| height
!= old_height
)
10244 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10246 /* Run suspend-resume-hook. */
10247 if (!NILP (Vrun_hooks
))
10248 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10254 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10255 Then in any case stuff anything Emacs has read ahead and not used. */
10258 stuff_buffered_input (stuffstring
)
10259 Lisp_Object stuffstring
;
10261 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10262 register unsigned char *p
;
10264 if (STRINGP (stuffstring
))
10266 register int count
;
10268 p
= SDATA (stuffstring
);
10269 count
= SBYTES (stuffstring
);
10270 while (count
-- > 0)
10275 /* Anything we have read ahead, put back for the shell to read. */
10276 /* ?? What should this do when we have multiple keyboards??
10277 Should we ignore anything that was typed in at the "wrong" kboard?
10279 rms: we should stuff everything back into the kboard
10281 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10284 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10285 kbd_fetch_ptr
= kbd_buffer
;
10286 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10287 stuff_char (kbd_fetch_ptr
->code
);
10289 clear_event (kbd_fetch_ptr
);
10293 #endif /* SIGTSTP */
10297 set_waiting_for_input (time_to_clear
)
10298 EMACS_TIME
*time_to_clear
;
10300 input_available_clear_time
= time_to_clear
;
10302 /* Tell interrupt_signal to throw back to read_char, */
10303 waiting_for_input
= 1;
10305 /* If interrupt_signal was called before and buffered a C-g,
10306 make it run again now, to avoid timing error. */
10307 if (!NILP (Vquit_flag
))
10308 quit_throw_to_read_char ();
10312 clear_waiting_for_input ()
10314 /* Tell interrupt_signal not to throw back to read_char, */
10315 waiting_for_input
= 0;
10316 input_available_clear_time
= 0;
10319 /* This routine is called at interrupt level in response to C-g.
10321 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10322 is called from kbd_buffer_store_event, in handling SIGIO or
10325 If `waiting_for_input' is non zero, then unless `echoing' is
10326 nonzero, immediately throw back to read_char.
10328 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10329 eval to throw, when it gets a chance. If quit-flag is already
10330 non-nil, it stops the job right away. */
10333 interrupt_signal (signalnum
) /* If we don't have an argument, */
10334 int signalnum
; /* some compilers complain in signal calls. */
10337 /* Must preserve main program's value of errno. */
10338 int old_errno
= errno
;
10339 struct frame
*sf
= SELECTED_FRAME ();
10341 #if defined (USG) && !defined (POSIX_SIGNALS)
10342 if (!read_socket_hook
&& NILP (Vwindow_system
))
10344 /* USG systems forget handlers when they are used;
10345 must reestablish each time */
10346 signal (SIGINT
, interrupt_signal
);
10347 signal (SIGQUIT
, interrupt_signal
);
10351 SIGNAL_THREAD_CHECK (signalnum
);
10354 if (!NILP (Vquit_flag
)
10355 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10357 /* If SIGINT isn't blocked, don't let us be interrupted by
10358 another SIGINT, it might be harmful due to non-reentrancy
10359 in I/O functions. */
10360 sigblock (sigmask (SIGINT
));
10363 reset_sys_modes ();
10365 #ifdef SIGTSTP /* Support possible in later USG versions */
10367 * On systems which can suspend the current process and return to the original
10368 * shell, this command causes the user to end up back at the shell.
10369 * The "Auto-save" and "Abort" questions are not asked until
10370 * the user elects to return to emacs, at which point he can save the current
10371 * job and either dump core or continue.
10376 if (sys_suspend () == -1)
10378 printf ("Not running as a subprocess;\n");
10379 printf ("you can continue or abort.\n");
10381 #else /* not VMS */
10382 /* Perhaps should really fork an inferior shell?
10383 But that would not provide any way to get back
10384 to the original shell, ever. */
10385 printf ("No support for stopping a process on this operating system;\n");
10386 printf ("you can continue or abort.\n");
10387 #endif /* not VMS */
10388 #endif /* not SIGTSTP */
10390 /* We must remain inside the screen area when the internal terminal
10391 is used. Note that [Enter] is not echoed by dos. */
10394 /* It doesn't work to autosave while GC is in progress;
10395 the code used for auto-saving doesn't cope with the mark bit. */
10396 if (!gc_in_progress
)
10398 printf ("Auto-save? (y or n) ");
10400 if (((c
= getchar ()) & ~040) == 'Y')
10402 Fdo_auto_save (Qt
, Qnil
);
10404 printf ("\r\nAuto-save done");
10405 #else /* not MSDOS */
10406 printf ("Auto-save done\n");
10407 #endif /* not MSDOS */
10409 while (c
!= '\n') c
= getchar ();
10413 /* During GC, it must be safe to reenable quitting again. */
10414 Vinhibit_quit
= Qnil
;
10417 #endif /* not MSDOS */
10418 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10419 printf ("but will instead do a real quit after garbage collection ends\r\n");
10424 printf ("\r\nAbort? (y or n) ");
10425 #else /* not MSDOS */
10427 printf ("Abort (and enter debugger)? (y or n) ");
10428 #else /* not VMS */
10429 printf ("Abort (and dump core)? (y or n) ");
10430 #endif /* not VMS */
10431 #endif /* not MSDOS */
10433 if (((c
= getchar ()) & ~040) == 'Y')
10435 while (c
!= '\n') c
= getchar ();
10437 printf ("\r\nContinuing...\r\n");
10438 #else /* not MSDOS */
10439 printf ("Continuing...\n");
10440 #endif /* not MSDOS */
10447 /* If executing a function that wants to be interrupted out of
10448 and the user has not deferred quitting by binding `inhibit-quit'
10449 then quit right away. */
10450 if (immediate_quit
&& NILP (Vinhibit_quit
))
10452 struct gl_state_s saved
;
10453 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10455 immediate_quit
= 0;
10458 GCPRO4 (saved
.object
, saved
.global_code
,
10459 saved
.current_syntax_table
, saved
.old_prop
);
10460 Fsignal (Qquit
, Qnil
);
10465 /* Else request quit when it's safe */
10469 if (waiting_for_input
&& !echoing
)
10470 quit_throw_to_read_char ();
10475 /* Handle a C-g by making read_char return C-g. */
10478 quit_throw_to_read_char ()
10481 /* Prevent another signal from doing this before we finish. */
10482 clear_waiting_for_input ();
10485 Vunread_command_events
= Qnil
;
10486 unread_command_char
= -1;
10488 #if 0 /* Currently, sit_for is called from read_char without turning
10489 off polling. And that can call set_waiting_for_input.
10490 It seems to be harmless. */
10491 #ifdef POLL_FOR_INPUT
10492 /* May be > 1 if in recursive minibuffer. */
10493 if (poll_suppress_count
== 0)
10497 if (FRAMEP (internal_last_event_frame
)
10498 && !EQ (internal_last_event_frame
, selected_frame
))
10499 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10502 _longjmp (getcjmp
, 1);
10505 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10506 doc
: /* Set mode of reading keyboard input.
10507 First arg INTERRUPT non-nil means use input interrupts;
10508 nil means use CBREAK mode.
10509 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10510 (no effect except in CBREAK mode).
10511 Third arg META t means accept 8-bit input (for a Meta key).
10512 META nil means ignore the top bit, on the assumption it is parity.
10513 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10514 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10515 See also `current-input-mode'. */)
10516 (interrupt
, flow
, meta
, quit
)
10517 Lisp_Object interrupt
, flow
, meta
, quit
;
10520 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10521 error ("set-input-mode: QUIT must be an ASCII character");
10523 #ifdef POLL_FOR_INPUT
10528 /* this causes startup screen to be restored and messes with the mouse */
10529 reset_sys_modes ();
10533 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10534 if (read_socket_hook
)
10536 /* When using X, don't give the user a real choice,
10537 because we haven't implemented the mechanisms to support it. */
10538 #ifdef NO_SOCK_SIGIO
10539 interrupt_input
= 0;
10540 #else /* not NO_SOCK_SIGIO */
10541 interrupt_input
= 1;
10542 #endif /* NO_SOCK_SIGIO */
10545 interrupt_input
= !NILP (interrupt
);
10546 #else /* not SIGIO */
10547 interrupt_input
= 0;
10548 #endif /* not SIGIO */
10550 /* Our VMS input only works by interrupts, as of now. */
10552 interrupt_input
= 1;
10555 flow_control
= !NILP (flow
);
10558 else if (EQ (meta
, Qt
))
10563 /* Don't let this value be out of range. */
10564 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10570 #ifdef POLL_FOR_INPUT
10571 poll_suppress_count
= 1;
10577 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10578 doc
: /* Return information about the way Emacs currently reads keyboard input.
10579 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10580 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10581 nil, Emacs is using CBREAK mode.
10582 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10583 terminal; this does not apply if Emacs uses interrupt-driven input.
10584 META is t if accepting 8-bit input with 8th bit as Meta flag.
10585 META nil means ignoring the top bit, on the assumption it is parity.
10586 META is neither t nor nil if accepting 8-bit input and using
10587 all 8 bits as the character code.
10588 QUIT is the character Emacs currently uses to quit.
10589 The elements of this list correspond to the arguments of
10590 `set-input-mode'. */)
10593 Lisp_Object val
[4];
10595 val
[0] = interrupt_input
? Qt
: Qnil
;
10596 val
[1] = flow_control
? Qt
: Qnil
;
10597 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10598 XSETFASTINT (val
[3], quit_char
);
10600 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10603 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10604 doc
: /* Return position information for pixel coordinates X and Y.
10605 By default, X and Y are relative to text area of the selected window.
10606 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10607 If optional fourth arg WHOLE is non-nil, X is relative to the left
10608 edge of the window.
10610 The return value is similar to a mouse click position:
10611 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10612 IMAGE (DX . DY) (WIDTH . HEIGHT))
10613 The `posn-' functions access elements of such lists. */)
10614 (x
, y
, frame_or_window
, whole
)
10615 Lisp_Object x
, y
, frame_or_window
, whole
;
10620 if (NILP (frame_or_window
))
10621 frame_or_window
= selected_window
;
10623 if (WINDOWP (frame_or_window
))
10627 CHECK_LIVE_WINDOW (frame_or_window
);
10629 w
= XWINDOW (frame_or_window
);
10630 XSETINT (x
, (XINT (x
)
10631 + WINDOW_LEFT_EDGE_X (w
)
10633 ? window_box_left_offset (w
, TEXT_AREA
)
10635 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10636 frame_or_window
= w
->frame
;
10639 CHECK_LIVE_FRAME (frame_or_window
);
10641 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10644 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10645 doc
: /* Return position information for buffer POS in WINDOW.
10646 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10648 Return nil if position is not visible in window. Otherwise,
10649 the return value is similar to that returned by `event-start' for
10650 a mouse click at the upper left corner of the glyph corresponding
10651 to the given buffer position:
10652 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10653 IMAGE (DX . DY) (WIDTH . HEIGHT))
10654 The `posn-' functions access elements of such lists. */)
10656 Lisp_Object pos
, window
;
10661 window
= selected_window
;
10663 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10666 Lisp_Object x
= XCAR (tem
);
10667 Lisp_Object y
= XCAR (XCDR (tem
));
10669 /* Point invisible due to hscrolling? */
10672 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10680 * Set up a new kboard object with reasonable initial values.
10686 kb
->Voverriding_terminal_local_map
= Qnil
;
10687 kb
->Vlast_command
= Qnil
;
10688 kb
->Vreal_last_command
= Qnil
;
10689 kb
->Vprefix_arg
= Qnil
;
10690 kb
->Vlast_prefix_arg
= Qnil
;
10691 kb
->kbd_queue
= Qnil
;
10692 kb
->kbd_queue_has_data
= 0;
10693 kb
->immediate_echo
= 0;
10694 kb
->echo_string
= Qnil
;
10695 kb
->echo_after_prompt
= -1;
10696 kb
->kbd_macro_buffer
= 0;
10697 kb
->kbd_macro_bufsize
= 0;
10698 kb
->defining_kbd_macro
= Qnil
;
10699 kb
->Vlast_kbd_macro
= Qnil
;
10700 kb
->reference_count
= 0;
10701 kb
->Vsystem_key_alist
= Qnil
;
10702 kb
->system_key_syms
= Qnil
;
10703 kb
->Vdefault_minibuffer_frame
= Qnil
;
10707 * Destroy the contents of a kboard object, but not the object itself.
10708 * We use this just before deleting it, or if we're going to initialize
10709 * it a second time.
10715 if (kb
->kbd_macro_buffer
)
10716 xfree (kb
->kbd_macro_buffer
);
10719 #ifdef MULTI_KBOARD
10721 /* Free KB and memory referenced from it. */
10729 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10732 *kbp
= kb
->next_kboard
;
10734 /* Prevent a dangling reference to KB. */
10735 if (kb
== current_kboard
10736 && FRAMEP (selected_frame
)
10737 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10739 current_kboard
= XFRAME (selected_frame
)->kboard
;
10740 if (current_kboard
== kb
)
10748 #endif /* MULTI_KBOARD */
10753 /* This is correct before outermost invocation of the editor loop */
10754 command_loop_level
= -1;
10755 immediate_quit
= 0;
10756 quit_char
= Ctl ('g');
10757 Vunread_command_events
= Qnil
;
10758 unread_command_char
= -1;
10759 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10761 recent_keys_index
= 0;
10762 kbd_fetch_ptr
= kbd_buffer
;
10763 kbd_store_ptr
= kbd_buffer
;
10765 do_mouse_tracking
= Qnil
;
10769 /* This means that command_loop_1 won't try to select anything the first
10771 internal_last_event_frame
= Qnil
;
10772 Vlast_event_frame
= internal_last_event_frame
;
10774 #ifdef MULTI_KBOARD
10775 current_kboard
= initial_kboard
;
10777 wipe_kboard (current_kboard
);
10778 init_kboard (current_kboard
);
10780 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10782 signal (SIGINT
, interrupt_signal
);
10783 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10784 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10785 SIGQUIT and we can't tell which one it will give us. */
10786 signal (SIGQUIT
, interrupt_signal
);
10787 #endif /* HAVE_TERMIO */
10789 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10791 if (!noninteractive
)
10792 signal (SIGIO
, input_available_signal
);
10795 /* Use interrupt input by default, if it works and noninterrupt input
10796 has deficiencies. */
10798 #ifdef INTERRUPT_INPUT
10799 interrupt_input
= 1;
10801 interrupt_input
= 0;
10804 /* Our VMS input only works by interrupts, as of now. */
10806 interrupt_input
= 1;
10812 if (keyboard_init_hook
)
10813 (*keyboard_init_hook
) ();
10815 #ifdef POLL_FOR_INPUT
10816 poll_suppress_count
= 1;
10821 /* This type's only use is in syms_of_keyboard, to initialize the
10822 event header symbols and put properties on them. */
10823 struct event_head
{
10829 struct event_head head_table
[] = {
10830 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10831 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10832 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10833 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10834 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10835 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10836 /* `select-window' should be handled just like `switch-frame'
10837 in read_key_sequence. */
10838 {&Qselect_window
, "select-window", &Qswitch_frame
}
10842 syms_of_keyboard ()
10844 Vpre_help_message
= Qnil
;
10845 staticpro (&Vpre_help_message
);
10847 Vlispy_mouse_stem
= build_string ("mouse");
10848 staticpro (&Vlispy_mouse_stem
);
10851 QCimage
= intern (":image");
10852 staticpro (&QCimage
);
10854 staticpro (&Qhelp_echo
);
10855 Qhelp_echo
= intern ("help-echo");
10857 staticpro (&item_properties
);
10858 item_properties
= Qnil
;
10860 staticpro (&tool_bar_item_properties
);
10861 tool_bar_item_properties
= Qnil
;
10862 staticpro (&tool_bar_items_vector
);
10863 tool_bar_items_vector
= Qnil
;
10865 staticpro (&real_this_command
);
10866 real_this_command
= Qnil
;
10868 Qtimer_event_handler
= intern ("timer-event-handler");
10869 staticpro (&Qtimer_event_handler
);
10871 Qdisabled_command_function
= intern ("disabled-command-function");
10872 staticpro (&Qdisabled_command_function
);
10874 Qself_insert_command
= intern ("self-insert-command");
10875 staticpro (&Qself_insert_command
);
10877 Qforward_char
= intern ("forward-char");
10878 staticpro (&Qforward_char
);
10880 Qbackward_char
= intern ("backward-char");
10881 staticpro (&Qbackward_char
);
10883 Qdisabled
= intern ("disabled");
10884 staticpro (&Qdisabled
);
10886 Qundefined
= intern ("undefined");
10887 staticpro (&Qundefined
);
10889 Qpre_command_hook
= intern ("pre-command-hook");
10890 staticpro (&Qpre_command_hook
);
10892 Qpost_command_hook
= intern ("post-command-hook");
10893 staticpro (&Qpost_command_hook
);
10895 Qdeferred_action_function
= intern ("deferred-action-function");
10896 staticpro (&Qdeferred_action_function
);
10898 Qcommand_hook_internal
= intern ("command-hook-internal");
10899 staticpro (&Qcommand_hook_internal
);
10901 Qfunction_key
= intern ("function-key");
10902 staticpro (&Qfunction_key
);
10903 Qmouse_click
= intern ("mouse-click");
10904 staticpro (&Qmouse_click
);
10905 #if defined (WINDOWSNT) || defined (MAC_OS)
10906 Qlanguage_change
= intern ("language-change");
10907 staticpro (&Qlanguage_change
);
10909 Qdrag_n_drop
= intern ("drag-n-drop");
10910 staticpro (&Qdrag_n_drop
);
10912 Qsave_session
= intern ("save-session");
10913 staticpro (&Qsave_session
);
10916 Qmac_apple_event
= intern ("mac-apple-event");
10917 staticpro (&Qmac_apple_event
);
10920 Qusr1_signal
= intern ("usr1-signal");
10921 staticpro (&Qusr1_signal
);
10922 Qusr2_signal
= intern ("usr2-signal");
10923 staticpro (&Qusr2_signal
);
10925 Qmenu_enable
= intern ("menu-enable");
10926 staticpro (&Qmenu_enable
);
10927 Qmenu_alias
= intern ("menu-alias");
10928 staticpro (&Qmenu_alias
);
10929 QCenable
= intern (":enable");
10930 staticpro (&QCenable
);
10931 QCvisible
= intern (":visible");
10932 staticpro (&QCvisible
);
10933 QChelp
= intern (":help");
10934 staticpro (&QChelp
);
10935 QCfilter
= intern (":filter");
10936 staticpro (&QCfilter
);
10937 QCbutton
= intern (":button");
10938 staticpro (&QCbutton
);
10939 QCkeys
= intern (":keys");
10940 staticpro (&QCkeys
);
10941 QCkey_sequence
= intern (":key-sequence");
10942 staticpro (&QCkey_sequence
);
10943 QCtoggle
= intern (":toggle");
10944 staticpro (&QCtoggle
);
10945 QCradio
= intern (":radio");
10946 staticpro (&QCradio
);
10948 Qmode_line
= intern ("mode-line");
10949 staticpro (&Qmode_line
);
10950 Qvertical_line
= intern ("vertical-line");
10951 staticpro (&Qvertical_line
);
10952 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10953 staticpro (&Qvertical_scroll_bar
);
10954 Qmenu_bar
= intern ("menu-bar");
10955 staticpro (&Qmenu_bar
);
10958 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
10959 staticpro (&Qmouse_fixup_help_message
);
10962 Qabove_handle
= intern ("above-handle");
10963 staticpro (&Qabove_handle
);
10964 Qhandle
= intern ("handle");
10965 staticpro (&Qhandle
);
10966 Qbelow_handle
= intern ("below-handle");
10967 staticpro (&Qbelow_handle
);
10968 Qup
= intern ("up");
10970 Qdown
= intern ("down");
10971 staticpro (&Qdown
);
10972 Qtop
= intern ("top");
10974 Qbottom
= intern ("bottom");
10975 staticpro (&Qbottom
);
10976 Qend_scroll
= intern ("end-scroll");
10977 staticpro (&Qend_scroll
);
10978 Qratio
= intern ("ratio");
10979 staticpro (&Qratio
);
10981 Qevent_kind
= intern ("event-kind");
10982 staticpro (&Qevent_kind
);
10983 Qevent_symbol_elements
= intern ("event-symbol-elements");
10984 staticpro (&Qevent_symbol_elements
);
10985 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10986 staticpro (&Qevent_symbol_element_mask
);
10987 Qmodifier_cache
= intern ("modifier-cache");
10988 staticpro (&Qmodifier_cache
);
10990 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10991 staticpro (&Qrecompute_lucid_menubar
);
10992 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10993 staticpro (&Qactivate_menubar_hook
);
10995 Qpolling_period
= intern ("polling-period");
10996 staticpro (&Qpolling_period
);
10998 Qinput_method_function
= intern ("input-method-function");
10999 staticpro (&Qinput_method_function
);
11001 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11002 staticpro (&Qinput_method_exit_on_first_char
);
11003 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11004 staticpro (&Qinput_method_use_echo_area
);
11006 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11007 Fset (Qinput_method_use_echo_area
, Qnil
);
11009 last_point_position_buffer
= Qnil
;
11010 last_point_position_window
= Qnil
;
11013 struct event_head
*p
;
11015 for (p
= head_table
;
11016 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11019 *p
->var
= intern (p
->name
);
11020 staticpro (p
->var
);
11021 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11022 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11026 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11027 staticpro (&button_down_location
);
11028 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11029 staticpro (&mouse_syms
);
11030 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11031 staticpro (&wheel_syms
);
11035 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11037 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11038 for (i
= 0; i
< len
; i
++)
11039 if (modifier_names
[i
])
11040 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11041 staticpro (&modifier_symbols
);
11044 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11045 staticpro (&recent_keys
);
11047 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11048 staticpro (&this_command_keys
);
11050 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11051 staticpro (&raw_keybuf
);
11053 Qextended_command_history
= intern ("extended-command-history");
11054 Fset (Qextended_command_history
, Qnil
);
11055 staticpro (&Qextended_command_history
);
11057 accent_key_syms
= Qnil
;
11058 staticpro (&accent_key_syms
);
11060 func_key_syms
= Qnil
;
11061 staticpro (&func_key_syms
);
11063 drag_n_drop_syms
= Qnil
;
11064 staticpro (&drag_n_drop_syms
);
11066 unread_switch_frame
= Qnil
;
11067 staticpro (&unread_switch_frame
);
11069 internal_last_event_frame
= Qnil
;
11070 staticpro (&internal_last_event_frame
);
11072 read_key_sequence_cmd
= Qnil
;
11073 staticpro (&read_key_sequence_cmd
);
11075 menu_bar_one_keymap_changed_items
= Qnil
;
11076 staticpro (&menu_bar_one_keymap_changed_items
);
11078 menu_bar_items_vector
= Qnil
;
11079 staticpro (&menu_bar_items_vector
);
11081 defsubr (&Sevent_convert_list
);
11082 defsubr (&Sread_key_sequence
);
11083 defsubr (&Sread_key_sequence_vector
);
11084 defsubr (&Srecursive_edit
);
11086 defsubr (&Strack_mouse
);
11088 defsubr (&Sinput_pending_p
);
11089 defsubr (&Scommand_execute
);
11090 defsubr (&Srecent_keys
);
11091 defsubr (&Sthis_command_keys
);
11092 defsubr (&Sthis_command_keys_vector
);
11093 defsubr (&Sthis_single_command_keys
);
11094 defsubr (&Sthis_single_command_raw_keys
);
11095 defsubr (&Sreset_this_command_lengths
);
11096 defsubr (&Sclear_this_command_keys
);
11097 defsubr (&Ssuspend_emacs
);
11098 defsubr (&Sabort_recursive_edit
);
11099 defsubr (&Sexit_recursive_edit
);
11100 defsubr (&Srecursion_depth
);
11101 defsubr (&Stop_level
);
11102 defsubr (&Sdiscard_input
);
11103 defsubr (&Sopen_dribble_file
);
11104 defsubr (&Sset_input_mode
);
11105 defsubr (&Scurrent_input_mode
);
11106 defsubr (&Sexecute_extended_command
);
11107 defsubr (&Sposn_at_point
);
11108 defsubr (&Sposn_at_x_y
);
11110 DEFVAR_LISP ("last-command-char", &last_command_char
,
11111 doc
: /* Last input event that was part of a command. */);
11113 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11114 doc
: /* Last input event that was part of a command. */);
11116 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11117 doc
: /* Last input event in a command, except for mouse menu events.
11118 Mouse menus give back keys that don't look like mouse events;
11119 this variable holds the actual mouse event that led to the menu,
11120 so that you can determine whether the command was run by mouse or not. */);
11122 DEFVAR_LISP ("last-input-char", &last_input_char
,
11123 doc
: /* Last input event. */);
11125 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11126 doc
: /* Last input event. */);
11128 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11129 doc
: /* List of events to be read as the command input.
11130 These events are processed first, before actual keyboard input. */);
11131 Vunread_command_events
= Qnil
;
11133 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11134 doc
: /* If not -1, an object to be read as next command input event. */);
11136 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11137 doc
: /* List of events to be processed as input by input methods.
11138 These events are processed after `unread-command-events', but
11139 before actual keyboard input. */);
11140 Vunread_post_input_method_events
= Qnil
;
11142 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11143 doc
: /* List of events to be processed as input by input methods.
11144 These events are processed after `unread-command-events', but
11145 before actual keyboard input. */);
11146 Vunread_input_method_events
= Qnil
;
11148 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11149 doc
: /* Meta-prefix character code.
11150 Meta-foo as command input turns into this character followed by foo. */);
11151 XSETINT (meta_prefix_char
, 033);
11153 DEFVAR_KBOARD ("last-command", Vlast_command
,
11154 doc
: /* The last command executed.
11155 Normally a symbol with a function definition, but can be whatever was found
11156 in the keymap, or whatever the variable `this-command' was set to by that
11159 The value `mode-exit' is special; it means that the previous command
11160 read an event that told it to exit, and it did so and unread that event.
11161 In other words, the present command is the event that made the previous
11164 The value `kill-region' is special; it means that the previous command
11165 was a kill command. */);
11167 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11168 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11170 DEFVAR_LISP ("this-command", &Vthis_command
,
11171 doc
: /* The command now being executed.
11172 The command can set this variable; whatever is put here
11173 will be in `last-command' during the following command. */);
11174 Vthis_command
= Qnil
;
11176 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11177 doc
: /* The command bound to the current key sequence before remapping.
11178 It equals `this-command' if the original command was not remapped through
11179 any of the active keymaps. Otherwise, the value of `this-command' is the
11180 result of looking up the original command in the active keymaps. */);
11181 Vthis_original_command
= Qnil
;
11183 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11184 doc
: /* *Number of input events between auto-saves.
11185 Zero means disable autosaving due to number of characters typed. */);
11186 auto_save_interval
= 300;
11188 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11189 doc
: /* *Number of seconds idle time before auto-save.
11190 Zero or nil means disable auto-saving due to idleness.
11191 After auto-saving due to this many seconds of idle time,
11192 Emacs also does a garbage collection if that seems to be warranted. */);
11193 XSETFASTINT (Vauto_save_timeout
, 30);
11195 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11196 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11197 The value may be integer or floating point. */);
11198 Vecho_keystrokes
= make_number (1);
11200 DEFVAR_INT ("polling-period", &polling_period
,
11201 doc
: /* *Interval between polling for input during Lisp execution.
11202 The reason for polling is to make C-g work to stop a running program.
11203 Polling is needed only when using X windows and SIGIO does not work.
11204 Polling is automatically disabled in all other cases. */);
11205 polling_period
= 2;
11207 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11208 doc
: /* *Maximum time between mouse clicks to make a double-click.
11209 Measured in milliseconds. nil means disable double-click recognition;
11210 t means double-clicks have no time limit and are detected
11211 by position only. */);
11212 Vdouble_click_time
= make_number (500);
11214 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11215 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11216 On window-system frames, value is the number of pixels the mouse may have
11217 moved horizontally or vertically between two clicks to make a double-click.
11218 On non window-system frames, value is interpreted in units of 1/8 characters
11221 This variable is also the threshold for motion of the mouse
11222 to count as a drag. */);
11223 double_click_fuzz
= 3;
11225 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11226 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11227 inhibit_local_menu_bar_menus
= 0;
11229 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11230 doc
: /* Number of complete key sequences read as input so far.
11231 This includes key sequences read from keyboard macros.
11232 The number is effectively the number of interactive command invocations. */);
11233 num_input_keys
= 0;
11235 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11236 doc
: /* Number of input events read from the keyboard so far.
11237 This does not include events generated by keyboard macros. */);
11238 num_nonmacro_input_events
= 0;
11240 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11241 doc
: /* The frame in which the most recently read event occurred.
11242 If the last event came from a keyboard macro, this is set to `macro'. */);
11243 Vlast_event_frame
= Qnil
;
11245 /* This variable is set up in sysdep.c. */
11246 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11247 doc
: /* The ERASE character as set by the user with stty. */);
11249 DEFVAR_LISP ("help-char", &Vhelp_char
,
11250 doc
: /* Character to recognize as meaning Help.
11251 When it is read, do `(eval help-form)', and display result if it's a string.
11252 If the value of `help-form' is nil, this char can be read normally. */);
11253 XSETINT (Vhelp_char
, Ctl ('H'));
11255 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11256 doc
: /* List of input events to recognize as meaning Help.
11257 These work just like the value of `help-char' (see that). */);
11258 Vhelp_event_list
= Qnil
;
11260 DEFVAR_LISP ("help-form", &Vhelp_form
,
11261 doc
: /* Form to execute when character `help-char' is read.
11262 If the form returns a string, that string is displayed.
11263 If `help-form' is nil, the help char is not recognized. */);
11266 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11267 doc
: /* Command to run when `help-char' character follows a prefix key.
11268 This command is used only when there is no actual binding
11269 for that character after that prefix key. */);
11270 Vprefix_help_command
= Qnil
;
11272 DEFVAR_LISP ("top-level", &Vtop_level
,
11273 doc
: /* Form to evaluate when Emacs starts up.
11274 Useful to set before you dump a modified Emacs. */);
11277 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11278 doc
: /* Translate table for keyboard input, or nil.
11279 If non-nil, the value should be a char-table. Each character read
11280 from the keyboard is looked up in this char-table. If the value found
11281 there is non-nil, then it is used instead of the actual input character.
11283 The value can also be a string or vector, but this is considered obsolete.
11284 If it is a string or vector of length N, character codes N and up are left
11285 untranslated. In a vector, an element which is nil means "no translation".
11287 This is applied to the characters supplied to input methods, not their
11288 output. See also `translation-table-for-input'. */);
11289 Vkeyboard_translate_table
= Qnil
;
11291 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11292 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11293 \(Even if the operating system has support for stopping a process.\) */);
11294 cannot_suspend
= 0;
11296 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11297 doc
: /* Non-nil means prompt with menus when appropriate.
11298 This is done when reading from a keymap that has a prompt string,
11299 for elements that have prompt strings.
11300 The menu is displayed on the screen
11301 if X menus were enabled at configuration
11302 time and the previous event was a mouse click prefix key.
11303 Otherwise, menu prompting uses the echo area. */);
11304 menu_prompting
= 1;
11306 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11307 doc
: /* Character to see next line of menu prompt.
11308 Type this character while in a menu prompt to rotate around the lines of it. */);
11309 XSETINT (menu_prompt_more_char
, ' ');
11311 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11312 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11313 Emacs applies the modifiers of the character stored here to each keyboard
11314 character it reads. For example, after evaluating the expression
11315 (setq extra-keyboard-modifiers ?\\C-x)
11316 all input characters will have the control modifier applied to them.
11318 Note that the character ?\\C-@, equivalent to the integer zero, does
11319 not count as a control character; rather, it counts as a character
11320 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11321 cancels any modification. */);
11322 extra_keyboard_modifiers
= 0;
11324 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11325 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11326 The command loop sets this to nil before each command,
11327 and tests the value when the command returns.
11328 Buffer modification stores t in this variable. */);
11329 Vdeactivate_mark
= Qnil
;
11331 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11332 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11333 Vcommand_hook_internal
= Qnil
;
11335 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11336 doc
: /* Normal hook run before each command is executed.
11337 If an unhandled error happens in running this hook,
11338 the hook value is set to nil, since otherwise the error
11339 might happen repeatedly and make Emacs nonfunctional. */);
11340 Vpre_command_hook
= Qnil
;
11342 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11343 doc
: /* Normal hook run after each command is executed.
11344 If an unhandled error happens in running this hook,
11345 the hook value is set to nil, since otherwise the error
11346 might happen repeatedly and make Emacs nonfunctional. */);
11347 Vpost_command_hook
= Qnil
;
11350 DEFVAR_LISP ("echo-area-clear-hook", ...,
11351 doc
: /* Normal hook run when clearing the echo area. */);
11353 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11354 staticpro (&Qecho_area_clear_hook
);
11355 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11357 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11358 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11359 Vlucid_menu_bar_dirty_flag
= Qnil
;
11361 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11362 doc
: /* List of menu bar items to move to the end of the menu bar.
11363 The elements of the list are event types that may have menu bar bindings. */);
11364 Vmenu_bar_final_items
= Qnil
;
11366 DEFVAR_KBOARD ("overriding-terminal-local-map",
11367 Voverriding_terminal_local_map
,
11368 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11369 If this variable is non-nil, it is used as a keymap instead of the
11370 buffer's local map, and the minor mode keymaps and text property keymaps.
11371 It also replaces `overriding-local-map'.
11373 This variable is intended to let commands such as `universal-argument'
11374 set up a different keymap for reading the next command. */);
11376 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11377 doc
: /* Keymap that overrides all other local keymaps.
11378 If this variable is non-nil, it is used as a keymap--replacing the
11379 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11380 Voverriding_local_map
= Qnil
;
11382 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11383 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11384 Otherwise, the menu bar continues to reflect the buffer's local map
11385 and the minor mode maps regardless of `overriding-local-map'. */);
11386 Voverriding_local_map_menu_flag
= Qnil
;
11388 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11389 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11390 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11392 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11393 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11395 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11396 doc
: /* Alist of system-specific X windows key symbols.
11397 Each element should have the form (N . SYMBOL) where N is the
11398 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11399 and SYMBOL is its name. */);
11401 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11402 doc
: /* List of deferred actions to be performed at a later time.
11403 The precise format isn't relevant here; we just check whether it is nil. */);
11404 Vdeferred_action_list
= Qnil
;
11406 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11407 doc
: /* Function to call to handle deferred actions, after each command.
11408 This function is called with no arguments after each command
11409 whenever `deferred-action-list' is non-nil. */);
11410 Vdeferred_action_function
= Qnil
;
11412 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11413 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11414 The value can be a length of time to show the message for.
11415 If the value is non-nil and not a number, we wait 2 seconds. */);
11416 Vsuggest_key_bindings
= Qt
;
11418 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11419 doc
: /* List of active absolute time timers in order of increasing time. */);
11420 Vtimer_list
= Qnil
;
11422 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11423 doc
: /* List of active idle-time timers in order of increasing time. */);
11424 Vtimer_idle_list
= Qnil
;
11426 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11427 doc
: /* If non-nil, the function that implements the current input method.
11428 It's called with one argument, a printing character that was just read.
11429 \(That means a character with code 040...0176.)
11430 Typically this function uses `read-event' to read additional events.
11431 When it does so, it should first bind `input-method-function' to nil
11432 so it will not be called recursively.
11434 The function should return a list of zero or more events
11435 to be used as input. If it wants to put back some events
11436 to be reconsidered, separately, by the input method,
11437 it can add them to the beginning of `unread-command-events'.
11439 The input method function can find in `input-method-previous-method'
11440 the previous echo area message.
11442 The input method function should refer to the variables
11443 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11444 for guidance on what to do. */);
11445 Vinput_method_function
= Qnil
;
11447 DEFVAR_LISP ("input-method-previous-message",
11448 &Vinput_method_previous_message
,
11449 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11450 This variable exists because `read-event' clears the echo area
11451 before running the input method. It is nil if there was no message. */);
11452 Vinput_method_previous_message
= Qnil
;
11454 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11455 doc
: /* If non-nil, the function that implements the display of help.
11456 It's called with one argument, the help string to display. */);
11457 Vshow_help_function
= Qnil
;
11459 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11460 doc
: /* If non-nil, suppress point adjustment after executing a command.
11462 After a command is executed, if point is moved into a region that has
11463 special properties (e.g. composition, display), we adjust point to
11464 the boundary of the region. But, when a command sets this variable to
11465 non-nil, we suppress the point adjustment.
11467 This variable is set to nil before reading a command, and is checked
11468 just after executing the command. */);
11469 Vdisable_point_adjustment
= Qnil
;
11471 DEFVAR_LISP ("global-disable-point-adjustment",
11472 &Vglobal_disable_point_adjustment
,
11473 doc
: /* *If non-nil, always suppress point adjustment.
11475 The default value is nil, in which case, point adjustment are
11476 suppressed only after special commands that set
11477 `disable-point-adjustment' (which see) to non-nil. */);
11478 Vglobal_disable_point_adjustment
= Qnil
;
11480 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11481 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11482 If the value is not a number, such messages don't time out. */);
11483 Vminibuffer_message_timeout
= make_number (2);
11485 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11486 doc
: /* If non-nil, any keyboard input throws to this symbol.
11487 The value of that variable is passed to `quit-flag' and later causes a
11488 peculiar kind of quitting. */);
11489 Vthrow_on_input
= Qnil
;
11491 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11492 &Venable_disabled_menus_and_buttons
,
11493 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11495 Help functions bind this to allow help on disabled menu items
11496 and tool-bar buttons. */);
11497 Venable_disabled_menus_and_buttons
= Qnil
;
11501 keys_of_keyboard ()
11503 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11504 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11505 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11506 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11507 initial_define_key (meta_map
, 'x', "execute-extended-command");
11509 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11510 "handle-delete-frame");
11511 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11512 current-prefix-arg, as is done in `handle-switch-frame'.
11513 But `handle-switch-frame is not run from the special-map.
11514 Commands from that map are run in a special way that automatically
11515 preserves the prefix-arg. Restoring the prefix arg here is not just
11516 redundant but harmful:
11518 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11519 - after the first prompt, the exit-minibuffer-hook is run which may
11520 iconify a frame and thus push a `iconify-frame' event.
11521 - after running exit-minibuffer-hook, current-prefix-arg is
11522 restored to the non-nil value it had before the prompt.
11523 - we enter the second prompt.
11524 current-prefix-arg is non-nil, prefix-arg is nil.
11525 - before running the first real event, we run the special iconify-frame
11526 event, but we pass the `special' arg to execute-command so
11527 current-prefix-arg and prefix-arg are left untouched.
11528 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11529 - the next key event will have a spuriously non-nil current-prefix-arg. */
11530 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11532 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11534 /* Handling it at such a low-level causes read_key_sequence to get
11535 * confused because it doesn't realize that the current_buffer was
11536 * changed by read_char.
11538 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11539 * "handle-select-window"); */
11540 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11541 "handle-save-session");
11544 /* Mark the pointers in the kboard objects.
11545 Called by the Fgarbage_collector. */
11551 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11553 if (kb
->kbd_macro_buffer
)
11554 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11556 mark_object (kb
->Voverriding_terminal_local_map
);
11557 mark_object (kb
->Vlast_command
);
11558 mark_object (kb
->Vreal_last_command
);
11559 mark_object (kb
->Vprefix_arg
);
11560 mark_object (kb
->Vlast_prefix_arg
);
11561 mark_object (kb
->kbd_queue
);
11562 mark_object (kb
->defining_kbd_macro
);
11563 mark_object (kb
->Vlast_kbd_macro
);
11564 mark_object (kb
->Vsystem_key_alist
);
11565 mark_object (kb
->system_key_syms
);
11566 mark_object (kb
->Vdefault_minibuffer_frame
);
11567 mark_object (kb
->echo_string
);
11570 struct input_event
*event
;
11571 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11573 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11574 event
= kbd_buffer
;
11575 if (event
->kind
!= SELECTION_REQUEST_EVENT
11576 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11578 mark_object (event
->x
);
11579 mark_object (event
->y
);
11581 mark_object (event
->frame_or_window
);
11582 mark_object (event
->arg
);
11587 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11588 (do not change this comment) */