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. */
26 #include "systty.h" /* This must be included befor termchar.h. */
29 #include "termhooks.h"
38 #include "dispextern.h"
40 #include "intervals.h"
42 #include "blockinput.h"
54 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #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 #ifdef HAVE_WINDOW_SYSTEM
93 /* Make all keyboard buffers much bigger when using X windows. */
95 /* But not too big (local data > 32K error) if on Mac OS Classic. */
96 #define KBD_BUFFER_SIZE 512
98 #define KBD_BUFFER_SIZE 4096
100 #else /* No X-windows, character input */
101 #define KBD_BUFFER_SIZE 4096
102 #endif /* No X-windows */
104 #define abs(x) ((x) >= 0 ? (x) : -(x))
106 /* Following definition copied from eval.c */
110 struct backtrace
*next
;
111 Lisp_Object
*function
;
112 Lisp_Object
*args
; /* Points to vector of args. */
113 int nargs
; /* length of vector. If nargs is UNEVALLED,
114 args points to slot holding list of
120 KBOARD
*initial_kboard
;
121 KBOARD
*current_kboard
;
125 KBOARD the_only_kboard
;
128 /* Non-nil disable property on a command means
129 do not execute it; call disabled-command-hook's value instead. */
130 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
132 #define NUM_RECENT_KEYS (100)
133 int recent_keys_index
; /* Index for storing next element into recent_keys */
134 int total_keys
; /* Total number of elements stored into recent_keys */
135 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
137 /* Vector holding the key sequence that invoked the current command.
138 It is reused for each command, and it may be longer than the current
139 sequence; this_command_key_count indicates how many elements
140 actually mean something.
141 It's easier to staticpro a single Lisp_Object than an array. */
142 Lisp_Object this_command_keys
;
143 int this_command_key_count
;
145 /* 1 after calling Freset_this_command_lengths.
147 int this_command_key_count_reset
;
149 /* This vector is used as a buffer to record the events that were actually read
150 by read_key_sequence. */
151 Lisp_Object raw_keybuf
;
152 int raw_keybuf_count
;
154 #define GROW_RAW_KEYBUF \
155 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
157 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
159 new = Fmake_vector (make_number (newsize), Qnil); \
160 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
161 raw_keybuf_count * sizeof (Lisp_Object)); \
165 /* Number of elements of this_command_keys
166 that precede this key sequence. */
167 int this_single_command_key_start
;
169 /* Record values of this_command_key_count and echo_length ()
170 before this command was read. */
171 static int before_command_key_count
;
172 static int before_command_echo_length
;
174 extern int minbuf_level
;
176 extern int message_enable_multibyte
;
178 extern struct backtrace
*backtrace_list
;
180 /* If non-nil, the function that implements the display of help.
181 It's called with one argument, the help string to display. */
183 Lisp_Object Vshow_help_function
;
185 /* If a string, the message displayed before displaying a help-echo
188 Lisp_Object Vpre_help_message
;
190 /* Nonzero means do menu prompting. */
192 static int menu_prompting
;
194 /* Character to see next line of menu prompt. */
196 static Lisp_Object menu_prompt_more_char
;
198 /* For longjmp to where kbd input is being done. */
200 static jmp_buf getcjmp
;
202 /* True while doing kbd input. */
203 int waiting_for_input
;
205 /* True while displaying for echoing. Delays C-g throwing. */
209 /* Non-null means we can start echoing at the next input pause even
210 though there is something in the echo area. */
212 static struct kboard
*ok_to_echo_at_next_pause
;
214 /* The kboard last echoing, or null for none. Reset to 0 in
215 cancel_echoing. If non-null, and a current echo area message
216 exists, and echo_message_buffer is eq to the current message
217 buffer, we know that the message comes from echo_kboard. */
219 struct kboard
*echo_kboard
;
221 /* The buffer used for echoing. Set in echo_now, reset in
224 Lisp_Object echo_message_buffer
;
226 /* Nonzero means disregard local maps for the menu bar. */
227 static int inhibit_local_menu_bar_menus
;
229 /* Nonzero means C-g should cause immediate error-signal. */
232 /* The user's ERASE setting. */
233 Lisp_Object Vtty_erase_char
;
235 /* Character to recognize as the help char. */
236 Lisp_Object Vhelp_char
;
238 /* List of other event types to recognize as meaning "help". */
239 Lisp_Object Vhelp_event_list
;
241 /* Form to execute when help char is typed. */
242 Lisp_Object Vhelp_form
;
244 /* Command to run when the help character follows a prefix key. */
245 Lisp_Object Vprefix_help_command
;
247 /* List of items that should move to the end of the menu bar. */
248 Lisp_Object Vmenu_bar_final_items
;
250 /* Non-nil means show the equivalent key-binding for
251 any M-x command that has one.
252 The value can be a length of time to show the message for.
253 If the value is non-nil and not a number, we wait 2 seconds. */
254 Lisp_Object Vsuggest_key_bindings
;
256 /* How long to display an echo-area message when the minibuffer is active.
257 If the value is not a number, such messages don't time out. */
258 Lisp_Object Vminibuffer_message_timeout
;
260 /* Character that causes a quit. Normally C-g.
262 If we are running on an ordinary terminal, this must be an ordinary
263 ASCII char, since we want to make it our interrupt character.
265 If we are not running on an ordinary terminal, it still needs to be
266 an ordinary ASCII char. This character needs to be recognized in
267 the input interrupt handler. At this point, the keystroke is
268 represented as a struct input_event, while the desired quit
269 character is specified as a lispy event. The mapping from struct
270 input_events to lispy events cannot run in an interrupt handler,
271 and the reverse mapping is difficult for anything but ASCII
274 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
278 extern Lisp_Object current_global_map
;
279 extern int minibuf_level
;
281 /* If non-nil, this is a map that overrides all other local maps. */
282 Lisp_Object Voverriding_local_map
;
284 /* If non-nil, Voverriding_local_map applies to the menu bar. */
285 Lisp_Object Voverriding_local_map_menu_flag
;
287 /* Keymap that defines special misc events that should
288 be processed immediately at a low level. */
289 Lisp_Object Vspecial_event_map
;
291 /* Current depth in recursive edits. */
292 int command_loop_level
;
294 /* Total number of times command_loop has read a key sequence. */
295 EMACS_INT num_input_keys
;
297 /* Last input character read as a command. */
298 Lisp_Object last_command_char
;
300 /* Last input character read as a command, not counting menus
301 reached by the mouse. */
302 Lisp_Object last_nonmenu_event
;
304 /* Last input character read for any purpose. */
305 Lisp_Object last_input_char
;
307 /* If not Qnil, a list of objects to be read as subsequent command input. */
308 Lisp_Object Vunread_command_events
;
310 /* If not Qnil, a list of objects to be read as subsequent command input
311 including input method processing. */
312 Lisp_Object Vunread_input_method_events
;
314 /* If not Qnil, a list of objects to be read as subsequent command input
315 but NOT including input method processing. */
316 Lisp_Object Vunread_post_input_method_events
;
318 /* If not -1, an event to be read as subsequent command input. */
319 EMACS_INT unread_command_char
;
321 /* If not Qnil, this is a switch-frame event which we decided to put
322 off until the end of a key sequence. This should be read as the
323 next command input, after any unread_command_events.
325 read_key_sequence uses this to delay switch-frame events until the
326 end of the key sequence; Fread_char uses it to put off switch-frame
327 events until a non-ASCII event is acceptable as input. */
328 Lisp_Object unread_switch_frame
;
330 /* A mask of extra modifier bits to put into every keyboard char. */
331 EMACS_INT extra_keyboard_modifiers
;
333 /* Char to use as prefix when a meta character is typed in.
334 This is bound on entry to minibuffer in case ESC is changed there. */
336 Lisp_Object meta_prefix_char
;
338 /* Last size recorded for a current buffer which is not a minibuffer. */
339 static int last_non_minibuf_size
;
341 /* Number of idle seconds before an auto-save and garbage collection. */
342 static Lisp_Object Vauto_save_timeout
;
344 /* Total number of times read_char has returned. */
345 int num_input_events
;
347 /* Total number of times read_char has returned, outside of macros. */
348 EMACS_INT num_nonmacro_input_events
;
350 /* Auto-save automatically when this many characters have been typed
351 since the last time. */
353 static EMACS_INT auto_save_interval
;
355 /* Value of num_nonmacro_input_events as of last auto save. */
359 /* The command being executed by the command loop.
360 Commands may set this, and the value set will be copied into
361 current_kboard->Vlast_command instead of the actual command. */
362 Lisp_Object Vthis_command
;
364 /* This is like Vthis_command, except that commands never set it. */
365 Lisp_Object real_this_command
;
367 /* If the lookup of the command returns a binding, the original
368 command is stored in this-original-command. It is nil otherwise. */
369 Lisp_Object Vthis_original_command
;
371 /* The value of point when the last command was executed. */
372 int last_point_position
;
374 /* The buffer that was current when the last command was started. */
375 Lisp_Object last_point_position_buffer
;
377 /* The frame in which the last input event occurred, or Qmacro if the
378 last event came from a macro. We use this to determine when to
379 generate switch-frame events. This may be cleared by functions
380 like Fselect_frame, to make sure that a switch-frame event is
381 generated by the next character. */
382 Lisp_Object internal_last_event_frame
;
384 /* A user-visible version of the above, intended to allow users to
385 figure out where the last event came from, if the event doesn't
386 carry that information itself (i.e. if it was a character). */
387 Lisp_Object Vlast_event_frame
;
389 /* The timestamp of the last input event we received from the X server.
390 X Windows wants this for selection ownership. */
391 unsigned long last_event_timestamp
;
393 Lisp_Object Qself_insert_command
;
394 Lisp_Object Qforward_char
;
395 Lisp_Object Qbackward_char
;
396 Lisp_Object Qundefined
;
397 Lisp_Object Qtimer_event_handler
;
399 /* read_key_sequence stores here the command definition of the
400 key sequence that it reads. */
401 Lisp_Object read_key_sequence_cmd
;
403 /* Echo unfinished commands after this many seconds of pause. */
404 Lisp_Object Vecho_keystrokes
;
406 /* Form to evaluate (if non-nil) when Emacs is started. */
407 Lisp_Object Vtop_level
;
409 /* User-supplied table to translate input characters. */
410 Lisp_Object Vkeyboard_translate_table
;
412 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
413 extern Lisp_Object Vfunction_key_map
;
415 /* Another keymap that maps key sequences into key sequences.
416 This one takes precedence over ordinary definitions. */
417 extern Lisp_Object Vkey_translation_map
;
419 /* If non-nil, this implements the current input method. */
420 Lisp_Object Vinput_method_function
;
421 Lisp_Object Qinput_method_function
;
423 /* When we call Vinput_method_function,
424 this holds the echo area message that was just erased. */
425 Lisp_Object Vinput_method_previous_message
;
427 /* Non-nil means deactivate the mark at end of this command. */
428 Lisp_Object Vdeactivate_mark
;
430 /* Menu bar specified in Lucid Emacs fashion. */
432 Lisp_Object Vlucid_menu_bar_dirty_flag
;
433 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
435 Lisp_Object Qecho_area_clear_hook
;
437 /* Hooks to run before and after each command. */
438 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
439 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
440 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
441 /* Hook run after a command if there's no more input soon. */
442 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
444 /* Delay time in microseconds before running post-command-idle-hook. */
445 EMACS_INT post_command_idle_delay
;
447 /* List of deferred actions to be performed at a later time.
448 The precise format isn't relevant here; we just check whether it is nil. */
449 Lisp_Object Vdeferred_action_list
;
451 /* Function to call to handle deferred actions, when there are any. */
452 Lisp_Object Vdeferred_action_function
;
453 Lisp_Object Qdeferred_action_function
;
455 Lisp_Object Qinput_method_exit_on_first_char
;
456 Lisp_Object Qinput_method_use_echo_area
;
458 /* File in which we write all commands we read. */
461 /* Nonzero if input is available. */
464 /* Non-zero means force key bindings update in parse_menu_item. */
466 int update_menu_bindings
;
468 extern char *pending_malloc_warning
;
470 /* Circular buffer for pre-read keyboard input. */
472 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
474 /* Vector to GCPRO the Lisp objects referenced from kbd_buffer.
476 The interrupt-level event handlers will never enqueue an event on a
477 frame which is not in Vframe_list, and once an event is dequeued,
478 internal_last_event_frame or the event itself points to the frame.
481 But while the event is sitting in the queue, it's completely
482 unprotected. Suppose the user types one command which will run for
483 a while and then delete a frame, and then types another event at
484 the frame that will be deleted, before the command gets around to
485 it. Suppose there are no references to this frame elsewhere in
486 Emacs, and a GC occurs before the second event is dequeued. Now we
487 have an event referring to a freed frame, which will crash Emacs
490 Similar things happen when an event on a scroll bar is enqueued; the
491 window may be deleted while the event is in the queue.
493 So, we use this vector to protect the Lisp_Objects in the event
494 queue. That way, they'll be dequeued as dead frames or windows,
495 but still valid Lisp objects.
497 If kbd_buffer[i].kind != NO_EVENT, then
499 AREF (kbd_buffer_gcpro, 2 * i) == kbd_buffer[i].frame_or_window.
500 AREF (kbd_buffer_gcpro, 2 * i + 1) == kbd_buffer[i].arg. */
502 static Lisp_Object kbd_buffer_gcpro
;
504 /* Pointer to next available character in kbd_buffer.
505 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
506 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
507 next available char is in kbd_buffer[0]. */
508 static struct input_event
*kbd_fetch_ptr
;
510 /* Pointer to next place to store character in kbd_buffer. This
511 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
512 character should go in kbd_buffer[0]. */
513 static struct input_event
* volatile kbd_store_ptr
;
515 /* The above pair of variables forms a "queue empty" flag. When we
516 enqueue a non-hook event, we increment kbd_store_ptr. When we
517 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
518 there is input available iff the two pointers are not equal.
520 Why not just have a flag set and cleared by the enqueuing and
521 dequeuing functions? Such a flag could be screwed up by interrupts
522 at inopportune times. */
524 /* If this flag is non-nil, we check mouse_moved to see when the
525 mouse moves, and motion events will appear in the input stream.
526 Otherwise, mouse motion is ignored. */
527 Lisp_Object do_mouse_tracking
;
529 /* Symbols to head events. */
530 Lisp_Object Qmouse_movement
;
531 Lisp_Object Qscroll_bar_movement
;
532 Lisp_Object Qswitch_frame
;
533 Lisp_Object Qdelete_frame
;
534 Lisp_Object Qiconify_frame
;
535 Lisp_Object Qmake_frame_visible
;
536 Lisp_Object Qselect_window
;
537 Lisp_Object Qhelp_echo
;
539 /* Symbols to denote kinds of events. */
540 Lisp_Object Qfunction_key
;
541 Lisp_Object Qmouse_click
;
543 Lisp_Object Qlanguage_change
;
545 Lisp_Object Qdrag_n_drop
;
546 Lisp_Object Qsave_session
;
548 /* Lisp_Object Qmouse_movement; - also an event header */
550 /* Properties of event headers. */
551 Lisp_Object Qevent_kind
;
552 Lisp_Object Qevent_symbol_elements
;
554 /* menu item parts */
555 Lisp_Object Qmenu_alias
;
556 Lisp_Object Qmenu_enable
;
557 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
558 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
559 extern Lisp_Object Vdefine_key_rebound_commands
;
560 extern Lisp_Object Qmenu_item
;
562 /* An event header symbol HEAD may have a property named
563 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
564 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
565 mask of modifiers applied to it. If present, this is used to help
566 speed up parse_modifiers. */
567 Lisp_Object Qevent_symbol_element_mask
;
569 /* An unmodified event header BASE may have a property named
570 Qmodifier_cache, which is an alist mapping modifier masks onto
571 modified versions of BASE. If present, this helps speed up
573 Lisp_Object Qmodifier_cache
;
575 /* Symbols to use for parts of windows. */
576 Lisp_Object Qmode_line
;
577 Lisp_Object Qvertical_line
;
578 Lisp_Object Qvertical_scroll_bar
;
579 Lisp_Object Qmenu_bar
;
580 extern Lisp_Object Qleft_margin
, Qright_margin
;
581 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
582 extern Lisp_Object QCmap
;
584 Lisp_Object
recursive_edit_unwind (), command_loop ();
585 Lisp_Object
Fthis_command_keys ();
586 Lisp_Object Qextended_command_history
;
587 EMACS_TIME
timer_check ();
589 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
591 extern char *x_get_keysym_name ();
593 static void record_menu_key ();
594 static int echo_length ();
596 Lisp_Object Qpolling_period
;
598 /* List of absolute timers. Appears in order of next scheduled event. */
599 Lisp_Object Vtimer_list
;
601 /* List of idle time timers. Appears in order of next scheduled event. */
602 Lisp_Object Vtimer_idle_list
;
604 /* Incremented whenever a timer is run. */
607 extern Lisp_Object Vprint_level
, Vprint_length
;
609 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
611 EMACS_TIME
*input_available_clear_time
;
613 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
614 Default is 1 if INTERRUPT_INPUT is defined. */
617 /* Nonzero while interrupts are temporarily deferred during redisplay. */
618 int interrupts_deferred
;
620 /* Allow m- file to inhibit use of FIONREAD. */
621 #ifdef BROKEN_FIONREAD
625 /* We are unable to use interrupts if FIONREAD is not available,
626 so flush SIGIO so we won't try. */
633 /* If we support a window system, turn on the code to poll periodically
634 to detect C-g. It isn't actually used when doing interrupt input. */
635 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
636 #define POLL_FOR_INPUT
639 /* After a command is executed, if point is moved into a region that
640 has specific properties (e.g. composition, display), we adjust
641 point to the boundary of the region. But, if a command sets this
642 variable to non-nil, we suppress this point adjustment. This
643 variable is set to nil before reading a command. */
645 Lisp_Object Vdisable_point_adjustment
;
647 /* If non-nil, always disable point adjustment. */
649 Lisp_Object Vglobal_disable_point_adjustment
;
651 /* The time when Emacs started being idle. */
653 static EMACS_TIME timer_idleness_start_time
;
655 /* After Emacs stops being idle, this saves the last value
656 of timer_idleness_start_time from when it was idle. */
658 static EMACS_TIME timer_last_idleness_start_time
;
661 /* Global variable declarations. */
663 /* Function for init_keyboard to call with no args (if nonzero). */
664 void (*keyboard_init_hook
) ();
666 static int read_avail_input
P_ ((int));
667 static void get_input_pending
P_ ((int *, int));
668 static void get_filtered_input_pending
P_ ((int *, int, int));
669 static int readable_events
P_ ((int));
670 static int readable_filtered_events
P_ ((int, int));
671 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
672 Lisp_Object
, int *));
673 static Lisp_Object
read_char_x_menu_prompt ();
674 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
676 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
678 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
679 enum scroll_bar_part
,
680 Lisp_Object
, Lisp_Object
,
683 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
684 Lisp_Object
, char **,
685 Lisp_Object
*, unsigned));
686 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
687 static int parse_solitary_modifier
P_ ((Lisp_Object
));
688 static int parse_solitary_modifier ();
689 static void save_getcjmp
P_ ((jmp_buf));
690 static void save_getcjmp ();
691 static void restore_getcjmp
P_ ((jmp_buf));
692 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
693 static void clear_event
P_ ((struct input_event
*));
694 static void any_kboard_state
P_ ((void));
695 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
697 /* Nonzero means don't try to suspend even if the operating system seems
699 static int cannot_suspend
;
701 /* Install the string STR as the beginning of the string of echoing,
702 so that it serves as a prompt for the next character.
703 Also start echoing. */
709 current_kboard
->echo_string
= str
;
710 current_kboard
->echo_after_prompt
= SCHARS (str
);
714 /* Add C to the echo string, if echoing is going on.
715 C can be a character, which is printed prettily ("M-C-x" and all that
716 jazz), or a symbol, whose name is printed. */
722 if (current_kboard
->immediate_echo
)
724 int size
= KEY_DESCRIPTION_SIZE
+ 100;
725 char *buffer
= (char *) alloca (size
);
727 Lisp_Object echo_string
;
729 echo_string
= current_kboard
->echo_string
;
731 /* If someone has passed us a composite event, use its head symbol. */
736 ptr
= push_key_description (XINT (c
), ptr
, 1);
738 else if (SYMBOLP (c
))
740 Lisp_Object name
= SYMBOL_NAME (c
);
741 int nbytes
= SBYTES (name
);
743 if (size
- (ptr
- buffer
) < nbytes
)
745 int offset
= ptr
- buffer
;
746 size
= max (2 * size
, size
+ nbytes
);
747 buffer
= (char *) alloca (size
);
748 ptr
= buffer
+ offset
;
751 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
752 STRING_MULTIBYTE (name
), 1);
755 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
758 const char *text
= " (Type ? for further options)";
759 int len
= strlen (text
);
761 if (size
- (ptr
- buffer
) < len
)
763 int offset
= ptr
- buffer
;
765 buffer
= (char *) alloca (size
);
766 ptr
= buffer
+ offset
;
769 bcopy (text
, ptr
, len
);
773 /* Replace a dash from echo_dash with a space, otherwise
774 add a space at the end as a separator between keys. */
775 if (STRINGP (echo_string
)
776 && SCHARS (echo_string
) > 1)
778 Lisp_Object last_char
, prev_char
, idx
;
780 idx
= make_number (SCHARS (echo_string
) - 2);
781 prev_char
= Faref (echo_string
, idx
);
783 idx
= make_number (SCHARS (echo_string
) - 1);
784 last_char
= Faref (echo_string
, idx
);
786 /* We test PREV_CHAR to make sure this isn't the echoing
788 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
789 Faset (echo_string
, idx
, make_number (' '));
791 echo_string
= concat2 (echo_string
, build_string (" "));
794 current_kboard
->echo_string
795 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
801 /* Temporarily add a dash to the end of the echo string if it's not
802 empty, so that it serves as a mini-prompt for the very next character. */
807 /* Do nothing if not echoing at all. */
808 if (NILP (current_kboard
->echo_string
))
811 if (!current_kboard
->immediate_echo
812 && SCHARS (current_kboard
->echo_string
) == 0)
815 /* Do nothing if we just printed a prompt. */
816 if (current_kboard
->echo_after_prompt
817 == SCHARS (current_kboard
->echo_string
))
820 /* Put a dash at the end of the buffer temporarily,
821 but make it go away when the next character is added. */
822 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
827 /* Display the current echo string, and begin echoing if not already
833 if (!current_kboard
->immediate_echo
)
836 current_kboard
->immediate_echo
= 1;
838 for (i
= 0; i
< this_command_key_count
; i
++)
842 /* Set before_command_echo_length to the value that would
843 have been saved before the start of this subcommand in
844 command_loop_1, if we had already been echoing then. */
845 if (i
== this_single_command_key_start
)
846 before_command_echo_length
= echo_length ();
848 c
= XVECTOR (this_command_keys
)->contents
[i
];
849 if (! (EVENT_HAS_PARAMETERS (c
)
850 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
854 /* Set before_command_echo_length to the value that would
855 have been saved before the start of this subcommand in
856 command_loop_1, if we had already been echoing then. */
857 if (this_command_key_count
== this_single_command_key_start
)
858 before_command_echo_length
= echo_length ();
860 /* Put a dash at the end to invite the user to type more. */
865 message3_nolog (current_kboard
->echo_string
,
866 SBYTES (current_kboard
->echo_string
),
867 STRING_MULTIBYTE (current_kboard
->echo_string
));
870 /* Record in what buffer we echoed, and from which kboard. */
871 echo_message_buffer
= echo_area_buffer
[0];
872 echo_kboard
= current_kboard
;
874 if (waiting_for_input
&& !NILP (Vquit_flag
))
875 quit_throw_to_read_char ();
878 /* Turn off echoing, for the start of a new command. */
883 current_kboard
->immediate_echo
= 0;
884 current_kboard
->echo_after_prompt
= -1;
885 current_kboard
->echo_string
= Qnil
;
886 ok_to_echo_at_next_pause
= NULL
;
888 echo_message_buffer
= Qnil
;
891 /* Return the length of the current echo string. */
896 return (STRINGP (current_kboard
->echo_string
)
897 ? SCHARS (current_kboard
->echo_string
)
901 /* Truncate the current echo message to its first LEN chars.
902 This and echo_char get used by read_key_sequence when the user
903 switches frames while entering a key sequence. */
906 echo_truncate (nchars
)
909 if (STRINGP (current_kboard
->echo_string
))
910 current_kboard
->echo_string
911 = Fsubstring (current_kboard
->echo_string
,
912 make_number (0), make_number (nchars
));
913 truncate_echo_area (nchars
);
917 /* Functions for manipulating this_command_keys. */
919 add_command_key (key
)
922 #if 0 /* Not needed after we made Freset_this_command_lengths
923 do the job immediately. */
924 /* If reset-this-command-length was called recently, obey it now.
925 See the doc string of that function for an explanation of why. */
926 if (before_command_restore_flag
)
928 this_command_key_count
= before_command_key_count_1
;
929 if (this_command_key_count
< this_single_command_key_start
)
930 this_single_command_key_start
= this_command_key_count
;
931 echo_truncate (before_command_echo_length_1
);
932 before_command_restore_flag
= 0;
936 if (this_command_key_count
>= ASIZE (this_command_keys
))
937 this_command_keys
= larger_vector (this_command_keys
,
938 2 * ASIZE (this_command_keys
),
941 AREF (this_command_keys
, this_command_key_count
) = key
;
942 ++this_command_key_count
;
949 int count
= SPECPDL_INDEX ();
952 if (command_loop_level
> 0)
954 specbind (Qstandard_output
, Qt
);
955 specbind (Qstandard_input
, Qt
);
958 #ifdef HAVE_X_WINDOWS
959 /* The command loop has started an hourglass timer, so we have to
960 cancel it here, otherwise it will fire because the recursive edit
961 can take some time. Do not check for display_hourglass_p here,
962 because it could already be nil. */
966 /* This function may have been called from a debugger called from
967 within redisplay, for instance by Edebugging a function called
968 from fontification-functions. We want to allow redisplay in
969 the debugging session.
971 The recursive edit is left with a `(throw exit ...)'. The `exit'
972 tag is not caught anywhere in redisplay, i.e. when we leave the
973 recursive edit, the original redisplay leading to the recursive
974 edit will be unwound. The outcome should therefore be safe. */
975 specbind (Qinhibit_redisplay
, Qnil
);
978 val
= command_loop ();
980 Fsignal (Qquit
, Qnil
);
981 /* Handle throw from read_minibuf when using minibuffer
982 while it's active but we're in another window. */
984 Fsignal (Qerror
, Fcons (val
, Qnil
));
986 return unbind_to (count
, Qnil
);
989 /* When an auto-save happens, record the "time", and don't do again soon. */
994 last_auto_save
= num_nonmacro_input_events
;
997 /* Make an auto save happen as soon as possible at command level. */
1000 force_auto_save_soon ()
1002 last_auto_save
= - auto_save_interval
- 1;
1004 record_asynch_buffer_change ();
1007 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1008 doc
: /* Invoke the editor command loop recursively.
1009 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1010 that tells this function to return.
1011 Alternately, `(throw 'exit t)' makes this function signal an error.
1012 This function is called by the editor initialization to begin editing. */)
1015 int count
= SPECPDL_INDEX ();
1018 command_loop_level
++;
1019 update_mode_lines
= 1;
1021 if (command_loop_level
1022 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1023 buffer
= Fcurrent_buffer ();
1027 /* If we leave recursive_edit_1 below with a `throw' for instance,
1028 like it is done in the splash screen display, we have to
1029 make sure that we restore single_kboard as command_loop_1
1030 would have done if it were left normally. */
1031 record_unwind_protect (recursive_edit_unwind
,
1032 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1034 recursive_edit_1 ();
1035 return unbind_to (count
, Qnil
);
1039 recursive_edit_unwind (info
)
1042 if (BUFFERP (XCAR (info
)))
1043 Fset_buffer (XCAR (info
));
1045 if (NILP (XCDR (info
)))
1046 any_kboard_state ();
1048 single_kboard_state ();
1050 command_loop_level
--;
1051 update_mode_lines
= 1;
1060 #if 0 /* Theory: if there's anything in Vunread_command_events,
1061 it will right away be read by read_key_sequence,
1062 and then if we do switch KBOARDS, it will go into the side
1063 queue then. So we don't need to do anything special here -- rms. */
1064 if (CONSP (Vunread_command_events
))
1066 current_kboard
->kbd_queue
1067 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1068 current_kboard
->kbd_queue_has_data
= 1;
1070 Vunread_command_events
= Qnil
;
1076 /* Switch to the single-kboard state, making current_kboard
1077 the only KBOARD from which further input is accepted. */
1080 single_kboard_state ()
1087 /* Maintain a stack of kboards, so other parts of Emacs
1088 can switch temporarily to the kboard of a given frame
1089 and then revert to the previous status. */
1094 struct kboard_stack
*next
;
1097 static struct kboard_stack
*kboard_stack
;
1100 push_frame_kboard (f
)
1104 struct kboard_stack
*p
1105 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1107 p
->next
= kboard_stack
;
1108 p
->kboard
= current_kboard
;
1111 current_kboard
= FRAME_KBOARD (f
);
1119 struct kboard_stack
*p
= kboard_stack
;
1120 current_kboard
= p
->kboard
;
1121 kboard_stack
= p
->next
;
1126 /* Handle errors that are not handled at inner levels
1127 by printing an error message and returning to the editor command loop. */
1133 Lisp_Object old_level
, old_length
;
1134 char macroerror
[50];
1136 #ifdef HAVE_X_WINDOWS
1137 if (display_hourglass_p
)
1138 cancel_hourglass ();
1141 if (!NILP (executing_macro
))
1143 if (executing_macro_iterations
== 1)
1144 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1146 sprintf (macroerror
, "After %d kbd macro iterations: ",
1147 executing_macro_iterations
);
1152 Vstandard_output
= Qt
;
1153 Vstandard_input
= Qt
;
1154 Vexecuting_macro
= Qnil
;
1155 executing_macro
= Qnil
;
1156 current_kboard
->Vprefix_arg
= Qnil
;
1157 current_kboard
->Vlast_prefix_arg
= Qnil
;
1160 /* Avoid unquittable loop if data contains a circular list. */
1161 old_level
= Vprint_level
;
1162 old_length
= Vprint_length
;
1163 XSETFASTINT (Vprint_level
, 10);
1164 XSETFASTINT (Vprint_length
, 10);
1165 cmd_error_internal (data
, macroerror
);
1166 Vprint_level
= old_level
;
1167 Vprint_length
= old_length
;
1171 Vinhibit_quit
= Qnil
;
1173 any_kboard_state ();
1176 return make_number (0);
1179 /* Take actions on handling an error. DATA is the data that describes
1182 CONTEXT is a C-string containing ASCII characters only which
1183 describes the context in which the error happened. If we need to
1184 generalize CONTEXT to allow multibyte characters, make it a Lisp
1188 cmd_error_internal (data
, context
)
1193 int kill_emacs_p
= 0;
1194 struct frame
*sf
= SELECTED_FRAME ();
1198 clear_message (1, 0);
1200 /* If the window system or terminal frame hasn't been initialized
1201 yet, or we're not interactive, it's best to dump this message out
1202 to stderr and exit. */
1203 if (!sf
->glyphs_initialized_p
1204 /* This is the case of the frame dumped with Emacs, when we're
1205 running under a window system. */
1206 || (!NILP (Vwindow_system
)
1207 && !inhibit_window_system
1208 && FRAME_TERMCAP_P (sf
)
1209 && !FRAME_TTY (sf
)->type
) /* XXX This is ugly. */
1212 stream
= Qexternal_debugging_output
;
1218 message_log_maybe_newline ();
1223 /* The immediate context is not interesting for Quits,
1224 since they are asyncronous. */
1225 if (EQ (XCAR (data
), Qquit
))
1226 Vsignaling_function
= Qnil
;
1228 print_error_message (data
, stream
, context
, Vsignaling_function
);
1230 Vsignaling_function
= Qnil
;
1232 /* If the window system or terminal frame hasn't been initialized
1233 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1237 Fkill_emacs (make_number (-1));
1241 Lisp_Object
command_loop_1 ();
1242 Lisp_Object
command_loop_2 ();
1243 Lisp_Object
top_level_1 ();
1245 /* Entry to editor-command-loop.
1246 This level has the catches for exiting/returning to editor command loop.
1247 It returns nil to exit recursive edit, t to abort it. */
1252 if (command_loop_level
> 0 || minibuf_level
> 0)
1255 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1256 executing_macro
= Qnil
;
1262 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1263 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1264 executing_macro
= Qnil
;
1266 /* End of file in -batch run causes exit here. */
1272 /* Here we catch errors in execution of commands within the
1273 editing loop, and reenter the editing loop.
1274 When there is an error, cmd_error runs and returns a non-nil
1275 value to us. A value of nil means that command_loop_1 itself
1276 returned due to end of file (or end of kbd macro). */
1281 register Lisp_Object val
;
1284 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1285 while (!NILP (val
));
1293 return Feval (Vtop_level
);
1299 /* On entry to the outer level, run the startup file */
1300 if (!NILP (Vtop_level
))
1301 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1302 else if (!NILP (Vpurify_flag
))
1303 message ("Bare impure Emacs (standard Lisp code not loaded)");
1305 message ("Bare Emacs (standard Lisp code not loaded)");
1309 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1310 doc
: /* Exit all recursive editing levels. */)
1313 #ifdef HAVE_X_WINDOWS
1314 if (display_hourglass_p
)
1315 cancel_hourglass ();
1317 return Fthrow (Qtop_level
, Qnil
);
1320 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1321 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1324 if (command_loop_level
> 0 || minibuf_level
> 0)
1325 Fthrow (Qexit
, Qnil
);
1327 error ("No recursive edit is in progress");
1331 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1332 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1335 if (command_loop_level
> 0 || minibuf_level
> 0)
1338 error ("No recursive edit is in progress");
1342 /* This is the actual command reading loop,
1343 sans error-handling encapsulation. */
1345 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1347 void safe_run_hooks
P_ ((Lisp_Object
));
1348 static void adjust_point_for_property
P_ ((int, int));
1350 /* Cancel hourglass from protect_unwind.
1352 #ifdef HAVE_X_WINDOWS
1354 cancel_hourglass_unwind (arg
)
1357 cancel_hourglass ();
1367 Lisp_Object keybuf
[30];
1371 struct buffer
*prev_buffer
= NULL
;
1373 int was_locked
= single_kboard
;
1375 int already_adjusted
;
1377 current_kboard
->Vprefix_arg
= Qnil
;
1378 current_kboard
->Vlast_prefix_arg
= Qnil
;
1379 Vdeactivate_mark
= Qnil
;
1380 waiting_for_input
= 0;
1384 this_command_key_count
= 0;
1385 this_command_key_count_reset
= 0;
1386 this_single_command_key_start
= 0;
1388 if (NILP (Vmemory_full
))
1390 /* Make sure this hook runs after commands that get errors and
1391 throw to top level. */
1392 /* Note that the value cell will never directly contain nil
1393 if the symbol is a local variable. */
1394 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1395 safe_run_hooks (Qpost_command_hook
);
1397 /* If displaying a message, resize the echo area window to fit
1398 that message's size exactly. */
1399 if (!NILP (echo_area_buffer
[0]))
1400 resize_echo_area_exactly ();
1402 if (!NILP (Vdeferred_action_list
))
1403 call0 (Vdeferred_action_function
);
1405 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1407 if (NILP (Vunread_command_events
)
1408 && NILP (Vunread_input_method_events
)
1409 && NILP (Vunread_post_input_method_events
)
1410 && NILP (Vexecuting_macro
)
1411 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1412 safe_run_hooks (Qpost_command_idle_hook
);
1416 Vmemory_full
= Qnil
;
1418 /* Do this after running Vpost_command_hook, for consistency. */
1419 current_kboard
->Vlast_command
= Vthis_command
;
1420 current_kboard
->Vreal_last_command
= real_this_command
;
1424 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1427 /* Make sure the current window's buffer is selected. */
1428 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1429 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1431 /* Display any malloc warning that just came out. Use while because
1432 displaying one warning can cause another. */
1434 while (pending_malloc_warning
)
1435 display_malloc_warning ();
1439 Vdeactivate_mark
= Qnil
;
1441 /* If minibuffer on and echo area in use,
1442 wait a short time and redraw minibuffer. */
1445 && !NILP (echo_area_buffer
[0])
1446 && EQ (minibuf_window
, echo_area_window
)
1447 && NUMBERP (Vminibuffer_message_timeout
))
1449 /* Bind inhibit-quit to t so that C-g gets read in
1450 rather than quitting back to the minibuffer. */
1451 int count
= SPECPDL_INDEX ();
1452 specbind (Qinhibit_quit
, Qt
);
1454 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1455 /* Clear the echo area. */
1457 safe_run_hooks (Qecho_area_clear_hook
);
1459 unbind_to (count
, Qnil
);
1461 /* If a C-g came in before, treat it as input now. */
1462 if (!NILP (Vquit_flag
))
1465 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1470 alloca (0); /* Cause a garbage collection now */
1471 /* Since we can free the most stuff here. */
1472 #endif /* C_ALLOCA */
1475 /* Select the frame that the last event came from. Usually,
1476 switch-frame events will take care of this, but if some lisp
1477 code swallows a switch-frame event, we'll fix things up here.
1478 Is this a good idea? */
1479 if (FRAMEP (internal_last_event_frame
)
1480 && !EQ (internal_last_event_frame
, selected_frame
))
1481 Fselect_frame (internal_last_event_frame
, Qnil
);
1483 /* If it has changed current-menubar from previous value,
1484 really recompute the menubar from the value. */
1485 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1486 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1487 call0 (Qrecompute_lucid_menubar
);
1489 before_command_key_count
= this_command_key_count
;
1490 before_command_echo_length
= echo_length ();
1492 Vthis_command
= Qnil
;
1493 real_this_command
= Qnil
;
1495 /* Read next key sequence; i gets its length. */
1496 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1499 /* A filter may have run while we were reading the input. */
1500 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1502 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1503 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1507 /* Now we have read a key sequence of length I,
1508 or else I is 0 and we found end of file. */
1510 if (i
== 0) /* End of file -- happens only in */
1511 return Qnil
; /* a kbd macro, at the end. */
1512 /* -1 means read_key_sequence got a menu that was rejected.
1513 Just loop around and read another command. */
1517 this_command_key_count
= 0;
1518 this_command_key_count_reset
= 0;
1519 this_single_command_key_start
= 0;
1523 last_command_char
= keybuf
[i
- 1];
1525 /* If the previous command tried to force a specific window-start,
1526 forget about that, in case this command moves point far away
1527 from that position. But also throw away beg_unchanged and
1528 end_unchanged information in that case, so that redisplay will
1529 update the whole window properly. */
1530 if (!NILP (XWINDOW (selected_window
)->force_start
))
1533 XWINDOW (selected_window
)->force_start
= Qnil
;
1534 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1535 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1538 cmd
= read_key_sequence_cmd
;
1539 if (!NILP (Vexecuting_macro
))
1541 if (!NILP (Vquit_flag
))
1543 Vexecuting_macro
= Qt
;
1544 QUIT
; /* Make some noise. */
1545 /* Will return since macro now empty. */
1549 /* Do redisplay processing after this command except in special
1550 cases identified below. */
1551 prev_buffer
= current_buffer
;
1552 prev_modiff
= MODIFF
;
1553 last_point_position
= PT
;
1554 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1556 /* By default, we adjust point to a boundary of a region that
1557 has such a property that should be treated intangible
1558 (e.g. composition, display). But, some commands will set
1559 this variable differently. */
1560 Vdisable_point_adjustment
= Qnil
;
1562 /* Process filters and timers may have messed with deactivate-mark.
1563 reset it before we execute the command. */
1564 Vdeactivate_mark
= Qnil
;
1566 /* Remap command through active keymaps */
1567 Vthis_original_command
= cmd
;
1571 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1575 /* Execute the command. */
1577 Vthis_command
= cmd
;
1578 real_this_command
= cmd
;
1579 /* Note that the value cell will never directly contain nil
1580 if the symbol is a local variable. */
1581 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1582 safe_run_hooks (Qpre_command_hook
);
1584 already_adjusted
= 0;
1586 if (NILP (Vthis_command
))
1588 /* nil means key is undefined. */
1590 current_kboard
->defining_kbd_macro
= Qnil
;
1591 update_mode_lines
= 1;
1592 current_kboard
->Vprefix_arg
= Qnil
;
1596 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1598 /* In case we jump to directly_done. */
1599 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1601 /* Recognize some common commands in common situations and
1602 do them directly. */
1603 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1605 struct Lisp_Char_Table
*dp
1606 = window_display_table (XWINDOW (selected_window
));
1607 lose
= FETCH_CHAR (PT_BYTE
);
1609 if (! NILP (Vpost_command_hook
))
1610 /* Put this before calling adjust_point_for_property
1611 so it will only get called once in any case. */
1613 if (current_buffer
== prev_buffer
1614 && last_point_position
!= PT
1615 && NILP (Vdisable_point_adjustment
)
1616 && NILP (Vglobal_disable_point_adjustment
))
1617 adjust_point_for_property (last_point_position
, 0);
1618 already_adjusted
= 1;
1619 if (PT
== last_point_position
+ 1
1621 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1622 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1623 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1624 && (lose
>= 0x20 && lose
< 0x7f)))
1625 : (lose
>= 0x20 && lose
< 0x7f))
1626 /* To extract the case of continuation on
1627 wide-column characters. */
1628 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1629 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1631 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1633 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1635 && !windows_or_buffers_changed
1636 && EQ (current_buffer
->selective_display
, Qnil
)
1637 && !detect_input_pending ()
1638 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1639 && NILP (Vexecuting_macro
))
1640 direct_output_forward_char (1);
1643 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1645 struct Lisp_Char_Table
*dp
1646 = window_display_table (XWINDOW (selected_window
));
1648 lose
= FETCH_CHAR (PT_BYTE
);
1649 if (! NILP (Vpost_command_hook
))
1651 if (current_buffer
== prev_buffer
1652 && last_point_position
!= PT
1653 && NILP (Vdisable_point_adjustment
)
1654 && NILP (Vglobal_disable_point_adjustment
))
1655 adjust_point_for_property (last_point_position
, 0);
1656 already_adjusted
= 1;
1657 if (PT
== last_point_position
- 1
1659 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1660 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1661 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1662 && (lose
>= 0x20 && lose
< 0x7f)))
1663 : (lose
>= 0x20 && lose
< 0x7f))
1664 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1666 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1668 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1670 && !windows_or_buffers_changed
1671 && EQ (current_buffer
->selective_display
, Qnil
)
1672 && !detect_input_pending ()
1673 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1674 && NILP (Vexecuting_macro
))
1675 direct_output_forward_char (-1);
1678 else if (EQ (Vthis_command
, Qself_insert_command
)
1679 /* Try this optimization only on char keystrokes. */
1680 && NATNUMP (last_command_char
)
1681 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1684 = translate_char (Vtranslation_table_for_input
,
1685 XFASTINT (last_command_char
), 0, 0, 0);
1687 if (NILP (Vexecuting_macro
)
1688 && !EQ (minibuf_window
, selected_window
))
1690 if (!nonundocount
|| nonundocount
>= 20)
1698 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1700 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1702 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1704 || MODIFF
<= SAVE_MODIFF
1705 || windows_or_buffers_changed
1706 || !EQ (current_buffer
->selective_display
, Qnil
)
1707 || detect_input_pending ()
1708 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1709 || !NILP (Vexecuting_macro
));
1711 value
= internal_self_insert (c
, 0);
1716 if (! NILP (Vpost_command_hook
))
1717 /* Put this before calling adjust_point_for_property
1718 so it will only get called once in any case. */
1721 /* VALUE == 1 when AFTER-CHANGE functions are
1722 installed which is the case most of the time
1723 because FONT-LOCK installs one. */
1724 if (!lose
&& !value
)
1725 direct_output_for_insert (c
);
1730 /* Here for a command that isn't executed directly */
1733 #ifdef HAVE_X_WINDOWS
1734 int scount
= SPECPDL_INDEX ();
1736 if (display_hourglass_p
1737 && NILP (Vexecuting_macro
))
1739 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1745 if (NILP (current_kboard
->Vprefix_arg
))
1747 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1749 #ifdef HAVE_X_WINDOWS
1750 /* Do not check display_hourglass_p here, because
1751 Fcommand_execute could change it, but we should cancel
1752 hourglass cursor anyway.
1753 But don't cancel the hourglass within a macro
1754 just because a command in the macro finishes. */
1755 if (NILP (Vexecuting_macro
))
1756 unbind_to (scount
, Qnil
);
1761 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1763 /* Note that the value cell will never directly contain nil
1764 if the symbol is a local variable. */
1765 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1766 safe_run_hooks (Qpost_command_hook
);
1768 /* If displaying a message, resize the echo area window to fit
1769 that message's size exactly. */
1770 if (!NILP (echo_area_buffer
[0]))
1771 resize_echo_area_exactly ();
1773 if (!NILP (Vdeferred_action_list
))
1774 safe_run_hooks (Qdeferred_action_function
);
1776 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1778 if (NILP (Vunread_command_events
)
1779 && NILP (Vunread_input_method_events
)
1780 && NILP (Vunread_post_input_method_events
)
1781 && NILP (Vexecuting_macro
)
1782 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1783 safe_run_hooks (Qpost_command_idle_hook
);
1786 /* If there is a prefix argument,
1787 1) We don't want Vlast_command to be ``universal-argument''
1788 (that would be dumb), so don't set Vlast_command,
1789 2) we want to leave echoing on so that the prefix will be
1790 echoed as part of this key sequence, so don't call
1792 3) we want to leave this_command_key_count non-zero, so that
1793 read_char will realize that it is re-reading a character, and
1794 not echo it a second time.
1796 If the command didn't actually create a prefix arg,
1797 but is merely a frame event that is transparent to prefix args,
1798 then the above doesn't apply. */
1799 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1801 current_kboard
->Vlast_command
= Vthis_command
;
1802 current_kboard
->Vreal_last_command
= real_this_command
;
1804 this_command_key_count
= 0;
1805 this_command_key_count_reset
= 0;
1806 this_single_command_key_start
= 0;
1809 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1811 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1813 /* We could also call `deactivate'mark'. */
1814 if (EQ (Vtransient_mark_mode
, Qlambda
))
1815 Vtransient_mark_mode
= Qnil
;
1818 current_buffer
->mark_active
= Qnil
;
1819 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1822 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1823 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1828 if (current_buffer
== prev_buffer
1829 && last_point_position
!= PT
1830 && NILP (Vdisable_point_adjustment
)
1831 && NILP (Vglobal_disable_point_adjustment
)
1832 && !already_adjusted
)
1833 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1835 /* Install chars successfully executed in kbd macro. */
1837 if (!NILP (current_kboard
->defining_kbd_macro
)
1838 && NILP (current_kboard
->Vprefix_arg
))
1839 finalize_kbd_macro_chars ();
1843 any_kboard_state ();
1848 extern Lisp_Object Qcomposition
, Qdisplay
;
1850 /* Adjust point to a boundary of a region that has such a property
1851 that should be treated intangible. For the moment, we check
1852 `composition', `display' and `invisible' properties.
1853 LAST_PT is the last position of point. */
1855 extern Lisp_Object Qafter_string
, Qbefore_string
;
1856 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1859 adjust_point_for_property (last_pt
, modified
)
1864 Lisp_Object val
, overlay
, tmp
;
1865 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1868 /* FIXME: cycling is probably not necessary because these properties
1869 can't be usefully combined anyway. */
1870 while (check_composition
|| check_display
|| check_invisible
)
1872 if (check_composition
1873 && PT
> BEGV
&& PT
< ZV
1874 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1875 && COMPOSITION_VALID_P (beg
, end
, val
)
1876 && beg
< PT
/* && end > PT <- It's always the case. */
1877 && (last_pt
<= beg
|| last_pt
>= end
))
1880 SET_PT (PT
< last_pt
? beg
: end
);
1881 check_display
= check_invisible
= 1;
1883 check_composition
= 0;
1885 && PT
> BEGV
&& PT
< ZV
1886 && !NILP (val
= get_char_property_and_overlay
1887 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1888 && display_prop_intangible_p (val
)
1889 && (!OVERLAYP (overlay
)
1890 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1891 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1892 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1893 && beg
< PT
) /* && end > PT <- It's always the case. */
1896 SET_PT (PT
< last_pt
? beg
: end
);
1897 check_composition
= check_invisible
= 1;
1900 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1902 int inv
, ellipsis
= 0;
1905 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1907 && !NILP (val
= get_char_property_and_overlay
1908 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1909 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1911 ellipsis
= ellipsis
|| inv
> 1
1912 || (OVERLAYP (overlay
)
1913 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1914 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1915 tmp
= Fnext_single_char_property_change
1916 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1917 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1920 && !NILP (val
= get_char_property_and_overlay
1921 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1922 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1924 ellipsis
= ellipsis
|| inv
> 1
1925 || (OVERLAYP (overlay
)
1926 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1927 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1928 tmp
= Fprevious_single_char_property_change
1929 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1930 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1933 /* Move away from the inside area. */
1934 if (beg
< PT
&& end
> PT
)
1936 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1937 /* We haven't moved yet (so we don't need to fear
1938 infinite-looping) and we were outside the range
1939 before (so either end of the range still corresponds
1940 to a move in the right direction): pretend we moved
1941 less than we actually did, so that we still have
1942 more freedom below in choosing which end of the range
1944 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1945 /* We either have moved already or the last point
1946 was already in the range: we don't get to choose
1947 which end of the range we have to go to. */
1948 : (PT
< last_pt
? beg
: end
));
1949 check_composition
= check_display
= 1;
1951 xassert (PT
== beg
|| PT
== end
);
1952 /* Pretend the area doesn't exist if the buffer is not
1954 if (!modified
&& !ellipsis
&& beg
< end
)
1956 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1957 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1958 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1959 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1960 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1961 /* We've already moved as far as we can. Trying to go
1962 to the other end would mean moving backwards and thus
1963 could lead to an infinite loop. */
1965 else if (val
= get_pos_property (make_number (PT
),
1967 TEXT_PROP_MEANS_INVISIBLE (val
)
1968 && (val
= get_pos_property
1969 (make_number (PT
== beg
? end
: beg
),
1971 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1972 (check_composition
= check_display
= 1,
1973 SET_PT (PT
== beg
? end
: beg
));
1976 check_invisible
= 0;
1980 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1983 safe_run_hooks_1 (hook
)
1986 return call1 (Vrun_hooks
, Vinhibit_quit
);
1989 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1992 safe_run_hooks_error (data
)
1995 Lisp_Object args
[3];
1996 args
[0] = build_string ("Error in %s: %s");
1997 args
[1] = Vinhibit_quit
;
2000 return Fset (Vinhibit_quit
, Qnil
);
2003 /* If we get an error while running the hook, cause the hook variable
2004 to be nil. Also inhibit quits, so that C-g won't cause the hook
2005 to mysteriously evaporate. */
2008 safe_run_hooks (hook
)
2011 int count
= SPECPDL_INDEX ();
2012 specbind (Qinhibit_quit
, hook
);
2014 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2016 unbind_to (count
, Qnil
);
2020 /* Number of seconds between polling for input. This is a Lisp
2021 variable that can be bound. */
2023 EMACS_INT polling_period
;
2025 /* Nonzero means polling for input is temporarily suppressed. */
2027 int poll_suppress_count
;
2029 /* Asynchronous timer for polling. */
2031 struct atimer
*poll_timer
;
2034 #ifdef POLL_FOR_INPUT
2036 /* Poll for input, so what we catch a C-g if it comes in. This
2037 function is called from x_make_frame_visible, see comment
2043 if (interrupt_input_blocked
== 0
2044 && !waiting_for_input
)
2045 read_avail_input (0);
2048 /* Timer callback function for poll_timer. TIMER is equal to
2052 poll_for_input (timer
)
2053 struct atimer
*timer
;
2055 if (poll_suppress_count
== 0)
2056 poll_for_input_1 ();
2059 #endif /* POLL_FOR_INPUT */
2061 /* Begin signals to poll for input, if they are appropriate.
2062 This function is called unconditionally from various places. */
2067 #ifdef POLL_FOR_INPUT
2068 if (read_socket_hook
&& !interrupt_input
)
2070 /* Turn alarm handling on unconditionally. It might have
2071 been turned off in process.c. */
2072 turn_on_atimers (1);
2074 /* If poll timer doesn't exist, are we need one with
2075 a different interval, start a new one. */
2076 if (poll_timer
== NULL
2077 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2079 EMACS_TIME interval
;
2082 cancel_atimer (poll_timer
);
2084 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2085 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2086 poll_for_input
, NULL
);
2089 /* Let the timer's callback function poll for input
2090 if this becomes zero. */
2091 --poll_suppress_count
;
2096 /* Nonzero if we are using polling to handle input asynchronously. */
2099 input_polling_used ()
2101 #ifdef POLL_FOR_INPUT
2102 return read_socket_hook
&& !interrupt_input
;
2108 /* Turn off polling. */
2113 #ifdef POLL_FOR_INPUT
2114 if (read_socket_hook
&& !interrupt_input
)
2115 ++poll_suppress_count
;
2119 /* Set the value of poll_suppress_count to COUNT
2120 and start or stop polling accordingly. */
2123 set_poll_suppress_count (count
)
2126 #ifdef POLL_FOR_INPUT
2127 if (count
== 0 && poll_suppress_count
!= 0)
2129 poll_suppress_count
= 1;
2132 else if (count
!= 0 && poll_suppress_count
== 0)
2136 poll_suppress_count
= count
;
2140 /* Bind polling_period to a value at least N.
2141 But don't decrease it. */
2144 bind_polling_period (n
)
2147 #ifdef POLL_FOR_INPUT
2148 int new = polling_period
;
2153 stop_other_atimers (poll_timer
);
2155 specbind (Qpolling_period
, make_number (new));
2156 /* Start a new alarm with the new period. */
2161 /* Apply the control modifier to CHARACTER. */
2167 /* Save the upper bits here. */
2168 int upper
= c
& ~0177;
2172 /* Everything in the columns containing the upper-case letters
2173 denotes a control character. */
2174 if (c
>= 0100 && c
< 0140)
2178 /* Set the shift modifier for a control char
2179 made from a shifted letter. But only for letters! */
2180 if (oc
>= 'A' && oc
<= 'Z')
2181 c
|= shift_modifier
;
2184 /* The lower-case letters denote control characters too. */
2185 else if (c
>= 'a' && c
<= 'z')
2188 /* Include the bits for control and shift
2189 only if the basic ASCII code can't indicate them. */
2193 /* Replace the high bits. */
2194 c
|= (upper
& ~ctrl_modifier
);
2199 /* Display help echo in the echo area.
2201 HELP a string means display that string, HELP nil means clear the
2202 help echo. If HELP is a function, call it with OBJECT and POS as
2203 arguments; the function should return a help string or nil for
2204 none. For all other types of HELP evaluate it to obtain a string.
2206 WINDOW is the window in which the help was generated, if any.
2207 It is nil if not in a window.
2209 If OBJECT is a buffer, POS is the position in the buffer where the
2210 `help-echo' text property was found.
2212 If OBJECT is an overlay, that overlay has a `help-echo' property,
2213 and POS is the position in the overlay's buffer under the mouse.
2215 If OBJECT is a string (an overlay string or a string displayed with
2216 the `display' property). POS is the position in that string under
2219 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2220 echo overwrites a keystroke echo currently displayed in the echo
2223 Note: this function may only be called with HELP nil or a string
2224 from X code running asynchronously. */
2227 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2228 Lisp_Object help
, window
, object
, pos
;
2229 int ok_to_overwrite_keystroke_echo
;
2231 if (!NILP (help
) && !STRINGP (help
))
2233 if (FUNCTIONP (help
))
2235 Lisp_Object args
[4];
2240 help
= safe_call (4, args
);
2243 help
= safe_eval (help
);
2245 if (!STRINGP (help
))
2249 if (STRINGP (help
) || NILP (help
))
2251 if (!NILP (Vshow_help_function
))
2252 call1 (Vshow_help_function
, help
);
2253 else if (/* Don't overwrite minibuffer contents. */
2254 !MINI_WINDOW_P (XWINDOW (selected_window
))
2255 /* Don't overwrite a keystroke echo. */
2256 && (NILP (echo_message_buffer
)
2257 || ok_to_overwrite_keystroke_echo
)
2258 /* Don't overwrite a prompt. */
2259 && !cursor_in_echo_area
)
2263 int count
= SPECPDL_INDEX ();
2265 if (!help_echo_showing_p
)
2266 Vpre_help_message
= current_message ();
2268 specbind (Qmessage_truncate_lines
, Qt
);
2269 message3_nolog (help
, SBYTES (help
),
2270 STRING_MULTIBYTE (help
));
2271 unbind_to (count
, Qnil
);
2273 else if (STRINGP (Vpre_help_message
))
2275 message3_nolog (Vpre_help_message
,
2276 SBYTES (Vpre_help_message
),
2277 STRING_MULTIBYTE (Vpre_help_message
));
2278 Vpre_help_message
= Qnil
;
2284 help_echo_showing_p
= STRINGP (help
);
2290 /* Input of single characters from keyboard */
2292 Lisp_Object
print_help ();
2293 static Lisp_Object
kbd_buffer_get_event ();
2294 static void record_char ();
2297 static jmp_buf wrong_kboard_jmpbuf
;
2300 #define STOP_POLLING \
2301 do { if (! polling_stopped_here) stop_polling (); \
2302 polling_stopped_here = 1; } while (0)
2304 #define RESUME_POLLING \
2305 do { if (polling_stopped_here) start_polling (); \
2306 polling_stopped_here = 0; } while (0)
2308 /* read a character from the keyboard; call the redisplay if needed */
2309 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2310 -1 means do not do redisplay, but do do autosaving.
2313 /* The arguments MAPS and NMAPS are for menu prompting.
2314 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2316 PREV_EVENT is the previous input event, or nil if we are reading
2317 the first event of a key sequence (or not reading a key sequence).
2318 If PREV_EVENT is t, that is a "magic" value that says
2319 not to run input methods, but in other respects to act as if
2320 not reading a key sequence.
2322 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2323 if we used a mouse menu to read the input, or zero otherwise. If
2324 USED_MOUSE_MENU is null, we don't dereference it.
2326 Value is t if we showed a menu and the user rejected it. */
2329 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2333 Lisp_Object prev_event
;
2334 int *used_mouse_menu
;
2336 volatile Lisp_Object c
;
2338 jmp_buf local_getcjmp
;
2340 volatile int key_already_recorded
= 0;
2341 Lisp_Object tem
, save
;
2342 volatile Lisp_Object previous_echo_area_message
;
2343 volatile Lisp_Object also_record
;
2344 volatile int reread
;
2345 struct gcpro gcpro1
, gcpro2
;
2346 EMACS_TIME last_idle_start
;
2347 int polling_stopped_here
= 0;
2351 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2352 before_command_key_count
= this_command_key_count
;
2353 before_command_echo_length
= echo_length ();
2356 previous_echo_area_message
= Qnil
;
2358 GCPRO2 (c
, previous_echo_area_message
);
2363 if (CONSP (Vunread_post_input_method_events
))
2365 c
= XCAR (Vunread_post_input_method_events
);
2366 Vunread_post_input_method_events
2367 = XCDR (Vunread_post_input_method_events
);
2369 /* Undo what read_char_x_menu_prompt did when it unread
2370 additional keys returned by Fx_popup_menu. */
2372 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2380 if (unread_command_char
!= -1)
2382 XSETINT (c
, unread_command_char
);
2383 unread_command_char
= -1;
2389 if (CONSP (Vunread_command_events
))
2391 c
= XCAR (Vunread_command_events
);
2392 Vunread_command_events
= XCDR (Vunread_command_events
);
2394 /* Undo what read_char_x_menu_prompt did when it unread
2395 additional keys returned by Fx_popup_menu. */
2397 && EQ (XCDR (c
), Qdisabled
)
2398 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2401 /* If the queued event is something that used the mouse,
2402 set used_mouse_menu accordingly. */
2404 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2405 *used_mouse_menu
= 1;
2408 goto reread_for_input_method
;
2411 if (CONSP (Vunread_input_method_events
))
2413 c
= XCAR (Vunread_input_method_events
);
2414 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2416 /* Undo what read_char_x_menu_prompt did when it unread
2417 additional keys returned by Fx_popup_menu. */
2419 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2423 goto reread_for_input_method
;
2426 this_command_key_count_reset
= 0;
2428 if (!NILP (Vexecuting_macro
))
2430 /* We set this to Qmacro; since that's not a frame, nobody will
2431 try to switch frames on us, and the selected window will
2434 Since this event came from a macro, it would be misleading to
2435 leave internal_last_event_frame set to wherever the last
2436 real event came from. Normally, a switch-frame event selects
2437 internal_last_event_frame after each command is read, but
2438 events read from a macro should never cause a new frame to be
2440 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2442 /* Exit the macro if we are at the end.
2443 Also, some things replace the macro with t
2444 to force an early exit. */
2445 if (EQ (Vexecuting_macro
, Qt
)
2446 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2452 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2453 if (STRINGP (Vexecuting_macro
)
2454 && (XINT (c
) & 0x80))
2455 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2457 executing_macro_index
++;
2462 if (!NILP (unread_switch_frame
))
2464 c
= unread_switch_frame
;
2465 unread_switch_frame
= Qnil
;
2467 /* This event should make it into this_command_keys, and get echoed
2468 again, so we do not set `reread'. */
2472 /* if redisplay was requested */
2473 if (commandflag
>= 0)
2475 /* If there is pending input, process any events which are not
2476 user-visible, such as X selection_request events. */
2478 || detect_input_pending_run_timers (0))
2479 swallow_events (0); /* may clear input_pending */
2481 /* Redisplay if no pending input. */
2482 while (!input_pending
)
2484 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2485 redisplay_preserve_echo_area (5);
2490 /* Normal case: no input arrived during redisplay. */
2493 /* Input arrived and pre-empted redisplay.
2494 Process any events which are not user-visible. */
2496 /* If that cleared input_pending, try again to redisplay. */
2500 /* Message turns off echoing unless more keystrokes turn it on again.
2502 The code in 20.x for the condition was
2504 1. echo_area_glyphs && *echo_area_glyphs
2505 2. && echo_area_glyphs != current_kboard->echobuf
2506 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2508 (1) means there's a current message displayed
2510 (2) means it's not the message from echoing from the current
2513 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2514 is set to a non-null value. This is done in read_char and it is
2515 set to echo_area_glyphs after a call to echo_char. That means
2516 ok_to_echo_at_next_pause is either null or
2517 current_kboard->echobuf with the appropriate current_kboard at
2520 So, condition (3) means in clear text ok_to_echo_at_next_pause
2521 must be either null, or the current message isn't from echoing at
2522 all, or it's from echoing from a different kboard than the
2525 if (/* There currently is something in the echo area. */
2526 !NILP (echo_area_buffer
[0])
2527 && (/* And it's either not from echoing. */
2528 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2529 /* Or it's an echo from a different kboard. */
2530 || echo_kboard
!= current_kboard
2531 /* Or we explicitly allow overwriting whatever there is. */
2532 || ok_to_echo_at_next_pause
== NULL
))
2537 /* Try reading a character via menu prompting in the minibuf.
2538 Try this before the sit-for, because the sit-for
2539 would do the wrong thing if we are supposed to do
2540 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2541 after a mouse event so don't try a minibuf menu. */
2543 if (nmaps
> 0 && INTERACTIVE
2544 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2545 /* Don't bring up a menu if we already have another event. */
2546 && NILP (Vunread_command_events
)
2547 && unread_command_char
< 0
2548 && !detect_input_pending_run_timers (0))
2550 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2553 key_already_recorded
= 1;
2558 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2559 We will do that below, temporarily for short sections of code,
2560 when appropriate. local_getcjmp must be in effect
2561 around any call to sit_for or kbd_buffer_get_event;
2562 it *must not* be in effect when we call redisplay. */
2564 if (_setjmp (local_getcjmp
))
2566 XSETINT (c
, quit_char
);
2567 internal_last_event_frame
= selected_frame
;
2568 Vlast_event_frame
= internal_last_event_frame
;
2569 /* If we report the quit char as an event,
2570 don't do so more than once. */
2571 if (!NILP (Vinhibit_quit
))
2576 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2577 if (kb
!= current_kboard
)
2579 Lisp_Object link
= kb
->kbd_queue
;
2580 /* We shouldn't get here if we were in single-kboard mode! */
2585 while (CONSP (XCDR (link
)))
2587 if (!NILP (XCDR (link
)))
2591 kb
->kbd_queue
= Fcons (c
, Qnil
);
2593 XSETCDR (link
, Fcons (c
, Qnil
));
2594 kb
->kbd_queue_has_data
= 1;
2595 current_kboard
= kb
;
2596 /* This is going to exit from read_char
2597 so we had better get rid of this frame's stuff. */
2599 longjmp (wrong_kboard_jmpbuf
, 1);
2606 timer_start_idle ();
2608 /* If in middle of key sequence and minibuffer not active,
2609 start echoing if enough time elapses. */
2611 if (minibuf_level
== 0
2612 && !current_kboard
->immediate_echo
2613 && this_command_key_count
> 0
2615 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2616 && NILP (Fzerop (Vecho_keystrokes
))
2617 && (/* No message. */
2618 NILP (echo_area_buffer
[0])
2619 /* Or empty message. */
2620 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2621 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2622 /* Or already echoing from same kboard. */
2623 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2624 /* Or not echoing before and echoing allowed. */
2625 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2629 /* After a mouse event, start echoing right away.
2630 This is because we are probably about to display a menu,
2631 and we don't want to delay before doing so. */
2632 if (EVENT_HAS_PARAMETERS (prev_event
))
2637 double duration
= extract_float (Vecho_keystrokes
);
2638 sec
= (int) duration
;
2639 usec
= (duration
- sec
) * 1000000;
2640 save_getcjmp (save_jump
);
2641 restore_getcjmp (local_getcjmp
);
2642 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2643 restore_getcjmp (save_jump
);
2645 && ! CONSP (Vunread_command_events
))
2650 /* Maybe auto save due to number of keystrokes. */
2652 if (commandflag
!= 0
2653 && auto_save_interval
> 0
2654 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2655 && !detect_input_pending_run_timers (0))
2657 Fdo_auto_save (Qnil
, Qnil
);
2658 /* Hooks can actually change some buffers in auto save. */
2662 /* Try reading using an X menu.
2663 This is never confused with reading using the minibuf
2664 because the recursive call of read_char in read_char_minibuf_menu_prompt
2665 does not pass on any keymaps. */
2667 if (nmaps
> 0 && INTERACTIVE
2668 && !NILP (prev_event
)
2669 && EVENT_HAS_PARAMETERS (prev_event
)
2670 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2671 && !EQ (XCAR (prev_event
), Qtool_bar
)
2672 /* Don't bring up a menu if we already have another event. */
2673 && NILP (Vunread_command_events
)
2674 && unread_command_char
< 0)
2676 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2678 /* Now that we have read an event, Emacs is not idle. */
2684 /* Maybe autosave and/or garbage collect due to idleness. */
2686 if (INTERACTIVE
&& NILP (c
))
2688 int delay_level
, buffer_size
;
2690 /* Slow down auto saves logarithmically in size of current buffer,
2691 and garbage collect while we're at it. */
2692 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2693 last_non_minibuf_size
= Z
- BEG
;
2694 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2696 while (buffer_size
> 64)
2697 delay_level
++, buffer_size
-= buffer_size
>> 2;
2698 if (delay_level
< 4) delay_level
= 4;
2699 /* delay_level is 4 for files under around 50k, 7 at 100k,
2700 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2702 /* Auto save if enough time goes by without input. */
2703 if (commandflag
!= 0
2704 && num_nonmacro_input_events
> last_auto_save
2705 && INTEGERP (Vauto_save_timeout
)
2706 && XINT (Vauto_save_timeout
) > 0)
2710 save_getcjmp (save_jump
);
2711 restore_getcjmp (local_getcjmp
);
2712 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2714 restore_getcjmp (save_jump
);
2717 && ! CONSP (Vunread_command_events
))
2719 Fdo_auto_save (Qnil
, Qnil
);
2721 /* If we have auto-saved and there is still no input
2722 available, garbage collect if there has been enough
2723 consing going on to make it worthwhile. */
2724 if (!detect_input_pending_run_timers (0)
2725 && consing_since_gc
> gc_cons_threshold
/ 2)
2726 Fgarbage_collect ();
2733 /* If this has become non-nil here, it has been set by a timer
2734 or sentinel or filter. */
2735 if (CONSP (Vunread_command_events
))
2737 c
= XCAR (Vunread_command_events
);
2738 Vunread_command_events
= XCDR (Vunread_command_events
);
2741 /* Read something from current KBOARD's side queue, if possible. */
2745 if (current_kboard
->kbd_queue_has_data
)
2747 if (!CONSP (current_kboard
->kbd_queue
))
2749 c
= XCAR (current_kboard
->kbd_queue
);
2750 current_kboard
->kbd_queue
2751 = XCDR (current_kboard
->kbd_queue
);
2752 if (NILP (current_kboard
->kbd_queue
))
2753 current_kboard
->kbd_queue_has_data
= 0;
2754 input_pending
= readable_events (0);
2755 if (EVENT_HAS_PARAMETERS (c
)
2756 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2757 internal_last_event_frame
= XCAR (XCDR (c
));
2758 Vlast_event_frame
= internal_last_event_frame
;
2763 /* If current_kboard's side queue is empty check the other kboards.
2764 If one of them has data that we have not yet seen here,
2765 switch to it and process the data waiting for it.
2767 Note: if the events queued up for another kboard
2768 have already been seen here, and therefore are not a complete command,
2769 the kbd_queue_has_data field is 0, so we skip that kboard here.
2770 That's to avoid an infinite loop switching between kboards here. */
2771 if (NILP (c
) && !single_kboard
)
2774 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2775 if (kb
->kbd_queue_has_data
)
2777 current_kboard
= kb
;
2778 /* This is going to exit from read_char
2779 so we had better get rid of this frame's stuff. */
2781 longjmp (wrong_kboard_jmpbuf
, 1);
2790 /* Finally, we read from the main queue,
2791 and if that gives us something we can't use yet, we put it on the
2792 appropriate side queue and try again. */
2798 /* Actually read a character, waiting if necessary. */
2799 save_getcjmp (save_jump
);
2800 restore_getcjmp (local_getcjmp
);
2801 timer_start_idle ();
2802 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2803 restore_getcjmp (save_jump
);
2806 if (! NILP (c
) && (kb
!= current_kboard
))
2808 Lisp_Object link
= kb
->kbd_queue
;
2811 while (CONSP (XCDR (link
)))
2813 if (!NILP (XCDR (link
)))
2817 kb
->kbd_queue
= Fcons (c
, Qnil
);
2819 XSETCDR (link
, Fcons (c
, Qnil
));
2820 kb
->kbd_queue_has_data
= 1;
2824 current_kboard
= kb
;
2825 /* This is going to exit from read_char
2826 so we had better get rid of this frame's stuff. */
2828 longjmp (wrong_kboard_jmpbuf
, 1);
2833 /* Terminate Emacs in batch mode if at eof. */
2834 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2835 Fkill_emacs (make_number (1));
2839 /* Add in any extra modifiers, where appropriate. */
2840 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2841 || ((extra_keyboard_modifiers
& 0177) < ' '
2842 && (extra_keyboard_modifiers
& 0177) != 0))
2843 XSETINT (c
, make_ctrl_char (XINT (c
)));
2845 /* Transfer any other modifier bits directly from
2846 extra_keyboard_modifiers to c. Ignore the actual character code
2847 in the low 16 bits of extra_keyboard_modifiers. */
2848 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2853 /* Record the last idle start time so that we can reset it
2854 should the next event read be a help-echo. */
2855 last_idle_start
= timer_idleness_start_time
;
2861 if (commandflag
>= 0
2862 && !input_pending
&& !detect_input_pending_run_timers (0))
2870 /* Buffer switch events are only for internal wakeups
2871 so don't show them to the user.
2872 Also, don't record a key if we already did. */
2873 if (BUFFERP (c
) || key_already_recorded
)
2876 /* Process special events within read_char
2877 and loop around to read another event. */
2880 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2885 int was_locked
= single_kboard
;
2887 last_input_char
= c
;
2888 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2890 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2891 /* We stopped being idle for this event; undo that. This
2892 prevents automatic window selection (under
2893 mouse_autoselect_window from acting as a real input event, for
2894 example banishing the mouse under mouse-avoidance-mode. */
2895 timer_idleness_start_time
= last_idle_start
;
2897 /* Resume allowing input from any kboard, if that was true before. */
2899 any_kboard_state ();
2904 /* Handle things that only apply to characters. */
2907 /* If kbd_buffer_get_event gave us an EOF, return that. */
2911 if ((STRINGP (Vkeyboard_translate_table
)
2912 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2913 || (VECTORP (Vkeyboard_translate_table
)
2914 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2915 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2916 && CHAR_VALID_P (XINT (c
), 0)))
2919 d
= Faref (Vkeyboard_translate_table
, c
);
2920 /* nil in keyboard-translate-table means no translation. */
2926 /* If this event is a mouse click in the menu bar,
2927 return just menu-bar for now. Modify the mouse click event
2928 so we won't do this twice, then queue it up. */
2929 if (EVENT_HAS_PARAMETERS (c
)
2931 && CONSP (EVENT_START (c
))
2932 && CONSP (XCDR (EVENT_START (c
))))
2936 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2937 /* Handle menu-bar events:
2938 insert the dummy prefix event `menu-bar'. */
2939 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2941 /* Change menu-bar to (menu-bar) as the event "position". */
2942 POSN_BUFFER_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2945 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2950 /* Store these characters into recent_keys, the dribble file if any,
2951 and the keyboard macro being defined, if any. */
2953 if (! NILP (also_record
))
2954 record_char (also_record
);
2956 /* Wipe the echo area.
2957 But first, if we are about to use an input method,
2958 save the echo area contents for it to refer to. */
2960 && ! NILP (Vinput_method_function
)
2961 && (unsigned) XINT (c
) >= ' '
2962 && (unsigned) XINT (c
) != 127
2963 && (unsigned) XINT (c
) < 256)
2965 previous_echo_area_message
= Fcurrent_message ();
2966 Vinput_method_previous_message
= previous_echo_area_message
;
2969 /* Now wipe the echo area, except for help events which do their
2970 own stuff with the echo area. */
2972 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2973 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2975 if (!NILP (echo_area_buffer
[0]))
2976 safe_run_hooks (Qecho_area_clear_hook
);
2977 clear_message (1, 0);
2980 reread_for_input_method
:
2982 /* Pass this to the input method, if appropriate. */
2984 && ! NILP (Vinput_method_function
)
2985 /* Don't run the input method within a key sequence,
2986 after the first event of the key sequence. */
2987 && NILP (prev_event
)
2988 && (unsigned) XINT (c
) >= ' '
2989 && (unsigned) XINT (c
) != 127
2990 && (unsigned) XINT (c
) < 256)
2993 int key_count
, key_count_reset
;
2994 struct gcpro gcpro1
;
2995 int count
= SPECPDL_INDEX ();
2997 /* Save the echo status. */
2998 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2999 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3000 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3003 if (before_command_restore_flag
)
3005 this_command_key_count
= before_command_key_count_1
;
3006 if (this_command_key_count
< this_single_command_key_start
)
3007 this_single_command_key_start
= this_command_key_count
;
3008 echo_truncate (before_command_echo_length_1
);
3009 before_command_restore_flag
= 0;
3013 /* Save the this_command_keys status. */
3014 key_count
= this_command_key_count
;
3015 key_count_reset
= this_command_key_count_reset
;
3018 keys
= Fcopy_sequence (this_command_keys
);
3023 /* Clear out this_command_keys. */
3024 this_command_key_count
= 0;
3025 this_command_key_count_reset
= 0;
3027 /* Now wipe the echo area. */
3028 if (!NILP (echo_area_buffer
[0]))
3029 safe_run_hooks (Qecho_area_clear_hook
);
3030 clear_message (1, 0);
3033 /* If we are not reading a key sequence,
3034 never use the echo area. */
3037 specbind (Qinput_method_use_echo_area
, Qt
);
3040 /* Call the input method. */
3041 tem
= call1 (Vinput_method_function
, c
);
3043 tem
= unbind_to (count
, tem
);
3045 /* Restore the saved echoing state
3046 and this_command_keys state. */
3047 this_command_key_count
= key_count
;
3048 this_command_key_count_reset
= key_count_reset
;
3050 this_command_keys
= keys
;
3053 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3054 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3055 if (saved_immediate_echo
)
3060 /* The input method can return no events. */
3063 /* Bring back the previous message, if any. */
3064 if (! NILP (previous_echo_area_message
))
3065 message_with_string ("%s", previous_echo_area_message
, 0);
3068 /* It returned one event or more. */
3070 Vunread_post_input_method_events
3071 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3076 /* Display help if not echoing. */
3077 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3079 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3080 Lisp_Object help
, object
, position
, window
, tem
;
3082 tem
= Fcdr (XCDR (c
));
3085 window
= Fcar (tem
);
3087 object
= Fcar (tem
);
3089 position
= Fcar (tem
);
3091 show_help_echo (help
, window
, object
, position
, 0);
3093 /* We stopped being idle for this event; undo that. */
3094 timer_idleness_start_time
= last_idle_start
;
3098 if (! reread
|| this_command_key_count
== 0
3099 || this_command_key_count_reset
)
3102 /* Don't echo mouse motion events. */
3103 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3104 && NILP (Fzerop (Vecho_keystrokes
))
3105 && ! (EVENT_HAS_PARAMETERS (c
)
3106 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3109 if (! NILP (also_record
))
3110 echo_char (also_record
);
3111 /* Once we reread a character, echoing can happen
3112 the next time we pause to read a new one. */
3113 ok_to_echo_at_next_pause
= current_kboard
;
3116 /* Record this character as part of the current key. */
3117 add_command_key (c
);
3118 if (! NILP (also_record
))
3119 add_command_key (also_record
);
3122 last_input_char
= c
;
3125 /* Process the help character specially if enabled */
3126 if (!NILP (Vhelp_form
) && help_char_p (c
))
3129 count
= SPECPDL_INDEX ();
3131 record_unwind_protect (Fset_window_configuration
,
3132 Fcurrent_window_configuration (Qnil
));
3134 tem0
= Feval (Vhelp_form
);
3136 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3140 c
= read_char (0, 0, 0, Qnil
, 0);
3141 while (BUFFERP (c
));
3142 /* Remove the help from the frame */
3143 unbind_to (count
, Qnil
);
3146 if (EQ (c
, make_number (040)))
3150 c
= read_char (0, 0, 0, Qnil
, 0);
3151 while (BUFFERP (c
));
3160 /* Record a key that came from a mouse menu.
3161 Record it for echoing, for this-command-keys, and so on. */
3167 /* Wipe the echo area. */
3168 clear_message (1, 0);
3173 before_command_key_count
= this_command_key_count
;
3174 before_command_echo_length
= echo_length ();
3177 /* Don't echo mouse motion events. */
3178 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3179 && NILP (Fzerop (Vecho_keystrokes
)))
3183 /* Once we reread a character, echoing can happen
3184 the next time we pause to read a new one. */
3185 ok_to_echo_at_next_pause
= 0;
3188 /* Record this character as part of the current key. */
3189 add_command_key (c
);
3191 /* Re-reading in the middle of a command */
3192 last_input_char
= c
;
3196 /* Return 1 if should recognize C as "the help character". */
3204 if (EQ (c
, Vhelp_char
))
3206 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3207 if (EQ (c
, XCAR (tail
)))
3212 /* Record the input event C in various ways. */
3220 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3222 /* To avoid filling recent_keys with help-echo and mouse-movement
3223 events, we filter out repeated help-echo events, only store the
3224 first and last in a series of mouse-movement events, and don't
3225 store repeated help-echo events which are only separated by
3226 mouse-movement events. */
3228 Lisp_Object ev1
, ev2
, ev3
;
3231 if ((ix1
= recent_keys_index
- 1) < 0)
3232 ix1
= NUM_RECENT_KEYS
- 1;
3233 ev1
= AREF (recent_keys
, ix1
);
3235 if ((ix2
= ix1
- 1) < 0)
3236 ix2
= NUM_RECENT_KEYS
- 1;
3237 ev2
= AREF (recent_keys
, ix2
);
3239 if ((ix3
= ix2
- 1) < 0)
3240 ix3
= NUM_RECENT_KEYS
- 1;
3241 ev3
= AREF (recent_keys
, ix3
);
3243 if (EQ (XCAR (c
), Qhelp_echo
))
3245 /* Don't record `help-echo' in recent_keys unless it shows some help
3246 message, and a different help than the previously recorded
3248 Lisp_Object help
, last_help
;
3250 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3251 if (!STRINGP (help
))
3253 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3254 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3256 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3257 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3258 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3260 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3261 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3262 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3263 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3266 else if (EQ (XCAR (c
), Qmouse_movement
))
3268 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3269 So additional mouse movement events replace the last element. */
3270 Lisp_Object last_window
, window
;
3272 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3273 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3274 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3275 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3276 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3278 ASET (recent_keys
, ix1
, c
);
3284 store_kbd_macro_char (c
);
3289 ASET (recent_keys
, recent_keys_index
, c
);
3290 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3291 recent_keys_index
= 0;
3293 else if (recorded
< 0)
3295 /* We need to remove one or two events from recent_keys.
3296 To do this, we simply put nil at those events and move the
3297 recent_keys_index backwards over those events. Usually,
3298 users will never see those nil events, as they will be
3299 overwritten by the command keys entered to see recent_keys
3302 while (recorded
++ < 0 && total_keys
> 0)
3304 if (total_keys
< NUM_RECENT_KEYS
)
3306 if (--recent_keys_index
< 0)
3307 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3308 ASET (recent_keys
, recent_keys_index
, Qnil
);
3312 num_nonmacro_input_events
++;
3314 /* Write c to the dribble file. If c is a lispy event, write
3315 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3316 If you, dear reader, have a better idea, you've got the source. :-) */
3321 if (XUINT (c
) < 0x100)
3322 putc (XINT (c
), dribble
);
3324 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3328 Lisp_Object dribblee
;
3330 /* If it's a structured event, take the event header. */
3331 dribblee
= EVENT_HEAD (c
);
3333 if (SYMBOLP (dribblee
))
3335 putc ('<', dribble
);
3336 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3337 SBYTES (SYMBOL_NAME (dribblee
)),
3339 putc ('>', dribble
);
3351 struct buffer
*old
= current_buffer
;
3352 Fprinc (object
, Qnil
);
3353 set_buffer_internal (XBUFFER (Vstandard_output
));
3354 call0 (intern ("help-mode"));
3355 set_buffer_internal (old
);
3359 /* Copy out or in the info on where C-g should throw to.
3360 This is used when running Lisp code from within get_char,
3361 in case get_char is called recursively.
3362 See read_process_output. */
3368 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3372 restore_getcjmp (temp
)
3375 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3380 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3381 of this function. */
3384 tracking_off (old_value
)
3385 Lisp_Object old_value
;
3387 do_mouse_tracking
= old_value
;
3388 if (NILP (old_value
))
3390 /* Redisplay may have been preempted because there was input
3391 available, and it assumes it will be called again after the
3392 input has been processed. If the only input available was
3393 the sort that we have just disabled, then we need to call
3395 if (!readable_events (1))
3397 redisplay_preserve_echo_area (6);
3398 get_input_pending (&input_pending
, 1);
3404 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3405 doc
: /* Evaluate BODY with mouse movement events enabled.
3406 Within a `track-mouse' form, mouse motion generates input events that
3407 you can read with `read-event'.
3408 Normally, mouse motion is ignored.
3409 usage: (track-mouse BODY ...) */)
3413 int count
= SPECPDL_INDEX ();
3416 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3418 do_mouse_tracking
= Qt
;
3420 val
= Fprogn (args
);
3421 return unbind_to (count
, val
);
3424 /* If mouse has moved on some frame, return one of those frames.
3425 Return 0 otherwise. */
3430 Lisp_Object tail
, frame
;
3432 FOR_EACH_FRAME (tail
, frame
)
3434 if (XFRAME (frame
)->mouse_moved
)
3435 return XFRAME (frame
);
3441 #endif /* HAVE_MOUSE */
3443 /* Low level keyboard/mouse input.
3444 kbd_buffer_store_event places events in kbd_buffer, and
3445 kbd_buffer_get_event retrieves them. */
3447 /* Return true iff there are any events in the queue that read-char
3448 would return. If this returns false, a read-char would block. */
3450 readable_filtered_events (do_timers_now
, filter_events
)
3455 timer_check (do_timers_now
);
3457 /* If the buffer contains only FOCUS_IN_EVENT events,
3458 and FILTER_EVENTS is nonzero, report it as empty. */
3459 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3461 int have_live_event
= 1;
3465 struct input_event
*event
;
3467 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3471 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3474 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3476 if (event
== kbd_store_ptr
)
3477 have_live_event
= 0;
3480 if (have_live_event
) return 1;
3484 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3489 if (current_kboard
->kbd_queue_has_data
)
3495 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3496 if (kb
->kbd_queue_has_data
)
3502 /* Return true iff there are any events in the queue that read-char
3503 would return. If this returns false, a read-char would block. */
3505 readable_events (do_timers_now
)
3508 return readable_filtered_events (do_timers_now
, 0);
3511 /* Set this for debugging, to have a way to get out */
3516 event_to_kboard (event
)
3517 struct input_event
*event
;
3520 frame
= event
->frame_or_window
;
3522 frame
= XCAR (frame
);
3523 else if (WINDOWP (frame
))
3524 frame
= WINDOW_FRAME (XWINDOW (frame
));
3526 /* There are still some events that don't set this field.
3527 For now, just ignore the problem.
3528 Also ignore dead frames here. */
3529 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3532 return FRAME_KBOARD (XFRAME (frame
));
3536 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3539 kbd_buffer_store_event (event
)
3540 register struct input_event
*event
;
3542 if (event
->kind
== NO_EVENT
)
3545 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3547 register int c
= event
->code
& 0377;
3549 if (event
->modifiers
& ctrl_modifier
)
3550 c
= make_ctrl_char (c
);
3552 c
|= (event
->modifiers
3553 & (meta_modifier
| alt_modifier
3554 | hyper_modifier
| super_modifier
));
3560 struct input_event
*sp
;
3563 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3564 kb
!= current_kboard
))
3567 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3568 Fcons (make_number (c
), Qnil
));
3569 kb
->kbd_queue_has_data
= 1;
3570 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3572 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3575 if (event_to_kboard (sp
) == kb
)
3577 sp
->kind
= NO_EVENT
;
3578 sp
->frame_or_window
= Qnil
;
3586 /* If this results in a quit_char being returned to Emacs as
3587 input, set Vlast_event_frame properly. If this doesn't
3588 get returned to Emacs as an event, the next event read
3589 will set Vlast_event_frame again, so this is safe to do. */
3593 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3595 focus
= event
->frame_or_window
;
3596 internal_last_event_frame
= focus
;
3597 Vlast_event_frame
= focus
;
3600 last_event_timestamp
= event
->timestamp
;
3601 interrupt_signal (0 /* dummy */);
3605 if (c
&& c
== stop_character
)
3611 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3612 Just ignore the second one. */
3613 else if (event
->kind
== BUFFER_SWITCH_EVENT
3614 && kbd_fetch_ptr
!= kbd_store_ptr
3615 && kbd_store_ptr
->kind
== BUFFER_SWITCH_EVENT
)
3618 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3619 kbd_store_ptr
= kbd_buffer
;
3621 /* Don't let the very last slot in the buffer become full,
3622 since that would make the two pointers equal,
3623 and that is indistinguishable from an empty buffer.
3624 Discard the event if it would fill the last slot. */
3625 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3629 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3630 prone to assign individual members for other events, in case
3631 the input_event structure is changed. --2000-07-13, gerd. */
3632 struct input_event
*sp
= kbd_store_ptr
;
3633 sp
->kind
= event
->kind
;
3634 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3636 /* We must not use the ordinary copying code for this case,
3637 since `part' is an enum and copying it might not copy enough
3639 bcopy (event
, (char *) sp
, sizeof (*event
));
3644 sp
->code
= event
->code
;
3645 sp
->part
= event
->part
;
3646 sp
->frame_or_window
= event
->frame_or_window
;
3647 sp
->arg
= event
->arg
;
3648 sp
->modifiers
= event
->modifiers
;
3651 sp
->timestamp
= event
->timestamp
;
3654 *kbd_store_ptr
= *event
;
3657 idx
= 2 * (kbd_store_ptr
- kbd_buffer
);
3658 ASET (kbd_buffer_gcpro
, idx
, event
->frame_or_window
);
3659 ASET (kbd_buffer_gcpro
, idx
+ 1, event
->arg
);
3665 /* Generate HELP_EVENT input_events in BUFP which has room for
3666 SIZE events. If there's not enough room in BUFP, ignore this
3669 HELP is the help form.
3671 FRAME is the frame on which the help is generated. OBJECT is the
3672 Lisp object where the help was found (a buffer, a string, an
3673 overlay, or nil if neither from a string nor from a buffer. POS is
3674 the position within OBJECT where the help was found.
3676 Value is the number of input_events generated. */
3679 gen_help_event (bufp
, size
, help
, frame
, window
, object
, pos
)
3680 struct input_event
*bufp
;
3682 Lisp_Object help
, frame
, object
, window
;
3687 bufp
->kind
= HELP_EVENT
;
3688 bufp
->frame_or_window
= frame
;
3690 bufp
->x
= WINDOWP (window
) ? window
: frame
;
3699 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3702 kbd_buffer_store_help_event (frame
, help
)
3703 Lisp_Object frame
, help
;
3705 struct input_event event
;
3707 event
.kind
= HELP_EVENT
;
3708 event
.frame_or_window
= frame
;
3713 kbd_buffer_store_event (&event
);
3717 /* Discard any mouse events in the event buffer by setting them to
3720 discard_mouse_events ()
3722 struct input_event
*sp
;
3723 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3725 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3728 if (sp
->kind
== MOUSE_CLICK_EVENT
3729 || sp
->kind
== WHEEL_EVENT
3731 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3733 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3735 sp
->kind
= NO_EVENT
;
3741 /* Return non-zero if there are any real events waiting in the event
3742 buffer, not counting `NO_EVENT's.
3744 If DISCARD is non-zero, discard NO_EVENT events at the front of
3745 the input queue, possibly leaving the input queue empty if there
3746 are no real input events. */
3749 kbd_buffer_events_waiting (discard
)
3752 struct input_event
*sp
;
3754 for (sp
= kbd_fetch_ptr
;
3755 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3758 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3765 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3769 /* Clear input event EVENT. */
3773 struct input_event
*event
;
3775 int idx
= 2 * (event
- kbd_buffer
);
3776 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
3777 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
3778 event
->kind
= NO_EVENT
;
3782 /* Read one event from the event buffer, waiting if necessary.
3783 The value is a Lisp object representing the event.
3784 The value is nil for an event that should be ignored,
3785 or that was handled here.
3786 We always read and discard one event. */
3789 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3791 int *used_mouse_menu
;
3800 *kbp
= current_kboard
;
3804 /* Wait until there is input available. */
3807 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3810 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3814 /* If the quit flag is set, then read_char will return
3815 quit_char, so that counts as "available input." */
3816 if (!NILP (Vquit_flag
))
3817 quit_throw_to_read_char ();
3819 /* One way or another, wait until input is available; then, if
3820 interrupt handlers have not read it, read it now. */
3823 wait_for_kbd_input ();
3825 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3829 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3832 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3836 Lisp_Object minus_one
;
3838 XSETINT (minus_one
, -1);
3839 wait_reading_process_input (0, 0, minus_one
, 1);
3841 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3842 /* Pass 1 for EXPECT since we just waited to have input. */
3843 read_avail_input (1);
3845 #endif /* not VMS */
3848 if (CONSP (Vunread_command_events
))
3851 first
= XCAR (Vunread_command_events
);
3852 Vunread_command_events
= XCDR (Vunread_command_events
);
3853 *kbp
= current_kboard
;
3857 /* At this point, we know that there is a readable event available
3858 somewhere. If the event queue is empty, then there must be a
3859 mouse movement enabled and available. */
3860 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3862 struct input_event
*event
;
3864 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3868 last_event_timestamp
= event
->timestamp
;
3871 *kbp
= event_to_kboard (event
);
3873 *kbp
= current_kboard
; /* Better than returning null ptr? */
3875 *kbp
= &the_only_kboard
;
3880 /* These two kinds of events get special handling
3881 and don't actually appear to the command loop.
3882 We return nil for them. */
3883 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3886 struct input_event copy
;
3888 /* Remove it from the buffer before processing it,
3889 since otherwise swallow_events will see it
3890 and process it again. */
3892 kbd_fetch_ptr
= event
+ 1;
3893 input_pending
= readable_events (0);
3894 x_handle_selection_request (©
);
3896 /* We're getting selection request events, but we don't have
3902 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3905 struct input_event copy
;
3907 /* Remove it from the buffer before processing it. */
3909 kbd_fetch_ptr
= event
+ 1;
3910 input_pending
= readable_events (0);
3911 x_handle_selection_clear (©
);
3913 /* We're getting selection request events, but we don't have
3918 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3919 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3921 /* Make an event (delete-frame (FRAME)). */
3922 obj
= Fcons (event
->frame_or_window
, Qnil
);
3923 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3924 kbd_fetch_ptr
= event
+ 1;
3927 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3928 else if (event
->kind
== ICONIFY_EVENT
)
3930 /* Make an event (iconify-frame (FRAME)). */
3931 obj
= Fcons (event
->frame_or_window
, Qnil
);
3932 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3933 kbd_fetch_ptr
= event
+ 1;
3935 else if (event
->kind
== DEICONIFY_EVENT
)
3937 /* Make an event (make-frame-visible (FRAME)). */
3938 obj
= Fcons (event
->frame_or_window
, Qnil
);
3939 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3940 kbd_fetch_ptr
= event
+ 1;
3943 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3945 /* The value doesn't matter here; only the type is tested. */
3946 XSETBUFFER (obj
, current_buffer
);
3947 kbd_fetch_ptr
= event
+ 1;
3949 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
3950 || defined (USE_GTK)
3951 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3953 kbd_fetch_ptr
= event
+ 1;
3954 input_pending
= readable_events (0);
3955 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3956 x_activate_menubar (XFRAME (event
->frame_or_window
));
3960 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3962 /* Make an event (language-change (FRAME CHARSET LCID)). */
3963 obj
= Fcons (event
->modifiers
, Qnil
);
3964 obj
= Fcons (event
->code
, obj
);
3965 obj
= Fcons (event
->frame_or_window
, obj
);
3966 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3967 kbd_fetch_ptr
= event
+ 1;
3970 else if (event
->kind
== SAVE_SESSION_EVENT
)
3972 obj
= Fcons (Qsave_session
, Qnil
);
3973 kbd_fetch_ptr
= event
+ 1;
3975 /* Just discard these, by returning nil.
3976 With MULTI_KBOARD, these events are used as placeholders
3977 when we need to randomly delete events from the queue.
3978 (They shouldn't otherwise be found in the buffer,
3979 but on some machines it appears they do show up
3980 even without MULTI_KBOARD.) */
3981 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3982 mouse events during a popup-menu call. */
3983 else if (event
->kind
== NO_EVENT
)
3984 kbd_fetch_ptr
= event
+ 1;
3985 else if (event
->kind
== HELP_EVENT
)
3987 Lisp_Object object
, position
, help
, frame
, window
;
3989 frame
= event
->frame_or_window
;
3990 object
= event
->arg
;
3991 position
= make_number (event
->code
);
3994 clear_event (event
);
3996 kbd_fetch_ptr
= event
+ 1;
3997 if (!WINDOWP (window
))
3999 obj
= Fcons (Qhelp_echo
,
4000 list5 (frame
, help
, window
, object
, position
));
4002 else if (event
->kind
== FOCUS_IN_EVENT
)
4004 /* Notification of a FocusIn event. The frame receiving the
4005 focus is in event->frame_or_window. Generate a
4006 switch-frame event if necessary. */
4007 Lisp_Object frame
, focus
;
4009 frame
= event
->frame_or_window
;
4010 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4014 if (!EQ (frame
, internal_last_event_frame
)
4015 && !EQ (frame
, selected_frame
))
4016 obj
= make_lispy_switch_frame (frame
);
4017 internal_last_event_frame
= frame
;
4018 kbd_fetch_ptr
= event
+ 1;
4022 /* If this event is on a different frame, return a switch-frame this
4023 time, and leave the event in the queue for next time. */
4027 frame
= event
->frame_or_window
;
4029 frame
= XCAR (frame
);
4030 else if (WINDOWP (frame
))
4031 frame
= WINDOW_FRAME (XWINDOW (frame
));
4033 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4037 if (! EQ (frame
, internal_last_event_frame
)
4038 && !EQ (frame
, selected_frame
))
4039 obj
= make_lispy_switch_frame (frame
);
4040 internal_last_event_frame
= frame
;
4042 /* If we didn't decide to make a switch-frame event, go ahead
4043 and build a real event from the queue entry. */
4047 obj
= make_lispy_event (event
);
4049 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4050 || defined (USE_GTK)
4051 /* If this was a menu selection, then set the flag to inhibit
4052 writing to last_nonmenu_event. Don't do this if the event
4053 we're returning is (menu-bar), though; that indicates the
4054 beginning of the menu sequence, and we might as well leave
4055 that as the `event with parameters' for this selection. */
4057 && !EQ (event
->frame_or_window
, event
->arg
)
4058 && (event
->kind
== MENU_BAR_EVENT
4059 || event
->kind
== TOOL_BAR_EVENT
))
4060 *used_mouse_menu
= 1;
4063 /* Wipe out this event, to catch bugs. */
4064 clear_event (event
);
4065 kbd_fetch_ptr
= event
+ 1;
4070 /* Try generating a mouse motion event. */
4071 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4073 FRAME_PTR f
= some_mouse_moved ();
4074 Lisp_Object bar_window
;
4075 enum scroll_bar_part part
;
4079 *kbp
= current_kboard
;
4080 /* Note that this uses F to determine which display to look at.
4081 If there is no valid info, it does not store anything
4082 so x remains nil. */
4084 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4088 /* Decide if we should generate a switch-frame event. Don't
4089 generate switch-frame events for motion outside of all Emacs
4095 frame
= FRAME_FOCUS_FRAME (f
);
4097 XSETFRAME (frame
, f
);
4099 if (! EQ (frame
, internal_last_event_frame
)
4100 && !EQ (frame
, selected_frame
))
4101 obj
= make_lispy_switch_frame (frame
);
4102 internal_last_event_frame
= frame
;
4105 /* If we didn't decide to make a switch-frame event, go ahead and
4106 return a mouse-motion event. */
4107 if (!NILP (x
) && NILP (obj
))
4108 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4110 #endif /* HAVE_MOUSE */
4112 /* We were promised by the above while loop that there was
4113 something for us to read! */
4116 input_pending
= readable_events (0);
4118 Vlast_event_frame
= internal_last_event_frame
;
4123 /* Process any events that are not user-visible,
4124 then return, without reading any user-visible events. */
4127 swallow_events (do_display
)
4132 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4134 struct input_event
*event
;
4136 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4140 last_event_timestamp
= event
->timestamp
;
4142 /* These two kinds of events get special handling
4143 and don't actually appear to the command loop. */
4144 if (event
->kind
== SELECTION_REQUEST_EVENT
)
4147 struct input_event copy
;
4149 /* Remove it from the buffer before processing it,
4150 since otherwise swallow_events called recursively could see it
4151 and process it again. */
4153 kbd_fetch_ptr
= event
+ 1;
4154 input_pending
= readable_events (0);
4155 x_handle_selection_request (©
);
4157 /* We're getting selection request events, but we don't have
4163 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
4166 struct input_event copy
;
4168 /* Remove it from the buffer before processing it, */
4171 kbd_fetch_ptr
= event
+ 1;
4172 input_pending
= readable_events (0);
4173 x_handle_selection_clear (©
);
4175 /* We're getting selection request events, but we don't have
4184 old_timers_run
= timers_run
;
4185 get_input_pending (&input_pending
, 1);
4187 if (timers_run
!= old_timers_run
&& do_display
)
4188 redisplay_preserve_echo_area (7);
4191 /* Record the start of when Emacs is idle,
4192 for the sake of running idle-time timers. */
4199 /* If we are already in the idle state, do nothing. */
4200 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4203 EMACS_GET_TIME (timer_idleness_start_time
);
4205 timer_last_idleness_start_time
= timer_idleness_start_time
;
4207 /* Mark all idle-time timers as once again candidates for running. */
4208 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4212 timer
= XCAR (timers
);
4214 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4216 XVECTOR (timer
)->contents
[0] = Qnil
;
4220 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4225 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4228 /* This is only for debugging. */
4229 struct input_event last_timer_event
;
4231 /* Check whether a timer has fired. To prevent larger problems we simply
4232 disregard elements that are not proper timers. Do not make a circular
4233 timer list for the time being.
4235 Returns the number of seconds to wait until the next timer fires. If a
4236 timer is triggering now, return zero seconds.
4237 If no timer is active, return -1 seconds.
4239 If a timer is ripe, we run it, with quitting turned off.
4241 DO_IT_NOW is now ignored. It used to mean that we should
4242 run the timer directly instead of queueing a timer-event.
4243 Now we always run timers directly. */
4246 timer_check (do_it_now
)
4249 EMACS_TIME nexttime
;
4250 EMACS_TIME now
, idleness_now
;
4251 Lisp_Object timers
, idle_timers
, chosen_timer
;
4252 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4254 EMACS_SET_SECS (nexttime
, -1);
4255 EMACS_SET_USECS (nexttime
, -1);
4257 /* Always consider the ordinary timers. */
4258 timers
= Vtimer_list
;
4259 /* Consider the idle timers only if Emacs is idle. */
4260 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4261 idle_timers
= Vtimer_idle_list
;
4264 chosen_timer
= Qnil
;
4265 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4267 if (CONSP (timers
) || CONSP (idle_timers
))
4269 EMACS_GET_TIME (now
);
4270 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4271 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4274 while (CONSP (timers
) || CONSP (idle_timers
))
4276 Lisp_Object
*vector
;
4277 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4278 EMACS_TIME timer_time
, idle_timer_time
;
4279 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4281 /* Skip past invalid timers and timers already handled. */
4284 timer
= XCAR (timers
);
4285 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4287 timers
= XCDR (timers
);
4290 vector
= XVECTOR (timer
)->contents
;
4292 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4293 || !INTEGERP (vector
[3])
4294 || ! NILP (vector
[0]))
4296 timers
= XCDR (timers
);
4300 if (!NILP (idle_timers
))
4302 timer
= XCAR (idle_timers
);
4303 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4305 idle_timers
= XCDR (idle_timers
);
4308 vector
= XVECTOR (timer
)->contents
;
4310 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4311 || !INTEGERP (vector
[3])
4312 || ! NILP (vector
[0]))
4314 idle_timers
= XCDR (idle_timers
);
4319 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4320 based on the next ordinary timer.
4321 TIMER_DIFFERENCE is the distance in time from NOW to when
4322 this timer becomes ripe (negative if it's already ripe). */
4325 timer
= XCAR (timers
);
4326 vector
= XVECTOR (timer
)->contents
;
4327 EMACS_SET_SECS (timer_time
,
4328 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4329 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4330 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4333 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4334 based on the next idle timer. */
4335 if (!NILP (idle_timers
))
4337 idle_timer
= XCAR (idle_timers
);
4338 vector
= XVECTOR (idle_timer
)->contents
;
4339 EMACS_SET_SECS (idle_timer_time
,
4340 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4341 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4342 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4345 /* Decide which timer is the next timer,
4346 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4347 Also step down the list where we found that timer. */
4349 if (! NILP (timers
) && ! NILP (idle_timers
))
4352 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4353 if (EMACS_TIME_NEG_P (temp
))
4355 chosen_timer
= timer
;
4356 timers
= XCDR (timers
);
4357 difference
= timer_difference
;
4361 chosen_timer
= idle_timer
;
4362 idle_timers
= XCDR (idle_timers
);
4363 difference
= idle_timer_difference
;
4366 else if (! NILP (timers
))
4368 chosen_timer
= timer
;
4369 timers
= XCDR (timers
);
4370 difference
= timer_difference
;
4374 chosen_timer
= idle_timer
;
4375 idle_timers
= XCDR (idle_timers
);
4376 difference
= idle_timer_difference
;
4378 vector
= XVECTOR (chosen_timer
)->contents
;
4380 /* If timer is ripe, run it if it hasn't been run. */
4381 if (EMACS_TIME_NEG_P (difference
)
4382 || (EMACS_SECS (difference
) == 0
4383 && EMACS_USECS (difference
) == 0))
4385 if (NILP (vector
[0]))
4387 int was_locked
= single_kboard
;
4388 int count
= SPECPDL_INDEX ();
4389 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4391 /* Mark the timer as triggered to prevent problems if the lisp
4392 code fails to reschedule it right. */
4395 specbind (Qinhibit_quit
, Qt
);
4397 call1 (Qtimer_event_handler
, chosen_timer
);
4398 Vdeactivate_mark
= old_deactivate_mark
;
4400 unbind_to (count
, Qnil
);
4402 /* Resume allowing input from any kboard, if that was true before. */
4404 any_kboard_state ();
4406 /* Since we have handled the event,
4407 we don't need to tell the caller to wake up and do it. */
4411 /* When we encounter a timer that is still waiting,
4412 return the amount of time to wait before it is ripe. */
4419 /* No timers are pending in the future. */
4420 /* Return 0 if we generated an event, and -1 if not. */
4425 /* Caches for modify_event_symbol. */
4426 static Lisp_Object accent_key_syms
;
4427 static Lisp_Object func_key_syms
;
4428 static Lisp_Object mouse_syms
;
4429 static Lisp_Object wheel_syms
;
4430 static Lisp_Object drag_n_drop_syms
;
4432 /* This is a list of keysym codes for special "accent" characters.
4433 It parallels lispy_accent_keys. */
4435 static int lispy_accent_codes
[] =
4437 #ifdef XK_dead_circumflex
4442 #ifdef XK_dead_grave
4447 #ifdef XK_dead_tilde
4452 #ifdef XK_dead_diaeresis
4457 #ifdef XK_dead_macron
4462 #ifdef XK_dead_degree
4467 #ifdef XK_dead_acute
4472 #ifdef XK_dead_cedilla
4477 #ifdef XK_dead_breve
4482 #ifdef XK_dead_ogonek
4487 #ifdef XK_dead_caron
4492 #ifdef XK_dead_doubleacute
4493 XK_dead_doubleacute
,
4497 #ifdef XK_dead_abovedot
4502 #ifdef XK_dead_abovering
4512 #ifdef XK_dead_belowdot
4517 #ifdef XK_dead_voiced_sound
4518 XK_dead_voiced_sound
,
4522 #ifdef XK_dead_semivoiced_sound
4523 XK_dead_semivoiced_sound
,
4539 /* This is a list of Lisp names for special "accent" characters.
4540 It parallels lispy_accent_codes. */
4542 static char *lispy_accent_keys
[] =
4560 "dead-voiced-sound",
4561 "dead-semivoiced-sound",
4567 #define FUNCTION_KEY_OFFSET 0x0
4569 char *lispy_function_keys
[] =
4573 0, /* VK_LBUTTON 0x01 */
4574 0, /* VK_RBUTTON 0x02 */
4575 "cancel", /* VK_CANCEL 0x03 */
4576 0, /* VK_MBUTTON 0x04 */
4578 0, 0, 0, /* 0x05 .. 0x07 */
4580 "backspace", /* VK_BACK 0x08 */
4581 "tab", /* VK_TAB 0x09 */
4583 0, 0, /* 0x0A .. 0x0B */
4585 "clear", /* VK_CLEAR 0x0C */
4586 "return", /* VK_RETURN 0x0D */
4588 0, 0, /* 0x0E .. 0x0F */
4590 0, /* VK_SHIFT 0x10 */
4591 0, /* VK_CONTROL 0x11 */
4592 0, /* VK_MENU 0x12 */
4593 "pause", /* VK_PAUSE 0x13 */
4594 "capslock", /* VK_CAPITAL 0x14 */
4596 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4598 "escape", /* VK_ESCAPE 0x1B */
4600 0, 0, 0, 0, /* 0x1C .. 0x1F */
4602 0, /* VK_SPACE 0x20 */
4603 "prior", /* VK_PRIOR 0x21 */
4604 "next", /* VK_NEXT 0x22 */
4605 "end", /* VK_END 0x23 */
4606 "home", /* VK_HOME 0x24 */
4607 "left", /* VK_LEFT 0x25 */
4608 "up", /* VK_UP 0x26 */
4609 "right", /* VK_RIGHT 0x27 */
4610 "down", /* VK_DOWN 0x28 */
4611 "select", /* VK_SELECT 0x29 */
4612 "print", /* VK_PRINT 0x2A */
4613 "execute", /* VK_EXECUTE 0x2B */
4614 "snapshot", /* VK_SNAPSHOT 0x2C */
4615 "insert", /* VK_INSERT 0x2D */
4616 "delete", /* VK_DELETE 0x2E */
4617 "help", /* VK_HELP 0x2F */
4619 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4621 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4623 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4625 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4627 0, 0, 0, 0, 0, 0, 0, 0, 0,
4628 0, 0, 0, 0, 0, 0, 0, 0, 0,
4629 0, 0, 0, 0, 0, 0, 0, 0,
4631 "lwindow", /* VK_LWIN 0x5B */
4632 "rwindow", /* VK_RWIN 0x5C */
4633 "apps", /* VK_APPS 0x5D */
4635 0, 0, /* 0x5E .. 0x5F */
4637 "kp-0", /* VK_NUMPAD0 0x60 */
4638 "kp-1", /* VK_NUMPAD1 0x61 */
4639 "kp-2", /* VK_NUMPAD2 0x62 */
4640 "kp-3", /* VK_NUMPAD3 0x63 */
4641 "kp-4", /* VK_NUMPAD4 0x64 */
4642 "kp-5", /* VK_NUMPAD5 0x65 */
4643 "kp-6", /* VK_NUMPAD6 0x66 */
4644 "kp-7", /* VK_NUMPAD7 0x67 */
4645 "kp-8", /* VK_NUMPAD8 0x68 */
4646 "kp-9", /* VK_NUMPAD9 0x69 */
4647 "kp-multiply", /* VK_MULTIPLY 0x6A */
4648 "kp-add", /* VK_ADD 0x6B */
4649 "kp-separator", /* VK_SEPARATOR 0x6C */
4650 "kp-subtract", /* VK_SUBTRACT 0x6D */
4651 "kp-decimal", /* VK_DECIMAL 0x6E */
4652 "kp-divide", /* VK_DIVIDE 0x6F */
4653 "f1", /* VK_F1 0x70 */
4654 "f2", /* VK_F2 0x71 */
4655 "f3", /* VK_F3 0x72 */
4656 "f4", /* VK_F4 0x73 */
4657 "f5", /* VK_F5 0x74 */
4658 "f6", /* VK_F6 0x75 */
4659 "f7", /* VK_F7 0x76 */
4660 "f8", /* VK_F8 0x77 */
4661 "f9", /* VK_F9 0x78 */
4662 "f10", /* VK_F10 0x79 */
4663 "f11", /* VK_F11 0x7A */
4664 "f12", /* VK_F12 0x7B */
4665 "f13", /* VK_F13 0x7C */
4666 "f14", /* VK_F14 0x7D */
4667 "f15", /* VK_F15 0x7E */
4668 "f16", /* VK_F16 0x7F */
4669 "f17", /* VK_F17 0x80 */
4670 "f18", /* VK_F18 0x81 */
4671 "f19", /* VK_F19 0x82 */
4672 "f20", /* VK_F20 0x83 */
4673 "f21", /* VK_F21 0x84 */
4674 "f22", /* VK_F22 0x85 */
4675 "f23", /* VK_F23 0x86 */
4676 "f24", /* VK_F24 0x87 */
4678 0, 0, 0, 0, /* 0x88 .. 0x8B */
4679 0, 0, 0, 0, /* 0x8C .. 0x8F */
4681 "kp-numlock", /* VK_NUMLOCK 0x90 */
4682 "scroll", /* VK_SCROLL 0x91 */
4684 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4685 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4686 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4687 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4688 "kp-end", /* VK_NUMPAD_END 0x96 */
4689 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4690 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4691 "kp-up", /* VK_NUMPAD_UP 0x99 */
4692 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4693 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4694 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4695 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4697 0, 0, /* 0x9E .. 0x9F */
4700 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4701 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4702 * No other API or message will distinguish left and right keys this way.
4706 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4707 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4708 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4709 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4710 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4716 "attn", /* VK_ATTN 0xF6 */
4717 "crsel", /* VK_CRSEL 0xF7 */
4718 "exsel", /* VK_EXSEL 0xF8 */
4719 "ereof", /* VK_EREOF 0xF9 */
4720 "play", /* VK_PLAY 0xFA */
4721 "zoom", /* VK_ZOOM 0xFB */
4722 "noname", /* VK_NONAME 0xFC */
4723 "pa1", /* VK_PA1 0xFD */
4724 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4728 #else /* not HAVE_NTGUI */
4730 /* This should be dealt with in XTread_socket now, and that doesn't
4731 depend on the client system having the Kana syms defined. See also
4732 the XK_kana_A case below. */
4735 static char *lispy_kana_keys
[] =
4737 /* X Keysym value */
4738 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4739 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4740 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4741 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4742 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4743 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4744 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4745 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4746 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4747 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4748 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4749 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4750 "kana-i", "kana-u", "kana-e", "kana-o",
4751 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4752 "prolongedsound", "kana-A", "kana-I", "kana-U",
4753 "kana-E", "kana-O", "kana-KA", "kana-KI",
4754 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4755 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4756 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4757 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4758 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4759 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4760 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4761 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4762 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4763 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4764 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4765 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4767 #endif /* XK_kana_A */
4770 #define FUNCTION_KEY_OFFSET 0xff00
4772 /* You'll notice that this table is arranged to be conveniently
4773 indexed by X Windows keysym values. */
4774 static char *lispy_function_keys
[] =
4776 /* X Keysym value */
4778 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4779 "backspace", "tab", "linefeed", "clear",
4781 0, 0, 0, "pause", /* 0xff10...1f */
4782 0, 0, 0, 0, 0, 0, 0, "escape",
4784 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4785 "romaji", "hiragana", "katakana", "hiragana-katakana",
4786 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4787 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4788 "eisu-toggle", /* 0xff30...3f */
4789 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4790 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4792 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4793 "down", "prior", "next", "end",
4794 "begin", 0, 0, 0, 0, 0, 0, 0,
4795 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4806 "break", /* 0xff6b */
4809 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4810 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4811 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4812 0, 0, 0, 0, 0, 0, 0, 0,
4813 "kp-tab", /* 0xff89 */
4815 "kp-enter", /* 0xff8d */
4817 "kp-f1", /* 0xff91 */
4821 "kp-home", /* 0xff95 */
4826 "kp-prior", /* kp-page-up */
4827 "kp-next", /* kp-page-down */
4833 0, 0, 0, 0, 0, 0, 0, 0, 0,
4834 "kp-multiply", /* 0xffaa */
4839 "kp-divide", /* 0xffaf */
4840 "kp-0", /* 0xffb0 */
4841 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4844 "kp-equal", /* 0xffbd */
4845 "f1", /* 0xffbe */ /* IsFunctionKey */
4847 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4848 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4849 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4850 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4851 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4852 0, 0, 0, 0, 0, 0, 0, 0,
4853 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4854 0, 0, 0, 0, 0, 0, 0, "delete"
4857 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4858 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4860 static char *iso_lispy_function_keys
[] =
4862 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4863 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4864 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4865 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4866 "iso-lefttab", /* 0xfe20 */
4867 "iso-move-line-up", "iso-move-line-down",
4868 "iso-partial-line-up", "iso-partial-line-down",
4869 "iso-partial-space-left", "iso-partial-space-right",
4870 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4871 "iso-release-margin-left", "iso-release-margin-right",
4872 "iso-release-both-margins",
4873 "iso-fast-cursor-left", "iso-fast-cursor-right",
4874 "iso-fast-cursor-up", "iso-fast-cursor-down",
4875 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4876 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4879 #endif /* not HAVE_NTGUI */
4881 Lisp_Object Vlispy_mouse_stem
;
4883 static char *lispy_wheel_names
[] =
4885 "wheel-up", "wheel-down"
4888 /* drag-n-drop events are generated when a set of selected files are
4889 dragged from another application and dropped onto an Emacs window. */
4890 static char *lispy_drag_n_drop_names
[] =
4895 /* Scroll bar parts. */
4896 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4897 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4898 Lisp_Object Qtop
, Qratio
;
4900 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4901 Lisp_Object
*scroll_bar_parts
[] = {
4902 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4903 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4906 /* User signal events. */
4907 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4909 Lisp_Object
*lispy_user_signals
[] =
4911 &Qusr1_signal
, &Qusr2_signal
4915 /* A vector, indexed by button number, giving the down-going location
4916 of currently depressed buttons, both scroll bar and non-scroll bar.
4918 The elements have the form
4919 (BUTTON-NUMBER MODIFIER-MASK . REST)
4920 where REST is the cdr of a position as it would be reported in the event.
4922 The make_lispy_event function stores positions here to tell the
4923 difference between click and drag events, and to store the starting
4924 location to be included in drag events. */
4926 static Lisp_Object button_down_location
;
4928 /* Information about the most recent up-going button event: Which
4929 button, what location, and what time. */
4931 static int last_mouse_button
;
4932 static int last_mouse_x
;
4933 static int last_mouse_y
;
4934 static unsigned long button_down_time
;
4936 /* The maximum time between clicks to make a double-click, or Qnil to
4937 disable double-click detection, or Qt for no time limit. */
4939 Lisp_Object Vdouble_click_time
;
4941 /* Maximum number of pixels the mouse may be moved between clicks
4942 to make a double-click. */
4944 EMACS_INT double_click_fuzz
;
4946 /* The number of clicks in this multiple-click. */
4948 int double_click_count
;
4950 /* Return position of a mouse click or wheel event */
4953 make_lispy_position (f
, x
, y
, time
)
4959 enum window_part part
;
4960 Lisp_Object posn
= Qnil
;
4961 Lisp_Object extra_info
= Qnil
;
4964 /* Set `window' to the window under frame pixel coordinates (x,y) */
4966 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
4967 &part
, &wx
, &wy
, 0);
4971 if (WINDOWP (window
))
4973 /* It's a click in window window at frame coordinates (x,y) */
4974 struct window
*w
= XWINDOW (window
);
4975 Lisp_Object object
= Qnil
;
4976 int textpos
= -1, rx
= -1, ry
= -1;
4977 int dx
= -1, dy
= -1;
4979 /* Set event coordinates to window-relative coordinates
4980 for constructing the Lisp event below. */
4984 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
4986 /* Mode line or header line. Look for a string under
4987 the mouse that may have a `local-map' property. */
4991 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
4993 string
= mode_line_string (w
, &rx
, &ry
, &dx
, &dy
, part
, &charpos
);
4994 if (STRINGP (string
))
4995 object
= Fcons (string
, make_number (charpos
));
4996 if (w
== XWINDOW (selected_window
))
4999 textpos
= XMARKER (w
->pointm
)->charpos
;
5001 else if (part
== ON_VERTICAL_BORDER
)
5003 posn
= Qvertical_line
;
5007 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5012 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5014 string
= marginal_area_string (w
, &rx
, &ry
, &dx
, &dy
, part
, &charpos
);
5015 if (STRINGP (string
))
5016 object
= Fcons (string
, make_number (charpos
));
5017 #ifdef HAVE_WINDOW_SYSTEM
5018 else if (IMAGEP (string
))
5020 Lisp_Object image_map
, hotspot
;
5022 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5024 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5026 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5027 posn
= XCAR (hotspot
);
5031 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
5033 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
5036 if (part
== ON_RIGHT_FRINGE
)
5037 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5038 + window_box_width (w
, TEXT_AREA
)
5039 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5040 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5042 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5043 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5049 struct display_pos p
;
5051 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5052 buffer_posn_from_coords (w
, &wx
, &wy
, &dx2
, &dy2
, &string
, &p
);
5053 textpos
= CHARPOS (p
.pos
);
5054 if (rx
< 0) rx
= wx
;
5055 if (ry
< 0) ry
= wy
;
5056 if (dx
< 0) dx
= dx2
;
5057 if (dy
< 0) dy
= dy2
;
5061 posn
= make_number (textpos
);
5062 if (STRINGP (string
))
5063 object
= Fcons (string
,
5064 make_number (CHARPOS (p
.string_pos
)));
5065 #ifdef HAVE_WINDOW_SYSTEM
5066 else if (IMAGEP (string
))
5068 Lisp_Object image_map
, hotspot
;
5070 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5072 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5074 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5075 posn
= XCAR (hotspot
);
5081 extra_info
= Fcons (object
,
5082 Fcons (make_number (textpos
),
5083 Fcons (Fcons (make_number (rx
),
5085 Fcons (Fcons (make_number (dx
),
5091 XSETFRAME (window
, f
);
5096 XSETFASTINT (*x
, 0);
5097 XSETFASTINT (*y
, 0);
5100 return Fcons (window
,
5102 Fcons (Fcons (*x
, *y
),
5103 Fcons (make_number (time
),
5107 /* Given a struct input_event, build the lisp event which represents
5108 it. If EVENT is 0, build a mouse movement event from the mouse
5109 movement buffer, which should have a movement event in it.
5111 Note that events must be passed to this function in the order they
5112 are received; this function stores the location of button presses
5113 in order to build drag events when the button is released. */
5116 make_lispy_event (event
)
5117 struct input_event
*event
;
5121 switch (SWITCH_ENUM_CAST (event
->kind
))
5123 /* A simple keystroke. */
5124 case ASCII_KEYSTROKE_EVENT
:
5126 Lisp_Object lispy_c
;
5127 int c
= event
->code
& 0377;
5128 /* Turn ASCII characters into control characters
5130 if (event
->modifiers
& ctrl_modifier
)
5131 c
= make_ctrl_char (c
);
5133 /* Add in the other modifier bits. We took care of ctrl_modifier
5134 just above, and the shift key was taken care of by the X code,
5135 and applied to control characters by make_ctrl_char. */
5136 c
|= (event
->modifiers
5137 & (meta_modifier
| alt_modifier
5138 | hyper_modifier
| super_modifier
));
5139 /* Distinguish Shift-SPC from SPC. */
5140 if ((event
->code
& 0377) == 040
5141 && event
->modifiers
& shift_modifier
)
5142 c
|= shift_modifier
;
5143 button_down_time
= 0;
5144 XSETFASTINT (lispy_c
, c
);
5148 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5150 Lisp_Object lispy_c
;
5151 int c
= event
->code
;
5153 /* Add in the other modifier bits. We took care of ctrl_modifier
5154 just above, and the shift key was taken care of by the X code,
5155 and applied to control characters by make_ctrl_char. */
5156 c
|= (event
->modifiers
5157 & (meta_modifier
| alt_modifier
5158 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5159 /* What about the `shift' modifier ? */
5160 button_down_time
= 0;
5161 XSETFASTINT (lispy_c
, c
);
5165 /* A function key. The symbol may need to have modifier prefixes
5167 case NON_ASCII_KEYSTROKE_EVENT
:
5168 button_down_time
= 0;
5170 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5171 if (event
->code
== lispy_accent_codes
[i
])
5172 return modify_event_symbol (i
,
5174 Qfunction_key
, Qnil
,
5175 lispy_accent_keys
, &accent_key_syms
,
5176 (sizeof (lispy_accent_keys
)
5177 / sizeof (lispy_accent_keys
[0])));
5181 if (event
->code
>= 0x400 && event
->code
< 0x500)
5182 return modify_event_symbol (event
->code
- 0x400,
5183 event
->modifiers
& ~shift_modifier
,
5184 Qfunction_key
, Qnil
,
5185 lispy_kana_keys
, &func_key_syms
,
5186 (sizeof (lispy_kana_keys
)
5187 / sizeof (lispy_kana_keys
[0])));
5188 #endif /* XK_kana_A */
5191 #ifdef ISO_FUNCTION_KEY_OFFSET
5192 if (event
->code
< FUNCTION_KEY_OFFSET
5193 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5194 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5196 Qfunction_key
, Qnil
,
5197 iso_lispy_function_keys
, &func_key_syms
,
5198 (sizeof (iso_lispy_function_keys
)
5199 / sizeof (iso_lispy_function_keys
[0])));
5202 /* Handle system-specific or unknown keysyms. */
5203 if (event
->code
& (1 << 28)
5204 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5205 || (event
->code
- FUNCTION_KEY_OFFSET
5206 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5207 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5209 /* We need to use an alist rather than a vector as the cache
5210 since we can't make a vector long enuf. */
5211 if (NILP (current_kboard
->system_key_syms
))
5212 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5213 return modify_event_symbol (event
->code
,
5216 current_kboard
->Vsystem_key_alist
,
5217 0, ¤t_kboard
->system_key_syms
,
5221 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5223 Qfunction_key
, Qnil
,
5224 lispy_function_keys
, &func_key_syms
,
5225 (sizeof (lispy_function_keys
)
5226 / sizeof (lispy_function_keys
[0])));
5229 /* A mouse click. Figure out where it is, decide whether it's
5230 a press, click or drag, and build the appropriate structure. */
5231 case MOUSE_CLICK_EVENT
:
5232 #ifndef USE_TOOLKIT_SCROLL_BARS
5233 case SCROLL_BAR_CLICK_EVENT
:
5236 int button
= event
->code
;
5238 Lisp_Object position
;
5239 Lisp_Object
*start_pos_ptr
;
5240 Lisp_Object start_pos
;
5244 /* Build the position as appropriate for this mouse click. */
5245 if (event
->kind
== MOUSE_CLICK_EVENT
)
5247 struct frame
*f
= XFRAME (event
->frame_or_window
);
5248 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5252 /* Ignore mouse events that were made on frame that
5253 have been deleted. */
5254 if (! FRAME_LIVE_P (f
))
5257 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5258 /* EVENT->x and EVENT->y are frame-relative pixel
5259 coordinates at this place. Under old redisplay, COLUMN
5260 and ROW are set to frame relative glyph coordinates
5261 which are then used to determine whether this click is
5262 in a menu (non-toolkit version). */
5263 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5264 &column
, &row
, NULL
, 1);
5266 /* In the non-toolkit version, clicks on the menu bar
5267 are ordinary button events in the event buffer.
5268 Distinguish them, and invoke the menu.
5270 (In the toolkit version, the toolkit handles the menu bar
5271 and Emacs doesn't know about it until after the user
5272 makes a selection.) */
5273 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5274 && (event
->modifiers
& down_modifier
))
5276 Lisp_Object items
, item
;
5281 /* Activate the menu bar on the down event. If the
5282 up event comes in before the menu code can deal with it,
5284 if (! (event
->modifiers
& down_modifier
))
5288 /* Find the menu bar item under `column'. */
5290 items
= FRAME_MENU_BAR_ITEMS (f
);
5291 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5293 Lisp_Object pos
, string
;
5294 string
= AREF (items
, i
+ 1);
5295 pos
= AREF (items
, i
+ 3);
5298 if (column
>= XINT (pos
)
5299 && column
< XINT (pos
) + SCHARS (string
))
5301 item
= AREF (items
, i
);
5306 /* ELisp manual 2.4b says (x y) are window relative but
5307 code says they are frame-relative. */
5309 = Fcons (event
->frame_or_window
,
5311 Fcons (Fcons (event
->x
, event
->y
),
5312 Fcons (make_number (event
->timestamp
),
5315 return Fcons (item
, Fcons (position
, Qnil
));
5317 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5319 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5322 #ifndef USE_TOOLKIT_SCROLL_BARS
5325 /* It's a scrollbar click. */
5327 Lisp_Object portion_whole
;
5330 window
= event
->frame_or_window
;
5331 portion_whole
= Fcons (event
->x
, event
->y
);
5332 part
= *scroll_bar_parts
[(int) event
->part
];
5336 Fcons (Qvertical_scroll_bar
,
5337 Fcons (portion_whole
,
5338 Fcons (make_number (event
->timestamp
),
5339 Fcons (part
, Qnil
)))));
5341 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5343 if (button
>= ASIZE (button_down_location
))
5345 button_down_location
= larger_vector (button_down_location
,
5347 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5350 start_pos_ptr
= &AREF (button_down_location
, button
);
5351 start_pos
= *start_pos_ptr
;
5352 *start_pos_ptr
= Qnil
;
5355 /* On window-system frames, use the value of
5356 double-click-fuzz as is. On other frames, interpret it
5357 as a multiple of 1/8 characters. */
5361 if (WINDOWP (event
->frame_or_window
))
5362 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5363 else if (FRAMEP (event
->frame_or_window
))
5364 f
= XFRAME (event
->frame_or_window
);
5368 if (FRAME_WINDOW_P (f
))
5369 fuzz
= double_click_fuzz
;
5371 fuzz
= double_click_fuzz
/ 8;
5373 is_double
= (button
== last_mouse_button
5374 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5375 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5376 && button_down_time
!= 0
5377 && (EQ (Vdouble_click_time
, Qt
)
5378 || (INTEGERP (Vdouble_click_time
)
5379 && ((int)(event
->timestamp
- button_down_time
)
5380 < XINT (Vdouble_click_time
)))));
5383 last_mouse_button
= button
;
5384 last_mouse_x
= XINT (event
->x
);
5385 last_mouse_y
= XINT (event
->y
);
5387 /* If this is a button press, squirrel away the location, so
5388 we can decide later whether it was a click or a drag. */
5389 if (event
->modifiers
& down_modifier
)
5393 double_click_count
++;
5394 event
->modifiers
|= ((double_click_count
> 2)
5399 double_click_count
= 1;
5400 button_down_time
= event
->timestamp
;
5401 *start_pos_ptr
= Fcopy_alist (position
);
5404 /* Now we're releasing a button - check the co-ordinates to
5405 see if this was a click or a drag. */
5406 else if (event
->modifiers
& up_modifier
)
5408 /* If we did not see a down before this up, ignore the up.
5409 Probably this happened because the down event chose a
5410 menu item. It would be an annoyance to treat the
5411 release of the button that chose the menu item as a
5414 if (!CONSP (start_pos
))
5417 event
->modifiers
&= ~up_modifier
;
5418 #if 0 /* Formerly we treated an up with no down as a click event. */
5419 if (!CONSP (start_pos
))
5420 event
->modifiers
|= click_modifier
;
5425 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5427 /* The third element of every position
5428 should be the (x,y) pair. */
5429 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5431 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5433 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5434 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5437 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5438 && ydiff
< double_click_fuzz
5439 && ydiff
> - double_click_fuzz
)
5440 /* Mouse hasn't moved (much). */
5441 event
->modifiers
|= click_modifier
;
5444 button_down_time
= 0;
5445 event
->modifiers
|= drag_modifier
;
5448 /* Don't check is_double; treat this as multiple
5449 if the down-event was multiple. */
5450 if (double_click_count
> 1)
5451 event
->modifiers
|= ((double_click_count
> 2)
5457 /* Every mouse event should either have the down_modifier or
5458 the up_modifier set. */
5462 /* Get the symbol we should use for the mouse click. */
5465 head
= modify_event_symbol (button
,
5467 Qmouse_click
, Vlispy_mouse_stem
,
5470 XVECTOR (mouse_syms
)->size
);
5471 if (event
->modifiers
& drag_modifier
)
5476 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5479 Fcons (make_number (double_click_count
),
5490 Lisp_Object position
;
5493 /* Build the position as appropriate for this mouse click. */
5494 struct frame
*f
= XFRAME (event
->frame_or_window
);
5496 /* Ignore wheel events that were made on frame that have been
5498 if (! FRAME_LIVE_P (f
))
5501 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5504 /* Set double or triple modifiers to indicate the wheel speed. */
5506 /* On window-system frames, use the value of
5507 double-click-fuzz as is. On other frames, interpret it
5508 as a multiple of 1/8 characters. */
5513 if (WINDOWP (event
->frame_or_window
))
5514 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5515 else if (FRAMEP (event
->frame_or_window
))
5516 f
= XFRAME (event
->frame_or_window
);
5520 if (FRAME_WINDOW_P (f
))
5521 fuzz
= double_click_fuzz
;
5523 fuzz
= double_click_fuzz
/ 8;
5525 is_double
= (last_mouse_button
< 0
5526 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5527 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5528 && button_down_time
!= 0
5529 && (EQ (Vdouble_click_time
, Qt
)
5530 || (INTEGERP (Vdouble_click_time
)
5531 && ((int)(event
->timestamp
- button_down_time
)
5532 < XINT (Vdouble_click_time
)))));
5535 double_click_count
++;
5536 event
->modifiers
|= ((double_click_count
> 2)
5542 double_click_count
= 1;
5543 event
->modifiers
|= click_modifier
;
5546 button_down_time
= event
->timestamp
;
5547 /* Use a negative value to distinguish wheel from mouse button. */
5548 last_mouse_button
= -1;
5549 last_mouse_x
= XINT (event
->x
);
5550 last_mouse_y
= XINT (event
->y
);
5556 if (event
->modifiers
& up_modifier
)
5558 /* Emit a wheel-up event. */
5559 event
->modifiers
&= ~up_modifier
;
5562 else if (event
->modifiers
& down_modifier
)
5564 /* Emit a wheel-down event. */
5565 event
->modifiers
&= ~down_modifier
;
5569 /* Every wheel event should either have the down_modifier or
5570 the up_modifier set. */
5573 /* Get the symbol we should use for the wheel event. */
5574 head
= modify_event_symbol (symbol_num
,
5580 ASIZE (wheel_syms
));
5583 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5586 Fcons (make_number (double_click_count
),
5595 #ifdef USE_TOOLKIT_SCROLL_BARS
5597 /* We don't have down and up events if using toolkit scroll bars,
5598 so make this always a click event. Store in the `part' of
5599 the Lisp event a symbol which maps to the following actions:
5601 `above_handle' page up
5602 `below_handle' page down
5606 `bottom' bottom of buffer
5607 `handle' thumb has been dragged.
5608 `end-scroll' end of interaction with scroll bar
5610 The incoming input_event contains in its `part' member an
5611 index of type `enum scroll_bar_part' which we can use as an
5612 index in scroll_bar_parts to get the appropriate symbol. */
5614 case SCROLL_BAR_CLICK_EVENT
:
5616 Lisp_Object position
, head
, window
, portion_whole
, part
;
5618 window
= event
->frame_or_window
;
5619 portion_whole
= Fcons (event
->x
, event
->y
);
5620 part
= *scroll_bar_parts
[(int) event
->part
];
5624 Fcons (Qvertical_scroll_bar
,
5625 Fcons (portion_whole
,
5626 Fcons (make_number (event
->timestamp
),
5627 Fcons (part
, Qnil
)))));
5629 /* Always treat scroll bar events as clicks. */
5630 event
->modifiers
|= click_modifier
;
5631 event
->modifiers
&= ~up_modifier
;
5633 if (event
->code
>= ASIZE (mouse_syms
))
5634 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5636 /* Get the symbol we should use for the mouse click. */
5637 head
= modify_event_symbol (event
->code
,
5642 XVECTOR (mouse_syms
)->size
);
5643 return Fcons (head
, Fcons (position
, Qnil
));
5646 #endif /* USE_TOOLKIT_SCROLL_BARS */
5649 case W32_SCROLL_BAR_CLICK_EVENT
:
5651 int button
= event
->code
;
5653 Lisp_Object position
;
5654 Lisp_Object
*start_pos_ptr
;
5655 Lisp_Object start_pos
;
5659 Lisp_Object portion_whole
;
5662 window
= event
->frame_or_window
;
5663 portion_whole
= Fcons (event
->x
, event
->y
);
5664 part
= *scroll_bar_parts
[(int) event
->part
];
5668 Fcons (Qvertical_scroll_bar
,
5669 Fcons (portion_whole
,
5670 Fcons (make_number (event
->timestamp
),
5671 Fcons (part
, Qnil
)))));
5674 /* Always treat W32 scroll bar events as clicks. */
5675 event
->modifiers
|= click_modifier
;
5678 /* Get the symbol we should use for the mouse click. */
5681 head
= modify_event_symbol (button
,
5686 XVECTOR (mouse_syms
)->size
);
5692 #endif /* WINDOWSNT */
5694 case DRAG_N_DROP_EVENT
:
5697 Lisp_Object head
, position
;
5700 /* The frame_or_window field should be a cons of the frame in
5701 which the event occurred and a list of the filenames
5703 if (! CONSP (event
->frame_or_window
))
5706 f
= XFRAME (XCAR (event
->frame_or_window
));
5707 files
= XCDR (event
->frame_or_window
);
5709 /* Ignore mouse events that were made on frames that
5710 have been deleted. */
5711 if (! FRAME_LIVE_P (f
))
5714 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5717 head
= modify_event_symbol (0, event
->modifiers
,
5719 lispy_drag_n_drop_names
,
5720 &drag_n_drop_syms
, 1);
5726 #endif /* HAVE_MOUSE */
5728 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5729 || defined (USE_GTK)
5730 case MENU_BAR_EVENT
:
5731 if (EQ (event
->arg
, event
->frame_or_window
))
5732 /* This is the prefix key. We translate this to
5733 `(menu_bar)' because the code in keyboard.c for menu
5734 events, which we use, relies on this. */
5735 return Fcons (Qmenu_bar
, Qnil
);
5739 case SELECT_WINDOW_EVENT
:
5740 /* Make an event (select-window (WINDOW)). */
5741 return Fcons (Qselect_window
,
5742 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5745 case TOOL_BAR_EVENT
:
5746 if (EQ (event
->arg
, event
->frame_or_window
))
5747 /* This is the prefix key. We translate this to
5748 `(tool_bar)' because the code in keyboard.c for tool bar
5749 events, which we use, relies on this. */
5750 return Fcons (Qtool_bar
, Qnil
);
5751 else if (SYMBOLP (event
->arg
))
5752 return apply_modifiers (event
->modifiers
, event
->arg
);
5755 case USER_SIGNAL_EVENT
:
5756 /* A user signal. */
5757 return *lispy_user_signals
[event
->code
];
5759 case SAVE_SESSION_EVENT
:
5760 return Qsave_session
;
5762 /* The 'kind' field of the event is something we don't recognize. */
5771 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5773 Lisp_Object bar_window
;
5774 enum scroll_bar_part part
;
5778 /* Is it a scroll bar movement? */
5779 if (frame
&& ! NILP (bar_window
))
5781 Lisp_Object part_sym
;
5783 part_sym
= *scroll_bar_parts
[(int) part
];
5784 return Fcons (Qscroll_bar_movement
,
5785 (Fcons (Fcons (bar_window
,
5786 Fcons (Qvertical_scroll_bar
,
5787 Fcons (Fcons (x
, y
),
5788 Fcons (make_number (time
),
5794 /* Or is it an ordinary mouse movement? */
5797 Lisp_Object position
;
5799 position
= make_lispy_position (frame
, &x
, &y
, time
);
5801 return Fcons (Qmouse_movement
,
5807 #endif /* HAVE_MOUSE */
5809 /* Construct a switch frame event. */
5811 make_lispy_switch_frame (frame
)
5814 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5817 /* Manipulating modifiers. */
5819 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5821 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5822 SYMBOL's name of the end of the modifiers; the string from this
5823 position is the unmodified symbol name.
5825 This doesn't use any caches. */
5828 parse_modifiers_uncached (symbol
, modifier_end
)
5836 CHECK_SYMBOL (symbol
);
5839 name
= SYMBOL_NAME (symbol
);
5841 for (i
= 0; i
+2 <= SBYTES (name
); )
5843 int this_mod_end
= 0;
5846 /* See if the name continues with a modifier word.
5847 Check that the word appears, but don't check what follows it.
5848 Set this_mod and this_mod_end to record what we find. */
5850 switch (SREF (name
, i
))
5852 #define SINGLE_LETTER_MOD(BIT) \
5853 (this_mod_end = i + 1, this_mod = BIT)
5856 SINGLE_LETTER_MOD (alt_modifier
);
5860 SINGLE_LETTER_MOD (ctrl_modifier
);
5864 SINGLE_LETTER_MOD (hyper_modifier
);
5868 SINGLE_LETTER_MOD (meta_modifier
);
5872 SINGLE_LETTER_MOD (shift_modifier
);
5876 SINGLE_LETTER_MOD (super_modifier
);
5879 #undef SINGLE_LETTER_MOD
5881 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5882 if (i + LEN + 1 <= SBYTES (name) \
5883 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5885 this_mod_end = i + LEN; \
5890 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5891 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5892 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5896 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5898 #undef MULTI_LETTER_MOD
5902 /* If we found no modifier, stop looking for them. */
5903 if (this_mod_end
== 0)
5906 /* Check there is a dash after the modifier, so that it
5907 really is a modifier. */
5908 if (this_mod_end
>= SBYTES (name
)
5909 || SREF (name
, this_mod_end
) != '-')
5912 /* This modifier is real; look for another. */
5913 modifiers
|= this_mod
;
5914 i
= this_mod_end
+ 1;
5917 /* Should we include the `click' modifier? */
5918 if (! (modifiers
& (down_modifier
| drag_modifier
5919 | double_modifier
| triple_modifier
))
5920 && i
+ 7 == SBYTES (name
)
5921 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5922 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5923 modifiers
|= click_modifier
;
5931 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5932 prepended to the string BASE[0..BASE_LEN-1].
5933 This doesn't use any caches. */
5935 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5938 int base_len
, base_len_byte
;
5940 /* Since BASE could contain nulls, we can't use intern here; we have
5941 to use Fintern, which expects a genuine Lisp_String, and keeps a
5944 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5950 /* Only the event queue may use the `up' modifier; it should always
5951 be turned into a click or drag event before presented to lisp code. */
5952 if (modifiers
& up_modifier
)
5955 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5956 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5957 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5958 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5959 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5960 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5961 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5962 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5963 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5964 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5965 /* The click modifier is denoted by the absence of other modifiers. */
5969 mod_len
= p
- new_mods
;
5973 Lisp_Object new_name
;
5975 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5976 mod_len
+ base_len_byte
);
5977 bcopy (new_mods
, SDATA (new_name
), mod_len
);
5978 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
5980 return Fintern (new_name
, Qnil
);
5985 static char *modifier_names
[] =
5987 "up", "down", "drag", "click", "double", "triple", 0, 0,
5988 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5989 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5991 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5993 static Lisp_Object modifier_symbols
;
5995 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5997 lispy_modifier_list (modifiers
)
6000 Lisp_Object modifier_list
;
6003 modifier_list
= Qnil
;
6004 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6005 if (modifiers
& (1<<i
))
6006 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6009 return modifier_list
;
6013 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6014 where UNMODIFIED is the unmodified form of SYMBOL,
6015 MASK is the set of modifiers present in SYMBOL's name.
6016 This is similar to parse_modifiers_uncached, but uses the cache in
6017 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6018 Qevent_symbol_elements property. */
6021 parse_modifiers (symbol
)
6024 Lisp_Object elements
;
6026 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6027 if (CONSP (elements
))
6032 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6033 Lisp_Object unmodified
;
6036 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6037 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6040 if (modifiers
& ~INTMASK
)
6042 XSETFASTINT (mask
, modifiers
);
6043 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6045 /* Cache the parsing results on SYMBOL. */
6046 Fput (symbol
, Qevent_symbol_element_mask
,
6048 Fput (symbol
, Qevent_symbol_elements
,
6049 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6051 /* Since we know that SYMBOL is modifiers applied to unmodified,
6052 it would be nice to put that in unmodified's cache.
6053 But we can't, since we're not sure that parse_modifiers is
6060 /* Apply the modifiers MODIFIERS to the symbol BASE.
6061 BASE must be unmodified.
6063 This is like apply_modifiers_uncached, but uses BASE's
6064 Qmodifier_cache property, if present. It also builds
6065 Qevent_symbol_elements properties, since it has that info anyway.
6067 apply_modifiers copies the value of BASE's Qevent_kind property to
6068 the modified symbol. */
6070 apply_modifiers (modifiers
, base
)
6074 Lisp_Object cache
, index
, entry
, new_symbol
;
6076 /* Mask out upper bits. We don't know where this value's been. */
6077 modifiers
&= INTMASK
;
6079 /* The click modifier never figures into cache indices. */
6080 cache
= Fget (base
, Qmodifier_cache
);
6081 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6082 entry
= assq_no_quit (index
, cache
);
6085 new_symbol
= XCDR (entry
);
6088 /* We have to create the symbol ourselves. */
6089 new_symbol
= apply_modifiers_uncached (modifiers
,
6090 SDATA (SYMBOL_NAME (base
)),
6091 SCHARS (SYMBOL_NAME (base
)),
6092 SBYTES (SYMBOL_NAME (base
)));
6094 /* Add the new symbol to the base's cache. */
6095 entry
= Fcons (index
, new_symbol
);
6096 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6098 /* We have the parsing info now for free, so we could add it to
6100 XSETFASTINT (index, modifiers);
6101 Fput (new_symbol, Qevent_symbol_element_mask,
6102 Fcons (base, Fcons (index, Qnil)));
6103 Fput (new_symbol, Qevent_symbol_elements,
6104 Fcons (base, lispy_modifier_list (modifiers)));
6105 Sadly, this is only correct if `base' is indeed a base event,
6106 which is not necessarily the case. -stef */
6109 /* Make sure this symbol is of the same kind as BASE.
6111 You'd think we could just set this once and for all when we
6112 intern the symbol above, but reorder_modifiers may call us when
6113 BASE's property isn't set right; we can't assume that just
6114 because it has a Qmodifier_cache property it must have its
6115 Qevent_kind set right as well. */
6116 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6120 kind
= Fget (base
, Qevent_kind
);
6122 Fput (new_symbol
, Qevent_kind
, kind
);
6129 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6130 return a symbol with the modifiers placed in the canonical order.
6131 Canonical order is alphabetical, except for down and drag, which
6132 always come last. The 'click' modifier is never written out.
6134 Fdefine_key calls this to make sure that (for example) C-M-foo
6135 and M-C-foo end up being equivalent in the keymap. */
6138 reorder_modifiers (symbol
)
6141 /* It's hopefully okay to write the code this way, since everything
6142 will soon be in caches, and no consing will be done at all. */
6145 parsed
= parse_modifiers (symbol
);
6146 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6151 /* For handling events, we often want to produce a symbol whose name
6152 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6153 to some base, like the name of a function key or mouse button.
6154 modify_event_symbol produces symbols of this sort.
6156 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6157 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6160 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6161 into symbol names, or a string specifying a name stem used to
6162 construct a symbol name or the form `STEM-N', where N is the decimal
6163 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6164 non-nil; otherwise NAME_TABLE is used.
6166 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6167 persist between calls to modify_event_symbol that it can use to
6168 store a cache of the symbols it's generated for this NAME_TABLE
6169 before. The object stored there may be a vector or an alist.
6171 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6173 MODIFIERS is a set of modifier bits (as given in struct input_events)
6174 whose prefixes should be applied to the symbol name.
6176 SYMBOL_KIND is the value to be placed in the event_kind property of
6177 the returned symbol.
6179 The symbols we create are supposed to have an
6180 `event-symbol-elements' property, which lists the modifiers present
6181 in the symbol's name. */
6184 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6185 name_table
, symbol_table
, table_size
)
6188 Lisp_Object symbol_kind
;
6189 Lisp_Object name_alist_or_stem
;
6191 Lisp_Object
*symbol_table
;
6192 unsigned int table_size
;
6195 Lisp_Object symbol_int
;
6197 /* Get rid of the "vendor-specific" bit here. */
6198 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6200 /* Is this a request for a valid symbol? */
6201 if (symbol_num
< 0 || symbol_num
>= table_size
)
6204 if (CONSP (*symbol_table
))
6205 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6207 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6208 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6209 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6210 we've never used that symbol before. */
6213 if (! VECTORP (*symbol_table
)
6214 || XVECTOR (*symbol_table
)->size
!= table_size
)
6218 XSETFASTINT (size
, table_size
);
6219 *symbol_table
= Fmake_vector (size
, Qnil
);
6222 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6225 /* Have we already used this symbol before? */
6228 /* No; let's create it. */
6229 if (CONSP (name_alist_or_stem
))
6230 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6231 else if (STRINGP (name_alist_or_stem
))
6233 int len
= SBYTES (name_alist_or_stem
);
6234 char *buf
= (char *) alloca (len
+ 50);
6235 if (sizeof (int) == sizeof (EMACS_INT
))
6236 sprintf (buf
, "%s-%d", SDATA (name_alist_or_stem
),
6237 XINT (symbol_int
) + 1);
6238 else if (sizeof (long) == sizeof (EMACS_INT
))
6239 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6240 XINT (symbol_int
) + 1);
6241 value
= intern (buf
);
6243 else if (name_table
!= 0 && name_table
[symbol_num
])
6244 value
= intern (name_table
[symbol_num
]);
6246 #ifdef HAVE_WINDOW_SYSTEM
6249 char *name
= x_get_keysym_name (symbol_num
);
6251 value
= intern (name
);
6258 sprintf (buf
, "key-%d", symbol_num
);
6259 value
= intern (buf
);
6262 if (CONSP (*symbol_table
))
6263 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6265 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6267 /* Fill in the cache entries for this symbol; this also
6268 builds the Qevent_symbol_elements property, which the user
6270 apply_modifiers (modifiers
& click_modifier
, value
);
6271 Fput (value
, Qevent_kind
, symbol_kind
);
6274 /* Apply modifiers to that symbol. */
6275 return apply_modifiers (modifiers
, value
);
6278 /* Convert a list that represents an event type,
6279 such as (ctrl meta backspace), into the usual representation of that
6280 event type as a number or a symbol. */
6282 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6283 doc
: /* Convert the event description list EVENT-DESC to an event type.
6284 EVENT-DESC should contain one base event type (a character or symbol)
6285 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6286 drag, down, double or triple). The base must be last.
6287 The return value is an event type (a character or symbol) which
6288 has the same base event type and all the specified modifiers. */)
6290 Lisp_Object event_desc
;
6298 while (CONSP (rest
))
6306 /* Given a symbol, see if it is a modifier name. */
6307 if (SYMBOLP (elt
) && CONSP (rest
))
6308 this = parse_solitary_modifier (elt
);
6312 else if (!NILP (base
))
6313 error ("Two bases given in one event");
6319 /* Let the symbol A refer to the character A. */
6320 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6321 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6323 if (INTEGERP (base
))
6325 /* Turn (shift a) into A. */
6326 if ((modifiers
& shift_modifier
) != 0
6327 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6329 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6330 modifiers
&= ~shift_modifier
;
6333 /* Turn (control a) into C-a. */
6334 if (modifiers
& ctrl_modifier
)
6335 return make_number ((modifiers
& ~ctrl_modifier
)
6336 | make_ctrl_char (XINT (base
)));
6338 return make_number (modifiers
| XINT (base
));
6340 else if (SYMBOLP (base
))
6341 return apply_modifiers (modifiers
, base
);
6344 error ("Invalid base event");
6349 /* Try to recognize SYMBOL as a modifier name.
6350 Return the modifier flag bit, or 0 if not recognized. */
6353 parse_solitary_modifier (symbol
)
6356 Lisp_Object name
= SYMBOL_NAME (symbol
);
6358 switch (SREF (name
, 0))
6360 #define SINGLE_LETTER_MOD(BIT) \
6361 if (SBYTES (name) == 1) \
6364 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6365 if (LEN == SBYTES (name) \
6366 && ! strncmp (SDATA (name), NAME, LEN)) \
6370 SINGLE_LETTER_MOD (alt_modifier
);
6374 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6378 SINGLE_LETTER_MOD (ctrl_modifier
);
6382 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6383 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6387 SINGLE_LETTER_MOD (hyper_modifier
);
6391 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6395 SINGLE_LETTER_MOD (meta_modifier
);
6399 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6403 SINGLE_LETTER_MOD (shift_modifier
);
6407 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6408 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6409 SINGLE_LETTER_MOD (super_modifier
);
6413 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6414 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6415 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6419 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6422 #undef SINGLE_LETTER_MOD
6423 #undef MULTI_LETTER_MOD
6429 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6430 Such a list is not valid as an event,
6431 but it can be a Lucid-style event type list. */
6434 lucid_event_type_list_p (object
)
6439 if (! CONSP (object
))
6442 if (EQ (XCAR (object
), Qhelp_echo
)
6443 || EQ (XCAR (object
), Qvertical_line
)
6444 || EQ (XCAR (object
), Qmode_line
)
6445 || EQ (XCAR (object
), Qheader_line
))
6448 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6452 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6459 /* Store into *addr a value nonzero if terminal input chars are available.
6460 Serves the purpose of ioctl (0, FIONREAD, addr)
6461 but works even if FIONREAD does not exist.
6462 (In fact, this may actually read some input.)
6464 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6465 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6468 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6473 /* First of all, have we already counted some input? */
6474 *addr
= (!NILP (Vquit_flag
)
6475 || readable_filtered_events (do_timers_now
, filter_events
));
6477 /* If input is being read as it arrives, and we have none, there is none. */
6478 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6481 /* Try to read some input and see how much we get. */
6483 *addr
= (!NILP (Vquit_flag
)
6484 || readable_filtered_events (do_timers_now
, filter_events
));
6487 /* Store into *addr a value nonzero if terminal input chars are available.
6488 Serves the purpose of ioctl (0, FIONREAD, addr)
6489 but works even if FIONREAD does not exist.
6490 (In fact, this may actually read some input.)
6492 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6495 get_input_pending (addr
, do_timers_now
)
6499 get_filtered_input_pending (addr
, do_timers_now
, 0);
6502 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6505 gobble_input (expected
)
6510 if (interrupt_input
)
6513 mask
= sigblock (sigmask (SIGIO
));
6514 read_avail_input (expected
);
6518 #ifdef POLL_FOR_INPUT
6519 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6522 mask
= sigblock (sigmask (SIGALRM
));
6523 read_avail_input (expected
);
6529 read_avail_input (expected
);
6533 /* Put a BUFFER_SWITCH_EVENT in the buffer
6534 so that read_key_sequence will notice the new current buffer. */
6537 record_asynch_buffer_change ()
6539 struct input_event event
;
6543 event
.kind
= BUFFER_SWITCH_EVENT
;
6544 event
.frame_or_window
= Qnil
;
6548 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6549 The purpose of the event is to make read_key_sequence look up the
6550 keymaps again. If we aren't in read_key_sequence, we don't need one,
6551 and the event could cause trouble by messing up (input-pending-p). */
6552 tem
= Fwaiting_for_user_input_p ();
6556 /* We never need these events if we have no asynchronous subprocesses. */
6560 /* Make sure no interrupt happens while storing the event. */
6562 if (interrupt_input
)
6565 mask
= sigblock (sigmask (SIGIO
));
6566 kbd_buffer_store_event (&event
);
6573 kbd_buffer_store_event (&event
);
6580 /* Read any terminal input already buffered up by the system
6581 into the kbd_buffer, but do not wait.
6583 EXPECTED should be nonzero if the caller knows there is some input.
6585 Except on VMS, all input is read by this function.
6586 If interrupt_input is nonzero, this function MUST be called
6587 only when SIGIO is blocked.
6589 Returns the number of keyboard chars read, or -1 meaning
6590 this is a bad time to try to read input. */
6593 read_avail_input (expected
)
6596 struct input_event buf
[KBD_BUFFER_SIZE
];
6600 for (i
= 0; i
< KBD_BUFFER_SIZE
; i
++)
6601 EVENT_INIT (buf
[i
]);
6603 if (read_socket_hook
)
6604 /* No need for FIONREAD or fcntl; just say don't wait. */
6605 nread
= (*read_socket_hook
) (buf
, KBD_BUFFER_SIZE
, expected
);
6607 if (!nread
&& tty_list
)
6609 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6610 the kbd_buffer can really hold. That may prevent loss
6611 of characters on some systems when input is stuffed at us. */
6612 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6614 struct tty_display_info
*tty
;
6619 #else /* not WINDOWSNT */
6621 n_to_read
= dos_keysns ();
6625 cbuf
[0] = dos_keyread ();
6628 #else /* not MSDOS */
6632 /* Try to read from each available tty, until one succeeds. */
6633 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
6635 if (! tty
->term_initted
)
6638 /* Determine how many characters we should *try* to read. */
6640 /* Find out how much input is available. */
6641 if (ioctl (fileno (TTY_INPUT (tty
)), FIONREAD
, &n_to_read
) < 0)
6643 /* Formerly simply reported no input, but that sometimes led to
6644 a failure of Emacs to terminate.
6645 SIGHUP seems appropriate if we can't reach the terminal. */
6646 /* ??? Is it really right to send the signal just to this process
6647 rather than to the whole process group?
6648 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6649 /* It appears to be the case, see narrow_foreground_group. */
6650 if (! noninteractive
)
6652 if (! tty_list
->next
)
6653 kill (getpid (), SIGHUP
); /* This was the last terminal. */
6655 n_to_read
= 0; /* XXX tty should be closed here. */
6664 if (n_to_read
> sizeof cbuf
)
6665 n_to_read
= sizeof cbuf
;
6666 #else /* no FIONREAD */
6667 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6668 /* Read some input if available, but don't wait. */
6669 n_to_read
= sizeof cbuf
;
6670 fcntl (fileno (TTY_INPUT (tty
)), F_SETFL
, O_NDELAY
);
6676 /* Now read; for one reason or another, this will not block.
6677 NREAD is set to the number of chars read. */
6680 nread
= emacs_read (fileno (TTY_INPUT (tty
)), cbuf
, n_to_read
);
6681 /* POSIX infers that processes which are not in the session leader's
6682 process group won't get SIGHUP's at logout time. BSDI adheres to
6683 this part standard and returns -1 from read (0) with errno==EIO
6684 when the control tty is taken away.
6685 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6686 if (nread
== -1 && errno
== EIO
)
6688 if (! tty_list
->next
)
6689 kill (0, SIGHUP
); /* This was the last terminal. */
6691 delete_tty (tty
); /* XXX I wonder if this is safe here. */
6693 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6694 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6695 This looks incorrect, but it isn't, because _BSD causes
6696 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6697 and that causes a value other than 0 when there is no input. */
6700 if (! tty_list
->next
)
6701 kill (0, SIGHUP
); /* This was the last terminal. */
6703 delete_tty (tty
); /* XXX I wonder if this is safe here. */
6708 /* We used to retry the read if it was interrupted.
6709 But this does the wrong thing when O_NDELAY causes
6710 an EAGAIN error. Does anybody know of a situation
6711 where a retry is actually needed? */
6713 nread
< 0 && (errno
== EAGAIN
6727 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6728 fcntl (fileno (TTY_INPUT (tty
)), F_SETFL
, 0);
6729 #endif /* USG or DGUX or CYGWIN */
6730 #endif /* no FIONREAD */
6734 } /* for each tty */
6739 #endif /* not MSDOS */
6740 #endif /* not WINDOWSNT */
6745 /* Select frame corresponding to the active tty. Note that the
6746 value of selected_frame is not reliable here, redisplay tends
6747 to temporarily change it. But tty should always be non-NULL. */
6748 frame
= tty
->top_frame
;
6750 for (i
= 0; i
< nread
; i
++)
6752 buf
[i
].kind
= ASCII_KEYSTROKE_EVENT
;
6753 buf
[i
].modifiers
= 0;
6754 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
6755 buf
[i
].modifiers
= meta_modifier
;
6756 if (tty
->meta_key
!= 2)
6759 buf
[i
].code
= cbuf
[i
];
6760 buf
[i
].frame_or_window
= frame
;
6765 /* Scan the chars for C-g and store them in kbd_buffer. */
6766 for (i
= 0; i
< nread
; i
++)
6768 kbd_buffer_store_event (&buf
[i
]);
6769 /* Don't look at input that follows a C-g too closely.
6770 This reduces lossage due to autorepeat on C-g. */
6771 if (buf
[i
].kind
== ASCII_KEYSTROKE_EVENT
6772 && buf
[i
].code
== quit_char
)
6778 #endif /* not VMS */
6780 #ifdef SIGIO /* for entire page */
6781 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6784 input_available_signal (signo
)
6787 /* Must preserve main program's value of errno. */
6788 int old_errno
= errno
;
6790 extern int select_alarmed
;
6793 #if defined (USG) && !defined (POSIX_SIGNALS)
6794 /* USG systems forget handlers when they are used;
6795 must reestablish each time */
6796 signal (signo
, input_available_signal
);
6803 if (input_available_clear_time
)
6804 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6809 nread
= read_avail_input (1);
6810 /* -1 means it's not ok to read the input now.
6811 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6812 0 means there was no keyboard input available. */
6817 select_alarmed
= 1; /* Force the select emulator back to life */
6828 /* Send ourselves a SIGIO.
6830 This function exists so that the UNBLOCK_INPUT macro in
6831 blockinput.h can have some way to take care of input we put off
6832 dealing with, without assuming that every file which uses
6833 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6835 reinvoke_input_signal ()
6838 kill (getpid (), SIGIO
);
6844 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6845 static Lisp_Object menu_bar_one_keymap_changed_items
;
6847 /* These variables hold the vector under construction within
6848 menu_bar_items and its subroutines, and the current index
6849 for storing into that vector. */
6850 static Lisp_Object menu_bar_items_vector
;
6851 static int menu_bar_items_index
;
6853 /* Return a vector of menu items for a menu bar, appropriate
6854 to the current buffer. Each item has three elements in the vector:
6857 OLD is an old vector we can optionally reuse, or nil. */
6860 menu_bar_items (old
)
6863 /* The number of keymaps we're scanning right now, and the number of
6864 keymaps we have allocated space for. */
6867 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6868 in the current keymaps, or nil where it is not a prefix. */
6871 Lisp_Object def
, tail
;
6880 struct gcpro gcpro1
;
6882 /* In order to build the menus, we need to call the keymap
6883 accessors. They all call QUIT. But this function is called
6884 during redisplay, during which a quit is fatal. So inhibit
6885 quitting while building the menus.
6886 We do this instead of specbind because (1) errors will clear it anyway
6887 and (2) this avoids risk of specpdl overflow. */
6888 oquit
= Vinhibit_quit
;
6892 menu_bar_items_vector
= old
;
6894 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6895 menu_bar_items_index
= 0;
6897 GCPRO1 (menu_bar_items_vector
);
6899 /* Build our list of keymaps.
6900 If we recognize a function key and replace its escape sequence in
6901 keybuf with its symbol, or if the sequence starts with a mouse
6902 click and we need to switch buffers, we jump back here to rebuild
6903 the initial keymaps from the current buffer. */
6907 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6908 if (!NILP (Voverriding_local_map_menu_flag
))
6910 /* Yes, use them (if non-nil) as well as the global map. */
6911 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6913 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6914 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6915 if (!NILP (Voverriding_local_map
))
6916 maps
[nmaps
++] = Voverriding_local_map
;
6920 /* No, so use major and minor mode keymaps and keymap property.
6921 Note that menu-bar bindings in the local-map and keymap
6922 properties may not work reliable, as they are only
6923 recognized when the menu-bar (or mode-line) is updated,
6924 which does not normally happen after every command. */
6927 nminor
= current_minor_maps (NULL
, &tmaps
);
6928 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6930 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6931 maps
[nmaps
++] = tem
;
6932 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6934 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6936 maps
[nmaps
++] = current_global_map
;
6939 /* Look up in each map the dummy prefix key `menu-bar'. */
6943 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6944 if (!NILP (maps
[mapno
]))
6946 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6950 menu_bar_one_keymap_changed_items
= Qnil
;
6951 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
6955 /* Move to the end those items that should be at the end. */
6957 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6960 int end
= menu_bar_items_index
;
6962 for (i
= 0; i
< end
; i
+= 4)
6963 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6965 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6966 /* Move the item at index I to the end,
6967 shifting all the others forward. */
6968 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6969 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6970 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6971 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6973 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6974 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6975 (end
- i
- 4) * sizeof (Lisp_Object
));
6976 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6977 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6978 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6979 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6984 /* Add nil, nil, nil, nil at the end. */
6985 i
= menu_bar_items_index
;
6986 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6989 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6990 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6991 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6992 menu_bar_items_vector
= tem
;
6994 /* Add this item. */
6995 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6996 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6997 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6998 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6999 menu_bar_items_index
= i
;
7001 Vinhibit_quit
= oquit
;
7003 return menu_bar_items_vector
;
7006 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7007 If there's already an item for KEY, add this DEF to it. */
7009 Lisp_Object item_properties
;
7012 menu_bar_item (key
, item
, dummy1
, dummy2
)
7013 Lisp_Object key
, item
, dummy1
;
7016 struct gcpro gcpro1
;
7020 if (EQ (item
, Qundefined
))
7022 /* If a map has an explicit `undefined' as definition,
7023 discard any previously made menu bar item. */
7025 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7026 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7028 if (menu_bar_items_index
> i
+ 4)
7029 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7030 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7031 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7032 menu_bar_items_index
-= 4;
7036 /* If this keymap has already contributed to this KEY,
7037 don't contribute to it a second time. */
7038 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7039 if (!NILP (tem
) || NILP (item
))
7042 menu_bar_one_keymap_changed_items
7043 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7045 /* We add to menu_bar_one_keymap_changed_items before doing the
7046 parse_menu_item, so that if it turns out it wasn't a menu item,
7047 it still correctly hides any further menu item. */
7049 i
= parse_menu_item (item
, 0, 1);
7054 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7056 /* Find any existing item for this KEY. */
7057 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7058 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7061 /* If we did not find this KEY, add it at the end. */
7062 if (i
== menu_bar_items_index
)
7064 /* If vector is too small, get a bigger one. */
7065 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7068 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7069 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7070 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7071 menu_bar_items_vector
= tem
;
7074 /* Add this item. */
7075 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7076 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7077 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7078 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7079 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7080 menu_bar_items_index
= i
;
7082 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7086 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7087 /* If the new and the old items are not both keymaps,
7088 the lookup will only find `item'. */
7089 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7090 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7094 /* This is used as the handler when calling menu_item_eval_property. */
7096 menu_item_eval_property_1 (arg
)
7099 /* If we got a quit from within the menu computation,
7100 quit all the way out of it. This takes care of C-] in the debugger. */
7101 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7102 Fsignal (Qquit
, Qnil
);
7107 /* Evaluate an expression and return the result (or nil if something
7108 went wrong). Used to evaluate dynamic parts of menu items. */
7110 menu_item_eval_property (sexpr
)
7113 int count
= SPECPDL_INDEX ();
7115 specbind (Qinhibit_redisplay
, Qt
);
7116 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7117 menu_item_eval_property_1
);
7118 return unbind_to (count
, val
);
7121 /* This function parses a menu item and leaves the result in the
7122 vector item_properties.
7123 ITEM is a key binding, a possible menu item.
7124 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7125 evaluate dynamic expressions in the menu item.
7126 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7128 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7129 parse_menu_item returns true if the item is a menu item and false
7133 parse_menu_item (item
, notreal
, inmenubar
)
7135 int notreal
, inmenubar
;
7137 Lisp_Object def
, tem
, item_string
, start
;
7138 Lisp_Object cachelist
;
7140 Lisp_Object keyhint
;
7151 /* Create item_properties vector if necessary. */
7152 if (NILP (item_properties
))
7154 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7156 /* Initialize optional entries. */
7157 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7158 AREF (item_properties
, i
) = Qnil
;
7159 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7161 /* Save the item here to protect it from GC. */
7162 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7164 item_string
= XCAR (item
);
7168 if (STRINGP (item_string
))
7170 /* Old format menu item. */
7171 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7173 /* Maybe help string. */
7174 if (CONSP (item
) && STRINGP (XCAR (item
)))
7176 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7181 /* Maybe key binding cache. */
7182 if (CONSP (item
) && CONSP (XCAR (item
))
7183 && (NILP (XCAR (XCAR (item
)))
7184 || VECTORP (XCAR (XCAR (item
)))))
7186 cachelist
= XCAR (item
);
7190 /* This is the real definition--the function to run. */
7191 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7193 /* Get enable property, if any. */
7196 tem
= Fget (item
, Qmenu_enable
);
7198 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7201 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7203 /* New format menu item. */
7204 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7205 start
= XCDR (item
);
7208 /* We have a real binding. */
7209 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7211 item
= XCDR (start
);
7212 /* Is there a cache list with key equivalences. */
7213 if (CONSP (item
) && CONSP (XCAR (item
)))
7215 cachelist
= XCAR (item
);
7219 /* Parse properties. */
7220 while (CONSP (item
) && CONSP (XCDR (item
)))
7225 if (EQ (tem
, QCenable
))
7226 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7227 else if (EQ (tem
, QCvisible
) && !notreal
)
7229 /* If got a visible property and that evaluates to nil
7230 then ignore this item. */
7231 tem
= menu_item_eval_property (XCAR (item
));
7235 else if (EQ (tem
, QChelp
))
7236 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7237 else if (EQ (tem
, QCfilter
))
7239 else if (EQ (tem
, QCkey_sequence
))
7242 if (NILP (cachelist
)
7243 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7244 /* Be GC protected. Set keyhint to item instead of tem. */
7247 else if (EQ (tem
, QCkeys
))
7250 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7251 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7253 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7258 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7260 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7262 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7269 else if (inmenubar
|| !NILP (start
))
7273 return 0; /* not a menu item */
7275 /* If item string is not a string, evaluate it to get string.
7276 If we don't get a string, skip this item. */
7277 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7278 if (!(STRINGP (item_string
) || notreal
))
7280 item_string
= menu_item_eval_property (item_string
);
7281 if (!STRINGP (item_string
))
7283 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7286 /* If got a filter apply it on definition. */
7287 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7290 def
= menu_item_eval_property (list2 (XCAR (filter
),
7291 list2 (Qquote
, def
)));
7293 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7296 /* Enable or disable selection of item. */
7297 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7303 tem
= menu_item_eval_property (tem
);
7304 if (inmenubar
&& NILP (tem
))
7305 return 0; /* Ignore disabled items in menu bar. */
7306 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7309 /* If we got no definition, this item is just unselectable text which
7310 is OK in a submenu but not in the menubar. */
7312 return (inmenubar
? 0 : 1);
7314 /* See if this is a separate pane or a submenu. */
7315 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7316 tem
= get_keymap (def
, 0, 1);
7317 /* For a subkeymap, just record its details and exit. */
7320 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7321 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7325 /* At the top level in the menu bar, do likewise for commands also.
7326 The menu bar does not display equivalent key bindings anyway.
7327 ITEM_PROPERTY_DEF is already set up properly. */
7331 /* This is a command. See if there is an equivalent key binding. */
7332 if (NILP (cachelist
))
7334 /* We have to create a cachelist. */
7335 CHECK_IMPURE (start
);
7336 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7337 cachelist
= XCAR (XCDR (start
));
7339 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7340 if (!NILP (keyhint
))
7342 XSETCAR (cachelist
, XCAR (keyhint
));
7345 else if (STRINGP (tem
))
7347 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7348 XSETCAR (cachelist
, Qt
);
7352 tem
= XCAR (cachelist
);
7359 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7361 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7364 def
= XCAR (prefix
);
7365 prefix
= XCDR (prefix
);
7368 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7370 if (!update_menu_bindings
)
7372 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7374 if (newcache
/* Always check first time. */
7375 /* Should we check everything when precomputing key
7377 /* If something had no key binding before, don't recheck it
7378 because that is too slow--except if we have a list of
7379 rebound commands in Vdefine_key_rebound_commands, do
7380 recheck any command that appears in that list. */
7381 || (CONSP (Vdefine_key_rebound_commands
)
7382 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7385 /* We had a saved key. Is it still bound to the command? */
7388 /* If the command is an alias for another
7389 (such as lmenu.el set it up), check if the
7390 original command matches the cached command. */
7391 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7392 chkcache
= 1; /* Need to recompute key binding. */
7396 /* Recompute equivalent key binding. If the command is an alias
7397 for another (such as lmenu.el set it up), see if the original
7398 command name has equivalent keys. Otherwise look up the
7399 specified command itself. We don't try both, because that
7400 makes lmenu menus slow. */
7402 && SYMBOLP (XSYMBOL (def
)->function
)
7403 && ! NILP (Fget (def
, Qmenu_alias
)))
7404 def
= XSYMBOL (def
)->function
;
7405 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7406 XSETCAR (cachelist
, tem
);
7409 XSETCDR (cachelist
, Qnil
);
7413 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7415 tem
= XCAR (cachelist
);
7419 newcache
= chkcache
;
7422 tem
= Fkey_description (tem
);
7425 if (STRINGP (XCAR (prefix
)))
7426 tem
= concat2 (XCAR (prefix
), tem
);
7427 if (STRINGP (XCDR (prefix
)))
7428 tem
= concat2 (tem
, XCDR (prefix
));
7430 XSETCDR (cachelist
, tem
);
7434 tem
= XCDR (cachelist
);
7435 if (newcache
&& !NILP (tem
))
7437 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7438 XSETCDR (cachelist
, tem
);
7441 /* If we only want to precompute equivalent key bindings, stop here. */
7445 /* If we have an equivalent key binding, use that. */
7446 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7448 /* Include this when menu help is implemented.
7449 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7450 if (!(NILP (tem) || STRINGP (tem)))
7452 tem = menu_item_eval_property (tem);
7455 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7459 /* Handle radio buttons or toggle boxes. */
7460 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7462 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7463 = menu_item_eval_property (tem
);
7470 /***********************************************************************
7472 ***********************************************************************/
7474 /* A vector holding tool bar items while they are parsed in function
7475 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7478 static Lisp_Object tool_bar_items_vector
;
7480 /* A vector holding the result of parse_tool_bar_item. Layout is like
7481 the one for a single item in tool_bar_items_vector. */
7483 static Lisp_Object tool_bar_item_properties
;
7485 /* Next free index in tool_bar_items_vector. */
7487 static int ntool_bar_items
;
7489 /* The symbols `tool-bar', and `:image'. */
7491 extern Lisp_Object Qtool_bar
;
7492 Lisp_Object QCimage
;
7494 /* Function prototypes. */
7496 static void init_tool_bar_items
P_ ((Lisp_Object
));
7497 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7498 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7499 static void append_tool_bar_item
P_ ((void));
7502 /* Return a vector of tool bar items for keymaps currently in effect.
7503 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7504 tool bar items found. */
7507 tool_bar_items (reuse
, nitems
)
7518 /* In order to build the menus, we need to call the keymap
7519 accessors. They all call QUIT. But this function is called
7520 during redisplay, during which a quit is fatal. So inhibit
7521 quitting while building the menus. We do this instead of
7522 specbind because (1) errors will clear it anyway and (2) this
7523 avoids risk of specpdl overflow. */
7524 oquit
= Vinhibit_quit
;
7527 /* Initialize tool_bar_items_vector and protect it from GC. */
7528 init_tool_bar_items (reuse
);
7530 /* Build list of keymaps in maps. Set nmaps to the number of maps
7533 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7534 if (!NILP (Voverriding_local_map_menu_flag
))
7536 /* Yes, use them (if non-nil) as well as the global map. */
7537 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7539 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7540 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7541 if (!NILP (Voverriding_local_map
))
7542 maps
[nmaps
++] = Voverriding_local_map
;
7546 /* No, so use major and minor mode keymaps and keymap property.
7547 Note that tool-bar bindings in the local-map and keymap
7548 properties may not work reliable, as they are only
7549 recognized when the tool-bar (or mode-line) is updated,
7550 which does not normally happen after every command. */
7553 nminor
= current_minor_maps (NULL
, &tmaps
);
7554 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7556 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7557 maps
[nmaps
++] = tem
;
7558 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7560 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7563 /* Add global keymap at the end. */
7564 maps
[nmaps
++] = current_global_map
;
7566 /* Process maps in reverse order and look up in each map the prefix
7568 for (i
= nmaps
- 1; i
>= 0; --i
)
7569 if (!NILP (maps
[i
]))
7573 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7578 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7579 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7581 Lisp_Object keydef
= XCAR (tail
);
7583 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7588 Vinhibit_quit
= oquit
;
7589 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7590 return tool_bar_items_vector
;
7594 /* Process the definition of KEY which is DEF. */
7597 process_tool_bar_item (key
, def
)
7598 Lisp_Object key
, def
;
7601 extern Lisp_Object Qundefined
;
7602 struct gcpro gcpro1
, gcpro2
;
7604 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7608 if (EQ (def
, Qundefined
))
7610 /* If a map has an explicit `undefined' as definition,
7611 discard any previously made item. */
7612 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7614 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7616 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7618 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7619 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7620 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7621 * sizeof (Lisp_Object
)));
7622 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7627 else if (parse_tool_bar_item (key
, def
))
7628 /* Append a new tool bar item to tool_bar_items_vector. Accept
7629 more than one definition for the same key. */
7630 append_tool_bar_item ();
7636 /* Parse a tool bar item specification ITEM for key KEY and return the
7637 result in tool_bar_item_properties. Value is zero if ITEM is
7640 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7642 CAPTION is the caption of the item, If it's not a string, it is
7643 evaluated to get a string.
7645 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7646 as binding are currently ignored.
7648 The following properties are recognized:
7652 FORM is evaluated and specifies whether the tool bar item is
7653 enabled or disabled.
7657 FORM is evaluated and specifies whether the tool bar item is visible.
7659 - `:filter FUNCTION'
7661 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7662 result is stored as the new binding.
7664 - `:button (TYPE SELECTED)'
7666 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7667 and specifies whether the button is selected (pressed) or not.
7671 IMAGES is either a single image specification or a vector of four
7672 image specifications. See enum tool_bar_item_images.
7674 - `:help HELP-STRING'.
7676 Gives a help string to display for the tool bar item. */
7679 parse_tool_bar_item (key
, item
)
7680 Lisp_Object key
, item
;
7682 /* Access slot with index IDX of vector tool_bar_item_properties. */
7683 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7685 Lisp_Object filter
= Qnil
;
7686 Lisp_Object caption
;
7689 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7690 Rule out items that aren't lists, don't start with
7691 `menu-item' or whose rest following `tool-bar-item' is not a
7694 || !EQ (XCAR (item
), Qmenu_item
)
7695 || (item
= XCDR (item
),
7699 /* Create tool_bar_item_properties vector if necessary. Reset it to
7701 if (VECTORP (tool_bar_item_properties
))
7703 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7707 tool_bar_item_properties
7708 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7711 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7712 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7714 /* Get the caption of the item. If the caption is not a string,
7715 evaluate it to get a string. If we don't get a string, skip this
7717 caption
= XCAR (item
);
7718 if (!STRINGP (caption
))
7720 caption
= menu_item_eval_property (caption
);
7721 if (!STRINGP (caption
))
7724 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7726 /* Give up if rest following the caption is not a list. */
7731 /* Store the binding. */
7732 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7735 /* Ignore cached key binding, if any. */
7736 if (CONSP (item
) && CONSP (XCAR (item
)))
7739 /* Process the rest of the properties. */
7740 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7742 Lisp_Object key
, value
;
7745 value
= XCAR (XCDR (item
));
7747 if (EQ (key
, QCenable
))
7748 /* `:enable FORM'. */
7749 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7750 else if (EQ (key
, QCvisible
))
7752 /* `:visible FORM'. If got a visible property and that
7753 evaluates to nil then ignore this item. */
7754 if (NILP (menu_item_eval_property (value
)))
7757 else if (EQ (key
, QChelp
))
7758 /* `:help HELP-STRING'. */
7759 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7760 else if (EQ (key
, QCfilter
))
7761 /* ':filter FORM'. */
7763 else if (EQ (key
, QCbutton
) && CONSP (value
))
7765 /* `:button (TYPE . SELECTED)'. */
7766 Lisp_Object type
, selected
;
7768 type
= XCAR (value
);
7769 selected
= XCDR (value
);
7770 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7772 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7773 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7776 else if (EQ (key
, QCimage
)
7778 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7779 /* Value is either a single image specification or a vector
7780 of 4 such specifications for the different button states. */
7781 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7784 /* If got a filter apply it on binding. */
7786 PROP (TOOL_BAR_ITEM_BINDING
)
7787 = menu_item_eval_property (list2 (filter
,
7789 PROP (TOOL_BAR_ITEM_BINDING
))));
7791 /* See if the binding is a keymap. Give up if it is. */
7792 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7795 /* Enable or disable selection of item. */
7796 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7797 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7798 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7800 /* Handle radio buttons or toggle boxes. */
7801 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7802 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7803 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7811 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7812 that can be reused. */
7815 init_tool_bar_items (reuse
)
7818 if (VECTORP (reuse
))
7819 tool_bar_items_vector
= reuse
;
7821 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7822 ntool_bar_items
= 0;
7826 /* Append parsed tool bar item properties from
7827 tool_bar_item_properties */
7830 append_tool_bar_item ()
7832 Lisp_Object
*to
, *from
;
7834 /* Enlarge tool_bar_items_vector if necessary. */
7835 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7836 >= XVECTOR (tool_bar_items_vector
)->size
)
7838 Lisp_Object new_vector
;
7839 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7841 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7842 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7843 XVECTOR (new_vector
)->contents
,
7844 old_size
* sizeof (Lisp_Object
));
7845 tool_bar_items_vector
= new_vector
;
7848 /* Append entries from tool_bar_item_properties to the end of
7849 tool_bar_items_vector. */
7850 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7851 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7852 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7853 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7860 /* Read a character using menus based on maps in the array MAPS.
7861 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7862 Return t if we displayed a menu but the user rejected it.
7864 PREV_EVENT is the previous input event, or nil if we are reading
7865 the first event of a key sequence.
7867 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7868 if we used a mouse menu to read the input, or zero otherwise. If
7869 USED_MOUSE_MENU is null, we don't dereference it.
7871 The prompting is done based on the prompt-string of the map
7872 and the strings associated with various map elements.
7874 This can be done with X menus or with menus put in the minibuf.
7875 These are done in different ways, depending on how the input will be read.
7876 Menus using X are done after auto-saving in read-char, getting the input
7877 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7878 and do auto-saving in the inner call of read_char. */
7881 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7884 Lisp_Object prev_event
;
7885 int *used_mouse_menu
;
7888 register Lisp_Object name
= Qnil
;
7890 if (used_mouse_menu
)
7891 *used_mouse_menu
= 0;
7893 /* Use local over global Menu maps */
7895 if (! menu_prompting
)
7898 /* Optionally disregard all but the global map. */
7899 if (inhibit_local_menu_bar_menus
)
7901 maps
+= (nmaps
- 1);
7905 /* Get the menu name from the first map that has one (a prompt string). */
7906 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7908 name
= Fkeymap_prompt (maps
[mapno
]);
7913 /* If we don't have any menus, just read a character normally. */
7914 if (!STRINGP (name
))
7918 /* If we got to this point via a mouse click,
7919 use a real menu for mouse selection. */
7920 if (EVENT_HAS_PARAMETERS (prev_event
)
7921 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7922 && !EQ (XCAR (prev_event
), Qtool_bar
))
7924 /* Display the menu and get the selection. */
7925 Lisp_Object
*realmaps
7926 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7930 /* Use the maps that are not nil. */
7931 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7932 if (!NILP (maps
[mapno
]))
7933 realmaps
[nmaps1
++] = maps
[mapno
];
7935 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7940 record_menu_key (XCAR (value
));
7942 /* If we got multiple events, unread all but
7944 There is no way to prevent those unread events
7945 from showing up later in last_nonmenu_event.
7946 So turn symbol and integer events into lists,
7947 to indicate that they came from a mouse menu,
7948 so that when present in last_nonmenu_event
7949 they won't confuse things. */
7950 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7952 record_menu_key (XCAR (tem
));
7953 if (SYMBOLP (XCAR (tem
))
7954 || INTEGERP (XCAR (tem
)))
7955 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7958 /* If we got more than one event, put all but the first
7959 onto this list to be read later.
7960 Return just the first event now. */
7961 Vunread_command_events
7962 = nconc2 (XCDR (value
), Vunread_command_events
);
7963 value
= XCAR (value
);
7965 else if (NILP (value
))
7967 if (used_mouse_menu
)
7968 *used_mouse_menu
= 1;
7971 #endif /* HAVE_MENUS */
7975 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7976 We make this bigger when necessary, and never free it. */
7977 static char *read_char_minibuf_menu_text
;
7978 /* Size of that buffer. */
7979 static int read_char_minibuf_menu_width
;
7982 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7988 register Lisp_Object name
;
7990 /* FIXME: Use the minibuffer's frame width. */
7991 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
7994 Lisp_Object rest
, vector
;
8000 if (! menu_prompting
)
8003 /* Make sure we have a big enough buffer for the menu text. */
8004 if (read_char_minibuf_menu_text
== 0)
8006 read_char_minibuf_menu_width
= width
+ 4;
8007 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8009 else if (width
+ 4 > read_char_minibuf_menu_width
)
8011 read_char_minibuf_menu_width
= width
+ 4;
8012 read_char_minibuf_menu_text
8013 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8015 menu
= read_char_minibuf_menu_text
;
8017 /* Get the menu name from the first map that has one (a prompt string). */
8018 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8020 name
= Fkeymap_prompt (maps
[mapno
]);
8025 /* If we don't have any menus, just read a character normally. */
8026 if (!STRINGP (name
))
8029 /* Prompt string always starts with map's prompt, and a space. */
8030 strcpy (menu
, SDATA (name
));
8031 nlength
= SBYTES (name
);
8032 menu
[nlength
++] = ':';
8033 menu
[nlength
++] = ' ';
8036 /* Start prompting at start of first map. */
8040 /* Present the documented bindings, a line at a time. */
8047 Lisp_Object orig_defn_macro
;
8049 /* Loop over elements of map. */
8054 /* If reached end of map, start at beginning of next map. */
8058 /* At end of last map, wrap around to first map if just starting,
8059 or end this line if already have something on it. */
8063 if (notfirst
|| nobindings
) break;
8068 /* Look at the next element of the map. */
8070 elt
= XVECTOR (vector
)->contents
[idx
];
8072 elt
= Fcar_safe (rest
);
8074 if (idx
< 0 && VECTORP (elt
))
8076 /* If we found a dense table in the keymap,
8077 advanced past it, but start scanning its contents. */
8078 rest
= Fcdr_safe (rest
);
8084 /* An ordinary element. */
8085 Lisp_Object event
, tem
;
8089 event
= Fcar_safe (elt
); /* alist */
8090 elt
= Fcdr_safe (elt
);
8094 XSETINT (event
, idx
); /* vector */
8097 /* Ignore the element if it has no prompt string. */
8098 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8100 /* 1 if the char to type matches the string. */
8102 Lisp_Object upcased_event
, downcased_event
;
8103 Lisp_Object desc
= Qnil
;
8105 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8107 upcased_event
= Fupcase (event
);
8108 downcased_event
= Fdowncase (event
);
8109 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8110 || XINT (downcased_event
) == SREF (s
, 0));
8112 desc
= Fsingle_key_description (event
, Qnil
);
8114 #if 0 /* It is redundant to list the equivalent key bindings because
8115 the prefix is what the user has already typed. */
8117 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8119 /* Insert equivalent keybinding. */
8120 s
= concat2 (s
, tem
);
8123 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8124 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8126 /* Insert button prefix. */
8127 Lisp_Object selected
8128 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8129 if (EQ (tem
, QCradio
))
8130 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8132 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8133 s
= concat2 (tem
, s
);
8137 /* If we have room for the prompt string, add it to this line.
8138 If this is the first on the line, always add it. */
8139 if ((SCHARS (s
) + i
+ 2
8140 + (char_matches
? 0 : SCHARS (desc
) + 3))
8146 /* Punctuate between strings. */
8149 strcpy (menu
+ i
, ", ");
8155 /* If the char to type doesn't match the string's
8156 first char, explicitly show what char to type. */
8159 /* Add as much of string as fits. */
8160 thiswidth
= SCHARS (desc
);
8161 if (thiswidth
+ i
> width
)
8162 thiswidth
= width
- i
;
8163 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8165 strcpy (menu
+ i
, " = ");
8169 /* Add as much of string as fits. */
8170 thiswidth
= SCHARS (s
);
8171 if (thiswidth
+ i
> width
)
8172 thiswidth
= width
- i
;
8173 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8179 /* If this element does not fit, end the line now,
8180 and save the element for the next line. */
8181 strcpy (menu
+ i
, "...");
8186 /* Move past this element. */
8187 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8188 /* Handle reaching end of dense table. */
8193 rest
= Fcdr_safe (rest
);
8197 /* Prompt with that and read response. */
8198 message2_nolog (menu
, strlen (menu
),
8199 ! NILP (current_buffer
->enable_multibyte_characters
));
8201 /* Make believe its not a keyboard macro in case the help char
8202 is pressed. Help characters are not recorded because menu prompting
8203 is not used on replay.
8205 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8206 current_kboard
->defining_kbd_macro
= Qnil
;
8208 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8209 while (BUFFERP (obj
));
8210 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8212 if (!INTEGERP (obj
))
8217 if (! EQ (obj
, menu_prompt_more_char
)
8218 && (!INTEGERP (menu_prompt_more_char
)
8219 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8221 if (!NILP (current_kboard
->defining_kbd_macro
))
8222 store_kbd_macro_char (obj
);
8225 /* Help char - go round again */
8229 /* Reading key sequences. */
8231 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8232 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8233 keymap, or nil otherwise. Return the index of the first keymap in
8234 which KEY has any binding, or NMAPS if no map has a binding.
8236 If KEY is a meta ASCII character, treat it like meta-prefix-char
8237 followed by the corresponding non-meta character. Keymaps in
8238 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8241 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8244 NEXT may be the same array as CURRENT. */
8247 follow_key (key
, nmaps
, current
, defs
, next
)
8249 Lisp_Object
*current
, *defs
, *next
;
8252 int i
, first_binding
;
8254 first_binding
= nmaps
;
8255 for (i
= nmaps
- 1; i
>= 0; i
--)
8257 if (! NILP (current
[i
]))
8259 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8260 if (! NILP (defs
[i
]))
8267 /* Given the set of bindings we've found, produce the next set of maps. */
8268 if (first_binding
< nmaps
)
8269 for (i
= 0; i
< nmaps
; i
++)
8270 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8272 return first_binding
;
8275 /* Structure used to keep track of partial application of key remapping
8276 such as Vfunction_key_map and Vkey_translation_map. */
8277 typedef struct keyremap
8279 Lisp_Object map
, parent
;
8283 /* Lookup KEY in MAP.
8284 MAP is a keymap mapping keys to key vectors or functions.
8285 If the mapping is a function and DO_FUNCTION is non-zero, then
8286 the function is called with PROMPT as parameter and its return
8287 value is used as the return value of this function (after checking
8288 that it is indeed a vector). */
8291 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8292 Lisp_Object map
, key
, prompt
;
8297 next
= access_keymap (map
, key
, 1, 0, 1);
8299 /* Handle symbol with autoload definition. */
8300 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8301 && CONSP (XSYMBOL (next
)->function
)
8302 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8303 do_autoload (XSYMBOL (next
)->function
, next
);
8305 /* Handle a symbol whose function definition is a keymap
8307 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8308 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8309 || KEYMAPP (XSYMBOL (next
)->function
)))
8310 next
= XSYMBOL (next
)->function
;
8312 /* If the keymap gives a function, not an
8313 array, then call the function with one arg and use
8314 its value instead. */
8315 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8320 next
= call1 (next
, prompt
);
8321 /* If the function returned something invalid,
8322 barf--don't ignore it.
8323 (To ignore it safely, we would need to gcpro a bunch of
8324 other variables.) */
8325 if (! (VECTORP (next
) || STRINGP (next
)))
8326 error ("Function %s returns invalid key sequence", tem
);
8331 /* Do one step of the key remapping used for function-key-map and
8332 key-translation-map:
8333 KEYBUF is the buffer holding the input events.
8334 BUFSIZE is its maximum size.
8335 FKEY is a pointer to the keyremap structure to use.
8336 INPUT is the index of the last element in KEYBUF.
8337 DOIT if non-zero says that the remapping can actually take place.
8338 DIFF is used to return the number of keys added/removed by the remapping.
8339 PARENT is the root of the keymap.
8340 PROMPT is the prompt to use if the remapping happens through a function.
8341 The return value is non-zero if the remapping actually took place. */
8344 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8345 Lisp_Object
*keybuf
, prompt
;
8347 int input
, doit
, *diff
, bufsize
;
8349 Lisp_Object next
, key
;
8351 key
= keybuf
[fkey
->end
++];
8352 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8354 /* If keybuf[fkey->start..fkey->end] is bound in the
8355 map and we're in a position to do the key remapping, replace it with
8356 the binding and restart with fkey->start at the end. */
8357 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8359 int len
= XFASTINT (Flength (next
));
8362 *diff
= len
- (fkey
->end
- fkey
->start
);
8364 if (input
+ *diff
>= bufsize
)
8365 error ("Key sequence too long");
8367 /* Shift the keys that follow fkey->end. */
8369 for (i
= fkey
->end
; i
< input
; i
++)
8370 keybuf
[i
+ *diff
] = keybuf
[i
];
8372 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8373 keybuf
[i
+ *diff
] = keybuf
[i
];
8374 /* Overwrite the old keys with the new ones. */
8375 for (i
= 0; i
< len
; i
++)
8376 keybuf
[fkey
->start
+ i
]
8377 = Faref (next
, make_number (i
));
8379 fkey
->start
= fkey
->end
+= *diff
;
8380 fkey
->map
= fkey
->parent
;
8385 fkey
->map
= get_keymap (next
, 0, 1);
8387 /* If we no longer have a bound suffix, try a new position for
8389 if (!CONSP (fkey
->map
))
8391 fkey
->end
= ++fkey
->start
;
8392 fkey
->map
= fkey
->parent
;
8397 /* Read a sequence of keys that ends with a non prefix character,
8398 storing it in KEYBUF, a buffer of size BUFSIZE.
8400 Return the length of the key sequence stored.
8401 Return -1 if the user rejected a command menu.
8403 Echo starting immediately unless `prompt' is 0.
8405 Where a key sequence ends depends on the currently active keymaps.
8406 These include any minor mode keymaps active in the current buffer,
8407 the current buffer's local map, and the global map.
8409 If a key sequence has no other bindings, we check Vfunction_key_map
8410 to see if some trailing subsequence might be the beginning of a
8411 function key's sequence. If so, we try to read the whole function
8412 key, and substitute its symbolic name into the key sequence.
8414 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8415 `double-' events into similar click events, if that would make them
8416 bound. We try to turn `triple-' events first into `double-' events,
8419 If we get a mouse click in a mode line, vertical divider, or other
8420 non-text area, we treat the click as if it were prefixed by the
8421 symbol denoting that area - `mode-line', `vertical-line', or
8424 If the sequence starts with a mouse click, we read the key sequence
8425 with respect to the buffer clicked on, not the current buffer.
8427 If the user switches frames in the midst of a key sequence, we put
8428 off the switch-frame event until later; the next call to
8429 read_char will return it.
8431 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8432 from the selected window's buffer. */
8435 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8436 can_return_switch_frame
, fix_current_buffer
)
8437 Lisp_Object
*keybuf
;
8440 int dont_downcase_last
;
8441 int can_return_switch_frame
;
8442 int fix_current_buffer
;
8444 volatile Lisp_Object from_string
;
8445 volatile int count
= SPECPDL_INDEX ();
8447 /* How many keys there are in the current key sequence. */
8450 /* The length of the echo buffer when we started reading, and
8451 the length of this_command_keys when we started reading. */
8452 volatile int echo_start
;
8453 volatile int keys_start
;
8455 /* The number of keymaps we're scanning right now, and the number of
8456 keymaps we have allocated space for. */
8458 volatile int nmaps_allocated
= 0;
8460 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8461 the current keymaps. */
8462 Lisp_Object
*volatile defs
= NULL
;
8464 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8465 in the current keymaps, or nil where it is not a prefix. */
8466 Lisp_Object
*volatile submaps
= NULL
;
8468 /* The local map to start out with at start of key sequence. */
8469 volatile Lisp_Object orig_local_map
;
8471 /* The map from the `keymap' property to start out with at start of
8473 volatile Lisp_Object orig_keymap
;
8475 /* 1 if we have already considered switching to the local-map property
8476 of the place where a mouse click occurred. */
8477 volatile int localized_local_map
= 0;
8479 /* The index in defs[] of the first keymap that has a binding for
8480 this key sequence. In other words, the lowest i such that
8481 defs[i] is non-nil. */
8482 volatile int first_binding
;
8483 /* Index of the first key that has no binding.
8484 It is useless to try fkey.start larger than that. */
8485 volatile int first_unbound
;
8487 /* If t < mock_input, then KEYBUF[t] should be read as the next
8490 We use this to recover after recognizing a function key. Once we
8491 realize that a suffix of the current key sequence is actually a
8492 function key's escape sequence, we replace the suffix with the
8493 function key's binding from Vfunction_key_map. Now keybuf
8494 contains a new and different key sequence, so the echo area,
8495 this_command_keys, and the submaps and defs arrays are wrong. In
8496 this situation, we set mock_input to t, set t to 0, and jump to
8497 restart_sequence; the loop will read keys from keybuf up until
8498 mock_input, thus rebuilding the state; and then it will resume
8499 reading characters from the keyboard. */
8500 volatile int mock_input
= 0;
8502 /* If the sequence is unbound in submaps[], then
8503 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8504 and fkey.map is its binding.
8506 These might be > t, indicating that all function key scanning
8507 should hold off until t reaches them. We do this when we've just
8508 recognized a function key, to avoid searching for the function
8509 key's again in Vfunction_key_map. */
8510 volatile keyremap fkey
;
8512 /* Likewise, for key_translation_map. */
8513 volatile keyremap keytran
;
8515 /* If we receive a `switch-frame' or `select-window' event in the middle of
8516 a key sequence, we put it off for later.
8517 While we're reading, we keep the event here. */
8518 volatile Lisp_Object delayed_switch_frame
;
8520 /* See the comment below... */
8521 #if defined (GOBBLE_FIRST_EVENT)
8522 Lisp_Object first_event
;
8525 volatile Lisp_Object original_uppercase
;
8526 volatile int original_uppercase_position
= -1;
8528 /* Gets around Microsoft compiler limitations. */
8531 struct buffer
*starting_buffer
;
8533 /* List of events for which a fake prefix key has been generated. */
8534 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8536 #if defined (GOBBLE_FIRST_EVENT)
8540 struct gcpro gcpro1
;
8542 GCPRO1 (fake_prefixed_keys
);
8543 raw_keybuf_count
= 0;
8545 last_nonmenu_event
= Qnil
;
8547 delayed_switch_frame
= Qnil
;
8548 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8549 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8550 /* If there is no translation-map, turn off scanning. */
8551 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8552 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8557 echo_prompt (prompt
);
8558 else if (cursor_in_echo_area
8559 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8560 && NILP (Fzerop (Vecho_keystrokes
)))
8561 /* This doesn't put in a dash if the echo buffer is empty, so
8562 you don't always see a dash hanging out in the minibuffer. */
8566 /* Record the initial state of the echo area and this_command_keys;
8567 we will need to restore them if we replay a key sequence. */
8569 echo_start
= echo_length ();
8570 keys_start
= this_command_key_count
;
8571 this_single_command_key_start
= keys_start
;
8573 #if defined (GOBBLE_FIRST_EVENT)
8574 /* This doesn't quite work, because some of the things that read_char
8575 does cannot safely be bypassed. It seems too risky to try to make
8578 /* Read the first char of the sequence specially, before setting
8579 up any keymaps, in case a filter runs and switches buffers on us. */
8580 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8582 #endif /* GOBBLE_FIRST_EVENT */
8584 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8585 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8588 /* We jump here when the key sequence has been thoroughly changed, and
8589 we need to rescan it starting from the beginning. When we jump here,
8590 keybuf[0..mock_input] holds the sequence we should reread. */
8593 starting_buffer
= current_buffer
;
8594 first_unbound
= bufsize
+ 1;
8596 /* Build our list of keymaps.
8597 If we recognize a function key and replace its escape sequence in
8598 keybuf with its symbol, or if the sequence starts with a mouse
8599 click and we need to switch buffers, we jump back here to rebuild
8600 the initial keymaps from the current buffer. */
8603 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8604 || !NILP (Voverriding_local_map
))
8606 if (3 > nmaps_allocated
)
8608 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8609 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8610 nmaps_allocated
= 3;
8612 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8613 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8614 if (!NILP (Voverriding_local_map
))
8615 submaps
[nmaps
++] = Voverriding_local_map
;
8623 nminor
= current_minor_maps (0, &maps
);
8624 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8626 if (total
> nmaps_allocated
)
8628 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8629 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8630 nmaps_allocated
= total
;
8633 if (!NILP (orig_keymap
))
8634 submaps
[nmaps
++] = orig_keymap
;
8636 bcopy (maps
, (void *) (submaps
+ nmaps
),
8637 nminor
* sizeof (submaps
[0]));
8641 submaps
[nmaps
++] = orig_local_map
;
8643 submaps
[nmaps
++] = current_global_map
;
8645 /* Find an accurate initial value for first_binding. */
8646 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8647 if (! NILP (submaps
[first_binding
]))
8650 /* Start from the beginning in keybuf. */
8653 /* These are no-ops the first time through, but if we restart, they
8654 revert the echo area and this_command_keys to their original state. */
8655 this_command_key_count
= keys_start
;
8656 if (INTERACTIVE
&& t
< mock_input
)
8657 echo_truncate (echo_start
);
8659 /* If the best binding for the current key sequence is a keymap, or
8660 we may be looking at a function key's escape sequence, keep on
8662 while (first_binding
< nmaps
8663 /* Keep reading as long as there's a prefix binding. */
8664 ? !NILP (submaps
[first_binding
])
8665 /* Don't return in the middle of a possible function key sequence,
8666 if the only bindings we found were via case conversion.
8667 Thus, if ESC O a has a function-key-map translation
8668 and ESC o has a binding, don't return after ESC O,
8669 so that we can translate ESC O plus the next character. */
8670 : (fkey
.start
< t
|| keytran
.start
< t
))
8673 int used_mouse_menu
= 0;
8675 /* Where the last real key started. If we need to throw away a
8676 key that has expanded into more than one element of keybuf
8677 (say, a mouse click on the mode line which is being treated
8678 as [mode-line (mouse-...)], then we backtrack to this point
8680 volatile int last_real_key_start
;
8682 /* These variables are analogous to echo_start and keys_start;
8683 while those allow us to restart the entire key sequence,
8684 echo_local_start and keys_local_start allow us to throw away
8686 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8688 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8689 eassert (fkey
.start
<= fkey
.end
);
8690 eassert (keytran
.start
<= keytran
.end
);
8691 /* key-translation-map is applied *after* function-key-map. */
8692 eassert (keytran
.end
<= fkey
.start
);
8694 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8695 { /* The prefix upto first_unbound has no binding and has
8696 no translation left to do either, so we know it's unbound.
8697 If we don't stop now, we risk staying here indefinitely
8698 (if the user keeps entering fkey or keytran prefixes
8699 like C-c ESC ESC ESC ESC ...) */
8701 for (i
= first_unbound
+ 1; i
< t
; i
++)
8702 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8703 mock_input
= t
- first_unbound
- 1;
8704 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8705 fkey
.map
= fkey
.parent
;
8706 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8707 keytran
.map
= keytran
.parent
;
8708 goto replay_sequence
;
8712 error ("Key sequence too long");
8715 echo_local_start
= echo_length ();
8716 keys_local_start
= this_command_key_count
;
8717 local_first_binding
= first_binding
;
8720 /* These are no-ops, unless we throw away a keystroke below and
8721 jumped back up to replay_key; in that case, these restore the
8722 variables to their original state, allowing us to replay the
8724 if (INTERACTIVE
&& t
< mock_input
)
8725 echo_truncate (echo_local_start
);
8726 this_command_key_count
= keys_local_start
;
8727 first_binding
= local_first_binding
;
8729 /* By default, assume each event is "real". */
8730 last_real_key_start
= t
;
8732 /* Does mock_input indicate that we are re-reading a key sequence? */
8736 add_command_key (key
);
8737 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8738 && NILP (Fzerop (Vecho_keystrokes
)))
8742 /* If not, we should actually read a character. */
8747 KBOARD
*interrupted_kboard
= current_kboard
;
8748 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8749 if (setjmp (wrong_kboard_jmpbuf
))
8751 if (!NILP (delayed_switch_frame
))
8753 interrupted_kboard
->kbd_queue
8754 = Fcons (delayed_switch_frame
,
8755 interrupted_kboard
->kbd_queue
);
8756 delayed_switch_frame
= Qnil
;
8759 interrupted_kboard
->kbd_queue
8760 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8762 /* If the side queue is non-empty, ensure it begins with a
8763 switch-frame, so we'll replay it in the right context. */
8764 if (CONSP (interrupted_kboard
->kbd_queue
)
8765 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8766 !(EVENT_HAS_PARAMETERS (key
)
8767 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8771 XSETFRAME (frame
, interrupted_frame
);
8772 interrupted_kboard
->kbd_queue
8773 = Fcons (make_lispy_switch_frame (frame
),
8774 interrupted_kboard
->kbd_queue
);
8777 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8778 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8779 goto replay_sequence
;
8782 key
= read_char (NILP (prompt
), nmaps
,
8783 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8787 /* read_char returns t when it shows a menu and the user rejects it.
8791 unbind_to (count
, Qnil
);
8796 /* read_char returns -1 at the end of a macro.
8797 Emacs 18 handles this by returning immediately with a
8798 zero, so that's what we'll do. */
8799 if (INTEGERP (key
) && XINT (key
) == -1)
8802 /* The Microsoft C compiler can't handle the goto that
8808 /* If the current buffer has been changed from under us, the
8809 keymap may have changed, so replay the sequence. */
8812 EMACS_TIME initial_idleness_start_time
;
8813 EMACS_SET_SECS_USECS (initial_idleness_start_time
,
8814 EMACS_SECS (timer_last_idleness_start_time
),
8815 EMACS_USECS (timer_last_idleness_start_time
));
8817 /* Resume idle state, using the same start-time as before. */
8818 timer_start_idle ();
8819 timer_idleness_start_time
= initial_idleness_start_time
;
8822 /* Reset the current buffer from the selected window
8823 in case something changed the former and not the latter.
8824 This is to be more consistent with the behavior
8825 of the command_loop_1. */
8826 if (fix_current_buffer
)
8828 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8830 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8831 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8834 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8835 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8836 goto replay_sequence
;
8839 /* If we have a quit that was typed in another frame, and
8840 quit_throw_to_read_char switched buffers,
8841 replay to get the right keymap. */
8843 && XINT (key
) == quit_char
8844 && current_buffer
!= starting_buffer
)
8847 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8851 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8852 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8853 goto replay_sequence
;
8858 if (EVENT_HAS_PARAMETERS (key
)
8859 /* Either a `switch-frame' or a `select-window' event. */
8860 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8862 /* If we're at the beginning of a key sequence, and the caller
8863 says it's okay, go ahead and return this event. If we're
8864 in the midst of a key sequence, delay it until the end. */
8865 if (t
> 0 || !can_return_switch_frame
)
8867 delayed_switch_frame
= key
;
8873 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8876 /* Clicks in non-text areas get prefixed by the symbol
8877 in their CHAR-ADDRESS field. For example, a click on
8878 the mode line is prefixed by the symbol `mode-line'.
8880 Furthermore, key sequences beginning with mouse clicks
8881 are read using the keymaps of the buffer clicked on, not
8882 the current buffer. So we may have to switch the buffer
8885 When we turn one event into two events, we must make sure
8886 that neither of the two looks like the original--so that,
8887 if we replay the events, they won't be expanded again.
8888 If not for this, such reexpansion could happen either here
8889 or when user programs play with this-command-keys. */
8890 if (EVENT_HAS_PARAMETERS (key
))
8895 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8896 if (EQ (kind
, Qmouse_click
))
8898 Lisp_Object window
, posn
;
8900 window
= POSN_WINDOW (EVENT_START (key
));
8901 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8904 || (!NILP (fake_prefixed_keys
)
8905 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8907 /* We're looking a second time at an event for which
8908 we generated a fake prefix key. Set
8909 last_real_key_start appropriately. */
8911 last_real_key_start
= t
- 1;
8914 /* Key sequences beginning with mouse clicks are
8915 read using the keymaps in the buffer clicked on,
8916 not the current buffer. If we're at the
8917 beginning of a key sequence, switch buffers. */
8918 if (last_real_key_start
== 0
8920 && BUFFERP (XWINDOW (window
)->buffer
)
8921 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8923 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8927 /* Arrange to go back to the original buffer once we're
8928 done reading the key sequence. Note that we can't
8929 use save_excursion_{save,restore} here, because they
8930 save point as well as the current buffer; we don't
8931 want to save point, because redisplay may change it,
8932 to accommodate a Fset_window_start or something. We
8933 don't want to do this at the top of the function,
8934 because we may get input from a subprocess which
8935 wants to change the selected window and stuff (say,
8937 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8939 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8941 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8942 orig_local_map
= get_local_map (PT
, current_buffer
,
8944 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8945 goto replay_sequence
;
8948 /* For a mouse click, get the local text-property keymap
8949 of the place clicked on, rather than point. */
8950 if (last_real_key_start
== 0
8951 && CONSP (XCDR (key
))
8952 && ! localized_local_map
)
8954 Lisp_Object map_here
, start
, pos
;
8956 localized_local_map
= 1;
8957 start
= EVENT_START (key
);
8959 if (CONSP (start
) && CONSP (XCDR (start
)))
8961 pos
= POSN_BUFFER_POSN (start
);
8963 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8965 map_here
= get_local_map (XINT (pos
),
8966 current_buffer
, Qlocal_map
);
8967 if (!EQ (map_here
, orig_local_map
))
8969 orig_local_map
= map_here
;
8973 goto replay_sequence
;
8975 map_here
= get_local_map (XINT (pos
),
8976 current_buffer
, Qkeymap
);
8977 if (!EQ (map_here
, orig_keymap
))
8979 orig_keymap
= map_here
;
8983 goto replay_sequence
;
8989 /* Expand mode-line and scroll-bar events into two events:
8990 use posn as a fake prefix key. */
8992 && (NILP (fake_prefixed_keys
)
8993 || NILP (Fmemq (key
, fake_prefixed_keys
))))
8995 if (t
+ 1 >= bufsize
)
8996 error ("Key sequence too long");
8999 keybuf
[t
+ 1] = key
;
9002 /* Record that a fake prefix key has been generated
9003 for KEY. Don't modify the event; this would
9004 prevent proper action when the event is pushed
9005 back into unread-command-events. */
9006 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9008 /* If on a mode line string with a local keymap,
9009 reconsider the key sequence with that keymap. */
9010 if (string
= POSN_STRING (EVENT_START (key
)),
9011 (CONSP (string
) && STRINGP (XCAR (string
))))
9013 Lisp_Object pos
, map
, map2
;
9015 pos
= XCDR (string
);
9016 string
= XCAR (string
);
9018 && XINT (pos
) < SCHARS (string
))
9020 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9022 orig_local_map
= map
;
9023 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9026 if (!NILP (map
) || !NILP (map2
))
9027 goto replay_sequence
;
9033 else if (NILP (from_string
)
9034 && (string
= POSN_STRING (EVENT_START (key
)),
9035 (CONSP (string
) && STRINGP (XCAR (string
)))))
9037 /* For a click on a string, i.e. overlay string or a
9038 string displayed via the `display' property,
9039 consider `local-map' and `keymap' properties of
9041 Lisp_Object pos
, map
, map2
;
9043 pos
= XCDR (string
);
9044 string
= XCAR (string
);
9046 && XINT (pos
) < SCHARS (string
))
9048 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9050 orig_local_map
= map
;
9051 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9055 if (!NILP (map
) || !NILP (map2
))
9057 from_string
= string
;
9058 goto replay_sequence
;
9063 else if (CONSP (XCDR (key
))
9064 && CONSP (EVENT_START (key
))
9065 && CONSP (XCDR (EVENT_START (key
))))
9069 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
9070 /* Handle menu-bar events:
9071 insert the dummy prefix event `menu-bar'. */
9072 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9074 if (t
+ 1 >= bufsize
)
9075 error ("Key sequence too long");
9079 /* Zap the position in key, so we know that we've
9080 expanded it, and don't try to do so again. */
9081 POSN_BUFFER_SET_POSN (EVENT_START (key
),
9082 Fcons (posn
, Qnil
));
9085 goto replay_sequence
;
9087 else if (CONSP (posn
))
9089 /* We're looking at the second event of a
9090 sequence which we expanded before. Set
9091 last_real_key_start appropriately. */
9092 if (last_real_key_start
== t
&& t
> 0)
9093 last_real_key_start
= t
- 1;
9098 /* We have finally decided that KEY is something we might want
9100 first_binding
= (follow_key (key
,
9101 nmaps
- first_binding
,
9102 submaps
+ first_binding
,
9103 defs
+ first_binding
,
9104 submaps
+ first_binding
)
9107 /* If KEY wasn't bound, we'll try some fallbacks. */
9108 if (first_binding
< nmaps
)
9109 /* This is needed for the following scenario:
9110 event 0: a down-event that gets dropped by calling replay_key.
9111 event 1: some normal prefix like C-h.
9112 After event 0, first_unbound is 0, after event 1 fkey.start
9113 and keytran.start are both 1, so when we see that C-h is bound,
9114 we need to update first_unbound. */
9115 first_unbound
= max (t
+ 1, first_unbound
);
9120 /* Remember the position to put an upper bound on fkey.start. */
9121 first_unbound
= min (t
, first_unbound
);
9123 head
= EVENT_HEAD (key
);
9124 if (help_char_p (head
) && t
> 0)
9126 read_key_sequence_cmd
= Vprefix_help_command
;
9128 last_nonmenu_event
= key
;
9129 /* The Microsoft C compiler can't handle the goto that
9137 Lisp_Object breakdown
;
9140 breakdown
= parse_modifiers (head
);
9141 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9142 /* Attempt to reduce an unbound mouse event to a simpler
9143 event that is bound:
9144 Drags reduce to clicks.
9145 Double-clicks reduce to clicks.
9146 Triple-clicks reduce to double-clicks, then to clicks.
9147 Down-clicks are eliminated.
9148 Double-downs reduce to downs, then are eliminated.
9149 Triple-downs reduce to double-downs, then to downs,
9150 then are eliminated. */
9151 if (modifiers
& (down_modifier
| drag_modifier
9152 | double_modifier
| triple_modifier
))
9154 while (modifiers
& (down_modifier
| drag_modifier
9155 | double_modifier
| triple_modifier
))
9157 Lisp_Object new_head
, new_click
;
9158 if (modifiers
& triple_modifier
)
9159 modifiers
^= (double_modifier
| triple_modifier
);
9160 else if (modifiers
& double_modifier
)
9161 modifiers
&= ~double_modifier
;
9162 else if (modifiers
& drag_modifier
)
9163 modifiers
&= ~drag_modifier
;
9166 /* Dispose of this `down' event by simply jumping
9167 back to replay_key, to get another event.
9169 Note that if this event came from mock input,
9170 then just jumping back to replay_key will just
9171 hand it to us again. So we have to wipe out any
9174 We could delete keybuf[t] and shift everything
9175 after that to the left by one spot, but we'd also
9176 have to fix up any variable that points into
9177 keybuf, and shifting isn't really necessary
9180 Adding prefixes for non-textual mouse clicks
9181 creates two characters of mock input, and both
9182 must be thrown away. If we're only looking at
9183 the prefix now, we can just jump back to
9184 replay_key. On the other hand, if we've already
9185 processed the prefix, and now the actual click
9186 itself is giving us trouble, then we've lost the
9187 state of the keymaps we want to backtrack to, and
9188 we need to replay the whole sequence to rebuild
9191 Beyond that, only function key expansion could
9192 create more than two keys, but that should never
9193 generate mouse events, so it's okay to zero
9194 mock_input in that case too.
9196 FIXME: The above paragraph seems just plain
9197 wrong, if you consider things like
9198 xterm-mouse-mode. -stef
9200 Isn't this just the most wonderful code ever? */
9202 /* If mock_input > t + 1, the above simplification
9203 will actually end up dropping keys on the floor.
9204 This is probably OK for now, but even
9205 if mock_input <= t + 1, we need to adjust fkey
9207 Typical case [header-line down-mouse-N]:
9208 mock_input = 2, t = 1, fkey.end = 1,
9209 last_real_key_start = 0. */
9210 if (fkey
.end
> last_real_key_start
)
9212 fkey
.end
= fkey
.start
9213 = min (last_real_key_start
, fkey
.start
);
9214 fkey
.map
= fkey
.parent
;
9215 if (keytran
.end
> last_real_key_start
)
9217 keytran
.end
= keytran
.start
9218 = min (last_real_key_start
, keytran
.start
);
9219 keytran
.map
= keytran
.parent
;
9222 if (t
== last_real_key_start
)
9229 mock_input
= last_real_key_start
;
9230 goto replay_sequence
;
9235 = apply_modifiers (modifiers
, XCAR (breakdown
));
9237 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9239 /* Look for a binding for this new key. follow_key
9240 promises that it didn't munge submaps the
9241 last time we called it, since key was unbound. */
9243 = (follow_key (new_click
,
9244 nmaps
- local_first_binding
,
9245 submaps
+ local_first_binding
,
9246 defs
+ local_first_binding
,
9247 submaps
+ local_first_binding
)
9248 + local_first_binding
);
9250 /* If that click is bound, go for it. */
9251 if (first_binding
< nmaps
)
9256 /* Otherwise, we'll leave key set to the drag event. */
9263 /* Normally, last_nonmenu_event gets the previous key we read.
9264 But when a mouse popup menu is being used,
9265 we don't update last_nonmenu_event; it continues to hold the mouse
9266 event that preceded the first level of menu. */
9267 if (!used_mouse_menu
)
9268 last_nonmenu_event
= key
;
9270 /* Record what part of this_command_keys is the current key sequence. */
9271 this_single_command_key_start
= this_command_key_count
- t
;
9273 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9274 /* There is a binding and it's not a prefix.
9275 There is thus no function-key in this sequence.
9276 Moving fkey.start is important in this case to allow keytran.start
9277 to go over the sequence before we return (since we keep the
9278 invariant that keytran.end <= fkey.start). */
9281 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9284 /* If the sequence is unbound, see if we can hang a function key
9285 off the end of it. */
9286 /* Continue scan from fkey.end until we find a bound suffix. */
9287 while (fkey
.end
< t
)
9289 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9292 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9293 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9294 max (t
, mock_input
),
9295 /* If there's a binding (i.e.
9296 first_binding >= nmaps) we don't want
9297 to apply this function-key-mapping. */
9298 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9303 mock_input
= diff
+ max (t
, mock_input
);
9304 goto replay_sequence
;
9308 /* Look for this sequence in key-translation-map.
9309 Scan from keytran.end until we find a bound suffix. */
9310 while (keytran
.end
< fkey
.start
)
9312 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9315 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9316 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9321 mock_input
= diff
+ max (t
, mock_input
);
9322 /* Adjust the function-key-map counters. */
9326 goto replay_sequence
;
9330 /* If KEY is not defined in any of the keymaps,
9331 and cannot be part of a function key or translation,
9332 and is an upper case letter
9333 use the corresponding lower-case letter instead. */
9334 if (first_binding
>= nmaps
9335 && fkey
.start
>= t
&& keytran
.start
>= t
9337 && ((((XINT (key
) & 0x3ffff)
9338 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9339 && UPPERCASEP (XINT (key
) & 0x3ffff))
9340 || (XINT (key
) & shift_modifier
)))
9342 Lisp_Object new_key
;
9344 original_uppercase
= key
;
9345 original_uppercase_position
= t
- 1;
9347 if (XINT (key
) & shift_modifier
)
9348 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9350 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9351 | (XINT (key
) & ~0x3ffff)));
9353 /* We have to do this unconditionally, regardless of whether
9354 the lower-case char is defined in the keymaps, because they
9355 might get translated through function-key-map. */
9356 keybuf
[t
- 1] = new_key
;
9357 mock_input
= max (t
, mock_input
);
9359 goto replay_sequence
;
9361 /* If KEY is not defined in any of the keymaps,
9362 and cannot be part of a function key or translation,
9363 and is a shifted function key,
9364 use the corresponding unshifted function key instead. */
9365 if (first_binding
>= nmaps
9366 && fkey
.start
>= t
&& keytran
.start
>= t
9369 Lisp_Object breakdown
;
9372 breakdown
= parse_modifiers (key
);
9373 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9374 if (modifiers
& shift_modifier
)
9376 Lisp_Object new_key
;
9378 original_uppercase
= key
;
9379 original_uppercase_position
= t
- 1;
9381 modifiers
&= ~shift_modifier
;
9382 new_key
= apply_modifiers (modifiers
,
9385 keybuf
[t
- 1] = new_key
;
9386 mock_input
= max (t
, mock_input
);
9387 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9388 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9390 goto replay_sequence
;
9396 read_key_sequence_cmd
= (first_binding
< nmaps
9397 ? defs
[first_binding
]
9400 unread_switch_frame
= delayed_switch_frame
;
9401 unbind_to (count
, Qnil
);
9403 /* Don't downcase the last character if the caller says don't.
9404 Don't downcase it if the result is undefined, either. */
9405 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9406 && t
- 1 == original_uppercase_position
)
9407 keybuf
[t
- 1] = original_uppercase
;
9409 /* Occasionally we fabricate events, perhaps by expanding something
9410 according to function-key-map, or by adding a prefix symbol to a
9411 mouse click in the scroll bar or modeline. In this cases, return
9412 the entire generated key sequence, even if we hit an unbound
9413 prefix or a definition before the end. This means that you will
9414 be able to push back the event properly, and also means that
9415 read-key-sequence will always return a logical unit.
9418 for (; t
< mock_input
; t
++)
9420 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9421 && NILP (Fzerop (Vecho_keystrokes
)))
9422 echo_char (keybuf
[t
]);
9423 add_command_key (keybuf
[t
]);
9432 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9433 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9434 The sequence is sufficient to specify a non-prefix command in the
9435 current local and global maps.
9437 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9438 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9439 as a continuation of the previous key.
9441 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9442 convert the last event to lower case. (Normally any upper case event
9443 is converted to lower case if the original event is undefined and the lower
9444 case equivalent is defined.) A non-nil value is appropriate for reading
9445 a key sequence to be defined.
9447 A C-g typed while in this function is treated like any other character,
9448 and `quit-flag' is not set.
9450 If the key sequence starts with a mouse click, then the sequence is read
9451 using the keymaps of the buffer of the window clicked in, not the buffer
9452 of the selected window as normal.
9454 `read-key-sequence' drops unbound button-down events, since you normally
9455 only care about the click or drag events which follow them. If a drag
9456 or multi-click event is unbound, but the corresponding click event would
9457 be bound, `read-key-sequence' turns the event into a click event at the
9458 drag's starting position. This means that you don't have to distinguish
9459 between click and drag, double, or triple events unless you want to.
9461 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9462 lines separating windows, and scroll bars with imaginary keys
9463 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9465 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9466 function will process a switch-frame event if the user switches frames
9467 before typing anything. If the user switches frames in the middle of a
9468 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9469 is nil, then the event will be put off until after the current key sequence.
9471 `read-key-sequence' checks `function-key-map' for function key
9472 sequences, where they wouldn't conflict with ordinary bindings. See
9473 `function-key-map' for more details.
9475 The optional fifth argument COMMAND-LOOP, if non-nil, means
9476 that this key sequence is being read by something that will
9477 read commands one after another. It should be nil if the caller
9478 will read just one key sequence. */)
9479 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9481 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9482 Lisp_Object can_return_switch_frame
, command_loop
;
9484 Lisp_Object keybuf
[30];
9486 struct gcpro gcpro1
;
9487 int count
= SPECPDL_INDEX ();
9490 CHECK_STRING (prompt
);
9493 specbind (Qinput_method_exit_on_first_char
,
9494 (NILP (command_loop
) ? Qt
: Qnil
));
9495 specbind (Qinput_method_use_echo_area
,
9496 (NILP (command_loop
) ? Qt
: Qnil
));
9498 bzero (keybuf
, sizeof keybuf
);
9500 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9502 if (NILP (continue_echo
))
9504 this_command_key_count
= 0;
9505 this_command_key_count_reset
= 0;
9506 this_single_command_key_start
= 0;
9509 #ifdef HAVE_X_WINDOWS
9510 if (display_hourglass_p
)
9511 cancel_hourglass ();
9514 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9515 prompt
, ! NILP (dont_downcase_last
),
9516 ! NILP (can_return_switch_frame
), 0);
9518 #if 0 /* The following is fine for code reading a key sequence and
9519 then proceeding with a lenghty computation, but it's not good
9520 for code reading keys in a loop, like an input method. */
9521 #ifdef HAVE_X_WINDOWS
9522 if (display_hourglass_p
)
9533 return unbind_to (count
, make_event_array (i
, keybuf
));
9536 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9537 Sread_key_sequence_vector
, 1, 5, 0,
9538 doc
: /* Like `read-key-sequence' but always return a vector. */)
9539 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9541 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9542 Lisp_Object can_return_switch_frame
, command_loop
;
9544 Lisp_Object keybuf
[30];
9546 struct gcpro gcpro1
;
9547 int count
= SPECPDL_INDEX ();
9550 CHECK_STRING (prompt
);
9553 specbind (Qinput_method_exit_on_first_char
,
9554 (NILP (command_loop
) ? Qt
: Qnil
));
9555 specbind (Qinput_method_use_echo_area
,
9556 (NILP (command_loop
) ? Qt
: Qnil
));
9558 bzero (keybuf
, sizeof keybuf
);
9560 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9562 if (NILP (continue_echo
))
9564 this_command_key_count
= 0;
9565 this_command_key_count_reset
= 0;
9566 this_single_command_key_start
= 0;
9569 #ifdef HAVE_X_WINDOWS
9570 if (display_hourglass_p
)
9571 cancel_hourglass ();
9574 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9575 prompt
, ! NILP (dont_downcase_last
),
9576 ! NILP (can_return_switch_frame
), 0);
9578 #ifdef HAVE_X_WINDOWS
9579 if (display_hourglass_p
)
9589 return unbind_to (count
, Fvector (i
, keybuf
));
9592 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9593 doc
: /* Execute CMD as an editor command.
9594 CMD must be a symbol that satisfies the `commandp' predicate.
9595 Optional second arg RECORD-FLAG non-nil
9596 means unconditionally put this command in `command-history'.
9597 Otherwise, that is done only if an arg is read using the minibuffer.
9598 The argument KEYS specifies the value to use instead of (this-command-keys)
9599 when reading the arguments; if it is nil, (this-command-keys) is used.
9600 The argument SPECIAL, if non-nil, means that this command is executing
9601 a special event, so ignore the prefix argument and don't clear it. */)
9602 (cmd
, record_flag
, keys
, special
)
9603 Lisp_Object cmd
, record_flag
, keys
, special
;
9605 register Lisp_Object final
;
9606 register Lisp_Object tem
;
9607 Lisp_Object prefixarg
;
9608 struct backtrace backtrace
;
9609 extern int debug_on_next_call
;
9611 debug_on_next_call
= 0;
9615 prefixarg
= current_kboard
->Vprefix_arg
;
9616 Vcurrent_prefix_arg
= prefixarg
;
9617 current_kboard
->Vprefix_arg
= Qnil
;
9624 tem
= Fget (cmd
, Qdisabled
);
9625 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9627 tem
= Fsymbol_value (Qdisabled_command_hook
);
9629 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9635 final
= Findirect_function (cmd
);
9637 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9639 struct gcpro gcpro1
, gcpro2
;
9641 GCPRO2 (cmd
, prefixarg
);
9642 do_autoload (final
, cmd
);
9649 if (STRINGP (final
) || VECTORP (final
))
9651 /* If requested, place the macro in the command history. For
9652 other sorts of commands, call-interactively takes care of
9654 if (!NILP (record_flag
))
9657 = Fcons (Fcons (Qexecute_kbd_macro
,
9658 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9661 /* Don't keep command history around forever. */
9662 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9664 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9666 XSETCDR (tem
, Qnil
);
9670 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9673 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9675 backtrace
.next
= backtrace_list
;
9676 backtrace_list
= &backtrace
;
9677 backtrace
.function
= &Qcall_interactively
;
9678 backtrace
.args
= &cmd
;
9679 backtrace
.nargs
= 1;
9680 backtrace
.evalargs
= 0;
9682 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9684 backtrace_list
= backtrace
.next
;
9692 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9694 doc
: /* Read function name, then read its arguments and call it. */)
9696 Lisp_Object prefixarg
;
9698 Lisp_Object function
;
9700 int saved_last_point_position
;
9701 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9702 Lisp_Object bindings
, value
;
9703 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9705 saved_keys
= Fvector (this_command_key_count
,
9706 XVECTOR (this_command_keys
)->contents
);
9707 saved_last_point_position_buffer
= last_point_position_buffer
;
9708 saved_last_point_position
= last_point_position
;
9710 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9712 if (EQ (prefixarg
, Qminus
))
9714 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9715 strcpy (buf
, "C-u ");
9716 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9718 if (sizeof (int) == sizeof (EMACS_INT
))
9719 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9720 else if (sizeof (long) == sizeof (EMACS_INT
))
9721 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9725 else if (INTEGERP (prefixarg
))
9727 if (sizeof (int) == sizeof (EMACS_INT
))
9728 sprintf (buf
, "%d ", XINT (prefixarg
));
9729 else if (sizeof (long) == sizeof (EMACS_INT
))
9730 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9735 /* This isn't strictly correct if execute-extended-command
9736 is bound to anything else. Perhaps it should use
9737 this_command_keys? */
9738 strcat (buf
, "M-x ");
9740 /* Prompt with buf, and then read a string, completing from and
9741 restricting to the set of all defined commands. Don't provide
9742 any initial input. Save the command read on the extended-command
9744 function
= Fcompleting_read (build_string (buf
),
9745 Vobarray
, Qcommandp
,
9746 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9749 if (STRINGP (function
) && SCHARS (function
) == 0)
9750 error ("No command name given");
9752 /* Set this_command_keys to the concatenation of saved_keys and
9753 function, followed by a RET. */
9758 this_command_key_count
= 0;
9759 this_command_key_count_reset
= 0;
9760 this_single_command_key_start
= 0;
9762 keys
= XVECTOR (saved_keys
)->contents
;
9763 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9764 add_command_key (keys
[i
]);
9766 for (i
= 0; i
< SCHARS (function
); i
++)
9767 add_command_key (Faref (function
, make_number (i
)));
9769 add_command_key (make_number ('\015'));
9772 last_point_position
= saved_last_point_position
;
9773 last_point_position_buffer
= saved_last_point_position_buffer
;
9777 function
= Fintern (function
, Qnil
);
9778 current_kboard
->Vprefix_arg
= prefixarg
;
9779 Vthis_command
= function
;
9780 real_this_command
= function
;
9782 /* If enabled, show which key runs this command. */
9783 if (!NILP (Vsuggest_key_bindings
)
9784 && NILP (Vexecuting_macro
)
9785 && SYMBOLP (function
))
9786 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9792 GCPRO2 (bindings
, value
);
9793 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9795 /* If the command has a key binding, print it now. */
9796 if (!NILP (bindings
)
9797 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9800 /* But first wait, and skip the message if there is input. */
9802 if (!NILP (echo_area_buffer
[0]))
9803 /* This command displayed something in the echo area;
9804 so wait a few seconds, then display our suggestion message. */
9805 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9806 ? XINT (Vsuggest_key_bindings
) : 2);
9808 /* This command left the echo area empty,
9809 so display our message immediately. */
9812 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9813 && ! CONSP (Vunread_command_events
))
9815 Lisp_Object binding
;
9817 int message_p
= push_message ();
9818 int count
= SPECPDL_INDEX ();
9820 record_unwind_protect (pop_message_unwind
, Qnil
);
9821 binding
= Fkey_description (bindings
);
9824 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9827 sprintf (newmessage
, "You can run the command `%s' with %s",
9828 SDATA (SYMBOL_NAME (function
)),
9830 message2_nolog (newmessage
,
9831 strlen (newmessage
),
9832 STRING_MULTIBYTE (binding
));
9833 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9834 ? Vsuggest_key_bindings
: make_number (2)),
9839 unbind_to (count
, Qnil
);
9843 RETURN_UNGCPRO (value
);
9847 /* Return nonzero if input events are pending. */
9850 detect_input_pending ()
9853 get_input_pending (&input_pending
, 0);
9855 return input_pending
;
9858 /* Return nonzero if input events are pending, and run any pending timers. */
9861 detect_input_pending_run_timers (do_display
)
9864 int old_timers_run
= timers_run
;
9867 get_input_pending (&input_pending
, 1);
9869 if (old_timers_run
!= timers_run
&& do_display
)
9871 redisplay_preserve_echo_area (8);
9872 /* The following fixes a bug when using lazy-lock with
9873 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9874 from an idle timer function. The symptom of the bug is that
9875 the cursor sometimes doesn't become visible until the next X
9876 event is processed. --gerd. */
9878 Lisp_Object tail
, frame
;
9879 FOR_EACH_FRAME (tail
, frame
)
9880 if (FRAME_RIF (XFRAME (frame
)))
9881 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
9885 return input_pending
;
9888 /* This is called in some cases before a possible quit.
9889 It cases the next call to detect_input_pending to recompute input_pending.
9890 So calling this function unnecessarily can't do any harm. */
9893 clear_input_pending ()
9898 /* Return nonzero if there are pending requeued events.
9899 This isn't used yet. The hope is to make wait_reading_process_input
9900 call it, and return if it runs Lisp code that unreads something.
9901 The problem is, kbd_buffer_get_event needs to be fixed to know what
9902 to do in that case. It isn't trivial. */
9905 requeued_events_pending_p ()
9907 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9911 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9912 doc
: /* Return t if command input is currently available with no wait.
9913 Actually, the value is nil only if we can be sure that no input is available;
9914 if there is a doubt, the value is t. */)
9917 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9920 get_filtered_input_pending (&input_pending
, 1, 1);
9921 return input_pending
> 0 ? Qt
: Qnil
;
9924 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9925 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9928 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9931 if (total_keys
< NUM_RECENT_KEYS
)
9932 return Fvector (total_keys
, keys
);
9935 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9936 bcopy (keys
+ recent_keys_index
,
9937 XVECTOR (val
)->contents
,
9938 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9940 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9941 recent_keys_index
* sizeof (Lisp_Object
));
9946 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9947 doc
: /* Return the key sequence that invoked this command.
9948 However, if the command has called `read-key-sequence', it returns
9949 the last key sequence that has been read.
9950 The value is a string or a vector. */)
9953 return make_event_array (this_command_key_count
,
9954 XVECTOR (this_command_keys
)->contents
);
9957 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9958 doc
: /* Return the key sequence that invoked this command, as a vector.
9959 However, if the command has called `read-key-sequence', it returns
9960 the last key sequence that has been read. */)
9963 return Fvector (this_command_key_count
,
9964 XVECTOR (this_command_keys
)->contents
);
9967 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9968 Sthis_single_command_keys
, 0, 0, 0,
9969 doc
: /* Return the key sequence that invoked this command.
9970 More generally, it returns the last key sequence read, either by
9971 the command loop or by `read-key-sequence'.
9972 Unlike `this-command-keys', this function's value
9973 does not include prefix arguments.
9974 The value is always a vector. */)
9977 return Fvector (this_command_key_count
9978 - this_single_command_key_start
,
9979 (XVECTOR (this_command_keys
)->contents
9980 + this_single_command_key_start
));
9983 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9984 Sthis_single_command_raw_keys
, 0, 0, 0,
9985 doc
: /* Return the raw events that were read for this command.
9986 More generally, it returns the last key sequence read, either by
9987 the command loop or by `read-key-sequence'.
9988 Unlike `this-single-command-keys', this function's value
9989 shows the events before all translations (except for input methods).
9990 The value is always a vector. */)
9993 return Fvector (raw_keybuf_count
,
9994 (XVECTOR (raw_keybuf
)->contents
));
9997 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9998 Sreset_this_command_lengths
, 0, 0, 0,
9999 doc
: /* Make the unread events replace the last command and echo.
10000 Used in `universal-argument-other-key'.
10002 `universal-argument-other-key' rereads the event just typed.
10003 It then gets translated through `function-key-map'.
10004 The translated event has to replace the real events,
10005 both in the value of (this-command-keys) and in echoing.
10006 To achieve this, `universal-argument-other-key' calls
10007 `reset-this-command-lengths', which discards the record of reading
10008 these events the first time. */)
10011 this_command_key_count
= before_command_key_count
;
10012 if (this_command_key_count
< this_single_command_key_start
)
10013 this_single_command_key_start
= this_command_key_count
;
10015 echo_truncate (before_command_echo_length
);
10017 /* Cause whatever we put into unread-command-events
10018 to echo as if it were being freshly read from the keyboard. */
10019 this_command_key_count_reset
= 1;
10024 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10025 Sclear_this_command_keys
, 0, 1, 0,
10026 doc
: /* Clear out the vector that `this-command-keys' returns.
10027 Also clear the record of the last 100 events, unless optional arg
10028 KEEP-RECORD is non-nil. */)
10030 Lisp_Object keep_record
;
10034 this_command_key_count
= 0;
10035 this_command_key_count_reset
= 0;
10037 if (NILP (keep_record
))
10039 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10040 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10042 recent_keys_index
= 0;
10047 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10048 doc
: /* Return the current depth in recursive edits. */)
10052 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10056 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10057 "FOpen dribble file: ",
10058 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10059 If FILE is nil, close any open dribble file. */)
10070 file
= Fexpand_file_name (file
, Qnil
);
10071 dribble
= fopen (SDATA (file
), "w");
10073 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10078 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10079 doc
: /* Discard the contents of the terminal input buffer.
10080 Also end any kbd macro being defined. */)
10083 if (!NILP (current_kboard
->defining_kbd_macro
))
10085 /* Discard the last command from the macro. */
10086 Fcancel_kbd_macro_events ();
10090 update_mode_lines
++;
10092 Vunread_command_events
= Qnil
;
10093 unread_command_char
= -1;
10095 discard_tty_input ();
10097 kbd_fetch_ptr
= kbd_store_ptr
;
10098 Ffillarray (kbd_buffer_gcpro
, Qnil
);
10104 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10105 doc
: /* Stop Emacs and return to superior process. You can resume later.
10106 If `cannot-suspend' is non-nil, or if the system doesn't support job
10107 control, run a subshell instead.
10109 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10110 to be read as terminal input by Emacs's parent, after suspension.
10112 Before suspending, run the normal hook `suspend-hook'.
10113 After resumption run the normal hook `suspend-resume-hook'.
10115 Some operating systems cannot stop the Emacs process and resume it later.
10116 On such systems, Emacs starts a subshell instead of suspending. */)
10118 Lisp_Object stuffstring
;
10120 int count
= SPECPDL_INDEX ();
10121 int old_height
, old_width
;
10123 struct gcpro gcpro1
;
10125 if (tty_list
&& tty_list
->next
)
10126 error ("Suspend is not supported with multiple ttys");
10128 if (!NILP (stuffstring
))
10129 CHECK_STRING (stuffstring
);
10131 /* Run the functions in suspend-hook. */
10132 if (!NILP (Vrun_hooks
))
10133 call1 (Vrun_hooks
, intern ("suspend-hook"));
10135 GCPRO1 (stuffstring
);
10136 get_tty_size (fileno (TTY_INPUT (CURTTY ())), &old_width
, &old_height
);
10137 reset_all_sys_modes ();
10138 /* sys_suspend can get an error if it tries to fork a subshell
10139 and the system resources aren't available for that. */
10140 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10141 (Lisp_Object
)CURTTY()); /* XXX */
10142 stuff_buffered_input (stuffstring
);
10143 if (cannot_suspend
)
10147 unbind_to (count
, Qnil
);
10149 /* Check if terminal/window size has changed.
10150 Note that this is not useful when we are running directly
10151 with a window system; but suspend should be disabled in that case. */
10152 get_tty_size (fileno (TTY_INPUT (CURTTY ())), &width
, &height
);
10153 if (width
!= old_width
|| height
!= old_height
)
10154 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10156 /* Run suspend-resume-hook. */
10157 if (!NILP (Vrun_hooks
))
10158 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10164 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10165 Then in any case stuff anything Emacs has read ahead and not used. */
10168 stuff_buffered_input (stuffstring
)
10169 Lisp_Object stuffstring
;
10171 /* stuff_char works only in BSD, versions 4.2 and up. */
10174 register unsigned char *p
;
10176 if (STRINGP (stuffstring
))
10178 register int count
;
10180 p
= SDATA (stuffstring
);
10181 count
= SBYTES (stuffstring
);
10182 while (count
-- > 0)
10187 /* Anything we have read ahead, put back for the shell to read. */
10188 /* ?? What should this do when we have multiple keyboards??
10189 Should we ignore anything that was typed in at the "wrong" kboard? */
10190 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10194 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10195 kbd_fetch_ptr
= kbd_buffer
;
10196 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10197 stuff_char (kbd_fetch_ptr
->code
);
10199 kbd_fetch_ptr
->kind
= NO_EVENT
;
10200 idx
= 2 * (kbd_fetch_ptr
- kbd_buffer
);
10201 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
10202 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
10207 #endif /* BSD_SYSTEM and not BSD4_1 */
10211 set_waiting_for_input (time_to_clear
)
10212 EMACS_TIME
*time_to_clear
;
10214 input_available_clear_time
= time_to_clear
;
10216 /* Tell interrupt_signal to throw back to read_char, */
10217 waiting_for_input
= 1;
10219 /* If interrupt_signal was called before and buffered a C-g,
10220 make it run again now, to avoid timing error. */
10221 if (!NILP (Vquit_flag
))
10222 quit_throw_to_read_char ();
10226 clear_waiting_for_input ()
10228 /* Tell interrupt_signal not to throw back to read_char, */
10229 waiting_for_input
= 0;
10230 input_available_clear_time
= 0;
10233 /* This routine is called at interrupt level in response to C-g.
10235 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10236 is called from kbd_buffer_store_event, in handling SIGIO or
10239 If `waiting_for_input' is non zero, then unless `echoing' is
10240 nonzero, immediately throw back to read_char.
10242 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10243 eval to throw, when it gets a chance. If quit-flag is already
10244 non-nil, it stops the job right away. */
10247 interrupt_signal (signalnum
) /* If we don't have an argument, */
10248 int signalnum
; /* some compilers complain in signal calls. */
10251 /* Must preserve main program's value of errno. */
10252 int old_errno
= errno
;
10253 struct frame
*sf
= SELECTED_FRAME ();
10255 #if defined (USG) && !defined (POSIX_SIGNALS)
10256 /* USG systems forget handlers when they are used;
10257 must reestablish each time */
10258 signal (SIGINT
, interrupt_signal
);
10259 signal (SIGQUIT
, interrupt_signal
);
10264 if (!NILP (Vquit_flag
)
10265 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10267 /* If SIGINT isn't blocked, don't let us be interrupted by
10268 another SIGINT, it might be harmful due to non-reentrancy
10269 in I/O functions. */
10270 sigblock (sigmask (SIGINT
));
10273 reset_all_sys_modes ();
10275 #ifdef SIGTSTP /* Support possible in later USG versions */
10277 * On systems which can suspend the current process and return to the original
10278 * shell, this command causes the user to end up back at the shell.
10279 * The "Auto-save" and "Abort" questions are not asked until
10280 * the user elects to return to emacs, at which point he can save the current
10281 * job and either dump core or continue.
10286 if (sys_suspend () == -1)
10288 printf ("Not running as a subprocess;\n");
10289 printf ("you can continue or abort.\n");
10291 #else /* not VMS */
10292 /* Perhaps should really fork an inferior shell?
10293 But that would not provide any way to get back
10294 to the original shell, ever. */
10295 printf ("No support for stopping a process on this operating system;\n");
10296 printf ("you can continue or abort.\n");
10297 #endif /* not VMS */
10298 #endif /* not SIGTSTP */
10300 /* We must remain inside the screen area when the internal terminal
10301 is used. Note that [Enter] is not echoed by dos. */
10304 /* It doesn't work to autosave while GC is in progress;
10305 the code used for auto-saving doesn't cope with the mark bit. */
10306 if (!gc_in_progress
)
10308 printf ("Auto-save? (y or n) ");
10310 if (((c
= getchar ()) & ~040) == 'Y')
10312 Fdo_auto_save (Qt
, Qnil
);
10314 printf ("\r\nAuto-save done");
10315 #else /* not MSDOS */
10316 printf ("Auto-save done\n");
10317 #endif /* not MSDOS */
10319 while (c
!= '\n') c
= getchar ();
10323 /* During GC, it must be safe to reenable quitting again. */
10324 Vinhibit_quit
= Qnil
;
10327 #endif /* not MSDOS */
10328 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10329 printf ("but will instead do a real quit after garbage collection ends\r\n");
10334 printf ("\r\nAbort? (y or n) ");
10335 #else /* not MSDOS */
10337 printf ("Abort (and enter debugger)? (y or n) ");
10338 #else /* not VMS */
10339 printf ("Abort (and dump core)? (y or n) ");
10340 #endif /* not VMS */
10341 #endif /* not MSDOS */
10343 if (((c
= getchar ()) & ~040) == 'Y')
10345 while (c
!= '\n') c
= getchar ();
10347 printf ("\r\nContinuing...\r\n");
10348 #else /* not MSDOS */
10349 printf ("Continuing...\n");
10350 #endif /* not MSDOS */
10352 init_all_sys_modes ();
10357 /* If executing a function that wants to be interrupted out of
10358 and the user has not deferred quitting by binding `inhibit-quit'
10359 then quit right away. */
10360 if (immediate_quit
&& NILP (Vinhibit_quit
))
10362 struct gl_state_s saved
;
10363 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10365 immediate_quit
= 0;
10368 GCPRO4 (saved
.object
, saved
.global_code
,
10369 saved
.current_syntax_table
, saved
.old_prop
);
10370 Fsignal (Qquit
, Qnil
);
10375 /* Else request quit when it's safe */
10379 if (waiting_for_input
&& !echoing
)
10380 quit_throw_to_read_char ();
10385 /* Handle a C-g by making read_char return C-g. */
10388 quit_throw_to_read_char ()
10391 /* Prevent another signal from doing this before we finish. */
10392 clear_waiting_for_input ();
10395 Vunread_command_events
= Qnil
;
10396 unread_command_char
= -1;
10398 #if 0 /* Currently, sit_for is called from read_char without turning
10399 off polling. And that can call set_waiting_for_input.
10400 It seems to be harmless. */
10401 #ifdef POLL_FOR_INPUT
10402 /* May be > 1 if in recursive minibuffer. */
10403 if (poll_suppress_count
== 0)
10407 if (FRAMEP (internal_last_event_frame
)
10408 && !EQ (internal_last_event_frame
, selected_frame
))
10409 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10412 _longjmp (getcjmp
, 1);
10415 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10416 doc
: /* Set mode of reading keyboard input.
10417 First arg INTERRUPT non-nil means use input interrupts;
10418 nil means use CBREAK mode.
10419 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10420 (no effect except in CBREAK mode).
10421 Third arg META t means accept 8-bit input (for a Meta key).
10422 META nil means ignore the top bit, on the assumption it is parity.
10423 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10424 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10425 See also `current-input-mode'. */)
10426 (interrupt
, flow
, meta
, quit
)
10427 Lisp_Object interrupt
, flow
, meta
, quit
;
10430 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10431 error ("set-input-mode: QUIT must be an ASCII character");
10433 #ifdef POLL_FOR_INPUT
10438 /* this causes startup screen to be restored and messes with the mouse */
10439 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
10440 reset_sys_modes (CURTTY ());
10444 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10445 if (read_socket_hook
)
10447 /* When using X, don't give the user a real choice,
10448 because we haven't implemented the mechanisms to support it. */
10449 #ifdef NO_SOCK_SIGIO
10450 interrupt_input
= 0;
10451 #else /* not NO_SOCK_SIGIO */
10452 interrupt_input
= 1;
10453 #endif /* NO_SOCK_SIGIO */
10456 interrupt_input
= !NILP (interrupt
);
10457 #else /* not SIGIO */
10458 interrupt_input
= 0;
10459 #endif /* not SIGIO */
10461 /* Our VMS input only works by interrupts, as of now. */
10463 interrupt_input
= 1;
10466 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10468 struct tty_display_info
*tty
= CURTTY ();
10469 tty
->flow_control
= !NILP (flow
);
10472 else if (EQ (meta
, Qt
))
10479 /* Don't let this value be out of range. */
10480 quit_char
= XINT (quit
) & (CURTTY ()->meta_key
? 0377 : 0177);
10483 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10484 init_sys_modes (CURTTY ());
10487 #ifdef POLL_FOR_INPUT
10488 poll_suppress_count
= 1;
10494 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10495 doc
: /* Return information about the way Emacs currently reads keyboard input.
10496 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10497 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10498 nil, Emacs is using CBREAK mode.
10499 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10500 terminal; this does not apply if Emacs uses interrupt-driven input.
10501 META is t if accepting 8-bit input with 8th bit as Meta flag.
10502 META nil means ignoring the top bit, on the assumption it is parity.
10503 META is neither t nor nil if accepting 8-bit input and using
10504 all 8 bits as the character code.
10505 QUIT is the character Emacs currently uses to quit.
10506 The elements of this list correspond to the arguments of
10507 `set-input-mode'. */)
10510 Lisp_Object val
[4];
10511 struct frame
*sf
= XFRAME (selected_frame
);
10513 val
[0] = interrupt_input
? Qt
: Qnil
;
10514 if (FRAME_TERMCAP_P (sf
))
10516 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10517 val
[2] = FRAME_TTY (sf
)->meta_key
== 2
10519 : CURTTY ()->meta_key
== 1 ? Qt
: Qnil
;
10526 XSETFASTINT (val
[3], quit_char
);
10528 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10533 * Set up a new kboard object with reasonable initial values.
10539 kb
->Voverriding_terminal_local_map
= Qnil
;
10540 kb
->Vlast_command
= Qnil
;
10541 kb
->Vreal_last_command
= Qnil
;
10542 kb
->Vprefix_arg
= Qnil
;
10543 kb
->Vlast_prefix_arg
= Qnil
;
10544 kb
->kbd_queue
= Qnil
;
10545 kb
->kbd_queue_has_data
= 0;
10546 kb
->immediate_echo
= 0;
10547 kb
->echo_string
= Qnil
;
10548 kb
->echo_after_prompt
= -1;
10549 kb
->kbd_macro_buffer
= 0;
10550 kb
->kbd_macro_bufsize
= 0;
10551 kb
->defining_kbd_macro
= Qnil
;
10552 kb
->Vlast_kbd_macro
= Qnil
;
10553 kb
->reference_count
= 0;
10554 kb
->Vsystem_key_alist
= Qnil
;
10555 kb
->system_key_syms
= Qnil
;
10556 kb
->Vdefault_minibuffer_frame
= Qnil
;
10560 * Destroy the contents of a kboard object, but not the object itself.
10561 * We use this just before deleting it, or if we're going to initialize
10562 * it a second time.
10568 if (kb
->kbd_macro_buffer
)
10569 xfree (kb
->kbd_macro_buffer
);
10572 #ifdef MULTI_KBOARD
10574 /* Free KB and memory referenced from it. */
10582 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10585 *kbp
= kb
->next_kboard
;
10587 /* Prevent a dangling reference to KB. */
10588 if (kb
== current_kboard
10589 && FRAMEP (selected_frame
)
10590 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10592 current_kboard
= XFRAME (selected_frame
)->kboard
;
10593 if (current_kboard
== kb
)
10601 #endif /* MULTI_KBOARD */
10606 /* This is correct before outermost invocation of the editor loop */
10607 command_loop_level
= -1;
10608 immediate_quit
= 0;
10609 quit_char
= Ctl ('g');
10610 Vunread_command_events
= Qnil
;
10611 unread_command_char
= -1;
10612 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10614 recent_keys_index
= 0;
10615 kbd_fetch_ptr
= kbd_buffer
;
10616 kbd_store_ptr
= kbd_buffer
;
10617 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10619 do_mouse_tracking
= Qnil
;
10623 /* This means that command_loop_1 won't try to select anything the first
10625 internal_last_event_frame
= Qnil
;
10626 Vlast_event_frame
= internal_last_event_frame
;
10628 #ifdef MULTI_KBOARD
10629 current_kboard
= initial_kboard
;
10631 wipe_kboard (current_kboard
);
10632 init_kboard (current_kboard
);
10634 if (!noninteractive
)
10636 signal (SIGINT
, interrupt_signal
);
10637 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10638 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10639 SIGQUIT and we can't tell which one it will give us. */
10640 signal (SIGQUIT
, interrupt_signal
);
10641 #endif /* HAVE_TERMIO */
10643 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10645 if (!noninteractive
)
10646 signal (SIGIO
, input_available_signal
);
10649 /* Use interrupt input by default, if it works and noninterrupt input
10650 has deficiencies. */
10652 #ifdef INTERRUPT_INPUT
10653 interrupt_input
= 1;
10655 interrupt_input
= 0;
10658 /* Our VMS input only works by interrupts, as of now. */
10660 interrupt_input
= 1;
10666 if (keyboard_init_hook
)
10667 (*keyboard_init_hook
) ();
10669 #ifdef POLL_FOR_INPUT
10670 poll_suppress_count
= 1;
10675 /* At least provide an escape route since C-g doesn't work. */
10676 signal (SIGINT
, interrupt_signal
);
10680 /* This type's only use is in syms_of_keyboard, to initialize the
10681 event header symbols and put properties on them. */
10682 struct event_head
{
10688 struct event_head head_table
[] = {
10689 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10690 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10691 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10692 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10693 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10694 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10695 /* `select-window' should be handled just like `switch-frame'
10696 in read_key_sequence. */
10697 {&Qselect_window
, "select-window", &Qswitch_frame
}
10701 syms_of_keyboard ()
10703 Vpre_help_message
= Qnil
;
10704 staticpro (&Vpre_help_message
);
10706 Vlispy_mouse_stem
= build_string ("mouse");
10707 staticpro (&Vlispy_mouse_stem
);
10710 QCimage
= intern (":image");
10711 staticpro (&QCimage
);
10713 staticpro (&Qhelp_echo
);
10714 Qhelp_echo
= intern ("help-echo");
10716 staticpro (&item_properties
);
10717 item_properties
= Qnil
;
10719 staticpro (&tool_bar_item_properties
);
10720 tool_bar_item_properties
= Qnil
;
10721 staticpro (&tool_bar_items_vector
);
10722 tool_bar_items_vector
= Qnil
;
10724 staticpro (&real_this_command
);
10725 real_this_command
= Qnil
;
10727 Qtimer_event_handler
= intern ("timer-event-handler");
10728 staticpro (&Qtimer_event_handler
);
10730 Qdisabled_command_hook
= intern ("disabled-command-hook");
10731 staticpro (&Qdisabled_command_hook
);
10733 Qself_insert_command
= intern ("self-insert-command");
10734 staticpro (&Qself_insert_command
);
10736 Qforward_char
= intern ("forward-char");
10737 staticpro (&Qforward_char
);
10739 Qbackward_char
= intern ("backward-char");
10740 staticpro (&Qbackward_char
);
10742 Qdisabled
= intern ("disabled");
10743 staticpro (&Qdisabled
);
10745 Qundefined
= intern ("undefined");
10746 staticpro (&Qundefined
);
10748 Qpre_command_hook
= intern ("pre-command-hook");
10749 staticpro (&Qpre_command_hook
);
10751 Qpost_command_hook
= intern ("post-command-hook");
10752 staticpro (&Qpost_command_hook
);
10754 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10755 staticpro (&Qpost_command_idle_hook
);
10757 Qdeferred_action_function
= intern ("deferred-action-function");
10758 staticpro (&Qdeferred_action_function
);
10760 Qcommand_hook_internal
= intern ("command-hook-internal");
10761 staticpro (&Qcommand_hook_internal
);
10763 Qfunction_key
= intern ("function-key");
10764 staticpro (&Qfunction_key
);
10765 Qmouse_click
= intern ("mouse-click");
10766 staticpro (&Qmouse_click
);
10768 Qlanguage_change
= intern ("language-change");
10769 staticpro (&Qlanguage_change
);
10771 Qdrag_n_drop
= intern ("drag-n-drop");
10772 staticpro (&Qdrag_n_drop
);
10774 Qsave_session
= intern ("save-session");
10775 staticpro(&Qsave_session
);
10777 Qusr1_signal
= intern ("usr1-signal");
10778 staticpro (&Qusr1_signal
);
10779 Qusr2_signal
= intern ("usr2-signal");
10780 staticpro (&Qusr2_signal
);
10782 Qmenu_enable
= intern ("menu-enable");
10783 staticpro (&Qmenu_enable
);
10784 Qmenu_alias
= intern ("menu-alias");
10785 staticpro (&Qmenu_alias
);
10786 QCenable
= intern (":enable");
10787 staticpro (&QCenable
);
10788 QCvisible
= intern (":visible");
10789 staticpro (&QCvisible
);
10790 QChelp
= intern (":help");
10791 staticpro (&QChelp
);
10792 QCfilter
= intern (":filter");
10793 staticpro (&QCfilter
);
10794 QCbutton
= intern (":button");
10795 staticpro (&QCbutton
);
10796 QCkeys
= intern (":keys");
10797 staticpro (&QCkeys
);
10798 QCkey_sequence
= intern (":key-sequence");
10799 staticpro (&QCkey_sequence
);
10800 QCtoggle
= intern (":toggle");
10801 staticpro (&QCtoggle
);
10802 QCradio
= intern (":radio");
10803 staticpro (&QCradio
);
10805 Qmode_line
= intern ("mode-line");
10806 staticpro (&Qmode_line
);
10807 Qvertical_line
= intern ("vertical-line");
10808 staticpro (&Qvertical_line
);
10809 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10810 staticpro (&Qvertical_scroll_bar
);
10811 Qmenu_bar
= intern ("menu-bar");
10812 staticpro (&Qmenu_bar
);
10814 Qabove_handle
= intern ("above-handle");
10815 staticpro (&Qabove_handle
);
10816 Qhandle
= intern ("handle");
10817 staticpro (&Qhandle
);
10818 Qbelow_handle
= intern ("below-handle");
10819 staticpro (&Qbelow_handle
);
10820 Qup
= intern ("up");
10822 Qdown
= intern ("down");
10823 staticpro (&Qdown
);
10824 Qtop
= intern ("top");
10826 Qbottom
= intern ("bottom");
10827 staticpro (&Qbottom
);
10828 Qend_scroll
= intern ("end-scroll");
10829 staticpro (&Qend_scroll
);
10830 Qratio
= intern ("ratio");
10831 staticpro (&Qratio
);
10833 Qevent_kind
= intern ("event-kind");
10834 staticpro (&Qevent_kind
);
10835 Qevent_symbol_elements
= intern ("event-symbol-elements");
10836 staticpro (&Qevent_symbol_elements
);
10837 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10838 staticpro (&Qevent_symbol_element_mask
);
10839 Qmodifier_cache
= intern ("modifier-cache");
10840 staticpro (&Qmodifier_cache
);
10842 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10843 staticpro (&Qrecompute_lucid_menubar
);
10844 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10845 staticpro (&Qactivate_menubar_hook
);
10847 Qpolling_period
= intern ("polling-period");
10848 staticpro (&Qpolling_period
);
10850 Qinput_method_function
= intern ("input-method-function");
10851 staticpro (&Qinput_method_function
);
10853 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10854 staticpro (&Qinput_method_exit_on_first_char
);
10855 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10856 staticpro (&Qinput_method_use_echo_area
);
10858 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10859 Fset (Qinput_method_use_echo_area
, Qnil
);
10861 last_point_position_buffer
= Qnil
;
10864 struct event_head
*p
;
10866 for (p
= head_table
;
10867 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10870 *p
->var
= intern (p
->name
);
10871 staticpro (p
->var
);
10872 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10873 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10877 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10878 staticpro (&button_down_location
);
10879 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10880 staticpro (&mouse_syms
);
10881 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
10882 staticpro (&wheel_syms
);
10886 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10888 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10889 for (i
= 0; i
< len
; i
++)
10890 if (modifier_names
[i
])
10891 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10892 staticpro (&modifier_symbols
);
10895 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10896 staticpro (&recent_keys
);
10898 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10899 staticpro (&this_command_keys
);
10901 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10902 staticpro (&raw_keybuf
);
10904 Qextended_command_history
= intern ("extended-command-history");
10905 Fset (Qextended_command_history
, Qnil
);
10906 staticpro (&Qextended_command_history
);
10908 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10909 staticpro (&kbd_buffer_gcpro
);
10911 accent_key_syms
= Qnil
;
10912 staticpro (&accent_key_syms
);
10914 func_key_syms
= Qnil
;
10915 staticpro (&func_key_syms
);
10917 drag_n_drop_syms
= Qnil
;
10918 staticpro (&drag_n_drop_syms
);
10920 unread_switch_frame
= Qnil
;
10921 staticpro (&unread_switch_frame
);
10923 internal_last_event_frame
= Qnil
;
10924 staticpro (&internal_last_event_frame
);
10926 read_key_sequence_cmd
= Qnil
;
10927 staticpro (&read_key_sequence_cmd
);
10929 menu_bar_one_keymap_changed_items
= Qnil
;
10930 staticpro (&menu_bar_one_keymap_changed_items
);
10932 defsubr (&Sevent_convert_list
);
10933 defsubr (&Sread_key_sequence
);
10934 defsubr (&Sread_key_sequence_vector
);
10935 defsubr (&Srecursive_edit
);
10937 defsubr (&Strack_mouse
);
10939 defsubr (&Sinput_pending_p
);
10940 defsubr (&Scommand_execute
);
10941 defsubr (&Srecent_keys
);
10942 defsubr (&Sthis_command_keys
);
10943 defsubr (&Sthis_command_keys_vector
);
10944 defsubr (&Sthis_single_command_keys
);
10945 defsubr (&Sthis_single_command_raw_keys
);
10946 defsubr (&Sreset_this_command_lengths
);
10947 defsubr (&Sclear_this_command_keys
);
10948 defsubr (&Ssuspend_emacs
);
10949 defsubr (&Sabort_recursive_edit
);
10950 defsubr (&Sexit_recursive_edit
);
10951 defsubr (&Srecursion_depth
);
10952 defsubr (&Stop_level
);
10953 defsubr (&Sdiscard_input
);
10954 defsubr (&Sopen_dribble_file
);
10955 defsubr (&Sset_input_mode
);
10956 defsubr (&Scurrent_input_mode
);
10957 defsubr (&Sexecute_extended_command
);
10959 DEFVAR_LISP ("last-command-char", &last_command_char
,
10960 doc
: /* Last input event that was part of a command. */);
10962 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10963 doc
: /* Last input event that was part of a command. */);
10965 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10966 doc
: /* Last input event in a command, except for mouse menu events.
10967 Mouse menus give back keys that don't look like mouse events;
10968 this variable holds the actual mouse event that led to the menu,
10969 so that you can determine whether the command was run by mouse or not. */);
10971 DEFVAR_LISP ("last-input-char", &last_input_char
,
10972 doc
: /* Last input event. */);
10974 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10975 doc
: /* Last input event. */);
10977 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10978 doc
: /* List of events to be read as the command input.
10979 These events are processed first, before actual keyboard input. */);
10980 Vunread_command_events
= Qnil
;
10982 DEFVAR_INT ("unread-command-char", &unread_command_char
,
10983 doc
: /* If not -1, an object to be read as next command input event. */);
10985 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
10986 doc
: /* List of events to be processed as input by input methods.
10987 These events are processed after `unread-command-events', but
10988 before actual keyboard input. */);
10989 Vunread_post_input_method_events
= Qnil
;
10991 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
10992 doc
: /* List of events to be processed as input by input methods.
10993 These events are processed after `unread-command-events', but
10994 before actual keyboard input. */);
10995 Vunread_input_method_events
= Qnil
;
10997 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
10998 doc
: /* Meta-prefix character code.
10999 Meta-foo as command input turns into this character followed by foo. */);
11000 XSETINT (meta_prefix_char
, 033);
11002 DEFVAR_KBOARD ("last-command", Vlast_command
,
11003 doc
: /* The last command executed.
11004 Normally a symbol with a function definition, but can be whatever was found
11005 in the keymap, or whatever the variable `this-command' was set to by that
11008 The value `mode-exit' is special; it means that the previous command
11009 read an event that told it to exit, and it did so and unread that event.
11010 In other words, the present command is the event that made the previous
11013 The value `kill-region' is special; it means that the previous command
11014 was a kill command. */);
11016 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11017 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11019 DEFVAR_LISP ("this-command", &Vthis_command
,
11020 doc
: /* The command now being executed.
11021 The command can set this variable; whatever is put here
11022 will be in `last-command' during the following command. */);
11023 Vthis_command
= Qnil
;
11025 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11026 doc
: /* The command bound to the current key sequence before remapping.
11027 It equals `this-command' if the original command was not remapped through
11028 any of the active keymaps. Otherwise, the value of `this-command' is the
11029 result of looking up the original command in the active keymaps. */);
11030 Vthis_original_command
= Qnil
;
11032 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11033 doc
: /* *Number of input events between auto-saves.
11034 Zero means disable autosaving due to number of characters typed. */);
11035 auto_save_interval
= 300;
11037 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11038 doc
: /* *Number of seconds idle time before auto-save.
11039 Zero or nil means disable auto-saving due to idleness.
11040 After auto-saving due to this many seconds of idle time,
11041 Emacs also does a garbage collection if that seems to be warranted. */);
11042 XSETFASTINT (Vauto_save_timeout
, 30);
11044 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11045 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11046 The value may be integer or floating point. */);
11047 Vecho_keystrokes
= make_number (1);
11049 DEFVAR_INT ("polling-period", &polling_period
,
11050 doc
: /* *Interval between polling for input during Lisp execution.
11051 The reason for polling is to make C-g work to stop a running program.
11052 Polling is needed only when using X windows and SIGIO does not work.
11053 Polling is automatically disabled in all other cases. */);
11054 polling_period
= 2;
11056 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11057 doc
: /* *Maximum time between mouse clicks to make a double-click.
11058 Measured in milliseconds. nil means disable double-click recognition;
11059 t means double-clicks have no time limit and are detected
11060 by position only. */);
11061 Vdouble_click_time
= make_number (500);
11063 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11064 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11065 On window-system frames, value is the number of pixels the mouse may have
11066 moved horizontally or vertically between two clicks to make a double-click.
11067 On non window-system frames, value is interpreted in units of 1/8 characters
11070 This variable is also the threshold for motion of the mouse
11071 to count as a drag. */);
11072 double_click_fuzz
= 3;
11074 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11075 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11076 inhibit_local_menu_bar_menus
= 0;
11078 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11079 doc
: /* Number of complete key sequences read as input so far.
11080 This includes key sequences read from keyboard macros.
11081 The number is effectively the number of interactive command invocations. */);
11082 num_input_keys
= 0;
11084 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11085 doc
: /* Number of input events read from the keyboard so far.
11086 This does not include events generated by keyboard macros. */);
11087 num_nonmacro_input_events
= 0;
11089 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11090 doc
: /* The frame in which the most recently read event occurred.
11091 If the last event came from a keyboard macro, this is set to `macro'. */);
11092 Vlast_event_frame
= Qnil
;
11094 /* This variable is set up in sysdep.c. */
11095 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11096 doc
: /* The ERASE character as set by the user with stty. */);
11098 DEFVAR_LISP ("help-char", &Vhelp_char
,
11099 doc
: /* Character to recognize as meaning Help.
11100 When it is read, do `(eval help-form)', and display result if it's a string.
11101 If the value of `help-form' is nil, this char can be read normally. */);
11102 XSETINT (Vhelp_char
, Ctl ('H'));
11104 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11105 doc
: /* List of input events to recognize as meaning Help.
11106 These work just like the value of `help-char' (see that). */);
11107 Vhelp_event_list
= Qnil
;
11109 DEFVAR_LISP ("help-form", &Vhelp_form
,
11110 doc
: /* Form to execute when character `help-char' is read.
11111 If the form returns a string, that string is displayed.
11112 If `help-form' is nil, the help char is not recognized. */);
11115 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11116 doc
: /* Command to run when `help-char' character follows a prefix key.
11117 This command is used only when there is no actual binding
11118 for that character after that prefix key. */);
11119 Vprefix_help_command
= Qnil
;
11121 DEFVAR_LISP ("top-level", &Vtop_level
,
11122 doc
: /* Form to evaluate when Emacs starts up.
11123 Useful to set before you dump a modified Emacs. */);
11126 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11127 doc
: /* Translate table for keyboard input, or nil.
11128 Each character is looked up in this string and the contents used instead.
11129 The value may be a string, a vector, or a char-table.
11130 If it is a string or vector of length N,
11131 character codes N and up are untranslated.
11132 In a vector or a char-table, an element which is nil means "no translation".
11134 This is applied to the characters supplied to input methods, not their
11135 output. See also `translation-table-for-input'. */);
11136 Vkeyboard_translate_table
= Qnil
;
11138 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11139 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11140 \(Even if the operating system has support for stopping a process.\) */);
11141 cannot_suspend
= 0;
11143 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11144 doc
: /* Non-nil means prompt with menus when appropriate.
11145 This is done when reading from a keymap that has a prompt string,
11146 for elements that have prompt strings.
11147 The menu is displayed on the screen
11148 if X menus were enabled at configuration
11149 time and the previous event was a mouse click prefix key.
11150 Otherwise, menu prompting uses the echo area. */);
11151 menu_prompting
= 1;
11153 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11154 doc
: /* Character to see next line of menu prompt.
11155 Type this character while in a menu prompt to rotate around the lines of it. */);
11156 XSETINT (menu_prompt_more_char
, ' ');
11158 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11159 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11160 Emacs applies the modifiers of the character stored here to each keyboard
11161 character it reads. For example, after evaluating the expression
11162 (setq extra-keyboard-modifiers ?\\C-x)
11163 all input characters will have the control modifier applied to them.
11165 Note that the character ?\\C-@, equivalent to the integer zero, does
11166 not count as a control character; rather, it counts as a character
11167 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11168 cancels any modification. */);
11169 extra_keyboard_modifiers
= 0;
11171 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11172 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11173 The command loop sets this to nil before each command,
11174 and tests the value when the command returns.
11175 Buffer modification stores t in this variable. */);
11176 Vdeactivate_mark
= Qnil
;
11178 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11179 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11180 Vcommand_hook_internal
= Qnil
;
11182 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11183 doc
: /* Normal hook run before each command is executed.
11184 If an unhandled error happens in running this hook,
11185 the hook value is set to nil, since otherwise the error
11186 might happen repeatedly and make Emacs nonfunctional. */);
11187 Vpre_command_hook
= Qnil
;
11189 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11190 doc
: /* Normal hook run after each command is executed.
11191 If an unhandled error happens in running this hook,
11192 the hook value is set to nil, since otherwise the error
11193 might happen repeatedly and make Emacs nonfunctional. */);
11194 Vpost_command_hook
= Qnil
;
11196 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11197 doc
: /* Normal hook run after each command is executed, if idle.
11198 Errors running the hook are caught and ignored. */);
11199 Vpost_command_idle_hook
= Qnil
;
11201 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11202 doc
: /* Delay time before running `post-command-idle-hook'.
11203 This is measured in microseconds. */);
11204 post_command_idle_delay
= 100000;
11207 DEFVAR_LISP ("echo-area-clear-hook", ...,
11208 doc
: /* Normal hook run when clearing the echo area. */);
11210 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11211 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11213 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11214 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11215 Vlucid_menu_bar_dirty_flag
= Qnil
;
11217 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11218 doc
: /* List of menu bar items to move to the end of the menu bar.
11219 The elements of the list are event types that may have menu bar bindings. */);
11220 Vmenu_bar_final_items
= Qnil
;
11222 DEFVAR_KBOARD ("overriding-terminal-local-map",
11223 Voverriding_terminal_local_map
,
11224 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11225 If this variable is non-nil, it is used as a keymap instead of the
11226 buffer's local map, and the minor mode keymaps and text property keymaps.
11227 This variable is intended to let commands such as `universal-argument'
11228 set up a different keymap for reading the next command. */);
11230 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11231 doc
: /* Keymap that overrides all other local keymaps.
11232 If this variable is non-nil, it is used as a keymap instead of the
11233 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11234 Voverriding_local_map
= Qnil
;
11236 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11237 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11238 Otherwise, the menu bar continues to reflect the buffer's local map
11239 and the minor mode maps regardless of `overriding-local-map'. */);
11240 Voverriding_local_map_menu_flag
= Qnil
;
11242 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11243 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11244 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11246 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11247 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11249 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11250 doc
: /* Alist of system-specific X windows key symbols.
11251 Each element should have the form (N . SYMBOL) where N is the
11252 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11253 and SYMBOL is its name. */);
11255 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11256 doc
: /* List of deferred actions to be performed at a later time.
11257 The precise format isn't relevant here; we just check whether it is nil. */);
11258 Vdeferred_action_list
= Qnil
;
11260 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11261 doc
: /* Function to call to handle deferred actions, after each command.
11262 This function is called with no arguments after each command
11263 whenever `deferred-action-list' is non-nil. */);
11264 Vdeferred_action_function
= Qnil
;
11266 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11267 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11268 The value can be a length of time to show the message for.
11269 If the value is non-nil and not a number, we wait 2 seconds. */);
11270 Vsuggest_key_bindings
= Qt
;
11272 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11273 doc
: /* List of active absolute time timers in order of increasing time. */);
11274 Vtimer_list
= Qnil
;
11276 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11277 doc
: /* List of active idle-time timers in order of increasing time. */);
11278 Vtimer_idle_list
= Qnil
;
11280 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11281 doc
: /* If non-nil, the function that implements the current input method.
11282 It's called with one argument, a printing character that was just read.
11283 \(That means a character with code 040...0176.)
11284 Typically this function uses `read-event' to read additional events.
11285 When it does so, it should first bind `input-method-function' to nil
11286 so it will not be called recursively.
11288 The function should return a list of zero or more events
11289 to be used as input. If it wants to put back some events
11290 to be reconsidered, separately, by the input method,
11291 it can add them to the beginning of `unread-command-events'.
11293 The input method function can find in `input-method-previous-method'
11294 the previous echo area message.
11296 The input method function should refer to the variables
11297 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11298 for guidance on what to do. */);
11299 Vinput_method_function
= Qnil
;
11301 DEFVAR_LISP ("input-method-previous-message",
11302 &Vinput_method_previous_message
,
11303 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11304 This variable exists because `read-event' clears the echo area
11305 before running the input method. It is nil if there was no message. */);
11306 Vinput_method_previous_message
= Qnil
;
11308 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11309 doc
: /* If non-nil, the function that implements the display of help.
11310 It's called with one argument, the help string to display. */);
11311 Vshow_help_function
= Qnil
;
11313 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11314 doc
: /* If non-nil, suppress point adjustment after executing a command.
11316 After a command is executed, if point is moved into a region that has
11317 special properties (e.g. composition, display), we adjust point to
11318 the boundary of the region. But, several special commands sets this
11319 variable to non-nil, then we suppress the point adjustment.
11321 This variable is set to nil before reading a command, and is checked
11322 just after executing the command. */);
11323 Vdisable_point_adjustment
= Qnil
;
11325 DEFVAR_LISP ("global-disable-point-adjustment",
11326 &Vglobal_disable_point_adjustment
,
11327 doc
: /* *If non-nil, always suppress point adjustment.
11329 The default value is nil, in which case, point adjustment are
11330 suppressed only after special commands that set
11331 `disable-point-adjustment' (which see) to non-nil. */);
11332 Vglobal_disable_point_adjustment
= Qnil
;
11334 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11335 doc
: /* Non-nil means updating menu bindings is allowed.
11336 A value of nil means menu bindings should not be updated.
11337 Used during Emacs' startup. */);
11338 update_menu_bindings
= 1;
11340 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11341 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11342 If the value is not a number, such messages don't time out. */);
11343 Vminibuffer_message_timeout
= make_number (2);
11347 keys_of_keyboard ()
11349 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11350 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11351 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11352 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11353 initial_define_key (meta_map
, 'x', "execute-extended-command");
11355 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11356 "handle-delete-frame");
11357 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11359 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11361 /* Handling it at such a low-level causes read_key_sequence to get
11362 * confused because it doesn't realize that the current_buffer was
11363 * changed by read_char.
11365 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11366 * "handle-select-window"); */
11367 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11368 "handle-save-session");
11371 /* Mark the pointers in the kboard objects.
11372 Called by the Fgarbage_collector. */
11378 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11380 if (kb
->kbd_macro_buffer
)
11381 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11383 mark_object (kb
->Voverriding_terminal_local_map
);
11384 mark_object (kb
->Vlast_command
);
11385 mark_object (kb
->Vreal_last_command
);
11386 mark_object (kb
->Vprefix_arg
);
11387 mark_object (kb
->Vlast_prefix_arg
);
11388 mark_object (kb
->kbd_queue
);
11389 mark_object (kb
->defining_kbd_macro
);
11390 mark_object (kb
->Vlast_kbd_macro
);
11391 mark_object (kb
->Vsystem_key_alist
);
11392 mark_object (kb
->system_key_syms
);
11393 mark_object (kb
->Vdefault_minibuffer_frame
);
11394 mark_object (kb
->echo_string
);
11397 struct input_event
*event
;
11398 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11400 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11401 event
= kbd_buffer
;
11402 mark_object (event
->x
);
11403 mark_object (event
->y
);
11404 mark_object (event
->frame_or_window
);
11405 mark_object (event
->arg
);
11410 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11411 (do not change this comment) */