1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96,97,99,2000,01,02,03,04
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
28 #include "termhooks.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
53 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
60 #include <sys/types.h>
65 /* This is to get the definitions of the XK_ symbols. */
72 #endif /* HAVE_NTGUI */
82 /* Variables for blockinput.h: */
84 /* Non-zero if interrupt input is blocked right now. */
85 int interrupt_input_blocked
;
87 /* Nonzero means an input interrupt has arrived
88 during the current critical section. */
89 int interrupt_input_pending
;
92 /* File descriptor to use for input. */
95 #ifdef HAVE_WINDOW_SYSTEM
96 /* Make all keyboard buffers much bigger when using X windows. */
98 /* But not too big (local data > 32K error) if on Mac OS Classic. */
99 #define KBD_BUFFER_SIZE 512
101 #define KBD_BUFFER_SIZE 4096
103 #else /* No X-windows, character input */
104 #define KBD_BUFFER_SIZE 4096
105 #endif /* No X-windows */
107 #define abs(x) ((x) >= 0 ? (x) : -(x))
109 /* Following definition copied from eval.c */
113 struct backtrace
*next
;
114 Lisp_Object
*function
;
115 Lisp_Object
*args
; /* Points to vector of args. */
116 int nargs
; /* length of vector. If nargs is UNEVALLED,
117 args points to slot holding list of
123 KBOARD
*initial_kboard
;
124 KBOARD
*current_kboard
;
128 KBOARD the_only_kboard
;
131 /* Non-nil disable property on a command means
132 do not execute it; call disabled-command-hook's value instead. */
133 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
135 #define NUM_RECENT_KEYS (100)
136 int recent_keys_index
; /* Index for storing next element into recent_keys */
137 int total_keys
; /* Total number of elements stored into recent_keys */
138 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
140 /* Vector holding the key sequence that invoked the current command.
141 It is reused for each command, and it may be longer than the current
142 sequence; this_command_key_count indicates how many elements
143 actually mean something.
144 It's easier to staticpro a single Lisp_Object than an array. */
145 Lisp_Object this_command_keys
;
146 int this_command_key_count
;
148 /* 1 after calling Freset_this_command_lengths.
150 int this_command_key_count_reset
;
152 /* This vector is used as a buffer to record the events that were actually read
153 by read_key_sequence. */
154 Lisp_Object raw_keybuf
;
155 int raw_keybuf_count
;
157 #define GROW_RAW_KEYBUF \
158 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
160 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
162 new = Fmake_vector (make_number (newsize), Qnil); \
163 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
164 raw_keybuf_count * sizeof (Lisp_Object)); \
168 /* Number of elements of this_command_keys
169 that precede this key sequence. */
170 int this_single_command_key_start
;
172 /* Record values of this_command_key_count and echo_length ()
173 before this command was read. */
174 static int before_command_key_count
;
175 static int before_command_echo_length
;
177 extern int minbuf_level
;
179 extern int message_enable_multibyte
;
181 extern struct backtrace
*backtrace_list
;
183 /* If non-nil, the function that implements the display of help.
184 It's called with one argument, the help string to display. */
186 Lisp_Object Vshow_help_function
;
188 /* If a string, the message displayed before displaying a help-echo
191 Lisp_Object Vpre_help_message
;
193 /* Nonzero means do menu prompting. */
195 static int menu_prompting
;
197 /* Character to see next line of menu prompt. */
199 static Lisp_Object menu_prompt_more_char
;
201 /* For longjmp to where kbd input is being done. */
203 static jmp_buf getcjmp
;
205 /* True while doing kbd input. */
206 int waiting_for_input
;
208 /* True while displaying for echoing. Delays C-g throwing. */
212 /* Non-null means we can start echoing at the next input pause even
213 though there is something in the echo area. */
215 static struct kboard
*ok_to_echo_at_next_pause
;
217 /* The kboard last echoing, or null for none. Reset to 0 in
218 cancel_echoing. If non-null, and a current echo area message
219 exists, and echo_message_buffer is eq to the current message
220 buffer, we know that the message comes from echo_kboard. */
222 struct kboard
*echo_kboard
;
224 /* The buffer used for echoing. Set in echo_now, reset in
227 Lisp_Object echo_message_buffer
;
229 /* Nonzero means disregard local maps for the menu bar. */
230 static int inhibit_local_menu_bar_menus
;
232 /* Nonzero means C-g should cause immediate error-signal. */
235 /* The user's ERASE setting. */
236 Lisp_Object Vtty_erase_char
;
238 /* Character to recognize as the help char. */
239 Lisp_Object Vhelp_char
;
241 /* List of other event types to recognize as meaning "help". */
242 Lisp_Object Vhelp_event_list
;
244 /* Form to execute when help char is typed. */
245 Lisp_Object Vhelp_form
;
247 /* Command to run when the help character follows a prefix key. */
248 Lisp_Object Vprefix_help_command
;
250 /* List of items that should move to the end of the menu bar. */
251 Lisp_Object Vmenu_bar_final_items
;
253 /* Non-nil means show the equivalent key-binding for
254 any M-x command that has one.
255 The value can be a length of time to show the message for.
256 If the value is non-nil and not a number, we wait 2 seconds. */
257 Lisp_Object Vsuggest_key_bindings
;
259 /* How long to display an echo-area message when the minibuffer is active.
260 If the value is not a number, such messages don't time out. */
261 Lisp_Object Vminibuffer_message_timeout
;
263 /* Character that causes a quit. Normally C-g.
265 If we are running on an ordinary terminal, this must be an ordinary
266 ASCII char, since we want to make it our interrupt character.
268 If we are not running on an ordinary terminal, it still needs to be
269 an ordinary ASCII char. This character needs to be recognized in
270 the input interrupt handler. At this point, the keystroke is
271 represented as a struct input_event, while the desired quit
272 character is specified as a lispy event. The mapping from struct
273 input_events to lispy events cannot run in an interrupt handler,
274 and the reverse mapping is difficult for anything but ASCII
277 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
281 extern Lisp_Object current_global_map
;
282 extern int minibuf_level
;
284 /* If non-nil, this is a map that overrides all other local maps. */
285 Lisp_Object Voverriding_local_map
;
287 /* If non-nil, Voverriding_local_map applies to the menu bar. */
288 Lisp_Object Voverriding_local_map_menu_flag
;
290 /* Keymap that defines special misc events that should
291 be processed immediately at a low level. */
292 Lisp_Object Vspecial_event_map
;
294 /* Current depth in recursive edits. */
295 int command_loop_level
;
297 /* Total number of times command_loop has read a key sequence. */
298 EMACS_INT num_input_keys
;
300 /* Last input character read as a command. */
301 Lisp_Object last_command_char
;
303 /* Last input character read as a command, not counting menus
304 reached by the mouse. */
305 Lisp_Object last_nonmenu_event
;
307 /* Last input character read for any purpose. */
308 Lisp_Object last_input_char
;
310 /* If not Qnil, a list of objects to be read as subsequent command input. */
311 Lisp_Object Vunread_command_events
;
313 /* If not Qnil, a list of objects to be read as subsequent command input
314 including input method processing. */
315 Lisp_Object Vunread_input_method_events
;
317 /* If not Qnil, a list of objects to be read as subsequent command input
318 but NOT including input method processing. */
319 Lisp_Object Vunread_post_input_method_events
;
321 /* If not -1, an event to be read as subsequent command input. */
322 EMACS_INT unread_command_char
;
324 /* If not Qnil, this is a switch-frame event which we decided to put
325 off until the end of a key sequence. This should be read as the
326 next command input, after any unread_command_events.
328 read_key_sequence uses this to delay switch-frame events until the
329 end of the key sequence; Fread_char uses it to put off switch-frame
330 events until a non-ASCII event is acceptable as input. */
331 Lisp_Object unread_switch_frame
;
333 /* A mask of extra modifier bits to put into every keyboard char. */
334 EMACS_INT extra_keyboard_modifiers
;
336 /* Char to use as prefix when a meta character is typed in.
337 This is bound on entry to minibuffer in case ESC is changed there. */
339 Lisp_Object meta_prefix_char
;
341 /* Last size recorded for a current buffer which is not a minibuffer. */
342 static int last_non_minibuf_size
;
344 /* Number of idle seconds before an auto-save and garbage collection. */
345 static Lisp_Object Vauto_save_timeout
;
347 /* Total number of times read_char has returned. */
348 int num_input_events
;
350 /* Total number of times read_char has returned, outside of macros. */
351 EMACS_INT num_nonmacro_input_events
;
353 /* Auto-save automatically when this many characters have been typed
354 since the last time. */
356 static EMACS_INT auto_save_interval
;
358 /* Value of num_nonmacro_input_events as of last auto save. */
362 /* The command being executed by the command loop.
363 Commands may set this, and the value set will be copied into
364 current_kboard->Vlast_command instead of the actual command. */
365 Lisp_Object Vthis_command
;
367 /* This is like Vthis_command, except that commands never set it. */
368 Lisp_Object real_this_command
;
370 /* If the lookup of the command returns a binding, the original
371 command is stored in this-original-command. It is nil otherwise. */
372 Lisp_Object Vthis_original_command
;
374 /* The value of point when the last command was executed. */
375 int last_point_position
;
377 /* The buffer that was current when the last command was started. */
378 Lisp_Object last_point_position_buffer
;
380 /* The frame in which the last input event occurred, or Qmacro if the
381 last event came from a macro. We use this to determine when to
382 generate switch-frame events. This may be cleared by functions
383 like Fselect_frame, to make sure that a switch-frame event is
384 generated by the next character. */
385 Lisp_Object internal_last_event_frame
;
387 /* A user-visible version of the above, intended to allow users to
388 figure out where the last event came from, if the event doesn't
389 carry that information itself (i.e. if it was a character). */
390 Lisp_Object Vlast_event_frame
;
392 /* The timestamp of the last input event we received from the X server.
393 X Windows wants this for selection ownership. */
394 unsigned long last_event_timestamp
;
396 Lisp_Object Qself_insert_command
;
397 Lisp_Object Qforward_char
;
398 Lisp_Object Qbackward_char
;
399 Lisp_Object Qundefined
;
400 Lisp_Object Qtimer_event_handler
;
402 /* read_key_sequence stores here the command definition of the
403 key sequence that it reads. */
404 Lisp_Object read_key_sequence_cmd
;
406 /* Echo unfinished commands after this many seconds of pause. */
407 Lisp_Object Vecho_keystrokes
;
409 /* Form to evaluate (if non-nil) when Emacs is started. */
410 Lisp_Object Vtop_level
;
412 /* User-supplied table to translate input characters. */
413 Lisp_Object Vkeyboard_translate_table
;
415 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
416 extern Lisp_Object Vfunction_key_map
;
418 /* Another keymap that maps key sequences into key sequences.
419 This one takes precedence over ordinary definitions. */
420 extern Lisp_Object Vkey_translation_map
;
422 /* If non-nil, this implements the current input method. */
423 Lisp_Object Vinput_method_function
;
424 Lisp_Object Qinput_method_function
;
426 /* When we call Vinput_method_function,
427 this holds the echo area message that was just erased. */
428 Lisp_Object Vinput_method_previous_message
;
430 /* Non-nil means deactivate the mark at end of this command. */
431 Lisp_Object Vdeactivate_mark
;
433 /* Menu bar specified in Lucid Emacs fashion. */
435 Lisp_Object Vlucid_menu_bar_dirty_flag
;
436 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
438 Lisp_Object Qecho_area_clear_hook
;
440 /* Hooks to run before and after each command. */
441 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
442 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
443 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
444 /* Hook run after a command if there's no more input soon. */
445 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
447 /* Delay time in microseconds before running post-command-idle-hook. */
448 EMACS_INT post_command_idle_delay
;
450 /* List of deferred actions to be performed at a later time.
451 The precise format isn't relevant here; we just check whether it is nil. */
452 Lisp_Object Vdeferred_action_list
;
454 /* Function to call to handle deferred actions, when there are any. */
455 Lisp_Object Vdeferred_action_function
;
456 Lisp_Object Qdeferred_action_function
;
458 Lisp_Object Qinput_method_exit_on_first_char
;
459 Lisp_Object Qinput_method_use_echo_area
;
461 /* File in which we write all commands we read. */
464 /* Nonzero if input is available. */
467 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
468 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
472 /* Non-zero means force key bindings update in parse_menu_item. */
474 int update_menu_bindings
;
476 extern char *pending_malloc_warning
;
478 /* Circular buffer for pre-read keyboard input. */
480 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
482 /* Pointer to next available character in kbd_buffer.
483 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
484 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
485 next available char is in kbd_buffer[0]. */
486 static struct input_event
*kbd_fetch_ptr
;
488 /* Pointer to next place to store character in kbd_buffer. This
489 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
490 character should go in kbd_buffer[0]. */
491 static struct input_event
* volatile kbd_store_ptr
;
493 /* The above pair of variables forms a "queue empty" flag. When we
494 enqueue a non-hook event, we increment kbd_store_ptr. When we
495 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
496 there is input available iff the two pointers are not equal.
498 Why not just have a flag set and cleared by the enqueuing and
499 dequeuing functions? Such a flag could be screwed up by interrupts
500 at inopportune times. */
502 /* If this flag is non-nil, we check mouse_moved to see when the
503 mouse moves, and motion events will appear in the input stream.
504 Otherwise, mouse motion is ignored. */
505 Lisp_Object do_mouse_tracking
;
507 /* Symbols to head events. */
508 Lisp_Object Qmouse_movement
;
509 Lisp_Object Qscroll_bar_movement
;
510 Lisp_Object Qswitch_frame
;
511 Lisp_Object Qdelete_frame
;
512 Lisp_Object Qiconify_frame
;
513 Lisp_Object Qmake_frame_visible
;
514 Lisp_Object Qselect_window
;
515 Lisp_Object Qhelp_echo
;
517 /* Symbols to denote kinds of events. */
518 Lisp_Object Qfunction_key
;
519 Lisp_Object Qmouse_click
;
521 Lisp_Object Qlanguage_change
;
523 Lisp_Object Qdrag_n_drop
;
524 Lisp_Object Qsave_session
;
526 /* Lisp_Object Qmouse_movement; - also an event header */
528 /* Properties of event headers. */
529 Lisp_Object Qevent_kind
;
530 Lisp_Object Qevent_symbol_elements
;
532 /* menu item parts */
533 Lisp_Object Qmenu_alias
;
534 Lisp_Object Qmenu_enable
;
535 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
536 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
537 extern Lisp_Object Vdefine_key_rebound_commands
;
538 extern Lisp_Object Qmenu_item
;
540 /* An event header symbol HEAD may have a property named
541 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
542 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
543 mask of modifiers applied to it. If present, this is used to help
544 speed up parse_modifiers. */
545 Lisp_Object Qevent_symbol_element_mask
;
547 /* An unmodified event header BASE may have a property named
548 Qmodifier_cache, which is an alist mapping modifier masks onto
549 modified versions of BASE. If present, this helps speed up
551 Lisp_Object Qmodifier_cache
;
553 /* Symbols to use for parts of windows. */
554 Lisp_Object Qmode_line
;
555 Lisp_Object Qvertical_line
;
556 Lisp_Object Qvertical_scroll_bar
;
557 Lisp_Object Qmenu_bar
;
558 extern Lisp_Object Qleft_margin
, Qright_margin
;
559 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
560 extern Lisp_Object QCmap
;
562 Lisp_Object
recursive_edit_unwind (), command_loop ();
563 Lisp_Object
Fthis_command_keys ();
564 Lisp_Object Qextended_command_history
;
565 EMACS_TIME
timer_check ();
567 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
569 extern char *x_get_keysym_name ();
571 static void record_menu_key ();
572 static int echo_length ();
574 Lisp_Object Qpolling_period
;
576 /* List of absolute timers. Appears in order of next scheduled event. */
577 Lisp_Object Vtimer_list
;
579 /* List of idle time timers. Appears in order of next scheduled event. */
580 Lisp_Object Vtimer_idle_list
;
582 /* Incremented whenever a timer is run. */
585 extern Lisp_Object Vprint_level
, Vprint_length
;
587 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
589 EMACS_TIME
*input_available_clear_time
;
591 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
592 Default is 1 if INTERRUPT_INPUT is defined. */
595 /* Nonzero while interrupts are temporarily deferred during redisplay. */
596 int interrupts_deferred
;
598 /* Nonzero means use ^S/^Q for flow control. */
601 /* Allow m- file to inhibit use of FIONREAD. */
602 #ifdef BROKEN_FIONREAD
606 /* We are unable to use interrupts if FIONREAD is not available,
607 so flush SIGIO so we won't try. */
614 /* If we support a window system, turn on the code to poll periodically
615 to detect C-g. It isn't actually used when doing interrupt input. */
616 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
617 #define POLL_FOR_INPUT
620 /* After a command is executed, if point is moved into a region that
621 has specific properties (e.g. composition, display), we adjust
622 point to the boundary of the region. But, if a command sets this
623 variable to non-nil, we suppress this point adjustment. This
624 variable is set to nil before reading a command. */
626 Lisp_Object Vdisable_point_adjustment
;
628 /* If non-nil, always disable point adjustment. */
630 Lisp_Object Vglobal_disable_point_adjustment
;
632 /* The time when Emacs started being idle. */
634 static EMACS_TIME timer_idleness_start_time
;
636 /* After Emacs stops being idle, this saves the last value
637 of timer_idleness_start_time from when it was idle. */
639 static EMACS_TIME timer_last_idleness_start_time
;
642 /* Global variable declarations. */
644 /* Function for init_keyboard to call with no args (if nonzero). */
645 void (*keyboard_init_hook
) ();
647 static int read_avail_input
P_ ((int));
648 static void get_input_pending
P_ ((int *, int));
649 static void get_filtered_input_pending
P_ ((int *, int, int));
650 static int readable_events
P_ ((int));
651 static int readable_filtered_events
P_ ((int, int));
652 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
653 Lisp_Object
, int *));
654 static Lisp_Object
read_char_x_menu_prompt ();
655 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
657 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
659 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
660 enum scroll_bar_part
,
661 Lisp_Object
, Lisp_Object
,
664 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
665 Lisp_Object
, char **,
666 Lisp_Object
*, unsigned));
667 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
668 static int parse_solitary_modifier
P_ ((Lisp_Object
));
669 static int parse_solitary_modifier ();
670 static void save_getcjmp
P_ ((jmp_buf));
671 static void save_getcjmp ();
672 static void restore_getcjmp
P_ ((jmp_buf));
673 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
674 static void clear_event
P_ ((struct input_event
*));
675 static void any_kboard_state
P_ ((void));
676 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
678 /* Nonzero means don't try to suspend even if the operating system seems
680 static int cannot_suspend
;
682 /* Install the string STR as the beginning of the string of echoing,
683 so that it serves as a prompt for the next character.
684 Also start echoing. */
690 current_kboard
->echo_string
= str
;
691 current_kboard
->echo_after_prompt
= SCHARS (str
);
695 /* Add C to the echo string, if echoing is going on.
696 C can be a character, which is printed prettily ("M-C-x" and all that
697 jazz), or a symbol, whose name is printed. */
703 if (current_kboard
->immediate_echo
)
705 int size
= KEY_DESCRIPTION_SIZE
+ 100;
706 char *buffer
= (char *) alloca (size
);
708 Lisp_Object echo_string
;
710 echo_string
= current_kboard
->echo_string
;
712 /* If someone has passed us a composite event, use its head symbol. */
717 ptr
= push_key_description (XINT (c
), ptr
, 1);
719 else if (SYMBOLP (c
))
721 Lisp_Object name
= SYMBOL_NAME (c
);
722 int nbytes
= SBYTES (name
);
724 if (size
- (ptr
- buffer
) < nbytes
)
726 int offset
= ptr
- buffer
;
727 size
= max (2 * size
, size
+ nbytes
);
728 buffer
= (char *) alloca (size
);
729 ptr
= buffer
+ offset
;
732 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
733 STRING_MULTIBYTE (name
), 1);
736 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
739 const char *text
= " (Type ? for further options)";
740 int len
= strlen (text
);
742 if (size
- (ptr
- buffer
) < len
)
744 int offset
= ptr
- buffer
;
746 buffer
= (char *) alloca (size
);
747 ptr
= buffer
+ offset
;
750 bcopy (text
, ptr
, len
);
754 /* Replace a dash from echo_dash with a space, otherwise
755 add a space at the end as a separator between keys. */
756 if (STRINGP (echo_string
)
757 && SCHARS (echo_string
) > 1)
759 Lisp_Object last_char
, prev_char
, idx
;
761 idx
= make_number (SCHARS (echo_string
) - 2);
762 prev_char
= Faref (echo_string
, idx
);
764 idx
= make_number (SCHARS (echo_string
) - 1);
765 last_char
= Faref (echo_string
, idx
);
767 /* We test PREV_CHAR to make sure this isn't the echoing
769 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
770 Faset (echo_string
, idx
, make_number (' '));
772 echo_string
= concat2 (echo_string
, build_string (" "));
775 current_kboard
->echo_string
776 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
782 /* Temporarily add a dash to the end of the echo string if it's not
783 empty, so that it serves as a mini-prompt for the very next character. */
788 /* Do nothing if not echoing at all. */
789 if (NILP (current_kboard
->echo_string
))
792 if (!current_kboard
->immediate_echo
793 && SCHARS (current_kboard
->echo_string
) == 0)
796 /* Do nothing if we just printed a prompt. */
797 if (current_kboard
->echo_after_prompt
798 == SCHARS (current_kboard
->echo_string
))
801 /* Put a dash at the end of the buffer temporarily,
802 but make it go away when the next character is added. */
803 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
808 /* Display the current echo string, and begin echoing if not already
814 if (!current_kboard
->immediate_echo
)
817 current_kboard
->immediate_echo
= 1;
819 for (i
= 0; i
< this_command_key_count
; i
++)
823 /* Set before_command_echo_length to the value that would
824 have been saved before the start of this subcommand in
825 command_loop_1, if we had already been echoing then. */
826 if (i
== this_single_command_key_start
)
827 before_command_echo_length
= echo_length ();
829 c
= XVECTOR (this_command_keys
)->contents
[i
];
830 if (! (EVENT_HAS_PARAMETERS (c
)
831 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
835 /* Set before_command_echo_length to the value that would
836 have been saved before the start of this subcommand in
837 command_loop_1, if we had already been echoing then. */
838 if (this_command_key_count
== this_single_command_key_start
)
839 before_command_echo_length
= echo_length ();
841 /* Put a dash at the end to invite the user to type more. */
846 message3_nolog (current_kboard
->echo_string
,
847 SBYTES (current_kboard
->echo_string
),
848 STRING_MULTIBYTE (current_kboard
->echo_string
));
851 /* Record in what buffer we echoed, and from which kboard. */
852 echo_message_buffer
= echo_area_buffer
[0];
853 echo_kboard
= current_kboard
;
855 if (waiting_for_input
&& !NILP (Vquit_flag
))
856 quit_throw_to_read_char ();
859 /* Turn off echoing, for the start of a new command. */
864 current_kboard
->immediate_echo
= 0;
865 current_kboard
->echo_after_prompt
= -1;
866 current_kboard
->echo_string
= Qnil
;
867 ok_to_echo_at_next_pause
= NULL
;
869 echo_message_buffer
= Qnil
;
872 /* Return the length of the current echo string. */
877 return (STRINGP (current_kboard
->echo_string
)
878 ? SCHARS (current_kboard
->echo_string
)
882 /* Truncate the current echo message to its first LEN chars.
883 This and echo_char get used by read_key_sequence when the user
884 switches frames while entering a key sequence. */
887 echo_truncate (nchars
)
890 if (STRINGP (current_kboard
->echo_string
))
891 current_kboard
->echo_string
892 = Fsubstring (current_kboard
->echo_string
,
893 make_number (0), make_number (nchars
));
894 truncate_echo_area (nchars
);
898 /* Functions for manipulating this_command_keys. */
900 add_command_key (key
)
903 #if 0 /* Not needed after we made Freset_this_command_lengths
904 do the job immediately. */
905 /* If reset-this-command-length was called recently, obey it now.
906 See the doc string of that function for an explanation of why. */
907 if (before_command_restore_flag
)
909 this_command_key_count
= before_command_key_count_1
;
910 if (this_command_key_count
< this_single_command_key_start
)
911 this_single_command_key_start
= this_command_key_count
;
912 echo_truncate (before_command_echo_length_1
);
913 before_command_restore_flag
= 0;
917 if (this_command_key_count
>= ASIZE (this_command_keys
))
918 this_command_keys
= larger_vector (this_command_keys
,
919 2 * ASIZE (this_command_keys
),
922 AREF (this_command_keys
, this_command_key_count
) = key
;
923 ++this_command_key_count
;
930 int count
= SPECPDL_INDEX ();
933 if (command_loop_level
> 0)
935 specbind (Qstandard_output
, Qt
);
936 specbind (Qstandard_input
, Qt
);
939 #ifdef HAVE_X_WINDOWS
940 /* The command loop has started an hourglass timer, so we have to
941 cancel it here, otherwise it will fire because the recursive edit
942 can take some time. Do not check for display_hourglass_p here,
943 because it could already be nil. */
947 /* This function may have been called from a debugger called from
948 within redisplay, for instance by Edebugging a function called
949 from fontification-functions. We want to allow redisplay in
950 the debugging session.
952 The recursive edit is left with a `(throw exit ...)'. The `exit'
953 tag is not caught anywhere in redisplay, i.e. when we leave the
954 recursive edit, the original redisplay leading to the recursive
955 edit will be unwound. The outcome should therefore be safe. */
956 specbind (Qinhibit_redisplay
, Qnil
);
959 val
= command_loop ();
961 Fsignal (Qquit
, Qnil
);
962 /* Handle throw from read_minibuf when using minibuffer
963 while it's active but we're in another window. */
965 Fsignal (Qerror
, Fcons (val
, Qnil
));
967 return unbind_to (count
, Qnil
);
970 /* When an auto-save happens, record the "time", and don't do again soon. */
975 last_auto_save
= num_nonmacro_input_events
;
978 /* Make an auto save happen as soon as possible at command level. */
981 force_auto_save_soon ()
983 last_auto_save
= - auto_save_interval
- 1;
985 record_asynch_buffer_change ();
988 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
989 doc
: /* Invoke the editor command loop recursively.
990 To get out of the recursive edit, a command can do `(throw 'exit nil)';
991 that tells this function to return.
992 Alternately, `(throw 'exit t)' makes this function signal an error.
993 This function is called by the editor initialization to begin editing. */)
996 int count
= SPECPDL_INDEX ();
999 /* If we enter while input is blocked, don't lock up here.
1000 This may happen through the debugger during redisplay. */
1001 if (INPUT_BLOCKED_P
)
1004 command_loop_level
++;
1005 update_mode_lines
= 1;
1007 if (command_loop_level
1008 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1009 buffer
= Fcurrent_buffer ();
1013 /* If we leave recursive_edit_1 below with a `throw' for instance,
1014 like it is done in the splash screen display, we have to
1015 make sure that we restore single_kboard as command_loop_1
1016 would have done if it were left normally. */
1017 record_unwind_protect (recursive_edit_unwind
,
1018 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1020 recursive_edit_1 ();
1021 return unbind_to (count
, Qnil
);
1025 recursive_edit_unwind (info
)
1028 if (BUFFERP (XCAR (info
)))
1029 Fset_buffer (XCAR (info
));
1031 if (NILP (XCDR (info
)))
1032 any_kboard_state ();
1034 single_kboard_state ();
1036 command_loop_level
--;
1037 update_mode_lines
= 1;
1046 #if 0 /* Theory: if there's anything in Vunread_command_events,
1047 it will right away be read by read_key_sequence,
1048 and then if we do switch KBOARDS, it will go into the side
1049 queue then. So we don't need to do anything special here -- rms. */
1050 if (CONSP (Vunread_command_events
))
1052 current_kboard
->kbd_queue
1053 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1054 current_kboard
->kbd_queue_has_data
= 1;
1056 Vunread_command_events
= Qnil
;
1062 /* Switch to the single-kboard state, making current_kboard
1063 the only KBOARD from which further input is accepted. */
1066 single_kboard_state ()
1073 /* Maintain a stack of kboards, so other parts of Emacs
1074 can switch temporarily to the kboard of a given frame
1075 and then revert to the previous status. */
1080 struct kboard_stack
*next
;
1083 static struct kboard_stack
*kboard_stack
;
1086 push_frame_kboard (f
)
1090 struct kboard_stack
*p
1091 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1093 p
->next
= kboard_stack
;
1094 p
->kboard
= current_kboard
;
1097 current_kboard
= FRAME_KBOARD (f
);
1105 struct kboard_stack
*p
= kboard_stack
;
1106 current_kboard
= p
->kboard
;
1107 kboard_stack
= p
->next
;
1112 /* Handle errors that are not handled at inner levels
1113 by printing an error message and returning to the editor command loop. */
1119 Lisp_Object old_level
, old_length
;
1120 char macroerror
[50];
1122 #ifdef HAVE_X_WINDOWS
1123 if (display_hourglass_p
)
1124 cancel_hourglass ();
1127 if (!NILP (executing_macro
))
1129 if (executing_macro_iterations
== 1)
1130 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1132 sprintf (macroerror
, "After %d kbd macro iterations: ",
1133 executing_macro_iterations
);
1138 Vstandard_output
= Qt
;
1139 Vstandard_input
= Qt
;
1140 Vexecuting_macro
= Qnil
;
1141 executing_macro
= Qnil
;
1142 current_kboard
->Vprefix_arg
= Qnil
;
1143 current_kboard
->Vlast_prefix_arg
= Qnil
;
1146 /* Avoid unquittable loop if data contains a circular list. */
1147 old_level
= Vprint_level
;
1148 old_length
= Vprint_length
;
1149 XSETFASTINT (Vprint_level
, 10);
1150 XSETFASTINT (Vprint_length
, 10);
1151 cmd_error_internal (data
, macroerror
);
1152 Vprint_level
= old_level
;
1153 Vprint_length
= old_length
;
1157 Vinhibit_quit
= Qnil
;
1159 any_kboard_state ();
1162 return make_number (0);
1165 /* Take actions on handling an error. DATA is the data that describes
1168 CONTEXT is a C-string containing ASCII characters only which
1169 describes the context in which the error happened. If we need to
1170 generalize CONTEXT to allow multibyte characters, make it a Lisp
1174 cmd_error_internal (data
, context
)
1179 int kill_emacs_p
= 0;
1180 struct frame
*sf
= SELECTED_FRAME ();
1184 clear_message (1, 0);
1186 /* If the window system or terminal frame hasn't been initialized
1187 yet, or we're not interactive, it's best to dump this message out
1188 to stderr and exit. */
1189 if (!sf
->glyphs_initialized_p
1190 /* This is the case of the frame dumped with Emacs, when we're
1191 running under a window system. */
1192 || (!NILP (Vwindow_system
)
1193 && !inhibit_window_system
1194 && FRAME_TERMCAP_P (sf
))
1197 stream
= Qexternal_debugging_output
;
1203 message_log_maybe_newline ();
1208 /* The immediate context is not interesting for Quits,
1209 since they are asyncronous. */
1210 if (EQ (XCAR (data
), Qquit
))
1211 Vsignaling_function
= Qnil
;
1213 print_error_message (data
, stream
, context
, Vsignaling_function
);
1215 Vsignaling_function
= Qnil
;
1217 /* If the window system or terminal frame hasn't been initialized
1218 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1222 Fkill_emacs (make_number (-1));
1226 Lisp_Object
command_loop_1 ();
1227 Lisp_Object
command_loop_2 ();
1228 Lisp_Object
top_level_1 ();
1230 /* Entry to editor-command-loop.
1231 This level has the catches for exiting/returning to editor command loop.
1232 It returns nil to exit recursive edit, t to abort it. */
1237 if (command_loop_level
> 0 || minibuf_level
> 0)
1240 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1241 executing_macro
= Qnil
;
1247 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1248 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1249 executing_macro
= Qnil
;
1251 /* End of file in -batch run causes exit here. */
1257 /* Here we catch errors in execution of commands within the
1258 editing loop, and reenter the editing loop.
1259 When there is an error, cmd_error runs and returns a non-nil
1260 value to us. A value of nil means that command_loop_1 itself
1261 returned due to end of file (or end of kbd macro). */
1266 register Lisp_Object val
;
1269 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1270 while (!NILP (val
));
1278 return Feval (Vtop_level
);
1284 /* On entry to the outer level, run the startup file */
1285 if (!NILP (Vtop_level
))
1286 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1287 else if (!NILP (Vpurify_flag
))
1288 message ("Bare impure Emacs (standard Lisp code not loaded)");
1290 message ("Bare Emacs (standard Lisp code not loaded)");
1294 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1295 doc
: /* Exit all recursive editing levels. */)
1298 #ifdef HAVE_X_WINDOWS
1299 if (display_hourglass_p
)
1300 cancel_hourglass ();
1303 /* Unblock input if we enter with input blocked. This may happen if
1304 redisplay traps e.g. during tool-bar update with input blocked. */
1305 while (INPUT_BLOCKED_P
)
1308 return Fthrow (Qtop_level
, Qnil
);
1311 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1312 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1315 if (command_loop_level
> 0 || minibuf_level
> 0)
1316 Fthrow (Qexit
, Qnil
);
1318 error ("No recursive edit is in progress");
1322 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1323 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1326 if (command_loop_level
> 0 || minibuf_level
> 0)
1329 error ("No recursive edit is in progress");
1333 /* This is the actual command reading loop,
1334 sans error-handling encapsulation. */
1336 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1338 void safe_run_hooks
P_ ((Lisp_Object
));
1339 static void adjust_point_for_property
P_ ((int, int));
1341 /* Cancel hourglass from protect_unwind.
1343 #ifdef HAVE_X_WINDOWS
1345 cancel_hourglass_unwind (arg
)
1348 cancel_hourglass ();
1358 Lisp_Object keybuf
[30];
1362 struct buffer
*prev_buffer
= NULL
;
1364 int was_locked
= single_kboard
;
1366 int already_adjusted
;
1368 current_kboard
->Vprefix_arg
= Qnil
;
1369 current_kboard
->Vlast_prefix_arg
= Qnil
;
1370 Vdeactivate_mark
= Qnil
;
1371 waiting_for_input
= 0;
1375 this_command_key_count
= 0;
1376 this_command_key_count_reset
= 0;
1377 this_single_command_key_start
= 0;
1379 if (NILP (Vmemory_full
))
1381 /* Make sure this hook runs after commands that get errors and
1382 throw to top level. */
1383 /* Note that the value cell will never directly contain nil
1384 if the symbol is a local variable. */
1385 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1386 safe_run_hooks (Qpost_command_hook
);
1388 /* If displaying a message, resize the echo area window to fit
1389 that message's size exactly. */
1390 if (!NILP (echo_area_buffer
[0]))
1391 resize_echo_area_exactly ();
1393 if (!NILP (Vdeferred_action_list
))
1394 call0 (Vdeferred_action_function
);
1396 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1398 if (NILP (Vunread_command_events
)
1399 && NILP (Vunread_input_method_events
)
1400 && NILP (Vunread_post_input_method_events
)
1401 && NILP (Vexecuting_macro
)
1402 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1403 safe_run_hooks (Qpost_command_idle_hook
);
1407 Vmemory_full
= Qnil
;
1409 /* Do this after running Vpost_command_hook, for consistency. */
1410 current_kboard
->Vlast_command
= Vthis_command
;
1411 current_kboard
->Vreal_last_command
= real_this_command
;
1415 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1418 /* Make sure the current window's buffer is selected. */
1419 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1420 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1422 /* Display any malloc warning that just came out. Use while because
1423 displaying one warning can cause another. */
1425 while (pending_malloc_warning
)
1426 display_malloc_warning ();
1430 Vdeactivate_mark
= Qnil
;
1432 /* If minibuffer on and echo area in use,
1433 wait a short time and redraw minibuffer. */
1436 && !NILP (echo_area_buffer
[0])
1437 && EQ (minibuf_window
, echo_area_window
)
1438 && NUMBERP (Vminibuffer_message_timeout
))
1440 /* Bind inhibit-quit to t so that C-g gets read in
1441 rather than quitting back to the minibuffer. */
1442 int count
= SPECPDL_INDEX ();
1443 specbind (Qinhibit_quit
, Qt
);
1445 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1446 /* Clear the echo area. */
1448 safe_run_hooks (Qecho_area_clear_hook
);
1450 unbind_to (count
, Qnil
);
1452 /* If a C-g came in before, treat it as input now. */
1453 if (!NILP (Vquit_flag
))
1456 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1461 alloca (0); /* Cause a garbage collection now */
1462 /* Since we can free the most stuff here. */
1463 #endif /* C_ALLOCA */
1466 /* Select the frame that the last event came from. Usually,
1467 switch-frame events will take care of this, but if some lisp
1468 code swallows a switch-frame event, we'll fix things up here.
1469 Is this a good idea? */
1470 if (FRAMEP (internal_last_event_frame
)
1471 && !EQ (internal_last_event_frame
, selected_frame
))
1472 Fselect_frame (internal_last_event_frame
, Qnil
);
1474 /* If it has changed current-menubar from previous value,
1475 really recompute the menubar from the value. */
1476 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1477 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1478 call0 (Qrecompute_lucid_menubar
);
1480 before_command_key_count
= this_command_key_count
;
1481 before_command_echo_length
= echo_length ();
1483 Vthis_command
= Qnil
;
1484 real_this_command
= Qnil
;
1486 /* Read next key sequence; i gets its length. */
1487 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1490 /* A filter may have run while we were reading the input. */
1491 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1493 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1494 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1498 /* Now we have read a key sequence of length I,
1499 or else I is 0 and we found end of file. */
1501 if (i
== 0) /* End of file -- happens only in */
1502 return Qnil
; /* a kbd macro, at the end. */
1503 /* -1 means read_key_sequence got a menu that was rejected.
1504 Just loop around and read another command. */
1508 this_command_key_count
= 0;
1509 this_command_key_count_reset
= 0;
1510 this_single_command_key_start
= 0;
1514 last_command_char
= keybuf
[i
- 1];
1516 /* If the previous command tried to force a specific window-start,
1517 forget about that, in case this command moves point far away
1518 from that position. But also throw away beg_unchanged and
1519 end_unchanged information in that case, so that redisplay will
1520 update the whole window properly. */
1521 if (!NILP (XWINDOW (selected_window
)->force_start
))
1524 XWINDOW (selected_window
)->force_start
= Qnil
;
1525 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1526 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1529 cmd
= read_key_sequence_cmd
;
1530 if (!NILP (Vexecuting_macro
))
1532 if (!NILP (Vquit_flag
))
1534 Vexecuting_macro
= Qt
;
1535 QUIT
; /* Make some noise. */
1536 /* Will return since macro now empty. */
1540 /* Do redisplay processing after this command except in special
1541 cases identified below. */
1542 prev_buffer
= current_buffer
;
1543 prev_modiff
= MODIFF
;
1544 last_point_position
= PT
;
1545 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1547 /* By default, we adjust point to a boundary of a region that
1548 has such a property that should be treated intangible
1549 (e.g. composition, display). But, some commands will set
1550 this variable differently. */
1551 Vdisable_point_adjustment
= Qnil
;
1553 /* Process filters and timers may have messed with deactivate-mark.
1554 reset it before we execute the command. */
1555 Vdeactivate_mark
= Qnil
;
1557 /* Remap command through active keymaps */
1558 Vthis_original_command
= cmd
;
1562 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1566 /* Execute the command. */
1568 Vthis_command
= cmd
;
1569 real_this_command
= cmd
;
1570 /* Note that the value cell will never directly contain nil
1571 if the symbol is a local variable. */
1572 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1573 safe_run_hooks (Qpre_command_hook
);
1575 already_adjusted
= 0;
1577 if (NILP (Vthis_command
))
1579 /* nil means key is undefined. */
1581 current_kboard
->defining_kbd_macro
= Qnil
;
1582 update_mode_lines
= 1;
1583 current_kboard
->Vprefix_arg
= Qnil
;
1587 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1589 /* In case we jump to directly_done. */
1590 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1592 /* Recognize some common commands in common situations and
1593 do them directly. */
1594 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1596 struct Lisp_Char_Table
*dp
1597 = window_display_table (XWINDOW (selected_window
));
1598 lose
= FETCH_CHAR (PT_BYTE
);
1600 if (! NILP (Vpost_command_hook
))
1601 /* Put this before calling adjust_point_for_property
1602 so it will only get called once in any case. */
1604 if (current_buffer
== prev_buffer
1605 && last_point_position
!= PT
1606 && NILP (Vdisable_point_adjustment
)
1607 && NILP (Vglobal_disable_point_adjustment
))
1608 adjust_point_for_property (last_point_position
, 0);
1609 already_adjusted
= 1;
1610 if (PT
== last_point_position
+ 1
1612 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1613 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1614 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1615 && (lose
>= 0x20 && lose
< 0x7f)))
1616 : (lose
>= 0x20 && lose
< 0x7f))
1617 /* To extract the case of continuation on
1618 wide-column characters. */
1619 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1620 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1622 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1624 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1626 && !windows_or_buffers_changed
1627 && EQ (current_buffer
->selective_display
, Qnil
)
1628 && !detect_input_pending ()
1629 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1630 && NILP (Vexecuting_macro
))
1631 direct_output_forward_char (1);
1634 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1636 struct Lisp_Char_Table
*dp
1637 = window_display_table (XWINDOW (selected_window
));
1639 lose
= FETCH_CHAR (PT_BYTE
);
1640 if (! NILP (Vpost_command_hook
))
1642 if (current_buffer
== prev_buffer
1643 && last_point_position
!= PT
1644 && NILP (Vdisable_point_adjustment
)
1645 && NILP (Vglobal_disable_point_adjustment
))
1646 adjust_point_for_property (last_point_position
, 0);
1647 already_adjusted
= 1;
1648 if (PT
== last_point_position
- 1
1650 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1651 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1652 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1653 && (lose
>= 0x20 && lose
< 0x7f)))
1654 : (lose
>= 0x20 && lose
< 0x7f))
1655 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1657 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1659 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1661 && !windows_or_buffers_changed
1662 && EQ (current_buffer
->selective_display
, Qnil
)
1663 && !detect_input_pending ()
1664 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1665 && NILP (Vexecuting_macro
))
1666 direct_output_forward_char (-1);
1669 else if (EQ (Vthis_command
, Qself_insert_command
)
1670 /* Try this optimization only on char keystrokes. */
1671 && NATNUMP (last_command_char
)
1672 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1675 = translate_char (Vtranslation_table_for_input
,
1676 XFASTINT (last_command_char
), 0, 0, 0);
1678 if (NILP (Vexecuting_macro
)
1679 && !EQ (minibuf_window
, selected_window
))
1681 if (!nonundocount
|| nonundocount
>= 20)
1689 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1691 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1693 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1695 || MODIFF
<= SAVE_MODIFF
1696 || windows_or_buffers_changed
1697 || !EQ (current_buffer
->selective_display
, Qnil
)
1698 || detect_input_pending ()
1699 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1700 || !NILP (Vexecuting_macro
));
1702 value
= internal_self_insert (c
, 0);
1707 if (! NILP (Vpost_command_hook
))
1708 /* Put this before calling adjust_point_for_property
1709 so it will only get called once in any case. */
1712 /* VALUE == 1 when AFTER-CHANGE functions are
1713 installed which is the case most of the time
1714 because FONT-LOCK installs one. */
1715 if (!lose
&& !value
)
1716 direct_output_for_insert (c
);
1721 /* Here for a command that isn't executed directly */
1724 #ifdef HAVE_X_WINDOWS
1725 int scount
= SPECPDL_INDEX ();
1727 if (display_hourglass_p
1728 && NILP (Vexecuting_macro
))
1730 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1736 if (NILP (current_kboard
->Vprefix_arg
))
1738 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1740 #ifdef HAVE_X_WINDOWS
1741 /* Do not check display_hourglass_p here, because
1742 Fcommand_execute could change it, but we should cancel
1743 hourglass cursor anyway.
1744 But don't cancel the hourglass within a macro
1745 just because a command in the macro finishes. */
1746 if (NILP (Vexecuting_macro
))
1747 unbind_to (scount
, Qnil
);
1752 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1754 /* Note that the value cell will never directly contain nil
1755 if the symbol is a local variable. */
1756 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1757 safe_run_hooks (Qpost_command_hook
);
1759 /* If displaying a message, resize the echo area window to fit
1760 that message's size exactly. */
1761 if (!NILP (echo_area_buffer
[0]))
1762 resize_echo_area_exactly ();
1764 if (!NILP (Vdeferred_action_list
))
1765 safe_run_hooks (Qdeferred_action_function
);
1767 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1769 if (NILP (Vunread_command_events
)
1770 && NILP (Vunread_input_method_events
)
1771 && NILP (Vunread_post_input_method_events
)
1772 && NILP (Vexecuting_macro
)
1773 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1774 safe_run_hooks (Qpost_command_idle_hook
);
1777 /* If there is a prefix argument,
1778 1) We don't want Vlast_command to be ``universal-argument''
1779 (that would be dumb), so don't set Vlast_command,
1780 2) we want to leave echoing on so that the prefix will be
1781 echoed as part of this key sequence, so don't call
1783 3) we want to leave this_command_key_count non-zero, so that
1784 read_char will realize that it is re-reading a character, and
1785 not echo it a second time.
1787 If the command didn't actually create a prefix arg,
1788 but is merely a frame event that is transparent to prefix args,
1789 then the above doesn't apply. */
1790 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1792 current_kboard
->Vlast_command
= Vthis_command
;
1793 current_kboard
->Vreal_last_command
= real_this_command
;
1795 this_command_key_count
= 0;
1796 this_command_key_count_reset
= 0;
1797 this_single_command_key_start
= 0;
1800 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1802 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1804 /* We could also call `deactivate'mark'. */
1805 if (EQ (Vtransient_mark_mode
, Qlambda
))
1806 Vtransient_mark_mode
= Qnil
;
1809 current_buffer
->mark_active
= Qnil
;
1810 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1813 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1814 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1819 if (current_buffer
== prev_buffer
1820 && last_point_position
!= PT
1821 && NILP (Vdisable_point_adjustment
)
1822 && NILP (Vglobal_disable_point_adjustment
)
1823 && !already_adjusted
)
1824 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1826 /* Install chars successfully executed in kbd macro. */
1828 if (!NILP (current_kboard
->defining_kbd_macro
)
1829 && NILP (current_kboard
->Vprefix_arg
))
1830 finalize_kbd_macro_chars ();
1834 any_kboard_state ();
1839 extern Lisp_Object Qcomposition
, Qdisplay
;
1841 /* Adjust point to a boundary of a region that has such a property
1842 that should be treated intangible. For the moment, we check
1843 `composition', `display' and `invisible' properties.
1844 LAST_PT is the last position of point. */
1846 extern Lisp_Object Qafter_string
, Qbefore_string
;
1847 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1850 adjust_point_for_property (last_pt
, modified
)
1855 Lisp_Object val
, overlay
, tmp
;
1856 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1859 /* FIXME: cycling is probably not necessary because these properties
1860 can't be usefully combined anyway. */
1861 while (check_composition
|| check_display
|| check_invisible
)
1863 if (check_composition
1864 && PT
> BEGV
&& PT
< ZV
1865 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1866 && COMPOSITION_VALID_P (beg
, end
, val
)
1867 && beg
< PT
/* && end > PT <- It's always the case. */
1868 && (last_pt
<= beg
|| last_pt
>= end
))
1871 SET_PT (PT
< last_pt
? beg
: end
);
1872 check_display
= check_invisible
= 1;
1874 check_composition
= 0;
1876 && PT
> BEGV
&& PT
< ZV
1877 && !NILP (val
= get_char_property_and_overlay
1878 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1879 && display_prop_intangible_p (val
)
1880 && (!OVERLAYP (overlay
)
1881 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1882 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1883 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1884 && beg
< PT
) /* && end > PT <- It's always the case. */
1887 SET_PT (PT
< last_pt
? beg
: end
);
1888 check_composition
= check_invisible
= 1;
1891 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1893 int inv
, ellipsis
= 0;
1896 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1898 && !NILP (val
= get_char_property_and_overlay
1899 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1900 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1902 ellipsis
= ellipsis
|| inv
> 1
1903 || (OVERLAYP (overlay
)
1904 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1905 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1906 tmp
= Fnext_single_char_property_change
1907 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1908 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1911 && !NILP (val
= get_char_property_and_overlay
1912 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1913 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1915 ellipsis
= ellipsis
|| inv
> 1
1916 || (OVERLAYP (overlay
)
1917 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1918 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1919 tmp
= Fprevious_single_char_property_change
1920 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1921 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1924 /* Move away from the inside area. */
1925 if (beg
< PT
&& end
> PT
)
1927 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1928 /* We haven't moved yet (so we don't need to fear
1929 infinite-looping) and we were outside the range
1930 before (so either end of the range still corresponds
1931 to a move in the right direction): pretend we moved
1932 less than we actually did, so that we still have
1933 more freedom below in choosing which end of the range
1935 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1936 /* We either have moved already or the last point
1937 was already in the range: we don't get to choose
1938 which end of the range we have to go to. */
1939 : (PT
< last_pt
? beg
: end
));
1940 check_composition
= check_display
= 1;
1942 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1943 the point to something other than its argument, due to
1944 point-motion hooks, intangibility, etc. */
1945 xassert (PT
== beg
|| PT
== end
);
1948 /* Pretend the area doesn't exist if the buffer is not
1950 if (!modified
&& !ellipsis
&& beg
< end
)
1952 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1953 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1954 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1955 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1956 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1957 /* We've already moved as far as we can. Trying to go
1958 to the other end would mean moving backwards and thus
1959 could lead to an infinite loop. */
1961 else if (val
= get_pos_property (make_number (PT
),
1963 TEXT_PROP_MEANS_INVISIBLE (val
)
1964 && (val
= get_pos_property
1965 (make_number (PT
== beg
? end
: beg
),
1967 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1968 (check_composition
= check_display
= 1,
1969 SET_PT (PT
== beg
? end
: beg
));
1972 check_invisible
= 0;
1976 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1979 safe_run_hooks_1 (hook
)
1982 return call1 (Vrun_hooks
, Vinhibit_quit
);
1985 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1988 safe_run_hooks_error (data
)
1991 Lisp_Object args
[3];
1992 args
[0] = build_string ("Error in %s: %s");
1993 args
[1] = Vinhibit_quit
;
1996 return Fset (Vinhibit_quit
, Qnil
);
1999 /* If we get an error while running the hook, cause the hook variable
2000 to be nil. Also inhibit quits, so that C-g won't cause the hook
2001 to mysteriously evaporate. */
2004 safe_run_hooks (hook
)
2007 int count
= SPECPDL_INDEX ();
2008 specbind (Qinhibit_quit
, hook
);
2010 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2012 unbind_to (count
, Qnil
);
2016 /* Number of seconds between polling for input. This is a Lisp
2017 variable that can be bound. */
2019 EMACS_INT polling_period
;
2021 /* Nonzero means polling for input is temporarily suppressed. */
2023 int poll_suppress_count
;
2025 /* Asynchronous timer for polling. */
2027 struct atimer
*poll_timer
;
2030 #ifdef POLL_FOR_INPUT
2032 /* Poll for input, so what we catch a C-g if it comes in. This
2033 function is called from x_make_frame_visible, see comment
2039 if (interrupt_input_blocked
== 0
2040 && !waiting_for_input
)
2041 read_avail_input (0);
2044 /* Timer callback function for poll_timer. TIMER is equal to
2048 poll_for_input (timer
)
2049 struct atimer
*timer
;
2051 if (poll_suppress_count
== 0)
2052 poll_for_input_1 ();
2055 #endif /* POLL_FOR_INPUT */
2057 /* Begin signals to poll for input, if they are appropriate.
2058 This function is called unconditionally from various places. */
2063 #ifdef POLL_FOR_INPUT
2064 if (read_socket_hook
&& !interrupt_input
)
2066 /* Turn alarm handling on unconditionally. It might have
2067 been turned off in process.c. */
2068 turn_on_atimers (1);
2070 /* If poll timer doesn't exist, are we need one with
2071 a different interval, start a new one. */
2072 if (poll_timer
== NULL
2073 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2075 EMACS_TIME interval
;
2078 cancel_atimer (poll_timer
);
2080 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2081 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2082 poll_for_input
, NULL
);
2085 /* Let the timer's callback function poll for input
2086 if this becomes zero. */
2087 --poll_suppress_count
;
2092 /* Nonzero if we are using polling to handle input asynchronously. */
2095 input_polling_used ()
2097 #ifdef POLL_FOR_INPUT
2098 return read_socket_hook
&& !interrupt_input
;
2104 /* Turn off polling. */
2109 #ifdef POLL_FOR_INPUT
2110 if (read_socket_hook
&& !interrupt_input
)
2111 ++poll_suppress_count
;
2115 /* Set the value of poll_suppress_count to COUNT
2116 and start or stop polling accordingly. */
2119 set_poll_suppress_count (count
)
2122 #ifdef POLL_FOR_INPUT
2123 if (count
== 0 && poll_suppress_count
!= 0)
2125 poll_suppress_count
= 1;
2128 else if (count
!= 0 && poll_suppress_count
== 0)
2132 poll_suppress_count
= count
;
2136 /* Bind polling_period to a value at least N.
2137 But don't decrease it. */
2140 bind_polling_period (n
)
2143 #ifdef POLL_FOR_INPUT
2144 int new = polling_period
;
2149 stop_other_atimers (poll_timer
);
2151 specbind (Qpolling_period
, make_number (new));
2152 /* Start a new alarm with the new period. */
2157 /* Apply the control modifier to CHARACTER. */
2163 /* Save the upper bits here. */
2164 int upper
= c
& ~0177;
2168 /* Everything in the columns containing the upper-case letters
2169 denotes a control character. */
2170 if (c
>= 0100 && c
< 0140)
2174 /* Set the shift modifier for a control char
2175 made from a shifted letter. But only for letters! */
2176 if (oc
>= 'A' && oc
<= 'Z')
2177 c
|= shift_modifier
;
2180 /* The lower-case letters denote control characters too. */
2181 else if (c
>= 'a' && c
<= 'z')
2184 /* Include the bits for control and shift
2185 only if the basic ASCII code can't indicate them. */
2189 /* Replace the high bits. */
2190 c
|= (upper
& ~ctrl_modifier
);
2195 /* Display help echo in the echo area.
2197 HELP a string means display that string, HELP nil means clear the
2198 help echo. If HELP is a function, call it with OBJECT and POS as
2199 arguments; the function should return a help string or nil for
2200 none. For all other types of HELP evaluate it to obtain a string.
2202 WINDOW is the window in which the help was generated, if any.
2203 It is nil if not in a window.
2205 If OBJECT is a buffer, POS is the position in the buffer where the
2206 `help-echo' text property was found.
2208 If OBJECT is an overlay, that overlay has a `help-echo' property,
2209 and POS is the position in the overlay's buffer under the mouse.
2211 If OBJECT is a string (an overlay string or a string displayed with
2212 the `display' property). POS is the position in that string under
2215 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2216 echo overwrites a keystroke echo currently displayed in the echo
2219 Note: this function may only be called with HELP nil or a string
2220 from X code running asynchronously. */
2223 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2224 Lisp_Object help
, window
, object
, pos
;
2225 int ok_to_overwrite_keystroke_echo
;
2227 if (!NILP (help
) && !STRINGP (help
))
2229 if (FUNCTIONP (help
))
2231 Lisp_Object args
[4];
2236 help
= safe_call (4, args
);
2239 help
= safe_eval (help
);
2241 if (!STRINGP (help
))
2245 if (STRINGP (help
) || NILP (help
))
2247 if (!NILP (Vshow_help_function
))
2248 call1 (Vshow_help_function
, help
);
2249 else if (/* Don't overwrite minibuffer contents. */
2250 !MINI_WINDOW_P (XWINDOW (selected_window
))
2251 /* Don't overwrite a keystroke echo. */
2252 && (NILP (echo_message_buffer
)
2253 || ok_to_overwrite_keystroke_echo
)
2254 /* Don't overwrite a prompt. */
2255 && !cursor_in_echo_area
)
2259 int count
= SPECPDL_INDEX ();
2261 if (!help_echo_showing_p
)
2262 Vpre_help_message
= current_message ();
2264 specbind (Qmessage_truncate_lines
, Qt
);
2265 message3_nolog (help
, SBYTES (help
),
2266 STRING_MULTIBYTE (help
));
2267 unbind_to (count
, Qnil
);
2269 else if (STRINGP (Vpre_help_message
))
2271 message3_nolog (Vpre_help_message
,
2272 SBYTES (Vpre_help_message
),
2273 STRING_MULTIBYTE (Vpre_help_message
));
2274 Vpre_help_message
= Qnil
;
2280 help_echo_showing_p
= STRINGP (help
);
2286 /* Input of single characters from keyboard */
2288 Lisp_Object
print_help ();
2289 static Lisp_Object
kbd_buffer_get_event ();
2290 static void record_char ();
2293 static jmp_buf wrong_kboard_jmpbuf
;
2296 #define STOP_POLLING \
2297 do { if (! polling_stopped_here) stop_polling (); \
2298 polling_stopped_here = 1; } while (0)
2300 #define RESUME_POLLING \
2301 do { if (polling_stopped_here) start_polling (); \
2302 polling_stopped_here = 0; } while (0)
2304 /* read a character from the keyboard; call the redisplay if needed */
2305 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2306 -1 means do not do redisplay, but do do autosaving.
2309 /* The arguments MAPS and NMAPS are for menu prompting.
2310 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2312 PREV_EVENT is the previous input event, or nil if we are reading
2313 the first event of a key sequence (or not reading a key sequence).
2314 If PREV_EVENT is t, that is a "magic" value that says
2315 not to run input methods, but in other respects to act as if
2316 not reading a key sequence.
2318 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2319 if we used a mouse menu to read the input, or zero otherwise. If
2320 USED_MOUSE_MENU is null, we don't dereference it.
2322 Value is t if we showed a menu and the user rejected it. */
2325 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2329 Lisp_Object prev_event
;
2330 int *used_mouse_menu
;
2332 volatile Lisp_Object c
;
2334 jmp_buf local_getcjmp
;
2336 volatile int key_already_recorded
= 0;
2337 Lisp_Object tem
, save
;
2338 volatile Lisp_Object previous_echo_area_message
;
2339 volatile Lisp_Object also_record
;
2340 volatile int reread
;
2341 struct gcpro gcpro1
, gcpro2
;
2342 EMACS_TIME last_idle_start
;
2343 int polling_stopped_here
= 0;
2347 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2348 before_command_key_count
= this_command_key_count
;
2349 before_command_echo_length
= echo_length ();
2352 previous_echo_area_message
= Qnil
;
2354 GCPRO2 (c
, previous_echo_area_message
);
2359 if (CONSP (Vunread_post_input_method_events
))
2361 c
= XCAR (Vunread_post_input_method_events
);
2362 Vunread_post_input_method_events
2363 = XCDR (Vunread_post_input_method_events
);
2365 /* Undo what read_char_x_menu_prompt did when it unread
2366 additional keys returned by Fx_popup_menu. */
2368 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2376 if (unread_command_char
!= -1)
2378 XSETINT (c
, unread_command_char
);
2379 unread_command_char
= -1;
2385 if (CONSP (Vunread_command_events
))
2387 c
= XCAR (Vunread_command_events
);
2388 Vunread_command_events
= XCDR (Vunread_command_events
);
2390 /* Undo what read_char_x_menu_prompt did when it unread
2391 additional keys returned by Fx_popup_menu. */
2393 && EQ (XCDR (c
), Qdisabled
)
2394 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2397 /* If the queued event is something that used the mouse,
2398 set used_mouse_menu accordingly. */
2400 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2401 *used_mouse_menu
= 1;
2404 goto reread_for_input_method
;
2407 if (CONSP (Vunread_input_method_events
))
2409 c
= XCAR (Vunread_input_method_events
);
2410 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2412 /* Undo what read_char_x_menu_prompt did when it unread
2413 additional keys returned by Fx_popup_menu. */
2415 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2419 goto reread_for_input_method
;
2422 this_command_key_count_reset
= 0;
2424 if (!NILP (Vexecuting_macro
))
2426 /* We set this to Qmacro; since that's not a frame, nobody will
2427 try to switch frames on us, and the selected window will
2430 Since this event came from a macro, it would be misleading to
2431 leave internal_last_event_frame set to wherever the last
2432 real event came from. Normally, a switch-frame event selects
2433 internal_last_event_frame after each command is read, but
2434 events read from a macro should never cause a new frame to be
2436 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2438 /* Exit the macro if we are at the end.
2439 Also, some things replace the macro with t
2440 to force an early exit. */
2441 if (EQ (Vexecuting_macro
, Qt
)
2442 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2448 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2449 if (STRINGP (Vexecuting_macro
)
2450 && (XINT (c
) & 0x80))
2451 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2453 executing_macro_index
++;
2458 if (!NILP (unread_switch_frame
))
2460 c
= unread_switch_frame
;
2461 unread_switch_frame
= Qnil
;
2463 /* This event should make it into this_command_keys, and get echoed
2464 again, so we do not set `reread'. */
2468 /* if redisplay was requested */
2469 if (commandflag
>= 0)
2471 /* If there is pending input, process any events which are not
2472 user-visible, such as X selection_request events. */
2474 || detect_input_pending_run_timers (0))
2475 swallow_events (0); /* may clear input_pending */
2477 /* Redisplay if no pending input. */
2478 while (!input_pending
)
2480 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2481 redisplay_preserve_echo_area (5);
2486 /* Normal case: no input arrived during redisplay. */
2489 /* Input arrived and pre-empted redisplay.
2490 Process any events which are not user-visible. */
2492 /* If that cleared input_pending, try again to redisplay. */
2496 /* Message turns off echoing unless more keystrokes turn it on again.
2498 The code in 20.x for the condition was
2500 1. echo_area_glyphs && *echo_area_glyphs
2501 2. && echo_area_glyphs != current_kboard->echobuf
2502 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2504 (1) means there's a current message displayed
2506 (2) means it's not the message from echoing from the current
2509 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2510 is set to a non-null value. This is done in read_char and it is
2511 set to echo_area_glyphs after a call to echo_char. That means
2512 ok_to_echo_at_next_pause is either null or
2513 current_kboard->echobuf with the appropriate current_kboard at
2516 So, condition (3) means in clear text ok_to_echo_at_next_pause
2517 must be either null, or the current message isn't from echoing at
2518 all, or it's from echoing from a different kboard than the
2521 if (/* There currently is something in the echo area. */
2522 !NILP (echo_area_buffer
[0])
2523 && (/* And it's either not from echoing. */
2524 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2525 /* Or it's an echo from a different kboard. */
2526 || echo_kboard
!= current_kboard
2527 /* Or we explicitly allow overwriting whatever there is. */
2528 || ok_to_echo_at_next_pause
== NULL
))
2533 /* Try reading a character via menu prompting in the minibuf.
2534 Try this before the sit-for, because the sit-for
2535 would do the wrong thing if we are supposed to do
2536 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2537 after a mouse event so don't try a minibuf menu. */
2539 if (nmaps
> 0 && INTERACTIVE
2540 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2541 /* Don't bring up a menu if we already have another event. */
2542 && NILP (Vunread_command_events
)
2543 && unread_command_char
< 0
2544 && !detect_input_pending_run_timers (0))
2546 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2549 key_already_recorded
= 1;
2554 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2555 We will do that below, temporarily for short sections of code,
2556 when appropriate. local_getcjmp must be in effect
2557 around any call to sit_for or kbd_buffer_get_event;
2558 it *must not* be in effect when we call redisplay. */
2560 if (_setjmp (local_getcjmp
))
2562 XSETINT (c
, quit_char
);
2563 internal_last_event_frame
= selected_frame
;
2564 Vlast_event_frame
= internal_last_event_frame
;
2565 /* If we report the quit char as an event,
2566 don't do so more than once. */
2567 if (!NILP (Vinhibit_quit
))
2572 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2573 if (kb
!= current_kboard
)
2575 Lisp_Object link
= kb
->kbd_queue
;
2576 /* We shouldn't get here if we were in single-kboard mode! */
2581 while (CONSP (XCDR (link
)))
2583 if (!NILP (XCDR (link
)))
2587 kb
->kbd_queue
= Fcons (c
, Qnil
);
2589 XSETCDR (link
, Fcons (c
, Qnil
));
2590 kb
->kbd_queue_has_data
= 1;
2591 current_kboard
= kb
;
2592 /* This is going to exit from read_char
2593 so we had better get rid of this frame's stuff. */
2595 longjmp (wrong_kboard_jmpbuf
, 1);
2602 timer_start_idle ();
2604 /* If in middle of key sequence and minibuffer not active,
2605 start echoing if enough time elapses. */
2607 if (minibuf_level
== 0
2608 && !current_kboard
->immediate_echo
2609 && this_command_key_count
> 0
2611 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2612 && NILP (Fzerop (Vecho_keystrokes
))
2613 && (/* No message. */
2614 NILP (echo_area_buffer
[0])
2615 /* Or empty message. */
2616 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2617 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2618 /* Or already echoing from same kboard. */
2619 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2620 /* Or not echoing before and echoing allowed. */
2621 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2625 /* After a mouse event, start echoing right away.
2626 This is because we are probably about to display a menu,
2627 and we don't want to delay before doing so. */
2628 if (EVENT_HAS_PARAMETERS (prev_event
))
2633 double duration
= extract_float (Vecho_keystrokes
);
2634 sec
= (int) duration
;
2635 usec
= (duration
- sec
) * 1000000;
2636 save_getcjmp (save_jump
);
2637 restore_getcjmp (local_getcjmp
);
2638 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2639 restore_getcjmp (save_jump
);
2641 && ! CONSP (Vunread_command_events
))
2646 /* Maybe auto save due to number of keystrokes. */
2648 if (commandflag
!= 0
2649 && auto_save_interval
> 0
2650 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2651 && !detect_input_pending_run_timers (0))
2653 Fdo_auto_save (Qnil
, Qnil
);
2654 /* Hooks can actually change some buffers in auto save. */
2658 /* Try reading using an X menu.
2659 This is never confused with reading using the minibuf
2660 because the recursive call of read_char in read_char_minibuf_menu_prompt
2661 does not pass on any keymaps. */
2663 if (nmaps
> 0 && INTERACTIVE
2664 && !NILP (prev_event
)
2665 && EVENT_HAS_PARAMETERS (prev_event
)
2666 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2667 && !EQ (XCAR (prev_event
), Qtool_bar
)
2668 /* Don't bring up a menu if we already have another event. */
2669 && NILP (Vunread_command_events
)
2670 && unread_command_char
< 0)
2672 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2674 /* Now that we have read an event, Emacs is not idle. */
2680 /* Maybe autosave and/or garbage collect due to idleness. */
2682 if (INTERACTIVE
&& NILP (c
))
2684 int delay_level
, buffer_size
;
2686 /* Slow down auto saves logarithmically in size of current buffer,
2687 and garbage collect while we're at it. */
2688 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2689 last_non_minibuf_size
= Z
- BEG
;
2690 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2692 while (buffer_size
> 64)
2693 delay_level
++, buffer_size
-= buffer_size
>> 2;
2694 if (delay_level
< 4) delay_level
= 4;
2695 /* delay_level is 4 for files under around 50k, 7 at 100k,
2696 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2698 /* Auto save if enough time goes by without input. */
2699 if (commandflag
!= 0
2700 && num_nonmacro_input_events
> last_auto_save
2701 && INTEGERP (Vauto_save_timeout
)
2702 && XINT (Vauto_save_timeout
) > 0)
2706 save_getcjmp (save_jump
);
2707 restore_getcjmp (local_getcjmp
);
2708 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2710 restore_getcjmp (save_jump
);
2713 && ! CONSP (Vunread_command_events
))
2715 Fdo_auto_save (Qnil
, Qnil
);
2717 /* If we have auto-saved and there is still no input
2718 available, garbage collect if there has been enough
2719 consing going on to make it worthwhile. */
2720 if (!detect_input_pending_run_timers (0)
2721 && consing_since_gc
> gc_cons_threshold
/ 2)
2722 Fgarbage_collect ();
2729 /* If this has become non-nil here, it has been set by a timer
2730 or sentinel or filter. */
2731 if (CONSP (Vunread_command_events
))
2733 c
= XCAR (Vunread_command_events
);
2734 Vunread_command_events
= XCDR (Vunread_command_events
);
2737 /* Read something from current KBOARD's side queue, if possible. */
2741 if (current_kboard
->kbd_queue_has_data
)
2743 if (!CONSP (current_kboard
->kbd_queue
))
2745 c
= XCAR (current_kboard
->kbd_queue
);
2746 current_kboard
->kbd_queue
2747 = XCDR (current_kboard
->kbd_queue
);
2748 if (NILP (current_kboard
->kbd_queue
))
2749 current_kboard
->kbd_queue_has_data
= 0;
2750 input_pending
= readable_events (0);
2751 if (EVENT_HAS_PARAMETERS (c
)
2752 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2753 internal_last_event_frame
= XCAR (XCDR (c
));
2754 Vlast_event_frame
= internal_last_event_frame
;
2759 /* If current_kboard's side queue is empty check the other kboards.
2760 If one of them has data that we have not yet seen here,
2761 switch to it and process the data waiting for it.
2763 Note: if the events queued up for another kboard
2764 have already been seen here, and therefore are not a complete command,
2765 the kbd_queue_has_data field is 0, so we skip that kboard here.
2766 That's to avoid an infinite loop switching between kboards here. */
2767 if (NILP (c
) && !single_kboard
)
2770 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2771 if (kb
->kbd_queue_has_data
)
2773 current_kboard
= kb
;
2774 /* This is going to exit from read_char
2775 so we had better get rid of this frame's stuff. */
2777 longjmp (wrong_kboard_jmpbuf
, 1);
2786 /* Finally, we read from the main queue,
2787 and if that gives us something we can't use yet, we put it on the
2788 appropriate side queue and try again. */
2794 /* Actually read a character, waiting if necessary. */
2795 save_getcjmp (save_jump
);
2796 restore_getcjmp (local_getcjmp
);
2797 timer_start_idle ();
2798 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2799 restore_getcjmp (save_jump
);
2802 if (! NILP (c
) && (kb
!= current_kboard
))
2804 Lisp_Object link
= kb
->kbd_queue
;
2807 while (CONSP (XCDR (link
)))
2809 if (!NILP (XCDR (link
)))
2813 kb
->kbd_queue
= Fcons (c
, Qnil
);
2815 XSETCDR (link
, Fcons (c
, Qnil
));
2816 kb
->kbd_queue_has_data
= 1;
2820 current_kboard
= kb
;
2821 /* This is going to exit from read_char
2822 so we had better get rid of this frame's stuff. */
2824 longjmp (wrong_kboard_jmpbuf
, 1);
2829 /* Terminate Emacs in batch mode if at eof. */
2830 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2831 Fkill_emacs (make_number (1));
2835 /* Add in any extra modifiers, where appropriate. */
2836 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2837 || ((extra_keyboard_modifiers
& 0177) < ' '
2838 && (extra_keyboard_modifiers
& 0177) != 0))
2839 XSETINT (c
, make_ctrl_char (XINT (c
)));
2841 /* Transfer any other modifier bits directly from
2842 extra_keyboard_modifiers to c. Ignore the actual character code
2843 in the low 16 bits of extra_keyboard_modifiers. */
2844 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2849 /* Record the last idle start time so that we can reset it
2850 should the next event read be a help-echo. */
2851 last_idle_start
= timer_idleness_start_time
;
2857 if (commandflag
>= 0
2858 && !input_pending
&& !detect_input_pending_run_timers (0))
2866 /* Buffer switch events are only for internal wakeups
2867 so don't show them to the user.
2868 Also, don't record a key if we already did. */
2869 if (BUFFERP (c
) || key_already_recorded
)
2872 /* Process special events within read_char
2873 and loop around to read another event. */
2876 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2881 int was_locked
= single_kboard
;
2883 last_input_char
= c
;
2884 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2886 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2887 /* We stopped being idle for this event; undo that. This
2888 prevents automatic window selection (under
2889 mouse_autoselect_window from acting as a real input event, for
2890 example banishing the mouse under mouse-avoidance-mode. */
2891 timer_idleness_start_time
= last_idle_start
;
2893 /* Resume allowing input from any kboard, if that was true before. */
2895 any_kboard_state ();
2900 /* Handle things that only apply to characters. */
2903 /* If kbd_buffer_get_event gave us an EOF, return that. */
2907 if ((STRINGP (Vkeyboard_translate_table
)
2908 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2909 || (VECTORP (Vkeyboard_translate_table
)
2910 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2911 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2912 && CHAR_VALID_P (XINT (c
), 0)))
2915 d
= Faref (Vkeyboard_translate_table
, c
);
2916 /* nil in keyboard-translate-table means no translation. */
2922 /* If this event is a mouse click in the menu bar,
2923 return just menu-bar for now. Modify the mouse click event
2924 so we won't do this twice, then queue it up. */
2925 if (EVENT_HAS_PARAMETERS (c
)
2927 && CONSP (EVENT_START (c
))
2928 && CONSP (XCDR (EVENT_START (c
))))
2932 posn
= POSN_POSN (EVENT_START (c
));
2933 /* Handle menu-bar events:
2934 insert the dummy prefix event `menu-bar'. */
2935 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2937 /* Change menu-bar to (menu-bar) as the event "position". */
2938 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2941 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2946 /* Store these characters into recent_keys, the dribble file if any,
2947 and the keyboard macro being defined, if any. */
2949 if (! NILP (also_record
))
2950 record_char (also_record
);
2952 /* Wipe the echo area.
2953 But first, if we are about to use an input method,
2954 save the echo area contents for it to refer to. */
2956 && ! NILP (Vinput_method_function
)
2957 && (unsigned) XINT (c
) >= ' '
2958 && (unsigned) XINT (c
) != 127
2959 && (unsigned) XINT (c
) < 256)
2961 previous_echo_area_message
= Fcurrent_message ();
2962 Vinput_method_previous_message
= previous_echo_area_message
;
2965 /* Now wipe the echo area, except for help events which do their
2966 own stuff with the echo area. */
2968 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2969 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2971 if (!NILP (echo_area_buffer
[0]))
2972 safe_run_hooks (Qecho_area_clear_hook
);
2973 clear_message (1, 0);
2976 reread_for_input_method
:
2978 /* Pass this to the input method, if appropriate. */
2980 && ! NILP (Vinput_method_function
)
2981 /* Don't run the input method within a key sequence,
2982 after the first event of the key sequence. */
2983 && NILP (prev_event
)
2984 && (unsigned) XINT (c
) >= ' '
2985 && (unsigned) XINT (c
) != 127
2986 && (unsigned) XINT (c
) < 256)
2989 int key_count
, key_count_reset
;
2990 struct gcpro gcpro1
;
2991 int count
= SPECPDL_INDEX ();
2993 /* Save the echo status. */
2994 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2995 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2996 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2999 if (before_command_restore_flag
)
3001 this_command_key_count
= before_command_key_count_1
;
3002 if (this_command_key_count
< this_single_command_key_start
)
3003 this_single_command_key_start
= this_command_key_count
;
3004 echo_truncate (before_command_echo_length_1
);
3005 before_command_restore_flag
= 0;
3009 /* Save the this_command_keys status. */
3010 key_count
= this_command_key_count
;
3011 key_count_reset
= this_command_key_count_reset
;
3014 keys
= Fcopy_sequence (this_command_keys
);
3019 /* Clear out this_command_keys. */
3020 this_command_key_count
= 0;
3021 this_command_key_count_reset
= 0;
3023 /* Now wipe the echo area. */
3024 if (!NILP (echo_area_buffer
[0]))
3025 safe_run_hooks (Qecho_area_clear_hook
);
3026 clear_message (1, 0);
3029 /* If we are not reading a key sequence,
3030 never use the echo area. */
3033 specbind (Qinput_method_use_echo_area
, Qt
);
3036 /* Call the input method. */
3037 tem
= call1 (Vinput_method_function
, c
);
3039 tem
= unbind_to (count
, tem
);
3041 /* Restore the saved echoing state
3042 and this_command_keys state. */
3043 this_command_key_count
= key_count
;
3044 this_command_key_count_reset
= key_count_reset
;
3046 this_command_keys
= keys
;
3049 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3050 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3051 if (saved_immediate_echo
)
3056 /* The input method can return no events. */
3059 /* Bring back the previous message, if any. */
3060 if (! NILP (previous_echo_area_message
))
3061 message_with_string ("%s", previous_echo_area_message
, 0);
3064 /* It returned one event or more. */
3066 Vunread_post_input_method_events
3067 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3072 /* Display help if not echoing. */
3073 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3075 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3076 Lisp_Object help
, object
, position
, window
, tem
;
3078 tem
= Fcdr (XCDR (c
));
3081 window
= Fcar (tem
);
3083 object
= Fcar (tem
);
3085 position
= Fcar (tem
);
3087 show_help_echo (help
, window
, object
, position
, 0);
3089 /* We stopped being idle for this event; undo that. */
3090 timer_idleness_start_time
= last_idle_start
;
3094 if (! reread
|| this_command_key_count
== 0
3095 || this_command_key_count_reset
)
3098 /* Don't echo mouse motion events. */
3099 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3100 && NILP (Fzerop (Vecho_keystrokes
))
3101 && ! (EVENT_HAS_PARAMETERS (c
)
3102 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3105 if (! NILP (also_record
))
3106 echo_char (also_record
);
3107 /* Once we reread a character, echoing can happen
3108 the next time we pause to read a new one. */
3109 ok_to_echo_at_next_pause
= current_kboard
;
3112 /* Record this character as part of the current key. */
3113 add_command_key (c
);
3114 if (! NILP (also_record
))
3115 add_command_key (also_record
);
3118 last_input_char
= c
;
3121 /* Process the help character specially if enabled */
3122 if (!NILP (Vhelp_form
) && help_char_p (c
))
3125 count
= SPECPDL_INDEX ();
3127 record_unwind_protect (Fset_window_configuration
,
3128 Fcurrent_window_configuration (Qnil
));
3130 tem0
= Feval (Vhelp_form
);
3132 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3136 c
= read_char (0, 0, 0, Qnil
, 0);
3137 while (BUFFERP (c
));
3138 /* Remove the help from the frame */
3139 unbind_to (count
, Qnil
);
3142 if (EQ (c
, make_number (040)))
3146 c
= read_char (0, 0, 0, Qnil
, 0);
3147 while (BUFFERP (c
));
3156 /* Record a key that came from a mouse menu.
3157 Record it for echoing, for this-command-keys, and so on. */
3163 /* Wipe the echo area. */
3164 clear_message (1, 0);
3169 before_command_key_count
= this_command_key_count
;
3170 before_command_echo_length
= echo_length ();
3173 /* Don't echo mouse motion events. */
3174 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3175 && NILP (Fzerop (Vecho_keystrokes
)))
3179 /* Once we reread a character, echoing can happen
3180 the next time we pause to read a new one. */
3181 ok_to_echo_at_next_pause
= 0;
3184 /* Record this character as part of the current key. */
3185 add_command_key (c
);
3187 /* Re-reading in the middle of a command */
3188 last_input_char
= c
;
3192 /* Return 1 if should recognize C as "the help character". */
3200 if (EQ (c
, Vhelp_char
))
3202 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3203 if (EQ (c
, XCAR (tail
)))
3208 /* Record the input event C in various ways. */
3216 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3218 /* To avoid filling recent_keys with help-echo and mouse-movement
3219 events, we filter out repeated help-echo events, only store the
3220 first and last in a series of mouse-movement events, and don't
3221 store repeated help-echo events which are only separated by
3222 mouse-movement events. */
3224 Lisp_Object ev1
, ev2
, ev3
;
3227 if ((ix1
= recent_keys_index
- 1) < 0)
3228 ix1
= NUM_RECENT_KEYS
- 1;
3229 ev1
= AREF (recent_keys
, ix1
);
3231 if ((ix2
= ix1
- 1) < 0)
3232 ix2
= NUM_RECENT_KEYS
- 1;
3233 ev2
= AREF (recent_keys
, ix2
);
3235 if ((ix3
= ix2
- 1) < 0)
3236 ix3
= NUM_RECENT_KEYS
- 1;
3237 ev3
= AREF (recent_keys
, ix3
);
3239 if (EQ (XCAR (c
), Qhelp_echo
))
3241 /* Don't record `help-echo' in recent_keys unless it shows some help
3242 message, and a different help than the previously recorded
3244 Lisp_Object help
, last_help
;
3246 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3247 if (!STRINGP (help
))
3249 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3250 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3252 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3253 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3254 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3256 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3257 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3258 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3259 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3262 else if (EQ (XCAR (c
), Qmouse_movement
))
3264 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3265 So additional mouse movement events replace the last element. */
3266 Lisp_Object last_window
, window
;
3268 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3269 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3270 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3271 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3272 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3274 ASET (recent_keys
, ix1
, c
);
3280 store_kbd_macro_char (c
);
3285 ASET (recent_keys
, recent_keys_index
, c
);
3286 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3287 recent_keys_index
= 0;
3289 else if (recorded
< 0)
3291 /* We need to remove one or two events from recent_keys.
3292 To do this, we simply put nil at those events and move the
3293 recent_keys_index backwards over those events. Usually,
3294 users will never see those nil events, as they will be
3295 overwritten by the command keys entered to see recent_keys
3298 while (recorded
++ < 0 && total_keys
> 0)
3300 if (total_keys
< NUM_RECENT_KEYS
)
3302 if (--recent_keys_index
< 0)
3303 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3304 ASET (recent_keys
, recent_keys_index
, Qnil
);
3308 num_nonmacro_input_events
++;
3310 /* Write c to the dribble file. If c is a lispy event, write
3311 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3312 If you, dear reader, have a better idea, you've got the source. :-) */
3317 if (XUINT (c
) < 0x100)
3318 putc (XINT (c
), dribble
);
3320 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3324 Lisp_Object dribblee
;
3326 /* If it's a structured event, take the event header. */
3327 dribblee
= EVENT_HEAD (c
);
3329 if (SYMBOLP (dribblee
))
3331 putc ('<', dribble
);
3332 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3333 SBYTES (SYMBOL_NAME (dribblee
)),
3335 putc ('>', dribble
);
3347 struct buffer
*old
= current_buffer
;
3348 Fprinc (object
, Qnil
);
3349 set_buffer_internal (XBUFFER (Vstandard_output
));
3350 call0 (intern ("help-mode"));
3351 set_buffer_internal (old
);
3355 /* Copy out or in the info on where C-g should throw to.
3356 This is used when running Lisp code from within get_char,
3357 in case get_char is called recursively.
3358 See read_process_output. */
3364 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3368 restore_getcjmp (temp
)
3371 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3376 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3377 of this function. */
3380 tracking_off (old_value
)
3381 Lisp_Object old_value
;
3383 do_mouse_tracking
= old_value
;
3384 if (NILP (old_value
))
3386 /* Redisplay may have been preempted because there was input
3387 available, and it assumes it will be called again after the
3388 input has been processed. If the only input available was
3389 the sort that we have just disabled, then we need to call
3391 if (!readable_events (1))
3393 redisplay_preserve_echo_area (6);
3394 get_input_pending (&input_pending
, 1);
3400 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3401 doc
: /* Evaluate BODY with mouse movement events enabled.
3402 Within a `track-mouse' form, mouse motion generates input events that
3403 you can read with `read-event'.
3404 Normally, mouse motion is ignored.
3405 usage: (track-mouse BODY ...) */)
3409 int count
= SPECPDL_INDEX ();
3412 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3414 do_mouse_tracking
= Qt
;
3416 val
= Fprogn (args
);
3417 return unbind_to (count
, val
);
3420 /* If mouse has moved on some frame, return one of those frames.
3421 Return 0 otherwise. */
3426 Lisp_Object tail
, frame
;
3428 FOR_EACH_FRAME (tail
, frame
)
3430 if (XFRAME (frame
)->mouse_moved
)
3431 return XFRAME (frame
);
3437 #endif /* HAVE_MOUSE */
3439 /* Low level keyboard/mouse input.
3440 kbd_buffer_store_event places events in kbd_buffer, and
3441 kbd_buffer_get_event retrieves them. */
3443 /* Return true iff there are any events in the queue that read-char
3444 would return. If this returns false, a read-char would block. */
3446 readable_filtered_events (do_timers_now
, filter_events
)
3451 timer_check (do_timers_now
);
3453 /* If the buffer contains only FOCUS_IN_EVENT events,
3454 and FILTER_EVENTS is nonzero, report it as empty. */
3455 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3457 int have_live_event
= 1;
3461 struct input_event
*event
;
3463 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3467 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3470 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3472 if (event
== kbd_store_ptr
)
3473 have_live_event
= 0;
3476 if (have_live_event
) return 1;
3480 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3485 if (current_kboard
->kbd_queue_has_data
)
3491 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3492 if (kb
->kbd_queue_has_data
)
3498 /* Return true iff there are any events in the queue that read-char
3499 would return. If this returns false, a read-char would block. */
3501 readable_events (do_timers_now
)
3504 return readable_filtered_events (do_timers_now
, 0);
3507 /* Set this for debugging, to have a way to get out */
3512 event_to_kboard (event
)
3513 struct input_event
*event
;
3516 frame
= event
->frame_or_window
;
3518 frame
= XCAR (frame
);
3519 else if (WINDOWP (frame
))
3520 frame
= WINDOW_FRAME (XWINDOW (frame
));
3522 /* There are still some events that don't set this field.
3523 For now, just ignore the problem.
3524 Also ignore dead frames here. */
3525 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3528 return FRAME_KBOARD (XFRAME (frame
));
3532 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3535 kbd_buffer_store_event (event
)
3536 register struct input_event
*event
;
3538 kbd_buffer_store_event_hold (event
, 0);
3541 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3543 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3544 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3545 Else, if EVENT is a quit event, store the quit event
3546 in HOLD_QUIT, and return (thus ignoring further events).
3548 This is used in read_avail_input to postpone the processing
3549 of the quit event until all subsequent input events have been
3550 parsed (and discarded).
3554 kbd_buffer_store_event_hold (event
, hold_quit
)
3555 register struct input_event
*event
;
3556 struct input_event
*hold_quit
;
3558 if (event
->kind
== NO_EVENT
)
3561 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3564 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3566 register int c
= event
->code
& 0377;
3568 if (event
->modifiers
& ctrl_modifier
)
3569 c
= make_ctrl_char (c
);
3571 c
|= (event
->modifiers
3572 & (meta_modifier
| alt_modifier
3573 | hyper_modifier
| super_modifier
));
3579 struct input_event
*sp
;
3582 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3583 kb
!= current_kboard
))
3586 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3587 Fcons (make_number (c
), Qnil
));
3588 kb
->kbd_queue_has_data
= 1;
3589 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3591 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3594 if (event_to_kboard (sp
) == kb
)
3596 sp
->kind
= NO_EVENT
;
3597 sp
->frame_or_window
= Qnil
;
3607 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3611 /* If this results in a quit_char being returned to Emacs as
3612 input, set Vlast_event_frame properly. If this doesn't
3613 get returned to Emacs as an event, the next event read
3614 will set Vlast_event_frame again, so this is safe to do. */
3618 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3620 focus
= event
->frame_or_window
;
3621 internal_last_event_frame
= focus
;
3622 Vlast_event_frame
= focus
;
3625 last_event_timestamp
= event
->timestamp
;
3626 interrupt_signal (0 /* dummy */);
3630 if (c
&& c
== stop_character
)
3636 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3637 Just ignore the second one. */
3638 else if (event
->kind
== BUFFER_SWITCH_EVENT
3639 && kbd_fetch_ptr
!= kbd_store_ptr
3640 && ((kbd_store_ptr
== kbd_buffer
3641 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3642 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3645 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3646 kbd_store_ptr
= kbd_buffer
;
3648 /* Don't let the very last slot in the buffer become full,
3649 since that would make the two pointers equal,
3650 and that is indistinguishable from an empty buffer.
3651 Discard the event if it would fill the last slot. */
3652 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3655 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3656 prone to assign individual members for other events, in case
3657 the input_event structure is changed. --2000-07-13, gerd. */
3658 struct input_event
*sp
= kbd_store_ptr
;
3659 sp
->kind
= event
->kind
;
3660 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3662 /* We must not use the ordinary copying code for this case,
3663 since `part' is an enum and copying it might not copy enough
3665 bcopy (event
, (char *) sp
, sizeof (*event
));
3670 sp
->code
= event
->code
;
3671 sp
->part
= event
->part
;
3672 sp
->frame_or_window
= event
->frame_or_window
;
3673 sp
->arg
= event
->arg
;
3674 sp
->modifiers
= event
->modifiers
;
3677 sp
->timestamp
= event
->timestamp
;
3680 *kbd_store_ptr
= *event
;
3688 /* Generate HELP_EVENT input_events in BUFP which has room for
3689 SIZE events. If there's not enough room in BUFP, ignore this
3692 HELP is the help form.
3694 FRAME is the frame on which the help is generated. OBJECT is the
3695 Lisp object where the help was found (a buffer, a string, an
3696 overlay, or nil if neither from a string nor from a buffer. POS is
3697 the position within OBJECT where the help was found.
3699 Value is the number of input_events generated. */
3702 gen_help_event (help
, frame
, window
, object
, pos
)
3703 Lisp_Object help
, frame
, object
, window
;
3706 struct input_event event
;
3710 event
.kind
= HELP_EVENT
;
3711 event
.frame_or_window
= frame
;
3713 event
.x
= WINDOWP (window
) ? window
: frame
;
3716 kbd_buffer_store_event (&event
);
3720 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3723 kbd_buffer_store_help_event (frame
, help
)
3724 Lisp_Object frame
, help
;
3726 struct input_event event
;
3728 event
.kind
= HELP_EVENT
;
3729 event
.frame_or_window
= frame
;
3734 kbd_buffer_store_event (&event
);
3738 /* Discard any mouse events in the event buffer by setting them to
3741 discard_mouse_events ()
3743 struct input_event
*sp
;
3744 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3746 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3749 if (sp
->kind
== MOUSE_CLICK_EVENT
3750 || sp
->kind
== WHEEL_EVENT
3752 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3754 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3756 sp
->kind
= NO_EVENT
;
3762 /* Return non-zero if there are any real events waiting in the event
3763 buffer, not counting `NO_EVENT's.
3765 If DISCARD is non-zero, discard NO_EVENT events at the front of
3766 the input queue, possibly leaving the input queue empty if there
3767 are no real input events. */
3770 kbd_buffer_events_waiting (discard
)
3773 struct input_event
*sp
;
3775 for (sp
= kbd_fetch_ptr
;
3776 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3779 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3786 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3790 /* Clear input event EVENT. */
3794 struct input_event
*event
;
3796 event
->kind
= NO_EVENT
;
3800 /* Read one event from the event buffer, waiting if necessary.
3801 The value is a Lisp object representing the event.
3802 The value is nil for an event that should be ignored,
3803 or that was handled here.
3804 We always read and discard one event. */
3807 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3809 int *used_mouse_menu
;
3818 *kbp
= current_kboard
;
3822 /* Wait until there is input available. */
3825 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3828 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3832 /* If the quit flag is set, then read_char will return
3833 quit_char, so that counts as "available input." */
3834 if (!NILP (Vquit_flag
))
3835 quit_throw_to_read_char ();
3837 /* One way or another, wait until input is available; then, if
3838 interrupt handlers have not read it, read it now. */
3841 wait_for_kbd_input ();
3843 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3847 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3850 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3854 Lisp_Object minus_one
;
3856 XSETINT (minus_one
, -1);
3857 wait_reading_process_input (0, 0, minus_one
, 1);
3859 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3860 /* Pass 1 for EXPECT since we just waited to have input. */
3861 read_avail_input (1);
3863 #endif /* not VMS */
3866 if (CONSP (Vunread_command_events
))
3869 first
= XCAR (Vunread_command_events
);
3870 Vunread_command_events
= XCDR (Vunread_command_events
);
3871 *kbp
= current_kboard
;
3875 /* At this point, we know that there is a readable event available
3876 somewhere. If the event queue is empty, then there must be a
3877 mouse movement enabled and available. */
3878 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3880 struct input_event
*event
;
3882 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3886 last_event_timestamp
= event
->timestamp
;
3889 *kbp
= event_to_kboard (event
);
3891 *kbp
= current_kboard
; /* Better than returning null ptr? */
3893 *kbp
= &the_only_kboard
;
3898 /* These two kinds of events get special handling
3899 and don't actually appear to the command loop.
3900 We return nil for them. */
3901 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3904 struct input_event copy
;
3906 /* Remove it from the buffer before processing it,
3907 since otherwise swallow_events will see it
3908 and process it again. */
3910 kbd_fetch_ptr
= event
+ 1;
3911 input_pending
= readable_events (0);
3912 x_handle_selection_request (©
);
3914 /* We're getting selection request events, but we don't have
3920 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3923 struct input_event copy
;
3925 /* Remove it from the buffer before processing it. */
3927 kbd_fetch_ptr
= event
+ 1;
3928 input_pending
= readable_events (0);
3929 x_handle_selection_clear (©
);
3931 /* We're getting selection request events, but we don't have
3936 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3937 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3939 /* Make an event (delete-frame (FRAME)). */
3940 obj
= Fcons (event
->frame_or_window
, Qnil
);
3941 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3942 kbd_fetch_ptr
= event
+ 1;
3945 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3946 else if (event
->kind
== ICONIFY_EVENT
)
3948 /* Make an event (iconify-frame (FRAME)). */
3949 obj
= Fcons (event
->frame_or_window
, Qnil
);
3950 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3951 kbd_fetch_ptr
= event
+ 1;
3953 else if (event
->kind
== DEICONIFY_EVENT
)
3955 /* Make an event (make-frame-visible (FRAME)). */
3956 obj
= Fcons (event
->frame_or_window
, Qnil
);
3957 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3958 kbd_fetch_ptr
= event
+ 1;
3961 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3963 /* The value doesn't matter here; only the type is tested. */
3964 XSETBUFFER (obj
, current_buffer
);
3965 kbd_fetch_ptr
= event
+ 1;
3967 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
3968 || defined (USE_GTK)
3969 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3971 kbd_fetch_ptr
= event
+ 1;
3972 input_pending
= readable_events (0);
3973 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3974 x_activate_menubar (XFRAME (event
->frame_or_window
));
3978 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3980 /* Make an event (language-change (FRAME CHARSET LCID)). */
3981 obj
= Fcons (event
->frame_or_window
, Qnil
);
3982 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3983 kbd_fetch_ptr
= event
+ 1;
3986 else if (event
->kind
== SAVE_SESSION_EVENT
)
3988 obj
= Fcons (Qsave_session
, Qnil
);
3989 kbd_fetch_ptr
= event
+ 1;
3991 /* Just discard these, by returning nil.
3992 With MULTI_KBOARD, these events are used as placeholders
3993 when we need to randomly delete events from the queue.
3994 (They shouldn't otherwise be found in the buffer,
3995 but on some machines it appears they do show up
3996 even without MULTI_KBOARD.) */
3997 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3998 mouse events during a popup-menu call. */
3999 else if (event
->kind
== NO_EVENT
)
4000 kbd_fetch_ptr
= event
+ 1;
4001 else if (event
->kind
== HELP_EVENT
)
4003 Lisp_Object object
, position
, help
, frame
, window
;
4005 frame
= event
->frame_or_window
;
4006 object
= event
->arg
;
4007 position
= make_number (event
->code
);
4010 clear_event (event
);
4012 kbd_fetch_ptr
= event
+ 1;
4013 if (!WINDOWP (window
))
4015 obj
= Fcons (Qhelp_echo
,
4016 list5 (frame
, help
, window
, object
, position
));
4018 else if (event
->kind
== FOCUS_IN_EVENT
)
4020 /* Notification of a FocusIn event. The frame receiving the
4021 focus is in event->frame_or_window. Generate a
4022 switch-frame event if necessary. */
4023 Lisp_Object frame
, focus
;
4025 frame
= event
->frame_or_window
;
4026 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4030 if (!EQ (frame
, internal_last_event_frame
)
4031 && !EQ (frame
, selected_frame
))
4032 obj
= make_lispy_switch_frame (frame
);
4033 internal_last_event_frame
= frame
;
4034 kbd_fetch_ptr
= event
+ 1;
4038 /* If this event is on a different frame, return a switch-frame this
4039 time, and leave the event in the queue for next time. */
4043 frame
= event
->frame_or_window
;
4045 frame
= XCAR (frame
);
4046 else if (WINDOWP (frame
))
4047 frame
= WINDOW_FRAME (XWINDOW (frame
));
4049 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4053 if (! EQ (frame
, internal_last_event_frame
)
4054 && !EQ (frame
, selected_frame
))
4055 obj
= make_lispy_switch_frame (frame
);
4056 internal_last_event_frame
= frame
;
4058 /* If we didn't decide to make a switch-frame event, go ahead
4059 and build a real event from the queue entry. */
4063 obj
= make_lispy_event (event
);
4065 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4066 || defined (USE_GTK)
4067 /* If this was a menu selection, then set the flag to inhibit
4068 writing to last_nonmenu_event. Don't do this if the event
4069 we're returning is (menu-bar), though; that indicates the
4070 beginning of the menu sequence, and we might as well leave
4071 that as the `event with parameters' for this selection. */
4073 && !EQ (event
->frame_or_window
, event
->arg
)
4074 && (event
->kind
== MENU_BAR_EVENT
4075 || event
->kind
== TOOL_BAR_EVENT
))
4076 *used_mouse_menu
= 1;
4079 /* Wipe out this event, to catch bugs. */
4080 clear_event (event
);
4081 kbd_fetch_ptr
= event
+ 1;
4086 /* Try generating a mouse motion event. */
4087 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4089 FRAME_PTR f
= some_mouse_moved ();
4090 Lisp_Object bar_window
;
4091 enum scroll_bar_part part
;
4095 *kbp
= current_kboard
;
4096 /* Note that this uses F to determine which display to look at.
4097 If there is no valid info, it does not store anything
4098 so x remains nil. */
4100 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4104 /* Decide if we should generate a switch-frame event. Don't
4105 generate switch-frame events for motion outside of all Emacs
4111 frame
= FRAME_FOCUS_FRAME (f
);
4113 XSETFRAME (frame
, f
);
4115 if (! EQ (frame
, internal_last_event_frame
)
4116 && !EQ (frame
, selected_frame
))
4117 obj
= make_lispy_switch_frame (frame
);
4118 internal_last_event_frame
= frame
;
4121 /* If we didn't decide to make a switch-frame event, go ahead and
4122 return a mouse-motion event. */
4123 if (!NILP (x
) && NILP (obj
))
4124 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4126 #endif /* HAVE_MOUSE */
4128 /* We were promised by the above while loop that there was
4129 something for us to read! */
4132 input_pending
= readable_events (0);
4134 Vlast_event_frame
= internal_last_event_frame
;
4139 /* Process any events that are not user-visible,
4140 then return, without reading any user-visible events. */
4143 swallow_events (do_display
)
4148 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4150 struct input_event
*event
;
4152 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4156 last_event_timestamp
= event
->timestamp
;
4158 /* These two kinds of events get special handling
4159 and don't actually appear to the command loop. */
4160 if (event
->kind
== SELECTION_REQUEST_EVENT
)
4163 struct input_event copy
;
4165 /* Remove it from the buffer before processing it,
4166 since otherwise swallow_events called recursively could see it
4167 and process it again. */
4169 kbd_fetch_ptr
= event
+ 1;
4170 input_pending
= readable_events (0);
4171 x_handle_selection_request (©
);
4173 /* We're getting selection request events, but we don't have
4179 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
4182 struct input_event copy
;
4184 /* Remove it from the buffer before processing it, */
4187 kbd_fetch_ptr
= event
+ 1;
4188 input_pending
= readable_events (0);
4189 x_handle_selection_clear (©
);
4191 /* We're getting selection request events, but we don't have
4200 old_timers_run
= timers_run
;
4201 get_input_pending (&input_pending
, 1);
4203 if (timers_run
!= old_timers_run
&& do_display
)
4204 redisplay_preserve_echo_area (7);
4207 /* Record the start of when Emacs is idle,
4208 for the sake of running idle-time timers. */
4215 /* If we are already in the idle state, do nothing. */
4216 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4219 EMACS_GET_TIME (timer_idleness_start_time
);
4221 timer_last_idleness_start_time
= timer_idleness_start_time
;
4223 /* Mark all idle-time timers as once again candidates for running. */
4224 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4228 timer
= XCAR (timers
);
4230 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4232 XVECTOR (timer
)->contents
[0] = Qnil
;
4236 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4241 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4244 /* This is only for debugging. */
4245 struct input_event last_timer_event
;
4247 /* Check whether a timer has fired. To prevent larger problems we simply
4248 disregard elements that are not proper timers. Do not make a circular
4249 timer list for the time being.
4251 Returns the number of seconds to wait until the next timer fires. If a
4252 timer is triggering now, return zero seconds.
4253 If no timer is active, return -1 seconds.
4255 If a timer is ripe, we run it, with quitting turned off.
4257 DO_IT_NOW is now ignored. It used to mean that we should
4258 run the timer directly instead of queueing a timer-event.
4259 Now we always run timers directly. */
4262 timer_check (do_it_now
)
4265 EMACS_TIME nexttime
;
4266 EMACS_TIME now
, idleness_now
;
4267 Lisp_Object timers
, idle_timers
, chosen_timer
;
4268 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4270 EMACS_SET_SECS (nexttime
, -1);
4271 EMACS_SET_USECS (nexttime
, -1);
4273 /* Always consider the ordinary timers. */
4274 timers
= Vtimer_list
;
4275 /* Consider the idle timers only if Emacs is idle. */
4276 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4277 idle_timers
= Vtimer_idle_list
;
4280 chosen_timer
= Qnil
;
4281 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4283 if (CONSP (timers
) || CONSP (idle_timers
))
4285 EMACS_GET_TIME (now
);
4286 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4287 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4290 while (CONSP (timers
) || CONSP (idle_timers
))
4292 Lisp_Object
*vector
;
4293 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4294 EMACS_TIME timer_time
, idle_timer_time
;
4295 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4297 /* Skip past invalid timers and timers already handled. */
4300 timer
= XCAR (timers
);
4301 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4303 timers
= XCDR (timers
);
4306 vector
= XVECTOR (timer
)->contents
;
4308 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4309 || !INTEGERP (vector
[3])
4310 || ! NILP (vector
[0]))
4312 timers
= XCDR (timers
);
4316 if (!NILP (idle_timers
))
4318 timer
= XCAR (idle_timers
);
4319 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4321 idle_timers
= XCDR (idle_timers
);
4324 vector
= XVECTOR (timer
)->contents
;
4326 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4327 || !INTEGERP (vector
[3])
4328 || ! NILP (vector
[0]))
4330 idle_timers
= XCDR (idle_timers
);
4335 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4336 based on the next ordinary timer.
4337 TIMER_DIFFERENCE is the distance in time from NOW to when
4338 this timer becomes ripe (negative if it's already ripe). */
4341 timer
= XCAR (timers
);
4342 vector
= XVECTOR (timer
)->contents
;
4343 EMACS_SET_SECS (timer_time
,
4344 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4345 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4346 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4349 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4350 based on the next idle timer. */
4351 if (!NILP (idle_timers
))
4353 idle_timer
= XCAR (idle_timers
);
4354 vector
= XVECTOR (idle_timer
)->contents
;
4355 EMACS_SET_SECS (idle_timer_time
,
4356 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4357 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4358 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4361 /* Decide which timer is the next timer,
4362 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4363 Also step down the list where we found that timer. */
4365 if (! NILP (timers
) && ! NILP (idle_timers
))
4368 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4369 if (EMACS_TIME_NEG_P (temp
))
4371 chosen_timer
= timer
;
4372 timers
= XCDR (timers
);
4373 difference
= timer_difference
;
4377 chosen_timer
= idle_timer
;
4378 idle_timers
= XCDR (idle_timers
);
4379 difference
= idle_timer_difference
;
4382 else if (! NILP (timers
))
4384 chosen_timer
= timer
;
4385 timers
= XCDR (timers
);
4386 difference
= timer_difference
;
4390 chosen_timer
= idle_timer
;
4391 idle_timers
= XCDR (idle_timers
);
4392 difference
= idle_timer_difference
;
4394 vector
= XVECTOR (chosen_timer
)->contents
;
4396 /* If timer is ripe, run it if it hasn't been run. */
4397 if (EMACS_TIME_NEG_P (difference
)
4398 || (EMACS_SECS (difference
) == 0
4399 && EMACS_USECS (difference
) == 0))
4401 if (NILP (vector
[0]))
4403 int was_locked
= single_kboard
;
4404 int count
= SPECPDL_INDEX ();
4405 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4407 /* Mark the timer as triggered to prevent problems if the lisp
4408 code fails to reschedule it right. */
4411 specbind (Qinhibit_quit
, Qt
);
4413 call1 (Qtimer_event_handler
, chosen_timer
);
4414 Vdeactivate_mark
= old_deactivate_mark
;
4416 unbind_to (count
, Qnil
);
4418 /* Resume allowing input from any kboard, if that was true before. */
4420 any_kboard_state ();
4422 /* Since we have handled the event,
4423 we don't need to tell the caller to wake up and do it. */
4427 /* When we encounter a timer that is still waiting,
4428 return the amount of time to wait before it is ripe. */
4435 /* No timers are pending in the future. */
4436 /* Return 0 if we generated an event, and -1 if not. */
4441 /* Caches for modify_event_symbol. */
4442 static Lisp_Object accent_key_syms
;
4443 static Lisp_Object func_key_syms
;
4444 static Lisp_Object mouse_syms
;
4445 static Lisp_Object wheel_syms
;
4446 static Lisp_Object drag_n_drop_syms
;
4448 /* This is a list of keysym codes for special "accent" characters.
4449 It parallels lispy_accent_keys. */
4451 static int lispy_accent_codes
[] =
4453 #ifdef XK_dead_circumflex
4458 #ifdef XK_dead_grave
4463 #ifdef XK_dead_tilde
4468 #ifdef XK_dead_diaeresis
4473 #ifdef XK_dead_macron
4478 #ifdef XK_dead_degree
4483 #ifdef XK_dead_acute
4488 #ifdef XK_dead_cedilla
4493 #ifdef XK_dead_breve
4498 #ifdef XK_dead_ogonek
4503 #ifdef XK_dead_caron
4508 #ifdef XK_dead_doubleacute
4509 XK_dead_doubleacute
,
4513 #ifdef XK_dead_abovedot
4518 #ifdef XK_dead_abovering
4528 #ifdef XK_dead_belowdot
4533 #ifdef XK_dead_voiced_sound
4534 XK_dead_voiced_sound
,
4538 #ifdef XK_dead_semivoiced_sound
4539 XK_dead_semivoiced_sound
,
4555 /* This is a list of Lisp names for special "accent" characters.
4556 It parallels lispy_accent_codes. */
4558 static char *lispy_accent_keys
[] =
4576 "dead-voiced-sound",
4577 "dead-semivoiced-sound",
4583 #define FUNCTION_KEY_OFFSET 0x0
4585 char *lispy_function_keys
[] =
4589 0, /* VK_LBUTTON 0x01 */
4590 0, /* VK_RBUTTON 0x02 */
4591 "cancel", /* VK_CANCEL 0x03 */
4592 0, /* VK_MBUTTON 0x04 */
4594 0, 0, 0, /* 0x05 .. 0x07 */
4596 "backspace", /* VK_BACK 0x08 */
4597 "tab", /* VK_TAB 0x09 */
4599 0, 0, /* 0x0A .. 0x0B */
4601 "clear", /* VK_CLEAR 0x0C */
4602 "return", /* VK_RETURN 0x0D */
4604 0, 0, /* 0x0E .. 0x0F */
4606 0, /* VK_SHIFT 0x10 */
4607 0, /* VK_CONTROL 0x11 */
4608 0, /* VK_MENU 0x12 */
4609 "pause", /* VK_PAUSE 0x13 */
4610 "capslock", /* VK_CAPITAL 0x14 */
4612 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4614 "escape", /* VK_ESCAPE 0x1B */
4616 0, 0, 0, 0, /* 0x1C .. 0x1F */
4618 0, /* VK_SPACE 0x20 */
4619 "prior", /* VK_PRIOR 0x21 */
4620 "next", /* VK_NEXT 0x22 */
4621 "end", /* VK_END 0x23 */
4622 "home", /* VK_HOME 0x24 */
4623 "left", /* VK_LEFT 0x25 */
4624 "up", /* VK_UP 0x26 */
4625 "right", /* VK_RIGHT 0x27 */
4626 "down", /* VK_DOWN 0x28 */
4627 "select", /* VK_SELECT 0x29 */
4628 "print", /* VK_PRINT 0x2A */
4629 "execute", /* VK_EXECUTE 0x2B */
4630 "snapshot", /* VK_SNAPSHOT 0x2C */
4631 "insert", /* VK_INSERT 0x2D */
4632 "delete", /* VK_DELETE 0x2E */
4633 "help", /* VK_HELP 0x2F */
4635 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4637 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4639 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4641 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4643 0, 0, 0, 0, 0, 0, 0, 0, 0,
4644 0, 0, 0, 0, 0, 0, 0, 0, 0,
4645 0, 0, 0, 0, 0, 0, 0, 0,
4647 "lwindow", /* VK_LWIN 0x5B */
4648 "rwindow", /* VK_RWIN 0x5C */
4649 "apps", /* VK_APPS 0x5D */
4651 0, 0, /* 0x5E .. 0x5F */
4653 "kp-0", /* VK_NUMPAD0 0x60 */
4654 "kp-1", /* VK_NUMPAD1 0x61 */
4655 "kp-2", /* VK_NUMPAD2 0x62 */
4656 "kp-3", /* VK_NUMPAD3 0x63 */
4657 "kp-4", /* VK_NUMPAD4 0x64 */
4658 "kp-5", /* VK_NUMPAD5 0x65 */
4659 "kp-6", /* VK_NUMPAD6 0x66 */
4660 "kp-7", /* VK_NUMPAD7 0x67 */
4661 "kp-8", /* VK_NUMPAD8 0x68 */
4662 "kp-9", /* VK_NUMPAD9 0x69 */
4663 "kp-multiply", /* VK_MULTIPLY 0x6A */
4664 "kp-add", /* VK_ADD 0x6B */
4665 "kp-separator", /* VK_SEPARATOR 0x6C */
4666 "kp-subtract", /* VK_SUBTRACT 0x6D */
4667 "kp-decimal", /* VK_DECIMAL 0x6E */
4668 "kp-divide", /* VK_DIVIDE 0x6F */
4669 "f1", /* VK_F1 0x70 */
4670 "f2", /* VK_F2 0x71 */
4671 "f3", /* VK_F3 0x72 */
4672 "f4", /* VK_F4 0x73 */
4673 "f5", /* VK_F5 0x74 */
4674 "f6", /* VK_F6 0x75 */
4675 "f7", /* VK_F7 0x76 */
4676 "f8", /* VK_F8 0x77 */
4677 "f9", /* VK_F9 0x78 */
4678 "f10", /* VK_F10 0x79 */
4679 "f11", /* VK_F11 0x7A */
4680 "f12", /* VK_F12 0x7B */
4681 "f13", /* VK_F13 0x7C */
4682 "f14", /* VK_F14 0x7D */
4683 "f15", /* VK_F15 0x7E */
4684 "f16", /* VK_F16 0x7F */
4685 "f17", /* VK_F17 0x80 */
4686 "f18", /* VK_F18 0x81 */
4687 "f19", /* VK_F19 0x82 */
4688 "f20", /* VK_F20 0x83 */
4689 "f21", /* VK_F21 0x84 */
4690 "f22", /* VK_F22 0x85 */
4691 "f23", /* VK_F23 0x86 */
4692 "f24", /* VK_F24 0x87 */
4694 0, 0, 0, 0, /* 0x88 .. 0x8B */
4695 0, 0, 0, 0, /* 0x8C .. 0x8F */
4697 "kp-numlock", /* VK_NUMLOCK 0x90 */
4698 "scroll", /* VK_SCROLL 0x91 */
4700 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4701 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4702 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4703 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4704 "kp-end", /* VK_NUMPAD_END 0x96 */
4705 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4706 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4707 "kp-up", /* VK_NUMPAD_UP 0x99 */
4708 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4709 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4710 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4711 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4713 0, 0, /* 0x9E .. 0x9F */
4716 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4717 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4718 * No other API or message will distinguish left and right keys this way.
4722 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4723 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4724 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4725 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4726 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4732 "attn", /* VK_ATTN 0xF6 */
4733 "crsel", /* VK_CRSEL 0xF7 */
4734 "exsel", /* VK_EXSEL 0xF8 */
4735 "ereof", /* VK_EREOF 0xF9 */
4736 "play", /* VK_PLAY 0xFA */
4737 "zoom", /* VK_ZOOM 0xFB */
4738 "noname", /* VK_NONAME 0xFC */
4739 "pa1", /* VK_PA1 0xFD */
4740 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4744 #else /* not HAVE_NTGUI */
4746 /* This should be dealt with in XTread_socket now, and that doesn't
4747 depend on the client system having the Kana syms defined. See also
4748 the XK_kana_A case below. */
4751 static char *lispy_kana_keys
[] =
4753 /* X Keysym value */
4754 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4755 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4756 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4757 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4758 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4759 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4760 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4761 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4762 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4763 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4764 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4765 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4766 "kana-i", "kana-u", "kana-e", "kana-o",
4767 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4768 "prolongedsound", "kana-A", "kana-I", "kana-U",
4769 "kana-E", "kana-O", "kana-KA", "kana-KI",
4770 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4771 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4772 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4773 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4774 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4775 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4776 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4777 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4778 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4779 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4780 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4781 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4783 #endif /* XK_kana_A */
4786 #define FUNCTION_KEY_OFFSET 0xff00
4788 /* You'll notice that this table is arranged to be conveniently
4789 indexed by X Windows keysym values. */
4790 static char *lispy_function_keys
[] =
4792 /* X Keysym value */
4794 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4795 "backspace", "tab", "linefeed", "clear",
4797 0, 0, 0, "pause", /* 0xff10...1f */
4798 0, 0, 0, 0, 0, 0, 0, "escape",
4800 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4801 "romaji", "hiragana", "katakana", "hiragana-katakana",
4802 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4803 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4804 "eisu-toggle", /* 0xff30...3f */
4805 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4806 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4808 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4809 "down", "prior", "next", "end",
4810 "begin", 0, 0, 0, 0, 0, 0, 0,
4811 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4822 "break", /* 0xff6b */
4825 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4826 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4827 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4828 0, 0, 0, 0, 0, 0, 0, 0,
4829 "kp-tab", /* 0xff89 */
4831 "kp-enter", /* 0xff8d */
4833 "kp-f1", /* 0xff91 */
4837 "kp-home", /* 0xff95 */
4842 "kp-prior", /* kp-page-up */
4843 "kp-next", /* kp-page-down */
4849 0, 0, 0, 0, 0, 0, 0, 0, 0,
4850 "kp-multiply", /* 0xffaa */
4855 "kp-divide", /* 0xffaf */
4856 "kp-0", /* 0xffb0 */
4857 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4860 "kp-equal", /* 0xffbd */
4861 "f1", /* 0xffbe */ /* IsFunctionKey */
4863 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4864 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4865 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4866 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4867 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4868 0, 0, 0, 0, 0, 0, 0, 0,
4869 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4870 0, 0, 0, 0, 0, 0, 0, "delete"
4873 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4874 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4876 static char *iso_lispy_function_keys
[] =
4878 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4879 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4880 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4881 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4882 "iso-lefttab", /* 0xfe20 */
4883 "iso-move-line-up", "iso-move-line-down",
4884 "iso-partial-line-up", "iso-partial-line-down",
4885 "iso-partial-space-left", "iso-partial-space-right",
4886 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4887 "iso-release-margin-left", "iso-release-margin-right",
4888 "iso-release-both-margins",
4889 "iso-fast-cursor-left", "iso-fast-cursor-right",
4890 "iso-fast-cursor-up", "iso-fast-cursor-down",
4891 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4892 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4895 #endif /* not HAVE_NTGUI */
4897 Lisp_Object Vlispy_mouse_stem
;
4899 static char *lispy_wheel_names
[] =
4901 "wheel-up", "wheel-down"
4904 /* drag-n-drop events are generated when a set of selected files are
4905 dragged from another application and dropped onto an Emacs window. */
4906 static char *lispy_drag_n_drop_names
[] =
4911 /* Scroll bar parts. */
4912 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4913 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4914 Lisp_Object Qtop
, Qratio
;
4916 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4917 Lisp_Object
*scroll_bar_parts
[] = {
4918 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4919 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4922 /* User signal events. */
4923 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4925 Lisp_Object
*lispy_user_signals
[] =
4927 &Qusr1_signal
, &Qusr2_signal
4931 /* A vector, indexed by button number, giving the down-going location
4932 of currently depressed buttons, both scroll bar and non-scroll bar.
4934 The elements have the form
4935 (BUTTON-NUMBER MODIFIER-MASK . REST)
4936 where REST is the cdr of a position as it would be reported in the event.
4938 The make_lispy_event function stores positions here to tell the
4939 difference between click and drag events, and to store the starting
4940 location to be included in drag events. */
4942 static Lisp_Object button_down_location
;
4944 /* Information about the most recent up-going button event: Which
4945 button, what location, and what time. */
4947 static int last_mouse_button
;
4948 static int last_mouse_x
;
4949 static int last_mouse_y
;
4950 static unsigned long button_down_time
;
4952 /* The maximum time between clicks to make a double-click, or Qnil to
4953 disable double-click detection, or Qt for no time limit. */
4955 Lisp_Object Vdouble_click_time
;
4957 /* Maximum number of pixels the mouse may be moved between clicks
4958 to make a double-click. */
4960 EMACS_INT double_click_fuzz
;
4962 /* The number of clicks in this multiple-click. */
4964 int double_click_count
;
4966 /* Return position of a mouse click or wheel event */
4969 make_lispy_position (f
, x
, y
, time
)
4975 enum window_part part
;
4976 Lisp_Object posn
= Qnil
;
4977 Lisp_Object extra_info
= Qnil
;
4980 /* Set `window' to the window under frame pixel coordinates (x,y) */
4982 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
4983 &part
, &wx
, &wy
, 0);
4987 if (WINDOWP (window
))
4989 /* It's a click in window window at frame coordinates (x,y) */
4990 struct window
*w
= XWINDOW (window
);
4991 Lisp_Object string_info
= Qnil
;
4992 int textpos
= -1, rx
= -1, ry
= -1;
4993 int dx
= -1, dy
= -1;
4994 int width
= -1, height
= -1;
4995 Lisp_Object object
= Qnil
;
4997 /* Set event coordinates to window-relative coordinates
4998 for constructing the Lisp event below. */
5002 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5004 /* Mode line or header line. Look for a string under
5005 the mouse that may have a `local-map' property. */
5009 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5011 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5012 &object
, &dx
, &dy
, &width
, &height
);
5013 if (STRINGP (string
))
5014 string_info
= Fcons (string
, make_number (charpos
));
5015 if (w
== XWINDOW (selected_window
))
5018 textpos
= XMARKER (w
->pointm
)->charpos
;
5020 else if (part
== ON_VERTICAL_BORDER
)
5022 posn
= Qvertical_line
;
5027 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5032 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5034 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5035 &object
, &dx
, &dy
, &width
, &height
);
5036 if (STRINGP (string
))
5037 string_info
= Fcons (string
, make_number (charpos
));
5039 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
5041 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
5044 if (part
== ON_RIGHT_FRINGE
)
5045 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5046 + window_box_width (w
, TEXT_AREA
)
5047 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5048 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5050 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5051 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5056 Lisp_Object string2
, object2
= Qnil
;
5057 struct display_pos p
;
5059 int width2
, height2
;
5060 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5061 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5062 &object2
, &dx2
, &dy2
,
5064 textpos
= CHARPOS (p
.pos
);
5065 if (rx
< 0) rx
= wx
;
5066 if (ry
< 0) ry
= wy
;
5067 if (dx
< 0) dx
= dx2
;
5068 if (dy
< 0) dy
= dy2
;
5069 if (width
< 0) width
= width2
;
5070 if (height
< 0) height
= height2
;
5074 posn
= make_number (textpos
);
5075 if (STRINGP (string2
))
5076 string_info
= Fcons (string2
,
5077 make_number (CHARPOS (p
.string_pos
)));
5083 #ifdef HAVE_WINDOW_SYSTEM
5084 if (IMAGEP (object
))
5086 Lisp_Object image_map
, hotspot
;
5087 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5089 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5091 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5092 posn
= XCAR (hotspot
);
5097 extra_info
= Fcons (object
,
5098 Fcons (Fcons (make_number (dx
),
5100 Fcons (Fcons (make_number (width
),
5101 make_number (height
)),
5105 extra_info
= Fcons (string_info
,
5106 Fcons (make_number (textpos
),
5107 Fcons (Fcons (make_number (rx
),
5113 XSETFRAME (window
, f
);
5118 XSETFASTINT (*x
, 0);
5119 XSETFASTINT (*y
, 0);
5122 return Fcons (window
,
5124 Fcons (Fcons (*x
, *y
),
5125 Fcons (make_number (time
),
5129 /* Given a struct input_event, build the lisp event which represents
5130 it. If EVENT is 0, build a mouse movement event from the mouse
5131 movement buffer, which should have a movement event in it.
5133 Note that events must be passed to this function in the order they
5134 are received; this function stores the location of button presses
5135 in order to build drag events when the button is released. */
5138 make_lispy_event (event
)
5139 struct input_event
*event
;
5143 switch (SWITCH_ENUM_CAST (event
->kind
))
5145 /* A simple keystroke. */
5146 case ASCII_KEYSTROKE_EVENT
:
5148 Lisp_Object lispy_c
;
5149 int c
= event
->code
& 0377;
5150 /* Turn ASCII characters into control characters
5152 if (event
->modifiers
& ctrl_modifier
)
5153 c
= make_ctrl_char (c
);
5155 /* Add in the other modifier bits. We took care of ctrl_modifier
5156 just above, and the shift key was taken care of by the X code,
5157 and applied to control characters by make_ctrl_char. */
5158 c
|= (event
->modifiers
5159 & (meta_modifier
| alt_modifier
5160 | hyper_modifier
| super_modifier
));
5161 /* Distinguish Shift-SPC from SPC. */
5162 if ((event
->code
& 0377) == 040
5163 && event
->modifiers
& shift_modifier
)
5164 c
|= shift_modifier
;
5165 button_down_time
= 0;
5166 XSETFASTINT (lispy_c
, c
);
5170 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5172 Lisp_Object lispy_c
;
5173 int c
= event
->code
;
5175 /* Add in the other modifier bits. We took care of ctrl_modifier
5176 just above, and the shift key was taken care of by the X code,
5177 and applied to control characters by make_ctrl_char. */
5178 c
|= (event
->modifiers
5179 & (meta_modifier
| alt_modifier
5180 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5181 /* What about the `shift' modifier ? */
5182 button_down_time
= 0;
5183 XSETFASTINT (lispy_c
, c
);
5187 /* A function key. The symbol may need to have modifier prefixes
5189 case NON_ASCII_KEYSTROKE_EVENT
:
5190 button_down_time
= 0;
5192 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5193 if (event
->code
== lispy_accent_codes
[i
])
5194 return modify_event_symbol (i
,
5196 Qfunction_key
, Qnil
,
5197 lispy_accent_keys
, &accent_key_syms
,
5198 (sizeof (lispy_accent_keys
)
5199 / sizeof (lispy_accent_keys
[0])));
5203 if (event
->code
>= 0x400 && event
->code
< 0x500)
5204 return modify_event_symbol (event
->code
- 0x400,
5205 event
->modifiers
& ~shift_modifier
,
5206 Qfunction_key
, Qnil
,
5207 lispy_kana_keys
, &func_key_syms
,
5208 (sizeof (lispy_kana_keys
)
5209 / sizeof (lispy_kana_keys
[0])));
5210 #endif /* XK_kana_A */
5213 #ifdef ISO_FUNCTION_KEY_OFFSET
5214 if (event
->code
< FUNCTION_KEY_OFFSET
5215 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5216 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5218 Qfunction_key
, Qnil
,
5219 iso_lispy_function_keys
, &func_key_syms
,
5220 (sizeof (iso_lispy_function_keys
)
5221 / sizeof (iso_lispy_function_keys
[0])));
5224 /* Handle system-specific or unknown keysyms. */
5225 if (event
->code
& (1 << 28)
5226 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5227 || (event
->code
- FUNCTION_KEY_OFFSET
5228 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5229 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5231 /* We need to use an alist rather than a vector as the cache
5232 since we can't make a vector long enuf. */
5233 if (NILP (current_kboard
->system_key_syms
))
5234 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5235 return modify_event_symbol (event
->code
,
5238 current_kboard
->Vsystem_key_alist
,
5239 0, ¤t_kboard
->system_key_syms
,
5243 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5245 Qfunction_key
, Qnil
,
5246 lispy_function_keys
, &func_key_syms
,
5247 (sizeof (lispy_function_keys
)
5248 / sizeof (lispy_function_keys
[0])));
5251 /* A mouse click. Figure out where it is, decide whether it's
5252 a press, click or drag, and build the appropriate structure. */
5253 case MOUSE_CLICK_EVENT
:
5254 #ifndef USE_TOOLKIT_SCROLL_BARS
5255 case SCROLL_BAR_CLICK_EVENT
:
5258 int button
= event
->code
;
5260 Lisp_Object position
;
5261 Lisp_Object
*start_pos_ptr
;
5262 Lisp_Object start_pos
;
5266 /* Build the position as appropriate for this mouse click. */
5267 if (event
->kind
== MOUSE_CLICK_EVENT
)
5269 struct frame
*f
= XFRAME (event
->frame_or_window
);
5270 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5274 /* Ignore mouse events that were made on frame that
5275 have been deleted. */
5276 if (! FRAME_LIVE_P (f
))
5279 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5280 /* EVENT->x and EVENT->y are frame-relative pixel
5281 coordinates at this place. Under old redisplay, COLUMN
5282 and ROW are set to frame relative glyph coordinates
5283 which are then used to determine whether this click is
5284 in a menu (non-toolkit version). */
5285 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5286 &column
, &row
, NULL
, 1);
5288 /* In the non-toolkit version, clicks on the menu bar
5289 are ordinary button events in the event buffer.
5290 Distinguish them, and invoke the menu.
5292 (In the toolkit version, the toolkit handles the menu bar
5293 and Emacs doesn't know about it until after the user
5294 makes a selection.) */
5295 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5296 && (event
->modifiers
& down_modifier
))
5298 Lisp_Object items
, item
;
5303 /* Activate the menu bar on the down event. If the
5304 up event comes in before the menu code can deal with it,
5306 if (! (event
->modifiers
& down_modifier
))
5310 /* Find the menu bar item under `column'. */
5312 items
= FRAME_MENU_BAR_ITEMS (f
);
5313 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5315 Lisp_Object pos
, string
;
5316 string
= AREF (items
, i
+ 1);
5317 pos
= AREF (items
, i
+ 3);
5320 if (column
>= XINT (pos
)
5321 && column
< XINT (pos
) + SCHARS (string
))
5323 item
= AREF (items
, i
);
5328 /* ELisp manual 2.4b says (x y) are window relative but
5329 code says they are frame-relative. */
5331 = Fcons (event
->frame_or_window
,
5333 Fcons (Fcons (event
->x
, event
->y
),
5334 Fcons (make_number (event
->timestamp
),
5337 return Fcons (item
, Fcons (position
, Qnil
));
5339 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5341 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5344 #ifndef USE_TOOLKIT_SCROLL_BARS
5347 /* It's a scrollbar click. */
5349 Lisp_Object portion_whole
;
5352 window
= event
->frame_or_window
;
5353 portion_whole
= Fcons (event
->x
, event
->y
);
5354 part
= *scroll_bar_parts
[(int) event
->part
];
5358 Fcons (Qvertical_scroll_bar
,
5359 Fcons (portion_whole
,
5360 Fcons (make_number (event
->timestamp
),
5361 Fcons (part
, Qnil
)))));
5363 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5365 if (button
>= ASIZE (button_down_location
))
5367 button_down_location
= larger_vector (button_down_location
,
5369 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5372 start_pos_ptr
= &AREF (button_down_location
, button
);
5373 start_pos
= *start_pos_ptr
;
5374 *start_pos_ptr
= Qnil
;
5377 /* On window-system frames, use the value of
5378 double-click-fuzz as is. On other frames, interpret it
5379 as a multiple of 1/8 characters. */
5383 if (WINDOWP (event
->frame_or_window
))
5384 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5385 else if (FRAMEP (event
->frame_or_window
))
5386 f
= XFRAME (event
->frame_or_window
);
5390 if (FRAME_WINDOW_P (f
))
5391 fuzz
= double_click_fuzz
;
5393 fuzz
= double_click_fuzz
/ 8;
5395 is_double
= (button
== last_mouse_button
5396 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5397 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5398 && button_down_time
!= 0
5399 && (EQ (Vdouble_click_time
, Qt
)
5400 || (INTEGERP (Vdouble_click_time
)
5401 && ((int)(event
->timestamp
- button_down_time
)
5402 < XINT (Vdouble_click_time
)))));
5405 last_mouse_button
= button
;
5406 last_mouse_x
= XINT (event
->x
);
5407 last_mouse_y
= XINT (event
->y
);
5409 /* If this is a button press, squirrel away the location, so
5410 we can decide later whether it was a click or a drag. */
5411 if (event
->modifiers
& down_modifier
)
5415 double_click_count
++;
5416 event
->modifiers
|= ((double_click_count
> 2)
5421 double_click_count
= 1;
5422 button_down_time
= event
->timestamp
;
5423 *start_pos_ptr
= Fcopy_alist (position
);
5426 /* Now we're releasing a button - check the co-ordinates to
5427 see if this was a click or a drag. */
5428 else if (event
->modifiers
& up_modifier
)
5430 /* If we did not see a down before this up, ignore the up.
5431 Probably this happened because the down event chose a
5432 menu item. It would be an annoyance to treat the
5433 release of the button that chose the menu item as a
5436 if (!CONSP (start_pos
))
5439 event
->modifiers
&= ~up_modifier
;
5440 #if 0 /* Formerly we treated an up with no down as a click event. */
5441 if (!CONSP (start_pos
))
5442 event
->modifiers
|= click_modifier
;
5447 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5449 /* The third element of every position
5450 should be the (x,y) pair. */
5451 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5453 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5455 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5456 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5459 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5460 && ydiff
< double_click_fuzz
5461 && ydiff
> - double_click_fuzz
)
5462 /* Mouse hasn't moved (much). */
5463 event
->modifiers
|= click_modifier
;
5466 button_down_time
= 0;
5467 event
->modifiers
|= drag_modifier
;
5470 /* Don't check is_double; treat this as multiple
5471 if the down-event was multiple. */
5472 if (double_click_count
> 1)
5473 event
->modifiers
|= ((double_click_count
> 2)
5479 /* Every mouse event should either have the down_modifier or
5480 the up_modifier set. */
5484 /* Get the symbol we should use for the mouse click. */
5487 head
= modify_event_symbol (button
,
5489 Qmouse_click
, Vlispy_mouse_stem
,
5492 XVECTOR (mouse_syms
)->size
);
5493 if (event
->modifiers
& drag_modifier
)
5498 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5501 Fcons (make_number (double_click_count
),
5512 Lisp_Object position
;
5515 /* Build the position as appropriate for this mouse click. */
5516 struct frame
*f
= XFRAME (event
->frame_or_window
);
5518 /* Ignore wheel events that were made on frame that have been
5520 if (! FRAME_LIVE_P (f
))
5523 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5526 /* Set double or triple modifiers to indicate the wheel speed. */
5528 /* On window-system frames, use the value of
5529 double-click-fuzz as is. On other frames, interpret it
5530 as a multiple of 1/8 characters. */
5535 if (WINDOWP (event
->frame_or_window
))
5536 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5537 else if (FRAMEP (event
->frame_or_window
))
5538 f
= XFRAME (event
->frame_or_window
);
5542 if (FRAME_WINDOW_P (f
))
5543 fuzz
= double_click_fuzz
;
5545 fuzz
= double_click_fuzz
/ 8;
5547 is_double
= (last_mouse_button
< 0
5548 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5549 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5550 && button_down_time
!= 0
5551 && (EQ (Vdouble_click_time
, Qt
)
5552 || (INTEGERP (Vdouble_click_time
)
5553 && ((int)(event
->timestamp
- button_down_time
)
5554 < XINT (Vdouble_click_time
)))));
5557 double_click_count
++;
5558 event
->modifiers
|= ((double_click_count
> 2)
5564 double_click_count
= 1;
5565 event
->modifiers
|= click_modifier
;
5568 button_down_time
= event
->timestamp
;
5569 /* Use a negative value to distinguish wheel from mouse button. */
5570 last_mouse_button
= -1;
5571 last_mouse_x
= XINT (event
->x
);
5572 last_mouse_y
= XINT (event
->y
);
5578 if (event
->modifiers
& up_modifier
)
5580 /* Emit a wheel-up event. */
5581 event
->modifiers
&= ~up_modifier
;
5584 else if (event
->modifiers
& down_modifier
)
5586 /* Emit a wheel-down event. */
5587 event
->modifiers
&= ~down_modifier
;
5591 /* Every wheel event should either have the down_modifier or
5592 the up_modifier set. */
5595 /* Get the symbol we should use for the wheel event. */
5596 head
= modify_event_symbol (symbol_num
,
5602 ASIZE (wheel_syms
));
5605 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5608 Fcons (make_number (double_click_count
),
5617 #ifdef USE_TOOLKIT_SCROLL_BARS
5619 /* We don't have down and up events if using toolkit scroll bars,
5620 so make this always a click event. Store in the `part' of
5621 the Lisp event a symbol which maps to the following actions:
5623 `above_handle' page up
5624 `below_handle' page down
5628 `bottom' bottom of buffer
5629 `handle' thumb has been dragged.
5630 `end-scroll' end of interaction with scroll bar
5632 The incoming input_event contains in its `part' member an
5633 index of type `enum scroll_bar_part' which we can use as an
5634 index in scroll_bar_parts to get the appropriate symbol. */
5636 case SCROLL_BAR_CLICK_EVENT
:
5638 Lisp_Object position
, head
, window
, portion_whole
, part
;
5640 window
= event
->frame_or_window
;
5641 portion_whole
= Fcons (event
->x
, event
->y
);
5642 part
= *scroll_bar_parts
[(int) event
->part
];
5646 Fcons (Qvertical_scroll_bar
,
5647 Fcons (portion_whole
,
5648 Fcons (make_number (event
->timestamp
),
5649 Fcons (part
, Qnil
)))));
5651 /* Always treat scroll bar events as clicks. */
5652 event
->modifiers
|= click_modifier
;
5653 event
->modifiers
&= ~up_modifier
;
5655 if (event
->code
>= ASIZE (mouse_syms
))
5656 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5658 /* Get the symbol we should use for the mouse click. */
5659 head
= modify_event_symbol (event
->code
,
5664 XVECTOR (mouse_syms
)->size
);
5665 return Fcons (head
, Fcons (position
, Qnil
));
5668 #endif /* USE_TOOLKIT_SCROLL_BARS */
5671 case W32_SCROLL_BAR_CLICK_EVENT
:
5673 int button
= event
->code
;
5675 Lisp_Object position
;
5676 Lisp_Object
*start_pos_ptr
;
5677 Lisp_Object start_pos
;
5681 Lisp_Object portion_whole
;
5684 window
= event
->frame_or_window
;
5685 portion_whole
= Fcons (event
->x
, event
->y
);
5686 part
= *scroll_bar_parts
[(int) event
->part
];
5690 Fcons (Qvertical_scroll_bar
,
5691 Fcons (portion_whole
,
5692 Fcons (make_number (event
->timestamp
),
5693 Fcons (part
, Qnil
)))));
5696 /* Always treat W32 scroll bar events as clicks. */
5697 event
->modifiers
|= click_modifier
;
5700 /* Get the symbol we should use for the mouse click. */
5703 head
= modify_event_symbol (button
,
5708 XVECTOR (mouse_syms
)->size
);
5714 #endif /* WINDOWSNT */
5716 case DRAG_N_DROP_EVENT
:
5719 Lisp_Object head
, position
;
5722 /* The frame_or_window field should be a cons of the frame in
5723 which the event occurred and a list of the filenames
5725 if (! CONSP (event
->frame_or_window
))
5728 f
= XFRAME (XCAR (event
->frame_or_window
));
5729 files
= XCDR (event
->frame_or_window
);
5731 /* Ignore mouse events that were made on frames that
5732 have been deleted. */
5733 if (! FRAME_LIVE_P (f
))
5736 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5739 head
= modify_event_symbol (0, event
->modifiers
,
5741 lispy_drag_n_drop_names
,
5742 &drag_n_drop_syms
, 1);
5748 #endif /* HAVE_MOUSE */
5750 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5751 || defined (USE_GTK)
5752 case MENU_BAR_EVENT
:
5753 if (EQ (event
->arg
, event
->frame_or_window
))
5754 /* This is the prefix key. We translate this to
5755 `(menu_bar)' because the code in keyboard.c for menu
5756 events, which we use, relies on this. */
5757 return Fcons (Qmenu_bar
, Qnil
);
5761 case SELECT_WINDOW_EVENT
:
5762 /* Make an event (select-window (WINDOW)). */
5763 return Fcons (Qselect_window
,
5764 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5767 case TOOL_BAR_EVENT
:
5768 if (EQ (event
->arg
, event
->frame_or_window
))
5769 /* This is the prefix key. We translate this to
5770 `(tool_bar)' because the code in keyboard.c for tool bar
5771 events, which we use, relies on this. */
5772 return Fcons (Qtool_bar
, Qnil
);
5773 else if (SYMBOLP (event
->arg
))
5774 return apply_modifiers (event
->modifiers
, event
->arg
);
5777 case USER_SIGNAL_EVENT
:
5778 /* A user signal. */
5779 return *lispy_user_signals
[event
->code
];
5781 case SAVE_SESSION_EVENT
:
5782 return Qsave_session
;
5784 /* The 'kind' field of the event is something we don't recognize. */
5793 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5795 Lisp_Object bar_window
;
5796 enum scroll_bar_part part
;
5800 /* Is it a scroll bar movement? */
5801 if (frame
&& ! NILP (bar_window
))
5803 Lisp_Object part_sym
;
5805 part_sym
= *scroll_bar_parts
[(int) part
];
5806 return Fcons (Qscroll_bar_movement
,
5807 (Fcons (Fcons (bar_window
,
5808 Fcons (Qvertical_scroll_bar
,
5809 Fcons (Fcons (x
, y
),
5810 Fcons (make_number (time
),
5816 /* Or is it an ordinary mouse movement? */
5819 Lisp_Object position
;
5821 position
= make_lispy_position (frame
, &x
, &y
, time
);
5823 return Fcons (Qmouse_movement
,
5829 #endif /* HAVE_MOUSE */
5831 /* Construct a switch frame event. */
5833 make_lispy_switch_frame (frame
)
5836 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5839 /* Manipulating modifiers. */
5841 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5843 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5844 SYMBOL's name of the end of the modifiers; the string from this
5845 position is the unmodified symbol name.
5847 This doesn't use any caches. */
5850 parse_modifiers_uncached (symbol
, modifier_end
)
5858 CHECK_SYMBOL (symbol
);
5861 name
= SYMBOL_NAME (symbol
);
5863 for (i
= 0; i
+2 <= SBYTES (name
); )
5865 int this_mod_end
= 0;
5868 /* See if the name continues with a modifier word.
5869 Check that the word appears, but don't check what follows it.
5870 Set this_mod and this_mod_end to record what we find. */
5872 switch (SREF (name
, i
))
5874 #define SINGLE_LETTER_MOD(BIT) \
5875 (this_mod_end = i + 1, this_mod = BIT)
5878 SINGLE_LETTER_MOD (alt_modifier
);
5882 SINGLE_LETTER_MOD (ctrl_modifier
);
5886 SINGLE_LETTER_MOD (hyper_modifier
);
5890 SINGLE_LETTER_MOD (meta_modifier
);
5894 SINGLE_LETTER_MOD (shift_modifier
);
5898 SINGLE_LETTER_MOD (super_modifier
);
5901 #undef SINGLE_LETTER_MOD
5903 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5904 if (i + LEN + 1 <= SBYTES (name) \
5905 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5907 this_mod_end = i + LEN; \
5912 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5913 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5914 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5918 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5920 #undef MULTI_LETTER_MOD
5924 /* If we found no modifier, stop looking for them. */
5925 if (this_mod_end
== 0)
5928 /* Check there is a dash after the modifier, so that it
5929 really is a modifier. */
5930 if (this_mod_end
>= SBYTES (name
)
5931 || SREF (name
, this_mod_end
) != '-')
5934 /* This modifier is real; look for another. */
5935 modifiers
|= this_mod
;
5936 i
= this_mod_end
+ 1;
5939 /* Should we include the `click' modifier? */
5940 if (! (modifiers
& (down_modifier
| drag_modifier
5941 | double_modifier
| triple_modifier
))
5942 && i
+ 7 == SBYTES (name
)
5943 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5944 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5945 modifiers
|= click_modifier
;
5953 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5954 prepended to the string BASE[0..BASE_LEN-1].
5955 This doesn't use any caches. */
5957 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5960 int base_len
, base_len_byte
;
5962 /* Since BASE could contain nulls, we can't use intern here; we have
5963 to use Fintern, which expects a genuine Lisp_String, and keeps a
5966 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5972 /* Only the event queue may use the `up' modifier; it should always
5973 be turned into a click or drag event before presented to lisp code. */
5974 if (modifiers
& up_modifier
)
5977 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5978 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5979 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5980 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5981 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5982 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5983 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5984 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5985 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5986 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5987 /* The click modifier is denoted by the absence of other modifiers. */
5991 mod_len
= p
- new_mods
;
5995 Lisp_Object new_name
;
5997 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5998 mod_len
+ base_len_byte
);
5999 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6000 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6002 return Fintern (new_name
, Qnil
);
6007 static char *modifier_names
[] =
6009 "up", "down", "drag", "click", "double", "triple", 0, 0,
6010 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6011 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6013 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6015 static Lisp_Object modifier_symbols
;
6017 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6019 lispy_modifier_list (modifiers
)
6022 Lisp_Object modifier_list
;
6025 modifier_list
= Qnil
;
6026 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6027 if (modifiers
& (1<<i
))
6028 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6031 return modifier_list
;
6035 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6036 where UNMODIFIED is the unmodified form of SYMBOL,
6037 MASK is the set of modifiers present in SYMBOL's name.
6038 This is similar to parse_modifiers_uncached, but uses the cache in
6039 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6040 Qevent_symbol_elements property. */
6043 parse_modifiers (symbol
)
6046 Lisp_Object elements
;
6048 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6049 if (CONSP (elements
))
6054 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6055 Lisp_Object unmodified
;
6058 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6059 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6062 if (modifiers
& ~INTMASK
)
6064 XSETFASTINT (mask
, modifiers
);
6065 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6067 /* Cache the parsing results on SYMBOL. */
6068 Fput (symbol
, Qevent_symbol_element_mask
,
6070 Fput (symbol
, Qevent_symbol_elements
,
6071 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6073 /* Since we know that SYMBOL is modifiers applied to unmodified,
6074 it would be nice to put that in unmodified's cache.
6075 But we can't, since we're not sure that parse_modifiers is
6082 /* Apply the modifiers MODIFIERS to the symbol BASE.
6083 BASE must be unmodified.
6085 This is like apply_modifiers_uncached, but uses BASE's
6086 Qmodifier_cache property, if present. It also builds
6087 Qevent_symbol_elements properties, since it has that info anyway.
6089 apply_modifiers copies the value of BASE's Qevent_kind property to
6090 the modified symbol. */
6092 apply_modifiers (modifiers
, base
)
6096 Lisp_Object cache
, index
, entry
, new_symbol
;
6098 /* Mask out upper bits. We don't know where this value's been. */
6099 modifiers
&= INTMASK
;
6101 /* The click modifier never figures into cache indices. */
6102 cache
= Fget (base
, Qmodifier_cache
);
6103 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6104 entry
= assq_no_quit (index
, cache
);
6107 new_symbol
= XCDR (entry
);
6110 /* We have to create the symbol ourselves. */
6111 new_symbol
= apply_modifiers_uncached (modifiers
,
6112 SDATA (SYMBOL_NAME (base
)),
6113 SCHARS (SYMBOL_NAME (base
)),
6114 SBYTES (SYMBOL_NAME (base
)));
6116 /* Add the new symbol to the base's cache. */
6117 entry
= Fcons (index
, new_symbol
);
6118 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6120 /* We have the parsing info now for free, so we could add it to
6122 XSETFASTINT (index, modifiers);
6123 Fput (new_symbol, Qevent_symbol_element_mask,
6124 Fcons (base, Fcons (index, Qnil)));
6125 Fput (new_symbol, Qevent_symbol_elements,
6126 Fcons (base, lispy_modifier_list (modifiers)));
6127 Sadly, this is only correct if `base' is indeed a base event,
6128 which is not necessarily the case. -stef */
6131 /* Make sure this symbol is of the same kind as BASE.
6133 You'd think we could just set this once and for all when we
6134 intern the symbol above, but reorder_modifiers may call us when
6135 BASE's property isn't set right; we can't assume that just
6136 because it has a Qmodifier_cache property it must have its
6137 Qevent_kind set right as well. */
6138 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6142 kind
= Fget (base
, Qevent_kind
);
6144 Fput (new_symbol
, Qevent_kind
, kind
);
6151 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6152 return a symbol with the modifiers placed in the canonical order.
6153 Canonical order is alphabetical, except for down and drag, which
6154 always come last. The 'click' modifier is never written out.
6156 Fdefine_key calls this to make sure that (for example) C-M-foo
6157 and M-C-foo end up being equivalent in the keymap. */
6160 reorder_modifiers (symbol
)
6163 /* It's hopefully okay to write the code this way, since everything
6164 will soon be in caches, and no consing will be done at all. */
6167 parsed
= parse_modifiers (symbol
);
6168 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6173 /* For handling events, we often want to produce a symbol whose name
6174 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6175 to some base, like the name of a function key or mouse button.
6176 modify_event_symbol produces symbols of this sort.
6178 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6179 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6182 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6183 into symbol names, or a string specifying a name stem used to
6184 construct a symbol name or the form `STEM-N', where N is the decimal
6185 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6186 non-nil; otherwise NAME_TABLE is used.
6188 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6189 persist between calls to modify_event_symbol that it can use to
6190 store a cache of the symbols it's generated for this NAME_TABLE
6191 before. The object stored there may be a vector or an alist.
6193 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6195 MODIFIERS is a set of modifier bits (as given in struct input_events)
6196 whose prefixes should be applied to the symbol name.
6198 SYMBOL_KIND is the value to be placed in the event_kind property of
6199 the returned symbol.
6201 The symbols we create are supposed to have an
6202 `event-symbol-elements' property, which lists the modifiers present
6203 in the symbol's name. */
6206 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6207 name_table
, symbol_table
, table_size
)
6210 Lisp_Object symbol_kind
;
6211 Lisp_Object name_alist_or_stem
;
6213 Lisp_Object
*symbol_table
;
6214 unsigned int table_size
;
6217 Lisp_Object symbol_int
;
6219 /* Get rid of the "vendor-specific" bit here. */
6220 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6222 /* Is this a request for a valid symbol? */
6223 if (symbol_num
< 0 || symbol_num
>= table_size
)
6226 if (CONSP (*symbol_table
))
6227 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6229 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6230 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6231 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6232 we've never used that symbol before. */
6235 if (! VECTORP (*symbol_table
)
6236 || XVECTOR (*symbol_table
)->size
!= table_size
)
6240 XSETFASTINT (size
, table_size
);
6241 *symbol_table
= Fmake_vector (size
, Qnil
);
6244 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6247 /* Have we already used this symbol before? */
6250 /* No; let's create it. */
6251 if (CONSP (name_alist_or_stem
))
6252 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6253 else if (STRINGP (name_alist_or_stem
))
6255 int len
= SBYTES (name_alist_or_stem
);
6256 char *buf
= (char *) alloca (len
+ 50);
6257 if (sizeof (int) == sizeof (EMACS_INT
))
6258 sprintf (buf
, "%s-%d", SDATA (name_alist_or_stem
),
6259 XINT (symbol_int
) + 1);
6260 else if (sizeof (long) == sizeof (EMACS_INT
))
6261 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6262 XINT (symbol_int
) + 1);
6263 value
= intern (buf
);
6265 else if (name_table
!= 0 && name_table
[symbol_num
])
6266 value
= intern (name_table
[symbol_num
]);
6268 #ifdef HAVE_WINDOW_SYSTEM
6271 char *name
= x_get_keysym_name (symbol_num
);
6273 value
= intern (name
);
6280 sprintf (buf
, "key-%d", symbol_num
);
6281 value
= intern (buf
);
6284 if (CONSP (*symbol_table
))
6285 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6287 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6289 /* Fill in the cache entries for this symbol; this also
6290 builds the Qevent_symbol_elements property, which the user
6292 apply_modifiers (modifiers
& click_modifier
, value
);
6293 Fput (value
, Qevent_kind
, symbol_kind
);
6296 /* Apply modifiers to that symbol. */
6297 return apply_modifiers (modifiers
, value
);
6300 /* Convert a list that represents an event type,
6301 such as (ctrl meta backspace), into the usual representation of that
6302 event type as a number or a symbol. */
6304 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6305 doc
: /* Convert the event description list EVENT-DESC to an event type.
6306 EVENT-DESC should contain one base event type (a character or symbol)
6307 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6308 drag, down, double or triple). The base must be last.
6309 The return value is an event type (a character or symbol) which
6310 has the same base event type and all the specified modifiers. */)
6312 Lisp_Object event_desc
;
6320 while (CONSP (rest
))
6328 /* Given a symbol, see if it is a modifier name. */
6329 if (SYMBOLP (elt
) && CONSP (rest
))
6330 this = parse_solitary_modifier (elt
);
6334 else if (!NILP (base
))
6335 error ("Two bases given in one event");
6341 /* Let the symbol A refer to the character A. */
6342 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6343 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6345 if (INTEGERP (base
))
6347 /* Turn (shift a) into A. */
6348 if ((modifiers
& shift_modifier
) != 0
6349 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6351 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6352 modifiers
&= ~shift_modifier
;
6355 /* Turn (control a) into C-a. */
6356 if (modifiers
& ctrl_modifier
)
6357 return make_number ((modifiers
& ~ctrl_modifier
)
6358 | make_ctrl_char (XINT (base
)));
6360 return make_number (modifiers
| XINT (base
));
6362 else if (SYMBOLP (base
))
6363 return apply_modifiers (modifiers
, base
);
6366 error ("Invalid base event");
6371 /* Try to recognize SYMBOL as a modifier name.
6372 Return the modifier flag bit, or 0 if not recognized. */
6375 parse_solitary_modifier (symbol
)
6378 Lisp_Object name
= SYMBOL_NAME (symbol
);
6380 switch (SREF (name
, 0))
6382 #define SINGLE_LETTER_MOD(BIT) \
6383 if (SBYTES (name) == 1) \
6386 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6387 if (LEN == SBYTES (name) \
6388 && ! strncmp (SDATA (name), NAME, LEN)) \
6392 SINGLE_LETTER_MOD (alt_modifier
);
6396 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6400 SINGLE_LETTER_MOD (ctrl_modifier
);
6404 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6405 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6409 SINGLE_LETTER_MOD (hyper_modifier
);
6413 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6417 SINGLE_LETTER_MOD (meta_modifier
);
6421 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6425 SINGLE_LETTER_MOD (shift_modifier
);
6429 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6430 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6431 SINGLE_LETTER_MOD (super_modifier
);
6435 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6436 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6437 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6441 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6444 #undef SINGLE_LETTER_MOD
6445 #undef MULTI_LETTER_MOD
6451 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6452 Such a list is not valid as an event,
6453 but it can be a Lucid-style event type list. */
6456 lucid_event_type_list_p (object
)
6461 if (! CONSP (object
))
6464 if (EQ (XCAR (object
), Qhelp_echo
)
6465 || EQ (XCAR (object
), Qvertical_line
)
6466 || EQ (XCAR (object
), Qmode_line
)
6467 || EQ (XCAR (object
), Qheader_line
))
6470 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6474 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6481 /* Store into *addr a value nonzero if terminal input chars are available.
6482 Serves the purpose of ioctl (0, FIONREAD, addr)
6483 but works even if FIONREAD does not exist.
6484 (In fact, this may actually read some input.)
6486 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6487 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6490 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6495 /* First of all, have we already counted some input? */
6496 *addr
= (!NILP (Vquit_flag
)
6497 || readable_filtered_events (do_timers_now
, filter_events
));
6499 /* If input is being read as it arrives, and we have none, there is none. */
6500 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6503 /* Try to read some input and see how much we get. */
6505 *addr
= (!NILP (Vquit_flag
)
6506 || readable_filtered_events (do_timers_now
, filter_events
));
6509 /* Store into *addr a value nonzero if terminal input chars are available.
6510 Serves the purpose of ioctl (0, FIONREAD, addr)
6511 but works even if FIONREAD does not exist.
6512 (In fact, this may actually read some input.)
6514 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6517 get_input_pending (addr
, do_timers_now
)
6521 get_filtered_input_pending (addr
, do_timers_now
, 0);
6524 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6527 gobble_input (expected
)
6532 if (interrupt_input
)
6535 mask
= sigblock (sigmask (SIGIO
));
6536 read_avail_input (expected
);
6540 #ifdef POLL_FOR_INPUT
6541 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6544 mask
= sigblock (sigmask (SIGALRM
));
6545 read_avail_input (expected
);
6551 read_avail_input (expected
);
6555 /* Put a BUFFER_SWITCH_EVENT in the buffer
6556 so that read_key_sequence will notice the new current buffer. */
6559 record_asynch_buffer_change ()
6561 struct input_event event
;
6565 event
.kind
= BUFFER_SWITCH_EVENT
;
6566 event
.frame_or_window
= Qnil
;
6570 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6571 The purpose of the event is to make read_key_sequence look up the
6572 keymaps again. If we aren't in read_key_sequence, we don't need one,
6573 and the event could cause trouble by messing up (input-pending-p). */
6574 tem
= Fwaiting_for_user_input_p ();
6578 /* We never need these events if we have no asynchronous subprocesses. */
6582 /* Make sure no interrupt happens while storing the event. */
6584 if (interrupt_input
)
6587 mask
= sigblock (sigmask (SIGIO
));
6588 kbd_buffer_store_event (&event
);
6595 kbd_buffer_store_event (&event
);
6602 /* Read any terminal input already buffered up by the system
6603 into the kbd_buffer, but do not wait.
6605 EXPECTED should be nonzero if the caller knows there is some input.
6607 Except on VMS, all input is read by this function.
6608 If interrupt_input is nonzero, this function MUST be called
6609 only when SIGIO is blocked.
6611 Returns the number of keyboard chars read, or -1 meaning
6612 this is a bad time to try to read input. */
6615 read_avail_input (expected
)
6621 if (read_socket_hook
)
6625 struct input_event hold_quit
;
6627 EVENT_INIT (hold_quit
);
6628 hold_quit
.kind
= NO_EVENT
;
6630 /* No need for FIONREAD or fcntl; just say don't wait. */
6631 while (nr
= (*read_socket_hook
) (input_fd
, expected
, &hold_quit
), nr
> 0)
6636 if (hold_quit
.kind
!= NO_EVENT
)
6637 kbd_buffer_store_event (&hold_quit
);
6641 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6642 the kbd_buffer can really hold. That may prevent loss
6643 of characters on some systems when input is stuffed at us. */
6644 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6647 /* Determine how many characters we should *try* to read. */
6650 #else /* not WINDOWSNT */
6652 n_to_read
= dos_keysns ();
6655 #else /* not MSDOS */
6657 /* Find out how much input is available. */
6658 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6659 /* Formerly simply reported no input, but that sometimes led to
6660 a failure of Emacs to terminate.
6661 SIGHUP seems appropriate if we can't reach the terminal. */
6662 /* ??? Is it really right to send the signal just to this process
6663 rather than to the whole process group?
6664 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6666 if (! noninteractive
)
6667 kill (getpid (), SIGHUP
);
6673 if (n_to_read
> sizeof cbuf
)
6674 n_to_read
= sizeof cbuf
;
6675 #else /* no FIONREAD */
6676 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6677 /* Read some input if available, but don't wait. */
6678 n_to_read
= sizeof cbuf
;
6679 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6684 #endif /* not MSDOS */
6685 #endif /* not WINDOWSNT */
6687 /* Now read; for one reason or another, this will not block.
6688 NREAD is set to the number of chars read. */
6692 cbuf
[0] = dos_keyread ();
6695 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6697 /* POSIX infers that processes which are not in the session leader's
6698 process group won't get SIGHUP's at logout time. BSDI adheres to
6699 this part standard and returns -1 from read (0) with errno==EIO
6700 when the control tty is taken away.
6701 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6702 if (nread
== -1 && errno
== EIO
)
6704 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6705 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6706 This looks incorrect, but it isn't, because _BSD causes
6707 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6708 and that causes a value other than 0 when there is no input. */
6714 /* We used to retry the read if it was interrupted.
6715 But this does the wrong thing when O_NDELAY causes
6716 an EAGAIN error. Does anybody know of a situation
6717 where a retry is actually needed? */
6719 nread
< 0 && (errno
== EAGAIN
6733 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6734 fcntl (input_fd
, F_SETFL
, 0);
6735 #endif /* USG or DGUX or CYGWIN */
6736 #endif /* no FIONREAD */
6737 for (i
= 0; i
< nread
; i
++)
6739 struct input_event buf
;
6741 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6743 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6744 buf
.modifiers
= meta_modifier
;
6749 buf
.frame_or_window
= selected_frame
;
6752 kbd_buffer_store_event (&buf
);
6753 /* Don't look at input that follows a C-g too closely.
6754 This reduces lossage due to autorepeat on C-g. */
6755 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6756 && buf
.code
== quit_char
)
6763 #endif /* not VMS */
6766 handle_async_input ()
6769 extern int select_alarmed
;
6771 interrupt_input_pending
= 0;
6776 nread
= read_avail_input (1);
6777 /* -1 means it's not ok to read the input now.
6778 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6779 0 means there was no keyboard input available. */
6784 select_alarmed
= 1; /* Force the select emulator back to life */
6789 #ifdef SIGIO /* for entire page */
6790 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6793 input_available_signal (signo
)
6796 /* Must preserve main program's value of errno. */
6797 int old_errno
= errno
;
6799 #if defined (USG) && !defined (POSIX_SIGNALS)
6800 /* USG systems forget handlers when they are used;
6801 must reestablish each time */
6802 signal (signo
, input_available_signal
);
6809 if (input_available_clear_time
)
6810 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6813 interrupt_input_pending
= 1;
6815 handle_async_input ();
6825 /* Send ourselves a SIGIO.
6827 This function exists so that the UNBLOCK_INPUT macro in
6828 blockinput.h can have some way to take care of input we put off
6829 dealing with, without assuming that every file which uses
6830 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6832 reinvoke_input_signal ()
6835 handle_async_input ();
6841 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6842 static Lisp_Object menu_bar_one_keymap_changed_items
;
6844 /* These variables hold the vector under construction within
6845 menu_bar_items and its subroutines, and the current index
6846 for storing into that vector. */
6847 static Lisp_Object menu_bar_items_vector
;
6848 static int menu_bar_items_index
;
6850 /* Return a vector of menu items for a menu bar, appropriate
6851 to the current buffer. Each item has three elements in the vector:
6854 OLD is an old vector we can optionally reuse, or nil. */
6857 menu_bar_items (old
)
6860 /* The number of keymaps we're scanning right now, and the number of
6861 keymaps we have allocated space for. */
6864 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6865 in the current keymaps, or nil where it is not a prefix. */
6868 Lisp_Object def
, tail
;
6877 struct gcpro gcpro1
;
6879 /* In order to build the menus, we need to call the keymap
6880 accessors. They all call QUIT. But this function is called
6881 during redisplay, during which a quit is fatal. So inhibit
6882 quitting while building the menus.
6883 We do this instead of specbind because (1) errors will clear it anyway
6884 and (2) this avoids risk of specpdl overflow. */
6885 oquit
= Vinhibit_quit
;
6889 menu_bar_items_vector
= old
;
6891 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6892 menu_bar_items_index
= 0;
6894 GCPRO1 (menu_bar_items_vector
);
6896 /* Build our list of keymaps.
6897 If we recognize a function key and replace its escape sequence in
6898 keybuf with its symbol, or if the sequence starts with a mouse
6899 click and we need to switch buffers, we jump back here to rebuild
6900 the initial keymaps from the current buffer. */
6904 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6905 if (!NILP (Voverriding_local_map_menu_flag
))
6907 /* Yes, use them (if non-nil) as well as the global map. */
6908 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6910 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6911 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6912 if (!NILP (Voverriding_local_map
))
6913 maps
[nmaps
++] = Voverriding_local_map
;
6917 /* No, so use major and minor mode keymaps and keymap property.
6918 Note that menu-bar bindings in the local-map and keymap
6919 properties may not work reliable, as they are only
6920 recognized when the menu-bar (or mode-line) is updated,
6921 which does not normally happen after every command. */
6924 nminor
= current_minor_maps (NULL
, &tmaps
);
6925 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6927 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6928 maps
[nmaps
++] = tem
;
6929 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6931 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6933 maps
[nmaps
++] = current_global_map
;
6936 /* Look up in each map the dummy prefix key `menu-bar'. */
6940 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6941 if (!NILP (maps
[mapno
]))
6943 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6947 menu_bar_one_keymap_changed_items
= Qnil
;
6948 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
6952 /* Move to the end those items that should be at the end. */
6954 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6957 int end
= menu_bar_items_index
;
6959 for (i
= 0; i
< end
; i
+= 4)
6960 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6962 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6963 /* Move the item at index I to the end,
6964 shifting all the others forward. */
6965 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6966 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6967 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6968 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6970 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6971 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6972 (end
- i
- 4) * sizeof (Lisp_Object
));
6973 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6974 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6975 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6976 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6981 /* Add nil, nil, nil, nil at the end. */
6982 i
= menu_bar_items_index
;
6983 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6986 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6987 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6988 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6989 menu_bar_items_vector
= tem
;
6991 /* Add this item. */
6992 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6993 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6994 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6995 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6996 menu_bar_items_index
= i
;
6998 Vinhibit_quit
= oquit
;
7000 return menu_bar_items_vector
;
7003 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7004 If there's already an item for KEY, add this DEF to it. */
7006 Lisp_Object item_properties
;
7009 menu_bar_item (key
, item
, dummy1
, dummy2
)
7010 Lisp_Object key
, item
, dummy1
;
7013 struct gcpro gcpro1
;
7017 if (EQ (item
, Qundefined
))
7019 /* If a map has an explicit `undefined' as definition,
7020 discard any previously made menu bar item. */
7022 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7023 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7025 if (menu_bar_items_index
> i
+ 4)
7026 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7027 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7028 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7029 menu_bar_items_index
-= 4;
7033 /* If this keymap has already contributed to this KEY,
7034 don't contribute to it a second time. */
7035 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7036 if (!NILP (tem
) || NILP (item
))
7039 menu_bar_one_keymap_changed_items
7040 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7042 /* We add to menu_bar_one_keymap_changed_items before doing the
7043 parse_menu_item, so that if it turns out it wasn't a menu item,
7044 it still correctly hides any further menu item. */
7046 i
= parse_menu_item (item
, 0, 1);
7051 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7053 /* Find any existing item for this KEY. */
7054 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7055 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7058 /* If we did not find this KEY, add it at the end. */
7059 if (i
== menu_bar_items_index
)
7061 /* If vector is too small, get a bigger one. */
7062 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7065 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7066 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7067 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7068 menu_bar_items_vector
= tem
;
7071 /* Add this item. */
7072 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7073 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7074 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7075 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7076 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7077 menu_bar_items_index
= i
;
7079 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7083 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7084 /* If the new and the old items are not both keymaps,
7085 the lookup will only find `item'. */
7086 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7087 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7091 /* This is used as the handler when calling menu_item_eval_property. */
7093 menu_item_eval_property_1 (arg
)
7096 /* If we got a quit from within the menu computation,
7097 quit all the way out of it. This takes care of C-] in the debugger. */
7098 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7099 Fsignal (Qquit
, Qnil
);
7104 /* Evaluate an expression and return the result (or nil if something
7105 went wrong). Used to evaluate dynamic parts of menu items. */
7107 menu_item_eval_property (sexpr
)
7110 int count
= SPECPDL_INDEX ();
7112 specbind (Qinhibit_redisplay
, Qt
);
7113 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7114 menu_item_eval_property_1
);
7115 return unbind_to (count
, val
);
7118 /* This function parses a menu item and leaves the result in the
7119 vector item_properties.
7120 ITEM is a key binding, a possible menu item.
7121 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7122 evaluate dynamic expressions in the menu item.
7123 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7125 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7126 parse_menu_item returns true if the item is a menu item and false
7130 parse_menu_item (item
, notreal
, inmenubar
)
7132 int notreal
, inmenubar
;
7134 Lisp_Object def
, tem
, item_string
, start
;
7135 Lisp_Object cachelist
;
7137 Lisp_Object keyhint
;
7148 /* Create item_properties vector if necessary. */
7149 if (NILP (item_properties
))
7151 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7153 /* Initialize optional entries. */
7154 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7155 AREF (item_properties
, i
) = Qnil
;
7156 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7158 /* Save the item here to protect it from GC. */
7159 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7161 item_string
= XCAR (item
);
7165 if (STRINGP (item_string
))
7167 /* Old format menu item. */
7168 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7170 /* Maybe help string. */
7171 if (CONSP (item
) && STRINGP (XCAR (item
)))
7173 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7178 /* Maybe key binding cache. */
7179 if (CONSP (item
) && CONSP (XCAR (item
))
7180 && (NILP (XCAR (XCAR (item
)))
7181 || VECTORP (XCAR (XCAR (item
)))))
7183 cachelist
= XCAR (item
);
7187 /* This is the real definition--the function to run. */
7188 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7190 /* Get enable property, if any. */
7193 tem
= Fget (item
, Qmenu_enable
);
7195 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7198 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7200 /* New format menu item. */
7201 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7202 start
= XCDR (item
);
7205 /* We have a real binding. */
7206 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7208 item
= XCDR (start
);
7209 /* Is there a cache list with key equivalences. */
7210 if (CONSP (item
) && CONSP (XCAR (item
)))
7212 cachelist
= XCAR (item
);
7216 /* Parse properties. */
7217 while (CONSP (item
) && CONSP (XCDR (item
)))
7222 if (EQ (tem
, QCenable
))
7223 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7224 else if (EQ (tem
, QCvisible
) && !notreal
)
7226 /* If got a visible property and that evaluates to nil
7227 then ignore this item. */
7228 tem
= menu_item_eval_property (XCAR (item
));
7232 else if (EQ (tem
, QChelp
))
7233 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7234 else if (EQ (tem
, QCfilter
))
7236 else if (EQ (tem
, QCkey_sequence
))
7239 if (NILP (cachelist
)
7240 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7241 /* Be GC protected. Set keyhint to item instead of tem. */
7244 else if (EQ (tem
, QCkeys
))
7247 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7248 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7250 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7255 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7257 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7259 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7266 else if (inmenubar
|| !NILP (start
))
7270 return 0; /* not a menu item */
7272 /* If item string is not a string, evaluate it to get string.
7273 If we don't get a string, skip this item. */
7274 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7275 if (!(STRINGP (item_string
) || notreal
))
7277 item_string
= menu_item_eval_property (item_string
);
7278 if (!STRINGP (item_string
))
7280 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7283 /* If got a filter apply it on definition. */
7284 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7287 def
= menu_item_eval_property (list2 (XCAR (filter
),
7288 list2 (Qquote
, def
)));
7290 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7293 /* Enable or disable selection of item. */
7294 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7300 tem
= menu_item_eval_property (tem
);
7301 if (inmenubar
&& NILP (tem
))
7302 return 0; /* Ignore disabled items in menu bar. */
7303 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7306 /* If we got no definition, this item is just unselectable text which
7307 is OK in a submenu but not in the menubar. */
7309 return (inmenubar
? 0 : 1);
7311 /* See if this is a separate pane or a submenu. */
7312 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7313 tem
= get_keymap (def
, 0, 1);
7314 /* For a subkeymap, just record its details and exit. */
7317 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7318 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7322 /* At the top level in the menu bar, do likewise for commands also.
7323 The menu bar does not display equivalent key bindings anyway.
7324 ITEM_PROPERTY_DEF is already set up properly. */
7328 /* This is a command. See if there is an equivalent key binding. */
7329 if (NILP (cachelist
))
7331 /* We have to create a cachelist. */
7332 CHECK_IMPURE (start
);
7333 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7334 cachelist
= XCAR (XCDR (start
));
7336 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7337 if (!NILP (keyhint
))
7339 XSETCAR (cachelist
, XCAR (keyhint
));
7342 else if (STRINGP (tem
))
7344 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7345 XSETCAR (cachelist
, Qt
);
7349 tem
= XCAR (cachelist
);
7356 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7358 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7361 def
= XCAR (prefix
);
7362 prefix
= XCDR (prefix
);
7365 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7367 if (!update_menu_bindings
)
7369 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7371 if (newcache
/* Always check first time. */
7372 /* Should we check everything when precomputing key
7374 /* If something had no key binding before, don't recheck it
7375 because that is too slow--except if we have a list of
7376 rebound commands in Vdefine_key_rebound_commands, do
7377 recheck any command that appears in that list. */
7378 || (CONSP (Vdefine_key_rebound_commands
)
7379 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7382 /* We had a saved key. Is it still bound to the command? */
7385 /* If the command is an alias for another
7386 (such as lmenu.el set it up), check if the
7387 original command matches the cached command. */
7388 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7389 chkcache
= 1; /* Need to recompute key binding. */
7393 /* Recompute equivalent key binding. If the command is an alias
7394 for another (such as lmenu.el set it up), see if the original
7395 command name has equivalent keys. Otherwise look up the
7396 specified command itself. We don't try both, because that
7397 makes lmenu menus slow. */
7399 && SYMBOLP (XSYMBOL (def
)->function
)
7400 && ! NILP (Fget (def
, Qmenu_alias
)))
7401 def
= XSYMBOL (def
)->function
;
7402 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7403 XSETCAR (cachelist
, tem
);
7406 XSETCDR (cachelist
, Qnil
);
7410 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7412 tem
= XCAR (cachelist
);
7416 newcache
= chkcache
;
7419 tem
= Fkey_description (tem
, Qnil
);
7422 if (STRINGP (XCAR (prefix
)))
7423 tem
= concat2 (XCAR (prefix
), tem
);
7424 if (STRINGP (XCDR (prefix
)))
7425 tem
= concat2 (tem
, XCDR (prefix
));
7427 XSETCDR (cachelist
, tem
);
7431 tem
= XCDR (cachelist
);
7432 if (newcache
&& !NILP (tem
))
7434 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7435 XSETCDR (cachelist
, tem
);
7438 /* If we only want to precompute equivalent key bindings, stop here. */
7442 /* If we have an equivalent key binding, use that. */
7443 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7445 /* Include this when menu help is implemented.
7446 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7447 if (!(NILP (tem) || STRINGP (tem)))
7449 tem = menu_item_eval_property (tem);
7452 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7456 /* Handle radio buttons or toggle boxes. */
7457 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7459 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7460 = menu_item_eval_property (tem
);
7467 /***********************************************************************
7469 ***********************************************************************/
7471 /* A vector holding tool bar items while they are parsed in function
7472 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7475 static Lisp_Object tool_bar_items_vector
;
7477 /* A vector holding the result of parse_tool_bar_item. Layout is like
7478 the one for a single item in tool_bar_items_vector. */
7480 static Lisp_Object tool_bar_item_properties
;
7482 /* Next free index in tool_bar_items_vector. */
7484 static int ntool_bar_items
;
7486 /* The symbols `tool-bar', and `:image'. */
7488 extern Lisp_Object Qtool_bar
;
7489 Lisp_Object QCimage
;
7491 /* Function prototypes. */
7493 static void init_tool_bar_items
P_ ((Lisp_Object
));
7494 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7495 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7496 static void append_tool_bar_item
P_ ((void));
7499 /* Return a vector of tool bar items for keymaps currently in effect.
7500 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7501 tool bar items found. */
7504 tool_bar_items (reuse
, nitems
)
7515 /* In order to build the menus, we need to call the keymap
7516 accessors. They all call QUIT. But this function is called
7517 during redisplay, during which a quit is fatal. So inhibit
7518 quitting while building the menus. We do this instead of
7519 specbind because (1) errors will clear it anyway and (2) this
7520 avoids risk of specpdl overflow. */
7521 oquit
= Vinhibit_quit
;
7524 /* Initialize tool_bar_items_vector and protect it from GC. */
7525 init_tool_bar_items (reuse
);
7527 /* Build list of keymaps in maps. Set nmaps to the number of maps
7530 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7531 if (!NILP (Voverriding_local_map_menu_flag
))
7533 /* Yes, use them (if non-nil) as well as the global map. */
7534 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7536 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7537 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7538 if (!NILP (Voverriding_local_map
))
7539 maps
[nmaps
++] = Voverriding_local_map
;
7543 /* No, so use major and minor mode keymaps and keymap property.
7544 Note that tool-bar bindings in the local-map and keymap
7545 properties may not work reliable, as they are only
7546 recognized when the tool-bar (or mode-line) is updated,
7547 which does not normally happen after every command. */
7550 nminor
= current_minor_maps (NULL
, &tmaps
);
7551 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7553 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7554 maps
[nmaps
++] = tem
;
7555 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7557 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7560 /* Add global keymap at the end. */
7561 maps
[nmaps
++] = current_global_map
;
7563 /* Process maps in reverse order and look up in each map the prefix
7565 for (i
= nmaps
- 1; i
>= 0; --i
)
7566 if (!NILP (maps
[i
]))
7570 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7575 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7576 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7578 Lisp_Object keydef
= XCAR (tail
);
7580 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7585 Vinhibit_quit
= oquit
;
7586 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7587 return tool_bar_items_vector
;
7591 /* Process the definition of KEY which is DEF. */
7594 process_tool_bar_item (key
, def
)
7595 Lisp_Object key
, def
;
7598 extern Lisp_Object Qundefined
;
7599 struct gcpro gcpro1
, gcpro2
;
7601 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7605 if (EQ (def
, Qundefined
))
7607 /* If a map has an explicit `undefined' as definition,
7608 discard any previously made item. */
7609 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7611 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7613 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7615 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7616 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7617 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7618 * sizeof (Lisp_Object
)));
7619 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7624 else if (parse_tool_bar_item (key
, def
))
7625 /* Append a new tool bar item to tool_bar_items_vector. Accept
7626 more than one definition for the same key. */
7627 append_tool_bar_item ();
7633 /* Parse a tool bar item specification ITEM for key KEY and return the
7634 result in tool_bar_item_properties. Value is zero if ITEM is
7637 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7639 CAPTION is the caption of the item, If it's not a string, it is
7640 evaluated to get a string.
7642 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7643 as binding are currently ignored.
7645 The following properties are recognized:
7649 FORM is evaluated and specifies whether the tool bar item is
7650 enabled or disabled.
7654 FORM is evaluated and specifies whether the tool bar item is visible.
7656 - `:filter FUNCTION'
7658 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7659 result is stored as the new binding.
7661 - `:button (TYPE SELECTED)'
7663 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7664 and specifies whether the button is selected (pressed) or not.
7668 IMAGES is either a single image specification or a vector of four
7669 image specifications. See enum tool_bar_item_images.
7671 - `:help HELP-STRING'.
7673 Gives a help string to display for the tool bar item. */
7676 parse_tool_bar_item (key
, item
)
7677 Lisp_Object key
, item
;
7679 /* Access slot with index IDX of vector tool_bar_item_properties. */
7680 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7682 Lisp_Object filter
= Qnil
;
7683 Lisp_Object caption
;
7686 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7687 Rule out items that aren't lists, don't start with
7688 `menu-item' or whose rest following `tool-bar-item' is not a
7691 || !EQ (XCAR (item
), Qmenu_item
)
7692 || (item
= XCDR (item
),
7696 /* Create tool_bar_item_properties vector if necessary. Reset it to
7698 if (VECTORP (tool_bar_item_properties
))
7700 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7704 tool_bar_item_properties
7705 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7708 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7709 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7711 /* Get the caption of the item. If the caption is not a string,
7712 evaluate it to get a string. If we don't get a string, skip this
7714 caption
= XCAR (item
);
7715 if (!STRINGP (caption
))
7717 caption
= menu_item_eval_property (caption
);
7718 if (!STRINGP (caption
))
7721 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7723 /* Give up if rest following the caption is not a list. */
7728 /* Store the binding. */
7729 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7732 /* Ignore cached key binding, if any. */
7733 if (CONSP (item
) && CONSP (XCAR (item
)))
7736 /* Process the rest of the properties. */
7737 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7739 Lisp_Object key
, value
;
7742 value
= XCAR (XCDR (item
));
7744 if (EQ (key
, QCenable
))
7745 /* `:enable FORM'. */
7746 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7747 else if (EQ (key
, QCvisible
))
7749 /* `:visible FORM'. If got a visible property and that
7750 evaluates to nil then ignore this item. */
7751 if (NILP (menu_item_eval_property (value
)))
7754 else if (EQ (key
, QChelp
))
7755 /* `:help HELP-STRING'. */
7756 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7757 else if (EQ (key
, QCfilter
))
7758 /* ':filter FORM'. */
7760 else if (EQ (key
, QCbutton
) && CONSP (value
))
7762 /* `:button (TYPE . SELECTED)'. */
7763 Lisp_Object type
, selected
;
7765 type
= XCAR (value
);
7766 selected
= XCDR (value
);
7767 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7769 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7770 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7773 else if (EQ (key
, QCimage
)
7775 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7776 /* Value is either a single image specification or a vector
7777 of 4 such specifications for the different button states. */
7778 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7781 /* If got a filter apply it on binding. */
7783 PROP (TOOL_BAR_ITEM_BINDING
)
7784 = menu_item_eval_property (list2 (filter
,
7786 PROP (TOOL_BAR_ITEM_BINDING
))));
7788 /* See if the binding is a keymap. Give up if it is. */
7789 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7792 /* Enable or disable selection of item. */
7793 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7794 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7795 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7797 /* Handle radio buttons or toggle boxes. */
7798 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7799 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7800 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7808 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7809 that can be reused. */
7812 init_tool_bar_items (reuse
)
7815 if (VECTORP (reuse
))
7816 tool_bar_items_vector
= reuse
;
7818 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7819 ntool_bar_items
= 0;
7823 /* Append parsed tool bar item properties from
7824 tool_bar_item_properties */
7827 append_tool_bar_item ()
7829 Lisp_Object
*to
, *from
;
7831 /* Enlarge tool_bar_items_vector if necessary. */
7832 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7833 >= XVECTOR (tool_bar_items_vector
)->size
)
7835 Lisp_Object new_vector
;
7836 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7838 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7839 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7840 XVECTOR (new_vector
)->contents
,
7841 old_size
* sizeof (Lisp_Object
));
7842 tool_bar_items_vector
= new_vector
;
7845 /* Append entries from tool_bar_item_properties to the end of
7846 tool_bar_items_vector. */
7847 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7848 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7849 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7850 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7857 /* Read a character using menus based on maps in the array MAPS.
7858 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7859 Return t if we displayed a menu but the user rejected it.
7861 PREV_EVENT is the previous input event, or nil if we are reading
7862 the first event of a key sequence.
7864 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7865 if we used a mouse menu to read the input, or zero otherwise. If
7866 USED_MOUSE_MENU is null, we don't dereference it.
7868 The prompting is done based on the prompt-string of the map
7869 and the strings associated with various map elements.
7871 This can be done with X menus or with menus put in the minibuf.
7872 These are done in different ways, depending on how the input will be read.
7873 Menus using X are done after auto-saving in read-char, getting the input
7874 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7875 and do auto-saving in the inner call of read_char. */
7878 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7881 Lisp_Object prev_event
;
7882 int *used_mouse_menu
;
7885 register Lisp_Object name
= Qnil
;
7887 if (used_mouse_menu
)
7888 *used_mouse_menu
= 0;
7890 /* Use local over global Menu maps */
7892 if (! menu_prompting
)
7895 /* Optionally disregard all but the global map. */
7896 if (inhibit_local_menu_bar_menus
)
7898 maps
+= (nmaps
- 1);
7902 /* Get the menu name from the first map that has one (a prompt string). */
7903 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7905 name
= Fkeymap_prompt (maps
[mapno
]);
7910 /* If we don't have any menus, just read a character normally. */
7911 if (!STRINGP (name
))
7915 /* If we got to this point via a mouse click,
7916 use a real menu for mouse selection. */
7917 if (EVENT_HAS_PARAMETERS (prev_event
)
7918 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7919 && !EQ (XCAR (prev_event
), Qtool_bar
))
7921 /* Display the menu and get the selection. */
7922 Lisp_Object
*realmaps
7923 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7927 /* Use the maps that are not nil. */
7928 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7929 if (!NILP (maps
[mapno
]))
7930 realmaps
[nmaps1
++] = maps
[mapno
];
7932 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7937 record_menu_key (XCAR (value
));
7939 /* If we got multiple events, unread all but
7941 There is no way to prevent those unread events
7942 from showing up later in last_nonmenu_event.
7943 So turn symbol and integer events into lists,
7944 to indicate that they came from a mouse menu,
7945 so that when present in last_nonmenu_event
7946 they won't confuse things. */
7947 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7949 record_menu_key (XCAR (tem
));
7950 if (SYMBOLP (XCAR (tem
))
7951 || INTEGERP (XCAR (tem
)))
7952 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7955 /* If we got more than one event, put all but the first
7956 onto this list to be read later.
7957 Return just the first event now. */
7958 Vunread_command_events
7959 = nconc2 (XCDR (value
), Vunread_command_events
);
7960 value
= XCAR (value
);
7962 else if (NILP (value
))
7964 if (used_mouse_menu
)
7965 *used_mouse_menu
= 1;
7968 #endif /* HAVE_MENUS */
7972 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7973 We make this bigger when necessary, and never free it. */
7974 static char *read_char_minibuf_menu_text
;
7975 /* Size of that buffer. */
7976 static int read_char_minibuf_menu_width
;
7979 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7985 register Lisp_Object name
;
7987 /* FIXME: Use the minibuffer's frame width. */
7988 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
7991 Lisp_Object rest
, vector
;
7997 if (! menu_prompting
)
8000 /* Make sure we have a big enough buffer for the menu text. */
8001 if (read_char_minibuf_menu_text
== 0)
8003 read_char_minibuf_menu_width
= width
+ 4;
8004 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8006 else if (width
+ 4 > read_char_minibuf_menu_width
)
8008 read_char_minibuf_menu_width
= width
+ 4;
8009 read_char_minibuf_menu_text
8010 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8012 menu
= read_char_minibuf_menu_text
;
8014 /* Get the menu name from the first map that has one (a prompt string). */
8015 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8017 name
= Fkeymap_prompt (maps
[mapno
]);
8022 /* If we don't have any menus, just read a character normally. */
8023 if (!STRINGP (name
))
8026 /* Prompt string always starts with map's prompt, and a space. */
8027 strcpy (menu
, SDATA (name
));
8028 nlength
= SBYTES (name
);
8029 menu
[nlength
++] = ':';
8030 menu
[nlength
++] = ' ';
8033 /* Start prompting at start of first map. */
8037 /* Present the documented bindings, a line at a time. */
8044 Lisp_Object orig_defn_macro
;
8046 /* Loop over elements of map. */
8051 /* If reached end of map, start at beginning of next map. */
8055 /* At end of last map, wrap around to first map if just starting,
8056 or end this line if already have something on it. */
8060 if (notfirst
|| nobindings
) break;
8065 /* Look at the next element of the map. */
8067 elt
= XVECTOR (vector
)->contents
[idx
];
8069 elt
= Fcar_safe (rest
);
8071 if (idx
< 0 && VECTORP (elt
))
8073 /* If we found a dense table in the keymap,
8074 advanced past it, but start scanning its contents. */
8075 rest
= Fcdr_safe (rest
);
8081 /* An ordinary element. */
8082 Lisp_Object event
, tem
;
8086 event
= Fcar_safe (elt
); /* alist */
8087 elt
= Fcdr_safe (elt
);
8091 XSETINT (event
, idx
); /* vector */
8094 /* Ignore the element if it has no prompt string. */
8095 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8097 /* 1 if the char to type matches the string. */
8099 Lisp_Object upcased_event
, downcased_event
;
8100 Lisp_Object desc
= Qnil
;
8102 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8104 upcased_event
= Fupcase (event
);
8105 downcased_event
= Fdowncase (event
);
8106 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8107 || XINT (downcased_event
) == SREF (s
, 0));
8109 desc
= Fsingle_key_description (event
, Qnil
);
8111 #if 0 /* It is redundant to list the equivalent key bindings because
8112 the prefix is what the user has already typed. */
8114 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8116 /* Insert equivalent keybinding. */
8117 s
= concat2 (s
, tem
);
8120 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8121 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8123 /* Insert button prefix. */
8124 Lisp_Object selected
8125 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8126 if (EQ (tem
, QCradio
))
8127 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8129 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8130 s
= concat2 (tem
, s
);
8134 /* If we have room for the prompt string, add it to this line.
8135 If this is the first on the line, always add it. */
8136 if ((SCHARS (s
) + i
+ 2
8137 + (char_matches
? 0 : SCHARS (desc
) + 3))
8143 /* Punctuate between strings. */
8146 strcpy (menu
+ i
, ", ");
8152 /* If the char to type doesn't match the string's
8153 first char, explicitly show what char to type. */
8156 /* Add as much of string as fits. */
8157 thiswidth
= SCHARS (desc
);
8158 if (thiswidth
+ i
> width
)
8159 thiswidth
= width
- i
;
8160 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8162 strcpy (menu
+ i
, " = ");
8166 /* Add as much of string as fits. */
8167 thiswidth
= SCHARS (s
);
8168 if (thiswidth
+ i
> width
)
8169 thiswidth
= width
- i
;
8170 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8176 /* If this element does not fit, end the line now,
8177 and save the element for the next line. */
8178 strcpy (menu
+ i
, "...");
8183 /* Move past this element. */
8184 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8185 /* Handle reaching end of dense table. */
8190 rest
= Fcdr_safe (rest
);
8194 /* Prompt with that and read response. */
8195 message2_nolog (menu
, strlen (menu
),
8196 ! NILP (current_buffer
->enable_multibyte_characters
));
8198 /* Make believe its not a keyboard macro in case the help char
8199 is pressed. Help characters are not recorded because menu prompting
8200 is not used on replay.
8202 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8203 current_kboard
->defining_kbd_macro
= Qnil
;
8205 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8206 while (BUFFERP (obj
));
8207 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8209 if (!INTEGERP (obj
))
8214 if (! EQ (obj
, menu_prompt_more_char
)
8215 && (!INTEGERP (menu_prompt_more_char
)
8216 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8218 if (!NILP (current_kboard
->defining_kbd_macro
))
8219 store_kbd_macro_char (obj
);
8222 /* Help char - go round again */
8226 /* Reading key sequences. */
8228 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8229 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8230 keymap, or nil otherwise. Return the index of the first keymap in
8231 which KEY has any binding, or NMAPS if no map has a binding.
8233 If KEY is a meta ASCII character, treat it like meta-prefix-char
8234 followed by the corresponding non-meta character. Keymaps in
8235 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8238 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8241 NEXT may be the same array as CURRENT. */
8244 follow_key (key
, nmaps
, current
, defs
, next
)
8246 Lisp_Object
*current
, *defs
, *next
;
8249 int i
, first_binding
;
8251 first_binding
= nmaps
;
8252 for (i
= nmaps
- 1; i
>= 0; i
--)
8254 if (! NILP (current
[i
]))
8256 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8257 if (! NILP (defs
[i
]))
8264 /* Given the set of bindings we've found, produce the next set of maps. */
8265 if (first_binding
< nmaps
)
8266 for (i
= 0; i
< nmaps
; i
++)
8267 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8269 return first_binding
;
8272 /* Structure used to keep track of partial application of key remapping
8273 such as Vfunction_key_map and Vkey_translation_map. */
8274 typedef struct keyremap
8276 Lisp_Object map
, parent
;
8280 /* Lookup KEY in MAP.
8281 MAP is a keymap mapping keys to key vectors or functions.
8282 If the mapping is a function and DO_FUNCTION is non-zero, then
8283 the function is called with PROMPT as parameter and its return
8284 value is used as the return value of this function (after checking
8285 that it is indeed a vector). */
8288 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8289 Lisp_Object map
, key
, prompt
;
8294 next
= access_keymap (map
, key
, 1, 0, 1);
8296 /* Handle symbol with autoload definition. */
8297 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8298 && CONSP (XSYMBOL (next
)->function
)
8299 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8300 do_autoload (XSYMBOL (next
)->function
, next
);
8302 /* Handle a symbol whose function definition is a keymap
8304 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8305 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8306 || KEYMAPP (XSYMBOL (next
)->function
)))
8307 next
= XSYMBOL (next
)->function
;
8309 /* If the keymap gives a function, not an
8310 array, then call the function with one arg and use
8311 its value instead. */
8312 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8317 next
= call1 (next
, prompt
);
8318 /* If the function returned something invalid,
8319 barf--don't ignore it.
8320 (To ignore it safely, we would need to gcpro a bunch of
8321 other variables.) */
8322 if (! (VECTORP (next
) || STRINGP (next
)))
8323 error ("Function %s returns invalid key sequence", tem
);
8328 /* Do one step of the key remapping used for function-key-map and
8329 key-translation-map:
8330 KEYBUF is the buffer holding the input events.
8331 BUFSIZE is its maximum size.
8332 FKEY is a pointer to the keyremap structure to use.
8333 INPUT is the index of the last element in KEYBUF.
8334 DOIT if non-zero says that the remapping can actually take place.
8335 DIFF is used to return the number of keys added/removed by the remapping.
8336 PARENT is the root of the keymap.
8337 PROMPT is the prompt to use if the remapping happens through a function.
8338 The return value is non-zero if the remapping actually took place. */
8341 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8342 Lisp_Object
*keybuf
, prompt
;
8344 int input
, doit
, *diff
, bufsize
;
8346 Lisp_Object next
, key
;
8348 key
= keybuf
[fkey
->end
++];
8349 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8351 /* If keybuf[fkey->start..fkey->end] is bound in the
8352 map and we're in a position to do the key remapping, replace it with
8353 the binding and restart with fkey->start at the end. */
8354 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8356 int len
= XFASTINT (Flength (next
));
8359 *diff
= len
- (fkey
->end
- fkey
->start
);
8361 if (input
+ *diff
>= bufsize
)
8362 error ("Key sequence too long");
8364 /* Shift the keys that follow fkey->end. */
8366 for (i
= fkey
->end
; i
< input
; i
++)
8367 keybuf
[i
+ *diff
] = keybuf
[i
];
8369 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8370 keybuf
[i
+ *diff
] = keybuf
[i
];
8371 /* Overwrite the old keys with the new ones. */
8372 for (i
= 0; i
< len
; i
++)
8373 keybuf
[fkey
->start
+ i
]
8374 = Faref (next
, make_number (i
));
8376 fkey
->start
= fkey
->end
+= *diff
;
8377 fkey
->map
= fkey
->parent
;
8382 fkey
->map
= get_keymap (next
, 0, 1);
8384 /* If we no longer have a bound suffix, try a new position for
8386 if (!CONSP (fkey
->map
))
8388 fkey
->end
= ++fkey
->start
;
8389 fkey
->map
= fkey
->parent
;
8394 /* Read a sequence of keys that ends with a non prefix character,
8395 storing it in KEYBUF, a buffer of size BUFSIZE.
8397 Return the length of the key sequence stored.
8398 Return -1 if the user rejected a command menu.
8400 Echo starting immediately unless `prompt' is 0.
8402 Where a key sequence ends depends on the currently active keymaps.
8403 These include any minor mode keymaps active in the current buffer,
8404 the current buffer's local map, and the global map.
8406 If a key sequence has no other bindings, we check Vfunction_key_map
8407 to see if some trailing subsequence might be the beginning of a
8408 function key's sequence. If so, we try to read the whole function
8409 key, and substitute its symbolic name into the key sequence.
8411 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8412 `double-' events into similar click events, if that would make them
8413 bound. We try to turn `triple-' events first into `double-' events,
8416 If we get a mouse click in a mode line, vertical divider, or other
8417 non-text area, we treat the click as if it were prefixed by the
8418 symbol denoting that area - `mode-line', `vertical-line', or
8421 If the sequence starts with a mouse click, we read the key sequence
8422 with respect to the buffer clicked on, not the current buffer.
8424 If the user switches frames in the midst of a key sequence, we put
8425 off the switch-frame event until later; the next call to
8426 read_char will return it.
8428 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8429 from the selected window's buffer. */
8432 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8433 can_return_switch_frame
, fix_current_buffer
)
8434 Lisp_Object
*keybuf
;
8437 int dont_downcase_last
;
8438 int can_return_switch_frame
;
8439 int fix_current_buffer
;
8441 volatile Lisp_Object from_string
;
8442 volatile int count
= SPECPDL_INDEX ();
8444 /* How many keys there are in the current key sequence. */
8447 /* The length of the echo buffer when we started reading, and
8448 the length of this_command_keys when we started reading. */
8449 volatile int echo_start
;
8450 volatile int keys_start
;
8452 /* The number of keymaps we're scanning right now, and the number of
8453 keymaps we have allocated space for. */
8455 volatile int nmaps_allocated
= 0;
8457 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8458 the current keymaps. */
8459 Lisp_Object
*volatile defs
= NULL
;
8461 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8462 in the current keymaps, or nil where it is not a prefix. */
8463 Lisp_Object
*volatile submaps
= NULL
;
8465 /* The local map to start out with at start of key sequence. */
8466 volatile Lisp_Object orig_local_map
;
8468 /* The map from the `keymap' property to start out with at start of
8470 volatile Lisp_Object orig_keymap
;
8472 /* 1 if we have already considered switching to the local-map property
8473 of the place where a mouse click occurred. */
8474 volatile int localized_local_map
= 0;
8476 /* The index in defs[] of the first keymap that has a binding for
8477 this key sequence. In other words, the lowest i such that
8478 defs[i] is non-nil. */
8479 volatile int first_binding
;
8480 /* Index of the first key that has no binding.
8481 It is useless to try fkey.start larger than that. */
8482 volatile int first_unbound
;
8484 /* If t < mock_input, then KEYBUF[t] should be read as the next
8487 We use this to recover after recognizing a function key. Once we
8488 realize that a suffix of the current key sequence is actually a
8489 function key's escape sequence, we replace the suffix with the
8490 function key's binding from Vfunction_key_map. Now keybuf
8491 contains a new and different key sequence, so the echo area,
8492 this_command_keys, and the submaps and defs arrays are wrong. In
8493 this situation, we set mock_input to t, set t to 0, and jump to
8494 restart_sequence; the loop will read keys from keybuf up until
8495 mock_input, thus rebuilding the state; and then it will resume
8496 reading characters from the keyboard. */
8497 volatile int mock_input
= 0;
8499 /* If the sequence is unbound in submaps[], then
8500 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8501 and fkey.map is its binding.
8503 These might be > t, indicating that all function key scanning
8504 should hold off until t reaches them. We do this when we've just
8505 recognized a function key, to avoid searching for the function
8506 key's again in Vfunction_key_map. */
8507 volatile keyremap fkey
;
8509 /* Likewise, for key_translation_map. */
8510 volatile keyremap keytran
;
8512 /* If we receive a `switch-frame' or `select-window' event in the middle of
8513 a key sequence, we put it off for later.
8514 While we're reading, we keep the event here. */
8515 volatile Lisp_Object delayed_switch_frame
;
8517 /* See the comment below... */
8518 #if defined (GOBBLE_FIRST_EVENT)
8519 Lisp_Object first_event
;
8522 volatile Lisp_Object original_uppercase
;
8523 volatile int original_uppercase_position
= -1;
8525 /* Gets around Microsoft compiler limitations. */
8528 struct buffer
*starting_buffer
;
8530 /* List of events for which a fake prefix key has been generated. */
8531 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8533 #if defined (GOBBLE_FIRST_EVENT)
8537 struct gcpro gcpro1
;
8539 GCPRO1 (fake_prefixed_keys
);
8540 raw_keybuf_count
= 0;
8542 last_nonmenu_event
= Qnil
;
8544 delayed_switch_frame
= Qnil
;
8545 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8546 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8547 /* If there is no translation-map, turn off scanning. */
8548 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8549 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8554 echo_prompt (prompt
);
8555 else if (cursor_in_echo_area
8556 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8557 && NILP (Fzerop (Vecho_keystrokes
)))
8558 /* This doesn't put in a dash if the echo buffer is empty, so
8559 you don't always see a dash hanging out in the minibuffer. */
8563 /* Record the initial state of the echo area and this_command_keys;
8564 we will need to restore them if we replay a key sequence. */
8566 echo_start
= echo_length ();
8567 keys_start
= this_command_key_count
;
8568 this_single_command_key_start
= keys_start
;
8570 #if defined (GOBBLE_FIRST_EVENT)
8571 /* This doesn't quite work, because some of the things that read_char
8572 does cannot safely be bypassed. It seems too risky to try to make
8575 /* Read the first char of the sequence specially, before setting
8576 up any keymaps, in case a filter runs and switches buffers on us. */
8577 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8579 #endif /* GOBBLE_FIRST_EVENT */
8581 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8582 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8585 /* We jump here when the key sequence has been thoroughly changed, and
8586 we need to rescan it starting from the beginning. When we jump here,
8587 keybuf[0..mock_input] holds the sequence we should reread. */
8590 starting_buffer
= current_buffer
;
8591 first_unbound
= bufsize
+ 1;
8593 /* Build our list of keymaps.
8594 If we recognize a function key and replace its escape sequence in
8595 keybuf with its symbol, or if the sequence starts with a mouse
8596 click and we need to switch buffers, we jump back here to rebuild
8597 the initial keymaps from the current buffer. */
8600 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8601 || !NILP (Voverriding_local_map
))
8603 if (3 > nmaps_allocated
)
8605 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8606 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8607 nmaps_allocated
= 3;
8609 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8610 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8611 if (!NILP (Voverriding_local_map
))
8612 submaps
[nmaps
++] = Voverriding_local_map
;
8620 nminor
= current_minor_maps (0, &maps
);
8621 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8623 if (total
> nmaps_allocated
)
8625 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8626 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8627 nmaps_allocated
= total
;
8630 if (!NILP (orig_keymap
))
8631 submaps
[nmaps
++] = orig_keymap
;
8633 bcopy (maps
, (void *) (submaps
+ nmaps
),
8634 nminor
* sizeof (submaps
[0]));
8638 submaps
[nmaps
++] = orig_local_map
;
8640 submaps
[nmaps
++] = current_global_map
;
8642 /* Find an accurate initial value for first_binding. */
8643 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8644 if (! NILP (submaps
[first_binding
]))
8647 /* Start from the beginning in keybuf. */
8650 /* These are no-ops the first time through, but if we restart, they
8651 revert the echo area and this_command_keys to their original state. */
8652 this_command_key_count
= keys_start
;
8653 if (INTERACTIVE
&& t
< mock_input
)
8654 echo_truncate (echo_start
);
8656 /* If the best binding for the current key sequence is a keymap, or
8657 we may be looking at a function key's escape sequence, keep on
8659 while (first_binding
< nmaps
8660 /* Keep reading as long as there's a prefix binding. */
8661 ? !NILP (submaps
[first_binding
])
8662 /* Don't return in the middle of a possible function key sequence,
8663 if the only bindings we found were via case conversion.
8664 Thus, if ESC O a has a function-key-map translation
8665 and ESC o has a binding, don't return after ESC O,
8666 so that we can translate ESC O plus the next character. */
8667 : (fkey
.start
< t
|| keytran
.start
< t
))
8670 int used_mouse_menu
= 0;
8672 /* Where the last real key started. If we need to throw away a
8673 key that has expanded into more than one element of keybuf
8674 (say, a mouse click on the mode line which is being treated
8675 as [mode-line (mouse-...)], then we backtrack to this point
8677 volatile int last_real_key_start
;
8679 /* These variables are analogous to echo_start and keys_start;
8680 while those allow us to restart the entire key sequence,
8681 echo_local_start and keys_local_start allow us to throw away
8683 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8685 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8686 eassert (fkey
.start
<= fkey
.end
);
8687 eassert (keytran
.start
<= keytran
.end
);
8688 /* key-translation-map is applied *after* function-key-map. */
8689 eassert (keytran
.end
<= fkey
.start
);
8691 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8692 { /* The prefix upto first_unbound has no binding and has
8693 no translation left to do either, so we know it's unbound.
8694 If we don't stop now, we risk staying here indefinitely
8695 (if the user keeps entering fkey or keytran prefixes
8696 like C-c ESC ESC ESC ESC ...) */
8698 for (i
= first_unbound
+ 1; i
< t
; i
++)
8699 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8700 mock_input
= t
- first_unbound
- 1;
8701 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8702 fkey
.map
= fkey
.parent
;
8703 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8704 keytran
.map
= keytran
.parent
;
8705 goto replay_sequence
;
8709 error ("Key sequence too long");
8712 echo_local_start
= echo_length ();
8713 keys_local_start
= this_command_key_count
;
8714 local_first_binding
= first_binding
;
8717 /* These are no-ops, unless we throw away a keystroke below and
8718 jumped back up to replay_key; in that case, these restore the
8719 variables to their original state, allowing us to replay the
8721 if (INTERACTIVE
&& t
< mock_input
)
8722 echo_truncate (echo_local_start
);
8723 this_command_key_count
= keys_local_start
;
8724 first_binding
= local_first_binding
;
8726 /* By default, assume each event is "real". */
8727 last_real_key_start
= t
;
8729 /* Does mock_input indicate that we are re-reading a key sequence? */
8733 add_command_key (key
);
8734 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8735 && NILP (Fzerop (Vecho_keystrokes
)))
8739 /* If not, we should actually read a character. */
8744 KBOARD
*interrupted_kboard
= current_kboard
;
8745 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8746 if (setjmp (wrong_kboard_jmpbuf
))
8748 if (!NILP (delayed_switch_frame
))
8750 interrupted_kboard
->kbd_queue
8751 = Fcons (delayed_switch_frame
,
8752 interrupted_kboard
->kbd_queue
);
8753 delayed_switch_frame
= Qnil
;
8756 interrupted_kboard
->kbd_queue
8757 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8759 /* If the side queue is non-empty, ensure it begins with a
8760 switch-frame, so we'll replay it in the right context. */
8761 if (CONSP (interrupted_kboard
->kbd_queue
)
8762 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8763 !(EVENT_HAS_PARAMETERS (key
)
8764 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8768 XSETFRAME (frame
, interrupted_frame
);
8769 interrupted_kboard
->kbd_queue
8770 = Fcons (make_lispy_switch_frame (frame
),
8771 interrupted_kboard
->kbd_queue
);
8774 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8775 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8776 goto replay_sequence
;
8779 key
= read_char (NILP (prompt
), nmaps
,
8780 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8784 /* read_char returns t when it shows a menu and the user rejects it.
8788 unbind_to (count
, Qnil
);
8793 /* read_char returns -1 at the end of a macro.
8794 Emacs 18 handles this by returning immediately with a
8795 zero, so that's what we'll do. */
8796 if (INTEGERP (key
) && XINT (key
) == -1)
8799 /* The Microsoft C compiler can't handle the goto that
8805 /* If the current buffer has been changed from under us, the
8806 keymap may have changed, so replay the sequence. */
8809 EMACS_TIME initial_idleness_start_time
;
8810 EMACS_SET_SECS_USECS (initial_idleness_start_time
,
8811 EMACS_SECS (timer_last_idleness_start_time
),
8812 EMACS_USECS (timer_last_idleness_start_time
));
8814 /* Resume idle state, using the same start-time as before. */
8815 timer_start_idle ();
8816 timer_idleness_start_time
= initial_idleness_start_time
;
8819 /* Reset the current buffer from the selected window
8820 in case something changed the former and not the latter.
8821 This is to be more consistent with the behavior
8822 of the command_loop_1. */
8823 if (fix_current_buffer
)
8825 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8827 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8828 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8831 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8832 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8833 goto replay_sequence
;
8836 /* If we have a quit that was typed in another frame, and
8837 quit_throw_to_read_char switched buffers,
8838 replay to get the right keymap. */
8840 && XINT (key
) == quit_char
8841 && current_buffer
!= starting_buffer
)
8844 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8848 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8849 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8850 goto replay_sequence
;
8855 if (EVENT_HAS_PARAMETERS (key
)
8856 /* Either a `switch-frame' or a `select-window' event. */
8857 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8859 /* If we're at the beginning of a key sequence, and the caller
8860 says it's okay, go ahead and return this event. If we're
8861 in the midst of a key sequence, delay it until the end. */
8862 if (t
> 0 || !can_return_switch_frame
)
8864 delayed_switch_frame
= key
;
8870 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8873 /* Clicks in non-text areas get prefixed by the symbol
8874 in their CHAR-ADDRESS field. For example, a click on
8875 the mode line is prefixed by the symbol `mode-line'.
8877 Furthermore, key sequences beginning with mouse clicks
8878 are read using the keymaps of the buffer clicked on, not
8879 the current buffer. So we may have to switch the buffer
8882 When we turn one event into two events, we must make sure
8883 that neither of the two looks like the original--so that,
8884 if we replay the events, they won't be expanded again.
8885 If not for this, such reexpansion could happen either here
8886 or when user programs play with this-command-keys. */
8887 if (EVENT_HAS_PARAMETERS (key
))
8892 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8893 if (EQ (kind
, Qmouse_click
))
8895 Lisp_Object window
, posn
;
8897 window
= POSN_WINDOW (EVENT_START (key
));
8898 posn
= POSN_POSN (EVENT_START (key
));
8901 || (!NILP (fake_prefixed_keys
)
8902 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8904 /* We're looking a second time at an event for which
8905 we generated a fake prefix key. Set
8906 last_real_key_start appropriately. */
8908 last_real_key_start
= t
- 1;
8911 /* Key sequences beginning with mouse clicks are
8912 read using the keymaps in the buffer clicked on,
8913 not the current buffer. If we're at the
8914 beginning of a key sequence, switch buffers. */
8915 if (last_real_key_start
== 0
8917 && BUFFERP (XWINDOW (window
)->buffer
)
8918 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8920 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8924 /* Arrange to go back to the original buffer once we're
8925 done reading the key sequence. Note that we can't
8926 use save_excursion_{save,restore} here, because they
8927 save point as well as the current buffer; we don't
8928 want to save point, because redisplay may change it,
8929 to accommodate a Fset_window_start or something. We
8930 don't want to do this at the top of the function,
8931 because we may get input from a subprocess which
8932 wants to change the selected window and stuff (say,
8934 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8936 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8938 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8939 orig_local_map
= get_local_map (PT
, current_buffer
,
8941 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8942 goto replay_sequence
;
8945 /* For a mouse click, get the local text-property keymap
8946 of the place clicked on, rather than point. */
8947 if (last_real_key_start
== 0
8948 && CONSP (XCDR (key
))
8949 && ! localized_local_map
)
8951 Lisp_Object map_here
, start
, pos
;
8953 localized_local_map
= 1;
8954 start
= EVENT_START (key
);
8956 if (CONSP (start
) && POSN_INBUFFER_P (start
))
8958 pos
= POSN_BUFFER_POSN (start
);
8960 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8962 map_here
= get_local_map (XINT (pos
),
8963 current_buffer
, Qlocal_map
);
8964 if (!EQ (map_here
, orig_local_map
))
8966 orig_local_map
= map_here
;
8970 goto replay_sequence
;
8972 map_here
= get_local_map (XINT (pos
),
8973 current_buffer
, Qkeymap
);
8974 if (!EQ (map_here
, orig_keymap
))
8976 orig_keymap
= map_here
;
8980 goto replay_sequence
;
8986 /* Expand mode-line and scroll-bar events into two events:
8987 use posn as a fake prefix key. */
8989 && (NILP (fake_prefixed_keys
)
8990 || NILP (Fmemq (key
, fake_prefixed_keys
))))
8992 if (t
+ 1 >= bufsize
)
8993 error ("Key sequence too long");
8996 keybuf
[t
+ 1] = key
;
8999 /* Record that a fake prefix key has been generated
9000 for KEY. Don't modify the event; this would
9001 prevent proper action when the event is pushed
9002 back into unread-command-events. */
9003 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9005 /* If on a mode line string with a local keymap,
9006 reconsider the key sequence with that keymap. */
9007 if (string
= POSN_STRING (EVENT_START (key
)),
9008 (CONSP (string
) && STRINGP (XCAR (string
))))
9010 Lisp_Object pos
, map
, map2
;
9012 pos
= XCDR (string
);
9013 string
= XCAR (string
);
9015 && XINT (pos
) < SCHARS (string
))
9017 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9019 orig_local_map
= map
;
9020 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9023 if (!NILP (map
) || !NILP (map2
))
9024 goto replay_sequence
;
9030 else if (NILP (from_string
)
9031 && (string
= POSN_STRING (EVENT_START (key
)),
9032 (CONSP (string
) && STRINGP (XCAR (string
)))))
9034 /* For a click on a string, i.e. overlay string or a
9035 string displayed via the `display' property,
9036 consider `local-map' and `keymap' properties of
9038 Lisp_Object pos
, map
, map2
;
9040 pos
= XCDR (string
);
9041 string
= XCAR (string
);
9043 && XINT (pos
) < SCHARS (string
))
9045 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9047 orig_local_map
= map
;
9048 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9052 if (!NILP (map
) || !NILP (map2
))
9054 from_string
= string
;
9055 goto replay_sequence
;
9060 else if (CONSP (XCDR (key
))
9061 && CONSP (EVENT_START (key
))
9062 && CONSP (XCDR (EVENT_START (key
))))
9066 posn
= POSN_POSN (EVENT_START (key
));
9067 /* Handle menu-bar events:
9068 insert the dummy prefix event `menu-bar'. */
9069 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9071 if (t
+ 1 >= bufsize
)
9072 error ("Key sequence too long");
9076 /* Zap the position in key, so we know that we've
9077 expanded it, and don't try to do so again. */
9078 POSN_SET_POSN (EVENT_START (key
),
9079 Fcons (posn
, Qnil
));
9082 goto replay_sequence
;
9084 else if (CONSP (posn
))
9086 /* We're looking at the second event of a
9087 sequence which we expanded before. Set
9088 last_real_key_start appropriately. */
9089 if (last_real_key_start
== t
&& t
> 0)
9090 last_real_key_start
= t
- 1;
9095 /* We have finally decided that KEY is something we might want
9097 first_binding
= (follow_key (key
,
9098 nmaps
- first_binding
,
9099 submaps
+ first_binding
,
9100 defs
+ first_binding
,
9101 submaps
+ first_binding
)
9104 /* If KEY wasn't bound, we'll try some fallbacks. */
9105 if (first_binding
< nmaps
)
9106 /* This is needed for the following scenario:
9107 event 0: a down-event that gets dropped by calling replay_key.
9108 event 1: some normal prefix like C-h.
9109 After event 0, first_unbound is 0, after event 1 fkey.start
9110 and keytran.start are both 1, so when we see that C-h is bound,
9111 we need to update first_unbound. */
9112 first_unbound
= max (t
+ 1, first_unbound
);
9117 /* Remember the position to put an upper bound on fkey.start. */
9118 first_unbound
= min (t
, first_unbound
);
9120 head
= EVENT_HEAD (key
);
9121 if (help_char_p (head
) && t
> 0)
9123 read_key_sequence_cmd
= Vprefix_help_command
;
9125 last_nonmenu_event
= key
;
9126 /* The Microsoft C compiler can't handle the goto that
9134 Lisp_Object breakdown
;
9137 breakdown
= parse_modifiers (head
);
9138 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9139 /* Attempt to reduce an unbound mouse event to a simpler
9140 event that is bound:
9141 Drags reduce to clicks.
9142 Double-clicks reduce to clicks.
9143 Triple-clicks reduce to double-clicks, then to clicks.
9144 Down-clicks are eliminated.
9145 Double-downs reduce to downs, then are eliminated.
9146 Triple-downs reduce to double-downs, then to downs,
9147 then are eliminated. */
9148 if (modifiers
& (down_modifier
| drag_modifier
9149 | double_modifier
| triple_modifier
))
9151 while (modifiers
& (down_modifier
| drag_modifier
9152 | double_modifier
| triple_modifier
))
9154 Lisp_Object new_head
, new_click
;
9155 if (modifiers
& triple_modifier
)
9156 modifiers
^= (double_modifier
| triple_modifier
);
9157 else if (modifiers
& double_modifier
)
9158 modifiers
&= ~double_modifier
;
9159 else if (modifiers
& drag_modifier
)
9160 modifiers
&= ~drag_modifier
;
9163 /* Dispose of this `down' event by simply jumping
9164 back to replay_key, to get another event.
9166 Note that if this event came from mock input,
9167 then just jumping back to replay_key will just
9168 hand it to us again. So we have to wipe out any
9171 We could delete keybuf[t] and shift everything
9172 after that to the left by one spot, but we'd also
9173 have to fix up any variable that points into
9174 keybuf, and shifting isn't really necessary
9177 Adding prefixes for non-textual mouse clicks
9178 creates two characters of mock input, and both
9179 must be thrown away. If we're only looking at
9180 the prefix now, we can just jump back to
9181 replay_key. On the other hand, if we've already
9182 processed the prefix, and now the actual click
9183 itself is giving us trouble, then we've lost the
9184 state of the keymaps we want to backtrack to, and
9185 we need to replay the whole sequence to rebuild
9188 Beyond that, only function key expansion could
9189 create more than two keys, but that should never
9190 generate mouse events, so it's okay to zero
9191 mock_input in that case too.
9193 FIXME: The above paragraph seems just plain
9194 wrong, if you consider things like
9195 xterm-mouse-mode. -stef
9197 Isn't this just the most wonderful code ever? */
9199 /* If mock_input > t + 1, the above simplification
9200 will actually end up dropping keys on the floor.
9201 This is probably OK for now, but even
9202 if mock_input <= t + 1, we need to adjust fkey
9204 Typical case [header-line down-mouse-N]:
9205 mock_input = 2, t = 1, fkey.end = 1,
9206 last_real_key_start = 0. */
9207 if (fkey
.end
> last_real_key_start
)
9209 fkey
.end
= fkey
.start
9210 = min (last_real_key_start
, fkey
.start
);
9211 fkey
.map
= fkey
.parent
;
9212 if (keytran
.end
> last_real_key_start
)
9214 keytran
.end
= keytran
.start
9215 = min (last_real_key_start
, keytran
.start
);
9216 keytran
.map
= keytran
.parent
;
9219 if (t
== last_real_key_start
)
9226 mock_input
= last_real_key_start
;
9227 goto replay_sequence
;
9232 = apply_modifiers (modifiers
, XCAR (breakdown
));
9234 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9236 /* Look for a binding for this new key. follow_key
9237 promises that it didn't munge submaps the
9238 last time we called it, since key was unbound. */
9240 = (follow_key (new_click
,
9241 nmaps
- local_first_binding
,
9242 submaps
+ local_first_binding
,
9243 defs
+ local_first_binding
,
9244 submaps
+ local_first_binding
)
9245 + local_first_binding
);
9247 /* If that click is bound, go for it. */
9248 if (first_binding
< nmaps
)
9253 /* Otherwise, we'll leave key set to the drag event. */
9260 /* Normally, last_nonmenu_event gets the previous key we read.
9261 But when a mouse popup menu is being used,
9262 we don't update last_nonmenu_event; it continues to hold the mouse
9263 event that preceded the first level of menu. */
9264 if (!used_mouse_menu
)
9265 last_nonmenu_event
= key
;
9267 /* Record what part of this_command_keys is the current key sequence. */
9268 this_single_command_key_start
= this_command_key_count
- t
;
9270 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9271 /* There is a binding and it's not a prefix.
9272 There is thus no function-key in this sequence.
9273 Moving fkey.start is important in this case to allow keytran.start
9274 to go over the sequence before we return (since we keep the
9275 invariant that keytran.end <= fkey.start). */
9278 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9281 /* If the sequence is unbound, see if we can hang a function key
9282 off the end of it. */
9283 /* Continue scan from fkey.end until we find a bound suffix. */
9284 while (fkey
.end
< t
)
9286 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9289 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9290 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9291 max (t
, mock_input
),
9292 /* If there's a binding (i.e.
9293 first_binding >= nmaps) we don't want
9294 to apply this function-key-mapping. */
9295 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9300 mock_input
= diff
+ max (t
, mock_input
);
9301 goto replay_sequence
;
9305 /* Look for this sequence in key-translation-map.
9306 Scan from keytran.end until we find a bound suffix. */
9307 while (keytran
.end
< fkey
.start
)
9309 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9312 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9313 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9318 mock_input
= diff
+ max (t
, mock_input
);
9319 /* Adjust the function-key-map counters. */
9323 goto replay_sequence
;
9327 /* If KEY is not defined in any of the keymaps,
9328 and cannot be part of a function key or translation,
9329 and is an upper case letter
9330 use the corresponding lower-case letter instead. */
9331 if (first_binding
>= nmaps
9332 && fkey
.start
>= t
&& keytran
.start
>= t
9334 && ((((XINT (key
) & 0x3ffff)
9335 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9336 && UPPERCASEP (XINT (key
) & 0x3ffff))
9337 || (XINT (key
) & shift_modifier
)))
9339 Lisp_Object new_key
;
9341 original_uppercase
= key
;
9342 original_uppercase_position
= t
- 1;
9344 if (XINT (key
) & shift_modifier
)
9345 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9347 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9348 | (XINT (key
) & ~0x3ffff)));
9350 /* We have to do this unconditionally, regardless of whether
9351 the lower-case char is defined in the keymaps, because they
9352 might get translated through function-key-map. */
9353 keybuf
[t
- 1] = new_key
;
9354 mock_input
= max (t
, mock_input
);
9356 goto replay_sequence
;
9358 /* If KEY is not defined in any of the keymaps,
9359 and cannot be part of a function key or translation,
9360 and is a shifted function key,
9361 use the corresponding unshifted function key instead. */
9362 if (first_binding
>= nmaps
9363 && fkey
.start
>= t
&& keytran
.start
>= t
9366 Lisp_Object breakdown
;
9369 breakdown
= parse_modifiers (key
);
9370 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9371 if (modifiers
& shift_modifier
)
9373 Lisp_Object new_key
;
9375 original_uppercase
= key
;
9376 original_uppercase_position
= t
- 1;
9378 modifiers
&= ~shift_modifier
;
9379 new_key
= apply_modifiers (modifiers
,
9382 keybuf
[t
- 1] = new_key
;
9383 mock_input
= max (t
, mock_input
);
9384 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9385 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9387 goto replay_sequence
;
9393 read_key_sequence_cmd
= (first_binding
< nmaps
9394 ? defs
[first_binding
]
9397 unread_switch_frame
= delayed_switch_frame
;
9398 unbind_to (count
, Qnil
);
9400 /* Don't downcase the last character if the caller says don't.
9401 Don't downcase it if the result is undefined, either. */
9402 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9403 && t
- 1 == original_uppercase_position
)
9404 keybuf
[t
- 1] = original_uppercase
;
9406 /* Occasionally we fabricate events, perhaps by expanding something
9407 according to function-key-map, or by adding a prefix symbol to a
9408 mouse click in the scroll bar or modeline. In this cases, return
9409 the entire generated key sequence, even if we hit an unbound
9410 prefix or a definition before the end. This means that you will
9411 be able to push back the event properly, and also means that
9412 read-key-sequence will always return a logical unit.
9415 for (; t
< mock_input
; t
++)
9417 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9418 && NILP (Fzerop (Vecho_keystrokes
)))
9419 echo_char (keybuf
[t
]);
9420 add_command_key (keybuf
[t
]);
9429 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9430 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9431 The sequence is sufficient to specify a non-prefix command in the
9432 current local and global maps.
9434 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9435 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9436 as a continuation of the previous key.
9438 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9439 convert the last event to lower case. (Normally any upper case event
9440 is converted to lower case if the original event is undefined and the lower
9441 case equivalent is defined.) A non-nil value is appropriate for reading
9442 a key sequence to be defined.
9444 A C-g typed while in this function is treated like any other character,
9445 and `quit-flag' is not set.
9447 If the key sequence starts with a mouse click, then the sequence is read
9448 using the keymaps of the buffer of the window clicked in, not the buffer
9449 of the selected window as normal.
9451 `read-key-sequence' drops unbound button-down events, since you normally
9452 only care about the click or drag events which follow them. If a drag
9453 or multi-click event is unbound, but the corresponding click event would
9454 be bound, `read-key-sequence' turns the event into a click event at the
9455 drag's starting position. This means that you don't have to distinguish
9456 between click and drag, double, or triple events unless you want to.
9458 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9459 lines separating windows, and scroll bars with imaginary keys
9460 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9462 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9463 function will process a switch-frame event if the user switches frames
9464 before typing anything. If the user switches frames in the middle of a
9465 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9466 is nil, then the event will be put off until after the current key sequence.
9468 `read-key-sequence' checks `function-key-map' for function key
9469 sequences, where they wouldn't conflict with ordinary bindings. See
9470 `function-key-map' for more details.
9472 The optional fifth argument COMMAND-LOOP, if non-nil, means
9473 that this key sequence is being read by something that will
9474 read commands one after another. It should be nil if the caller
9475 will read just one key sequence. */)
9476 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9478 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9479 Lisp_Object can_return_switch_frame
, command_loop
;
9481 Lisp_Object keybuf
[30];
9483 struct gcpro gcpro1
;
9484 int count
= SPECPDL_INDEX ();
9487 CHECK_STRING (prompt
);
9490 specbind (Qinput_method_exit_on_first_char
,
9491 (NILP (command_loop
) ? Qt
: Qnil
));
9492 specbind (Qinput_method_use_echo_area
,
9493 (NILP (command_loop
) ? Qt
: Qnil
));
9495 bzero (keybuf
, sizeof keybuf
);
9497 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9499 if (NILP (continue_echo
))
9501 this_command_key_count
= 0;
9502 this_command_key_count_reset
= 0;
9503 this_single_command_key_start
= 0;
9506 #ifdef HAVE_X_WINDOWS
9507 if (display_hourglass_p
)
9508 cancel_hourglass ();
9511 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9512 prompt
, ! NILP (dont_downcase_last
),
9513 ! NILP (can_return_switch_frame
), 0);
9515 #if 0 /* The following is fine for code reading a key sequence and
9516 then proceeding with a lenghty computation, but it's not good
9517 for code reading keys in a loop, like an input method. */
9518 #ifdef HAVE_X_WINDOWS
9519 if (display_hourglass_p
)
9530 return unbind_to (count
, make_event_array (i
, keybuf
));
9533 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9534 Sread_key_sequence_vector
, 1, 5, 0,
9535 doc
: /* Like `read-key-sequence' but always return a vector. */)
9536 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9538 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9539 Lisp_Object can_return_switch_frame
, command_loop
;
9541 Lisp_Object keybuf
[30];
9543 struct gcpro gcpro1
;
9544 int count
= SPECPDL_INDEX ();
9547 CHECK_STRING (prompt
);
9550 specbind (Qinput_method_exit_on_first_char
,
9551 (NILP (command_loop
) ? Qt
: Qnil
));
9552 specbind (Qinput_method_use_echo_area
,
9553 (NILP (command_loop
) ? Qt
: Qnil
));
9555 bzero (keybuf
, sizeof keybuf
);
9557 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9559 if (NILP (continue_echo
))
9561 this_command_key_count
= 0;
9562 this_command_key_count_reset
= 0;
9563 this_single_command_key_start
= 0;
9566 #ifdef HAVE_X_WINDOWS
9567 if (display_hourglass_p
)
9568 cancel_hourglass ();
9571 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9572 prompt
, ! NILP (dont_downcase_last
),
9573 ! NILP (can_return_switch_frame
), 0);
9575 #ifdef HAVE_X_WINDOWS
9576 if (display_hourglass_p
)
9586 return unbind_to (count
, Fvector (i
, keybuf
));
9589 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9590 doc
: /* Execute CMD as an editor command.
9591 CMD must be a symbol that satisfies the `commandp' predicate.
9592 Optional second arg RECORD-FLAG non-nil
9593 means unconditionally put this command in `command-history'.
9594 Otherwise, that is done only if an arg is read using the minibuffer.
9595 The argument KEYS specifies the value to use instead of (this-command-keys)
9596 when reading the arguments; if it is nil, (this-command-keys) is used.
9597 The argument SPECIAL, if non-nil, means that this command is executing
9598 a special event, so ignore the prefix argument and don't clear it. */)
9599 (cmd
, record_flag
, keys
, special
)
9600 Lisp_Object cmd
, record_flag
, keys
, special
;
9602 register Lisp_Object final
;
9603 register Lisp_Object tem
;
9604 Lisp_Object prefixarg
;
9605 struct backtrace backtrace
;
9606 extern int debug_on_next_call
;
9608 debug_on_next_call
= 0;
9612 prefixarg
= current_kboard
->Vprefix_arg
;
9613 Vcurrent_prefix_arg
= prefixarg
;
9614 current_kboard
->Vprefix_arg
= Qnil
;
9621 tem
= Fget (cmd
, Qdisabled
);
9622 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9624 tem
= Fsymbol_value (Qdisabled_command_hook
);
9626 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9632 final
= Findirect_function (cmd
);
9634 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9636 struct gcpro gcpro1
, gcpro2
;
9638 GCPRO2 (cmd
, prefixarg
);
9639 do_autoload (final
, cmd
);
9646 if (STRINGP (final
) || VECTORP (final
))
9648 /* If requested, place the macro in the command history. For
9649 other sorts of commands, call-interactively takes care of
9651 if (!NILP (record_flag
))
9654 = Fcons (Fcons (Qexecute_kbd_macro
,
9655 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9658 /* Don't keep command history around forever. */
9659 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9661 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9663 XSETCDR (tem
, Qnil
);
9667 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9670 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9672 backtrace
.next
= backtrace_list
;
9673 backtrace_list
= &backtrace
;
9674 backtrace
.function
= &Qcall_interactively
;
9675 backtrace
.args
= &cmd
;
9676 backtrace
.nargs
= 1;
9677 backtrace
.evalargs
= 0;
9679 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9681 backtrace_list
= backtrace
.next
;
9689 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9691 doc
: /* Read function name, then read its arguments and call it. */)
9693 Lisp_Object prefixarg
;
9695 Lisp_Object function
;
9697 int saved_last_point_position
;
9698 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9699 Lisp_Object bindings
, value
;
9700 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9702 saved_keys
= Fvector (this_command_key_count
,
9703 XVECTOR (this_command_keys
)->contents
);
9704 saved_last_point_position_buffer
= last_point_position_buffer
;
9705 saved_last_point_position
= last_point_position
;
9707 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9709 if (EQ (prefixarg
, Qminus
))
9711 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9712 strcpy (buf
, "C-u ");
9713 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9715 if (sizeof (int) == sizeof (EMACS_INT
))
9716 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9717 else if (sizeof (long) == sizeof (EMACS_INT
))
9718 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9722 else if (INTEGERP (prefixarg
))
9724 if (sizeof (int) == sizeof (EMACS_INT
))
9725 sprintf (buf
, "%d ", XINT (prefixarg
));
9726 else if (sizeof (long) == sizeof (EMACS_INT
))
9727 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9732 /* This isn't strictly correct if execute-extended-command
9733 is bound to anything else. Perhaps it should use
9734 this_command_keys? */
9735 strcat (buf
, "M-x ");
9737 /* Prompt with buf, and then read a string, completing from and
9738 restricting to the set of all defined commands. Don't provide
9739 any initial input. Save the command read on the extended-command
9741 function
= Fcompleting_read (build_string (buf
),
9742 Vobarray
, Qcommandp
,
9743 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9746 if (STRINGP (function
) && SCHARS (function
) == 0)
9747 error ("No command name given");
9749 /* Set this_command_keys to the concatenation of saved_keys and
9750 function, followed by a RET. */
9755 this_command_key_count
= 0;
9756 this_command_key_count_reset
= 0;
9757 this_single_command_key_start
= 0;
9759 keys
= XVECTOR (saved_keys
)->contents
;
9760 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9761 add_command_key (keys
[i
]);
9763 for (i
= 0; i
< SCHARS (function
); i
++)
9764 add_command_key (Faref (function
, make_number (i
)));
9766 add_command_key (make_number ('\015'));
9769 last_point_position
= saved_last_point_position
;
9770 last_point_position_buffer
= saved_last_point_position_buffer
;
9774 function
= Fintern (function
, Qnil
);
9775 current_kboard
->Vprefix_arg
= prefixarg
;
9776 Vthis_command
= function
;
9777 real_this_command
= function
;
9779 /* If enabled, show which key runs this command. */
9780 if (!NILP (Vsuggest_key_bindings
)
9781 && NILP (Vexecuting_macro
)
9782 && SYMBOLP (function
))
9783 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9789 GCPRO2 (bindings
, value
);
9790 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9792 /* If the command has a key binding, print it now. */
9793 if (!NILP (bindings
)
9794 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9797 /* But first wait, and skip the message if there is input. */
9799 if (!NILP (echo_area_buffer
[0]))
9800 /* This command displayed something in the echo area;
9801 so wait a few seconds, then display our suggestion message. */
9802 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9803 ? XINT (Vsuggest_key_bindings
) : 2);
9805 /* This command left the echo area empty,
9806 so display our message immediately. */
9809 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9810 && ! CONSP (Vunread_command_events
))
9812 Lisp_Object binding
;
9814 int message_p
= push_message ();
9815 int count
= SPECPDL_INDEX ();
9817 record_unwind_protect (pop_message_unwind
, Qnil
);
9818 binding
= Fkey_description (bindings
, Qnil
);
9821 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9824 sprintf (newmessage
, "You can run the command `%s' with %s",
9825 SDATA (SYMBOL_NAME (function
)),
9827 message2_nolog (newmessage
,
9828 strlen (newmessage
),
9829 STRING_MULTIBYTE (binding
));
9830 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9831 ? Vsuggest_key_bindings
: make_number (2)),
9836 unbind_to (count
, Qnil
);
9840 RETURN_UNGCPRO (value
);
9844 /* Return nonzero if input events are pending. */
9847 detect_input_pending ()
9850 get_input_pending (&input_pending
, 0);
9852 return input_pending
;
9855 /* Return nonzero if input events are pending, and run any pending timers. */
9858 detect_input_pending_run_timers (do_display
)
9861 int old_timers_run
= timers_run
;
9864 get_input_pending (&input_pending
, 1);
9866 if (old_timers_run
!= timers_run
&& do_display
)
9868 redisplay_preserve_echo_area (8);
9869 /* The following fixes a bug when using lazy-lock with
9870 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9871 from an idle timer function. The symptom of the bug is that
9872 the cursor sometimes doesn't become visible until the next X
9873 event is processed. --gerd. */
9875 rif
->flush_display (NULL
);
9878 return input_pending
;
9881 /* This is called in some cases before a possible quit.
9882 It cases the next call to detect_input_pending to recompute input_pending.
9883 So calling this function unnecessarily can't do any harm. */
9886 clear_input_pending ()
9891 /* Return nonzero if there are pending requeued events.
9892 This isn't used yet. The hope is to make wait_reading_process_input
9893 call it, and return if it runs Lisp code that unreads something.
9894 The problem is, kbd_buffer_get_event needs to be fixed to know what
9895 to do in that case. It isn't trivial. */
9898 requeued_events_pending_p ()
9900 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9904 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9905 doc
: /* Return t if command input is currently available with no wait.
9906 Actually, the value is nil only if we can be sure that no input is available;
9907 if there is a doubt, the value is t. */)
9910 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9913 get_filtered_input_pending (&input_pending
, 1, 1);
9914 return input_pending
> 0 ? Qt
: Qnil
;
9917 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9918 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9921 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9924 if (total_keys
< NUM_RECENT_KEYS
)
9925 return Fvector (total_keys
, keys
);
9928 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9929 bcopy (keys
+ recent_keys_index
,
9930 XVECTOR (val
)->contents
,
9931 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9933 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9934 recent_keys_index
* sizeof (Lisp_Object
));
9939 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9940 doc
: /* Return the key sequence that invoked this command.
9941 However, if the command has called `read-key-sequence', it returns
9942 the last key sequence that has been read.
9943 The value is a string or a vector. */)
9946 return make_event_array (this_command_key_count
,
9947 XVECTOR (this_command_keys
)->contents
);
9950 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9951 doc
: /* Return the key sequence that invoked this command, as a vector.
9952 However, if the command has called `read-key-sequence', it returns
9953 the last key sequence that has been read. */)
9956 return Fvector (this_command_key_count
,
9957 XVECTOR (this_command_keys
)->contents
);
9960 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9961 Sthis_single_command_keys
, 0, 0, 0,
9962 doc
: /* Return the key sequence that invoked this command.
9963 More generally, it returns the last key sequence read, either by
9964 the command loop or by `read-key-sequence'.
9965 Unlike `this-command-keys', this function's value
9966 does not include prefix arguments.
9967 The value is always a vector. */)
9970 return Fvector (this_command_key_count
9971 - this_single_command_key_start
,
9972 (XVECTOR (this_command_keys
)->contents
9973 + this_single_command_key_start
));
9976 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9977 Sthis_single_command_raw_keys
, 0, 0, 0,
9978 doc
: /* Return the raw events that were read for this command.
9979 More generally, it returns the last key sequence read, either by
9980 the command loop or by `read-key-sequence'.
9981 Unlike `this-single-command-keys', this function's value
9982 shows the events before all translations (except for input methods).
9983 The value is always a vector. */)
9986 return Fvector (raw_keybuf_count
,
9987 (XVECTOR (raw_keybuf
)->contents
));
9990 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9991 Sreset_this_command_lengths
, 0, 0, 0,
9992 doc
: /* Make the unread events replace the last command and echo.
9993 Used in `universal-argument-other-key'.
9995 `universal-argument-other-key' rereads the event just typed.
9996 It then gets translated through `function-key-map'.
9997 The translated event has to replace the real events,
9998 both in the value of (this-command-keys) and in echoing.
9999 To achieve this, `universal-argument-other-key' calls
10000 `reset-this-command-lengths', which discards the record of reading
10001 these events the first time. */)
10004 this_command_key_count
= before_command_key_count
;
10005 if (this_command_key_count
< this_single_command_key_start
)
10006 this_single_command_key_start
= this_command_key_count
;
10008 echo_truncate (before_command_echo_length
);
10010 /* Cause whatever we put into unread-command-events
10011 to echo as if it were being freshly read from the keyboard. */
10012 this_command_key_count_reset
= 1;
10017 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10018 Sclear_this_command_keys
, 0, 1, 0,
10019 doc
: /* Clear out the vector that `this-command-keys' returns.
10020 Also clear the record of the last 100 events, unless optional arg
10021 KEEP-RECORD is non-nil. */)
10023 Lisp_Object keep_record
;
10027 this_command_key_count
= 0;
10028 this_command_key_count_reset
= 0;
10030 if (NILP (keep_record
))
10032 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10033 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10035 recent_keys_index
= 0;
10040 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10041 doc
: /* Return the current depth in recursive edits. */)
10045 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10049 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10050 "FOpen dribble file: ",
10051 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10052 If FILE is nil, close any open dribble file. */)
10063 file
= Fexpand_file_name (file
, Qnil
);
10064 dribble
= fopen (SDATA (file
), "w");
10066 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10071 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10072 doc
: /* Discard the contents of the terminal input buffer.
10073 Also end any kbd macro being defined. */)
10076 if (!NILP (current_kboard
->defining_kbd_macro
))
10078 /* Discard the last command from the macro. */
10079 Fcancel_kbd_macro_events ();
10083 update_mode_lines
++;
10085 Vunread_command_events
= Qnil
;
10086 unread_command_char
= -1;
10088 discard_tty_input ();
10090 kbd_fetch_ptr
= kbd_store_ptr
;
10096 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10097 doc
: /* Stop Emacs and return to superior process. You can resume later.
10098 If `cannot-suspend' is non-nil, or if the system doesn't support job
10099 control, run a subshell instead.
10101 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10102 to be read as terminal input by Emacs's parent, after suspension.
10104 Before suspending, run the normal hook `suspend-hook'.
10105 After resumption run the normal hook `suspend-resume-hook'.
10107 Some operating systems cannot stop the Emacs process and resume it later.
10108 On such systems, Emacs starts a subshell instead of suspending. */)
10110 Lisp_Object stuffstring
;
10112 int count
= SPECPDL_INDEX ();
10113 int old_height
, old_width
;
10115 struct gcpro gcpro1
;
10117 if (!NILP (stuffstring
))
10118 CHECK_STRING (stuffstring
);
10120 /* Run the functions in suspend-hook. */
10121 if (!NILP (Vrun_hooks
))
10122 call1 (Vrun_hooks
, intern ("suspend-hook"));
10124 GCPRO1 (stuffstring
);
10125 get_frame_size (&old_width
, &old_height
);
10126 reset_sys_modes ();
10127 /* sys_suspend can get an error if it tries to fork a subshell
10128 and the system resources aren't available for that. */
10129 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10131 stuff_buffered_input (stuffstring
);
10132 if (cannot_suspend
)
10136 unbind_to (count
, Qnil
);
10138 /* Check if terminal/window size has changed.
10139 Note that this is not useful when we are running directly
10140 with a window system; but suspend should be disabled in that case. */
10141 get_frame_size (&width
, &height
);
10142 if (width
!= old_width
|| height
!= old_height
)
10143 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10145 /* Run suspend-resume-hook. */
10146 if (!NILP (Vrun_hooks
))
10147 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10153 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10154 Then in any case stuff anything Emacs has read ahead and not used. */
10157 stuff_buffered_input (stuffstring
)
10158 Lisp_Object stuffstring
;
10160 /* stuff_char works only in BSD, versions 4.2 and up. */
10163 register unsigned char *p
;
10165 if (STRINGP (stuffstring
))
10167 register int count
;
10169 p
= SDATA (stuffstring
);
10170 count
= SBYTES (stuffstring
);
10171 while (count
-- > 0)
10176 /* Anything we have read ahead, put back for the shell to read. */
10177 /* ?? What should this do when we have multiple keyboards??
10178 Should we ignore anything that was typed in at the "wrong" kboard? */
10179 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10182 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10183 kbd_fetch_ptr
= kbd_buffer
;
10184 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10185 stuff_char (kbd_fetch_ptr
->code
);
10187 clear_event (kbd_fetch_ptr
);
10192 #endif /* BSD_SYSTEM and not BSD4_1 */
10196 set_waiting_for_input (time_to_clear
)
10197 EMACS_TIME
*time_to_clear
;
10199 input_available_clear_time
= time_to_clear
;
10201 /* Tell interrupt_signal to throw back to read_char, */
10202 waiting_for_input
= 1;
10204 /* If interrupt_signal was called before and buffered a C-g,
10205 make it run again now, to avoid timing error. */
10206 if (!NILP (Vquit_flag
))
10207 quit_throw_to_read_char ();
10211 clear_waiting_for_input ()
10213 /* Tell interrupt_signal not to throw back to read_char, */
10214 waiting_for_input
= 0;
10215 input_available_clear_time
= 0;
10218 /* This routine is called at interrupt level in response to C-g.
10220 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10221 is called from kbd_buffer_store_event, in handling SIGIO or
10224 If `waiting_for_input' is non zero, then unless `echoing' is
10225 nonzero, immediately throw back to read_char.
10227 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10228 eval to throw, when it gets a chance. If quit-flag is already
10229 non-nil, it stops the job right away. */
10232 interrupt_signal (signalnum
) /* If we don't have an argument, */
10233 int signalnum
; /* some compilers complain in signal calls. */
10236 /* Must preserve main program's value of errno. */
10237 int old_errno
= errno
;
10238 struct frame
*sf
= SELECTED_FRAME ();
10240 #if defined (USG) && !defined (POSIX_SIGNALS)
10241 if (!read_socket_hook
&& NILP (Vwindow_system
))
10243 /* USG systems forget handlers when they are used;
10244 must reestablish each time */
10245 signal (SIGINT
, interrupt_signal
);
10246 signal (SIGQUIT
, interrupt_signal
);
10252 if (!NILP (Vquit_flag
)
10253 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10255 /* If SIGINT isn't blocked, don't let us be interrupted by
10256 another SIGINT, it might be harmful due to non-reentrancy
10257 in I/O functions. */
10258 sigblock (sigmask (SIGINT
));
10261 reset_sys_modes ();
10263 #ifdef SIGTSTP /* Support possible in later USG versions */
10265 * On systems which can suspend the current process and return to the original
10266 * shell, this command causes the user to end up back at the shell.
10267 * The "Auto-save" and "Abort" questions are not asked until
10268 * the user elects to return to emacs, at which point he can save the current
10269 * job and either dump core or continue.
10274 if (sys_suspend () == -1)
10276 printf ("Not running as a subprocess;\n");
10277 printf ("you can continue or abort.\n");
10279 #else /* not VMS */
10280 /* Perhaps should really fork an inferior shell?
10281 But that would not provide any way to get back
10282 to the original shell, ever. */
10283 printf ("No support for stopping a process on this operating system;\n");
10284 printf ("you can continue or abort.\n");
10285 #endif /* not VMS */
10286 #endif /* not SIGTSTP */
10288 /* We must remain inside the screen area when the internal terminal
10289 is used. Note that [Enter] is not echoed by dos. */
10292 /* It doesn't work to autosave while GC is in progress;
10293 the code used for auto-saving doesn't cope with the mark bit. */
10294 if (!gc_in_progress
)
10296 printf ("Auto-save? (y or n) ");
10298 if (((c
= getchar ()) & ~040) == 'Y')
10300 Fdo_auto_save (Qt
, Qnil
);
10302 printf ("\r\nAuto-save done");
10303 #else /* not MSDOS */
10304 printf ("Auto-save done\n");
10305 #endif /* not MSDOS */
10307 while (c
!= '\n') c
= getchar ();
10311 /* During GC, it must be safe to reenable quitting again. */
10312 Vinhibit_quit
= Qnil
;
10315 #endif /* not MSDOS */
10316 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10317 printf ("but will instead do a real quit after garbage collection ends\r\n");
10322 printf ("\r\nAbort? (y or n) ");
10323 #else /* not MSDOS */
10325 printf ("Abort (and enter debugger)? (y or n) ");
10326 #else /* not VMS */
10327 printf ("Abort (and dump core)? (y or n) ");
10328 #endif /* not VMS */
10329 #endif /* not MSDOS */
10331 if (((c
= getchar ()) & ~040) == 'Y')
10333 while (c
!= '\n') c
= getchar ();
10335 printf ("\r\nContinuing...\r\n");
10336 #else /* not MSDOS */
10337 printf ("Continuing...\n");
10338 #endif /* not MSDOS */
10345 /* If executing a function that wants to be interrupted out of
10346 and the user has not deferred quitting by binding `inhibit-quit'
10347 then quit right away. */
10348 if (immediate_quit
&& NILP (Vinhibit_quit
))
10350 struct gl_state_s saved
;
10351 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10353 immediate_quit
= 0;
10356 GCPRO4 (saved
.object
, saved
.global_code
,
10357 saved
.current_syntax_table
, saved
.old_prop
);
10358 Fsignal (Qquit
, Qnil
);
10363 /* Else request quit when it's safe */
10367 if (waiting_for_input
&& !echoing
)
10368 quit_throw_to_read_char ();
10373 /* Handle a C-g by making read_char return C-g. */
10376 quit_throw_to_read_char ()
10379 /* Prevent another signal from doing this before we finish. */
10380 clear_waiting_for_input ();
10383 Vunread_command_events
= Qnil
;
10384 unread_command_char
= -1;
10386 #if 0 /* Currently, sit_for is called from read_char without turning
10387 off polling. And that can call set_waiting_for_input.
10388 It seems to be harmless. */
10389 #ifdef POLL_FOR_INPUT
10390 /* May be > 1 if in recursive minibuffer. */
10391 if (poll_suppress_count
== 0)
10395 if (FRAMEP (internal_last_event_frame
)
10396 && !EQ (internal_last_event_frame
, selected_frame
))
10397 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10400 _longjmp (getcjmp
, 1);
10403 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10404 doc
: /* Set mode of reading keyboard input.
10405 First arg INTERRUPT non-nil means use input interrupts;
10406 nil means use CBREAK mode.
10407 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10408 (no effect except in CBREAK mode).
10409 Third arg META t means accept 8-bit input (for a Meta key).
10410 META nil means ignore the top bit, on the assumption it is parity.
10411 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10412 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10413 See also `current-input-mode'. */)
10414 (interrupt
, flow
, meta
, quit
)
10415 Lisp_Object interrupt
, flow
, meta
, quit
;
10418 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10419 error ("set-input-mode: QUIT must be an ASCII character");
10421 #ifdef POLL_FOR_INPUT
10426 /* this causes startup screen to be restored and messes with the mouse */
10427 reset_sys_modes ();
10431 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10432 if (read_socket_hook
)
10434 /* When using X, don't give the user a real choice,
10435 because we haven't implemented the mechanisms to support it. */
10436 #ifdef NO_SOCK_SIGIO
10437 interrupt_input
= 0;
10438 #else /* not NO_SOCK_SIGIO */
10439 interrupt_input
= 1;
10440 #endif /* NO_SOCK_SIGIO */
10443 interrupt_input
= !NILP (interrupt
);
10444 #else /* not SIGIO */
10445 interrupt_input
= 0;
10446 #endif /* not SIGIO */
10448 /* Our VMS input only works by interrupts, as of now. */
10450 interrupt_input
= 1;
10453 flow_control
= !NILP (flow
);
10456 else if (EQ (meta
, Qt
))
10461 /* Don't let this value be out of range. */
10462 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10468 #ifdef POLL_FOR_INPUT
10469 poll_suppress_count
= 1;
10475 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10476 doc
: /* Return information about the way Emacs currently reads keyboard input.
10477 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10478 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10479 nil, Emacs is using CBREAK mode.
10480 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10481 terminal; this does not apply if Emacs uses interrupt-driven input.
10482 META is t if accepting 8-bit input with 8th bit as Meta flag.
10483 META nil means ignoring the top bit, on the assumption it is parity.
10484 META is neither t nor nil if accepting 8-bit input and using
10485 all 8 bits as the character code.
10486 QUIT is the character Emacs currently uses to quit.
10487 The elements of this list correspond to the arguments of
10488 `set-input-mode'. */)
10491 Lisp_Object val
[4];
10493 val
[0] = interrupt_input
? Qt
: Qnil
;
10494 val
[1] = flow_control
? Qt
: Qnil
;
10495 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10496 XSETFASTINT (val
[3], quit_char
);
10498 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10501 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 3, 0,
10502 doc
: /* Return position information for pixel coordinates X and Y.
10503 By default, X and Y are relative to text area of the selected window.
10504 Optional third arg FRAME_OR_WINDOW non-nil specifies frame or window.
10506 The return value is similar to a mouse click position:
10507 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10508 IMAGE (DX . DY) (WIDTH . HEIGHT))
10509 The `posn-' functions access elements of such lists. */)
10510 (x
, y
, frame_or_window
)
10511 Lisp_Object x
, y
, frame_or_window
;
10513 if (NILP (frame_or_window
))
10514 frame_or_window
= selected_window
;
10516 if (WINDOWP (frame_or_window
))
10520 CHECK_LIVE_WINDOW (frame_or_window
);
10522 w
= XWINDOW (frame_or_window
);
10523 XSETINT (x
, (WINDOW_TO_FRAME_PIXEL_X (w
, XINT (x
))
10524 + window_box_left_offset (w
, TEXT_AREA
)));
10525 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10526 frame_or_window
= w
->frame
;
10529 CHECK_LIVE_FRAME (frame_or_window
);
10531 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10534 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10535 doc
: /* Return position information for buffer POS in WINDOW.
10536 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10538 Return nil if position is not visible in window. Otherwise,
10539 the return value is similar to that returned by event-start for
10540 a mouse click at the upper left corner of the glyph corresponding
10541 to the given buffer position:
10542 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10543 IMAGE (DX . DY) (WIDTH . HEIGHT))
10544 The `posn-' functions access elements of such lists. */*/
)
10546 Lisp_Object pos
, window
;
10550 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10552 tem
= Fposn_at_x_y (XCAR (tem
), XCAR (XCDR (tem
)), window
);
10558 * Set up a new kboard object with reasonable initial values.
10564 kb
->Voverriding_terminal_local_map
= Qnil
;
10565 kb
->Vlast_command
= Qnil
;
10566 kb
->Vreal_last_command
= Qnil
;
10567 kb
->Vprefix_arg
= Qnil
;
10568 kb
->Vlast_prefix_arg
= Qnil
;
10569 kb
->kbd_queue
= Qnil
;
10570 kb
->kbd_queue_has_data
= 0;
10571 kb
->immediate_echo
= 0;
10572 kb
->echo_string
= Qnil
;
10573 kb
->echo_after_prompt
= -1;
10574 kb
->kbd_macro_buffer
= 0;
10575 kb
->kbd_macro_bufsize
= 0;
10576 kb
->defining_kbd_macro
= Qnil
;
10577 kb
->Vlast_kbd_macro
= Qnil
;
10578 kb
->reference_count
= 0;
10579 kb
->Vsystem_key_alist
= Qnil
;
10580 kb
->system_key_syms
= Qnil
;
10581 kb
->Vdefault_minibuffer_frame
= Qnil
;
10585 * Destroy the contents of a kboard object, but not the object itself.
10586 * We use this just before deleting it, or if we're going to initialize
10587 * it a second time.
10593 if (kb
->kbd_macro_buffer
)
10594 xfree (kb
->kbd_macro_buffer
);
10597 #ifdef MULTI_KBOARD
10599 /* Free KB and memory referenced from it. */
10607 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10610 *kbp
= kb
->next_kboard
;
10612 /* Prevent a dangling reference to KB. */
10613 if (kb
== current_kboard
10614 && FRAMEP (selected_frame
)
10615 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10617 current_kboard
= XFRAME (selected_frame
)->kboard
;
10618 if (current_kboard
== kb
)
10626 #endif /* MULTI_KBOARD */
10631 /* This is correct before outermost invocation of the editor loop */
10632 command_loop_level
= -1;
10633 immediate_quit
= 0;
10634 quit_char
= Ctl ('g');
10635 Vunread_command_events
= Qnil
;
10636 unread_command_char
= -1;
10637 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10639 recent_keys_index
= 0;
10640 kbd_fetch_ptr
= kbd_buffer
;
10641 kbd_store_ptr
= kbd_buffer
;
10643 do_mouse_tracking
= Qnil
;
10647 /* This means that command_loop_1 won't try to select anything the first
10649 internal_last_event_frame
= Qnil
;
10650 Vlast_event_frame
= internal_last_event_frame
;
10652 #ifdef MULTI_KBOARD
10653 current_kboard
= initial_kboard
;
10655 wipe_kboard (current_kboard
);
10656 init_kboard (current_kboard
);
10658 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10660 signal (SIGINT
, interrupt_signal
);
10661 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10662 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10663 SIGQUIT and we can't tell which one it will give us. */
10664 signal (SIGQUIT
, interrupt_signal
);
10665 #endif /* HAVE_TERMIO */
10667 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10669 if (!noninteractive
)
10670 signal (SIGIO
, input_available_signal
);
10673 /* Use interrupt input by default, if it works and noninterrupt input
10674 has deficiencies. */
10676 #ifdef INTERRUPT_INPUT
10677 interrupt_input
= 1;
10679 interrupt_input
= 0;
10682 /* Our VMS input only works by interrupts, as of now. */
10684 interrupt_input
= 1;
10690 if (keyboard_init_hook
)
10691 (*keyboard_init_hook
) ();
10693 #ifdef POLL_FOR_INPUT
10694 poll_suppress_count
= 1;
10699 /* At least provide an escape route since C-g doesn't work. */
10700 signal (SIGINT
, interrupt_signal
);
10704 /* This type's only use is in syms_of_keyboard, to initialize the
10705 event header symbols and put properties on them. */
10706 struct event_head
{
10712 struct event_head head_table
[] = {
10713 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10714 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10715 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10716 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10717 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10718 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10719 /* `select-window' should be handled just like `switch-frame'
10720 in read_key_sequence. */
10721 {&Qselect_window
, "select-window", &Qswitch_frame
}
10725 syms_of_keyboard ()
10727 Vpre_help_message
= Qnil
;
10728 staticpro (&Vpre_help_message
);
10730 Vlispy_mouse_stem
= build_string ("mouse");
10731 staticpro (&Vlispy_mouse_stem
);
10734 QCimage
= intern (":image");
10735 staticpro (&QCimage
);
10737 staticpro (&Qhelp_echo
);
10738 Qhelp_echo
= intern ("help-echo");
10740 staticpro (&item_properties
);
10741 item_properties
= Qnil
;
10743 staticpro (&tool_bar_item_properties
);
10744 tool_bar_item_properties
= Qnil
;
10745 staticpro (&tool_bar_items_vector
);
10746 tool_bar_items_vector
= Qnil
;
10748 staticpro (&real_this_command
);
10749 real_this_command
= Qnil
;
10751 Qtimer_event_handler
= intern ("timer-event-handler");
10752 staticpro (&Qtimer_event_handler
);
10754 Qdisabled_command_hook
= intern ("disabled-command-hook");
10755 staticpro (&Qdisabled_command_hook
);
10757 Qself_insert_command
= intern ("self-insert-command");
10758 staticpro (&Qself_insert_command
);
10760 Qforward_char
= intern ("forward-char");
10761 staticpro (&Qforward_char
);
10763 Qbackward_char
= intern ("backward-char");
10764 staticpro (&Qbackward_char
);
10766 Qdisabled
= intern ("disabled");
10767 staticpro (&Qdisabled
);
10769 Qundefined
= intern ("undefined");
10770 staticpro (&Qundefined
);
10772 Qpre_command_hook
= intern ("pre-command-hook");
10773 staticpro (&Qpre_command_hook
);
10775 Qpost_command_hook
= intern ("post-command-hook");
10776 staticpro (&Qpost_command_hook
);
10778 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10779 staticpro (&Qpost_command_idle_hook
);
10781 Qdeferred_action_function
= intern ("deferred-action-function");
10782 staticpro (&Qdeferred_action_function
);
10784 Qcommand_hook_internal
= intern ("command-hook-internal");
10785 staticpro (&Qcommand_hook_internal
);
10787 Qfunction_key
= intern ("function-key");
10788 staticpro (&Qfunction_key
);
10789 Qmouse_click
= intern ("mouse-click");
10790 staticpro (&Qmouse_click
);
10792 Qlanguage_change
= intern ("language-change");
10793 staticpro (&Qlanguage_change
);
10795 Qdrag_n_drop
= intern ("drag-n-drop");
10796 staticpro (&Qdrag_n_drop
);
10798 Qsave_session
= intern ("save-session");
10799 staticpro(&Qsave_session
);
10801 Qusr1_signal
= intern ("usr1-signal");
10802 staticpro (&Qusr1_signal
);
10803 Qusr2_signal
= intern ("usr2-signal");
10804 staticpro (&Qusr2_signal
);
10806 Qmenu_enable
= intern ("menu-enable");
10807 staticpro (&Qmenu_enable
);
10808 Qmenu_alias
= intern ("menu-alias");
10809 staticpro (&Qmenu_alias
);
10810 QCenable
= intern (":enable");
10811 staticpro (&QCenable
);
10812 QCvisible
= intern (":visible");
10813 staticpro (&QCvisible
);
10814 QChelp
= intern (":help");
10815 staticpro (&QChelp
);
10816 QCfilter
= intern (":filter");
10817 staticpro (&QCfilter
);
10818 QCbutton
= intern (":button");
10819 staticpro (&QCbutton
);
10820 QCkeys
= intern (":keys");
10821 staticpro (&QCkeys
);
10822 QCkey_sequence
= intern (":key-sequence");
10823 staticpro (&QCkey_sequence
);
10824 QCtoggle
= intern (":toggle");
10825 staticpro (&QCtoggle
);
10826 QCradio
= intern (":radio");
10827 staticpro (&QCradio
);
10829 Qmode_line
= intern ("mode-line");
10830 staticpro (&Qmode_line
);
10831 Qvertical_line
= intern ("vertical-line");
10832 staticpro (&Qvertical_line
);
10833 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10834 staticpro (&Qvertical_scroll_bar
);
10835 Qmenu_bar
= intern ("menu-bar");
10836 staticpro (&Qmenu_bar
);
10838 Qabove_handle
= intern ("above-handle");
10839 staticpro (&Qabove_handle
);
10840 Qhandle
= intern ("handle");
10841 staticpro (&Qhandle
);
10842 Qbelow_handle
= intern ("below-handle");
10843 staticpro (&Qbelow_handle
);
10844 Qup
= intern ("up");
10846 Qdown
= intern ("down");
10847 staticpro (&Qdown
);
10848 Qtop
= intern ("top");
10850 Qbottom
= intern ("bottom");
10851 staticpro (&Qbottom
);
10852 Qend_scroll
= intern ("end-scroll");
10853 staticpro (&Qend_scroll
);
10854 Qratio
= intern ("ratio");
10855 staticpro (&Qratio
);
10857 Qevent_kind
= intern ("event-kind");
10858 staticpro (&Qevent_kind
);
10859 Qevent_symbol_elements
= intern ("event-symbol-elements");
10860 staticpro (&Qevent_symbol_elements
);
10861 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10862 staticpro (&Qevent_symbol_element_mask
);
10863 Qmodifier_cache
= intern ("modifier-cache");
10864 staticpro (&Qmodifier_cache
);
10866 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10867 staticpro (&Qrecompute_lucid_menubar
);
10868 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10869 staticpro (&Qactivate_menubar_hook
);
10871 Qpolling_period
= intern ("polling-period");
10872 staticpro (&Qpolling_period
);
10874 Qinput_method_function
= intern ("input-method-function");
10875 staticpro (&Qinput_method_function
);
10877 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10878 staticpro (&Qinput_method_exit_on_first_char
);
10879 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10880 staticpro (&Qinput_method_use_echo_area
);
10882 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10883 Fset (Qinput_method_use_echo_area
, Qnil
);
10885 last_point_position_buffer
= Qnil
;
10888 struct event_head
*p
;
10890 for (p
= head_table
;
10891 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10894 *p
->var
= intern (p
->name
);
10895 staticpro (p
->var
);
10896 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10897 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10901 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10902 staticpro (&button_down_location
);
10903 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10904 staticpro (&mouse_syms
);
10905 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
10906 staticpro (&wheel_syms
);
10910 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10912 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10913 for (i
= 0; i
< len
; i
++)
10914 if (modifier_names
[i
])
10915 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10916 staticpro (&modifier_symbols
);
10919 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10920 staticpro (&recent_keys
);
10922 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10923 staticpro (&this_command_keys
);
10925 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10926 staticpro (&raw_keybuf
);
10928 Qextended_command_history
= intern ("extended-command-history");
10929 Fset (Qextended_command_history
, Qnil
);
10930 staticpro (&Qextended_command_history
);
10932 accent_key_syms
= Qnil
;
10933 staticpro (&accent_key_syms
);
10935 func_key_syms
= Qnil
;
10936 staticpro (&func_key_syms
);
10938 drag_n_drop_syms
= Qnil
;
10939 staticpro (&drag_n_drop_syms
);
10941 unread_switch_frame
= Qnil
;
10942 staticpro (&unread_switch_frame
);
10944 internal_last_event_frame
= Qnil
;
10945 staticpro (&internal_last_event_frame
);
10947 read_key_sequence_cmd
= Qnil
;
10948 staticpro (&read_key_sequence_cmd
);
10950 menu_bar_one_keymap_changed_items
= Qnil
;
10951 staticpro (&menu_bar_one_keymap_changed_items
);
10953 defsubr (&Sevent_convert_list
);
10954 defsubr (&Sread_key_sequence
);
10955 defsubr (&Sread_key_sequence_vector
);
10956 defsubr (&Srecursive_edit
);
10958 defsubr (&Strack_mouse
);
10960 defsubr (&Sinput_pending_p
);
10961 defsubr (&Scommand_execute
);
10962 defsubr (&Srecent_keys
);
10963 defsubr (&Sthis_command_keys
);
10964 defsubr (&Sthis_command_keys_vector
);
10965 defsubr (&Sthis_single_command_keys
);
10966 defsubr (&Sthis_single_command_raw_keys
);
10967 defsubr (&Sreset_this_command_lengths
);
10968 defsubr (&Sclear_this_command_keys
);
10969 defsubr (&Ssuspend_emacs
);
10970 defsubr (&Sabort_recursive_edit
);
10971 defsubr (&Sexit_recursive_edit
);
10972 defsubr (&Srecursion_depth
);
10973 defsubr (&Stop_level
);
10974 defsubr (&Sdiscard_input
);
10975 defsubr (&Sopen_dribble_file
);
10976 defsubr (&Sset_input_mode
);
10977 defsubr (&Scurrent_input_mode
);
10978 defsubr (&Sexecute_extended_command
);
10979 defsubr (&Sposn_at_point
);
10980 defsubr (&Sposn_at_x_y
);
10982 DEFVAR_LISP ("last-command-char", &last_command_char
,
10983 doc
: /* Last input event that was part of a command. */);
10985 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10986 doc
: /* Last input event that was part of a command. */);
10988 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10989 doc
: /* Last input event in a command, except for mouse menu events.
10990 Mouse menus give back keys that don't look like mouse events;
10991 this variable holds the actual mouse event that led to the menu,
10992 so that you can determine whether the command was run by mouse or not. */);
10994 DEFVAR_LISP ("last-input-char", &last_input_char
,
10995 doc
: /* Last input event. */);
10997 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10998 doc
: /* Last input event. */);
11000 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11001 doc
: /* List of events to be read as the command input.
11002 These events are processed first, before actual keyboard input. */);
11003 Vunread_command_events
= Qnil
;
11005 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11006 doc
: /* If not -1, an object to be read as next command input event. */);
11008 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11009 doc
: /* List of events to be processed as input by input methods.
11010 These events are processed after `unread-command-events', but
11011 before actual keyboard input. */);
11012 Vunread_post_input_method_events
= Qnil
;
11014 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11015 doc
: /* List of events to be processed as input by input methods.
11016 These events are processed after `unread-command-events', but
11017 before actual keyboard input. */);
11018 Vunread_input_method_events
= Qnil
;
11020 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11021 doc
: /* Meta-prefix character code.
11022 Meta-foo as command input turns into this character followed by foo. */);
11023 XSETINT (meta_prefix_char
, 033);
11025 DEFVAR_KBOARD ("last-command", Vlast_command
,
11026 doc
: /* The last command executed.
11027 Normally a symbol with a function definition, but can be whatever was found
11028 in the keymap, or whatever the variable `this-command' was set to by that
11031 The value `mode-exit' is special; it means that the previous command
11032 read an event that told it to exit, and it did so and unread that event.
11033 In other words, the present command is the event that made the previous
11036 The value `kill-region' is special; it means that the previous command
11037 was a kill command. */);
11039 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11040 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11042 DEFVAR_LISP ("this-command", &Vthis_command
,
11043 doc
: /* The command now being executed.
11044 The command can set this variable; whatever is put here
11045 will be in `last-command' during the following command. */);
11046 Vthis_command
= Qnil
;
11048 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11049 doc
: /* The command bound to the current key sequence before remapping.
11050 It equals `this-command' if the original command was not remapped through
11051 any of the active keymaps. Otherwise, the value of `this-command' is the
11052 result of looking up the original command in the active keymaps. */);
11053 Vthis_original_command
= Qnil
;
11055 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11056 doc
: /* *Number of input events between auto-saves.
11057 Zero means disable autosaving due to number of characters typed. */);
11058 auto_save_interval
= 300;
11060 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11061 doc
: /* *Number of seconds idle time before auto-save.
11062 Zero or nil means disable auto-saving due to idleness.
11063 After auto-saving due to this many seconds of idle time,
11064 Emacs also does a garbage collection if that seems to be warranted. */);
11065 XSETFASTINT (Vauto_save_timeout
, 30);
11067 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11068 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11069 The value may be integer or floating point. */);
11070 Vecho_keystrokes
= make_number (1);
11072 DEFVAR_INT ("polling-period", &polling_period
,
11073 doc
: /* *Interval between polling for input during Lisp execution.
11074 The reason for polling is to make C-g work to stop a running program.
11075 Polling is needed only when using X windows and SIGIO does not work.
11076 Polling is automatically disabled in all other cases. */);
11077 polling_period
= 2;
11079 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11080 doc
: /* *Maximum time between mouse clicks to make a double-click.
11081 Measured in milliseconds. nil means disable double-click recognition;
11082 t means double-clicks have no time limit and are detected
11083 by position only. */);
11084 Vdouble_click_time
= make_number (500);
11086 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11087 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11088 On window-system frames, value is the number of pixels the mouse may have
11089 moved horizontally or vertically between two clicks to make a double-click.
11090 On non window-system frames, value is interpreted in units of 1/8 characters
11093 This variable is also the threshold for motion of the mouse
11094 to count as a drag. */);
11095 double_click_fuzz
= 3;
11097 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11098 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11099 inhibit_local_menu_bar_menus
= 0;
11101 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11102 doc
: /* Number of complete key sequences read as input so far.
11103 This includes key sequences read from keyboard macros.
11104 The number is effectively the number of interactive command invocations. */);
11105 num_input_keys
= 0;
11107 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11108 doc
: /* Number of input events read from the keyboard so far.
11109 This does not include events generated by keyboard macros. */);
11110 num_nonmacro_input_events
= 0;
11112 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11113 doc
: /* The frame in which the most recently read event occurred.
11114 If the last event came from a keyboard macro, this is set to `macro'. */);
11115 Vlast_event_frame
= Qnil
;
11117 /* This variable is set up in sysdep.c. */
11118 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11119 doc
: /* The ERASE character as set by the user with stty. */);
11121 DEFVAR_LISP ("help-char", &Vhelp_char
,
11122 doc
: /* Character to recognize as meaning Help.
11123 When it is read, do `(eval help-form)', and display result if it's a string.
11124 If the value of `help-form' is nil, this char can be read normally. */);
11125 XSETINT (Vhelp_char
, Ctl ('H'));
11127 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11128 doc
: /* List of input events to recognize as meaning Help.
11129 These work just like the value of `help-char' (see that). */);
11130 Vhelp_event_list
= Qnil
;
11132 DEFVAR_LISP ("help-form", &Vhelp_form
,
11133 doc
: /* Form to execute when character `help-char' is read.
11134 If the form returns a string, that string is displayed.
11135 If `help-form' is nil, the help char is not recognized. */);
11138 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11139 doc
: /* Command to run when `help-char' character follows a prefix key.
11140 This command is used only when there is no actual binding
11141 for that character after that prefix key. */);
11142 Vprefix_help_command
= Qnil
;
11144 DEFVAR_LISP ("top-level", &Vtop_level
,
11145 doc
: /* Form to evaluate when Emacs starts up.
11146 Useful to set before you dump a modified Emacs. */);
11149 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11150 doc
: /* Translate table for keyboard input, or nil.
11151 Each character is looked up in this string and the contents used instead.
11152 The value may be a string, a vector, or a char-table.
11153 If it is a string or vector of length N,
11154 character codes N and up are untranslated.
11155 In a vector or a char-table, an element which is nil means "no translation".
11157 This is applied to the characters supplied to input methods, not their
11158 output. See also `translation-table-for-input'. */);
11159 Vkeyboard_translate_table
= Qnil
;
11161 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11162 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11163 \(Even if the operating system has support for stopping a process.\) */);
11164 cannot_suspend
= 0;
11166 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11167 doc
: /* Non-nil means prompt with menus when appropriate.
11168 This is done when reading from a keymap that has a prompt string,
11169 for elements that have prompt strings.
11170 The menu is displayed on the screen
11171 if X menus were enabled at configuration
11172 time and the previous event was a mouse click prefix key.
11173 Otherwise, menu prompting uses the echo area. */);
11174 menu_prompting
= 1;
11176 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11177 doc
: /* Character to see next line of menu prompt.
11178 Type this character while in a menu prompt to rotate around the lines of it. */);
11179 XSETINT (menu_prompt_more_char
, ' ');
11181 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11182 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11183 Emacs applies the modifiers of the character stored here to each keyboard
11184 character it reads. For example, after evaluating the expression
11185 (setq extra-keyboard-modifiers ?\\C-x)
11186 all input characters will have the control modifier applied to them.
11188 Note that the character ?\\C-@, equivalent to the integer zero, does
11189 not count as a control character; rather, it counts as a character
11190 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11191 cancels any modification. */);
11192 extra_keyboard_modifiers
= 0;
11194 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11195 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11196 The command loop sets this to nil before each command,
11197 and tests the value when the command returns.
11198 Buffer modification stores t in this variable. */);
11199 Vdeactivate_mark
= Qnil
;
11201 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11202 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11203 Vcommand_hook_internal
= Qnil
;
11205 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11206 doc
: /* Normal hook run before each command is executed.
11207 If an unhandled error happens in running this hook,
11208 the hook value is set to nil, since otherwise the error
11209 might happen repeatedly and make Emacs nonfunctional. */);
11210 Vpre_command_hook
= Qnil
;
11212 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11213 doc
: /* Normal hook run after each command is executed.
11214 If an unhandled error happens in running this hook,
11215 the hook value is set to nil, since otherwise the error
11216 might happen repeatedly and make Emacs nonfunctional. */);
11217 Vpost_command_hook
= Qnil
;
11219 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11220 doc
: /* Normal hook run after each command is executed, if idle.
11221 Errors running the hook are caught and ignored. */);
11222 Vpost_command_idle_hook
= Qnil
;
11224 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11225 doc
: /* Delay time before running `post-command-idle-hook'.
11226 This is measured in microseconds. */);
11227 post_command_idle_delay
= 100000;
11230 DEFVAR_LISP ("echo-area-clear-hook", ...,
11231 doc
: /* Normal hook run when clearing the echo area. */);
11233 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11234 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11236 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11237 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11238 Vlucid_menu_bar_dirty_flag
= Qnil
;
11240 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11241 doc
: /* List of menu bar items to move to the end of the menu bar.
11242 The elements of the list are event types that may have menu bar bindings. */);
11243 Vmenu_bar_final_items
= Qnil
;
11245 DEFVAR_KBOARD ("overriding-terminal-local-map",
11246 Voverriding_terminal_local_map
,
11247 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11248 If this variable is non-nil, it is used as a keymap instead of the
11249 buffer's local map, and the minor mode keymaps and text property keymaps.
11250 This variable is intended to let commands such as `universal-argument'
11251 set up a different keymap for reading the next command. */);
11253 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11254 doc
: /* Keymap that overrides all other local keymaps.
11255 If this variable is non-nil, it is used as a keymap instead of the
11256 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11257 Voverriding_local_map
= Qnil
;
11259 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11260 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11261 Otherwise, the menu bar continues to reflect the buffer's local map
11262 and the minor mode maps regardless of `overriding-local-map'. */);
11263 Voverriding_local_map_menu_flag
= Qnil
;
11265 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11266 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11267 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11269 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11270 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11272 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11273 doc
: /* Alist of system-specific X windows key symbols.
11274 Each element should have the form (N . SYMBOL) where N is the
11275 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11276 and SYMBOL is its name. */);
11278 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11279 doc
: /* List of deferred actions to be performed at a later time.
11280 The precise format isn't relevant here; we just check whether it is nil. */);
11281 Vdeferred_action_list
= Qnil
;
11283 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11284 doc
: /* Function to call to handle deferred actions, after each command.
11285 This function is called with no arguments after each command
11286 whenever `deferred-action-list' is non-nil. */);
11287 Vdeferred_action_function
= Qnil
;
11289 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11290 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11291 The value can be a length of time to show the message for.
11292 If the value is non-nil and not a number, we wait 2 seconds. */);
11293 Vsuggest_key_bindings
= Qt
;
11295 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11296 doc
: /* List of active absolute time timers in order of increasing time. */);
11297 Vtimer_list
= Qnil
;
11299 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11300 doc
: /* List of active idle-time timers in order of increasing time. */);
11301 Vtimer_idle_list
= Qnil
;
11303 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11304 doc
: /* If non-nil, the function that implements the current input method.
11305 It's called with one argument, a printing character that was just read.
11306 \(That means a character with code 040...0176.)
11307 Typically this function uses `read-event' to read additional events.
11308 When it does so, it should first bind `input-method-function' to nil
11309 so it will not be called recursively.
11311 The function should return a list of zero or more events
11312 to be used as input. If it wants to put back some events
11313 to be reconsidered, separately, by the input method,
11314 it can add them to the beginning of `unread-command-events'.
11316 The input method function can find in `input-method-previous-method'
11317 the previous echo area message.
11319 The input method function should refer to the variables
11320 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11321 for guidance on what to do. */);
11322 Vinput_method_function
= Qnil
;
11324 DEFVAR_LISP ("input-method-previous-message",
11325 &Vinput_method_previous_message
,
11326 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11327 This variable exists because `read-event' clears the echo area
11328 before running the input method. It is nil if there was no message. */);
11329 Vinput_method_previous_message
= Qnil
;
11331 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11332 doc
: /* If non-nil, the function that implements the display of help.
11333 It's called with one argument, the help string to display. */);
11334 Vshow_help_function
= Qnil
;
11336 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11337 doc
: /* If non-nil, suppress point adjustment after executing a command.
11339 After a command is executed, if point is moved into a region that has
11340 special properties (e.g. composition, display), we adjust point to
11341 the boundary of the region. But, several special commands sets this
11342 variable to non-nil, then we suppress the point adjustment.
11344 This variable is set to nil before reading a command, and is checked
11345 just after executing the command. */);
11346 Vdisable_point_adjustment
= Qnil
;
11348 DEFVAR_LISP ("global-disable-point-adjustment",
11349 &Vglobal_disable_point_adjustment
,
11350 doc
: /* *If non-nil, always suppress point adjustment.
11352 The default value is nil, in which case, point adjustment are
11353 suppressed only after special commands that set
11354 `disable-point-adjustment' (which see) to non-nil. */);
11355 Vglobal_disable_point_adjustment
= Qnil
;
11357 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11358 doc
: /* Non-nil means updating menu bindings is allowed.
11359 A value of nil means menu bindings should not be updated.
11360 Used during Emacs' startup. */);
11361 update_menu_bindings
= 1;
11363 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11364 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11365 If the value is not a number, such messages don't time out. */);
11366 Vminibuffer_message_timeout
= make_number (2);
11370 keys_of_keyboard ()
11372 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11373 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11374 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11375 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11376 initial_define_key (meta_map
, 'x', "execute-extended-command");
11378 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11379 "handle-delete-frame");
11380 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11382 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11384 /* Handling it at such a low-level causes read_key_sequence to get
11385 * confused because it doesn't realize that the current_buffer was
11386 * changed by read_char.
11388 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11389 * "handle-select-window"); */
11390 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11391 "handle-save-session");
11394 /* Mark the pointers in the kboard objects.
11395 Called by the Fgarbage_collector. */
11401 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11403 if (kb
->kbd_macro_buffer
)
11404 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11406 mark_object (kb
->Voverriding_terminal_local_map
);
11407 mark_object (kb
->Vlast_command
);
11408 mark_object (kb
->Vreal_last_command
);
11409 mark_object (kb
->Vprefix_arg
);
11410 mark_object (kb
->Vlast_prefix_arg
);
11411 mark_object (kb
->kbd_queue
);
11412 mark_object (kb
->defining_kbd_macro
);
11413 mark_object (kb
->Vlast_kbd_macro
);
11414 mark_object (kb
->Vsystem_key_alist
);
11415 mark_object (kb
->system_key_syms
);
11416 mark_object (kb
->Vdefault_minibuffer_frame
);
11417 mark_object (kb
->echo_string
);
11420 struct input_event
*event
;
11421 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11423 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11424 event
= kbd_buffer
;
11425 if (event
->kind
!= SELECTION_REQUEST_EVENT
)
11427 mark_object (event
->x
);
11428 mark_object (event
->y
);
11430 mark_object (event
->frame_or_window
);
11431 mark_object (event
->arg
);
11436 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11437 (do not change this comment) */