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
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"
35 #include "character.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 /* Vector to GCPRO the Lisp objects referenced from kbd_buffer.
484 The interrupt-level event handlers will never enqueue an event on a
485 frame which is not in Vframe_list, and once an event is dequeued,
486 internal_last_event_frame or the event itself points to the frame.
489 But while the event is sitting in the queue, it's completely
490 unprotected. Suppose the user types one command which will run for
491 a while and then delete a frame, and then types another event at
492 the frame that will be deleted, before the command gets around to
493 it. Suppose there are no references to this frame elsewhere in
494 Emacs, and a GC occurs before the second event is dequeued. Now we
495 have an event referring to a freed frame, which will crash Emacs
498 Similar things happen when an event on a scroll bar is enqueued; the
499 window may be deleted while the event is in the queue.
501 So, we use this vector to protect the Lisp_Objects in the event
502 queue. That way, they'll be dequeued as dead frames or windows,
503 but still valid Lisp objects.
505 If kbd_buffer[i].kind != NO_EVENT, then
507 AREF (kbd_buffer_gcpro, 2 * i) == kbd_buffer[i].frame_or_window.
508 AREF (kbd_buffer_gcpro, 2 * i + 1) == kbd_buffer[i].arg. */
510 static Lisp_Object kbd_buffer_gcpro
;
512 /* Pointer to next available character in kbd_buffer.
513 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
514 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
515 next available char is in kbd_buffer[0]. */
516 static struct input_event
*kbd_fetch_ptr
;
518 /* Pointer to next place to store character in kbd_buffer. This
519 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
520 character should go in kbd_buffer[0]. */
521 static struct input_event
* volatile kbd_store_ptr
;
523 /* The above pair of variables forms a "queue empty" flag. When we
524 enqueue a non-hook event, we increment kbd_store_ptr. When we
525 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
526 there is input available iff the two pointers are not equal.
528 Why not just have a flag set and cleared by the enqueuing and
529 dequeuing functions? Such a flag could be screwed up by interrupts
530 at inopportune times. */
532 /* If this flag is non-nil, we check mouse_moved to see when the
533 mouse moves, and motion events will appear in the input stream.
534 Otherwise, mouse motion is ignored. */
535 Lisp_Object do_mouse_tracking
;
537 /* Symbols to head events. */
538 Lisp_Object Qmouse_movement
;
539 Lisp_Object Qscroll_bar_movement
;
540 Lisp_Object Qswitch_frame
;
541 Lisp_Object Qdelete_frame
;
542 Lisp_Object Qiconify_frame
;
543 Lisp_Object Qmake_frame_visible
;
544 Lisp_Object Qselect_window
;
545 Lisp_Object Qhelp_echo
;
547 /* Symbols to denote kinds of events. */
548 Lisp_Object Qfunction_key
;
549 Lisp_Object Qmouse_click
;
551 Lisp_Object Qlanguage_change
;
553 Lisp_Object Qdrag_n_drop
;
554 Lisp_Object Qsave_session
;
556 /* Lisp_Object Qmouse_movement; - also an event header */
558 /* Properties of event headers. */
559 Lisp_Object Qevent_kind
;
560 Lisp_Object Qevent_symbol_elements
;
562 /* menu item parts */
563 Lisp_Object Qmenu_alias
;
564 Lisp_Object Qmenu_enable
;
565 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
566 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
567 extern Lisp_Object Vdefine_key_rebound_commands
;
568 extern Lisp_Object Qmenu_item
;
570 /* An event header symbol HEAD may have a property named
571 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
572 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
573 mask of modifiers applied to it. If present, this is used to help
574 speed up parse_modifiers. */
575 Lisp_Object Qevent_symbol_element_mask
;
577 /* An unmodified event header BASE may have a property named
578 Qmodifier_cache, which is an alist mapping modifier masks onto
579 modified versions of BASE. If present, this helps speed up
581 Lisp_Object Qmodifier_cache
;
583 /* Symbols to use for parts of windows. */
584 Lisp_Object Qmode_line
;
585 Lisp_Object Qvertical_line
;
586 Lisp_Object Qvertical_scroll_bar
;
587 Lisp_Object Qmenu_bar
;
588 extern Lisp_Object Qleft_margin
, Qright_margin
;
590 Lisp_Object
recursive_edit_unwind (), command_loop ();
591 Lisp_Object
Fthis_command_keys ();
592 Lisp_Object Qextended_command_history
;
593 EMACS_TIME
timer_check ();
595 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
597 extern char *x_get_keysym_name ();
599 static void record_menu_key ();
600 static int echo_length ();
602 Lisp_Object Qpolling_period
;
604 /* List of absolute timers. Appears in order of next scheduled event. */
605 Lisp_Object Vtimer_list
;
607 /* List of idle time timers. Appears in order of next scheduled event. */
608 Lisp_Object Vtimer_idle_list
;
610 /* Incremented whenever a timer is run. */
613 extern Lisp_Object Vprint_level
, Vprint_length
;
615 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
617 EMACS_TIME
*input_available_clear_time
;
619 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
620 Default is 1 if INTERRUPT_INPUT is defined. */
623 /* Nonzero while interrupts are temporarily deferred during redisplay. */
624 int interrupts_deferred
;
626 /* Nonzero means use ^S/^Q for flow control. */
629 /* Allow m- file to inhibit use of FIONREAD. */
630 #ifdef BROKEN_FIONREAD
634 /* We are unable to use interrupts if FIONREAD is not available,
635 so flush SIGIO so we won't try. */
642 /* If we support a window system, turn on the code to poll periodically
643 to detect C-g. It isn't actually used when doing interrupt input. */
644 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
645 #define POLL_FOR_INPUT
648 /* After a command is executed, if point is moved into a region that
649 has specific properties (e.g. composition, display), we adjust
650 point to the boundary of the region. But, if a command sets this
651 variable to non-nil, we suppress this point adjustment. This
652 variable is set to nil before reading a command. */
654 Lisp_Object Vdisable_point_adjustment
;
656 /* If non-nil, always disable point adjustment. */
658 Lisp_Object Vglobal_disable_point_adjustment
;
660 /* The time when Emacs started being idle. */
662 static EMACS_TIME timer_idleness_start_time
;
664 /* After Emacs stops being idle, this saves the last value
665 of timer_idleness_start_time from when it was idle. */
667 static EMACS_TIME timer_last_idleness_start_time
;
670 /* Global variable declarations. */
672 /* Function for init_keyboard to call with no args (if nonzero). */
673 void (*keyboard_init_hook
) ();
675 static int read_avail_input
P_ ((int));
676 static void get_input_pending
P_ ((int *, int));
677 static void get_filtered_input_pending
P_ ((int *, int, int));
678 static int readable_events
P_ ((int));
679 static int readable_filtered_events
P_ ((int, int));
680 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
681 Lisp_Object
, int *));
682 static Lisp_Object
read_char_x_menu_prompt ();
683 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
685 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
687 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
688 enum scroll_bar_part
,
689 Lisp_Object
, Lisp_Object
,
692 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
693 Lisp_Object
, char **,
694 Lisp_Object
*, unsigned));
695 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
696 static int parse_solitary_modifier
P_ ((Lisp_Object
));
697 static int parse_solitary_modifier ();
698 static void save_getcjmp
P_ ((jmp_buf));
699 static void save_getcjmp ();
700 static void restore_getcjmp
P_ ((jmp_buf));
701 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
702 static void clear_event
P_ ((struct input_event
*));
703 static void any_kboard_state
P_ ((void));
704 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
706 /* Nonzero means don't try to suspend even if the operating system seems
708 static int cannot_suspend
;
710 /* Install the string STR as the beginning of the string of echoing,
711 so that it serves as a prompt for the next character.
712 Also start echoing. */
718 current_kboard
->echo_string
= str
;
719 current_kboard
->echo_after_prompt
= SCHARS (str
);
723 /* Add C to the echo string, if echoing is going on.
724 C can be a character, which is printed prettily ("M-C-x" and all that
725 jazz), or a symbol, whose name is printed. */
731 if (current_kboard
->immediate_echo
)
733 int size
= KEY_DESCRIPTION_SIZE
+ 100;
734 char *buffer
= (char *) alloca (size
);
736 Lisp_Object echo_string
;
738 echo_string
= current_kboard
->echo_string
;
740 /* If someone has passed us a composite event, use its head symbol. */
745 ptr
= push_key_description (XINT (c
), ptr
, 1);
747 else if (SYMBOLP (c
))
749 Lisp_Object name
= SYMBOL_NAME (c
);
750 int nbytes
= SBYTES (name
);
752 if (size
- (ptr
- buffer
) < nbytes
)
754 int offset
= ptr
- buffer
;
755 size
= max (2 * size
, size
+ nbytes
);
756 buffer
= (char *) alloca (size
);
757 ptr
= buffer
+ offset
;
760 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
761 STRING_MULTIBYTE (name
), 1);
764 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
767 const char *text
= " (Type ? for further options)";
768 int len
= strlen (text
);
770 if (size
- (ptr
- buffer
) < len
)
772 int offset
= ptr
- buffer
;
774 buffer
= (char *) alloca (size
);
775 ptr
= buffer
+ offset
;
778 bcopy (text
, ptr
, len
);
782 /* Replace a dash from echo_dash with a space, otherwise
783 add a space at the end as a separator between keys. */
784 if (STRINGP (echo_string
)
785 && SCHARS (echo_string
) > 1)
787 Lisp_Object last_char
, prev_char
, idx
;
789 idx
= make_number (SCHARS (echo_string
) - 2);
790 prev_char
= Faref (echo_string
, idx
);
792 idx
= make_number (SCHARS (echo_string
) - 1);
793 last_char
= Faref (echo_string
, idx
);
795 /* We test PREV_CHAR to make sure this isn't the echoing
797 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
798 Faset (echo_string
, idx
, make_number (' '));
800 echo_string
= concat2 (echo_string
, build_string (" "));
803 current_kboard
->echo_string
804 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
810 /* Temporarily add a dash to the end of the echo string if it's not
811 empty, so that it serves as a mini-prompt for the very next character. */
816 /* Do nothing if not echoing at all. */
817 if (NILP (current_kboard
->echo_string
))
820 if (!current_kboard
->immediate_echo
821 && SCHARS (current_kboard
->echo_string
) == 0)
824 /* Do nothing if we just printed a prompt. */
825 if (current_kboard
->echo_after_prompt
826 == SCHARS (current_kboard
->echo_string
))
829 /* Put a dash at the end of the buffer temporarily,
830 but make it go away when the next character is added. */
831 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
836 /* Display the current echo string, and begin echoing if not already
842 if (!current_kboard
->immediate_echo
)
845 current_kboard
->immediate_echo
= 1;
847 for (i
= 0; i
< this_command_key_count
; i
++)
851 /* Set before_command_echo_length to the value that would
852 have been saved before the start of this subcommand in
853 command_loop_1, if we had already been echoing then. */
854 if (i
== this_single_command_key_start
)
855 before_command_echo_length
= echo_length ();
857 c
= XVECTOR (this_command_keys
)->contents
[i
];
858 if (! (EVENT_HAS_PARAMETERS (c
)
859 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
863 /* Set before_command_echo_length to the value that would
864 have been saved before the start of this subcommand in
865 command_loop_1, if we had already been echoing then. */
866 if (this_command_key_count
== this_single_command_key_start
)
867 before_command_echo_length
= echo_length ();
869 /* Put a dash at the end to invite the user to type more. */
874 message3_nolog (current_kboard
->echo_string
,
875 SBYTES (current_kboard
->echo_string
),
876 STRING_MULTIBYTE (current_kboard
->echo_string
));
879 /* Record in what buffer we echoed, and from which kboard. */
880 echo_message_buffer
= echo_area_buffer
[0];
881 echo_kboard
= current_kboard
;
883 if (waiting_for_input
&& !NILP (Vquit_flag
))
884 quit_throw_to_read_char ();
887 /* Turn off echoing, for the start of a new command. */
892 current_kboard
->immediate_echo
= 0;
893 current_kboard
->echo_after_prompt
= -1;
894 current_kboard
->echo_string
= Qnil
;
895 ok_to_echo_at_next_pause
= NULL
;
897 echo_message_buffer
= Qnil
;
900 /* Return the length of the current echo string. */
905 return (STRINGP (current_kboard
->echo_string
)
906 ? SCHARS (current_kboard
->echo_string
)
910 /* Truncate the current echo message to its first LEN chars.
911 This and echo_char get used by read_key_sequence when the user
912 switches frames while entering a key sequence. */
915 echo_truncate (nchars
)
918 if (STRINGP (current_kboard
->echo_string
))
919 current_kboard
->echo_string
920 = Fsubstring (current_kboard
->echo_string
,
921 make_number (0), make_number (nchars
));
922 truncate_echo_area (nchars
);
926 /* Functions for manipulating this_command_keys. */
928 add_command_key (key
)
931 #if 0 /* Not needed after we made Freset_this_command_lengths
932 do the job immediately. */
933 /* If reset-this-command-length was called recently, obey it now.
934 See the doc string of that function for an explanation of why. */
935 if (before_command_restore_flag
)
937 this_command_key_count
= before_command_key_count_1
;
938 if (this_command_key_count
< this_single_command_key_start
)
939 this_single_command_key_start
= this_command_key_count
;
940 echo_truncate (before_command_echo_length_1
);
941 before_command_restore_flag
= 0;
945 if (this_command_key_count
>= ASIZE (this_command_keys
))
946 this_command_keys
= larger_vector (this_command_keys
,
947 2 * ASIZE (this_command_keys
),
950 AREF (this_command_keys
, this_command_key_count
) = key
;
951 ++this_command_key_count
;
958 int count
= SPECPDL_INDEX ();
961 if (command_loop_level
> 0)
963 specbind (Qstandard_output
, Qt
);
964 specbind (Qstandard_input
, Qt
);
967 #ifdef HAVE_X_WINDOWS
968 /* The command loop has started an hourglass timer, so we have to
969 cancel it here, otherwise it will fire because the recursive edit
970 can take some time. Do not check for display_hourglass_p here,
971 because it could already be nil. */
975 /* This function may have been called from a debugger called from
976 within redisplay, for instance by Edebugging a function called
977 from fontification-functions. We want to allow redisplay in
978 the debugging session.
980 The recursive edit is left with a `(throw exit ...)'. The `exit'
981 tag is not caught anywhere in redisplay, i.e. when we leave the
982 recursive edit, the original redisplay leading to the recursive
983 edit will be unwound. The outcome should therefore be safe. */
984 specbind (Qinhibit_redisplay
, Qnil
);
987 val
= command_loop ();
989 Fsignal (Qquit
, Qnil
);
990 /* Handle throw from read_minibuf when using minibuffer
991 while it's active but we're in another window. */
993 Fsignal (Qerror
, Fcons (val
, Qnil
));
995 return unbind_to (count
, Qnil
);
998 /* When an auto-save happens, record the "time", and don't do again soon. */
1003 last_auto_save
= num_nonmacro_input_events
;
1006 /* Make an auto save happen as soon as possible at command level. */
1009 force_auto_save_soon ()
1011 last_auto_save
= - auto_save_interval
- 1;
1013 record_asynch_buffer_change ();
1016 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1017 doc
: /* Invoke the editor command loop recursively.
1018 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1019 that tells this function to return.
1020 Alternately, `(throw 'exit t)' makes this function signal an error.
1021 This function is called by the editor initialization to begin editing. */)
1024 int count
= SPECPDL_INDEX ();
1027 command_loop_level
++;
1028 update_mode_lines
= 1;
1030 if (command_loop_level
1031 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1032 buffer
= Fcurrent_buffer ();
1036 /* If we leave recursive_edit_1 below with a `throw' for instance,
1037 like it is done in the splash screen display, we have to
1038 make sure that we restore single_kboard as command_loop_1
1039 would have done if it were left normally. */
1040 record_unwind_protect (recursive_edit_unwind
,
1041 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1043 recursive_edit_1 ();
1044 return unbind_to (count
, Qnil
);
1048 recursive_edit_unwind (info
)
1051 if (BUFFERP (XCAR (info
)))
1052 Fset_buffer (XCAR (info
));
1054 if (NILP (XCDR (info
)))
1055 any_kboard_state ();
1057 single_kboard_state ();
1059 command_loop_level
--;
1060 update_mode_lines
= 1;
1069 #if 0 /* Theory: if there's anything in Vunread_command_events,
1070 it will right away be read by read_key_sequence,
1071 and then if we do switch KBOARDS, it will go into the side
1072 queue then. So we don't need to do anything special here -- rms. */
1073 if (CONSP (Vunread_command_events
))
1075 current_kboard
->kbd_queue
1076 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1077 current_kboard
->kbd_queue_has_data
= 1;
1079 Vunread_command_events
= Qnil
;
1085 /* Switch to the single-kboard state, making current_kboard
1086 the only KBOARD from which further input is accepted. */
1089 single_kboard_state ()
1096 /* Maintain a stack of kboards, so other parts of Emacs
1097 can switch temporarily to the kboard of a given frame
1098 and then revert to the previous status. */
1103 struct kboard_stack
*next
;
1106 static struct kboard_stack
*kboard_stack
;
1109 push_frame_kboard (f
)
1113 struct kboard_stack
*p
1114 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1116 p
->next
= kboard_stack
;
1117 p
->kboard
= current_kboard
;
1120 current_kboard
= FRAME_KBOARD (f
);
1128 struct kboard_stack
*p
= kboard_stack
;
1129 current_kboard
= p
->kboard
;
1130 kboard_stack
= p
->next
;
1135 /* Handle errors that are not handled at inner levels
1136 by printing an error message and returning to the editor command loop. */
1142 Lisp_Object old_level
, old_length
;
1143 char macroerror
[50];
1145 #ifdef HAVE_X_WINDOWS
1146 if (display_hourglass_p
)
1147 cancel_hourglass ();
1150 if (!NILP (executing_macro
))
1152 if (executing_macro_iterations
== 1)
1153 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1155 sprintf (macroerror
, "After %d kbd macro iterations: ",
1156 executing_macro_iterations
);
1161 Vstandard_output
= Qt
;
1162 Vstandard_input
= Qt
;
1163 Vexecuting_macro
= Qnil
;
1164 executing_macro
= Qnil
;
1165 current_kboard
->Vprefix_arg
= Qnil
;
1166 current_kboard
->Vlast_prefix_arg
= Qnil
;
1169 /* Avoid unquittable loop if data contains a circular list. */
1170 old_level
= Vprint_level
;
1171 old_length
= Vprint_length
;
1172 XSETFASTINT (Vprint_level
, 10);
1173 XSETFASTINT (Vprint_length
, 10);
1174 cmd_error_internal (data
, macroerror
);
1175 Vprint_level
= old_level
;
1176 Vprint_length
= old_length
;
1180 Vinhibit_quit
= Qnil
;
1182 any_kboard_state ();
1185 return make_number (0);
1188 /* Take actions on handling an error. DATA is the data that describes
1191 CONTEXT is a C-string containing ASCII characters only which
1192 describes the context in which the error happened. If we need to
1193 generalize CONTEXT to allow multibyte characters, make it a Lisp
1197 cmd_error_internal (data
, context
)
1202 int kill_emacs_p
= 0;
1203 struct frame
*sf
= SELECTED_FRAME ();
1207 clear_message (1, 0);
1209 /* If the window system or terminal frame hasn't been initialized
1210 yet, or we're not interactive, it's best to dump this message out
1211 to stderr and exit. */
1212 if (!sf
->glyphs_initialized_p
1213 /* This is the case of the frame dumped with Emacs, when we're
1214 running under a window system. */
1215 || (!NILP (Vwindow_system
)
1216 && !inhibit_window_system
1217 && FRAME_TERMCAP_P (sf
))
1220 stream
= Qexternal_debugging_output
;
1226 message_log_maybe_newline ();
1231 /* The immediate context is not interesting for Quits,
1232 since they are asyncronous. */
1233 if (EQ (XCAR (data
), Qquit
))
1234 Vsignaling_function
= Qnil
;
1236 print_error_message (data
, stream
, context
, Vsignaling_function
);
1238 Vsignaling_function
= Qnil
;
1240 /* If the window system or terminal frame hasn't been initialized
1241 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1245 Fkill_emacs (make_number (-1));
1249 Lisp_Object
command_loop_1 ();
1250 Lisp_Object
command_loop_2 ();
1251 Lisp_Object
top_level_1 ();
1253 /* Entry to editor-command-loop.
1254 This level has the catches for exiting/returning to editor command loop.
1255 It returns nil to exit recursive edit, t to abort it. */
1260 if (command_loop_level
> 0 || minibuf_level
> 0)
1263 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1264 executing_macro
= Qnil
;
1270 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1271 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1272 executing_macro
= Qnil
;
1274 /* End of file in -batch run causes exit here. */
1280 /* Here we catch errors in execution of commands within the
1281 editing loop, and reenter the editing loop.
1282 When there is an error, cmd_error runs and returns a non-nil
1283 value to us. A value of nil means that command_loop_1 itself
1284 returned due to end of file (or end of kbd macro). */
1289 register Lisp_Object val
;
1292 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1293 while (!NILP (val
));
1301 return Feval (Vtop_level
);
1307 /* On entry to the outer level, run the startup file */
1308 if (!NILP (Vtop_level
))
1309 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1310 else if (!NILP (Vpurify_flag
))
1311 message ("Bare impure Emacs (standard Lisp code not loaded)");
1313 message ("Bare Emacs (standard Lisp code not loaded)");
1317 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1318 doc
: /* Exit all recursive editing levels. */)
1321 #ifdef HAVE_X_WINDOWS
1322 if (display_hourglass_p
)
1323 cancel_hourglass ();
1325 return Fthrow (Qtop_level
, Qnil
);
1328 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1329 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1332 if (command_loop_level
> 0 || minibuf_level
> 0)
1333 Fthrow (Qexit
, Qnil
);
1335 error ("No recursive edit is in progress");
1339 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1340 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1343 if (command_loop_level
> 0 || minibuf_level
> 0)
1346 error ("No recursive edit is in progress");
1350 /* This is the actual command reading loop,
1351 sans error-handling encapsulation. */
1353 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1355 void safe_run_hooks
P_ ((Lisp_Object
));
1356 static void adjust_point_for_property
P_ ((int, int));
1358 /* Cancel hourglass from protect_unwind.
1360 #ifdef HAVE_X_WINDOWS
1362 cancel_hourglass_unwind (arg
)
1365 cancel_hourglass ();
1375 Lisp_Object keybuf
[30];
1379 struct buffer
*prev_buffer
= NULL
;
1381 int was_locked
= single_kboard
;
1383 int already_adjusted
;
1385 current_kboard
->Vprefix_arg
= Qnil
;
1386 current_kboard
->Vlast_prefix_arg
= Qnil
;
1387 Vdeactivate_mark
= Qnil
;
1388 waiting_for_input
= 0;
1392 this_command_key_count
= 0;
1393 this_command_key_count_reset
= 0;
1394 this_single_command_key_start
= 0;
1396 if (NILP (Vmemory_full
))
1398 /* Make sure this hook runs after commands that get errors and
1399 throw to top level. */
1400 /* Note that the value cell will never directly contain nil
1401 if the symbol is a local variable. */
1402 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1403 safe_run_hooks (Qpost_command_hook
);
1405 /* If displaying a message, resize the echo area window to fit
1406 that message's size exactly. */
1407 if (!NILP (echo_area_buffer
[0]))
1408 resize_echo_area_exactly ();
1410 if (!NILP (Vdeferred_action_list
))
1411 call0 (Vdeferred_action_function
);
1413 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1415 if (NILP (Vunread_command_events
)
1416 && NILP (Vunread_input_method_events
)
1417 && NILP (Vunread_post_input_method_events
)
1418 && NILP (Vexecuting_macro
)
1419 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1420 safe_run_hooks (Qpost_command_idle_hook
);
1424 Vmemory_full
= Qnil
;
1426 /* Do this after running Vpost_command_hook, for consistency. */
1427 current_kboard
->Vlast_command
= Vthis_command
;
1428 current_kboard
->Vreal_last_command
= real_this_command
;
1432 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1435 /* Make sure the current window's buffer is selected. */
1436 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1437 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1439 /* Display any malloc warning that just came out. Use while because
1440 displaying one warning can cause another. */
1442 while (pending_malloc_warning
)
1443 display_malloc_warning ();
1447 Vdeactivate_mark
= Qnil
;
1449 /* If minibuffer on and echo area in use,
1450 wait a short time and redraw minibuffer. */
1453 && !NILP (echo_area_buffer
[0])
1454 && EQ (minibuf_window
, echo_area_window
)
1455 && NUMBERP (Vminibuffer_message_timeout
))
1457 /* Bind inhibit-quit to t so that C-g gets read in
1458 rather than quitting back to the minibuffer. */
1459 int count
= SPECPDL_INDEX ();
1460 specbind (Qinhibit_quit
, Qt
);
1462 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1463 /* Clear the echo area. */
1465 safe_run_hooks (Qecho_area_clear_hook
);
1467 unbind_to (count
, Qnil
);
1469 /* If a C-g came in before, treat it as input now. */
1470 if (!NILP (Vquit_flag
))
1473 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1478 alloca (0); /* Cause a garbage collection now */
1479 /* Since we can free the most stuff here. */
1480 #endif /* C_ALLOCA */
1483 /* Select the frame that the last event came from. Usually,
1484 switch-frame events will take care of this, but if some lisp
1485 code swallows a switch-frame event, we'll fix things up here.
1486 Is this a good idea? */
1487 if (FRAMEP (internal_last_event_frame
)
1488 && !EQ (internal_last_event_frame
, selected_frame
))
1489 Fselect_frame (internal_last_event_frame
, Qnil
);
1491 /* If it has changed current-menubar from previous value,
1492 really recompute the menubar from the value. */
1493 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1494 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1495 call0 (Qrecompute_lucid_menubar
);
1497 before_command_key_count
= this_command_key_count
;
1498 before_command_echo_length
= echo_length ();
1500 Vthis_command
= Qnil
;
1501 real_this_command
= Qnil
;
1503 /* Read next key sequence; i gets its length. */
1504 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1507 /* A filter may have run while we were reading the input. */
1508 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1510 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1511 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1515 /* Now we have read a key sequence of length I,
1516 or else I is 0 and we found end of file. */
1518 if (i
== 0) /* End of file -- happens only in */
1519 return Qnil
; /* a kbd macro, at the end. */
1520 /* -1 means read_key_sequence got a menu that was rejected.
1521 Just loop around and read another command. */
1525 this_command_key_count
= 0;
1526 this_command_key_count_reset
= 0;
1527 this_single_command_key_start
= 0;
1531 last_command_char
= keybuf
[i
- 1];
1533 /* If the previous command tried to force a specific window-start,
1534 forget about that, in case this command moves point far away
1535 from that position. But also throw away beg_unchanged and
1536 end_unchanged information in that case, so that redisplay will
1537 update the whole window properly. */
1538 if (!NILP (XWINDOW (selected_window
)->force_start
))
1541 XWINDOW (selected_window
)->force_start
= Qnil
;
1542 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1543 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1546 cmd
= read_key_sequence_cmd
;
1547 if (!NILP (Vexecuting_macro
))
1549 if (!NILP (Vquit_flag
))
1551 Vexecuting_macro
= Qt
;
1552 QUIT
; /* Make some noise. */
1553 /* Will return since macro now empty. */
1557 /* Do redisplay processing after this command except in special
1558 cases identified below. */
1559 prev_buffer
= current_buffer
;
1560 prev_modiff
= MODIFF
;
1561 last_point_position
= PT
;
1562 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1564 /* By default, we adjust point to a boundary of a region that
1565 has such a property that should be treated intangible
1566 (e.g. composition, display). But, some commands will set
1567 this variable differently. */
1568 Vdisable_point_adjustment
= Qnil
;
1570 /* Process filters and timers may have messed with deactivate-mark.
1571 reset it before we execute the command. */
1572 Vdeactivate_mark
= Qnil
;
1574 /* Remap command through active keymaps */
1575 Vthis_original_command
= cmd
;
1579 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1583 /* Execute the command. */
1585 Vthis_command
= cmd
;
1586 real_this_command
= cmd
;
1587 /* Note that the value cell will never directly contain nil
1588 if the symbol is a local variable. */
1589 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1590 safe_run_hooks (Qpre_command_hook
);
1592 already_adjusted
= 0;
1594 if (NILP (Vthis_command
))
1596 /* nil means key is undefined. */
1598 current_kboard
->defining_kbd_macro
= Qnil
;
1599 update_mode_lines
= 1;
1600 current_kboard
->Vprefix_arg
= Qnil
;
1604 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1606 /* In case we jump to directly_done. */
1607 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1609 /* Recognize some common commands in common situations and
1610 do them directly. */
1611 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1613 struct Lisp_Char_Table
*dp
1614 = window_display_table (XWINDOW (selected_window
));
1615 lose
= FETCH_CHAR (PT_BYTE
);
1617 if (! NILP (Vpost_command_hook
))
1618 /* Put this before calling adjust_point_for_property
1619 so it will only get called once in any case. */
1621 if (current_buffer
== prev_buffer
1622 && last_point_position
!= PT
1623 && NILP (Vdisable_point_adjustment
)
1624 && NILP (Vglobal_disable_point_adjustment
))
1625 adjust_point_for_property (last_point_position
, 0);
1626 already_adjusted
= 1;
1627 if (PT
== last_point_position
+ 1
1629 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1630 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1631 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1632 && (lose
>= 0x20 && lose
< 0x7f)))
1633 : (lose
>= 0x20 && lose
< 0x7f))
1634 /* To extract the case of continuation on
1635 wide-column characters. */
1636 && ASCII_BYTE_P (lose
)
1637 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1639 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1641 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1643 && !windows_or_buffers_changed
1644 && EQ (current_buffer
->selective_display
, Qnil
)
1645 && !detect_input_pending ()
1646 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1647 && NILP (Vexecuting_macro
))
1648 direct_output_forward_char (1);
1651 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1653 struct Lisp_Char_Table
*dp
1654 = window_display_table (XWINDOW (selected_window
));
1656 lose
= FETCH_CHAR (PT_BYTE
);
1657 if (! NILP (Vpost_command_hook
))
1659 if (current_buffer
== prev_buffer
1660 && last_point_position
!= PT
1661 && NILP (Vdisable_point_adjustment
)
1662 && NILP (Vglobal_disable_point_adjustment
))
1663 adjust_point_for_property (last_point_position
, 0);
1664 already_adjusted
= 1;
1665 if (PT
== last_point_position
- 1
1667 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1668 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1669 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1670 && (lose
>= 0x20 && lose
< 0x7f)))
1671 : (lose
>= 0x20 && lose
< 0x7f))
1672 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1674 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1676 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1678 && !windows_or_buffers_changed
1679 && EQ (current_buffer
->selective_display
, Qnil
)
1680 && !detect_input_pending ()
1681 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1682 && NILP (Vexecuting_macro
))
1683 direct_output_forward_char (-1);
1686 else if (EQ (Vthis_command
, Qself_insert_command
)
1687 /* Try this optimization only on char keystrokes. */
1688 && NATNUMP (last_command_char
)
1689 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1692 = translate_char (Vtranslation_table_for_input
,
1693 XFASTINT (last_command_char
));
1695 if (NILP (Vexecuting_macro
)
1696 && !EQ (minibuf_window
, selected_window
))
1698 if (!nonundocount
|| nonundocount
>= 20)
1706 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1708 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1710 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1712 || MODIFF
<= SAVE_MODIFF
1713 || windows_or_buffers_changed
1714 || !EQ (current_buffer
->selective_display
, Qnil
)
1715 || detect_input_pending ()
1716 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1717 || !NILP (Vexecuting_macro
));
1719 value
= internal_self_insert (c
, 0);
1724 if (! NILP (Vpost_command_hook
))
1725 /* Put this before calling adjust_point_for_property
1726 so it will only get called once in any case. */
1729 /* VALUE == 1 when AFTER-CHANGE functions are
1730 installed which is the case most of the time
1731 because FONT-LOCK installs one. */
1732 if (!lose
&& !value
)
1733 direct_output_for_insert (c
);
1738 /* Here for a command that isn't executed directly */
1741 #ifdef HAVE_X_WINDOWS
1742 int scount
= SPECPDL_INDEX ();
1744 if (display_hourglass_p
1745 && NILP (Vexecuting_macro
))
1747 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1753 if (NILP (current_kboard
->Vprefix_arg
))
1755 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1757 #ifdef HAVE_X_WINDOWS
1758 /* Do not check display_hourglass_p here, because
1759 Fcommand_execute could change it, but we should cancel
1760 hourglass cursor anyway.
1761 But don't cancel the hourglass within a macro
1762 just because a command in the macro finishes. */
1763 if (NILP (Vexecuting_macro
))
1764 unbind_to (scount
, Qnil
);
1769 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1771 /* Note that the value cell will never directly contain nil
1772 if the symbol is a local variable. */
1773 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1774 safe_run_hooks (Qpost_command_hook
);
1776 /* If displaying a message, resize the echo area window to fit
1777 that message's size exactly. */
1778 if (!NILP (echo_area_buffer
[0]))
1779 resize_echo_area_exactly ();
1781 if (!NILP (Vdeferred_action_list
))
1782 safe_run_hooks (Qdeferred_action_function
);
1784 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1786 if (NILP (Vunread_command_events
)
1787 && NILP (Vunread_input_method_events
)
1788 && NILP (Vunread_post_input_method_events
)
1789 && NILP (Vexecuting_macro
)
1790 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1791 safe_run_hooks (Qpost_command_idle_hook
);
1794 /* If there is a prefix argument,
1795 1) We don't want Vlast_command to be ``universal-argument''
1796 (that would be dumb), so don't set Vlast_command,
1797 2) we want to leave echoing on so that the prefix will be
1798 echoed as part of this key sequence, so don't call
1800 3) we want to leave this_command_key_count non-zero, so that
1801 read_char will realize that it is re-reading a character, and
1802 not echo it a second time.
1804 If the command didn't actually create a prefix arg,
1805 but is merely a frame event that is transparent to prefix args,
1806 then the above doesn't apply. */
1807 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1809 current_kboard
->Vlast_command
= Vthis_command
;
1810 current_kboard
->Vreal_last_command
= real_this_command
;
1812 this_command_key_count
= 0;
1813 this_command_key_count_reset
= 0;
1814 this_single_command_key_start
= 0;
1817 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1819 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1821 /* We could also call `deactivate'mark'. */
1822 if (EQ (Vtransient_mark_mode
, Qlambda
))
1823 Vtransient_mark_mode
= Qnil
;
1826 current_buffer
->mark_active
= Qnil
;
1827 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1830 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1831 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1836 if (current_buffer
== prev_buffer
1837 && last_point_position
!= PT
1838 && NILP (Vdisable_point_adjustment
)
1839 && NILP (Vglobal_disable_point_adjustment
)
1840 && !already_adjusted
)
1841 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1843 /* Install chars successfully executed in kbd macro. */
1845 if (!NILP (current_kboard
->defining_kbd_macro
)
1846 && NILP (current_kboard
->Vprefix_arg
))
1847 finalize_kbd_macro_chars ();
1851 any_kboard_state ();
1856 extern Lisp_Object Qcomposition
, Qdisplay
;
1858 /* Adjust point to a boundary of a region that has such a property
1859 that should be treated intangible. For the moment, we check
1860 `composition', `display' and `invisible' properties.
1861 LAST_PT is the last position of point. */
1863 extern Lisp_Object Qafter_string
, Qbefore_string
;
1864 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1867 adjust_point_for_property (last_pt
, modified
)
1872 Lisp_Object val
, overlay
, tmp
;
1873 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1876 /* FIXME: cycling is probably not necessary because these properties
1877 can't be usefully combined anyway. */
1878 while (check_composition
|| check_display
|| check_invisible
)
1880 if (check_composition
1881 && PT
> BEGV
&& PT
< ZV
1882 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1883 && COMPOSITION_VALID_P (beg
, end
, val
)
1884 && beg
< PT
/* && end > PT <- It's always the case. */
1885 && (last_pt
<= beg
|| last_pt
>= end
))
1888 SET_PT (PT
< last_pt
? beg
: end
);
1889 check_display
= check_invisible
= 1;
1891 check_composition
= 0;
1893 && PT
> BEGV
&& PT
< ZV
1894 && !NILP (val
= get_char_property_and_overlay
1895 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1896 && display_prop_intangible_p (val
)
1897 && (!OVERLAYP (overlay
)
1898 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1899 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1900 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1901 && beg
< PT
) /* && end > PT <- It's always the case. */
1904 SET_PT (PT
< last_pt
? beg
: end
);
1905 check_composition
= check_invisible
= 1;
1908 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1910 int inv
, ellipsis
= 0;
1913 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1915 && !NILP (val
= get_char_property_and_overlay
1916 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1917 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1919 ellipsis
= ellipsis
|| inv
> 1
1920 || (OVERLAYP (overlay
)
1921 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1922 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1923 tmp
= Fnext_single_char_property_change
1924 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1925 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1928 && !NILP (val
= get_char_property_and_overlay
1929 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1930 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1932 ellipsis
= ellipsis
|| inv
> 1
1933 || (OVERLAYP (overlay
)
1934 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1935 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1936 tmp
= Fprevious_single_char_property_change
1937 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1938 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1941 /* Move away from the inside area. */
1942 if (beg
< PT
&& end
> PT
)
1944 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1945 /* We haven't moved yet (so we don't need to fear
1946 infinite-looping) and we were outside the range
1947 before (so either end of the range still corresponds
1948 to a move in the right direction): pretend we moved
1949 less than we actually did, so that we still have
1950 more freedom below in choosing which end of the range
1952 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1953 /* We either have moved already or the last point
1954 was already in the range: we don't get to choose
1955 which end of the range we have to go to. */
1956 : (PT
< last_pt
? beg
: end
));
1957 check_composition
= check_display
= 1;
1959 xassert (PT
== beg
|| PT
== end
);
1960 /* Pretend the area doesn't exist if the buffer is not
1962 if (!modified
&& !ellipsis
&& beg
< end
)
1964 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1965 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1966 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1967 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1968 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1969 /* We've already moved as far as we can. Trying to go
1970 to the other end would mean moving backwards and thus
1971 could lead to an infinite loop. */
1973 else if (val
= get_pos_property (make_number (PT
),
1975 TEXT_PROP_MEANS_INVISIBLE (val
)
1976 && (val
= get_pos_property
1977 (make_number (PT
== beg
? end
: beg
),
1979 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1980 (check_composition
= check_display
= 1,
1981 SET_PT (PT
== beg
? end
: beg
));
1984 check_invisible
= 0;
1988 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1991 safe_run_hooks_1 (hook
)
1994 return call1 (Vrun_hooks
, Vinhibit_quit
);
1997 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2000 safe_run_hooks_error (data
)
2003 Lisp_Object args
[3];
2004 args
[0] = build_string ("Error in %s: %s");
2005 args
[1] = Vinhibit_quit
;
2008 return Fset (Vinhibit_quit
, Qnil
);
2011 /* If we get an error while running the hook, cause the hook variable
2012 to be nil. Also inhibit quits, so that C-g won't cause the hook
2013 to mysteriously evaporate. */
2016 safe_run_hooks (hook
)
2019 int count
= SPECPDL_INDEX ();
2020 specbind (Qinhibit_quit
, hook
);
2022 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2024 unbind_to (count
, Qnil
);
2028 /* Number of seconds between polling for input. This is a Lisp
2029 variable that can be bound. */
2031 EMACS_INT polling_period
;
2033 /* Nonzero means polling for input is temporarily suppressed. */
2035 int poll_suppress_count
;
2037 /* Asynchronous timer for polling. */
2039 struct atimer
*poll_timer
;
2042 #ifdef POLL_FOR_INPUT
2044 /* Poll for input, so what we catch a C-g if it comes in. This
2045 function is called from x_make_frame_visible, see comment
2051 if (interrupt_input_blocked
== 0
2052 && !waiting_for_input
)
2053 read_avail_input (0);
2056 /* Timer callback function for poll_timer. TIMER is equal to
2060 poll_for_input (timer
)
2061 struct atimer
*timer
;
2063 if (poll_suppress_count
== 0)
2064 poll_for_input_1 ();
2067 #endif /* POLL_FOR_INPUT */
2069 /* Begin signals to poll for input, if they are appropriate.
2070 This function is called unconditionally from various places. */
2075 #ifdef POLL_FOR_INPUT
2076 if (read_socket_hook
&& !interrupt_input
)
2078 /* Turn alarm handling on unconditionally. It might have
2079 been turned off in process.c. */
2080 turn_on_atimers (1);
2082 /* If poll timer doesn't exist, are we need one with
2083 a different interval, start a new one. */
2084 if (poll_timer
== NULL
2085 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2087 EMACS_TIME interval
;
2090 cancel_atimer (poll_timer
);
2092 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2093 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2094 poll_for_input
, NULL
);
2097 /* Let the timer's callback function poll for input
2098 if this becomes zero. */
2099 --poll_suppress_count
;
2104 /* Nonzero if we are using polling to handle input asynchronously. */
2107 input_polling_used ()
2109 #ifdef POLL_FOR_INPUT
2110 return read_socket_hook
&& !interrupt_input
;
2116 /* Turn off polling. */
2121 #ifdef POLL_FOR_INPUT
2122 if (read_socket_hook
&& !interrupt_input
)
2123 ++poll_suppress_count
;
2127 /* Set the value of poll_suppress_count to COUNT
2128 and start or stop polling accordingly. */
2131 set_poll_suppress_count (count
)
2134 #ifdef POLL_FOR_INPUT
2135 if (count
== 0 && poll_suppress_count
!= 0)
2137 poll_suppress_count
= 1;
2140 else if (count
!= 0 && poll_suppress_count
== 0)
2144 poll_suppress_count
= count
;
2148 /* Bind polling_period to a value at least N.
2149 But don't decrease it. */
2152 bind_polling_period (n
)
2155 #ifdef POLL_FOR_INPUT
2156 int new = polling_period
;
2161 stop_other_atimers (poll_timer
);
2163 specbind (Qpolling_period
, make_number (new));
2164 /* Start a new alarm with the new period. */
2169 /* Apply the control modifier to CHARACTER. */
2175 /* Save the upper bits here. */
2176 int upper
= c
& ~0177;
2180 /* Everything in the columns containing the upper-case letters
2181 denotes a control character. */
2182 if (c
>= 0100 && c
< 0140)
2186 /* Set the shift modifier for a control char
2187 made from a shifted letter. But only for letters! */
2188 if (oc
>= 'A' && oc
<= 'Z')
2189 c
|= shift_modifier
;
2192 /* The lower-case letters denote control characters too. */
2193 else if (c
>= 'a' && c
<= 'z')
2196 /* Include the bits for control and shift
2197 only if the basic ASCII code can't indicate them. */
2201 /* Replace the high bits. */
2202 c
|= (upper
& ~ctrl_modifier
);
2207 /* Display help echo in the echo area.
2209 HELP a string means display that string, HELP nil means clear the
2210 help echo. If HELP is a function, call it with OBJECT and POS as
2211 arguments; the function should return a help string or nil for
2212 none. For all other types of HELP evaluate it to obtain a string.
2214 WINDOW is the window in which the help was generated, if any.
2215 It is nil if not in a window.
2217 If OBJECT is a buffer, POS is the position in the buffer where the
2218 `help-echo' text property was found.
2220 If OBJECT is an overlay, that overlay has a `help-echo' property,
2221 and POS is the position in the overlay's buffer under the mouse.
2223 If OBJECT is a string (an overlay string or a string displayed with
2224 the `display' property). POS is the position in that string under
2227 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2228 echo overwrites a keystroke echo currently displayed in the echo
2231 Note: this function may only be called with HELP nil or a string
2232 from X code running asynchronously. */
2235 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2236 Lisp_Object help
, window
, object
, pos
;
2237 int ok_to_overwrite_keystroke_echo
;
2239 if (!NILP (help
) && !STRINGP (help
))
2241 if (FUNCTIONP (help
))
2243 Lisp_Object args
[4];
2248 help
= safe_call (4, args
);
2251 help
= safe_eval (help
);
2253 if (!STRINGP (help
))
2257 if (STRINGP (help
) || NILP (help
))
2259 if (!NILP (Vshow_help_function
))
2260 call1 (Vshow_help_function
, help
);
2261 else if (/* Don't overwrite minibuffer contents. */
2262 !MINI_WINDOW_P (XWINDOW (selected_window
))
2263 /* Don't overwrite a keystroke echo. */
2264 && (NILP (echo_message_buffer
)
2265 || ok_to_overwrite_keystroke_echo
)
2266 /* Don't overwrite a prompt. */
2267 && !cursor_in_echo_area
)
2271 int count
= SPECPDL_INDEX ();
2273 if (!help_echo_showing_p
)
2274 Vpre_help_message
= current_message ();
2276 specbind (Qmessage_truncate_lines
, Qt
);
2277 message3_nolog (help
, SBYTES (help
),
2278 STRING_MULTIBYTE (help
));
2279 unbind_to (count
, Qnil
);
2281 else if (STRINGP (Vpre_help_message
))
2283 message3_nolog (Vpre_help_message
,
2284 SBYTES (Vpre_help_message
),
2285 STRING_MULTIBYTE (Vpre_help_message
));
2286 Vpre_help_message
= Qnil
;
2292 help_echo_showing_p
= STRINGP (help
);
2298 /* Input of single characters from keyboard */
2300 Lisp_Object
print_help ();
2301 static Lisp_Object
kbd_buffer_get_event ();
2302 static void record_char ();
2305 static jmp_buf wrong_kboard_jmpbuf
;
2308 #define STOP_POLLING \
2309 do { if (! polling_stopped_here) stop_polling (); \
2310 polling_stopped_here = 1; } while (0)
2312 #define RESUME_POLLING \
2313 do { if (polling_stopped_here) start_polling (); \
2314 polling_stopped_here = 0; } while (0)
2316 /* read a character from the keyboard; call the redisplay if needed */
2317 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2318 -1 means do not do redisplay, but do do autosaving.
2321 /* The arguments MAPS and NMAPS are for menu prompting.
2322 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2324 PREV_EVENT is the previous input event, or nil if we are reading
2325 the first event of a key sequence (or not reading a key sequence).
2326 If PREV_EVENT is t, that is a "magic" value that says
2327 not to run input methods, but in other respects to act as if
2328 not reading a key sequence.
2330 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2331 if we used a mouse menu to read the input, or zero otherwise. If
2332 USED_MOUSE_MENU is null, we don't dereference it.
2334 Value is t if we showed a menu and the user rejected it. */
2337 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2341 Lisp_Object prev_event
;
2342 int *used_mouse_menu
;
2344 volatile Lisp_Object c
;
2346 jmp_buf local_getcjmp
;
2348 volatile int key_already_recorded
= 0;
2349 Lisp_Object tem
, save
;
2350 volatile Lisp_Object previous_echo_area_message
;
2351 volatile Lisp_Object also_record
;
2352 volatile int reread
;
2353 struct gcpro gcpro1
, gcpro2
;
2354 EMACS_TIME last_idle_start
;
2355 int polling_stopped_here
= 0;
2359 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2360 before_command_key_count
= this_command_key_count
;
2361 before_command_echo_length
= echo_length ();
2364 previous_echo_area_message
= Qnil
;
2366 GCPRO2 (c
, previous_echo_area_message
);
2371 if (CONSP (Vunread_post_input_method_events
))
2373 c
= XCAR (Vunread_post_input_method_events
);
2374 Vunread_post_input_method_events
2375 = XCDR (Vunread_post_input_method_events
);
2377 /* Undo what read_char_x_menu_prompt did when it unread
2378 additional keys returned by Fx_popup_menu. */
2380 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2388 if (unread_command_char
!= -1)
2390 XSETINT (c
, unread_command_char
);
2391 unread_command_char
= -1;
2397 if (CONSP (Vunread_command_events
))
2399 c
= XCAR (Vunread_command_events
);
2400 Vunread_command_events
= XCDR (Vunread_command_events
);
2402 /* Undo what read_char_x_menu_prompt did when it unread
2403 additional keys returned by Fx_popup_menu. */
2405 && EQ (XCDR (c
), Qdisabled
)
2406 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2409 /* If the queued event is something that used the mouse,
2410 set used_mouse_menu accordingly. */
2412 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2413 *used_mouse_menu
= 1;
2416 goto reread_for_input_method
;
2419 if (CONSP (Vunread_input_method_events
))
2421 c
= XCAR (Vunread_input_method_events
);
2422 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2424 /* Undo what read_char_x_menu_prompt did when it unread
2425 additional keys returned by Fx_popup_menu. */
2427 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2431 goto reread_for_input_method
;
2434 this_command_key_count_reset
= 0;
2436 if (!NILP (Vexecuting_macro
))
2438 /* We set this to Qmacro; since that's not a frame, nobody will
2439 try to switch frames on us, and the selected window will
2442 Since this event came from a macro, it would be misleading to
2443 leave internal_last_event_frame set to wherever the last
2444 real event came from. Normally, a switch-frame event selects
2445 internal_last_event_frame after each command is read, but
2446 events read from a macro should never cause a new frame to be
2448 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2450 /* Exit the macro if we are at the end.
2451 Also, some things replace the macro with t
2452 to force an early exit. */
2453 if (EQ (Vexecuting_macro
, Qt
)
2454 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2460 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2461 if (STRINGP (Vexecuting_macro
)
2462 && (XINT (c
) & 0x80))
2463 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2465 executing_macro_index
++;
2470 if (!NILP (unread_switch_frame
))
2472 c
= unread_switch_frame
;
2473 unread_switch_frame
= Qnil
;
2475 /* This event should make it into this_command_keys, and get echoed
2476 again, so we do not set `reread'. */
2480 /* if redisplay was requested */
2481 if (commandflag
>= 0)
2483 /* If there is pending input, process any events which are not
2484 user-visible, such as X selection_request events. */
2486 || detect_input_pending_run_timers (0))
2487 swallow_events (0); /* may clear input_pending */
2489 /* Redisplay if no pending input. */
2490 while (!input_pending
)
2492 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2493 redisplay_preserve_echo_area (5);
2498 /* Normal case: no input arrived during redisplay. */
2501 /* Input arrived and pre-empted redisplay.
2502 Process any events which are not user-visible. */
2504 /* If that cleared input_pending, try again to redisplay. */
2508 /* Message turns off echoing unless more keystrokes turn it on again.
2510 The code in 20.x for the condition was
2512 1. echo_area_glyphs && *echo_area_glyphs
2513 2. && echo_area_glyphs != current_kboard->echobuf
2514 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2516 (1) means there's a current message displayed
2518 (2) means it's not the message from echoing from the current
2521 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2522 is set to a non-null value. This is done in read_char and it is
2523 set to echo_area_glyphs after a call to echo_char. That means
2524 ok_to_echo_at_next_pause is either null or
2525 current_kboard->echobuf with the appropriate current_kboard at
2528 So, condition (3) means in clear text ok_to_echo_at_next_pause
2529 must be either null, or the current message isn't from echoing at
2530 all, or it's from echoing from a different kboard than the
2533 if (/* There currently is something in the echo area. */
2534 !NILP (echo_area_buffer
[0])
2535 && (/* And it's either not from echoing. */
2536 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2537 /* Or it's an echo from a different kboard. */
2538 || echo_kboard
!= current_kboard
2539 /* Or we explicitly allow overwriting whatever there is. */
2540 || ok_to_echo_at_next_pause
== NULL
))
2545 /* Try reading a character via menu prompting in the minibuf.
2546 Try this before the sit-for, because the sit-for
2547 would do the wrong thing if we are supposed to do
2548 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2549 after a mouse event so don't try a minibuf menu. */
2551 if (nmaps
> 0 && INTERACTIVE
2552 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2553 /* Don't bring up a menu if we already have another event. */
2554 && NILP (Vunread_command_events
)
2555 && unread_command_char
< 0
2556 && !detect_input_pending_run_timers (0))
2558 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2561 key_already_recorded
= 1;
2566 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2567 We will do that below, temporarily for short sections of code,
2568 when appropriate. local_getcjmp must be in effect
2569 around any call to sit_for or kbd_buffer_get_event;
2570 it *must not* be in effect when we call redisplay. */
2572 if (_setjmp (local_getcjmp
))
2574 XSETINT (c
, quit_char
);
2575 internal_last_event_frame
= selected_frame
;
2576 Vlast_event_frame
= internal_last_event_frame
;
2577 /* If we report the quit char as an event,
2578 don't do so more than once. */
2579 if (!NILP (Vinhibit_quit
))
2584 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2585 if (kb
!= current_kboard
)
2587 Lisp_Object link
= kb
->kbd_queue
;
2588 /* We shouldn't get here if we were in single-kboard mode! */
2593 while (CONSP (XCDR (link
)))
2595 if (!NILP (XCDR (link
)))
2599 kb
->kbd_queue
= Fcons (c
, Qnil
);
2601 XSETCDR (link
, Fcons (c
, Qnil
));
2602 kb
->kbd_queue_has_data
= 1;
2603 current_kboard
= kb
;
2604 /* This is going to exit from read_char
2605 so we had better get rid of this frame's stuff. */
2607 longjmp (wrong_kboard_jmpbuf
, 1);
2614 timer_start_idle ();
2616 /* If in middle of key sequence and minibuffer not active,
2617 start echoing if enough time elapses. */
2619 if (minibuf_level
== 0
2620 && !current_kboard
->immediate_echo
2621 && this_command_key_count
> 0
2623 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2624 && NILP (Fzerop (Vecho_keystrokes
))
2625 && (/* No message. */
2626 NILP (echo_area_buffer
[0])
2627 /* Or empty message. */
2628 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2629 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2630 /* Or already echoing from same kboard. */
2631 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2632 /* Or not echoing before and echoing allowed. */
2633 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2637 /* After a mouse event, start echoing right away.
2638 This is because we are probably about to display a menu,
2639 and we don't want to delay before doing so. */
2640 if (EVENT_HAS_PARAMETERS (prev_event
))
2645 double duration
= extract_float (Vecho_keystrokes
);
2646 sec
= (int) duration
;
2647 usec
= (duration
- sec
) * 1000000;
2648 save_getcjmp (save_jump
);
2649 restore_getcjmp (local_getcjmp
);
2650 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2651 restore_getcjmp (save_jump
);
2653 && ! CONSP (Vunread_command_events
))
2658 /* Maybe auto save due to number of keystrokes. */
2660 if (commandflag
!= 0
2661 && auto_save_interval
> 0
2662 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2663 && !detect_input_pending_run_timers (0))
2665 Fdo_auto_save (Qnil
, Qnil
);
2666 /* Hooks can actually change some buffers in auto save. */
2670 /* Try reading using an X menu.
2671 This is never confused with reading using the minibuf
2672 because the recursive call of read_char in read_char_minibuf_menu_prompt
2673 does not pass on any keymaps. */
2675 if (nmaps
> 0 && INTERACTIVE
2676 && !NILP (prev_event
)
2677 && EVENT_HAS_PARAMETERS (prev_event
)
2678 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2679 && !EQ (XCAR (prev_event
), Qtool_bar
)
2680 /* Don't bring up a menu if we already have another event. */
2681 && NILP (Vunread_command_events
)
2682 && unread_command_char
< 0)
2684 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2686 /* Now that we have read an event, Emacs is not idle. */
2692 /* Maybe autosave and/or garbage collect due to idleness. */
2694 if (INTERACTIVE
&& NILP (c
))
2696 int delay_level
, buffer_size
;
2698 /* Slow down auto saves logarithmically in size of current buffer,
2699 and garbage collect while we're at it. */
2700 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2701 last_non_minibuf_size
= Z
- BEG
;
2702 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2704 while (buffer_size
> 64)
2705 delay_level
++, buffer_size
-= buffer_size
>> 2;
2706 if (delay_level
< 4) delay_level
= 4;
2707 /* delay_level is 4 for files under around 50k, 7 at 100k,
2708 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2710 /* Auto save if enough time goes by without input. */
2711 if (commandflag
!= 0
2712 && num_nonmacro_input_events
> last_auto_save
2713 && INTEGERP (Vauto_save_timeout
)
2714 && XINT (Vauto_save_timeout
) > 0)
2718 save_getcjmp (save_jump
);
2719 restore_getcjmp (local_getcjmp
);
2720 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2722 restore_getcjmp (save_jump
);
2725 && ! CONSP (Vunread_command_events
))
2727 Fdo_auto_save (Qnil
, Qnil
);
2729 /* If we have auto-saved and there is still no input
2730 available, garbage collect if there has been enough
2731 consing going on to make it worthwhile. */
2732 if (!detect_input_pending_run_timers (0)
2733 && consing_since_gc
> gc_cons_threshold
/ 2)
2734 Fgarbage_collect ();
2741 /* If this has become non-nil here, it has been set by a timer
2742 or sentinel or filter. */
2743 if (CONSP (Vunread_command_events
))
2745 c
= XCAR (Vunread_command_events
);
2746 Vunread_command_events
= XCDR (Vunread_command_events
);
2749 /* Read something from current KBOARD's side queue, if possible. */
2753 if (current_kboard
->kbd_queue_has_data
)
2755 if (!CONSP (current_kboard
->kbd_queue
))
2757 c
= XCAR (current_kboard
->kbd_queue
);
2758 current_kboard
->kbd_queue
2759 = XCDR (current_kboard
->kbd_queue
);
2760 if (NILP (current_kboard
->kbd_queue
))
2761 current_kboard
->kbd_queue_has_data
= 0;
2762 input_pending
= readable_events (0);
2763 if (EVENT_HAS_PARAMETERS (c
)
2764 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2765 internal_last_event_frame
= XCAR (XCDR (c
));
2766 Vlast_event_frame
= internal_last_event_frame
;
2771 /* If current_kboard's side queue is empty check the other kboards.
2772 If one of them has data that we have not yet seen here,
2773 switch to it and process the data waiting for it.
2775 Note: if the events queued up for another kboard
2776 have already been seen here, and therefore are not a complete command,
2777 the kbd_queue_has_data field is 0, so we skip that kboard here.
2778 That's to avoid an infinite loop switching between kboards here. */
2779 if (NILP (c
) && !single_kboard
)
2782 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2783 if (kb
->kbd_queue_has_data
)
2785 current_kboard
= kb
;
2786 /* This is going to exit from read_char
2787 so we had better get rid of this frame's stuff. */
2789 longjmp (wrong_kboard_jmpbuf
, 1);
2798 /* Finally, we read from the main queue,
2799 and if that gives us something we can't use yet, we put it on the
2800 appropriate side queue and try again. */
2806 /* Actually read a character, waiting if necessary. */
2807 save_getcjmp (save_jump
);
2808 restore_getcjmp (local_getcjmp
);
2809 timer_start_idle ();
2810 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2811 restore_getcjmp (save_jump
);
2814 if (! NILP (c
) && (kb
!= current_kboard
))
2816 Lisp_Object link
= kb
->kbd_queue
;
2819 while (CONSP (XCDR (link
)))
2821 if (!NILP (XCDR (link
)))
2825 kb
->kbd_queue
= Fcons (c
, Qnil
);
2827 XSETCDR (link
, Fcons (c
, Qnil
));
2828 kb
->kbd_queue_has_data
= 1;
2832 current_kboard
= kb
;
2833 /* This is going to exit from read_char
2834 so we had better get rid of this frame's stuff. */
2836 longjmp (wrong_kboard_jmpbuf
, 1);
2841 /* Terminate Emacs in batch mode if at eof. */
2842 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2843 Fkill_emacs (make_number (1));
2847 /* Add in any extra modifiers, where appropriate. */
2848 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2849 || ((extra_keyboard_modifiers
& 0177) < ' '
2850 && (extra_keyboard_modifiers
& 0177) != 0))
2851 XSETINT (c
, make_ctrl_char (XINT (c
)));
2853 /* Transfer any other modifier bits directly from
2854 extra_keyboard_modifiers to c. Ignore the actual character code
2855 in the low 16 bits of extra_keyboard_modifiers. */
2856 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2861 /* Record the last idle start time so that we can reset it
2862 should the next event read be a help-echo. */
2863 last_idle_start
= timer_idleness_start_time
;
2869 if (commandflag
>= 0
2870 && !input_pending
&& !detect_input_pending_run_timers (0))
2878 /* Buffer switch events are only for internal wakeups
2879 so don't show them to the user.
2880 Also, don't record a key if we already did. */
2881 if (BUFFERP (c
) || key_already_recorded
)
2884 /* Process special events within read_char
2885 and loop around to read another event. */
2888 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2893 int was_locked
= single_kboard
;
2895 last_input_char
= c
;
2896 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2898 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2899 /* We stopped being idle for this event; undo that. This
2900 prevents automatic window selection (under
2901 mouse_autoselect_window from acting as a real input event, for
2902 example banishing the mouse under mouse-avoidance-mode. */
2903 timer_idleness_start_time
= last_idle_start
;
2905 /* Resume allowing input from any kboard, if that was true before. */
2907 any_kboard_state ();
2912 /* Handle things that only apply to characters. */
2915 /* If kbd_buffer_get_event gave us an EOF, return that. */
2919 if ((STRINGP (Vkeyboard_translate_table
)
2920 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2921 || (VECTORP (Vkeyboard_translate_table
)
2922 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2923 || CHAR_TABLE_P (Vkeyboard_translate_table
))
2926 d
= Faref (Vkeyboard_translate_table
, c
);
2927 /* nil in keyboard-translate-table means no translation. */
2933 /* If this event is a mouse click in the menu bar,
2934 return just menu-bar for now. Modify the mouse click event
2935 so we won't do this twice, then queue it up. */
2936 if (EVENT_HAS_PARAMETERS (c
)
2938 && CONSP (EVENT_START (c
))
2939 && CONSP (XCDR (EVENT_START (c
))))
2943 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2944 /* Handle menu-bar events:
2945 insert the dummy prefix event `menu-bar'. */
2946 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2948 /* Change menu-bar to (menu-bar) as the event "position". */
2949 POSN_BUFFER_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2952 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2957 /* Store these characters into recent_keys, the dribble file if any,
2958 and the keyboard macro being defined, if any. */
2960 if (! NILP (also_record
))
2961 record_char (also_record
);
2963 /* Wipe the echo area.
2964 But first, if we are about to use an input method,
2965 save the echo area contents for it to refer to. */
2967 && ! NILP (Vinput_method_function
)
2968 && (unsigned) XINT (c
) >= ' '
2969 && (unsigned) XINT (c
) != 127
2970 && (unsigned) XINT (c
) < 256)
2972 previous_echo_area_message
= Fcurrent_message ();
2973 Vinput_method_previous_message
= previous_echo_area_message
;
2976 /* Now wipe the echo area, except for help events which do their
2977 own stuff with the echo area. */
2979 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2980 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2982 if (!NILP (echo_area_buffer
[0]))
2983 safe_run_hooks (Qecho_area_clear_hook
);
2984 clear_message (1, 0);
2987 reread_for_input_method
:
2989 /* Pass this to the input method, if appropriate. */
2991 && ! NILP (Vinput_method_function
)
2992 /* Don't run the input method within a key sequence,
2993 after the first event of the key sequence. */
2994 && NILP (prev_event
)
2995 && (unsigned) XINT (c
) >= ' '
2996 && (unsigned) XINT (c
) != 127
2997 && (unsigned) XINT (c
) < 256)
3000 int key_count
, key_count_reset
;
3001 struct gcpro gcpro1
;
3002 int count
= SPECPDL_INDEX ();
3004 /* Save the echo status. */
3005 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3006 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3007 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3010 if (before_command_restore_flag
)
3012 this_command_key_count
= before_command_key_count_1
;
3013 if (this_command_key_count
< this_single_command_key_start
)
3014 this_single_command_key_start
= this_command_key_count
;
3015 echo_truncate (before_command_echo_length_1
);
3016 before_command_restore_flag
= 0;
3020 /* Save the this_command_keys status. */
3021 key_count
= this_command_key_count
;
3022 key_count_reset
= this_command_key_count_reset
;
3025 keys
= Fcopy_sequence (this_command_keys
);
3030 /* Clear out this_command_keys. */
3031 this_command_key_count
= 0;
3032 this_command_key_count_reset
= 0;
3034 /* Now wipe the echo area. */
3035 if (!NILP (echo_area_buffer
[0]))
3036 safe_run_hooks (Qecho_area_clear_hook
);
3037 clear_message (1, 0);
3040 /* If we are not reading a key sequence,
3041 never use the echo area. */
3044 specbind (Qinput_method_use_echo_area
, Qt
);
3047 /* Call the input method. */
3048 tem
= call1 (Vinput_method_function
, c
);
3050 tem
= unbind_to (count
, tem
);
3052 /* Restore the saved echoing state
3053 and this_command_keys state. */
3054 this_command_key_count
= key_count
;
3055 this_command_key_count_reset
= key_count_reset
;
3057 this_command_keys
= keys
;
3060 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3061 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3062 if (saved_immediate_echo
)
3067 /* The input method can return no events. */
3070 /* Bring back the previous message, if any. */
3071 if (! NILP (previous_echo_area_message
))
3072 message_with_string ("%s", previous_echo_area_message
, 0);
3075 /* It returned one event or more. */
3077 Vunread_post_input_method_events
3078 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3083 /* Display help if not echoing. */
3084 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3086 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3087 Lisp_Object help
, object
, position
, window
, tem
;
3089 tem
= Fcdr (XCDR (c
));
3092 window
= Fcar (tem
);
3094 object
= Fcar (tem
);
3096 position
= Fcar (tem
);
3098 show_help_echo (help
, window
, object
, position
, 0);
3100 /* We stopped being idle for this event; undo that. */
3101 timer_idleness_start_time
= last_idle_start
;
3105 if (! reread
|| this_command_key_count
== 0
3106 || this_command_key_count_reset
)
3109 /* Don't echo mouse motion events. */
3110 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3111 && NILP (Fzerop (Vecho_keystrokes
))
3112 && ! (EVENT_HAS_PARAMETERS (c
)
3113 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3116 if (! NILP (also_record
))
3117 echo_char (also_record
);
3118 /* Once we reread a character, echoing can happen
3119 the next time we pause to read a new one. */
3120 ok_to_echo_at_next_pause
= current_kboard
;
3123 /* Record this character as part of the current key. */
3124 add_command_key (c
);
3125 if (! NILP (also_record
))
3126 add_command_key (also_record
);
3129 last_input_char
= c
;
3132 /* Process the help character specially if enabled */
3133 if (!NILP (Vhelp_form
) && help_char_p (c
))
3136 count
= SPECPDL_INDEX ();
3138 record_unwind_protect (Fset_window_configuration
,
3139 Fcurrent_window_configuration (Qnil
));
3141 tem0
= Feval (Vhelp_form
);
3143 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3147 c
= read_char (0, 0, 0, Qnil
, 0);
3148 while (BUFFERP (c
));
3149 /* Remove the help from the frame */
3150 unbind_to (count
, Qnil
);
3153 if (EQ (c
, make_number (040)))
3157 c
= read_char (0, 0, 0, Qnil
, 0);
3158 while (BUFFERP (c
));
3167 /* Record a key that came from a mouse menu.
3168 Record it for echoing, for this-command-keys, and so on. */
3174 /* Wipe the echo area. */
3175 clear_message (1, 0);
3180 before_command_key_count
= this_command_key_count
;
3181 before_command_echo_length
= echo_length ();
3184 /* Don't echo mouse motion events. */
3185 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3186 && NILP (Fzerop (Vecho_keystrokes
)))
3190 /* Once we reread a character, echoing can happen
3191 the next time we pause to read a new one. */
3192 ok_to_echo_at_next_pause
= 0;
3195 /* Record this character as part of the current key. */
3196 add_command_key (c
);
3198 /* Re-reading in the middle of a command */
3199 last_input_char
= c
;
3203 /* Return 1 if should recognize C as "the help character". */
3211 if (EQ (c
, Vhelp_char
))
3213 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3214 if (EQ (c
, XCAR (tail
)))
3219 /* Record the input event C in various ways. */
3227 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3229 /* To avoid filling recent_keys with help-echo and mouse-movement
3230 events, we filter out repeated help-echo events, only store the
3231 first and last in a series of mouse-movement events, and don't
3232 store repeated help-echo events which are only separated by
3233 mouse-movement events. */
3235 Lisp_Object ev1
, ev2
, ev3
;
3238 if ((ix1
= recent_keys_index
- 1) < 0)
3239 ix1
= NUM_RECENT_KEYS
- 1;
3240 ev1
= AREF (recent_keys
, ix1
);
3242 if ((ix2
= ix1
- 1) < 0)
3243 ix2
= NUM_RECENT_KEYS
- 1;
3244 ev2
= AREF (recent_keys
, ix2
);
3246 if ((ix3
= ix2
- 1) < 0)
3247 ix3
= NUM_RECENT_KEYS
- 1;
3248 ev3
= AREF (recent_keys
, ix3
);
3250 if (EQ (XCAR (c
), Qhelp_echo
))
3252 /* Don't record `help-echo' in recent_keys unless it shows some help
3253 message, and a different help than the previously recorded
3255 Lisp_Object help
, last_help
;
3257 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3258 if (!STRINGP (help
))
3260 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3261 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3263 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3264 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3265 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3267 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3268 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3269 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3270 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3273 else if (EQ (XCAR (c
), Qmouse_movement
))
3275 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3276 So additional mouse movement events replace the last element. */
3277 Lisp_Object last_window
, window
;
3279 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3280 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3281 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3282 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3283 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3285 ASET (recent_keys
, ix1
, c
);
3291 store_kbd_macro_char (c
);
3296 ASET (recent_keys
, recent_keys_index
, c
);
3297 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3298 recent_keys_index
= 0;
3300 else if (recorded
< 0)
3302 /* We need to remove one or two events from recent_keys.
3303 To do this, we simply put nil at those events and move the
3304 recent_keys_index backwards over those events. Usually,
3305 users will never see those nil events, as they will be
3306 overwritten by the command keys entered to see recent_keys
3309 while (recorded
++ < 0 && total_keys
> 0)
3311 if (total_keys
< NUM_RECENT_KEYS
)
3313 if (--recent_keys_index
< 0)
3314 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3315 ASET (recent_keys
, recent_keys_index
, Qnil
);
3319 num_nonmacro_input_events
++;
3321 /* Write c to the dribble file. If c is a lispy event, write
3322 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3323 If you, dear reader, have a better idea, you've got the source. :-) */
3328 if (XUINT (c
) < 0x100)
3329 putc (XINT (c
), dribble
);
3331 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3335 Lisp_Object dribblee
;
3337 /* If it's a structured event, take the event header. */
3338 dribblee
= EVENT_HEAD (c
);
3340 if (SYMBOLP (dribblee
))
3342 putc ('<', dribble
);
3343 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3344 SBYTES (SYMBOL_NAME (dribblee
)),
3346 putc ('>', dribble
);
3358 struct buffer
*old
= current_buffer
;
3359 Fprinc (object
, Qnil
);
3360 set_buffer_internal (XBUFFER (Vstandard_output
));
3361 call0 (intern ("help-mode"));
3362 set_buffer_internal (old
);
3366 /* Copy out or in the info on where C-g should throw to.
3367 This is used when running Lisp code from within get_char,
3368 in case get_char is called recursively.
3369 See read_process_output. */
3375 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3379 restore_getcjmp (temp
)
3382 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3387 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3388 of this function. */
3391 tracking_off (old_value
)
3392 Lisp_Object old_value
;
3394 do_mouse_tracking
= old_value
;
3395 if (NILP (old_value
))
3397 /* Redisplay may have been preempted because there was input
3398 available, and it assumes it will be called again after the
3399 input has been processed. If the only input available was
3400 the sort that we have just disabled, then we need to call
3402 if (!readable_events (1))
3404 redisplay_preserve_echo_area (6);
3405 get_input_pending (&input_pending
, 1);
3411 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3412 doc
: /* Evaluate BODY with mouse movement events enabled.
3413 Within a `track-mouse' form, mouse motion generates input events that
3414 you can read with `read-event'.
3415 Normally, mouse motion is ignored.
3416 usage: (track-mouse BODY ...) */)
3420 int count
= SPECPDL_INDEX ();
3423 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3425 do_mouse_tracking
= Qt
;
3427 val
= Fprogn (args
);
3428 return unbind_to (count
, val
);
3431 /* If mouse has moved on some frame, return one of those frames.
3432 Return 0 otherwise. */
3437 Lisp_Object tail
, frame
;
3439 FOR_EACH_FRAME (tail
, frame
)
3441 if (XFRAME (frame
)->mouse_moved
)
3442 return XFRAME (frame
);
3448 #endif /* HAVE_MOUSE */
3450 /* Low level keyboard/mouse input.
3451 kbd_buffer_store_event places events in kbd_buffer, and
3452 kbd_buffer_get_event retrieves them. */
3454 /* Return true iff there are any events in the queue that read-char
3455 would return. If this returns false, a read-char would block. */
3457 readable_filtered_events (do_timers_now
, filter_events
)
3462 timer_check (do_timers_now
);
3464 /* If the buffer contains only FOCUS_IN_EVENT events,
3465 and FILTER_EVENTS is nonzero, report it as empty. */
3466 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3468 int have_live_event
= 1;
3472 struct input_event
*event
;
3474 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3478 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3481 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3483 if (event
== kbd_store_ptr
)
3484 have_live_event
= 0;
3487 if (have_live_event
) return 1;
3491 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3496 if (current_kboard
->kbd_queue_has_data
)
3502 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3503 if (kb
->kbd_queue_has_data
)
3509 /* Return true iff there are any events in the queue that read-char
3510 would return. If this returns false, a read-char would block. */
3512 readable_events (do_timers_now
)
3515 return readable_filtered_events (do_timers_now
, 0);
3518 /* Set this for debugging, to have a way to get out */
3523 event_to_kboard (event
)
3524 struct input_event
*event
;
3527 frame
= event
->frame_or_window
;
3529 frame
= XCAR (frame
);
3530 else if (WINDOWP (frame
))
3531 frame
= WINDOW_FRAME (XWINDOW (frame
));
3533 /* There are still some events that don't set this field.
3534 For now, just ignore the problem.
3535 Also ignore dead frames here. */
3536 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3539 return FRAME_KBOARD (XFRAME (frame
));
3543 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3546 kbd_buffer_store_event (event
)
3547 register struct input_event
*event
;
3549 if (event
->kind
== NO_EVENT
)
3552 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3554 register int c
= event
->code
& 0377;
3556 if (event
->modifiers
& ctrl_modifier
)
3557 c
= make_ctrl_char (c
);
3559 c
|= (event
->modifiers
3560 & (meta_modifier
| alt_modifier
3561 | hyper_modifier
| super_modifier
));
3567 struct input_event
*sp
;
3570 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3571 kb
!= current_kboard
))
3574 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3575 Fcons (make_number (c
), Qnil
));
3576 kb
->kbd_queue_has_data
= 1;
3577 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3579 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3582 if (event_to_kboard (sp
) == kb
)
3584 sp
->kind
= NO_EVENT
;
3585 sp
->frame_or_window
= Qnil
;
3593 /* If this results in a quit_char being returned to Emacs as
3594 input, set Vlast_event_frame properly. If this doesn't
3595 get returned to Emacs as an event, the next event read
3596 will set Vlast_event_frame again, so this is safe to do. */
3600 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3602 focus
= event
->frame_or_window
;
3603 internal_last_event_frame
= focus
;
3604 Vlast_event_frame
= focus
;
3607 last_event_timestamp
= event
->timestamp
;
3608 interrupt_signal (0 /* dummy */);
3612 if (c
&& c
== stop_character
)
3618 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3619 Just ignore the second one. */
3620 else if (event
->kind
== BUFFER_SWITCH_EVENT
3621 && kbd_fetch_ptr
!= kbd_store_ptr
3622 && kbd_store_ptr
->kind
== BUFFER_SWITCH_EVENT
)
3625 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3626 kbd_store_ptr
= kbd_buffer
;
3628 /* Don't let the very last slot in the buffer become full,
3629 since that would make the two pointers equal,
3630 and that is indistinguishable from an empty buffer.
3631 Discard the event if it would fill the last slot. */
3632 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3636 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3637 prone to assign individual members for other events, in case
3638 the input_event structure is changed. --2000-07-13, gerd. */
3639 struct input_event
*sp
= kbd_store_ptr
;
3640 sp
->kind
= event
->kind
;
3641 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3643 /* We must not use the ordinary copying code for this case,
3644 since `part' is an enum and copying it might not copy enough
3646 bcopy (event
, (char *) sp
, sizeof (*event
));
3651 sp
->code
= event
->code
;
3652 sp
->part
= event
->part
;
3653 sp
->frame_or_window
= event
->frame_or_window
;
3654 sp
->arg
= event
->arg
;
3655 sp
->modifiers
= event
->modifiers
;
3658 sp
->timestamp
= event
->timestamp
;
3661 *kbd_store_ptr
= *event
;
3664 idx
= 2 * (kbd_store_ptr
- kbd_buffer
);
3665 ASET (kbd_buffer_gcpro
, idx
, event
->frame_or_window
);
3666 ASET (kbd_buffer_gcpro
, idx
+ 1, event
->arg
);
3672 /* Generate HELP_EVENT input_events in BUFP which has room for
3673 SIZE events. If there's not enough room in BUFP, ignore this
3676 HELP is the help form.
3678 FRAME is the frame on which the help is generated. OBJECT is the
3679 Lisp object where the help was found (a buffer, a string, an
3680 overlay, or nil if neither from a string nor from a buffer. POS is
3681 the position within OBJECT where the help was found.
3683 Value is the number of input_events generated. */
3686 gen_help_event (bufp
, size
, help
, frame
, window
, object
, pos
)
3687 struct input_event
*bufp
;
3689 Lisp_Object help
, frame
, object
, window
;
3694 bufp
->kind
= HELP_EVENT
;
3695 bufp
->frame_or_window
= frame
;
3697 bufp
->x
= WINDOWP (window
) ? window
: frame
;
3706 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3709 kbd_buffer_store_help_event (frame
, help
)
3710 Lisp_Object frame
, help
;
3712 struct input_event event
;
3714 event
.kind
= HELP_EVENT
;
3715 event
.frame_or_window
= frame
;
3720 kbd_buffer_store_event (&event
);
3724 /* Discard any mouse events in the event buffer by setting them to
3727 discard_mouse_events ()
3729 struct input_event
*sp
;
3730 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3732 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3735 if (sp
->kind
== MOUSE_CLICK_EVENT
3736 || sp
->kind
== WHEEL_EVENT
3738 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3740 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3742 sp
->kind
= NO_EVENT
;
3748 /* Return non-zero if there are any real events waiting in the event
3749 buffer, not counting `NO_EVENT's.
3751 If DISCARD is non-zero, discard NO_EVENT events at the front of
3752 the input queue, possibly leaving the input queue empty if there
3753 are no real input events. */
3756 kbd_buffer_events_waiting (discard
)
3759 struct input_event
*sp
;
3761 for (sp
= kbd_fetch_ptr
;
3762 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3765 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3772 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3776 /* Clear input event EVENT. */
3780 struct input_event
*event
;
3782 int idx
= 2 * (event
- kbd_buffer
);
3783 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
3784 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
3785 event
->kind
= NO_EVENT
;
3789 /* Read one event from the event buffer, waiting if necessary.
3790 The value is a Lisp object representing the event.
3791 The value is nil for an event that should be ignored,
3792 or that was handled here.
3793 We always read and discard one event. */
3796 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3798 int *used_mouse_menu
;
3807 *kbp
= current_kboard
;
3811 /* Wait until there is input available. */
3814 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3817 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3821 /* If the quit flag is set, then read_char will return
3822 quit_char, so that counts as "available input." */
3823 if (!NILP (Vquit_flag
))
3824 quit_throw_to_read_char ();
3826 /* One way or another, wait until input is available; then, if
3827 interrupt handlers have not read it, read it now. */
3830 wait_for_kbd_input ();
3832 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3836 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3839 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3843 Lisp_Object minus_one
;
3845 XSETINT (minus_one
, -1);
3846 wait_reading_process_input (0, 0, minus_one
, 1);
3848 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3849 /* Pass 1 for EXPECT since we just waited to have input. */
3850 read_avail_input (1);
3852 #endif /* not VMS */
3855 if (CONSP (Vunread_command_events
))
3858 first
= XCAR (Vunread_command_events
);
3859 Vunread_command_events
= XCDR (Vunread_command_events
);
3860 *kbp
= current_kboard
;
3864 /* At this point, we know that there is a readable event available
3865 somewhere. If the event queue is empty, then there must be a
3866 mouse movement enabled and available. */
3867 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3869 struct input_event
*event
;
3871 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3875 last_event_timestamp
= event
->timestamp
;
3878 *kbp
= event_to_kboard (event
);
3880 *kbp
= current_kboard
; /* Better than returning null ptr? */
3882 *kbp
= &the_only_kboard
;
3887 /* These two kinds of events get special handling
3888 and don't actually appear to the command loop.
3889 We return nil for them. */
3890 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3893 struct input_event copy
;
3895 /* Remove it from the buffer before processing it,
3896 since otherwise swallow_events will see it
3897 and process it again. */
3899 kbd_fetch_ptr
= event
+ 1;
3900 input_pending
= readable_events (0);
3901 x_handle_selection_request (©
);
3903 /* We're getting selection request events, but we don't have
3909 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3912 struct input_event copy
;
3914 /* Remove it from the buffer before processing it. */
3916 kbd_fetch_ptr
= event
+ 1;
3917 input_pending
= readable_events (0);
3918 x_handle_selection_clear (©
);
3920 /* We're getting selection request events, but we don't have
3925 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3926 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3928 /* Make an event (delete-frame (FRAME)). */
3929 obj
= Fcons (event
->frame_or_window
, Qnil
);
3930 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3931 kbd_fetch_ptr
= event
+ 1;
3934 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3935 else if (event
->kind
== ICONIFY_EVENT
)
3937 /* Make an event (iconify-frame (FRAME)). */
3938 obj
= Fcons (event
->frame_or_window
, Qnil
);
3939 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3940 kbd_fetch_ptr
= event
+ 1;
3942 else if (event
->kind
== DEICONIFY_EVENT
)
3944 /* Make an event (make-frame-visible (FRAME)). */
3945 obj
= Fcons (event
->frame_or_window
, Qnil
);
3946 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3947 kbd_fetch_ptr
= event
+ 1;
3950 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3952 /* The value doesn't matter here; only the type is tested. */
3953 XSETBUFFER (obj
, current_buffer
);
3954 kbd_fetch_ptr
= event
+ 1;
3956 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
3957 || defined (USE_GTK)
3958 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3960 kbd_fetch_ptr
= event
+ 1;
3961 input_pending
= readable_events (0);
3962 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3963 x_activate_menubar (XFRAME (event
->frame_or_window
));
3967 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3969 /* Make an event (language-change (FRAME CHARSET LCID)). */
3970 obj
= Fcons (event
->modifiers
, Qnil
);
3971 obj
= Fcons (event
->code
, obj
);
3972 obj
= Fcons (event
->frame_or_window
, obj
);
3973 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3974 kbd_fetch_ptr
= event
+ 1;
3977 else if (event
->kind
== SAVE_SESSION_EVENT
)
3979 obj
= Fcons (Qsave_session
, Qnil
);
3980 kbd_fetch_ptr
= event
+ 1;
3982 /* Just discard these, by returning nil.
3983 With MULTI_KBOARD, these events are used as placeholders
3984 when we need to randomly delete events from the queue.
3985 (They shouldn't otherwise be found in the buffer,
3986 but on some machines it appears they do show up
3987 even without MULTI_KBOARD.) */
3988 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3989 mouse events during a popup-menu call. */
3990 else if (event
->kind
== NO_EVENT
)
3991 kbd_fetch_ptr
= event
+ 1;
3992 else if (event
->kind
== HELP_EVENT
)
3994 Lisp_Object object
, position
, help
, frame
, window
;
3996 frame
= event
->frame_or_window
;
3997 object
= event
->arg
;
3998 position
= make_number (event
->code
);
4001 clear_event (event
);
4003 kbd_fetch_ptr
= event
+ 1;
4004 if (!WINDOWP (window
))
4006 obj
= Fcons (Qhelp_echo
,
4007 list5 (frame
, help
, window
, object
, position
));
4009 else if (event
->kind
== FOCUS_IN_EVENT
)
4011 /* Notification of a FocusIn event. The frame receiving the
4012 focus is in event->frame_or_window. Generate a
4013 switch-frame event if necessary. */
4014 Lisp_Object frame
, focus
;
4016 frame
= event
->frame_or_window
;
4017 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4021 if (!EQ (frame
, internal_last_event_frame
)
4022 && !EQ (frame
, selected_frame
))
4023 obj
= make_lispy_switch_frame (frame
);
4024 internal_last_event_frame
= frame
;
4025 kbd_fetch_ptr
= event
+ 1;
4029 /* If this event is on a different frame, return a switch-frame this
4030 time, and leave the event in the queue for next time. */
4034 frame
= event
->frame_or_window
;
4036 frame
= XCAR (frame
);
4037 else if (WINDOWP (frame
))
4038 frame
= WINDOW_FRAME (XWINDOW (frame
));
4040 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4044 if (! EQ (frame
, internal_last_event_frame
)
4045 && !EQ (frame
, selected_frame
))
4046 obj
= make_lispy_switch_frame (frame
);
4047 internal_last_event_frame
= frame
;
4049 /* If we didn't decide to make a switch-frame event, go ahead
4050 and build a real event from the queue entry. */
4054 obj
= make_lispy_event (event
);
4056 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4057 || defined (USE_GTK)
4058 /* If this was a menu selection, then set the flag to inhibit
4059 writing to last_nonmenu_event. Don't do this if the event
4060 we're returning is (menu-bar), though; that indicates the
4061 beginning of the menu sequence, and we might as well leave
4062 that as the `event with parameters' for this selection. */
4064 && !EQ (event
->frame_or_window
, event
->arg
)
4065 && (event
->kind
== MENU_BAR_EVENT
4066 || event
->kind
== TOOL_BAR_EVENT
))
4067 *used_mouse_menu
= 1;
4070 /* Wipe out this event, to catch bugs. */
4071 clear_event (event
);
4072 kbd_fetch_ptr
= event
+ 1;
4077 /* Try generating a mouse motion event. */
4078 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4080 FRAME_PTR f
= some_mouse_moved ();
4081 Lisp_Object bar_window
;
4082 enum scroll_bar_part part
;
4086 *kbp
= current_kboard
;
4087 /* Note that this uses F to determine which display to look at.
4088 If there is no valid info, it does not store anything
4089 so x remains nil. */
4091 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4095 /* Decide if we should generate a switch-frame event. Don't
4096 generate switch-frame events for motion outside of all Emacs
4102 frame
= FRAME_FOCUS_FRAME (f
);
4104 XSETFRAME (frame
, f
);
4106 if (! EQ (frame
, internal_last_event_frame
)
4107 && !EQ (frame
, selected_frame
))
4108 obj
= make_lispy_switch_frame (frame
);
4109 internal_last_event_frame
= frame
;
4112 /* If we didn't decide to make a switch-frame event, go ahead and
4113 return a mouse-motion event. */
4114 if (!NILP (x
) && NILP (obj
))
4115 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4117 #endif /* HAVE_MOUSE */
4119 /* We were promised by the above while loop that there was
4120 something for us to read! */
4123 input_pending
= readable_events (0);
4125 Vlast_event_frame
= internal_last_event_frame
;
4130 /* Process any events that are not user-visible,
4131 then return, without reading any user-visible events. */
4134 swallow_events (do_display
)
4139 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4141 struct input_event
*event
;
4143 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4147 last_event_timestamp
= event
->timestamp
;
4149 /* These two kinds of events get special handling
4150 and don't actually appear to the command loop. */
4151 if (event
->kind
== SELECTION_REQUEST_EVENT
)
4154 struct input_event copy
;
4156 /* Remove it from the buffer before processing it,
4157 since otherwise swallow_events called recursively could see it
4158 and process it again. */
4160 kbd_fetch_ptr
= event
+ 1;
4161 input_pending
= readable_events (0);
4162 x_handle_selection_request (©
);
4164 /* We're getting selection request events, but we don't have
4170 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
4173 struct input_event copy
;
4175 /* Remove it from the buffer before processing it, */
4178 kbd_fetch_ptr
= event
+ 1;
4179 input_pending
= readable_events (0);
4180 x_handle_selection_clear (©
);
4182 /* We're getting selection request events, but we don't have
4191 old_timers_run
= timers_run
;
4192 get_input_pending (&input_pending
, 1);
4194 if (timers_run
!= old_timers_run
&& do_display
)
4195 redisplay_preserve_echo_area (7);
4198 /* Record the start of when Emacs is idle,
4199 for the sake of running idle-time timers. */
4206 /* If we are already in the idle state, do nothing. */
4207 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4210 EMACS_GET_TIME (timer_idleness_start_time
);
4212 timer_last_idleness_start_time
= timer_idleness_start_time
;
4214 /* Mark all idle-time timers as once again candidates for running. */
4215 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4219 timer
= XCAR (timers
);
4221 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4223 XVECTOR (timer
)->contents
[0] = Qnil
;
4227 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4232 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4235 /* This is only for debugging. */
4236 struct input_event last_timer_event
;
4238 /* Check whether a timer has fired. To prevent larger problems we simply
4239 disregard elements that are not proper timers. Do not make a circular
4240 timer list for the time being.
4242 Returns the number of seconds to wait until the next timer fires. If a
4243 timer is triggering now, return zero seconds.
4244 If no timer is active, return -1 seconds.
4246 If a timer is ripe, we run it, with quitting turned off.
4248 DO_IT_NOW is now ignored. It used to mean that we should
4249 run the timer directly instead of queueing a timer-event.
4250 Now we always run timers directly. */
4253 timer_check (do_it_now
)
4256 EMACS_TIME nexttime
;
4257 EMACS_TIME now
, idleness_now
;
4258 Lisp_Object timers
, idle_timers
, chosen_timer
;
4259 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4261 EMACS_SET_SECS (nexttime
, -1);
4262 EMACS_SET_USECS (nexttime
, -1);
4264 /* Always consider the ordinary timers. */
4265 timers
= Vtimer_list
;
4266 /* Consider the idle timers only if Emacs is idle. */
4267 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4268 idle_timers
= Vtimer_idle_list
;
4271 chosen_timer
= Qnil
;
4272 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4274 if (CONSP (timers
) || CONSP (idle_timers
))
4276 EMACS_GET_TIME (now
);
4277 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4278 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4281 while (CONSP (timers
) || CONSP (idle_timers
))
4283 Lisp_Object
*vector
;
4284 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4285 EMACS_TIME timer_time
, idle_timer_time
;
4286 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4288 /* Skip past invalid timers and timers already handled. */
4291 timer
= XCAR (timers
);
4292 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4294 timers
= XCDR (timers
);
4297 vector
= XVECTOR (timer
)->contents
;
4299 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4300 || !INTEGERP (vector
[3])
4301 || ! NILP (vector
[0]))
4303 timers
= XCDR (timers
);
4307 if (!NILP (idle_timers
))
4309 timer
= XCAR (idle_timers
);
4310 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4312 idle_timers
= XCDR (idle_timers
);
4315 vector
= XVECTOR (timer
)->contents
;
4317 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4318 || !INTEGERP (vector
[3])
4319 || ! NILP (vector
[0]))
4321 idle_timers
= XCDR (idle_timers
);
4326 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4327 based on the next ordinary timer.
4328 TIMER_DIFFERENCE is the distance in time from NOW to when
4329 this timer becomes ripe (negative if it's already ripe). */
4332 timer
= XCAR (timers
);
4333 vector
= XVECTOR (timer
)->contents
;
4334 EMACS_SET_SECS (timer_time
,
4335 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4336 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4337 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4340 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4341 based on the next idle timer. */
4342 if (!NILP (idle_timers
))
4344 idle_timer
= XCAR (idle_timers
);
4345 vector
= XVECTOR (idle_timer
)->contents
;
4346 EMACS_SET_SECS (idle_timer_time
,
4347 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4348 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4349 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4352 /* Decide which timer is the next timer,
4353 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4354 Also step down the list where we found that timer. */
4356 if (! NILP (timers
) && ! NILP (idle_timers
))
4359 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4360 if (EMACS_TIME_NEG_P (temp
))
4362 chosen_timer
= timer
;
4363 timers
= XCDR (timers
);
4364 difference
= timer_difference
;
4368 chosen_timer
= idle_timer
;
4369 idle_timers
= XCDR (idle_timers
);
4370 difference
= idle_timer_difference
;
4373 else if (! NILP (timers
))
4375 chosen_timer
= timer
;
4376 timers
= XCDR (timers
);
4377 difference
= timer_difference
;
4381 chosen_timer
= idle_timer
;
4382 idle_timers
= XCDR (idle_timers
);
4383 difference
= idle_timer_difference
;
4385 vector
= XVECTOR (chosen_timer
)->contents
;
4387 /* If timer is ripe, run it if it hasn't been run. */
4388 if (EMACS_TIME_NEG_P (difference
)
4389 || (EMACS_SECS (difference
) == 0
4390 && EMACS_USECS (difference
) == 0))
4392 if (NILP (vector
[0]))
4394 int was_locked
= single_kboard
;
4395 int count
= SPECPDL_INDEX ();
4396 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4398 /* Mark the timer as triggered to prevent problems if the lisp
4399 code fails to reschedule it right. */
4402 specbind (Qinhibit_quit
, Qt
);
4404 call1 (Qtimer_event_handler
, chosen_timer
);
4405 Vdeactivate_mark
= old_deactivate_mark
;
4407 unbind_to (count
, Qnil
);
4409 /* Resume allowing input from any kboard, if that was true before. */
4411 any_kboard_state ();
4413 /* Since we have handled the event,
4414 we don't need to tell the caller to wake up and do it. */
4418 /* When we encounter a timer that is still waiting,
4419 return the amount of time to wait before it is ripe. */
4426 /* No timers are pending in the future. */
4427 /* Return 0 if we generated an event, and -1 if not. */
4432 /* Caches for modify_event_symbol. */
4433 static Lisp_Object accent_key_syms
;
4434 static Lisp_Object func_key_syms
;
4435 static Lisp_Object mouse_syms
;
4436 static Lisp_Object wheel_syms
;
4437 static Lisp_Object drag_n_drop_syms
;
4439 /* This is a list of keysym codes for special "accent" characters.
4440 It parallels lispy_accent_keys. */
4442 static int lispy_accent_codes
[] =
4444 #ifdef XK_dead_circumflex
4449 #ifdef XK_dead_grave
4454 #ifdef XK_dead_tilde
4459 #ifdef XK_dead_diaeresis
4464 #ifdef XK_dead_macron
4469 #ifdef XK_dead_degree
4474 #ifdef XK_dead_acute
4479 #ifdef XK_dead_cedilla
4484 #ifdef XK_dead_breve
4489 #ifdef XK_dead_ogonek
4494 #ifdef XK_dead_caron
4499 #ifdef XK_dead_doubleacute
4500 XK_dead_doubleacute
,
4504 #ifdef XK_dead_abovedot
4509 #ifdef XK_dead_abovering
4519 #ifdef XK_dead_belowdot
4524 #ifdef XK_dead_voiced_sound
4525 XK_dead_voiced_sound
,
4529 #ifdef XK_dead_semivoiced_sound
4530 XK_dead_semivoiced_sound
,
4546 /* This is a list of Lisp names for special "accent" characters.
4547 It parallels lispy_accent_codes. */
4549 static char *lispy_accent_keys
[] =
4567 "dead-voiced-sound",
4568 "dead-semivoiced-sound",
4574 #define FUNCTION_KEY_OFFSET 0x0
4576 char *lispy_function_keys
[] =
4580 0, /* VK_LBUTTON 0x01 */
4581 0, /* VK_RBUTTON 0x02 */
4582 "cancel", /* VK_CANCEL 0x03 */
4583 0, /* VK_MBUTTON 0x04 */
4585 0, 0, 0, /* 0x05 .. 0x07 */
4587 "backspace", /* VK_BACK 0x08 */
4588 "tab", /* VK_TAB 0x09 */
4590 0, 0, /* 0x0A .. 0x0B */
4592 "clear", /* VK_CLEAR 0x0C */
4593 "return", /* VK_RETURN 0x0D */
4595 0, 0, /* 0x0E .. 0x0F */
4597 0, /* VK_SHIFT 0x10 */
4598 0, /* VK_CONTROL 0x11 */
4599 0, /* VK_MENU 0x12 */
4600 "pause", /* VK_PAUSE 0x13 */
4601 "capslock", /* VK_CAPITAL 0x14 */
4603 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4605 "escape", /* VK_ESCAPE 0x1B */
4607 0, 0, 0, 0, /* 0x1C .. 0x1F */
4609 0, /* VK_SPACE 0x20 */
4610 "prior", /* VK_PRIOR 0x21 */
4611 "next", /* VK_NEXT 0x22 */
4612 "end", /* VK_END 0x23 */
4613 "home", /* VK_HOME 0x24 */
4614 "left", /* VK_LEFT 0x25 */
4615 "up", /* VK_UP 0x26 */
4616 "right", /* VK_RIGHT 0x27 */
4617 "down", /* VK_DOWN 0x28 */
4618 "select", /* VK_SELECT 0x29 */
4619 "print", /* VK_PRINT 0x2A */
4620 "execute", /* VK_EXECUTE 0x2B */
4621 "snapshot", /* VK_SNAPSHOT 0x2C */
4622 "insert", /* VK_INSERT 0x2D */
4623 "delete", /* VK_DELETE 0x2E */
4624 "help", /* VK_HELP 0x2F */
4626 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4628 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4630 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4632 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4634 0, 0, 0, 0, 0, 0, 0, 0, 0,
4635 0, 0, 0, 0, 0, 0, 0, 0, 0,
4636 0, 0, 0, 0, 0, 0, 0, 0,
4638 "lwindow", /* VK_LWIN 0x5B */
4639 "rwindow", /* VK_RWIN 0x5C */
4640 "apps", /* VK_APPS 0x5D */
4642 0, 0, /* 0x5E .. 0x5F */
4644 "kp-0", /* VK_NUMPAD0 0x60 */
4645 "kp-1", /* VK_NUMPAD1 0x61 */
4646 "kp-2", /* VK_NUMPAD2 0x62 */
4647 "kp-3", /* VK_NUMPAD3 0x63 */
4648 "kp-4", /* VK_NUMPAD4 0x64 */
4649 "kp-5", /* VK_NUMPAD5 0x65 */
4650 "kp-6", /* VK_NUMPAD6 0x66 */
4651 "kp-7", /* VK_NUMPAD7 0x67 */
4652 "kp-8", /* VK_NUMPAD8 0x68 */
4653 "kp-9", /* VK_NUMPAD9 0x69 */
4654 "kp-multiply", /* VK_MULTIPLY 0x6A */
4655 "kp-add", /* VK_ADD 0x6B */
4656 "kp-separator", /* VK_SEPARATOR 0x6C */
4657 "kp-subtract", /* VK_SUBTRACT 0x6D */
4658 "kp-decimal", /* VK_DECIMAL 0x6E */
4659 "kp-divide", /* VK_DIVIDE 0x6F */
4660 "f1", /* VK_F1 0x70 */
4661 "f2", /* VK_F2 0x71 */
4662 "f3", /* VK_F3 0x72 */
4663 "f4", /* VK_F4 0x73 */
4664 "f5", /* VK_F5 0x74 */
4665 "f6", /* VK_F6 0x75 */
4666 "f7", /* VK_F7 0x76 */
4667 "f8", /* VK_F8 0x77 */
4668 "f9", /* VK_F9 0x78 */
4669 "f10", /* VK_F10 0x79 */
4670 "f11", /* VK_F11 0x7A */
4671 "f12", /* VK_F12 0x7B */
4672 "f13", /* VK_F13 0x7C */
4673 "f14", /* VK_F14 0x7D */
4674 "f15", /* VK_F15 0x7E */
4675 "f16", /* VK_F16 0x7F */
4676 "f17", /* VK_F17 0x80 */
4677 "f18", /* VK_F18 0x81 */
4678 "f19", /* VK_F19 0x82 */
4679 "f20", /* VK_F20 0x83 */
4680 "f21", /* VK_F21 0x84 */
4681 "f22", /* VK_F22 0x85 */
4682 "f23", /* VK_F23 0x86 */
4683 "f24", /* VK_F24 0x87 */
4685 0, 0, 0, 0, /* 0x88 .. 0x8B */
4686 0, 0, 0, 0, /* 0x8C .. 0x8F */
4688 "kp-numlock", /* VK_NUMLOCK 0x90 */
4689 "scroll", /* VK_SCROLL 0x91 */
4691 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4692 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4693 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4694 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4695 "kp-end", /* VK_NUMPAD_END 0x96 */
4696 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4697 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4698 "kp-up", /* VK_NUMPAD_UP 0x99 */
4699 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4700 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4701 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4702 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4704 0, 0, /* 0x9E .. 0x9F */
4707 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4708 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4709 * No other API or message will distinguish left and right keys this way.
4713 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4714 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4715 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4716 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4717 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4723 "attn", /* VK_ATTN 0xF6 */
4724 "crsel", /* VK_CRSEL 0xF7 */
4725 "exsel", /* VK_EXSEL 0xF8 */
4726 "ereof", /* VK_EREOF 0xF9 */
4727 "play", /* VK_PLAY 0xFA */
4728 "zoom", /* VK_ZOOM 0xFB */
4729 "noname", /* VK_NONAME 0xFC */
4730 "pa1", /* VK_PA1 0xFD */
4731 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4735 #else /* not HAVE_NTGUI */
4737 /* This should be dealt with in XTread_socket now, and that doesn't
4738 depend on the client system having the Kana syms defined. See also
4739 the XK_kana_A case below. */
4742 static char *lispy_kana_keys
[] =
4744 /* X Keysym value */
4745 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4746 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4747 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4748 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4749 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4750 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4751 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4752 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4753 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4754 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4755 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4756 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4757 "kana-i", "kana-u", "kana-e", "kana-o",
4758 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4759 "prolongedsound", "kana-A", "kana-I", "kana-U",
4760 "kana-E", "kana-O", "kana-KA", "kana-KI",
4761 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4762 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4763 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4764 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4765 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4766 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4767 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4768 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4769 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4770 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4771 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4772 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4774 #endif /* XK_kana_A */
4777 #define FUNCTION_KEY_OFFSET 0xff00
4779 /* You'll notice that this table is arranged to be conveniently
4780 indexed by X Windows keysym values. */
4781 static char *lispy_function_keys
[] =
4783 /* X Keysym value */
4785 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4786 "backspace", "tab", "linefeed", "clear",
4788 0, 0, 0, "pause", /* 0xff10...1f */
4789 0, 0, 0, 0, 0, 0, 0, "escape",
4791 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4792 "romaji", "hiragana", "katakana", "hiragana-katakana",
4793 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4794 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4795 "eisu-toggle", /* 0xff30...3f */
4796 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4797 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4799 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4800 "down", "prior", "next", "end",
4801 "begin", 0, 0, 0, 0, 0, 0, 0,
4802 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4813 "break", /* 0xff6b */
4816 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4817 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4818 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4819 0, 0, 0, 0, 0, 0, 0, 0,
4820 "kp-tab", /* 0xff89 */
4822 "kp-enter", /* 0xff8d */
4824 "kp-f1", /* 0xff91 */
4828 "kp-home", /* 0xff95 */
4833 "kp-prior", /* kp-page-up */
4834 "kp-next", /* kp-page-down */
4840 0, 0, 0, 0, 0, 0, 0, 0, 0,
4841 "kp-multiply", /* 0xffaa */
4846 "kp-divide", /* 0xffaf */
4847 "kp-0", /* 0xffb0 */
4848 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4851 "kp-equal", /* 0xffbd */
4852 "f1", /* 0xffbe */ /* IsFunctionKey */
4854 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4855 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4856 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4857 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4858 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4859 0, 0, 0, 0, 0, 0, 0, 0,
4860 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4861 0, 0, 0, 0, 0, 0, 0, "delete"
4864 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4865 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4867 static char *iso_lispy_function_keys
[] =
4869 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4870 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4871 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4872 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4873 "iso-lefttab", /* 0xfe20 */
4874 "iso-move-line-up", "iso-move-line-down",
4875 "iso-partial-line-up", "iso-partial-line-down",
4876 "iso-partial-space-left", "iso-partial-space-right",
4877 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4878 "iso-release-margin-left", "iso-release-margin-right",
4879 "iso-release-both-margins",
4880 "iso-fast-cursor-left", "iso-fast-cursor-right",
4881 "iso-fast-cursor-up", "iso-fast-cursor-down",
4882 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4883 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4886 #endif /* not HAVE_NTGUI */
4888 Lisp_Object Vlispy_mouse_stem
;
4890 static char *lispy_wheel_names
[] =
4892 "wheel-up", "wheel-down"
4895 /* drag-n-drop events are generated when a set of selected files are
4896 dragged from another application and dropped onto an Emacs window. */
4897 static char *lispy_drag_n_drop_names
[] =
4902 /* Scroll bar parts. */
4903 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4904 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4905 Lisp_Object Qtop
, Qratio
;
4907 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4908 Lisp_Object
*scroll_bar_parts
[] = {
4909 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4910 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4913 /* User signal events. */
4914 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4916 Lisp_Object
*lispy_user_signals
[] =
4918 &Qusr1_signal
, &Qusr2_signal
4922 /* A vector, indexed by button number, giving the down-going location
4923 of currently depressed buttons, both scroll bar and non-scroll bar.
4925 The elements have the form
4926 (BUTTON-NUMBER MODIFIER-MASK . REST)
4927 where REST is the cdr of a position as it would be reported in the event.
4929 The make_lispy_event function stores positions here to tell the
4930 difference between click and drag events, and to store the starting
4931 location to be included in drag events. */
4933 static Lisp_Object button_down_location
;
4935 /* Information about the most recent up-going button event: Which
4936 button, what location, and what time. */
4938 static int last_mouse_button
;
4939 static int last_mouse_x
;
4940 static int last_mouse_y
;
4941 static unsigned long button_down_time
;
4943 /* The maximum time between clicks to make a double-click, or Qnil to
4944 disable double-click detection, or Qt for no time limit. */
4946 Lisp_Object Vdouble_click_time
;
4948 /* Maximum number of pixels the mouse may be moved between clicks
4949 to make a double-click. */
4951 EMACS_INT double_click_fuzz
;
4953 /* The number of clicks in this multiple-click. */
4955 int double_click_count
;
4957 /* Given a struct input_event, build the lisp event which represents
4958 it. If EVENT is 0, build a mouse movement event from the mouse
4959 movement buffer, which should have a movement event in it.
4961 Note that events must be passed to this function in the order they
4962 are received; this function stores the location of button presses
4963 in order to build drag events when the button is released. */
4966 make_lispy_event (event
)
4967 struct input_event
*event
;
4971 switch (SWITCH_ENUM_CAST (event
->kind
))
4973 /* A simple keystroke. */
4974 case ASCII_KEYSTROKE_EVENT
:
4976 Lisp_Object lispy_c
;
4977 int c
= event
->code
& 0377;
4978 /* Turn ASCII characters into control characters
4980 if (event
->modifiers
& ctrl_modifier
)
4981 c
= make_ctrl_char (c
);
4983 /* Add in the other modifier bits. We took care of ctrl_modifier
4984 just above, and the shift key was taken care of by the X code,
4985 and applied to control characters by make_ctrl_char. */
4986 c
|= (event
->modifiers
4987 & (meta_modifier
| alt_modifier
4988 | hyper_modifier
| super_modifier
));
4989 /* Distinguish Shift-SPC from SPC. */
4990 if ((event
->code
& 0377) == 040
4991 && event
->modifiers
& shift_modifier
)
4992 c
|= shift_modifier
;
4993 button_down_time
= 0;
4994 XSETFASTINT (lispy_c
, c
);
4998 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5000 Lisp_Object lispy_c
;
5001 int c
= event
->code
;
5003 /* Add in the other modifier bits. We took care of ctrl_modifier
5004 just above, and the shift key was taken care of by the X code,
5005 and applied to control characters by make_ctrl_char. */
5006 c
|= (event
->modifiers
5007 & (meta_modifier
| alt_modifier
5008 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5009 /* What about the `shift' modifier ? */
5010 button_down_time
= 0;
5011 XSETFASTINT (lispy_c
, c
);
5015 /* A function key. The symbol may need to have modifier prefixes
5017 case NON_ASCII_KEYSTROKE_EVENT
:
5018 button_down_time
= 0;
5020 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5021 if (event
->code
== lispy_accent_codes
[i
])
5022 return modify_event_symbol (i
,
5024 Qfunction_key
, Qnil
,
5025 lispy_accent_keys
, &accent_key_syms
,
5026 (sizeof (lispy_accent_keys
)
5027 / sizeof (lispy_accent_keys
[0])));
5031 if (event
->code
>= 0x400 && event
->code
< 0x500)
5032 return modify_event_symbol (event
->code
- 0x400,
5033 event
->modifiers
& ~shift_modifier
,
5034 Qfunction_key
, Qnil
,
5035 lispy_kana_keys
, &func_key_syms
,
5036 (sizeof (lispy_kana_keys
)
5037 / sizeof (lispy_kana_keys
[0])));
5038 #endif /* XK_kana_A */
5041 #ifdef ISO_FUNCTION_KEY_OFFSET
5042 if (event
->code
< FUNCTION_KEY_OFFSET
5043 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5044 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5046 Qfunction_key
, Qnil
,
5047 iso_lispy_function_keys
, &func_key_syms
,
5048 (sizeof (iso_lispy_function_keys
)
5049 / sizeof (iso_lispy_function_keys
[0])));
5052 /* Handle system-specific or unknown keysyms. */
5053 if (event
->code
& (1 << 28)
5054 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5055 || (event
->code
- FUNCTION_KEY_OFFSET
5056 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5057 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5059 /* We need to use an alist rather than a vector as the cache
5060 since we can't make a vector long enuf. */
5061 if (NILP (current_kboard
->system_key_syms
))
5062 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5063 return modify_event_symbol (event
->code
,
5066 current_kboard
->Vsystem_key_alist
,
5067 0, ¤t_kboard
->system_key_syms
,
5071 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5073 Qfunction_key
, Qnil
,
5074 lispy_function_keys
, &func_key_syms
,
5075 (sizeof (lispy_function_keys
)
5076 / sizeof (lispy_function_keys
[0])));
5079 /* A mouse click. Figure out where it is, decide whether it's
5080 a press, click or drag, and build the appropriate structure. */
5081 case MOUSE_CLICK_EVENT
:
5082 #ifndef USE_TOOLKIT_SCROLL_BARS
5083 case SCROLL_BAR_CLICK_EVENT
:
5086 int button
= event
->code
;
5088 Lisp_Object position
;
5089 Lisp_Object
*start_pos_ptr
;
5090 Lisp_Object start_pos
;
5095 /* Build the position as appropriate for this mouse click. */
5096 if (event
->kind
== MOUSE_CLICK_EVENT
)
5098 enum window_part part
;
5099 struct frame
*f
= XFRAME (event
->frame_or_window
);
5101 Lisp_Object string_info
= Qnil
;
5105 /* Ignore mouse events that were made on frame that
5106 have been deleted. */
5107 if (! FRAME_LIVE_P (f
))
5110 /* EVENT->x and EVENT->y are frame-relative pixel
5111 coordinates at this place. Under old redisplay, COLUMN
5112 and ROW are set to frame relative glyph coordinates
5113 which are then used to determine whether this click is
5114 in a menu (non-toolkit version). */
5115 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5116 &column
, &row
, NULL
, 1);
5118 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5119 /* In the non-toolkit version, clicks on the menu bar
5120 are ordinary button events in the event buffer.
5121 Distinguish them, and invoke the menu.
5123 (In the toolkit version, the toolkit handles the menu bar
5124 and Emacs doesn't know about it until after the user
5125 makes a selection.) */
5126 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5127 && (event
->modifiers
& down_modifier
))
5129 Lisp_Object items
, item
;
5134 /* Activate the menu bar on the down event. If the
5135 up event comes in before the menu code can deal with it,
5137 if (! (event
->modifiers
& down_modifier
))
5141 /* Find the menu bar item under `column'. */
5143 items
= FRAME_MENU_BAR_ITEMS (f
);
5144 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5146 Lisp_Object pos
, string
;
5147 string
= AREF (items
, i
+ 1);
5148 pos
= AREF (items
, i
+ 3);
5151 if (column
>= XINT (pos
)
5152 && column
< XINT (pos
) + SCHARS (string
))
5154 item
= AREF (items
, i
);
5159 /* ELisp manual 2.4b says (x y) are window relative but
5160 code says they are frame-relative. */
5162 = Fcons (event
->frame_or_window
,
5164 Fcons (Fcons (event
->x
, event
->y
),
5165 Fcons (make_number (event
->timestamp
),
5168 return Fcons (item
, Fcons (position
, Qnil
));
5170 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5172 /* Set `window' to the window under frame pixel coordinates
5173 event->x/event->y. */
5174 window
= window_from_coordinates (f
, XINT (event
->x
),
5176 &part
, &wx
, &wy
, 0);
5178 if (!WINDOWP (window
))
5180 window
= event
->frame_or_window
;
5185 /* It's a click in window window at frame coordinates
5186 event->x/ event->y. */
5187 struct window
*w
= XWINDOW (window
);
5189 /* Set event coordinates to window-relative coordinates
5190 for constructing the Lisp event below. */
5191 XSETINT (event
->x
, wx
);
5192 XSETINT (event
->y
, wy
);
5194 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5196 /* Mode line or header line. Look for a string under
5197 the mouse that may have a `local-map' property. */
5201 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5202 string
= mode_line_string (w
, wx
, wy
, part
, &charpos
);
5203 if (STRINGP (string
))
5204 string_info
= Fcons (string
, make_number (charpos
));
5206 else if (part
== ON_VERTICAL_BORDER
)
5207 posn
= Qvertical_line
;
5208 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5211 Lisp_Object object
= marginal_area_string (w
, wx
, wy
, part
,
5213 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5214 if (STRINGP (object
))
5215 string_info
= Fcons (object
, make_number (charpos
));
5220 struct display_pos p
;
5221 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5222 posn
= make_number (CHARPOS (p
.pos
));
5223 if (STRINGP (object
))
5226 make_number (CHARPOS (p
.string_pos
)));
5233 Fcons (Fcons (event
->x
, event
->y
),
5234 Fcons (make_number (event
->timestamp
),
5237 : Fcons (string_info
, Qnil
))))));
5239 #ifndef USE_TOOLKIT_SCROLL_BARS
5242 /* It's a scrollbar click. */
5243 Lisp_Object portion_whole
;
5246 window
= event
->frame_or_window
;
5247 portion_whole
= Fcons (event
->x
, event
->y
);
5248 part
= *scroll_bar_parts
[(int) event
->part
];
5252 Fcons (Qvertical_scroll_bar
,
5253 Fcons (portion_whole
,
5254 Fcons (make_number (event
->timestamp
),
5255 Fcons (part
, Qnil
)))));
5257 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5259 if (button
>= ASIZE (button_down_location
))
5261 button_down_location
= larger_vector (button_down_location
,
5263 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5266 start_pos_ptr
= &AREF (button_down_location
, button
);
5267 start_pos
= *start_pos_ptr
;
5268 *start_pos_ptr
= Qnil
;
5271 /* On window-system frames, use the value of
5272 double-click-fuzz as is. On other frames, interpret it
5273 as a multiple of 1/8 characters. */
5277 if (WINDOWP (event
->frame_or_window
))
5278 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5279 else if (FRAMEP (event
->frame_or_window
))
5280 f
= XFRAME (event
->frame_or_window
);
5284 if (FRAME_WINDOW_P (f
))
5285 fuzz
= double_click_fuzz
;
5287 fuzz
= double_click_fuzz
/ 8;
5289 is_double
= (button
== last_mouse_button
5290 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5291 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5292 && button_down_time
!= 0
5293 && (EQ (Vdouble_click_time
, Qt
)
5294 || (INTEGERP (Vdouble_click_time
)
5295 && ((int)(event
->timestamp
- button_down_time
)
5296 < XINT (Vdouble_click_time
)))));
5299 last_mouse_button
= button
;
5300 last_mouse_x
= XINT (event
->x
);
5301 last_mouse_y
= XINT (event
->y
);
5303 /* If this is a button press, squirrel away the location, so
5304 we can decide later whether it was a click or a drag. */
5305 if (event
->modifiers
& down_modifier
)
5309 double_click_count
++;
5310 event
->modifiers
|= ((double_click_count
> 2)
5315 double_click_count
= 1;
5316 button_down_time
= event
->timestamp
;
5317 *start_pos_ptr
= Fcopy_alist (position
);
5320 /* Now we're releasing a button - check the co-ordinates to
5321 see if this was a click or a drag. */
5322 else if (event
->modifiers
& up_modifier
)
5324 /* If we did not see a down before this up, ignore the up.
5325 Probably this happened because the down event chose a
5326 menu item. It would be an annoyance to treat the
5327 release of the button that chose the menu item as a
5330 if (!CONSP (start_pos
))
5333 event
->modifiers
&= ~up_modifier
;
5334 #if 0 /* Formerly we treated an up with no down as a click event. */
5335 if (!CONSP (start_pos
))
5336 event
->modifiers
|= click_modifier
;
5341 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5343 /* The third element of every position
5344 should be the (x,y) pair. */
5345 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5347 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5349 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5350 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5353 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5354 && ydiff
< double_click_fuzz
5355 && ydiff
> - double_click_fuzz
)
5356 /* Mouse hasn't moved (much). */
5357 event
->modifiers
|= click_modifier
;
5360 button_down_time
= 0;
5361 event
->modifiers
|= drag_modifier
;
5364 /* Don't check is_double; treat this as multiple
5365 if the down-event was multiple. */
5366 if (double_click_count
> 1)
5367 event
->modifiers
|= ((double_click_count
> 2)
5373 /* Every mouse event should either have the down_modifier or
5374 the up_modifier set. */
5378 /* Get the symbol we should use for the mouse click. */
5381 head
= modify_event_symbol (button
,
5383 Qmouse_click
, Vlispy_mouse_stem
,
5386 XVECTOR (mouse_syms
)->size
);
5387 if (event
->modifiers
& drag_modifier
)
5392 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5395 Fcons (make_number (double_click_count
),
5406 Lisp_Object position
;
5410 /* Build the position as appropriate for this mouse click. */
5411 enum window_part part
;
5412 struct frame
*f
= XFRAME (event
->frame_or_window
);
5414 Lisp_Object string_info
= Qnil
;
5419 /* Ignore wheel events that were made on frame that have been
5421 if (! FRAME_LIVE_P (f
))
5424 /* EVENT->x and EVENT->y are frame-relative pixel
5425 coordinates at this place. Under old redisplay, COLUMN
5426 and ROW are set to frame relative glyph coordinates
5427 which are then used to determine whether this click is
5428 in a menu (non-toolkit version). */
5429 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5430 &column
, &row
, NULL
, 1);
5432 /* Set `window' to the window under frame pixel coordinates
5433 event->x/event->y. */
5434 window
= window_from_coordinates (f
, XINT (event
->x
),
5436 &part
, &wx
, &wy
, 0);
5438 if (!WINDOWP (window
))
5440 window
= event
->frame_or_window
;
5445 /* It's a click in window window at frame coordinates
5446 event->x/ event->y. */
5447 struct window
*w
= XWINDOW (window
);
5449 /* Set event coordinates to window-relative coordinates
5450 for constructing the Lisp event below. */
5451 XSETINT (event
->x
, wx
);
5452 XSETINT (event
->y
, wy
);
5454 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5456 /* Mode line or header line. Look for a string under
5457 the mouse that may have a `local-map' property. */
5461 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5462 string
= mode_line_string (w
, wx
, wy
, part
, &charpos
);
5463 if (STRINGP (string
))
5464 string_info
= Fcons (string
, make_number (charpos
));
5466 else if (part
== ON_VERTICAL_BORDER
)
5467 posn
= Qvertical_line
;
5468 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5471 Lisp_Object object
= marginal_area_string (w
, wx
, wy
, part
,
5473 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5474 if (STRINGP (object
))
5475 string_info
= Fcons (object
, make_number (charpos
));
5480 struct display_pos p
;
5481 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5482 posn
= make_number (CHARPOS (p
.pos
));
5483 if (STRINGP (object
))
5486 make_number (CHARPOS (p
.string_pos
)));
5493 Fcons (Fcons (event
->x
, event
->y
),
5494 Fcons (make_number (event
->timestamp
),
5497 : Fcons (string_info
, Qnil
))))));
5499 /* Set double or triple modifiers to indicate the wheel speed. */
5501 /* On window-system frames, use the value of
5502 double-click-fuzz as is. On other frames, interpret it
5503 as a multiple of 1/8 characters. */
5508 if (WINDOWP (event
->frame_or_window
))
5509 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5510 else if (FRAMEP (event
->frame_or_window
))
5511 f
= XFRAME (event
->frame_or_window
);
5515 if (FRAME_WINDOW_P (f
))
5516 fuzz
= double_click_fuzz
;
5518 fuzz
= double_click_fuzz
/ 8;
5520 is_double
= (last_mouse_button
< 0
5521 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5522 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5523 && button_down_time
!= 0
5524 && (EQ (Vdouble_click_time
, Qt
)
5525 || (INTEGERP (Vdouble_click_time
)
5526 && ((int)(event
->timestamp
- button_down_time
)
5527 < XINT (Vdouble_click_time
)))));
5530 double_click_count
++;
5531 event
->modifiers
|= ((double_click_count
> 2)
5537 double_click_count
= 1;
5538 event
->modifiers
|= click_modifier
;
5541 button_down_time
= event
->timestamp
;
5542 /* Use a negative value to distinguish wheel from mouse button. */
5543 last_mouse_button
= -1;
5544 last_mouse_x
= XINT (event
->x
);
5545 last_mouse_y
= XINT (event
->y
);
5551 if (event
->modifiers
& up_modifier
)
5553 /* Emit a wheel-up event. */
5554 event
->modifiers
&= ~up_modifier
;
5557 else if (event
->modifiers
& down_modifier
)
5559 /* Emit a wheel-down event. */
5560 event
->modifiers
&= ~down_modifier
;
5564 /* Every wheel event should either have the down_modifier or
5565 the up_modifier set. */
5568 /* Get the symbol we should use for the wheel event. */
5569 head
= modify_event_symbol (symbol_num
,
5575 ASIZE (wheel_syms
));
5578 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5581 Fcons (make_number (double_click_count
),
5590 #ifdef USE_TOOLKIT_SCROLL_BARS
5592 /* We don't have down and up events if using toolkit scroll bars,
5593 so make this always a click event. Store in the `part' of
5594 the Lisp event a symbol which maps to the following actions:
5596 `above_handle' page up
5597 `below_handle' page down
5601 `bottom' bottom of buffer
5602 `handle' thumb has been dragged.
5603 `end-scroll' end of interaction with scroll bar
5605 The incoming input_event contains in its `part' member an
5606 index of type `enum scroll_bar_part' which we can use as an
5607 index in scroll_bar_parts to get the appropriate symbol. */
5609 case SCROLL_BAR_CLICK_EVENT
:
5611 Lisp_Object position
, head
, window
, portion_whole
, part
;
5613 window
= event
->frame_or_window
;
5614 portion_whole
= Fcons (event
->x
, event
->y
);
5615 part
= *scroll_bar_parts
[(int) event
->part
];
5619 Fcons (Qvertical_scroll_bar
,
5620 Fcons (portion_whole
,
5621 Fcons (make_number (event
->timestamp
),
5622 Fcons (part
, Qnil
)))));
5624 /* Always treat scroll bar events as clicks. */
5625 event
->modifiers
|= click_modifier
;
5626 event
->modifiers
&= ~up_modifier
;
5628 if (event
->code
>= ASIZE (mouse_syms
))
5629 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5631 /* Get the symbol we should use for the mouse click. */
5632 head
= modify_event_symbol (event
->code
,
5637 XVECTOR (mouse_syms
)->size
);
5638 return Fcons (head
, Fcons (position
, Qnil
));
5641 #endif /* USE_TOOLKIT_SCROLL_BARS */
5644 case W32_SCROLL_BAR_CLICK_EVENT
:
5646 int button
= event
->code
;
5648 Lisp_Object position
;
5649 Lisp_Object
*start_pos_ptr
;
5650 Lisp_Object start_pos
;
5654 Lisp_Object portion_whole
;
5657 window
= event
->frame_or_window
;
5658 portion_whole
= Fcons (event
->x
, event
->y
);
5659 part
= *scroll_bar_parts
[(int) event
->part
];
5663 Fcons (Qvertical_scroll_bar
,
5664 Fcons (portion_whole
,
5665 Fcons (make_number (event
->timestamp
),
5666 Fcons (part
, Qnil
)))));
5669 /* Always treat W32 scroll bar events as clicks. */
5670 event
->modifiers
|= click_modifier
;
5673 /* Get the symbol we should use for the mouse click. */
5676 head
= modify_event_symbol (button
,
5681 XVECTOR (mouse_syms
)->size
);
5687 #endif /* WINDOWSNT */
5689 case DRAG_N_DROP_EVENT
:
5691 enum window_part part
;
5698 /* The frame_or_window field should be a cons of the frame in
5699 which the event occurred and a list of the filenames
5701 if (! CONSP (event
->frame_or_window
))
5704 f
= XFRAME (XCAR (event
->frame_or_window
));
5705 files
= XCDR (event
->frame_or_window
);
5707 /* Ignore mouse events that were made on frames that
5708 have been deleted. */
5709 if (! FRAME_LIVE_P (f
))
5712 window
= window_from_coordinates (f
, XINT (event
->x
),
5714 &part
, &wx
, &wy
, 0);
5716 if (!WINDOWP (window
))
5718 window
= XCAR (event
->frame_or_window
);
5723 /* It's an event in window `window' at frame coordinates
5724 event->x/ event->y. */
5725 struct window
*w
= XWINDOW (window
);
5727 /* Set event coordinates to window-relative coordinates
5728 for constructing the Lisp event below. */
5729 XSETINT (event
->x
, wx
);
5730 XSETINT (event
->y
, wy
);
5732 if (part
== ON_MODE_LINE
)
5734 else if (part
== ON_VERTICAL_BORDER
)
5735 posn
= Qvertical_line
;
5736 else if (part
== ON_HEADER_LINE
)
5737 posn
= Qheader_line
;
5741 struct display_pos p
;
5742 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5743 posn
= make_number (CHARPOS (p
.pos
));
5748 Lisp_Object head
, position
;
5753 Fcons (Fcons (event
->x
, event
->y
),
5754 Fcons (make_number (event
->timestamp
),
5757 head
= modify_event_symbol (0, event
->modifiers
,
5759 lispy_drag_n_drop_names
,
5760 &drag_n_drop_syms
, 1);
5767 #endif /* HAVE_MOUSE */
5769 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5770 || defined (USE_GTK)
5771 case MENU_BAR_EVENT
:
5772 if (EQ (event
->arg
, event
->frame_or_window
))
5773 /* This is the prefix key. We translate this to
5774 `(menu_bar)' because the code in keyboard.c for menu
5775 events, which we use, relies on this. */
5776 return Fcons (Qmenu_bar
, Qnil
);
5780 case SELECT_WINDOW_EVENT
:
5781 /* Make an event (select-window (WINDOW)). */
5782 return Fcons (Qselect_window
,
5783 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5786 case TOOL_BAR_EVENT
:
5787 if (EQ (event
->arg
, event
->frame_or_window
))
5788 /* This is the prefix key. We translate this to
5789 `(tool_bar)' because the code in keyboard.c for tool bar
5790 events, which we use, relies on this. */
5791 return Fcons (Qtool_bar
, Qnil
);
5792 else if (SYMBOLP (event
->arg
))
5793 return apply_modifiers (event
->modifiers
, event
->arg
);
5796 case USER_SIGNAL_EVENT
:
5797 /* A user signal. */
5798 return *lispy_user_signals
[event
->code
];
5800 case SAVE_SESSION_EVENT
:
5801 return Qsave_session
;
5803 /* The 'kind' field of the event is something we don't recognize. */
5812 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5814 Lisp_Object bar_window
;
5815 enum scroll_bar_part part
;
5819 /* Is it a scroll bar movement? */
5820 if (frame
&& ! NILP (bar_window
))
5822 Lisp_Object part_sym
;
5824 part_sym
= *scroll_bar_parts
[(int) part
];
5825 return Fcons (Qscroll_bar_movement
,
5826 (Fcons (Fcons (bar_window
,
5827 Fcons (Qvertical_scroll_bar
,
5828 Fcons (Fcons (x
, y
),
5829 Fcons (make_number (time
),
5835 /* Or is it an ordinary mouse movement? */
5838 enum window_part area
;
5844 /* It's in a frame; which window on that frame? */
5845 window
= window_from_coordinates (frame
, XINT (x
), XINT (y
),
5846 &area
, &wx
, &wy
, 0);
5850 if (WINDOWP (window
))
5852 struct window
*w
= XWINDOW (window
);
5854 /* Set window relative coordinates. */
5858 if (area
== ON_MODE_LINE
)
5860 else if (area
== ON_VERTICAL_BORDER
)
5861 posn
= Qvertical_line
;
5862 else if (area
== ON_HEADER_LINE
)
5863 posn
= Qheader_line
;
5867 struct display_pos p
;
5868 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5869 posn
= make_number (CHARPOS (p
.pos
));
5872 else if (frame
!= 0)
5874 XSETFRAME (window
, frame
);
5885 return Fcons (Qmouse_movement
,
5886 Fcons (Fcons (window
,
5888 Fcons (Fcons (x
, y
),
5889 Fcons (make_number (time
),
5895 #endif /* HAVE_MOUSE */
5897 /* Construct a switch frame event. */
5899 make_lispy_switch_frame (frame
)
5902 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5905 /* Manipulating modifiers. */
5907 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5909 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5910 SYMBOL's name of the end of the modifiers; the string from this
5911 position is the unmodified symbol name.
5913 This doesn't use any caches. */
5916 parse_modifiers_uncached (symbol
, modifier_end
)
5924 CHECK_SYMBOL (symbol
);
5927 name
= SYMBOL_NAME (symbol
);
5929 for (i
= 0; i
+2 <= SBYTES (name
); )
5931 int this_mod_end
= 0;
5934 /* See if the name continues with a modifier word.
5935 Check that the word appears, but don't check what follows it.
5936 Set this_mod and this_mod_end to record what we find. */
5938 switch (SREF (name
, i
))
5940 #define SINGLE_LETTER_MOD(BIT) \
5941 (this_mod_end = i + 1, this_mod = BIT)
5944 SINGLE_LETTER_MOD (alt_modifier
);
5948 SINGLE_LETTER_MOD (ctrl_modifier
);
5952 SINGLE_LETTER_MOD (hyper_modifier
);
5956 SINGLE_LETTER_MOD (meta_modifier
);
5960 SINGLE_LETTER_MOD (shift_modifier
);
5964 SINGLE_LETTER_MOD (super_modifier
);
5967 #undef SINGLE_LETTER_MOD
5969 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5970 if (i + LEN + 1 <= SBYTES (name) \
5971 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5973 this_mod_end = i + LEN; \
5978 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5979 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5980 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5984 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5986 #undef MULTI_LETTER_MOD
5990 /* If we found no modifier, stop looking for them. */
5991 if (this_mod_end
== 0)
5994 /* Check there is a dash after the modifier, so that it
5995 really is a modifier. */
5996 if (this_mod_end
>= SBYTES (name
)
5997 || SREF (name
, this_mod_end
) != '-')
6000 /* This modifier is real; look for another. */
6001 modifiers
|= this_mod
;
6002 i
= this_mod_end
+ 1;
6005 /* Should we include the `click' modifier? */
6006 if (! (modifiers
& (down_modifier
| drag_modifier
6007 | double_modifier
| triple_modifier
))
6008 && i
+ 7 == SBYTES (name
)
6009 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6010 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6011 modifiers
|= click_modifier
;
6019 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6020 prepended to the string BASE[0..BASE_LEN-1].
6021 This doesn't use any caches. */
6023 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6026 int base_len
, base_len_byte
;
6028 /* Since BASE could contain nulls, we can't use intern here; we have
6029 to use Fintern, which expects a genuine Lisp_String, and keeps a
6032 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6038 /* Only the event queue may use the `up' modifier; it should always
6039 be turned into a click or drag event before presented to lisp code. */
6040 if (modifiers
& up_modifier
)
6043 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6044 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6045 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6046 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6047 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6048 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6049 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6050 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6051 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6052 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6053 /* The click modifier is denoted by the absence of other modifiers. */
6057 mod_len
= p
- new_mods
;
6061 Lisp_Object new_name
;
6063 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6064 mod_len
+ base_len_byte
);
6065 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6066 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6068 return Fintern (new_name
, Qnil
);
6073 static char *modifier_names
[] =
6075 "up", "down", "drag", "click", "double", "triple", 0, 0,
6076 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6077 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6079 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6081 static Lisp_Object modifier_symbols
;
6083 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6085 lispy_modifier_list (modifiers
)
6088 Lisp_Object modifier_list
;
6091 modifier_list
= Qnil
;
6092 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6093 if (modifiers
& (1<<i
))
6094 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6097 return modifier_list
;
6101 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6102 where UNMODIFIED is the unmodified form of SYMBOL,
6103 MASK is the set of modifiers present in SYMBOL's name.
6104 This is similar to parse_modifiers_uncached, but uses the cache in
6105 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6106 Qevent_symbol_elements property. */
6109 parse_modifiers (symbol
)
6112 Lisp_Object elements
;
6114 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6115 if (CONSP (elements
))
6120 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6121 Lisp_Object unmodified
;
6124 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6125 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6128 if (modifiers
& ~VALMASK
)
6130 XSETFASTINT (mask
, modifiers
);
6131 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6133 /* Cache the parsing results on SYMBOL. */
6134 Fput (symbol
, Qevent_symbol_element_mask
,
6136 Fput (symbol
, Qevent_symbol_elements
,
6137 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6139 /* Since we know that SYMBOL is modifiers applied to unmodified,
6140 it would be nice to put that in unmodified's cache.
6141 But we can't, since we're not sure that parse_modifiers is
6148 /* Apply the modifiers MODIFIERS to the symbol BASE.
6149 BASE must be unmodified.
6151 This is like apply_modifiers_uncached, but uses BASE's
6152 Qmodifier_cache property, if present. It also builds
6153 Qevent_symbol_elements properties, since it has that info anyway.
6155 apply_modifiers copies the value of BASE's Qevent_kind property to
6156 the modified symbol. */
6158 apply_modifiers (modifiers
, base
)
6162 Lisp_Object cache
, index
, entry
, new_symbol
;
6164 /* Mask out upper bits. We don't know where this value's been. */
6165 modifiers
&= VALMASK
;
6167 /* The click modifier never figures into cache indices. */
6168 cache
= Fget (base
, Qmodifier_cache
);
6169 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6170 entry
= assq_no_quit (index
, cache
);
6173 new_symbol
= XCDR (entry
);
6176 /* We have to create the symbol ourselves. */
6177 new_symbol
= apply_modifiers_uncached (modifiers
,
6178 SDATA (SYMBOL_NAME (base
)),
6179 SCHARS (SYMBOL_NAME (base
)),
6180 SBYTES (SYMBOL_NAME (base
)));
6182 /* Add the new symbol to the base's cache. */
6183 entry
= Fcons (index
, new_symbol
);
6184 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6186 /* We have the parsing info now for free, so we could add it to
6188 XSETFASTINT (index, modifiers);
6189 Fput (new_symbol, Qevent_symbol_element_mask,
6190 Fcons (base, Fcons (index, Qnil)));
6191 Fput (new_symbol, Qevent_symbol_elements,
6192 Fcons (base, lispy_modifier_list (modifiers)));
6193 Sadly, this is only correct if `base' is indeed a base event,
6194 which is not necessarily the case. -stef */
6197 /* Make sure this symbol is of the same kind as BASE.
6199 You'd think we could just set this once and for all when we
6200 intern the symbol above, but reorder_modifiers may call us when
6201 BASE's property isn't set right; we can't assume that just
6202 because it has a Qmodifier_cache property it must have its
6203 Qevent_kind set right as well. */
6204 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6208 kind
= Fget (base
, Qevent_kind
);
6210 Fput (new_symbol
, Qevent_kind
, kind
);
6217 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6218 return a symbol with the modifiers placed in the canonical order.
6219 Canonical order is alphabetical, except for down and drag, which
6220 always come last. The 'click' modifier is never written out.
6222 Fdefine_key calls this to make sure that (for example) C-M-foo
6223 and M-C-foo end up being equivalent in the keymap. */
6226 reorder_modifiers (symbol
)
6229 /* It's hopefully okay to write the code this way, since everything
6230 will soon be in caches, and no consing will be done at all. */
6233 parsed
= parse_modifiers (symbol
);
6234 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6239 /* For handling events, we often want to produce a symbol whose name
6240 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6241 to some base, like the name of a function key or mouse button.
6242 modify_event_symbol produces symbols of this sort.
6244 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6245 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6248 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6249 into symbol names, or a string specifying a name stem used to
6250 construct a symbol name or the form `STEM-N', where N is the decimal
6251 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6252 non-nil; otherwise NAME_TABLE is used.
6254 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6255 persist between calls to modify_event_symbol that it can use to
6256 store a cache of the symbols it's generated for this NAME_TABLE
6257 before. The object stored there may be a vector or an alist.
6259 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6261 MODIFIERS is a set of modifier bits (as given in struct input_events)
6262 whose prefixes should be applied to the symbol name.
6264 SYMBOL_KIND is the value to be placed in the event_kind property of
6265 the returned symbol.
6267 The symbols we create are supposed to have an
6268 `event-symbol-elements' property, which lists the modifiers present
6269 in the symbol's name. */
6272 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6273 name_table
, symbol_table
, table_size
)
6276 Lisp_Object symbol_kind
;
6277 Lisp_Object name_alist_or_stem
;
6279 Lisp_Object
*symbol_table
;
6280 unsigned int table_size
;
6283 Lisp_Object symbol_int
;
6285 /* Get rid of the "vendor-specific" bit here. */
6286 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6288 /* Is this a request for a valid symbol? */
6289 if (symbol_num
< 0 || symbol_num
>= table_size
)
6292 if (CONSP (*symbol_table
))
6293 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6295 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6296 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6297 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6298 we've never used that symbol before. */
6301 if (! VECTORP (*symbol_table
)
6302 || XVECTOR (*symbol_table
)->size
!= table_size
)
6306 XSETFASTINT (size
, table_size
);
6307 *symbol_table
= Fmake_vector (size
, Qnil
);
6310 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6313 /* Have we already used this symbol before? */
6316 /* No; let's create it. */
6317 if (CONSP (name_alist_or_stem
))
6318 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6319 else if (STRINGP (name_alist_or_stem
))
6321 int len
= SBYTES (name_alist_or_stem
);
6322 char *buf
= (char *) alloca (len
+ 50);
6323 if (sizeof (int) == sizeof (EMACS_INT
))
6324 sprintf (buf
, "%s-%d", SDATA (name_alist_or_stem
),
6325 XINT (symbol_int
) + 1);
6326 else if (sizeof (long) == sizeof (EMACS_INT
))
6327 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6328 XINT (symbol_int
) + 1);
6331 value
= intern (buf
);
6333 else if (name_table
!= 0 && name_table
[symbol_num
])
6334 value
= intern (name_table
[symbol_num
]);
6336 #ifdef HAVE_WINDOW_SYSTEM
6339 char *name
= x_get_keysym_name (symbol_num
);
6341 value
= intern (name
);
6348 sprintf (buf
, "key-%d", symbol_num
);
6349 value
= intern (buf
);
6352 if (CONSP (*symbol_table
))
6353 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6355 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6357 /* Fill in the cache entries for this symbol; this also
6358 builds the Qevent_symbol_elements property, which the user
6360 apply_modifiers (modifiers
& click_modifier
, value
);
6361 Fput (value
, Qevent_kind
, symbol_kind
);
6364 /* Apply modifiers to that symbol. */
6365 return apply_modifiers (modifiers
, value
);
6368 /* Convert a list that represents an event type,
6369 such as (ctrl meta backspace), into the usual representation of that
6370 event type as a number or a symbol. */
6372 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6373 doc
: /* Convert the event description list EVENT-DESC to an event type.
6374 EVENT-DESC should contain one base event type (a character or symbol)
6375 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6376 drag, down, double or triple). The base must be last.
6377 The return value is an event type (a character or symbol) which
6378 has the same base event type and all the specified modifiers. */)
6380 Lisp_Object event_desc
;
6388 while (CONSP (rest
))
6396 /* Given a symbol, see if it is a modifier name. */
6397 if (SYMBOLP (elt
) && CONSP (rest
))
6398 this = parse_solitary_modifier (elt
);
6402 else if (!NILP (base
))
6403 error ("Two bases given in one event");
6409 /* Let the symbol A refer to the character A. */
6410 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6411 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6413 if (INTEGERP (base
))
6415 /* Turn (shift a) into A. */
6416 if ((modifiers
& shift_modifier
) != 0
6417 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6419 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6420 modifiers
&= ~shift_modifier
;
6423 /* Turn (control a) into C-a. */
6424 if (modifiers
& ctrl_modifier
)
6425 return make_number ((modifiers
& ~ctrl_modifier
)
6426 | make_ctrl_char (XINT (base
)));
6428 return make_number (modifiers
| XINT (base
));
6430 else if (SYMBOLP (base
))
6431 return apply_modifiers (modifiers
, base
);
6434 error ("Invalid base event");
6439 /* Try to recognize SYMBOL as a modifier name.
6440 Return the modifier flag bit, or 0 if not recognized. */
6443 parse_solitary_modifier (symbol
)
6446 Lisp_Object name
= SYMBOL_NAME (symbol
);
6448 switch (SREF (name
, 0))
6450 #define SINGLE_LETTER_MOD(BIT) \
6451 if (SBYTES (name) == 1) \
6454 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6455 if (LEN == SBYTES (name) \
6456 && ! strncmp (SDATA (name), NAME, LEN)) \
6460 SINGLE_LETTER_MOD (alt_modifier
);
6464 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6468 SINGLE_LETTER_MOD (ctrl_modifier
);
6472 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6473 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6477 SINGLE_LETTER_MOD (hyper_modifier
);
6481 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6485 SINGLE_LETTER_MOD (meta_modifier
);
6489 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6493 SINGLE_LETTER_MOD (shift_modifier
);
6497 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6498 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6499 SINGLE_LETTER_MOD (super_modifier
);
6503 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6504 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6505 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6509 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6512 #undef SINGLE_LETTER_MOD
6513 #undef MULTI_LETTER_MOD
6519 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6520 Such a list is not valid as an event,
6521 but it can be a Lucid-style event type list. */
6524 lucid_event_type_list_p (object
)
6529 if (! CONSP (object
))
6532 if (EQ (XCAR (object
), Qhelp_echo
)
6533 || EQ (XCAR (object
), Qvertical_line
)
6534 || EQ (XCAR (object
), Qmode_line
)
6535 || EQ (XCAR (object
), Qheader_line
))
6538 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6542 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6549 /* Store into *addr a value nonzero if terminal input chars are available.
6550 Serves the purpose of ioctl (0, FIONREAD, addr)
6551 but works even if FIONREAD does not exist.
6552 (In fact, this may actually read some input.)
6554 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6555 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6558 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6563 /* First of all, have we already counted some input? */
6564 *addr
= (!NILP (Vquit_flag
)
6565 || readable_filtered_events (do_timers_now
, filter_events
));
6567 /* If input is being read as it arrives, and we have none, there is none. */
6568 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6571 /* Try to read some input and see how much we get. */
6573 *addr
= (!NILP (Vquit_flag
)
6574 || readable_filtered_events (do_timers_now
, filter_events
));
6577 /* Store into *addr a value nonzero if terminal input chars are available.
6578 Serves the purpose of ioctl (0, FIONREAD, addr)
6579 but works even if FIONREAD does not exist.
6580 (In fact, this may actually read some input.)
6582 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6585 get_input_pending (addr
, do_timers_now
)
6589 get_filtered_input_pending (addr
, do_timers_now
, 0);
6592 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6595 gobble_input (expected
)
6600 if (interrupt_input
)
6603 mask
= sigblock (sigmask (SIGIO
));
6604 read_avail_input (expected
);
6608 #ifdef POLL_FOR_INPUT
6609 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6612 mask
= sigblock (sigmask (SIGALRM
));
6613 read_avail_input (expected
);
6619 read_avail_input (expected
);
6623 /* Put a BUFFER_SWITCH_EVENT in the buffer
6624 so that read_key_sequence will notice the new current buffer. */
6627 record_asynch_buffer_change ()
6629 struct input_event event
;
6633 event
.kind
= BUFFER_SWITCH_EVENT
;
6634 event
.frame_or_window
= Qnil
;
6638 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6639 The purpose of the event is to make read_key_sequence look up the
6640 keymaps again. If we aren't in read_key_sequence, we don't need one,
6641 and the event could cause trouble by messing up (input-pending-p). */
6642 tem
= Fwaiting_for_user_input_p ();
6646 /* We never need these events if we have no asynchronous subprocesses. */
6650 /* Make sure no interrupt happens while storing the event. */
6652 if (interrupt_input
)
6655 mask
= sigblock (sigmask (SIGIO
));
6656 kbd_buffer_store_event (&event
);
6663 kbd_buffer_store_event (&event
);
6670 /* Read any terminal input already buffered up by the system
6671 into the kbd_buffer, but do not wait.
6673 EXPECTED should be nonzero if the caller knows there is some input.
6675 Except on VMS, all input is read by this function.
6676 If interrupt_input is nonzero, this function MUST be called
6677 only when SIGIO is blocked.
6679 Returns the number of keyboard chars read, or -1 meaning
6680 this is a bad time to try to read input. */
6683 read_avail_input (expected
)
6686 struct input_event buf
[KBD_BUFFER_SIZE
];
6690 for (i
= 0; i
< KBD_BUFFER_SIZE
; i
++)
6691 EVENT_INIT (buf
[i
]);
6693 if (read_socket_hook
)
6694 /* No need for FIONREAD or fcntl; just say don't wait. */
6695 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
6698 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6699 the kbd_buffer can really hold. That may prevent loss
6700 of characters on some systems when input is stuffed at us. */
6701 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6704 /* Determine how many characters we should *try* to read. */
6707 #else /* not WINDOWSNT */
6709 n_to_read
= dos_keysns ();
6712 #else /* not MSDOS */
6714 /* Find out how much input is available. */
6715 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6716 /* Formerly simply reported no input, but that sometimes led to
6717 a failure of Emacs to terminate.
6718 SIGHUP seems appropriate if we can't reach the terminal. */
6719 /* ??? Is it really right to send the signal just to this process
6720 rather than to the whole process group?
6721 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6723 if (! noninteractive
)
6724 kill (getpid (), SIGHUP
);
6730 if (n_to_read
> sizeof cbuf
)
6731 n_to_read
= sizeof cbuf
;
6732 #else /* no FIONREAD */
6733 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6734 /* Read some input if available, but don't wait. */
6735 n_to_read
= sizeof cbuf
;
6736 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6741 #endif /* not MSDOS */
6742 #endif /* not WINDOWSNT */
6744 /* Now read; for one reason or another, this will not block.
6745 NREAD is set to the number of chars read. */
6749 cbuf
[0] = dos_keyread ();
6752 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6754 /* POSIX infers that processes which are not in the session leader's
6755 process group won't get SIGHUP's at logout time. BSDI adheres to
6756 this part standard and returns -1 from read (0) with errno==EIO
6757 when the control tty is taken away.
6758 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6759 if (nread
== -1 && errno
== EIO
)
6761 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6762 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6763 This looks incorrect, but it isn't, because _BSD causes
6764 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6765 and that causes a value other than 0 when there is no input. */
6771 /* We used to retry the read if it was interrupted.
6772 But this does the wrong thing when O_NDELAY causes
6773 an EAGAIN error. Does anybody know of a situation
6774 where a retry is actually needed? */
6776 nread
< 0 && (errno
== EAGAIN
6790 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6791 fcntl (input_fd
, F_SETFL
, 0);
6792 #endif /* USG or DGUX or CYGWIN */
6793 #endif /* no FIONREAD */
6794 for (i
= 0; i
< nread
; i
++)
6796 buf
[i
].kind
= ASCII_KEYSTROKE_EVENT
;
6797 buf
[i
].modifiers
= 0;
6798 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6799 buf
[i
].modifiers
= meta_modifier
;
6803 buf
[i
].code
= cbuf
[i
];
6804 buf
[i
].frame_or_window
= selected_frame
;
6809 /* Scan the chars for C-g and store them in kbd_buffer. */
6810 for (i
= 0; i
< nread
; i
++)
6812 kbd_buffer_store_event (&buf
[i
]);
6813 /* Don't look at input that follows a C-g too closely.
6814 This reduces lossage due to autorepeat on C-g. */
6815 if (buf
[i
].kind
== ASCII_KEYSTROKE_EVENT
6816 && buf
[i
].code
== quit_char
)
6822 #endif /* not VMS */
6824 #ifdef SIGIO /* for entire page */
6825 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6828 input_available_signal (signo
)
6831 /* Must preserve main program's value of errno. */
6832 int old_errno
= errno
;
6834 extern int select_alarmed
;
6837 #if defined (USG) && !defined (POSIX_SIGNALS)
6838 /* USG systems forget handlers when they are used;
6839 must reestablish each time */
6840 signal (signo
, input_available_signal
);
6847 if (input_available_clear_time
)
6848 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6853 nread
= read_avail_input (1);
6854 /* -1 means it's not ok to read the input now.
6855 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6856 0 means there was no keyboard input available. */
6861 select_alarmed
= 1; /* Force the select emulator back to life */
6872 /* Send ourselves a SIGIO.
6874 This function exists so that the UNBLOCK_INPUT macro in
6875 blockinput.h can have some way to take care of input we put off
6876 dealing with, without assuming that every file which uses
6877 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6879 reinvoke_input_signal ()
6882 kill (getpid (), SIGIO
);
6888 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6889 static Lisp_Object menu_bar_one_keymap_changed_items
;
6891 /* These variables hold the vector under construction within
6892 menu_bar_items and its subroutines, and the current index
6893 for storing into that vector. */
6894 static Lisp_Object menu_bar_items_vector
;
6895 static int menu_bar_items_index
;
6897 /* Return a vector of menu items for a menu bar, appropriate
6898 to the current buffer. Each item has three elements in the vector:
6901 OLD is an old vector we can optionally reuse, or nil. */
6904 menu_bar_items (old
)
6907 /* The number of keymaps we're scanning right now, and the number of
6908 keymaps we have allocated space for. */
6911 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6912 in the current keymaps, or nil where it is not a prefix. */
6915 Lisp_Object def
, tail
;
6924 struct gcpro gcpro1
;
6926 /* In order to build the menus, we need to call the keymap
6927 accessors. They all call QUIT. But this function is called
6928 during redisplay, during which a quit is fatal. So inhibit
6929 quitting while building the menus.
6930 We do this instead of specbind because (1) errors will clear it anyway
6931 and (2) this avoids risk of specpdl overflow. */
6932 oquit
= Vinhibit_quit
;
6936 menu_bar_items_vector
= old
;
6938 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6939 menu_bar_items_index
= 0;
6941 GCPRO1 (menu_bar_items_vector
);
6943 /* Build our list of keymaps.
6944 If we recognize a function key and replace its escape sequence in
6945 keybuf with its symbol, or if the sequence starts with a mouse
6946 click and we need to switch buffers, we jump back here to rebuild
6947 the initial keymaps from the current buffer. */
6951 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6952 if (!NILP (Voverriding_local_map_menu_flag
))
6954 /* Yes, use them (if non-nil) as well as the global map. */
6955 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6957 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6958 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6959 if (!NILP (Voverriding_local_map
))
6960 maps
[nmaps
++] = Voverriding_local_map
;
6964 /* No, so use major and minor mode keymaps and keymap property.
6965 Note that menu-bar bindings in the local-map and keymap
6966 properties may not work reliable, as they are only
6967 recognized when the menu-bar (or mode-line) is updated,
6968 which does not normally happen after every command. */
6971 nminor
= current_minor_maps (NULL
, &tmaps
);
6972 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6974 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6975 maps
[nmaps
++] = tem
;
6976 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6978 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6980 maps
[nmaps
++] = current_global_map
;
6983 /* Look up in each map the dummy prefix key `menu-bar'. */
6987 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6988 if (!NILP (maps
[mapno
]))
6990 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6994 menu_bar_one_keymap_changed_items
= Qnil
;
6995 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
6999 /* Move to the end those items that should be at the end. */
7001 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7004 int end
= menu_bar_items_index
;
7006 for (i
= 0; i
< end
; i
+= 4)
7007 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7009 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7010 /* Move the item at index I to the end,
7011 shifting all the others forward. */
7012 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7013 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7014 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7015 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7017 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7018 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7019 (end
- i
- 4) * sizeof (Lisp_Object
));
7020 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7021 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7022 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7023 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7028 /* Add nil, nil, nil, nil at the end. */
7029 i
= menu_bar_items_index
;
7030 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7033 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7034 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7035 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7036 menu_bar_items_vector
= tem
;
7038 /* Add this item. */
7039 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7040 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7041 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7042 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7043 menu_bar_items_index
= i
;
7045 Vinhibit_quit
= oquit
;
7047 return menu_bar_items_vector
;
7050 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7051 If there's already an item for KEY, add this DEF to it. */
7053 Lisp_Object item_properties
;
7056 menu_bar_item (key
, item
, dummy1
, dummy2
)
7057 Lisp_Object key
, item
, dummy1
;
7060 struct gcpro gcpro1
;
7064 if (EQ (item
, Qundefined
))
7066 /* If a map has an explicit `undefined' as definition,
7067 discard any previously made menu bar item. */
7069 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7070 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7072 if (menu_bar_items_index
> i
+ 4)
7073 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7074 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7075 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7076 menu_bar_items_index
-= 4;
7080 /* If this keymap has already contributed to this KEY,
7081 don't contribute to it a second time. */
7082 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7083 if (!NILP (tem
) || NILP (item
))
7086 menu_bar_one_keymap_changed_items
7087 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7089 /* We add to menu_bar_one_keymap_changed_items before doing the
7090 parse_menu_item, so that if it turns out it wasn't a menu item,
7091 it still correctly hides any further menu item. */
7093 i
= parse_menu_item (item
, 0, 1);
7098 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7100 /* Find any existing item for this KEY. */
7101 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7102 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7105 /* If we did not find this KEY, add it at the end. */
7106 if (i
== menu_bar_items_index
)
7108 /* If vector is too small, get a bigger one. */
7109 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7112 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7113 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7114 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7115 menu_bar_items_vector
= tem
;
7118 /* Add this item. */
7119 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7120 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7121 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7122 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7123 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7124 menu_bar_items_index
= i
;
7126 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7130 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7131 /* If the new and the old items are not both keymaps,
7132 the lookup will only find `item'. */
7133 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7134 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7138 /* This is used as the handler when calling menu_item_eval_property. */
7140 menu_item_eval_property_1 (arg
)
7143 /* If we got a quit from within the menu computation,
7144 quit all the way out of it. This takes care of C-] in the debugger. */
7145 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7146 Fsignal (Qquit
, Qnil
);
7151 /* Evaluate an expression and return the result (or nil if something
7152 went wrong). Used to evaluate dynamic parts of menu items. */
7154 menu_item_eval_property (sexpr
)
7157 int count
= SPECPDL_INDEX ();
7159 specbind (Qinhibit_redisplay
, Qt
);
7160 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7161 menu_item_eval_property_1
);
7162 return unbind_to (count
, val
);
7165 /* This function parses a menu item and leaves the result in the
7166 vector item_properties.
7167 ITEM is a key binding, a possible menu item.
7168 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7169 evaluate dynamic expressions in the menu item.
7170 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7172 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7173 parse_menu_item returns true if the item is a menu item and false
7177 parse_menu_item (item
, notreal
, inmenubar
)
7179 int notreal
, inmenubar
;
7181 Lisp_Object def
, tem
, item_string
, start
;
7182 Lisp_Object cachelist
;
7184 Lisp_Object keyhint
;
7195 /* Create item_properties vector if necessary. */
7196 if (NILP (item_properties
))
7198 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7200 /* Initialize optional entries. */
7201 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7202 AREF (item_properties
, i
) = Qnil
;
7203 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7205 /* Save the item here to protect it from GC. */
7206 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7208 item_string
= XCAR (item
);
7212 if (STRINGP (item_string
))
7214 /* Old format menu item. */
7215 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7217 /* Maybe help string. */
7218 if (CONSP (item
) && STRINGP (XCAR (item
)))
7220 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7225 /* Maybe key binding cache. */
7226 if (CONSP (item
) && CONSP (XCAR (item
))
7227 && (NILP (XCAR (XCAR (item
)))
7228 || VECTORP (XCAR (XCAR (item
)))))
7230 cachelist
= XCAR (item
);
7234 /* This is the real definition--the function to run. */
7235 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7237 /* Get enable property, if any. */
7240 tem
= Fget (item
, Qmenu_enable
);
7242 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7245 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7247 /* New format menu item. */
7248 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7249 start
= XCDR (item
);
7252 /* We have a real binding. */
7253 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7255 item
= XCDR (start
);
7256 /* Is there a cache list with key equivalences. */
7257 if (CONSP (item
) && CONSP (XCAR (item
)))
7259 cachelist
= XCAR (item
);
7263 /* Parse properties. */
7264 while (CONSP (item
) && CONSP (XCDR (item
)))
7269 if (EQ (tem
, QCenable
))
7270 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7271 else if (EQ (tem
, QCvisible
) && !notreal
)
7273 /* If got a visible property and that evaluates to nil
7274 then ignore this item. */
7275 tem
= menu_item_eval_property (XCAR (item
));
7279 else if (EQ (tem
, QChelp
))
7280 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7281 else if (EQ (tem
, QCfilter
))
7283 else if (EQ (tem
, QCkey_sequence
))
7286 if (NILP (cachelist
)
7287 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7288 /* Be GC protected. Set keyhint to item instead of tem. */
7291 else if (EQ (tem
, QCkeys
))
7294 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7295 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7297 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7302 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7304 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7306 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7313 else if (inmenubar
|| !NILP (start
))
7317 return 0; /* not a menu item */
7319 /* If item string is not a string, evaluate it to get string.
7320 If we don't get a string, skip this item. */
7321 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7322 if (!(STRINGP (item_string
) || notreal
))
7324 item_string
= menu_item_eval_property (item_string
);
7325 if (!STRINGP (item_string
))
7327 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7330 /* If got a filter apply it on definition. */
7331 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7334 def
= menu_item_eval_property (list2 (XCAR (filter
),
7335 list2 (Qquote
, def
)));
7337 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7340 /* Enable or disable selection of item. */
7341 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7347 tem
= menu_item_eval_property (tem
);
7348 if (inmenubar
&& NILP (tem
))
7349 return 0; /* Ignore disabled items in menu bar. */
7350 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7353 /* If we got no definition, this item is just unselectable text which
7354 is OK in a submenu but not in the menubar. */
7356 return (inmenubar
? 0 : 1);
7358 /* See if this is a separate pane or a submenu. */
7359 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7360 tem
= get_keymap (def
, 0, 1);
7361 /* For a subkeymap, just record its details and exit. */
7364 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7365 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7369 /* At the top level in the menu bar, do likewise for commands also.
7370 The menu bar does not display equivalent key bindings anyway.
7371 ITEM_PROPERTY_DEF is already set up properly. */
7375 /* This is a command. See if there is an equivalent key binding. */
7376 if (NILP (cachelist
))
7378 /* We have to create a cachelist. */
7379 CHECK_IMPURE (start
);
7380 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7381 cachelist
= XCAR (XCDR (start
));
7383 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7384 if (!NILP (keyhint
))
7386 XSETCAR (cachelist
, XCAR (keyhint
));
7389 else if (STRINGP (tem
))
7391 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7392 XSETCAR (cachelist
, Qt
);
7396 tem
= XCAR (cachelist
);
7403 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7405 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7408 def
= XCAR (prefix
);
7409 prefix
= XCDR (prefix
);
7412 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7414 if (!update_menu_bindings
)
7416 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7418 if (newcache
/* Always check first time. */
7419 /* Should we check everything when precomputing key
7421 /* If something had no key binding before, don't recheck it
7422 because that is too slow--except if we have a list of
7423 rebound commands in Vdefine_key_rebound_commands, do
7424 recheck any command that appears in that list. */
7425 || (CONSP (Vdefine_key_rebound_commands
)
7426 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7429 /* We had a saved key. Is it still bound to the command? */
7432 /* If the command is an alias for another
7433 (such as lmenu.el set it up), check if the
7434 original command matches the cached command. */
7435 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7436 chkcache
= 1; /* Need to recompute key binding. */
7440 /* Recompute equivalent key binding. If the command is an alias
7441 for another (such as lmenu.el set it up), see if the original
7442 command name has equivalent keys. Otherwise look up the
7443 specified command itself. We don't try both, because that
7444 makes lmenu menus slow. */
7446 && SYMBOLP (XSYMBOL (def
)->function
)
7447 && ! NILP (Fget (def
, Qmenu_alias
)))
7448 def
= XSYMBOL (def
)->function
;
7449 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7450 XSETCAR (cachelist
, tem
);
7453 XSETCDR (cachelist
, Qnil
);
7457 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7459 tem
= XCAR (cachelist
);
7463 newcache
= chkcache
;
7466 tem
= Fkey_description (tem
);
7469 if (STRINGP (XCAR (prefix
)))
7470 tem
= concat2 (XCAR (prefix
), tem
);
7471 if (STRINGP (XCDR (prefix
)))
7472 tem
= concat2 (tem
, XCDR (prefix
));
7474 XSETCDR (cachelist
, tem
);
7478 tem
= XCDR (cachelist
);
7479 if (newcache
&& !NILP (tem
))
7481 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7482 XSETCDR (cachelist
, tem
);
7485 /* If we only want to precompute equivalent key bindings, stop here. */
7489 /* If we have an equivalent key binding, use that. */
7490 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7492 /* Include this when menu help is implemented.
7493 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7494 if (!(NILP (tem) || STRINGP (tem)))
7496 tem = menu_item_eval_property (tem);
7499 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7503 /* Handle radio buttons or toggle boxes. */
7504 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7506 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7507 = menu_item_eval_property (tem
);
7514 /***********************************************************************
7516 ***********************************************************************/
7518 /* A vector holding tool bar items while they are parsed in function
7519 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7522 static Lisp_Object tool_bar_items_vector
;
7524 /* A vector holding the result of parse_tool_bar_item. Layout is like
7525 the one for a single item in tool_bar_items_vector. */
7527 static Lisp_Object tool_bar_item_properties
;
7529 /* Next free index in tool_bar_items_vector. */
7531 static int ntool_bar_items
;
7533 /* The symbols `tool-bar', and `:image'. */
7535 extern Lisp_Object Qtool_bar
;
7536 Lisp_Object QCimage
;
7538 /* Function prototypes. */
7540 static void init_tool_bar_items
P_ ((Lisp_Object
));
7541 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7542 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7543 static void append_tool_bar_item
P_ ((void));
7546 /* Return a vector of tool bar items for keymaps currently in effect.
7547 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7548 tool bar items found. */
7551 tool_bar_items (reuse
, nitems
)
7562 /* In order to build the menus, we need to call the keymap
7563 accessors. They all call QUIT. But this function is called
7564 during redisplay, during which a quit is fatal. So inhibit
7565 quitting while building the menus. We do this instead of
7566 specbind because (1) errors will clear it anyway and (2) this
7567 avoids risk of specpdl overflow. */
7568 oquit
= Vinhibit_quit
;
7571 /* Initialize tool_bar_items_vector and protect it from GC. */
7572 init_tool_bar_items (reuse
);
7574 /* Build list of keymaps in maps. Set nmaps to the number of maps
7577 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7578 if (!NILP (Voverriding_local_map_menu_flag
))
7580 /* Yes, use them (if non-nil) as well as the global map. */
7581 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7583 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7584 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7585 if (!NILP (Voverriding_local_map
))
7586 maps
[nmaps
++] = Voverriding_local_map
;
7590 /* No, so use major and minor mode keymaps and keymap property.
7591 Note that tool-bar bindings in the local-map and keymap
7592 properties may not work reliable, as they are only
7593 recognized when the tool-bar (or mode-line) is updated,
7594 which does not normally happen after every command. */
7597 nminor
= current_minor_maps (NULL
, &tmaps
);
7598 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7600 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7601 maps
[nmaps
++] = tem
;
7602 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7604 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7607 /* Add global keymap at the end. */
7608 maps
[nmaps
++] = current_global_map
;
7610 /* Process maps in reverse order and look up in each map the prefix
7612 for (i
= nmaps
- 1; i
>= 0; --i
)
7613 if (!NILP (maps
[i
]))
7617 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7622 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7623 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7625 Lisp_Object keydef
= XCAR (tail
);
7627 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7632 Vinhibit_quit
= oquit
;
7633 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7634 return tool_bar_items_vector
;
7638 /* Process the definition of KEY which is DEF. */
7641 process_tool_bar_item (key
, def
)
7642 Lisp_Object key
, def
;
7645 extern Lisp_Object Qundefined
;
7646 struct gcpro gcpro1
, gcpro2
;
7648 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7652 if (EQ (def
, Qundefined
))
7654 /* If a map has an explicit `undefined' as definition,
7655 discard any previously made item. */
7656 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7658 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7660 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7662 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7663 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7664 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7665 * sizeof (Lisp_Object
)));
7666 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7671 else if (parse_tool_bar_item (key
, def
))
7672 /* Append a new tool bar item to tool_bar_items_vector. Accept
7673 more than one definition for the same key. */
7674 append_tool_bar_item ();
7680 /* Parse a tool bar item specification ITEM for key KEY and return the
7681 result in tool_bar_item_properties. Value is zero if ITEM is
7684 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7686 CAPTION is the caption of the item, If it's not a string, it is
7687 evaluated to get a string.
7689 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7690 as binding are currently ignored.
7692 The following properties are recognized:
7696 FORM is evaluated and specifies whether the tool bar item is
7697 enabled or disabled.
7701 FORM is evaluated and specifies whether the tool bar item is visible.
7703 - `:filter FUNCTION'
7705 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7706 result is stored as the new binding.
7708 - `:button (TYPE SELECTED)'
7710 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7711 and specifies whether the button is selected (pressed) or not.
7715 IMAGES is either a single image specification or a vector of four
7716 image specifications. See enum tool_bar_item_images.
7718 - `:help HELP-STRING'.
7720 Gives a help string to display for the tool bar item. */
7723 parse_tool_bar_item (key
, item
)
7724 Lisp_Object key
, item
;
7726 /* Access slot with index IDX of vector tool_bar_item_properties. */
7727 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7729 Lisp_Object filter
= Qnil
;
7730 Lisp_Object caption
;
7733 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7734 Rule out items that aren't lists, don't start with
7735 `menu-item' or whose rest following `tool-bar-item' is not a
7738 || !EQ (XCAR (item
), Qmenu_item
)
7739 || (item
= XCDR (item
),
7743 /* Create tool_bar_item_properties vector if necessary. Reset it to
7745 if (VECTORP (tool_bar_item_properties
))
7747 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7751 tool_bar_item_properties
7752 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7755 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7756 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7758 /* Get the caption of the item. If the caption is not a string,
7759 evaluate it to get a string. If we don't get a string, skip this
7761 caption
= XCAR (item
);
7762 if (!STRINGP (caption
))
7764 caption
= menu_item_eval_property (caption
);
7765 if (!STRINGP (caption
))
7768 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7770 /* Give up if rest following the caption is not a list. */
7775 /* Store the binding. */
7776 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7779 /* Ignore cached key binding, if any. */
7780 if (CONSP (item
) && CONSP (XCAR (item
)))
7783 /* Process the rest of the properties. */
7784 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7786 Lisp_Object key
, value
;
7789 value
= XCAR (XCDR (item
));
7791 if (EQ (key
, QCenable
))
7792 /* `:enable FORM'. */
7793 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7794 else if (EQ (key
, QCvisible
))
7796 /* `:visible FORM'. If got a visible property and that
7797 evaluates to nil then ignore this item. */
7798 if (NILP (menu_item_eval_property (value
)))
7801 else if (EQ (key
, QChelp
))
7802 /* `:help HELP-STRING'. */
7803 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7804 else if (EQ (key
, QCfilter
))
7805 /* ':filter FORM'. */
7807 else if (EQ (key
, QCbutton
) && CONSP (value
))
7809 /* `:button (TYPE . SELECTED)'. */
7810 Lisp_Object type
, selected
;
7812 type
= XCAR (value
);
7813 selected
= XCDR (value
);
7814 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7816 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7817 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7820 else if (EQ (key
, QCimage
)
7822 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7823 /* Value is either a single image specification or a vector
7824 of 4 such specifications for the different button states. */
7825 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7828 /* If got a filter apply it on binding. */
7830 PROP (TOOL_BAR_ITEM_BINDING
)
7831 = menu_item_eval_property (list2 (filter
,
7833 PROP (TOOL_BAR_ITEM_BINDING
))));
7835 /* See if the binding is a keymap. Give up if it is. */
7836 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7839 /* Enable or disable selection of item. */
7840 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7841 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7842 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7844 /* Handle radio buttons or toggle boxes. */
7845 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7846 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7847 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7855 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7856 that can be reused. */
7859 init_tool_bar_items (reuse
)
7862 if (VECTORP (reuse
))
7863 tool_bar_items_vector
= reuse
;
7865 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7866 ntool_bar_items
= 0;
7870 /* Append parsed tool bar item properties from
7871 tool_bar_item_properties */
7874 append_tool_bar_item ()
7876 Lisp_Object
*to
, *from
;
7878 /* Enlarge tool_bar_items_vector if necessary. */
7879 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7880 >= XVECTOR (tool_bar_items_vector
)->size
)
7882 Lisp_Object new_vector
;
7883 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7885 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7886 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7887 XVECTOR (new_vector
)->contents
,
7888 old_size
* sizeof (Lisp_Object
));
7889 tool_bar_items_vector
= new_vector
;
7892 /* Append entries from tool_bar_item_properties to the end of
7893 tool_bar_items_vector. */
7894 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7895 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7896 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7897 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7904 /* Read a character using menus based on maps in the array MAPS.
7905 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7906 Return t if we displayed a menu but the user rejected it.
7908 PREV_EVENT is the previous input event, or nil if we are reading
7909 the first event of a key sequence.
7911 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7912 if we used a mouse menu to read the input, or zero otherwise. If
7913 USED_MOUSE_MENU is null, we don't dereference it.
7915 The prompting is done based on the prompt-string of the map
7916 and the strings associated with various map elements.
7918 This can be done with X menus or with menus put in the minibuf.
7919 These are done in different ways, depending on how the input will be read.
7920 Menus using X are done after auto-saving in read-char, getting the input
7921 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7922 and do auto-saving in the inner call of read_char. */
7925 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7928 Lisp_Object prev_event
;
7929 int *used_mouse_menu
;
7932 register Lisp_Object name
= Qnil
;
7934 if (used_mouse_menu
)
7935 *used_mouse_menu
= 0;
7937 /* Use local over global Menu maps */
7939 if (! menu_prompting
)
7942 /* Optionally disregard all but the global map. */
7943 if (inhibit_local_menu_bar_menus
)
7945 maps
+= (nmaps
- 1);
7949 /* Get the menu name from the first map that has one (a prompt string). */
7950 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7952 name
= Fkeymap_prompt (maps
[mapno
]);
7957 /* If we don't have any menus, just read a character normally. */
7958 if (!STRINGP (name
))
7962 /* If we got to this point via a mouse click,
7963 use a real menu for mouse selection. */
7964 if (EVENT_HAS_PARAMETERS (prev_event
)
7965 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7966 && !EQ (XCAR (prev_event
), Qtool_bar
))
7968 /* Display the menu and get the selection. */
7969 Lisp_Object
*realmaps
7970 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7974 /* Use the maps that are not nil. */
7975 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7976 if (!NILP (maps
[mapno
]))
7977 realmaps
[nmaps1
++] = maps
[mapno
];
7979 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7984 record_menu_key (XCAR (value
));
7986 /* If we got multiple events, unread all but
7988 There is no way to prevent those unread events
7989 from showing up later in last_nonmenu_event.
7990 So turn symbol and integer events into lists,
7991 to indicate that they came from a mouse menu,
7992 so that when present in last_nonmenu_event
7993 they won't confuse things. */
7994 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7996 record_menu_key (XCAR (tem
));
7997 if (SYMBOLP (XCAR (tem
))
7998 || INTEGERP (XCAR (tem
)))
7999 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8002 /* If we got more than one event, put all but the first
8003 onto this list to be read later.
8004 Return just the first event now. */
8005 Vunread_command_events
8006 = nconc2 (XCDR (value
), Vunread_command_events
);
8007 value
= XCAR (value
);
8009 else if (NILP (value
))
8011 if (used_mouse_menu
)
8012 *used_mouse_menu
= 1;
8015 #endif /* HAVE_MENUS */
8019 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8020 We make this bigger when necessary, and never free it. */
8021 static char *read_char_minibuf_menu_text
;
8022 /* Size of that buffer. */
8023 static int read_char_minibuf_menu_width
;
8026 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8032 register Lisp_Object name
;
8034 /* FIXME: Use the minibuffer's frame width. */
8035 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8038 Lisp_Object rest
, vector
;
8044 if (! menu_prompting
)
8047 /* Make sure we have a big enough buffer for the menu text. */
8048 if (read_char_minibuf_menu_text
== 0)
8050 read_char_minibuf_menu_width
= width
+ 4;
8051 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8053 else if (width
+ 4 > read_char_minibuf_menu_width
)
8055 read_char_minibuf_menu_width
= width
+ 4;
8056 read_char_minibuf_menu_text
8057 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8059 menu
= read_char_minibuf_menu_text
;
8061 /* Get the menu name from the first map that has one (a prompt string). */
8062 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8064 name
= Fkeymap_prompt (maps
[mapno
]);
8069 /* If we don't have any menus, just read a character normally. */
8070 if (!STRINGP (name
))
8073 /* Prompt string always starts with map's prompt, and a space. */
8074 strcpy (menu
, SDATA (name
));
8075 nlength
= SBYTES (name
);
8076 menu
[nlength
++] = ':';
8077 menu
[nlength
++] = ' ';
8080 /* Start prompting at start of first map. */
8084 /* Present the documented bindings, a line at a time. */
8091 Lisp_Object orig_defn_macro
;
8093 /* Loop over elements of map. */
8098 /* If reached end of map, start at beginning of next map. */
8102 /* At end of last map, wrap around to first map if just starting,
8103 or end this line if already have something on it. */
8107 if (notfirst
|| nobindings
) break;
8112 /* Look at the next element of the map. */
8114 elt
= XVECTOR (vector
)->contents
[idx
];
8116 elt
= Fcar_safe (rest
);
8118 if (idx
< 0 && VECTORP (elt
))
8120 /* If we found a dense table in the keymap,
8121 advanced past it, but start scanning its contents. */
8122 rest
= Fcdr_safe (rest
);
8128 /* An ordinary element. */
8129 Lisp_Object event
, tem
;
8133 event
= Fcar_safe (elt
); /* alist */
8134 elt
= Fcdr_safe (elt
);
8138 XSETINT (event
, idx
); /* vector */
8141 /* Ignore the element if it has no prompt string. */
8142 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8144 /* 1 if the char to type matches the string. */
8146 Lisp_Object upcased_event
, downcased_event
;
8147 Lisp_Object desc
= Qnil
;
8149 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8151 upcased_event
= Fupcase (event
);
8152 downcased_event
= Fdowncase (event
);
8153 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8154 || XINT (downcased_event
) == SREF (s
, 0));
8156 desc
= Fsingle_key_description (event
, Qnil
);
8158 #if 0 /* It is redundant to list the equivalent key bindings because
8159 the prefix is what the user has already typed. */
8161 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8163 /* Insert equivalent keybinding. */
8164 s
= concat2 (s
, tem
);
8167 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8168 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8170 /* Insert button prefix. */
8171 Lisp_Object selected
8172 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8173 if (EQ (tem
, QCradio
))
8174 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8176 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8177 s
= concat2 (tem
, s
);
8181 /* If we have room for the prompt string, add it to this line.
8182 If this is the first on the line, always add it. */
8183 if ((SCHARS (s
) + i
+ 2
8184 + (char_matches
? 0 : SCHARS (desc
) + 3))
8190 /* Punctuate between strings. */
8193 strcpy (menu
+ i
, ", ");
8199 /* If the char to type doesn't match the string's
8200 first char, explicitly show what char to type. */
8203 /* Add as much of string as fits. */
8204 thiswidth
= SCHARS (desc
);
8205 if (thiswidth
+ i
> width
)
8206 thiswidth
= width
- i
;
8207 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8209 strcpy (menu
+ i
, " = ");
8213 /* Add as much of string as fits. */
8214 thiswidth
= SCHARS (s
);
8215 if (thiswidth
+ i
> width
)
8216 thiswidth
= width
- i
;
8217 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8223 /* If this element does not fit, end the line now,
8224 and save the element for the next line. */
8225 strcpy (menu
+ i
, "...");
8230 /* Move past this element. */
8231 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8232 /* Handle reaching end of dense table. */
8237 rest
= Fcdr_safe (rest
);
8241 /* Prompt with that and read response. */
8242 message2_nolog (menu
, strlen (menu
),
8243 ! NILP (current_buffer
->enable_multibyte_characters
));
8245 /* Make believe its not a keyboard macro in case the help char
8246 is pressed. Help characters are not recorded because menu prompting
8247 is not used on replay.
8249 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8250 current_kboard
->defining_kbd_macro
= Qnil
;
8252 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8253 while (BUFFERP (obj
));
8254 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8256 if (!INTEGERP (obj
))
8261 if (! EQ (obj
, menu_prompt_more_char
)
8262 && (!INTEGERP (menu_prompt_more_char
)
8263 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8265 if (!NILP (current_kboard
->defining_kbd_macro
))
8266 store_kbd_macro_char (obj
);
8269 /* Help char - go round again */
8273 /* Reading key sequences. */
8275 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8276 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8277 keymap, or nil otherwise. Return the index of the first keymap in
8278 which KEY has any binding, or NMAPS if no map has a binding.
8280 If KEY is a meta ASCII character, treat it like meta-prefix-char
8281 followed by the corresponding non-meta character. Keymaps in
8282 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8285 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8288 NEXT may be the same array as CURRENT. */
8291 follow_key (key
, nmaps
, current
, defs
, next
)
8293 Lisp_Object
*current
, *defs
, *next
;
8296 int i
, first_binding
;
8298 first_binding
= nmaps
;
8299 for (i
= nmaps
- 1; i
>= 0; i
--)
8301 if (! NILP (current
[i
]))
8303 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8304 if (! NILP (defs
[i
]))
8311 /* Given the set of bindings we've found, produce the next set of maps. */
8312 if (first_binding
< nmaps
)
8313 for (i
= 0; i
< nmaps
; i
++)
8314 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8316 return first_binding
;
8319 /* Structure used to keep track of partial application of key remapping
8320 such as Vfunction_key_map and Vkey_translation_map. */
8321 typedef struct keyremap
8323 Lisp_Object map
, parent
;
8327 /* Lookup KEY in MAP.
8328 MAP is a keymap mapping keys to key vectors or functions.
8329 If the mapping is a function and DO_FUNCTION is non-zero, then
8330 the function is called with PROMPT as parameter and its return
8331 value is used as the return value of this function (after checking
8332 that it is indeed a vector). */
8335 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8336 Lisp_Object map
, key
, prompt
;
8341 next
= access_keymap (map
, key
, 1, 0, 1);
8343 /* Handle symbol with autoload definition. */
8344 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8345 && CONSP (XSYMBOL (next
)->function
)
8346 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8347 do_autoload (XSYMBOL (next
)->function
, next
);
8349 /* Handle a symbol whose function definition is a keymap
8351 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8352 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8353 || KEYMAPP (XSYMBOL (next
)->function
)))
8354 next
= XSYMBOL (next
)->function
;
8356 /* If the keymap gives a function, not an
8357 array, then call the function with one arg and use
8358 its value instead. */
8359 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8364 next
= call1 (next
, prompt
);
8365 /* If the function returned something invalid,
8366 barf--don't ignore it.
8367 (To ignore it safely, we would need to gcpro a bunch of
8368 other variables.) */
8369 if (! (VECTORP (next
) || STRINGP (next
)))
8370 error ("Function %s returns invalid key sequence", tem
);
8375 /* Do one step of the key remapping used for function-key-map and
8376 key-translation-map:
8377 KEYBUF is the buffer holding the input events.
8378 BUFSIZE is its maximum size.
8379 FKEY is a pointer to the keyremap structure to use.
8380 INPUT is the index of the last element in KEYBUF.
8381 DOIT if non-zero says that the remapping can actually take place.
8382 DIFF is used to return the number of keys added/removed by the remapping.
8383 PARENT is the root of the keymap.
8384 PROMPT is the prompt to use if the remapping happens through a function.
8385 The return value is non-zero if the remapping actually took place. */
8388 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8389 Lisp_Object
*keybuf
, prompt
;
8391 int input
, doit
, *diff
, bufsize
;
8393 Lisp_Object next
, key
;
8395 key
= keybuf
[fkey
->end
++];
8396 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8398 /* If keybuf[fkey->start..fkey->end] is bound in the
8399 map and we're in a position to do the key remapping, replace it with
8400 the binding and restart with fkey->start at the end. */
8401 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8403 int len
= XFASTINT (Flength (next
));
8406 *diff
= len
- (fkey
->end
- fkey
->start
);
8408 if (input
+ *diff
>= bufsize
)
8409 error ("Key sequence too long");
8411 /* Shift the keys that follow fkey->end. */
8413 for (i
= fkey
->end
; i
< input
; i
++)
8414 keybuf
[i
+ *diff
] = keybuf
[i
];
8416 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8417 keybuf
[i
+ *diff
] = keybuf
[i
];
8418 /* Overwrite the old keys with the new ones. */
8419 for (i
= 0; i
< len
; i
++)
8420 keybuf
[fkey
->start
+ i
]
8421 = Faref (next
, make_number (i
));
8423 fkey
->start
= fkey
->end
+= *diff
;
8424 fkey
->map
= fkey
->parent
;
8429 fkey
->map
= get_keymap (next
, 0, 1);
8431 /* If we no longer have a bound suffix, try a new position for
8433 if (!CONSP (fkey
->map
))
8435 fkey
->end
= ++fkey
->start
;
8436 fkey
->map
= fkey
->parent
;
8441 /* Read a sequence of keys that ends with a non prefix character,
8442 storing it in KEYBUF, a buffer of size BUFSIZE.
8444 Return the length of the key sequence stored.
8445 Return -1 if the user rejected a command menu.
8447 Echo starting immediately unless `prompt' is 0.
8449 Where a key sequence ends depends on the currently active keymaps.
8450 These include any minor mode keymaps active in the current buffer,
8451 the current buffer's local map, and the global map.
8453 If a key sequence has no other bindings, we check Vfunction_key_map
8454 to see if some trailing subsequence might be the beginning of a
8455 function key's sequence. If so, we try to read the whole function
8456 key, and substitute its symbolic name into the key sequence.
8458 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8459 `double-' events into similar click events, if that would make them
8460 bound. We try to turn `triple-' events first into `double-' events,
8463 If we get a mouse click in a mode line, vertical divider, or other
8464 non-text area, we treat the click as if it were prefixed by the
8465 symbol denoting that area - `mode-line', `vertical-line', or
8468 If the sequence starts with a mouse click, we read the key sequence
8469 with respect to the buffer clicked on, not the current buffer.
8471 If the user switches frames in the midst of a key sequence, we put
8472 off the switch-frame event until later; the next call to
8473 read_char will return it.
8475 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8476 from the selected window's buffer. */
8479 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8480 can_return_switch_frame
, fix_current_buffer
)
8481 Lisp_Object
*keybuf
;
8484 int dont_downcase_last
;
8485 int can_return_switch_frame
;
8486 int fix_current_buffer
;
8488 volatile Lisp_Object from_string
;
8489 volatile int count
= SPECPDL_INDEX ();
8491 /* How many keys there are in the current key sequence. */
8494 /* The length of the echo buffer when we started reading, and
8495 the length of this_command_keys when we started reading. */
8496 volatile int echo_start
;
8497 volatile int keys_start
;
8499 /* The number of keymaps we're scanning right now, and the number of
8500 keymaps we have allocated space for. */
8502 volatile int nmaps_allocated
= 0;
8504 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8505 the current keymaps. */
8506 Lisp_Object
*volatile defs
= NULL
;
8508 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8509 in the current keymaps, or nil where it is not a prefix. */
8510 Lisp_Object
*volatile submaps
= NULL
;
8512 /* The local map to start out with at start of key sequence. */
8513 volatile Lisp_Object orig_local_map
;
8515 /* The map from the `keymap' property to start out with at start of
8517 volatile Lisp_Object orig_keymap
;
8519 /* 1 if we have already considered switching to the local-map property
8520 of the place where a mouse click occurred. */
8521 volatile int localized_local_map
= 0;
8523 /* The index in defs[] of the first keymap that has a binding for
8524 this key sequence. In other words, the lowest i such that
8525 defs[i] is non-nil. */
8526 volatile int first_binding
;
8527 /* Index of the first key that has no binding.
8528 It is useless to try fkey.start larger than that. */
8529 volatile int first_unbound
;
8531 /* If t < mock_input, then KEYBUF[t] should be read as the next
8534 We use this to recover after recognizing a function key. Once we
8535 realize that a suffix of the current key sequence is actually a
8536 function key's escape sequence, we replace the suffix with the
8537 function key's binding from Vfunction_key_map. Now keybuf
8538 contains a new and different key sequence, so the echo area,
8539 this_command_keys, and the submaps and defs arrays are wrong. In
8540 this situation, we set mock_input to t, set t to 0, and jump to
8541 restart_sequence; the loop will read keys from keybuf up until
8542 mock_input, thus rebuilding the state; and then it will resume
8543 reading characters from the keyboard. */
8544 volatile int mock_input
= 0;
8546 /* If the sequence is unbound in submaps[], then
8547 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8548 and fkey.map is its binding.
8550 These might be > t, indicating that all function key scanning
8551 should hold off until t reaches them. We do this when we've just
8552 recognized a function key, to avoid searching for the function
8553 key's again in Vfunction_key_map. */
8554 volatile keyremap fkey
;
8556 /* Likewise, for key_translation_map. */
8557 volatile keyremap keytran
;
8559 /* If we receive a `switch-frame' or `select-window' event in the middle of
8560 a key sequence, we put it off for later.
8561 While we're reading, we keep the event here. */
8562 volatile Lisp_Object delayed_switch_frame
;
8564 /* See the comment below... */
8565 #if defined (GOBBLE_FIRST_EVENT)
8566 Lisp_Object first_event
;
8569 volatile Lisp_Object original_uppercase
;
8570 volatile int original_uppercase_position
= -1;
8572 /* Gets around Microsoft compiler limitations. */
8575 struct buffer
*starting_buffer
;
8577 /* List of events for which a fake prefix key has been generated. */
8578 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8580 #if defined (GOBBLE_FIRST_EVENT)
8584 struct gcpro gcpro1
;
8586 GCPRO1 (fake_prefixed_keys
);
8587 raw_keybuf_count
= 0;
8589 last_nonmenu_event
= Qnil
;
8591 delayed_switch_frame
= Qnil
;
8592 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8593 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8594 /* If there is no translation-map, turn off scanning. */
8595 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8596 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8601 echo_prompt (prompt
);
8602 else if (cursor_in_echo_area
8603 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8604 && NILP (Fzerop (Vecho_keystrokes
)))
8605 /* This doesn't put in a dash if the echo buffer is empty, so
8606 you don't always see a dash hanging out in the minibuffer. */
8610 /* Record the initial state of the echo area and this_command_keys;
8611 we will need to restore them if we replay a key sequence. */
8613 echo_start
= echo_length ();
8614 keys_start
= this_command_key_count
;
8615 this_single_command_key_start
= keys_start
;
8617 #if defined (GOBBLE_FIRST_EVENT)
8618 /* This doesn't quite work, because some of the things that read_char
8619 does cannot safely be bypassed. It seems too risky to try to make
8622 /* Read the first char of the sequence specially, before setting
8623 up any keymaps, in case a filter runs and switches buffers on us. */
8624 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8626 #endif /* GOBBLE_FIRST_EVENT */
8628 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8629 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8632 /* We jump here when the key sequence has been thoroughly changed, and
8633 we need to rescan it starting from the beginning. When we jump here,
8634 keybuf[0..mock_input] holds the sequence we should reread. */
8637 starting_buffer
= current_buffer
;
8638 first_unbound
= bufsize
+ 1;
8640 /* Build our list of keymaps.
8641 If we recognize a function key and replace its escape sequence in
8642 keybuf with its symbol, or if the sequence starts with a mouse
8643 click and we need to switch buffers, we jump back here to rebuild
8644 the initial keymaps from the current buffer. */
8647 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8648 || !NILP (Voverriding_local_map
))
8650 if (3 > nmaps_allocated
)
8652 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8653 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8654 nmaps_allocated
= 3;
8656 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8657 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8658 if (!NILP (Voverriding_local_map
))
8659 submaps
[nmaps
++] = Voverriding_local_map
;
8667 nminor
= current_minor_maps (0, &maps
);
8668 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8670 if (total
> nmaps_allocated
)
8672 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8673 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8674 nmaps_allocated
= total
;
8677 if (!NILP (orig_keymap
))
8678 submaps
[nmaps
++] = orig_keymap
;
8680 bcopy (maps
, (void *) (submaps
+ nmaps
),
8681 nminor
* sizeof (submaps
[0]));
8685 submaps
[nmaps
++] = orig_local_map
;
8687 submaps
[nmaps
++] = current_global_map
;
8689 /* Find an accurate initial value for first_binding. */
8690 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8691 if (! NILP (submaps
[first_binding
]))
8694 /* Start from the beginning in keybuf. */
8697 /* These are no-ops the first time through, but if we restart, they
8698 revert the echo area and this_command_keys to their original state. */
8699 this_command_key_count
= keys_start
;
8700 if (INTERACTIVE
&& t
< mock_input
)
8701 echo_truncate (echo_start
);
8703 /* If the best binding for the current key sequence is a keymap, or
8704 we may be looking at a function key's escape sequence, keep on
8706 while (first_binding
< nmaps
8707 /* Keep reading as long as there's a prefix binding. */
8708 ? !NILP (submaps
[first_binding
])
8709 /* Don't return in the middle of a possible function key sequence,
8710 if the only bindings we found were via case conversion.
8711 Thus, if ESC O a has a function-key-map translation
8712 and ESC o has a binding, don't return after ESC O,
8713 so that we can translate ESC O plus the next character. */
8714 : (fkey
.start
< t
|| keytran
.start
< t
))
8717 int used_mouse_menu
= 0;
8719 /* Where the last real key started. If we need to throw away a
8720 key that has expanded into more than one element of keybuf
8721 (say, a mouse click on the mode line which is being treated
8722 as [mode-line (mouse-...)], then we backtrack to this point
8724 volatile int last_real_key_start
;
8726 /* These variables are analogous to echo_start and keys_start;
8727 while those allow us to restart the entire key sequence,
8728 echo_local_start and keys_local_start allow us to throw away
8730 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8732 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8733 eassert (fkey
.start
<= fkey
.end
);
8734 eassert (keytran
.start
<= keytran
.end
);
8735 /* key-translation-map is applied *after* function-key-map. */
8736 eassert (keytran
.end
<= fkey
.start
);
8738 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8739 { /* The prefix upto first_unbound has no binding and has
8740 no translation left to do either, so we know it's unbound.
8741 If we don't stop now, we risk staying here indefinitely
8742 (if the user keeps entering fkey or keytran prefixes
8743 like C-c ESC ESC ESC ESC ...) */
8745 for (i
= first_unbound
+ 1; i
< t
; i
++)
8746 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8747 mock_input
= t
- first_unbound
- 1;
8748 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8749 fkey
.map
= fkey
.parent
;
8750 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8751 keytran
.map
= keytran
.parent
;
8752 goto replay_sequence
;
8756 error ("Key sequence too long");
8759 echo_local_start
= echo_length ();
8760 keys_local_start
= this_command_key_count
;
8761 local_first_binding
= first_binding
;
8764 /* These are no-ops, unless we throw away a keystroke below and
8765 jumped back up to replay_key; in that case, these restore the
8766 variables to their original state, allowing us to replay the
8768 if (INTERACTIVE
&& t
< mock_input
)
8769 echo_truncate (echo_local_start
);
8770 this_command_key_count
= keys_local_start
;
8771 first_binding
= local_first_binding
;
8773 /* By default, assume each event is "real". */
8774 last_real_key_start
= t
;
8776 /* Does mock_input indicate that we are re-reading a key sequence? */
8780 add_command_key (key
);
8781 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8782 && NILP (Fzerop (Vecho_keystrokes
)))
8786 /* If not, we should actually read a character. */
8791 KBOARD
*interrupted_kboard
= current_kboard
;
8792 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8793 if (setjmp (wrong_kboard_jmpbuf
))
8795 if (!NILP (delayed_switch_frame
))
8797 interrupted_kboard
->kbd_queue
8798 = Fcons (delayed_switch_frame
,
8799 interrupted_kboard
->kbd_queue
);
8800 delayed_switch_frame
= Qnil
;
8803 interrupted_kboard
->kbd_queue
8804 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8806 /* If the side queue is non-empty, ensure it begins with a
8807 switch-frame, so we'll replay it in the right context. */
8808 if (CONSP (interrupted_kboard
->kbd_queue
)
8809 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8810 !(EVENT_HAS_PARAMETERS (key
)
8811 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8815 XSETFRAME (frame
, interrupted_frame
);
8816 interrupted_kboard
->kbd_queue
8817 = Fcons (make_lispy_switch_frame (frame
),
8818 interrupted_kboard
->kbd_queue
);
8821 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8822 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8823 goto replay_sequence
;
8826 key
= read_char (NILP (prompt
), nmaps
,
8827 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8831 /* read_char returns t when it shows a menu and the user rejects it.
8835 unbind_to (count
, Qnil
);
8840 /* read_char returns -1 at the end of a macro.
8841 Emacs 18 handles this by returning immediately with a
8842 zero, so that's what we'll do. */
8843 if (INTEGERP (key
) && XINT (key
) == -1)
8846 /* The Microsoft C compiler can't handle the goto that
8852 /* If the current buffer has been changed from under us, the
8853 keymap may have changed, so replay the sequence. */
8856 EMACS_TIME initial_idleness_start_time
;
8857 EMACS_SET_SECS_USECS (initial_idleness_start_time
,
8858 EMACS_SECS (timer_last_idleness_start_time
),
8859 EMACS_USECS (timer_last_idleness_start_time
));
8861 /* Resume idle state, using the same start-time as before. */
8862 timer_start_idle ();
8863 timer_idleness_start_time
= initial_idleness_start_time
;
8866 /* Reset the current buffer from the selected window
8867 in case something changed the former and not the latter.
8868 This is to be more consistent with the behavior
8869 of the command_loop_1. */
8870 if (fix_current_buffer
)
8872 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8874 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8875 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8878 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8879 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8880 goto replay_sequence
;
8883 /* If we have a quit that was typed in another frame, and
8884 quit_throw_to_read_char switched buffers,
8885 replay to get the right keymap. */
8887 && XINT (key
) == quit_char
8888 && current_buffer
!= starting_buffer
)
8891 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8895 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8896 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8897 goto replay_sequence
;
8902 if (EVENT_HAS_PARAMETERS (key
)
8903 /* Either a `switch-frame' or a `select-window' event. */
8904 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8906 /* If we're at the beginning of a key sequence, and the caller
8907 says it's okay, go ahead and return this event. If we're
8908 in the midst of a key sequence, delay it until the end. */
8909 if (t
> 0 || !can_return_switch_frame
)
8911 delayed_switch_frame
= key
;
8917 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8920 /* Clicks in non-text areas get prefixed by the symbol
8921 in their CHAR-ADDRESS field. For example, a click on
8922 the mode line is prefixed by the symbol `mode-line'.
8924 Furthermore, key sequences beginning with mouse clicks
8925 are read using the keymaps of the buffer clicked on, not
8926 the current buffer. So we may have to switch the buffer
8929 When we turn one event into two events, we must make sure
8930 that neither of the two looks like the original--so that,
8931 if we replay the events, they won't be expanded again.
8932 If not for this, such reexpansion could happen either here
8933 or when user programs play with this-command-keys. */
8934 if (EVENT_HAS_PARAMETERS (key
))
8938 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8939 if (EQ (kind
, Qmouse_click
))
8941 Lisp_Object window
, posn
;
8943 window
= POSN_WINDOW (EVENT_START (key
));
8944 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8947 || (!NILP (fake_prefixed_keys
)
8948 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8950 /* We're looking a second time at an event for which
8951 we generated a fake prefix key. Set
8952 last_real_key_start appropriately. */
8954 last_real_key_start
= t
- 1;
8957 /* Key sequences beginning with mouse clicks are
8958 read using the keymaps in the buffer clicked on,
8959 not the current buffer. If we're at the
8960 beginning of a key sequence, switch buffers. */
8961 if (last_real_key_start
== 0
8963 && BUFFERP (XWINDOW (window
)->buffer
)
8964 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8966 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8970 /* Arrange to go back to the original buffer once we're
8971 done reading the key sequence. Note that we can't
8972 use save_excursion_{save,restore} here, because they
8973 save point as well as the current buffer; we don't
8974 want to save point, because redisplay may change it,
8975 to accommodate a Fset_window_start or something. We
8976 don't want to do this at the top of the function,
8977 because we may get input from a subprocess which
8978 wants to change the selected window and stuff (say,
8980 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8982 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8984 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8985 orig_local_map
= get_local_map (PT
, current_buffer
,
8987 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8988 goto replay_sequence
;
8991 /* For a mouse click, get the local text-property keymap
8992 of the place clicked on, rather than point. */
8993 if (last_real_key_start
== 0
8994 && CONSP (XCDR (key
))
8995 && ! localized_local_map
)
8997 Lisp_Object map_here
, start
, pos
;
8999 localized_local_map
= 1;
9000 start
= EVENT_START (key
);
9002 if (CONSP (start
) && CONSP (XCDR (start
)))
9004 pos
= POSN_BUFFER_POSN (start
);
9006 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9008 map_here
= get_local_map (XINT (pos
),
9009 current_buffer
, Qlocal_map
);
9010 if (!EQ (map_here
, orig_local_map
))
9012 orig_local_map
= map_here
;
9016 goto replay_sequence
;
9018 map_here
= get_local_map (XINT (pos
),
9019 current_buffer
, Qkeymap
);
9020 if (!EQ (map_here
, orig_keymap
))
9022 orig_keymap
= map_here
;
9026 goto replay_sequence
;
9032 /* Expand mode-line and scroll-bar events into two events:
9033 use posn as a fake prefix key. */
9035 && (NILP (fake_prefixed_keys
)
9036 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9038 if (t
+ 1 >= bufsize
)
9039 error ("Key sequence too long");
9042 keybuf
[t
+ 1] = key
;
9045 /* Record that a fake prefix key has been generated
9046 for KEY. Don't modify the event; this would
9047 prevent proper action when the event is pushed
9048 back into unread-command-events. */
9049 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9051 /* If on a mode line string with a local keymap,
9052 reconsider the key sequence with that keymap. */
9053 if (CONSP (POSN_STRING (EVENT_START (key
))))
9055 Lisp_Object string
, pos
, map
, map2
;
9057 string
= POSN_STRING (EVENT_START (key
));
9058 pos
= XCDR (string
);
9059 string
= XCAR (string
);
9061 && XINT (pos
) < SCHARS (string
))
9063 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9065 orig_local_map
= map
;
9066 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9069 if (!NILP (map
) || !NILP (map2
))
9070 goto replay_sequence
;
9076 else if (CONSP (POSN_STRING (EVENT_START (key
)))
9077 && NILP (from_string
))
9079 /* For a click on a string, i.e. overlay string or a
9080 string displayed via the `display' property,
9081 consider `local-map' and `keymap' properties of
9083 Lisp_Object string
, pos
, map
, map2
;
9085 string
= POSN_STRING (EVENT_START (key
));
9086 pos
= XCDR (string
);
9087 string
= XCAR (string
);
9089 && XINT (pos
) < SCHARS (string
))
9091 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9093 orig_local_map
= map
;
9094 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9098 if (!NILP (map
) || !NILP (map2
))
9100 from_string
= string
;
9101 goto replay_sequence
;
9106 else if (CONSP (XCDR (key
))
9107 && CONSP (EVENT_START (key
))
9108 && CONSP (XCDR (EVENT_START (key
))))
9112 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
9113 /* Handle menu-bar events:
9114 insert the dummy prefix event `menu-bar'. */
9115 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9117 if (t
+ 1 >= bufsize
)
9118 error ("Key sequence too long");
9122 /* Zap the position in key, so we know that we've
9123 expanded it, and don't try to do so again. */
9124 POSN_BUFFER_SET_POSN (EVENT_START (key
),
9125 Fcons (posn
, Qnil
));
9128 goto replay_sequence
;
9130 else if (CONSP (posn
))
9132 /* We're looking at the second event of a
9133 sequence which we expanded before. Set
9134 last_real_key_start appropriately. */
9135 if (last_real_key_start
== t
&& t
> 0)
9136 last_real_key_start
= t
- 1;
9141 /* We have finally decided that KEY is something we might want
9143 first_binding
= (follow_key (key
,
9144 nmaps
- first_binding
,
9145 submaps
+ first_binding
,
9146 defs
+ first_binding
,
9147 submaps
+ first_binding
)
9150 /* If KEY wasn't bound, we'll try some fallbacks. */
9151 if (first_binding
< nmaps
)
9152 /* This is needed for the following scenario:
9153 event 0: a down-event that gets dropped by calling replay_key.
9154 event 1: some normal prefix like C-h.
9155 After event 0, first_unbound is 0, after event 1 fkey.start
9156 and keytran.start are both 1, so when we see that C-h is bound,
9157 we need to update first_unbound. */
9158 first_unbound
= max (t
+ 1, first_unbound
);
9163 /* Remember the position to put an upper bound on fkey.start. */
9164 first_unbound
= min (t
, first_unbound
);
9166 head
= EVENT_HEAD (key
);
9167 if (help_char_p (head
) && t
> 0)
9169 read_key_sequence_cmd
= Vprefix_help_command
;
9171 last_nonmenu_event
= key
;
9172 /* The Microsoft C compiler can't handle the goto that
9180 Lisp_Object breakdown
;
9183 breakdown
= parse_modifiers (head
);
9184 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9185 /* Attempt to reduce an unbound mouse event to a simpler
9186 event that is bound:
9187 Drags reduce to clicks.
9188 Double-clicks reduce to clicks.
9189 Triple-clicks reduce to double-clicks, then to clicks.
9190 Down-clicks are eliminated.
9191 Double-downs reduce to downs, then are eliminated.
9192 Triple-downs reduce to double-downs, then to downs,
9193 then are eliminated. */
9194 if (modifiers
& (down_modifier
| drag_modifier
9195 | double_modifier
| triple_modifier
))
9197 while (modifiers
& (down_modifier
| drag_modifier
9198 | double_modifier
| triple_modifier
))
9200 Lisp_Object new_head
, new_click
;
9201 if (modifiers
& triple_modifier
)
9202 modifiers
^= (double_modifier
| triple_modifier
);
9203 else if (modifiers
& double_modifier
)
9204 modifiers
&= ~double_modifier
;
9205 else if (modifiers
& drag_modifier
)
9206 modifiers
&= ~drag_modifier
;
9209 /* Dispose of this `down' event by simply jumping
9210 back to replay_key, to get another event.
9212 Note that if this event came from mock input,
9213 then just jumping back to replay_key will just
9214 hand it to us again. So we have to wipe out any
9217 We could delete keybuf[t] and shift everything
9218 after that to the left by one spot, but we'd also
9219 have to fix up any variable that points into
9220 keybuf, and shifting isn't really necessary
9223 Adding prefixes for non-textual mouse clicks
9224 creates two characters of mock input, and both
9225 must be thrown away. If we're only looking at
9226 the prefix now, we can just jump back to
9227 replay_key. On the other hand, if we've already
9228 processed the prefix, and now the actual click
9229 itself is giving us trouble, then we've lost the
9230 state of the keymaps we want to backtrack to, and
9231 we need to replay the whole sequence to rebuild
9234 Beyond that, only function key expansion could
9235 create more than two keys, but that should never
9236 generate mouse events, so it's okay to zero
9237 mock_input in that case too.
9239 FIXME: The above paragraph seems just plain
9240 wrong, if you consider things like
9241 xterm-mouse-mode. -stef
9243 Isn't this just the most wonderful code ever? */
9245 /* If mock_input > t + 1, the above simplification
9246 will actually end up dropping keys on the floor.
9247 This is probably OK for now, but even
9248 if mock_input <= t + 1, we need to adjust fkey
9250 Typical case [header-line down-mouse-N]:
9251 mock_input = 2, t = 1, fkey.end = 1,
9252 last_real_key_start = 0. */
9253 if (fkey
.end
> last_real_key_start
)
9255 fkey
.end
= fkey
.start
9256 = min (last_real_key_start
, fkey
.start
);
9257 fkey
.map
= fkey
.parent
;
9258 if (keytran
.end
> last_real_key_start
)
9260 keytran
.end
= keytran
.start
9261 = min (last_real_key_start
, keytran
.start
);
9262 keytran
.map
= keytran
.parent
;
9265 if (t
== last_real_key_start
)
9272 mock_input
= last_real_key_start
;
9273 goto replay_sequence
;
9278 = apply_modifiers (modifiers
, XCAR (breakdown
));
9280 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9282 /* Look for a binding for this new key. follow_key
9283 promises that it didn't munge submaps the
9284 last time we called it, since key was unbound. */
9286 = (follow_key (new_click
,
9287 nmaps
- local_first_binding
,
9288 submaps
+ local_first_binding
,
9289 defs
+ local_first_binding
,
9290 submaps
+ local_first_binding
)
9291 + local_first_binding
);
9293 /* If that click is bound, go for it. */
9294 if (first_binding
< nmaps
)
9299 /* Otherwise, we'll leave key set to the drag event. */
9306 /* Normally, last_nonmenu_event gets the previous key we read.
9307 But when a mouse popup menu is being used,
9308 we don't update last_nonmenu_event; it continues to hold the mouse
9309 event that preceded the first level of menu. */
9310 if (!used_mouse_menu
)
9311 last_nonmenu_event
= key
;
9313 /* Record what part of this_command_keys is the current key sequence. */
9314 this_single_command_key_start
= this_command_key_count
- t
;
9316 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9317 /* There is a binding and it's not a prefix.
9318 There is thus no function-key in this sequence.
9319 Moving fkey.start is important in this case to allow keytran.start
9320 to go over the sequence before we return (since we keep the
9321 invariant that keytran.end <= fkey.start). */
9324 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9327 /* If the sequence is unbound, see if we can hang a function key
9328 off the end of it. */
9329 /* Continue scan from fkey.end until we find a bound suffix. */
9330 while (fkey
.end
< t
)
9332 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9335 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9336 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9337 max (t
, mock_input
),
9338 /* If there's a binding (i.e.
9339 first_binding >= nmaps) we don't want
9340 to apply this function-key-mapping. */
9341 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9346 mock_input
= diff
+ max (t
, mock_input
);
9347 goto replay_sequence
;
9351 /* Look for this sequence in key-translation-map.
9352 Scan from keytran.end until we find a bound suffix. */
9353 while (keytran
.end
< fkey
.start
)
9355 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9358 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9359 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9364 mock_input
= diff
+ max (t
, mock_input
);
9365 /* Adjust the function-key-map counters. */
9369 goto replay_sequence
;
9373 /* If KEY is not defined in any of the keymaps,
9374 and cannot be part of a function key or translation,
9375 and is an upper case letter
9376 use the corresponding lower-case letter instead. */
9377 if (first_binding
>= nmaps
9378 && fkey
.start
>= t
&& keytran
.start
>= t
9380 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9381 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9382 || (XINT (key
) & shift_modifier
)))
9384 Lisp_Object new_key
;
9386 original_uppercase
= key
;
9387 original_uppercase_position
= t
- 1;
9389 if (XINT (key
) & shift_modifier
)
9390 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9392 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9393 | (XINT (key
) & ~CHAR_MODIFIER_MASK
)));
9395 /* We have to do this unconditionally, regardless of whether
9396 the lower-case char is defined in the keymaps, because they
9397 might get translated through function-key-map. */
9398 keybuf
[t
- 1] = new_key
;
9399 mock_input
= max (t
, mock_input
);
9401 goto replay_sequence
;
9403 /* If KEY is not defined in any of the keymaps,
9404 and cannot be part of a function key or translation,
9405 and is a shifted function key,
9406 use the corresponding unshifted function key instead. */
9407 if (first_binding
>= nmaps
9408 && fkey
.start
>= t
&& keytran
.start
>= t
9411 Lisp_Object breakdown
;
9414 breakdown
= parse_modifiers (key
);
9415 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9416 if (modifiers
& shift_modifier
)
9418 Lisp_Object new_key
;
9420 original_uppercase
= key
;
9421 original_uppercase_position
= t
- 1;
9423 modifiers
&= ~shift_modifier
;
9424 new_key
= apply_modifiers (modifiers
,
9427 keybuf
[t
- 1] = new_key
;
9428 mock_input
= max (t
, mock_input
);
9429 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9430 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9432 goto replay_sequence
;
9438 read_key_sequence_cmd
= (first_binding
< nmaps
9439 ? defs
[first_binding
]
9442 unread_switch_frame
= delayed_switch_frame
;
9443 unbind_to (count
, Qnil
);
9445 /* Don't downcase the last character if the caller says don't.
9446 Don't downcase it if the result is undefined, either. */
9447 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9448 && t
- 1 == original_uppercase_position
)
9449 keybuf
[t
- 1] = original_uppercase
;
9451 /* Occasionally we fabricate events, perhaps by expanding something
9452 according to function-key-map, or by adding a prefix symbol to a
9453 mouse click in the scroll bar or modeline. In this cases, return
9454 the entire generated key sequence, even if we hit an unbound
9455 prefix or a definition before the end. This means that you will
9456 be able to push back the event properly, and also means that
9457 read-key-sequence will always return a logical unit.
9460 for (; t
< mock_input
; t
++)
9462 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9463 && NILP (Fzerop (Vecho_keystrokes
)))
9464 echo_char (keybuf
[t
]);
9465 add_command_key (keybuf
[t
]);
9474 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9475 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9476 The sequence is sufficient to specify a non-prefix command in the
9477 current local and global maps.
9479 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9480 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9481 as a continuation of the previous key.
9483 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9484 convert the last event to lower case. (Normally any upper case event
9485 is converted to lower case if the original event is undefined and the lower
9486 case equivalent is defined.) A non-nil value is appropriate for reading
9487 a key sequence to be defined.
9489 A C-g typed while in this function is treated like any other character,
9490 and `quit-flag' is not set.
9492 If the key sequence starts with a mouse click, then the sequence is read
9493 using the keymaps of the buffer of the window clicked in, not the buffer
9494 of the selected window as normal.
9496 `read-key-sequence' drops unbound button-down events, since you normally
9497 only care about the click or drag events which follow them. If a drag
9498 or multi-click event is unbound, but the corresponding click event would
9499 be bound, `read-key-sequence' turns the event into a click event at the
9500 drag's starting position. This means that you don't have to distinguish
9501 between click and drag, double, or triple events unless you want to.
9503 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9504 lines separating windows, and scroll bars with imaginary keys
9505 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9507 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9508 function will process a switch-frame event if the user switches frames
9509 before typing anything. If the user switches frames in the middle of a
9510 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9511 is nil, then the event will be put off until after the current key sequence.
9513 `read-key-sequence' checks `function-key-map' for function key
9514 sequences, where they wouldn't conflict with ordinary bindings. See
9515 `function-key-map' for more details.
9517 The optional fifth argument COMMAND-LOOP, if non-nil, means
9518 that this key sequence is being read by something that will
9519 read commands one after another. It should be nil if the caller
9520 will read just one key sequence. */)
9521 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9523 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9524 Lisp_Object can_return_switch_frame
, command_loop
;
9526 Lisp_Object keybuf
[30];
9528 struct gcpro gcpro1
;
9529 int count
= SPECPDL_INDEX ();
9532 CHECK_STRING (prompt
);
9535 specbind (Qinput_method_exit_on_first_char
,
9536 (NILP (command_loop
) ? Qt
: Qnil
));
9537 specbind (Qinput_method_use_echo_area
,
9538 (NILP (command_loop
) ? Qt
: Qnil
));
9540 bzero (keybuf
, sizeof keybuf
);
9542 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9544 if (NILP (continue_echo
))
9546 this_command_key_count
= 0;
9547 this_command_key_count_reset
= 0;
9548 this_single_command_key_start
= 0;
9551 #ifdef HAVE_X_WINDOWS
9552 if (display_hourglass_p
)
9553 cancel_hourglass ();
9556 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9557 prompt
, ! NILP (dont_downcase_last
),
9558 ! NILP (can_return_switch_frame
), 0);
9560 #if 0 /* The following is fine for code reading a key sequence and
9561 then proceeding with a lenghty computation, but it's not good
9562 for code reading keys in a loop, like an input method. */
9563 #ifdef HAVE_X_WINDOWS
9564 if (display_hourglass_p
)
9575 return unbind_to (count
, make_event_array (i
, keybuf
));
9578 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9579 Sread_key_sequence_vector
, 1, 5, 0,
9580 doc
: /* Like `read-key-sequence' but always return a vector. */)
9581 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9583 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9584 Lisp_Object can_return_switch_frame
, command_loop
;
9586 Lisp_Object keybuf
[30];
9588 struct gcpro gcpro1
;
9589 int count
= SPECPDL_INDEX ();
9592 CHECK_STRING (prompt
);
9595 specbind (Qinput_method_exit_on_first_char
,
9596 (NILP (command_loop
) ? Qt
: Qnil
));
9597 specbind (Qinput_method_use_echo_area
,
9598 (NILP (command_loop
) ? Qt
: Qnil
));
9600 bzero (keybuf
, sizeof keybuf
);
9602 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9604 if (NILP (continue_echo
))
9606 this_command_key_count
= 0;
9607 this_command_key_count_reset
= 0;
9608 this_single_command_key_start
= 0;
9611 #ifdef HAVE_X_WINDOWS
9612 if (display_hourglass_p
)
9613 cancel_hourglass ();
9616 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9617 prompt
, ! NILP (dont_downcase_last
),
9618 ! NILP (can_return_switch_frame
), 0);
9620 #ifdef HAVE_X_WINDOWS
9621 if (display_hourglass_p
)
9631 return unbind_to (count
, Fvector (i
, keybuf
));
9634 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9635 doc
: /* Execute CMD as an editor command.
9636 CMD must be a symbol that satisfies the `commandp' predicate.
9637 Optional second arg RECORD-FLAG non-nil
9638 means unconditionally put this command in `command-history'.
9639 Otherwise, that is done only if an arg is read using the minibuffer.
9640 The argument KEYS specifies the value to use instead of (this-command-keys)
9641 when reading the arguments; if it is nil, (this-command-keys) is used.
9642 The argument SPECIAL, if non-nil, means that this command is executing
9643 a special event, so ignore the prefix argument and don't clear it. */)
9644 (cmd
, record_flag
, keys
, special
)
9645 Lisp_Object cmd
, record_flag
, keys
, special
;
9647 register Lisp_Object final
;
9648 register Lisp_Object tem
;
9649 Lisp_Object prefixarg
;
9650 struct backtrace backtrace
;
9651 extern int debug_on_next_call
;
9653 debug_on_next_call
= 0;
9657 prefixarg
= current_kboard
->Vprefix_arg
;
9658 Vcurrent_prefix_arg
= prefixarg
;
9659 current_kboard
->Vprefix_arg
= Qnil
;
9666 tem
= Fget (cmd
, Qdisabled
);
9667 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9669 tem
= Fsymbol_value (Qdisabled_command_hook
);
9671 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9677 final
= Findirect_function (cmd
);
9679 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9681 struct gcpro gcpro1
, gcpro2
;
9683 GCPRO2 (cmd
, prefixarg
);
9684 do_autoload (final
, cmd
);
9691 if (STRINGP (final
) || VECTORP (final
))
9693 /* If requested, place the macro in the command history. For
9694 other sorts of commands, call-interactively takes care of
9696 if (!NILP (record_flag
))
9699 = Fcons (Fcons (Qexecute_kbd_macro
,
9700 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9703 /* Don't keep command history around forever. */
9704 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9706 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9708 XSETCDR (tem
, Qnil
);
9712 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9715 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9717 backtrace
.next
= backtrace_list
;
9718 backtrace_list
= &backtrace
;
9719 backtrace
.function
= &Qcall_interactively
;
9720 backtrace
.args
= &cmd
;
9721 backtrace
.nargs
= 1;
9722 backtrace
.evalargs
= 0;
9724 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9726 backtrace_list
= backtrace
.next
;
9734 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9736 doc
: /* Read function name, then read its arguments and call it. */)
9738 Lisp_Object prefixarg
;
9740 Lisp_Object function
;
9742 int saved_last_point_position
;
9743 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9744 Lisp_Object bindings
, value
;
9745 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9747 saved_keys
= Fvector (this_command_key_count
,
9748 XVECTOR (this_command_keys
)->contents
);
9749 saved_last_point_position_buffer
= last_point_position_buffer
;
9750 saved_last_point_position
= last_point_position
;
9752 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9754 if (EQ (prefixarg
, Qminus
))
9756 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9757 strcpy (buf
, "C-u ");
9758 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9760 if (sizeof (int) == sizeof (EMACS_INT
))
9761 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9762 else if (sizeof (long) == sizeof (EMACS_INT
))
9763 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9767 else if (INTEGERP (prefixarg
))
9769 if (sizeof (int) == sizeof (EMACS_INT
))
9770 sprintf (buf
, "%d ", XINT (prefixarg
));
9771 else if (sizeof (long) == sizeof (EMACS_INT
))
9772 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9777 /* This isn't strictly correct if execute-extended-command
9778 is bound to anything else. Perhaps it should use
9779 this_command_keys? */
9780 strcat (buf
, "M-x ");
9782 /* Prompt with buf, and then read a string, completing from and
9783 restricting to the set of all defined commands. Don't provide
9784 any initial input. Save the command read on the extended-command
9786 function
= Fcompleting_read (build_string (buf
),
9787 Vobarray
, Qcommandp
,
9788 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9791 if (STRINGP (function
) && SCHARS (function
) == 0)
9792 error ("No command name given");
9794 /* Set this_command_keys to the concatenation of saved_keys and
9795 function, followed by a RET. */
9800 this_command_key_count
= 0;
9801 this_command_key_count_reset
= 0;
9802 this_single_command_key_start
= 0;
9804 keys
= XVECTOR (saved_keys
)->contents
;
9805 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9806 add_command_key (keys
[i
]);
9808 for (i
= 0; i
< SCHARS (function
); i
++)
9809 add_command_key (Faref (function
, make_number (i
)));
9811 add_command_key (make_number ('\015'));
9814 last_point_position
= saved_last_point_position
;
9815 last_point_position_buffer
= saved_last_point_position_buffer
;
9819 function
= Fintern (function
, Qnil
);
9820 current_kboard
->Vprefix_arg
= prefixarg
;
9821 Vthis_command
= function
;
9822 real_this_command
= function
;
9824 /* If enabled, show which key runs this command. */
9825 if (!NILP (Vsuggest_key_bindings
)
9826 && NILP (Vexecuting_macro
)
9827 && SYMBOLP (function
))
9828 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9834 GCPRO2 (bindings
, value
);
9835 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9837 /* If the command has a key binding, print it now. */
9838 if (!NILP (bindings
)
9839 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9842 /* But first wait, and skip the message if there is input. */
9844 if (!NILP (echo_area_buffer
[0]))
9845 /* This command displayed something in the echo area;
9846 so wait a few seconds, then display our suggestion message. */
9847 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9848 ? XINT (Vsuggest_key_bindings
) : 2);
9850 /* This command left the echo area empty,
9851 so display our message immediately. */
9854 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9855 && ! CONSP (Vunread_command_events
))
9857 Lisp_Object binding
;
9859 int message_p
= push_message ();
9860 int count
= SPECPDL_INDEX ();
9862 record_unwind_protect (pop_message_unwind
, Qnil
);
9863 binding
= Fkey_description (bindings
);
9866 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9869 sprintf (newmessage
, "You can run the command `%s' with %s",
9870 SDATA (SYMBOL_NAME (function
)),
9872 message2_nolog (newmessage
,
9873 strlen (newmessage
),
9874 STRING_MULTIBYTE (binding
));
9875 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9876 ? Vsuggest_key_bindings
: make_number (2)),
9881 unbind_to (count
, Qnil
);
9885 RETURN_UNGCPRO (value
);
9889 /* Return nonzero if input events are pending. */
9892 detect_input_pending ()
9895 get_input_pending (&input_pending
, 0);
9897 return input_pending
;
9900 /* Return nonzero if input events are pending, and run any pending timers. */
9903 detect_input_pending_run_timers (do_display
)
9906 int old_timers_run
= timers_run
;
9909 get_input_pending (&input_pending
, 1);
9911 if (old_timers_run
!= timers_run
&& do_display
)
9913 redisplay_preserve_echo_area (8);
9914 /* The following fixes a bug when using lazy-lock with
9915 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9916 from an idle timer function. The symptom of the bug is that
9917 the cursor sometimes doesn't become visible until the next X
9918 event is processed. --gerd. */
9920 rif
->flush_display (NULL
);
9923 return input_pending
;
9926 /* This is called in some cases before a possible quit.
9927 It cases the next call to detect_input_pending to recompute input_pending.
9928 So calling this function unnecessarily can't do any harm. */
9931 clear_input_pending ()
9936 /* Return nonzero if there are pending requeued events.
9937 This isn't used yet. The hope is to make wait_reading_process_input
9938 call it, and return if it runs Lisp code that unreads something.
9939 The problem is, kbd_buffer_get_event needs to be fixed to know what
9940 to do in that case. It isn't trivial. */
9943 requeued_events_pending_p ()
9945 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9949 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9950 doc
: /* Return t if command input is currently available with no wait.
9951 Actually, the value is nil only if we can be sure that no input is available;
9952 if there is a doubt, the value is t. */)
9955 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9958 get_filtered_input_pending (&input_pending
, 1, 1);
9959 return input_pending
> 0 ? Qt
: Qnil
;
9962 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9963 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9966 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9969 if (total_keys
< NUM_RECENT_KEYS
)
9970 return Fvector (total_keys
, keys
);
9973 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9974 bcopy (keys
+ recent_keys_index
,
9975 XVECTOR (val
)->contents
,
9976 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9978 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9979 recent_keys_index
* sizeof (Lisp_Object
));
9984 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9985 doc
: /* Return the key sequence that invoked this command.
9986 However, if the command has called `read-key-sequence', it returns
9987 the last key sequence that has been read.
9988 The value is a string or a vector. */)
9991 return make_event_array (this_command_key_count
,
9992 XVECTOR (this_command_keys
)->contents
);
9995 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9996 doc
: /* Return the key sequence that invoked this command, as a vector.
9997 However, if the command has called `read-key-sequence', it returns
9998 the last key sequence that has been read. */)
10001 return Fvector (this_command_key_count
,
10002 XVECTOR (this_command_keys
)->contents
);
10005 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10006 Sthis_single_command_keys
, 0, 0, 0,
10007 doc
: /* Return the key sequence that invoked this command.
10008 More generally, it returns the last key sequence read, either by
10009 the command loop or by `read-key-sequence'.
10010 Unlike `this-command-keys', this function's value
10011 does not include prefix arguments.
10012 The value is always a vector. */)
10015 return Fvector (this_command_key_count
10016 - this_single_command_key_start
,
10017 (XVECTOR (this_command_keys
)->contents
10018 + this_single_command_key_start
));
10021 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10022 Sthis_single_command_raw_keys
, 0, 0, 0,
10023 doc
: /* Return the raw events that were read for this command.
10024 More generally, it returns the last key sequence read, either by
10025 the command loop or by `read-key-sequence'.
10026 Unlike `this-single-command-keys', this function's value
10027 shows the events before all translations (except for input methods).
10028 The value is always a vector. */)
10031 return Fvector (raw_keybuf_count
,
10032 (XVECTOR (raw_keybuf
)->contents
));
10035 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10036 Sreset_this_command_lengths
, 0, 0, 0,
10037 doc
: /* Make the unread events replace the last command and echo.
10038 Used in `universal-argument-other-key'.
10040 `universal-argument-other-key' rereads the event just typed.
10041 It then gets translated through `function-key-map'.
10042 The translated event has to replace the real events,
10043 both in the value of (this-command-keys) and in echoing.
10044 To achieve this, `universal-argument-other-key' calls
10045 `reset-this-command-lengths', which discards the record of reading
10046 these events the first time. */)
10049 this_command_key_count
= before_command_key_count
;
10050 if (this_command_key_count
< this_single_command_key_start
)
10051 this_single_command_key_start
= this_command_key_count
;
10053 echo_truncate (before_command_echo_length
);
10055 /* Cause whatever we put into unread-command-events
10056 to echo as if it were being freshly read from the keyboard. */
10057 this_command_key_count_reset
= 1;
10062 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10063 Sclear_this_command_keys
, 0, 1, 0,
10064 doc
: /* Clear out the vector that `this-command-keys' returns.
10065 Also clear the record of the last 100 events, unless optional arg
10066 KEEP-RECORD is non-nil. */)
10068 Lisp_Object keep_record
;
10072 this_command_key_count
= 0;
10073 this_command_key_count_reset
= 0;
10075 if (NILP (keep_record
))
10077 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10078 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10080 recent_keys_index
= 0;
10085 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10086 doc
: /* Return the current depth in recursive edits. */)
10090 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10094 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10095 "FOpen dribble file: ",
10096 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10097 If FILE is nil, close any open dribble file. */)
10108 file
= Fexpand_file_name (file
, Qnil
);
10109 dribble
= fopen (SDATA (file
), "w");
10111 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10116 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10117 doc
: /* Discard the contents of the terminal input buffer.
10118 Also end any kbd macro being defined. */)
10121 if (!NILP (current_kboard
->defining_kbd_macro
))
10123 /* Discard the last command from the macro. */
10124 Fcancel_kbd_macro_events ();
10128 update_mode_lines
++;
10130 Vunread_command_events
= Qnil
;
10131 unread_command_char
= -1;
10133 discard_tty_input ();
10135 kbd_fetch_ptr
= kbd_store_ptr
;
10136 Ffillarray (kbd_buffer_gcpro
, Qnil
);
10142 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10143 doc
: /* Stop Emacs and return to superior process. You can resume later.
10144 If `cannot-suspend' is non-nil, or if the system doesn't support job
10145 control, run a subshell instead.
10147 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10148 to be read as terminal input by Emacs's parent, after suspension.
10150 Before suspending, run the normal hook `suspend-hook'.
10151 After resumption run the normal hook `suspend-resume-hook'.
10153 Some operating systems cannot stop the Emacs process and resume it later.
10154 On such systems, Emacs starts a subshell instead of suspending. */)
10156 Lisp_Object stuffstring
;
10158 int count
= SPECPDL_INDEX ();
10159 int old_height
, old_width
;
10161 struct gcpro gcpro1
;
10163 if (!NILP (stuffstring
))
10164 CHECK_STRING (stuffstring
);
10166 /* Run the functions in suspend-hook. */
10167 if (!NILP (Vrun_hooks
))
10168 call1 (Vrun_hooks
, intern ("suspend-hook"));
10170 GCPRO1 (stuffstring
);
10171 get_frame_size (&old_width
, &old_height
);
10172 reset_sys_modes ();
10173 /* sys_suspend can get an error if it tries to fork a subshell
10174 and the system resources aren't available for that. */
10175 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10177 stuff_buffered_input (stuffstring
);
10178 if (cannot_suspend
)
10182 unbind_to (count
, Qnil
);
10184 /* Check if terminal/window size has changed.
10185 Note that this is not useful when we are running directly
10186 with a window system; but suspend should be disabled in that case. */
10187 get_frame_size (&width
, &height
);
10188 if (width
!= old_width
|| height
!= old_height
)
10189 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10191 /* Run suspend-resume-hook. */
10192 if (!NILP (Vrun_hooks
))
10193 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10199 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10200 Then in any case stuff anything Emacs has read ahead and not used. */
10203 stuff_buffered_input (stuffstring
)
10204 Lisp_Object stuffstring
;
10206 /* stuff_char works only in BSD, versions 4.2 and up. */
10209 register unsigned char *p
;
10211 if (STRINGP (stuffstring
))
10213 register int count
;
10215 p
= SDATA (stuffstring
);
10216 count
= SBYTES (stuffstring
);
10217 while (count
-- > 0)
10222 /* Anything we have read ahead, put back for the shell to read. */
10223 /* ?? What should this do when we have multiple keyboards??
10224 Should we ignore anything that was typed in at the "wrong" kboard? */
10225 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10229 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10230 kbd_fetch_ptr
= kbd_buffer
;
10231 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10232 stuff_char (kbd_fetch_ptr
->code
);
10234 kbd_fetch_ptr
->kind
= NO_EVENT
;
10235 idx
= 2 * (kbd_fetch_ptr
- kbd_buffer
);
10236 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
10237 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
10242 #endif /* BSD_SYSTEM and not BSD4_1 */
10246 set_waiting_for_input (time_to_clear
)
10247 EMACS_TIME
*time_to_clear
;
10249 input_available_clear_time
= time_to_clear
;
10251 /* Tell interrupt_signal to throw back to read_char, */
10252 waiting_for_input
= 1;
10254 /* If interrupt_signal was called before and buffered a C-g,
10255 make it run again now, to avoid timing error. */
10256 if (!NILP (Vquit_flag
))
10257 quit_throw_to_read_char ();
10261 clear_waiting_for_input ()
10263 /* Tell interrupt_signal not to throw back to read_char, */
10264 waiting_for_input
= 0;
10265 input_available_clear_time
= 0;
10268 /* This routine is called at interrupt level in response to C-g.
10270 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10271 is called from kbd_buffer_store_event, in handling SIGIO or
10274 If `waiting_for_input' is non zero, then unless `echoing' is
10275 nonzero, immediately throw back to read_char.
10277 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10278 eval to throw, when it gets a chance. If quit-flag is already
10279 non-nil, it stops the job right away. */
10282 interrupt_signal (signalnum
) /* If we don't have an argument, */
10283 int signalnum
; /* some compilers complain in signal calls. */
10286 /* Must preserve main program's value of errno. */
10287 int old_errno
= errno
;
10288 struct frame
*sf
= SELECTED_FRAME ();
10290 #if defined (USG) && !defined (POSIX_SIGNALS)
10291 if (!read_socket_hook
&& NILP (Vwindow_system
))
10293 /* USG systems forget handlers when they are used;
10294 must reestablish each time */
10295 signal (SIGINT
, interrupt_signal
);
10296 signal (SIGQUIT
, interrupt_signal
);
10302 if (!NILP (Vquit_flag
)
10303 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10305 /* If SIGINT isn't blocked, don't let us be interrupted by
10306 another SIGINT, it might be harmful due to non-reentrancy
10307 in I/O functions. */
10308 sigblock (sigmask (SIGINT
));
10311 reset_sys_modes ();
10313 #ifdef SIGTSTP /* Support possible in later USG versions */
10315 * On systems which can suspend the current process and return to the original
10316 * shell, this command causes the user to end up back at the shell.
10317 * The "Auto-save" and "Abort" questions are not asked until
10318 * the user elects to return to emacs, at which point he can save the current
10319 * job and either dump core or continue.
10324 if (sys_suspend () == -1)
10326 printf ("Not running as a subprocess;\n");
10327 printf ("you can continue or abort.\n");
10329 #else /* not VMS */
10330 /* Perhaps should really fork an inferior shell?
10331 But that would not provide any way to get back
10332 to the original shell, ever. */
10333 printf ("No support for stopping a process on this operating system;\n");
10334 printf ("you can continue or abort.\n");
10335 #endif /* not VMS */
10336 #endif /* not SIGTSTP */
10338 /* We must remain inside the screen area when the internal terminal
10339 is used. Note that [Enter] is not echoed by dos. */
10342 /* It doesn't work to autosave while GC is in progress;
10343 the code used for auto-saving doesn't cope with the mark bit. */
10344 if (!gc_in_progress
)
10346 printf ("Auto-save? (y or n) ");
10348 if (((c
= getchar ()) & ~040) == 'Y')
10350 Fdo_auto_save (Qt
, Qnil
);
10352 printf ("\r\nAuto-save done");
10353 #else /* not MSDOS */
10354 printf ("Auto-save done\n");
10355 #endif /* not MSDOS */
10357 while (c
!= '\n') c
= getchar ();
10361 /* During GC, it must be safe to reenable quitting again. */
10362 Vinhibit_quit
= Qnil
;
10365 #endif /* not MSDOS */
10366 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10367 printf ("but will instead do a real quit after garbage collection ends\r\n");
10372 printf ("\r\nAbort? (y or n) ");
10373 #else /* not MSDOS */
10375 printf ("Abort (and enter debugger)? (y or n) ");
10376 #else /* not VMS */
10377 printf ("Abort (and dump core)? (y or n) ");
10378 #endif /* not VMS */
10379 #endif /* not MSDOS */
10381 if (((c
= getchar ()) & ~040) == 'Y')
10383 while (c
!= '\n') c
= getchar ();
10385 printf ("\r\nContinuing...\r\n");
10386 #else /* not MSDOS */
10387 printf ("Continuing...\n");
10388 #endif /* not MSDOS */
10395 /* If executing a function that wants to be interrupted out of
10396 and the user has not deferred quitting by binding `inhibit-quit'
10397 then quit right away. */
10398 if (immediate_quit
&& NILP (Vinhibit_quit
))
10400 struct gl_state_s saved
;
10401 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10403 immediate_quit
= 0;
10406 GCPRO4 (saved
.object
, saved
.global_code
,
10407 saved
.current_syntax_table
, saved
.old_prop
);
10408 Fsignal (Qquit
, Qnil
);
10413 /* Else request quit when it's safe */
10417 if (waiting_for_input
&& !echoing
)
10418 quit_throw_to_read_char ();
10423 /* Handle a C-g by making read_char return C-g. */
10426 quit_throw_to_read_char ()
10429 /* Prevent another signal from doing this before we finish. */
10430 clear_waiting_for_input ();
10433 Vunread_command_events
= Qnil
;
10434 unread_command_char
= -1;
10436 #if 0 /* Currently, sit_for is called from read_char without turning
10437 off polling. And that can call set_waiting_for_input.
10438 It seems to be harmless. */
10439 #ifdef POLL_FOR_INPUT
10440 /* May be > 1 if in recursive minibuffer. */
10441 if (poll_suppress_count
== 0)
10445 if (FRAMEP (internal_last_event_frame
)
10446 && !EQ (internal_last_event_frame
, selected_frame
))
10447 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10450 _longjmp (getcjmp
, 1);
10453 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10454 doc
: /* Set mode of reading keyboard input.
10455 First arg INTERRUPT non-nil means use input interrupts;
10456 nil means use CBREAK mode.
10457 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10458 (no effect except in CBREAK mode).
10459 Third arg META t means accept 8-bit input (for a Meta key).
10460 META nil means ignore the top bit, on the assumption it is parity.
10461 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10462 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10463 See also `current-input-mode'. */)
10464 (interrupt
, flow
, meta
, quit
)
10465 Lisp_Object interrupt
, flow
, meta
, quit
;
10468 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10469 error ("set-input-mode: QUIT must be an ASCII character");
10471 #ifdef POLL_FOR_INPUT
10476 /* this causes startup screen to be restored and messes with the mouse */
10477 reset_sys_modes ();
10481 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10482 if (read_socket_hook
)
10484 /* When using X, don't give the user a real choice,
10485 because we haven't implemented the mechanisms to support it. */
10486 #ifdef NO_SOCK_SIGIO
10487 interrupt_input
= 0;
10488 #else /* not NO_SOCK_SIGIO */
10489 interrupt_input
= 1;
10490 #endif /* NO_SOCK_SIGIO */
10493 interrupt_input
= !NILP (interrupt
);
10494 #else /* not SIGIO */
10495 interrupt_input
= 0;
10496 #endif /* not SIGIO */
10498 /* Our VMS input only works by interrupts, as of now. */
10500 interrupt_input
= 1;
10503 flow_control
= !NILP (flow
);
10506 else if (EQ (meta
, Qt
))
10511 /* Don't let this value be out of range. */
10512 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10518 #ifdef POLL_FOR_INPUT
10519 poll_suppress_count
= 1;
10525 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10526 doc
: /* Return information about the way Emacs currently reads keyboard input.
10527 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10528 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10529 nil, Emacs is using CBREAK mode.
10530 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10531 terminal; this does not apply if Emacs uses interrupt-driven input.
10532 META is t if accepting 8-bit input with 8th bit as Meta flag.
10533 META nil means ignoring the top bit, on the assumption it is parity.
10534 META is neither t nor nil if accepting 8-bit input and using
10535 all 8 bits as the character code.
10536 QUIT is the character Emacs currently uses to quit.
10537 The elements of this list correspond to the arguments of
10538 `set-input-mode'. */)
10541 Lisp_Object val
[4];
10543 val
[0] = interrupt_input
? Qt
: Qnil
;
10544 val
[1] = flow_control
? Qt
: Qnil
;
10545 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10546 XSETFASTINT (val
[3], quit_char
);
10548 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10553 * Set up a new kboard object with reasonable initial values.
10559 kb
->Voverriding_terminal_local_map
= Qnil
;
10560 kb
->Vlast_command
= Qnil
;
10561 kb
->Vreal_last_command
= Qnil
;
10562 kb
->Vprefix_arg
= Qnil
;
10563 kb
->Vlast_prefix_arg
= Qnil
;
10564 kb
->kbd_queue
= Qnil
;
10565 kb
->kbd_queue_has_data
= 0;
10566 kb
->immediate_echo
= 0;
10567 kb
->echo_string
= Qnil
;
10568 kb
->echo_after_prompt
= -1;
10569 kb
->kbd_macro_buffer
= 0;
10570 kb
->kbd_macro_bufsize
= 0;
10571 kb
->defining_kbd_macro
= Qnil
;
10572 kb
->Vlast_kbd_macro
= Qnil
;
10573 kb
->reference_count
= 0;
10574 kb
->Vsystem_key_alist
= Qnil
;
10575 kb
->system_key_syms
= Qnil
;
10576 kb
->Vdefault_minibuffer_frame
= Qnil
;
10580 * Destroy the contents of a kboard object, but not the object itself.
10581 * We use this just before deleting it, or if we're going to initialize
10582 * it a second time.
10588 if (kb
->kbd_macro_buffer
)
10589 xfree (kb
->kbd_macro_buffer
);
10592 #ifdef MULTI_KBOARD
10594 /* Free KB and memory referenced from it. */
10602 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10605 *kbp
= kb
->next_kboard
;
10607 /* Prevent a dangling reference to KB. */
10608 if (kb
== current_kboard
10609 && FRAMEP (selected_frame
)
10610 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10612 current_kboard
= XFRAME (selected_frame
)->kboard
;
10613 if (current_kboard
== kb
)
10621 #endif /* MULTI_KBOARD */
10626 /* This is correct before outermost invocation of the editor loop */
10627 command_loop_level
= -1;
10628 immediate_quit
= 0;
10629 quit_char
= Ctl ('g');
10630 Vunread_command_events
= Qnil
;
10631 unread_command_char
= -1;
10632 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10634 recent_keys_index
= 0;
10635 kbd_fetch_ptr
= kbd_buffer
;
10636 kbd_store_ptr
= kbd_buffer
;
10637 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10639 do_mouse_tracking
= Qnil
;
10643 /* This means that command_loop_1 won't try to select anything the first
10645 internal_last_event_frame
= Qnil
;
10646 Vlast_event_frame
= internal_last_event_frame
;
10648 #ifdef MULTI_KBOARD
10649 current_kboard
= initial_kboard
;
10651 wipe_kboard (current_kboard
);
10652 init_kboard (current_kboard
);
10654 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10656 signal (SIGINT
, interrupt_signal
);
10657 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10658 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10659 SIGQUIT and we can't tell which one it will give us. */
10660 signal (SIGQUIT
, interrupt_signal
);
10661 #endif /* HAVE_TERMIO */
10663 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10665 if (!noninteractive
)
10666 signal (SIGIO
, input_available_signal
);
10669 /* Use interrupt input by default, if it works and noninterrupt input
10670 has deficiencies. */
10672 #ifdef INTERRUPT_INPUT
10673 interrupt_input
= 1;
10675 interrupt_input
= 0;
10678 /* Our VMS input only works by interrupts, as of now. */
10680 interrupt_input
= 1;
10686 if (keyboard_init_hook
)
10687 (*keyboard_init_hook
) ();
10689 #ifdef POLL_FOR_INPUT
10690 poll_suppress_count
= 1;
10695 /* At least provide an escape route since C-g doesn't work. */
10696 signal (SIGINT
, interrupt_signal
);
10700 /* This type's only use is in syms_of_keyboard, to initialize the
10701 event header symbols and put properties on them. */
10702 struct event_head
{
10708 struct event_head head_table
[] = {
10709 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10710 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10711 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10712 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10713 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10714 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10715 /* `select-window' should be handled just like `switch-frame'
10716 in read_key_sequence. */
10717 {&Qselect_window
, "select-window", &Qswitch_frame
}
10721 syms_of_keyboard ()
10723 Vpre_help_message
= Qnil
;
10724 staticpro (&Vpre_help_message
);
10726 Vlispy_mouse_stem
= build_string ("mouse");
10727 staticpro (&Vlispy_mouse_stem
);
10730 QCimage
= intern (":image");
10731 staticpro (&QCimage
);
10733 staticpro (&Qhelp_echo
);
10734 Qhelp_echo
= intern ("help-echo");
10736 staticpro (&item_properties
);
10737 item_properties
= Qnil
;
10739 staticpro (&tool_bar_item_properties
);
10740 tool_bar_item_properties
= Qnil
;
10741 staticpro (&tool_bar_items_vector
);
10742 tool_bar_items_vector
= Qnil
;
10744 staticpro (&real_this_command
);
10745 real_this_command
= Qnil
;
10747 Qtimer_event_handler
= intern ("timer-event-handler");
10748 staticpro (&Qtimer_event_handler
);
10750 Qdisabled_command_hook
= intern ("disabled-command-hook");
10751 staticpro (&Qdisabled_command_hook
);
10753 Qself_insert_command
= intern ("self-insert-command");
10754 staticpro (&Qself_insert_command
);
10756 Qforward_char
= intern ("forward-char");
10757 staticpro (&Qforward_char
);
10759 Qbackward_char
= intern ("backward-char");
10760 staticpro (&Qbackward_char
);
10762 Qdisabled
= intern ("disabled");
10763 staticpro (&Qdisabled
);
10765 Qundefined
= intern ("undefined");
10766 staticpro (&Qundefined
);
10768 Qpre_command_hook
= intern ("pre-command-hook");
10769 staticpro (&Qpre_command_hook
);
10771 Qpost_command_hook
= intern ("post-command-hook");
10772 staticpro (&Qpost_command_hook
);
10774 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10775 staticpro (&Qpost_command_idle_hook
);
10777 Qdeferred_action_function
= intern ("deferred-action-function");
10778 staticpro (&Qdeferred_action_function
);
10780 Qcommand_hook_internal
= intern ("command-hook-internal");
10781 staticpro (&Qcommand_hook_internal
);
10783 Qfunction_key
= intern ("function-key");
10784 staticpro (&Qfunction_key
);
10785 Qmouse_click
= intern ("mouse-click");
10786 staticpro (&Qmouse_click
);
10788 Qlanguage_change
= intern ("language-change");
10789 staticpro (&Qlanguage_change
);
10791 Qdrag_n_drop
= intern ("drag-n-drop");
10792 staticpro (&Qdrag_n_drop
);
10794 Qsave_session
= intern ("save-session");
10795 staticpro(&Qsave_session
);
10797 Qusr1_signal
= intern ("usr1-signal");
10798 staticpro (&Qusr1_signal
);
10799 Qusr2_signal
= intern ("usr2-signal");
10800 staticpro (&Qusr2_signal
);
10802 Qmenu_enable
= intern ("menu-enable");
10803 staticpro (&Qmenu_enable
);
10804 Qmenu_alias
= intern ("menu-alias");
10805 staticpro (&Qmenu_alias
);
10806 QCenable
= intern (":enable");
10807 staticpro (&QCenable
);
10808 QCvisible
= intern (":visible");
10809 staticpro (&QCvisible
);
10810 QChelp
= intern (":help");
10811 staticpro (&QChelp
);
10812 QCfilter
= intern (":filter");
10813 staticpro (&QCfilter
);
10814 QCbutton
= intern (":button");
10815 staticpro (&QCbutton
);
10816 QCkeys
= intern (":keys");
10817 staticpro (&QCkeys
);
10818 QCkey_sequence
= intern (":key-sequence");
10819 staticpro (&QCkey_sequence
);
10820 QCtoggle
= intern (":toggle");
10821 staticpro (&QCtoggle
);
10822 QCradio
= intern (":radio");
10823 staticpro (&QCradio
);
10825 Qmode_line
= intern ("mode-line");
10826 staticpro (&Qmode_line
);
10827 Qvertical_line
= intern ("vertical-line");
10828 staticpro (&Qvertical_line
);
10829 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10830 staticpro (&Qvertical_scroll_bar
);
10831 Qmenu_bar
= intern ("menu-bar");
10832 staticpro (&Qmenu_bar
);
10834 Qabove_handle
= intern ("above-handle");
10835 staticpro (&Qabove_handle
);
10836 Qhandle
= intern ("handle");
10837 staticpro (&Qhandle
);
10838 Qbelow_handle
= intern ("below-handle");
10839 staticpro (&Qbelow_handle
);
10840 Qup
= intern ("up");
10842 Qdown
= intern ("down");
10843 staticpro (&Qdown
);
10844 Qtop
= intern ("top");
10846 Qbottom
= intern ("bottom");
10847 staticpro (&Qbottom
);
10848 Qend_scroll
= intern ("end-scroll");
10849 staticpro (&Qend_scroll
);
10850 Qratio
= intern ("ratio");
10851 staticpro (&Qratio
);
10853 Qevent_kind
= intern ("event-kind");
10854 staticpro (&Qevent_kind
);
10855 Qevent_symbol_elements
= intern ("event-symbol-elements");
10856 staticpro (&Qevent_symbol_elements
);
10857 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10858 staticpro (&Qevent_symbol_element_mask
);
10859 Qmodifier_cache
= intern ("modifier-cache");
10860 staticpro (&Qmodifier_cache
);
10862 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10863 staticpro (&Qrecompute_lucid_menubar
);
10864 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10865 staticpro (&Qactivate_menubar_hook
);
10867 Qpolling_period
= intern ("polling-period");
10868 staticpro (&Qpolling_period
);
10870 Qinput_method_function
= intern ("input-method-function");
10871 staticpro (&Qinput_method_function
);
10873 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10874 staticpro (&Qinput_method_exit_on_first_char
);
10875 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10876 staticpro (&Qinput_method_use_echo_area
);
10878 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10879 Fset (Qinput_method_use_echo_area
, Qnil
);
10881 last_point_position_buffer
= Qnil
;
10884 struct event_head
*p
;
10886 for (p
= head_table
;
10887 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10890 *p
->var
= intern (p
->name
);
10891 staticpro (p
->var
);
10892 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10893 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10897 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10898 staticpro (&button_down_location
);
10899 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10900 staticpro (&mouse_syms
);
10901 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
10902 staticpro (&wheel_syms
);
10906 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10908 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10909 for (i
= 0; i
< len
; i
++)
10910 if (modifier_names
[i
])
10911 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10912 staticpro (&modifier_symbols
);
10915 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10916 staticpro (&recent_keys
);
10918 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10919 staticpro (&this_command_keys
);
10921 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10922 staticpro (&raw_keybuf
);
10924 Qextended_command_history
= intern ("extended-command-history");
10925 Fset (Qextended_command_history
, Qnil
);
10926 staticpro (&Qextended_command_history
);
10928 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10929 staticpro (&kbd_buffer_gcpro
);
10931 accent_key_syms
= Qnil
;
10932 staticpro (&accent_key_syms
);
10934 func_key_syms
= Qnil
;
10935 staticpro (&func_key_syms
);
10937 drag_n_drop_syms
= Qnil
;
10938 staticpro (&drag_n_drop_syms
);
10940 unread_switch_frame
= Qnil
;
10941 staticpro (&unread_switch_frame
);
10943 internal_last_event_frame
= Qnil
;
10944 staticpro (&internal_last_event_frame
);
10946 read_key_sequence_cmd
= Qnil
;
10947 staticpro (&read_key_sequence_cmd
);
10949 menu_bar_one_keymap_changed_items
= Qnil
;
10950 staticpro (&menu_bar_one_keymap_changed_items
);
10952 defsubr (&Sevent_convert_list
);
10953 defsubr (&Sread_key_sequence
);
10954 defsubr (&Sread_key_sequence_vector
);
10955 defsubr (&Srecursive_edit
);
10957 defsubr (&Strack_mouse
);
10959 defsubr (&Sinput_pending_p
);
10960 defsubr (&Scommand_execute
);
10961 defsubr (&Srecent_keys
);
10962 defsubr (&Sthis_command_keys
);
10963 defsubr (&Sthis_command_keys_vector
);
10964 defsubr (&Sthis_single_command_keys
);
10965 defsubr (&Sthis_single_command_raw_keys
);
10966 defsubr (&Sreset_this_command_lengths
);
10967 defsubr (&Sclear_this_command_keys
);
10968 defsubr (&Ssuspend_emacs
);
10969 defsubr (&Sabort_recursive_edit
);
10970 defsubr (&Sexit_recursive_edit
);
10971 defsubr (&Srecursion_depth
);
10972 defsubr (&Stop_level
);
10973 defsubr (&Sdiscard_input
);
10974 defsubr (&Sopen_dribble_file
);
10975 defsubr (&Sset_input_mode
);
10976 defsubr (&Scurrent_input_mode
);
10977 defsubr (&Sexecute_extended_command
);
10979 DEFVAR_LISP ("last-command-char", &last_command_char
,
10980 doc
: /* Last input event that was part of a command. */);
10982 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10983 doc
: /* Last input event that was part of a command. */);
10985 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10986 doc
: /* Last input event in a command, except for mouse menu events.
10987 Mouse menus give back keys that don't look like mouse events;
10988 this variable holds the actual mouse event that led to the menu,
10989 so that you can determine whether the command was run by mouse or not. */);
10991 DEFVAR_LISP ("last-input-char", &last_input_char
,
10992 doc
: /* Last input event. */);
10994 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10995 doc
: /* Last input event. */);
10997 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10998 doc
: /* List of events to be read as the command input.
10999 These events are processed first, before actual keyboard input. */);
11000 Vunread_command_events
= Qnil
;
11002 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11003 doc
: /* If not -1, an object to be read as next command input event. */);
11005 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11006 doc
: /* List of events to be processed as input by input methods.
11007 These events are processed after `unread-command-events', but
11008 before actual keyboard input. */);
11009 Vunread_post_input_method_events
= Qnil
;
11011 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11012 doc
: /* List of events to be processed as input by input methods.
11013 These events are processed after `unread-command-events', but
11014 before actual keyboard input. */);
11015 Vunread_input_method_events
= Qnil
;
11017 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11018 doc
: /* Meta-prefix character code.
11019 Meta-foo as command input turns into this character followed by foo. */);
11020 XSETINT (meta_prefix_char
, 033);
11022 DEFVAR_KBOARD ("last-command", Vlast_command
,
11023 doc
: /* The last command executed.
11024 Normally a symbol with a function definition, but can be whatever was found
11025 in the keymap, or whatever the variable `this-command' was set to by that
11028 The value `mode-exit' is special; it means that the previous command
11029 read an event that told it to exit, and it did so and unread that event.
11030 In other words, the present command is the event that made the previous
11033 The value `kill-region' is special; it means that the previous command
11034 was a kill command. */);
11036 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11037 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11039 DEFVAR_LISP ("this-command", &Vthis_command
,
11040 doc
: /* The command now being executed.
11041 The command can set this variable; whatever is put here
11042 will be in `last-command' during the following command. */);
11043 Vthis_command
= Qnil
;
11045 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11046 doc
: /* The command bound to the current key sequence before remapping.
11047 It equals `this-command' if the original command was not remapped through
11048 any of the active keymaps. Otherwise, the value of `this-command' is the
11049 result of looking up the original command in the active keymaps. */);
11050 Vthis_original_command
= Qnil
;
11052 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11053 doc
: /* *Number of input events between auto-saves.
11054 Zero means disable autosaving due to number of characters typed. */);
11055 auto_save_interval
= 300;
11057 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11058 doc
: /* *Number of seconds idle time before auto-save.
11059 Zero or nil means disable auto-saving due to idleness.
11060 After auto-saving due to this many seconds of idle time,
11061 Emacs also does a garbage collection if that seems to be warranted. */);
11062 XSETFASTINT (Vauto_save_timeout
, 30);
11064 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11065 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11066 The value may be integer or floating point. */);
11067 Vecho_keystrokes
= make_number (1);
11069 DEFVAR_INT ("polling-period", &polling_period
,
11070 doc
: /* *Interval between polling for input during Lisp execution.
11071 The reason for polling is to make C-g work to stop a running program.
11072 Polling is needed only when using X windows and SIGIO does not work.
11073 Polling is automatically disabled in all other cases. */);
11074 polling_period
= 2;
11076 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11077 doc
: /* *Maximum time between mouse clicks to make a double-click.
11078 Measured in milliseconds. nil means disable double-click recognition;
11079 t means double-clicks have no time limit and are detected
11080 by position only. */);
11081 Vdouble_click_time
= make_number (500);
11083 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11084 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11085 On window-system frames, value is the number of pixels the mouse may have
11086 moved horizontally or vertically between two clicks to make a double-click.
11087 On non window-system frames, value is interpreted in units of 1/8 characters
11090 This variable is also the threshold for motion of the mouse
11091 to count as a drag. */);
11092 double_click_fuzz
= 3;
11094 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11095 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11096 inhibit_local_menu_bar_menus
= 0;
11098 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11099 doc
: /* Number of complete key sequences read as input so far.
11100 This includes key sequences read from keyboard macros.
11101 The number is effectively the number of interactive command invocations. */);
11102 num_input_keys
= 0;
11104 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11105 doc
: /* Number of input events read from the keyboard so far.
11106 This does not include events generated by keyboard macros. */);
11107 num_nonmacro_input_events
= 0;
11109 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11110 doc
: /* The frame in which the most recently read event occurred.
11111 If the last event came from a keyboard macro, this is set to `macro'. */);
11112 Vlast_event_frame
= Qnil
;
11114 /* This variable is set up in sysdep.c. */
11115 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11116 doc
: /* The ERASE character as set by the user with stty. */);
11118 DEFVAR_LISP ("help-char", &Vhelp_char
,
11119 doc
: /* Character to recognize as meaning Help.
11120 When it is read, do `(eval help-form)', and display result if it's a string.
11121 If the value of `help-form' is nil, this char can be read normally. */);
11122 XSETINT (Vhelp_char
, Ctl ('H'));
11124 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11125 doc
: /* List of input events to recognize as meaning Help.
11126 These work just like the value of `help-char' (see that). */);
11127 Vhelp_event_list
= Qnil
;
11129 DEFVAR_LISP ("help-form", &Vhelp_form
,
11130 doc
: /* Form to execute when character `help-char' is read.
11131 If the form returns a string, that string is displayed.
11132 If `help-form' is nil, the help char is not recognized. */);
11135 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11136 doc
: /* Command to run when `help-char' character follows a prefix key.
11137 This command is used only when there is no actual binding
11138 for that character after that prefix key. */);
11139 Vprefix_help_command
= Qnil
;
11141 DEFVAR_LISP ("top-level", &Vtop_level
,
11142 doc
: /* Form to evaluate when Emacs starts up.
11143 Useful to set before you dump a modified Emacs. */);
11146 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11147 doc
: /* Translate table for keyboard input, or nil.
11148 Each character is looked up in this string and the contents used instead.
11149 The value may be a string, a vector, or a char-table.
11150 If it is a string or vector of length N,
11151 character codes N and up are untranslated.
11152 In a vector or a char-table, an element which is nil means "no translation".
11154 This is applied to the characters supplied to input methods, not their
11155 output. See also `translation-table-for-input'. */);
11156 Vkeyboard_translate_table
= Qnil
;
11158 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11159 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11160 \(Even if the operating system has support for stopping a process.\) */);
11161 cannot_suspend
= 0;
11163 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11164 doc
: /* Non-nil means prompt with menus when appropriate.
11165 This is done when reading from a keymap that has a prompt string,
11166 for elements that have prompt strings.
11167 The menu is displayed on the screen
11168 if X menus were enabled at configuration
11169 time and the previous event was a mouse click prefix key.
11170 Otherwise, menu prompting uses the echo area. */);
11171 menu_prompting
= 1;
11173 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11174 doc
: /* Character to see next line of menu prompt.
11175 Type this character while in a menu prompt to rotate around the lines of it. */);
11176 XSETINT (menu_prompt_more_char
, ' ');
11178 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11179 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11180 Emacs applies the modifiers of the character stored here to each keyboard
11181 character it reads. For example, after evaluating the expression
11182 (setq extra-keyboard-modifiers ?\\C-x)
11183 all input characters will have the control modifier applied to them.
11185 Note that the character ?\\C-@, equivalent to the integer zero, does
11186 not count as a control character; rather, it counts as a character
11187 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11188 cancels any modification. */);
11189 extra_keyboard_modifiers
= 0;
11191 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11192 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11193 The command loop sets this to nil before each command,
11194 and tests the value when the command returns.
11195 Buffer modification stores t in this variable. */);
11196 Vdeactivate_mark
= Qnil
;
11198 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11199 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11200 Vcommand_hook_internal
= Qnil
;
11202 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11203 doc
: /* Normal hook run before each command is executed.
11204 If an unhandled error happens in running this hook,
11205 the hook value is set to nil, since otherwise the error
11206 might happen repeatedly and make Emacs nonfunctional. */);
11207 Vpre_command_hook
= Qnil
;
11209 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11210 doc
: /* Normal hook run after each command is executed.
11211 If an unhandled error happens in running this hook,
11212 the hook value is set to nil, since otherwise the error
11213 might happen repeatedly and make Emacs nonfunctional. */);
11214 Vpost_command_hook
= Qnil
;
11216 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11217 doc
: /* Normal hook run after each command is executed, if idle.
11218 Errors running the hook are caught and ignored. */);
11219 Vpost_command_idle_hook
= Qnil
;
11221 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11222 doc
: /* Delay time before running `post-command-idle-hook'.
11223 This is measured in microseconds. */);
11224 post_command_idle_delay
= 100000;
11227 DEFVAR_LISP ("echo-area-clear-hook", ...,
11228 doc
: /* Normal hook run when clearing the echo area. */);
11230 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11231 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11233 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11234 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11235 Vlucid_menu_bar_dirty_flag
= Qnil
;
11237 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11238 doc
: /* List of menu bar items to move to the end of the menu bar.
11239 The elements of the list are event types that may have menu bar bindings. */);
11240 Vmenu_bar_final_items
= Qnil
;
11242 DEFVAR_KBOARD ("overriding-terminal-local-map",
11243 Voverriding_terminal_local_map
,
11244 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11245 If this variable is non-nil, it is used as a keymap instead of the
11246 buffer's local map, and the minor mode keymaps and text property keymaps.
11247 This variable is intended to let commands such as `universal-argument'
11248 set up a different keymap for reading the next command. */);
11250 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11251 doc
: /* Keymap that overrides all other local keymaps.
11252 If this variable is non-nil, it is used as a keymap instead of the
11253 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11254 Voverriding_local_map
= Qnil
;
11256 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11257 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11258 Otherwise, the menu bar continues to reflect the buffer's local map
11259 and the minor mode maps regardless of `overriding-local-map'. */);
11260 Voverriding_local_map_menu_flag
= Qnil
;
11262 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11263 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11264 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11266 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11267 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11269 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11270 doc
: /* Alist of system-specific X windows key symbols.
11271 Each element should have the form (N . SYMBOL) where N is the
11272 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11273 and SYMBOL is its name. */);
11275 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11276 doc
: /* List of deferred actions to be performed at a later time.
11277 The precise format isn't relevant here; we just check whether it is nil. */);
11278 Vdeferred_action_list
= Qnil
;
11280 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11281 doc
: /* Function to call to handle deferred actions, after each command.
11282 This function is called with no arguments after each command
11283 whenever `deferred-action-list' is non-nil. */);
11284 Vdeferred_action_function
= Qnil
;
11286 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11287 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11288 The value can be a length of time to show the message for.
11289 If the value is non-nil and not a number, we wait 2 seconds. */);
11290 Vsuggest_key_bindings
= Qt
;
11292 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11293 doc
: /* List of active absolute time timers in order of increasing time. */);
11294 Vtimer_list
= Qnil
;
11296 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11297 doc
: /* List of active idle-time timers in order of increasing time. */);
11298 Vtimer_idle_list
= Qnil
;
11300 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11301 doc
: /* If non-nil, the function that implements the current input method.
11302 It's called with one argument, a printing character that was just read.
11303 \(That means a character with code 040...0176.)
11304 Typically this function uses `read-event' to read additional events.
11305 When it does so, it should first bind `input-method-function' to nil
11306 so it will not be called recursively.
11308 The function should return a list of zero or more events
11309 to be used as input. If it wants to put back some events
11310 to be reconsidered, separately, by the input method,
11311 it can add them to the beginning of `unread-command-events'.
11313 The input method function can find in `input-method-previous-method'
11314 the previous echo area message.
11316 The input method function should refer to the variables
11317 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11318 for guidance on what to do. */);
11319 Vinput_method_function
= Qnil
;
11321 DEFVAR_LISP ("input-method-previous-message",
11322 &Vinput_method_previous_message
,
11323 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11324 This variable exists because `read-event' clears the echo area
11325 before running the input method. It is nil if there was no message. */);
11326 Vinput_method_previous_message
= Qnil
;
11328 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11329 doc
: /* If non-nil, the function that implements the display of help.
11330 It's called with one argument, the help string to display. */);
11331 Vshow_help_function
= Qnil
;
11333 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11334 doc
: /* If non-nil, suppress point adjustment after executing a command.
11336 After a command is executed, if point is moved into a region that has
11337 special properties (e.g. composition, display), we adjust point to
11338 the boundary of the region. But, several special commands sets this
11339 variable to non-nil, then we suppress the point adjustment.
11341 This variable is set to nil before reading a command, and is checked
11342 just after executing the command. */);
11343 Vdisable_point_adjustment
= Qnil
;
11345 DEFVAR_LISP ("global-disable-point-adjustment",
11346 &Vglobal_disable_point_adjustment
,
11347 doc
: /* *If non-nil, always suppress point adjustment.
11349 The default value is nil, in which case, point adjustment are
11350 suppressed only after special commands that set
11351 `disable-point-adjustment' (which see) to non-nil. */);
11352 Vglobal_disable_point_adjustment
= Qnil
;
11354 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11355 doc
: /* Non-nil means updating menu bindings is allowed.
11356 A value of nil means menu bindings should not be updated.
11357 Used during Emacs' startup. */);
11358 update_menu_bindings
= 1;
11360 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11361 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11362 If the value is not a number, such messages don't time out. */);
11363 Vminibuffer_message_timeout
= make_number (2);
11367 keys_of_keyboard ()
11369 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11370 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11371 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11372 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11373 initial_define_key (meta_map
, 'x', "execute-extended-command");
11375 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11376 "handle-delete-frame");
11377 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11379 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11381 /* Handling it at such a low-level causes read_key_sequence to get
11382 * confused because it doesn't realize that the current_buffer was
11383 * changed by read_char.
11385 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11386 * "handle-select-window"); */
11387 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11388 "handle-save-session");
11391 /* Mark the pointers in the kboard objects.
11392 Called by the Fgarbage_collector. */
11398 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11400 if (kb
->kbd_macro_buffer
)
11401 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11403 mark_object (kb
->Voverriding_terminal_local_map
);
11404 mark_object (kb
->Vlast_command
);
11405 mark_object (kb
->Vreal_last_command
);
11406 mark_object (kb
->Vprefix_arg
);
11407 mark_object (kb
->Vlast_prefix_arg
);
11408 mark_object (kb
->kbd_queue
);
11409 mark_object (kb
->defining_kbd_macro
);
11410 mark_object (kb
->Vlast_kbd_macro
);
11411 mark_object (kb
->Vsystem_key_alist
);
11412 mark_object (kb
->system_key_syms
);
11413 mark_object (kb
->Vdefault_minibuffer_frame
);
11414 mark_object (kb
->echo_string
);
11417 struct input_event
*event
;
11418 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11420 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11421 event
= kbd_buffer
;
11422 mark_object (event
->x
);
11423 mark_object (event
->y
);
11424 mark_object (event
->frame_or_window
);
11425 mark_object (event
->arg
);