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
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
28 #include "termhooks.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
53 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
60 #include <sys/types.h>
65 /* This is to get the definitions of the XK_ symbols. */
72 #endif /* HAVE_NTGUI */
82 /* Variables for blockinput.h: */
84 /* Non-zero if interrupt input is blocked right now. */
85 int interrupt_input_blocked
;
87 /* Nonzero means an input interrupt has arrived
88 during the current critical section. */
89 int interrupt_input_pending
;
92 /* File descriptor to use for input. */
95 #ifdef HAVE_WINDOW_SYSTEM
96 /* Make all keyboard buffers much bigger when using X windows. */
98 /* But not too big (local data > 32K error) if on Mac OS Classic. */
99 #define KBD_BUFFER_SIZE 512
101 #define KBD_BUFFER_SIZE 4096
103 #else /* No X-windows, character input */
104 #define KBD_BUFFER_SIZE 4096
105 #endif /* No X-windows */
107 #define abs(x) ((x) >= 0 ? (x) : -(x))
109 /* Following definition copied from eval.c */
113 struct backtrace
*next
;
114 Lisp_Object
*function
;
115 Lisp_Object
*args
; /* Points to vector of args. */
116 int nargs
; /* length of vector. If nargs is UNEVALLED,
117 args points to slot holding list of
123 KBOARD
*initial_kboard
;
124 KBOARD
*current_kboard
;
128 KBOARD the_only_kboard
;
131 /* Non-nil disable property on a command means
132 do not execute it; call disabled-command-hook's value instead. */
133 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
135 #define NUM_RECENT_KEYS (100)
136 int recent_keys_index
; /* Index for storing next element into recent_keys */
137 int total_keys
; /* Total number of elements stored into recent_keys */
138 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
140 /* Vector holding the key sequence that invoked the current command.
141 It is reused for each command, and it may be longer than the current
142 sequence; this_command_key_count indicates how many elements
143 actually mean something.
144 It's easier to staticpro a single Lisp_Object than an array. */
145 Lisp_Object this_command_keys
;
146 int this_command_key_count
;
148 /* This vector is used as a buffer to record the events that were actually read
149 by read_key_sequence. */
150 Lisp_Object raw_keybuf
;
151 int raw_keybuf_count
;
153 #define GROW_RAW_KEYBUF \
154 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
156 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
158 new = Fmake_vector (make_number (newsize), Qnil); \
159 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
160 raw_keybuf_count * sizeof (Lisp_Object)); \
164 /* Number of elements of this_command_keys
165 that precede this key sequence. */
166 int this_single_command_key_start
;
168 /* Record values of this_command_key_count and echo_length ()
169 before this command was read. */
170 static int before_command_key_count
;
171 static int before_command_echo_length
;
172 /* Values of before_command_key_count and before_command_echo_length
173 saved by reset-this-command-lengths. */
174 static int before_command_key_count_1
;
175 static int before_command_echo_length_1
;
176 /* Flag set by reset-this-command-lengths,
177 saying to reset the lengths when add_command_key is called. */
178 static int before_command_restore_flag
;
180 extern int minbuf_level
;
182 extern int message_enable_multibyte
;
184 extern struct backtrace
*backtrace_list
;
186 /* If non-nil, the function that implements the display of help.
187 It's called with one argument, the help string to display. */
189 Lisp_Object Vshow_help_function
;
191 /* If a string, the message displayed before displaying a help-echo
194 Lisp_Object Vpre_help_message
;
196 /* Nonzero means do menu prompting. */
198 static int menu_prompting
;
200 /* Character to see next line of menu prompt. */
202 static Lisp_Object menu_prompt_more_char
;
204 /* For longjmp to where kbd input is being done. */
206 static jmp_buf getcjmp
;
208 /* True while doing kbd input. */
209 int waiting_for_input
;
211 /* True while displaying for echoing. Delays C-g throwing. */
215 /* Non-null means we can start echoing at the next input pause even
216 though there is something in the echo area. */
218 static struct kboard
*ok_to_echo_at_next_pause
;
220 /* The kboard last echoing, or null for none. Reset to 0 in
221 cancel_echoing. If non-null, and a current echo area message
222 exists, and echo_message_buffer is eq to the current message
223 buffer, we know that the message comes from echo_kboard. */
225 struct kboard
*echo_kboard
;
227 /* The buffer used for echoing. Set in echo_now, reset in
230 Lisp_Object echo_message_buffer
;
232 /* Nonzero means disregard local maps for the menu bar. */
233 static int inhibit_local_menu_bar_menus
;
235 /* Nonzero means C-g should cause immediate error-signal. */
238 /* The user's ERASE setting. */
239 Lisp_Object Vtty_erase_char
;
241 /* Character to recognize as the help char. */
242 Lisp_Object Vhelp_char
;
244 /* List of other event types to recognize as meaning "help". */
245 Lisp_Object Vhelp_event_list
;
247 /* Form to execute when help char is typed. */
248 Lisp_Object Vhelp_form
;
250 /* Command to run when the help character follows a prefix key. */
251 Lisp_Object Vprefix_help_command
;
253 /* List of items that should move to the end of the menu bar. */
254 Lisp_Object Vmenu_bar_final_items
;
256 /* Non-nil means show the equivalent key-binding for
257 any M-x command that has one.
258 The value can be a length of time to show the message for.
259 If the value is non-nil and not a number, we wait 2 seconds. */
260 Lisp_Object Vsuggest_key_bindings
;
262 /* How long to display an echo-area message when the minibuffer is active.
263 If the value is not a number, such messages don't time out. */
264 Lisp_Object Vminibuffer_message_timeout
;
266 /* Character that causes a quit. Normally C-g.
268 If we are running on an ordinary terminal, this must be an ordinary
269 ASCII char, since we want to make it our interrupt character.
271 If we are not running on an ordinary terminal, it still needs to be
272 an ordinary ASCII char. This character needs to be recognized in
273 the input interrupt handler. At this point, the keystroke is
274 represented as a struct input_event, while the desired quit
275 character is specified as a lispy event. The mapping from struct
276 input_events to lispy events cannot run in an interrupt handler,
277 and the reverse mapping is difficult for anything but ASCII
280 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
284 extern Lisp_Object current_global_map
;
285 extern int minibuf_level
;
287 /* If non-nil, this is a map that overrides all other local maps. */
288 Lisp_Object Voverriding_local_map
;
290 /* If non-nil, Voverriding_local_map applies to the menu bar. */
291 Lisp_Object Voverriding_local_map_menu_flag
;
293 /* Keymap that defines special misc events that should
294 be processed immediately at a low level. */
295 Lisp_Object Vspecial_event_map
;
297 /* Current depth in recursive edits. */
298 int command_loop_level
;
300 /* Total number of times command_loop has read a key sequence. */
301 EMACS_INT num_input_keys
;
303 /* Last input character read as a command. */
304 Lisp_Object last_command_char
;
306 /* Last input character read as a command, not counting menus
307 reached by the mouse. */
308 Lisp_Object last_nonmenu_event
;
310 /* Last input character read for any purpose. */
311 Lisp_Object last_input_char
;
313 /* If not Qnil, a list of objects to be read as subsequent command input. */
314 Lisp_Object Vunread_command_events
;
316 /* If not Qnil, a list of objects to be read as subsequent command input
317 including input method processing. */
318 Lisp_Object Vunread_input_method_events
;
320 /* If not Qnil, a list of objects to be read as subsequent command input
321 but NOT including input method processing. */
322 Lisp_Object Vunread_post_input_method_events
;
324 /* If not -1, an event to be read as subsequent command input. */
325 EMACS_INT unread_command_char
;
327 /* If not Qnil, this is a switch-frame event which we decided to put
328 off until the end of a key sequence. This should be read as the
329 next command input, after any unread_command_events.
331 read_key_sequence uses this to delay switch-frame events until the
332 end of the key sequence; Fread_char uses it to put off switch-frame
333 events until a non-ASCII event is acceptable as input. */
334 Lisp_Object unread_switch_frame
;
336 /* A mask of extra modifier bits to put into every keyboard char. */
337 EMACS_INT extra_keyboard_modifiers
;
339 /* Char to use as prefix when a meta character is typed in.
340 This is bound on entry to minibuffer in case ESC is changed there. */
342 Lisp_Object meta_prefix_char
;
344 /* Last size recorded for a current buffer which is not a minibuffer. */
345 static int last_non_minibuf_size
;
347 /* Number of idle seconds before an auto-save and garbage collection. */
348 static Lisp_Object Vauto_save_timeout
;
350 /* Total number of times read_char has returned. */
351 int num_input_events
;
353 /* Total number of times read_char has returned, outside of macros. */
354 EMACS_INT num_nonmacro_input_events
;
356 /* Auto-save automatically when this many characters have been typed
357 since the last time. */
359 static EMACS_INT auto_save_interval
;
361 /* Value of num_nonmacro_input_events as of last auto save. */
365 /* The command being executed by the command loop.
366 Commands may set this, and the value set will be copied into
367 current_kboard->Vlast_command instead of the actual command. */
368 Lisp_Object Vthis_command
;
370 /* This is like Vthis_command, except that commands never set it. */
371 Lisp_Object real_this_command
;
373 /* If the lookup of the command returns a binding, the original
374 command is stored in this-original-command. It is nil otherwise. */
375 Lisp_Object Vthis_original_command
;
377 /* The value of point when the last command was executed. */
378 int last_point_position
;
380 /* The buffer that was current when the last command was started. */
381 Lisp_Object last_point_position_buffer
;
383 /* The frame in which the last input event occurred, or Qmacro if the
384 last event came from a macro. We use this to determine when to
385 generate switch-frame events. This may be cleared by functions
386 like Fselect_frame, to make sure that a switch-frame event is
387 generated by the next character. */
388 Lisp_Object internal_last_event_frame
;
390 /* A user-visible version of the above, intended to allow users to
391 figure out where the last event came from, if the event doesn't
392 carry that information itself (i.e. if it was a character). */
393 Lisp_Object Vlast_event_frame
;
395 /* The timestamp of the last input event we received from the X server.
396 X Windows wants this for selection ownership. */
397 unsigned long last_event_timestamp
;
399 Lisp_Object Qself_insert_command
;
400 Lisp_Object Qforward_char
;
401 Lisp_Object Qbackward_char
;
402 Lisp_Object Qundefined
;
403 Lisp_Object Qtimer_event_handler
;
405 /* read_key_sequence stores here the command definition of the
406 key sequence that it reads. */
407 Lisp_Object read_key_sequence_cmd
;
409 /* Echo unfinished commands after this many seconds of pause. */
410 Lisp_Object Vecho_keystrokes
;
412 /* Form to evaluate (if non-nil) when Emacs is started. */
413 Lisp_Object Vtop_level
;
415 /* User-supplied table to translate input characters. */
416 Lisp_Object Vkeyboard_translate_table
;
418 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
419 extern Lisp_Object Vfunction_key_map
;
421 /* Another keymap that maps key sequences into key sequences.
422 This one takes precedence over ordinary definitions. */
423 extern Lisp_Object Vkey_translation_map
;
425 /* If non-nil, this implements the current input method. */
426 Lisp_Object Vinput_method_function
;
427 Lisp_Object Qinput_method_function
;
429 /* When we call Vinput_method_function,
430 this holds the echo area message that was just erased. */
431 Lisp_Object Vinput_method_previous_message
;
433 /* Non-nil means deactivate the mark at end of this command. */
434 Lisp_Object Vdeactivate_mark
;
436 /* Menu bar specified in Lucid Emacs fashion. */
438 Lisp_Object Vlucid_menu_bar_dirty_flag
;
439 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
441 Lisp_Object Qecho_area_clear_hook
;
443 /* Hooks to run before and after each command. */
444 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
445 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
446 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
447 /* Hook run after a command if there's no more input soon. */
448 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
450 /* Delay time in microseconds before running post-command-idle-hook. */
451 EMACS_INT post_command_idle_delay
;
453 /* List of deferred actions to be performed at a later time.
454 The precise format isn't relevant here; we just check whether it is nil. */
455 Lisp_Object Vdeferred_action_list
;
457 /* Function to call to handle deferred actions, when there are any. */
458 Lisp_Object Vdeferred_action_function
;
459 Lisp_Object Qdeferred_action_function
;
461 Lisp_Object Qinput_method_exit_on_first_char
;
462 Lisp_Object Qinput_method_use_echo_area
;
464 /* File in which we write all commands we read. */
467 /* Nonzero if input is available. */
470 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
471 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
475 /* Non-zero means force key bindings update in parse_menu_item. */
477 int update_menu_bindings
;
479 extern char *pending_malloc_warning
;
481 /* Circular buffer for pre-read keyboard input. */
483 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
485 /* Vector to GCPRO the Lisp objects referenced from kbd_buffer.
487 The interrupt-level event handlers will never enqueue an event on a
488 frame which is not in Vframe_list, and once an event is dequeued,
489 internal_last_event_frame or the event itself points to the frame.
492 But while the event is sitting in the queue, it's completely
493 unprotected. Suppose the user types one command which will run for
494 a while and then delete a frame, and then types another event at
495 the frame that will be deleted, before the command gets around to
496 it. Suppose there are no references to this frame elsewhere in
497 Emacs, and a GC occurs before the second event is dequeued. Now we
498 have an event referring to a freed frame, which will crash Emacs
501 Similar things happen when an event on a scroll bar is enqueued; the
502 window may be deleted while the event is in the queue.
504 So, we use this vector to protect the Lisp_Objects in the event
505 queue. That way, they'll be dequeued as dead frames or windows,
506 but still valid Lisp objects.
508 If kbd_buffer[i].kind != NO_EVENT, then
510 AREF (kbd_buffer_gcpro, 2 * i) == kbd_buffer[i].frame_or_window.
511 AREF (kbd_buffer_gcpro, 2 * i + 1) == kbd_buffer[i].arg. */
513 static Lisp_Object kbd_buffer_gcpro
;
515 /* Pointer to next available character in kbd_buffer.
516 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
517 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
518 next available char is in kbd_buffer[0]. */
519 static struct input_event
*kbd_fetch_ptr
;
521 /* Pointer to next place to store character in kbd_buffer. This
522 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
523 character should go in kbd_buffer[0]. */
524 static struct input_event
* volatile kbd_store_ptr
;
526 /* The above pair of variables forms a "queue empty" flag. When we
527 enqueue a non-hook event, we increment kbd_store_ptr. When we
528 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
529 there is input available iff the two pointers are not equal.
531 Why not just have a flag set and cleared by the enqueuing and
532 dequeuing functions? Such a flag could be screwed up by interrupts
533 at inopportune times. */
535 /* If this flag is non-nil, we check mouse_moved to see when the
536 mouse moves, and motion events will appear in the input stream.
537 Otherwise, mouse motion is ignored. */
538 Lisp_Object do_mouse_tracking
;
540 /* Symbols to head events. */
541 Lisp_Object Qmouse_movement
;
542 Lisp_Object Qscroll_bar_movement
;
543 Lisp_Object Qswitch_frame
;
544 Lisp_Object Qdelete_frame
;
545 Lisp_Object Qiconify_frame
;
546 Lisp_Object Qmake_frame_visible
;
547 Lisp_Object Qselect_window
;
548 Lisp_Object Qhelp_echo
;
550 /* Symbols to denote kinds of events. */
551 Lisp_Object Qfunction_key
;
552 Lisp_Object Qmouse_click
;
553 #if defined(WINDOWSNT) || defined(MAC_OSX)
554 Lisp_Object Qmouse_wheel
;
557 Lisp_Object Qlanguage_change
;
559 Lisp_Object Qdrag_n_drop
;
560 Lisp_Object Qsave_session
;
562 /* Lisp_Object Qmouse_movement; - also an event header */
564 /* Properties of event headers. */
565 Lisp_Object Qevent_kind
;
566 Lisp_Object Qevent_symbol_elements
;
568 /* menu item parts */
569 Lisp_Object Qmenu_alias
;
570 Lisp_Object Qmenu_enable
;
571 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
572 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
573 extern Lisp_Object Vdefine_key_rebound_commands
;
574 extern Lisp_Object Qmenu_item
;
576 /* An event header symbol HEAD may have a property named
577 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
578 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
579 mask of modifiers applied to it. If present, this is used to help
580 speed up parse_modifiers. */
581 Lisp_Object Qevent_symbol_element_mask
;
583 /* An unmodified event header BASE may have a property named
584 Qmodifier_cache, which is an alist mapping modifier masks onto
585 modified versions of BASE. If present, this helps speed up
587 Lisp_Object Qmodifier_cache
;
589 /* Symbols to use for parts of windows. */
590 Lisp_Object Qmode_line
;
591 Lisp_Object Qvertical_line
;
592 Lisp_Object Qvertical_scroll_bar
;
593 Lisp_Object Qmenu_bar
;
594 extern Lisp_Object Qleft_margin
, Qright_margin
;
596 Lisp_Object
recursive_edit_unwind (), command_loop ();
597 Lisp_Object
Fthis_command_keys ();
598 Lisp_Object Qextended_command_history
;
599 EMACS_TIME
timer_check ();
601 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
603 extern char *x_get_keysym_name ();
605 static void record_menu_key ();
607 Lisp_Object Qpolling_period
;
609 /* List of absolute timers. Appears in order of next scheduled event. */
610 Lisp_Object Vtimer_list
;
612 /* List of idle time timers. Appears in order of next scheduled event. */
613 Lisp_Object Vtimer_idle_list
;
615 /* Incremented whenever a timer is run. */
618 extern Lisp_Object Vprint_level
, Vprint_length
;
620 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
622 EMACS_TIME
*input_available_clear_time
;
624 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
625 Default is 1 if INTERRUPT_INPUT is defined. */
628 /* Nonzero while interrupts are temporarily deferred during redisplay. */
629 int interrupts_deferred
;
631 /* Nonzero means use ^S/^Q for flow control. */
634 /* Allow m- file to inhibit use of FIONREAD. */
635 #ifdef BROKEN_FIONREAD
639 /* We are unable to use interrupts if FIONREAD is not available,
640 so flush SIGIO so we won't try. */
647 /* If we support a window system, turn on the code to poll periodically
648 to detect C-g. It isn't actually used when doing interrupt input. */
649 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
650 #define POLL_FOR_INPUT
653 /* After a command is executed, if point is moved into a region that
654 has specific properties (e.g. composition, display), we adjust
655 point to the boundary of the region. But, if a command sets this
656 variable to non-nil, we suppress this point adjustment. This
657 variable is set to nil before reading a command. */
659 Lisp_Object Vdisable_point_adjustment
;
661 /* If non-nil, always disable point adjustment. */
663 Lisp_Object Vglobal_disable_point_adjustment
;
665 /* The time when Emacs started being idle. */
667 static EMACS_TIME timer_idleness_start_time
;
669 /* After Emacs stops being idle, this saves the last value
670 of timer_idleness_start_time from when it was idle. */
672 static EMACS_TIME timer_last_idleness_start_time
;
675 /* Global variable declarations. */
677 /* Function for init_keyboard to call with no args (if nonzero). */
678 void (*keyboard_init_hook
) ();
680 static int read_avail_input
P_ ((int));
681 static void get_input_pending
P_ ((int *, int));
682 static void get_filtered_input_pending
P_ ((int *, int, int));
683 static int readable_events
P_ ((int));
684 static int readable_filtered_events
P_ ((int, int));
685 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
686 Lisp_Object
, int *));
687 static Lisp_Object
read_char_x_menu_prompt ();
688 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
690 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
692 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
693 enum scroll_bar_part
,
694 Lisp_Object
, Lisp_Object
,
697 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
698 Lisp_Object
, char **,
699 Lisp_Object
*, unsigned));
700 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
701 static int parse_solitary_modifier
P_ ((Lisp_Object
));
702 static int parse_solitary_modifier ();
703 static void save_getcjmp
P_ ((jmp_buf));
704 static void save_getcjmp ();
705 static void restore_getcjmp
P_ ((jmp_buf));
706 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
707 static void clear_event
P_ ((struct input_event
*));
708 static void any_kboard_state
P_ ((void));
709 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
711 /* Nonzero means don't try to suspend even if the operating system seems
713 static int cannot_suspend
;
715 /* Install the string STR as the beginning of the string of echoing,
716 so that it serves as a prompt for the next character.
717 Also start echoing. */
723 current_kboard
->echo_string
= str
;
724 current_kboard
->echo_after_prompt
= SCHARS (str
);
728 /* Add C to the echo string, if echoing is going on.
729 C can be a character, which is printed prettily ("M-C-x" and all that
730 jazz), or a symbol, whose name is printed. */
736 if (current_kboard
->immediate_echo
)
738 int size
= KEY_DESCRIPTION_SIZE
+ 100;
739 char *buffer
= (char *) alloca (size
);
741 Lisp_Object echo_string
;
743 echo_string
= current_kboard
->echo_string
;
745 /* If someone has passed us a composite event, use its head symbol. */
750 ptr
= push_key_description (XINT (c
), ptr
, 1);
752 else if (SYMBOLP (c
))
754 Lisp_Object name
= SYMBOL_NAME (c
);
755 int nbytes
= SBYTES (name
);
757 if (size
- (ptr
- buffer
) < nbytes
)
759 int offset
= ptr
- buffer
;
760 size
= max (2 * size
, size
+ nbytes
);
761 buffer
= (char *) alloca (size
);
762 ptr
= buffer
+ offset
;
765 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
766 STRING_MULTIBYTE (name
), 1);
769 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
772 const char *text
= " (Type ? for further options)";
773 int len
= strlen (text
);
775 if (size
- (ptr
- buffer
) < len
)
777 int offset
= ptr
- buffer
;
779 buffer
= (char *) alloca (size
);
780 ptr
= buffer
+ offset
;
783 bcopy (text
, ptr
, len
);
787 /* Replace a dash from echo_dash with a space, otherwise
788 add a space at the end as a separator between keys. */
789 if (STRINGP (echo_string
)
790 && SCHARS (echo_string
) > 0)
792 Lisp_Object last_char
, idx
;
794 idx
= make_number (SCHARS (echo_string
) - 1);
795 last_char
= Faref (echo_string
, idx
);
797 if (XINT (last_char
) == '-')
798 Faset (echo_string
, idx
, make_number (' '));
800 echo_string
= concat2 (echo_string
, build_string (" "));
803 current_kboard
->echo_string
804 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
810 /* Temporarily add a dash to the end of the echo string if it's not
811 empty, so that it serves as a mini-prompt for the very next character. */
816 /* Do nothing if not echoing at all. */
817 if (NILP (current_kboard
->echo_string
))
820 if (!current_kboard
->immediate_echo
821 && SCHARS (current_kboard
->echo_string
) == 0)
824 /* Do nothing if we just printed a prompt. */
825 if (current_kboard
->echo_after_prompt
826 == SCHARS (current_kboard
->echo_string
))
829 /* Put a dash at the end of the buffer temporarily,
830 but make it go away when the next character is added. */
831 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
836 /* Display the current echo string, and begin echoing if not already
842 if (!current_kboard
->immediate_echo
)
845 current_kboard
->immediate_echo
= 1;
847 for (i
= 0; i
< this_command_key_count
; i
++)
850 c
= XVECTOR (this_command_keys
)->contents
[i
];
851 if (! (EVENT_HAS_PARAMETERS (c
)
852 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
859 message3_nolog (current_kboard
->echo_string
,
860 SBYTES (current_kboard
->echo_string
),
861 STRING_MULTIBYTE (current_kboard
->echo_string
));
864 /* Record in what buffer we echoed, and from which kboard. */
865 echo_message_buffer
= echo_area_buffer
[0];
866 echo_kboard
= current_kboard
;
868 if (waiting_for_input
&& !NILP (Vquit_flag
))
869 quit_throw_to_read_char ();
872 /* Turn off echoing, for the start of a new command. */
877 current_kboard
->immediate_echo
= 0;
878 current_kboard
->echo_after_prompt
= -1;
879 current_kboard
->echo_string
= Qnil
;
880 ok_to_echo_at_next_pause
= NULL
;
882 echo_message_buffer
= Qnil
;
885 /* Return the length of the current echo string. */
890 return (STRINGP (current_kboard
->echo_string
)
891 ? SCHARS (current_kboard
->echo_string
)
895 /* Truncate the current echo message to its first LEN chars.
896 This and echo_char get used by read_key_sequence when the user
897 switches frames while entering a key sequence. */
900 echo_truncate (nchars
)
903 if (STRINGP (current_kboard
->echo_string
))
904 current_kboard
->echo_string
905 = Fsubstring (current_kboard
->echo_string
,
906 make_number (0), make_number (nchars
));
907 truncate_echo_area (nchars
);
911 /* Functions for manipulating this_command_keys. */
913 add_command_key (key
)
916 /* If reset-this-command-length was called recently, obey it now.
917 See the doc string of that function for an explanation of why. */
918 if (before_command_restore_flag
)
920 this_command_key_count
= before_command_key_count_1
;
921 if (this_command_key_count
< this_single_command_key_start
)
922 this_single_command_key_start
= this_command_key_count
;
923 echo_truncate (before_command_echo_length_1
);
924 before_command_restore_flag
= 0;
927 if (this_command_key_count
>= ASIZE (this_command_keys
))
928 this_command_keys
= larger_vector (this_command_keys
,
929 2 * ASIZE (this_command_keys
),
932 AREF (this_command_keys
, this_command_key_count
) = key
;
933 ++this_command_key_count
;
940 int count
= SPECPDL_INDEX ();
943 if (command_loop_level
> 0)
945 specbind (Qstandard_output
, Qt
);
946 specbind (Qstandard_input
, Qt
);
949 #ifdef HAVE_X_WINDOWS
950 /* The command loop has started an hourglass timer, so we have to
951 cancel it here, otherwise it will fire because the recursive edit
952 can take some time. Do not check for display_hourglass_p here,
953 because it could already be nil. */
957 /* This function may have been called from a debugger called from
958 within redisplay, for instance by Edebugging a function called
959 from fontification-functions. We want to allow redisplay in
960 the debugging session.
962 The recursive edit is left with a `(throw exit ...)'. The `exit'
963 tag is not caught anywhere in redisplay, i.e. when we leave the
964 recursive edit, the original redisplay leading to the recursive
965 edit will be unwound. The outcome should therefore be safe. */
966 specbind (Qinhibit_redisplay
, Qnil
);
969 val
= command_loop ();
971 Fsignal (Qquit
, Qnil
);
972 /* Handle throw from read_minibuf when using minibuffer
973 while it's active but we're in another window. */
975 Fsignal (Qerror
, Fcons (val
, Qnil
));
977 return unbind_to (count
, Qnil
);
980 /* When an auto-save happens, record the "time", and don't do again soon. */
985 last_auto_save
= num_nonmacro_input_events
;
988 /* Make an auto save happen as soon as possible at command level. */
991 force_auto_save_soon ()
993 last_auto_save
= - auto_save_interval
- 1;
995 record_asynch_buffer_change ();
998 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
999 doc
: /* Invoke the editor command loop recursively.
1000 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1001 that tells this function to return.
1002 Alternately, `(throw 'exit t)' makes this function signal an error.
1003 This function is called by the editor initialization to begin editing. */)
1006 int count
= SPECPDL_INDEX ();
1009 command_loop_level
++;
1010 update_mode_lines
= 1;
1012 if (command_loop_level
1013 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1014 buffer
= Fcurrent_buffer ();
1018 /* If we leave recursive_edit_1 below with a `throw' for instance,
1019 like it is done in the splash screen display, we have to
1020 make sure that we restore single_kboard as command_loop_1
1021 would have done if it were left normally. */
1022 record_unwind_protect (recursive_edit_unwind
,
1023 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1025 recursive_edit_1 ();
1026 return unbind_to (count
, Qnil
);
1030 recursive_edit_unwind (info
)
1033 if (BUFFERP (XCAR (info
)))
1034 Fset_buffer (XCAR (info
));
1036 if (NILP (XCDR (info
)))
1037 any_kboard_state ();
1039 single_kboard_state ();
1041 command_loop_level
--;
1042 update_mode_lines
= 1;
1051 #if 0 /* Theory: if there's anything in Vunread_command_events,
1052 it will right away be read by read_key_sequence,
1053 and then if we do switch KBOARDS, it will go into the side
1054 queue then. So we don't need to do anything special here -- rms. */
1055 if (CONSP (Vunread_command_events
))
1057 current_kboard
->kbd_queue
1058 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1059 current_kboard
->kbd_queue_has_data
= 1;
1061 Vunread_command_events
= Qnil
;
1067 /* Switch to the single-kboard state, making current_kboard
1068 the only KBOARD from which further input is accepted. */
1071 single_kboard_state ()
1078 /* Maintain a stack of kboards, so other parts of Emacs
1079 can switch temporarily to the kboard of a given frame
1080 and then revert to the previous status. */
1085 struct kboard_stack
*next
;
1088 static struct kboard_stack
*kboard_stack
;
1091 push_frame_kboard (f
)
1095 struct kboard_stack
*p
1096 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1098 p
->next
= kboard_stack
;
1099 p
->kboard
= current_kboard
;
1102 current_kboard
= FRAME_KBOARD (f
);
1110 struct kboard_stack
*p
= kboard_stack
;
1111 current_kboard
= p
->kboard
;
1112 kboard_stack
= p
->next
;
1117 /* Handle errors that are not handled at inner levels
1118 by printing an error message and returning to the editor command loop. */
1124 Lisp_Object old_level
, old_length
;
1125 char macroerror
[50];
1127 #ifdef HAVE_X_WINDOWS
1128 if (display_hourglass_p
)
1129 cancel_hourglass ();
1132 if (!NILP (executing_macro
))
1134 if (executing_macro_iterations
== 1)
1135 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1137 sprintf (macroerror
, "After %d kbd macro iterations: ",
1138 executing_macro_iterations
);
1143 Vstandard_output
= Qt
;
1144 Vstandard_input
= Qt
;
1145 Vexecuting_macro
= Qnil
;
1146 executing_macro
= Qnil
;
1147 current_kboard
->Vprefix_arg
= Qnil
;
1148 current_kboard
->Vlast_prefix_arg
= Qnil
;
1151 /* Avoid unquittable loop if data contains a circular list. */
1152 old_level
= Vprint_level
;
1153 old_length
= Vprint_length
;
1154 XSETFASTINT (Vprint_level
, 10);
1155 XSETFASTINT (Vprint_length
, 10);
1156 cmd_error_internal (data
, macroerror
);
1157 Vprint_level
= old_level
;
1158 Vprint_length
= old_length
;
1162 Vinhibit_quit
= Qnil
;
1164 any_kboard_state ();
1167 return make_number (0);
1170 /* Take actions on handling an error. DATA is the data that describes
1173 CONTEXT is a C-string containing ASCII characters only which
1174 describes the context in which the error happened. If we need to
1175 generalize CONTEXT to allow multibyte characters, make it a Lisp
1179 cmd_error_internal (data
, context
)
1184 int kill_emacs_p
= 0;
1185 struct frame
*sf
= SELECTED_FRAME ();
1189 clear_message (1, 0);
1191 /* If the window system or terminal frame hasn't been initialized
1192 yet, or we're not interactive, it's best to dump this message out
1193 to stderr and exit. */
1194 if (!sf
->glyphs_initialized_p
1195 /* This is the case of the frame dumped with Emacs, when we're
1196 running under a window system. */
1197 || (!NILP (Vwindow_system
)
1198 && !inhibit_window_system
1199 && FRAME_TERMCAP_P (sf
))
1202 stream
= Qexternal_debugging_output
;
1208 message_log_maybe_newline ();
1213 /* The immediate context is not interesting for Quits,
1214 since they are asyncronous. */
1215 if (EQ (XCAR (data
), Qquit
))
1216 Vsignaling_function
= Qnil
;
1218 print_error_message (data
, stream
, context
, Vsignaling_function
);
1220 Vsignaling_function
= Qnil
;
1222 /* If the window system or terminal frame hasn't been initialized
1223 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1227 Fkill_emacs (make_number (-1));
1231 Lisp_Object
command_loop_1 ();
1232 Lisp_Object
command_loop_2 ();
1233 Lisp_Object
top_level_1 ();
1235 /* Entry to editor-command-loop.
1236 This level has the catches for exiting/returning to editor command loop.
1237 It returns nil to exit recursive edit, t to abort it. */
1242 if (command_loop_level
> 0 || minibuf_level
> 0)
1245 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1246 executing_macro
= Qnil
;
1252 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1253 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1254 executing_macro
= Qnil
;
1256 /* End of file in -batch run causes exit here. */
1262 /* Here we catch errors in execution of commands within the
1263 editing loop, and reenter the editing loop.
1264 When there is an error, cmd_error runs and returns a non-nil
1265 value to us. A value of nil means that command_loop_1 itself
1266 returned due to end of file (or end of kbd macro). */
1271 register Lisp_Object val
;
1274 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1275 while (!NILP (val
));
1283 return Feval (Vtop_level
);
1289 /* On entry to the outer level, run the startup file */
1290 if (!NILP (Vtop_level
))
1291 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1292 else if (!NILP (Vpurify_flag
))
1293 message ("Bare impure Emacs (standard Lisp code not loaded)");
1295 message ("Bare Emacs (standard Lisp code not loaded)");
1299 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1300 doc
: /* Exit all recursive editing levels. */)
1303 #ifdef HAVE_X_WINDOWS
1304 if (display_hourglass_p
)
1305 cancel_hourglass ();
1307 return Fthrow (Qtop_level
, Qnil
);
1310 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1311 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1314 if (command_loop_level
> 0 || minibuf_level
> 0)
1315 Fthrow (Qexit
, Qnil
);
1317 error ("No recursive edit is in progress");
1321 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1322 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1325 if (command_loop_level
> 0 || minibuf_level
> 0)
1328 error ("No recursive edit is in progress");
1332 /* This is the actual command reading loop,
1333 sans error-handling encapsulation. */
1335 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1337 void safe_run_hooks
P_ ((Lisp_Object
));
1338 static void adjust_point_for_property
P_ ((int));
1346 Lisp_Object keybuf
[30];
1350 struct buffer
*prev_buffer
= NULL
;
1352 int was_locked
= single_kboard
;
1354 int already_adjusted
;
1356 current_kboard
->Vprefix_arg
= Qnil
;
1357 current_kboard
->Vlast_prefix_arg
= Qnil
;
1358 Vdeactivate_mark
= Qnil
;
1359 waiting_for_input
= 0;
1363 this_command_key_count
= 0;
1364 this_single_command_key_start
= 0;
1366 if (NILP (Vmemory_full
))
1368 /* Make sure this hook runs after commands that get errors and
1369 throw to top level. */
1370 /* Note that the value cell will never directly contain nil
1371 if the symbol is a local variable. */
1372 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1373 safe_run_hooks (Qpost_command_hook
);
1375 /* If displaying a message, resize the echo area window to fit
1376 that message's size exactly. */
1377 if (!NILP (echo_area_buffer
[0]))
1378 resize_echo_area_exactly ();
1380 if (!NILP (Vdeferred_action_list
))
1381 call0 (Vdeferred_action_function
);
1383 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1385 if (NILP (Vunread_command_events
)
1386 && NILP (Vunread_input_method_events
)
1387 && NILP (Vunread_post_input_method_events
)
1388 && NILP (Vexecuting_macro
)
1389 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1390 safe_run_hooks (Qpost_command_idle_hook
);
1394 Vmemory_full
= Qnil
;
1396 /* Do this after running Vpost_command_hook, for consistency. */
1397 current_kboard
->Vlast_command
= Vthis_command
;
1398 current_kboard
->Vreal_last_command
= real_this_command
;
1402 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1405 /* Make sure the current window's buffer is selected. */
1406 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1407 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1409 /* Display any malloc warning that just came out. Use while because
1410 displaying one warning can cause another. */
1412 while (pending_malloc_warning
)
1413 display_malloc_warning ();
1417 Vdeactivate_mark
= Qnil
;
1419 /* If minibuffer on and echo area in use,
1420 wait a short time and redraw minibuffer. */
1423 && !NILP (echo_area_buffer
[0])
1424 && EQ (minibuf_window
, echo_area_window
)
1425 && NUMBERP (Vminibuffer_message_timeout
))
1427 /* Bind inhibit-quit to t so that C-g gets read in
1428 rather than quitting back to the minibuffer. */
1429 int count
= SPECPDL_INDEX ();
1430 specbind (Qinhibit_quit
, Qt
);
1432 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1433 /* Clear the echo area. */
1435 safe_run_hooks (Qecho_area_clear_hook
);
1437 unbind_to (count
, Qnil
);
1439 /* If a C-g came in before, treat it as input now. */
1440 if (!NILP (Vquit_flag
))
1443 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1448 alloca (0); /* Cause a garbage collection now */
1449 /* Since we can free the most stuff here. */
1450 #endif /* C_ALLOCA */
1453 /* Select the frame that the last event came from. Usually,
1454 switch-frame events will take care of this, but if some lisp
1455 code swallows a switch-frame event, we'll fix things up here.
1456 Is this a good idea? */
1457 if (FRAMEP (internal_last_event_frame
)
1458 && !EQ (internal_last_event_frame
, selected_frame
))
1459 Fselect_frame (internal_last_event_frame
, Qnil
);
1461 /* If it has changed current-menubar from previous value,
1462 really recompute the menubar from the value. */
1463 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1464 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1465 call0 (Qrecompute_lucid_menubar
);
1467 before_command_key_count
= this_command_key_count
;
1468 before_command_echo_length
= echo_length ();
1470 Vthis_command
= Qnil
;
1471 real_this_command
= Qnil
;
1473 /* Read next key sequence; i gets its length. */
1474 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1477 /* A filter may have run while we were reading the input. */
1478 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1480 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1481 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1485 /* Now we have read a key sequence of length I,
1486 or else I is 0 and we found end of file. */
1488 if (i
== 0) /* End of file -- happens only in */
1489 return Qnil
; /* a kbd macro, at the end. */
1490 /* -1 means read_key_sequence got a menu that was rejected.
1491 Just loop around and read another command. */
1495 this_command_key_count
= 0;
1496 this_single_command_key_start
= 0;
1500 last_command_char
= keybuf
[i
- 1];
1502 /* If the previous command tried to force a specific window-start,
1503 forget about that, in case this command moves point far away
1504 from that position. But also throw away beg_unchanged and
1505 end_unchanged information in that case, so that redisplay will
1506 update the whole window properly. */
1507 if (!NILP (XWINDOW (selected_window
)->force_start
))
1510 XWINDOW (selected_window
)->force_start
= Qnil
;
1511 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1512 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1515 cmd
= read_key_sequence_cmd
;
1516 if (!NILP (Vexecuting_macro
))
1518 if (!NILP (Vquit_flag
))
1520 Vexecuting_macro
= Qt
;
1521 QUIT
; /* Make some noise. */
1522 /* Will return since macro now empty. */
1526 /* Do redisplay processing after this command except in special
1527 cases identified below. */
1528 prev_buffer
= current_buffer
;
1529 prev_modiff
= MODIFF
;
1530 last_point_position
= PT
;
1531 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1533 /* By default, we adjust point to a boundary of a region that
1534 has such a property that should be treated intangible
1535 (e.g. composition, display). But, some commands will set
1536 this variable differently. */
1537 Vdisable_point_adjustment
= Qnil
;
1539 /* Process filters and timers may have messed with deactivate-mark.
1540 reset it before we execute the command. */
1541 Vdeactivate_mark
= Qnil
;
1543 /* Remap command through active keymaps */
1544 Vthis_original_command
= cmd
;
1548 if (cmd1
= Fremap_command (cmd
), !NILP (cmd1
))
1552 /* Execute the command. */
1554 Vthis_command
= cmd
;
1555 real_this_command
= cmd
;
1556 /* Note that the value cell will never directly contain nil
1557 if the symbol is a local variable. */
1558 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1559 safe_run_hooks (Qpre_command_hook
);
1561 already_adjusted
= 0;
1563 if (NILP (Vthis_command
))
1565 /* nil means key is undefined. */
1567 current_kboard
->defining_kbd_macro
= Qnil
;
1568 update_mode_lines
= 1;
1569 current_kboard
->Vprefix_arg
= Qnil
;
1573 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1575 /* In case we jump to directly_done. */
1576 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1578 /* Recognize some common commands in common situations and
1579 do them directly. */
1580 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1582 struct Lisp_Char_Table
*dp
1583 = window_display_table (XWINDOW (selected_window
));
1584 lose
= FETCH_CHAR (PT_BYTE
);
1586 adjust_point_for_property (last_point_position
);
1587 already_adjusted
= 1;
1588 if (PT
== last_point_position
+ 1
1590 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1591 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1592 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1593 && (lose
>= 0x20 && lose
< 0x7f)))
1594 : (lose
>= 0x20 && lose
< 0x7f))
1595 /* To extract the case of continuation on
1596 wide-column characters. */
1597 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1598 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1600 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1602 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1604 && !windows_or_buffers_changed
1605 && EQ (current_buffer
->selective_display
, Qnil
)
1606 && !detect_input_pending ()
1607 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1608 && NILP (Vexecuting_macro
))
1609 direct_output_forward_char (1);
1612 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1614 struct Lisp_Char_Table
*dp
1615 = window_display_table (XWINDOW (selected_window
));
1617 lose
= FETCH_CHAR (PT_BYTE
);
1618 adjust_point_for_property (last_point_position
);
1619 already_adjusted
= 1;
1620 if (PT
== last_point_position
- 1
1622 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1623 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1624 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1625 && (lose
>= 0x20 && lose
< 0x7f)))
1626 : (lose
>= 0x20 && lose
< 0x7f))
1627 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1629 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1631 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1633 && !windows_or_buffers_changed
1634 && EQ (current_buffer
->selective_display
, Qnil
)
1635 && !detect_input_pending ()
1636 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1637 && NILP (Vexecuting_macro
))
1638 direct_output_forward_char (-1);
1641 else if (EQ (Vthis_command
, Qself_insert_command
)
1642 /* Try this optimization only on char keystrokes. */
1643 && NATNUMP (last_command_char
)
1644 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1647 translate_char (Vtranslation_table_for_input
,
1648 XFASTINT (last_command_char
), 0, 0, 0);
1650 if (NILP (Vexecuting_macro
)
1651 && !EQ (minibuf_window
, selected_window
))
1653 if (!nonundocount
|| nonundocount
>= 20)
1661 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1663 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1665 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1667 || MODIFF
<= SAVE_MODIFF
1668 || windows_or_buffers_changed
1669 || !EQ (current_buffer
->selective_display
, Qnil
)
1670 || detect_input_pending ()
1671 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1672 || !NILP (Vexecuting_macro
));
1674 value
= internal_self_insert (c
, 0);
1679 /* VALUE == 1 when AFTER-CHANGE functions are
1680 installed which is the case most of the time
1681 because FONT-LOCK installs one. */
1682 if (!lose
&& !value
)
1683 direct_output_for_insert (c
);
1688 /* Here for a command that isn't executed directly */
1690 #ifdef HAVE_X_WINDOWS
1691 if (display_hourglass_p
1692 && NILP (Vexecuting_macro
))
1697 if (NILP (current_kboard
->Vprefix_arg
))
1699 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1701 #ifdef HAVE_X_WINDOWS
1702 /* Do not check display_hourglass_p here, because
1703 Fcommand_execute could change it, but we should cancel
1704 hourglass cursor anyway.
1705 But don't cancel the hourglass within a macro
1706 just because a command in the macro finishes. */
1707 if (NILP (Vexecuting_macro
))
1708 cancel_hourglass ();
1712 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1714 /* Note that the value cell will never directly contain nil
1715 if the symbol is a local variable. */
1716 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1717 safe_run_hooks (Qpost_command_hook
);
1719 /* If displaying a message, resize the echo area window to fit
1720 that message's size exactly. */
1721 if (!NILP (echo_area_buffer
[0]))
1722 resize_echo_area_exactly ();
1724 if (!NILP (Vdeferred_action_list
))
1725 safe_run_hooks (Qdeferred_action_function
);
1727 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1729 if (NILP (Vunread_command_events
)
1730 && NILP (Vunread_input_method_events
)
1731 && NILP (Vunread_post_input_method_events
)
1732 && NILP (Vexecuting_macro
)
1733 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1734 safe_run_hooks (Qpost_command_idle_hook
);
1737 /* If there is a prefix argument,
1738 1) We don't want Vlast_command to be ``universal-argument''
1739 (that would be dumb), so don't set Vlast_command,
1740 2) we want to leave echoing on so that the prefix will be
1741 echoed as part of this key sequence, so don't call
1743 3) we want to leave this_command_key_count non-zero, so that
1744 read_char will realize that it is re-reading a character, and
1745 not echo it a second time.
1747 If the command didn't actually create a prefix arg,
1748 but is merely a frame event that is transparent to prefix args,
1749 then the above doesn't apply. */
1750 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1752 current_kboard
->Vlast_command
= Vthis_command
;
1753 current_kboard
->Vreal_last_command
= real_this_command
;
1755 this_command_key_count
= 0;
1756 this_single_command_key_start
= 0;
1759 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1761 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1763 /* We could also call `deactivate'mark'. */
1764 if (EQ (Vtransient_mark_mode
, Qlambda
))
1765 Vtransient_mark_mode
= Qnil
;
1768 current_buffer
->mark_active
= Qnil
;
1769 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1772 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1773 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1778 if (current_buffer
== prev_buffer
1779 && last_point_position
!= PT
1780 && NILP (Vdisable_point_adjustment
)
1781 && NILP (Vglobal_disable_point_adjustment
)
1782 && !already_adjusted
)
1783 adjust_point_for_property (last_point_position
);
1785 /* Install chars successfully executed in kbd macro. */
1787 if (!NILP (current_kboard
->defining_kbd_macro
)
1788 && NILP (current_kboard
->Vprefix_arg
))
1789 finalize_kbd_macro_chars ();
1793 any_kboard_state ();
1798 extern Lisp_Object Qcomposition
, Qdisplay
;
1800 /* Adjust point to a boundary of a region that has such a property
1801 that should be treated intangible. For the moment, we check
1802 `composition', `display' and `invisible' properties.
1803 LAST_PT is the last position of point. */
1805 extern Lisp_Object Qafter_string
, Qbefore_string
;
1806 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1809 adjust_point_for_property (last_pt
)
1813 Lisp_Object val
, overlay
, tmp
;
1814 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1816 while (check_composition
|| check_display
|| check_invisible
)
1818 if (check_composition
1819 && PT
> BEGV
&& PT
< ZV
1820 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1821 && COMPOSITION_VALID_P (beg
, end
, val
)
1822 && beg
< PT
/* && end > PT <- It's always the case. */
1823 && (last_pt
<= beg
|| last_pt
>= end
))
1826 SET_PT (PT
< last_pt
? beg
: end
);
1827 check_display
= check_invisible
= 1;
1829 check_composition
= 0;
1831 && PT
> BEGV
&& PT
< ZV
1832 && !NILP (val
= get_char_property_and_overlay
1833 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1834 && display_prop_intangible_p (val
)
1835 && (!OVERLAYP (overlay
)
1836 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1837 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1838 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1839 && beg
< PT
) /* && end > PT <- It's always the case. */
1842 SET_PT (PT
< last_pt
? beg
: end
);
1843 check_composition
= check_invisible
= 1;
1846 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1848 int inv
, ellipsis
= 0;
1851 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1853 && !NILP (val
= get_char_property_and_overlay
1854 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1855 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1857 ellipsis
= ellipsis
|| inv
> 1
1858 || (OVERLAYP (overlay
)
1859 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1860 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1861 tmp
= Fnext_single_char_property_change
1862 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1863 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1866 && !NILP (val
= get_char_property_and_overlay
1867 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1868 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1870 ellipsis
= ellipsis
|| inv
> 1
1871 || (OVERLAYP (overlay
)
1872 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1873 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1874 tmp
= Fprevious_single_char_property_change
1875 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1876 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1879 /* Move away from the inside area. */
1880 if (beg
< PT
&& end
> PT
)
1882 SET_PT (PT
< last_pt
? beg
: end
);
1883 check_composition
= check_display
= 1;
1885 xassert (PT
== beg
|| PT
== end
);
1886 /* Pretend the area doesn't exist. */
1887 if (!ellipsis
&& beg
< end
)
1889 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1890 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1891 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1892 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1893 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1894 /* We've already moved as far as we can. Trying to go
1895 to the other end would mean moving backwards and thus
1896 could lead to an infinite loop. */
1898 else if (val
= get_pos_property (make_number (PT
),
1900 TEXT_PROP_MEANS_INVISIBLE (val
)
1901 && (val
= get_pos_property
1902 (make_number (PT
== beg
? end
: beg
),
1904 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1905 (check_composition
= check_display
= 1,
1906 SET_PT (PT
== beg
? end
: beg
));
1909 check_invisible
= 0;
1913 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1916 safe_run_hooks_1 (hook
)
1919 return call1 (Vrun_hooks
, Vinhibit_quit
);
1922 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1925 safe_run_hooks_error (data
)
1928 return Fset (Vinhibit_quit
, Qnil
);
1931 /* If we get an error while running the hook, cause the hook variable
1932 to be nil. Also inhibit quits, so that C-g won't cause the hook
1933 to mysteriously evaporate. */
1936 safe_run_hooks (hook
)
1939 int count
= SPECPDL_INDEX ();
1940 specbind (Qinhibit_quit
, hook
);
1942 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1944 unbind_to (count
, Qnil
);
1948 /* Number of seconds between polling for input. This is a Lisp
1949 variable that can be bound. */
1951 EMACS_INT polling_period
;
1953 /* Nonzero means polling for input is temporarily suppressed. */
1955 int poll_suppress_count
;
1957 /* Asynchronous timer for polling. */
1959 struct atimer
*poll_timer
;
1962 #ifdef POLL_FOR_INPUT
1964 /* Poll for input, so what we catch a C-g if it comes in. This
1965 function is called from x_make_frame_visible, see comment
1971 if (interrupt_input_blocked
== 0
1972 && !waiting_for_input
)
1973 read_avail_input (0);
1976 /* Timer callback function for poll_timer. TIMER is equal to
1980 poll_for_input (timer
)
1981 struct atimer
*timer
;
1983 if (poll_suppress_count
== 0)
1984 poll_for_input_1 ();
1987 #endif /* POLL_FOR_INPUT */
1989 /* Begin signals to poll for input, if they are appropriate.
1990 This function is called unconditionally from various places. */
1995 #ifdef POLL_FOR_INPUT
1996 if (read_socket_hook
&& !interrupt_input
)
1998 /* Turn alarm handling on unconditionally. It might have
1999 been turned off in process.c. */
2000 turn_on_atimers (1);
2002 /* If poll timer doesn't exist, are we need one with
2003 a different interval, start a new one. */
2004 if (poll_timer
== NULL
2005 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2007 EMACS_TIME interval
;
2010 cancel_atimer (poll_timer
);
2012 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2013 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2014 poll_for_input
, NULL
);
2017 /* Let the timer's callback function poll for input
2018 if this becomes zero. */
2019 --poll_suppress_count
;
2024 /* Nonzero if we are using polling to handle input asynchronously. */
2027 input_polling_used ()
2029 #ifdef POLL_FOR_INPUT
2030 return read_socket_hook
&& !interrupt_input
;
2036 /* Turn off polling. */
2041 #ifdef POLL_FOR_INPUT
2042 if (read_socket_hook
&& !interrupt_input
)
2043 ++poll_suppress_count
;
2047 /* Set the value of poll_suppress_count to COUNT
2048 and start or stop polling accordingly. */
2051 set_poll_suppress_count (count
)
2054 #ifdef POLL_FOR_INPUT
2055 if (count
== 0 && poll_suppress_count
!= 0)
2057 poll_suppress_count
= 1;
2060 else if (count
!= 0 && poll_suppress_count
== 0)
2064 poll_suppress_count
= count
;
2068 /* Bind polling_period to a value at least N.
2069 But don't decrease it. */
2072 bind_polling_period (n
)
2075 #ifdef POLL_FOR_INPUT
2076 int new = polling_period
;
2081 stop_other_atimers (poll_timer
);
2083 specbind (Qpolling_period
, make_number (new));
2084 /* Start a new alarm with the new period. */
2089 /* Apply the control modifier to CHARACTER. */
2095 /* Save the upper bits here. */
2096 int upper
= c
& ~0177;
2100 /* Everything in the columns containing the upper-case letters
2101 denotes a control character. */
2102 if (c
>= 0100 && c
< 0140)
2106 /* Set the shift modifier for a control char
2107 made from a shifted letter. But only for letters! */
2108 if (oc
>= 'A' && oc
<= 'Z')
2109 c
|= shift_modifier
;
2112 /* The lower-case letters denote control characters too. */
2113 else if (c
>= 'a' && c
<= 'z')
2116 /* Include the bits for control and shift
2117 only if the basic ASCII code can't indicate them. */
2121 /* Replace the high bits. */
2122 c
|= (upper
& ~ctrl_modifier
);
2127 /* Display help echo in the echo area.
2129 HELP a string means display that string, HELP nil means clear the
2130 help echo. If HELP is a function, call it with OBJECT and POS as
2131 arguments; the function should return a help string or nil for
2132 none. For all other types of HELP evaluate it to obtain a string.
2134 WINDOW is the window in which the help was generated, if any.
2135 It is nil if not in a window.
2137 If OBJECT is a buffer, POS is the position in the buffer where the
2138 `help-echo' text property was found.
2140 If OBJECT is an overlay, that overlay has a `help-echo' property,
2141 and POS is the position in the overlay's buffer under the mouse.
2143 If OBJECT is a string (an overlay string or a string displayed with
2144 the `display' property). POS is the position in that string under
2147 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2148 echo overwrites a keystroke echo currently displayed in the echo
2151 Note: this function may only be called with HELP nil or a string
2152 from X code running asynchronously. */
2155 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2156 Lisp_Object help
, window
, object
, pos
;
2157 int ok_to_overwrite_keystroke_echo
;
2159 if (!NILP (help
) && !STRINGP (help
))
2161 if (FUNCTIONP (help
))
2163 Lisp_Object args
[4];
2168 help
= safe_call (4, args
);
2171 help
= safe_eval (help
);
2173 if (!STRINGP (help
))
2177 if (STRINGP (help
) || NILP (help
))
2179 if (!NILP (Vshow_help_function
))
2180 call1 (Vshow_help_function
, help
);
2181 else if (/* Don't overwrite minibuffer contents. */
2182 !MINI_WINDOW_P (XWINDOW (selected_window
))
2183 /* Don't overwrite a keystroke echo. */
2184 && (NILP (echo_message_buffer
)
2185 || ok_to_overwrite_keystroke_echo
)
2186 /* Don't overwrite a prompt. */
2187 && !cursor_in_echo_area
)
2191 int count
= SPECPDL_INDEX ();
2193 if (!help_echo_showing_p
)
2194 Vpre_help_message
= current_message ();
2196 specbind (Qmessage_truncate_lines
, Qt
);
2197 message3_nolog (help
, SBYTES (help
),
2198 STRING_MULTIBYTE (help
));
2199 unbind_to (count
, Qnil
);
2201 else if (STRINGP (Vpre_help_message
))
2203 message3_nolog (Vpre_help_message
,
2204 SBYTES (Vpre_help_message
),
2205 STRING_MULTIBYTE (Vpre_help_message
));
2206 Vpre_help_message
= Qnil
;
2212 help_echo_showing_p
= STRINGP (help
);
2218 /* Input of single characters from keyboard */
2220 Lisp_Object
print_help ();
2221 static Lisp_Object
kbd_buffer_get_event ();
2222 static void record_char ();
2225 static jmp_buf wrong_kboard_jmpbuf
;
2228 #define STOP_POLLING \
2229 do { if (! polling_stopped_here) stop_polling (); \
2230 polling_stopped_here = 1; } while (0)
2232 #define RESUME_POLLING \
2233 do { if (polling_stopped_here) start_polling (); \
2234 polling_stopped_here = 0; } while (0)
2236 /* read a character from the keyboard; call the redisplay if needed */
2237 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2238 -1 means do not do redisplay, but do do autosaving.
2241 /* The arguments MAPS and NMAPS are for menu prompting.
2242 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2244 PREV_EVENT is the previous input event, or nil if we are reading
2245 the first event of a key sequence (or not reading a key sequence).
2246 If PREV_EVENT is t, that is a "magic" value that says
2247 not to run input methods, but in other respects to act as if
2248 not reading a key sequence.
2250 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2251 if we used a mouse menu to read the input, or zero otherwise. If
2252 USED_MOUSE_MENU is null, we don't dereference it.
2254 Value is t if we showed a menu and the user rejected it. */
2257 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2261 Lisp_Object prev_event
;
2262 int *used_mouse_menu
;
2264 volatile Lisp_Object c
;
2266 jmp_buf local_getcjmp
;
2268 volatile int key_already_recorded
= 0;
2269 Lisp_Object tem
, save
;
2270 volatile Lisp_Object previous_echo_area_message
;
2271 volatile Lisp_Object also_record
;
2272 volatile int reread
;
2273 struct gcpro gcpro1
, gcpro2
;
2274 EMACS_TIME last_idle_start
;
2275 int polling_stopped_here
= 0;
2279 before_command_key_count
= this_command_key_count
;
2280 before_command_echo_length
= echo_length ();
2282 previous_echo_area_message
= Qnil
;
2284 GCPRO2 (c
, previous_echo_area_message
);
2289 if (CONSP (Vunread_post_input_method_events
))
2291 c
= XCAR (Vunread_post_input_method_events
);
2292 Vunread_post_input_method_events
2293 = XCDR (Vunread_post_input_method_events
);
2295 /* Undo what read_char_x_menu_prompt did when it unread
2296 additional keys returned by Fx_popup_menu. */
2298 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2306 if (unread_command_char
!= -1)
2308 XSETINT (c
, unread_command_char
);
2309 unread_command_char
= -1;
2315 if (CONSP (Vunread_command_events
))
2317 c
= XCAR (Vunread_command_events
);
2318 Vunread_command_events
= XCDR (Vunread_command_events
);
2320 /* Undo what read_char_x_menu_prompt did when it unread
2321 additional keys returned by Fx_popup_menu. */
2323 && EQ (XCDR (c
), Qdisabled
)
2324 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2327 /* If the queued event is something that used the mouse,
2328 set used_mouse_menu accordingly. */
2330 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2331 *used_mouse_menu
= 1;
2334 goto reread_for_input_method
;
2337 if (CONSP (Vunread_input_method_events
))
2339 c
= XCAR (Vunread_input_method_events
);
2340 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2342 /* Undo what read_char_x_menu_prompt did when it unread
2343 additional keys returned by Fx_popup_menu. */
2345 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2349 goto reread_for_input_method
;
2352 /* If there is no function key translated before
2353 reset-this-command-lengths takes effect, forget about it. */
2354 before_command_restore_flag
= 0;
2356 if (!NILP (Vexecuting_macro
))
2358 /* We set this to Qmacro; since that's not a frame, nobody will
2359 try to switch frames on us, and the selected window will
2362 Since this event came from a macro, it would be misleading to
2363 leave internal_last_event_frame set to wherever the last
2364 real event came from. Normally, a switch-frame event selects
2365 internal_last_event_frame after each command is read, but
2366 events read from a macro should never cause a new frame to be
2368 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2370 /* Exit the macro if we are at the end.
2371 Also, some things replace the macro with t
2372 to force an early exit. */
2373 if (EQ (Vexecuting_macro
, Qt
)
2374 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2380 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2381 if (STRINGP (Vexecuting_macro
)
2382 && (XINT (c
) & 0x80))
2383 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2385 executing_macro_index
++;
2390 if (!NILP (unread_switch_frame
))
2392 c
= unread_switch_frame
;
2393 unread_switch_frame
= Qnil
;
2395 /* This event should make it into this_command_keys, and get echoed
2396 again, so we do not set `reread'. */
2400 /* if redisplay was requested */
2401 if (commandflag
>= 0)
2403 /* If there is pending input, process any events which are not
2404 user-visible, such as X selection_request events. */
2406 || detect_input_pending_run_timers (0))
2407 swallow_events (0); /* may clear input_pending */
2409 /* Redisplay if no pending input. */
2410 while (!input_pending
)
2412 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2413 redisplay_preserve_echo_area (5);
2418 /* Normal case: no input arrived during redisplay. */
2421 /* Input arrived and pre-empted redisplay.
2422 Process any events which are not user-visible. */
2424 /* If that cleared input_pending, try again to redisplay. */
2428 /* Message turns off echoing unless more keystrokes turn it on again.
2430 The code in 20.x for the condition was
2432 1. echo_area_glyphs && *echo_area_glyphs
2433 2. && echo_area_glyphs != current_kboard->echobuf
2434 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2436 (1) means there's a current message displayed
2438 (2) means it's not the message from echoing from the current
2441 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2442 is set to a non-null value. This is done in read_char and it is
2443 set to echo_area_glyphs after a call to echo_char. That means
2444 ok_to_echo_at_next_pause is either null or
2445 current_kboard->echobuf with the appropriate current_kboard at
2448 So, condition (3) means in clear text ok_to_echo_at_next_pause
2449 must be either null, or the current message isn't from echoing at
2450 all, or it's from echoing from a different kboard than the
2453 if (/* There currently is something in the echo area. */
2454 !NILP (echo_area_buffer
[0])
2455 && (/* And it's either not from echoing. */
2456 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2457 /* Or it's an echo from a different kboard. */
2458 || echo_kboard
!= current_kboard
2459 /* Or we explicitly allow overwriting whatever there is. */
2460 || ok_to_echo_at_next_pause
== NULL
))
2465 /* Try reading a character via menu prompting in the minibuf.
2466 Try this before the sit-for, because the sit-for
2467 would do the wrong thing if we are supposed to do
2468 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2469 after a mouse event so don't try a minibuf menu. */
2471 if (nmaps
> 0 && INTERACTIVE
2472 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2473 /* Don't bring up a menu if we already have another event. */
2474 && NILP (Vunread_command_events
)
2475 && unread_command_char
< 0
2476 && !detect_input_pending_run_timers (0))
2478 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2481 key_already_recorded
= 1;
2486 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2487 We will do that below, temporarily for short sections of code,
2488 when appropriate. local_getcjmp must be in effect
2489 around any call to sit_for or kbd_buffer_get_event;
2490 it *must not* be in effect when we call redisplay. */
2492 if (_setjmp (local_getcjmp
))
2494 XSETINT (c
, quit_char
);
2495 internal_last_event_frame
= selected_frame
;
2496 Vlast_event_frame
= internal_last_event_frame
;
2497 /* If we report the quit char as an event,
2498 don't do so more than once. */
2499 if (!NILP (Vinhibit_quit
))
2504 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2505 if (kb
!= current_kboard
)
2507 Lisp_Object link
= kb
->kbd_queue
;
2508 /* We shouldn't get here if we were in single-kboard mode! */
2513 while (CONSP (XCDR (link
)))
2515 if (!NILP (XCDR (link
)))
2519 kb
->kbd_queue
= Fcons (c
, Qnil
);
2521 XSETCDR (link
, Fcons (c
, Qnil
));
2522 kb
->kbd_queue_has_data
= 1;
2523 current_kboard
= kb
;
2524 /* This is going to exit from read_char
2525 so we had better get rid of this frame's stuff. */
2527 longjmp (wrong_kboard_jmpbuf
, 1);
2534 timer_start_idle ();
2536 /* If in middle of key sequence and minibuffer not active,
2537 start echoing if enough time elapses. */
2539 if (minibuf_level
== 0
2540 && !current_kboard
->immediate_echo
2541 && this_command_key_count
> 0
2543 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2544 && NILP (Fzerop (Vecho_keystrokes
))
2545 && (/* No message. */
2546 NILP (echo_area_buffer
[0])
2547 /* Or empty message. */
2548 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2549 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2550 /* Or already echoing from same kboard. */
2551 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2552 /* Or not echoing before and echoing allowed. */
2553 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2557 /* After a mouse event, start echoing right away.
2558 This is because we are probably about to display a menu,
2559 and we don't want to delay before doing so. */
2560 if (EVENT_HAS_PARAMETERS (prev_event
))
2565 double duration
= extract_float (Vecho_keystrokes
);
2566 sec
= (int) duration
;
2567 usec
= (duration
- sec
) * 1000000;
2568 save_getcjmp (save_jump
);
2569 restore_getcjmp (local_getcjmp
);
2570 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2571 restore_getcjmp (save_jump
);
2573 && ! CONSP (Vunread_command_events
))
2578 /* Maybe auto save due to number of keystrokes. */
2580 if (commandflag
!= 0
2581 && auto_save_interval
> 0
2582 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2583 && !detect_input_pending_run_timers (0))
2585 Fdo_auto_save (Qnil
, Qnil
);
2586 /* Hooks can actually change some buffers in auto save. */
2590 /* Try reading using an X menu.
2591 This is never confused with reading using the minibuf
2592 because the recursive call of read_char in read_char_minibuf_menu_prompt
2593 does not pass on any keymaps. */
2595 if (nmaps
> 0 && INTERACTIVE
2596 && !NILP (prev_event
)
2597 && EVENT_HAS_PARAMETERS (prev_event
)
2598 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2599 && !EQ (XCAR (prev_event
), Qtool_bar
)
2600 /* Don't bring up a menu if we already have another event. */
2601 && NILP (Vunread_command_events
)
2602 && unread_command_char
< 0)
2604 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2606 /* Now that we have read an event, Emacs is not idle. */
2612 /* Maybe autosave and/or garbage collect due to idleness. */
2614 if (INTERACTIVE
&& NILP (c
))
2616 int delay_level
, buffer_size
;
2618 /* Slow down auto saves logarithmically in size of current buffer,
2619 and garbage collect while we're at it. */
2620 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2621 last_non_minibuf_size
= Z
- BEG
;
2622 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2624 while (buffer_size
> 64)
2625 delay_level
++, buffer_size
-= buffer_size
>> 2;
2626 if (delay_level
< 4) delay_level
= 4;
2627 /* delay_level is 4 for files under around 50k, 7 at 100k,
2628 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2630 /* Auto save if enough time goes by without input. */
2631 if (commandflag
!= 0
2632 && num_nonmacro_input_events
> last_auto_save
2633 && INTEGERP (Vauto_save_timeout
)
2634 && XINT (Vauto_save_timeout
) > 0)
2638 save_getcjmp (save_jump
);
2639 restore_getcjmp (local_getcjmp
);
2640 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2642 restore_getcjmp (save_jump
);
2645 && ! CONSP (Vunread_command_events
))
2647 Fdo_auto_save (Qnil
, Qnil
);
2649 /* If we have auto-saved and there is still no input
2650 available, garbage collect if there has been enough
2651 consing going on to make it worthwhile. */
2652 if (!detect_input_pending_run_timers (0)
2653 && consing_since_gc
> gc_cons_threshold
/ 2)
2654 Fgarbage_collect ();
2661 /* If this has become non-nil here, it has been set by a timer
2662 or sentinel or filter. */
2663 if (CONSP (Vunread_command_events
))
2665 c
= XCAR (Vunread_command_events
);
2666 Vunread_command_events
= XCDR (Vunread_command_events
);
2669 /* Read something from current KBOARD's side queue, if possible. */
2673 if (current_kboard
->kbd_queue_has_data
)
2675 if (!CONSP (current_kboard
->kbd_queue
))
2677 c
= XCAR (current_kboard
->kbd_queue
);
2678 current_kboard
->kbd_queue
2679 = XCDR (current_kboard
->kbd_queue
);
2680 if (NILP (current_kboard
->kbd_queue
))
2681 current_kboard
->kbd_queue_has_data
= 0;
2682 input_pending
= readable_events (0);
2683 if (EVENT_HAS_PARAMETERS (c
)
2684 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2685 internal_last_event_frame
= XCAR (XCDR (c
));
2686 Vlast_event_frame
= internal_last_event_frame
;
2691 /* If current_kboard's side queue is empty check the other kboards.
2692 If one of them has data that we have not yet seen here,
2693 switch to it and process the data waiting for it.
2695 Note: if the events queued up for another kboard
2696 have already been seen here, and therefore are not a complete command,
2697 the kbd_queue_has_data field is 0, so we skip that kboard here.
2698 That's to avoid an infinite loop switching between kboards here. */
2699 if (NILP (c
) && !single_kboard
)
2702 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2703 if (kb
->kbd_queue_has_data
)
2705 current_kboard
= kb
;
2706 /* This is going to exit from read_char
2707 so we had better get rid of this frame's stuff. */
2709 longjmp (wrong_kboard_jmpbuf
, 1);
2718 /* Finally, we read from the main queue,
2719 and if that gives us something we can't use yet, we put it on the
2720 appropriate side queue and try again. */
2726 /* Actually read a character, waiting if necessary. */
2727 save_getcjmp (save_jump
);
2728 restore_getcjmp (local_getcjmp
);
2729 timer_start_idle ();
2730 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2731 restore_getcjmp (save_jump
);
2734 if (! NILP (c
) && (kb
!= current_kboard
))
2736 Lisp_Object link
= kb
->kbd_queue
;
2739 while (CONSP (XCDR (link
)))
2741 if (!NILP (XCDR (link
)))
2745 kb
->kbd_queue
= Fcons (c
, Qnil
);
2747 XSETCDR (link
, Fcons (c
, Qnil
));
2748 kb
->kbd_queue_has_data
= 1;
2752 current_kboard
= kb
;
2753 /* This is going to exit from read_char
2754 so we had better get rid of this frame's stuff. */
2756 longjmp (wrong_kboard_jmpbuf
, 1);
2761 /* Terminate Emacs in batch mode if at eof. */
2762 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2763 Fkill_emacs (make_number (1));
2767 /* Add in any extra modifiers, where appropriate. */
2768 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2769 || ((extra_keyboard_modifiers
& 0177) < ' '
2770 && (extra_keyboard_modifiers
& 0177) != 0))
2771 XSETINT (c
, make_ctrl_char (XINT (c
)));
2773 /* Transfer any other modifier bits directly from
2774 extra_keyboard_modifiers to c. Ignore the actual character code
2775 in the low 16 bits of extra_keyboard_modifiers. */
2776 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2781 /* Record the last idle start time so that we can reset it
2782 should the next event read be a help-echo. */
2783 last_idle_start
= timer_idleness_start_time
;
2789 if (commandflag
>= 0
2790 && !input_pending
&& !detect_input_pending_run_timers (0))
2798 /* Buffer switch events are only for internal wakeups
2799 so don't show them to the user.
2800 Also, don't record a key if we already did. */
2801 if (BUFFERP (c
) || key_already_recorded
)
2804 /* Process special events within read_char
2805 and loop around to read another event. */
2808 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2813 int was_locked
= single_kboard
;
2815 last_input_char
= c
;
2816 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2818 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2819 /* We stopped being idle for this event; undo that. This
2820 prevents automatic window selection (under
2821 mouse_autoselect_window from acting as a real input event, for
2822 example banishing the mouse under mouse-avoidance-mode. */
2823 timer_idleness_start_time
= last_idle_start
;
2825 /* Resume allowing input from any kboard, if that was true before. */
2827 any_kboard_state ();
2832 /* Handle things that only apply to characters. */
2835 /* If kbd_buffer_get_event gave us an EOF, return that. */
2839 if ((STRINGP (Vkeyboard_translate_table
)
2840 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2841 || (VECTORP (Vkeyboard_translate_table
)
2842 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2843 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2844 && CHAR_VALID_P (XINT (c
), 0)))
2847 d
= Faref (Vkeyboard_translate_table
, c
);
2848 /* nil in keyboard-translate-table means no translation. */
2854 /* If this event is a mouse click in the menu bar,
2855 return just menu-bar for now. Modify the mouse click event
2856 so we won't do this twice, then queue it up. */
2857 if (EVENT_HAS_PARAMETERS (c
)
2859 && CONSP (EVENT_START (c
))
2860 && CONSP (XCDR (EVENT_START (c
))))
2864 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2865 /* Handle menu-bar events:
2866 insert the dummy prefix event `menu-bar'. */
2867 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2869 /* Change menu-bar to (menu-bar) as the event "position". */
2870 POSN_BUFFER_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2873 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2878 /* Store these characters into recent_keys, the dribble file if any,
2879 and the keyboard macro being defined, if any. */
2881 if (! NILP (also_record
))
2882 record_char (also_record
);
2884 /* Wipe the echo area.
2885 But first, if we are about to use an input method,
2886 save the echo area contents for it to refer to. */
2888 && ! NILP (Vinput_method_function
)
2889 && (unsigned) XINT (c
) >= ' '
2890 && (unsigned) XINT (c
) != 127
2891 && (unsigned) XINT (c
) < 256)
2893 previous_echo_area_message
= Fcurrent_message ();
2894 Vinput_method_previous_message
= previous_echo_area_message
;
2897 /* Now wipe the echo area, except for help events which do their
2898 own stuff with the echo area. */
2900 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2901 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2903 if (!NILP (echo_area_buffer
[0]))
2904 safe_run_hooks (Qecho_area_clear_hook
);
2905 clear_message (1, 0);
2908 reread_for_input_method
:
2910 /* Pass this to the input method, if appropriate. */
2912 && ! NILP (Vinput_method_function
)
2913 /* Don't run the input method within a key sequence,
2914 after the first event of the key sequence. */
2915 && NILP (prev_event
)
2916 && (unsigned) XINT (c
) >= ' '
2917 && (unsigned) XINT (c
) != 127
2918 && (unsigned) XINT (c
) < 256)
2922 struct gcpro gcpro1
;
2923 int count
= SPECPDL_INDEX ();
2925 /* Save the echo status. */
2926 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2927 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2928 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2930 if (before_command_restore_flag
)
2932 this_command_key_count
= before_command_key_count_1
;
2933 if (this_command_key_count
< this_single_command_key_start
)
2934 this_single_command_key_start
= this_command_key_count
;
2935 echo_truncate (before_command_echo_length_1
);
2936 before_command_restore_flag
= 0;
2939 /* Save the this_command_keys status. */
2940 key_count
= this_command_key_count
;
2943 keys
= Fcopy_sequence (this_command_keys
);
2948 /* Clear out this_command_keys. */
2949 this_command_key_count
= 0;
2951 /* Now wipe the echo area. */
2952 if (!NILP (echo_area_buffer
[0]))
2953 safe_run_hooks (Qecho_area_clear_hook
);
2954 clear_message (1, 0);
2957 /* If we are not reading a key sequence,
2958 never use the echo area. */
2961 specbind (Qinput_method_use_echo_area
, Qt
);
2964 /* Call the input method. */
2965 tem
= call1 (Vinput_method_function
, c
);
2967 tem
= unbind_to (count
, tem
);
2969 /* Restore the saved echoing state
2970 and this_command_keys state. */
2971 this_command_key_count
= key_count
;
2973 this_command_keys
= keys
;
2976 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
2977 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
2978 if (saved_immediate_echo
)
2983 /* The input method can return no events. */
2986 /* Bring back the previous message, if any. */
2987 if (! NILP (previous_echo_area_message
))
2988 message_with_string ("%s", previous_echo_area_message
, 0);
2991 /* It returned one event or more. */
2993 Vunread_post_input_method_events
2994 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
2999 /* Display help if not echoing. */
3000 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3002 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3003 Lisp_Object help
, object
, position
, window
, tem
;
3005 tem
= Fcdr (XCDR (c
));
3008 window
= Fcar (tem
);
3010 object
= Fcar (tem
);
3012 position
= Fcar (tem
);
3014 show_help_echo (help
, window
, object
, position
, 0);
3016 /* We stopped being idle for this event; undo that. */
3017 timer_idleness_start_time
= last_idle_start
;
3021 if (this_command_key_count
== 0 || ! reread
)
3023 before_command_key_count
= this_command_key_count
;
3024 before_command_echo_length
= echo_length ();
3026 /* Don't echo mouse motion events. */
3027 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3028 && NILP (Fzerop (Vecho_keystrokes
))
3029 && ! (EVENT_HAS_PARAMETERS (c
)
3030 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3033 if (! NILP (also_record
))
3034 echo_char (also_record
);
3035 /* Once we reread a character, echoing can happen
3036 the next time we pause to read a new one. */
3037 ok_to_echo_at_next_pause
= current_kboard
;
3040 /* Record this character as part of the current key. */
3041 add_command_key (c
);
3042 if (! NILP (also_record
))
3043 add_command_key (also_record
);
3046 last_input_char
= c
;
3049 /* Process the help character specially if enabled */
3050 if (!NILP (Vhelp_form
) && help_char_p (c
))
3053 count
= SPECPDL_INDEX ();
3055 record_unwind_protect (Fset_window_configuration
,
3056 Fcurrent_window_configuration (Qnil
));
3058 tem0
= Feval (Vhelp_form
);
3060 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3064 c
= read_char (0, 0, 0, Qnil
, 0);
3065 while (BUFFERP (c
));
3066 /* Remove the help from the frame */
3067 unbind_to (count
, Qnil
);
3070 if (EQ (c
, make_number (040)))
3074 c
= read_char (0, 0, 0, Qnil
, 0);
3075 while (BUFFERP (c
));
3084 /* Record a key that came from a mouse menu.
3085 Record it for echoing, for this-command-keys, and so on. */
3091 /* Wipe the echo area. */
3092 clear_message (1, 0);
3096 before_command_key_count
= this_command_key_count
;
3097 before_command_echo_length
= echo_length ();
3099 /* Don't echo mouse motion events. */
3100 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3101 && NILP (Fzerop (Vecho_keystrokes
)))
3105 /* Once we reread a character, echoing can happen
3106 the next time we pause to read a new one. */
3107 ok_to_echo_at_next_pause
= 0;
3110 /* Record this character as part of the current key. */
3111 add_command_key (c
);
3113 /* Re-reading in the middle of a command */
3114 last_input_char
= c
;
3118 /* Return 1 if should recognize C as "the help character". */
3126 if (EQ (c
, Vhelp_char
))
3128 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3129 if (EQ (c
, XCAR (tail
)))
3134 /* Record the input event C in various ways. */
3142 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3144 /* To avoid filling recent_keys with help-echo and mouse-movement
3145 events, we filter out repeated help-echo events, only store the
3146 first and last in a series of mouse-movement events, and don't
3147 store repeated help-echo events which are only separated by
3148 mouse-movement events. */
3150 Lisp_Object ev1
, ev2
, ev3
;
3153 if ((ix1
= recent_keys_index
- 1) < 0)
3154 ix1
= NUM_RECENT_KEYS
- 1;
3155 ev1
= AREF (recent_keys
, ix1
);
3157 if ((ix2
= ix1
- 1) < 0)
3158 ix2
= NUM_RECENT_KEYS
- 1;
3159 ev2
= AREF (recent_keys
, ix2
);
3161 if ((ix3
= ix2
- 1) < 0)
3162 ix3
= NUM_RECENT_KEYS
- 1;
3163 ev3
= AREF (recent_keys
, ix3
);
3165 if (EQ (XCAR (c
), Qhelp_echo
))
3167 /* Don't record `help-echo' in recent_keys unless it shows some help
3168 message, and a different help than the previously recorded
3170 Lisp_Object help
, last_help
;
3172 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3173 if (!STRINGP (help
))
3175 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3176 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3178 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3179 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3180 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3182 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3183 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3184 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3185 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3188 else if (EQ (XCAR (c
), Qmouse_movement
))
3190 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3191 So additional mouse movement events replace the last element. */
3192 Lisp_Object last_window
, window
;
3194 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3195 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3196 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3197 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3198 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3200 ASET (recent_keys
, ix1
, c
);
3206 store_kbd_macro_char (c
);
3211 ASET (recent_keys
, recent_keys_index
, c
);
3212 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3213 recent_keys_index
= 0;
3215 else if (recorded
< 0)
3217 /* We need to remove one or two events from recent_keys.
3218 To do this, we simply put nil at those events and move the
3219 recent_keys_index backwards over those events. Usually,
3220 users will never see those nil events, as they will be
3221 overwritten by the command keys entered to see recent_keys
3224 while (recorded
++ < 0 && total_keys
> 0)
3226 if (total_keys
< NUM_RECENT_KEYS
)
3228 if (--recent_keys_index
< 0)
3229 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3230 ASET (recent_keys
, recent_keys_index
, Qnil
);
3234 num_nonmacro_input_events
++;
3236 /* Write c to the dribble file. If c is a lispy event, write
3237 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3238 If you, dear reader, have a better idea, you've got the source. :-) */
3243 if (XUINT (c
) < 0x100)
3244 putc (XINT (c
), dribble
);
3246 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3250 Lisp_Object dribblee
;
3252 /* If it's a structured event, take the event header. */
3253 dribblee
= EVENT_HEAD (c
);
3255 if (SYMBOLP (dribblee
))
3257 putc ('<', dribble
);
3258 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3259 SBYTES (SYMBOL_NAME (dribblee
)),
3261 putc ('>', dribble
);
3273 struct buffer
*old
= current_buffer
;
3274 Fprinc (object
, Qnil
);
3275 set_buffer_internal (XBUFFER (Vstandard_output
));
3276 call0 (intern ("help-mode"));
3277 set_buffer_internal (old
);
3281 /* Copy out or in the info on where C-g should throw to.
3282 This is used when running Lisp code from within get_char,
3283 in case get_char is called recursively.
3284 See read_process_output. */
3290 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3294 restore_getcjmp (temp
)
3297 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3302 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3303 of this function. */
3306 tracking_off (old_value
)
3307 Lisp_Object old_value
;
3309 do_mouse_tracking
= old_value
;
3310 if (NILP (old_value
))
3312 /* Redisplay may have been preempted because there was input
3313 available, and it assumes it will be called again after the
3314 input has been processed. If the only input available was
3315 the sort that we have just disabled, then we need to call
3317 if (!readable_events (1))
3319 redisplay_preserve_echo_area (6);
3320 get_input_pending (&input_pending
, 1);
3326 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3327 doc
: /* Evaluate BODY with mouse movement events enabled.
3328 Within a `track-mouse' form, mouse motion generates input events that
3329 you can read with `read-event'.
3330 Normally, mouse motion is ignored.
3331 usage: (track-mouse BODY ...) */)
3335 int count
= SPECPDL_INDEX ();
3338 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3340 do_mouse_tracking
= Qt
;
3342 val
= Fprogn (args
);
3343 return unbind_to (count
, val
);
3346 /* If mouse has moved on some frame, return one of those frames.
3347 Return 0 otherwise. */
3352 Lisp_Object tail
, frame
;
3354 FOR_EACH_FRAME (tail
, frame
)
3356 if (XFRAME (frame
)->mouse_moved
)
3357 return XFRAME (frame
);
3363 #endif /* HAVE_MOUSE */
3365 /* Low level keyboard/mouse input.
3366 kbd_buffer_store_event places events in kbd_buffer, and
3367 kbd_buffer_get_event retrieves them. */
3369 /* Return true iff there are any events in the queue that read-char
3370 would return. If this returns false, a read-char would block. */
3372 readable_filtered_events (do_timers_now
, filter_events
)
3377 timer_check (do_timers_now
);
3379 /* If the buffer contains only FOCUS_IN_EVENT events,
3380 and FILTER_EVENTS is nonzero, report it as empty. */
3381 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3383 int have_live_event
= 1;
3387 struct input_event
*event
;
3389 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3393 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3396 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3398 if (event
== kbd_store_ptr
)
3399 have_live_event
= 0;
3402 if (have_live_event
) return 1;
3406 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3411 if (current_kboard
->kbd_queue_has_data
)
3417 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3418 if (kb
->kbd_queue_has_data
)
3424 /* Return true iff there are any events in the queue that read-char
3425 would return. If this returns false, a read-char would block. */
3427 readable_events (do_timers_now
)
3430 return readable_filtered_events (do_timers_now
, 0);
3433 /* Set this for debugging, to have a way to get out */
3438 event_to_kboard (event
)
3439 struct input_event
*event
;
3442 frame
= event
->frame_or_window
;
3444 frame
= XCAR (frame
);
3445 else if (WINDOWP (frame
))
3446 frame
= WINDOW_FRAME (XWINDOW (frame
));
3448 /* There are still some events that don't set this field.
3449 For now, just ignore the problem.
3450 Also ignore dead frames here. */
3451 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3454 return FRAME_KBOARD (XFRAME (frame
));
3458 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3461 kbd_buffer_store_event (event
)
3462 register struct input_event
*event
;
3464 if (event
->kind
== NO_EVENT
)
3467 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3469 register int c
= event
->code
& 0377;
3471 if (event
->modifiers
& ctrl_modifier
)
3472 c
= make_ctrl_char (c
);
3474 c
|= (event
->modifiers
3475 & (meta_modifier
| alt_modifier
3476 | hyper_modifier
| super_modifier
));
3482 struct input_event
*sp
;
3485 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3486 kb
!= current_kboard
))
3489 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3490 Fcons (make_number (c
), Qnil
));
3491 kb
->kbd_queue_has_data
= 1;
3492 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3494 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3497 if (event_to_kboard (sp
) == kb
)
3499 sp
->kind
= NO_EVENT
;
3500 sp
->frame_or_window
= Qnil
;
3508 /* If this results in a quit_char being returned to Emacs as
3509 input, set Vlast_event_frame properly. If this doesn't
3510 get returned to Emacs as an event, the next event read
3511 will set Vlast_event_frame again, so this is safe to do. */
3515 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3517 focus
= event
->frame_or_window
;
3518 internal_last_event_frame
= focus
;
3519 Vlast_event_frame
= focus
;
3522 last_event_timestamp
= event
->timestamp
;
3523 interrupt_signal (0 /* dummy */);
3527 if (c
&& c
== stop_character
)
3533 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3534 Just ignore the second one. */
3535 else if (event
->kind
== BUFFER_SWITCH_EVENT
3536 && kbd_fetch_ptr
!= kbd_store_ptr
3537 && kbd_store_ptr
->kind
== BUFFER_SWITCH_EVENT
)
3540 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3541 kbd_store_ptr
= kbd_buffer
;
3543 /* Don't let the very last slot in the buffer become full,
3544 since that would make the two pointers equal,
3545 and that is indistinguishable from an empty buffer.
3546 Discard the event if it would fill the last slot. */
3547 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3551 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3552 prone to assign individual members for other events, in case
3553 the input_event structure is changed. --2000-07-13, gerd. */
3554 struct input_event
*sp
= kbd_store_ptr
;
3555 sp
->kind
= event
->kind
;
3556 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3558 /* We must not use the ordinary copying code for this case,
3559 since `part' is an enum and copying it might not copy enough
3561 bcopy (event
, (char *) sp
, sizeof (*event
));
3566 sp
->code
= event
->code
;
3567 sp
->part
= event
->part
;
3568 sp
->frame_or_window
= event
->frame_or_window
;
3569 sp
->arg
= event
->arg
;
3570 sp
->modifiers
= event
->modifiers
;
3573 sp
->timestamp
= event
->timestamp
;
3576 *kbd_store_ptr
= *event
;
3579 idx
= 2 * (kbd_store_ptr
- kbd_buffer
);
3580 ASET (kbd_buffer_gcpro
, idx
, event
->frame_or_window
);
3581 ASET (kbd_buffer_gcpro
, idx
+ 1, event
->arg
);
3587 /* Generate HELP_EVENT input_events in BUFP which has room for
3588 SIZE events. If there's not enough room in BUFP, ignore this
3591 HELP is the help form.
3593 FRAME is the frame on which the help is generated. OBJECT is the
3594 Lisp object where the help was found (a buffer, a string, an
3595 overlay, or nil if neither from a string nor from a buffer. POS is
3596 the position within OBJECT where the help was found.
3598 Value is the number of input_events generated. */
3601 gen_help_event (bufp
, size
, help
, frame
, window
, object
, pos
)
3602 struct input_event
*bufp
;
3604 Lisp_Object help
, frame
, object
, window
;
3609 bufp
->kind
= HELP_EVENT
;
3610 bufp
->frame_or_window
= frame
;
3612 bufp
->x
= WINDOWP (window
) ? window
: frame
;
3621 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3624 kbd_buffer_store_help_event (frame
, help
)
3625 Lisp_Object frame
, help
;
3627 struct input_event event
;
3629 event
.kind
= HELP_EVENT
;
3630 event
.frame_or_window
= frame
;
3635 kbd_buffer_store_event (&event
);
3639 /* Discard any mouse events in the event buffer by setting them to
3642 discard_mouse_events ()
3644 struct input_event
*sp
;
3645 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3647 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3650 if (sp
->kind
== MOUSE_CLICK_EVENT
3652 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3654 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3656 sp
->kind
= NO_EVENT
;
3662 /* Return non-zero if there are any real events waiting in the event
3663 buffer, not counting `NO_EVENT's.
3665 If DISCARD is non-zero, discard NO_EVENT events at the front of
3666 the input queue, possibly leaving the input queue empty if there
3667 are no real input events. */
3670 kbd_buffer_events_waiting (discard
)
3673 struct input_event
*sp
;
3675 for (sp
= kbd_fetch_ptr
;
3676 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3679 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3686 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3690 /* Clear input event EVENT. */
3694 struct input_event
*event
;
3696 int idx
= 2 * (event
- kbd_buffer
);
3697 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
3698 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
3699 event
->kind
= NO_EVENT
;
3703 /* Read one event from the event buffer, waiting if necessary.
3704 The value is a Lisp object representing the event.
3705 The value is nil for an event that should be ignored,
3706 or that was handled here.
3707 We always read and discard one event. */
3710 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3712 int *used_mouse_menu
;
3721 *kbp
= current_kboard
;
3725 /* Wait until there is input available. */
3728 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3731 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3735 /* If the quit flag is set, then read_char will return
3736 quit_char, so that counts as "available input." */
3737 if (!NILP (Vquit_flag
))
3738 quit_throw_to_read_char ();
3740 /* One way or another, wait until input is available; then, if
3741 interrupt handlers have not read it, read it now. */
3744 wait_for_kbd_input ();
3746 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3750 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3753 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3757 Lisp_Object minus_one
;
3759 XSETINT (minus_one
, -1);
3760 wait_reading_process_input (0, 0, minus_one
, 1);
3762 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3763 /* Pass 1 for EXPECT since we just waited to have input. */
3764 read_avail_input (1);
3766 #endif /* not VMS */
3769 if (CONSP (Vunread_command_events
))
3772 first
= XCAR (Vunread_command_events
);
3773 Vunread_command_events
= XCDR (Vunread_command_events
);
3774 *kbp
= current_kboard
;
3778 /* At this point, we know that there is a readable event available
3779 somewhere. If the event queue is empty, then there must be a
3780 mouse movement enabled and available. */
3781 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3783 struct input_event
*event
;
3785 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3789 last_event_timestamp
= event
->timestamp
;
3792 *kbp
= event_to_kboard (event
);
3794 *kbp
= current_kboard
; /* Better than returning null ptr? */
3796 *kbp
= &the_only_kboard
;
3801 /* These two kinds of events get special handling
3802 and don't actually appear to the command loop.
3803 We return nil for them. */
3804 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3807 struct input_event copy
;
3809 /* Remove it from the buffer before processing it,
3810 since otherwise swallow_events will see it
3811 and process it again. */
3813 kbd_fetch_ptr
= event
+ 1;
3814 input_pending
= readable_events (0);
3815 x_handle_selection_request (©
);
3817 /* We're getting selection request events, but we don't have
3823 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3826 struct input_event copy
;
3828 /* Remove it from the buffer before processing it. */
3830 kbd_fetch_ptr
= event
+ 1;
3831 input_pending
= readable_events (0);
3832 x_handle_selection_clear (©
);
3834 /* We're getting selection request events, but we don't have
3839 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3840 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3842 /* Make an event (delete-frame (FRAME)). */
3843 obj
= Fcons (event
->frame_or_window
, Qnil
);
3844 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3845 kbd_fetch_ptr
= event
+ 1;
3848 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3849 else if (event
->kind
== ICONIFY_EVENT
)
3851 /* Make an event (iconify-frame (FRAME)). */
3852 obj
= Fcons (event
->frame_or_window
, Qnil
);
3853 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3854 kbd_fetch_ptr
= event
+ 1;
3856 else if (event
->kind
== DEICONIFY_EVENT
)
3858 /* Make an event (make-frame-visible (FRAME)). */
3859 obj
= Fcons (event
->frame_or_window
, Qnil
);
3860 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3861 kbd_fetch_ptr
= event
+ 1;
3864 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3866 /* The value doesn't matter here; only the type is tested. */
3867 XSETBUFFER (obj
, current_buffer
);
3868 kbd_fetch_ptr
= event
+ 1;
3870 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS)
3871 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3873 kbd_fetch_ptr
= event
+ 1;
3874 input_pending
= readable_events (0);
3875 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3876 x_activate_menubar (XFRAME (event
->frame_or_window
));
3880 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3882 /* Make an event (language-change (FRAME CHARSET LCID)). */
3883 obj
= Fcons (event
->modifiers
, Qnil
);
3884 obj
= Fcons (event
->code
, obj
);
3885 obj
= Fcons (event
->frame_or_window
, obj
);
3886 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3887 kbd_fetch_ptr
= event
+ 1;
3890 else if (event
->kind
== SAVE_SESSION_EVENT
)
3892 obj
= Fcons (Qsave_session
, Qnil
);
3893 kbd_fetch_ptr
= event
+ 1;
3895 /* Just discard these, by returning nil.
3896 With MULTI_KBOARD, these events are used as placeholders
3897 when we need to randomly delete events from the queue.
3898 (They shouldn't otherwise be found in the buffer,
3899 but on some machines it appears they do show up
3900 even without MULTI_KBOARD.) */
3901 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3902 mouse events during a popup-menu call. */
3903 else if (event
->kind
== NO_EVENT
)
3904 kbd_fetch_ptr
= event
+ 1;
3905 else if (event
->kind
== HELP_EVENT
)
3907 Lisp_Object object
, position
, help
, frame
, window
;
3909 frame
= event
->frame_or_window
;
3910 object
= event
->arg
;
3911 position
= make_number (event
->code
);
3914 clear_event (event
);
3916 kbd_fetch_ptr
= event
+ 1;
3917 if (!WINDOWP (window
))
3919 obj
= Fcons (Qhelp_echo
,
3920 list5 (frame
, help
, window
, object
, position
));
3922 else if (event
->kind
== FOCUS_IN_EVENT
)
3924 /* Notification of a FocusIn event. The frame receiving the
3925 focus is in event->frame_or_window. Generate a
3926 switch-frame event if necessary. */
3927 Lisp_Object frame
, focus
;
3929 frame
= event
->frame_or_window
;
3930 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3934 if (!EQ (frame
, internal_last_event_frame
)
3935 && !EQ (frame
, selected_frame
))
3936 obj
= make_lispy_switch_frame (frame
);
3937 internal_last_event_frame
= frame
;
3938 kbd_fetch_ptr
= event
+ 1;
3940 else if (event
->kind
== SELECT_WINDOW_EVENT
)
3942 /* Make an event (select-window (WINDOW)). */
3943 obj
= Fcons (event
->frame_or_window
, Qnil
);
3944 obj
= Fcons (Qselect_window
, Fcons (obj
, Qnil
));
3946 kbd_fetch_ptr
= event
+ 1;
3950 /* If this event is on a different frame, return a switch-frame this
3951 time, and leave the event in the queue for next time. */
3955 frame
= event
->frame_or_window
;
3957 frame
= XCAR (frame
);
3958 else if (WINDOWP (frame
))
3959 frame
= WINDOW_FRAME (XWINDOW (frame
));
3961 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3965 if (! EQ (frame
, internal_last_event_frame
)
3966 && !EQ (frame
, selected_frame
))
3967 obj
= make_lispy_switch_frame (frame
);
3968 internal_last_event_frame
= frame
;
3970 /* If we didn't decide to make a switch-frame event, go ahead
3971 and build a real event from the queue entry. */
3975 obj
= make_lispy_event (event
);
3977 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS)
3978 /* If this was a menu selection, then set the flag to inhibit
3979 writing to last_nonmenu_event. Don't do this if the event
3980 we're returning is (menu-bar), though; that indicates the
3981 beginning of the menu sequence, and we might as well leave
3982 that as the `event with parameters' for this selection. */
3984 && !EQ (event
->frame_or_window
, event
->arg
)
3985 && (event
->kind
== MENU_BAR_EVENT
3986 || event
->kind
== TOOL_BAR_EVENT
))
3987 *used_mouse_menu
= 1;
3990 /* Wipe out this event, to catch bugs. */
3991 clear_event (event
);
3992 kbd_fetch_ptr
= event
+ 1;
3997 /* Try generating a mouse motion event. */
3998 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4000 FRAME_PTR f
= some_mouse_moved ();
4001 Lisp_Object bar_window
;
4002 enum scroll_bar_part part
;
4006 *kbp
= current_kboard
;
4007 /* Note that this uses F to determine which display to look at.
4008 If there is no valid info, it does not store anything
4009 so x remains nil. */
4011 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4015 /* Decide if we should generate a switch-frame event. Don't
4016 generate switch-frame events for motion outside of all Emacs
4022 frame
= FRAME_FOCUS_FRAME (f
);
4024 XSETFRAME (frame
, f
);
4026 if (! EQ (frame
, internal_last_event_frame
)
4027 && !EQ (frame
, selected_frame
))
4028 obj
= make_lispy_switch_frame (frame
);
4029 internal_last_event_frame
= frame
;
4032 /* If we didn't decide to make a switch-frame event, go ahead and
4033 return a mouse-motion event. */
4034 if (!NILP (x
) && NILP (obj
))
4035 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4037 #endif /* HAVE_MOUSE */
4039 /* We were promised by the above while loop that there was
4040 something for us to read! */
4043 input_pending
= readable_events (0);
4045 Vlast_event_frame
= internal_last_event_frame
;
4050 /* Process any events that are not user-visible,
4051 then return, without reading any user-visible events. */
4054 swallow_events (do_display
)
4059 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4061 struct input_event
*event
;
4063 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4067 last_event_timestamp
= event
->timestamp
;
4069 /* These two kinds of events get special handling
4070 and don't actually appear to the command loop. */
4071 if (event
->kind
== SELECTION_REQUEST_EVENT
)
4074 struct input_event copy
;
4076 /* Remove it from the buffer before processing it,
4077 since otherwise swallow_events called recursively could see it
4078 and process it again. */
4080 kbd_fetch_ptr
= event
+ 1;
4081 input_pending
= readable_events (0);
4082 x_handle_selection_request (©
);
4084 /* We're getting selection request events, but we don't have
4090 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
4093 struct input_event copy
;
4095 /* Remove it from the buffer before processing it, */
4098 kbd_fetch_ptr
= event
+ 1;
4099 input_pending
= readable_events (0);
4100 x_handle_selection_clear (©
);
4102 /* We're getting selection request events, but we don't have
4111 old_timers_run
= timers_run
;
4112 get_input_pending (&input_pending
, 1);
4114 if (timers_run
!= old_timers_run
&& do_display
)
4115 redisplay_preserve_echo_area (7);
4118 /* Record the start of when Emacs is idle,
4119 for the sake of running idle-time timers. */
4126 /* If we are already in the idle state, do nothing. */
4127 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4130 EMACS_GET_TIME (timer_idleness_start_time
);
4132 timer_last_idleness_start_time
= timer_idleness_start_time
;
4134 /* Mark all idle-time timers as once again candidates for running. */
4135 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4139 timer
= XCAR (timers
);
4141 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4143 XVECTOR (timer
)->contents
[0] = Qnil
;
4147 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4152 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4155 /* This is only for debugging. */
4156 struct input_event last_timer_event
;
4158 /* Check whether a timer has fired. To prevent larger problems we simply
4159 disregard elements that are not proper timers. Do not make a circular
4160 timer list for the time being.
4162 Returns the number of seconds to wait until the next timer fires. If a
4163 timer is triggering now, return zero seconds.
4164 If no timer is active, return -1 seconds.
4166 If a timer is ripe, we run it, with quitting turned off.
4168 DO_IT_NOW is now ignored. It used to mean that we should
4169 run the timer directly instead of queueing a timer-event.
4170 Now we always run timers directly. */
4173 timer_check (do_it_now
)
4176 EMACS_TIME nexttime
;
4177 EMACS_TIME now
, idleness_now
;
4178 Lisp_Object timers
, idle_timers
, chosen_timer
;
4179 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4181 EMACS_SET_SECS (nexttime
, -1);
4182 EMACS_SET_USECS (nexttime
, -1);
4184 /* Always consider the ordinary timers. */
4185 timers
= Vtimer_list
;
4186 /* Consider the idle timers only if Emacs is idle. */
4187 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4188 idle_timers
= Vtimer_idle_list
;
4191 chosen_timer
= Qnil
;
4192 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4194 if (CONSP (timers
) || CONSP (idle_timers
))
4196 EMACS_GET_TIME (now
);
4197 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4198 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4201 while (CONSP (timers
) || CONSP (idle_timers
))
4203 Lisp_Object
*vector
;
4204 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4205 EMACS_TIME timer_time
, idle_timer_time
;
4206 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4208 /* Skip past invalid timers and timers already handled. */
4211 timer
= XCAR (timers
);
4212 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4214 timers
= XCDR (timers
);
4217 vector
= XVECTOR (timer
)->contents
;
4219 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4220 || !INTEGERP (vector
[3])
4221 || ! NILP (vector
[0]))
4223 timers
= XCDR (timers
);
4227 if (!NILP (idle_timers
))
4229 timer
= XCAR (idle_timers
);
4230 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4232 idle_timers
= XCDR (idle_timers
);
4235 vector
= XVECTOR (timer
)->contents
;
4237 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4238 || !INTEGERP (vector
[3])
4239 || ! NILP (vector
[0]))
4241 idle_timers
= XCDR (idle_timers
);
4246 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4247 based on the next ordinary timer.
4248 TIMER_DIFFERENCE is the distance in time from NOW to when
4249 this timer becomes ripe (negative if it's already ripe). */
4252 timer
= XCAR (timers
);
4253 vector
= XVECTOR (timer
)->contents
;
4254 EMACS_SET_SECS (timer_time
,
4255 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4256 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4257 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4260 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4261 based on the next idle timer. */
4262 if (!NILP (idle_timers
))
4264 idle_timer
= XCAR (idle_timers
);
4265 vector
= XVECTOR (idle_timer
)->contents
;
4266 EMACS_SET_SECS (idle_timer_time
,
4267 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4268 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4269 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4272 /* Decide which timer is the next timer,
4273 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4274 Also step down the list where we found that timer. */
4276 if (! NILP (timers
) && ! NILP (idle_timers
))
4279 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4280 if (EMACS_TIME_NEG_P (temp
))
4282 chosen_timer
= timer
;
4283 timers
= XCDR (timers
);
4284 difference
= timer_difference
;
4288 chosen_timer
= idle_timer
;
4289 idle_timers
= XCDR (idle_timers
);
4290 difference
= idle_timer_difference
;
4293 else if (! NILP (timers
))
4295 chosen_timer
= timer
;
4296 timers
= XCDR (timers
);
4297 difference
= timer_difference
;
4301 chosen_timer
= idle_timer
;
4302 idle_timers
= XCDR (idle_timers
);
4303 difference
= idle_timer_difference
;
4305 vector
= XVECTOR (chosen_timer
)->contents
;
4307 /* If timer is ripe, run it if it hasn't been run. */
4308 if (EMACS_TIME_NEG_P (difference
)
4309 || (EMACS_SECS (difference
) == 0
4310 && EMACS_USECS (difference
) == 0))
4312 if (NILP (vector
[0]))
4314 int was_locked
= single_kboard
;
4315 int count
= SPECPDL_INDEX ();
4316 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4318 /* Mark the timer as triggered to prevent problems if the lisp
4319 code fails to reschedule it right. */
4322 specbind (Qinhibit_quit
, Qt
);
4324 call1 (Qtimer_event_handler
, chosen_timer
);
4325 Vdeactivate_mark
= old_deactivate_mark
;
4327 unbind_to (count
, Qnil
);
4329 /* Resume allowing input from any kboard, if that was true before. */
4331 any_kboard_state ();
4333 /* Since we have handled the event,
4334 we don't need to tell the caller to wake up and do it. */
4338 /* When we encounter a timer that is still waiting,
4339 return the amount of time to wait before it is ripe. */
4346 /* No timers are pending in the future. */
4347 /* Return 0 if we generated an event, and -1 if not. */
4352 /* Caches for modify_event_symbol. */
4353 static Lisp_Object accent_key_syms
;
4354 static Lisp_Object func_key_syms
;
4355 static Lisp_Object mouse_syms
;
4356 #if defined(WINDOWSNT) || defined(MAC_OSX)
4357 static Lisp_Object mouse_wheel_syms
;
4359 static Lisp_Object drag_n_drop_syms
;
4361 /* This is a list of keysym codes for special "accent" characters.
4362 It parallels lispy_accent_keys. */
4364 static int lispy_accent_codes
[] =
4366 #ifdef XK_dead_circumflex
4371 #ifdef XK_dead_grave
4376 #ifdef XK_dead_tilde
4381 #ifdef XK_dead_diaeresis
4386 #ifdef XK_dead_macron
4391 #ifdef XK_dead_degree
4396 #ifdef XK_dead_acute
4401 #ifdef XK_dead_cedilla
4406 #ifdef XK_dead_breve
4411 #ifdef XK_dead_ogonek
4416 #ifdef XK_dead_caron
4421 #ifdef XK_dead_doubleacute
4422 XK_dead_doubleacute
,
4426 #ifdef XK_dead_abovedot
4431 #ifdef XK_dead_abovering
4441 #ifdef XK_dead_belowdot
4446 #ifdef XK_dead_voiced_sound
4447 XK_dead_voiced_sound
,
4451 #ifdef XK_dead_semivoiced_sound
4452 XK_dead_semivoiced_sound
,
4468 /* This is a list of Lisp names for special "accent" characters.
4469 It parallels lispy_accent_codes. */
4471 static char *lispy_accent_keys
[] =
4489 "dead-voiced-sound",
4490 "dead-semivoiced-sound",
4496 #define FUNCTION_KEY_OFFSET 0x0
4498 char *lispy_function_keys
[] =
4502 0, /* VK_LBUTTON 0x01 */
4503 0, /* VK_RBUTTON 0x02 */
4504 "cancel", /* VK_CANCEL 0x03 */
4505 0, /* VK_MBUTTON 0x04 */
4507 0, 0, 0, /* 0x05 .. 0x07 */
4509 "backspace", /* VK_BACK 0x08 */
4510 "tab", /* VK_TAB 0x09 */
4512 0, 0, /* 0x0A .. 0x0B */
4514 "clear", /* VK_CLEAR 0x0C */
4515 "return", /* VK_RETURN 0x0D */
4517 0, 0, /* 0x0E .. 0x0F */
4519 0, /* VK_SHIFT 0x10 */
4520 0, /* VK_CONTROL 0x11 */
4521 0, /* VK_MENU 0x12 */
4522 "pause", /* VK_PAUSE 0x13 */
4523 "capslock", /* VK_CAPITAL 0x14 */
4525 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4527 "escape", /* VK_ESCAPE 0x1B */
4529 0, 0, 0, 0, /* 0x1C .. 0x1F */
4531 0, /* VK_SPACE 0x20 */
4532 "prior", /* VK_PRIOR 0x21 */
4533 "next", /* VK_NEXT 0x22 */
4534 "end", /* VK_END 0x23 */
4535 "home", /* VK_HOME 0x24 */
4536 "left", /* VK_LEFT 0x25 */
4537 "up", /* VK_UP 0x26 */
4538 "right", /* VK_RIGHT 0x27 */
4539 "down", /* VK_DOWN 0x28 */
4540 "select", /* VK_SELECT 0x29 */
4541 "print", /* VK_PRINT 0x2A */
4542 "execute", /* VK_EXECUTE 0x2B */
4543 "snapshot", /* VK_SNAPSHOT 0x2C */
4544 "insert", /* VK_INSERT 0x2D */
4545 "delete", /* VK_DELETE 0x2E */
4546 "help", /* VK_HELP 0x2F */
4548 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4550 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4552 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4554 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4556 0, 0, 0, 0, 0, 0, 0, 0, 0,
4557 0, 0, 0, 0, 0, 0, 0, 0, 0,
4558 0, 0, 0, 0, 0, 0, 0, 0,
4560 "lwindow", /* VK_LWIN 0x5B */
4561 "rwindow", /* VK_RWIN 0x5C */
4562 "apps", /* VK_APPS 0x5D */
4564 0, 0, /* 0x5E .. 0x5F */
4566 "kp-0", /* VK_NUMPAD0 0x60 */
4567 "kp-1", /* VK_NUMPAD1 0x61 */
4568 "kp-2", /* VK_NUMPAD2 0x62 */
4569 "kp-3", /* VK_NUMPAD3 0x63 */
4570 "kp-4", /* VK_NUMPAD4 0x64 */
4571 "kp-5", /* VK_NUMPAD5 0x65 */
4572 "kp-6", /* VK_NUMPAD6 0x66 */
4573 "kp-7", /* VK_NUMPAD7 0x67 */
4574 "kp-8", /* VK_NUMPAD8 0x68 */
4575 "kp-9", /* VK_NUMPAD9 0x69 */
4576 "kp-multiply", /* VK_MULTIPLY 0x6A */
4577 "kp-add", /* VK_ADD 0x6B */
4578 "kp-separator", /* VK_SEPARATOR 0x6C */
4579 "kp-subtract", /* VK_SUBTRACT 0x6D */
4580 "kp-decimal", /* VK_DECIMAL 0x6E */
4581 "kp-divide", /* VK_DIVIDE 0x6F */
4582 "f1", /* VK_F1 0x70 */
4583 "f2", /* VK_F2 0x71 */
4584 "f3", /* VK_F3 0x72 */
4585 "f4", /* VK_F4 0x73 */
4586 "f5", /* VK_F5 0x74 */
4587 "f6", /* VK_F6 0x75 */
4588 "f7", /* VK_F7 0x76 */
4589 "f8", /* VK_F8 0x77 */
4590 "f9", /* VK_F9 0x78 */
4591 "f10", /* VK_F10 0x79 */
4592 "f11", /* VK_F11 0x7A */
4593 "f12", /* VK_F12 0x7B */
4594 "f13", /* VK_F13 0x7C */
4595 "f14", /* VK_F14 0x7D */
4596 "f15", /* VK_F15 0x7E */
4597 "f16", /* VK_F16 0x7F */
4598 "f17", /* VK_F17 0x80 */
4599 "f18", /* VK_F18 0x81 */
4600 "f19", /* VK_F19 0x82 */
4601 "f20", /* VK_F20 0x83 */
4602 "f21", /* VK_F21 0x84 */
4603 "f22", /* VK_F22 0x85 */
4604 "f23", /* VK_F23 0x86 */
4605 "f24", /* VK_F24 0x87 */
4607 0, 0, 0, 0, /* 0x88 .. 0x8B */
4608 0, 0, 0, 0, /* 0x8C .. 0x8F */
4610 "kp-numlock", /* VK_NUMLOCK 0x90 */
4611 "scroll", /* VK_SCROLL 0x91 */
4613 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4614 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4615 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4616 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4617 "kp-end", /* VK_NUMPAD_END 0x96 */
4618 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4619 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4620 "kp-up", /* VK_NUMPAD_UP 0x99 */
4621 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4622 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4623 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4624 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4626 0, 0, /* 0x9E .. 0x9F */
4629 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4630 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4631 * No other API or message will distinguish left and right keys this way.
4635 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4636 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4637 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4638 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4639 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4645 "attn", /* VK_ATTN 0xF6 */
4646 "crsel", /* VK_CRSEL 0xF7 */
4647 "exsel", /* VK_EXSEL 0xF8 */
4648 "ereof", /* VK_EREOF 0xF9 */
4649 "play", /* VK_PLAY 0xFA */
4650 "zoom", /* VK_ZOOM 0xFB */
4651 "noname", /* VK_NONAME 0xFC */
4652 "pa1", /* VK_PA1 0xFD */
4653 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4657 #else /* not HAVE_NTGUI */
4659 /* This should be dealt with in XTread_socket now, and that doesn't
4660 depend on the client system having the Kana syms defined. See also
4661 the XK_kana_A case below. */
4664 static char *lispy_kana_keys
[] =
4666 /* X Keysym value */
4667 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4668 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4669 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4670 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4671 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4672 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4673 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4674 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4675 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4676 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4677 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4678 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4679 "kana-i", "kana-u", "kana-e", "kana-o",
4680 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4681 "prolongedsound", "kana-A", "kana-I", "kana-U",
4682 "kana-E", "kana-O", "kana-KA", "kana-KI",
4683 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4684 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4685 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4686 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4687 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4688 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4689 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4690 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4691 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4692 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4693 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4694 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4696 #endif /* XK_kana_A */
4699 #define FUNCTION_KEY_OFFSET 0xff00
4701 /* You'll notice that this table is arranged to be conveniently
4702 indexed by X Windows keysym values. */
4703 static char *lispy_function_keys
[] =
4705 /* X Keysym value */
4707 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4708 "backspace", "tab", "linefeed", "clear",
4710 0, 0, 0, "pause", /* 0xff10...1f */
4711 0, 0, 0, 0, 0, 0, 0, "escape",
4713 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4714 "romaji", "hiragana", "katakana", "hiragana-katakana",
4715 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4716 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4717 "eisu-toggle", /* 0xff30...3f */
4718 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4719 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4721 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4722 "down", "prior", "next", "end",
4723 "begin", 0, 0, 0, 0, 0, 0, 0,
4724 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4735 "break", /* 0xff6b */
4738 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4739 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4740 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4741 0, 0, 0, 0, 0, 0, 0, 0,
4742 "kp-tab", /* 0xff89 */
4744 "kp-enter", /* 0xff8d */
4746 "kp-f1", /* 0xff91 */
4750 "kp-home", /* 0xff95 */
4755 "kp-prior", /* kp-page-up */
4756 "kp-next", /* kp-page-down */
4762 0, 0, 0, 0, 0, 0, 0, 0, 0,
4763 "kp-multiply", /* 0xffaa */
4768 "kp-divide", /* 0xffaf */
4769 "kp-0", /* 0xffb0 */
4770 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4773 "kp-equal", /* 0xffbd */
4774 "f1", /* 0xffbe */ /* IsFunctionKey */
4776 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4777 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4778 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4779 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4780 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4781 0, 0, 0, 0, 0, 0, 0, 0,
4782 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4783 0, 0, 0, 0, 0, 0, 0, "delete"
4786 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4787 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4789 static char *iso_lispy_function_keys
[] =
4791 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4792 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4793 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4794 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4795 "iso-lefttab", /* 0xfe20 */
4796 "iso-move-line-up", "iso-move-line-down",
4797 "iso-partial-line-up", "iso-partial-line-down",
4798 "iso-partial-space-left", "iso-partial-space-right",
4799 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4800 "iso-release-margin-left", "iso-release-margin-right",
4801 "iso-release-both-margins",
4802 "iso-fast-cursor-left", "iso-fast-cursor-right",
4803 "iso-fast-cursor-up", "iso-fast-cursor-down",
4804 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4805 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4808 #endif /* not HAVE_NTGUI */
4810 Lisp_Object Vlispy_mouse_stem
;
4812 #if defined(WINDOWSNT) || defined(MAC_OSX)
4813 /* mouse-wheel events are generated by the wheel on devices such as
4814 the MS Intellimouse. The wheel sits in between the left and right
4815 mouse buttons, and is typically used to scroll or zoom the window
4816 underneath the pointer. mouse-wheel events specify the object on
4817 which they operate, and a delta corresponding to the amount and
4818 direction that the wheel is rotated. Clicking the mouse-wheel
4819 generates a mouse-2 event. */
4820 static char *lispy_mouse_wheel_names
[] =
4825 #endif /* WINDOWSNT */
4827 /* drag-n-drop events are generated when a set of selected files are
4828 dragged from another application and dropped onto an Emacs window. */
4829 static char *lispy_drag_n_drop_names
[] =
4834 /* Scroll bar parts. */
4835 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4836 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4837 Lisp_Object Qtop
, Qratio
;
4839 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4840 Lisp_Object
*scroll_bar_parts
[] = {
4841 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4842 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4845 /* User signal events. */
4846 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4848 Lisp_Object
*lispy_user_signals
[] =
4850 &Qusr1_signal
, &Qusr2_signal
4854 /* A vector, indexed by button number, giving the down-going location
4855 of currently depressed buttons, both scroll bar and non-scroll bar.
4857 The elements have the form
4858 (BUTTON-NUMBER MODIFIER-MASK . REST)
4859 where REST is the cdr of a position as it would be reported in the event.
4861 The make_lispy_event function stores positions here to tell the
4862 difference between click and drag events, and to store the starting
4863 location to be included in drag events. */
4865 static Lisp_Object button_down_location
;
4867 /* Information about the most recent up-going button event: Which
4868 button, what location, and what time. */
4870 static int last_mouse_button
;
4871 static int last_mouse_x
;
4872 static int last_mouse_y
;
4873 static unsigned long button_down_time
;
4875 /* The maximum time between clicks to make a double-click, or Qnil to
4876 disable double-click detection, or Qt for no time limit. */
4878 Lisp_Object Vdouble_click_time
;
4880 /* Maximum number of pixels the mouse may be moved between clicks
4881 to make a double-click. */
4883 EMACS_INT double_click_fuzz
;
4885 /* The number of clicks in this multiple-click. */
4887 int double_click_count
;
4889 /* Given a struct input_event, build the lisp event which represents
4890 it. If EVENT is 0, build a mouse movement event from the mouse
4891 movement buffer, which should have a movement event in it.
4893 Note that events must be passed to this function in the order they
4894 are received; this function stores the location of button presses
4895 in order to build drag events when the button is released. */
4898 make_lispy_event (event
)
4899 struct input_event
*event
;
4903 switch (SWITCH_ENUM_CAST (event
->kind
))
4905 /* A simple keystroke. */
4906 case ASCII_KEYSTROKE_EVENT
:
4908 Lisp_Object lispy_c
;
4909 int c
= event
->code
& 0377;
4910 /* Turn ASCII characters into control characters
4912 if (event
->modifiers
& ctrl_modifier
)
4913 c
= make_ctrl_char (c
);
4915 /* Add in the other modifier bits. We took care of ctrl_modifier
4916 just above, and the shift key was taken care of by the X code,
4917 and applied to control characters by make_ctrl_char. */
4918 c
|= (event
->modifiers
4919 & (meta_modifier
| alt_modifier
4920 | hyper_modifier
| super_modifier
));
4921 /* Distinguish Shift-SPC from SPC. */
4922 if ((event
->code
& 0377) == 040
4923 && event
->modifiers
& shift_modifier
)
4924 c
|= shift_modifier
;
4925 button_down_time
= 0;
4926 XSETFASTINT (lispy_c
, c
);
4930 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
4932 Lisp_Object lispy_c
;
4934 XSETFASTINT (lispy_c
, event
->code
);
4938 /* A function key. The symbol may need to have modifier prefixes
4940 case NON_ASCII_KEYSTROKE_EVENT
:
4941 button_down_time
= 0;
4943 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
4944 if (event
->code
== lispy_accent_codes
[i
])
4945 return modify_event_symbol (i
,
4947 Qfunction_key
, Qnil
,
4948 lispy_accent_keys
, &accent_key_syms
,
4949 (sizeof (lispy_accent_keys
)
4950 / sizeof (lispy_accent_keys
[0])));
4954 if (event
->code
>= 0x400 && event
->code
< 0x500)
4955 return modify_event_symbol (event
->code
- 0x400,
4956 event
->modifiers
& ~shift_modifier
,
4957 Qfunction_key
, Qnil
,
4958 lispy_kana_keys
, &func_key_syms
,
4959 (sizeof (lispy_kana_keys
)
4960 / sizeof (lispy_kana_keys
[0])));
4961 #endif /* XK_kana_A */
4964 #ifdef ISO_FUNCTION_KEY_OFFSET
4965 if (event
->code
< FUNCTION_KEY_OFFSET
4966 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
4967 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
4969 Qfunction_key
, Qnil
,
4970 iso_lispy_function_keys
, &func_key_syms
,
4971 (sizeof (iso_lispy_function_keys
)
4972 / sizeof (iso_lispy_function_keys
[0])));
4975 /* Handle system-specific or unknown keysyms. */
4976 if (event
->code
& (1 << 28)
4977 || event
->code
- FUNCTION_KEY_OFFSET
< 0
4978 || (event
->code
- FUNCTION_KEY_OFFSET
4979 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
4980 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
4982 /* We need to use an alist rather than a vector as the cache
4983 since we can't make a vector long enuf. */
4984 if (NILP (current_kboard
->system_key_syms
))
4985 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
4986 return modify_event_symbol (event
->code
,
4989 current_kboard
->Vsystem_key_alist
,
4990 0, ¤t_kboard
->system_key_syms
,
4994 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
4996 Qfunction_key
, Qnil
,
4997 lispy_function_keys
, &func_key_syms
,
4998 (sizeof (lispy_function_keys
)
4999 / sizeof (lispy_function_keys
[0])));
5002 /* A mouse click. Figure out where it is, decide whether it's
5003 a press, click or drag, and build the appropriate structure. */
5004 case MOUSE_CLICK_EVENT
:
5005 #ifndef USE_TOOLKIT_SCROLL_BARS
5006 case SCROLL_BAR_CLICK_EVENT
:
5009 int button
= event
->code
;
5011 Lisp_Object position
;
5012 Lisp_Object
*start_pos_ptr
;
5013 Lisp_Object start_pos
;
5018 /* Build the position as appropriate for this mouse click. */
5019 if (event
->kind
== MOUSE_CLICK_EVENT
)
5022 struct frame
*f
= XFRAME (event
->frame_or_window
);
5024 Lisp_Object string_info
= Qnil
;
5027 /* Ignore mouse events that were made on frame that
5028 have been deleted. */
5029 if (! FRAME_LIVE_P (f
))
5032 /* EVENT->x and EVENT->y are frame-relative pixel
5033 coordinates at this place. Under old redisplay, COLUMN
5034 and ROW are set to frame relative glyph coordinates
5035 which are then used to determine whether this click is
5036 in a menu (non-toolkit version). */
5037 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5038 &column
, &row
, NULL
, 1);
5040 #ifndef USE_X_TOOLKIT
5041 /* In the non-toolkit version, clicks on the menu bar
5042 are ordinary button events in the event buffer.
5043 Distinguish them, and invoke the menu.
5045 (In the toolkit version, the toolkit handles the menu bar
5046 and Emacs doesn't know about it until after the user
5047 makes a selection.) */
5048 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5049 && (event
->modifiers
& down_modifier
))
5051 Lisp_Object items
, item
;
5056 /* Activate the menu bar on the down event. If the
5057 up event comes in before the menu code can deal with it,
5059 if (! (event
->modifiers
& down_modifier
))
5063 /* Find the menu bar item under `column'. */
5065 items
= FRAME_MENU_BAR_ITEMS (f
);
5066 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5068 Lisp_Object pos
, string
;
5069 string
= AREF (items
, i
+ 1);
5070 pos
= AREF (items
, i
+ 3);
5073 if (column
>= XINT (pos
)
5074 && column
< XINT (pos
) + SCHARS (string
))
5076 item
= AREF (items
, i
);
5081 /* ELisp manual 2.4b says (x y) are window relative but
5082 code says they are frame-relative. */
5084 = Fcons (event
->frame_or_window
,
5086 Fcons (Fcons (event
->x
, event
->y
),
5087 Fcons (make_number (event
->timestamp
),
5090 return Fcons (item
, Fcons (position
, Qnil
));
5092 #endif /* not USE_X_TOOLKIT */
5094 /* Set `window' to the window under frame pixel coordinates
5095 event->x/event->y. */
5096 window
= window_from_coordinates (f
, XINT (event
->x
),
5097 XINT (event
->y
), &part
, 0);
5099 if (!WINDOWP (window
))
5101 window
= event
->frame_or_window
;
5106 /* It's a click in window window at frame coordinates
5107 event->x/ event->y. */
5108 struct window
*w
= XWINDOW (window
);
5110 /* Get window relative coordinates. Original code
5111 `rounded' this to glyph boundaries. */
5112 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
5113 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
5115 /* Set event coordinates to window-relative coordinates
5116 for constructing the Lisp event below. */
5117 XSETINT (event
->x
, wx
);
5118 XSETINT (event
->y
, wy
);
5120 if (part
== 1 || part
== 3)
5122 /* Mode line or header line. Look for a string under
5123 the mouse that may have a `local-map' property. */
5127 posn
= part
== 1 ? Qmode_line
: Qheader_line
;
5128 string
= mode_line_string (w
, wx
, wy
, part
== 1, &charpos
);
5129 if (STRINGP (string
))
5130 string_info
= Fcons (string
, make_number (charpos
));
5133 posn
= Qvertical_line
;
5134 else if (part
== 6 || part
== 7)
5137 Lisp_Object object
= marginal_area_string (w
, wx
, wy
, part
,
5139 posn
= (part
== 6) ? Qleft_margin
: Qright_margin
;
5140 if (STRINGP (object
))
5141 string_info
= Fcons (object
, make_number (charpos
));
5146 struct display_pos p
;
5147 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5148 posn
= make_number (CHARPOS (p
.pos
));
5149 if (STRINGP (object
))
5152 make_number (CHARPOS (p
.string_pos
)));
5159 Fcons (Fcons (event
->x
, event
->y
),
5160 Fcons (make_number (event
->timestamp
),
5163 : Fcons (string_info
, Qnil
))))));
5165 #ifndef USE_TOOLKIT_SCROLL_BARS
5168 /* It's a scrollbar click. */
5169 Lisp_Object portion_whole
;
5172 window
= event
->frame_or_window
;
5173 portion_whole
= Fcons (event
->x
, event
->y
);
5174 part
= *scroll_bar_parts
[(int) event
->part
];
5178 Fcons (Qvertical_scroll_bar
,
5179 Fcons (portion_whole
,
5180 Fcons (make_number (event
->timestamp
),
5181 Fcons (part
, Qnil
)))));
5183 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5185 if (button
>= ASIZE (button_down_location
))
5187 button_down_location
= larger_vector (button_down_location
,
5189 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5192 start_pos_ptr
= &AREF (button_down_location
, button
);
5193 start_pos
= *start_pos_ptr
;
5194 *start_pos_ptr
= Qnil
;
5197 /* On window-system frames, use the value of
5198 double-click-fuzz as is. On other frames, interpret it
5199 as a multiple of 1/8 characters. */
5203 if (WINDOWP (event
->frame_or_window
))
5204 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5205 else if (FRAMEP (event
->frame_or_window
))
5206 f
= XFRAME (event
->frame_or_window
);
5210 if (FRAME_WINDOW_P (f
))
5211 fuzz
= double_click_fuzz
;
5213 fuzz
= double_click_fuzz
/ 8;
5215 is_double
= (button
== last_mouse_button
5216 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5217 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5218 && button_down_time
!= 0
5219 && (EQ (Vdouble_click_time
, Qt
)
5220 || (INTEGERP (Vdouble_click_time
)
5221 && ((int)(event
->timestamp
- button_down_time
)
5222 < XINT (Vdouble_click_time
)))));
5225 last_mouse_button
= button
;
5226 last_mouse_x
= XINT (event
->x
);
5227 last_mouse_y
= XINT (event
->y
);
5229 /* If this is a button press, squirrel away the location, so
5230 we can decide later whether it was a click or a drag. */
5231 if (event
->modifiers
& down_modifier
)
5235 double_click_count
++;
5236 event
->modifiers
|= ((double_click_count
> 2)
5241 double_click_count
= 1;
5242 button_down_time
= event
->timestamp
;
5243 *start_pos_ptr
= Fcopy_alist (position
);
5246 /* Now we're releasing a button - check the co-ordinates to
5247 see if this was a click or a drag. */
5248 else if (event
->modifiers
& up_modifier
)
5250 /* If we did not see a down before this up, ignore the up.
5251 Probably this happened because the down event chose a
5252 menu item. It would be an annoyance to treat the
5253 release of the button that chose the menu item as a
5256 if (!CONSP (start_pos
))
5259 event
->modifiers
&= ~up_modifier
;
5260 #if 0 /* Formerly we treated an up with no down as a click event. */
5261 if (!CONSP (start_pos
))
5262 event
->modifiers
|= click_modifier
;
5267 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5269 /* The third element of every position
5270 should be the (x,y) pair. */
5271 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5273 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5275 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5276 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5279 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5280 && ydiff
< double_click_fuzz
5281 && ydiff
> - double_click_fuzz
)
5282 /* Mouse hasn't moved (much). */
5283 event
->modifiers
|= click_modifier
;
5286 button_down_time
= 0;
5287 event
->modifiers
|= drag_modifier
;
5290 /* Don't check is_double; treat this as multiple
5291 if the down-event was multiple. */
5292 if (double_click_count
> 1)
5293 event
->modifiers
|= ((double_click_count
> 2)
5299 /* Every mouse event should either have the down_modifier or
5300 the up_modifier set. */
5304 /* Get the symbol we should use for the mouse click. */
5307 head
= modify_event_symbol (button
,
5309 Qmouse_click
, Vlispy_mouse_stem
,
5312 XVECTOR (mouse_syms
)->size
);
5313 if (event
->modifiers
& drag_modifier
)
5318 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5321 Fcons (make_number (double_click_count
),
5330 #ifdef USE_TOOLKIT_SCROLL_BARS
5332 /* We don't have down and up events if using toolkit scroll bars,
5333 so make this always a click event. Store in the `part' of
5334 the Lisp event a symbol which maps to the following actions:
5336 `above_handle' page up
5337 `below_handle' page down
5341 `bottom' bottom of buffer
5342 `handle' thumb has been dragged.
5343 `end-scroll' end of interaction with scroll bar
5345 The incoming input_event contains in its `part' member an
5346 index of type `enum scroll_bar_part' which we can use as an
5347 index in scroll_bar_parts to get the appropriate symbol. */
5349 case SCROLL_BAR_CLICK_EVENT
:
5351 Lisp_Object position
, head
, window
, portion_whole
, part
;
5353 window
= event
->frame_or_window
;
5354 portion_whole
= Fcons (event
->x
, event
->y
);
5355 part
= *scroll_bar_parts
[(int) event
->part
];
5359 Fcons (Qvertical_scroll_bar
,
5360 Fcons (portion_whole
,
5361 Fcons (make_number (event
->timestamp
),
5362 Fcons (part
, Qnil
)))));
5364 /* Always treat scroll bar events as clicks. */
5365 event
->modifiers
|= click_modifier
;
5366 event
->modifiers
&= ~up_modifier
;
5368 /* Get the symbol we should use for the mouse click. */
5369 head
= modify_event_symbol (event
->code
,
5374 XVECTOR (mouse_syms
)->size
);
5375 return Fcons (head
, Fcons (position
, Qnil
));
5378 #endif /* USE_TOOLKIT_SCROLL_BARS */
5381 case W32_SCROLL_BAR_CLICK_EVENT
:
5383 int button
= event
->code
;
5385 Lisp_Object position
;
5386 Lisp_Object
*start_pos_ptr
;
5387 Lisp_Object start_pos
;
5391 Lisp_Object portion_whole
;
5394 window
= event
->frame_or_window
;
5395 portion_whole
= Fcons (event
->x
, event
->y
);
5396 part
= *scroll_bar_parts
[(int) event
->part
];
5400 Fcons (Qvertical_scroll_bar
,
5401 Fcons (portion_whole
,
5402 Fcons (make_number (event
->timestamp
),
5403 Fcons (part
, Qnil
)))));
5406 /* Always treat W32 scroll bar events as clicks. */
5407 event
->modifiers
|= click_modifier
;
5410 /* Get the symbol we should use for the mouse click. */
5413 head
= modify_event_symbol (button
,
5418 XVECTOR (mouse_syms
)->size
);
5424 #endif /* WINDOWSNT */
5425 #if defined(WINDOWSNT) || defined(MAC_OSX)
5426 case MOUSE_WHEEL_EVENT
:
5429 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5432 Lisp_Object head
, position
;
5435 /* Ignore mouse events that were made on frame that
5436 have been deleted. */
5437 if (! FRAME_LIVE_P (f
))
5439 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5440 &column
, &row
, NULL
, 1);
5441 window
= window_from_coordinates (f
, XINT (event
->x
),
5442 XINT (event
->y
), &part
, 0);
5444 if (!WINDOWP (window
))
5446 window
= event
->frame_or_window
;
5451 int pixcolumn
, pixrow
;
5452 column
-= XINT (XWINDOW (window
)->left
);
5453 row
-= XINT (XWINDOW (window
)->top
);
5454 glyph_to_pixel_coords (XWINDOW(window
), column
, row
,
5455 &pixcolumn
, &pixrow
);
5456 XSETINT (event
->x
, pixcolumn
);
5457 XSETINT (event
->y
, pixrow
);
5462 posn
= Qvertical_line
;
5464 posn
= Qheader_line
;
5468 struct display_pos p
;
5469 buffer_posn_from_coords (XWINDOW (window
), &column
, &row
,
5471 posn
= make_number (CHARPOS (p
.pos
));
5476 Lisp_Object head
, position
;
5481 Fcons (Fcons (event
->x
, event
->y
),
5482 Fcons (make_number (event
->timestamp
),
5485 head
= modify_event_symbol (0, event
->modifiers
,
5487 lispy_mouse_wheel_names
,
5488 &mouse_wheel_syms
, 1);
5491 /* Insert 1 here so event-click-count works. */
5492 Fcons (make_number (1),
5493 Fcons (make_number (event
->code
),
5497 #endif /* WINDOWSNT || MAC_OSX */
5499 case DRAG_N_DROP_EVENT
:
5507 /* The frame_or_window field should be a cons of the frame in
5508 which the event occurred and a list of the filenames
5510 if (! CONSP (event
->frame_or_window
))
5513 f
= XFRAME (XCAR (event
->frame_or_window
));
5514 files
= XCDR (event
->frame_or_window
);
5516 /* Ignore mouse events that were made on frames that
5517 have been deleted. */
5518 if (! FRAME_LIVE_P (f
))
5521 window
= window_from_coordinates (f
, XINT (event
->x
),
5522 XINT (event
->y
), &part
, 0);
5524 if (!WINDOWP (window
))
5526 window
= XCAR (event
->frame_or_window
);
5531 /* It's an event in window `window' at frame coordinates
5532 event->x/ event->y. */
5533 struct window
*w
= XWINDOW (window
);
5535 /* Get window relative coordinates. */
5536 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
5537 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
5539 /* Set event coordinates to window-relative coordinates
5540 for constructing the Lisp event below. */
5541 XSETINT (event
->x
, wx
);
5542 XSETINT (event
->y
, wy
);
5547 posn
= Qvertical_line
;
5549 posn
= Qheader_line
;
5553 struct display_pos p
;
5554 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5555 posn
= make_number (CHARPOS (p
.pos
));
5560 Lisp_Object head
, position
;
5565 Fcons (Fcons (event
->x
, event
->y
),
5566 Fcons (make_number (event
->timestamp
),
5569 head
= modify_event_symbol (0, event
->modifiers
,
5571 lispy_drag_n_drop_names
,
5572 &drag_n_drop_syms
, 1);
5579 #endif /* HAVE_MOUSE */
5581 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS)
5582 case MENU_BAR_EVENT
:
5583 if (EQ (event
->arg
, event
->frame_or_window
))
5584 /* This is the prefix key. We translate this to
5585 `(menu_bar)' because the code in keyboard.c for menu
5586 events, which we use, relies on this. */
5587 return Fcons (Qmenu_bar
, Qnil
);
5591 case TOOL_BAR_EVENT
:
5592 if (EQ (event
->arg
, event
->frame_or_window
))
5593 /* This is the prefix key. We translate this to
5594 `(tool_bar)' because the code in keyboard.c for tool bar
5595 events, which we use, relies on this. */
5596 return Fcons (Qtool_bar
, Qnil
);
5597 else if (SYMBOLP (event
->arg
))
5598 return apply_modifiers (event
->modifiers
, event
->arg
);
5601 case USER_SIGNAL_EVENT
:
5602 /* A user signal. */
5603 return *lispy_user_signals
[event
->code
];
5605 case SAVE_SESSION_EVENT
:
5606 return Qsave_session
;
5608 /* The 'kind' field of the event is something we don't recognize. */
5617 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5619 Lisp_Object bar_window
;
5620 enum scroll_bar_part part
;
5624 /* Is it a scroll bar movement? */
5625 if (frame
&& ! NILP (bar_window
))
5627 Lisp_Object part_sym
;
5629 part_sym
= *scroll_bar_parts
[(int) part
];
5630 return Fcons (Qscroll_bar_movement
,
5631 (Fcons (Fcons (bar_window
,
5632 Fcons (Qvertical_scroll_bar
,
5633 Fcons (Fcons (x
, y
),
5634 Fcons (make_number (time
),
5640 /* Or is it an ordinary mouse movement? */
5648 /* It's in a frame; which window on that frame? */
5649 window
= window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
, 0);
5653 if (WINDOWP (window
))
5655 struct window
*w
= XWINDOW (window
);
5658 /* Get window relative coordinates. */
5659 wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (x
));
5660 wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (y
));
5667 posn
= Qvertical_line
;
5669 posn
= Qheader_line
;
5673 struct display_pos p
;
5674 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5675 posn
= make_number (CHARPOS (p
.pos
));
5678 else if (frame
!= 0)
5680 XSETFRAME (window
, frame
);
5691 return Fcons (Qmouse_movement
,
5692 Fcons (Fcons (window
,
5694 Fcons (Fcons (x
, y
),
5695 Fcons (make_number (time
),
5701 #endif /* HAVE_MOUSE */
5703 /* Construct a switch frame event. */
5705 make_lispy_switch_frame (frame
)
5708 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5711 /* Manipulating modifiers. */
5713 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5715 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5716 SYMBOL's name of the end of the modifiers; the string from this
5717 position is the unmodified symbol name.
5719 This doesn't use any caches. */
5722 parse_modifiers_uncached (symbol
, modifier_end
)
5730 CHECK_SYMBOL (symbol
);
5733 name
= SYMBOL_NAME (symbol
);
5735 for (i
= 0; i
+2 <= SBYTES (name
); )
5737 int this_mod_end
= 0;
5740 /* See if the name continues with a modifier word.
5741 Check that the word appears, but don't check what follows it.
5742 Set this_mod and this_mod_end to record what we find. */
5744 switch (SREF (name
, i
))
5746 #define SINGLE_LETTER_MOD(BIT) \
5747 (this_mod_end = i + 1, this_mod = BIT)
5750 SINGLE_LETTER_MOD (alt_modifier
);
5754 SINGLE_LETTER_MOD (ctrl_modifier
);
5758 SINGLE_LETTER_MOD (hyper_modifier
);
5762 SINGLE_LETTER_MOD (meta_modifier
);
5766 SINGLE_LETTER_MOD (shift_modifier
);
5770 SINGLE_LETTER_MOD (super_modifier
);
5773 #undef SINGLE_LETTER_MOD
5776 /* If we found no modifier, stop looking for them. */
5777 if (this_mod_end
== 0)
5780 /* Check there is a dash after the modifier, so that it
5781 really is a modifier. */
5782 if (this_mod_end
>= SBYTES (name
)
5783 || SREF (name
, this_mod_end
) != '-')
5786 /* This modifier is real; look for another. */
5787 modifiers
|= this_mod
;
5788 i
= this_mod_end
+ 1;
5791 /* Should we include the `click' modifier? */
5792 if (! (modifiers
& (down_modifier
| drag_modifier
5793 | double_modifier
| triple_modifier
))
5794 && i
+ 7 == SBYTES (name
)
5795 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5796 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5797 modifiers
|= click_modifier
;
5805 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5806 prepended to the string BASE[0..BASE_LEN-1].
5807 This doesn't use any caches. */
5809 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5812 int base_len
, base_len_byte
;
5814 /* Since BASE could contain nulls, we can't use intern here; we have
5815 to use Fintern, which expects a genuine Lisp_String, and keeps a
5818 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5824 /* Only the event queue may use the `up' modifier; it should always
5825 be turned into a click or drag event before presented to lisp code. */
5826 if (modifiers
& up_modifier
)
5829 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5830 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5831 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5832 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5833 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5834 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5835 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5836 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5837 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5838 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5839 /* The click modifier is denoted by the absence of other modifiers. */
5843 mod_len
= p
- new_mods
;
5847 Lisp_Object new_name
;
5849 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5850 mod_len
+ base_len_byte
);
5851 bcopy (new_mods
, SDATA (new_name
), mod_len
);
5852 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
5854 return Fintern (new_name
, Qnil
);
5859 static char *modifier_names
[] =
5861 "up", "down", "drag", "click", "double", "triple", 0, 0,
5862 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5863 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5865 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5867 static Lisp_Object modifier_symbols
;
5869 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5871 lispy_modifier_list (modifiers
)
5874 Lisp_Object modifier_list
;
5877 modifier_list
= Qnil
;
5878 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
5879 if (modifiers
& (1<<i
))
5880 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
5883 return modifier_list
;
5887 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
5888 where UNMODIFIED is the unmodified form of SYMBOL,
5889 MASK is the set of modifiers present in SYMBOL's name.
5890 This is similar to parse_modifiers_uncached, but uses the cache in
5891 SYMBOL's Qevent_symbol_element_mask property, and maintains the
5892 Qevent_symbol_elements property. */
5895 parse_modifiers (symbol
)
5898 Lisp_Object elements
;
5900 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
5901 if (CONSP (elements
))
5906 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
5907 Lisp_Object unmodified
;
5910 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
5911 SBYTES (SYMBOL_NAME (symbol
)) - end
),
5914 if (modifiers
& ~VALMASK
)
5916 XSETFASTINT (mask
, modifiers
);
5917 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
5919 /* Cache the parsing results on SYMBOL. */
5920 Fput (symbol
, Qevent_symbol_element_mask
,
5922 Fput (symbol
, Qevent_symbol_elements
,
5923 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
5925 /* Since we know that SYMBOL is modifiers applied to unmodified,
5926 it would be nice to put that in unmodified's cache.
5927 But we can't, since we're not sure that parse_modifiers is
5934 /* Apply the modifiers MODIFIERS to the symbol BASE.
5935 BASE must be unmodified.
5937 This is like apply_modifiers_uncached, but uses BASE's
5938 Qmodifier_cache property, if present. It also builds
5939 Qevent_symbol_elements properties, since it has that info anyway.
5941 apply_modifiers copies the value of BASE's Qevent_kind property to
5942 the modified symbol. */
5944 apply_modifiers (modifiers
, base
)
5948 Lisp_Object cache
, index
, entry
, new_symbol
;
5950 /* Mask out upper bits. We don't know where this value's been. */
5951 modifiers
&= VALMASK
;
5953 /* The click modifier never figures into cache indices. */
5954 cache
= Fget (base
, Qmodifier_cache
);
5955 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
5956 entry
= assq_no_quit (index
, cache
);
5959 new_symbol
= XCDR (entry
);
5962 /* We have to create the symbol ourselves. */
5963 new_symbol
= apply_modifiers_uncached (modifiers
,
5964 SDATA (SYMBOL_NAME (base
)),
5965 SCHARS (SYMBOL_NAME (base
)),
5966 SBYTES (SYMBOL_NAME (base
)));
5968 /* Add the new symbol to the base's cache. */
5969 entry
= Fcons (index
, new_symbol
);
5970 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
5972 /* We have the parsing info now for free, so add it to the caches. */
5973 XSETFASTINT (index
, modifiers
);
5974 Fput (new_symbol
, Qevent_symbol_element_mask
,
5975 Fcons (base
, Fcons (index
, Qnil
)));
5976 Fput (new_symbol
, Qevent_symbol_elements
,
5977 Fcons (base
, lispy_modifier_list (modifiers
)));
5980 /* Make sure this symbol is of the same kind as BASE.
5982 You'd think we could just set this once and for all when we
5983 intern the symbol above, but reorder_modifiers may call us when
5984 BASE's property isn't set right; we can't assume that just
5985 because it has a Qmodifier_cache property it must have its
5986 Qevent_kind set right as well. */
5987 if (NILP (Fget (new_symbol
, Qevent_kind
)))
5991 kind
= Fget (base
, Qevent_kind
);
5993 Fput (new_symbol
, Qevent_kind
, kind
);
6000 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6001 return a symbol with the modifiers placed in the canonical order.
6002 Canonical order is alphabetical, except for down and drag, which
6003 always come last. The 'click' modifier is never written out.
6005 Fdefine_key calls this to make sure that (for example) C-M-foo
6006 and M-C-foo end up being equivalent in the keymap. */
6009 reorder_modifiers (symbol
)
6012 /* It's hopefully okay to write the code this way, since everything
6013 will soon be in caches, and no consing will be done at all. */
6016 parsed
= parse_modifiers (symbol
);
6017 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6022 /* For handling events, we often want to produce a symbol whose name
6023 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6024 to some base, like the name of a function key or mouse button.
6025 modify_event_symbol produces symbols of this sort.
6027 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6028 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6031 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6032 into symbol names, or a string specifying a name stem used to
6033 construct a symbol name or the form `STEM-N', where N is the decimal
6034 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6035 non-nil; otherwise NAME_TABLE is used.
6037 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6038 persist between calls to modify_event_symbol that it can use to
6039 store a cache of the symbols it's generated for this NAME_TABLE
6040 before. The object stored there may be a vector or an alist.
6042 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6044 MODIFIERS is a set of modifier bits (as given in struct input_events)
6045 whose prefixes should be applied to the symbol name.
6047 SYMBOL_KIND is the value to be placed in the event_kind property of
6048 the returned symbol.
6050 The symbols we create are supposed to have an
6051 `event-symbol-elements' property, which lists the modifiers present
6052 in the symbol's name. */
6055 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6056 name_table
, symbol_table
, table_size
)
6059 Lisp_Object symbol_kind
;
6060 Lisp_Object name_alist_or_stem
;
6062 Lisp_Object
*symbol_table
;
6063 unsigned int table_size
;
6066 Lisp_Object symbol_int
;
6068 /* Get rid of the "vendor-specific" bit here. */
6069 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6071 /* Is this a request for a valid symbol? */
6072 if (symbol_num
< 0 || symbol_num
>= table_size
)
6075 if (CONSP (*symbol_table
))
6076 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6078 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6079 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6080 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6081 we've never used that symbol before. */
6084 if (! VECTORP (*symbol_table
)
6085 || XVECTOR (*symbol_table
)->size
!= table_size
)
6089 XSETFASTINT (size
, table_size
);
6090 *symbol_table
= Fmake_vector (size
, Qnil
);
6093 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6096 /* Have we already used this symbol before? */
6099 /* No; let's create it. */
6100 if (CONSP (name_alist_or_stem
))
6101 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6102 else if (STRINGP (name_alist_or_stem
))
6104 int len
= SBYTES (name_alist_or_stem
);
6105 char *buf
= (char *) alloca (len
+ 50);
6106 if (sizeof (int) == sizeof (EMACS_INT
))
6107 sprintf (buf
, "%s-%d", SDATA (name_alist_or_stem
),
6108 XINT (symbol_int
) + 1);
6109 else if (sizeof (long) == sizeof (EMACS_INT
))
6110 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6111 XINT (symbol_int
) + 1);
6112 value
= intern (buf
);
6114 else if (name_table
!= 0 && name_table
[symbol_num
])
6115 value
= intern (name_table
[symbol_num
]);
6117 #ifdef HAVE_WINDOW_SYSTEM
6120 char *name
= x_get_keysym_name (symbol_num
);
6122 value
= intern (name
);
6129 sprintf (buf
, "key-%d", symbol_num
);
6130 value
= intern (buf
);
6133 if (CONSP (*symbol_table
))
6134 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6136 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6138 /* Fill in the cache entries for this symbol; this also
6139 builds the Qevent_symbol_elements property, which the user
6141 apply_modifiers (modifiers
& click_modifier
, value
);
6142 Fput (value
, Qevent_kind
, symbol_kind
);
6145 /* Apply modifiers to that symbol. */
6146 return apply_modifiers (modifiers
, value
);
6149 /* Convert a list that represents an event type,
6150 such as (ctrl meta backspace), into the usual representation of that
6151 event type as a number or a symbol. */
6153 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6154 doc
: /* Convert the event description list EVENT-DESC to an event type.
6155 EVENT-DESC should contain one base event type (a character or symbol)
6156 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6157 drag, down, double or triple). The base must be last.
6158 The return value is an event type (a character or symbol) which
6159 has the same base event type and all the specified modifiers. */)
6161 Lisp_Object event_desc
;
6169 while (CONSP (rest
))
6177 /* Given a symbol, see if it is a modifier name. */
6178 if (SYMBOLP (elt
) && CONSP (rest
))
6179 this = parse_solitary_modifier (elt
);
6183 else if (!NILP (base
))
6184 error ("Two bases given in one event");
6190 /* Let the symbol A refer to the character A. */
6191 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6192 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6194 if (INTEGERP (base
))
6196 /* Turn (shift a) into A. */
6197 if ((modifiers
& shift_modifier
) != 0
6198 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6200 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6201 modifiers
&= ~shift_modifier
;
6204 /* Turn (control a) into C-a. */
6205 if (modifiers
& ctrl_modifier
)
6206 return make_number ((modifiers
& ~ctrl_modifier
)
6207 | make_ctrl_char (XINT (base
)));
6209 return make_number (modifiers
| XINT (base
));
6211 else if (SYMBOLP (base
))
6212 return apply_modifiers (modifiers
, base
);
6215 error ("Invalid base event");
6220 /* Try to recognize SYMBOL as a modifier name.
6221 Return the modifier flag bit, or 0 if not recognized. */
6224 parse_solitary_modifier (symbol
)
6227 Lisp_Object name
= SYMBOL_NAME (symbol
);
6229 switch (SREF (name
, 0))
6231 #define SINGLE_LETTER_MOD(BIT) \
6232 if (SBYTES (name) == 1) \
6235 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6236 if (LEN == SBYTES (name) \
6237 && ! strncmp (SDATA (name), NAME, LEN)) \
6241 SINGLE_LETTER_MOD (alt_modifier
);
6245 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6249 SINGLE_LETTER_MOD (ctrl_modifier
);
6253 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6254 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6258 SINGLE_LETTER_MOD (hyper_modifier
);
6262 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6266 SINGLE_LETTER_MOD (meta_modifier
);
6270 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6274 SINGLE_LETTER_MOD (shift_modifier
);
6278 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6279 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6280 SINGLE_LETTER_MOD (super_modifier
);
6284 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6285 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6286 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6290 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6293 #undef SINGLE_LETTER_MOD
6294 #undef MULTI_LETTER_MOD
6300 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6301 Such a list is not valid as an event,
6302 but it can be a Lucid-style event type list. */
6305 lucid_event_type_list_p (object
)
6310 if (! CONSP (object
))
6313 if (EQ (XCAR (object
), Qhelp_echo
)
6314 || EQ (XCAR (object
), Qvertical_line
)
6315 || EQ (XCAR (object
), Qmode_line
)
6316 || EQ (XCAR (object
), Qheader_line
))
6319 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6323 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6330 /* Store into *addr a value nonzero if terminal input chars are available.
6331 Serves the purpose of ioctl (0, FIONREAD, addr)
6332 but works even if FIONREAD does not exist.
6333 (In fact, this may actually read some input.)
6335 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6336 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6339 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6344 /* First of all, have we already counted some input? */
6345 *addr
= (!NILP (Vquit_flag
)
6346 || readable_filtered_events (do_timers_now
, filter_events
));
6348 /* If input is being read as it arrives, and we have none, there is none. */
6349 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6352 /* Try to read some input and see how much we get. */
6354 *addr
= (!NILP (Vquit_flag
)
6355 || readable_filtered_events (do_timers_now
, filter_events
));
6358 /* Store into *addr a value nonzero if terminal input chars are available.
6359 Serves the purpose of ioctl (0, FIONREAD, addr)
6360 but works even if FIONREAD does not exist.
6361 (In fact, this may actually read some input.)
6363 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6366 get_input_pending (addr
, do_timers_now
)
6370 get_filtered_input_pending (addr
, do_timers_now
, 0);
6373 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6376 gobble_input (expected
)
6381 if (interrupt_input
)
6384 mask
= sigblock (sigmask (SIGIO
));
6385 read_avail_input (expected
);
6389 #ifdef POLL_FOR_INPUT
6390 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6393 mask
= sigblock (sigmask (SIGALRM
));
6394 read_avail_input (expected
);
6400 read_avail_input (expected
);
6404 /* Put a BUFFER_SWITCH_EVENT in the buffer
6405 so that read_key_sequence will notice the new current buffer. */
6408 record_asynch_buffer_change ()
6410 struct input_event event
;
6413 event
.kind
= BUFFER_SWITCH_EVENT
;
6414 event
.frame_or_window
= Qnil
;
6418 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6419 The purpose of the event is to make read_key_sequence look up the
6420 keymaps again. If we aren't in read_key_sequence, we don't need one,
6421 and the event could cause trouble by messing up (input-pending-p). */
6422 tem
= Fwaiting_for_user_input_p ();
6426 /* We never need these events if we have no asynchronous subprocesses. */
6430 /* Make sure no interrupt happens while storing the event. */
6432 if (interrupt_input
)
6435 mask
= sigblock (sigmask (SIGIO
));
6436 kbd_buffer_store_event (&event
);
6443 kbd_buffer_store_event (&event
);
6450 /* Read any terminal input already buffered up by the system
6451 into the kbd_buffer, but do not wait.
6453 EXPECTED should be nonzero if the caller knows there is some input.
6455 Except on VMS, all input is read by this function.
6456 If interrupt_input is nonzero, this function MUST be called
6457 only when SIGIO is blocked.
6459 Returns the number of keyboard chars read, or -1 meaning
6460 this is a bad time to try to read input. */
6463 read_avail_input (expected
)
6466 struct input_event buf
[KBD_BUFFER_SIZE
];
6470 if (read_socket_hook
)
6471 /* No need for FIONREAD or fcntl; just say don't wait. */
6472 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
6475 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6476 the kbd_buffer can really hold. That may prevent loss
6477 of characters on some systems when input is stuffed at us. */
6478 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6481 /* Determine how many characters we should *try* to read. */
6484 #else /* not WINDOWSNT */
6486 n_to_read
= dos_keysns ();
6489 #else /* not MSDOS */
6491 /* Find out how much input is available. */
6492 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6493 /* Formerly simply reported no input, but that sometimes led to
6494 a failure of Emacs to terminate.
6495 SIGHUP seems appropriate if we can't reach the terminal. */
6496 /* ??? Is it really right to send the signal just to this process
6497 rather than to the whole process group?
6498 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6499 kill (getpid (), SIGHUP
);
6502 if (n_to_read
> sizeof cbuf
)
6503 n_to_read
= sizeof cbuf
;
6504 #else /* no FIONREAD */
6505 #if defined (USG) || defined (DGUX)
6506 /* Read some input if available, but don't wait. */
6507 n_to_read
= sizeof cbuf
;
6508 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6513 #endif /* not MSDOS */
6514 #endif /* not WINDOWSNT */
6516 /* Now read; for one reason or another, this will not block.
6517 NREAD is set to the number of chars read. */
6521 cbuf
[0] = dos_keyread ();
6524 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6526 /* POSIX infers that processes which are not in the session leader's
6527 process group won't get SIGHUP's at logout time. BSDI adheres to
6528 this part standard and returns -1 from read (0) with errno==EIO
6529 when the control tty is taken away.
6530 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6531 if (nread
== -1 && errno
== EIO
)
6533 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6534 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6535 This looks incorrect, but it isn't, because _BSD causes
6536 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6537 and that causes a value other than 0 when there is no input. */
6543 /* We used to retry the read if it was interrupted.
6544 But this does the wrong thing when O_NDELAY causes
6545 an EAGAIN error. Does anybody know of a situation
6546 where a retry is actually needed? */
6548 nread
< 0 && (errno
== EAGAIN
6562 #if defined (USG) || defined (DGUX)
6563 fcntl (input_fd
, F_SETFL
, 0);
6564 #endif /* USG or DGUX */
6565 #endif /* no FIONREAD */
6566 for (i
= 0; i
< nread
; i
++)
6568 buf
[i
].kind
= ASCII_KEYSTROKE_EVENT
;
6569 buf
[i
].modifiers
= 0;
6570 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6571 buf
[i
].modifiers
= meta_modifier
;
6575 buf
[i
].code
= cbuf
[i
];
6576 buf
[i
].frame_or_window
= selected_frame
;
6581 /* Scan the chars for C-g and store them in kbd_buffer. */
6582 for (i
= 0; i
< nread
; i
++)
6584 kbd_buffer_store_event (&buf
[i
]);
6585 /* Don't look at input that follows a C-g too closely.
6586 This reduces lossage due to autorepeat on C-g. */
6587 if (buf
[i
].kind
== ASCII_KEYSTROKE_EVENT
6588 && buf
[i
].code
== quit_char
)
6594 #endif /* not VMS */
6596 #ifdef SIGIO /* for entire page */
6597 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6600 input_available_signal (signo
)
6603 /* Must preserve main program's value of errno. */
6604 int old_errno
= errno
;
6606 extern int select_alarmed
;
6609 #if defined (USG) && !defined (POSIX_SIGNALS)
6610 /* USG systems forget handlers when they are used;
6611 must reestablish each time */
6612 signal (signo
, input_available_signal
);
6619 if (input_available_clear_time
)
6620 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6625 nread
= read_avail_input (1);
6626 /* -1 means it's not ok to read the input now.
6627 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6628 0 means there was no keyboard input available. */
6633 select_alarmed
= 1; /* Force the select emulator back to life */
6644 /* Send ourselves a SIGIO.
6646 This function exists so that the UNBLOCK_INPUT macro in
6647 blockinput.h can have some way to take care of input we put off
6648 dealing with, without assuming that every file which uses
6649 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6651 reinvoke_input_signal ()
6654 kill (getpid (), SIGIO
);
6660 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6661 static void menu_bar_one_keymap
P_ ((Lisp_Object
));
6663 /* These variables hold the vector under construction within
6664 menu_bar_items and its subroutines, and the current index
6665 for storing into that vector. */
6666 static Lisp_Object menu_bar_items_vector
;
6667 static int menu_bar_items_index
;
6669 /* Return a vector of menu items for a menu bar, appropriate
6670 to the current buffer. Each item has three elements in the vector:
6673 OLD is an old vector we can optionally reuse, or nil. */
6676 menu_bar_items (old
)
6679 /* The number of keymaps we're scanning right now, and the number of
6680 keymaps we have allocated space for. */
6683 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6684 in the current keymaps, or nil where it is not a prefix. */
6687 Lisp_Object def
, tail
;
6696 struct gcpro gcpro1
;
6698 /* In order to build the menus, we need to call the keymap
6699 accessors. They all call QUIT. But this function is called
6700 during redisplay, during which a quit is fatal. So inhibit
6701 quitting while building the menus.
6702 We do this instead of specbind because (1) errors will clear it anyway
6703 and (2) this avoids risk of specpdl overflow. */
6704 oquit
= Vinhibit_quit
;
6708 menu_bar_items_vector
= old
;
6710 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6711 menu_bar_items_index
= 0;
6713 GCPRO1 (menu_bar_items_vector
);
6715 /* Build our list of keymaps.
6716 If we recognize a function key and replace its escape sequence in
6717 keybuf with its symbol, or if the sequence starts with a mouse
6718 click and we need to switch buffers, we jump back here to rebuild
6719 the initial keymaps from the current buffer. */
6723 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6724 if (!NILP (Voverriding_local_map_menu_flag
))
6726 /* Yes, use them (if non-nil) as well as the global map. */
6727 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6729 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6730 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6731 if (!NILP (Voverriding_local_map
))
6732 maps
[nmaps
++] = Voverriding_local_map
;
6736 /* No, so use major and minor mode keymaps and keymap property.
6737 Note that menu-bar bindings in the local-map and keymap
6738 properties may not work reliable, as they are only
6739 recognized when the menu-bar (or mode-line) is updated,
6740 which does not normally happen after every command. */
6743 nminor
= current_minor_maps (NULL
, &tmaps
);
6744 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6746 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6747 maps
[nmaps
++] = tem
;
6748 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6750 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6752 maps
[nmaps
++] = current_global_map
;
6755 /* Look up in each map the dummy prefix key `menu-bar'. */
6759 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6760 if (!NILP (maps
[mapno
]))
6762 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6765 menu_bar_one_keymap (def
);
6768 /* Move to the end those items that should be at the end. */
6770 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6773 int end
= menu_bar_items_index
;
6775 for (i
= 0; i
< end
; i
+= 4)
6776 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6778 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6779 /* Move the item at index I to the end,
6780 shifting all the others forward. */
6781 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6782 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6783 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6784 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6786 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6787 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6788 (end
- i
- 4) * sizeof (Lisp_Object
));
6789 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6790 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6791 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6792 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6797 /* Add nil, nil, nil, nil at the end. */
6798 i
= menu_bar_items_index
;
6799 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6802 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6803 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6804 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6805 menu_bar_items_vector
= tem
;
6807 /* Add this item. */
6808 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6809 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6810 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6811 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6812 menu_bar_items_index
= i
;
6814 Vinhibit_quit
= oquit
;
6816 return menu_bar_items_vector
;
6819 /* Scan one map KEYMAP, accumulating any menu items it defines
6820 in menu_bar_items_vector. */
6822 static Lisp_Object menu_bar_one_keymap_changed_items
;
6825 menu_bar_one_keymap (keymap
)
6828 Lisp_Object tail
, item
;
6830 menu_bar_one_keymap_changed_items
= Qnil
;
6832 /* Loop over all keymap entries that have menu strings. */
6833 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
6837 menu_bar_item (XCAR (item
), XCDR (item
));
6838 else if (VECTORP (item
))
6840 /* Loop over the char values represented in the vector. */
6841 int len
= XVECTOR (item
)->size
;
6843 for (c
= 0; c
< len
; c
++)
6845 Lisp_Object character
;
6846 XSETFASTINT (character
, c
);
6847 menu_bar_item (character
, XVECTOR (item
)->contents
[c
]);
6853 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
6854 If there's already an item for KEY, add this DEF to it. */
6856 Lisp_Object item_properties
;
6859 menu_bar_item (key
, item
)
6860 Lisp_Object key
, item
;
6862 struct gcpro gcpro1
;
6866 if (EQ (item
, Qundefined
))
6868 /* If a map has an explicit `undefined' as definition,
6869 discard any previously made menu bar item. */
6871 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6872 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6874 if (menu_bar_items_index
> i
+ 4)
6875 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6876 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6877 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
6878 menu_bar_items_index
-= 4;
6882 /* If this keymap has already contributed to this KEY,
6883 don't contribute to it a second time. */
6884 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
6885 if (!NILP (tem
) || NILP (item
))
6888 menu_bar_one_keymap_changed_items
6889 = Fcons (key
, menu_bar_one_keymap_changed_items
);
6891 /* We add to menu_bar_one_keymap_changed_items before doing the
6892 parse_menu_item, so that if it turns out it wasn't a menu item,
6893 it still correctly hides any further menu item. */
6895 i
= parse_menu_item (item
, 0, 1);
6900 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6902 /* Find any existing item for this KEY. */
6903 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6904 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6907 /* If we did not find this KEY, add it at the end. */
6908 if (i
== menu_bar_items_index
)
6910 /* If vector is too small, get a bigger one. */
6911 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6914 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6915 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6916 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6917 menu_bar_items_vector
= tem
;
6920 /* Add this item. */
6921 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
6922 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
6923 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6924 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
6925 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
6926 menu_bar_items_index
= i
;
6928 /* We did find an item for this KEY. Add ITEM to its list of maps. */
6932 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6933 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (item
, old
);
6937 /* This is used as the handler when calling menu_item_eval_property. */
6939 menu_item_eval_property_1 (arg
)
6942 /* If we got a quit from within the menu computation,
6943 quit all the way out of it. This takes care of C-] in the debugger. */
6944 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
6945 Fsignal (Qquit
, Qnil
);
6950 /* Evaluate an expression and return the result (or nil if something
6951 went wrong). Used to evaluate dynamic parts of menu items. */
6953 menu_item_eval_property (sexpr
)
6956 int count
= SPECPDL_INDEX ();
6958 specbind (Qinhibit_redisplay
, Qt
);
6959 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
6960 menu_item_eval_property_1
);
6961 return unbind_to (count
, val
);
6964 /* This function parses a menu item and leaves the result in the
6965 vector item_properties.
6966 ITEM is a key binding, a possible menu item.
6967 If NOTREAL is nonzero, only check for equivalent key bindings, don't
6968 evaluate dynamic expressions in the menu item.
6969 INMENUBAR is > 0 when this is considered for an entry in a menu bar
6971 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
6972 parse_menu_item returns true if the item is a menu item and false
6976 parse_menu_item (item
, notreal
, inmenubar
)
6978 int notreal
, inmenubar
;
6980 Lisp_Object def
, tem
, item_string
, start
;
6981 Lisp_Object cachelist
;
6983 Lisp_Object keyhint
;
6994 /* Create item_properties vector if necessary. */
6995 if (NILP (item_properties
))
6997 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
6999 /* Initialize optional entries. */
7000 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7001 AREF (item_properties
, i
) = Qnil
;
7002 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7004 /* Save the item here to protect it from GC. */
7005 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7007 item_string
= XCAR (item
);
7011 if (STRINGP (item_string
))
7013 /* Old format menu item. */
7014 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7016 /* Maybe help string. */
7017 if (CONSP (item
) && STRINGP (XCAR (item
)))
7019 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7024 /* Maybe key binding cache. */
7025 if (CONSP (item
) && CONSP (XCAR (item
))
7026 && (NILP (XCAR (XCAR (item
)))
7027 || VECTORP (XCAR (XCAR (item
)))))
7029 cachelist
= XCAR (item
);
7033 /* This is the real definition--the function to run. */
7034 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7036 /* Get enable property, if any. */
7039 tem
= Fget (item
, Qmenu_enable
);
7041 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7044 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7046 /* New format menu item. */
7047 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7048 start
= XCDR (item
);
7051 /* We have a real binding. */
7052 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7054 item
= XCDR (start
);
7055 /* Is there a cache list with key equivalences. */
7056 if (CONSP (item
) && CONSP (XCAR (item
)))
7058 cachelist
= XCAR (item
);
7062 /* Parse properties. */
7063 while (CONSP (item
) && CONSP (XCDR (item
)))
7068 if (EQ (tem
, QCenable
))
7069 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7070 else if (EQ (tem
, QCvisible
) && !notreal
)
7072 /* If got a visible property and that evaluates to nil
7073 then ignore this item. */
7074 tem
= menu_item_eval_property (XCAR (item
));
7078 else if (EQ (tem
, QChelp
))
7079 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7080 else if (EQ (tem
, QCfilter
))
7082 else if (EQ (tem
, QCkey_sequence
))
7085 if (NILP (cachelist
)
7086 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7087 /* Be GC protected. Set keyhint to item instead of tem. */
7090 else if (EQ (tem
, QCkeys
))
7093 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7094 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7096 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7101 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7103 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7105 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7112 else if (inmenubar
|| !NILP (start
))
7116 return 0; /* not a menu item */
7118 /* If item string is not a string, evaluate it to get string.
7119 If we don't get a string, skip this item. */
7120 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7121 if (!(STRINGP (item_string
) || notreal
))
7123 item_string
= menu_item_eval_property (item_string
);
7124 if (!STRINGP (item_string
))
7126 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7129 /* If got a filter apply it on definition. */
7130 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7133 def
= menu_item_eval_property (list2 (XCAR (filter
),
7134 list2 (Qquote
, def
)));
7136 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7139 /* Enable or disable selection of item. */
7140 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7146 tem
= menu_item_eval_property (tem
);
7147 if (inmenubar
&& NILP (tem
))
7148 return 0; /* Ignore disabled items in menu bar. */
7149 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7152 /* If we got no definition, this item is just unselectable text which
7153 is OK in a submenu but not in the menubar. */
7155 return (inmenubar
? 0 : 1);
7157 /* See if this is a separate pane or a submenu. */
7158 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7159 tem
= get_keymap (def
, 0, 1);
7160 /* For a subkeymap, just record its details and exit. */
7163 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7164 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7168 /* At the top level in the menu bar, do likewise for commands also.
7169 The menu bar does not display equivalent key bindings anyway.
7170 ITEM_PROPERTY_DEF is already set up properly. */
7174 /* This is a command. See if there is an equivalent key binding. */
7175 if (NILP (cachelist
))
7177 /* We have to create a cachelist. */
7178 CHECK_IMPURE (start
);
7179 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7180 cachelist
= XCAR (XCDR (start
));
7182 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7183 if (!NILP (keyhint
))
7185 XSETCAR (cachelist
, XCAR (keyhint
));
7188 else if (STRINGP (tem
))
7190 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7191 XSETCAR (cachelist
, Qt
);
7195 tem
= XCAR (cachelist
);
7202 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7204 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7207 def
= XCAR (prefix
);
7208 prefix
= XCDR (prefix
);
7211 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7213 if (!update_menu_bindings
)
7215 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7217 if (newcache
/* Always check first time. */
7218 /* Should we check everything when precomputing key
7220 /* If something had no key binding before, don't recheck it
7221 because that is too slow--except if we have a list of
7222 rebound commands in Vdefine_key_rebound_commands, do
7223 recheck any command that appears in that list. */
7224 || (CONSP (Vdefine_key_rebound_commands
)
7225 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7228 /* We had a saved key. Is it still bound to the command? */
7231 /* If the command is an alias for another
7232 (such as lmenu.el set it up), check if the
7233 original command matches the cached command. */
7234 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7235 chkcache
= 1; /* Need to recompute key binding. */
7239 /* Recompute equivalent key binding. If the command is an alias
7240 for another (such as lmenu.el set it up), see if the original
7241 command name has equivalent keys. Otherwise look up the
7242 specified command itself. We don't try both, because that
7243 makes lmenu menus slow. */
7245 && SYMBOLP (XSYMBOL (def
)->function
)
7246 && ! NILP (Fget (def
, Qmenu_alias
)))
7247 def
= XSYMBOL (def
)->function
;
7248 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7249 XSETCAR (cachelist
, tem
);
7252 XSETCDR (cachelist
, Qnil
);
7256 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7258 tem
= XCAR (cachelist
);
7262 newcache
= chkcache
;
7265 tem
= Fkey_description (tem
);
7268 if (STRINGP (XCAR (prefix
)))
7269 tem
= concat2 (XCAR (prefix
), tem
);
7270 if (STRINGP (XCDR (prefix
)))
7271 tem
= concat2 (tem
, XCDR (prefix
));
7273 XSETCDR (cachelist
, tem
);
7277 tem
= XCDR (cachelist
);
7278 if (newcache
&& !NILP (tem
))
7280 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7281 XSETCDR (cachelist
, tem
);
7284 /* If we only want to precompute equivalent key bindings, stop here. */
7288 /* If we have an equivalent key binding, use that. */
7289 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7291 /* Include this when menu help is implemented.
7292 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7293 if (!(NILP (tem) || STRINGP (tem)))
7295 tem = menu_item_eval_property (tem);
7298 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7302 /* Handle radio buttons or toggle boxes. */
7303 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7305 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7306 = menu_item_eval_property (tem
);
7313 /***********************************************************************
7315 ***********************************************************************/
7317 /* A vector holding tool bar items while they are parsed in function
7318 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7321 static Lisp_Object tool_bar_items_vector
;
7323 /* A vector holding the result of parse_tool_bar_item. Layout is like
7324 the one for a single item in tool_bar_items_vector. */
7326 static Lisp_Object tool_bar_item_properties
;
7328 /* Next free index in tool_bar_items_vector. */
7330 static int ntool_bar_items
;
7332 /* The symbols `tool-bar', and `:image'. */
7334 extern Lisp_Object Qtool_bar
;
7335 Lisp_Object QCimage
;
7337 /* Function prototypes. */
7339 static void init_tool_bar_items
P_ ((Lisp_Object
));
7340 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7341 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7342 static void append_tool_bar_item
P_ ((void));
7345 /* Return a vector of tool bar items for keymaps currently in effect.
7346 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7347 tool bar items found. */
7350 tool_bar_items (reuse
, nitems
)
7361 /* In order to build the menus, we need to call the keymap
7362 accessors. They all call QUIT. But this function is called
7363 during redisplay, during which a quit is fatal. So inhibit
7364 quitting while building the menus. We do this instead of
7365 specbind because (1) errors will clear it anyway and (2) this
7366 avoids risk of specpdl overflow. */
7367 oquit
= Vinhibit_quit
;
7370 /* Initialize tool_bar_items_vector and protect it from GC. */
7371 init_tool_bar_items (reuse
);
7373 /* Build list of keymaps in maps. Set nmaps to the number of maps
7376 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7377 if (!NILP (Voverriding_local_map_menu_flag
))
7379 /* Yes, use them (if non-nil) as well as the global map. */
7380 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7382 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7383 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7384 if (!NILP (Voverriding_local_map
))
7385 maps
[nmaps
++] = Voverriding_local_map
;
7389 /* No, so use major and minor mode keymaps and keymap property.
7390 Note that tool-bar bindings in the local-map and keymap
7391 properties may not work reliable, as they are only
7392 recognized when the tool-bar (or mode-line) is updated,
7393 which does not normally happen after every command. */
7396 nminor
= current_minor_maps (NULL
, &tmaps
);
7397 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7399 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7400 maps
[nmaps
++] = tem
;
7401 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7403 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7406 /* Add global keymap at the end. */
7407 maps
[nmaps
++] = current_global_map
;
7409 /* Process maps in reverse order and look up in each map the prefix
7411 for (i
= nmaps
- 1; i
>= 0; --i
)
7412 if (!NILP (maps
[i
]))
7416 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7421 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7422 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7424 Lisp_Object keydef
= XCAR (tail
);
7426 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7431 Vinhibit_quit
= oquit
;
7432 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7433 return tool_bar_items_vector
;
7437 /* Process the definition of KEY which is DEF. */
7440 process_tool_bar_item (key
, def
)
7441 Lisp_Object key
, def
;
7444 extern Lisp_Object Qundefined
;
7445 struct gcpro gcpro1
, gcpro2
;
7447 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7451 if (EQ (def
, Qundefined
))
7453 /* If a map has an explicit `undefined' as definition,
7454 discard any previously made item. */
7455 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7457 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7459 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7461 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7462 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7463 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7464 * sizeof (Lisp_Object
)));
7465 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7470 else if (parse_tool_bar_item (key
, def
))
7471 /* Append a new tool bar item to tool_bar_items_vector. Accept
7472 more than one definition for the same key. */
7473 append_tool_bar_item ();
7479 /* Parse a tool bar item specification ITEM for key KEY and return the
7480 result in tool_bar_item_properties. Value is zero if ITEM is
7483 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7485 CAPTION is the caption of the item, If it's not a string, it is
7486 evaluated to get a string.
7488 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7489 as binding are currently ignored.
7491 The following properties are recognized:
7495 FORM is evaluated and specifies whether the tool bar item is
7496 enabled or disabled.
7500 FORM is evaluated and specifies whether the tool bar item is visible.
7502 - `:filter FUNCTION'
7504 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7505 result is stored as the new binding.
7507 - `:button (TYPE SELECTED)'
7509 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7510 and specifies whether the button is selected (pressed) or not.
7514 IMAGES is either a single image specification or a vector of four
7515 image specifications. See enum tool_bar_item_images.
7517 - `:help HELP-STRING'.
7519 Gives a help string to display for the tool bar item. */
7522 parse_tool_bar_item (key
, item
)
7523 Lisp_Object key
, item
;
7525 /* Access slot with index IDX of vector tool_bar_item_properties. */
7526 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7528 Lisp_Object filter
= Qnil
;
7529 Lisp_Object caption
;
7532 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7533 Rule out items that aren't lists, don't start with
7534 `menu-item' or whose rest following `tool-bar-item' is not a
7537 || !EQ (XCAR (item
), Qmenu_item
)
7538 || (item
= XCDR (item
),
7542 /* Create tool_bar_item_properties vector if necessary. Reset it to
7544 if (VECTORP (tool_bar_item_properties
))
7546 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7550 tool_bar_item_properties
7551 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7554 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7555 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7557 /* Get the caption of the item. If the caption is not a string,
7558 evaluate it to get a string. If we don't get a string, skip this
7560 caption
= XCAR (item
);
7561 if (!STRINGP (caption
))
7563 caption
= menu_item_eval_property (caption
);
7564 if (!STRINGP (caption
))
7567 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7569 /* Give up if rest following the caption is not a list. */
7574 /* Store the binding. */
7575 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7578 /* Ignore cached key binding, if any. */
7579 if (CONSP (item
) && CONSP (XCAR (item
)))
7582 /* Process the rest of the properties. */
7583 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7585 Lisp_Object key
, value
;
7588 value
= XCAR (XCDR (item
));
7590 if (EQ (key
, QCenable
))
7591 /* `:enable FORM'. */
7592 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7593 else if (EQ (key
, QCvisible
))
7595 /* `:visible FORM'. If got a visible property and that
7596 evaluates to nil then ignore this item. */
7597 if (NILP (menu_item_eval_property (value
)))
7600 else if (EQ (key
, QChelp
))
7601 /* `:help HELP-STRING'. */
7602 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7603 else if (EQ (key
, QCfilter
))
7604 /* ':filter FORM'. */
7606 else if (EQ (key
, QCbutton
) && CONSP (value
))
7608 /* `:button (TYPE . SELECTED)'. */
7609 Lisp_Object type
, selected
;
7611 type
= XCAR (value
);
7612 selected
= XCDR (value
);
7613 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7615 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7616 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7619 else if (EQ (key
, QCimage
)
7621 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7622 /* Value is either a single image specification or a vector
7623 of 4 such specifications for the different button states. */
7624 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7627 /* If got a filter apply it on binding. */
7629 PROP (TOOL_BAR_ITEM_BINDING
)
7630 = menu_item_eval_property (list2 (filter
,
7632 PROP (TOOL_BAR_ITEM_BINDING
))));
7634 /* See if the binding is a keymap. Give up if it is. */
7635 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7638 /* Enable or disable selection of item. */
7639 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7640 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7641 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7643 /* Handle radio buttons or toggle boxes. */
7644 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7645 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7646 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7654 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7655 that can be reused. */
7658 init_tool_bar_items (reuse
)
7661 if (VECTORP (reuse
))
7662 tool_bar_items_vector
= reuse
;
7664 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7665 ntool_bar_items
= 0;
7669 /* Append parsed tool bar item properties from
7670 tool_bar_item_properties */
7673 append_tool_bar_item ()
7675 Lisp_Object
*to
, *from
;
7677 /* Enlarge tool_bar_items_vector if necessary. */
7678 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7679 >= XVECTOR (tool_bar_items_vector
)->size
)
7681 Lisp_Object new_vector
;
7682 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7684 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7685 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7686 XVECTOR (new_vector
)->contents
,
7687 old_size
* sizeof (Lisp_Object
));
7688 tool_bar_items_vector
= new_vector
;
7691 /* Append entries from tool_bar_item_properties to the end of
7692 tool_bar_items_vector. */
7693 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7694 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7695 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7696 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7703 /* Read a character using menus based on maps in the array MAPS.
7704 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7705 Return t if we displayed a menu but the user rejected it.
7707 PREV_EVENT is the previous input event, or nil if we are reading
7708 the first event of a key sequence.
7710 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7711 if we used a mouse menu to read the input, or zero otherwise. If
7712 USED_MOUSE_MENU is null, we don't dereference it.
7714 The prompting is done based on the prompt-string of the map
7715 and the strings associated with various map elements.
7717 This can be done with X menus or with menus put in the minibuf.
7718 These are done in different ways, depending on how the input will be read.
7719 Menus using X are done after auto-saving in read-char, getting the input
7720 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7721 and do auto-saving in the inner call of read_char. */
7724 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7727 Lisp_Object prev_event
;
7728 int *used_mouse_menu
;
7731 register Lisp_Object name
= Qnil
;
7733 if (used_mouse_menu
)
7734 *used_mouse_menu
= 0;
7736 /* Use local over global Menu maps */
7738 if (! menu_prompting
)
7741 /* Optionally disregard all but the global map. */
7742 if (inhibit_local_menu_bar_menus
)
7744 maps
+= (nmaps
- 1);
7748 /* Get the menu name from the first map that has one (a prompt string). */
7749 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7751 name
= Fkeymap_prompt (maps
[mapno
]);
7756 /* If we don't have any menus, just read a character normally. */
7757 if (!STRINGP (name
))
7761 /* If we got to this point via a mouse click,
7762 use a real menu for mouse selection. */
7763 if (EVENT_HAS_PARAMETERS (prev_event
)
7764 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7765 && !EQ (XCAR (prev_event
), Qtool_bar
))
7767 /* Display the menu and get the selection. */
7768 Lisp_Object
*realmaps
7769 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7773 /* Use the maps that are not nil. */
7774 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7775 if (!NILP (maps
[mapno
]))
7776 realmaps
[nmaps1
++] = maps
[mapno
];
7778 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7783 record_menu_key (XCAR (value
));
7785 /* If we got multiple events, unread all but
7787 There is no way to prevent those unread events
7788 from showing up later in last_nonmenu_event.
7789 So turn symbol and integer events into lists,
7790 to indicate that they came from a mouse menu,
7791 so that when present in last_nonmenu_event
7792 they won't confuse things. */
7793 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7795 record_menu_key (XCAR (tem
));
7796 if (SYMBOLP (XCAR (tem
))
7797 || INTEGERP (XCAR (tem
)))
7798 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7801 /* If we got more than one event, put all but the first
7802 onto this list to be read later.
7803 Return just the first event now. */
7804 Vunread_command_events
7805 = nconc2 (XCDR (value
), Vunread_command_events
);
7806 value
= XCAR (value
);
7808 else if (NILP (value
))
7810 if (used_mouse_menu
)
7811 *used_mouse_menu
= 1;
7814 #endif /* HAVE_MENUS */
7818 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7819 We make this bigger when necessary, and never free it. */
7820 static char *read_char_minibuf_menu_text
;
7821 /* Size of that buffer. */
7822 static int read_char_minibuf_menu_width
;
7825 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7831 register Lisp_Object name
;
7833 /* FIXME: Use the minibuffer's frame width. */
7834 int width
= FRAME_WIDTH (SELECTED_FRAME ()) - 4;
7837 Lisp_Object rest
, vector
;
7843 if (! menu_prompting
)
7846 /* Make sure we have a big enough buffer for the menu text. */
7847 if (read_char_minibuf_menu_text
== 0)
7849 read_char_minibuf_menu_width
= width
+ 4;
7850 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
7852 else if (width
+ 4 > read_char_minibuf_menu_width
)
7854 read_char_minibuf_menu_width
= width
+ 4;
7855 read_char_minibuf_menu_text
7856 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
7858 menu
= read_char_minibuf_menu_text
;
7860 /* Get the menu name from the first map that has one (a prompt string). */
7861 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7863 name
= Fkeymap_prompt (maps
[mapno
]);
7868 /* If we don't have any menus, just read a character normally. */
7869 if (!STRINGP (name
))
7872 /* Prompt string always starts with map's prompt, and a space. */
7873 strcpy (menu
, SDATA (name
));
7874 nlength
= SBYTES (name
);
7875 menu
[nlength
++] = ':';
7876 menu
[nlength
++] = ' ';
7879 /* Start prompting at start of first map. */
7883 /* Present the documented bindings, a line at a time. */
7890 Lisp_Object orig_defn_macro
;
7892 /* Loop over elements of map. */
7897 /* If reached end of map, start at beginning of next map. */
7901 /* At end of last map, wrap around to first map if just starting,
7902 or end this line if already have something on it. */
7906 if (notfirst
|| nobindings
) break;
7911 /* Look at the next element of the map. */
7913 elt
= XVECTOR (vector
)->contents
[idx
];
7915 elt
= Fcar_safe (rest
);
7917 if (idx
< 0 && VECTORP (elt
))
7919 /* If we found a dense table in the keymap,
7920 advanced past it, but start scanning its contents. */
7921 rest
= Fcdr_safe (rest
);
7927 /* An ordinary element. */
7928 Lisp_Object event
, tem
;
7932 event
= Fcar_safe (elt
); /* alist */
7933 elt
= Fcdr_safe (elt
);
7937 XSETINT (event
, idx
); /* vector */
7940 /* Ignore the element if it has no prompt string. */
7941 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
7943 /* 1 if the char to type matches the string. */
7945 Lisp_Object upcased_event
, downcased_event
;
7946 Lisp_Object desc
= Qnil
;
7948 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7950 upcased_event
= Fupcase (event
);
7951 downcased_event
= Fdowncase (event
);
7952 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
7953 || XINT (downcased_event
) == SREF (s
, 0));
7955 desc
= Fsingle_key_description (event
, Qnil
);
7957 #if 0 /* It is redundant to list the equivalent key bindings because
7958 the prefix is what the user has already typed. */
7960 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
7962 /* Insert equivalent keybinding. */
7963 s
= concat2 (s
, tem
);
7966 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
7967 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
7969 /* Insert button prefix. */
7970 Lisp_Object selected
7971 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
7972 if (EQ (tem
, QCradio
))
7973 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
7975 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
7976 s
= concat2 (tem
, s
);
7980 /* If we have room for the prompt string, add it to this line.
7981 If this is the first on the line, always add it. */
7982 if ((SCHARS (s
) + i
+ 2
7983 + (char_matches
? 0 : SCHARS (desc
) + 3))
7989 /* Punctuate between strings. */
7992 strcpy (menu
+ i
, ", ");
7998 /* If the char to type doesn't match the string's
7999 first char, explicitly show what char to type. */
8002 /* Add as much of string as fits. */
8003 thiswidth
= SCHARS (desc
);
8004 if (thiswidth
+ i
> width
)
8005 thiswidth
= width
- i
;
8006 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8008 strcpy (menu
+ i
, " = ");
8012 /* Add as much of string as fits. */
8013 thiswidth
= SCHARS (s
);
8014 if (thiswidth
+ i
> width
)
8015 thiswidth
= width
- i
;
8016 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8022 /* If this element does not fit, end the line now,
8023 and save the element for the next line. */
8024 strcpy (menu
+ i
, "...");
8029 /* Move past this element. */
8030 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8031 /* Handle reaching end of dense table. */
8036 rest
= Fcdr_safe (rest
);
8040 /* Prompt with that and read response. */
8041 message2_nolog (menu
, strlen (menu
),
8042 ! NILP (current_buffer
->enable_multibyte_characters
));
8044 /* Make believe its not a keyboard macro in case the help char
8045 is pressed. Help characters are not recorded because menu prompting
8046 is not used on replay.
8048 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8049 current_kboard
->defining_kbd_macro
= Qnil
;
8051 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8052 while (BUFFERP (obj
));
8053 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8055 if (!INTEGERP (obj
))
8060 if (! EQ (obj
, menu_prompt_more_char
)
8061 && (!INTEGERP (menu_prompt_more_char
)
8062 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8064 if (!NILP (current_kboard
->defining_kbd_macro
))
8065 store_kbd_macro_char (obj
);
8068 /* Help char - go round again */
8072 /* Reading key sequences. */
8074 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8075 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8076 keymap, or nil otherwise. Return the index of the first keymap in
8077 which KEY has any binding, or NMAPS if no map has a binding.
8079 If KEY is a meta ASCII character, treat it like meta-prefix-char
8080 followed by the corresponding non-meta character. Keymaps in
8081 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8084 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8087 NEXT may be the same array as CURRENT. */
8090 follow_key (key
, nmaps
, current
, defs
, next
)
8092 Lisp_Object
*current
, *defs
, *next
;
8095 int i
, first_binding
;
8098 first_binding
= nmaps
;
8099 for (i
= nmaps
- 1; i
>= 0; i
--)
8101 if (! NILP (current
[i
]))
8109 defs
[i
] = access_keymap (map
, key
, 1, 0, 1);
8110 if (! NILP (defs
[i
]))
8117 /* Given the set of bindings we've found, produce the next set of maps. */
8118 if (first_binding
< nmaps
)
8119 for (i
= 0; i
< nmaps
; i
++)
8120 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8122 return first_binding
;
8125 /* Structure used to keep track of partial application of key remapping
8126 such as Vfunction_key_map and Vkey_translation_map. */
8127 typedef struct keyremap
8134 /* Read a sequence of keys that ends with a non prefix character,
8135 storing it in KEYBUF, a buffer of size BUFSIZE.
8137 Return the length of the key sequence stored.
8138 Return -1 if the user rejected a command menu.
8140 Echo starting immediately unless `prompt' is 0.
8142 Where a key sequence ends depends on the currently active keymaps.
8143 These include any minor mode keymaps active in the current buffer,
8144 the current buffer's local map, and the global map.
8146 If a key sequence has no other bindings, we check Vfunction_key_map
8147 to see if some trailing subsequence might be the beginning of a
8148 function key's sequence. If so, we try to read the whole function
8149 key, and substitute its symbolic name into the key sequence.
8151 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8152 `double-' events into similar click events, if that would make them
8153 bound. We try to turn `triple-' events first into `double-' events,
8156 If we get a mouse click in a mode line, vertical divider, or other
8157 non-text area, we treat the click as if it were prefixed by the
8158 symbol denoting that area - `mode-line', `vertical-line', or
8161 If the sequence starts with a mouse click, we read the key sequence
8162 with respect to the buffer clicked on, not the current buffer.
8164 If the user switches frames in the midst of a key sequence, we put
8165 off the switch-frame event until later; the next call to
8166 read_char will return it.
8168 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8169 from the selected window's buffer. */
8172 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8173 can_return_switch_frame
, fix_current_buffer
)
8174 Lisp_Object
*keybuf
;
8177 int dont_downcase_last
;
8178 int can_return_switch_frame
;
8179 int fix_current_buffer
;
8181 volatile Lisp_Object from_string
;
8182 volatile int count
= SPECPDL_INDEX ();
8184 /* How many keys there are in the current key sequence. */
8187 /* The length of the echo buffer when we started reading, and
8188 the length of this_command_keys when we started reading. */
8189 volatile int echo_start
;
8190 volatile int keys_start
;
8192 /* The number of keymaps we're scanning right now, and the number of
8193 keymaps we have allocated space for. */
8195 volatile int nmaps_allocated
= 0;
8197 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8198 the current keymaps. */
8199 Lisp_Object
*volatile defs
= NULL
;
8201 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8202 in the current keymaps, or nil where it is not a prefix. */
8203 Lisp_Object
*volatile submaps
= NULL
;
8205 /* The local map to start out with at start of key sequence. */
8206 volatile Lisp_Object orig_local_map
;
8208 /* The map from the `keymap' property to start out with at start of
8210 volatile Lisp_Object orig_keymap
;
8212 /* 1 if we have already considered switching to the local-map property
8213 of the place where a mouse click occurred. */
8214 volatile int localized_local_map
= 0;
8216 /* The index in defs[] of the first keymap that has a binding for
8217 this key sequence. In other words, the lowest i such that
8218 defs[i] is non-nil. */
8219 volatile int first_binding
;
8220 /* Index of the first key that has no binding.
8221 It is useless to try fkey.start larger than that. */
8222 volatile int first_unbound
;
8224 /* If t < mock_input, then KEYBUF[t] should be read as the next
8227 We use this to recover after recognizing a function key. Once we
8228 realize that a suffix of the current key sequence is actually a
8229 function key's escape sequence, we replace the suffix with the
8230 function key's binding from Vfunction_key_map. Now keybuf
8231 contains a new and different key sequence, so the echo area,
8232 this_command_keys, and the submaps and defs arrays are wrong. In
8233 this situation, we set mock_input to t, set t to 0, and jump to
8234 restart_sequence; the loop will read keys from keybuf up until
8235 mock_input, thus rebuilding the state; and then it will resume
8236 reading characters from the keyboard. */
8237 volatile int mock_input
= 0;
8239 /* If the sequence is unbound in submaps[], then
8240 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8241 and fkey.map is its binding.
8243 These might be > t, indicating that all function key scanning
8244 should hold off until t reaches them. We do this when we've just
8245 recognized a function key, to avoid searching for the function
8246 key's again in Vfunction_key_map. */
8247 volatile keyremap fkey
;
8249 /* Likewise, for key_translation_map. */
8250 volatile keyremap keytran
;
8252 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
8253 we put it off for later. While we're reading, we keep the event here. */
8254 volatile Lisp_Object delayed_switch_frame
;
8256 /* See the comment below... */
8257 #if defined (GOBBLE_FIRST_EVENT)
8258 Lisp_Object first_event
;
8261 volatile Lisp_Object original_uppercase
;
8262 volatile int original_uppercase_position
= -1;
8264 /* Gets around Microsoft compiler limitations. */
8267 struct buffer
*starting_buffer
;
8269 /* List of events for which a fake prefix key has been generated. */
8270 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8272 #if defined (GOBBLE_FIRST_EVENT)
8276 struct gcpro gcpro1
;
8278 GCPRO1 (fake_prefixed_keys
);
8279 raw_keybuf_count
= 0;
8281 last_nonmenu_event
= Qnil
;
8283 delayed_switch_frame
= Qnil
;
8284 fkey
.map
= Vfunction_key_map
;
8285 keytran
.map
= Vkey_translation_map
;
8286 /* If there is no translation-map, turn off scanning. */
8287 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8288 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8293 echo_prompt (prompt
);
8294 else if (cursor_in_echo_area
8295 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8296 && NILP (Fzerop (Vecho_keystrokes
)))
8297 /* This doesn't put in a dash if the echo buffer is empty, so
8298 you don't always see a dash hanging out in the minibuffer. */
8302 /* Record the initial state of the echo area and this_command_keys;
8303 we will need to restore them if we replay a key sequence. */
8305 echo_start
= echo_length ();
8306 keys_start
= this_command_key_count
;
8307 this_single_command_key_start
= keys_start
;
8309 #if defined (GOBBLE_FIRST_EVENT)
8310 /* This doesn't quite work, because some of the things that read_char
8311 does cannot safely be bypassed. It seems too risky to try to make
8314 /* Read the first char of the sequence specially, before setting
8315 up any keymaps, in case a filter runs and switches buffers on us. */
8316 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8318 #endif /* GOBBLE_FIRST_EVENT */
8320 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8321 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8324 /* We jump here when the key sequence has been thoroughly changed, and
8325 we need to rescan it starting from the beginning. When we jump here,
8326 keybuf[0..mock_input] holds the sequence we should reread. */
8329 starting_buffer
= current_buffer
;
8330 first_unbound
= bufsize
+ 1;
8332 /* Build our list of keymaps.
8333 If we recognize a function key and replace its escape sequence in
8334 keybuf with its symbol, or if the sequence starts with a mouse
8335 click and we need to switch buffers, we jump back here to rebuild
8336 the initial keymaps from the current buffer. */
8339 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8340 || !NILP (Voverriding_local_map
))
8342 if (3 > nmaps_allocated
)
8344 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8345 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8346 nmaps_allocated
= 3;
8348 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8349 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8350 if (!NILP (Voverriding_local_map
))
8351 submaps
[nmaps
++] = Voverriding_local_map
;
8359 nminor
= current_minor_maps (0, &maps
);
8360 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8362 if (total
> nmaps_allocated
)
8364 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8365 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8366 nmaps_allocated
= total
;
8369 if (!NILP (orig_keymap
))
8370 submaps
[nmaps
++] = orig_keymap
;
8372 bcopy (maps
, (void *) (submaps
+ nmaps
),
8373 nminor
* sizeof (submaps
[0]));
8377 submaps
[nmaps
++] = orig_local_map
;
8379 submaps
[nmaps
++] = current_global_map
;
8381 /* Find an accurate initial value for first_binding. */
8382 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8383 if (! NILP (submaps
[first_binding
]))
8386 /* Start from the beginning in keybuf. */
8389 /* These are no-ops the first time through, but if we restart, they
8390 revert the echo area and this_command_keys to their original state. */
8391 this_command_key_count
= keys_start
;
8392 if (INTERACTIVE
&& t
< mock_input
)
8393 echo_truncate (echo_start
);
8395 /* If the best binding for the current key sequence is a keymap, or
8396 we may be looking at a function key's escape sequence, keep on
8398 while (first_binding
< nmaps
8399 /* Keep reading as long as there's a prefix binding. */
8400 ? !NILP (submaps
[first_binding
])
8401 /* Don't return in the middle of a possible function key sequence,
8402 if the only bindings we found were via case conversion.
8403 Thus, if ESC O a has a function-key-map translation
8404 and ESC o has a binding, don't return after ESC O,
8405 so that we can translate ESC O plus the next character. */
8406 : (fkey
.start
< t
|| keytran
.start
< t
))
8409 int used_mouse_menu
= 0;
8411 /* Where the last real key started. If we need to throw away a
8412 key that has expanded into more than one element of keybuf
8413 (say, a mouse click on the mode line which is being treated
8414 as [mode-line (mouse-...)], then we backtrack to this point
8416 volatile int last_real_key_start
;
8418 /* These variables are analogous to echo_start and keys_start;
8419 while those allow us to restart the entire key sequence,
8420 echo_local_start and keys_local_start allow us to throw away
8422 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8424 /* key-translation-map is applied *after* function-key-map. */
8425 eassert (keytran
.end
<= fkey
.start
);
8427 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8428 { /* The prefix upto first_unbound has no binding and has
8429 no translation left to do either, so we know it's unbound.
8430 If we don't stop now, we risk staying here indefinitely
8431 (if the user keeps entering fkey or keytran prefixes
8432 like C-c ESC ESC ESC ESC ...) */
8434 for (i
= first_unbound
+ 1; i
< t
; i
++)
8435 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8436 mock_input
= t
- first_unbound
- 1;
8437 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8438 fkey
.map
= Vfunction_key_map
;
8439 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8440 keytran
.map
= Vkey_translation_map
;
8441 goto replay_sequence
;
8445 error ("Key sequence too long");
8448 echo_local_start
= echo_length ();
8449 keys_local_start
= this_command_key_count
;
8450 local_first_binding
= first_binding
;
8453 /* These are no-ops, unless we throw away a keystroke below and
8454 jumped back up to replay_key; in that case, these restore the
8455 variables to their original state, allowing us to replay the
8457 if (INTERACTIVE
&& t
< mock_input
)
8458 echo_truncate (echo_local_start
);
8459 this_command_key_count
= keys_local_start
;
8460 first_binding
= local_first_binding
;
8462 /* By default, assume each event is "real". */
8463 last_real_key_start
= t
;
8465 /* Does mock_input indicate that we are re-reading a key sequence? */
8469 add_command_key (key
);
8470 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8471 && NILP (Fzerop (Vecho_keystrokes
)))
8475 /* If not, we should actually read a character. */
8480 KBOARD
*interrupted_kboard
= current_kboard
;
8481 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8482 if (setjmp (wrong_kboard_jmpbuf
))
8484 if (!NILP (delayed_switch_frame
))
8486 interrupted_kboard
->kbd_queue
8487 = Fcons (delayed_switch_frame
,
8488 interrupted_kboard
->kbd_queue
);
8489 delayed_switch_frame
= Qnil
;
8492 interrupted_kboard
->kbd_queue
8493 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8495 /* If the side queue is non-empty, ensure it begins with a
8496 switch-frame, so we'll replay it in the right context. */
8497 if (CONSP (interrupted_kboard
->kbd_queue
)
8498 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8499 !(EVENT_HAS_PARAMETERS (key
)
8500 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8504 XSETFRAME (frame
, interrupted_frame
);
8505 interrupted_kboard
->kbd_queue
8506 = Fcons (make_lispy_switch_frame (frame
),
8507 interrupted_kboard
->kbd_queue
);
8510 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8511 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8512 goto replay_sequence
;
8515 key
= read_char (NILP (prompt
), nmaps
,
8516 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8520 /* read_char returns t when it shows a menu and the user rejects it.
8524 unbind_to (count
, Qnil
);
8529 /* read_char returns -1 at the end of a macro.
8530 Emacs 18 handles this by returning immediately with a
8531 zero, so that's what we'll do. */
8532 if (INTEGERP (key
) && XINT (key
) == -1)
8535 /* The Microsoft C compiler can't handle the goto that
8541 /* If the current buffer has been changed from under us, the
8542 keymap may have changed, so replay the sequence. */
8545 EMACS_TIME initial_idleness_start_time
;
8546 EMACS_SET_SECS_USECS (initial_idleness_start_time
,
8547 EMACS_SECS (timer_last_idleness_start_time
),
8548 EMACS_USECS (timer_last_idleness_start_time
));
8550 /* Resume idle state, using the same start-time as before. */
8551 timer_start_idle ();
8552 timer_idleness_start_time
= initial_idleness_start_time
;
8555 /* Reset the current buffer from the selected window
8556 in case something changed the former and not the latter.
8557 This is to be more consistent with the behavior
8558 of the command_loop_1. */
8559 if (fix_current_buffer
)
8561 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8563 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8564 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8567 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8568 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8569 goto replay_sequence
;
8572 /* If we have a quit that was typed in another frame, and
8573 quit_throw_to_read_char switched buffers,
8574 replay to get the right keymap. */
8576 && XINT (key
) == quit_char
8577 && current_buffer
!= starting_buffer
)
8580 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8584 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8585 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8586 goto replay_sequence
;
8591 if (EVENT_HAS_PARAMETERS (key
)
8592 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8594 /* If we're at the beginning of a key sequence, and the caller
8595 says it's okay, go ahead and return this event. If we're
8596 in the midst of a key sequence, delay it until the end. */
8597 if (t
> 0 || !can_return_switch_frame
)
8599 delayed_switch_frame
= key
;
8605 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8608 /* Clicks in non-text areas get prefixed by the symbol
8609 in their CHAR-ADDRESS field. For example, a click on
8610 the mode line is prefixed by the symbol `mode-line'.
8612 Furthermore, key sequences beginning with mouse clicks
8613 are read using the keymaps of the buffer clicked on, not
8614 the current buffer. So we may have to switch the buffer
8617 When we turn one event into two events, we must make sure
8618 that neither of the two looks like the original--so that,
8619 if we replay the events, they won't be expanded again.
8620 If not for this, such reexpansion could happen either here
8621 or when user programs play with this-command-keys. */
8622 if (EVENT_HAS_PARAMETERS (key
))
8626 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8627 if (EQ (kind
, Qmouse_click
))
8629 Lisp_Object window
, posn
;
8631 window
= POSN_WINDOW (EVENT_START (key
));
8632 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8635 || (!NILP (fake_prefixed_keys
)
8636 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8638 /* We're looking a second time at an event for which
8639 we generated a fake prefix key. Set
8640 last_real_key_start appropriately. */
8642 last_real_key_start
= t
- 1;
8645 /* Key sequences beginning with mouse clicks are
8646 read using the keymaps in the buffer clicked on,
8647 not the current buffer. If we're at the
8648 beginning of a key sequence, switch buffers. */
8649 if (last_real_key_start
== 0
8651 && BUFFERP (XWINDOW (window
)->buffer
)
8652 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8654 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8658 /* Arrange to go back to the original buffer once we're
8659 done reading the key sequence. Note that we can't
8660 use save_excursion_{save,restore} here, because they
8661 save point as well as the current buffer; we don't
8662 want to save point, because redisplay may change it,
8663 to accommodate a Fset_window_start or something. We
8664 don't want to do this at the top of the function,
8665 because we may get input from a subprocess which
8666 wants to change the selected window and stuff (say,
8668 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8670 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8672 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8673 orig_local_map
= get_local_map (PT
, current_buffer
,
8675 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8676 goto replay_sequence
;
8679 /* For a mouse click, get the local text-property keymap
8680 of the place clicked on, rather than point. */
8681 if (last_real_key_start
== 0
8682 && CONSP (XCDR (key
))
8683 && ! localized_local_map
)
8685 Lisp_Object map_here
, start
, pos
;
8687 localized_local_map
= 1;
8688 start
= EVENT_START (key
);
8690 if (CONSP (start
) && CONSP (XCDR (start
)))
8692 pos
= POSN_BUFFER_POSN (start
);
8694 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8696 map_here
= get_local_map (XINT (pos
),
8697 current_buffer
, Qlocal_map
);
8698 if (!EQ (map_here
, orig_local_map
))
8700 orig_local_map
= map_here
;
8704 goto replay_sequence
;
8706 map_here
= get_local_map (XINT (pos
),
8707 current_buffer
, Qkeymap
);
8708 if (!EQ (map_here
, orig_keymap
))
8710 orig_keymap
= map_here
;
8714 goto replay_sequence
;
8720 /* Expand mode-line and scroll-bar events into two events:
8721 use posn as a fake prefix key. */
8723 && (NILP (fake_prefixed_keys
)
8724 || NILP (Fmemq (key
, fake_prefixed_keys
))))
8726 if (t
+ 1 >= bufsize
)
8727 error ("Key sequence too long");
8730 keybuf
[t
+ 1] = key
;
8733 /* Record that a fake prefix key has been generated
8734 for KEY. Don't modify the event; this would
8735 prevent proper action when the event is pushed
8736 back into unread-command-events. */
8737 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
8739 /* If on a mode line string with a local keymap,
8740 reconsider the key sequence with that keymap. */
8741 if (CONSP (POSN_STRING (EVENT_START (key
))))
8743 Lisp_Object string
, pos
, map
, map2
;
8745 string
= POSN_STRING (EVENT_START (key
));
8746 pos
= XCDR (string
);
8747 string
= XCAR (string
);
8749 && XINT (pos
) < SCHARS (string
))
8751 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8753 orig_local_map
= map
;
8754 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8757 if (!NILP (map
) || !NILP (map2
))
8758 goto replay_sequence
;
8764 else if (CONSP (POSN_STRING (EVENT_START (key
)))
8765 && NILP (from_string
))
8767 /* For a click on a string, i.e. overlay string or a
8768 string displayed via the `display' property,
8769 consider `local-map' and `keymap' properties of
8771 Lisp_Object string
, pos
, map
, map2
;
8773 string
= POSN_STRING (EVENT_START (key
));
8774 pos
= XCDR (string
);
8775 string
= XCAR (string
);
8777 && XINT (pos
) < SCHARS (string
))
8779 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8781 orig_local_map
= map
;
8782 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8786 if (!NILP (map
) || !NILP (map2
))
8788 from_string
= string
;
8789 goto replay_sequence
;
8794 else if (CONSP (XCDR (key
))
8795 && CONSP (EVENT_START (key
))
8796 && CONSP (XCDR (EVENT_START (key
))))
8800 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8801 /* Handle menu-bar events:
8802 insert the dummy prefix event `menu-bar'. */
8803 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
8805 if (t
+ 1 >= bufsize
)
8806 error ("Key sequence too long");
8810 /* Zap the position in key, so we know that we've
8811 expanded it, and don't try to do so again. */
8812 POSN_BUFFER_SET_POSN (EVENT_START (key
),
8813 Fcons (posn
, Qnil
));
8816 goto replay_sequence
;
8818 else if (CONSP (posn
))
8820 /* We're looking at the second event of a
8821 sequence which we expanded before. Set
8822 last_real_key_start appropriately. */
8823 if (last_real_key_start
== t
&& t
> 0)
8824 last_real_key_start
= t
- 1;
8829 /* We have finally decided that KEY is something we might want
8831 first_binding
= (follow_key (key
,
8832 nmaps
- first_binding
,
8833 submaps
+ first_binding
,
8834 defs
+ first_binding
,
8835 submaps
+ first_binding
)
8838 /* If KEY wasn't bound, we'll try some fallbacks. */
8839 if (first_binding
< nmaps
)
8840 /* This is needed for the following scenario:
8841 event 0: a down-event that gets dropped by calling replay_key.
8842 event 1: some normal prefix like C-h.
8843 After event 0, first_unbound is 0, after event 1 fkey.start
8844 and keytran.start are both 1, so when we see that C-h is bound,
8845 we need to update first_unbound. */
8846 first_unbound
= max (t
+ 1, first_unbound
);
8851 /* Remember the position to put an upper bound on fkey.start. */
8852 first_unbound
= min (t
, first_unbound
);
8854 head
= EVENT_HEAD (key
);
8855 if (help_char_p (head
) && t
> 0)
8857 read_key_sequence_cmd
= Vprefix_help_command
;
8859 last_nonmenu_event
= key
;
8860 /* The Microsoft C compiler can't handle the goto that
8868 Lisp_Object breakdown
;
8871 breakdown
= parse_modifiers (head
);
8872 modifiers
= XINT (XCAR (XCDR (breakdown
)));
8873 /* Attempt to reduce an unbound mouse event to a simpler
8874 event that is bound:
8875 Drags reduce to clicks.
8876 Double-clicks reduce to clicks.
8877 Triple-clicks reduce to double-clicks, then to clicks.
8878 Down-clicks are eliminated.
8879 Double-downs reduce to downs, then are eliminated.
8880 Triple-downs reduce to double-downs, then to downs,
8881 then are eliminated. */
8882 if (modifiers
& (down_modifier
| drag_modifier
8883 | double_modifier
| triple_modifier
))
8885 while (modifiers
& (down_modifier
| drag_modifier
8886 | double_modifier
| triple_modifier
))
8888 Lisp_Object new_head
, new_click
;
8889 if (modifiers
& triple_modifier
)
8890 modifiers
^= (double_modifier
| triple_modifier
);
8891 else if (modifiers
& double_modifier
)
8892 modifiers
&= ~double_modifier
;
8893 else if (modifiers
& drag_modifier
)
8894 modifiers
&= ~drag_modifier
;
8897 /* Dispose of this `down' event by simply jumping
8898 back to replay_key, to get another event.
8900 Note that if this event came from mock input,
8901 then just jumping back to replay_key will just
8902 hand it to us again. So we have to wipe out any
8905 We could delete keybuf[t] and shift everything
8906 after that to the left by one spot, but we'd also
8907 have to fix up any variable that points into
8908 keybuf, and shifting isn't really necessary
8911 Adding prefixes for non-textual mouse clicks
8912 creates two characters of mock input, and both
8913 must be thrown away. If we're only looking at
8914 the prefix now, we can just jump back to
8915 replay_key. On the other hand, if we've already
8916 processed the prefix, and now the actual click
8917 itself is giving us trouble, then we've lost the
8918 state of the keymaps we want to backtrack to, and
8919 we need to replay the whole sequence to rebuild
8922 Beyond that, only function key expansion could
8923 create more than two keys, but that should never
8924 generate mouse events, so it's okay to zero
8925 mock_input in that case too.
8927 FIXME: The above paragraph seems just plain
8928 wrong, if you consider things like
8929 xterm-mouse-mode. -stef
8931 Isn't this just the most wonderful code ever? */
8932 if (t
== last_real_key_start
)
8939 mock_input
= last_real_key_start
;
8940 goto replay_sequence
;
8945 = apply_modifiers (modifiers
, XCAR (breakdown
));
8947 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
8949 /* Look for a binding for this new key. follow_key
8950 promises that it didn't munge submaps the
8951 last time we called it, since key was unbound. */
8953 = (follow_key (new_click
,
8954 nmaps
- local_first_binding
,
8955 submaps
+ local_first_binding
,
8956 defs
+ local_first_binding
,
8957 submaps
+ local_first_binding
)
8958 + local_first_binding
);
8960 /* If that click is bound, go for it. */
8961 if (first_binding
< nmaps
)
8966 /* Otherwise, we'll leave key set to the drag event. */
8973 /* Normally, last_nonmenu_event gets the previous key we read.
8974 But when a mouse popup menu is being used,
8975 we don't update last_nonmenu_event; it continues to hold the mouse
8976 event that preceded the first level of menu. */
8977 if (!used_mouse_menu
)
8978 last_nonmenu_event
= key
;
8980 /* Record what part of this_command_keys is the current key sequence. */
8981 this_single_command_key_start
= this_command_key_count
- t
;
8983 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
8984 /* There is a binding and it's not a prefix.
8985 There is thus no function-key in this sequence.
8986 Moving fkey.start is important in this case to allow keytran.start
8987 to go over the sequence before we return (since we keep the
8988 invariant that keytran.end <= fkey.start). */
8991 (fkey
.start
= fkey
.end
= t
, fkey
.map
= Vfunction_key_map
);
8994 /* If the sequence is unbound, see if we can hang a function key
8995 off the end of it. */
8999 /* Continue scan from fkey.end until we find a bound suffix.
9000 If we fail, increment fkey.start and start over from there. */
9001 while (fkey
.end
< t
)
9005 key
= keybuf
[fkey
.end
++];
9006 next
= access_keymap (fkey
.map
, key
, 1, 0, 1);
9008 /* Handle symbol with autoload definition. */
9009 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9010 && CONSP (XSYMBOL (next
)->function
)
9011 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
9012 do_autoload (XSYMBOL (next
)->function
, next
);
9014 /* Handle a symbol whose function definition is a keymap
9016 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9017 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
9018 || KEYMAPP (XSYMBOL (next
)->function
)))
9019 next
= XSYMBOL (next
)->function
;
9021 #if 0 /* I didn't turn this on, because it might cause trouble
9022 for the mapping of return into C-m and tab into C-i. */
9023 /* Optionally don't map function keys into other things.
9024 This enables the user to redefine kp- keys easily. */
9025 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
9029 /* If the function key map gives a function, not an
9030 array, then call the function with no args and use
9031 its value instead. */
9032 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9033 /* If there's a binding (i.e. first_binding >= nmaps)
9034 we don't want to apply this function-key-mapping. */
9035 && fkey
.end
== t
&& first_binding
>= nmaps
)
9037 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9041 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9042 next
= call1 (next
, prompt
);
9044 /* If the function returned something invalid,
9045 barf--don't ignore it.
9046 (To ignore it safely, we would need to gcpro a bunch of
9047 other variables.) */
9048 if (! (VECTORP (next
) || STRINGP (next
)))
9049 error ("Function in key-translation-map returns invalid key sequence");
9052 /* If keybuf[fkey.start..fkey.end] is bound in the
9053 function key map and it's a suffix of the current
9054 sequence (i.e. fkey.end == t), replace it with
9055 the binding and restart with fkey.start at the end. */
9056 if ((VECTORP (next
) || STRINGP (next
))
9057 /* If there's a binding (i.e. first_binding >= nmaps)
9058 we don't want to apply this function-key-mapping. */
9059 && fkey
.end
== t
&& first_binding
>= nmaps
)
9061 int len
= XFASTINT (Flength (next
));
9063 t
= fkey
.start
+ len
;
9065 error ("Key sequence too long");
9068 bcopy (XVECTOR (next
)->contents
,
9069 keybuf
+ fkey
.start
,
9070 (t
- fkey
.start
) * sizeof (keybuf
[0]));
9071 else if (STRINGP (next
))
9075 for (i
= 0; i
< len
; i
++)
9076 XSETFASTINT (keybuf
[fkey
.start
+ i
], SREF (next
, i
));
9080 fkey
.start
= fkey
.end
= t
;
9081 fkey
.map
= Vfunction_key_map
;
9083 /* Do pass the results through key-translation-map.
9084 But don't retranslate what key-translation-map
9085 has already translated. */
9086 keytran
.end
= keytran
.start
;
9087 keytran
.map
= Vkey_translation_map
;
9089 goto replay_sequence
;
9092 fkey
.map
= get_keymap (next
, 0, 1);
9094 /* If we no longer have a bound suffix, try a new positions for
9096 if (!CONSP (fkey
.map
))
9098 fkey
.end
= ++fkey
.start
;
9099 fkey
.map
= Vfunction_key_map
;
9104 /* Look for this sequence in key-translation-map. */
9108 /* Scan from keytran.end until we find a bound suffix. */
9109 while (keytran
.end
< fkey
.start
)
9113 key
= keybuf
[keytran
.end
++];
9114 next
= access_keymap (keytran
.map
, key
, 1, 0, 1);
9116 /* Handle symbol with autoload definition. */
9117 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9118 && CONSP (XSYMBOL (next
)->function
)
9119 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
9120 do_autoload (XSYMBOL (next
)->function
, next
);
9122 /* Handle a symbol whose function definition is a keymap
9124 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9125 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
9126 || KEYMAPP (XSYMBOL (next
)->function
)))
9127 next
= XSYMBOL (next
)->function
;
9129 /* If the key translation map gives a function, not an
9130 array, then call the function with one arg and use
9131 its value instead. */
9132 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
)))
9134 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9138 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9139 next
= call1 (next
, prompt
);
9141 /* If the function returned something invalid,
9142 barf--don't ignore it.
9143 (To ignore it safely, we would need to gcpro a bunch of
9144 other variables.) */
9145 if (! (VECTORP (next
) || STRINGP (next
)))
9146 error ("Function in key-translation-map returns invalid key sequence");
9149 /* If keybuf[keytran.start..keytran.end] is bound in the
9150 key translation map and it's a suffix of the current
9151 sequence (i.e. keytran.end == t), replace it with
9152 the binding and restart with keytran.start at the end. */
9153 if ((VECTORP (next
) || STRINGP (next
)))
9155 int len
= XFASTINT (Flength (next
));
9156 int i
, diff
= len
- (keytran
.end
- keytran
.start
);
9158 mock_input
= max (t
, mock_input
);
9159 if (mock_input
+ diff
>= bufsize
)
9160 error ("Key sequence too long");
9162 /* Shift the keys that are after keytran.end. */
9164 for (i
= keytran
.end
; i
< mock_input
; i
++)
9165 keybuf
[i
+ diff
] = keybuf
[i
];
9167 for (i
= mock_input
- 1; i
>= keytran
.end
; i
--)
9168 keybuf
[i
+ diff
] = keybuf
[i
];
9169 /* Replace the keys between keytran.start and keytran.end
9170 with those from next. */
9171 for (i
= 0; i
< len
; i
++)
9172 keybuf
[keytran
.start
+ i
]
9173 = Faref (next
, make_number (i
));
9176 keytran
.start
= keytran
.end
+= diff
;
9177 keytran
.map
= Vkey_translation_map
;
9179 /* Adjust the function-key-map counters. */
9183 goto replay_sequence
;
9186 keytran
.map
= get_keymap (next
, 0, 1);
9188 /* If we no longer have a bound suffix, try a new positions for
9190 if (!CONSP (keytran
.map
))
9192 keytran
.end
= ++keytran
.start
;
9193 keytran
.map
= Vkey_translation_map
;
9198 /* If KEY is not defined in any of the keymaps,
9199 and cannot be part of a function key or translation,
9200 and is an upper case letter
9201 use the corresponding lower-case letter instead. */
9202 if (first_binding
>= nmaps
9203 && fkey
.start
>= t
&& keytran
.start
>= t
9205 && ((((XINT (key
) & 0x3ffff)
9206 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9207 && UPPERCASEP (XINT (key
) & 0x3ffff))
9208 || (XINT (key
) & shift_modifier
)))
9210 Lisp_Object new_key
;
9212 original_uppercase
= key
;
9213 original_uppercase_position
= t
- 1;
9215 if (XINT (key
) & shift_modifier
)
9216 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9218 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9219 | (XINT (key
) & ~0x3ffff)));
9221 /* We have to do this unconditionally, regardless of whether
9222 the lower-case char is defined in the keymaps, because they
9223 might get translated through function-key-map. */
9224 keybuf
[t
- 1] = new_key
;
9225 mock_input
= max (t
, mock_input
);
9227 goto replay_sequence
;
9229 /* If KEY is not defined in any of the keymaps,
9230 and cannot be part of a function key or translation,
9231 and is a shifted function key,
9232 use the corresponding unshifted function key instead. */
9233 if (first_binding
>= nmaps
9234 && fkey
.start
>= t
&& keytran
.start
>= t
9237 Lisp_Object breakdown
;
9240 breakdown
= parse_modifiers (key
);
9241 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9242 if (modifiers
& shift_modifier
)
9244 Lisp_Object new_key
;
9246 original_uppercase
= key
;
9247 original_uppercase_position
= t
- 1;
9249 modifiers
&= ~shift_modifier
;
9250 new_key
= apply_modifiers (modifiers
,
9253 keybuf
[t
- 1] = new_key
;
9254 mock_input
= max (t
, mock_input
);
9256 goto replay_sequence
;
9262 read_key_sequence_cmd
= (first_binding
< nmaps
9263 ? defs
[first_binding
]
9266 unread_switch_frame
= delayed_switch_frame
;
9267 unbind_to (count
, Qnil
);
9269 /* Don't downcase the last character if the caller says don't.
9270 Don't downcase it if the result is undefined, either. */
9271 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9272 && t
- 1 == original_uppercase_position
)
9273 keybuf
[t
- 1] = original_uppercase
;
9275 /* Occasionally we fabricate events, perhaps by expanding something
9276 according to function-key-map, or by adding a prefix symbol to a
9277 mouse click in the scroll bar or modeline. In this cases, return
9278 the entire generated key sequence, even if we hit an unbound
9279 prefix or a definition before the end. This means that you will
9280 be able to push back the event properly, and also means that
9281 read-key-sequence will always return a logical unit.
9284 for (; t
< mock_input
; t
++)
9286 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9287 && NILP (Fzerop (Vecho_keystrokes
)))
9288 echo_char (keybuf
[t
]);
9289 add_command_key (keybuf
[t
]);
9298 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9299 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9300 The sequence is sufficient to specify a non-prefix command in the
9301 current local and global maps.
9303 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9304 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9305 as a continuation of the previous key.
9307 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9308 convert the last event to lower case. (Normally any upper case event
9309 is converted to lower case if the original event is undefined and the lower
9310 case equivalent is defined.) A non-nil value is appropriate for reading
9311 a key sequence to be defined.
9313 A C-g typed while in this function is treated like any other character,
9314 and `quit-flag' is not set.
9316 If the key sequence starts with a mouse click, then the sequence is read
9317 using the keymaps of the buffer of the window clicked in, not the buffer
9318 of the selected window as normal.
9320 `read-key-sequence' drops unbound button-down events, since you normally
9321 only care about the click or drag events which follow them. If a drag
9322 or multi-click event is unbound, but the corresponding click event would
9323 be bound, `read-key-sequence' turns the event into a click event at the
9324 drag's starting position. This means that you don't have to distinguish
9325 between click and drag, double, or triple events unless you want to.
9327 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9328 lines separating windows, and scroll bars with imaginary keys
9329 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9331 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9332 function will process a switch-frame event if the user switches frames
9333 before typing anything. If the user switches frames in the middle of a
9334 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9335 is nil, then the event will be put off until after the current key sequence.
9337 `read-key-sequence' checks `function-key-map' for function key
9338 sequences, where they wouldn't conflict with ordinary bindings. See
9339 `function-key-map' for more details.
9341 The optional fifth argument COMMAND-LOOP, if non-nil, means
9342 that this key sequence is being read by something that will
9343 read commands one after another. It should be nil if the caller
9344 will read just one key sequence. */)
9345 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9347 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9348 Lisp_Object can_return_switch_frame
, command_loop
;
9350 Lisp_Object keybuf
[30];
9352 struct gcpro gcpro1
;
9353 int count
= SPECPDL_INDEX ();
9356 CHECK_STRING (prompt
);
9359 specbind (Qinput_method_exit_on_first_char
,
9360 (NILP (command_loop
) ? Qt
: Qnil
));
9361 specbind (Qinput_method_use_echo_area
,
9362 (NILP (command_loop
) ? Qt
: Qnil
));
9364 bzero (keybuf
, sizeof keybuf
);
9366 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9368 if (NILP (continue_echo
))
9370 this_command_key_count
= 0;
9371 this_single_command_key_start
= 0;
9374 #ifdef HAVE_X_WINDOWS
9375 if (display_hourglass_p
)
9376 cancel_hourglass ();
9379 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9380 prompt
, ! NILP (dont_downcase_last
),
9381 ! NILP (can_return_switch_frame
), 0);
9383 #if 0 /* The following is fine for code reading a key sequence and
9384 then proceeding with a lenghty computation, but it's not good
9385 for code reading keys in a loop, like an input method. */
9386 #ifdef HAVE_X_WINDOWS
9387 if (display_hourglass_p
)
9398 return unbind_to (count
, make_event_array (i
, keybuf
));
9401 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9402 Sread_key_sequence_vector
, 1, 5, 0,
9403 doc
: /* Like `read-key-sequence' but always return a vector. */)
9404 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9406 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9407 Lisp_Object can_return_switch_frame
, command_loop
;
9409 Lisp_Object keybuf
[30];
9411 struct gcpro gcpro1
;
9412 int count
= SPECPDL_INDEX ();
9415 CHECK_STRING (prompt
);
9418 specbind (Qinput_method_exit_on_first_char
,
9419 (NILP (command_loop
) ? Qt
: Qnil
));
9420 specbind (Qinput_method_use_echo_area
,
9421 (NILP (command_loop
) ? Qt
: Qnil
));
9423 bzero (keybuf
, sizeof keybuf
);
9425 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9427 if (NILP (continue_echo
))
9429 this_command_key_count
= 0;
9430 this_single_command_key_start
= 0;
9433 #ifdef HAVE_X_WINDOWS
9434 if (display_hourglass_p
)
9435 cancel_hourglass ();
9438 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9439 prompt
, ! NILP (dont_downcase_last
),
9440 ! NILP (can_return_switch_frame
), 0);
9442 #ifdef HAVE_X_WINDOWS
9443 if (display_hourglass_p
)
9453 return unbind_to (count
, Fvector (i
, keybuf
));
9456 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9457 doc
: /* Execute CMD as an editor command.
9458 CMD must be a symbol that satisfies the `commandp' predicate.
9459 Optional second arg RECORD-FLAG non-nil
9460 means unconditionally put this command in `command-history'.
9461 Otherwise, that is done only if an arg is read using the minibuffer.
9462 The argument KEYS specifies the value to use instead of (this-command-keys)
9463 when reading the arguments; if it is nil, (this-command-keys) is used.
9464 The argument SPECIAL, if non-nil, means that this command is executing
9465 a special event, so ignore the prefix argument and don't clear it. */)
9466 (cmd
, record_flag
, keys
, special
)
9467 Lisp_Object cmd
, record_flag
, keys
, special
;
9469 register Lisp_Object final
;
9470 register Lisp_Object tem
;
9471 Lisp_Object prefixarg
;
9472 struct backtrace backtrace
;
9473 extern int debug_on_next_call
;
9475 debug_on_next_call
= 0;
9479 prefixarg
= current_kboard
->Vprefix_arg
;
9480 Vcurrent_prefix_arg
= prefixarg
;
9481 current_kboard
->Vprefix_arg
= Qnil
;
9488 tem
= Fget (cmd
, Qdisabled
);
9489 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9491 tem
= Fsymbol_value (Qdisabled_command_hook
);
9493 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9499 final
= Findirect_function (cmd
);
9501 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9503 struct gcpro gcpro1
, gcpro2
;
9505 GCPRO2 (cmd
, prefixarg
);
9506 do_autoload (final
, cmd
);
9513 if (STRINGP (final
) || VECTORP (final
))
9515 /* If requested, place the macro in the command history. For
9516 other sorts of commands, call-interactively takes care of
9518 if (!NILP (record_flag
))
9521 = Fcons (Fcons (Qexecute_kbd_macro
,
9522 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9525 /* Don't keep command history around forever. */
9526 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9528 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9530 XSETCDR (tem
, Qnil
);
9534 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9537 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9539 backtrace
.next
= backtrace_list
;
9540 backtrace_list
= &backtrace
;
9541 backtrace
.function
= &Qcall_interactively
;
9542 backtrace
.args
= &cmd
;
9543 backtrace
.nargs
= 1;
9544 backtrace
.evalargs
= 0;
9546 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9548 backtrace_list
= backtrace
.next
;
9556 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9558 doc
: /* Read function name, then read its arguments and call it. */)
9560 Lisp_Object prefixarg
;
9562 Lisp_Object function
;
9564 int saved_last_point_position
;
9565 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9566 Lisp_Object bindings
, value
;
9567 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9569 saved_keys
= Fvector (this_command_key_count
,
9570 XVECTOR (this_command_keys
)->contents
);
9571 saved_last_point_position_buffer
= last_point_position_buffer
;
9572 saved_last_point_position
= last_point_position
;
9574 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9576 if (EQ (prefixarg
, Qminus
))
9578 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9579 strcpy (buf
, "C-u ");
9580 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9582 if (sizeof (int) == sizeof (EMACS_INT
))
9583 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9584 else if (sizeof (long) == sizeof (EMACS_INT
))
9585 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9589 else if (INTEGERP (prefixarg
))
9591 if (sizeof (int) == sizeof (EMACS_INT
))
9592 sprintf (buf
, "%d ", XINT (prefixarg
));
9593 else if (sizeof (long) == sizeof (EMACS_INT
))
9594 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9599 /* This isn't strictly correct if execute-extended-command
9600 is bound to anything else. Perhaps it should use
9601 this_command_keys? */
9602 strcat (buf
, "M-x ");
9604 /* Prompt with buf, and then read a string, completing from and
9605 restricting to the set of all defined commands. Don't provide
9606 any initial input. Save the command read on the extended-command
9608 function
= Fcompleting_read (build_string (buf
),
9609 Vobarray
, Qcommandp
,
9610 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9613 if (STRINGP (function
) && SCHARS (function
) == 0)
9614 error ("No command name given");
9616 /* Set this_command_keys to the concatenation of saved_keys and
9617 function, followed by a RET. */
9622 this_command_key_count
= 0;
9623 this_single_command_key_start
= 0;
9625 keys
= XVECTOR (saved_keys
)->contents
;
9626 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9627 add_command_key (keys
[i
]);
9629 for (i
= 0; i
< SCHARS (function
); i
++)
9630 add_command_key (Faref (function
, make_number (i
)));
9632 add_command_key (make_number ('\015'));
9635 last_point_position
= saved_last_point_position
;
9636 last_point_position_buffer
= saved_last_point_position_buffer
;
9640 function
= Fintern (function
, Qnil
);
9641 current_kboard
->Vprefix_arg
= prefixarg
;
9642 Vthis_command
= function
;
9643 real_this_command
= function
;
9645 /* If enabled, show which key runs this command. */
9646 if (!NILP (Vsuggest_key_bindings
)
9647 && NILP (Vexecuting_macro
)
9648 && SYMBOLP (function
))
9649 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9655 GCPRO2 (bindings
, value
);
9656 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9658 /* If the command has a key binding, print it now. */
9659 if (!NILP (bindings
)
9660 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9663 /* But first wait, and skip the message if there is input. */
9665 if (!NILP (echo_area_buffer
[0]))
9666 /* This command displayed something in the echo area;
9667 so wait a few seconds, then display our suggestion message. */
9668 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9669 ? XINT (Vsuggest_key_bindings
) : 2);
9671 /* This command left the echo area empty,
9672 so display our message immediately. */
9675 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9676 && ! CONSP (Vunread_command_events
))
9678 Lisp_Object binding
;
9680 int message_p
= push_message ();
9681 int count
= SPECPDL_INDEX ();
9683 record_unwind_protect (pop_message_unwind
, Qnil
);
9684 binding
= Fkey_description (bindings
);
9687 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9690 sprintf (newmessage
, "You can run the command `%s' with %s",
9691 SDATA (SYMBOL_NAME (function
)),
9693 message2_nolog (newmessage
,
9694 strlen (newmessage
),
9695 STRING_MULTIBYTE (binding
));
9696 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9697 ? Vsuggest_key_bindings
: make_number (2)),
9702 unbind_to (count
, Qnil
);
9706 RETURN_UNGCPRO (value
);
9710 /* Return nonzero if input events are pending. */
9713 detect_input_pending ()
9716 get_input_pending (&input_pending
, 0);
9718 return input_pending
;
9721 /* Return nonzero if input events are pending, and run any pending timers. */
9724 detect_input_pending_run_timers (do_display
)
9727 int old_timers_run
= timers_run
;
9730 get_input_pending (&input_pending
, 1);
9732 if (old_timers_run
!= timers_run
&& do_display
)
9734 redisplay_preserve_echo_area (8);
9735 /* The following fixes a bug when using lazy-lock with
9736 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9737 from an idle timer function. The symptom of the bug is that
9738 the cursor sometimes doesn't become visible until the next X
9739 event is processed. --gerd. */
9741 rif
->flush_display (NULL
);
9744 return input_pending
;
9747 /* This is called in some cases before a possible quit.
9748 It cases the next call to detect_input_pending to recompute input_pending.
9749 So calling this function unnecessarily can't do any harm. */
9752 clear_input_pending ()
9757 /* Return nonzero if there are pending requeued events.
9758 This isn't used yet. The hope is to make wait_reading_process_input
9759 call it, and return if it runs Lisp code that unreads something.
9760 The problem is, kbd_buffer_get_event needs to be fixed to know what
9761 to do in that case. It isn't trivial. */
9764 requeued_events_pending_p ()
9766 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9770 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9771 doc
: /* Return t if command input is currently available with no wait.
9772 Actually, the value is nil only if we can be sure that no input is available;
9773 if there is a doubt, the value is t. */)
9776 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9779 get_filtered_input_pending (&input_pending
, 1, 1);
9780 return input_pending
> 0 ? Qt
: Qnil
;
9783 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9784 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9787 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9790 if (total_keys
< NUM_RECENT_KEYS
)
9791 return Fvector (total_keys
, keys
);
9794 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9795 bcopy (keys
+ recent_keys_index
,
9796 XVECTOR (val
)->contents
,
9797 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9799 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9800 recent_keys_index
* sizeof (Lisp_Object
));
9805 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9806 doc
: /* Return the key sequence that invoked this command.
9807 However, if the command has called `read-key-sequence', it returns
9808 the last key sequence that has been read.
9809 The value is a string or a vector. */)
9812 return make_event_array (this_command_key_count
,
9813 XVECTOR (this_command_keys
)->contents
);
9816 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9817 doc
: /* Return the key sequence that invoked this command, as a vector.
9818 However, if the command has called `read-key-sequence', it returns
9819 the last key sequence that has been read. */)
9822 return Fvector (this_command_key_count
,
9823 XVECTOR (this_command_keys
)->contents
);
9826 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9827 Sthis_single_command_keys
, 0, 0, 0,
9828 doc
: /* Return the key sequence that invoked this command.
9829 More generally, it returns the last key sequence read, either by
9830 the command loop or by `read-key-sequence'.
9831 Unlike `this-command-keys', this function's value
9832 does not include prefix arguments.
9833 The value is always a vector. */)
9836 return Fvector (this_command_key_count
9837 - this_single_command_key_start
,
9838 (XVECTOR (this_command_keys
)->contents
9839 + this_single_command_key_start
));
9842 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9843 Sthis_single_command_raw_keys
, 0, 0, 0,
9844 doc
: /* Return the raw events that were read for this command.
9845 More generally, it returns the last key sequence read, either by
9846 the command loop or by `read-key-sequence'.
9847 Unlike `this-single-command-keys', this function's value
9848 shows the events before all translations (except for input methods).
9849 The value is always a vector. */)
9852 return Fvector (raw_keybuf_count
,
9853 (XVECTOR (raw_keybuf
)->contents
));
9856 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9857 Sreset_this_command_lengths
, 0, 0, 0,
9858 doc
: /* Used for complicated reasons in `universal-argument-other-key'.
9860 `universal-argument-other-key' rereads the event just typed.
9861 It then gets translated through `function-key-map'.
9862 The translated event gets included in the echo area and in
9863 the value of `this-command-keys' in addition to the raw original event.
9866 Calling this function directs the translated event to replace
9867 the original event, so that only one version of the event actually
9868 appears in the echo area and in the value of `this-command-keys'. */)
9871 before_command_restore_flag
= 1;
9872 before_command_key_count_1
= before_command_key_count
;
9873 before_command_echo_length_1
= before_command_echo_length
;
9877 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9878 Sclear_this_command_keys
, 0, 1, 0,
9879 doc
: /* Clear out the vector that `this-command-keys' returns.
9880 Also clear the record of the last 100 events, unless optional arg
9881 KEEP-RECORD is non-nil. */)
9883 Lisp_Object keep_record
;
9887 this_command_key_count
= 0;
9889 if (NILP (keep_record
))
9891 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
9892 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
9894 recent_keys_index
= 0;
9899 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
9900 doc
: /* Return the current depth in recursive edits. */)
9904 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
9908 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
9909 "FOpen dribble file: ",
9910 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
9911 If FILE is nil, close any open dribble file. */)
9922 file
= Fexpand_file_name (file
, Qnil
);
9923 dribble
= fopen (SDATA (file
), "w");
9925 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
9930 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
9931 doc
: /* Discard the contents of the terminal input buffer.
9932 Also end any kbd macro being defined. */)
9935 if (!NILP (current_kboard
->defining_kbd_macro
))
9937 /* Discard the last command from the macro. */
9938 Fcancel_kbd_macro_events ();
9942 update_mode_lines
++;
9944 Vunread_command_events
= Qnil
;
9945 unread_command_char
= -1;
9947 discard_tty_input ();
9949 kbd_fetch_ptr
= kbd_store_ptr
;
9950 Ffillarray (kbd_buffer_gcpro
, Qnil
);
9956 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
9957 doc
: /* Stop Emacs and return to superior process. You can resume later.
9958 If `cannot-suspend' is non-nil, or if the system doesn't support job
9959 control, run a subshell instead.
9961 If optional arg STUFFSTRING is non-nil, its characters are stuffed
9962 to be read as terminal input by Emacs's parent, after suspension.
9964 Before suspending, run the normal hook `suspend-hook'.
9965 After resumption run the normal hook `suspend-resume-hook'.
9967 Some operating systems cannot stop the Emacs process and resume it later.
9968 On such systems, Emacs starts a subshell instead of suspending. */)
9970 Lisp_Object stuffstring
;
9972 int count
= SPECPDL_INDEX ();
9973 int old_height
, old_width
;
9975 struct gcpro gcpro1
;
9977 if (!NILP (stuffstring
))
9978 CHECK_STRING (stuffstring
);
9980 /* Run the functions in suspend-hook. */
9981 if (!NILP (Vrun_hooks
))
9982 call1 (Vrun_hooks
, intern ("suspend-hook"));
9984 GCPRO1 (stuffstring
);
9985 get_frame_size (&old_width
, &old_height
);
9987 /* sys_suspend can get an error if it tries to fork a subshell
9988 and the system resources aren't available for that. */
9989 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
9991 stuff_buffered_input (stuffstring
);
9996 unbind_to (count
, Qnil
);
9998 /* Check if terminal/window size has changed.
9999 Note that this is not useful when we are running directly
10000 with a window system; but suspend should be disabled in that case. */
10001 get_frame_size (&width
, &height
);
10002 if (width
!= old_width
|| height
!= old_height
)
10003 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10005 /* Run suspend-resume-hook. */
10006 if (!NILP (Vrun_hooks
))
10007 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10013 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10014 Then in any case stuff anything Emacs has read ahead and not used. */
10017 stuff_buffered_input (stuffstring
)
10018 Lisp_Object stuffstring
;
10020 /* stuff_char works only in BSD, versions 4.2 and up. */
10023 register unsigned char *p
;
10025 if (STRINGP (stuffstring
))
10027 register int count
;
10029 p
= SDATA (stuffstring
);
10030 count
= SBYTES (stuffstring
);
10031 while (count
-- > 0)
10036 /* Anything we have read ahead, put back for the shell to read. */
10037 /* ?? What should this do when we have multiple keyboards??
10038 Should we ignore anything that was typed in at the "wrong" kboard? */
10039 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10043 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10044 kbd_fetch_ptr
= kbd_buffer
;
10045 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10046 stuff_char (kbd_fetch_ptr
->code
);
10048 kbd_fetch_ptr
->kind
= NO_EVENT
;
10049 idx
= 2 * (kbd_fetch_ptr
- kbd_buffer
);
10050 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
10051 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
10056 #endif /* BSD_SYSTEM and not BSD4_1 */
10060 set_waiting_for_input (time_to_clear
)
10061 EMACS_TIME
*time_to_clear
;
10063 input_available_clear_time
= time_to_clear
;
10065 /* Tell interrupt_signal to throw back to read_char, */
10066 waiting_for_input
= 1;
10068 /* If interrupt_signal was called before and buffered a C-g,
10069 make it run again now, to avoid timing error. */
10070 if (!NILP (Vquit_flag
))
10071 quit_throw_to_read_char ();
10075 clear_waiting_for_input ()
10077 /* Tell interrupt_signal not to throw back to read_char, */
10078 waiting_for_input
= 0;
10079 input_available_clear_time
= 0;
10082 /* This routine is called at interrupt level in response to C-g.
10084 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10085 is called from kbd_buffer_store_event, in handling SIGIO or
10088 If `waiting_for_input' is non zero, then unless `echoing' is
10089 nonzero, immediately throw back to read_char.
10091 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10092 eval to throw, when it gets a chance. If quit-flag is already
10093 non-nil, it stops the job right away. */
10096 interrupt_signal (signalnum
) /* If we don't have an argument, */
10097 int signalnum
; /* some compilers complain in signal calls. */
10100 /* Must preserve main program's value of errno. */
10101 int old_errno
= errno
;
10102 struct frame
*sf
= SELECTED_FRAME ();
10104 #if defined (USG) && !defined (POSIX_SIGNALS)
10105 if (!read_socket_hook
&& NILP (Vwindow_system
))
10107 /* USG systems forget handlers when they are used;
10108 must reestablish each time */
10109 signal (SIGINT
, interrupt_signal
);
10110 signal (SIGQUIT
, interrupt_signal
);
10116 if (!NILP (Vquit_flag
)
10117 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10119 /* If SIGINT isn't blocked, don't let us be interrupted by
10120 another SIGINT, it might be harmful due to non-reentrancy
10121 in I/O functions. */
10122 sigblock (sigmask (SIGINT
));
10125 reset_sys_modes ();
10127 #ifdef SIGTSTP /* Support possible in later USG versions */
10129 * On systems which can suspend the current process and return to the original
10130 * shell, this command causes the user to end up back at the shell.
10131 * The "Auto-save" and "Abort" questions are not asked until
10132 * the user elects to return to emacs, at which point he can save the current
10133 * job and either dump core or continue.
10138 if (sys_suspend () == -1)
10140 printf ("Not running as a subprocess;\n");
10141 printf ("you can continue or abort.\n");
10143 #else /* not VMS */
10144 /* Perhaps should really fork an inferior shell?
10145 But that would not provide any way to get back
10146 to the original shell, ever. */
10147 printf ("No support for stopping a process on this operating system;\n");
10148 printf ("you can continue or abort.\n");
10149 #endif /* not VMS */
10150 #endif /* not SIGTSTP */
10152 /* We must remain inside the screen area when the internal terminal
10153 is used. Note that [Enter] is not echoed by dos. */
10156 /* It doesn't work to autosave while GC is in progress;
10157 the code used for auto-saving doesn't cope with the mark bit. */
10158 if (!gc_in_progress
)
10160 printf ("Auto-save? (y or n) ");
10162 if (((c
= getchar ()) & ~040) == 'Y')
10164 Fdo_auto_save (Qt
, Qnil
);
10166 printf ("\r\nAuto-save done");
10167 #else /* not MSDOS */
10168 printf ("Auto-save done\n");
10169 #endif /* not MSDOS */
10171 while (c
!= '\n') c
= getchar ();
10175 /* During GC, it must be safe to reenable quitting again. */
10176 Vinhibit_quit
= Qnil
;
10179 #endif /* not MSDOS */
10180 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10181 printf ("but will instead do a real quit after garbage collection ends\r\n");
10186 printf ("\r\nAbort? (y or n) ");
10187 #else /* not MSDOS */
10189 printf ("Abort (and enter debugger)? (y or n) ");
10190 #else /* not VMS */
10191 printf ("Abort (and dump core)? (y or n) ");
10192 #endif /* not VMS */
10193 #endif /* not MSDOS */
10195 if (((c
= getchar ()) & ~040) == 'Y')
10197 while (c
!= '\n') c
= getchar ();
10199 printf ("\r\nContinuing...\r\n");
10200 #else /* not MSDOS */
10201 printf ("Continuing...\n");
10202 #endif /* not MSDOS */
10209 /* If executing a function that wants to be interrupted out of
10210 and the user has not deferred quitting by binding `inhibit-quit'
10211 then quit right away. */
10212 if (immediate_quit
&& NILP (Vinhibit_quit
))
10214 struct gl_state_s saved
;
10215 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10217 immediate_quit
= 0;
10220 GCPRO4 (saved
.object
, saved
.global_code
,
10221 saved
.current_syntax_table
, saved
.old_prop
);
10222 Fsignal (Qquit
, Qnil
);
10227 /* Else request quit when it's safe */
10231 if (waiting_for_input
&& !echoing
)
10232 quit_throw_to_read_char ();
10237 /* Handle a C-g by making read_char return C-g. */
10240 quit_throw_to_read_char ()
10243 /* Prevent another signal from doing this before we finish. */
10244 clear_waiting_for_input ();
10247 Vunread_command_events
= Qnil
;
10248 unread_command_char
= -1;
10250 #if 0 /* Currently, sit_for is called from read_char without turning
10251 off polling. And that can call set_waiting_for_input.
10252 It seems to be harmless. */
10253 #ifdef POLL_FOR_INPUT
10254 /* May be > 1 if in recursive minibuffer. */
10255 if (poll_suppress_count
== 0)
10259 if (FRAMEP (internal_last_event_frame
)
10260 && !EQ (internal_last_event_frame
, selected_frame
))
10261 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10264 _longjmp (getcjmp
, 1);
10267 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10268 doc
: /* Set mode of reading keyboard input.
10269 First arg INTERRUPT non-nil means use input interrupts;
10270 nil means use CBREAK mode.
10271 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10272 (no effect except in CBREAK mode).
10273 Third arg META t means accept 8-bit input (for a Meta key).
10274 META nil means ignore the top bit, on the assumption it is parity.
10275 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10276 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10277 See also `current-input-mode'. */)
10278 (interrupt
, flow
, meta
, quit
)
10279 Lisp_Object interrupt
, flow
, meta
, quit
;
10282 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10283 error ("set-input-mode: QUIT must be an ASCII character");
10285 #ifdef POLL_FOR_INPUT
10290 /* this causes startup screen to be restored and messes with the mouse */
10291 reset_sys_modes ();
10295 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10296 if (read_socket_hook
)
10298 /* When using X, don't give the user a real choice,
10299 because we haven't implemented the mechanisms to support it. */
10300 #ifdef NO_SOCK_SIGIO
10301 interrupt_input
= 0;
10302 #else /* not NO_SOCK_SIGIO */
10303 interrupt_input
= 1;
10304 #endif /* NO_SOCK_SIGIO */
10307 interrupt_input
= !NILP (interrupt
);
10308 #else /* not SIGIO */
10309 interrupt_input
= 0;
10310 #endif /* not SIGIO */
10312 /* Our VMS input only works by interrupts, as of now. */
10314 interrupt_input
= 1;
10317 flow_control
= !NILP (flow
);
10320 else if (EQ (meta
, Qt
))
10325 /* Don't let this value be out of range. */
10326 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10332 #ifdef POLL_FOR_INPUT
10333 poll_suppress_count
= 1;
10339 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10340 doc
: /* Return information about the way Emacs currently reads keyboard input.
10341 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10342 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10343 nil, Emacs is using CBREAK mode.
10344 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10345 terminal; this does not apply if Emacs uses interrupt-driven input.
10346 META is t if accepting 8-bit input with 8th bit as Meta flag.
10347 META nil means ignoring the top bit, on the assumption it is parity.
10348 META is neither t nor nil if accepting 8-bit input and using
10349 all 8 bits as the character code.
10350 QUIT is the character Emacs currently uses to quit.
10351 The elements of this list correspond to the arguments of
10352 `set-input-mode'. */)
10355 Lisp_Object val
[4];
10357 val
[0] = interrupt_input
? Qt
: Qnil
;
10358 val
[1] = flow_control
? Qt
: Qnil
;
10359 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10360 XSETFASTINT (val
[3], quit_char
);
10362 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10367 * Set up a new kboard object with reasonable initial values.
10373 kb
->Voverriding_terminal_local_map
= Qnil
;
10374 kb
->Vlast_command
= Qnil
;
10375 kb
->Vreal_last_command
= Qnil
;
10376 kb
->Vprefix_arg
= Qnil
;
10377 kb
->Vlast_prefix_arg
= Qnil
;
10378 kb
->kbd_queue
= Qnil
;
10379 kb
->kbd_queue_has_data
= 0;
10380 kb
->immediate_echo
= 0;
10381 kb
->echo_string
= Qnil
;
10382 kb
->echo_after_prompt
= -1;
10383 kb
->kbd_macro_buffer
= 0;
10384 kb
->kbd_macro_bufsize
= 0;
10385 kb
->defining_kbd_macro
= Qnil
;
10386 kb
->Vlast_kbd_macro
= Qnil
;
10387 kb
->reference_count
= 0;
10388 kb
->Vsystem_key_alist
= Qnil
;
10389 kb
->system_key_syms
= Qnil
;
10390 kb
->Vdefault_minibuffer_frame
= Qnil
;
10394 * Destroy the contents of a kboard object, but not the object itself.
10395 * We use this just before deleting it, or if we're going to initialize
10396 * it a second time.
10402 if (kb
->kbd_macro_buffer
)
10403 xfree (kb
->kbd_macro_buffer
);
10406 #ifdef MULTI_KBOARD
10408 /* Free KB and memory referenced from it. */
10416 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10419 *kbp
= kb
->next_kboard
;
10421 /* Prevent a dangling reference to KB. */
10422 if (kb
== current_kboard
10423 && FRAMEP (selected_frame
)
10424 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10426 current_kboard
= XFRAME (selected_frame
)->kboard
;
10427 if (current_kboard
== kb
)
10435 #endif /* MULTI_KBOARD */
10440 /* This is correct before outermost invocation of the editor loop */
10441 command_loop_level
= -1;
10442 immediate_quit
= 0;
10443 quit_char
= Ctl ('g');
10444 Vunread_command_events
= Qnil
;
10445 unread_command_char
= -1;
10446 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10448 recent_keys_index
= 0;
10449 kbd_fetch_ptr
= kbd_buffer
;
10450 kbd_store_ptr
= kbd_buffer
;
10451 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10453 do_mouse_tracking
= Qnil
;
10457 /* This means that command_loop_1 won't try to select anything the first
10459 internal_last_event_frame
= Qnil
;
10460 Vlast_event_frame
= internal_last_event_frame
;
10462 #ifdef MULTI_KBOARD
10463 current_kboard
= initial_kboard
;
10465 wipe_kboard (current_kboard
);
10466 init_kboard (current_kboard
);
10468 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10470 signal (SIGINT
, interrupt_signal
);
10471 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10472 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10473 SIGQUIT and we can't tell which one it will give us. */
10474 signal (SIGQUIT
, interrupt_signal
);
10475 #endif /* HAVE_TERMIO */
10477 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10479 if (!noninteractive
)
10480 signal (SIGIO
, input_available_signal
);
10483 /* Use interrupt input by default, if it works and noninterrupt input
10484 has deficiencies. */
10486 #ifdef INTERRUPT_INPUT
10487 interrupt_input
= 1;
10489 interrupt_input
= 0;
10492 /* Our VMS input only works by interrupts, as of now. */
10494 interrupt_input
= 1;
10500 if (keyboard_init_hook
)
10501 (*keyboard_init_hook
) ();
10503 #ifdef POLL_FOR_INPUT
10504 poll_suppress_count
= 1;
10509 /* This type's only use is in syms_of_keyboard, to initialize the
10510 event header symbols and put properties on them. */
10511 struct event_head
{
10517 struct event_head head_table
[] = {
10518 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10519 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10520 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10521 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10522 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10523 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10524 {&Qselect_window
, "select-window", &Qselect_window
}
10528 syms_of_keyboard ()
10530 Vpre_help_message
= Qnil
;
10531 staticpro (&Vpre_help_message
);
10533 Vlispy_mouse_stem
= build_string ("mouse");
10534 staticpro (&Vlispy_mouse_stem
);
10537 QCimage
= intern (":image");
10538 staticpro (&QCimage
);
10540 staticpro (&Qhelp_echo
);
10541 Qhelp_echo
= intern ("help-echo");
10543 staticpro (&item_properties
);
10544 item_properties
= Qnil
;
10546 staticpro (&tool_bar_item_properties
);
10547 tool_bar_item_properties
= Qnil
;
10548 staticpro (&tool_bar_items_vector
);
10549 tool_bar_items_vector
= Qnil
;
10551 staticpro (&real_this_command
);
10552 real_this_command
= Qnil
;
10554 Qtimer_event_handler
= intern ("timer-event-handler");
10555 staticpro (&Qtimer_event_handler
);
10557 Qdisabled_command_hook
= intern ("disabled-command-hook");
10558 staticpro (&Qdisabled_command_hook
);
10560 Qself_insert_command
= intern ("self-insert-command");
10561 staticpro (&Qself_insert_command
);
10563 Qforward_char
= intern ("forward-char");
10564 staticpro (&Qforward_char
);
10566 Qbackward_char
= intern ("backward-char");
10567 staticpro (&Qbackward_char
);
10569 Qdisabled
= intern ("disabled");
10570 staticpro (&Qdisabled
);
10572 Qundefined
= intern ("undefined");
10573 staticpro (&Qundefined
);
10575 Qpre_command_hook
= intern ("pre-command-hook");
10576 staticpro (&Qpre_command_hook
);
10578 Qpost_command_hook
= intern ("post-command-hook");
10579 staticpro (&Qpost_command_hook
);
10581 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10582 staticpro (&Qpost_command_idle_hook
);
10584 Qdeferred_action_function
= intern ("deferred-action-function");
10585 staticpro (&Qdeferred_action_function
);
10587 Qcommand_hook_internal
= intern ("command-hook-internal");
10588 staticpro (&Qcommand_hook_internal
);
10590 Qfunction_key
= intern ("function-key");
10591 staticpro (&Qfunction_key
);
10592 Qmouse_click
= intern ("mouse-click");
10593 staticpro (&Qmouse_click
);
10594 #if defined(WINDOWSNT) || defined(MAC_OSX)
10595 Qmouse_wheel
= intern ("mouse-wheel");
10596 staticpro (&Qmouse_wheel
);
10599 Qlanguage_change
= intern ("language-change");
10600 staticpro (&Qlanguage_change
);
10602 Qdrag_n_drop
= intern ("drag-n-drop");
10603 staticpro (&Qdrag_n_drop
);
10605 Qsave_session
= intern ("save-session");
10606 staticpro(&Qsave_session
);
10608 Qusr1_signal
= intern ("usr1-signal");
10609 staticpro (&Qusr1_signal
);
10610 Qusr2_signal
= intern ("usr2-signal");
10611 staticpro (&Qusr2_signal
);
10613 Qmenu_enable
= intern ("menu-enable");
10614 staticpro (&Qmenu_enable
);
10615 Qmenu_alias
= intern ("menu-alias");
10616 staticpro (&Qmenu_alias
);
10617 QCenable
= intern (":enable");
10618 staticpro (&QCenable
);
10619 QCvisible
= intern (":visible");
10620 staticpro (&QCvisible
);
10621 QChelp
= intern (":help");
10622 staticpro (&QChelp
);
10623 QCfilter
= intern (":filter");
10624 staticpro (&QCfilter
);
10625 QCbutton
= intern (":button");
10626 staticpro (&QCbutton
);
10627 QCkeys
= intern (":keys");
10628 staticpro (&QCkeys
);
10629 QCkey_sequence
= intern (":key-sequence");
10630 staticpro (&QCkey_sequence
);
10631 QCtoggle
= intern (":toggle");
10632 staticpro (&QCtoggle
);
10633 QCradio
= intern (":radio");
10634 staticpro (&QCradio
);
10636 Qmode_line
= intern ("mode-line");
10637 staticpro (&Qmode_line
);
10638 Qvertical_line
= intern ("vertical-line");
10639 staticpro (&Qvertical_line
);
10640 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10641 staticpro (&Qvertical_scroll_bar
);
10642 Qmenu_bar
= intern ("menu-bar");
10643 staticpro (&Qmenu_bar
);
10645 Qabove_handle
= intern ("above-handle");
10646 staticpro (&Qabove_handle
);
10647 Qhandle
= intern ("handle");
10648 staticpro (&Qhandle
);
10649 Qbelow_handle
= intern ("below-handle");
10650 staticpro (&Qbelow_handle
);
10651 Qup
= intern ("up");
10653 Qdown
= intern ("down");
10654 staticpro (&Qdown
);
10655 Qtop
= intern ("top");
10657 Qbottom
= intern ("bottom");
10658 staticpro (&Qbottom
);
10659 Qend_scroll
= intern ("end-scroll");
10660 staticpro (&Qend_scroll
);
10661 Qratio
= intern ("ratio");
10662 staticpro (&Qratio
);
10664 Qevent_kind
= intern ("event-kind");
10665 staticpro (&Qevent_kind
);
10666 Qevent_symbol_elements
= intern ("event-symbol-elements");
10667 staticpro (&Qevent_symbol_elements
);
10668 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10669 staticpro (&Qevent_symbol_element_mask
);
10670 Qmodifier_cache
= intern ("modifier-cache");
10671 staticpro (&Qmodifier_cache
);
10673 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10674 staticpro (&Qrecompute_lucid_menubar
);
10675 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10676 staticpro (&Qactivate_menubar_hook
);
10678 Qpolling_period
= intern ("polling-period");
10679 staticpro (&Qpolling_period
);
10681 Qinput_method_function
= intern ("input-method-function");
10682 staticpro (&Qinput_method_function
);
10684 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10685 staticpro (&Qinput_method_exit_on_first_char
);
10686 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10687 staticpro (&Qinput_method_use_echo_area
);
10689 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10690 Fset (Qinput_method_use_echo_area
, Qnil
);
10692 last_point_position_buffer
= Qnil
;
10695 struct event_head
*p
;
10697 for (p
= head_table
;
10698 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10701 *p
->var
= intern (p
->name
);
10702 staticpro (p
->var
);
10703 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10704 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10708 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10709 staticpro (&button_down_location
);
10710 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10711 staticpro (&mouse_syms
);
10715 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10717 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10718 for (i
= 0; i
< len
; i
++)
10719 if (modifier_names
[i
])
10720 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10721 staticpro (&modifier_symbols
);
10724 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10725 staticpro (&recent_keys
);
10727 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10728 staticpro (&this_command_keys
);
10730 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10731 staticpro (&raw_keybuf
);
10733 Qextended_command_history
= intern ("extended-command-history");
10734 Fset (Qextended_command_history
, Qnil
);
10735 staticpro (&Qextended_command_history
);
10737 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10738 staticpro (&kbd_buffer_gcpro
);
10740 accent_key_syms
= Qnil
;
10741 staticpro (&accent_key_syms
);
10743 func_key_syms
= Qnil
;
10744 staticpro (&func_key_syms
);
10746 #if defined(WINDOWSNT) || defined(MAC_OSX)
10747 mouse_wheel_syms
= Qnil
;
10748 staticpro (&mouse_wheel_syms
);
10749 drag_n_drop_syms
= Qnil
;
10750 staticpro (&drag_n_drop_syms
);
10753 unread_switch_frame
= Qnil
;
10754 staticpro (&unread_switch_frame
);
10756 internal_last_event_frame
= Qnil
;
10757 staticpro (&internal_last_event_frame
);
10759 read_key_sequence_cmd
= Qnil
;
10760 staticpro (&read_key_sequence_cmd
);
10762 menu_bar_one_keymap_changed_items
= Qnil
;
10763 staticpro (&menu_bar_one_keymap_changed_items
);
10765 defsubr (&Sevent_convert_list
);
10766 defsubr (&Sread_key_sequence
);
10767 defsubr (&Sread_key_sequence_vector
);
10768 defsubr (&Srecursive_edit
);
10770 defsubr (&Strack_mouse
);
10772 defsubr (&Sinput_pending_p
);
10773 defsubr (&Scommand_execute
);
10774 defsubr (&Srecent_keys
);
10775 defsubr (&Sthis_command_keys
);
10776 defsubr (&Sthis_command_keys_vector
);
10777 defsubr (&Sthis_single_command_keys
);
10778 defsubr (&Sthis_single_command_raw_keys
);
10779 defsubr (&Sreset_this_command_lengths
);
10780 defsubr (&Sclear_this_command_keys
);
10781 defsubr (&Ssuspend_emacs
);
10782 defsubr (&Sabort_recursive_edit
);
10783 defsubr (&Sexit_recursive_edit
);
10784 defsubr (&Srecursion_depth
);
10785 defsubr (&Stop_level
);
10786 defsubr (&Sdiscard_input
);
10787 defsubr (&Sopen_dribble_file
);
10788 defsubr (&Sset_input_mode
);
10789 defsubr (&Scurrent_input_mode
);
10790 defsubr (&Sexecute_extended_command
);
10792 DEFVAR_LISP ("last-command-char", &last_command_char
,
10793 doc
: /* Last input event that was part of a command. */);
10795 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10796 doc
: /* Last input event that was part of a command. */);
10798 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10799 doc
: /* Last input event in a command, except for mouse menu events.
10800 Mouse menus give back keys that don't look like mouse events;
10801 this variable holds the actual mouse event that led to the menu,
10802 so that you can determine whether the command was run by mouse or not. */);
10804 DEFVAR_LISP ("last-input-char", &last_input_char
,
10805 doc
: /* Last input event. */);
10807 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10808 doc
: /* Last input event. */);
10810 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10811 doc
: /* List of events to be read as the command input.
10812 These events are processed first, before actual keyboard input. */);
10813 Vunread_command_events
= Qnil
;
10815 DEFVAR_INT ("unread-command-char", &unread_command_char
,
10816 doc
: /* If not -1, an object to be read as next command input event. */);
10818 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
10819 doc
: /* List of events to be processed as input by input methods.
10820 These events are processed after `unread-command-events', but
10821 before actual keyboard input. */);
10822 Vunread_post_input_method_events
= Qnil
;
10824 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
10825 doc
: /* List of events to be processed as input by input methods.
10826 These events are processed after `unread-command-events', but
10827 before actual keyboard input. */);
10828 Vunread_input_method_events
= Qnil
;
10830 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
10831 doc
: /* Meta-prefix character code.
10832 Meta-foo as command input turns into this character followed by foo. */);
10833 XSETINT (meta_prefix_char
, 033);
10835 DEFVAR_KBOARD ("last-command", Vlast_command
,
10836 doc
: /* The last command executed.
10837 Normally a symbol with a function definition, but can be whatever was found
10838 in the keymap, or whatever the variable `this-command' was set to by that
10841 The value `mode-exit' is special; it means that the previous command
10842 read an event that told it to exit, and it did so and unread that event.
10843 In other words, the present command is the event that made the previous
10846 The value `kill-region' is special; it means that the previous command
10847 was a kill command. */);
10849 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
10850 doc
: /* Same as `last-command', but never altered by Lisp code. */);
10852 DEFVAR_LISP ("this-command", &Vthis_command
,
10853 doc
: /* The command now being executed.
10854 The command can set this variable; whatever is put here
10855 will be in `last-command' during the following command. */);
10856 Vthis_command
= Qnil
;
10858 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
10859 doc
: /* If non-nil, the original command bound to the current key sequence.
10860 The value of `this-command' is the result of looking up the original
10861 command in the active keymaps. */);
10862 Vthis_original_command
= Qnil
;
10864 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
10865 doc
: /* *Number of input events between auto-saves.
10866 Zero means disable autosaving due to number of characters typed. */);
10867 auto_save_interval
= 300;
10869 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
10870 doc
: /* *Number of seconds idle time before auto-save.
10871 Zero or nil means disable auto-saving due to idleness.
10872 After auto-saving due to this many seconds of idle time,
10873 Emacs also does a garbage collection if that seems to be warranted. */);
10874 XSETFASTINT (Vauto_save_timeout
, 30);
10876 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
10877 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
10878 The value may be integer or floating point. */);
10879 Vecho_keystrokes
= make_number (1);
10881 DEFVAR_INT ("polling-period", &polling_period
,
10882 doc
: /* *Interval between polling for input during Lisp execution.
10883 The reason for polling is to make C-g work to stop a running program.
10884 Polling is needed only when using X windows and SIGIO does not work.
10885 Polling is automatically disabled in all other cases. */);
10886 polling_period
= 2;
10888 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
10889 doc
: /* *Maximum time between mouse clicks to make a double-click.
10890 Measured in milliseconds. nil means disable double-click recognition;
10891 t means double-clicks have no time limit and are detected
10892 by position only. */);
10893 Vdouble_click_time
= make_number (500);
10895 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
10896 doc
: /* *Maximum mouse movement between clicks to make a double-click.
10897 On window-system frames, value is the number of pixels the mouse may have
10898 moved horizontally or vertically between two clicks to make a double-click.
10899 On non window-system frames, value is interpreted in units of 1/8 characters
10902 This variable is also the threshold for motion of the mouse
10903 to count as a drag. */);
10904 double_click_fuzz
= 3;
10906 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
10907 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
10908 inhibit_local_menu_bar_menus
= 0;
10910 DEFVAR_INT ("num-input-keys", &num_input_keys
,
10911 doc
: /* Number of complete key sequences read as input so far.
10912 This includes key sequences read from keyboard macros.
10913 The number is effectively the number of interactive command invocations. */);
10914 num_input_keys
= 0;
10916 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
10917 doc
: /* Number of input events read from the keyboard so far.
10918 This does not include events generated by keyboard macros. */);
10919 num_nonmacro_input_events
= 0;
10921 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
10922 doc
: /* The frame in which the most recently read event occurred.
10923 If the last event came from a keyboard macro, this is set to `macro'. */);
10924 Vlast_event_frame
= Qnil
;
10926 /* This variable is set up in sysdep.c. */
10927 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
10928 doc
: /* The ERASE character as set by the user with stty. */);
10930 DEFVAR_LISP ("help-char", &Vhelp_char
,
10931 doc
: /* Character to recognize as meaning Help.
10932 When it is read, do `(eval help-form)', and display result if it's a string.
10933 If the value of `help-form' is nil, this char can be read normally. */);
10934 XSETINT (Vhelp_char
, Ctl ('H'));
10936 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
10937 doc
: /* List of input events to recognize as meaning Help.
10938 These work just like the value of `help-char' (see that). */);
10939 Vhelp_event_list
= Qnil
;
10941 DEFVAR_LISP ("help-form", &Vhelp_form
,
10942 doc
: /* Form to execute when character `help-char' is read.
10943 If the form returns a string, that string is displayed.
10944 If `help-form' is nil, the help char is not recognized. */);
10947 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
10948 doc
: /* Command to run when `help-char' character follows a prefix key.
10949 This command is used only when there is no actual binding
10950 for that character after that prefix key. */);
10951 Vprefix_help_command
= Qnil
;
10953 DEFVAR_LISP ("top-level", &Vtop_level
,
10954 doc
: /* Form to evaluate when Emacs starts up.
10955 Useful to set before you dump a modified Emacs. */);
10958 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
10959 doc
: /* Translate table for keyboard input, or nil.
10960 Each character is looked up in this string and the contents used instead.
10961 The value may be a string, a vector, or a char-table.
10962 If it is a string or vector of length N,
10963 character codes N and up are untranslated.
10964 In a vector or a char-table, an element which is nil means "no translation".
10966 This is applied to the characters supplied to input methods, not their
10967 output. See also `translation-table-for-input'. */);
10968 Vkeyboard_translate_table
= Qnil
;
10970 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
10971 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
10972 \(Even if the operating system has support for stopping a process.\) */);
10973 cannot_suspend
= 0;
10975 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
10976 doc
: /* Non-nil means prompt with menus when appropriate.
10977 This is done when reading from a keymap that has a prompt string,
10978 for elements that have prompt strings.
10979 The menu is displayed on the screen
10980 if X menus were enabled at configuration
10981 time and the previous event was a mouse click prefix key.
10982 Otherwise, menu prompting uses the echo area. */);
10983 menu_prompting
= 1;
10985 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
10986 doc
: /* Character to see next line of menu prompt.
10987 Type this character while in a menu prompt to rotate around the lines of it. */);
10988 XSETINT (menu_prompt_more_char
, ' ');
10990 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
10991 doc
: /* A mask of additional modifier keys to use with every keyboard character.
10992 Emacs applies the modifiers of the character stored here to each keyboard
10993 character it reads. For example, after evaluating the expression
10994 (setq extra-keyboard-modifiers ?\\C-x)
10995 all input characters will have the control modifier applied to them.
10997 Note that the character ?\\C-@, equivalent to the integer zero, does
10998 not count as a control character; rather, it counts as a character
10999 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11000 cancels any modification. */);
11001 extra_keyboard_modifiers
= 0;
11003 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11004 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11005 The command loop sets this to nil before each command,
11006 and tests the value when the command returns.
11007 Buffer modification stores t in this variable. */);
11008 Vdeactivate_mark
= Qnil
;
11010 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11011 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11012 Vcommand_hook_internal
= Qnil
;
11014 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11015 doc
: /* Normal hook run before each command is executed.
11016 If an unhandled error happens in running this hook,
11017 the hook value is set to nil, since otherwise the error
11018 might happen repeatedly and make Emacs nonfunctional. */);
11019 Vpre_command_hook
= Qnil
;
11021 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11022 doc
: /* Normal hook run after each command is executed.
11023 If an unhandled error happens in running this hook,
11024 the hook value is set to nil, since otherwise the error
11025 might happen repeatedly and make Emacs nonfunctional. */);
11026 Vpost_command_hook
= Qnil
;
11028 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11029 doc
: /* Normal hook run after each command is executed, if idle.
11030 Errors running the hook are caught and ignored. */);
11031 Vpost_command_idle_hook
= Qnil
;
11033 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11034 doc
: /* Delay time before running `post-command-idle-hook'.
11035 This is measured in microseconds. */);
11036 post_command_idle_delay
= 100000;
11039 DEFVAR_LISP ("echo-area-clear-hook", ...,
11040 doc
: /* Normal hook run when clearing the echo area. */);
11042 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11043 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11045 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11046 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11047 Vlucid_menu_bar_dirty_flag
= Qnil
;
11049 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11050 doc
: /* List of menu bar items to move to the end of the menu bar.
11051 The elements of the list are event types that may have menu bar bindings. */);
11052 Vmenu_bar_final_items
= Qnil
;
11054 DEFVAR_KBOARD ("overriding-terminal-local-map",
11055 Voverriding_terminal_local_map
,
11056 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11057 If this variable is non-nil, it is used as a keymap instead of the
11058 buffer's local map, and the minor mode keymaps and text property keymaps.
11059 This variable is intended to let commands such as `universal-argument'
11060 set up a different keymap for reading the next command. */);
11062 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11063 doc
: /* Keymap that overrides all other local keymaps.
11064 If this variable is non-nil, it is used as a keymap instead of the
11065 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11066 Voverriding_local_map
= Qnil
;
11068 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11069 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11070 Otherwise, the menu bar continues to reflect the buffer's local map
11071 and the minor mode maps regardless of `overriding-local-map'. */);
11072 Voverriding_local_map_menu_flag
= Qnil
;
11074 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11075 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11076 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11078 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11079 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11081 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11082 doc
: /* Alist of system-specific X windows key symbols.
11083 Each element should have the form (N . SYMBOL) where N is the
11084 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11085 and SYMBOL is its name. */);
11087 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11088 doc
: /* List of deferred actions to be performed at a later time.
11089 The precise format isn't relevant here; we just check whether it is nil. */);
11090 Vdeferred_action_list
= Qnil
;
11092 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11093 doc
: /* Function to call to handle deferred actions, after each command.
11094 This function is called with no arguments after each command
11095 whenever `deferred-action-list' is non-nil. */);
11096 Vdeferred_action_function
= Qnil
;
11098 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11099 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11100 The value can be a length of time to show the message for.
11101 If the value is non-nil and not a number, we wait 2 seconds. */);
11102 Vsuggest_key_bindings
= Qt
;
11104 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11105 doc
: /* List of active absolute time timers in order of increasing time. */);
11106 Vtimer_list
= Qnil
;
11108 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11109 doc
: /* List of active idle-time timers in order of increasing time. */);
11110 Vtimer_idle_list
= Qnil
;
11112 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11113 doc
: /* If non-nil, the function that implements the current input method.
11114 It's called with one argument, a printing character that was just read.
11115 \(That means a character with code 040...0176.)
11116 Typically this function uses `read-event' to read additional events.
11117 When it does so, it should first bind `input-method-function' to nil
11118 so it will not be called recursively.
11120 The function should return a list of zero or more events
11121 to be used as input. If it wants to put back some events
11122 to be reconsidered, separately, by the input method,
11123 it can add them to the beginning of `unread-command-events'.
11125 The input method function can find in `input-method-previous-method'
11126 the previous echo area message.
11128 The input method function should refer to the variables
11129 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11130 for guidance on what to do. */);
11131 Vinput_method_function
= Qnil
;
11133 DEFVAR_LISP ("input-method-previous-message",
11134 &Vinput_method_previous_message
,
11135 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11136 This variable exists because `read-event' clears the echo area
11137 before running the input method. It is nil if there was no message. */);
11138 Vinput_method_previous_message
= Qnil
;
11140 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11141 doc
: /* If non-nil, the function that implements the display of help.
11142 It's called with one argument, the help string to display. */);
11143 Vshow_help_function
= Qnil
;
11145 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11146 doc
: /* If non-nil, suppress point adjustment after executing a command.
11148 After a command is executed, if point is moved into a region that has
11149 special properties (e.g. composition, display), we adjust point to
11150 the boundary of the region. But, several special commands sets this
11151 variable to non-nil, then we suppress the point adjustment.
11153 This variable is set to nil before reading a command, and is checked
11154 just after executing the command. */);
11155 Vdisable_point_adjustment
= Qnil
;
11157 DEFVAR_LISP ("global-disable-point-adjustment",
11158 &Vglobal_disable_point_adjustment
,
11159 doc
: /* *If non-nil, always suppress point adjustment.
11161 The default value is nil, in which case, point adjustment are
11162 suppressed only after special commands that set
11163 `disable-point-adjustment' (which see) to non-nil. */);
11164 Vglobal_disable_point_adjustment
= Qnil
;
11166 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11167 doc
: /* Non-nil means updating menu bindings is allowed.
11168 A value of nil means menu bindings should not be updated.
11169 Used during Emacs' startup. */);
11170 update_menu_bindings
= 1;
11172 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11173 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11174 If the value is not a number, such messages don't time out. */);
11175 Vminibuffer_message_timeout
= make_number (2);
11179 keys_of_keyboard ()
11181 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11182 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11183 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11184 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11185 initial_define_key (meta_map
, 'x', "execute-extended-command");
11187 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11188 "handle-delete-frame");
11189 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11191 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11193 initial_define_lispy_key (Vspecial_event_map
, "select-window",
11194 "handle-select-window");
11195 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11196 "handle-save-session");