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
;
173 extern int minbuf_level
;
175 extern int message_enable_multibyte
;
177 extern struct backtrace
*backtrace_list
;
179 /* If non-nil, the function that implements the display of help.
180 It's called with one argument, the help string to display. */
182 Lisp_Object Vshow_help_function
;
184 /* If a string, the message displayed before displaying a help-echo
187 Lisp_Object Vpre_help_message
;
189 /* Nonzero means do menu prompting. */
191 static int menu_prompting
;
193 /* Character to see next line of menu prompt. */
195 static Lisp_Object menu_prompt_more_char
;
197 /* For longjmp to where kbd input is being done. */
199 static jmp_buf getcjmp
;
201 /* True while doing kbd input. */
202 int waiting_for_input
;
204 /* True while displaying for echoing. Delays C-g throwing. */
208 /* Non-null means we can start echoing at the next input pause even
209 though there is something in the echo area. */
211 static struct kboard
*ok_to_echo_at_next_pause
;
213 /* The kboard last echoing, or null for none. Reset to 0 in
214 cancel_echoing. If non-null, and a current echo area message
215 exists, and echo_message_buffer is eq to the current message
216 buffer, we know that the message comes from echo_kboard. */
218 struct kboard
*echo_kboard
;
220 /* The buffer used for echoing. Set in echo_now, reset in
223 Lisp_Object echo_message_buffer
;
225 /* Nonzero means disregard local maps for the menu bar. */
226 static int inhibit_local_menu_bar_menus
;
228 /* Nonzero means C-g should cause immediate error-signal. */
231 /* The user's ERASE setting. */
232 Lisp_Object Vtty_erase_char
;
234 /* Character to recognize as the help char. */
235 Lisp_Object Vhelp_char
;
237 /* List of other event types to recognize as meaning "help". */
238 Lisp_Object Vhelp_event_list
;
240 /* Form to execute when help char is typed. */
241 Lisp_Object Vhelp_form
;
243 /* Command to run when the help character follows a prefix key. */
244 Lisp_Object Vprefix_help_command
;
246 /* List of items that should move to the end of the menu bar. */
247 Lisp_Object Vmenu_bar_final_items
;
249 /* Non-nil means show the equivalent key-binding for
250 any M-x command that has one.
251 The value can be a length of time to show the message for.
252 If the value is non-nil and not a number, we wait 2 seconds. */
253 Lisp_Object Vsuggest_key_bindings
;
255 /* How long to display an echo-area message when the minibuffer is active.
256 If the value is not a number, such messages don't time out. */
257 Lisp_Object Vminibuffer_message_timeout
;
259 /* Character that causes a quit. Normally C-g.
261 If we are running on an ordinary terminal, this must be an ordinary
262 ASCII char, since we want to make it our interrupt character.
264 If we are not running on an ordinary terminal, it still needs to be
265 an ordinary ASCII char. This character needs to be recognized in
266 the input interrupt handler. At this point, the keystroke is
267 represented as a struct input_event, while the desired quit
268 character is specified as a lispy event. The mapping from struct
269 input_events to lispy events cannot run in an interrupt handler,
270 and the reverse mapping is difficult for anything but ASCII
273 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
277 extern Lisp_Object current_global_map
;
278 extern int minibuf_level
;
280 /* If non-nil, this is a map that overrides all other local maps. */
281 Lisp_Object Voverriding_local_map
;
283 /* If non-nil, Voverriding_local_map applies to the menu bar. */
284 Lisp_Object Voverriding_local_map_menu_flag
;
286 /* Keymap that defines special misc events that should
287 be processed immediately at a low level. */
288 Lisp_Object Vspecial_event_map
;
290 /* Current depth in recursive edits. */
291 int command_loop_level
;
293 /* Total number of times command_loop has read a key sequence. */
294 EMACS_INT num_input_keys
;
296 /* Last input character read as a command. */
297 Lisp_Object last_command_char
;
299 /* Last input character read as a command, not counting menus
300 reached by the mouse. */
301 Lisp_Object last_nonmenu_event
;
303 /* Last input character read for any purpose. */
304 Lisp_Object last_input_char
;
306 /* If not Qnil, a list of objects to be read as subsequent command input. */
307 Lisp_Object Vunread_command_events
;
309 /* If not Qnil, a list of objects to be read as subsequent command input
310 including input method processing. */
311 Lisp_Object Vunread_input_method_events
;
313 /* If not Qnil, a list of objects to be read as subsequent command input
314 but NOT including input method processing. */
315 Lisp_Object Vunread_post_input_method_events
;
317 /* If not -1, an event to be read as subsequent command input. */
318 EMACS_INT unread_command_char
;
320 /* If not Qnil, this is a switch-frame event which we decided to put
321 off until the end of a key sequence. This should be read as the
322 next command input, after any unread_command_events.
324 read_key_sequence uses this to delay switch-frame events until the
325 end of the key sequence; Fread_char uses it to put off switch-frame
326 events until a non-ASCII event is acceptable as input. */
327 Lisp_Object unread_switch_frame
;
329 /* A mask of extra modifier bits to put into every keyboard char. */
330 EMACS_INT extra_keyboard_modifiers
;
332 /* Char to use as prefix when a meta character is typed in.
333 This is bound on entry to minibuffer in case ESC is changed there. */
335 Lisp_Object meta_prefix_char
;
337 /* Last size recorded for a current buffer which is not a minibuffer. */
338 static int last_non_minibuf_size
;
340 /* Number of idle seconds before an auto-save and garbage collection. */
341 static Lisp_Object Vauto_save_timeout
;
343 /* Total number of times read_char has returned. */
344 int num_input_events
;
346 /* Total number of times read_char has returned, outside of macros. */
347 EMACS_INT num_nonmacro_input_events
;
349 /* Auto-save automatically when this many characters have been typed
350 since the last time. */
352 static EMACS_INT auto_save_interval
;
354 /* Value of num_nonmacro_input_events as of last auto save. */
358 /* The command being executed by the command loop.
359 Commands may set this, and the value set will be copied into
360 current_kboard->Vlast_command instead of the actual command. */
361 Lisp_Object Vthis_command
;
363 /* This is like Vthis_command, except that commands never set it. */
364 Lisp_Object real_this_command
;
366 /* If the lookup of the command returns a binding, the original
367 command is stored in this-original-command. It is nil otherwise. */
368 Lisp_Object Vthis_original_command
;
370 /* The value of point when the last command was executed. */
371 int last_point_position
;
373 /* The buffer that was current when the last command was started. */
374 Lisp_Object last_point_position_buffer
;
376 /* The frame in which the last input event occurred, or Qmacro if the
377 last event came from a macro. We use this to determine when to
378 generate switch-frame events. This may be cleared by functions
379 like Fselect_frame, to make sure that a switch-frame event is
380 generated by the next character. */
381 Lisp_Object internal_last_event_frame
;
383 /* A user-visible version of the above, intended to allow users to
384 figure out where the last event came from, if the event doesn't
385 carry that information itself (i.e. if it was a character). */
386 Lisp_Object Vlast_event_frame
;
388 /* The timestamp of the last input event we received from the X server.
389 X Windows wants this for selection ownership. */
390 unsigned long last_event_timestamp
;
392 Lisp_Object Qself_insert_command
;
393 Lisp_Object Qforward_char
;
394 Lisp_Object Qbackward_char
;
395 Lisp_Object Qundefined
;
396 Lisp_Object Qtimer_event_handler
;
398 /* read_key_sequence stores here the command definition of the
399 key sequence that it reads. */
400 Lisp_Object read_key_sequence_cmd
;
402 /* Echo unfinished commands after this many seconds of pause. */
403 Lisp_Object Vecho_keystrokes
;
405 /* Form to evaluate (if non-nil) when Emacs is started. */
406 Lisp_Object Vtop_level
;
408 /* User-supplied table to translate input characters. */
409 Lisp_Object Vkeyboard_translate_table
;
411 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
412 extern Lisp_Object Vfunction_key_map
;
414 /* Another keymap that maps key sequences into key sequences.
415 This one takes precedence over ordinary definitions. */
416 extern Lisp_Object Vkey_translation_map
;
418 /* If non-nil, this implements the current input method. */
419 Lisp_Object Vinput_method_function
;
420 Lisp_Object Qinput_method_function
;
422 /* When we call Vinput_method_function,
423 this holds the echo area message that was just erased. */
424 Lisp_Object Vinput_method_previous_message
;
426 /* Non-nil means deactivate the mark at end of this command. */
427 Lisp_Object Vdeactivate_mark
;
429 /* Menu bar specified in Lucid Emacs fashion. */
431 Lisp_Object Vlucid_menu_bar_dirty_flag
;
432 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
434 Lisp_Object Qecho_area_clear_hook
;
436 /* Hooks to run before and after each command. */
437 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
438 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
439 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
440 /* Hook run after a command if there's no more input soon. */
441 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
443 /* Delay time in microseconds before running post-command-idle-hook. */
444 EMACS_INT post_command_idle_delay
;
446 /* List of deferred actions to be performed at a later time.
447 The precise format isn't relevant here; we just check whether it is nil. */
448 Lisp_Object Vdeferred_action_list
;
450 /* Function to call to handle deferred actions, when there are any. */
451 Lisp_Object Vdeferred_action_function
;
452 Lisp_Object Qdeferred_action_function
;
454 Lisp_Object Qinput_method_exit_on_first_char
;
455 Lisp_Object Qinput_method_use_echo_area
;
457 /* File in which we write all commands we read. */
460 /* Nonzero if input is available. */
463 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
464 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
468 /* Non-zero means force key bindings update in parse_menu_item. */
470 int update_menu_bindings
;
472 extern char *pending_malloc_warning
;
474 /* Circular buffer for pre-read keyboard input. */
476 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
478 /* Vector to GCPRO the Lisp objects referenced from kbd_buffer.
480 The interrupt-level event handlers will never enqueue an event on a
481 frame which is not in Vframe_list, and once an event is dequeued,
482 internal_last_event_frame or the event itself points to the frame.
485 But while the event is sitting in the queue, it's completely
486 unprotected. Suppose the user types one command which will run for
487 a while and then delete a frame, and then types another event at
488 the frame that will be deleted, before the command gets around to
489 it. Suppose there are no references to this frame elsewhere in
490 Emacs, and a GC occurs before the second event is dequeued. Now we
491 have an event referring to a freed frame, which will crash Emacs
494 Similar things happen when an event on a scroll bar is enqueued; the
495 window may be deleted while the event is in the queue.
497 So, we use this vector to protect the Lisp_Objects in the event
498 queue. That way, they'll be dequeued as dead frames or windows,
499 but still valid Lisp objects.
501 If kbd_buffer[i].kind != NO_EVENT, then
503 AREF (kbd_buffer_gcpro, 2 * i) == kbd_buffer[i].frame_or_window.
504 AREF (kbd_buffer_gcpro, 2 * i + 1) == kbd_buffer[i].arg. */
506 static Lisp_Object kbd_buffer_gcpro
;
508 /* Pointer to next available character in kbd_buffer.
509 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
510 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
511 next available char is in kbd_buffer[0]. */
512 static struct input_event
*kbd_fetch_ptr
;
514 /* Pointer to next place to store character in kbd_buffer. This
515 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
516 character should go in kbd_buffer[0]. */
517 static struct input_event
* volatile kbd_store_ptr
;
519 /* The above pair of variables forms a "queue empty" flag. When we
520 enqueue a non-hook event, we increment kbd_store_ptr. When we
521 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
522 there is input available iff the two pointers are not equal.
524 Why not just have a flag set and cleared by the enqueuing and
525 dequeuing functions? Such a flag could be screwed up by interrupts
526 at inopportune times. */
528 /* If this flag is non-nil, we check mouse_moved to see when the
529 mouse moves, and motion events will appear in the input stream.
530 Otherwise, mouse motion is ignored. */
531 Lisp_Object do_mouse_tracking
;
533 /* Symbols to head events. */
534 Lisp_Object Qmouse_movement
;
535 Lisp_Object Qscroll_bar_movement
;
536 Lisp_Object Qswitch_frame
;
537 Lisp_Object Qdelete_frame
;
538 Lisp_Object Qiconify_frame
;
539 Lisp_Object Qmake_frame_visible
;
540 Lisp_Object Qselect_window
;
541 Lisp_Object Qhelp_echo
;
543 /* Symbols to denote kinds of events. */
544 Lisp_Object Qfunction_key
;
545 Lisp_Object Qmouse_click
;
546 #if defined(WINDOWSNT) || defined(MAC_OSX)
547 Lisp_Object Qmouse_wheel
;
550 Lisp_Object Qlanguage_change
;
552 Lisp_Object Qdrag_n_drop
;
553 Lisp_Object Qsave_session
;
555 /* Lisp_Object Qmouse_movement; - also an event header */
557 /* Properties of event headers. */
558 Lisp_Object Qevent_kind
;
559 Lisp_Object Qevent_symbol_elements
;
561 /* menu item parts */
562 Lisp_Object Qmenu_alias
;
563 Lisp_Object Qmenu_enable
;
564 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
565 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
566 extern Lisp_Object Vdefine_key_rebound_commands
;
567 extern Lisp_Object Qmenu_item
;
569 /* An event header symbol HEAD may have a property named
570 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
571 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
572 mask of modifiers applied to it. If present, this is used to help
573 speed up parse_modifiers. */
574 Lisp_Object Qevent_symbol_element_mask
;
576 /* An unmodified event header BASE may have a property named
577 Qmodifier_cache, which is an alist mapping modifier masks onto
578 modified versions of BASE. If present, this helps speed up
580 Lisp_Object Qmodifier_cache
;
582 /* Symbols to use for parts of windows. */
583 Lisp_Object Qmode_line
;
584 Lisp_Object Qvertical_line
;
585 Lisp_Object Qvertical_scroll_bar
;
586 Lisp_Object Qmenu_bar
;
587 extern Lisp_Object Qleft_margin
, Qright_margin
;
589 Lisp_Object
recursive_edit_unwind (), command_loop ();
590 Lisp_Object
Fthis_command_keys ();
591 Lisp_Object Qextended_command_history
;
592 EMACS_TIME
timer_check ();
594 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
596 extern char *x_get_keysym_name ();
598 static void record_menu_key ();
599 static int echo_length ();
601 Lisp_Object Qpolling_period
;
603 /* List of absolute timers. Appears in order of next scheduled event. */
604 Lisp_Object Vtimer_list
;
606 /* List of idle time timers. Appears in order of next scheduled event. */
607 Lisp_Object Vtimer_idle_list
;
609 /* Incremented whenever a timer is run. */
612 extern Lisp_Object Vprint_level
, Vprint_length
;
614 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
616 EMACS_TIME
*input_available_clear_time
;
618 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
619 Default is 1 if INTERRUPT_INPUT is defined. */
622 /* Nonzero while interrupts are temporarily deferred during redisplay. */
623 int interrupts_deferred
;
625 /* Nonzero means use ^S/^Q for flow control. */
628 /* Allow m- file to inhibit use of FIONREAD. */
629 #ifdef BROKEN_FIONREAD
633 /* We are unable to use interrupts if FIONREAD is not available,
634 so flush SIGIO so we won't try. */
641 /* If we support a window system, turn on the code to poll periodically
642 to detect C-g. It isn't actually used when doing interrupt input. */
643 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
644 #define POLL_FOR_INPUT
647 /* After a command is executed, if point is moved into a region that
648 has specific properties (e.g. composition, display), we adjust
649 point to the boundary of the region. But, if a command sets this
650 variable to non-nil, we suppress this point adjustment. This
651 variable is set to nil before reading a command. */
653 Lisp_Object Vdisable_point_adjustment
;
655 /* If non-nil, always disable point adjustment. */
657 Lisp_Object Vglobal_disable_point_adjustment
;
659 /* The time when Emacs started being idle. */
661 static EMACS_TIME timer_idleness_start_time
;
663 /* After Emacs stops being idle, this saves the last value
664 of timer_idleness_start_time from when it was idle. */
666 static EMACS_TIME timer_last_idleness_start_time
;
669 /* Global variable declarations. */
671 /* Function for init_keyboard to call with no args (if nonzero). */
672 void (*keyboard_init_hook
) ();
674 static int read_avail_input
P_ ((int));
675 static void get_input_pending
P_ ((int *, int));
676 static void get_filtered_input_pending
P_ ((int *, int, int));
677 static int readable_events
P_ ((int));
678 static int readable_filtered_events
P_ ((int, int));
679 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
680 Lisp_Object
, int *));
681 static Lisp_Object
read_char_x_menu_prompt ();
682 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
684 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
686 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
687 enum scroll_bar_part
,
688 Lisp_Object
, Lisp_Object
,
691 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
692 Lisp_Object
, char **,
693 Lisp_Object
*, unsigned));
694 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
695 static int parse_solitary_modifier
P_ ((Lisp_Object
));
696 static int parse_solitary_modifier ();
697 static void save_getcjmp
P_ ((jmp_buf));
698 static void save_getcjmp ();
699 static void restore_getcjmp
P_ ((jmp_buf));
700 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
701 static void clear_event
P_ ((struct input_event
*));
702 static void any_kboard_state
P_ ((void));
703 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
705 /* Nonzero means don't try to suspend even if the operating system seems
707 static int cannot_suspend
;
709 /* Install the string STR as the beginning of the string of echoing,
710 so that it serves as a prompt for the next character.
711 Also start echoing. */
717 current_kboard
->echo_string
= str
;
718 current_kboard
->echo_after_prompt
= SCHARS (str
);
722 /* Add C to the echo string, if echoing is going on.
723 C can be a character, which is printed prettily ("M-C-x" and all that
724 jazz), or a symbol, whose name is printed. */
730 if (current_kboard
->immediate_echo
)
732 int size
= KEY_DESCRIPTION_SIZE
+ 100;
733 char *buffer
= (char *) alloca (size
);
735 Lisp_Object echo_string
;
737 echo_string
= current_kboard
->echo_string
;
739 /* If someone has passed us a composite event, use its head symbol. */
744 ptr
= push_key_description (XINT (c
), ptr
, 1);
746 else if (SYMBOLP (c
))
748 Lisp_Object name
= SYMBOL_NAME (c
);
749 int nbytes
= SBYTES (name
);
751 if (size
- (ptr
- buffer
) < nbytes
)
753 int offset
= ptr
- buffer
;
754 size
= max (2 * size
, size
+ nbytes
);
755 buffer
= (char *) alloca (size
);
756 ptr
= buffer
+ offset
;
759 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
760 STRING_MULTIBYTE (name
), 1);
763 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
766 const char *text
= " (Type ? for further options)";
767 int len
= strlen (text
);
769 if (size
- (ptr
- buffer
) < len
)
771 int offset
= ptr
- buffer
;
773 buffer
= (char *) alloca (size
);
774 ptr
= buffer
+ offset
;
777 bcopy (text
, ptr
, len
);
781 /* Replace a dash from echo_dash with a space, otherwise
782 add a space at the end as a separator between keys. */
783 if (STRINGP (echo_string
)
784 && SCHARS (echo_string
) > 0)
786 Lisp_Object last_char
, idx
;
788 idx
= make_number (SCHARS (echo_string
) - 1);
789 last_char
= Faref (echo_string
, idx
);
791 if (XINT (last_char
) == '-')
792 Faset (echo_string
, idx
, make_number (' '));
794 echo_string
= concat2 (echo_string
, build_string (" "));
797 current_kboard
->echo_string
798 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
804 /* Temporarily add a dash to the end of the echo string if it's not
805 empty, so that it serves as a mini-prompt for the very next character. */
810 /* Do nothing if not echoing at all. */
811 if (NILP (current_kboard
->echo_string
))
814 if (!current_kboard
->immediate_echo
815 && SCHARS (current_kboard
->echo_string
) == 0)
818 /* Do nothing if we just printed a prompt. */
819 if (current_kboard
->echo_after_prompt
820 == SCHARS (current_kboard
->echo_string
))
823 /* Put a dash at the end of the buffer temporarily,
824 but make it go away when the next character is added. */
825 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
830 /* Display the current echo string, and begin echoing if not already
836 if (!current_kboard
->immediate_echo
)
839 current_kboard
->immediate_echo
= 1;
841 for (i
= 0; i
< this_command_key_count
; i
++)
845 /* Set before_command_echo_length to the value that would
846 have been saved before the start of this subcommand in
847 command_loop_1, if we had already been echoing then. */
848 if (i
== this_single_command_key_start
)
849 before_command_echo_length
= echo_length ();
851 c
= XVECTOR (this_command_keys
)->contents
[i
];
852 if (! (EVENT_HAS_PARAMETERS (c
)
853 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
857 /* Set before_command_echo_length to the value that would
858 have been saved before the start of this subcommand in
859 command_loop_1, if we had already been echoing then. */
860 if (this_command_key_count
== this_single_command_key_start
)
861 before_command_echo_length
= echo_length ();
863 /* Put a dash at the end to invite the user to type more. */
868 message3_nolog (current_kboard
->echo_string
,
869 SBYTES (current_kboard
->echo_string
),
870 STRING_MULTIBYTE (current_kboard
->echo_string
));
873 /* Record in what buffer we echoed, and from which kboard. */
874 echo_message_buffer
= echo_area_buffer
[0];
875 echo_kboard
= current_kboard
;
877 if (waiting_for_input
&& !NILP (Vquit_flag
))
878 quit_throw_to_read_char ();
881 /* Turn off echoing, for the start of a new command. */
886 current_kboard
->immediate_echo
= 0;
887 current_kboard
->echo_after_prompt
= -1;
888 current_kboard
->echo_string
= Qnil
;
889 ok_to_echo_at_next_pause
= NULL
;
891 echo_message_buffer
= Qnil
;
894 /* Return the length of the current echo string. */
899 return (STRINGP (current_kboard
->echo_string
)
900 ? SCHARS (current_kboard
->echo_string
)
904 /* Truncate the current echo message to its first LEN chars.
905 This and echo_char get used by read_key_sequence when the user
906 switches frames while entering a key sequence. */
909 echo_truncate (nchars
)
912 if (STRINGP (current_kboard
->echo_string
))
913 current_kboard
->echo_string
914 = Fsubstring (current_kboard
->echo_string
,
915 make_number (0), make_number (nchars
));
916 truncate_echo_area (nchars
);
920 /* Functions for manipulating this_command_keys. */
922 add_command_key (key
)
925 #if 0 /* Not needed after we made Freset_this_command_lengths
926 do the job immediately. */
927 /* If reset-this-command-length was called recently, obey it now.
928 See the doc string of that function for an explanation of why. */
929 if (before_command_restore_flag
)
931 this_command_key_count
= before_command_key_count_1
;
932 if (this_command_key_count
< this_single_command_key_start
)
933 this_single_command_key_start
= this_command_key_count
;
934 echo_truncate (before_command_echo_length_1
);
935 before_command_restore_flag
= 0;
939 if (this_command_key_count
>= ASIZE (this_command_keys
))
940 this_command_keys
= larger_vector (this_command_keys
,
941 2 * ASIZE (this_command_keys
),
944 AREF (this_command_keys
, this_command_key_count
) = key
;
945 ++this_command_key_count
;
952 int count
= SPECPDL_INDEX ();
955 if (command_loop_level
> 0)
957 specbind (Qstandard_output
, Qt
);
958 specbind (Qstandard_input
, Qt
);
961 #ifdef HAVE_X_WINDOWS
962 /* The command loop has started an hourglass timer, so we have to
963 cancel it here, otherwise it will fire because the recursive edit
964 can take some time. Do not check for display_hourglass_p here,
965 because it could already be nil. */
969 /* This function may have been called from a debugger called from
970 within redisplay, for instance by Edebugging a function called
971 from fontification-functions. We want to allow redisplay in
972 the debugging session.
974 The recursive edit is left with a `(throw exit ...)'. The `exit'
975 tag is not caught anywhere in redisplay, i.e. when we leave the
976 recursive edit, the original redisplay leading to the recursive
977 edit will be unwound. The outcome should therefore be safe. */
978 specbind (Qinhibit_redisplay
, Qnil
);
981 val
= command_loop ();
983 Fsignal (Qquit
, Qnil
);
984 /* Handle throw from read_minibuf when using minibuffer
985 while it's active but we're in another window. */
987 Fsignal (Qerror
, Fcons (val
, Qnil
));
989 return unbind_to (count
, Qnil
);
992 /* When an auto-save happens, record the "time", and don't do again soon. */
997 last_auto_save
= num_nonmacro_input_events
;
1000 /* Make an auto save happen as soon as possible at command level. */
1003 force_auto_save_soon ()
1005 last_auto_save
= - auto_save_interval
- 1;
1007 record_asynch_buffer_change ();
1010 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1011 doc
: /* Invoke the editor command loop recursively.
1012 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1013 that tells this function to return.
1014 Alternately, `(throw 'exit t)' makes this function signal an error.
1015 This function is called by the editor initialization to begin editing. */)
1018 int count
= SPECPDL_INDEX ();
1021 command_loop_level
++;
1022 update_mode_lines
= 1;
1024 if (command_loop_level
1025 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1026 buffer
= Fcurrent_buffer ();
1030 /* If we leave recursive_edit_1 below with a `throw' for instance,
1031 like it is done in the splash screen display, we have to
1032 make sure that we restore single_kboard as command_loop_1
1033 would have done if it were left normally. */
1034 record_unwind_protect (recursive_edit_unwind
,
1035 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1037 recursive_edit_1 ();
1038 return unbind_to (count
, Qnil
);
1042 recursive_edit_unwind (info
)
1045 if (BUFFERP (XCAR (info
)))
1046 Fset_buffer (XCAR (info
));
1048 if (NILP (XCDR (info
)))
1049 any_kboard_state ();
1051 single_kboard_state ();
1053 command_loop_level
--;
1054 update_mode_lines
= 1;
1063 #if 0 /* Theory: if there's anything in Vunread_command_events,
1064 it will right away be read by read_key_sequence,
1065 and then if we do switch KBOARDS, it will go into the side
1066 queue then. So we don't need to do anything special here -- rms. */
1067 if (CONSP (Vunread_command_events
))
1069 current_kboard
->kbd_queue
1070 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1071 current_kboard
->kbd_queue_has_data
= 1;
1073 Vunread_command_events
= Qnil
;
1079 /* Switch to the single-kboard state, making current_kboard
1080 the only KBOARD from which further input is accepted. */
1083 single_kboard_state ()
1090 /* Maintain a stack of kboards, so other parts of Emacs
1091 can switch temporarily to the kboard of a given frame
1092 and then revert to the previous status. */
1097 struct kboard_stack
*next
;
1100 static struct kboard_stack
*kboard_stack
;
1103 push_frame_kboard (f
)
1107 struct kboard_stack
*p
1108 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1110 p
->next
= kboard_stack
;
1111 p
->kboard
= current_kboard
;
1114 current_kboard
= FRAME_KBOARD (f
);
1122 struct kboard_stack
*p
= kboard_stack
;
1123 current_kboard
= p
->kboard
;
1124 kboard_stack
= p
->next
;
1129 /* Handle errors that are not handled at inner levels
1130 by printing an error message and returning to the editor command loop. */
1136 Lisp_Object old_level
, old_length
;
1137 char macroerror
[50];
1139 #ifdef HAVE_X_WINDOWS
1140 if (display_hourglass_p
)
1141 cancel_hourglass ();
1144 if (!NILP (executing_macro
))
1146 if (executing_macro_iterations
== 1)
1147 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1149 sprintf (macroerror
, "After %d kbd macro iterations: ",
1150 executing_macro_iterations
);
1155 Vstandard_output
= Qt
;
1156 Vstandard_input
= Qt
;
1157 Vexecuting_macro
= Qnil
;
1158 executing_macro
= Qnil
;
1159 current_kboard
->Vprefix_arg
= Qnil
;
1160 current_kboard
->Vlast_prefix_arg
= Qnil
;
1163 /* Avoid unquittable loop if data contains a circular list. */
1164 old_level
= Vprint_level
;
1165 old_length
= Vprint_length
;
1166 XSETFASTINT (Vprint_level
, 10);
1167 XSETFASTINT (Vprint_length
, 10);
1168 cmd_error_internal (data
, macroerror
);
1169 Vprint_level
= old_level
;
1170 Vprint_length
= old_length
;
1174 Vinhibit_quit
= Qnil
;
1176 any_kboard_state ();
1179 return make_number (0);
1182 /* Take actions on handling an error. DATA is the data that describes
1185 CONTEXT is a C-string containing ASCII characters only which
1186 describes the context in which the error happened. If we need to
1187 generalize CONTEXT to allow multibyte characters, make it a Lisp
1191 cmd_error_internal (data
, context
)
1196 int kill_emacs_p
= 0;
1197 struct frame
*sf
= SELECTED_FRAME ();
1201 clear_message (1, 0);
1203 /* If the window system or terminal frame hasn't been initialized
1204 yet, or we're not interactive, it's best to dump this message out
1205 to stderr and exit. */
1206 if (!sf
->glyphs_initialized_p
1207 /* This is the case of the frame dumped with Emacs, when we're
1208 running under a window system. */
1209 || (!NILP (Vwindow_system
)
1210 && !inhibit_window_system
1211 && FRAME_TERMCAP_P (sf
))
1214 stream
= Qexternal_debugging_output
;
1220 message_log_maybe_newline ();
1225 /* The immediate context is not interesting for Quits,
1226 since they are asyncronous. */
1227 if (EQ (XCAR (data
), Qquit
))
1228 Vsignaling_function
= Qnil
;
1230 print_error_message (data
, stream
, context
, Vsignaling_function
);
1232 Vsignaling_function
= Qnil
;
1234 /* If the window system or terminal frame hasn't been initialized
1235 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1239 Fkill_emacs (make_number (-1));
1243 Lisp_Object
command_loop_1 ();
1244 Lisp_Object
command_loop_2 ();
1245 Lisp_Object
top_level_1 ();
1247 /* Entry to editor-command-loop.
1248 This level has the catches for exiting/returning to editor command loop.
1249 It returns nil to exit recursive edit, t to abort it. */
1254 if (command_loop_level
> 0 || minibuf_level
> 0)
1257 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1258 executing_macro
= Qnil
;
1264 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1265 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1266 executing_macro
= Qnil
;
1268 /* End of file in -batch run causes exit here. */
1274 /* Here we catch errors in execution of commands within the
1275 editing loop, and reenter the editing loop.
1276 When there is an error, cmd_error runs and returns a non-nil
1277 value to us. A value of nil means that command_loop_1 itself
1278 returned due to end of file (or end of kbd macro). */
1283 register Lisp_Object val
;
1286 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1287 while (!NILP (val
));
1295 return Feval (Vtop_level
);
1301 /* On entry to the outer level, run the startup file */
1302 if (!NILP (Vtop_level
))
1303 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1304 else if (!NILP (Vpurify_flag
))
1305 message ("Bare impure Emacs (standard Lisp code not loaded)");
1307 message ("Bare Emacs (standard Lisp code not loaded)");
1311 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1312 doc
: /* Exit all recursive editing levels. */)
1315 #ifdef HAVE_X_WINDOWS
1316 if (display_hourglass_p
)
1317 cancel_hourglass ();
1319 return Fthrow (Qtop_level
, Qnil
);
1322 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1323 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1326 if (command_loop_level
> 0 || minibuf_level
> 0)
1327 Fthrow (Qexit
, Qnil
);
1329 error ("No recursive edit is in progress");
1333 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1334 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1337 if (command_loop_level
> 0 || minibuf_level
> 0)
1340 error ("No recursive edit is in progress");
1344 /* This is the actual command reading loop,
1345 sans error-handling encapsulation. */
1347 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1349 void safe_run_hooks
P_ ((Lisp_Object
));
1350 static void adjust_point_for_property
P_ ((int, int));
1358 Lisp_Object keybuf
[30];
1362 struct buffer
*prev_buffer
= NULL
;
1364 int was_locked
= single_kboard
;
1366 int already_adjusted
;
1368 current_kboard
->Vprefix_arg
= Qnil
;
1369 current_kboard
->Vlast_prefix_arg
= Qnil
;
1370 Vdeactivate_mark
= Qnil
;
1371 waiting_for_input
= 0;
1375 this_command_key_count
= 0;
1376 this_single_command_key_start
= 0;
1378 if (NILP (Vmemory_full
))
1380 /* Make sure this hook runs after commands that get errors and
1381 throw to top level. */
1382 /* Note that the value cell will never directly contain nil
1383 if the symbol is a local variable. */
1384 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1385 safe_run_hooks (Qpost_command_hook
);
1387 /* If displaying a message, resize the echo area window to fit
1388 that message's size exactly. */
1389 if (!NILP (echo_area_buffer
[0]))
1390 resize_echo_area_exactly ();
1392 if (!NILP (Vdeferred_action_list
))
1393 call0 (Vdeferred_action_function
);
1395 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1397 if (NILP (Vunread_command_events
)
1398 && NILP (Vunread_input_method_events
)
1399 && NILP (Vunread_post_input_method_events
)
1400 && NILP (Vexecuting_macro
)
1401 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1402 safe_run_hooks (Qpost_command_idle_hook
);
1406 Vmemory_full
= Qnil
;
1408 /* Do this after running Vpost_command_hook, for consistency. */
1409 current_kboard
->Vlast_command
= Vthis_command
;
1410 current_kboard
->Vreal_last_command
= real_this_command
;
1414 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1417 /* Make sure the current window's buffer is selected. */
1418 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1419 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1421 /* Display any malloc warning that just came out. Use while because
1422 displaying one warning can cause another. */
1424 while (pending_malloc_warning
)
1425 display_malloc_warning ();
1429 Vdeactivate_mark
= Qnil
;
1431 /* If minibuffer on and echo area in use,
1432 wait a short time and redraw minibuffer. */
1435 && !NILP (echo_area_buffer
[0])
1436 && EQ (minibuf_window
, echo_area_window
)
1437 && NUMBERP (Vminibuffer_message_timeout
))
1439 /* Bind inhibit-quit to t so that C-g gets read in
1440 rather than quitting back to the minibuffer. */
1441 int count
= SPECPDL_INDEX ();
1442 specbind (Qinhibit_quit
, Qt
);
1444 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1445 /* Clear the echo area. */
1447 safe_run_hooks (Qecho_area_clear_hook
);
1449 unbind_to (count
, Qnil
);
1451 /* If a C-g came in before, treat it as input now. */
1452 if (!NILP (Vquit_flag
))
1455 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1460 alloca (0); /* Cause a garbage collection now */
1461 /* Since we can free the most stuff here. */
1462 #endif /* C_ALLOCA */
1465 /* Select the frame that the last event came from. Usually,
1466 switch-frame events will take care of this, but if some lisp
1467 code swallows a switch-frame event, we'll fix things up here.
1468 Is this a good idea? */
1469 if (FRAMEP (internal_last_event_frame
)
1470 && !EQ (internal_last_event_frame
, selected_frame
))
1471 Fselect_frame (internal_last_event_frame
, Qnil
);
1473 /* If it has changed current-menubar from previous value,
1474 really recompute the menubar from the value. */
1475 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1476 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1477 call0 (Qrecompute_lucid_menubar
);
1479 before_command_key_count
= this_command_key_count
;
1480 before_command_echo_length
= echo_length ();
1482 Vthis_command
= Qnil
;
1483 real_this_command
= Qnil
;
1485 /* Read next key sequence; i gets its length. */
1486 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1489 /* A filter may have run while we were reading the input. */
1490 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1492 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1493 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1497 /* Now we have read a key sequence of length I,
1498 or else I is 0 and we found end of file. */
1500 if (i
== 0) /* End of file -- happens only in */
1501 return Qnil
; /* a kbd macro, at the end. */
1502 /* -1 means read_key_sequence got a menu that was rejected.
1503 Just loop around and read another command. */
1507 this_command_key_count
= 0;
1508 this_single_command_key_start
= 0;
1512 last_command_char
= keybuf
[i
- 1];
1514 /* If the previous command tried to force a specific window-start,
1515 forget about that, in case this command moves point far away
1516 from that position. But also throw away beg_unchanged and
1517 end_unchanged information in that case, so that redisplay will
1518 update the whole window properly. */
1519 if (!NILP (XWINDOW (selected_window
)->force_start
))
1522 XWINDOW (selected_window
)->force_start
= Qnil
;
1523 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1524 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1527 cmd
= read_key_sequence_cmd
;
1528 if (!NILP (Vexecuting_macro
))
1530 if (!NILP (Vquit_flag
))
1532 Vexecuting_macro
= Qt
;
1533 QUIT
; /* Make some noise. */
1534 /* Will return since macro now empty. */
1538 /* Do redisplay processing after this command except in special
1539 cases identified below. */
1540 prev_buffer
= current_buffer
;
1541 prev_modiff
= MODIFF
;
1542 last_point_position
= PT
;
1543 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1545 /* By default, we adjust point to a boundary of a region that
1546 has such a property that should be treated intangible
1547 (e.g. composition, display). But, some commands will set
1548 this variable differently. */
1549 Vdisable_point_adjustment
= Qnil
;
1551 /* Process filters and timers may have messed with deactivate-mark.
1552 reset it before we execute the command. */
1553 Vdeactivate_mark
= Qnil
;
1555 /* Remap command through active keymaps */
1556 Vthis_original_command
= cmd
;
1560 if (cmd1
= Fremap_command (cmd
), !NILP (cmd1
))
1564 /* Execute the command. */
1566 Vthis_command
= cmd
;
1567 real_this_command
= cmd
;
1568 /* Note that the value cell will never directly contain nil
1569 if the symbol is a local variable. */
1570 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1571 safe_run_hooks (Qpre_command_hook
);
1573 already_adjusted
= 0;
1575 if (NILP (Vthis_command
))
1577 /* nil means key is undefined. */
1579 current_kboard
->defining_kbd_macro
= Qnil
;
1580 update_mode_lines
= 1;
1581 current_kboard
->Vprefix_arg
= Qnil
;
1585 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1587 /* In case we jump to directly_done. */
1588 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1590 /* Recognize some common commands in common situations and
1591 do them directly. */
1592 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1594 struct Lisp_Char_Table
*dp
1595 = window_display_table (XWINDOW (selected_window
));
1596 lose
= FETCH_CHAR (PT_BYTE
);
1598 if (! NILP (Vpost_command_hook
))
1599 /* Put this before calling adjust_point_for_property
1600 so it will only get called once in any case. */
1602 if (current_buffer
== prev_buffer
1603 && last_point_position
!= PT
1604 && NILP (Vdisable_point_adjustment
)
1605 && NILP (Vglobal_disable_point_adjustment
))
1606 adjust_point_for_property (last_point_position
, 0);
1607 already_adjusted
= 1;
1608 if (PT
== last_point_position
+ 1
1610 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1611 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1612 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1613 && (lose
>= 0x20 && lose
< 0x7f)))
1614 : (lose
>= 0x20 && lose
< 0x7f))
1615 /* To extract the case of continuation on
1616 wide-column characters. */
1617 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1618 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1620 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1622 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1624 && !windows_or_buffers_changed
1625 && EQ (current_buffer
->selective_display
, Qnil
)
1626 && !detect_input_pending ()
1627 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1628 && NILP (Vexecuting_macro
))
1629 direct_output_forward_char (1);
1632 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1634 struct Lisp_Char_Table
*dp
1635 = window_display_table (XWINDOW (selected_window
));
1637 lose
= FETCH_CHAR (PT_BYTE
);
1638 if (! NILP (Vpost_command_hook
))
1640 if (current_buffer
== prev_buffer
1641 && last_point_position
!= PT
1642 && NILP (Vdisable_point_adjustment
)
1643 && NILP (Vglobal_disable_point_adjustment
))
1644 adjust_point_for_property (last_point_position
, 0);
1645 already_adjusted
= 1;
1646 if (PT
== last_point_position
- 1
1648 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1649 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1650 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1651 && (lose
>= 0x20 && lose
< 0x7f)))
1652 : (lose
>= 0x20 && lose
< 0x7f))
1653 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1655 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1657 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1659 && !windows_or_buffers_changed
1660 && EQ (current_buffer
->selective_display
, Qnil
)
1661 && !detect_input_pending ()
1662 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1663 && NILP (Vexecuting_macro
))
1664 direct_output_forward_char (-1);
1667 else if (EQ (Vthis_command
, Qself_insert_command
)
1668 /* Try this optimization only on char keystrokes. */
1669 && NATNUMP (last_command_char
)
1670 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1673 = translate_char (Vtranslation_table_for_input
,
1674 XFASTINT (last_command_char
), 0, 0, 0);
1676 if (NILP (Vexecuting_macro
)
1677 && !EQ (minibuf_window
, selected_window
))
1679 if (!nonundocount
|| nonundocount
>= 20)
1687 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1689 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1691 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1693 || MODIFF
<= SAVE_MODIFF
1694 || windows_or_buffers_changed
1695 || !EQ (current_buffer
->selective_display
, Qnil
)
1696 || detect_input_pending ()
1697 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1698 || !NILP (Vexecuting_macro
));
1700 value
= internal_self_insert (c
, 0);
1705 if (! NILP (Vpost_command_hook
))
1706 /* Put this before calling adjust_point_for_property
1707 so it will only get called once in any case. */
1710 /* VALUE == 1 when AFTER-CHANGE functions are
1711 installed which is the case most of the time
1712 because FONT-LOCK installs one. */
1713 if (!lose
&& !value
)
1714 direct_output_for_insert (c
);
1719 /* Here for a command that isn't executed directly */
1721 #ifdef HAVE_X_WINDOWS
1722 if (display_hourglass_p
1723 && NILP (Vexecuting_macro
))
1728 if (NILP (current_kboard
->Vprefix_arg
))
1730 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1732 #ifdef HAVE_X_WINDOWS
1733 /* Do not check display_hourglass_p here, because
1734 Fcommand_execute could change it, but we should cancel
1735 hourglass cursor anyway.
1736 But don't cancel the hourglass within a macro
1737 just because a command in the macro finishes. */
1738 if (NILP (Vexecuting_macro
))
1739 cancel_hourglass ();
1743 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1745 /* Note that the value cell will never directly contain nil
1746 if the symbol is a local variable. */
1747 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1748 safe_run_hooks (Qpost_command_hook
);
1750 /* If displaying a message, resize the echo area window to fit
1751 that message's size exactly. */
1752 if (!NILP (echo_area_buffer
[0]))
1753 resize_echo_area_exactly ();
1755 if (!NILP (Vdeferred_action_list
))
1756 safe_run_hooks (Qdeferred_action_function
);
1758 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1760 if (NILP (Vunread_command_events
)
1761 && NILP (Vunread_input_method_events
)
1762 && NILP (Vunread_post_input_method_events
)
1763 && NILP (Vexecuting_macro
)
1764 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1765 safe_run_hooks (Qpost_command_idle_hook
);
1768 /* If there is a prefix argument,
1769 1) We don't want Vlast_command to be ``universal-argument''
1770 (that would be dumb), so don't set Vlast_command,
1771 2) we want to leave echoing on so that the prefix will be
1772 echoed as part of this key sequence, so don't call
1774 3) we want to leave this_command_key_count non-zero, so that
1775 read_char will realize that it is re-reading a character, and
1776 not echo it a second time.
1778 If the command didn't actually create a prefix arg,
1779 but is merely a frame event that is transparent to prefix args,
1780 then the above doesn't apply. */
1781 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1783 current_kboard
->Vlast_command
= Vthis_command
;
1784 current_kboard
->Vreal_last_command
= real_this_command
;
1786 this_command_key_count
= 0;
1787 this_single_command_key_start
= 0;
1790 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1792 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1794 /* We could also call `deactivate'mark'. */
1795 if (EQ (Vtransient_mark_mode
, Qlambda
))
1796 Vtransient_mark_mode
= Qnil
;
1799 current_buffer
->mark_active
= Qnil
;
1800 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1803 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1804 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1809 if (current_buffer
== prev_buffer
1810 && last_point_position
!= PT
1811 && NILP (Vdisable_point_adjustment
)
1812 && NILP (Vglobal_disable_point_adjustment
)
1813 && !already_adjusted
)
1814 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1816 /* Install chars successfully executed in kbd macro. */
1818 if (!NILP (current_kboard
->defining_kbd_macro
)
1819 && NILP (current_kboard
->Vprefix_arg
))
1820 finalize_kbd_macro_chars ();
1824 any_kboard_state ();
1829 extern Lisp_Object Qcomposition
, Qdisplay
;
1831 /* Adjust point to a boundary of a region that has such a property
1832 that should be treated intangible. For the moment, we check
1833 `composition', `display' and `invisible' properties.
1834 LAST_PT is the last position of point. */
1836 extern Lisp_Object Qafter_string
, Qbefore_string
;
1837 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1840 adjust_point_for_property (last_pt
, modified
)
1845 Lisp_Object val
, overlay
, tmp
;
1846 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1848 while (check_composition
|| check_display
|| check_invisible
)
1850 if (check_composition
1851 && PT
> BEGV
&& PT
< ZV
1852 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1853 && COMPOSITION_VALID_P (beg
, end
, val
)
1854 && beg
< PT
/* && end > PT <- It's always the case. */
1855 && (last_pt
<= beg
|| last_pt
>= end
))
1858 SET_PT (PT
< last_pt
? beg
: end
);
1859 check_display
= check_invisible
= 1;
1861 check_composition
= 0;
1863 && PT
> BEGV
&& PT
< ZV
1864 && !NILP (val
= get_char_property_and_overlay
1865 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1866 && display_prop_intangible_p (val
)
1867 && (!OVERLAYP (overlay
)
1868 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1869 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1870 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1871 && beg
< PT
) /* && end > PT <- It's always the case. */
1874 SET_PT (PT
< last_pt
? beg
: end
);
1875 check_composition
= check_invisible
= 1;
1878 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1880 int inv
, ellipsis
= 0;
1883 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1885 && !NILP (val
= get_char_property_and_overlay
1886 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1887 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1889 ellipsis
= ellipsis
|| inv
> 1
1890 || (OVERLAYP (overlay
)
1891 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1892 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1893 tmp
= Fnext_single_char_property_change
1894 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1895 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1898 && !NILP (val
= get_char_property_and_overlay
1899 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1900 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1902 ellipsis
= ellipsis
|| inv
> 1
1903 || (OVERLAYP (overlay
)
1904 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1905 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1906 tmp
= Fprevious_single_char_property_change
1907 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1908 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1911 /* Move away from the inside area. */
1912 if (beg
< PT
&& end
> PT
)
1914 SET_PT (PT
< last_pt
? beg
: end
);
1915 check_composition
= check_display
= 1;
1917 xassert (PT
== beg
|| PT
== end
);
1918 /* Pretend the area doesn't exist if the buffer is not
1920 if (!modified
&& !ellipsis
&& beg
< end
)
1922 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1923 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1924 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1925 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1926 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1927 /* We've already moved as far as we can. Trying to go
1928 to the other end would mean moving backwards and thus
1929 could lead to an infinite loop. */
1931 else if (val
= get_pos_property (make_number (PT
),
1933 TEXT_PROP_MEANS_INVISIBLE (val
)
1934 && (val
= get_pos_property
1935 (make_number (PT
== beg
? end
: beg
),
1937 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1938 (check_composition
= check_display
= 1,
1939 SET_PT (PT
== beg
? end
: beg
));
1942 check_invisible
= 0;
1946 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1949 safe_run_hooks_1 (hook
)
1952 return call1 (Vrun_hooks
, Vinhibit_quit
);
1955 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1958 safe_run_hooks_error (data
)
1961 return Fset (Vinhibit_quit
, Qnil
);
1964 /* If we get an error while running the hook, cause the hook variable
1965 to be nil. Also inhibit quits, so that C-g won't cause the hook
1966 to mysteriously evaporate. */
1969 safe_run_hooks (hook
)
1972 int count
= SPECPDL_INDEX ();
1973 specbind (Qinhibit_quit
, hook
);
1975 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1977 unbind_to (count
, Qnil
);
1981 /* Number of seconds between polling for input. This is a Lisp
1982 variable that can be bound. */
1984 EMACS_INT polling_period
;
1986 /* Nonzero means polling for input is temporarily suppressed. */
1988 int poll_suppress_count
;
1990 /* Asynchronous timer for polling. */
1992 struct atimer
*poll_timer
;
1995 #ifdef POLL_FOR_INPUT
1997 /* Poll for input, so what we catch a C-g if it comes in. This
1998 function is called from x_make_frame_visible, see comment
2004 if (interrupt_input_blocked
== 0
2005 && !waiting_for_input
)
2006 read_avail_input (0);
2009 /* Timer callback function for poll_timer. TIMER is equal to
2013 poll_for_input (timer
)
2014 struct atimer
*timer
;
2016 if (poll_suppress_count
== 0)
2017 poll_for_input_1 ();
2020 #endif /* POLL_FOR_INPUT */
2022 /* Begin signals to poll for input, if they are appropriate.
2023 This function is called unconditionally from various places. */
2028 #ifdef POLL_FOR_INPUT
2029 if (read_socket_hook
&& !interrupt_input
)
2031 /* Turn alarm handling on unconditionally. It might have
2032 been turned off in process.c. */
2033 turn_on_atimers (1);
2035 /* If poll timer doesn't exist, are we need one with
2036 a different interval, start a new one. */
2037 if (poll_timer
== NULL
2038 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2040 EMACS_TIME interval
;
2043 cancel_atimer (poll_timer
);
2045 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2046 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2047 poll_for_input
, NULL
);
2050 /* Let the timer's callback function poll for input
2051 if this becomes zero. */
2052 --poll_suppress_count
;
2057 /* Nonzero if we are using polling to handle input asynchronously. */
2060 input_polling_used ()
2062 #ifdef POLL_FOR_INPUT
2063 return read_socket_hook
&& !interrupt_input
;
2069 /* Turn off polling. */
2074 #ifdef POLL_FOR_INPUT
2075 if (read_socket_hook
&& !interrupt_input
)
2076 ++poll_suppress_count
;
2080 /* Set the value of poll_suppress_count to COUNT
2081 and start or stop polling accordingly. */
2084 set_poll_suppress_count (count
)
2087 #ifdef POLL_FOR_INPUT
2088 if (count
== 0 && poll_suppress_count
!= 0)
2090 poll_suppress_count
= 1;
2093 else if (count
!= 0 && poll_suppress_count
== 0)
2097 poll_suppress_count
= count
;
2101 /* Bind polling_period to a value at least N.
2102 But don't decrease it. */
2105 bind_polling_period (n
)
2108 #ifdef POLL_FOR_INPUT
2109 int new = polling_period
;
2114 stop_other_atimers (poll_timer
);
2116 specbind (Qpolling_period
, make_number (new));
2117 /* Start a new alarm with the new period. */
2122 /* Apply the control modifier to CHARACTER. */
2128 /* Save the upper bits here. */
2129 int upper
= c
& ~0177;
2133 /* Everything in the columns containing the upper-case letters
2134 denotes a control character. */
2135 if (c
>= 0100 && c
< 0140)
2139 /* Set the shift modifier for a control char
2140 made from a shifted letter. But only for letters! */
2141 if (oc
>= 'A' && oc
<= 'Z')
2142 c
|= shift_modifier
;
2145 /* The lower-case letters denote control characters too. */
2146 else if (c
>= 'a' && c
<= 'z')
2149 /* Include the bits for control and shift
2150 only if the basic ASCII code can't indicate them. */
2154 /* Replace the high bits. */
2155 c
|= (upper
& ~ctrl_modifier
);
2160 /* Display help echo in the echo area.
2162 HELP a string means display that string, HELP nil means clear the
2163 help echo. If HELP is a function, call it with OBJECT and POS as
2164 arguments; the function should return a help string or nil for
2165 none. For all other types of HELP evaluate it to obtain a string.
2167 WINDOW is the window in which the help was generated, if any.
2168 It is nil if not in a window.
2170 If OBJECT is a buffer, POS is the position in the buffer where the
2171 `help-echo' text property was found.
2173 If OBJECT is an overlay, that overlay has a `help-echo' property,
2174 and POS is the position in the overlay's buffer under the mouse.
2176 If OBJECT is a string (an overlay string or a string displayed with
2177 the `display' property). POS is the position in that string under
2180 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2181 echo overwrites a keystroke echo currently displayed in the echo
2184 Note: this function may only be called with HELP nil or a string
2185 from X code running asynchronously. */
2188 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2189 Lisp_Object help
, window
, object
, pos
;
2190 int ok_to_overwrite_keystroke_echo
;
2192 if (!NILP (help
) && !STRINGP (help
))
2194 if (FUNCTIONP (help
))
2196 Lisp_Object args
[4];
2201 help
= safe_call (4, args
);
2204 help
= safe_eval (help
);
2206 if (!STRINGP (help
))
2210 if (STRINGP (help
) || NILP (help
))
2212 if (!NILP (Vshow_help_function
))
2213 call1 (Vshow_help_function
, help
);
2214 else if (/* Don't overwrite minibuffer contents. */
2215 !MINI_WINDOW_P (XWINDOW (selected_window
))
2216 /* Don't overwrite a keystroke echo. */
2217 && (NILP (echo_message_buffer
)
2218 || ok_to_overwrite_keystroke_echo
)
2219 /* Don't overwrite a prompt. */
2220 && !cursor_in_echo_area
)
2224 int count
= SPECPDL_INDEX ();
2226 if (!help_echo_showing_p
)
2227 Vpre_help_message
= current_message ();
2229 specbind (Qmessage_truncate_lines
, Qt
);
2230 message3_nolog (help
, SBYTES (help
),
2231 STRING_MULTIBYTE (help
));
2232 unbind_to (count
, Qnil
);
2234 else if (STRINGP (Vpre_help_message
))
2236 message3_nolog (Vpre_help_message
,
2237 SBYTES (Vpre_help_message
),
2238 STRING_MULTIBYTE (Vpre_help_message
));
2239 Vpre_help_message
= Qnil
;
2245 help_echo_showing_p
= STRINGP (help
);
2251 /* Input of single characters from keyboard */
2253 Lisp_Object
print_help ();
2254 static Lisp_Object
kbd_buffer_get_event ();
2255 static void record_char ();
2258 static jmp_buf wrong_kboard_jmpbuf
;
2261 #define STOP_POLLING \
2262 do { if (! polling_stopped_here) stop_polling (); \
2263 polling_stopped_here = 1; } while (0)
2265 #define RESUME_POLLING \
2266 do { if (polling_stopped_here) start_polling (); \
2267 polling_stopped_here = 0; } while (0)
2269 /* read a character from the keyboard; call the redisplay if needed */
2270 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2271 -1 means do not do redisplay, but do do autosaving.
2274 /* The arguments MAPS and NMAPS are for menu prompting.
2275 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2277 PREV_EVENT is the previous input event, or nil if we are reading
2278 the first event of a key sequence (or not reading a key sequence).
2279 If PREV_EVENT is t, that is a "magic" value that says
2280 not to run input methods, but in other respects to act as if
2281 not reading a key sequence.
2283 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2284 if we used a mouse menu to read the input, or zero otherwise. If
2285 USED_MOUSE_MENU is null, we don't dereference it.
2287 Value is t if we showed a menu and the user rejected it. */
2290 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2294 Lisp_Object prev_event
;
2295 int *used_mouse_menu
;
2297 volatile Lisp_Object c
;
2299 jmp_buf local_getcjmp
;
2301 volatile int key_already_recorded
= 0;
2302 Lisp_Object tem
, save
;
2303 volatile Lisp_Object previous_echo_area_message
;
2304 volatile Lisp_Object also_record
;
2305 volatile int reread
;
2306 struct gcpro gcpro1
, gcpro2
;
2307 EMACS_TIME last_idle_start
;
2308 int polling_stopped_here
= 0;
2312 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2313 before_command_key_count
= this_command_key_count
;
2314 before_command_echo_length
= echo_length ();
2317 previous_echo_area_message
= Qnil
;
2319 GCPRO2 (c
, previous_echo_area_message
);
2324 if (CONSP (Vunread_post_input_method_events
))
2326 c
= XCAR (Vunread_post_input_method_events
);
2327 Vunread_post_input_method_events
2328 = XCDR (Vunread_post_input_method_events
);
2330 /* Undo what read_char_x_menu_prompt did when it unread
2331 additional keys returned by Fx_popup_menu. */
2333 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2341 if (unread_command_char
!= -1)
2343 XSETINT (c
, unread_command_char
);
2344 unread_command_char
= -1;
2350 if (CONSP (Vunread_command_events
))
2352 c
= XCAR (Vunread_command_events
);
2353 Vunread_command_events
= XCDR (Vunread_command_events
);
2355 /* Undo what read_char_x_menu_prompt did when it unread
2356 additional keys returned by Fx_popup_menu. */
2358 && EQ (XCDR (c
), Qdisabled
)
2359 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2362 /* If the queued event is something that used the mouse,
2363 set used_mouse_menu accordingly. */
2365 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2366 *used_mouse_menu
= 1;
2369 goto reread_for_input_method
;
2372 if (CONSP (Vunread_input_method_events
))
2374 c
= XCAR (Vunread_input_method_events
);
2375 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2377 /* Undo what read_char_x_menu_prompt did when it unread
2378 additional keys returned by Fx_popup_menu. */
2380 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2384 goto reread_for_input_method
;
2387 if (!NILP (Vexecuting_macro
))
2389 /* We set this to Qmacro; since that's not a frame, nobody will
2390 try to switch frames on us, and the selected window will
2393 Since this event came from a macro, it would be misleading to
2394 leave internal_last_event_frame set to wherever the last
2395 real event came from. Normally, a switch-frame event selects
2396 internal_last_event_frame after each command is read, but
2397 events read from a macro should never cause a new frame to be
2399 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2401 /* Exit the macro if we are at the end.
2402 Also, some things replace the macro with t
2403 to force an early exit. */
2404 if (EQ (Vexecuting_macro
, Qt
)
2405 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2411 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2412 if (STRINGP (Vexecuting_macro
)
2413 && (XINT (c
) & 0x80))
2414 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2416 executing_macro_index
++;
2421 if (!NILP (unread_switch_frame
))
2423 c
= unread_switch_frame
;
2424 unread_switch_frame
= Qnil
;
2426 /* This event should make it into this_command_keys, and get echoed
2427 again, so we do not set `reread'. */
2431 /* if redisplay was requested */
2432 if (commandflag
>= 0)
2434 /* If there is pending input, process any events which are not
2435 user-visible, such as X selection_request events. */
2437 || detect_input_pending_run_timers (0))
2438 swallow_events (0); /* may clear input_pending */
2440 /* Redisplay if no pending input. */
2441 while (!input_pending
)
2443 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2444 redisplay_preserve_echo_area (5);
2449 /* Normal case: no input arrived during redisplay. */
2452 /* Input arrived and pre-empted redisplay.
2453 Process any events which are not user-visible. */
2455 /* If that cleared input_pending, try again to redisplay. */
2459 /* Message turns off echoing unless more keystrokes turn it on again.
2461 The code in 20.x for the condition was
2463 1. echo_area_glyphs && *echo_area_glyphs
2464 2. && echo_area_glyphs != current_kboard->echobuf
2465 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2467 (1) means there's a current message displayed
2469 (2) means it's not the message from echoing from the current
2472 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2473 is set to a non-null value. This is done in read_char and it is
2474 set to echo_area_glyphs after a call to echo_char. That means
2475 ok_to_echo_at_next_pause is either null or
2476 current_kboard->echobuf with the appropriate current_kboard at
2479 So, condition (3) means in clear text ok_to_echo_at_next_pause
2480 must be either null, or the current message isn't from echoing at
2481 all, or it's from echoing from a different kboard than the
2484 if (/* There currently is something in the echo area. */
2485 !NILP (echo_area_buffer
[0])
2486 && (/* And it's either not from echoing. */
2487 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2488 /* Or it's an echo from a different kboard. */
2489 || echo_kboard
!= current_kboard
2490 /* Or we explicitly allow overwriting whatever there is. */
2491 || ok_to_echo_at_next_pause
== NULL
))
2496 /* Try reading a character via menu prompting in the minibuf.
2497 Try this before the sit-for, because the sit-for
2498 would do the wrong thing if we are supposed to do
2499 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2500 after a mouse event so don't try a minibuf menu. */
2502 if (nmaps
> 0 && INTERACTIVE
2503 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2504 /* Don't bring up a menu if we already have another event. */
2505 && NILP (Vunread_command_events
)
2506 && unread_command_char
< 0
2507 && !detect_input_pending_run_timers (0))
2509 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2512 key_already_recorded
= 1;
2517 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2518 We will do that below, temporarily for short sections of code,
2519 when appropriate. local_getcjmp must be in effect
2520 around any call to sit_for or kbd_buffer_get_event;
2521 it *must not* be in effect when we call redisplay. */
2523 if (_setjmp (local_getcjmp
))
2525 XSETINT (c
, quit_char
);
2526 internal_last_event_frame
= selected_frame
;
2527 Vlast_event_frame
= internal_last_event_frame
;
2528 /* If we report the quit char as an event,
2529 don't do so more than once. */
2530 if (!NILP (Vinhibit_quit
))
2535 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2536 if (kb
!= current_kboard
)
2538 Lisp_Object link
= kb
->kbd_queue
;
2539 /* We shouldn't get here if we were in single-kboard mode! */
2544 while (CONSP (XCDR (link
)))
2546 if (!NILP (XCDR (link
)))
2550 kb
->kbd_queue
= Fcons (c
, Qnil
);
2552 XSETCDR (link
, Fcons (c
, Qnil
));
2553 kb
->kbd_queue_has_data
= 1;
2554 current_kboard
= kb
;
2555 /* This is going to exit from read_char
2556 so we had better get rid of this frame's stuff. */
2558 longjmp (wrong_kboard_jmpbuf
, 1);
2565 timer_start_idle ();
2567 /* If in middle of key sequence and minibuffer not active,
2568 start echoing if enough time elapses. */
2570 if (minibuf_level
== 0
2571 && !current_kboard
->immediate_echo
2572 && this_command_key_count
> 0
2574 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2575 && NILP (Fzerop (Vecho_keystrokes
))
2576 && (/* No message. */
2577 NILP (echo_area_buffer
[0])
2578 /* Or empty message. */
2579 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2580 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2581 /* Or already echoing from same kboard. */
2582 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2583 /* Or not echoing before and echoing allowed. */
2584 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2588 /* After a mouse event, start echoing right away.
2589 This is because we are probably about to display a menu,
2590 and we don't want to delay before doing so. */
2591 if (EVENT_HAS_PARAMETERS (prev_event
))
2596 double duration
= extract_float (Vecho_keystrokes
);
2597 sec
= (int) duration
;
2598 usec
= (duration
- sec
) * 1000000;
2599 save_getcjmp (save_jump
);
2600 restore_getcjmp (local_getcjmp
);
2601 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2602 restore_getcjmp (save_jump
);
2604 && ! CONSP (Vunread_command_events
))
2609 /* Maybe auto save due to number of keystrokes. */
2611 if (commandflag
!= 0
2612 && auto_save_interval
> 0
2613 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2614 && !detect_input_pending_run_timers (0))
2616 Fdo_auto_save (Qnil
, Qnil
);
2617 /* Hooks can actually change some buffers in auto save. */
2621 /* Try reading using an X menu.
2622 This is never confused with reading using the minibuf
2623 because the recursive call of read_char in read_char_minibuf_menu_prompt
2624 does not pass on any keymaps. */
2626 if (nmaps
> 0 && INTERACTIVE
2627 && !NILP (prev_event
)
2628 && EVENT_HAS_PARAMETERS (prev_event
)
2629 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2630 && !EQ (XCAR (prev_event
), Qtool_bar
)
2631 /* Don't bring up a menu if we already have another event. */
2632 && NILP (Vunread_command_events
)
2633 && unread_command_char
< 0)
2635 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2637 /* Now that we have read an event, Emacs is not idle. */
2643 /* Maybe autosave and/or garbage collect due to idleness. */
2645 if (INTERACTIVE
&& NILP (c
))
2647 int delay_level
, buffer_size
;
2649 /* Slow down auto saves logarithmically in size of current buffer,
2650 and garbage collect while we're at it. */
2651 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2652 last_non_minibuf_size
= Z
- BEG
;
2653 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2655 while (buffer_size
> 64)
2656 delay_level
++, buffer_size
-= buffer_size
>> 2;
2657 if (delay_level
< 4) delay_level
= 4;
2658 /* delay_level is 4 for files under around 50k, 7 at 100k,
2659 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2661 /* Auto save if enough time goes by without input. */
2662 if (commandflag
!= 0
2663 && num_nonmacro_input_events
> last_auto_save
2664 && INTEGERP (Vauto_save_timeout
)
2665 && XINT (Vauto_save_timeout
) > 0)
2669 save_getcjmp (save_jump
);
2670 restore_getcjmp (local_getcjmp
);
2671 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2673 restore_getcjmp (save_jump
);
2676 && ! CONSP (Vunread_command_events
))
2678 Fdo_auto_save (Qnil
, Qnil
);
2680 /* If we have auto-saved and there is still no input
2681 available, garbage collect if there has been enough
2682 consing going on to make it worthwhile. */
2683 if (!detect_input_pending_run_timers (0)
2684 && consing_since_gc
> gc_cons_threshold
/ 2)
2685 Fgarbage_collect ();
2692 /* If this has become non-nil here, it has been set by a timer
2693 or sentinel or filter. */
2694 if (CONSP (Vunread_command_events
))
2696 c
= XCAR (Vunread_command_events
);
2697 Vunread_command_events
= XCDR (Vunread_command_events
);
2700 /* Read something from current KBOARD's side queue, if possible. */
2704 if (current_kboard
->kbd_queue_has_data
)
2706 if (!CONSP (current_kboard
->kbd_queue
))
2708 c
= XCAR (current_kboard
->kbd_queue
);
2709 current_kboard
->kbd_queue
2710 = XCDR (current_kboard
->kbd_queue
);
2711 if (NILP (current_kboard
->kbd_queue
))
2712 current_kboard
->kbd_queue_has_data
= 0;
2713 input_pending
= readable_events (0);
2714 if (EVENT_HAS_PARAMETERS (c
)
2715 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2716 internal_last_event_frame
= XCAR (XCDR (c
));
2717 Vlast_event_frame
= internal_last_event_frame
;
2722 /* If current_kboard's side queue is empty check the other kboards.
2723 If one of them has data that we have not yet seen here,
2724 switch to it and process the data waiting for it.
2726 Note: if the events queued up for another kboard
2727 have already been seen here, and therefore are not a complete command,
2728 the kbd_queue_has_data field is 0, so we skip that kboard here.
2729 That's to avoid an infinite loop switching between kboards here. */
2730 if (NILP (c
) && !single_kboard
)
2733 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2734 if (kb
->kbd_queue_has_data
)
2736 current_kboard
= kb
;
2737 /* This is going to exit from read_char
2738 so we had better get rid of this frame's stuff. */
2740 longjmp (wrong_kboard_jmpbuf
, 1);
2749 /* Finally, we read from the main queue,
2750 and if that gives us something we can't use yet, we put it on the
2751 appropriate side queue and try again. */
2757 /* Actually read a character, waiting if necessary. */
2758 save_getcjmp (save_jump
);
2759 restore_getcjmp (local_getcjmp
);
2760 timer_start_idle ();
2761 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2762 restore_getcjmp (save_jump
);
2765 if (! NILP (c
) && (kb
!= current_kboard
))
2767 Lisp_Object link
= kb
->kbd_queue
;
2770 while (CONSP (XCDR (link
)))
2772 if (!NILP (XCDR (link
)))
2776 kb
->kbd_queue
= Fcons (c
, Qnil
);
2778 XSETCDR (link
, Fcons (c
, Qnil
));
2779 kb
->kbd_queue_has_data
= 1;
2783 current_kboard
= kb
;
2784 /* This is going to exit from read_char
2785 so we had better get rid of this frame's stuff. */
2787 longjmp (wrong_kboard_jmpbuf
, 1);
2792 /* Terminate Emacs in batch mode if at eof. */
2793 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2794 Fkill_emacs (make_number (1));
2798 /* Add in any extra modifiers, where appropriate. */
2799 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2800 || ((extra_keyboard_modifiers
& 0177) < ' '
2801 && (extra_keyboard_modifiers
& 0177) != 0))
2802 XSETINT (c
, make_ctrl_char (XINT (c
)));
2804 /* Transfer any other modifier bits directly from
2805 extra_keyboard_modifiers to c. Ignore the actual character code
2806 in the low 16 bits of extra_keyboard_modifiers. */
2807 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2812 /* Record the last idle start time so that we can reset it
2813 should the next event read be a help-echo. */
2814 last_idle_start
= timer_idleness_start_time
;
2820 if (commandflag
>= 0
2821 && !input_pending
&& !detect_input_pending_run_timers (0))
2829 /* Buffer switch events are only for internal wakeups
2830 so don't show them to the user.
2831 Also, don't record a key if we already did. */
2832 if (BUFFERP (c
) || key_already_recorded
)
2835 /* Process special events within read_char
2836 and loop around to read another event. */
2839 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2844 int was_locked
= single_kboard
;
2846 last_input_char
= c
;
2847 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2849 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2850 /* We stopped being idle for this event; undo that. This
2851 prevents automatic window selection (under
2852 mouse_autoselect_window from acting as a real input event, for
2853 example banishing the mouse under mouse-avoidance-mode. */
2854 timer_idleness_start_time
= last_idle_start
;
2856 /* Resume allowing input from any kboard, if that was true before. */
2858 any_kboard_state ();
2863 /* Handle things that only apply to characters. */
2866 /* If kbd_buffer_get_event gave us an EOF, return that. */
2870 if ((STRINGP (Vkeyboard_translate_table
)
2871 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2872 || (VECTORP (Vkeyboard_translate_table
)
2873 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2874 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2875 && CHAR_VALID_P (XINT (c
), 0)))
2878 d
= Faref (Vkeyboard_translate_table
, c
);
2879 /* nil in keyboard-translate-table means no translation. */
2885 /* If this event is a mouse click in the menu bar,
2886 return just menu-bar for now. Modify the mouse click event
2887 so we won't do this twice, then queue it up. */
2888 if (EVENT_HAS_PARAMETERS (c
)
2890 && CONSP (EVENT_START (c
))
2891 && CONSP (XCDR (EVENT_START (c
))))
2895 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2896 /* Handle menu-bar events:
2897 insert the dummy prefix event `menu-bar'. */
2898 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2900 /* Change menu-bar to (menu-bar) as the event "position". */
2901 POSN_BUFFER_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2904 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2909 /* Store these characters into recent_keys, the dribble file if any,
2910 and the keyboard macro being defined, if any. */
2912 if (! NILP (also_record
))
2913 record_char (also_record
);
2915 /* Wipe the echo area.
2916 But first, if we are about to use an input method,
2917 save the echo area contents for it to refer to. */
2919 && ! NILP (Vinput_method_function
)
2920 && (unsigned) XINT (c
) >= ' '
2921 && (unsigned) XINT (c
) != 127
2922 && (unsigned) XINT (c
) < 256)
2924 previous_echo_area_message
= Fcurrent_message ();
2925 Vinput_method_previous_message
= previous_echo_area_message
;
2928 /* Now wipe the echo area, except for help events which do their
2929 own stuff with the echo area. */
2931 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2932 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2934 if (!NILP (echo_area_buffer
[0]))
2935 safe_run_hooks (Qecho_area_clear_hook
);
2936 clear_message (1, 0);
2939 reread_for_input_method
:
2941 /* Pass this to the input method, if appropriate. */
2943 && ! NILP (Vinput_method_function
)
2944 /* Don't run the input method within a key sequence,
2945 after the first event of the key sequence. */
2946 && NILP (prev_event
)
2947 && (unsigned) XINT (c
) >= ' '
2948 && (unsigned) XINT (c
) != 127
2949 && (unsigned) XINT (c
) < 256)
2953 struct gcpro gcpro1
;
2954 int count
= SPECPDL_INDEX ();
2956 /* Save the echo status. */
2957 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2958 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2959 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2962 if (before_command_restore_flag
)
2964 this_command_key_count
= before_command_key_count_1
;
2965 if (this_command_key_count
< this_single_command_key_start
)
2966 this_single_command_key_start
= this_command_key_count
;
2967 echo_truncate (before_command_echo_length_1
);
2968 before_command_restore_flag
= 0;
2972 /* Save the this_command_keys status. */
2973 key_count
= this_command_key_count
;
2976 keys
= Fcopy_sequence (this_command_keys
);
2981 /* Clear out this_command_keys. */
2982 this_command_key_count
= 0;
2984 /* Now wipe the echo area. */
2985 if (!NILP (echo_area_buffer
[0]))
2986 safe_run_hooks (Qecho_area_clear_hook
);
2987 clear_message (1, 0);
2990 /* If we are not reading a key sequence,
2991 never use the echo area. */
2994 specbind (Qinput_method_use_echo_area
, Qt
);
2997 /* Call the input method. */
2998 tem
= call1 (Vinput_method_function
, c
);
3000 tem
= unbind_to (count
, tem
);
3002 /* Restore the saved echoing state
3003 and this_command_keys state. */
3004 this_command_key_count
= key_count
;
3006 this_command_keys
= keys
;
3009 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3010 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3011 if (saved_immediate_echo
)
3016 /* The input method can return no events. */
3019 /* Bring back the previous message, if any. */
3020 if (! NILP (previous_echo_area_message
))
3021 message_with_string ("%s", previous_echo_area_message
, 0);
3024 /* It returned one event or more. */
3026 Vunread_post_input_method_events
3027 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3032 /* Display help if not echoing. */
3033 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3035 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3036 Lisp_Object help
, object
, position
, window
, tem
;
3038 tem
= Fcdr (XCDR (c
));
3041 window
= Fcar (tem
);
3043 object
= Fcar (tem
);
3045 position
= Fcar (tem
);
3047 show_help_echo (help
, window
, object
, position
, 0);
3049 /* We stopped being idle for this event; undo that. */
3050 timer_idleness_start_time
= last_idle_start
;
3054 if (this_command_key_count
== 0 || ! reread
)
3057 /* Don't echo mouse motion events. */
3058 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3059 && NILP (Fzerop (Vecho_keystrokes
))
3060 && ! (EVENT_HAS_PARAMETERS (c
)
3061 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3064 if (! NILP (also_record
))
3065 echo_char (also_record
);
3066 /* Once we reread a character, echoing can happen
3067 the next time we pause to read a new one. */
3068 ok_to_echo_at_next_pause
= current_kboard
;
3071 /* Record this character as part of the current key. */
3072 add_command_key (c
);
3073 if (! NILP (also_record
))
3074 add_command_key (also_record
);
3077 last_input_char
= c
;
3080 /* Process the help character specially if enabled */
3081 if (!NILP (Vhelp_form
) && help_char_p (c
))
3084 count
= SPECPDL_INDEX ();
3086 record_unwind_protect (Fset_window_configuration
,
3087 Fcurrent_window_configuration (Qnil
));
3089 tem0
= Feval (Vhelp_form
);
3091 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3095 c
= read_char (0, 0, 0, Qnil
, 0);
3096 while (BUFFERP (c
));
3097 /* Remove the help from the frame */
3098 unbind_to (count
, Qnil
);
3101 if (EQ (c
, make_number (040)))
3105 c
= read_char (0, 0, 0, Qnil
, 0);
3106 while (BUFFERP (c
));
3115 /* Record a key that came from a mouse menu.
3116 Record it for echoing, for this-command-keys, and so on. */
3122 /* Wipe the echo area. */
3123 clear_message (1, 0);
3128 before_command_key_count
= this_command_key_count
;
3129 before_command_echo_length
= echo_length ();
3132 /* Don't echo mouse motion events. */
3133 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3134 && NILP (Fzerop (Vecho_keystrokes
)))
3138 /* Once we reread a character, echoing can happen
3139 the next time we pause to read a new one. */
3140 ok_to_echo_at_next_pause
= 0;
3143 /* Record this character as part of the current key. */
3144 add_command_key (c
);
3146 /* Re-reading in the middle of a command */
3147 last_input_char
= c
;
3151 /* Return 1 if should recognize C as "the help character". */
3159 if (EQ (c
, Vhelp_char
))
3161 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3162 if (EQ (c
, XCAR (tail
)))
3167 /* Record the input event C in various ways. */
3175 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3177 /* To avoid filling recent_keys with help-echo and mouse-movement
3178 events, we filter out repeated help-echo events, only store the
3179 first and last in a series of mouse-movement events, and don't
3180 store repeated help-echo events which are only separated by
3181 mouse-movement events. */
3183 Lisp_Object ev1
, ev2
, ev3
;
3186 if ((ix1
= recent_keys_index
- 1) < 0)
3187 ix1
= NUM_RECENT_KEYS
- 1;
3188 ev1
= AREF (recent_keys
, ix1
);
3190 if ((ix2
= ix1
- 1) < 0)
3191 ix2
= NUM_RECENT_KEYS
- 1;
3192 ev2
= AREF (recent_keys
, ix2
);
3194 if ((ix3
= ix2
- 1) < 0)
3195 ix3
= NUM_RECENT_KEYS
- 1;
3196 ev3
= AREF (recent_keys
, ix3
);
3198 if (EQ (XCAR (c
), Qhelp_echo
))
3200 /* Don't record `help-echo' in recent_keys unless it shows some help
3201 message, and a different help than the previously recorded
3203 Lisp_Object help
, last_help
;
3205 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3206 if (!STRINGP (help
))
3208 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3209 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3211 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3212 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3213 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3215 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3216 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3217 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3218 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3221 else if (EQ (XCAR (c
), Qmouse_movement
))
3223 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3224 So additional mouse movement events replace the last element. */
3225 Lisp_Object last_window
, window
;
3227 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3228 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3229 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3230 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3231 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3233 ASET (recent_keys
, ix1
, c
);
3239 store_kbd_macro_char (c
);
3244 ASET (recent_keys
, recent_keys_index
, c
);
3245 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3246 recent_keys_index
= 0;
3248 else if (recorded
< 0)
3250 /* We need to remove one or two events from recent_keys.
3251 To do this, we simply put nil at those events and move the
3252 recent_keys_index backwards over those events. Usually,
3253 users will never see those nil events, as they will be
3254 overwritten by the command keys entered to see recent_keys
3257 while (recorded
++ < 0 && total_keys
> 0)
3259 if (total_keys
< NUM_RECENT_KEYS
)
3261 if (--recent_keys_index
< 0)
3262 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3263 ASET (recent_keys
, recent_keys_index
, Qnil
);
3267 num_nonmacro_input_events
++;
3269 /* Write c to the dribble file. If c is a lispy event, write
3270 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3271 If you, dear reader, have a better idea, you've got the source. :-) */
3276 if (XUINT (c
) < 0x100)
3277 putc (XINT (c
), dribble
);
3279 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3283 Lisp_Object dribblee
;
3285 /* If it's a structured event, take the event header. */
3286 dribblee
= EVENT_HEAD (c
);
3288 if (SYMBOLP (dribblee
))
3290 putc ('<', dribble
);
3291 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3292 SBYTES (SYMBOL_NAME (dribblee
)),
3294 putc ('>', dribble
);
3306 struct buffer
*old
= current_buffer
;
3307 Fprinc (object
, Qnil
);
3308 set_buffer_internal (XBUFFER (Vstandard_output
));
3309 call0 (intern ("help-mode"));
3310 set_buffer_internal (old
);
3314 /* Copy out or in the info on where C-g should throw to.
3315 This is used when running Lisp code from within get_char,
3316 in case get_char is called recursively.
3317 See read_process_output. */
3323 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3327 restore_getcjmp (temp
)
3330 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3335 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3336 of this function. */
3339 tracking_off (old_value
)
3340 Lisp_Object old_value
;
3342 do_mouse_tracking
= old_value
;
3343 if (NILP (old_value
))
3345 /* Redisplay may have been preempted because there was input
3346 available, and it assumes it will be called again after the
3347 input has been processed. If the only input available was
3348 the sort that we have just disabled, then we need to call
3350 if (!readable_events (1))
3352 redisplay_preserve_echo_area (6);
3353 get_input_pending (&input_pending
, 1);
3359 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3360 doc
: /* Evaluate BODY with mouse movement events enabled.
3361 Within a `track-mouse' form, mouse motion generates input events that
3362 you can read with `read-event'.
3363 Normally, mouse motion is ignored.
3364 usage: (track-mouse BODY ...) */)
3368 int count
= SPECPDL_INDEX ();
3371 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3373 do_mouse_tracking
= Qt
;
3375 val
= Fprogn (args
);
3376 return unbind_to (count
, val
);
3379 /* If mouse has moved on some frame, return one of those frames.
3380 Return 0 otherwise. */
3385 Lisp_Object tail
, frame
;
3387 FOR_EACH_FRAME (tail
, frame
)
3389 if (XFRAME (frame
)->mouse_moved
)
3390 return XFRAME (frame
);
3396 #endif /* HAVE_MOUSE */
3398 /* Low level keyboard/mouse input.
3399 kbd_buffer_store_event places events in kbd_buffer, and
3400 kbd_buffer_get_event retrieves them. */
3402 /* Return true iff there are any events in the queue that read-char
3403 would return. If this returns false, a read-char would block. */
3405 readable_filtered_events (do_timers_now
, filter_events
)
3410 timer_check (do_timers_now
);
3412 /* If the buffer contains only FOCUS_IN_EVENT events,
3413 and FILTER_EVENTS is nonzero, report it as empty. */
3414 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3416 int have_live_event
= 1;
3420 struct input_event
*event
;
3422 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3426 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3429 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3431 if (event
== kbd_store_ptr
)
3432 have_live_event
= 0;
3435 if (have_live_event
) return 1;
3439 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3444 if (current_kboard
->kbd_queue_has_data
)
3450 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3451 if (kb
->kbd_queue_has_data
)
3457 /* Return true iff there are any events in the queue that read-char
3458 would return. If this returns false, a read-char would block. */
3460 readable_events (do_timers_now
)
3463 return readable_filtered_events (do_timers_now
, 0);
3466 /* Set this for debugging, to have a way to get out */
3471 event_to_kboard (event
)
3472 struct input_event
*event
;
3475 frame
= event
->frame_or_window
;
3477 frame
= XCAR (frame
);
3478 else if (WINDOWP (frame
))
3479 frame
= WINDOW_FRAME (XWINDOW (frame
));
3481 /* There are still some events that don't set this field.
3482 For now, just ignore the problem.
3483 Also ignore dead frames here. */
3484 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3487 return FRAME_KBOARD (XFRAME (frame
));
3491 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3494 kbd_buffer_store_event (event
)
3495 register struct input_event
*event
;
3497 if (event
->kind
== NO_EVENT
)
3500 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3502 register int c
= event
->code
& 0377;
3504 if (event
->modifiers
& ctrl_modifier
)
3505 c
= make_ctrl_char (c
);
3507 c
|= (event
->modifiers
3508 & (meta_modifier
| alt_modifier
3509 | hyper_modifier
| super_modifier
));
3515 struct input_event
*sp
;
3518 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3519 kb
!= current_kboard
))
3522 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3523 Fcons (make_number (c
), Qnil
));
3524 kb
->kbd_queue_has_data
= 1;
3525 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3527 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3530 if (event_to_kboard (sp
) == kb
)
3532 sp
->kind
= NO_EVENT
;
3533 sp
->frame_or_window
= Qnil
;
3541 /* If this results in a quit_char being returned to Emacs as
3542 input, set Vlast_event_frame properly. If this doesn't
3543 get returned to Emacs as an event, the next event read
3544 will set Vlast_event_frame again, so this is safe to do. */
3548 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3550 focus
= event
->frame_or_window
;
3551 internal_last_event_frame
= focus
;
3552 Vlast_event_frame
= focus
;
3555 last_event_timestamp
= event
->timestamp
;
3556 interrupt_signal (0 /* dummy */);
3560 if (c
&& c
== stop_character
)
3566 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3567 Just ignore the second one. */
3568 else if (event
->kind
== BUFFER_SWITCH_EVENT
3569 && kbd_fetch_ptr
!= kbd_store_ptr
3570 && kbd_store_ptr
->kind
== BUFFER_SWITCH_EVENT
)
3573 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3574 kbd_store_ptr
= kbd_buffer
;
3576 /* Don't let the very last slot in the buffer become full,
3577 since that would make the two pointers equal,
3578 and that is indistinguishable from an empty buffer.
3579 Discard the event if it would fill the last slot. */
3580 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3584 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3585 prone to assign individual members for other events, in case
3586 the input_event structure is changed. --2000-07-13, gerd. */
3587 struct input_event
*sp
= kbd_store_ptr
;
3588 sp
->kind
= event
->kind
;
3589 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3591 /* We must not use the ordinary copying code for this case,
3592 since `part' is an enum and copying it might not copy enough
3594 bcopy (event
, (char *) sp
, sizeof (*event
));
3599 sp
->code
= event
->code
;
3600 sp
->part
= event
->part
;
3601 sp
->frame_or_window
= event
->frame_or_window
;
3602 sp
->arg
= event
->arg
;
3603 sp
->modifiers
= event
->modifiers
;
3606 sp
->timestamp
= event
->timestamp
;
3609 *kbd_store_ptr
= *event
;
3612 idx
= 2 * (kbd_store_ptr
- kbd_buffer
);
3613 ASET (kbd_buffer_gcpro
, idx
, event
->frame_or_window
);
3614 ASET (kbd_buffer_gcpro
, idx
+ 1, event
->arg
);
3620 /* Generate HELP_EVENT input_events in BUFP which has room for
3621 SIZE events. If there's not enough room in BUFP, ignore this
3624 HELP is the help form.
3626 FRAME is the frame on which the help is generated. OBJECT is the
3627 Lisp object where the help was found (a buffer, a string, an
3628 overlay, or nil if neither from a string nor from a buffer. POS is
3629 the position within OBJECT where the help was found.
3631 Value is the number of input_events generated. */
3634 gen_help_event (bufp
, size
, help
, frame
, window
, object
, pos
)
3635 struct input_event
*bufp
;
3637 Lisp_Object help
, frame
, object
, window
;
3642 bufp
->kind
= HELP_EVENT
;
3643 bufp
->frame_or_window
= frame
;
3645 bufp
->x
= WINDOWP (window
) ? window
: frame
;
3654 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3657 kbd_buffer_store_help_event (frame
, help
)
3658 Lisp_Object frame
, help
;
3660 struct input_event event
;
3662 event
.kind
= HELP_EVENT
;
3663 event
.frame_or_window
= frame
;
3668 kbd_buffer_store_event (&event
);
3672 /* Discard any mouse events in the event buffer by setting them to
3675 discard_mouse_events ()
3677 struct input_event
*sp
;
3678 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3680 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3683 if (sp
->kind
== MOUSE_CLICK_EVENT
3685 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3687 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3689 sp
->kind
= NO_EVENT
;
3695 /* Return non-zero if there are any real events waiting in the event
3696 buffer, not counting `NO_EVENT's.
3698 If DISCARD is non-zero, discard NO_EVENT events at the front of
3699 the input queue, possibly leaving the input queue empty if there
3700 are no real input events. */
3703 kbd_buffer_events_waiting (discard
)
3706 struct input_event
*sp
;
3708 for (sp
= kbd_fetch_ptr
;
3709 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3712 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3719 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3723 /* Clear input event EVENT. */
3727 struct input_event
*event
;
3729 int idx
= 2 * (event
- kbd_buffer
);
3730 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
3731 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
3732 event
->kind
= NO_EVENT
;
3736 /* Read one event from the event buffer, waiting if necessary.
3737 The value is a Lisp object representing the event.
3738 The value is nil for an event that should be ignored,
3739 or that was handled here.
3740 We always read and discard one event. */
3743 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3745 int *used_mouse_menu
;
3754 *kbp
= current_kboard
;
3758 /* Wait until there is input available. */
3761 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3764 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3768 /* If the quit flag is set, then read_char will return
3769 quit_char, so that counts as "available input." */
3770 if (!NILP (Vquit_flag
))
3771 quit_throw_to_read_char ();
3773 /* One way or another, wait until input is available; then, if
3774 interrupt handlers have not read it, read it now. */
3777 wait_for_kbd_input ();
3779 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3783 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3786 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3790 Lisp_Object minus_one
;
3792 XSETINT (minus_one
, -1);
3793 wait_reading_process_input (0, 0, minus_one
, 1);
3795 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3796 /* Pass 1 for EXPECT since we just waited to have input. */
3797 read_avail_input (1);
3799 #endif /* not VMS */
3802 if (CONSP (Vunread_command_events
))
3805 first
= XCAR (Vunread_command_events
);
3806 Vunread_command_events
= XCDR (Vunread_command_events
);
3807 *kbp
= current_kboard
;
3811 /* At this point, we know that there is a readable event available
3812 somewhere. If the event queue is empty, then there must be a
3813 mouse movement enabled and available. */
3814 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3816 struct input_event
*event
;
3818 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3822 last_event_timestamp
= event
->timestamp
;
3825 *kbp
= event_to_kboard (event
);
3827 *kbp
= current_kboard
; /* Better than returning null ptr? */
3829 *kbp
= &the_only_kboard
;
3834 /* These two kinds of events get special handling
3835 and don't actually appear to the command loop.
3836 We return nil for them. */
3837 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3840 struct input_event copy
;
3842 /* Remove it from the buffer before processing it,
3843 since otherwise swallow_events will see it
3844 and process it again. */
3846 kbd_fetch_ptr
= event
+ 1;
3847 input_pending
= readable_events (0);
3848 x_handle_selection_request (©
);
3850 /* We're getting selection request events, but we don't have
3856 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3859 struct input_event copy
;
3861 /* Remove it from the buffer before processing it. */
3863 kbd_fetch_ptr
= event
+ 1;
3864 input_pending
= readable_events (0);
3865 x_handle_selection_clear (©
);
3867 /* We're getting selection request events, but we don't have
3872 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3873 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3875 /* Make an event (delete-frame (FRAME)). */
3876 obj
= Fcons (event
->frame_or_window
, Qnil
);
3877 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3878 kbd_fetch_ptr
= event
+ 1;
3881 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3882 else if (event
->kind
== ICONIFY_EVENT
)
3884 /* Make an event (iconify-frame (FRAME)). */
3885 obj
= Fcons (event
->frame_or_window
, Qnil
);
3886 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3887 kbd_fetch_ptr
= event
+ 1;
3889 else if (event
->kind
== DEICONIFY_EVENT
)
3891 /* Make an event (make-frame-visible (FRAME)). */
3892 obj
= Fcons (event
->frame_or_window
, Qnil
);
3893 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3894 kbd_fetch_ptr
= event
+ 1;
3897 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3899 /* The value doesn't matter here; only the type is tested. */
3900 XSETBUFFER (obj
, current_buffer
);
3901 kbd_fetch_ptr
= event
+ 1;
3903 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
3904 || defined (USE_GTK)
3905 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3907 kbd_fetch_ptr
= event
+ 1;
3908 input_pending
= readable_events (0);
3909 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3910 x_activate_menubar (XFRAME (event
->frame_or_window
));
3914 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3916 /* Make an event (language-change (FRAME CHARSET LCID)). */
3917 obj
= Fcons (event
->modifiers
, Qnil
);
3918 obj
= Fcons (event
->code
, obj
);
3919 obj
= Fcons (event
->frame_or_window
, obj
);
3920 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3921 kbd_fetch_ptr
= event
+ 1;
3924 else if (event
->kind
== SAVE_SESSION_EVENT
)
3926 obj
= Fcons (Qsave_session
, Qnil
);
3927 kbd_fetch_ptr
= event
+ 1;
3929 /* Just discard these, by returning nil.
3930 With MULTI_KBOARD, these events are used as placeholders
3931 when we need to randomly delete events from the queue.
3932 (They shouldn't otherwise be found in the buffer,
3933 but on some machines it appears they do show up
3934 even without MULTI_KBOARD.) */
3935 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3936 mouse events during a popup-menu call. */
3937 else if (event
->kind
== NO_EVENT
)
3938 kbd_fetch_ptr
= event
+ 1;
3939 else if (event
->kind
== HELP_EVENT
)
3941 Lisp_Object object
, position
, help
, frame
, window
;
3943 frame
= event
->frame_or_window
;
3944 object
= event
->arg
;
3945 position
= make_number (event
->code
);
3948 clear_event (event
);
3950 kbd_fetch_ptr
= event
+ 1;
3951 if (!WINDOWP (window
))
3953 obj
= Fcons (Qhelp_echo
,
3954 list5 (frame
, help
, window
, object
, position
));
3956 else if (event
->kind
== FOCUS_IN_EVENT
)
3958 /* Notification of a FocusIn event. The frame receiving the
3959 focus is in event->frame_or_window. Generate a
3960 switch-frame event if necessary. */
3961 Lisp_Object frame
, focus
;
3963 frame
= event
->frame_or_window
;
3964 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3968 if (!EQ (frame
, internal_last_event_frame
)
3969 && !EQ (frame
, selected_frame
))
3970 obj
= make_lispy_switch_frame (frame
);
3971 internal_last_event_frame
= frame
;
3972 kbd_fetch_ptr
= event
+ 1;
3974 else if (event
->kind
== SELECT_WINDOW_EVENT
)
3976 /* Make an event (select-window (WINDOW)). */
3977 obj
= Fcons (event
->frame_or_window
, Qnil
);
3978 obj
= Fcons (Qselect_window
, Fcons (obj
, Qnil
));
3980 kbd_fetch_ptr
= event
+ 1;
3984 /* If this event is on a different frame, return a switch-frame this
3985 time, and leave the event in the queue for next time. */
3989 frame
= event
->frame_or_window
;
3991 frame
= XCAR (frame
);
3992 else if (WINDOWP (frame
))
3993 frame
= WINDOW_FRAME (XWINDOW (frame
));
3995 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3999 if (! EQ (frame
, internal_last_event_frame
)
4000 && !EQ (frame
, selected_frame
))
4001 obj
= make_lispy_switch_frame (frame
);
4002 internal_last_event_frame
= frame
;
4004 /* If we didn't decide to make a switch-frame event, go ahead
4005 and build a real event from the queue entry. */
4009 obj
= make_lispy_event (event
);
4011 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4012 || defined (USE_GTK)
4013 /* If this was a menu selection, then set the flag to inhibit
4014 writing to last_nonmenu_event. Don't do this if the event
4015 we're returning is (menu-bar), though; that indicates the
4016 beginning of the menu sequence, and we might as well leave
4017 that as the `event with parameters' for this selection. */
4019 && !EQ (event
->frame_or_window
, event
->arg
)
4020 && (event
->kind
== MENU_BAR_EVENT
4021 || event
->kind
== TOOL_BAR_EVENT
))
4022 *used_mouse_menu
= 1;
4025 /* Wipe out this event, to catch bugs. */
4026 clear_event (event
);
4027 kbd_fetch_ptr
= event
+ 1;
4032 /* Try generating a mouse motion event. */
4033 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4035 FRAME_PTR f
= some_mouse_moved ();
4036 Lisp_Object bar_window
;
4037 enum scroll_bar_part part
;
4041 *kbp
= current_kboard
;
4042 /* Note that this uses F to determine which display to look at.
4043 If there is no valid info, it does not store anything
4044 so x remains nil. */
4046 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4050 /* Decide if we should generate a switch-frame event. Don't
4051 generate switch-frame events for motion outside of all Emacs
4057 frame
= FRAME_FOCUS_FRAME (f
);
4059 XSETFRAME (frame
, f
);
4061 if (! EQ (frame
, internal_last_event_frame
)
4062 && !EQ (frame
, selected_frame
))
4063 obj
= make_lispy_switch_frame (frame
);
4064 internal_last_event_frame
= frame
;
4067 /* If we didn't decide to make a switch-frame event, go ahead and
4068 return a mouse-motion event. */
4069 if (!NILP (x
) && NILP (obj
))
4070 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4072 #endif /* HAVE_MOUSE */
4074 /* We were promised by the above while loop that there was
4075 something for us to read! */
4078 input_pending
= readable_events (0);
4080 Vlast_event_frame
= internal_last_event_frame
;
4085 /* Process any events that are not user-visible,
4086 then return, without reading any user-visible events. */
4089 swallow_events (do_display
)
4094 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4096 struct input_event
*event
;
4098 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4102 last_event_timestamp
= event
->timestamp
;
4104 /* These two kinds of events get special handling
4105 and don't actually appear to the command loop. */
4106 if (event
->kind
== SELECTION_REQUEST_EVENT
)
4109 struct input_event copy
;
4111 /* Remove it from the buffer before processing it,
4112 since otherwise swallow_events called recursively could see it
4113 and process it again. */
4115 kbd_fetch_ptr
= event
+ 1;
4116 input_pending
= readable_events (0);
4117 x_handle_selection_request (©
);
4119 /* We're getting selection request events, but we don't have
4125 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
4128 struct input_event copy
;
4130 /* Remove it from the buffer before processing it, */
4133 kbd_fetch_ptr
= event
+ 1;
4134 input_pending
= readable_events (0);
4135 x_handle_selection_clear (©
);
4137 /* We're getting selection request events, but we don't have
4146 old_timers_run
= timers_run
;
4147 get_input_pending (&input_pending
, 1);
4149 if (timers_run
!= old_timers_run
&& do_display
)
4150 redisplay_preserve_echo_area (7);
4153 /* Record the start of when Emacs is idle,
4154 for the sake of running idle-time timers. */
4161 /* If we are already in the idle state, do nothing. */
4162 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4165 EMACS_GET_TIME (timer_idleness_start_time
);
4167 timer_last_idleness_start_time
= timer_idleness_start_time
;
4169 /* Mark all idle-time timers as once again candidates for running. */
4170 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4174 timer
= XCAR (timers
);
4176 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4178 XVECTOR (timer
)->contents
[0] = Qnil
;
4182 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4187 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4190 /* This is only for debugging. */
4191 struct input_event last_timer_event
;
4193 /* Check whether a timer has fired. To prevent larger problems we simply
4194 disregard elements that are not proper timers. Do not make a circular
4195 timer list for the time being.
4197 Returns the number of seconds to wait until the next timer fires. If a
4198 timer is triggering now, return zero seconds.
4199 If no timer is active, return -1 seconds.
4201 If a timer is ripe, we run it, with quitting turned off.
4203 DO_IT_NOW is now ignored. It used to mean that we should
4204 run the timer directly instead of queueing a timer-event.
4205 Now we always run timers directly. */
4208 timer_check (do_it_now
)
4211 EMACS_TIME nexttime
;
4212 EMACS_TIME now
, idleness_now
;
4213 Lisp_Object timers
, idle_timers
, chosen_timer
;
4214 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4216 EMACS_SET_SECS (nexttime
, -1);
4217 EMACS_SET_USECS (nexttime
, -1);
4219 /* Always consider the ordinary timers. */
4220 timers
= Vtimer_list
;
4221 /* Consider the idle timers only if Emacs is idle. */
4222 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4223 idle_timers
= Vtimer_idle_list
;
4226 chosen_timer
= Qnil
;
4227 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4229 if (CONSP (timers
) || CONSP (idle_timers
))
4231 EMACS_GET_TIME (now
);
4232 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4233 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4236 while (CONSP (timers
) || CONSP (idle_timers
))
4238 Lisp_Object
*vector
;
4239 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4240 EMACS_TIME timer_time
, idle_timer_time
;
4241 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4243 /* Skip past invalid timers and timers already handled. */
4246 timer
= XCAR (timers
);
4247 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4249 timers
= XCDR (timers
);
4252 vector
= XVECTOR (timer
)->contents
;
4254 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4255 || !INTEGERP (vector
[3])
4256 || ! NILP (vector
[0]))
4258 timers
= XCDR (timers
);
4262 if (!NILP (idle_timers
))
4264 timer
= XCAR (idle_timers
);
4265 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4267 idle_timers
= XCDR (idle_timers
);
4270 vector
= XVECTOR (timer
)->contents
;
4272 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4273 || !INTEGERP (vector
[3])
4274 || ! NILP (vector
[0]))
4276 idle_timers
= XCDR (idle_timers
);
4281 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4282 based on the next ordinary timer.
4283 TIMER_DIFFERENCE is the distance in time from NOW to when
4284 this timer becomes ripe (negative if it's already ripe). */
4287 timer
= XCAR (timers
);
4288 vector
= XVECTOR (timer
)->contents
;
4289 EMACS_SET_SECS (timer_time
,
4290 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4291 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4292 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4295 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4296 based on the next idle timer. */
4297 if (!NILP (idle_timers
))
4299 idle_timer
= XCAR (idle_timers
);
4300 vector
= XVECTOR (idle_timer
)->contents
;
4301 EMACS_SET_SECS (idle_timer_time
,
4302 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4303 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4304 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4307 /* Decide which timer is the next timer,
4308 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4309 Also step down the list where we found that timer. */
4311 if (! NILP (timers
) && ! NILP (idle_timers
))
4314 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4315 if (EMACS_TIME_NEG_P (temp
))
4317 chosen_timer
= timer
;
4318 timers
= XCDR (timers
);
4319 difference
= timer_difference
;
4323 chosen_timer
= idle_timer
;
4324 idle_timers
= XCDR (idle_timers
);
4325 difference
= idle_timer_difference
;
4328 else if (! NILP (timers
))
4330 chosen_timer
= timer
;
4331 timers
= XCDR (timers
);
4332 difference
= timer_difference
;
4336 chosen_timer
= idle_timer
;
4337 idle_timers
= XCDR (idle_timers
);
4338 difference
= idle_timer_difference
;
4340 vector
= XVECTOR (chosen_timer
)->contents
;
4342 /* If timer is ripe, run it if it hasn't been run. */
4343 if (EMACS_TIME_NEG_P (difference
)
4344 || (EMACS_SECS (difference
) == 0
4345 && EMACS_USECS (difference
) == 0))
4347 if (NILP (vector
[0]))
4349 int was_locked
= single_kboard
;
4350 int count
= SPECPDL_INDEX ();
4351 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4353 /* Mark the timer as triggered to prevent problems if the lisp
4354 code fails to reschedule it right. */
4357 specbind (Qinhibit_quit
, Qt
);
4359 call1 (Qtimer_event_handler
, chosen_timer
);
4360 Vdeactivate_mark
= old_deactivate_mark
;
4362 unbind_to (count
, Qnil
);
4364 /* Resume allowing input from any kboard, if that was true before. */
4366 any_kboard_state ();
4368 /* Since we have handled the event,
4369 we don't need to tell the caller to wake up and do it. */
4373 /* When we encounter a timer that is still waiting,
4374 return the amount of time to wait before it is ripe. */
4381 /* No timers are pending in the future. */
4382 /* Return 0 if we generated an event, and -1 if not. */
4387 /* Caches for modify_event_symbol. */
4388 static Lisp_Object accent_key_syms
;
4389 static Lisp_Object func_key_syms
;
4390 static Lisp_Object mouse_syms
;
4391 #if defined(WINDOWSNT) || defined(MAC_OSX)
4392 static Lisp_Object mouse_wheel_syms
;
4394 static Lisp_Object drag_n_drop_syms
;
4396 /* This is a list of keysym codes for special "accent" characters.
4397 It parallels lispy_accent_keys. */
4399 static int lispy_accent_codes
[] =
4401 #ifdef XK_dead_circumflex
4406 #ifdef XK_dead_grave
4411 #ifdef XK_dead_tilde
4416 #ifdef XK_dead_diaeresis
4421 #ifdef XK_dead_macron
4426 #ifdef XK_dead_degree
4431 #ifdef XK_dead_acute
4436 #ifdef XK_dead_cedilla
4441 #ifdef XK_dead_breve
4446 #ifdef XK_dead_ogonek
4451 #ifdef XK_dead_caron
4456 #ifdef XK_dead_doubleacute
4457 XK_dead_doubleacute
,
4461 #ifdef XK_dead_abovedot
4466 #ifdef XK_dead_abovering
4476 #ifdef XK_dead_belowdot
4481 #ifdef XK_dead_voiced_sound
4482 XK_dead_voiced_sound
,
4486 #ifdef XK_dead_semivoiced_sound
4487 XK_dead_semivoiced_sound
,
4503 /* This is a list of Lisp names for special "accent" characters.
4504 It parallels lispy_accent_codes. */
4506 static char *lispy_accent_keys
[] =
4524 "dead-voiced-sound",
4525 "dead-semivoiced-sound",
4531 #define FUNCTION_KEY_OFFSET 0x0
4533 char *lispy_function_keys
[] =
4537 0, /* VK_LBUTTON 0x01 */
4538 0, /* VK_RBUTTON 0x02 */
4539 "cancel", /* VK_CANCEL 0x03 */
4540 0, /* VK_MBUTTON 0x04 */
4542 0, 0, 0, /* 0x05 .. 0x07 */
4544 "backspace", /* VK_BACK 0x08 */
4545 "tab", /* VK_TAB 0x09 */
4547 0, 0, /* 0x0A .. 0x0B */
4549 "clear", /* VK_CLEAR 0x0C */
4550 "return", /* VK_RETURN 0x0D */
4552 0, 0, /* 0x0E .. 0x0F */
4554 0, /* VK_SHIFT 0x10 */
4555 0, /* VK_CONTROL 0x11 */
4556 0, /* VK_MENU 0x12 */
4557 "pause", /* VK_PAUSE 0x13 */
4558 "capslock", /* VK_CAPITAL 0x14 */
4560 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4562 "escape", /* VK_ESCAPE 0x1B */
4564 0, 0, 0, 0, /* 0x1C .. 0x1F */
4566 0, /* VK_SPACE 0x20 */
4567 "prior", /* VK_PRIOR 0x21 */
4568 "next", /* VK_NEXT 0x22 */
4569 "end", /* VK_END 0x23 */
4570 "home", /* VK_HOME 0x24 */
4571 "left", /* VK_LEFT 0x25 */
4572 "up", /* VK_UP 0x26 */
4573 "right", /* VK_RIGHT 0x27 */
4574 "down", /* VK_DOWN 0x28 */
4575 "select", /* VK_SELECT 0x29 */
4576 "print", /* VK_PRINT 0x2A */
4577 "execute", /* VK_EXECUTE 0x2B */
4578 "snapshot", /* VK_SNAPSHOT 0x2C */
4579 "insert", /* VK_INSERT 0x2D */
4580 "delete", /* VK_DELETE 0x2E */
4581 "help", /* VK_HELP 0x2F */
4583 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4585 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4587 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4589 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4591 0, 0, 0, 0, 0, 0, 0, 0, 0,
4592 0, 0, 0, 0, 0, 0, 0, 0, 0,
4593 0, 0, 0, 0, 0, 0, 0, 0,
4595 "lwindow", /* VK_LWIN 0x5B */
4596 "rwindow", /* VK_RWIN 0x5C */
4597 "apps", /* VK_APPS 0x5D */
4599 0, 0, /* 0x5E .. 0x5F */
4601 "kp-0", /* VK_NUMPAD0 0x60 */
4602 "kp-1", /* VK_NUMPAD1 0x61 */
4603 "kp-2", /* VK_NUMPAD2 0x62 */
4604 "kp-3", /* VK_NUMPAD3 0x63 */
4605 "kp-4", /* VK_NUMPAD4 0x64 */
4606 "kp-5", /* VK_NUMPAD5 0x65 */
4607 "kp-6", /* VK_NUMPAD6 0x66 */
4608 "kp-7", /* VK_NUMPAD7 0x67 */
4609 "kp-8", /* VK_NUMPAD8 0x68 */
4610 "kp-9", /* VK_NUMPAD9 0x69 */
4611 "kp-multiply", /* VK_MULTIPLY 0x6A */
4612 "kp-add", /* VK_ADD 0x6B */
4613 "kp-separator", /* VK_SEPARATOR 0x6C */
4614 "kp-subtract", /* VK_SUBTRACT 0x6D */
4615 "kp-decimal", /* VK_DECIMAL 0x6E */
4616 "kp-divide", /* VK_DIVIDE 0x6F */
4617 "f1", /* VK_F1 0x70 */
4618 "f2", /* VK_F2 0x71 */
4619 "f3", /* VK_F3 0x72 */
4620 "f4", /* VK_F4 0x73 */
4621 "f5", /* VK_F5 0x74 */
4622 "f6", /* VK_F6 0x75 */
4623 "f7", /* VK_F7 0x76 */
4624 "f8", /* VK_F8 0x77 */
4625 "f9", /* VK_F9 0x78 */
4626 "f10", /* VK_F10 0x79 */
4627 "f11", /* VK_F11 0x7A */
4628 "f12", /* VK_F12 0x7B */
4629 "f13", /* VK_F13 0x7C */
4630 "f14", /* VK_F14 0x7D */
4631 "f15", /* VK_F15 0x7E */
4632 "f16", /* VK_F16 0x7F */
4633 "f17", /* VK_F17 0x80 */
4634 "f18", /* VK_F18 0x81 */
4635 "f19", /* VK_F19 0x82 */
4636 "f20", /* VK_F20 0x83 */
4637 "f21", /* VK_F21 0x84 */
4638 "f22", /* VK_F22 0x85 */
4639 "f23", /* VK_F23 0x86 */
4640 "f24", /* VK_F24 0x87 */
4642 0, 0, 0, 0, /* 0x88 .. 0x8B */
4643 0, 0, 0, 0, /* 0x8C .. 0x8F */
4645 "kp-numlock", /* VK_NUMLOCK 0x90 */
4646 "scroll", /* VK_SCROLL 0x91 */
4648 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4649 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4650 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4651 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4652 "kp-end", /* VK_NUMPAD_END 0x96 */
4653 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4654 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4655 "kp-up", /* VK_NUMPAD_UP 0x99 */
4656 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4657 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4658 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4659 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4661 0, 0, /* 0x9E .. 0x9F */
4664 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4665 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4666 * No other API or message will distinguish left and right keys this way.
4670 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4671 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4672 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4673 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4674 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4680 "attn", /* VK_ATTN 0xF6 */
4681 "crsel", /* VK_CRSEL 0xF7 */
4682 "exsel", /* VK_EXSEL 0xF8 */
4683 "ereof", /* VK_EREOF 0xF9 */
4684 "play", /* VK_PLAY 0xFA */
4685 "zoom", /* VK_ZOOM 0xFB */
4686 "noname", /* VK_NONAME 0xFC */
4687 "pa1", /* VK_PA1 0xFD */
4688 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4692 #else /* not HAVE_NTGUI */
4694 /* This should be dealt with in XTread_socket now, and that doesn't
4695 depend on the client system having the Kana syms defined. See also
4696 the XK_kana_A case below. */
4699 static char *lispy_kana_keys
[] =
4701 /* X Keysym value */
4702 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4703 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4704 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4705 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4706 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4707 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4708 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4709 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4710 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4711 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4712 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4713 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4714 "kana-i", "kana-u", "kana-e", "kana-o",
4715 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4716 "prolongedsound", "kana-A", "kana-I", "kana-U",
4717 "kana-E", "kana-O", "kana-KA", "kana-KI",
4718 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4719 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4720 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4721 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4722 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4723 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4724 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4725 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4726 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4727 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4728 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4729 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4731 #endif /* XK_kana_A */
4734 #define FUNCTION_KEY_OFFSET 0xff00
4736 /* You'll notice that this table is arranged to be conveniently
4737 indexed by X Windows keysym values. */
4738 static char *lispy_function_keys
[] =
4740 /* X Keysym value */
4742 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4743 "backspace", "tab", "linefeed", "clear",
4745 0, 0, 0, "pause", /* 0xff10...1f */
4746 0, 0, 0, 0, 0, 0, 0, "escape",
4748 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4749 "romaji", "hiragana", "katakana", "hiragana-katakana",
4750 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4751 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4752 "eisu-toggle", /* 0xff30...3f */
4753 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4754 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4756 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4757 "down", "prior", "next", "end",
4758 "begin", 0, 0, 0, 0, 0, 0, 0,
4759 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4770 "break", /* 0xff6b */
4773 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4774 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4775 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4776 0, 0, 0, 0, 0, 0, 0, 0,
4777 "kp-tab", /* 0xff89 */
4779 "kp-enter", /* 0xff8d */
4781 "kp-f1", /* 0xff91 */
4785 "kp-home", /* 0xff95 */
4790 "kp-prior", /* kp-page-up */
4791 "kp-next", /* kp-page-down */
4797 0, 0, 0, 0, 0, 0, 0, 0, 0,
4798 "kp-multiply", /* 0xffaa */
4803 "kp-divide", /* 0xffaf */
4804 "kp-0", /* 0xffb0 */
4805 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4808 "kp-equal", /* 0xffbd */
4809 "f1", /* 0xffbe */ /* IsFunctionKey */
4811 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4812 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4813 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4814 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4815 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4816 0, 0, 0, 0, 0, 0, 0, 0,
4817 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4818 0, 0, 0, 0, 0, 0, 0, "delete"
4821 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4822 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4824 static char *iso_lispy_function_keys
[] =
4826 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4827 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4828 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4829 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4830 "iso-lefttab", /* 0xfe20 */
4831 "iso-move-line-up", "iso-move-line-down",
4832 "iso-partial-line-up", "iso-partial-line-down",
4833 "iso-partial-space-left", "iso-partial-space-right",
4834 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4835 "iso-release-margin-left", "iso-release-margin-right",
4836 "iso-release-both-margins",
4837 "iso-fast-cursor-left", "iso-fast-cursor-right",
4838 "iso-fast-cursor-up", "iso-fast-cursor-down",
4839 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4840 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4843 #endif /* not HAVE_NTGUI */
4845 Lisp_Object Vlispy_mouse_stem
;
4847 #if defined(WINDOWSNT) || defined(MAC_OSX)
4848 /* mouse-wheel events are generated by the wheel on devices such as
4849 the MS Intellimouse. The wheel sits in between the left and right
4850 mouse buttons, and is typically used to scroll or zoom the window
4851 underneath the pointer. mouse-wheel events specify the object on
4852 which they operate, and a delta corresponding to the amount and
4853 direction that the wheel is rotated. Clicking the mouse-wheel
4854 generates a mouse-2 event. */
4855 static char *lispy_mouse_wheel_names
[] =
4860 #endif /* WINDOWSNT */
4862 /* drag-n-drop events are generated when a set of selected files are
4863 dragged from another application and dropped onto an Emacs window. */
4864 static char *lispy_drag_n_drop_names
[] =
4869 /* Scroll bar parts. */
4870 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4871 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4872 Lisp_Object Qtop
, Qratio
;
4874 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4875 Lisp_Object
*scroll_bar_parts
[] = {
4876 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4877 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4880 /* User signal events. */
4881 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4883 Lisp_Object
*lispy_user_signals
[] =
4885 &Qusr1_signal
, &Qusr2_signal
4889 /* A vector, indexed by button number, giving the down-going location
4890 of currently depressed buttons, both scroll bar and non-scroll bar.
4892 The elements have the form
4893 (BUTTON-NUMBER MODIFIER-MASK . REST)
4894 where REST is the cdr of a position as it would be reported in the event.
4896 The make_lispy_event function stores positions here to tell the
4897 difference between click and drag events, and to store the starting
4898 location to be included in drag events. */
4900 static Lisp_Object button_down_location
;
4902 /* Information about the most recent up-going button event: Which
4903 button, what location, and what time. */
4905 static int last_mouse_button
;
4906 static int last_mouse_x
;
4907 static int last_mouse_y
;
4908 static unsigned long button_down_time
;
4910 /* The maximum time between clicks to make a double-click, or Qnil to
4911 disable double-click detection, or Qt for no time limit. */
4913 Lisp_Object Vdouble_click_time
;
4915 /* Maximum number of pixels the mouse may be moved between clicks
4916 to make a double-click. */
4918 EMACS_INT double_click_fuzz
;
4920 /* The number of clicks in this multiple-click. */
4922 int double_click_count
;
4924 /* Given a struct input_event, build the lisp event which represents
4925 it. If EVENT is 0, build a mouse movement event from the mouse
4926 movement buffer, which should have a movement event in it.
4928 Note that events must be passed to this function in the order they
4929 are received; this function stores the location of button presses
4930 in order to build drag events when the button is released. */
4933 make_lispy_event (event
)
4934 struct input_event
*event
;
4938 switch (SWITCH_ENUM_CAST (event
->kind
))
4940 /* A simple keystroke. */
4941 case ASCII_KEYSTROKE_EVENT
:
4943 Lisp_Object lispy_c
;
4944 int c
= event
->code
& 0377;
4945 /* Turn ASCII characters into control characters
4947 if (event
->modifiers
& ctrl_modifier
)
4948 c
= make_ctrl_char (c
);
4950 /* Add in the other modifier bits. We took care of ctrl_modifier
4951 just above, and the shift key was taken care of by the X code,
4952 and applied to control characters by make_ctrl_char. */
4953 c
|= (event
->modifiers
4954 & (meta_modifier
| alt_modifier
4955 | hyper_modifier
| super_modifier
));
4956 /* Distinguish Shift-SPC from SPC. */
4957 if ((event
->code
& 0377) == 040
4958 && event
->modifiers
& shift_modifier
)
4959 c
|= shift_modifier
;
4960 button_down_time
= 0;
4961 XSETFASTINT (lispy_c
, c
);
4965 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
4967 Lisp_Object lispy_c
;
4969 XSETFASTINT (lispy_c
, event
->code
);
4973 /* A function key. The symbol may need to have modifier prefixes
4975 case NON_ASCII_KEYSTROKE_EVENT
:
4976 button_down_time
= 0;
4978 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
4979 if (event
->code
== lispy_accent_codes
[i
])
4980 return modify_event_symbol (i
,
4982 Qfunction_key
, Qnil
,
4983 lispy_accent_keys
, &accent_key_syms
,
4984 (sizeof (lispy_accent_keys
)
4985 / sizeof (lispy_accent_keys
[0])));
4989 if (event
->code
>= 0x400 && event
->code
< 0x500)
4990 return modify_event_symbol (event
->code
- 0x400,
4991 event
->modifiers
& ~shift_modifier
,
4992 Qfunction_key
, Qnil
,
4993 lispy_kana_keys
, &func_key_syms
,
4994 (sizeof (lispy_kana_keys
)
4995 / sizeof (lispy_kana_keys
[0])));
4996 #endif /* XK_kana_A */
4999 #ifdef ISO_FUNCTION_KEY_OFFSET
5000 if (event
->code
< FUNCTION_KEY_OFFSET
5001 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5002 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5004 Qfunction_key
, Qnil
,
5005 iso_lispy_function_keys
, &func_key_syms
,
5006 (sizeof (iso_lispy_function_keys
)
5007 / sizeof (iso_lispy_function_keys
[0])));
5010 /* Handle system-specific or unknown keysyms. */
5011 if (event
->code
& (1 << 28)
5012 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5013 || (event
->code
- FUNCTION_KEY_OFFSET
5014 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5015 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5017 /* We need to use an alist rather than a vector as the cache
5018 since we can't make a vector long enuf. */
5019 if (NILP (current_kboard
->system_key_syms
))
5020 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5021 return modify_event_symbol (event
->code
,
5024 current_kboard
->Vsystem_key_alist
,
5025 0, ¤t_kboard
->system_key_syms
,
5029 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5031 Qfunction_key
, Qnil
,
5032 lispy_function_keys
, &func_key_syms
,
5033 (sizeof (lispy_function_keys
)
5034 / sizeof (lispy_function_keys
[0])));
5037 /* A mouse click. Figure out where it is, decide whether it's
5038 a press, click or drag, and build the appropriate structure. */
5039 case MOUSE_CLICK_EVENT
:
5040 #ifndef USE_TOOLKIT_SCROLL_BARS
5041 case SCROLL_BAR_CLICK_EVENT
:
5044 int button
= event
->code
;
5046 Lisp_Object position
;
5047 Lisp_Object
*start_pos_ptr
;
5048 Lisp_Object start_pos
;
5053 /* Build the position as appropriate for this mouse click. */
5054 if (event
->kind
== MOUSE_CLICK_EVENT
)
5057 struct frame
*f
= XFRAME (event
->frame_or_window
);
5059 Lisp_Object string_info
= Qnil
;
5062 /* Ignore mouse events that were made on frame that
5063 have been deleted. */
5064 if (! FRAME_LIVE_P (f
))
5067 /* EVENT->x and EVENT->y are frame-relative pixel
5068 coordinates at this place. Under old redisplay, COLUMN
5069 and ROW are set to frame relative glyph coordinates
5070 which are then used to determine whether this click is
5071 in a menu (non-toolkit version). */
5072 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5073 &column
, &row
, NULL
, 1);
5075 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5076 /* In the non-toolkit version, clicks on the menu bar
5077 are ordinary button events in the event buffer.
5078 Distinguish them, and invoke the menu.
5080 (In the toolkit version, the toolkit handles the menu bar
5081 and Emacs doesn't know about it until after the user
5082 makes a selection.) */
5083 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5084 && (event
->modifiers
& down_modifier
))
5086 Lisp_Object items
, item
;
5091 /* Activate the menu bar on the down event. If the
5092 up event comes in before the menu code can deal with it,
5094 if (! (event
->modifiers
& down_modifier
))
5098 /* Find the menu bar item under `column'. */
5100 items
= FRAME_MENU_BAR_ITEMS (f
);
5101 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5103 Lisp_Object pos
, string
;
5104 string
= AREF (items
, i
+ 1);
5105 pos
= AREF (items
, i
+ 3);
5108 if (column
>= XINT (pos
)
5109 && column
< XINT (pos
) + SCHARS (string
))
5111 item
= AREF (items
, i
);
5116 /* ELisp manual 2.4b says (x y) are window relative but
5117 code says they are frame-relative. */
5119 = Fcons (event
->frame_or_window
,
5121 Fcons (Fcons (event
->x
, event
->y
),
5122 Fcons (make_number (event
->timestamp
),
5125 return Fcons (item
, Fcons (position
, Qnil
));
5127 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5129 /* Set `window' to the window under frame pixel coordinates
5130 event->x/event->y. */
5131 window
= window_from_coordinates (f
, XINT (event
->x
),
5132 XINT (event
->y
), &part
, 0);
5134 if (!WINDOWP (window
))
5136 window
= event
->frame_or_window
;
5141 /* It's a click in window window at frame coordinates
5142 event->x/ event->y. */
5143 struct window
*w
= XWINDOW (window
);
5145 /* Get window relative coordinates. Original code
5146 `rounded' this to glyph boundaries. */
5147 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
5148 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
5150 /* Set event coordinates to window-relative coordinates
5151 for constructing the Lisp event below. */
5152 XSETINT (event
->x
, wx
);
5153 XSETINT (event
->y
, wy
);
5155 if (part
== 1 || part
== 3)
5157 /* Mode line or header line. Look for a string under
5158 the mouse that may have a `local-map' property. */
5162 posn
= part
== 1 ? Qmode_line
: Qheader_line
;
5163 string
= mode_line_string (w
, wx
, wy
, part
== 1, &charpos
);
5164 if (STRINGP (string
))
5165 string_info
= Fcons (string
, make_number (charpos
));
5168 posn
= Qvertical_line
;
5169 else if (part
== 6 || part
== 7)
5172 Lisp_Object object
= marginal_area_string (w
, wx
, wy
, part
,
5174 posn
= (part
== 6) ? Qleft_margin
: Qright_margin
;
5175 if (STRINGP (object
))
5176 string_info
= Fcons (object
, make_number (charpos
));
5181 struct display_pos p
;
5182 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5183 posn
= make_number (CHARPOS (p
.pos
));
5184 if (STRINGP (object
))
5187 make_number (CHARPOS (p
.string_pos
)));
5194 Fcons (Fcons (event
->x
, event
->y
),
5195 Fcons (make_number (event
->timestamp
),
5198 : Fcons (string_info
, Qnil
))))));
5200 #ifndef USE_TOOLKIT_SCROLL_BARS
5203 /* It's a scrollbar click. */
5204 Lisp_Object portion_whole
;
5207 window
= event
->frame_or_window
;
5208 portion_whole
= Fcons (event
->x
, event
->y
);
5209 part
= *scroll_bar_parts
[(int) event
->part
];
5213 Fcons (Qvertical_scroll_bar
,
5214 Fcons (portion_whole
,
5215 Fcons (make_number (event
->timestamp
),
5216 Fcons (part
, Qnil
)))));
5218 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5220 if (button
>= ASIZE (button_down_location
))
5222 button_down_location
= larger_vector (button_down_location
,
5224 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5227 start_pos_ptr
= &AREF (button_down_location
, button
);
5228 start_pos
= *start_pos_ptr
;
5229 *start_pos_ptr
= Qnil
;
5232 /* On window-system frames, use the value of
5233 double-click-fuzz as is. On other frames, interpret it
5234 as a multiple of 1/8 characters. */
5238 if (WINDOWP (event
->frame_or_window
))
5239 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5240 else if (FRAMEP (event
->frame_or_window
))
5241 f
= XFRAME (event
->frame_or_window
);
5245 if (FRAME_WINDOW_P (f
))
5246 fuzz
= double_click_fuzz
;
5248 fuzz
= double_click_fuzz
/ 8;
5250 is_double
= (button
== last_mouse_button
5251 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5252 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5253 && button_down_time
!= 0
5254 && (EQ (Vdouble_click_time
, Qt
)
5255 || (INTEGERP (Vdouble_click_time
)
5256 && ((int)(event
->timestamp
- button_down_time
)
5257 < XINT (Vdouble_click_time
)))));
5260 last_mouse_button
= button
;
5261 last_mouse_x
= XINT (event
->x
);
5262 last_mouse_y
= XINT (event
->y
);
5264 /* If this is a button press, squirrel away the location, so
5265 we can decide later whether it was a click or a drag. */
5266 if (event
->modifiers
& down_modifier
)
5270 double_click_count
++;
5271 event
->modifiers
|= ((double_click_count
> 2)
5276 double_click_count
= 1;
5277 button_down_time
= event
->timestamp
;
5278 *start_pos_ptr
= Fcopy_alist (position
);
5281 /* Now we're releasing a button - check the co-ordinates to
5282 see if this was a click or a drag. */
5283 else if (event
->modifiers
& up_modifier
)
5285 /* If we did not see a down before this up, ignore the up.
5286 Probably this happened because the down event chose a
5287 menu item. It would be an annoyance to treat the
5288 release of the button that chose the menu item as a
5291 if (!CONSP (start_pos
))
5294 event
->modifiers
&= ~up_modifier
;
5295 #if 0 /* Formerly we treated an up with no down as a click event. */
5296 if (!CONSP (start_pos
))
5297 event
->modifiers
|= click_modifier
;
5302 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5304 /* The third element of every position
5305 should be the (x,y) pair. */
5306 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5308 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5310 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5311 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5314 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5315 && ydiff
< double_click_fuzz
5316 && ydiff
> - double_click_fuzz
)
5317 /* Mouse hasn't moved (much). */
5318 event
->modifiers
|= click_modifier
;
5321 button_down_time
= 0;
5322 event
->modifiers
|= drag_modifier
;
5325 /* Don't check is_double; treat this as multiple
5326 if the down-event was multiple. */
5327 if (double_click_count
> 1)
5328 event
->modifiers
|= ((double_click_count
> 2)
5334 /* Every mouse event should either have the down_modifier or
5335 the up_modifier set. */
5339 /* Get the symbol we should use for the mouse click. */
5342 head
= modify_event_symbol (button
,
5344 Qmouse_click
, Vlispy_mouse_stem
,
5347 XVECTOR (mouse_syms
)->size
);
5348 if (event
->modifiers
& drag_modifier
)
5353 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5356 Fcons (make_number (double_click_count
),
5365 #ifdef USE_TOOLKIT_SCROLL_BARS
5367 /* We don't have down and up events if using toolkit scroll bars,
5368 so make this always a click event. Store in the `part' of
5369 the Lisp event a symbol which maps to the following actions:
5371 `above_handle' page up
5372 `below_handle' page down
5376 `bottom' bottom of buffer
5377 `handle' thumb has been dragged.
5378 `end-scroll' end of interaction with scroll bar
5380 The incoming input_event contains in its `part' member an
5381 index of type `enum scroll_bar_part' which we can use as an
5382 index in scroll_bar_parts to get the appropriate symbol. */
5384 case SCROLL_BAR_CLICK_EVENT
:
5386 Lisp_Object position
, head
, window
, portion_whole
, part
;
5388 window
= event
->frame_or_window
;
5389 portion_whole
= Fcons (event
->x
, event
->y
);
5390 part
= *scroll_bar_parts
[(int) event
->part
];
5394 Fcons (Qvertical_scroll_bar
,
5395 Fcons (portion_whole
,
5396 Fcons (make_number (event
->timestamp
),
5397 Fcons (part
, Qnil
)))));
5399 /* Always treat scroll bar events as clicks. */
5400 event
->modifiers
|= click_modifier
;
5401 event
->modifiers
&= ~up_modifier
;
5403 /* Get the symbol we should use for the mouse click. */
5404 head
= modify_event_symbol (event
->code
,
5409 XVECTOR (mouse_syms
)->size
);
5410 return Fcons (head
, Fcons (position
, Qnil
));
5413 #endif /* USE_TOOLKIT_SCROLL_BARS */
5416 case W32_SCROLL_BAR_CLICK_EVENT
:
5418 int button
= event
->code
;
5420 Lisp_Object position
;
5421 Lisp_Object
*start_pos_ptr
;
5422 Lisp_Object start_pos
;
5426 Lisp_Object portion_whole
;
5429 window
= event
->frame_or_window
;
5430 portion_whole
= Fcons (event
->x
, event
->y
);
5431 part
= *scroll_bar_parts
[(int) event
->part
];
5435 Fcons (Qvertical_scroll_bar
,
5436 Fcons (portion_whole
,
5437 Fcons (make_number (event
->timestamp
),
5438 Fcons (part
, Qnil
)))));
5441 /* Always treat W32 scroll bar events as clicks. */
5442 event
->modifiers
|= click_modifier
;
5445 /* Get the symbol we should use for the mouse click. */
5448 head
= modify_event_symbol (button
,
5453 XVECTOR (mouse_syms
)->size
);
5459 #endif /* WINDOWSNT */
5460 #if defined(WINDOWSNT) || defined(MAC_OSX)
5461 case MOUSE_WHEEL_EVENT
:
5464 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5467 Lisp_Object head
, position
;
5470 /* Ignore mouse events that were made on frame that
5471 have been deleted. */
5472 if (! FRAME_LIVE_P (f
))
5474 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5475 &column
, &row
, NULL
, 1);
5476 window
= window_from_coordinates (f
, XINT (event
->x
),
5477 XINT (event
->y
), &part
, 0);
5479 if (!WINDOWP (window
))
5481 window
= event
->frame_or_window
;
5486 int pixcolumn
, pixrow
;
5487 column
-= XINT (XWINDOW (window
)->left
);
5488 row
-= XINT (XWINDOW (window
)->top
);
5489 glyph_to_pixel_coords (XWINDOW(window
), column
, row
,
5490 &pixcolumn
, &pixrow
);
5491 XSETINT (event
->x
, pixcolumn
);
5492 XSETINT (event
->y
, pixrow
);
5497 posn
= Qvertical_line
;
5499 posn
= Qheader_line
;
5503 struct display_pos p
;
5504 buffer_posn_from_coords (XWINDOW (window
), &column
, &row
,
5506 posn
= make_number (CHARPOS (p
.pos
));
5511 Lisp_Object head
, position
;
5516 Fcons (Fcons (event
->x
, event
->y
),
5517 Fcons (make_number (event
->timestamp
),
5520 head
= modify_event_symbol (0, event
->modifiers
,
5522 lispy_mouse_wheel_names
,
5523 &mouse_wheel_syms
, 1);
5526 /* Insert 1 here so event-click-count works. */
5527 Fcons (make_number (1),
5528 Fcons (make_number (event
->code
),
5532 #endif /* WINDOWSNT || MAC_OSX */
5534 case DRAG_N_DROP_EVENT
:
5542 /* The frame_or_window field should be a cons of the frame in
5543 which the event occurred and a list of the filenames
5545 if (! CONSP (event
->frame_or_window
))
5548 f
= XFRAME (XCAR (event
->frame_or_window
));
5549 files
= XCDR (event
->frame_or_window
);
5551 /* Ignore mouse events that were made on frames that
5552 have been deleted. */
5553 if (! FRAME_LIVE_P (f
))
5556 window
= window_from_coordinates (f
, XINT (event
->x
),
5557 XINT (event
->y
), &part
, 0);
5559 if (!WINDOWP (window
))
5561 window
= XCAR (event
->frame_or_window
);
5566 /* It's an event in window `window' at frame coordinates
5567 event->x/ event->y. */
5568 struct window
*w
= XWINDOW (window
);
5570 /* Get window relative coordinates. */
5571 int wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (event
->x
));
5572 int wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (event
->y
));
5574 /* Set event coordinates to window-relative coordinates
5575 for constructing the Lisp event below. */
5576 XSETINT (event
->x
, wx
);
5577 XSETINT (event
->y
, wy
);
5582 posn
= Qvertical_line
;
5584 posn
= Qheader_line
;
5588 struct display_pos p
;
5589 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5590 posn
= make_number (CHARPOS (p
.pos
));
5595 Lisp_Object head
, position
;
5600 Fcons (Fcons (event
->x
, event
->y
),
5601 Fcons (make_number (event
->timestamp
),
5604 head
= modify_event_symbol (0, event
->modifiers
,
5606 lispy_drag_n_drop_names
,
5607 &drag_n_drop_syms
, 1);
5614 #endif /* HAVE_MOUSE */
5616 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5617 || defined (USE_GTK)
5618 case MENU_BAR_EVENT
:
5619 if (EQ (event
->arg
, event
->frame_or_window
))
5620 /* This is the prefix key. We translate this to
5621 `(menu_bar)' because the code in keyboard.c for menu
5622 events, which we use, relies on this. */
5623 return Fcons (Qmenu_bar
, Qnil
);
5627 case TOOL_BAR_EVENT
:
5628 if (EQ (event
->arg
, event
->frame_or_window
))
5629 /* This is the prefix key. We translate this to
5630 `(tool_bar)' because the code in keyboard.c for tool bar
5631 events, which we use, relies on this. */
5632 return Fcons (Qtool_bar
, Qnil
);
5633 else if (SYMBOLP (event
->arg
))
5634 return apply_modifiers (event
->modifiers
, event
->arg
);
5637 case USER_SIGNAL_EVENT
:
5638 /* A user signal. */
5639 return *lispy_user_signals
[event
->code
];
5641 case SAVE_SESSION_EVENT
:
5642 return Qsave_session
;
5644 /* The 'kind' field of the event is something we don't recognize. */
5653 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5655 Lisp_Object bar_window
;
5656 enum scroll_bar_part part
;
5660 /* Is it a scroll bar movement? */
5661 if (frame
&& ! NILP (bar_window
))
5663 Lisp_Object part_sym
;
5665 part_sym
= *scroll_bar_parts
[(int) part
];
5666 return Fcons (Qscroll_bar_movement
,
5667 (Fcons (Fcons (bar_window
,
5668 Fcons (Qvertical_scroll_bar
,
5669 Fcons (Fcons (x
, y
),
5670 Fcons (make_number (time
),
5676 /* Or is it an ordinary mouse movement? */
5684 /* It's in a frame; which window on that frame? */
5685 window
= window_from_coordinates (frame
, XINT (x
), XINT (y
), &area
, 0);
5689 if (WINDOWP (window
))
5691 struct window
*w
= XWINDOW (window
);
5694 /* Get window relative coordinates. */
5695 wx
= FRAME_TO_WINDOW_PIXEL_X (w
, XINT (x
));
5696 wy
= FRAME_TO_WINDOW_PIXEL_Y (w
, XINT (y
));
5703 posn
= Qvertical_line
;
5705 posn
= Qheader_line
;
5709 struct display_pos p
;
5710 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5711 posn
= make_number (CHARPOS (p
.pos
));
5714 else if (frame
!= 0)
5716 XSETFRAME (window
, frame
);
5727 return Fcons (Qmouse_movement
,
5728 Fcons (Fcons (window
,
5730 Fcons (Fcons (x
, y
),
5731 Fcons (make_number (time
),
5737 #endif /* HAVE_MOUSE */
5739 /* Construct a switch frame event. */
5741 make_lispy_switch_frame (frame
)
5744 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5747 /* Manipulating modifiers. */
5749 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5751 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5752 SYMBOL's name of the end of the modifiers; the string from this
5753 position is the unmodified symbol name.
5755 This doesn't use any caches. */
5758 parse_modifiers_uncached (symbol
, modifier_end
)
5766 CHECK_SYMBOL (symbol
);
5769 name
= SYMBOL_NAME (symbol
);
5771 for (i
= 0; i
+2 <= SBYTES (name
); )
5773 int this_mod_end
= 0;
5776 /* See if the name continues with a modifier word.
5777 Check that the word appears, but don't check what follows it.
5778 Set this_mod and this_mod_end to record what we find. */
5780 switch (SREF (name
, i
))
5782 #define SINGLE_LETTER_MOD(BIT) \
5783 (this_mod_end = i + 1, this_mod = BIT)
5786 SINGLE_LETTER_MOD (alt_modifier
);
5790 SINGLE_LETTER_MOD (ctrl_modifier
);
5794 SINGLE_LETTER_MOD (hyper_modifier
);
5798 SINGLE_LETTER_MOD (meta_modifier
);
5802 SINGLE_LETTER_MOD (shift_modifier
);
5806 SINGLE_LETTER_MOD (super_modifier
);
5809 #undef SINGLE_LETTER_MOD
5812 /* If we found no modifier, stop looking for them. */
5813 if (this_mod_end
== 0)
5816 /* Check there is a dash after the modifier, so that it
5817 really is a modifier. */
5818 if (this_mod_end
>= SBYTES (name
)
5819 || SREF (name
, this_mod_end
) != '-')
5822 /* This modifier is real; look for another. */
5823 modifiers
|= this_mod
;
5824 i
= this_mod_end
+ 1;
5827 /* Should we include the `click' modifier? */
5828 if (! (modifiers
& (down_modifier
| drag_modifier
5829 | double_modifier
| triple_modifier
))
5830 && i
+ 7 == SBYTES (name
)
5831 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5832 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5833 modifiers
|= click_modifier
;
5841 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5842 prepended to the string BASE[0..BASE_LEN-1].
5843 This doesn't use any caches. */
5845 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5848 int base_len
, base_len_byte
;
5850 /* Since BASE could contain nulls, we can't use intern here; we have
5851 to use Fintern, which expects a genuine Lisp_String, and keeps a
5854 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5860 /* Only the event queue may use the `up' modifier; it should always
5861 be turned into a click or drag event before presented to lisp code. */
5862 if (modifiers
& up_modifier
)
5865 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5866 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5867 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5868 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5869 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5870 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5871 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5872 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5873 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5874 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5875 /* The click modifier is denoted by the absence of other modifiers. */
5879 mod_len
= p
- new_mods
;
5883 Lisp_Object new_name
;
5885 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5886 mod_len
+ base_len_byte
);
5887 bcopy (new_mods
, SDATA (new_name
), mod_len
);
5888 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
5890 return Fintern (new_name
, Qnil
);
5895 static char *modifier_names
[] =
5897 "up", "down", "drag", "click", "double", "triple", 0, 0,
5898 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5899 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5901 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5903 static Lisp_Object modifier_symbols
;
5905 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5907 lispy_modifier_list (modifiers
)
5910 Lisp_Object modifier_list
;
5913 modifier_list
= Qnil
;
5914 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
5915 if (modifiers
& (1<<i
))
5916 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
5919 return modifier_list
;
5923 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
5924 where UNMODIFIED is the unmodified form of SYMBOL,
5925 MASK is the set of modifiers present in SYMBOL's name.
5926 This is similar to parse_modifiers_uncached, but uses the cache in
5927 SYMBOL's Qevent_symbol_element_mask property, and maintains the
5928 Qevent_symbol_elements property. */
5931 parse_modifiers (symbol
)
5934 Lisp_Object elements
;
5936 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
5937 if (CONSP (elements
))
5942 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
5943 Lisp_Object unmodified
;
5946 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
5947 SBYTES (SYMBOL_NAME (symbol
)) - end
),
5950 if (modifiers
& ~VALMASK
)
5952 XSETFASTINT (mask
, modifiers
);
5953 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
5955 /* Cache the parsing results on SYMBOL. */
5956 Fput (symbol
, Qevent_symbol_element_mask
,
5958 Fput (symbol
, Qevent_symbol_elements
,
5959 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
5961 /* Since we know that SYMBOL is modifiers applied to unmodified,
5962 it would be nice to put that in unmodified's cache.
5963 But we can't, since we're not sure that parse_modifiers is
5970 /* Apply the modifiers MODIFIERS to the symbol BASE.
5971 BASE must be unmodified.
5973 This is like apply_modifiers_uncached, but uses BASE's
5974 Qmodifier_cache property, if present. It also builds
5975 Qevent_symbol_elements properties, since it has that info anyway.
5977 apply_modifiers copies the value of BASE's Qevent_kind property to
5978 the modified symbol. */
5980 apply_modifiers (modifiers
, base
)
5984 Lisp_Object cache
, index
, entry
, new_symbol
;
5986 /* Mask out upper bits. We don't know where this value's been. */
5987 modifiers
&= VALMASK
;
5989 /* The click modifier never figures into cache indices. */
5990 cache
= Fget (base
, Qmodifier_cache
);
5991 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
5992 entry
= assq_no_quit (index
, cache
);
5995 new_symbol
= XCDR (entry
);
5998 /* We have to create the symbol ourselves. */
5999 new_symbol
= apply_modifiers_uncached (modifiers
,
6000 SDATA (SYMBOL_NAME (base
)),
6001 SCHARS (SYMBOL_NAME (base
)),
6002 SBYTES (SYMBOL_NAME (base
)));
6004 /* Add the new symbol to the base's cache. */
6005 entry
= Fcons (index
, new_symbol
);
6006 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6008 /* We have the parsing info now for free, so add it to the caches. */
6009 XSETFASTINT (index
, modifiers
);
6010 Fput (new_symbol
, Qevent_symbol_element_mask
,
6011 Fcons (base
, Fcons (index
, Qnil
)));
6012 Fput (new_symbol
, Qevent_symbol_elements
,
6013 Fcons (base
, lispy_modifier_list (modifiers
)));
6016 /* Make sure this symbol is of the same kind as BASE.
6018 You'd think we could just set this once and for all when we
6019 intern the symbol above, but reorder_modifiers may call us when
6020 BASE's property isn't set right; we can't assume that just
6021 because it has a Qmodifier_cache property it must have its
6022 Qevent_kind set right as well. */
6023 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6027 kind
= Fget (base
, Qevent_kind
);
6029 Fput (new_symbol
, Qevent_kind
, kind
);
6036 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6037 return a symbol with the modifiers placed in the canonical order.
6038 Canonical order is alphabetical, except for down and drag, which
6039 always come last. The 'click' modifier is never written out.
6041 Fdefine_key calls this to make sure that (for example) C-M-foo
6042 and M-C-foo end up being equivalent in the keymap. */
6045 reorder_modifiers (symbol
)
6048 /* It's hopefully okay to write the code this way, since everything
6049 will soon be in caches, and no consing will be done at all. */
6052 parsed
= parse_modifiers (symbol
);
6053 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6058 /* For handling events, we often want to produce a symbol whose name
6059 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6060 to some base, like the name of a function key or mouse button.
6061 modify_event_symbol produces symbols of this sort.
6063 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6064 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6067 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6068 into symbol names, or a string specifying a name stem used to
6069 construct a symbol name or the form `STEM-N', where N is the decimal
6070 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6071 non-nil; otherwise NAME_TABLE is used.
6073 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6074 persist between calls to modify_event_symbol that it can use to
6075 store a cache of the symbols it's generated for this NAME_TABLE
6076 before. The object stored there may be a vector or an alist.
6078 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6080 MODIFIERS is a set of modifier bits (as given in struct input_events)
6081 whose prefixes should be applied to the symbol name.
6083 SYMBOL_KIND is the value to be placed in the event_kind property of
6084 the returned symbol.
6086 The symbols we create are supposed to have an
6087 `event-symbol-elements' property, which lists the modifiers present
6088 in the symbol's name. */
6091 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6092 name_table
, symbol_table
, table_size
)
6095 Lisp_Object symbol_kind
;
6096 Lisp_Object name_alist_or_stem
;
6098 Lisp_Object
*symbol_table
;
6099 unsigned int table_size
;
6102 Lisp_Object symbol_int
;
6104 /* Get rid of the "vendor-specific" bit here. */
6105 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6107 /* Is this a request for a valid symbol? */
6108 if (symbol_num
< 0 || symbol_num
>= table_size
)
6111 if (CONSP (*symbol_table
))
6112 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6114 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6115 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6116 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6117 we've never used that symbol before. */
6120 if (! VECTORP (*symbol_table
)
6121 || XVECTOR (*symbol_table
)->size
!= table_size
)
6125 XSETFASTINT (size
, table_size
);
6126 *symbol_table
= Fmake_vector (size
, Qnil
);
6129 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6132 /* Have we already used this symbol before? */
6135 /* No; let's create it. */
6136 if (CONSP (name_alist_or_stem
))
6137 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6138 else if (STRINGP (name_alist_or_stem
))
6140 int len
= SBYTES (name_alist_or_stem
);
6141 char *buf
= (char *) alloca (len
+ 50);
6142 if (sizeof (int) == sizeof (EMACS_INT
))
6143 sprintf (buf
, "%s-%d", SDATA (name_alist_or_stem
),
6144 XINT (symbol_int
) + 1);
6145 else if (sizeof (long) == sizeof (EMACS_INT
))
6146 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6147 XINT (symbol_int
) + 1);
6148 value
= intern (buf
);
6150 else if (name_table
!= 0 && name_table
[symbol_num
])
6151 value
= intern (name_table
[symbol_num
]);
6153 #ifdef HAVE_WINDOW_SYSTEM
6156 char *name
= x_get_keysym_name (symbol_num
);
6158 value
= intern (name
);
6165 sprintf (buf
, "key-%d", symbol_num
);
6166 value
= intern (buf
);
6169 if (CONSP (*symbol_table
))
6170 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6172 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6174 /* Fill in the cache entries for this symbol; this also
6175 builds the Qevent_symbol_elements property, which the user
6177 apply_modifiers (modifiers
& click_modifier
, value
);
6178 Fput (value
, Qevent_kind
, symbol_kind
);
6181 /* Apply modifiers to that symbol. */
6182 return apply_modifiers (modifiers
, value
);
6185 /* Convert a list that represents an event type,
6186 such as (ctrl meta backspace), into the usual representation of that
6187 event type as a number or a symbol. */
6189 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6190 doc
: /* Convert the event description list EVENT-DESC to an event type.
6191 EVENT-DESC should contain one base event type (a character or symbol)
6192 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6193 drag, down, double or triple). The base must be last.
6194 The return value is an event type (a character or symbol) which
6195 has the same base event type and all the specified modifiers. */)
6197 Lisp_Object event_desc
;
6205 while (CONSP (rest
))
6213 /* Given a symbol, see if it is a modifier name. */
6214 if (SYMBOLP (elt
) && CONSP (rest
))
6215 this = parse_solitary_modifier (elt
);
6219 else if (!NILP (base
))
6220 error ("Two bases given in one event");
6226 /* Let the symbol A refer to the character A. */
6227 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6228 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6230 if (INTEGERP (base
))
6232 /* Turn (shift a) into A. */
6233 if ((modifiers
& shift_modifier
) != 0
6234 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6236 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6237 modifiers
&= ~shift_modifier
;
6240 /* Turn (control a) into C-a. */
6241 if (modifiers
& ctrl_modifier
)
6242 return make_number ((modifiers
& ~ctrl_modifier
)
6243 | make_ctrl_char (XINT (base
)));
6245 return make_number (modifiers
| XINT (base
));
6247 else if (SYMBOLP (base
))
6248 return apply_modifiers (modifiers
, base
);
6251 error ("Invalid base event");
6256 /* Try to recognize SYMBOL as a modifier name.
6257 Return the modifier flag bit, or 0 if not recognized. */
6260 parse_solitary_modifier (symbol
)
6263 Lisp_Object name
= SYMBOL_NAME (symbol
);
6265 switch (SREF (name
, 0))
6267 #define SINGLE_LETTER_MOD(BIT) \
6268 if (SBYTES (name) == 1) \
6271 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6272 if (LEN == SBYTES (name) \
6273 && ! strncmp (SDATA (name), NAME, LEN)) \
6277 SINGLE_LETTER_MOD (alt_modifier
);
6281 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6285 SINGLE_LETTER_MOD (ctrl_modifier
);
6289 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6290 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6294 SINGLE_LETTER_MOD (hyper_modifier
);
6298 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6302 SINGLE_LETTER_MOD (meta_modifier
);
6306 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6310 SINGLE_LETTER_MOD (shift_modifier
);
6314 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6315 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6316 SINGLE_LETTER_MOD (super_modifier
);
6320 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6321 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6322 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6326 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6329 #undef SINGLE_LETTER_MOD
6330 #undef MULTI_LETTER_MOD
6336 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6337 Such a list is not valid as an event,
6338 but it can be a Lucid-style event type list. */
6341 lucid_event_type_list_p (object
)
6346 if (! CONSP (object
))
6349 if (EQ (XCAR (object
), Qhelp_echo
)
6350 || EQ (XCAR (object
), Qvertical_line
)
6351 || EQ (XCAR (object
), Qmode_line
)
6352 || EQ (XCAR (object
), Qheader_line
))
6355 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6359 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6366 /* Store into *addr a value nonzero if terminal input chars are available.
6367 Serves the purpose of ioctl (0, FIONREAD, addr)
6368 but works even if FIONREAD does not exist.
6369 (In fact, this may actually read some input.)
6371 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6372 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6375 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6380 /* First of all, have we already counted some input? */
6381 *addr
= (!NILP (Vquit_flag
)
6382 || readable_filtered_events (do_timers_now
, filter_events
));
6384 /* If input is being read as it arrives, and we have none, there is none. */
6385 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6388 /* Try to read some input and see how much we get. */
6390 *addr
= (!NILP (Vquit_flag
)
6391 || readable_filtered_events (do_timers_now
, filter_events
));
6394 /* Store into *addr a value nonzero if terminal input chars are available.
6395 Serves the purpose of ioctl (0, FIONREAD, addr)
6396 but works even if FIONREAD does not exist.
6397 (In fact, this may actually read some input.)
6399 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6402 get_input_pending (addr
, do_timers_now
)
6406 get_filtered_input_pending (addr
, do_timers_now
, 0);
6409 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6412 gobble_input (expected
)
6417 if (interrupt_input
)
6420 mask
= sigblock (sigmask (SIGIO
));
6421 read_avail_input (expected
);
6425 #ifdef POLL_FOR_INPUT
6426 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6429 mask
= sigblock (sigmask (SIGALRM
));
6430 read_avail_input (expected
);
6436 read_avail_input (expected
);
6440 /* Put a BUFFER_SWITCH_EVENT in the buffer
6441 so that read_key_sequence will notice the new current buffer. */
6444 record_asynch_buffer_change ()
6446 struct input_event event
;
6449 event
.kind
= BUFFER_SWITCH_EVENT
;
6450 event
.frame_or_window
= Qnil
;
6454 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6455 The purpose of the event is to make read_key_sequence look up the
6456 keymaps again. If we aren't in read_key_sequence, we don't need one,
6457 and the event could cause trouble by messing up (input-pending-p). */
6458 tem
= Fwaiting_for_user_input_p ();
6462 /* We never need these events if we have no asynchronous subprocesses. */
6466 /* Make sure no interrupt happens while storing the event. */
6468 if (interrupt_input
)
6471 mask
= sigblock (sigmask (SIGIO
));
6472 kbd_buffer_store_event (&event
);
6479 kbd_buffer_store_event (&event
);
6486 /* Read any terminal input already buffered up by the system
6487 into the kbd_buffer, but do not wait.
6489 EXPECTED should be nonzero if the caller knows there is some input.
6491 Except on VMS, all input is read by this function.
6492 If interrupt_input is nonzero, this function MUST be called
6493 only when SIGIO is blocked.
6495 Returns the number of keyboard chars read, or -1 meaning
6496 this is a bad time to try to read input. */
6499 read_avail_input (expected
)
6502 struct input_event buf
[KBD_BUFFER_SIZE
];
6506 if (read_socket_hook
)
6507 /* No need for FIONREAD or fcntl; just say don't wait. */
6508 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
6511 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6512 the kbd_buffer can really hold. That may prevent loss
6513 of characters on some systems when input is stuffed at us. */
6514 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6517 /* Determine how many characters we should *try* to read. */
6520 #else /* not WINDOWSNT */
6522 n_to_read
= dos_keysns ();
6525 #else /* not MSDOS */
6527 /* Find out how much input is available. */
6528 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6529 /* Formerly simply reported no input, but that sometimes led to
6530 a failure of Emacs to terminate.
6531 SIGHUP seems appropriate if we can't reach the terminal. */
6532 /* ??? Is it really right to send the signal just to this process
6533 rather than to the whole process group?
6534 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6535 kill (getpid (), SIGHUP
);
6538 if (n_to_read
> sizeof cbuf
)
6539 n_to_read
= sizeof cbuf
;
6540 #else /* no FIONREAD */
6541 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6542 /* Read some input if available, but don't wait. */
6543 n_to_read
= sizeof cbuf
;
6544 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6549 #endif /* not MSDOS */
6550 #endif /* not WINDOWSNT */
6552 /* Now read; for one reason or another, this will not block.
6553 NREAD is set to the number of chars read. */
6557 cbuf
[0] = dos_keyread ();
6560 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6562 /* POSIX infers that processes which are not in the session leader's
6563 process group won't get SIGHUP's at logout time. BSDI adheres to
6564 this part standard and returns -1 from read (0) with errno==EIO
6565 when the control tty is taken away.
6566 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6567 if (nread
== -1 && errno
== EIO
)
6569 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6570 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6571 This looks incorrect, but it isn't, because _BSD causes
6572 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6573 and that causes a value other than 0 when there is no input. */
6579 /* We used to retry the read if it was interrupted.
6580 But this does the wrong thing when O_NDELAY causes
6581 an EAGAIN error. Does anybody know of a situation
6582 where a retry is actually needed? */
6584 nread
< 0 && (errno
== EAGAIN
6598 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6599 fcntl (input_fd
, F_SETFL
, 0);
6600 #endif /* USG or DGUX or CYGWIN */
6601 #endif /* no FIONREAD */
6602 for (i
= 0; i
< nread
; i
++)
6604 buf
[i
].kind
= ASCII_KEYSTROKE_EVENT
;
6605 buf
[i
].modifiers
= 0;
6606 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6607 buf
[i
].modifiers
= meta_modifier
;
6611 buf
[i
].code
= cbuf
[i
];
6612 buf
[i
].frame_or_window
= selected_frame
;
6617 /* Scan the chars for C-g and store them in kbd_buffer. */
6618 for (i
= 0; i
< nread
; i
++)
6620 kbd_buffer_store_event (&buf
[i
]);
6621 /* Don't look at input that follows a C-g too closely.
6622 This reduces lossage due to autorepeat on C-g. */
6623 if (buf
[i
].kind
== ASCII_KEYSTROKE_EVENT
6624 && buf
[i
].code
== quit_char
)
6630 #endif /* not VMS */
6632 #ifdef SIGIO /* for entire page */
6633 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6636 input_available_signal (signo
)
6639 /* Must preserve main program's value of errno. */
6640 int old_errno
= errno
;
6642 extern int select_alarmed
;
6645 #if defined (USG) && !defined (POSIX_SIGNALS)
6646 /* USG systems forget handlers when they are used;
6647 must reestablish each time */
6648 signal (signo
, input_available_signal
);
6655 if (input_available_clear_time
)
6656 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6661 nread
= read_avail_input (1);
6662 /* -1 means it's not ok to read the input now.
6663 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6664 0 means there was no keyboard input available. */
6669 select_alarmed
= 1; /* Force the select emulator back to life */
6680 /* Send ourselves a SIGIO.
6682 This function exists so that the UNBLOCK_INPUT macro in
6683 blockinput.h can have some way to take care of input we put off
6684 dealing with, without assuming that every file which uses
6685 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6687 reinvoke_input_signal ()
6690 kill (getpid (), SIGIO
);
6696 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
6697 static void menu_bar_one_keymap
P_ ((Lisp_Object
));
6699 /* These variables hold the vector under construction within
6700 menu_bar_items and its subroutines, and the current index
6701 for storing into that vector. */
6702 static Lisp_Object menu_bar_items_vector
;
6703 static int menu_bar_items_index
;
6705 /* Return a vector of menu items for a menu bar, appropriate
6706 to the current buffer. Each item has three elements in the vector:
6709 OLD is an old vector we can optionally reuse, or nil. */
6712 menu_bar_items (old
)
6715 /* The number of keymaps we're scanning right now, and the number of
6716 keymaps we have allocated space for. */
6719 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6720 in the current keymaps, or nil where it is not a prefix. */
6723 Lisp_Object def
, tail
;
6732 struct gcpro gcpro1
;
6734 /* In order to build the menus, we need to call the keymap
6735 accessors. They all call QUIT. But this function is called
6736 during redisplay, during which a quit is fatal. So inhibit
6737 quitting while building the menus.
6738 We do this instead of specbind because (1) errors will clear it anyway
6739 and (2) this avoids risk of specpdl overflow. */
6740 oquit
= Vinhibit_quit
;
6744 menu_bar_items_vector
= old
;
6746 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6747 menu_bar_items_index
= 0;
6749 GCPRO1 (menu_bar_items_vector
);
6751 /* Build our list of keymaps.
6752 If we recognize a function key and replace its escape sequence in
6753 keybuf with its symbol, or if the sequence starts with a mouse
6754 click and we need to switch buffers, we jump back here to rebuild
6755 the initial keymaps from the current buffer. */
6759 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6760 if (!NILP (Voverriding_local_map_menu_flag
))
6762 /* Yes, use them (if non-nil) as well as the global map. */
6763 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6765 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6766 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6767 if (!NILP (Voverriding_local_map
))
6768 maps
[nmaps
++] = Voverriding_local_map
;
6772 /* No, so use major and minor mode keymaps and keymap property.
6773 Note that menu-bar bindings in the local-map and keymap
6774 properties may not work reliable, as they are only
6775 recognized when the menu-bar (or mode-line) is updated,
6776 which does not normally happen after every command. */
6779 nminor
= current_minor_maps (NULL
, &tmaps
);
6780 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6782 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6783 maps
[nmaps
++] = tem
;
6784 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6786 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6788 maps
[nmaps
++] = current_global_map
;
6791 /* Look up in each map the dummy prefix key `menu-bar'. */
6795 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6796 if (!NILP (maps
[mapno
]))
6798 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6801 menu_bar_one_keymap (def
);
6804 /* Move to the end those items that should be at the end. */
6806 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6809 int end
= menu_bar_items_index
;
6811 for (i
= 0; i
< end
; i
+= 4)
6812 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6814 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6815 /* Move the item at index I to the end,
6816 shifting all the others forward. */
6817 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6818 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6819 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6820 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6822 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6823 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6824 (end
- i
- 4) * sizeof (Lisp_Object
));
6825 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6826 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6827 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6828 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6833 /* Add nil, nil, nil, nil at the end. */
6834 i
= menu_bar_items_index
;
6835 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6838 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6839 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6840 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6841 menu_bar_items_vector
= tem
;
6843 /* Add this item. */
6844 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6845 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6846 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6847 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6848 menu_bar_items_index
= i
;
6850 Vinhibit_quit
= oquit
;
6852 return menu_bar_items_vector
;
6855 /* Scan one map KEYMAP, accumulating any menu items it defines
6856 in menu_bar_items_vector. */
6858 static Lisp_Object menu_bar_one_keymap_changed_items
;
6861 menu_bar_one_keymap (keymap
)
6864 Lisp_Object tail
, item
;
6866 menu_bar_one_keymap_changed_items
= Qnil
;
6868 /* Loop over all keymap entries that have menu strings. */
6869 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
6873 menu_bar_item (XCAR (item
), XCDR (item
));
6874 else if (VECTORP (item
))
6876 /* Loop over the char values represented in the vector. */
6877 int len
= XVECTOR (item
)->size
;
6879 for (c
= 0; c
< len
; c
++)
6881 Lisp_Object character
;
6882 XSETFASTINT (character
, c
);
6883 menu_bar_item (character
, XVECTOR (item
)->contents
[c
]);
6889 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
6890 If there's already an item for KEY, add this DEF to it. */
6892 Lisp_Object item_properties
;
6895 menu_bar_item (key
, item
)
6896 Lisp_Object key
, item
;
6898 struct gcpro gcpro1
;
6902 if (EQ (item
, Qundefined
))
6904 /* If a map has an explicit `undefined' as definition,
6905 discard any previously made menu bar item. */
6907 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6908 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6910 if (menu_bar_items_index
> i
+ 4)
6911 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6912 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6913 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
6914 menu_bar_items_index
-= 4;
6918 /* If this keymap has already contributed to this KEY,
6919 don't contribute to it a second time. */
6920 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
6921 if (!NILP (tem
) || NILP (item
))
6924 menu_bar_one_keymap_changed_items
6925 = Fcons (key
, menu_bar_one_keymap_changed_items
);
6927 /* We add to menu_bar_one_keymap_changed_items before doing the
6928 parse_menu_item, so that if it turns out it wasn't a menu item,
6929 it still correctly hides any further menu item. */
6931 i
= parse_menu_item (item
, 0, 1);
6936 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
6938 /* Find any existing item for this KEY. */
6939 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
6940 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6943 /* If we did not find this KEY, add it at the end. */
6944 if (i
== menu_bar_items_index
)
6946 /* If vector is too small, get a bigger one. */
6947 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6950 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6951 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6952 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6953 menu_bar_items_vector
= tem
;
6956 /* Add this item. */
6957 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
6958 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
6959 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
6960 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
6961 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
6962 menu_bar_items_index
= i
;
6964 /* We did find an item for this KEY. Add ITEM to its list of maps. */
6968 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6969 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = Fcons (item
, old
);
6973 /* This is used as the handler when calling menu_item_eval_property. */
6975 menu_item_eval_property_1 (arg
)
6978 /* If we got a quit from within the menu computation,
6979 quit all the way out of it. This takes care of C-] in the debugger. */
6980 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
6981 Fsignal (Qquit
, Qnil
);
6986 /* Evaluate an expression and return the result (or nil if something
6987 went wrong). Used to evaluate dynamic parts of menu items. */
6989 menu_item_eval_property (sexpr
)
6992 int count
= SPECPDL_INDEX ();
6994 specbind (Qinhibit_redisplay
, Qt
);
6995 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
6996 menu_item_eval_property_1
);
6997 return unbind_to (count
, val
);
7000 /* This function parses a menu item and leaves the result in the
7001 vector item_properties.
7002 ITEM is a key binding, a possible menu item.
7003 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7004 evaluate dynamic expressions in the menu item.
7005 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7007 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7008 parse_menu_item returns true if the item is a menu item and false
7012 parse_menu_item (item
, notreal
, inmenubar
)
7014 int notreal
, inmenubar
;
7016 Lisp_Object def
, tem
, item_string
, start
;
7017 Lisp_Object cachelist
;
7019 Lisp_Object keyhint
;
7030 /* Create item_properties vector if necessary. */
7031 if (NILP (item_properties
))
7033 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7035 /* Initialize optional entries. */
7036 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7037 AREF (item_properties
, i
) = Qnil
;
7038 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7040 /* Save the item here to protect it from GC. */
7041 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7043 item_string
= XCAR (item
);
7047 if (STRINGP (item_string
))
7049 /* Old format menu item. */
7050 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7052 /* Maybe help string. */
7053 if (CONSP (item
) && STRINGP (XCAR (item
)))
7055 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7060 /* Maybe key binding cache. */
7061 if (CONSP (item
) && CONSP (XCAR (item
))
7062 && (NILP (XCAR (XCAR (item
)))
7063 || VECTORP (XCAR (XCAR (item
)))))
7065 cachelist
= XCAR (item
);
7069 /* This is the real definition--the function to run. */
7070 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7072 /* Get enable property, if any. */
7075 tem
= Fget (item
, Qmenu_enable
);
7077 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7080 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7082 /* New format menu item. */
7083 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7084 start
= XCDR (item
);
7087 /* We have a real binding. */
7088 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7090 item
= XCDR (start
);
7091 /* Is there a cache list with key equivalences. */
7092 if (CONSP (item
) && CONSP (XCAR (item
)))
7094 cachelist
= XCAR (item
);
7098 /* Parse properties. */
7099 while (CONSP (item
) && CONSP (XCDR (item
)))
7104 if (EQ (tem
, QCenable
))
7105 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7106 else if (EQ (tem
, QCvisible
) && !notreal
)
7108 /* If got a visible property and that evaluates to nil
7109 then ignore this item. */
7110 tem
= menu_item_eval_property (XCAR (item
));
7114 else if (EQ (tem
, QChelp
))
7115 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7116 else if (EQ (tem
, QCfilter
))
7118 else if (EQ (tem
, QCkey_sequence
))
7121 if (NILP (cachelist
)
7122 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7123 /* Be GC protected. Set keyhint to item instead of tem. */
7126 else if (EQ (tem
, QCkeys
))
7129 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7130 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7132 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7137 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7139 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7141 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7148 else if (inmenubar
|| !NILP (start
))
7152 return 0; /* not a menu item */
7154 /* If item string is not a string, evaluate it to get string.
7155 If we don't get a string, skip this item. */
7156 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7157 if (!(STRINGP (item_string
) || notreal
))
7159 item_string
= menu_item_eval_property (item_string
);
7160 if (!STRINGP (item_string
))
7162 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7165 /* If got a filter apply it on definition. */
7166 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7169 def
= menu_item_eval_property (list2 (XCAR (filter
),
7170 list2 (Qquote
, def
)));
7172 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7175 /* Enable or disable selection of item. */
7176 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7182 tem
= menu_item_eval_property (tem
);
7183 if (inmenubar
&& NILP (tem
))
7184 return 0; /* Ignore disabled items in menu bar. */
7185 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7188 /* If we got no definition, this item is just unselectable text which
7189 is OK in a submenu but not in the menubar. */
7191 return (inmenubar
? 0 : 1);
7193 /* See if this is a separate pane or a submenu. */
7194 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7195 tem
= get_keymap (def
, 0, 1);
7196 /* For a subkeymap, just record its details and exit. */
7199 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7200 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7204 /* At the top level in the menu bar, do likewise for commands also.
7205 The menu bar does not display equivalent key bindings anyway.
7206 ITEM_PROPERTY_DEF is already set up properly. */
7210 /* This is a command. See if there is an equivalent key binding. */
7211 if (NILP (cachelist
))
7213 /* We have to create a cachelist. */
7214 CHECK_IMPURE (start
);
7215 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7216 cachelist
= XCAR (XCDR (start
));
7218 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7219 if (!NILP (keyhint
))
7221 XSETCAR (cachelist
, XCAR (keyhint
));
7224 else if (STRINGP (tem
))
7226 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7227 XSETCAR (cachelist
, Qt
);
7231 tem
= XCAR (cachelist
);
7238 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7240 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7243 def
= XCAR (prefix
);
7244 prefix
= XCDR (prefix
);
7247 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7249 if (!update_menu_bindings
)
7251 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7253 if (newcache
/* Always check first time. */
7254 /* Should we check everything when precomputing key
7256 /* If something had no key binding before, don't recheck it
7257 because that is too slow--except if we have a list of
7258 rebound commands in Vdefine_key_rebound_commands, do
7259 recheck any command that appears in that list. */
7260 || (CONSP (Vdefine_key_rebound_commands
)
7261 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7264 /* We had a saved key. Is it still bound to the command? */
7267 /* If the command is an alias for another
7268 (such as lmenu.el set it up), check if the
7269 original command matches the cached command. */
7270 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7271 chkcache
= 1; /* Need to recompute key binding. */
7275 /* Recompute equivalent key binding. If the command is an alias
7276 for another (such as lmenu.el set it up), see if the original
7277 command name has equivalent keys. Otherwise look up the
7278 specified command itself. We don't try both, because that
7279 makes lmenu menus slow. */
7281 && SYMBOLP (XSYMBOL (def
)->function
)
7282 && ! NILP (Fget (def
, Qmenu_alias
)))
7283 def
= XSYMBOL (def
)->function
;
7284 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7285 XSETCAR (cachelist
, tem
);
7288 XSETCDR (cachelist
, Qnil
);
7292 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7294 tem
= XCAR (cachelist
);
7298 newcache
= chkcache
;
7301 tem
= Fkey_description (tem
);
7304 if (STRINGP (XCAR (prefix
)))
7305 tem
= concat2 (XCAR (prefix
), tem
);
7306 if (STRINGP (XCDR (prefix
)))
7307 tem
= concat2 (tem
, XCDR (prefix
));
7309 XSETCDR (cachelist
, tem
);
7313 tem
= XCDR (cachelist
);
7314 if (newcache
&& !NILP (tem
))
7316 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7317 XSETCDR (cachelist
, tem
);
7320 /* If we only want to precompute equivalent key bindings, stop here. */
7324 /* If we have an equivalent key binding, use that. */
7325 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7327 /* Include this when menu help is implemented.
7328 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7329 if (!(NILP (tem) || STRINGP (tem)))
7331 tem = menu_item_eval_property (tem);
7334 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7338 /* Handle radio buttons or toggle boxes. */
7339 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7341 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7342 = menu_item_eval_property (tem
);
7349 /***********************************************************************
7351 ***********************************************************************/
7353 /* A vector holding tool bar items while they are parsed in function
7354 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7357 static Lisp_Object tool_bar_items_vector
;
7359 /* A vector holding the result of parse_tool_bar_item. Layout is like
7360 the one for a single item in tool_bar_items_vector. */
7362 static Lisp_Object tool_bar_item_properties
;
7364 /* Next free index in tool_bar_items_vector. */
7366 static int ntool_bar_items
;
7368 /* The symbols `tool-bar', and `:image'. */
7370 extern Lisp_Object Qtool_bar
;
7371 Lisp_Object QCimage
;
7373 /* Function prototypes. */
7375 static void init_tool_bar_items
P_ ((Lisp_Object
));
7376 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7377 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7378 static void append_tool_bar_item
P_ ((void));
7381 /* Return a vector of tool bar items for keymaps currently in effect.
7382 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7383 tool bar items found. */
7386 tool_bar_items (reuse
, nitems
)
7397 /* In order to build the menus, we need to call the keymap
7398 accessors. They all call QUIT. But this function is called
7399 during redisplay, during which a quit is fatal. So inhibit
7400 quitting while building the menus. We do this instead of
7401 specbind because (1) errors will clear it anyway and (2) this
7402 avoids risk of specpdl overflow. */
7403 oquit
= Vinhibit_quit
;
7406 /* Initialize tool_bar_items_vector and protect it from GC. */
7407 init_tool_bar_items (reuse
);
7409 /* Build list of keymaps in maps. Set nmaps to the number of maps
7412 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7413 if (!NILP (Voverriding_local_map_menu_flag
))
7415 /* Yes, use them (if non-nil) as well as the global map. */
7416 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7418 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7419 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7420 if (!NILP (Voverriding_local_map
))
7421 maps
[nmaps
++] = Voverriding_local_map
;
7425 /* No, so use major and minor mode keymaps and keymap property.
7426 Note that tool-bar bindings in the local-map and keymap
7427 properties may not work reliable, as they are only
7428 recognized when the tool-bar (or mode-line) is updated,
7429 which does not normally happen after every command. */
7432 nminor
= current_minor_maps (NULL
, &tmaps
);
7433 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7435 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7436 maps
[nmaps
++] = tem
;
7437 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7439 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7442 /* Add global keymap at the end. */
7443 maps
[nmaps
++] = current_global_map
;
7445 /* Process maps in reverse order and look up in each map the prefix
7447 for (i
= nmaps
- 1; i
>= 0; --i
)
7448 if (!NILP (maps
[i
]))
7452 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7457 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7458 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7460 Lisp_Object keydef
= XCAR (tail
);
7462 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7467 Vinhibit_quit
= oquit
;
7468 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7469 return tool_bar_items_vector
;
7473 /* Process the definition of KEY which is DEF. */
7476 process_tool_bar_item (key
, def
)
7477 Lisp_Object key
, def
;
7480 extern Lisp_Object Qundefined
;
7481 struct gcpro gcpro1
, gcpro2
;
7483 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7487 if (EQ (def
, Qundefined
))
7489 /* If a map has an explicit `undefined' as definition,
7490 discard any previously made item. */
7491 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7493 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7495 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7497 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7498 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7499 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7500 * sizeof (Lisp_Object
)));
7501 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7506 else if (parse_tool_bar_item (key
, def
))
7507 /* Append a new tool bar item to tool_bar_items_vector. Accept
7508 more than one definition for the same key. */
7509 append_tool_bar_item ();
7515 /* Parse a tool bar item specification ITEM for key KEY and return the
7516 result in tool_bar_item_properties. Value is zero if ITEM is
7519 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7521 CAPTION is the caption of the item, If it's not a string, it is
7522 evaluated to get a string.
7524 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7525 as binding are currently ignored.
7527 The following properties are recognized:
7531 FORM is evaluated and specifies whether the tool bar item is
7532 enabled or disabled.
7536 FORM is evaluated and specifies whether the tool bar item is visible.
7538 - `:filter FUNCTION'
7540 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7541 result is stored as the new binding.
7543 - `:button (TYPE SELECTED)'
7545 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7546 and specifies whether the button is selected (pressed) or not.
7550 IMAGES is either a single image specification or a vector of four
7551 image specifications. See enum tool_bar_item_images.
7553 - `:help HELP-STRING'.
7555 Gives a help string to display for the tool bar item. */
7558 parse_tool_bar_item (key
, item
)
7559 Lisp_Object key
, item
;
7561 /* Access slot with index IDX of vector tool_bar_item_properties. */
7562 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7564 Lisp_Object filter
= Qnil
;
7565 Lisp_Object caption
;
7568 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7569 Rule out items that aren't lists, don't start with
7570 `menu-item' or whose rest following `tool-bar-item' is not a
7573 || !EQ (XCAR (item
), Qmenu_item
)
7574 || (item
= XCDR (item
),
7578 /* Create tool_bar_item_properties vector if necessary. Reset it to
7580 if (VECTORP (tool_bar_item_properties
))
7582 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7586 tool_bar_item_properties
7587 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7590 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7591 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7593 /* Get the caption of the item. If the caption is not a string,
7594 evaluate it to get a string. If we don't get a string, skip this
7596 caption
= XCAR (item
);
7597 if (!STRINGP (caption
))
7599 caption
= menu_item_eval_property (caption
);
7600 if (!STRINGP (caption
))
7603 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7605 /* Give up if rest following the caption is not a list. */
7610 /* Store the binding. */
7611 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7614 /* Ignore cached key binding, if any. */
7615 if (CONSP (item
) && CONSP (XCAR (item
)))
7618 /* Process the rest of the properties. */
7619 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7621 Lisp_Object key
, value
;
7624 value
= XCAR (XCDR (item
));
7626 if (EQ (key
, QCenable
))
7627 /* `:enable FORM'. */
7628 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7629 else if (EQ (key
, QCvisible
))
7631 /* `:visible FORM'. If got a visible property and that
7632 evaluates to nil then ignore this item. */
7633 if (NILP (menu_item_eval_property (value
)))
7636 else if (EQ (key
, QChelp
))
7637 /* `:help HELP-STRING'. */
7638 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7639 else if (EQ (key
, QCfilter
))
7640 /* ':filter FORM'. */
7642 else if (EQ (key
, QCbutton
) && CONSP (value
))
7644 /* `:button (TYPE . SELECTED)'. */
7645 Lisp_Object type
, selected
;
7647 type
= XCAR (value
);
7648 selected
= XCDR (value
);
7649 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7651 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7652 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7655 else if (EQ (key
, QCimage
)
7657 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7658 /* Value is either a single image specification or a vector
7659 of 4 such specifications for the different button states. */
7660 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7663 /* If got a filter apply it on binding. */
7665 PROP (TOOL_BAR_ITEM_BINDING
)
7666 = menu_item_eval_property (list2 (filter
,
7668 PROP (TOOL_BAR_ITEM_BINDING
))));
7670 /* See if the binding is a keymap. Give up if it is. */
7671 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7674 /* Enable or disable selection of item. */
7675 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7676 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7677 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7679 /* Handle radio buttons or toggle boxes. */
7680 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7681 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7682 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7690 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7691 that can be reused. */
7694 init_tool_bar_items (reuse
)
7697 if (VECTORP (reuse
))
7698 tool_bar_items_vector
= reuse
;
7700 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7701 ntool_bar_items
= 0;
7705 /* Append parsed tool bar item properties from
7706 tool_bar_item_properties */
7709 append_tool_bar_item ()
7711 Lisp_Object
*to
, *from
;
7713 /* Enlarge tool_bar_items_vector if necessary. */
7714 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7715 >= XVECTOR (tool_bar_items_vector
)->size
)
7717 Lisp_Object new_vector
;
7718 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7720 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7721 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7722 XVECTOR (new_vector
)->contents
,
7723 old_size
* sizeof (Lisp_Object
));
7724 tool_bar_items_vector
= new_vector
;
7727 /* Append entries from tool_bar_item_properties to the end of
7728 tool_bar_items_vector. */
7729 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7730 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7731 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7732 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7739 /* Read a character using menus based on maps in the array MAPS.
7740 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7741 Return t if we displayed a menu but the user rejected it.
7743 PREV_EVENT is the previous input event, or nil if we are reading
7744 the first event of a key sequence.
7746 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7747 if we used a mouse menu to read the input, or zero otherwise. If
7748 USED_MOUSE_MENU is null, we don't dereference it.
7750 The prompting is done based on the prompt-string of the map
7751 and the strings associated with various map elements.
7753 This can be done with X menus or with menus put in the minibuf.
7754 These are done in different ways, depending on how the input will be read.
7755 Menus using X are done after auto-saving in read-char, getting the input
7756 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7757 and do auto-saving in the inner call of read_char. */
7760 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7763 Lisp_Object prev_event
;
7764 int *used_mouse_menu
;
7767 register Lisp_Object name
= Qnil
;
7769 if (used_mouse_menu
)
7770 *used_mouse_menu
= 0;
7772 /* Use local over global Menu maps */
7774 if (! menu_prompting
)
7777 /* Optionally disregard all but the global map. */
7778 if (inhibit_local_menu_bar_menus
)
7780 maps
+= (nmaps
- 1);
7784 /* Get the menu name from the first map that has one (a prompt string). */
7785 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7787 name
= Fkeymap_prompt (maps
[mapno
]);
7792 /* If we don't have any menus, just read a character normally. */
7793 if (!STRINGP (name
))
7797 /* If we got to this point via a mouse click,
7798 use a real menu for mouse selection. */
7799 if (EVENT_HAS_PARAMETERS (prev_event
)
7800 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7801 && !EQ (XCAR (prev_event
), Qtool_bar
))
7803 /* Display the menu and get the selection. */
7804 Lisp_Object
*realmaps
7805 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7809 /* Use the maps that are not nil. */
7810 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7811 if (!NILP (maps
[mapno
]))
7812 realmaps
[nmaps1
++] = maps
[mapno
];
7814 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7819 record_menu_key (XCAR (value
));
7821 /* If we got multiple events, unread all but
7823 There is no way to prevent those unread events
7824 from showing up later in last_nonmenu_event.
7825 So turn symbol and integer events into lists,
7826 to indicate that they came from a mouse menu,
7827 so that when present in last_nonmenu_event
7828 they won't confuse things. */
7829 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7831 record_menu_key (XCAR (tem
));
7832 if (SYMBOLP (XCAR (tem
))
7833 || INTEGERP (XCAR (tem
)))
7834 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7837 /* If we got more than one event, put all but the first
7838 onto this list to be read later.
7839 Return just the first event now. */
7840 Vunread_command_events
7841 = nconc2 (XCDR (value
), Vunread_command_events
);
7842 value
= XCAR (value
);
7844 else if (NILP (value
))
7846 if (used_mouse_menu
)
7847 *used_mouse_menu
= 1;
7850 #endif /* HAVE_MENUS */
7854 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7855 We make this bigger when necessary, and never free it. */
7856 static char *read_char_minibuf_menu_text
;
7857 /* Size of that buffer. */
7858 static int read_char_minibuf_menu_width
;
7861 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7867 register Lisp_Object name
;
7869 /* FIXME: Use the minibuffer's frame width. */
7870 int width
= FRAME_WIDTH (SELECTED_FRAME ()) - 4;
7873 Lisp_Object rest
, vector
;
7879 if (! menu_prompting
)
7882 /* Make sure we have a big enough buffer for the menu text. */
7883 if (read_char_minibuf_menu_text
== 0)
7885 read_char_minibuf_menu_width
= width
+ 4;
7886 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
7888 else if (width
+ 4 > read_char_minibuf_menu_width
)
7890 read_char_minibuf_menu_width
= width
+ 4;
7891 read_char_minibuf_menu_text
7892 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
7894 menu
= read_char_minibuf_menu_text
;
7896 /* Get the menu name from the first map that has one (a prompt string). */
7897 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7899 name
= Fkeymap_prompt (maps
[mapno
]);
7904 /* If we don't have any menus, just read a character normally. */
7905 if (!STRINGP (name
))
7908 /* Prompt string always starts with map's prompt, and a space. */
7909 strcpy (menu
, SDATA (name
));
7910 nlength
= SBYTES (name
);
7911 menu
[nlength
++] = ':';
7912 menu
[nlength
++] = ' ';
7915 /* Start prompting at start of first map. */
7919 /* Present the documented bindings, a line at a time. */
7926 Lisp_Object orig_defn_macro
;
7928 /* Loop over elements of map. */
7933 /* If reached end of map, start at beginning of next map. */
7937 /* At end of last map, wrap around to first map if just starting,
7938 or end this line if already have something on it. */
7942 if (notfirst
|| nobindings
) break;
7947 /* Look at the next element of the map. */
7949 elt
= XVECTOR (vector
)->contents
[idx
];
7951 elt
= Fcar_safe (rest
);
7953 if (idx
< 0 && VECTORP (elt
))
7955 /* If we found a dense table in the keymap,
7956 advanced past it, but start scanning its contents. */
7957 rest
= Fcdr_safe (rest
);
7963 /* An ordinary element. */
7964 Lisp_Object event
, tem
;
7968 event
= Fcar_safe (elt
); /* alist */
7969 elt
= Fcdr_safe (elt
);
7973 XSETINT (event
, idx
); /* vector */
7976 /* Ignore the element if it has no prompt string. */
7977 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
7979 /* 1 if the char to type matches the string. */
7981 Lisp_Object upcased_event
, downcased_event
;
7982 Lisp_Object desc
= Qnil
;
7984 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7986 upcased_event
= Fupcase (event
);
7987 downcased_event
= Fdowncase (event
);
7988 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
7989 || XINT (downcased_event
) == SREF (s
, 0));
7991 desc
= Fsingle_key_description (event
, Qnil
);
7993 #if 0 /* It is redundant to list the equivalent key bindings because
7994 the prefix is what the user has already typed. */
7996 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
7998 /* Insert equivalent keybinding. */
7999 s
= concat2 (s
, tem
);
8002 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8003 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8005 /* Insert button prefix. */
8006 Lisp_Object selected
8007 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8008 if (EQ (tem
, QCradio
))
8009 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8011 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8012 s
= concat2 (tem
, s
);
8016 /* If we have room for the prompt string, add it to this line.
8017 If this is the first on the line, always add it. */
8018 if ((SCHARS (s
) + i
+ 2
8019 + (char_matches
? 0 : SCHARS (desc
) + 3))
8025 /* Punctuate between strings. */
8028 strcpy (menu
+ i
, ", ");
8034 /* If the char to type doesn't match the string's
8035 first char, explicitly show what char to type. */
8038 /* Add as much of string as fits. */
8039 thiswidth
= SCHARS (desc
);
8040 if (thiswidth
+ i
> width
)
8041 thiswidth
= width
- i
;
8042 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8044 strcpy (menu
+ i
, " = ");
8048 /* Add as much of string as fits. */
8049 thiswidth
= SCHARS (s
);
8050 if (thiswidth
+ i
> width
)
8051 thiswidth
= width
- i
;
8052 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8058 /* If this element does not fit, end the line now,
8059 and save the element for the next line. */
8060 strcpy (menu
+ i
, "...");
8065 /* Move past this element. */
8066 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8067 /* Handle reaching end of dense table. */
8072 rest
= Fcdr_safe (rest
);
8076 /* Prompt with that and read response. */
8077 message2_nolog (menu
, strlen (menu
),
8078 ! NILP (current_buffer
->enable_multibyte_characters
));
8080 /* Make believe its not a keyboard macro in case the help char
8081 is pressed. Help characters are not recorded because menu prompting
8082 is not used on replay.
8084 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8085 current_kboard
->defining_kbd_macro
= Qnil
;
8087 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8088 while (BUFFERP (obj
));
8089 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8091 if (!INTEGERP (obj
))
8096 if (! EQ (obj
, menu_prompt_more_char
)
8097 && (!INTEGERP (menu_prompt_more_char
)
8098 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8100 if (!NILP (current_kboard
->defining_kbd_macro
))
8101 store_kbd_macro_char (obj
);
8104 /* Help char - go round again */
8108 /* Reading key sequences. */
8110 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8111 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8112 keymap, or nil otherwise. Return the index of the first keymap in
8113 which KEY has any binding, or NMAPS if no map has a binding.
8115 If KEY is a meta ASCII character, treat it like meta-prefix-char
8116 followed by the corresponding non-meta character. Keymaps in
8117 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8120 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8123 NEXT may be the same array as CURRENT. */
8126 follow_key (key
, nmaps
, current
, defs
, next
)
8128 Lisp_Object
*current
, *defs
, *next
;
8131 int i
, first_binding
;
8134 first_binding
= nmaps
;
8135 for (i
= nmaps
- 1; i
>= 0; i
--)
8137 if (! NILP (current
[i
]))
8145 defs
[i
] = access_keymap (map
, key
, 1, 0, 1);
8146 if (! NILP (defs
[i
]))
8153 /* Given the set of bindings we've found, produce the next set of maps. */
8154 if (first_binding
< nmaps
)
8155 for (i
= 0; i
< nmaps
; i
++)
8156 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8158 return first_binding
;
8161 /* Structure used to keep track of partial application of key remapping
8162 such as Vfunction_key_map and Vkey_translation_map. */
8163 typedef struct keyremap
8170 /* Read a sequence of keys that ends with a non prefix character,
8171 storing it in KEYBUF, a buffer of size BUFSIZE.
8173 Return the length of the key sequence stored.
8174 Return -1 if the user rejected a command menu.
8176 Echo starting immediately unless `prompt' is 0.
8178 Where a key sequence ends depends on the currently active keymaps.
8179 These include any minor mode keymaps active in the current buffer,
8180 the current buffer's local map, and the global map.
8182 If a key sequence has no other bindings, we check Vfunction_key_map
8183 to see if some trailing subsequence might be the beginning of a
8184 function key's sequence. If so, we try to read the whole function
8185 key, and substitute its symbolic name into the key sequence.
8187 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8188 `double-' events into similar click events, if that would make them
8189 bound. We try to turn `triple-' events first into `double-' events,
8192 If we get a mouse click in a mode line, vertical divider, or other
8193 non-text area, we treat the click as if it were prefixed by the
8194 symbol denoting that area - `mode-line', `vertical-line', or
8197 If the sequence starts with a mouse click, we read the key sequence
8198 with respect to the buffer clicked on, not the current buffer.
8200 If the user switches frames in the midst of a key sequence, we put
8201 off the switch-frame event until later; the next call to
8202 read_char will return it.
8204 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8205 from the selected window's buffer. */
8208 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8209 can_return_switch_frame
, fix_current_buffer
)
8210 Lisp_Object
*keybuf
;
8213 int dont_downcase_last
;
8214 int can_return_switch_frame
;
8215 int fix_current_buffer
;
8217 volatile Lisp_Object from_string
;
8218 volatile int count
= SPECPDL_INDEX ();
8220 /* How many keys there are in the current key sequence. */
8223 /* The length of the echo buffer when we started reading, and
8224 the length of this_command_keys when we started reading. */
8225 volatile int echo_start
;
8226 volatile int keys_start
;
8228 /* The number of keymaps we're scanning right now, and the number of
8229 keymaps we have allocated space for. */
8231 volatile int nmaps_allocated
= 0;
8233 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8234 the current keymaps. */
8235 Lisp_Object
*volatile defs
= NULL
;
8237 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8238 in the current keymaps, or nil where it is not a prefix. */
8239 Lisp_Object
*volatile submaps
= NULL
;
8241 /* The local map to start out with at start of key sequence. */
8242 volatile Lisp_Object orig_local_map
;
8244 /* The map from the `keymap' property to start out with at start of
8246 volatile Lisp_Object orig_keymap
;
8248 /* 1 if we have already considered switching to the local-map property
8249 of the place where a mouse click occurred. */
8250 volatile int localized_local_map
= 0;
8252 /* The index in defs[] of the first keymap that has a binding for
8253 this key sequence. In other words, the lowest i such that
8254 defs[i] is non-nil. */
8255 volatile int first_binding
;
8256 /* Index of the first key that has no binding.
8257 It is useless to try fkey.start larger than that. */
8258 volatile int first_unbound
;
8260 /* If t < mock_input, then KEYBUF[t] should be read as the next
8263 We use this to recover after recognizing a function key. Once we
8264 realize that a suffix of the current key sequence is actually a
8265 function key's escape sequence, we replace the suffix with the
8266 function key's binding from Vfunction_key_map. Now keybuf
8267 contains a new and different key sequence, so the echo area,
8268 this_command_keys, and the submaps and defs arrays are wrong. In
8269 this situation, we set mock_input to t, set t to 0, and jump to
8270 restart_sequence; the loop will read keys from keybuf up until
8271 mock_input, thus rebuilding the state; and then it will resume
8272 reading characters from the keyboard. */
8273 volatile int mock_input
= 0;
8275 /* If the sequence is unbound in submaps[], then
8276 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8277 and fkey.map is its binding.
8279 These might be > t, indicating that all function key scanning
8280 should hold off until t reaches them. We do this when we've just
8281 recognized a function key, to avoid searching for the function
8282 key's again in Vfunction_key_map. */
8283 volatile keyremap fkey
;
8285 /* Likewise, for key_translation_map. */
8286 volatile keyremap keytran
;
8288 /* If we receive a ``switch-frame'' event in the middle of a key sequence,
8289 we put it off for later. While we're reading, we keep the event here. */
8290 volatile Lisp_Object delayed_switch_frame
;
8292 /* See the comment below... */
8293 #if defined (GOBBLE_FIRST_EVENT)
8294 Lisp_Object first_event
;
8297 volatile Lisp_Object original_uppercase
;
8298 volatile int original_uppercase_position
= -1;
8300 /* Gets around Microsoft compiler limitations. */
8303 struct buffer
*starting_buffer
;
8305 /* List of events for which a fake prefix key has been generated. */
8306 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8308 #if defined (GOBBLE_FIRST_EVENT)
8312 struct gcpro gcpro1
;
8314 GCPRO1 (fake_prefixed_keys
);
8315 raw_keybuf_count
= 0;
8317 last_nonmenu_event
= Qnil
;
8319 delayed_switch_frame
= Qnil
;
8320 fkey
.map
= Vfunction_key_map
;
8321 keytran
.map
= Vkey_translation_map
;
8322 /* If there is no translation-map, turn off scanning. */
8323 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8324 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8329 echo_prompt (prompt
);
8330 else if (cursor_in_echo_area
8331 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8332 && NILP (Fzerop (Vecho_keystrokes
)))
8333 /* This doesn't put in a dash if the echo buffer is empty, so
8334 you don't always see a dash hanging out in the minibuffer. */
8338 /* Record the initial state of the echo area and this_command_keys;
8339 we will need to restore them if we replay a key sequence. */
8341 echo_start
= echo_length ();
8342 keys_start
= this_command_key_count
;
8343 this_single_command_key_start
= keys_start
;
8345 #if defined (GOBBLE_FIRST_EVENT)
8346 /* This doesn't quite work, because some of the things that read_char
8347 does cannot safely be bypassed. It seems too risky to try to make
8350 /* Read the first char of the sequence specially, before setting
8351 up any keymaps, in case a filter runs and switches buffers on us. */
8352 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8354 #endif /* GOBBLE_FIRST_EVENT */
8356 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8357 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8360 /* We jump here when the key sequence has been thoroughly changed, and
8361 we need to rescan it starting from the beginning. When we jump here,
8362 keybuf[0..mock_input] holds the sequence we should reread. */
8365 starting_buffer
= current_buffer
;
8366 first_unbound
= bufsize
+ 1;
8368 /* Build our list of keymaps.
8369 If we recognize a function key and replace its escape sequence in
8370 keybuf with its symbol, or if the sequence starts with a mouse
8371 click and we need to switch buffers, we jump back here to rebuild
8372 the initial keymaps from the current buffer. */
8375 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8376 || !NILP (Voverriding_local_map
))
8378 if (3 > nmaps_allocated
)
8380 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8381 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8382 nmaps_allocated
= 3;
8384 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8385 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8386 if (!NILP (Voverriding_local_map
))
8387 submaps
[nmaps
++] = Voverriding_local_map
;
8395 nminor
= current_minor_maps (0, &maps
);
8396 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8398 if (total
> nmaps_allocated
)
8400 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8401 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8402 nmaps_allocated
= total
;
8405 if (!NILP (orig_keymap
))
8406 submaps
[nmaps
++] = orig_keymap
;
8408 bcopy (maps
, (void *) (submaps
+ nmaps
),
8409 nminor
* sizeof (submaps
[0]));
8413 submaps
[nmaps
++] = orig_local_map
;
8415 submaps
[nmaps
++] = current_global_map
;
8417 /* Find an accurate initial value for first_binding. */
8418 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8419 if (! NILP (submaps
[first_binding
]))
8422 /* Start from the beginning in keybuf. */
8425 /* These are no-ops the first time through, but if we restart, they
8426 revert the echo area and this_command_keys to their original state. */
8427 this_command_key_count
= keys_start
;
8428 if (INTERACTIVE
&& t
< mock_input
)
8429 echo_truncate (echo_start
);
8431 /* If the best binding for the current key sequence is a keymap, or
8432 we may be looking at a function key's escape sequence, keep on
8434 while (first_binding
< nmaps
8435 /* Keep reading as long as there's a prefix binding. */
8436 ? !NILP (submaps
[first_binding
])
8437 /* Don't return in the middle of a possible function key sequence,
8438 if the only bindings we found were via case conversion.
8439 Thus, if ESC O a has a function-key-map translation
8440 and ESC o has a binding, don't return after ESC O,
8441 so that we can translate ESC O plus the next character. */
8442 : (fkey
.start
< t
|| keytran
.start
< t
))
8445 int used_mouse_menu
= 0;
8447 /* Where the last real key started. If we need to throw away a
8448 key that has expanded into more than one element of keybuf
8449 (say, a mouse click on the mode line which is being treated
8450 as [mode-line (mouse-...)], then we backtrack to this point
8452 volatile int last_real_key_start
;
8454 /* These variables are analogous to echo_start and keys_start;
8455 while those allow us to restart the entire key sequence,
8456 echo_local_start and keys_local_start allow us to throw away
8458 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8460 /* key-translation-map is applied *after* function-key-map. */
8461 eassert (keytran
.end
<= fkey
.start
);
8463 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8464 { /* The prefix upto first_unbound has no binding and has
8465 no translation left to do either, so we know it's unbound.
8466 If we don't stop now, we risk staying here indefinitely
8467 (if the user keeps entering fkey or keytran prefixes
8468 like C-c ESC ESC ESC ESC ...) */
8470 for (i
= first_unbound
+ 1; i
< t
; i
++)
8471 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8472 mock_input
= t
- first_unbound
- 1;
8473 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8474 fkey
.map
= Vfunction_key_map
;
8475 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8476 keytran
.map
= Vkey_translation_map
;
8477 goto replay_sequence
;
8481 error ("Key sequence too long");
8484 echo_local_start
= echo_length ();
8485 keys_local_start
= this_command_key_count
;
8486 local_first_binding
= first_binding
;
8489 /* These are no-ops, unless we throw away a keystroke below and
8490 jumped back up to replay_key; in that case, these restore the
8491 variables to their original state, allowing us to replay the
8493 if (INTERACTIVE
&& t
< mock_input
)
8494 echo_truncate (echo_local_start
);
8495 this_command_key_count
= keys_local_start
;
8496 first_binding
= local_first_binding
;
8498 /* By default, assume each event is "real". */
8499 last_real_key_start
= t
;
8501 /* Does mock_input indicate that we are re-reading a key sequence? */
8505 add_command_key (key
);
8506 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8507 && NILP (Fzerop (Vecho_keystrokes
)))
8511 /* If not, we should actually read a character. */
8516 KBOARD
*interrupted_kboard
= current_kboard
;
8517 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8518 if (setjmp (wrong_kboard_jmpbuf
))
8520 if (!NILP (delayed_switch_frame
))
8522 interrupted_kboard
->kbd_queue
8523 = Fcons (delayed_switch_frame
,
8524 interrupted_kboard
->kbd_queue
);
8525 delayed_switch_frame
= Qnil
;
8528 interrupted_kboard
->kbd_queue
8529 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8531 /* If the side queue is non-empty, ensure it begins with a
8532 switch-frame, so we'll replay it in the right context. */
8533 if (CONSP (interrupted_kboard
->kbd_queue
)
8534 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8535 !(EVENT_HAS_PARAMETERS (key
)
8536 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8540 XSETFRAME (frame
, interrupted_frame
);
8541 interrupted_kboard
->kbd_queue
8542 = Fcons (make_lispy_switch_frame (frame
),
8543 interrupted_kboard
->kbd_queue
);
8546 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8547 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8548 goto replay_sequence
;
8551 key
= read_char (NILP (prompt
), nmaps
,
8552 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8556 /* read_char returns t when it shows a menu and the user rejects it.
8560 unbind_to (count
, Qnil
);
8565 /* read_char returns -1 at the end of a macro.
8566 Emacs 18 handles this by returning immediately with a
8567 zero, so that's what we'll do. */
8568 if (INTEGERP (key
) && XINT (key
) == -1)
8571 /* The Microsoft C compiler can't handle the goto that
8577 /* If the current buffer has been changed from under us, the
8578 keymap may have changed, so replay the sequence. */
8581 EMACS_TIME initial_idleness_start_time
;
8582 EMACS_SET_SECS_USECS (initial_idleness_start_time
,
8583 EMACS_SECS (timer_last_idleness_start_time
),
8584 EMACS_USECS (timer_last_idleness_start_time
));
8586 /* Resume idle state, using the same start-time as before. */
8587 timer_start_idle ();
8588 timer_idleness_start_time
= initial_idleness_start_time
;
8591 /* Reset the current buffer from the selected window
8592 in case something changed the former and not the latter.
8593 This is to be more consistent with the behavior
8594 of the command_loop_1. */
8595 if (fix_current_buffer
)
8597 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8599 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8600 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8603 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8604 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8605 goto replay_sequence
;
8608 /* If we have a quit that was typed in another frame, and
8609 quit_throw_to_read_char switched buffers,
8610 replay to get the right keymap. */
8612 && XINT (key
) == quit_char
8613 && current_buffer
!= starting_buffer
)
8616 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8620 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8621 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8622 goto replay_sequence
;
8627 if (EVENT_HAS_PARAMETERS (key
)
8628 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8630 /* If we're at the beginning of a key sequence, and the caller
8631 says it's okay, go ahead and return this event. If we're
8632 in the midst of a key sequence, delay it until the end. */
8633 if (t
> 0 || !can_return_switch_frame
)
8635 delayed_switch_frame
= key
;
8641 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8644 /* Clicks in non-text areas get prefixed by the symbol
8645 in their CHAR-ADDRESS field. For example, a click on
8646 the mode line is prefixed by the symbol `mode-line'.
8648 Furthermore, key sequences beginning with mouse clicks
8649 are read using the keymaps of the buffer clicked on, not
8650 the current buffer. So we may have to switch the buffer
8653 When we turn one event into two events, we must make sure
8654 that neither of the two looks like the original--so that,
8655 if we replay the events, they won't be expanded again.
8656 If not for this, such reexpansion could happen either here
8657 or when user programs play with this-command-keys. */
8658 if (EVENT_HAS_PARAMETERS (key
))
8662 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8663 if (EQ (kind
, Qmouse_click
))
8665 Lisp_Object window
, posn
;
8667 window
= POSN_WINDOW (EVENT_START (key
));
8668 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8671 || (!NILP (fake_prefixed_keys
)
8672 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8674 /* We're looking a second time at an event for which
8675 we generated a fake prefix key. Set
8676 last_real_key_start appropriately. */
8678 last_real_key_start
= t
- 1;
8681 /* Key sequences beginning with mouse clicks are
8682 read using the keymaps in the buffer clicked on,
8683 not the current buffer. If we're at the
8684 beginning of a key sequence, switch buffers. */
8685 if (last_real_key_start
== 0
8687 && BUFFERP (XWINDOW (window
)->buffer
)
8688 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8690 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8694 /* Arrange to go back to the original buffer once we're
8695 done reading the key sequence. Note that we can't
8696 use save_excursion_{save,restore} here, because they
8697 save point as well as the current buffer; we don't
8698 want to save point, because redisplay may change it,
8699 to accommodate a Fset_window_start or something. We
8700 don't want to do this at the top of the function,
8701 because we may get input from a subprocess which
8702 wants to change the selected window and stuff (say,
8704 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8706 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8708 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8709 orig_local_map
= get_local_map (PT
, current_buffer
,
8711 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8712 goto replay_sequence
;
8715 /* For a mouse click, get the local text-property keymap
8716 of the place clicked on, rather than point. */
8717 if (last_real_key_start
== 0
8718 && CONSP (XCDR (key
))
8719 && ! localized_local_map
)
8721 Lisp_Object map_here
, start
, pos
;
8723 localized_local_map
= 1;
8724 start
= EVENT_START (key
);
8726 if (CONSP (start
) && CONSP (XCDR (start
)))
8728 pos
= POSN_BUFFER_POSN (start
);
8730 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8732 map_here
= get_local_map (XINT (pos
),
8733 current_buffer
, Qlocal_map
);
8734 if (!EQ (map_here
, orig_local_map
))
8736 orig_local_map
= map_here
;
8740 goto replay_sequence
;
8742 map_here
= get_local_map (XINT (pos
),
8743 current_buffer
, Qkeymap
);
8744 if (!EQ (map_here
, orig_keymap
))
8746 orig_keymap
= map_here
;
8750 goto replay_sequence
;
8756 /* Expand mode-line and scroll-bar events into two events:
8757 use posn as a fake prefix key. */
8759 && (NILP (fake_prefixed_keys
)
8760 || NILP (Fmemq (key
, fake_prefixed_keys
))))
8762 if (t
+ 1 >= bufsize
)
8763 error ("Key sequence too long");
8766 keybuf
[t
+ 1] = key
;
8769 /* Record that a fake prefix key has been generated
8770 for KEY. Don't modify the event; this would
8771 prevent proper action when the event is pushed
8772 back into unread-command-events. */
8773 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
8775 /* If on a mode line string with a local keymap,
8776 reconsider the key sequence with that keymap. */
8777 if (CONSP (POSN_STRING (EVENT_START (key
))))
8779 Lisp_Object string
, pos
, map
, map2
;
8781 string
= POSN_STRING (EVENT_START (key
));
8782 pos
= XCDR (string
);
8783 string
= XCAR (string
);
8785 && XINT (pos
) < SCHARS (string
))
8787 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8789 orig_local_map
= map
;
8790 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8793 if (!NILP (map
) || !NILP (map2
))
8794 goto replay_sequence
;
8800 else if (CONSP (POSN_STRING (EVENT_START (key
)))
8801 && NILP (from_string
))
8803 /* For a click on a string, i.e. overlay string or a
8804 string displayed via the `display' property,
8805 consider `local-map' and `keymap' properties of
8807 Lisp_Object string
, pos
, map
, map2
;
8809 string
= POSN_STRING (EVENT_START (key
));
8810 pos
= XCDR (string
);
8811 string
= XCAR (string
);
8813 && XINT (pos
) < SCHARS (string
))
8815 map
= Fget_text_property (pos
, Qlocal_map
, string
);
8817 orig_local_map
= map
;
8818 map2
= Fget_text_property (pos
, Qkeymap
, string
);
8822 if (!NILP (map
) || !NILP (map2
))
8824 from_string
= string
;
8825 goto replay_sequence
;
8830 else if (CONSP (XCDR (key
))
8831 && CONSP (EVENT_START (key
))
8832 && CONSP (XCDR (EVENT_START (key
))))
8836 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8837 /* Handle menu-bar events:
8838 insert the dummy prefix event `menu-bar'. */
8839 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
8841 if (t
+ 1 >= bufsize
)
8842 error ("Key sequence too long");
8846 /* Zap the position in key, so we know that we've
8847 expanded it, and don't try to do so again. */
8848 POSN_BUFFER_SET_POSN (EVENT_START (key
),
8849 Fcons (posn
, Qnil
));
8852 goto replay_sequence
;
8854 else if (CONSP (posn
))
8856 /* We're looking at the second event of a
8857 sequence which we expanded before. Set
8858 last_real_key_start appropriately. */
8859 if (last_real_key_start
== t
&& t
> 0)
8860 last_real_key_start
= t
- 1;
8865 /* We have finally decided that KEY is something we might want
8867 first_binding
= (follow_key (key
,
8868 nmaps
- first_binding
,
8869 submaps
+ first_binding
,
8870 defs
+ first_binding
,
8871 submaps
+ first_binding
)
8874 /* If KEY wasn't bound, we'll try some fallbacks. */
8875 if (first_binding
< nmaps
)
8876 /* This is needed for the following scenario:
8877 event 0: a down-event that gets dropped by calling replay_key.
8878 event 1: some normal prefix like C-h.
8879 After event 0, first_unbound is 0, after event 1 fkey.start
8880 and keytran.start are both 1, so when we see that C-h is bound,
8881 we need to update first_unbound. */
8882 first_unbound
= max (t
+ 1, first_unbound
);
8887 /* Remember the position to put an upper bound on fkey.start. */
8888 first_unbound
= min (t
, first_unbound
);
8890 head
= EVENT_HEAD (key
);
8891 if (help_char_p (head
) && t
> 0)
8893 read_key_sequence_cmd
= Vprefix_help_command
;
8895 last_nonmenu_event
= key
;
8896 /* The Microsoft C compiler can't handle the goto that
8904 Lisp_Object breakdown
;
8907 breakdown
= parse_modifiers (head
);
8908 modifiers
= XINT (XCAR (XCDR (breakdown
)));
8909 /* Attempt to reduce an unbound mouse event to a simpler
8910 event that is bound:
8911 Drags reduce to clicks.
8912 Double-clicks reduce to clicks.
8913 Triple-clicks reduce to double-clicks, then to clicks.
8914 Down-clicks are eliminated.
8915 Double-downs reduce to downs, then are eliminated.
8916 Triple-downs reduce to double-downs, then to downs,
8917 then are eliminated. */
8918 if (modifiers
& (down_modifier
| drag_modifier
8919 | double_modifier
| triple_modifier
))
8921 while (modifiers
& (down_modifier
| drag_modifier
8922 | double_modifier
| triple_modifier
))
8924 Lisp_Object new_head
, new_click
;
8925 if (modifiers
& triple_modifier
)
8926 modifiers
^= (double_modifier
| triple_modifier
);
8927 else if (modifiers
& double_modifier
)
8928 modifiers
&= ~double_modifier
;
8929 else if (modifiers
& drag_modifier
)
8930 modifiers
&= ~drag_modifier
;
8933 /* Dispose of this `down' event by simply jumping
8934 back to replay_key, to get another event.
8936 Note that if this event came from mock input,
8937 then just jumping back to replay_key will just
8938 hand it to us again. So we have to wipe out any
8941 We could delete keybuf[t] and shift everything
8942 after that to the left by one spot, but we'd also
8943 have to fix up any variable that points into
8944 keybuf, and shifting isn't really necessary
8947 Adding prefixes for non-textual mouse clicks
8948 creates two characters of mock input, and both
8949 must be thrown away. If we're only looking at
8950 the prefix now, we can just jump back to
8951 replay_key. On the other hand, if we've already
8952 processed the prefix, and now the actual click
8953 itself is giving us trouble, then we've lost the
8954 state of the keymaps we want to backtrack to, and
8955 we need to replay the whole sequence to rebuild
8958 Beyond that, only function key expansion could
8959 create more than two keys, but that should never
8960 generate mouse events, so it's okay to zero
8961 mock_input in that case too.
8963 FIXME: The above paragraph seems just plain
8964 wrong, if you consider things like
8965 xterm-mouse-mode. -stef
8967 Isn't this just the most wonderful code ever? */
8968 if (t
== last_real_key_start
)
8975 mock_input
= last_real_key_start
;
8976 goto replay_sequence
;
8981 = apply_modifiers (modifiers
, XCAR (breakdown
));
8983 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
8985 /* Look for a binding for this new key. follow_key
8986 promises that it didn't munge submaps the
8987 last time we called it, since key was unbound. */
8989 = (follow_key (new_click
,
8990 nmaps
- local_first_binding
,
8991 submaps
+ local_first_binding
,
8992 defs
+ local_first_binding
,
8993 submaps
+ local_first_binding
)
8994 + local_first_binding
);
8996 /* If that click is bound, go for it. */
8997 if (first_binding
< nmaps
)
9002 /* Otherwise, we'll leave key set to the drag event. */
9009 /* Normally, last_nonmenu_event gets the previous key we read.
9010 But when a mouse popup menu is being used,
9011 we don't update last_nonmenu_event; it continues to hold the mouse
9012 event that preceded the first level of menu. */
9013 if (!used_mouse_menu
)
9014 last_nonmenu_event
= key
;
9016 /* Record what part of this_command_keys is the current key sequence. */
9017 this_single_command_key_start
= this_command_key_count
- t
;
9019 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9020 /* There is a binding and it's not a prefix.
9021 There is thus no function-key in this sequence.
9022 Moving fkey.start is important in this case to allow keytran.start
9023 to go over the sequence before we return (since we keep the
9024 invariant that keytran.end <= fkey.start). */
9027 (fkey
.start
= fkey
.end
= t
, fkey
.map
= Vfunction_key_map
);
9030 /* If the sequence is unbound, see if we can hang a function key
9031 off the end of it. */
9035 /* Continue scan from fkey.end until we find a bound suffix.
9036 If we fail, increment fkey.start and start over from there. */
9037 while (fkey
.end
< t
)
9041 key
= keybuf
[fkey
.end
++];
9042 next
= access_keymap (fkey
.map
, key
, 1, 0, 1);
9044 /* Handle symbol with autoload definition. */
9045 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9046 && CONSP (XSYMBOL (next
)->function
)
9047 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
9048 do_autoload (XSYMBOL (next
)->function
, next
);
9050 /* Handle a symbol whose function definition is a keymap
9052 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9053 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
9054 || KEYMAPP (XSYMBOL (next
)->function
)))
9055 next
= XSYMBOL (next
)->function
;
9057 #if 0 /* I didn't turn this on, because it might cause trouble
9058 for the mapping of return into C-m and tab into C-i. */
9059 /* Optionally don't map function keys into other things.
9060 This enables the user to redefine kp- keys easily. */
9061 if (SYMBOLP (key
) && !NILP (Vinhibit_function_key_mapping
))
9065 /* If the function key map gives a function, not an
9066 array, then call the function with no args and use
9067 its value instead. */
9068 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9069 /* If there's a binding (i.e. first_binding >= nmaps)
9070 we don't want to apply this function-key-mapping. */
9071 && fkey
.end
== t
&& first_binding
>= nmaps
)
9073 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9077 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9078 next
= call1 (next
, prompt
);
9080 /* If the function returned something invalid,
9081 barf--don't ignore it.
9082 (To ignore it safely, we would need to gcpro a bunch of
9083 other variables.) */
9084 if (! (VECTORP (next
) || STRINGP (next
)))
9085 error ("Function in key-translation-map returns invalid key sequence");
9088 /* If keybuf[fkey.start..fkey.end] is bound in the
9089 function key map and it's a suffix of the current
9090 sequence (i.e. fkey.end == t), replace it with
9091 the binding and restart with fkey.start at the end. */
9092 if ((VECTORP (next
) || STRINGP (next
))
9093 /* If there's a binding (i.e. first_binding >= nmaps)
9094 we don't want to apply this function-key-mapping. */
9095 && fkey
.end
== t
&& first_binding
>= nmaps
)
9097 int len
= XFASTINT (Flength (next
));
9099 t
= fkey
.start
+ len
;
9101 error ("Key sequence too long");
9104 bcopy (XVECTOR (next
)->contents
,
9105 keybuf
+ fkey
.start
,
9106 (t
- fkey
.start
) * sizeof (keybuf
[0]));
9107 else if (STRINGP (next
))
9111 for (i
= 0; i
< len
; i
++)
9112 XSETFASTINT (keybuf
[fkey
.start
+ i
], SREF (next
, i
));
9116 fkey
.start
= fkey
.end
= t
;
9117 fkey
.map
= Vfunction_key_map
;
9119 /* Do pass the results through key-translation-map.
9120 But don't retranslate what key-translation-map
9121 has already translated. */
9122 keytran
.end
= keytran
.start
;
9123 keytran
.map
= Vkey_translation_map
;
9125 goto replay_sequence
;
9128 fkey
.map
= get_keymap (next
, 0, 1);
9130 /* If we no longer have a bound suffix, try a new positions for
9132 if (!CONSP (fkey
.map
))
9134 fkey
.end
= ++fkey
.start
;
9135 fkey
.map
= Vfunction_key_map
;
9140 /* Look for this sequence in key-translation-map. */
9144 /* Scan from keytran.end until we find a bound suffix. */
9145 while (keytran
.end
< fkey
.start
)
9149 key
= keybuf
[keytran
.end
++];
9150 next
= access_keymap (keytran
.map
, key
, 1, 0, 1);
9152 /* Handle symbol with autoload definition. */
9153 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9154 && CONSP (XSYMBOL (next
)->function
)
9155 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
9156 do_autoload (XSYMBOL (next
)->function
, next
);
9158 /* Handle a symbol whose function definition is a keymap
9160 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
))
9161 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
9162 || KEYMAPP (XSYMBOL (next
)->function
)))
9163 next
= XSYMBOL (next
)->function
;
9165 /* If the key translation map gives a function, not an
9166 array, then call the function with one arg and use
9167 its value instead. */
9168 if (SYMBOLP (next
) && ! NILP (Ffboundp (next
)))
9170 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9174 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9175 next
= call1 (next
, prompt
);
9177 /* If the function returned something invalid,
9178 barf--don't ignore it.
9179 (To ignore it safely, we would need to gcpro a bunch of
9180 other variables.) */
9181 if (! (VECTORP (next
) || STRINGP (next
)))
9182 error ("Function in key-translation-map returns invalid key sequence");
9185 /* If keybuf[keytran.start..keytran.end] is bound in the
9186 key translation map and it's a suffix of the current
9187 sequence (i.e. keytran.end == t), replace it with
9188 the binding and restart with keytran.start at the end. */
9189 if ((VECTORP (next
) || STRINGP (next
)))
9191 int len
= XFASTINT (Flength (next
));
9192 int i
, diff
= len
- (keytran
.end
- keytran
.start
);
9194 mock_input
= max (t
, mock_input
);
9195 if (mock_input
+ diff
>= bufsize
)
9196 error ("Key sequence too long");
9198 /* Shift the keys that are after keytran.end. */
9200 for (i
= keytran
.end
; i
< mock_input
; i
++)
9201 keybuf
[i
+ diff
] = keybuf
[i
];
9203 for (i
= mock_input
- 1; i
>= keytran
.end
; i
--)
9204 keybuf
[i
+ diff
] = keybuf
[i
];
9205 /* Replace the keys between keytran.start and keytran.end
9206 with those from next. */
9207 for (i
= 0; i
< len
; i
++)
9208 keybuf
[keytran
.start
+ i
]
9209 = Faref (next
, make_number (i
));
9212 keytran
.start
= keytran
.end
+= diff
;
9213 keytran
.map
= Vkey_translation_map
;
9215 /* Adjust the function-key-map counters. */
9219 goto replay_sequence
;
9222 keytran
.map
= get_keymap (next
, 0, 1);
9224 /* If we no longer have a bound suffix, try a new positions for
9226 if (!CONSP (keytran
.map
))
9228 keytran
.end
= ++keytran
.start
;
9229 keytran
.map
= Vkey_translation_map
;
9234 /* If KEY is not defined in any of the keymaps,
9235 and cannot be part of a function key or translation,
9236 and is an upper case letter
9237 use the corresponding lower-case letter instead. */
9238 if (first_binding
>= nmaps
9239 && fkey
.start
>= t
&& keytran
.start
>= t
9241 && ((((XINT (key
) & 0x3ffff)
9242 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9243 && UPPERCASEP (XINT (key
) & 0x3ffff))
9244 || (XINT (key
) & shift_modifier
)))
9246 Lisp_Object new_key
;
9248 original_uppercase
= key
;
9249 original_uppercase_position
= t
- 1;
9251 if (XINT (key
) & shift_modifier
)
9252 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9254 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9255 | (XINT (key
) & ~0x3ffff)));
9257 /* We have to do this unconditionally, regardless of whether
9258 the lower-case char is defined in the keymaps, because they
9259 might get translated through function-key-map. */
9260 keybuf
[t
- 1] = new_key
;
9261 mock_input
= max (t
, mock_input
);
9263 goto replay_sequence
;
9265 /* If KEY is not defined in any of the keymaps,
9266 and cannot be part of a function key or translation,
9267 and is a shifted function key,
9268 use the corresponding unshifted function key instead. */
9269 if (first_binding
>= nmaps
9270 && fkey
.start
>= t
&& keytran
.start
>= t
9273 Lisp_Object breakdown
;
9276 breakdown
= parse_modifiers (key
);
9277 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9278 if (modifiers
& shift_modifier
)
9280 Lisp_Object new_key
;
9282 original_uppercase
= key
;
9283 original_uppercase_position
= t
- 1;
9285 modifiers
&= ~shift_modifier
;
9286 new_key
= apply_modifiers (modifiers
,
9289 keybuf
[t
- 1] = new_key
;
9290 mock_input
= max (t
, mock_input
);
9292 goto replay_sequence
;
9298 read_key_sequence_cmd
= (first_binding
< nmaps
9299 ? defs
[first_binding
]
9302 unread_switch_frame
= delayed_switch_frame
;
9303 unbind_to (count
, Qnil
);
9305 /* Don't downcase the last character if the caller says don't.
9306 Don't downcase it if the result is undefined, either. */
9307 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9308 && t
- 1 == original_uppercase_position
)
9309 keybuf
[t
- 1] = original_uppercase
;
9311 /* Occasionally we fabricate events, perhaps by expanding something
9312 according to function-key-map, or by adding a prefix symbol to a
9313 mouse click in the scroll bar or modeline. In this cases, return
9314 the entire generated key sequence, even if we hit an unbound
9315 prefix or a definition before the end. This means that you will
9316 be able to push back the event properly, and also means that
9317 read-key-sequence will always return a logical unit.
9320 for (; t
< mock_input
; t
++)
9322 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9323 && NILP (Fzerop (Vecho_keystrokes
)))
9324 echo_char (keybuf
[t
]);
9325 add_command_key (keybuf
[t
]);
9334 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9335 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9336 The sequence is sufficient to specify a non-prefix command in the
9337 current local and global maps.
9339 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9340 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9341 as a continuation of the previous key.
9343 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9344 convert the last event to lower case. (Normally any upper case event
9345 is converted to lower case if the original event is undefined and the lower
9346 case equivalent is defined.) A non-nil value is appropriate for reading
9347 a key sequence to be defined.
9349 A C-g typed while in this function is treated like any other character,
9350 and `quit-flag' is not set.
9352 If the key sequence starts with a mouse click, then the sequence is read
9353 using the keymaps of the buffer of the window clicked in, not the buffer
9354 of the selected window as normal.
9356 `read-key-sequence' drops unbound button-down events, since you normally
9357 only care about the click or drag events which follow them. If a drag
9358 or multi-click event is unbound, but the corresponding click event would
9359 be bound, `read-key-sequence' turns the event into a click event at the
9360 drag's starting position. This means that you don't have to distinguish
9361 between click and drag, double, or triple events unless you want to.
9363 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9364 lines separating windows, and scroll bars with imaginary keys
9365 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9367 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9368 function will process a switch-frame event if the user switches frames
9369 before typing anything. If the user switches frames in the middle of a
9370 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9371 is nil, then the event will be put off until after the current key sequence.
9373 `read-key-sequence' checks `function-key-map' for function key
9374 sequences, where they wouldn't conflict with ordinary bindings. See
9375 `function-key-map' for more details.
9377 The optional fifth argument COMMAND-LOOP, if non-nil, means
9378 that this key sequence is being read by something that will
9379 read commands one after another. It should be nil if the caller
9380 will read just one key sequence. */)
9381 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9383 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9384 Lisp_Object can_return_switch_frame
, command_loop
;
9386 Lisp_Object keybuf
[30];
9388 struct gcpro gcpro1
;
9389 int count
= SPECPDL_INDEX ();
9392 CHECK_STRING (prompt
);
9395 specbind (Qinput_method_exit_on_first_char
,
9396 (NILP (command_loop
) ? Qt
: Qnil
));
9397 specbind (Qinput_method_use_echo_area
,
9398 (NILP (command_loop
) ? Qt
: Qnil
));
9400 bzero (keybuf
, sizeof keybuf
);
9402 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9404 if (NILP (continue_echo
))
9406 this_command_key_count
= 0;
9407 this_single_command_key_start
= 0;
9410 #ifdef HAVE_X_WINDOWS
9411 if (display_hourglass_p
)
9412 cancel_hourglass ();
9415 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9416 prompt
, ! NILP (dont_downcase_last
),
9417 ! NILP (can_return_switch_frame
), 0);
9419 #if 0 /* The following is fine for code reading a key sequence and
9420 then proceeding with a lenghty computation, but it's not good
9421 for code reading keys in a loop, like an input method. */
9422 #ifdef HAVE_X_WINDOWS
9423 if (display_hourglass_p
)
9434 return unbind_to (count
, make_event_array (i
, keybuf
));
9437 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9438 Sread_key_sequence_vector
, 1, 5, 0,
9439 doc
: /* Like `read-key-sequence' but always return a vector. */)
9440 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9442 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9443 Lisp_Object can_return_switch_frame
, command_loop
;
9445 Lisp_Object keybuf
[30];
9447 struct gcpro gcpro1
;
9448 int count
= SPECPDL_INDEX ();
9451 CHECK_STRING (prompt
);
9454 specbind (Qinput_method_exit_on_first_char
,
9455 (NILP (command_loop
) ? Qt
: Qnil
));
9456 specbind (Qinput_method_use_echo_area
,
9457 (NILP (command_loop
) ? Qt
: Qnil
));
9459 bzero (keybuf
, sizeof keybuf
);
9461 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9463 if (NILP (continue_echo
))
9465 this_command_key_count
= 0;
9466 this_single_command_key_start
= 0;
9469 #ifdef HAVE_X_WINDOWS
9470 if (display_hourglass_p
)
9471 cancel_hourglass ();
9474 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9475 prompt
, ! NILP (dont_downcase_last
),
9476 ! NILP (can_return_switch_frame
), 0);
9478 #ifdef HAVE_X_WINDOWS
9479 if (display_hourglass_p
)
9489 return unbind_to (count
, Fvector (i
, keybuf
));
9492 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9493 doc
: /* Execute CMD as an editor command.
9494 CMD must be a symbol that satisfies the `commandp' predicate.
9495 Optional second arg RECORD-FLAG non-nil
9496 means unconditionally put this command in `command-history'.
9497 Otherwise, that is done only if an arg is read using the minibuffer.
9498 The argument KEYS specifies the value to use instead of (this-command-keys)
9499 when reading the arguments; if it is nil, (this-command-keys) is used.
9500 The argument SPECIAL, if non-nil, means that this command is executing
9501 a special event, so ignore the prefix argument and don't clear it. */)
9502 (cmd
, record_flag
, keys
, special
)
9503 Lisp_Object cmd
, record_flag
, keys
, special
;
9505 register Lisp_Object final
;
9506 register Lisp_Object tem
;
9507 Lisp_Object prefixarg
;
9508 struct backtrace backtrace
;
9509 extern int debug_on_next_call
;
9511 debug_on_next_call
= 0;
9515 prefixarg
= current_kboard
->Vprefix_arg
;
9516 Vcurrent_prefix_arg
= prefixarg
;
9517 current_kboard
->Vprefix_arg
= Qnil
;
9524 tem
= Fget (cmd
, Qdisabled
);
9525 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9527 tem
= Fsymbol_value (Qdisabled_command_hook
);
9529 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9535 final
= Findirect_function (cmd
);
9537 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9539 struct gcpro gcpro1
, gcpro2
;
9541 GCPRO2 (cmd
, prefixarg
);
9542 do_autoload (final
, cmd
);
9549 if (STRINGP (final
) || VECTORP (final
))
9551 /* If requested, place the macro in the command history. For
9552 other sorts of commands, call-interactively takes care of
9554 if (!NILP (record_flag
))
9557 = Fcons (Fcons (Qexecute_kbd_macro
,
9558 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9561 /* Don't keep command history around forever. */
9562 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9564 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9566 XSETCDR (tem
, Qnil
);
9570 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9573 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9575 backtrace
.next
= backtrace_list
;
9576 backtrace_list
= &backtrace
;
9577 backtrace
.function
= &Qcall_interactively
;
9578 backtrace
.args
= &cmd
;
9579 backtrace
.nargs
= 1;
9580 backtrace
.evalargs
= 0;
9582 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9584 backtrace_list
= backtrace
.next
;
9592 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9594 doc
: /* Read function name, then read its arguments and call it. */)
9596 Lisp_Object prefixarg
;
9598 Lisp_Object function
;
9600 int saved_last_point_position
;
9601 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9602 Lisp_Object bindings
, value
;
9603 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9605 saved_keys
= Fvector (this_command_key_count
,
9606 XVECTOR (this_command_keys
)->contents
);
9607 saved_last_point_position_buffer
= last_point_position_buffer
;
9608 saved_last_point_position
= last_point_position
;
9610 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9612 if (EQ (prefixarg
, Qminus
))
9614 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9615 strcpy (buf
, "C-u ");
9616 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9618 if (sizeof (int) == sizeof (EMACS_INT
))
9619 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9620 else if (sizeof (long) == sizeof (EMACS_INT
))
9621 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9625 else if (INTEGERP (prefixarg
))
9627 if (sizeof (int) == sizeof (EMACS_INT
))
9628 sprintf (buf
, "%d ", XINT (prefixarg
));
9629 else if (sizeof (long) == sizeof (EMACS_INT
))
9630 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9635 /* This isn't strictly correct if execute-extended-command
9636 is bound to anything else. Perhaps it should use
9637 this_command_keys? */
9638 strcat (buf
, "M-x ");
9640 /* Prompt with buf, and then read a string, completing from and
9641 restricting to the set of all defined commands. Don't provide
9642 any initial input. Save the command read on the extended-command
9644 function
= Fcompleting_read (build_string (buf
),
9645 Vobarray
, Qcommandp
,
9646 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9649 if (STRINGP (function
) && SCHARS (function
) == 0)
9650 error ("No command name given");
9652 /* Set this_command_keys to the concatenation of saved_keys and
9653 function, followed by a RET. */
9658 this_command_key_count
= 0;
9659 this_single_command_key_start
= 0;
9661 keys
= XVECTOR (saved_keys
)->contents
;
9662 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9663 add_command_key (keys
[i
]);
9665 for (i
= 0; i
< SCHARS (function
); i
++)
9666 add_command_key (Faref (function
, make_number (i
)));
9668 add_command_key (make_number ('\015'));
9671 last_point_position
= saved_last_point_position
;
9672 last_point_position_buffer
= saved_last_point_position_buffer
;
9676 function
= Fintern (function
, Qnil
);
9677 current_kboard
->Vprefix_arg
= prefixarg
;
9678 Vthis_command
= function
;
9679 real_this_command
= function
;
9681 /* If enabled, show which key runs this command. */
9682 if (!NILP (Vsuggest_key_bindings
)
9683 && NILP (Vexecuting_macro
)
9684 && SYMBOLP (function
))
9685 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9691 GCPRO2 (bindings
, value
);
9692 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9694 /* If the command has a key binding, print it now. */
9695 if (!NILP (bindings
)
9696 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9699 /* But first wait, and skip the message if there is input. */
9701 if (!NILP (echo_area_buffer
[0]))
9702 /* This command displayed something in the echo area;
9703 so wait a few seconds, then display our suggestion message. */
9704 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9705 ? XINT (Vsuggest_key_bindings
) : 2);
9707 /* This command left the echo area empty,
9708 so display our message immediately. */
9711 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9712 && ! CONSP (Vunread_command_events
))
9714 Lisp_Object binding
;
9716 int message_p
= push_message ();
9717 int count
= SPECPDL_INDEX ();
9719 record_unwind_protect (pop_message_unwind
, Qnil
);
9720 binding
= Fkey_description (bindings
);
9723 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9726 sprintf (newmessage
, "You can run the command `%s' with %s",
9727 SDATA (SYMBOL_NAME (function
)),
9729 message2_nolog (newmessage
,
9730 strlen (newmessage
),
9731 STRING_MULTIBYTE (binding
));
9732 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9733 ? Vsuggest_key_bindings
: make_number (2)),
9738 unbind_to (count
, Qnil
);
9742 RETURN_UNGCPRO (value
);
9746 /* Return nonzero if input events are pending. */
9749 detect_input_pending ()
9752 get_input_pending (&input_pending
, 0);
9754 return input_pending
;
9757 /* Return nonzero if input events are pending, and run any pending timers. */
9760 detect_input_pending_run_timers (do_display
)
9763 int old_timers_run
= timers_run
;
9766 get_input_pending (&input_pending
, 1);
9768 if (old_timers_run
!= timers_run
&& do_display
)
9770 redisplay_preserve_echo_area (8);
9771 /* The following fixes a bug when using lazy-lock with
9772 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9773 from an idle timer function. The symptom of the bug is that
9774 the cursor sometimes doesn't become visible until the next X
9775 event is processed. --gerd. */
9777 rif
->flush_display (NULL
);
9780 return input_pending
;
9783 /* This is called in some cases before a possible quit.
9784 It cases the next call to detect_input_pending to recompute input_pending.
9785 So calling this function unnecessarily can't do any harm. */
9788 clear_input_pending ()
9793 /* Return nonzero if there are pending requeued events.
9794 This isn't used yet. The hope is to make wait_reading_process_input
9795 call it, and return if it runs Lisp code that unreads something.
9796 The problem is, kbd_buffer_get_event needs to be fixed to know what
9797 to do in that case. It isn't trivial. */
9800 requeued_events_pending_p ()
9802 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9806 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9807 doc
: /* Return t if command input is currently available with no wait.
9808 Actually, the value is nil only if we can be sure that no input is available;
9809 if there is a doubt, the value is t. */)
9812 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9815 get_filtered_input_pending (&input_pending
, 1, 1);
9816 return input_pending
> 0 ? Qt
: Qnil
;
9819 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9820 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9823 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9826 if (total_keys
< NUM_RECENT_KEYS
)
9827 return Fvector (total_keys
, keys
);
9830 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9831 bcopy (keys
+ recent_keys_index
,
9832 XVECTOR (val
)->contents
,
9833 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9835 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9836 recent_keys_index
* sizeof (Lisp_Object
));
9841 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9842 doc
: /* Return the key sequence that invoked this command.
9843 However, if the command has called `read-key-sequence', it returns
9844 the last key sequence that has been read.
9845 The value is a string or a vector. */)
9848 return make_event_array (this_command_key_count
,
9849 XVECTOR (this_command_keys
)->contents
);
9852 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9853 doc
: /* Return the key sequence that invoked this command, as a vector.
9854 However, if the command has called `read-key-sequence', it returns
9855 the last key sequence that has been read. */)
9858 return Fvector (this_command_key_count
,
9859 XVECTOR (this_command_keys
)->contents
);
9862 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9863 Sthis_single_command_keys
, 0, 0, 0,
9864 doc
: /* Return the key sequence that invoked this command.
9865 More generally, it returns the last key sequence read, either by
9866 the command loop or by `read-key-sequence'.
9867 Unlike `this-command-keys', this function's value
9868 does not include prefix arguments.
9869 The value is always a vector. */)
9872 return Fvector (this_command_key_count
9873 - this_single_command_key_start
,
9874 (XVECTOR (this_command_keys
)->contents
9875 + this_single_command_key_start
));
9878 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9879 Sthis_single_command_raw_keys
, 0, 0, 0,
9880 doc
: /* Return the raw events that were read for this command.
9881 More generally, it returns the last key sequence read, either by
9882 the command loop or by `read-key-sequence'.
9883 Unlike `this-single-command-keys', this function's value
9884 shows the events before all translations (except for input methods).
9885 The value is always a vector. */)
9888 return Fvector (raw_keybuf_count
,
9889 (XVECTOR (raw_keybuf
)->contents
));
9892 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9893 Sreset_this_command_lengths
, 0, 0, 0,
9894 doc
: /* Used for complicated reasons in `universal-argument-other-key'.
9896 `universal-argument-other-key' rereads the event just typed.
9897 It then gets translated through `function-key-map'.
9898 The translated event gets included in the echo area and in
9899 the value of `this-command-keys' in addition to the raw original event.
9902 Calling this function directs the translated event to replace
9903 the original event, so that only one version of the event actually
9904 appears in the echo area and in the value of `this-command-keys'. */)
9907 this_command_key_count
= before_command_key_count
;
9908 if (this_command_key_count
< this_single_command_key_start
)
9909 this_single_command_key_start
= this_command_key_count
;
9910 echo_truncate (before_command_echo_length
);
9915 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9916 Sclear_this_command_keys
, 0, 1, 0,
9917 doc
: /* Clear out the vector that `this-command-keys' returns.
9918 Also clear the record of the last 100 events, unless optional arg
9919 KEEP-RECORD is non-nil. */)
9921 Lisp_Object keep_record
;
9925 this_command_key_count
= 0;
9927 if (NILP (keep_record
))
9929 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
9930 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
9932 recent_keys_index
= 0;
9937 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
9938 doc
: /* Return the current depth in recursive edits. */)
9942 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
9946 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
9947 "FOpen dribble file: ",
9948 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
9949 If FILE is nil, close any open dribble file. */)
9960 file
= Fexpand_file_name (file
, Qnil
);
9961 dribble
= fopen (SDATA (file
), "w");
9963 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
9968 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
9969 doc
: /* Discard the contents of the terminal input buffer.
9970 Also end any kbd macro being defined. */)
9973 if (!NILP (current_kboard
->defining_kbd_macro
))
9975 /* Discard the last command from the macro. */
9976 Fcancel_kbd_macro_events ();
9980 update_mode_lines
++;
9982 Vunread_command_events
= Qnil
;
9983 unread_command_char
= -1;
9985 discard_tty_input ();
9987 kbd_fetch_ptr
= kbd_store_ptr
;
9988 Ffillarray (kbd_buffer_gcpro
, Qnil
);
9994 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
9995 doc
: /* Stop Emacs and return to superior process. You can resume later.
9996 If `cannot-suspend' is non-nil, or if the system doesn't support job
9997 control, run a subshell instead.
9999 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10000 to be read as terminal input by Emacs's parent, after suspension.
10002 Before suspending, run the normal hook `suspend-hook'.
10003 After resumption run the normal hook `suspend-resume-hook'.
10005 Some operating systems cannot stop the Emacs process and resume it later.
10006 On such systems, Emacs starts a subshell instead of suspending. */)
10008 Lisp_Object stuffstring
;
10010 int count
= SPECPDL_INDEX ();
10011 int old_height
, old_width
;
10013 struct gcpro gcpro1
;
10015 if (!NILP (stuffstring
))
10016 CHECK_STRING (stuffstring
);
10018 /* Run the functions in suspend-hook. */
10019 if (!NILP (Vrun_hooks
))
10020 call1 (Vrun_hooks
, intern ("suspend-hook"));
10022 GCPRO1 (stuffstring
);
10023 get_frame_size (&old_width
, &old_height
);
10024 reset_sys_modes ();
10025 /* sys_suspend can get an error if it tries to fork a subshell
10026 and the system resources aren't available for that. */
10027 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10029 stuff_buffered_input (stuffstring
);
10030 if (cannot_suspend
)
10034 unbind_to (count
, Qnil
);
10036 /* Check if terminal/window size has changed.
10037 Note that this is not useful when we are running directly
10038 with a window system; but suspend should be disabled in that case. */
10039 get_frame_size (&width
, &height
);
10040 if (width
!= old_width
|| height
!= old_height
)
10041 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10043 /* Run suspend-resume-hook. */
10044 if (!NILP (Vrun_hooks
))
10045 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10051 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10052 Then in any case stuff anything Emacs has read ahead and not used. */
10055 stuff_buffered_input (stuffstring
)
10056 Lisp_Object stuffstring
;
10058 /* stuff_char works only in BSD, versions 4.2 and up. */
10061 register unsigned char *p
;
10063 if (STRINGP (stuffstring
))
10065 register int count
;
10067 p
= SDATA (stuffstring
);
10068 count
= SBYTES (stuffstring
);
10069 while (count
-- > 0)
10074 /* Anything we have read ahead, put back for the shell to read. */
10075 /* ?? What should this do when we have multiple keyboards??
10076 Should we ignore anything that was typed in at the "wrong" kboard? */
10077 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10081 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10082 kbd_fetch_ptr
= kbd_buffer
;
10083 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10084 stuff_char (kbd_fetch_ptr
->code
);
10086 kbd_fetch_ptr
->kind
= NO_EVENT
;
10087 idx
= 2 * (kbd_fetch_ptr
- kbd_buffer
);
10088 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
10089 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
10094 #endif /* BSD_SYSTEM and not BSD4_1 */
10098 set_waiting_for_input (time_to_clear
)
10099 EMACS_TIME
*time_to_clear
;
10101 input_available_clear_time
= time_to_clear
;
10103 /* Tell interrupt_signal to throw back to read_char, */
10104 waiting_for_input
= 1;
10106 /* If interrupt_signal was called before and buffered a C-g,
10107 make it run again now, to avoid timing error. */
10108 if (!NILP (Vquit_flag
))
10109 quit_throw_to_read_char ();
10113 clear_waiting_for_input ()
10115 /* Tell interrupt_signal not to throw back to read_char, */
10116 waiting_for_input
= 0;
10117 input_available_clear_time
= 0;
10120 /* This routine is called at interrupt level in response to C-g.
10122 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10123 is called from kbd_buffer_store_event, in handling SIGIO or
10126 If `waiting_for_input' is non zero, then unless `echoing' is
10127 nonzero, immediately throw back to read_char.
10129 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10130 eval to throw, when it gets a chance. If quit-flag is already
10131 non-nil, it stops the job right away. */
10134 interrupt_signal (signalnum
) /* If we don't have an argument, */
10135 int signalnum
; /* some compilers complain in signal calls. */
10138 /* Must preserve main program's value of errno. */
10139 int old_errno
= errno
;
10140 struct frame
*sf
= SELECTED_FRAME ();
10142 #if defined (USG) && !defined (POSIX_SIGNALS)
10143 if (!read_socket_hook
&& NILP (Vwindow_system
))
10145 /* USG systems forget handlers when they are used;
10146 must reestablish each time */
10147 signal (SIGINT
, interrupt_signal
);
10148 signal (SIGQUIT
, interrupt_signal
);
10154 if (!NILP (Vquit_flag
)
10155 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10157 /* If SIGINT isn't blocked, don't let us be interrupted by
10158 another SIGINT, it might be harmful due to non-reentrancy
10159 in I/O functions. */
10160 sigblock (sigmask (SIGINT
));
10163 reset_sys_modes ();
10165 #ifdef SIGTSTP /* Support possible in later USG versions */
10167 * On systems which can suspend the current process and return to the original
10168 * shell, this command causes the user to end up back at the shell.
10169 * The "Auto-save" and "Abort" questions are not asked until
10170 * the user elects to return to emacs, at which point he can save the current
10171 * job and either dump core or continue.
10176 if (sys_suspend () == -1)
10178 printf ("Not running as a subprocess;\n");
10179 printf ("you can continue or abort.\n");
10181 #else /* not VMS */
10182 /* Perhaps should really fork an inferior shell?
10183 But that would not provide any way to get back
10184 to the original shell, ever. */
10185 printf ("No support for stopping a process on this operating system;\n");
10186 printf ("you can continue or abort.\n");
10187 #endif /* not VMS */
10188 #endif /* not SIGTSTP */
10190 /* We must remain inside the screen area when the internal terminal
10191 is used. Note that [Enter] is not echoed by dos. */
10194 /* It doesn't work to autosave while GC is in progress;
10195 the code used for auto-saving doesn't cope with the mark bit. */
10196 if (!gc_in_progress
)
10198 printf ("Auto-save? (y or n) ");
10200 if (((c
= getchar ()) & ~040) == 'Y')
10202 Fdo_auto_save (Qt
, Qnil
);
10204 printf ("\r\nAuto-save done");
10205 #else /* not MSDOS */
10206 printf ("Auto-save done\n");
10207 #endif /* not MSDOS */
10209 while (c
!= '\n') c
= getchar ();
10213 /* During GC, it must be safe to reenable quitting again. */
10214 Vinhibit_quit
= Qnil
;
10217 #endif /* not MSDOS */
10218 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10219 printf ("but will instead do a real quit after garbage collection ends\r\n");
10224 printf ("\r\nAbort? (y or n) ");
10225 #else /* not MSDOS */
10227 printf ("Abort (and enter debugger)? (y or n) ");
10228 #else /* not VMS */
10229 printf ("Abort (and dump core)? (y or n) ");
10230 #endif /* not VMS */
10231 #endif /* not MSDOS */
10233 if (((c
= getchar ()) & ~040) == 'Y')
10235 while (c
!= '\n') c
= getchar ();
10237 printf ("\r\nContinuing...\r\n");
10238 #else /* not MSDOS */
10239 printf ("Continuing...\n");
10240 #endif /* not MSDOS */
10247 /* If executing a function that wants to be interrupted out of
10248 and the user has not deferred quitting by binding `inhibit-quit'
10249 then quit right away. */
10250 if (immediate_quit
&& NILP (Vinhibit_quit
))
10252 struct gl_state_s saved
;
10253 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10255 immediate_quit
= 0;
10258 GCPRO4 (saved
.object
, saved
.global_code
,
10259 saved
.current_syntax_table
, saved
.old_prop
);
10260 Fsignal (Qquit
, Qnil
);
10265 /* Else request quit when it's safe */
10269 if (waiting_for_input
&& !echoing
)
10270 quit_throw_to_read_char ();
10275 /* Handle a C-g by making read_char return C-g. */
10278 quit_throw_to_read_char ()
10281 /* Prevent another signal from doing this before we finish. */
10282 clear_waiting_for_input ();
10285 Vunread_command_events
= Qnil
;
10286 unread_command_char
= -1;
10288 #if 0 /* Currently, sit_for is called from read_char without turning
10289 off polling. And that can call set_waiting_for_input.
10290 It seems to be harmless. */
10291 #ifdef POLL_FOR_INPUT
10292 /* May be > 1 if in recursive minibuffer. */
10293 if (poll_suppress_count
== 0)
10297 if (FRAMEP (internal_last_event_frame
)
10298 && !EQ (internal_last_event_frame
, selected_frame
))
10299 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10302 _longjmp (getcjmp
, 1);
10305 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10306 doc
: /* Set mode of reading keyboard input.
10307 First arg INTERRUPT non-nil means use input interrupts;
10308 nil means use CBREAK mode.
10309 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10310 (no effect except in CBREAK mode).
10311 Third arg META t means accept 8-bit input (for a Meta key).
10312 META nil means ignore the top bit, on the assumption it is parity.
10313 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10314 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10315 See also `current-input-mode'. */)
10316 (interrupt
, flow
, meta
, quit
)
10317 Lisp_Object interrupt
, flow
, meta
, quit
;
10320 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10321 error ("set-input-mode: QUIT must be an ASCII character");
10323 #ifdef POLL_FOR_INPUT
10328 /* this causes startup screen to be restored and messes with the mouse */
10329 reset_sys_modes ();
10333 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10334 if (read_socket_hook
)
10336 /* When using X, don't give the user a real choice,
10337 because we haven't implemented the mechanisms to support it. */
10338 #ifdef NO_SOCK_SIGIO
10339 interrupt_input
= 0;
10340 #else /* not NO_SOCK_SIGIO */
10341 interrupt_input
= 1;
10342 #endif /* NO_SOCK_SIGIO */
10345 interrupt_input
= !NILP (interrupt
);
10346 #else /* not SIGIO */
10347 interrupt_input
= 0;
10348 #endif /* not SIGIO */
10350 /* Our VMS input only works by interrupts, as of now. */
10352 interrupt_input
= 1;
10355 flow_control
= !NILP (flow
);
10358 else if (EQ (meta
, Qt
))
10363 /* Don't let this value be out of range. */
10364 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10370 #ifdef POLL_FOR_INPUT
10371 poll_suppress_count
= 1;
10377 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10378 doc
: /* Return information about the way Emacs currently reads keyboard input.
10379 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10380 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10381 nil, Emacs is using CBREAK mode.
10382 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10383 terminal; this does not apply if Emacs uses interrupt-driven input.
10384 META is t if accepting 8-bit input with 8th bit as Meta flag.
10385 META nil means ignoring the top bit, on the assumption it is parity.
10386 META is neither t nor nil if accepting 8-bit input and using
10387 all 8 bits as the character code.
10388 QUIT is the character Emacs currently uses to quit.
10389 The elements of this list correspond to the arguments of
10390 `set-input-mode'. */)
10393 Lisp_Object val
[4];
10395 val
[0] = interrupt_input
? Qt
: Qnil
;
10396 val
[1] = flow_control
? Qt
: Qnil
;
10397 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10398 XSETFASTINT (val
[3], quit_char
);
10400 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10405 * Set up a new kboard object with reasonable initial values.
10411 kb
->Voverriding_terminal_local_map
= Qnil
;
10412 kb
->Vlast_command
= Qnil
;
10413 kb
->Vreal_last_command
= Qnil
;
10414 kb
->Vprefix_arg
= Qnil
;
10415 kb
->Vlast_prefix_arg
= Qnil
;
10416 kb
->kbd_queue
= Qnil
;
10417 kb
->kbd_queue_has_data
= 0;
10418 kb
->immediate_echo
= 0;
10419 kb
->echo_string
= Qnil
;
10420 kb
->echo_after_prompt
= -1;
10421 kb
->kbd_macro_buffer
= 0;
10422 kb
->kbd_macro_bufsize
= 0;
10423 kb
->defining_kbd_macro
= Qnil
;
10424 kb
->Vlast_kbd_macro
= Qnil
;
10425 kb
->reference_count
= 0;
10426 kb
->Vsystem_key_alist
= Qnil
;
10427 kb
->system_key_syms
= Qnil
;
10428 kb
->Vdefault_minibuffer_frame
= Qnil
;
10432 * Destroy the contents of a kboard object, but not the object itself.
10433 * We use this just before deleting it, or if we're going to initialize
10434 * it a second time.
10440 if (kb
->kbd_macro_buffer
)
10441 xfree (kb
->kbd_macro_buffer
);
10444 #ifdef MULTI_KBOARD
10446 /* Free KB and memory referenced from it. */
10454 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10457 *kbp
= kb
->next_kboard
;
10459 /* Prevent a dangling reference to KB. */
10460 if (kb
== current_kboard
10461 && FRAMEP (selected_frame
)
10462 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10464 current_kboard
= XFRAME (selected_frame
)->kboard
;
10465 if (current_kboard
== kb
)
10473 #endif /* MULTI_KBOARD */
10478 /* This is correct before outermost invocation of the editor loop */
10479 command_loop_level
= -1;
10480 immediate_quit
= 0;
10481 quit_char
= Ctl ('g');
10482 Vunread_command_events
= Qnil
;
10483 unread_command_char
= -1;
10484 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10486 recent_keys_index
= 0;
10487 kbd_fetch_ptr
= kbd_buffer
;
10488 kbd_store_ptr
= kbd_buffer
;
10489 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10491 do_mouse_tracking
= Qnil
;
10495 /* This means that command_loop_1 won't try to select anything the first
10497 internal_last_event_frame
= Qnil
;
10498 Vlast_event_frame
= internal_last_event_frame
;
10500 #ifdef MULTI_KBOARD
10501 current_kboard
= initial_kboard
;
10503 wipe_kboard (current_kboard
);
10504 init_kboard (current_kboard
);
10506 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10508 signal (SIGINT
, interrupt_signal
);
10509 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10510 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10511 SIGQUIT and we can't tell which one it will give us. */
10512 signal (SIGQUIT
, interrupt_signal
);
10513 #endif /* HAVE_TERMIO */
10515 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10517 if (!noninteractive
)
10518 signal (SIGIO
, input_available_signal
);
10521 /* Use interrupt input by default, if it works and noninterrupt input
10522 has deficiencies. */
10524 #ifdef INTERRUPT_INPUT
10525 interrupt_input
= 1;
10527 interrupt_input
= 0;
10530 /* Our VMS input only works by interrupts, as of now. */
10532 interrupt_input
= 1;
10538 if (keyboard_init_hook
)
10539 (*keyboard_init_hook
) ();
10541 #ifdef POLL_FOR_INPUT
10542 poll_suppress_count
= 1;
10547 /* This type's only use is in syms_of_keyboard, to initialize the
10548 event header symbols and put properties on them. */
10549 struct event_head
{
10555 struct event_head head_table
[] = {
10556 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10557 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10558 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10559 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10560 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10561 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10562 {&Qselect_window
, "select-window", &Qselect_window
}
10566 syms_of_keyboard ()
10568 Vpre_help_message
= Qnil
;
10569 staticpro (&Vpre_help_message
);
10571 Vlispy_mouse_stem
= build_string ("mouse");
10572 staticpro (&Vlispy_mouse_stem
);
10575 QCimage
= intern (":image");
10576 staticpro (&QCimage
);
10578 staticpro (&Qhelp_echo
);
10579 Qhelp_echo
= intern ("help-echo");
10581 staticpro (&item_properties
);
10582 item_properties
= Qnil
;
10584 staticpro (&tool_bar_item_properties
);
10585 tool_bar_item_properties
= Qnil
;
10586 staticpro (&tool_bar_items_vector
);
10587 tool_bar_items_vector
= Qnil
;
10589 staticpro (&real_this_command
);
10590 real_this_command
= Qnil
;
10592 Qtimer_event_handler
= intern ("timer-event-handler");
10593 staticpro (&Qtimer_event_handler
);
10595 Qdisabled_command_hook
= intern ("disabled-command-hook");
10596 staticpro (&Qdisabled_command_hook
);
10598 Qself_insert_command
= intern ("self-insert-command");
10599 staticpro (&Qself_insert_command
);
10601 Qforward_char
= intern ("forward-char");
10602 staticpro (&Qforward_char
);
10604 Qbackward_char
= intern ("backward-char");
10605 staticpro (&Qbackward_char
);
10607 Qdisabled
= intern ("disabled");
10608 staticpro (&Qdisabled
);
10610 Qundefined
= intern ("undefined");
10611 staticpro (&Qundefined
);
10613 Qpre_command_hook
= intern ("pre-command-hook");
10614 staticpro (&Qpre_command_hook
);
10616 Qpost_command_hook
= intern ("post-command-hook");
10617 staticpro (&Qpost_command_hook
);
10619 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10620 staticpro (&Qpost_command_idle_hook
);
10622 Qdeferred_action_function
= intern ("deferred-action-function");
10623 staticpro (&Qdeferred_action_function
);
10625 Qcommand_hook_internal
= intern ("command-hook-internal");
10626 staticpro (&Qcommand_hook_internal
);
10628 Qfunction_key
= intern ("function-key");
10629 staticpro (&Qfunction_key
);
10630 Qmouse_click
= intern ("mouse-click");
10631 staticpro (&Qmouse_click
);
10632 #if defined(WINDOWSNT) || defined(MAC_OSX)
10633 Qmouse_wheel
= intern ("mouse-wheel");
10634 staticpro (&Qmouse_wheel
);
10637 Qlanguage_change
= intern ("language-change");
10638 staticpro (&Qlanguage_change
);
10640 Qdrag_n_drop
= intern ("drag-n-drop");
10641 staticpro (&Qdrag_n_drop
);
10643 Qsave_session
= intern ("save-session");
10644 staticpro(&Qsave_session
);
10646 Qusr1_signal
= intern ("usr1-signal");
10647 staticpro (&Qusr1_signal
);
10648 Qusr2_signal
= intern ("usr2-signal");
10649 staticpro (&Qusr2_signal
);
10651 Qmenu_enable
= intern ("menu-enable");
10652 staticpro (&Qmenu_enable
);
10653 Qmenu_alias
= intern ("menu-alias");
10654 staticpro (&Qmenu_alias
);
10655 QCenable
= intern (":enable");
10656 staticpro (&QCenable
);
10657 QCvisible
= intern (":visible");
10658 staticpro (&QCvisible
);
10659 QChelp
= intern (":help");
10660 staticpro (&QChelp
);
10661 QCfilter
= intern (":filter");
10662 staticpro (&QCfilter
);
10663 QCbutton
= intern (":button");
10664 staticpro (&QCbutton
);
10665 QCkeys
= intern (":keys");
10666 staticpro (&QCkeys
);
10667 QCkey_sequence
= intern (":key-sequence");
10668 staticpro (&QCkey_sequence
);
10669 QCtoggle
= intern (":toggle");
10670 staticpro (&QCtoggle
);
10671 QCradio
= intern (":radio");
10672 staticpro (&QCradio
);
10674 Qmode_line
= intern ("mode-line");
10675 staticpro (&Qmode_line
);
10676 Qvertical_line
= intern ("vertical-line");
10677 staticpro (&Qvertical_line
);
10678 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10679 staticpro (&Qvertical_scroll_bar
);
10680 Qmenu_bar
= intern ("menu-bar");
10681 staticpro (&Qmenu_bar
);
10683 Qabove_handle
= intern ("above-handle");
10684 staticpro (&Qabove_handle
);
10685 Qhandle
= intern ("handle");
10686 staticpro (&Qhandle
);
10687 Qbelow_handle
= intern ("below-handle");
10688 staticpro (&Qbelow_handle
);
10689 Qup
= intern ("up");
10691 Qdown
= intern ("down");
10692 staticpro (&Qdown
);
10693 Qtop
= intern ("top");
10695 Qbottom
= intern ("bottom");
10696 staticpro (&Qbottom
);
10697 Qend_scroll
= intern ("end-scroll");
10698 staticpro (&Qend_scroll
);
10699 Qratio
= intern ("ratio");
10700 staticpro (&Qratio
);
10702 Qevent_kind
= intern ("event-kind");
10703 staticpro (&Qevent_kind
);
10704 Qevent_symbol_elements
= intern ("event-symbol-elements");
10705 staticpro (&Qevent_symbol_elements
);
10706 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10707 staticpro (&Qevent_symbol_element_mask
);
10708 Qmodifier_cache
= intern ("modifier-cache");
10709 staticpro (&Qmodifier_cache
);
10711 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10712 staticpro (&Qrecompute_lucid_menubar
);
10713 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10714 staticpro (&Qactivate_menubar_hook
);
10716 Qpolling_period
= intern ("polling-period");
10717 staticpro (&Qpolling_period
);
10719 Qinput_method_function
= intern ("input-method-function");
10720 staticpro (&Qinput_method_function
);
10722 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10723 staticpro (&Qinput_method_exit_on_first_char
);
10724 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10725 staticpro (&Qinput_method_use_echo_area
);
10727 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10728 Fset (Qinput_method_use_echo_area
, Qnil
);
10730 last_point_position_buffer
= Qnil
;
10733 struct event_head
*p
;
10735 for (p
= head_table
;
10736 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10739 *p
->var
= intern (p
->name
);
10740 staticpro (p
->var
);
10741 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10742 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10746 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10747 staticpro (&button_down_location
);
10748 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10749 staticpro (&mouse_syms
);
10753 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10755 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10756 for (i
= 0; i
< len
; i
++)
10757 if (modifier_names
[i
])
10758 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10759 staticpro (&modifier_symbols
);
10762 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10763 staticpro (&recent_keys
);
10765 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10766 staticpro (&this_command_keys
);
10768 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10769 staticpro (&raw_keybuf
);
10771 Qextended_command_history
= intern ("extended-command-history");
10772 Fset (Qextended_command_history
, Qnil
);
10773 staticpro (&Qextended_command_history
);
10775 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10776 staticpro (&kbd_buffer_gcpro
);
10778 accent_key_syms
= Qnil
;
10779 staticpro (&accent_key_syms
);
10781 func_key_syms
= Qnil
;
10782 staticpro (&func_key_syms
);
10784 #if defined(WINDOWSNT) || defined(MAC_OSX)
10785 mouse_wheel_syms
= Qnil
;
10786 staticpro (&mouse_wheel_syms
);
10787 drag_n_drop_syms
= Qnil
;
10788 staticpro (&drag_n_drop_syms
);
10791 unread_switch_frame
= Qnil
;
10792 staticpro (&unread_switch_frame
);
10794 internal_last_event_frame
= Qnil
;
10795 staticpro (&internal_last_event_frame
);
10797 read_key_sequence_cmd
= Qnil
;
10798 staticpro (&read_key_sequence_cmd
);
10800 menu_bar_one_keymap_changed_items
= Qnil
;
10801 staticpro (&menu_bar_one_keymap_changed_items
);
10803 defsubr (&Sevent_convert_list
);
10804 defsubr (&Sread_key_sequence
);
10805 defsubr (&Sread_key_sequence_vector
);
10806 defsubr (&Srecursive_edit
);
10808 defsubr (&Strack_mouse
);
10810 defsubr (&Sinput_pending_p
);
10811 defsubr (&Scommand_execute
);
10812 defsubr (&Srecent_keys
);
10813 defsubr (&Sthis_command_keys
);
10814 defsubr (&Sthis_command_keys_vector
);
10815 defsubr (&Sthis_single_command_keys
);
10816 defsubr (&Sthis_single_command_raw_keys
);
10817 defsubr (&Sreset_this_command_lengths
);
10818 defsubr (&Sclear_this_command_keys
);
10819 defsubr (&Ssuspend_emacs
);
10820 defsubr (&Sabort_recursive_edit
);
10821 defsubr (&Sexit_recursive_edit
);
10822 defsubr (&Srecursion_depth
);
10823 defsubr (&Stop_level
);
10824 defsubr (&Sdiscard_input
);
10825 defsubr (&Sopen_dribble_file
);
10826 defsubr (&Sset_input_mode
);
10827 defsubr (&Scurrent_input_mode
);
10828 defsubr (&Sexecute_extended_command
);
10830 DEFVAR_LISP ("last-command-char", &last_command_char
,
10831 doc
: /* Last input event that was part of a command. */);
10833 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10834 doc
: /* Last input event that was part of a command. */);
10836 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10837 doc
: /* Last input event in a command, except for mouse menu events.
10838 Mouse menus give back keys that don't look like mouse events;
10839 this variable holds the actual mouse event that led to the menu,
10840 so that you can determine whether the command was run by mouse or not. */);
10842 DEFVAR_LISP ("last-input-char", &last_input_char
,
10843 doc
: /* Last input event. */);
10845 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10846 doc
: /* Last input event. */);
10848 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10849 doc
: /* List of events to be read as the command input.
10850 These events are processed first, before actual keyboard input. */);
10851 Vunread_command_events
= Qnil
;
10853 DEFVAR_INT ("unread-command-char", &unread_command_char
,
10854 doc
: /* If not -1, an object to be read as next command input event. */);
10856 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
10857 doc
: /* List of events to be processed as input by input methods.
10858 These events are processed after `unread-command-events', but
10859 before actual keyboard input. */);
10860 Vunread_post_input_method_events
= Qnil
;
10862 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
10863 doc
: /* List of events to be processed as input by input methods.
10864 These events are processed after `unread-command-events', but
10865 before actual keyboard input. */);
10866 Vunread_input_method_events
= Qnil
;
10868 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
10869 doc
: /* Meta-prefix character code.
10870 Meta-foo as command input turns into this character followed by foo. */);
10871 XSETINT (meta_prefix_char
, 033);
10873 DEFVAR_KBOARD ("last-command", Vlast_command
,
10874 doc
: /* The last command executed.
10875 Normally a symbol with a function definition, but can be whatever was found
10876 in the keymap, or whatever the variable `this-command' was set to by that
10879 The value `mode-exit' is special; it means that the previous command
10880 read an event that told it to exit, and it did so and unread that event.
10881 In other words, the present command is the event that made the previous
10884 The value `kill-region' is special; it means that the previous command
10885 was a kill command. */);
10887 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
10888 doc
: /* Same as `last-command', but never altered by Lisp code. */);
10890 DEFVAR_LISP ("this-command", &Vthis_command
,
10891 doc
: /* The command now being executed.
10892 The command can set this variable; whatever is put here
10893 will be in `last-command' during the following command. */);
10894 Vthis_command
= Qnil
;
10896 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
10897 doc
: /* The command bound to the current key sequence before remapping.
10898 It equals `this-command' if the original command was not remapped through
10899 any of the active keymaps. Otherwise, the value of `this-command' is the
10900 result of looking up the original command in the active keymaps. */);
10901 Vthis_original_command
= Qnil
;
10903 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
10904 doc
: /* *Number of input events between auto-saves.
10905 Zero means disable autosaving due to number of characters typed. */);
10906 auto_save_interval
= 300;
10908 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
10909 doc
: /* *Number of seconds idle time before auto-save.
10910 Zero or nil means disable auto-saving due to idleness.
10911 After auto-saving due to this many seconds of idle time,
10912 Emacs also does a garbage collection if that seems to be warranted. */);
10913 XSETFASTINT (Vauto_save_timeout
, 30);
10915 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
10916 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
10917 The value may be integer or floating point. */);
10918 Vecho_keystrokes
= make_number (1);
10920 DEFVAR_INT ("polling-period", &polling_period
,
10921 doc
: /* *Interval between polling for input during Lisp execution.
10922 The reason for polling is to make C-g work to stop a running program.
10923 Polling is needed only when using X windows and SIGIO does not work.
10924 Polling is automatically disabled in all other cases. */);
10925 polling_period
= 2;
10927 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
10928 doc
: /* *Maximum time between mouse clicks to make a double-click.
10929 Measured in milliseconds. nil means disable double-click recognition;
10930 t means double-clicks have no time limit and are detected
10931 by position only. */);
10932 Vdouble_click_time
= make_number (500);
10934 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
10935 doc
: /* *Maximum mouse movement between clicks to make a double-click.
10936 On window-system frames, value is the number of pixels the mouse may have
10937 moved horizontally or vertically between two clicks to make a double-click.
10938 On non window-system frames, value is interpreted in units of 1/8 characters
10941 This variable is also the threshold for motion of the mouse
10942 to count as a drag. */);
10943 double_click_fuzz
= 3;
10945 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
10946 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
10947 inhibit_local_menu_bar_menus
= 0;
10949 DEFVAR_INT ("num-input-keys", &num_input_keys
,
10950 doc
: /* Number of complete key sequences read as input so far.
10951 This includes key sequences read from keyboard macros.
10952 The number is effectively the number of interactive command invocations. */);
10953 num_input_keys
= 0;
10955 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
10956 doc
: /* Number of input events read from the keyboard so far.
10957 This does not include events generated by keyboard macros. */);
10958 num_nonmacro_input_events
= 0;
10960 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
10961 doc
: /* The frame in which the most recently read event occurred.
10962 If the last event came from a keyboard macro, this is set to `macro'. */);
10963 Vlast_event_frame
= Qnil
;
10965 /* This variable is set up in sysdep.c. */
10966 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
10967 doc
: /* The ERASE character as set by the user with stty. */);
10969 DEFVAR_LISP ("help-char", &Vhelp_char
,
10970 doc
: /* Character to recognize as meaning Help.
10971 When it is read, do `(eval help-form)', and display result if it's a string.
10972 If the value of `help-form' is nil, this char can be read normally. */);
10973 XSETINT (Vhelp_char
, Ctl ('H'));
10975 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
10976 doc
: /* List of input events to recognize as meaning Help.
10977 These work just like the value of `help-char' (see that). */);
10978 Vhelp_event_list
= Qnil
;
10980 DEFVAR_LISP ("help-form", &Vhelp_form
,
10981 doc
: /* Form to execute when character `help-char' is read.
10982 If the form returns a string, that string is displayed.
10983 If `help-form' is nil, the help char is not recognized. */);
10986 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
10987 doc
: /* Command to run when `help-char' character follows a prefix key.
10988 This command is used only when there is no actual binding
10989 for that character after that prefix key. */);
10990 Vprefix_help_command
= Qnil
;
10992 DEFVAR_LISP ("top-level", &Vtop_level
,
10993 doc
: /* Form to evaluate when Emacs starts up.
10994 Useful to set before you dump a modified Emacs. */);
10997 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
10998 doc
: /* Translate table for keyboard input, or nil.
10999 Each character is looked up in this string and the contents used instead.
11000 The value may be a string, a vector, or a char-table.
11001 If it is a string or vector of length N,
11002 character codes N and up are untranslated.
11003 In a vector or a char-table, an element which is nil means "no translation".
11005 This is applied to the characters supplied to input methods, not their
11006 output. See also `translation-table-for-input'. */);
11007 Vkeyboard_translate_table
= Qnil
;
11009 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11010 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11011 \(Even if the operating system has support for stopping a process.\) */);
11012 cannot_suspend
= 0;
11014 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11015 doc
: /* Non-nil means prompt with menus when appropriate.
11016 This is done when reading from a keymap that has a prompt string,
11017 for elements that have prompt strings.
11018 The menu is displayed on the screen
11019 if X menus were enabled at configuration
11020 time and the previous event was a mouse click prefix key.
11021 Otherwise, menu prompting uses the echo area. */);
11022 menu_prompting
= 1;
11024 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11025 doc
: /* Character to see next line of menu prompt.
11026 Type this character while in a menu prompt to rotate around the lines of it. */);
11027 XSETINT (menu_prompt_more_char
, ' ');
11029 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11030 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11031 Emacs applies the modifiers of the character stored here to each keyboard
11032 character it reads. For example, after evaluating the expression
11033 (setq extra-keyboard-modifiers ?\\C-x)
11034 all input characters will have the control modifier applied to them.
11036 Note that the character ?\\C-@, equivalent to the integer zero, does
11037 not count as a control character; rather, it counts as a character
11038 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11039 cancels any modification. */);
11040 extra_keyboard_modifiers
= 0;
11042 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11043 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11044 The command loop sets this to nil before each command,
11045 and tests the value when the command returns.
11046 Buffer modification stores t in this variable. */);
11047 Vdeactivate_mark
= Qnil
;
11049 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11050 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11051 Vcommand_hook_internal
= Qnil
;
11053 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11054 doc
: /* Normal hook run before each command is executed.
11055 If an unhandled error happens in running this hook,
11056 the hook value is set to nil, since otherwise the error
11057 might happen repeatedly and make Emacs nonfunctional. */);
11058 Vpre_command_hook
= Qnil
;
11060 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11061 doc
: /* Normal hook run after each command is executed.
11062 If an unhandled error happens in running this hook,
11063 the hook value is set to nil, since otherwise the error
11064 might happen repeatedly and make Emacs nonfunctional. */);
11065 Vpost_command_hook
= Qnil
;
11067 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11068 doc
: /* Normal hook run after each command is executed, if idle.
11069 Errors running the hook are caught and ignored. */);
11070 Vpost_command_idle_hook
= Qnil
;
11072 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11073 doc
: /* Delay time before running `post-command-idle-hook'.
11074 This is measured in microseconds. */);
11075 post_command_idle_delay
= 100000;
11078 DEFVAR_LISP ("echo-area-clear-hook", ...,
11079 doc
: /* Normal hook run when clearing the echo area. */);
11081 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11082 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11084 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11085 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11086 Vlucid_menu_bar_dirty_flag
= Qnil
;
11088 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11089 doc
: /* List of menu bar items to move to the end of the menu bar.
11090 The elements of the list are event types that may have menu bar bindings. */);
11091 Vmenu_bar_final_items
= Qnil
;
11093 DEFVAR_KBOARD ("overriding-terminal-local-map",
11094 Voverriding_terminal_local_map
,
11095 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11096 If this variable is non-nil, it is used as a keymap instead of the
11097 buffer's local map, and the minor mode keymaps and text property keymaps.
11098 This variable is intended to let commands such as `universal-argument'
11099 set up a different keymap for reading the next command. */);
11101 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11102 doc
: /* Keymap that overrides all other local keymaps.
11103 If this variable is non-nil, it is used as a keymap instead of the
11104 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11105 Voverriding_local_map
= Qnil
;
11107 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11108 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11109 Otherwise, the menu bar continues to reflect the buffer's local map
11110 and the minor mode maps regardless of `overriding-local-map'. */);
11111 Voverriding_local_map_menu_flag
= Qnil
;
11113 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11114 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11115 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11117 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11118 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11120 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11121 doc
: /* Alist of system-specific X windows key symbols.
11122 Each element should have the form (N . SYMBOL) where N is the
11123 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11124 and SYMBOL is its name. */);
11126 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11127 doc
: /* List of deferred actions to be performed at a later time.
11128 The precise format isn't relevant here; we just check whether it is nil. */);
11129 Vdeferred_action_list
= Qnil
;
11131 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11132 doc
: /* Function to call to handle deferred actions, after each command.
11133 This function is called with no arguments after each command
11134 whenever `deferred-action-list' is non-nil. */);
11135 Vdeferred_action_function
= Qnil
;
11137 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11138 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11139 The value can be a length of time to show the message for.
11140 If the value is non-nil and not a number, we wait 2 seconds. */);
11141 Vsuggest_key_bindings
= Qt
;
11143 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11144 doc
: /* List of active absolute time timers in order of increasing time. */);
11145 Vtimer_list
= Qnil
;
11147 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11148 doc
: /* List of active idle-time timers in order of increasing time. */);
11149 Vtimer_idle_list
= Qnil
;
11151 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11152 doc
: /* If non-nil, the function that implements the current input method.
11153 It's called with one argument, a printing character that was just read.
11154 \(That means a character with code 040...0176.)
11155 Typically this function uses `read-event' to read additional events.
11156 When it does so, it should first bind `input-method-function' to nil
11157 so it will not be called recursively.
11159 The function should return a list of zero or more events
11160 to be used as input. If it wants to put back some events
11161 to be reconsidered, separately, by the input method,
11162 it can add them to the beginning of `unread-command-events'.
11164 The input method function can find in `input-method-previous-method'
11165 the previous echo area message.
11167 The input method function should refer to the variables
11168 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11169 for guidance on what to do. */);
11170 Vinput_method_function
= Qnil
;
11172 DEFVAR_LISP ("input-method-previous-message",
11173 &Vinput_method_previous_message
,
11174 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11175 This variable exists because `read-event' clears the echo area
11176 before running the input method. It is nil if there was no message. */);
11177 Vinput_method_previous_message
= Qnil
;
11179 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11180 doc
: /* If non-nil, the function that implements the display of help.
11181 It's called with one argument, the help string to display. */);
11182 Vshow_help_function
= Qnil
;
11184 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11185 doc
: /* If non-nil, suppress point adjustment after executing a command.
11187 After a command is executed, if point is moved into a region that has
11188 special properties (e.g. composition, display), we adjust point to
11189 the boundary of the region. But, several special commands sets this
11190 variable to non-nil, then we suppress the point adjustment.
11192 This variable is set to nil before reading a command, and is checked
11193 just after executing the command. */);
11194 Vdisable_point_adjustment
= Qnil
;
11196 DEFVAR_LISP ("global-disable-point-adjustment",
11197 &Vglobal_disable_point_adjustment
,
11198 doc
: /* *If non-nil, always suppress point adjustment.
11200 The default value is nil, in which case, point adjustment are
11201 suppressed only after special commands that set
11202 `disable-point-adjustment' (which see) to non-nil. */);
11203 Vglobal_disable_point_adjustment
= Qnil
;
11205 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11206 doc
: /* Non-nil means updating menu bindings is allowed.
11207 A value of nil means menu bindings should not be updated.
11208 Used during Emacs' startup. */);
11209 update_menu_bindings
= 1;
11211 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11212 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11213 If the value is not a number, such messages don't time out. */);
11214 Vminibuffer_message_timeout
= make_number (2);
11218 keys_of_keyboard ()
11220 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11221 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11222 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11223 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11224 initial_define_key (meta_map
, 'x', "execute-extended-command");
11226 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11227 "handle-delete-frame");
11228 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11230 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11232 initial_define_lispy_key (Vspecial_event_map
, "select-window",
11233 "handle-select-window");
11234 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11235 "handle-save-session");