1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96,97,99,2000,01,02,03
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
28 #include "termhooks.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
53 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
60 #include <sys/types.h>
65 /* This is to get the definitions of the XK_ symbols. */
72 #endif /* HAVE_NTGUI */
82 /* Variables for blockinput.h: */
84 /* Non-zero if interrupt input is blocked right now. */
85 int interrupt_input_blocked
;
87 /* Nonzero means an input interrupt has arrived
88 during the current critical section. */
89 int interrupt_input_pending
;
92 /* File descriptor to use for input. */
95 #ifdef HAVE_WINDOW_SYSTEM
96 /* Make all keyboard buffers much bigger when using X windows. */
98 /* But not too big (local data > 32K error) if on Mac OS Classic. */
99 #define KBD_BUFFER_SIZE 512
101 #define KBD_BUFFER_SIZE 4096
103 #else /* No X-windows, character input */
104 #define KBD_BUFFER_SIZE 4096
105 #endif /* No X-windows */
107 #define abs(x) ((x) >= 0 ? (x) : -(x))
109 /* Following definition copied from eval.c */
113 struct backtrace
*next
;
114 Lisp_Object
*function
;
115 Lisp_Object
*args
; /* Points to vector of args. */
116 int nargs
; /* length of vector. If nargs is UNEVALLED,
117 args points to slot holding list of
123 KBOARD
*initial_kboard
;
124 KBOARD
*current_kboard
;
128 KBOARD the_only_kboard
;
131 /* Non-nil disable property on a command means
132 do not execute it; call disabled-command-hook's value instead. */
133 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
135 #define NUM_RECENT_KEYS (100)
136 int recent_keys_index
; /* Index for storing next element into recent_keys */
137 int total_keys
; /* Total number of elements stored into recent_keys */
138 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
140 /* Vector holding the key sequence that invoked the current command.
141 It is reused for each command, and it may be longer than the current
142 sequence; this_command_key_count indicates how many elements
143 actually mean something.
144 It's easier to staticpro a single Lisp_Object than an array. */
145 Lisp_Object this_command_keys
;
146 int this_command_key_count
;
148 /* 1 after calling Freset_this_command_lengths.
150 int this_command_key_count_reset
;
152 /* This vector is used as a buffer to record the events that were actually read
153 by read_key_sequence. */
154 Lisp_Object raw_keybuf
;
155 int raw_keybuf_count
;
157 #define GROW_RAW_KEYBUF \
158 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
160 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
162 new = Fmake_vector (make_number (newsize), Qnil); \
163 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
164 raw_keybuf_count * sizeof (Lisp_Object)); \
168 /* Number of elements of this_command_keys
169 that precede this key sequence. */
170 int this_single_command_key_start
;
172 /* Record values of this_command_key_count and echo_length ()
173 before this command was read. */
174 static int before_command_key_count
;
175 static int before_command_echo_length
;
177 extern int minbuf_level
;
179 extern int message_enable_multibyte
;
181 extern struct backtrace
*backtrace_list
;
183 /* If non-nil, the function that implements the display of help.
184 It's called with one argument, the help string to display. */
186 Lisp_Object Vshow_help_function
;
188 /* If a string, the message displayed before displaying a help-echo
191 Lisp_Object Vpre_help_message
;
193 /* Nonzero means do menu prompting. */
195 static int menu_prompting
;
197 /* Character to see next line of menu prompt. */
199 static Lisp_Object menu_prompt_more_char
;
201 /* For longjmp to where kbd input is being done. */
203 static jmp_buf getcjmp
;
205 /* True while doing kbd input. */
206 int waiting_for_input
;
208 /* True while displaying for echoing. Delays C-g throwing. */
212 /* Non-null means we can start echoing at the next input pause even
213 though there is something in the echo area. */
215 static struct kboard
*ok_to_echo_at_next_pause
;
217 /* The kboard last echoing, or null for none. Reset to 0 in
218 cancel_echoing. If non-null, and a current echo area message
219 exists, and echo_message_buffer is eq to the current message
220 buffer, we know that the message comes from echo_kboard. */
222 struct kboard
*echo_kboard
;
224 /* The buffer used for echoing. Set in echo_now, reset in
227 Lisp_Object echo_message_buffer
;
229 /* Nonzero means disregard local maps for the menu bar. */
230 static int inhibit_local_menu_bar_menus
;
232 /* Nonzero means C-g should cause immediate error-signal. */
235 /* The user's ERASE setting. */
236 Lisp_Object Vtty_erase_char
;
238 /* Character to recognize as the help char. */
239 Lisp_Object Vhelp_char
;
241 /* List of other event types to recognize as meaning "help". */
242 Lisp_Object Vhelp_event_list
;
244 /* Form to execute when help char is typed. */
245 Lisp_Object Vhelp_form
;
247 /* Command to run when the help character follows a prefix key. */
248 Lisp_Object Vprefix_help_command
;
250 /* List of items that should move to the end of the menu bar. */
251 Lisp_Object Vmenu_bar_final_items
;
253 /* Non-nil means show the equivalent key-binding for
254 any M-x command that has one.
255 The value can be a length of time to show the message for.
256 If the value is non-nil and not a number, we wait 2 seconds. */
257 Lisp_Object Vsuggest_key_bindings
;
259 /* How long to display an echo-area message when the minibuffer is active.
260 If the value is not a number, such messages don't time out. */
261 Lisp_Object Vminibuffer_message_timeout
;
263 /* Character that causes a quit. Normally C-g.
265 If we are running on an ordinary terminal, this must be an ordinary
266 ASCII char, since we want to make it our interrupt character.
268 If we are not running on an ordinary terminal, it still needs to be
269 an ordinary ASCII char. This character needs to be recognized in
270 the input interrupt handler. At this point, the keystroke is
271 represented as a struct input_event, while the desired quit
272 character is specified as a lispy event. The mapping from struct
273 input_events to lispy events cannot run in an interrupt handler,
274 and the reverse mapping is difficult for anything but ASCII
277 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
281 extern Lisp_Object current_global_map
;
282 extern int minibuf_level
;
284 /* If non-nil, this is a map that overrides all other local maps. */
285 Lisp_Object Voverriding_local_map
;
287 /* If non-nil, Voverriding_local_map applies to the menu bar. */
288 Lisp_Object Voverriding_local_map_menu_flag
;
290 /* Keymap that defines special misc events that should
291 be processed immediately at a low level. */
292 Lisp_Object Vspecial_event_map
;
294 /* Current depth in recursive edits. */
295 int command_loop_level
;
297 /* Total number of times command_loop has read a key sequence. */
298 EMACS_INT num_input_keys
;
300 /* Last input character read as a command. */
301 Lisp_Object last_command_char
;
303 /* Last input character read as a command, not counting menus
304 reached by the mouse. */
305 Lisp_Object last_nonmenu_event
;
307 /* Last input character read for any purpose. */
308 Lisp_Object last_input_char
;
310 /* If not Qnil, a list of objects to be read as subsequent command input. */
311 Lisp_Object Vunread_command_events
;
313 /* If not Qnil, a list of objects to be read as subsequent command input
314 including input method processing. */
315 Lisp_Object Vunread_input_method_events
;
317 /* If not Qnil, a list of objects to be read as subsequent command input
318 but NOT including input method processing. */
319 Lisp_Object Vunread_post_input_method_events
;
321 /* If not -1, an event to be read as subsequent command input. */
322 EMACS_INT unread_command_char
;
324 /* If not Qnil, this is a switch-frame event which we decided to put
325 off until the end of a key sequence. This should be read as the
326 next command input, after any unread_command_events.
328 read_key_sequence uses this to delay switch-frame events until the
329 end of the key sequence; Fread_char uses it to put off switch-frame
330 events until a non-ASCII event is acceptable as input. */
331 Lisp_Object unread_switch_frame
;
333 /* A mask of extra modifier bits to put into every keyboard char. */
334 EMACS_INT extra_keyboard_modifiers
;
336 /* Char to use as prefix when a meta character is typed in.
337 This is bound on entry to minibuffer in case ESC is changed there. */
339 Lisp_Object meta_prefix_char
;
341 /* Last size recorded for a current buffer which is not a minibuffer. */
342 static int last_non_minibuf_size
;
344 /* Number of idle seconds before an auto-save and garbage collection. */
345 static Lisp_Object Vauto_save_timeout
;
347 /* Total number of times read_char has returned. */
348 int num_input_events
;
350 /* Total number of times read_char has returned, outside of macros. */
351 EMACS_INT num_nonmacro_input_events
;
353 /* Auto-save automatically when this many characters have been typed
354 since the last time. */
356 static EMACS_INT auto_save_interval
;
358 /* Value of num_nonmacro_input_events as of last auto save. */
362 /* The command being executed by the command loop.
363 Commands may set this, and the value set will be copied into
364 current_kboard->Vlast_command instead of the actual command. */
365 Lisp_Object Vthis_command
;
367 /* This is like Vthis_command, except that commands never set it. */
368 Lisp_Object real_this_command
;
370 /* If the lookup of the command returns a binding, the original
371 command is stored in this-original-command. It is nil otherwise. */
372 Lisp_Object Vthis_original_command
;
374 /* The value of point when the last command was executed. */
375 int last_point_position
;
377 /* The buffer that was current when the last command was started. */
378 Lisp_Object last_point_position_buffer
;
380 /* The frame in which the last input event occurred, or Qmacro if the
381 last event came from a macro. We use this to determine when to
382 generate switch-frame events. This may be cleared by functions
383 like Fselect_frame, to make sure that a switch-frame event is
384 generated by the next character. */
385 Lisp_Object internal_last_event_frame
;
387 /* A user-visible version of the above, intended to allow users to
388 figure out where the last event came from, if the event doesn't
389 carry that information itself (i.e. if it was a character). */
390 Lisp_Object Vlast_event_frame
;
392 /* The timestamp of the last input event we received from the X server.
393 X Windows wants this for selection ownership. */
394 unsigned long last_event_timestamp
;
396 Lisp_Object Qself_insert_command
;
397 Lisp_Object Qforward_char
;
398 Lisp_Object Qbackward_char
;
399 Lisp_Object Qundefined
;
400 Lisp_Object Qtimer_event_handler
;
402 /* read_key_sequence stores here the command definition of the
403 key sequence that it reads. */
404 Lisp_Object read_key_sequence_cmd
;
406 /* Echo unfinished commands after this many seconds of pause. */
407 Lisp_Object Vecho_keystrokes
;
409 /* Form to evaluate (if non-nil) when Emacs is started. */
410 Lisp_Object Vtop_level
;
412 /* User-supplied table to translate input characters. */
413 Lisp_Object Vkeyboard_translate_table
;
415 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
416 extern Lisp_Object Vfunction_key_map
;
418 /* Another keymap that maps key sequences into key sequences.
419 This one takes precedence over ordinary definitions. */
420 extern Lisp_Object Vkey_translation_map
;
422 /* If non-nil, this implements the current input method. */
423 Lisp_Object Vinput_method_function
;
424 Lisp_Object Qinput_method_function
;
426 /* When we call Vinput_method_function,
427 this holds the echo area message that was just erased. */
428 Lisp_Object Vinput_method_previous_message
;
430 /* Non-nil means deactivate the mark at end of this command. */
431 Lisp_Object Vdeactivate_mark
;
433 /* Menu bar specified in Lucid Emacs fashion. */
435 Lisp_Object Vlucid_menu_bar_dirty_flag
;
436 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
438 Lisp_Object Qecho_area_clear_hook
;
440 /* Hooks to run before and after each command. */
441 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
442 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
443 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
444 /* Hook run after a command if there's no more input soon. */
445 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
447 /* Delay time in microseconds before running post-command-idle-hook. */
448 EMACS_INT post_command_idle_delay
;
450 /* List of deferred actions to be performed at a later time.
451 The precise format isn't relevant here; we just check whether it is nil. */
452 Lisp_Object Vdeferred_action_list
;
454 /* Function to call to handle deferred actions, when there are any. */
455 Lisp_Object Vdeferred_action_function
;
456 Lisp_Object Qdeferred_action_function
;
458 Lisp_Object Qinput_method_exit_on_first_char
;
459 Lisp_Object Qinput_method_use_echo_area
;
461 /* File in which we write all commands we read. */
464 /* Nonzero if input is available. */
467 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
468 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
472 /* Non-zero means force key bindings update in parse_menu_item. */
474 int update_menu_bindings
;
476 extern char *pending_malloc_warning
;
478 /* Circular buffer for pre-read keyboard input. */
480 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
482 /* Vector to GCPRO the Lisp objects referenced from kbd_buffer.
484 The interrupt-level event handlers will never enqueue an event on a
485 frame which is not in Vframe_list, and once an event is dequeued,
486 internal_last_event_frame or the event itself points to the frame.
489 But while the event is sitting in the queue, it's completely
490 unprotected. Suppose the user types one command which will run for
491 a while and then delete a frame, and then types another event at
492 the frame that will be deleted, before the command gets around to
493 it. Suppose there are no references to this frame elsewhere in
494 Emacs, and a GC occurs before the second event is dequeued. Now we
495 have an event referring to a freed frame, which will crash Emacs
498 Similar things happen when an event on a scroll bar is enqueued; the
499 window may be deleted while the event is in the queue.
501 So, we use this vector to protect the Lisp_Objects in the event
502 queue. That way, they'll be dequeued as dead frames or windows,
503 but still valid Lisp objects.
505 If kbd_buffer[i].kind != NO_EVENT, then
507 AREF (kbd_buffer_gcpro, 2 * i) == kbd_buffer[i].frame_or_window.
508 AREF (kbd_buffer_gcpro, 2 * i + 1) == kbd_buffer[i].arg. */
510 static Lisp_Object kbd_buffer_gcpro
;
512 /* Pointer to next available character in kbd_buffer.
513 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
514 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
515 next available char is in kbd_buffer[0]. */
516 static struct input_event
*kbd_fetch_ptr
;
518 /* Pointer to next place to store character in kbd_buffer. This
519 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
520 character should go in kbd_buffer[0]. */
521 static struct input_event
* volatile kbd_store_ptr
;
523 /* The above pair of variables forms a "queue empty" flag. When we
524 enqueue a non-hook event, we increment kbd_store_ptr. When we
525 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
526 there is input available iff the two pointers are not equal.
528 Why not just have a flag set and cleared by the enqueuing and
529 dequeuing functions? Such a flag could be screwed up by interrupts
530 at inopportune times. */
532 /* If this flag is non-nil, we check mouse_moved to see when the
533 mouse moves, and motion events will appear in the input stream.
534 Otherwise, mouse motion is ignored. */
535 Lisp_Object do_mouse_tracking
;
537 /* Symbols to head events. */
538 Lisp_Object Qmouse_movement
;
539 Lisp_Object Qscroll_bar_movement
;
540 Lisp_Object Qswitch_frame
;
541 Lisp_Object Qdelete_frame
;
542 Lisp_Object Qiconify_frame
;
543 Lisp_Object Qmake_frame_visible
;
544 Lisp_Object Qselect_window
;
545 Lisp_Object Qhelp_echo
;
547 /* Symbols to denote kinds of events. */
548 Lisp_Object Qfunction_key
;
549 Lisp_Object Qmouse_click
;
551 Lisp_Object Qlanguage_change
;
553 Lisp_Object Qdrag_n_drop
;
554 Lisp_Object Qsave_session
;
556 /* Lisp_Object Qmouse_movement; - also an event header */
558 /* Properties of event headers. */
559 Lisp_Object Qevent_kind
;
560 Lisp_Object Qevent_symbol_elements
;
562 /* menu item parts */
563 Lisp_Object Qmenu_alias
;
564 Lisp_Object Qmenu_enable
;
565 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
566 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
567 extern Lisp_Object Vdefine_key_rebound_commands
;
568 extern Lisp_Object Qmenu_item
;
570 /* An event header symbol HEAD may have a property named
571 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
572 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
573 mask of modifiers applied to it. If present, this is used to help
574 speed up parse_modifiers. */
575 Lisp_Object Qevent_symbol_element_mask
;
577 /* An unmodified event header BASE may have a property named
578 Qmodifier_cache, which is an alist mapping modifier masks onto
579 modified versions of BASE. If present, this helps speed up
581 Lisp_Object Qmodifier_cache
;
583 /* Symbols to use for parts of windows. */
584 Lisp_Object Qmode_line
;
585 Lisp_Object Qvertical_line
;
586 Lisp_Object Qvertical_scroll_bar
;
587 Lisp_Object Qmenu_bar
;
588 extern Lisp_Object Qleft_margin
, Qright_margin
;
590 Lisp_Object
recursive_edit_unwind (), command_loop ();
591 Lisp_Object
Fthis_command_keys ();
592 Lisp_Object Qextended_command_history
;
593 EMACS_TIME
timer_check ();
595 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
597 extern char *x_get_keysym_name ();
599 static void record_menu_key ();
600 static int echo_length ();
602 Lisp_Object Qpolling_period
;
604 /* List of absolute timers. Appears in order of next scheduled event. */
605 Lisp_Object Vtimer_list
;
607 /* List of idle time timers. Appears in order of next scheduled event. */
608 Lisp_Object Vtimer_idle_list
;
610 /* Incremented whenever a timer is run. */
613 extern Lisp_Object Vprint_level
, Vprint_length
;
615 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
617 EMACS_TIME
*input_available_clear_time
;
619 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
620 Default is 1 if INTERRUPT_INPUT is defined. */
623 /* Nonzero while interrupts are temporarily deferred during redisplay. */
624 int interrupts_deferred
;
626 /* Nonzero means use ^S/^Q for flow control. */
629 /* Allow m- file to inhibit use of FIONREAD. */
630 #ifdef BROKEN_FIONREAD
634 /* We are unable to use interrupts if FIONREAD is not available,
635 so flush SIGIO so we won't try. */
642 /* If we support a window system, turn on the code to poll periodically
643 to detect C-g. It isn't actually used when doing interrupt input. */
644 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
645 #define POLL_FOR_INPUT
648 /* After a command is executed, if point is moved into a region that
649 has specific properties (e.g. composition, display), we adjust
650 point to the boundary of the region. But, if a command sets this
651 variable to non-nil, we suppress this point adjustment. This
652 variable is set to nil before reading a command. */
654 Lisp_Object Vdisable_point_adjustment
;
656 /* If non-nil, always disable point adjustment. */
658 Lisp_Object Vglobal_disable_point_adjustment
;
660 /* The time when Emacs started being idle. */
662 static EMACS_TIME timer_idleness_start_time
;
664 /* After Emacs stops being idle, this saves the last value
665 of timer_idleness_start_time from when it was idle. */
667 static EMACS_TIME timer_last_idleness_start_time
;
670 /* Global variable declarations. */
672 /* Function for init_keyboard to call with no args (if nonzero). */
673 void (*keyboard_init_hook
) ();
675 static int read_avail_input
P_ ((int));
676 static void get_input_pending
P_ ((int *, int));
677 static void get_filtered_input_pending
P_ ((int *, int, int));
678 static int readable_events
P_ ((int));
679 static int readable_filtered_events
P_ ((int, int));
680 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
681 Lisp_Object
, int *));
682 static Lisp_Object
read_char_x_menu_prompt ();
683 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
685 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
687 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
688 enum scroll_bar_part
,
689 Lisp_Object
, Lisp_Object
,
692 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
693 Lisp_Object
, char **,
694 Lisp_Object
*, unsigned));
695 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
696 static int parse_solitary_modifier
P_ ((Lisp_Object
));
697 static int parse_solitary_modifier ();
698 static void save_getcjmp
P_ ((jmp_buf));
699 static void save_getcjmp ();
700 static void restore_getcjmp
P_ ((jmp_buf));
701 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
702 static void clear_event
P_ ((struct input_event
*));
703 static void any_kboard_state
P_ ((void));
704 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
706 /* Nonzero means don't try to suspend even if the operating system seems
708 static int cannot_suspend
;
710 /* Install the string STR as the beginning of the string of echoing,
711 so that it serves as a prompt for the next character.
712 Also start echoing. */
718 current_kboard
->echo_string
= str
;
719 current_kboard
->echo_after_prompt
= SCHARS (str
);
723 /* Add C to the echo string, if echoing is going on.
724 C can be a character, which is printed prettily ("M-C-x" and all that
725 jazz), or a symbol, whose name is printed. */
731 if (current_kboard
->immediate_echo
)
733 int size
= KEY_DESCRIPTION_SIZE
+ 100;
734 char *buffer
= (char *) alloca (size
);
736 Lisp_Object echo_string
;
738 echo_string
= current_kboard
->echo_string
;
740 /* If someone has passed us a composite event, use its head symbol. */
745 ptr
= push_key_description (XINT (c
), ptr
, 1);
747 else if (SYMBOLP (c
))
749 Lisp_Object name
= SYMBOL_NAME (c
);
750 int nbytes
= SBYTES (name
);
752 if (size
- (ptr
- buffer
) < nbytes
)
754 int offset
= ptr
- buffer
;
755 size
= max (2 * size
, size
+ nbytes
);
756 buffer
= (char *) alloca (size
);
757 ptr
= buffer
+ offset
;
760 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
761 STRING_MULTIBYTE (name
), 1);
764 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
767 const char *text
= " (Type ? for further options)";
768 int len
= strlen (text
);
770 if (size
- (ptr
- buffer
) < len
)
772 int offset
= ptr
- buffer
;
774 buffer
= (char *) alloca (size
);
775 ptr
= buffer
+ offset
;
778 bcopy (text
, ptr
, len
);
782 /* Replace a dash from echo_dash with a space, otherwise
783 add a space at the end as a separator between keys. */
784 if (STRINGP (echo_string
)
785 && SCHARS (echo_string
) > 1)
787 Lisp_Object last_char
, prev_char
, idx
;
789 idx
= make_number (SCHARS (echo_string
) - 2);
790 prev_char
= Faref (echo_string
, idx
);
792 idx
= make_number (SCHARS (echo_string
) - 1);
793 last_char
= Faref (echo_string
, idx
);
795 /* We test PREV_CHAR to make sure this isn't the echoing
797 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
798 Faset (echo_string
, idx
, make_number (' '));
800 echo_string
= concat2 (echo_string
, build_string (" "));
803 current_kboard
->echo_string
804 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
810 /* Temporarily add a dash to the end of the echo string if it's not
811 empty, so that it serves as a mini-prompt for the very next character. */
816 /* Do nothing if not echoing at all. */
817 if (NILP (current_kboard
->echo_string
))
820 if (!current_kboard
->immediate_echo
821 && SCHARS (current_kboard
->echo_string
) == 0)
824 /* Do nothing if we just printed a prompt. */
825 if (current_kboard
->echo_after_prompt
826 == SCHARS (current_kboard
->echo_string
))
829 /* Put a dash at the end of the buffer temporarily,
830 but make it go away when the next character is added. */
831 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
836 /* Display the current echo string, and begin echoing if not already
842 if (!current_kboard
->immediate_echo
)
845 current_kboard
->immediate_echo
= 1;
847 for (i
= 0; i
< this_command_key_count
; i
++)
851 /* Set before_command_echo_length to the value that would
852 have been saved before the start of this subcommand in
853 command_loop_1, if we had already been echoing then. */
854 if (i
== this_single_command_key_start
)
855 before_command_echo_length
= echo_length ();
857 c
= XVECTOR (this_command_keys
)->contents
[i
];
858 if (! (EVENT_HAS_PARAMETERS (c
)
859 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
863 /* Set before_command_echo_length to the value that would
864 have been saved before the start of this subcommand in
865 command_loop_1, if we had already been echoing then. */
866 if (this_command_key_count
== this_single_command_key_start
)
867 before_command_echo_length
= echo_length ();
869 /* Put a dash at the end to invite the user to type more. */
874 message3_nolog (current_kboard
->echo_string
,
875 SBYTES (current_kboard
->echo_string
),
876 STRING_MULTIBYTE (current_kboard
->echo_string
));
879 /* Record in what buffer we echoed, and from which kboard. */
880 echo_message_buffer
= echo_area_buffer
[0];
881 echo_kboard
= current_kboard
;
883 if (waiting_for_input
&& !NILP (Vquit_flag
))
884 quit_throw_to_read_char ();
887 /* Turn off echoing, for the start of a new command. */
892 current_kboard
->immediate_echo
= 0;
893 current_kboard
->echo_after_prompt
= -1;
894 current_kboard
->echo_string
= Qnil
;
895 ok_to_echo_at_next_pause
= NULL
;
897 echo_message_buffer
= Qnil
;
900 /* Return the length of the current echo string. */
905 return (STRINGP (current_kboard
->echo_string
)
906 ? SCHARS (current_kboard
->echo_string
)
910 /* Truncate the current echo message to its first LEN chars.
911 This and echo_char get used by read_key_sequence when the user
912 switches frames while entering a key sequence. */
915 echo_truncate (nchars
)
918 if (STRINGP (current_kboard
->echo_string
))
919 current_kboard
->echo_string
920 = Fsubstring (current_kboard
->echo_string
,
921 make_number (0), make_number (nchars
));
922 truncate_echo_area (nchars
);
926 /* Functions for manipulating this_command_keys. */
928 add_command_key (key
)
931 #if 0 /* Not needed after we made Freset_this_command_lengths
932 do the job immediately. */
933 /* If reset-this-command-length was called recently, obey it now.
934 See the doc string of that function for an explanation of why. */
935 if (before_command_restore_flag
)
937 this_command_key_count
= before_command_key_count_1
;
938 if (this_command_key_count
< this_single_command_key_start
)
939 this_single_command_key_start
= this_command_key_count
;
940 echo_truncate (before_command_echo_length_1
);
941 before_command_restore_flag
= 0;
945 if (this_command_key_count
>= ASIZE (this_command_keys
))
946 this_command_keys
= larger_vector (this_command_keys
,
947 2 * ASIZE (this_command_keys
),
950 AREF (this_command_keys
, this_command_key_count
) = key
;
951 ++this_command_key_count
;
958 int count
= SPECPDL_INDEX ();
961 if (command_loop_level
> 0)
963 specbind (Qstandard_output
, Qt
);
964 specbind (Qstandard_input
, Qt
);
967 #ifdef HAVE_X_WINDOWS
968 /* The command loop has started an hourglass timer, so we have to
969 cancel it here, otherwise it will fire because the recursive edit
970 can take some time. Do not check for display_hourglass_p here,
971 because it could already be nil. */
975 /* This function may have been called from a debugger called from
976 within redisplay, for instance by Edebugging a function called
977 from fontification-functions. We want to allow redisplay in
978 the debugging session.
980 The recursive edit is left with a `(throw exit ...)'. The `exit'
981 tag is not caught anywhere in redisplay, i.e. when we leave the
982 recursive edit, the original redisplay leading to the recursive
983 edit will be unwound. The outcome should therefore be safe. */
984 specbind (Qinhibit_redisplay
, Qnil
);
987 val
= command_loop ();
989 Fsignal (Qquit
, Qnil
);
990 /* Handle throw from read_minibuf when using minibuffer
991 while it's active but we're in another window. */
993 Fsignal (Qerror
, Fcons (val
, Qnil
));
995 return unbind_to (count
, Qnil
);
998 /* When an auto-save happens, record the "time", and don't do again soon. */
1003 last_auto_save
= num_nonmacro_input_events
;
1006 /* Make an auto save happen as soon as possible at command level. */
1009 force_auto_save_soon ()
1011 last_auto_save
= - auto_save_interval
- 1;
1013 record_asynch_buffer_change ();
1016 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1017 doc
: /* Invoke the editor command loop recursively.
1018 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1019 that tells this function to return.
1020 Alternately, `(throw 'exit t)' makes this function signal an error.
1021 This function is called by the editor initialization to begin editing. */)
1024 int count
= SPECPDL_INDEX ();
1027 command_loop_level
++;
1028 update_mode_lines
= 1;
1030 if (command_loop_level
1031 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1032 buffer
= Fcurrent_buffer ();
1036 /* If we leave recursive_edit_1 below with a `throw' for instance,
1037 like it is done in the splash screen display, we have to
1038 make sure that we restore single_kboard as command_loop_1
1039 would have done if it were left normally. */
1040 record_unwind_protect (recursive_edit_unwind
,
1041 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1043 recursive_edit_1 ();
1044 return unbind_to (count
, Qnil
);
1048 recursive_edit_unwind (info
)
1051 if (BUFFERP (XCAR (info
)))
1052 Fset_buffer (XCAR (info
));
1054 if (NILP (XCDR (info
)))
1055 any_kboard_state ();
1057 single_kboard_state ();
1059 command_loop_level
--;
1060 update_mode_lines
= 1;
1069 #if 0 /* Theory: if there's anything in Vunread_command_events,
1070 it will right away be read by read_key_sequence,
1071 and then if we do switch KBOARDS, it will go into the side
1072 queue then. So we don't need to do anything special here -- rms. */
1073 if (CONSP (Vunread_command_events
))
1075 current_kboard
->kbd_queue
1076 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1077 current_kboard
->kbd_queue_has_data
= 1;
1079 Vunread_command_events
= Qnil
;
1085 /* Switch to the single-kboard state, making current_kboard
1086 the only KBOARD from which further input is accepted. */
1089 single_kboard_state ()
1096 /* Maintain a stack of kboards, so other parts of Emacs
1097 can switch temporarily to the kboard of a given frame
1098 and then revert to the previous status. */
1103 struct kboard_stack
*next
;
1106 static struct kboard_stack
*kboard_stack
;
1109 push_frame_kboard (f
)
1113 struct kboard_stack
*p
1114 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1116 p
->next
= kboard_stack
;
1117 p
->kboard
= current_kboard
;
1120 current_kboard
= FRAME_KBOARD (f
);
1128 struct kboard_stack
*p
= kboard_stack
;
1129 current_kboard
= p
->kboard
;
1130 kboard_stack
= p
->next
;
1135 /* Handle errors that are not handled at inner levels
1136 by printing an error message and returning to the editor command loop. */
1142 Lisp_Object old_level
, old_length
;
1143 char macroerror
[50];
1145 #ifdef HAVE_X_WINDOWS
1146 if (display_hourglass_p
)
1147 cancel_hourglass ();
1150 if (!NILP (executing_macro
))
1152 if (executing_macro_iterations
== 1)
1153 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1155 sprintf (macroerror
, "After %d kbd macro iterations: ",
1156 executing_macro_iterations
);
1161 Vstandard_output
= Qt
;
1162 Vstandard_input
= Qt
;
1163 Vexecuting_macro
= Qnil
;
1164 executing_macro
= Qnil
;
1165 current_kboard
->Vprefix_arg
= Qnil
;
1166 current_kboard
->Vlast_prefix_arg
= Qnil
;
1169 /* Avoid unquittable loop if data contains a circular list. */
1170 old_level
= Vprint_level
;
1171 old_length
= Vprint_length
;
1172 XSETFASTINT (Vprint_level
, 10);
1173 XSETFASTINT (Vprint_length
, 10);
1174 cmd_error_internal (data
, macroerror
);
1175 Vprint_level
= old_level
;
1176 Vprint_length
= old_length
;
1180 Vinhibit_quit
= Qnil
;
1182 any_kboard_state ();
1185 return make_number (0);
1188 /* Take actions on handling an error. DATA is the data that describes
1191 CONTEXT is a C-string containing ASCII characters only which
1192 describes the context in which the error happened. If we need to
1193 generalize CONTEXT to allow multibyte characters, make it a Lisp
1197 cmd_error_internal (data
, context
)
1202 int kill_emacs_p
= 0;
1203 struct frame
*sf
= SELECTED_FRAME ();
1207 clear_message (1, 0);
1209 /* If the window system or terminal frame hasn't been initialized
1210 yet, or we're not interactive, it's best to dump this message out
1211 to stderr and exit. */
1212 if (!sf
->glyphs_initialized_p
1213 /* This is the case of the frame dumped with Emacs, when we're
1214 running under a window system. */
1215 || (!NILP (Vwindow_system
)
1216 && !inhibit_window_system
1217 && FRAME_TERMCAP_P (sf
))
1220 stream
= Qexternal_debugging_output
;
1226 message_log_maybe_newline ();
1231 /* The immediate context is not interesting for Quits,
1232 since they are asyncronous. */
1233 if (EQ (XCAR (data
), Qquit
))
1234 Vsignaling_function
= Qnil
;
1236 print_error_message (data
, stream
, context
, Vsignaling_function
);
1238 Vsignaling_function
= Qnil
;
1240 /* If the window system or terminal frame hasn't been initialized
1241 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1245 Fkill_emacs (make_number (-1));
1249 Lisp_Object
command_loop_1 ();
1250 Lisp_Object
command_loop_2 ();
1251 Lisp_Object
top_level_1 ();
1253 /* Entry to editor-command-loop.
1254 This level has the catches for exiting/returning to editor command loop.
1255 It returns nil to exit recursive edit, t to abort it. */
1260 if (command_loop_level
> 0 || minibuf_level
> 0)
1263 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1264 executing_macro
= Qnil
;
1270 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1271 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1272 executing_macro
= Qnil
;
1274 /* End of file in -batch run causes exit here. */
1280 /* Here we catch errors in execution of commands within the
1281 editing loop, and reenter the editing loop.
1282 When there is an error, cmd_error runs and returns a non-nil
1283 value to us. A value of nil means that command_loop_1 itself
1284 returned due to end of file (or end of kbd macro). */
1289 register Lisp_Object val
;
1292 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1293 while (!NILP (val
));
1301 return Feval (Vtop_level
);
1307 /* On entry to the outer level, run the startup file */
1308 if (!NILP (Vtop_level
))
1309 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1310 else if (!NILP (Vpurify_flag
))
1311 message ("Bare impure Emacs (standard Lisp code not loaded)");
1313 message ("Bare Emacs (standard Lisp code not loaded)");
1317 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1318 doc
: /* Exit all recursive editing levels. */)
1321 #ifdef HAVE_X_WINDOWS
1322 if (display_hourglass_p
)
1323 cancel_hourglass ();
1325 return Fthrow (Qtop_level
, Qnil
);
1328 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1329 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1332 if (command_loop_level
> 0 || minibuf_level
> 0)
1333 Fthrow (Qexit
, Qnil
);
1335 error ("No recursive edit is in progress");
1339 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1340 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1343 if (command_loop_level
> 0 || minibuf_level
> 0)
1346 error ("No recursive edit is in progress");
1350 /* This is the actual command reading loop,
1351 sans error-handling encapsulation. */
1353 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1355 void safe_run_hooks
P_ ((Lisp_Object
));
1356 static void adjust_point_for_property
P_ ((int, int));
1358 /* Cancel hourglass from protect_unwind.
1360 #ifdef HAVE_X_WINDOWS
1362 cancel_hourglass_unwind (arg
)
1365 cancel_hourglass ();
1375 Lisp_Object keybuf
[30];
1379 struct buffer
*prev_buffer
= NULL
;
1381 int was_locked
= single_kboard
;
1383 int already_adjusted
;
1385 current_kboard
->Vprefix_arg
= Qnil
;
1386 current_kboard
->Vlast_prefix_arg
= Qnil
;
1387 Vdeactivate_mark
= Qnil
;
1388 waiting_for_input
= 0;
1392 this_command_key_count
= 0;
1393 this_command_key_count_reset
= 0;
1394 this_single_command_key_start
= 0;
1396 if (NILP (Vmemory_full
))
1398 /* Make sure this hook runs after commands that get errors and
1399 throw to top level. */
1400 /* Note that the value cell will never directly contain nil
1401 if the symbol is a local variable. */
1402 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1403 safe_run_hooks (Qpost_command_hook
);
1405 /* If displaying a message, resize the echo area window to fit
1406 that message's size exactly. */
1407 if (!NILP (echo_area_buffer
[0]))
1408 resize_echo_area_exactly ();
1410 if (!NILP (Vdeferred_action_list
))
1411 call0 (Vdeferred_action_function
);
1413 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1415 if (NILP (Vunread_command_events
)
1416 && NILP (Vunread_input_method_events
)
1417 && NILP (Vunread_post_input_method_events
)
1418 && NILP (Vexecuting_macro
)
1419 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1420 safe_run_hooks (Qpost_command_idle_hook
);
1424 Vmemory_full
= Qnil
;
1426 /* Do this after running Vpost_command_hook, for consistency. */
1427 current_kboard
->Vlast_command
= Vthis_command
;
1428 current_kboard
->Vreal_last_command
= real_this_command
;
1432 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1435 /* Make sure the current window's buffer is selected. */
1436 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1437 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1439 /* Display any malloc warning that just came out. Use while because
1440 displaying one warning can cause another. */
1442 while (pending_malloc_warning
)
1443 display_malloc_warning ();
1447 Vdeactivate_mark
= Qnil
;
1449 /* If minibuffer on and echo area in use,
1450 wait a short time and redraw minibuffer. */
1453 && !NILP (echo_area_buffer
[0])
1454 && EQ (minibuf_window
, echo_area_window
)
1455 && NUMBERP (Vminibuffer_message_timeout
))
1457 /* Bind inhibit-quit to t so that C-g gets read in
1458 rather than quitting back to the minibuffer. */
1459 int count
= SPECPDL_INDEX ();
1460 specbind (Qinhibit_quit
, Qt
);
1462 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1463 /* Clear the echo area. */
1465 safe_run_hooks (Qecho_area_clear_hook
);
1467 unbind_to (count
, Qnil
);
1469 /* If a C-g came in before, treat it as input now. */
1470 if (!NILP (Vquit_flag
))
1473 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1478 alloca (0); /* Cause a garbage collection now */
1479 /* Since we can free the most stuff here. */
1480 #endif /* C_ALLOCA */
1483 /* Select the frame that the last event came from. Usually,
1484 switch-frame events will take care of this, but if some lisp
1485 code swallows a switch-frame event, we'll fix things up here.
1486 Is this a good idea? */
1487 if (FRAMEP (internal_last_event_frame
)
1488 && !EQ (internal_last_event_frame
, selected_frame
))
1489 Fselect_frame (internal_last_event_frame
, Qnil
);
1491 /* If it has changed current-menubar from previous value,
1492 really recompute the menubar from the value. */
1493 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1494 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1495 call0 (Qrecompute_lucid_menubar
);
1497 before_command_key_count
= this_command_key_count
;
1498 before_command_echo_length
= echo_length ();
1500 Vthis_command
= Qnil
;
1501 real_this_command
= Qnil
;
1503 /* Read next key sequence; i gets its length. */
1504 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1507 /* A filter may have run while we were reading the input. */
1508 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1510 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1511 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1515 /* Now we have read a key sequence of length I,
1516 or else I is 0 and we found end of file. */
1518 if (i
== 0) /* End of file -- happens only in */
1519 return Qnil
; /* a kbd macro, at the end. */
1520 /* -1 means read_key_sequence got a menu that was rejected.
1521 Just loop around and read another command. */
1525 this_command_key_count
= 0;
1526 this_command_key_count_reset
= 0;
1527 this_single_command_key_start
= 0;
1531 last_command_char
= keybuf
[i
- 1];
1533 /* If the previous command tried to force a specific window-start,
1534 forget about that, in case this command moves point far away
1535 from that position. But also throw away beg_unchanged and
1536 end_unchanged information in that case, so that redisplay will
1537 update the whole window properly. */
1538 if (!NILP (XWINDOW (selected_window
)->force_start
))
1541 XWINDOW (selected_window
)->force_start
= Qnil
;
1542 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1543 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1546 cmd
= read_key_sequence_cmd
;
1547 if (!NILP (Vexecuting_macro
))
1549 if (!NILP (Vquit_flag
))
1551 Vexecuting_macro
= Qt
;
1552 QUIT
; /* Make some noise. */
1553 /* Will return since macro now empty. */
1557 /* Do redisplay processing after this command except in special
1558 cases identified below. */
1559 prev_buffer
= current_buffer
;
1560 prev_modiff
= MODIFF
;
1561 last_point_position
= PT
;
1562 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1564 /* By default, we adjust point to a boundary of a region that
1565 has such a property that should be treated intangible
1566 (e.g. composition, display). But, some commands will set
1567 this variable differently. */
1568 Vdisable_point_adjustment
= Qnil
;
1570 /* Process filters and timers may have messed with deactivate-mark.
1571 reset it before we execute the command. */
1572 Vdeactivate_mark
= Qnil
;
1574 /* Remap command through active keymaps */
1575 Vthis_original_command
= cmd
;
1579 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1583 /* Execute the command. */
1585 Vthis_command
= cmd
;
1586 real_this_command
= cmd
;
1587 /* Note that the value cell will never directly contain nil
1588 if the symbol is a local variable. */
1589 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1590 safe_run_hooks (Qpre_command_hook
);
1592 already_adjusted
= 0;
1594 if (NILP (Vthis_command
))
1596 /* nil means key is undefined. */
1598 current_kboard
->defining_kbd_macro
= Qnil
;
1599 update_mode_lines
= 1;
1600 current_kboard
->Vprefix_arg
= Qnil
;
1604 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1606 /* In case we jump to directly_done. */
1607 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1609 /* Recognize some common commands in common situations and
1610 do them directly. */
1611 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1613 struct Lisp_Char_Table
*dp
1614 = window_display_table (XWINDOW (selected_window
));
1615 lose
= FETCH_CHAR (PT_BYTE
);
1617 if (! NILP (Vpost_command_hook
))
1618 /* Put this before calling adjust_point_for_property
1619 so it will only get called once in any case. */
1621 if (current_buffer
== prev_buffer
1622 && last_point_position
!= PT
1623 && NILP (Vdisable_point_adjustment
)
1624 && NILP (Vglobal_disable_point_adjustment
))
1625 adjust_point_for_property (last_point_position
, 0);
1626 already_adjusted
= 1;
1627 if (PT
== last_point_position
+ 1
1629 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1630 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1631 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1632 && (lose
>= 0x20 && lose
< 0x7f)))
1633 : (lose
>= 0x20 && lose
< 0x7f))
1634 /* To extract the case of continuation on
1635 wide-column characters. */
1636 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1637 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1639 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1641 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1643 && !windows_or_buffers_changed
1644 && EQ (current_buffer
->selective_display
, Qnil
)
1645 && !detect_input_pending ()
1646 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1647 && NILP (Vexecuting_macro
))
1648 direct_output_forward_char (1);
1651 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1653 struct Lisp_Char_Table
*dp
1654 = window_display_table (XWINDOW (selected_window
));
1656 lose
= FETCH_CHAR (PT_BYTE
);
1657 if (! NILP (Vpost_command_hook
))
1659 if (current_buffer
== prev_buffer
1660 && last_point_position
!= PT
1661 && NILP (Vdisable_point_adjustment
)
1662 && NILP (Vglobal_disable_point_adjustment
))
1663 adjust_point_for_property (last_point_position
, 0);
1664 already_adjusted
= 1;
1665 if (PT
== last_point_position
- 1
1667 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1668 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1669 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1670 && (lose
>= 0x20 && lose
< 0x7f)))
1671 : (lose
>= 0x20 && lose
< 0x7f))
1672 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1674 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1676 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1678 && !windows_or_buffers_changed
1679 && EQ (current_buffer
->selective_display
, Qnil
)
1680 && !detect_input_pending ()
1681 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1682 && NILP (Vexecuting_macro
))
1683 direct_output_forward_char (-1);
1686 else if (EQ (Vthis_command
, Qself_insert_command
)
1687 /* Try this optimization only on char keystrokes. */
1688 && NATNUMP (last_command_char
)
1689 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1692 = translate_char (Vtranslation_table_for_input
,
1693 XFASTINT (last_command_char
), 0, 0, 0);
1695 if (NILP (Vexecuting_macro
)
1696 && !EQ (minibuf_window
, selected_window
))
1698 if (!nonundocount
|| nonundocount
>= 20)
1706 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1708 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1710 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1712 || MODIFF
<= SAVE_MODIFF
1713 || windows_or_buffers_changed
1714 || !EQ (current_buffer
->selective_display
, Qnil
)
1715 || detect_input_pending ()
1716 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1717 || !NILP (Vexecuting_macro
));
1719 value
= internal_self_insert (c
, 0);
1724 if (! NILP (Vpost_command_hook
))
1725 /* Put this before calling adjust_point_for_property
1726 so it will only get called once in any case. */
1729 /* VALUE == 1 when AFTER-CHANGE functions are
1730 installed which is the case most of the time
1731 because FONT-LOCK installs one. */
1732 if (!lose
&& !value
)
1733 direct_output_for_insert (c
);
1738 /* Here for a command that isn't executed directly */
1741 #ifdef HAVE_X_WINDOWS
1742 int scount
= SPECPDL_INDEX ();
1744 if (display_hourglass_p
1745 && NILP (Vexecuting_macro
))
1747 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1753 if (NILP (current_kboard
->Vprefix_arg
))
1755 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1757 #ifdef HAVE_X_WINDOWS
1758 /* Do not check display_hourglass_p here, because
1759 Fcommand_execute could change it, but we should cancel
1760 hourglass cursor anyway.
1761 But don't cancel the hourglass within a macro
1762 just because a command in the macro finishes. */
1763 if (NILP (Vexecuting_macro
))
1764 unbind_to (scount
, Qnil
);
1769 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1771 /* Note that the value cell will never directly contain nil
1772 if the symbol is a local variable. */
1773 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1774 safe_run_hooks (Qpost_command_hook
);
1776 /* If displaying a message, resize the echo area window to fit
1777 that message's size exactly. */
1778 if (!NILP (echo_area_buffer
[0]))
1779 resize_echo_area_exactly ();
1781 if (!NILP (Vdeferred_action_list
))
1782 safe_run_hooks (Qdeferred_action_function
);
1784 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1786 if (NILP (Vunread_command_events
)
1787 && NILP (Vunread_input_method_events
)
1788 && NILP (Vunread_post_input_method_events
)
1789 && NILP (Vexecuting_macro
)
1790 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1791 safe_run_hooks (Qpost_command_idle_hook
);
1794 /* If there is a prefix argument,
1795 1) We don't want Vlast_command to be ``universal-argument''
1796 (that would be dumb), so don't set Vlast_command,
1797 2) we want to leave echoing on so that the prefix will be
1798 echoed as part of this key sequence, so don't call
1800 3) we want to leave this_command_key_count non-zero, so that
1801 read_char will realize that it is re-reading a character, and
1802 not echo it a second time.
1804 If the command didn't actually create a prefix arg,
1805 but is merely a frame event that is transparent to prefix args,
1806 then the above doesn't apply. */
1807 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1809 current_kboard
->Vlast_command
= Vthis_command
;
1810 current_kboard
->Vreal_last_command
= real_this_command
;
1812 this_command_key_count
= 0;
1813 this_command_key_count_reset
= 0;
1814 this_single_command_key_start
= 0;
1817 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1819 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1821 /* We could also call `deactivate'mark'. */
1822 if (EQ (Vtransient_mark_mode
, Qlambda
))
1823 Vtransient_mark_mode
= Qnil
;
1826 current_buffer
->mark_active
= Qnil
;
1827 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1830 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1831 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1836 if (current_buffer
== prev_buffer
1837 && last_point_position
!= PT
1838 && NILP (Vdisable_point_adjustment
)
1839 && NILP (Vglobal_disable_point_adjustment
)
1840 && !already_adjusted
)
1841 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1843 /* Install chars successfully executed in kbd macro. */
1845 if (!NILP (current_kboard
->defining_kbd_macro
)
1846 && NILP (current_kboard
->Vprefix_arg
))
1847 finalize_kbd_macro_chars ();
1851 any_kboard_state ();
1856 extern Lisp_Object Qcomposition
, Qdisplay
;
1858 /* Adjust point to a boundary of a region that has such a property
1859 that should be treated intangible. For the moment, we check
1860 `composition', `display' and `invisible' properties.
1861 LAST_PT is the last position of point. */
1863 extern Lisp_Object Qafter_string
, Qbefore_string
;
1864 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1867 adjust_point_for_property (last_pt
, modified
)
1872 Lisp_Object val
, overlay
, tmp
;
1873 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1876 /* FIXME: cycling is probably not necessary because these properties
1877 can't be usefully combined anyway. */
1878 while (check_composition
|| check_display
|| check_invisible
)
1880 if (check_composition
1881 && PT
> BEGV
&& PT
< ZV
1882 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1883 && COMPOSITION_VALID_P (beg
, end
, val
)
1884 && beg
< PT
/* && end > PT <- It's always the case. */
1885 && (last_pt
<= beg
|| last_pt
>= end
))
1888 SET_PT (PT
< last_pt
? beg
: end
);
1889 check_display
= check_invisible
= 1;
1891 check_composition
= 0;
1893 && PT
> BEGV
&& PT
< ZV
1894 && !NILP (val
= get_char_property_and_overlay
1895 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1896 && display_prop_intangible_p (val
)
1897 && (!OVERLAYP (overlay
)
1898 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1899 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1900 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1901 && beg
< PT
) /* && end > PT <- It's always the case. */
1904 SET_PT (PT
< last_pt
? beg
: end
);
1905 check_composition
= check_invisible
= 1;
1908 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1910 int inv
, ellipsis
= 0;
1913 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1915 && !NILP (val
= get_char_property_and_overlay
1916 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1917 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1919 ellipsis
= ellipsis
|| inv
> 1
1920 || (OVERLAYP (overlay
)
1921 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1922 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1923 tmp
= Fnext_single_char_property_change
1924 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1925 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1928 && !NILP (val
= get_char_property_and_overlay
1929 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1930 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1932 ellipsis
= ellipsis
|| inv
> 1
1933 || (OVERLAYP (overlay
)
1934 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1935 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1936 tmp
= Fprevious_single_char_property_change
1937 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1938 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1941 /* Move away from the inside area. */
1942 if (beg
< PT
&& end
> PT
)
1944 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1945 /* We haven't moved yet (so we don't need to fear
1946 infinite-looping) and we were outside the range
1947 before (so either end of the range still corresponds
1948 to a move in the right direction): pretend we moved
1949 less than we actually did, so that we still have
1950 more freedom below in choosing which end of the range
1952 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1953 /* We either have moved already or the last point
1954 was already in the range: we don't get to choose
1955 which end of the range we have to go to. */
1956 : (PT
< last_pt
? beg
: end
));
1957 check_composition
= check_display
= 1;
1959 xassert (PT
== beg
|| PT
== end
);
1960 /* Pretend the area doesn't exist if the buffer is not
1962 if (!modified
&& !ellipsis
&& beg
< end
)
1964 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1965 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1966 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1967 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1968 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1969 /* We've already moved as far as we can. Trying to go
1970 to the other end would mean moving backwards and thus
1971 could lead to an infinite loop. */
1973 else if (val
= get_pos_property (make_number (PT
),
1975 TEXT_PROP_MEANS_INVISIBLE (val
)
1976 && (val
= get_pos_property
1977 (make_number (PT
== beg
? end
: beg
),
1979 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1980 (check_composition
= check_display
= 1,
1981 SET_PT (PT
== beg
? end
: beg
));
1984 check_invisible
= 0;
1988 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1991 safe_run_hooks_1 (hook
)
1994 return call1 (Vrun_hooks
, Vinhibit_quit
);
1997 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2000 safe_run_hooks_error (data
)
2003 Lisp_Object args
[3];
2004 args
[0] = build_string ("Error in %s: %s");
2005 args
[1] = Vinhibit_quit
;
2008 return Fset (Vinhibit_quit
, Qnil
);
2011 /* If we get an error while running the hook, cause the hook variable
2012 to be nil. Also inhibit quits, so that C-g won't cause the hook
2013 to mysteriously evaporate. */
2016 safe_run_hooks (hook
)
2019 int count
= SPECPDL_INDEX ();
2020 specbind (Qinhibit_quit
, hook
);
2022 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2024 unbind_to (count
, Qnil
);
2028 /* Number of seconds between polling for input. This is a Lisp
2029 variable that can be bound. */
2031 EMACS_INT polling_period
;
2033 /* Nonzero means polling for input is temporarily suppressed. */
2035 int poll_suppress_count
;
2037 /* Asynchronous timer for polling. */
2039 struct atimer
*poll_timer
;
2042 #ifdef POLL_FOR_INPUT
2044 /* Poll for input, so what we catch a C-g if it comes in. This
2045 function is called from x_make_frame_visible, see comment
2051 if (interrupt_input_blocked
== 0
2052 && !waiting_for_input
)
2053 read_avail_input (0);
2056 /* Timer callback function for poll_timer. TIMER is equal to
2060 poll_for_input (timer
)
2061 struct atimer
*timer
;
2063 if (poll_suppress_count
== 0)
2064 poll_for_input_1 ();
2067 #endif /* POLL_FOR_INPUT */
2069 /* Begin signals to poll for input, if they are appropriate.
2070 This function is called unconditionally from various places. */
2075 #ifdef POLL_FOR_INPUT
2076 if (read_socket_hook
&& !interrupt_input
)
2078 /* Turn alarm handling on unconditionally. It might have
2079 been turned off in process.c. */
2080 turn_on_atimers (1);
2082 /* If poll timer doesn't exist, are we need one with
2083 a different interval, start a new one. */
2084 if (poll_timer
== NULL
2085 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2087 EMACS_TIME interval
;
2090 cancel_atimer (poll_timer
);
2092 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2093 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2094 poll_for_input
, NULL
);
2097 /* Let the timer's callback function poll for input
2098 if this becomes zero. */
2099 --poll_suppress_count
;
2104 /* Nonzero if we are using polling to handle input asynchronously. */
2107 input_polling_used ()
2109 #ifdef POLL_FOR_INPUT
2110 return read_socket_hook
&& !interrupt_input
;
2116 /* Turn off polling. */
2121 #ifdef POLL_FOR_INPUT
2122 if (read_socket_hook
&& !interrupt_input
)
2123 ++poll_suppress_count
;
2127 /* Set the value of poll_suppress_count to COUNT
2128 and start or stop polling accordingly. */
2131 set_poll_suppress_count (count
)
2134 #ifdef POLL_FOR_INPUT
2135 if (count
== 0 && poll_suppress_count
!= 0)
2137 poll_suppress_count
= 1;
2140 else if (count
!= 0 && poll_suppress_count
== 0)
2144 poll_suppress_count
= count
;
2148 /* Bind polling_period to a value at least N.
2149 But don't decrease it. */
2152 bind_polling_period (n
)
2155 #ifdef POLL_FOR_INPUT
2156 int new = polling_period
;
2161 stop_other_atimers (poll_timer
);
2163 specbind (Qpolling_period
, make_number (new));
2164 /* Start a new alarm with the new period. */
2169 /* Apply the control modifier to CHARACTER. */
2175 /* Save the upper bits here. */
2176 int upper
= c
& ~0177;
2180 /* Everything in the columns containing the upper-case letters
2181 denotes a control character. */
2182 if (c
>= 0100 && c
< 0140)
2186 /* Set the shift modifier for a control char
2187 made from a shifted letter. But only for letters! */
2188 if (oc
>= 'A' && oc
<= 'Z')
2189 c
|= shift_modifier
;
2192 /* The lower-case letters denote control characters too. */
2193 else if (c
>= 'a' && c
<= 'z')
2196 /* Include the bits for control and shift
2197 only if the basic ASCII code can't indicate them. */
2201 /* Replace the high bits. */
2202 c
|= (upper
& ~ctrl_modifier
);
2207 /* Display help echo in the echo area.
2209 HELP a string means display that string, HELP nil means clear the
2210 help echo. If HELP is a function, call it with OBJECT and POS as
2211 arguments; the function should return a help string or nil for
2212 none. For all other types of HELP evaluate it to obtain a string.
2214 WINDOW is the window in which the help was generated, if any.
2215 It is nil if not in a window.
2217 If OBJECT is a buffer, POS is the position in the buffer where the
2218 `help-echo' text property was found.
2220 If OBJECT is an overlay, that overlay has a `help-echo' property,
2221 and POS is the position in the overlay's buffer under the mouse.
2223 If OBJECT is a string (an overlay string or a string displayed with
2224 the `display' property). POS is the position in that string under
2227 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2228 echo overwrites a keystroke echo currently displayed in the echo
2231 Note: this function may only be called with HELP nil or a string
2232 from X code running asynchronously. */
2235 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2236 Lisp_Object help
, window
, object
, pos
;
2237 int ok_to_overwrite_keystroke_echo
;
2239 if (!NILP (help
) && !STRINGP (help
))
2241 if (FUNCTIONP (help
))
2243 Lisp_Object args
[4];
2248 help
= safe_call (4, args
);
2251 help
= safe_eval (help
);
2253 if (!STRINGP (help
))
2257 if (STRINGP (help
) || NILP (help
))
2259 if (!NILP (Vshow_help_function
))
2260 call1 (Vshow_help_function
, help
);
2261 else if (/* Don't overwrite minibuffer contents. */
2262 !MINI_WINDOW_P (XWINDOW (selected_window
))
2263 /* Don't overwrite a keystroke echo. */
2264 && (NILP (echo_message_buffer
)
2265 || ok_to_overwrite_keystroke_echo
)
2266 /* Don't overwrite a prompt. */
2267 && !cursor_in_echo_area
)
2271 int count
= SPECPDL_INDEX ();
2273 if (!help_echo_showing_p
)
2274 Vpre_help_message
= current_message ();
2276 specbind (Qmessage_truncate_lines
, Qt
);
2277 message3_nolog (help
, SBYTES (help
),
2278 STRING_MULTIBYTE (help
));
2279 unbind_to (count
, Qnil
);
2281 else if (STRINGP (Vpre_help_message
))
2283 message3_nolog (Vpre_help_message
,
2284 SBYTES (Vpre_help_message
),
2285 STRING_MULTIBYTE (Vpre_help_message
));
2286 Vpre_help_message
= Qnil
;
2292 help_echo_showing_p
= STRINGP (help
);
2298 /* Input of single characters from keyboard */
2300 Lisp_Object
print_help ();
2301 static Lisp_Object
kbd_buffer_get_event ();
2302 static void record_char ();
2305 static jmp_buf wrong_kboard_jmpbuf
;
2308 #define STOP_POLLING \
2309 do { if (! polling_stopped_here) stop_polling (); \
2310 polling_stopped_here = 1; } while (0)
2312 #define RESUME_POLLING \
2313 do { if (polling_stopped_here) start_polling (); \
2314 polling_stopped_here = 0; } while (0)
2316 /* read a character from the keyboard; call the redisplay if needed */
2317 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2318 -1 means do not do redisplay, but do do autosaving.
2321 /* The arguments MAPS and NMAPS are for menu prompting.
2322 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2324 PREV_EVENT is the previous input event, or nil if we are reading
2325 the first event of a key sequence (or not reading a key sequence).
2326 If PREV_EVENT is t, that is a "magic" value that says
2327 not to run input methods, but in other respects to act as if
2328 not reading a key sequence.
2330 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2331 if we used a mouse menu to read the input, or zero otherwise. If
2332 USED_MOUSE_MENU is null, we don't dereference it.
2334 Value is t if we showed a menu and the user rejected it. */
2337 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2341 Lisp_Object prev_event
;
2342 int *used_mouse_menu
;
2344 volatile Lisp_Object c
;
2346 jmp_buf local_getcjmp
;
2348 volatile int key_already_recorded
= 0;
2349 Lisp_Object tem
, save
;
2350 volatile Lisp_Object previous_echo_area_message
;
2351 volatile Lisp_Object also_record
;
2352 volatile int reread
;
2353 struct gcpro gcpro1
, gcpro2
;
2354 EMACS_TIME last_idle_start
;
2355 int polling_stopped_here
= 0;
2359 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2360 before_command_key_count
= this_command_key_count
;
2361 before_command_echo_length
= echo_length ();
2364 previous_echo_area_message
= Qnil
;
2366 GCPRO2 (c
, previous_echo_area_message
);
2371 if (CONSP (Vunread_post_input_method_events
))
2373 c
= XCAR (Vunread_post_input_method_events
);
2374 Vunread_post_input_method_events
2375 = XCDR (Vunread_post_input_method_events
);
2377 /* Undo what read_char_x_menu_prompt did when it unread
2378 additional keys returned by Fx_popup_menu. */
2380 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2388 if (unread_command_char
!= -1)
2390 XSETINT (c
, unread_command_char
);
2391 unread_command_char
= -1;
2397 if (CONSP (Vunread_command_events
))
2399 c
= XCAR (Vunread_command_events
);
2400 Vunread_command_events
= XCDR (Vunread_command_events
);
2402 /* Undo what read_char_x_menu_prompt did when it unread
2403 additional keys returned by Fx_popup_menu. */
2405 && EQ (XCDR (c
), Qdisabled
)
2406 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2409 /* If the queued event is something that used the mouse,
2410 set used_mouse_menu accordingly. */
2412 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2413 *used_mouse_menu
= 1;
2416 goto reread_for_input_method
;
2419 if (CONSP (Vunread_input_method_events
))
2421 c
= XCAR (Vunread_input_method_events
);
2422 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2424 /* Undo what read_char_x_menu_prompt did when it unread
2425 additional keys returned by Fx_popup_menu. */
2427 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2431 goto reread_for_input_method
;
2434 this_command_key_count_reset
= 0;
2436 if (!NILP (Vexecuting_macro
))
2438 /* We set this to Qmacro; since that's not a frame, nobody will
2439 try to switch frames on us, and the selected window will
2442 Since this event came from a macro, it would be misleading to
2443 leave internal_last_event_frame set to wherever the last
2444 real event came from. Normally, a switch-frame event selects
2445 internal_last_event_frame after each command is read, but
2446 events read from a macro should never cause a new frame to be
2448 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2450 /* Exit the macro if we are at the end.
2451 Also, some things replace the macro with t
2452 to force an early exit. */
2453 if (EQ (Vexecuting_macro
, Qt
)
2454 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2460 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2461 if (STRINGP (Vexecuting_macro
)
2462 && (XINT (c
) & 0x80))
2463 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2465 executing_macro_index
++;
2470 if (!NILP (unread_switch_frame
))
2472 c
= unread_switch_frame
;
2473 unread_switch_frame
= Qnil
;
2475 /* This event should make it into this_command_keys, and get echoed
2476 again, so we do not set `reread'. */
2480 /* if redisplay was requested */
2481 if (commandflag
>= 0)
2483 /* If there is pending input, process any events which are not
2484 user-visible, such as X selection_request events. */
2486 || detect_input_pending_run_timers (0))
2487 swallow_events (0); /* may clear input_pending */
2489 /* Redisplay if no pending input. */
2490 while (!input_pending
)
2492 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2493 redisplay_preserve_echo_area (5);
2498 /* Normal case: no input arrived during redisplay. */
2501 /* Input arrived and pre-empted redisplay.
2502 Process any events which are not user-visible. */
2504 /* If that cleared input_pending, try again to redisplay. */
2508 /* Message turns off echoing unless more keystrokes turn it on again.
2510 The code in 20.x for the condition was
2512 1. echo_area_glyphs && *echo_area_glyphs
2513 2. && echo_area_glyphs != current_kboard->echobuf
2514 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2516 (1) means there's a current message displayed
2518 (2) means it's not the message from echoing from the current
2521 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2522 is set to a non-null value. This is done in read_char and it is
2523 set to echo_area_glyphs after a call to echo_char. That means
2524 ok_to_echo_at_next_pause is either null or
2525 current_kboard->echobuf with the appropriate current_kboard at
2528 So, condition (3) means in clear text ok_to_echo_at_next_pause
2529 must be either null, or the current message isn't from echoing at
2530 all, or it's from echoing from a different kboard than the
2533 if (/* There currently is something in the echo area. */
2534 !NILP (echo_area_buffer
[0])
2535 && (/* And it's either not from echoing. */
2536 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2537 /* Or it's an echo from a different kboard. */
2538 || echo_kboard
!= current_kboard
2539 /* Or we explicitly allow overwriting whatever there is. */
2540 || ok_to_echo_at_next_pause
== NULL
))
2545 /* Try reading a character via menu prompting in the minibuf.
2546 Try this before the sit-for, because the sit-for
2547 would do the wrong thing if we are supposed to do
2548 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2549 after a mouse event so don't try a minibuf menu. */
2551 if (nmaps
> 0 && INTERACTIVE
2552 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2553 /* Don't bring up a menu if we already have another event. */
2554 && NILP (Vunread_command_events
)
2555 && unread_command_char
< 0
2556 && !detect_input_pending_run_timers (0))
2558 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2561 key_already_recorded
= 1;
2566 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2567 We will do that below, temporarily for short sections of code,
2568 when appropriate. local_getcjmp must be in effect
2569 around any call to sit_for or kbd_buffer_get_event;
2570 it *must not* be in effect when we call redisplay. */
2572 if (_setjmp (local_getcjmp
))
2574 XSETINT (c
, quit_char
);
2575 internal_last_event_frame
= selected_frame
;
2576 Vlast_event_frame
= internal_last_event_frame
;
2577 /* If we report the quit char as an event,
2578 don't do so more than once. */
2579 if (!NILP (Vinhibit_quit
))
2584 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2585 if (kb
!= current_kboard
)
2587 Lisp_Object link
= kb
->kbd_queue
;
2588 /* We shouldn't get here if we were in single-kboard mode! */
2593 while (CONSP (XCDR (link
)))
2595 if (!NILP (XCDR (link
)))
2599 kb
->kbd_queue
= Fcons (c
, Qnil
);
2601 XSETCDR (link
, Fcons (c
, Qnil
));
2602 kb
->kbd_queue_has_data
= 1;
2603 current_kboard
= kb
;
2604 /* This is going to exit from read_char
2605 so we had better get rid of this frame's stuff. */
2607 longjmp (wrong_kboard_jmpbuf
, 1);
2614 timer_start_idle ();
2616 /* If in middle of key sequence and minibuffer not active,
2617 start echoing if enough time elapses. */
2619 if (minibuf_level
== 0
2620 && !current_kboard
->immediate_echo
2621 && this_command_key_count
> 0
2623 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2624 && NILP (Fzerop (Vecho_keystrokes
))
2625 && (/* No message. */
2626 NILP (echo_area_buffer
[0])
2627 /* Or empty message. */
2628 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2629 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2630 /* Or already echoing from same kboard. */
2631 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2632 /* Or not echoing before and echoing allowed. */
2633 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2637 /* After a mouse event, start echoing right away.
2638 This is because we are probably about to display a menu,
2639 and we don't want to delay before doing so. */
2640 if (EVENT_HAS_PARAMETERS (prev_event
))
2645 double duration
= extract_float (Vecho_keystrokes
);
2646 sec
= (int) duration
;
2647 usec
= (duration
- sec
) * 1000000;
2648 save_getcjmp (save_jump
);
2649 restore_getcjmp (local_getcjmp
);
2650 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2651 restore_getcjmp (save_jump
);
2653 && ! CONSP (Vunread_command_events
))
2658 /* Maybe auto save due to number of keystrokes. */
2660 if (commandflag
!= 0
2661 && auto_save_interval
> 0
2662 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2663 && !detect_input_pending_run_timers (0))
2665 Fdo_auto_save (Qnil
, Qnil
);
2666 /* Hooks can actually change some buffers in auto save. */
2670 /* Try reading using an X menu.
2671 This is never confused with reading using the minibuf
2672 because the recursive call of read_char in read_char_minibuf_menu_prompt
2673 does not pass on any keymaps. */
2675 if (nmaps
> 0 && INTERACTIVE
2676 && !NILP (prev_event
)
2677 && EVENT_HAS_PARAMETERS (prev_event
)
2678 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2679 && !EQ (XCAR (prev_event
), Qtool_bar
)
2680 /* Don't bring up a menu if we already have another event. */
2681 && NILP (Vunread_command_events
)
2682 && unread_command_char
< 0)
2684 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2686 /* Now that we have read an event, Emacs is not idle. */
2692 /* Maybe autosave and/or garbage collect due to idleness. */
2694 if (INTERACTIVE
&& NILP (c
))
2696 int delay_level
, buffer_size
;
2698 /* Slow down auto saves logarithmically in size of current buffer,
2699 and garbage collect while we're at it. */
2700 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2701 last_non_minibuf_size
= Z
- BEG
;
2702 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2704 while (buffer_size
> 64)
2705 delay_level
++, buffer_size
-= buffer_size
>> 2;
2706 if (delay_level
< 4) delay_level
= 4;
2707 /* delay_level is 4 for files under around 50k, 7 at 100k,
2708 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2710 /* Auto save if enough time goes by without input. */
2711 if (commandflag
!= 0
2712 && num_nonmacro_input_events
> last_auto_save
2713 && INTEGERP (Vauto_save_timeout
)
2714 && XINT (Vauto_save_timeout
) > 0)
2718 save_getcjmp (save_jump
);
2719 restore_getcjmp (local_getcjmp
);
2720 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2722 restore_getcjmp (save_jump
);
2725 && ! CONSP (Vunread_command_events
))
2727 Fdo_auto_save (Qnil
, Qnil
);
2729 /* If we have auto-saved and there is still no input
2730 available, garbage collect if there has been enough
2731 consing going on to make it worthwhile. */
2732 if (!detect_input_pending_run_timers (0)
2733 && consing_since_gc
> gc_cons_threshold
/ 2)
2734 Fgarbage_collect ();
2741 /* If this has become non-nil here, it has been set by a timer
2742 or sentinel or filter. */
2743 if (CONSP (Vunread_command_events
))
2745 c
= XCAR (Vunread_command_events
);
2746 Vunread_command_events
= XCDR (Vunread_command_events
);
2749 /* Read something from current KBOARD's side queue, if possible. */
2753 if (current_kboard
->kbd_queue_has_data
)
2755 if (!CONSP (current_kboard
->kbd_queue
))
2757 c
= XCAR (current_kboard
->kbd_queue
);
2758 current_kboard
->kbd_queue
2759 = XCDR (current_kboard
->kbd_queue
);
2760 if (NILP (current_kboard
->kbd_queue
))
2761 current_kboard
->kbd_queue_has_data
= 0;
2762 input_pending
= readable_events (0);
2763 if (EVENT_HAS_PARAMETERS (c
)
2764 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2765 internal_last_event_frame
= XCAR (XCDR (c
));
2766 Vlast_event_frame
= internal_last_event_frame
;
2771 /* If current_kboard's side queue is empty check the other kboards.
2772 If one of them has data that we have not yet seen here,
2773 switch to it and process the data waiting for it.
2775 Note: if the events queued up for another kboard
2776 have already been seen here, and therefore are not a complete command,
2777 the kbd_queue_has_data field is 0, so we skip that kboard here.
2778 That's to avoid an infinite loop switching between kboards here. */
2779 if (NILP (c
) && !single_kboard
)
2782 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2783 if (kb
->kbd_queue_has_data
)
2785 current_kboard
= kb
;
2786 /* This is going to exit from read_char
2787 so we had better get rid of this frame's stuff. */
2789 longjmp (wrong_kboard_jmpbuf
, 1);
2798 /* Finally, we read from the main queue,
2799 and if that gives us something we can't use yet, we put it on the
2800 appropriate side queue and try again. */
2806 /* Actually read a character, waiting if necessary. */
2807 save_getcjmp (save_jump
);
2808 restore_getcjmp (local_getcjmp
);
2809 timer_start_idle ();
2810 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2811 restore_getcjmp (save_jump
);
2814 if (! NILP (c
) && (kb
!= current_kboard
))
2816 Lisp_Object link
= kb
->kbd_queue
;
2819 while (CONSP (XCDR (link
)))
2821 if (!NILP (XCDR (link
)))
2825 kb
->kbd_queue
= Fcons (c
, Qnil
);
2827 XSETCDR (link
, Fcons (c
, Qnil
));
2828 kb
->kbd_queue_has_data
= 1;
2832 current_kboard
= kb
;
2833 /* This is going to exit from read_char
2834 so we had better get rid of this frame's stuff. */
2836 longjmp (wrong_kboard_jmpbuf
, 1);
2841 /* Terminate Emacs in batch mode if at eof. */
2842 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2843 Fkill_emacs (make_number (1));
2847 /* Add in any extra modifiers, where appropriate. */
2848 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2849 || ((extra_keyboard_modifiers
& 0177) < ' '
2850 && (extra_keyboard_modifiers
& 0177) != 0))
2851 XSETINT (c
, make_ctrl_char (XINT (c
)));
2853 /* Transfer any other modifier bits directly from
2854 extra_keyboard_modifiers to c. Ignore the actual character code
2855 in the low 16 bits of extra_keyboard_modifiers. */
2856 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2861 /* Record the last idle start time so that we can reset it
2862 should the next event read be a help-echo. */
2863 last_idle_start
= timer_idleness_start_time
;
2869 if (commandflag
>= 0
2870 && !input_pending
&& !detect_input_pending_run_timers (0))
2878 /* Buffer switch events are only for internal wakeups
2879 so don't show them to the user.
2880 Also, don't record a key if we already did. */
2881 if (BUFFERP (c
) || key_already_recorded
)
2884 /* Process special events within read_char
2885 and loop around to read another event. */
2888 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2893 int was_locked
= single_kboard
;
2895 last_input_char
= c
;
2896 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2898 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2899 /* We stopped being idle for this event; undo that. This
2900 prevents automatic window selection (under
2901 mouse_autoselect_window from acting as a real input event, for
2902 example banishing the mouse under mouse-avoidance-mode. */
2903 timer_idleness_start_time
= last_idle_start
;
2905 /* Resume allowing input from any kboard, if that was true before. */
2907 any_kboard_state ();
2912 /* Handle things that only apply to characters. */
2915 /* If kbd_buffer_get_event gave us an EOF, return that. */
2919 if ((STRINGP (Vkeyboard_translate_table
)
2920 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2921 || (VECTORP (Vkeyboard_translate_table
)
2922 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2923 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2924 && CHAR_VALID_P (XINT (c
), 0)))
2927 d
= Faref (Vkeyboard_translate_table
, c
);
2928 /* nil in keyboard-translate-table means no translation. */
2934 /* If this event is a mouse click in the menu bar,
2935 return just menu-bar for now. Modify the mouse click event
2936 so we won't do this twice, then queue it up. */
2937 if (EVENT_HAS_PARAMETERS (c
)
2939 && CONSP (EVENT_START (c
))
2940 && CONSP (XCDR (EVENT_START (c
))))
2944 posn
= POSN_BUFFER_POSN (EVENT_START (c
));
2945 /* Handle menu-bar events:
2946 insert the dummy prefix event `menu-bar'. */
2947 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2949 /* Change menu-bar to (menu-bar) as the event "position". */
2950 POSN_BUFFER_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2953 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2958 /* Store these characters into recent_keys, the dribble file if any,
2959 and the keyboard macro being defined, if any. */
2961 if (! NILP (also_record
))
2962 record_char (also_record
);
2964 /* Wipe the echo area.
2965 But first, if we are about to use an input method,
2966 save the echo area contents for it to refer to. */
2968 && ! NILP (Vinput_method_function
)
2969 && (unsigned) XINT (c
) >= ' '
2970 && (unsigned) XINT (c
) != 127
2971 && (unsigned) XINT (c
) < 256)
2973 previous_echo_area_message
= Fcurrent_message ();
2974 Vinput_method_previous_message
= previous_echo_area_message
;
2977 /* Now wipe the echo area, except for help events which do their
2978 own stuff with the echo area. */
2980 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2981 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2983 if (!NILP (echo_area_buffer
[0]))
2984 safe_run_hooks (Qecho_area_clear_hook
);
2985 clear_message (1, 0);
2988 reread_for_input_method
:
2990 /* Pass this to the input method, if appropriate. */
2992 && ! NILP (Vinput_method_function
)
2993 /* Don't run the input method within a key sequence,
2994 after the first event of the key sequence. */
2995 && NILP (prev_event
)
2996 && (unsigned) XINT (c
) >= ' '
2997 && (unsigned) XINT (c
) != 127
2998 && (unsigned) XINT (c
) < 256)
3001 int key_count
, key_count_reset
;
3002 struct gcpro gcpro1
;
3003 int count
= SPECPDL_INDEX ();
3005 /* Save the echo status. */
3006 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3007 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3008 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3011 if (before_command_restore_flag
)
3013 this_command_key_count
= before_command_key_count_1
;
3014 if (this_command_key_count
< this_single_command_key_start
)
3015 this_single_command_key_start
= this_command_key_count
;
3016 echo_truncate (before_command_echo_length_1
);
3017 before_command_restore_flag
= 0;
3021 /* Save the this_command_keys status. */
3022 key_count
= this_command_key_count
;
3023 key_count_reset
= this_command_key_count_reset
;
3026 keys
= Fcopy_sequence (this_command_keys
);
3031 /* Clear out this_command_keys. */
3032 this_command_key_count
= 0;
3033 this_command_key_count_reset
= 0;
3035 /* Now wipe the echo area. */
3036 if (!NILP (echo_area_buffer
[0]))
3037 safe_run_hooks (Qecho_area_clear_hook
);
3038 clear_message (1, 0);
3041 /* If we are not reading a key sequence,
3042 never use the echo area. */
3045 specbind (Qinput_method_use_echo_area
, Qt
);
3048 /* Call the input method. */
3049 tem
= call1 (Vinput_method_function
, c
);
3051 tem
= unbind_to (count
, tem
);
3053 /* Restore the saved echoing state
3054 and this_command_keys state. */
3055 this_command_key_count
= key_count
;
3056 this_command_key_count_reset
= key_count_reset
;
3058 this_command_keys
= keys
;
3061 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3062 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3063 if (saved_immediate_echo
)
3068 /* The input method can return no events. */
3071 /* Bring back the previous message, if any. */
3072 if (! NILP (previous_echo_area_message
))
3073 message_with_string ("%s", previous_echo_area_message
, 0);
3076 /* It returned one event or more. */
3078 Vunread_post_input_method_events
3079 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3084 /* Display help if not echoing. */
3085 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3087 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3088 Lisp_Object help
, object
, position
, window
, tem
;
3090 tem
= Fcdr (XCDR (c
));
3093 window
= Fcar (tem
);
3095 object
= Fcar (tem
);
3097 position
= Fcar (tem
);
3099 show_help_echo (help
, window
, object
, position
, 0);
3101 /* We stopped being idle for this event; undo that. */
3102 timer_idleness_start_time
= last_idle_start
;
3106 if (! reread
|| this_command_key_count
== 0
3107 || this_command_key_count_reset
)
3110 /* Don't echo mouse motion events. */
3111 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3112 && NILP (Fzerop (Vecho_keystrokes
))
3113 && ! (EVENT_HAS_PARAMETERS (c
)
3114 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3117 if (! NILP (also_record
))
3118 echo_char (also_record
);
3119 /* Once we reread a character, echoing can happen
3120 the next time we pause to read a new one. */
3121 ok_to_echo_at_next_pause
= current_kboard
;
3124 /* Record this character as part of the current key. */
3125 add_command_key (c
);
3126 if (! NILP (also_record
))
3127 add_command_key (also_record
);
3130 last_input_char
= c
;
3133 /* Process the help character specially if enabled */
3134 if (!NILP (Vhelp_form
) && help_char_p (c
))
3137 count
= SPECPDL_INDEX ();
3139 record_unwind_protect (Fset_window_configuration
,
3140 Fcurrent_window_configuration (Qnil
));
3142 tem0
= Feval (Vhelp_form
);
3144 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3148 c
= read_char (0, 0, 0, Qnil
, 0);
3149 while (BUFFERP (c
));
3150 /* Remove the help from the frame */
3151 unbind_to (count
, Qnil
);
3154 if (EQ (c
, make_number (040)))
3158 c
= read_char (0, 0, 0, Qnil
, 0);
3159 while (BUFFERP (c
));
3168 /* Record a key that came from a mouse menu.
3169 Record it for echoing, for this-command-keys, and so on. */
3175 /* Wipe the echo area. */
3176 clear_message (1, 0);
3181 before_command_key_count
= this_command_key_count
;
3182 before_command_echo_length
= echo_length ();
3185 /* Don't echo mouse motion events. */
3186 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3187 && NILP (Fzerop (Vecho_keystrokes
)))
3191 /* Once we reread a character, echoing can happen
3192 the next time we pause to read a new one. */
3193 ok_to_echo_at_next_pause
= 0;
3196 /* Record this character as part of the current key. */
3197 add_command_key (c
);
3199 /* Re-reading in the middle of a command */
3200 last_input_char
= c
;
3204 /* Return 1 if should recognize C as "the help character". */
3212 if (EQ (c
, Vhelp_char
))
3214 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3215 if (EQ (c
, XCAR (tail
)))
3220 /* Record the input event C in various ways. */
3228 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3230 /* To avoid filling recent_keys with help-echo and mouse-movement
3231 events, we filter out repeated help-echo events, only store the
3232 first and last in a series of mouse-movement events, and don't
3233 store repeated help-echo events which are only separated by
3234 mouse-movement events. */
3236 Lisp_Object ev1
, ev2
, ev3
;
3239 if ((ix1
= recent_keys_index
- 1) < 0)
3240 ix1
= NUM_RECENT_KEYS
- 1;
3241 ev1
= AREF (recent_keys
, ix1
);
3243 if ((ix2
= ix1
- 1) < 0)
3244 ix2
= NUM_RECENT_KEYS
- 1;
3245 ev2
= AREF (recent_keys
, ix2
);
3247 if ((ix3
= ix2
- 1) < 0)
3248 ix3
= NUM_RECENT_KEYS
- 1;
3249 ev3
= AREF (recent_keys
, ix3
);
3251 if (EQ (XCAR (c
), Qhelp_echo
))
3253 /* Don't record `help-echo' in recent_keys unless it shows some help
3254 message, and a different help than the previously recorded
3256 Lisp_Object help
, last_help
;
3258 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3259 if (!STRINGP (help
))
3261 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3262 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3264 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3265 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3266 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3268 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3269 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3270 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3271 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3274 else if (EQ (XCAR (c
), Qmouse_movement
))
3276 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3277 So additional mouse movement events replace the last element. */
3278 Lisp_Object last_window
, window
;
3280 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3281 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3282 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3283 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3284 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3286 ASET (recent_keys
, ix1
, c
);
3292 store_kbd_macro_char (c
);
3297 ASET (recent_keys
, recent_keys_index
, c
);
3298 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3299 recent_keys_index
= 0;
3301 else if (recorded
< 0)
3303 /* We need to remove one or two events from recent_keys.
3304 To do this, we simply put nil at those events and move the
3305 recent_keys_index backwards over those events. Usually,
3306 users will never see those nil events, as they will be
3307 overwritten by the command keys entered to see recent_keys
3310 while (recorded
++ < 0 && total_keys
> 0)
3312 if (total_keys
< NUM_RECENT_KEYS
)
3314 if (--recent_keys_index
< 0)
3315 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3316 ASET (recent_keys
, recent_keys_index
, Qnil
);
3320 num_nonmacro_input_events
++;
3322 /* Write c to the dribble file. If c is a lispy event, write
3323 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3324 If you, dear reader, have a better idea, you've got the source. :-) */
3329 if (XUINT (c
) < 0x100)
3330 putc (XINT (c
), dribble
);
3332 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3336 Lisp_Object dribblee
;
3338 /* If it's a structured event, take the event header. */
3339 dribblee
= EVENT_HEAD (c
);
3341 if (SYMBOLP (dribblee
))
3343 putc ('<', dribble
);
3344 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3345 SBYTES (SYMBOL_NAME (dribblee
)),
3347 putc ('>', dribble
);
3359 struct buffer
*old
= current_buffer
;
3360 Fprinc (object
, Qnil
);
3361 set_buffer_internal (XBUFFER (Vstandard_output
));
3362 call0 (intern ("help-mode"));
3363 set_buffer_internal (old
);
3367 /* Copy out or in the info on where C-g should throw to.
3368 This is used when running Lisp code from within get_char,
3369 in case get_char is called recursively.
3370 See read_process_output. */
3376 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3380 restore_getcjmp (temp
)
3383 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3388 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3389 of this function. */
3392 tracking_off (old_value
)
3393 Lisp_Object old_value
;
3395 do_mouse_tracking
= old_value
;
3396 if (NILP (old_value
))
3398 /* Redisplay may have been preempted because there was input
3399 available, and it assumes it will be called again after the
3400 input has been processed. If the only input available was
3401 the sort that we have just disabled, then we need to call
3403 if (!readable_events (1))
3405 redisplay_preserve_echo_area (6);
3406 get_input_pending (&input_pending
, 1);
3412 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3413 doc
: /* Evaluate BODY with mouse movement events enabled.
3414 Within a `track-mouse' form, mouse motion generates input events that
3415 you can read with `read-event'.
3416 Normally, mouse motion is ignored.
3417 usage: (track-mouse BODY ...) */)
3421 int count
= SPECPDL_INDEX ();
3424 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3426 do_mouse_tracking
= Qt
;
3428 val
= Fprogn (args
);
3429 return unbind_to (count
, val
);
3432 /* If mouse has moved on some frame, return one of those frames.
3433 Return 0 otherwise. */
3438 Lisp_Object tail
, frame
;
3440 FOR_EACH_FRAME (tail
, frame
)
3442 if (XFRAME (frame
)->mouse_moved
)
3443 return XFRAME (frame
);
3449 #endif /* HAVE_MOUSE */
3451 /* Low level keyboard/mouse input.
3452 kbd_buffer_store_event places events in kbd_buffer, and
3453 kbd_buffer_get_event retrieves them. */
3455 /* Return true iff there are any events in the queue that read-char
3456 would return. If this returns false, a read-char would block. */
3458 readable_filtered_events (do_timers_now
, filter_events
)
3463 timer_check (do_timers_now
);
3465 /* If the buffer contains only FOCUS_IN_EVENT events,
3466 and FILTER_EVENTS is nonzero, report it as empty. */
3467 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3469 int have_live_event
= 1;
3473 struct input_event
*event
;
3475 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3479 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3482 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3484 if (event
== kbd_store_ptr
)
3485 have_live_event
= 0;
3488 if (have_live_event
) return 1;
3492 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3497 if (current_kboard
->kbd_queue_has_data
)
3503 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3504 if (kb
->kbd_queue_has_data
)
3510 /* Return true iff there are any events in the queue that read-char
3511 would return. If this returns false, a read-char would block. */
3513 readable_events (do_timers_now
)
3516 return readable_filtered_events (do_timers_now
, 0);
3519 /* Set this for debugging, to have a way to get out */
3524 event_to_kboard (event
)
3525 struct input_event
*event
;
3528 frame
= event
->frame_or_window
;
3530 frame
= XCAR (frame
);
3531 else if (WINDOWP (frame
))
3532 frame
= WINDOW_FRAME (XWINDOW (frame
));
3534 /* There are still some events that don't set this field.
3535 For now, just ignore the problem.
3536 Also ignore dead frames here. */
3537 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3540 return FRAME_KBOARD (XFRAME (frame
));
3544 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3547 kbd_buffer_store_event (event
)
3548 register struct input_event
*event
;
3550 if (event
->kind
== NO_EVENT
)
3553 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3555 register int c
= event
->code
& 0377;
3557 if (event
->modifiers
& ctrl_modifier
)
3558 c
= make_ctrl_char (c
);
3560 c
|= (event
->modifiers
3561 & (meta_modifier
| alt_modifier
3562 | hyper_modifier
| super_modifier
));
3568 struct input_event
*sp
;
3571 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3572 kb
!= current_kboard
))
3575 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3576 Fcons (make_number (c
), Qnil
));
3577 kb
->kbd_queue_has_data
= 1;
3578 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3580 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3583 if (event_to_kboard (sp
) == kb
)
3585 sp
->kind
= NO_EVENT
;
3586 sp
->frame_or_window
= Qnil
;
3594 /* If this results in a quit_char being returned to Emacs as
3595 input, set Vlast_event_frame properly. If this doesn't
3596 get returned to Emacs as an event, the next event read
3597 will set Vlast_event_frame again, so this is safe to do. */
3601 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3603 focus
= event
->frame_or_window
;
3604 internal_last_event_frame
= focus
;
3605 Vlast_event_frame
= focus
;
3608 last_event_timestamp
= event
->timestamp
;
3609 interrupt_signal (0 /* dummy */);
3613 if (c
&& c
== stop_character
)
3619 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3620 Just ignore the second one. */
3621 else if (event
->kind
== BUFFER_SWITCH_EVENT
3622 && kbd_fetch_ptr
!= kbd_store_ptr
3623 && kbd_store_ptr
->kind
== BUFFER_SWITCH_EVENT
)
3626 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3627 kbd_store_ptr
= kbd_buffer
;
3629 /* Don't let the very last slot in the buffer become full,
3630 since that would make the two pointers equal,
3631 and that is indistinguishable from an empty buffer.
3632 Discard the event if it would fill the last slot. */
3633 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3637 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3638 prone to assign individual members for other events, in case
3639 the input_event structure is changed. --2000-07-13, gerd. */
3640 struct input_event
*sp
= kbd_store_ptr
;
3641 sp
->kind
= event
->kind
;
3642 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3644 /* We must not use the ordinary copying code for this case,
3645 since `part' is an enum and copying it might not copy enough
3647 bcopy (event
, (char *) sp
, sizeof (*event
));
3652 sp
->code
= event
->code
;
3653 sp
->part
= event
->part
;
3654 sp
->frame_or_window
= event
->frame_or_window
;
3655 sp
->arg
= event
->arg
;
3656 sp
->modifiers
= event
->modifiers
;
3659 sp
->timestamp
= event
->timestamp
;
3662 *kbd_store_ptr
= *event
;
3665 idx
= 2 * (kbd_store_ptr
- kbd_buffer
);
3666 ASET (kbd_buffer_gcpro
, idx
, event
->frame_or_window
);
3667 ASET (kbd_buffer_gcpro
, idx
+ 1, event
->arg
);
3673 /* Generate HELP_EVENT input_events in BUFP which has room for
3674 SIZE events. If there's not enough room in BUFP, ignore this
3677 HELP is the help form.
3679 FRAME is the frame on which the help is generated. OBJECT is the
3680 Lisp object where the help was found (a buffer, a string, an
3681 overlay, or nil if neither from a string nor from a buffer. POS is
3682 the position within OBJECT where the help was found.
3684 Value is the number of input_events generated. */
3687 gen_help_event (bufp
, size
, help
, frame
, window
, object
, pos
)
3688 struct input_event
*bufp
;
3690 Lisp_Object help
, frame
, object
, window
;
3695 bufp
->kind
= HELP_EVENT
;
3696 bufp
->frame_or_window
= frame
;
3698 bufp
->x
= WINDOWP (window
) ? window
: frame
;
3707 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3710 kbd_buffer_store_help_event (frame
, help
)
3711 Lisp_Object frame
, help
;
3713 struct input_event event
;
3715 event
.kind
= HELP_EVENT
;
3716 event
.frame_or_window
= frame
;
3721 kbd_buffer_store_event (&event
);
3725 /* Discard any mouse events in the event buffer by setting them to
3728 discard_mouse_events ()
3730 struct input_event
*sp
;
3731 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3733 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3736 if (sp
->kind
== MOUSE_CLICK_EVENT
3737 || sp
->kind
== WHEEL_EVENT
3739 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3741 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3743 sp
->kind
= NO_EVENT
;
3749 /* Return non-zero if there are any real events waiting in the event
3750 buffer, not counting `NO_EVENT's.
3752 If DISCARD is non-zero, discard NO_EVENT events at the front of
3753 the input queue, possibly leaving the input queue empty if there
3754 are no real input events. */
3757 kbd_buffer_events_waiting (discard
)
3760 struct input_event
*sp
;
3762 for (sp
= kbd_fetch_ptr
;
3763 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3766 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3773 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3777 /* Clear input event EVENT. */
3781 struct input_event
*event
;
3783 int idx
= 2 * (event
- kbd_buffer
);
3784 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
3785 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
3786 event
->kind
= NO_EVENT
;
3790 /* Read one event from the event buffer, waiting if necessary.
3791 The value is a Lisp object representing the event.
3792 The value is nil for an event that should be ignored,
3793 or that was handled here.
3794 We always read and discard one event. */
3797 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3799 int *used_mouse_menu
;
3808 *kbp
= current_kboard
;
3812 /* Wait until there is input available. */
3815 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3818 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3822 /* If the quit flag is set, then read_char will return
3823 quit_char, so that counts as "available input." */
3824 if (!NILP (Vquit_flag
))
3825 quit_throw_to_read_char ();
3827 /* One way or another, wait until input is available; then, if
3828 interrupt handlers have not read it, read it now. */
3831 wait_for_kbd_input ();
3833 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3837 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3840 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3844 Lisp_Object minus_one
;
3846 XSETINT (minus_one
, -1);
3847 wait_reading_process_input (0, 0, minus_one
, 1);
3849 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3850 /* Pass 1 for EXPECT since we just waited to have input. */
3851 read_avail_input (1);
3853 #endif /* not VMS */
3856 if (CONSP (Vunread_command_events
))
3859 first
= XCAR (Vunread_command_events
);
3860 Vunread_command_events
= XCDR (Vunread_command_events
);
3861 *kbp
= current_kboard
;
3865 /* At this point, we know that there is a readable event available
3866 somewhere. If the event queue is empty, then there must be a
3867 mouse movement enabled and available. */
3868 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3870 struct input_event
*event
;
3872 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3876 last_event_timestamp
= event
->timestamp
;
3879 *kbp
= event_to_kboard (event
);
3881 *kbp
= current_kboard
; /* Better than returning null ptr? */
3883 *kbp
= &the_only_kboard
;
3888 /* These two kinds of events get special handling
3889 and don't actually appear to the command loop.
3890 We return nil for them. */
3891 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3894 struct input_event copy
;
3896 /* Remove it from the buffer before processing it,
3897 since otherwise swallow_events will see it
3898 and process it again. */
3900 kbd_fetch_ptr
= event
+ 1;
3901 input_pending
= readable_events (0);
3902 x_handle_selection_request (©
);
3904 /* We're getting selection request events, but we don't have
3910 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3913 struct input_event copy
;
3915 /* Remove it from the buffer before processing it. */
3917 kbd_fetch_ptr
= event
+ 1;
3918 input_pending
= readable_events (0);
3919 x_handle_selection_clear (©
);
3921 /* We're getting selection request events, but we don't have
3926 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3927 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3929 /* Make an event (delete-frame (FRAME)). */
3930 obj
= Fcons (event
->frame_or_window
, Qnil
);
3931 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3932 kbd_fetch_ptr
= event
+ 1;
3935 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3936 else if (event
->kind
== ICONIFY_EVENT
)
3938 /* Make an event (iconify-frame (FRAME)). */
3939 obj
= Fcons (event
->frame_or_window
, Qnil
);
3940 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3941 kbd_fetch_ptr
= event
+ 1;
3943 else if (event
->kind
== DEICONIFY_EVENT
)
3945 /* Make an event (make-frame-visible (FRAME)). */
3946 obj
= Fcons (event
->frame_or_window
, Qnil
);
3947 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3948 kbd_fetch_ptr
= event
+ 1;
3951 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3953 /* The value doesn't matter here; only the type is tested. */
3954 XSETBUFFER (obj
, current_buffer
);
3955 kbd_fetch_ptr
= event
+ 1;
3957 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
3958 || defined (USE_GTK)
3959 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3961 kbd_fetch_ptr
= event
+ 1;
3962 input_pending
= readable_events (0);
3963 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3964 x_activate_menubar (XFRAME (event
->frame_or_window
));
3968 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3970 /* Make an event (language-change (FRAME CHARSET LCID)). */
3971 obj
= Fcons (event
->modifiers
, Qnil
);
3972 obj
= Fcons (event
->code
, obj
);
3973 obj
= Fcons (event
->frame_or_window
, obj
);
3974 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3975 kbd_fetch_ptr
= event
+ 1;
3978 else if (event
->kind
== SAVE_SESSION_EVENT
)
3980 obj
= Fcons (Qsave_session
, Qnil
);
3981 kbd_fetch_ptr
= event
+ 1;
3983 /* Just discard these, by returning nil.
3984 With MULTI_KBOARD, these events are used as placeholders
3985 when we need to randomly delete events from the queue.
3986 (They shouldn't otherwise be found in the buffer,
3987 but on some machines it appears they do show up
3988 even without MULTI_KBOARD.) */
3989 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3990 mouse events during a popup-menu call. */
3991 else if (event
->kind
== NO_EVENT
)
3992 kbd_fetch_ptr
= event
+ 1;
3993 else if (event
->kind
== HELP_EVENT
)
3995 Lisp_Object object
, position
, help
, frame
, window
;
3997 frame
= event
->frame_or_window
;
3998 object
= event
->arg
;
3999 position
= make_number (event
->code
);
4002 clear_event (event
);
4004 kbd_fetch_ptr
= event
+ 1;
4005 if (!WINDOWP (window
))
4007 obj
= Fcons (Qhelp_echo
,
4008 list5 (frame
, help
, window
, object
, position
));
4010 else if (event
->kind
== FOCUS_IN_EVENT
)
4012 /* Notification of a FocusIn event. The frame receiving the
4013 focus is in event->frame_or_window. Generate a
4014 switch-frame event if necessary. */
4015 Lisp_Object frame
, focus
;
4017 frame
= event
->frame_or_window
;
4018 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4022 if (!EQ (frame
, internal_last_event_frame
)
4023 && !EQ (frame
, selected_frame
))
4024 obj
= make_lispy_switch_frame (frame
);
4025 internal_last_event_frame
= frame
;
4026 kbd_fetch_ptr
= event
+ 1;
4030 /* If this event is on a different frame, return a switch-frame this
4031 time, and leave the event in the queue for next time. */
4035 frame
= event
->frame_or_window
;
4037 frame
= XCAR (frame
);
4038 else if (WINDOWP (frame
))
4039 frame
= WINDOW_FRAME (XWINDOW (frame
));
4041 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4045 if (! EQ (frame
, internal_last_event_frame
)
4046 && !EQ (frame
, selected_frame
))
4047 obj
= make_lispy_switch_frame (frame
);
4048 internal_last_event_frame
= frame
;
4050 /* If we didn't decide to make a switch-frame event, go ahead
4051 and build a real event from the queue entry. */
4055 obj
= make_lispy_event (event
);
4057 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4058 || defined (USE_GTK)
4059 /* If this was a menu selection, then set the flag to inhibit
4060 writing to last_nonmenu_event. Don't do this if the event
4061 we're returning is (menu-bar), though; that indicates the
4062 beginning of the menu sequence, and we might as well leave
4063 that as the `event with parameters' for this selection. */
4065 && !EQ (event
->frame_or_window
, event
->arg
)
4066 && (event
->kind
== MENU_BAR_EVENT
4067 || event
->kind
== TOOL_BAR_EVENT
))
4068 *used_mouse_menu
= 1;
4071 /* Wipe out this event, to catch bugs. */
4072 clear_event (event
);
4073 kbd_fetch_ptr
= event
+ 1;
4078 /* Try generating a mouse motion event. */
4079 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4081 FRAME_PTR f
= some_mouse_moved ();
4082 Lisp_Object bar_window
;
4083 enum scroll_bar_part part
;
4087 *kbp
= current_kboard
;
4088 /* Note that this uses F to determine which display to look at.
4089 If there is no valid info, it does not store anything
4090 so x remains nil. */
4092 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4096 /* Decide if we should generate a switch-frame event. Don't
4097 generate switch-frame events for motion outside of all Emacs
4103 frame
= FRAME_FOCUS_FRAME (f
);
4105 XSETFRAME (frame
, f
);
4107 if (! EQ (frame
, internal_last_event_frame
)
4108 && !EQ (frame
, selected_frame
))
4109 obj
= make_lispy_switch_frame (frame
);
4110 internal_last_event_frame
= frame
;
4113 /* If we didn't decide to make a switch-frame event, go ahead and
4114 return a mouse-motion event. */
4115 if (!NILP (x
) && NILP (obj
))
4116 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4118 #endif /* HAVE_MOUSE */
4120 /* We were promised by the above while loop that there was
4121 something for us to read! */
4124 input_pending
= readable_events (0);
4126 Vlast_event_frame
= internal_last_event_frame
;
4131 /* Process any events that are not user-visible,
4132 then return, without reading any user-visible events. */
4135 swallow_events (do_display
)
4140 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4142 struct input_event
*event
;
4144 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4148 last_event_timestamp
= event
->timestamp
;
4150 /* These two kinds of events get special handling
4151 and don't actually appear to the command loop. */
4152 if (event
->kind
== SELECTION_REQUEST_EVENT
)
4155 struct input_event copy
;
4157 /* Remove it from the buffer before processing it,
4158 since otherwise swallow_events called recursively could see it
4159 and process it again. */
4161 kbd_fetch_ptr
= event
+ 1;
4162 input_pending
= readable_events (0);
4163 x_handle_selection_request (©
);
4165 /* We're getting selection request events, but we don't have
4171 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
4174 struct input_event copy
;
4176 /* Remove it from the buffer before processing it, */
4179 kbd_fetch_ptr
= event
+ 1;
4180 input_pending
= readable_events (0);
4181 x_handle_selection_clear (©
);
4183 /* We're getting selection request events, but we don't have
4192 old_timers_run
= timers_run
;
4193 get_input_pending (&input_pending
, 1);
4195 if (timers_run
!= old_timers_run
&& do_display
)
4196 redisplay_preserve_echo_area (7);
4199 /* Record the start of when Emacs is idle,
4200 for the sake of running idle-time timers. */
4207 /* If we are already in the idle state, do nothing. */
4208 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4211 EMACS_GET_TIME (timer_idleness_start_time
);
4213 timer_last_idleness_start_time
= timer_idleness_start_time
;
4215 /* Mark all idle-time timers as once again candidates for running. */
4216 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4220 timer
= XCAR (timers
);
4222 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4224 XVECTOR (timer
)->contents
[0] = Qnil
;
4228 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4233 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4236 /* This is only for debugging. */
4237 struct input_event last_timer_event
;
4239 /* Check whether a timer has fired. To prevent larger problems we simply
4240 disregard elements that are not proper timers. Do not make a circular
4241 timer list for the time being.
4243 Returns the number of seconds to wait until the next timer fires. If a
4244 timer is triggering now, return zero seconds.
4245 If no timer is active, return -1 seconds.
4247 If a timer is ripe, we run it, with quitting turned off.
4249 DO_IT_NOW is now ignored. It used to mean that we should
4250 run the timer directly instead of queueing a timer-event.
4251 Now we always run timers directly. */
4254 timer_check (do_it_now
)
4257 EMACS_TIME nexttime
;
4258 EMACS_TIME now
, idleness_now
;
4259 Lisp_Object timers
, idle_timers
, chosen_timer
;
4260 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4262 EMACS_SET_SECS (nexttime
, -1);
4263 EMACS_SET_USECS (nexttime
, -1);
4265 /* Always consider the ordinary timers. */
4266 timers
= Vtimer_list
;
4267 /* Consider the idle timers only if Emacs is idle. */
4268 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4269 idle_timers
= Vtimer_idle_list
;
4272 chosen_timer
= Qnil
;
4273 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4275 if (CONSP (timers
) || CONSP (idle_timers
))
4277 EMACS_GET_TIME (now
);
4278 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4279 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4282 while (CONSP (timers
) || CONSP (idle_timers
))
4284 Lisp_Object
*vector
;
4285 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4286 EMACS_TIME timer_time
, idle_timer_time
;
4287 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4289 /* Skip past invalid timers and timers already handled. */
4292 timer
= XCAR (timers
);
4293 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4295 timers
= XCDR (timers
);
4298 vector
= XVECTOR (timer
)->contents
;
4300 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4301 || !INTEGERP (vector
[3])
4302 || ! NILP (vector
[0]))
4304 timers
= XCDR (timers
);
4308 if (!NILP (idle_timers
))
4310 timer
= XCAR (idle_timers
);
4311 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4313 idle_timers
= XCDR (idle_timers
);
4316 vector
= XVECTOR (timer
)->contents
;
4318 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4319 || !INTEGERP (vector
[3])
4320 || ! NILP (vector
[0]))
4322 idle_timers
= XCDR (idle_timers
);
4327 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4328 based on the next ordinary timer.
4329 TIMER_DIFFERENCE is the distance in time from NOW to when
4330 this timer becomes ripe (negative if it's already ripe). */
4333 timer
= XCAR (timers
);
4334 vector
= XVECTOR (timer
)->contents
;
4335 EMACS_SET_SECS (timer_time
,
4336 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4337 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4338 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4341 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4342 based on the next idle timer. */
4343 if (!NILP (idle_timers
))
4345 idle_timer
= XCAR (idle_timers
);
4346 vector
= XVECTOR (idle_timer
)->contents
;
4347 EMACS_SET_SECS (idle_timer_time
,
4348 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4349 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4350 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4353 /* Decide which timer is the next timer,
4354 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4355 Also step down the list where we found that timer. */
4357 if (! NILP (timers
) && ! NILP (idle_timers
))
4360 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4361 if (EMACS_TIME_NEG_P (temp
))
4363 chosen_timer
= timer
;
4364 timers
= XCDR (timers
);
4365 difference
= timer_difference
;
4369 chosen_timer
= idle_timer
;
4370 idle_timers
= XCDR (idle_timers
);
4371 difference
= idle_timer_difference
;
4374 else if (! NILP (timers
))
4376 chosen_timer
= timer
;
4377 timers
= XCDR (timers
);
4378 difference
= timer_difference
;
4382 chosen_timer
= idle_timer
;
4383 idle_timers
= XCDR (idle_timers
);
4384 difference
= idle_timer_difference
;
4386 vector
= XVECTOR (chosen_timer
)->contents
;
4388 /* If timer is ripe, run it if it hasn't been run. */
4389 if (EMACS_TIME_NEG_P (difference
)
4390 || (EMACS_SECS (difference
) == 0
4391 && EMACS_USECS (difference
) == 0))
4393 if (NILP (vector
[0]))
4395 int was_locked
= single_kboard
;
4396 int count
= SPECPDL_INDEX ();
4397 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4399 /* Mark the timer as triggered to prevent problems if the lisp
4400 code fails to reschedule it right. */
4403 specbind (Qinhibit_quit
, Qt
);
4405 call1 (Qtimer_event_handler
, chosen_timer
);
4406 Vdeactivate_mark
= old_deactivate_mark
;
4408 unbind_to (count
, Qnil
);
4410 /* Resume allowing input from any kboard, if that was true before. */
4412 any_kboard_state ();
4414 /* Since we have handled the event,
4415 we don't need to tell the caller to wake up and do it. */
4419 /* When we encounter a timer that is still waiting,
4420 return the amount of time to wait before it is ripe. */
4427 /* No timers are pending in the future. */
4428 /* Return 0 if we generated an event, and -1 if not. */
4433 /* Caches for modify_event_symbol. */
4434 static Lisp_Object accent_key_syms
;
4435 static Lisp_Object func_key_syms
;
4436 static Lisp_Object mouse_syms
;
4437 static Lisp_Object wheel_syms
;
4438 static Lisp_Object drag_n_drop_syms
;
4440 /* This is a list of keysym codes for special "accent" characters.
4441 It parallels lispy_accent_keys. */
4443 static int lispy_accent_codes
[] =
4445 #ifdef XK_dead_circumflex
4450 #ifdef XK_dead_grave
4455 #ifdef XK_dead_tilde
4460 #ifdef XK_dead_diaeresis
4465 #ifdef XK_dead_macron
4470 #ifdef XK_dead_degree
4475 #ifdef XK_dead_acute
4480 #ifdef XK_dead_cedilla
4485 #ifdef XK_dead_breve
4490 #ifdef XK_dead_ogonek
4495 #ifdef XK_dead_caron
4500 #ifdef XK_dead_doubleacute
4501 XK_dead_doubleacute
,
4505 #ifdef XK_dead_abovedot
4510 #ifdef XK_dead_abovering
4520 #ifdef XK_dead_belowdot
4525 #ifdef XK_dead_voiced_sound
4526 XK_dead_voiced_sound
,
4530 #ifdef XK_dead_semivoiced_sound
4531 XK_dead_semivoiced_sound
,
4547 /* This is a list of Lisp names for special "accent" characters.
4548 It parallels lispy_accent_codes. */
4550 static char *lispy_accent_keys
[] =
4568 "dead-voiced-sound",
4569 "dead-semivoiced-sound",
4575 #define FUNCTION_KEY_OFFSET 0x0
4577 char *lispy_function_keys
[] =
4581 0, /* VK_LBUTTON 0x01 */
4582 0, /* VK_RBUTTON 0x02 */
4583 "cancel", /* VK_CANCEL 0x03 */
4584 0, /* VK_MBUTTON 0x04 */
4586 0, 0, 0, /* 0x05 .. 0x07 */
4588 "backspace", /* VK_BACK 0x08 */
4589 "tab", /* VK_TAB 0x09 */
4591 0, 0, /* 0x0A .. 0x0B */
4593 "clear", /* VK_CLEAR 0x0C */
4594 "return", /* VK_RETURN 0x0D */
4596 0, 0, /* 0x0E .. 0x0F */
4598 0, /* VK_SHIFT 0x10 */
4599 0, /* VK_CONTROL 0x11 */
4600 0, /* VK_MENU 0x12 */
4601 "pause", /* VK_PAUSE 0x13 */
4602 "capslock", /* VK_CAPITAL 0x14 */
4604 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4606 "escape", /* VK_ESCAPE 0x1B */
4608 0, 0, 0, 0, /* 0x1C .. 0x1F */
4610 0, /* VK_SPACE 0x20 */
4611 "prior", /* VK_PRIOR 0x21 */
4612 "next", /* VK_NEXT 0x22 */
4613 "end", /* VK_END 0x23 */
4614 "home", /* VK_HOME 0x24 */
4615 "left", /* VK_LEFT 0x25 */
4616 "up", /* VK_UP 0x26 */
4617 "right", /* VK_RIGHT 0x27 */
4618 "down", /* VK_DOWN 0x28 */
4619 "select", /* VK_SELECT 0x29 */
4620 "print", /* VK_PRINT 0x2A */
4621 "execute", /* VK_EXECUTE 0x2B */
4622 "snapshot", /* VK_SNAPSHOT 0x2C */
4623 "insert", /* VK_INSERT 0x2D */
4624 "delete", /* VK_DELETE 0x2E */
4625 "help", /* VK_HELP 0x2F */
4627 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4629 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4631 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4633 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4635 0, 0, 0, 0, 0, 0, 0, 0, 0,
4636 0, 0, 0, 0, 0, 0, 0, 0, 0,
4637 0, 0, 0, 0, 0, 0, 0, 0,
4639 "lwindow", /* VK_LWIN 0x5B */
4640 "rwindow", /* VK_RWIN 0x5C */
4641 "apps", /* VK_APPS 0x5D */
4643 0, 0, /* 0x5E .. 0x5F */
4645 "kp-0", /* VK_NUMPAD0 0x60 */
4646 "kp-1", /* VK_NUMPAD1 0x61 */
4647 "kp-2", /* VK_NUMPAD2 0x62 */
4648 "kp-3", /* VK_NUMPAD3 0x63 */
4649 "kp-4", /* VK_NUMPAD4 0x64 */
4650 "kp-5", /* VK_NUMPAD5 0x65 */
4651 "kp-6", /* VK_NUMPAD6 0x66 */
4652 "kp-7", /* VK_NUMPAD7 0x67 */
4653 "kp-8", /* VK_NUMPAD8 0x68 */
4654 "kp-9", /* VK_NUMPAD9 0x69 */
4655 "kp-multiply", /* VK_MULTIPLY 0x6A */
4656 "kp-add", /* VK_ADD 0x6B */
4657 "kp-separator", /* VK_SEPARATOR 0x6C */
4658 "kp-subtract", /* VK_SUBTRACT 0x6D */
4659 "kp-decimal", /* VK_DECIMAL 0x6E */
4660 "kp-divide", /* VK_DIVIDE 0x6F */
4661 "f1", /* VK_F1 0x70 */
4662 "f2", /* VK_F2 0x71 */
4663 "f3", /* VK_F3 0x72 */
4664 "f4", /* VK_F4 0x73 */
4665 "f5", /* VK_F5 0x74 */
4666 "f6", /* VK_F6 0x75 */
4667 "f7", /* VK_F7 0x76 */
4668 "f8", /* VK_F8 0x77 */
4669 "f9", /* VK_F9 0x78 */
4670 "f10", /* VK_F10 0x79 */
4671 "f11", /* VK_F11 0x7A */
4672 "f12", /* VK_F12 0x7B */
4673 "f13", /* VK_F13 0x7C */
4674 "f14", /* VK_F14 0x7D */
4675 "f15", /* VK_F15 0x7E */
4676 "f16", /* VK_F16 0x7F */
4677 "f17", /* VK_F17 0x80 */
4678 "f18", /* VK_F18 0x81 */
4679 "f19", /* VK_F19 0x82 */
4680 "f20", /* VK_F20 0x83 */
4681 "f21", /* VK_F21 0x84 */
4682 "f22", /* VK_F22 0x85 */
4683 "f23", /* VK_F23 0x86 */
4684 "f24", /* VK_F24 0x87 */
4686 0, 0, 0, 0, /* 0x88 .. 0x8B */
4687 0, 0, 0, 0, /* 0x8C .. 0x8F */
4689 "kp-numlock", /* VK_NUMLOCK 0x90 */
4690 "scroll", /* VK_SCROLL 0x91 */
4692 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4693 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4694 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4695 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4696 "kp-end", /* VK_NUMPAD_END 0x96 */
4697 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4698 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4699 "kp-up", /* VK_NUMPAD_UP 0x99 */
4700 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4701 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4702 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4703 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4705 0, 0, /* 0x9E .. 0x9F */
4708 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4709 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4710 * No other API or message will distinguish left and right keys this way.
4714 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4715 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4716 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4717 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4718 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4724 "attn", /* VK_ATTN 0xF6 */
4725 "crsel", /* VK_CRSEL 0xF7 */
4726 "exsel", /* VK_EXSEL 0xF8 */
4727 "ereof", /* VK_EREOF 0xF9 */
4728 "play", /* VK_PLAY 0xFA */
4729 "zoom", /* VK_ZOOM 0xFB */
4730 "noname", /* VK_NONAME 0xFC */
4731 "pa1", /* VK_PA1 0xFD */
4732 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4736 #else /* not HAVE_NTGUI */
4738 /* This should be dealt with in XTread_socket now, and that doesn't
4739 depend on the client system having the Kana syms defined. See also
4740 the XK_kana_A case below. */
4743 static char *lispy_kana_keys
[] =
4745 /* X Keysym value */
4746 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4747 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4748 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4749 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4750 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4751 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4752 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4753 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4754 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4755 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4756 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4757 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4758 "kana-i", "kana-u", "kana-e", "kana-o",
4759 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4760 "prolongedsound", "kana-A", "kana-I", "kana-U",
4761 "kana-E", "kana-O", "kana-KA", "kana-KI",
4762 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4763 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4764 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4765 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4766 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4767 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4768 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4769 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4770 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4771 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4772 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4773 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4775 #endif /* XK_kana_A */
4778 #define FUNCTION_KEY_OFFSET 0xff00
4780 /* You'll notice that this table is arranged to be conveniently
4781 indexed by X Windows keysym values. */
4782 static char *lispy_function_keys
[] =
4784 /* X Keysym value */
4786 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4787 "backspace", "tab", "linefeed", "clear",
4789 0, 0, 0, "pause", /* 0xff10...1f */
4790 0, 0, 0, 0, 0, 0, 0, "escape",
4792 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4793 "romaji", "hiragana", "katakana", "hiragana-katakana",
4794 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4795 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4796 "eisu-toggle", /* 0xff30...3f */
4797 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4798 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4800 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4801 "down", "prior", "next", "end",
4802 "begin", 0, 0, 0, 0, 0, 0, 0,
4803 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4814 "break", /* 0xff6b */
4817 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4818 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4819 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4820 0, 0, 0, 0, 0, 0, 0, 0,
4821 "kp-tab", /* 0xff89 */
4823 "kp-enter", /* 0xff8d */
4825 "kp-f1", /* 0xff91 */
4829 "kp-home", /* 0xff95 */
4834 "kp-prior", /* kp-page-up */
4835 "kp-next", /* kp-page-down */
4841 0, 0, 0, 0, 0, 0, 0, 0, 0,
4842 "kp-multiply", /* 0xffaa */
4847 "kp-divide", /* 0xffaf */
4848 "kp-0", /* 0xffb0 */
4849 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4852 "kp-equal", /* 0xffbd */
4853 "f1", /* 0xffbe */ /* IsFunctionKey */
4855 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4856 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4857 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4858 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4859 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4860 0, 0, 0, 0, 0, 0, 0, 0,
4861 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4862 0, 0, 0, 0, 0, 0, 0, "delete"
4865 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4866 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4868 static char *iso_lispy_function_keys
[] =
4870 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4871 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4872 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4873 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4874 "iso-lefttab", /* 0xfe20 */
4875 "iso-move-line-up", "iso-move-line-down",
4876 "iso-partial-line-up", "iso-partial-line-down",
4877 "iso-partial-space-left", "iso-partial-space-right",
4878 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4879 "iso-release-margin-left", "iso-release-margin-right",
4880 "iso-release-both-margins",
4881 "iso-fast-cursor-left", "iso-fast-cursor-right",
4882 "iso-fast-cursor-up", "iso-fast-cursor-down",
4883 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4884 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4887 #endif /* not HAVE_NTGUI */
4889 Lisp_Object Vlispy_mouse_stem
;
4891 static char *lispy_wheel_names
[] =
4893 "wheel-up", "wheel-down"
4896 /* drag-n-drop events are generated when a set of selected files are
4897 dragged from another application and dropped onto an Emacs window. */
4898 static char *lispy_drag_n_drop_names
[] =
4903 /* Scroll bar parts. */
4904 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4905 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4906 Lisp_Object Qtop
, Qratio
;
4908 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4909 Lisp_Object
*scroll_bar_parts
[] = {
4910 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4911 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4914 /* User signal events. */
4915 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4917 Lisp_Object
*lispy_user_signals
[] =
4919 &Qusr1_signal
, &Qusr2_signal
4923 /* A vector, indexed by button number, giving the down-going location
4924 of currently depressed buttons, both scroll bar and non-scroll bar.
4926 The elements have the form
4927 (BUTTON-NUMBER MODIFIER-MASK . REST)
4928 where REST is the cdr of a position as it would be reported in the event.
4930 The make_lispy_event function stores positions here to tell the
4931 difference between click and drag events, and to store the starting
4932 location to be included in drag events. */
4934 static Lisp_Object button_down_location
;
4936 /* Information about the most recent up-going button event: Which
4937 button, what location, and what time. */
4939 static int last_mouse_button
;
4940 static int last_mouse_x
;
4941 static int last_mouse_y
;
4942 static unsigned long button_down_time
;
4944 /* The maximum time between clicks to make a double-click, or Qnil to
4945 disable double-click detection, or Qt for no time limit. */
4947 Lisp_Object Vdouble_click_time
;
4949 /* Maximum number of pixels the mouse may be moved between clicks
4950 to make a double-click. */
4952 EMACS_INT double_click_fuzz
;
4954 /* The number of clicks in this multiple-click. */
4956 int double_click_count
;
4958 /* Given a struct input_event, build the lisp event which represents
4959 it. If EVENT is 0, build a mouse movement event from the mouse
4960 movement buffer, which should have a movement event in it.
4962 Note that events must be passed to this function in the order they
4963 are received; this function stores the location of button presses
4964 in order to build drag events when the button is released. */
4967 make_lispy_event (event
)
4968 struct input_event
*event
;
4972 switch (SWITCH_ENUM_CAST (event
->kind
))
4974 /* A simple keystroke. */
4975 case ASCII_KEYSTROKE_EVENT
:
4977 Lisp_Object lispy_c
;
4978 int c
= event
->code
& 0377;
4979 /* Turn ASCII characters into control characters
4981 if (event
->modifiers
& ctrl_modifier
)
4982 c
= make_ctrl_char (c
);
4984 /* Add in the other modifier bits. We took care of ctrl_modifier
4985 just above, and the shift key was taken care of by the X code,
4986 and applied to control characters by make_ctrl_char. */
4987 c
|= (event
->modifiers
4988 & (meta_modifier
| alt_modifier
4989 | hyper_modifier
| super_modifier
));
4990 /* Distinguish Shift-SPC from SPC. */
4991 if ((event
->code
& 0377) == 040
4992 && event
->modifiers
& shift_modifier
)
4993 c
|= shift_modifier
;
4994 button_down_time
= 0;
4995 XSETFASTINT (lispy_c
, c
);
4999 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5001 Lisp_Object lispy_c
;
5002 int c
= event
->code
;
5004 /* Add in the other modifier bits. We took care of ctrl_modifier
5005 just above, and the shift key was taken care of by the X code,
5006 and applied to control characters by make_ctrl_char. */
5007 c
|= (event
->modifiers
5008 & (meta_modifier
| alt_modifier
5009 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5010 /* What about the `shift' modifier ? */
5011 button_down_time
= 0;
5012 XSETFASTINT (lispy_c
, c
);
5016 /* A function key. The symbol may need to have modifier prefixes
5018 case NON_ASCII_KEYSTROKE_EVENT
:
5019 button_down_time
= 0;
5021 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5022 if (event
->code
== lispy_accent_codes
[i
])
5023 return modify_event_symbol (i
,
5025 Qfunction_key
, Qnil
,
5026 lispy_accent_keys
, &accent_key_syms
,
5027 (sizeof (lispy_accent_keys
)
5028 / sizeof (lispy_accent_keys
[0])));
5032 if (event
->code
>= 0x400 && event
->code
< 0x500)
5033 return modify_event_symbol (event
->code
- 0x400,
5034 event
->modifiers
& ~shift_modifier
,
5035 Qfunction_key
, Qnil
,
5036 lispy_kana_keys
, &func_key_syms
,
5037 (sizeof (lispy_kana_keys
)
5038 / sizeof (lispy_kana_keys
[0])));
5039 #endif /* XK_kana_A */
5042 #ifdef ISO_FUNCTION_KEY_OFFSET
5043 if (event
->code
< FUNCTION_KEY_OFFSET
5044 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5045 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5047 Qfunction_key
, Qnil
,
5048 iso_lispy_function_keys
, &func_key_syms
,
5049 (sizeof (iso_lispy_function_keys
)
5050 / sizeof (iso_lispy_function_keys
[0])));
5053 /* Handle system-specific or unknown keysyms. */
5054 if (event
->code
& (1 << 28)
5055 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5056 || (event
->code
- FUNCTION_KEY_OFFSET
5057 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5058 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5060 /* We need to use an alist rather than a vector as the cache
5061 since we can't make a vector long enuf. */
5062 if (NILP (current_kboard
->system_key_syms
))
5063 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5064 return modify_event_symbol (event
->code
,
5067 current_kboard
->Vsystem_key_alist
,
5068 0, ¤t_kboard
->system_key_syms
,
5072 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5074 Qfunction_key
, Qnil
,
5075 lispy_function_keys
, &func_key_syms
,
5076 (sizeof (lispy_function_keys
)
5077 / sizeof (lispy_function_keys
[0])));
5080 /* A mouse click. Figure out where it is, decide whether it's
5081 a press, click or drag, and build the appropriate structure. */
5082 case MOUSE_CLICK_EVENT
:
5083 #ifndef USE_TOOLKIT_SCROLL_BARS
5084 case SCROLL_BAR_CLICK_EVENT
:
5087 int button
= event
->code
;
5089 Lisp_Object position
;
5090 Lisp_Object
*start_pos_ptr
;
5091 Lisp_Object start_pos
;
5096 /* Build the position as appropriate for this mouse click. */
5097 if (event
->kind
== MOUSE_CLICK_EVENT
)
5099 enum window_part part
;
5100 struct frame
*f
= XFRAME (event
->frame_or_window
);
5102 Lisp_Object string_info
= Qnil
;
5106 /* Ignore mouse events that were made on frame that
5107 have been deleted. */
5108 if (! FRAME_LIVE_P (f
))
5111 /* EVENT->x and EVENT->y are frame-relative pixel
5112 coordinates at this place. Under old redisplay, COLUMN
5113 and ROW are set to frame relative glyph coordinates
5114 which are then used to determine whether this click is
5115 in a menu (non-toolkit version). */
5116 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5117 &column
, &row
, NULL
, 1);
5119 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5120 /* In the non-toolkit version, clicks on the menu bar
5121 are ordinary button events in the event buffer.
5122 Distinguish them, and invoke the menu.
5124 (In the toolkit version, the toolkit handles the menu bar
5125 and Emacs doesn't know about it until after the user
5126 makes a selection.) */
5127 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5128 && (event
->modifiers
& down_modifier
))
5130 Lisp_Object items
, item
;
5135 /* Activate the menu bar on the down event. If the
5136 up event comes in before the menu code can deal with it,
5138 if (! (event
->modifiers
& down_modifier
))
5142 /* Find the menu bar item under `column'. */
5144 items
= FRAME_MENU_BAR_ITEMS (f
);
5145 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5147 Lisp_Object pos
, string
;
5148 string
= AREF (items
, i
+ 1);
5149 pos
= AREF (items
, i
+ 3);
5152 if (column
>= XINT (pos
)
5153 && column
< XINT (pos
) + SCHARS (string
))
5155 item
= AREF (items
, i
);
5160 /* ELisp manual 2.4b says (x y) are window relative but
5161 code says they are frame-relative. */
5163 = Fcons (event
->frame_or_window
,
5165 Fcons (Fcons (event
->x
, event
->y
),
5166 Fcons (make_number (event
->timestamp
),
5169 return Fcons (item
, Fcons (position
, Qnil
));
5171 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5173 /* Set `window' to the window under frame pixel coordinates
5174 event->x/event->y. */
5175 window
= window_from_coordinates (f
, XINT (event
->x
),
5177 &part
, &wx
, &wy
, 0);
5179 if (!WINDOWP (window
))
5181 window
= event
->frame_or_window
;
5186 /* It's a click in window window at frame coordinates
5187 event->x/ event->y. */
5188 struct window
*w
= XWINDOW (window
);
5190 /* Set event coordinates to window-relative coordinates
5191 for constructing the Lisp event below. */
5192 XSETINT (event
->x
, wx
);
5193 XSETINT (event
->y
, wy
);
5195 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5197 /* Mode line or header line. Look for a string under
5198 the mouse that may have a `local-map' property. */
5202 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5203 string
= mode_line_string (w
, wx
, wy
, part
, &charpos
);
5204 if (STRINGP (string
))
5205 string_info
= Fcons (string
, make_number (charpos
));
5207 else if (part
== ON_VERTICAL_BORDER
)
5208 posn
= Qvertical_line
;
5209 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5212 Lisp_Object object
= marginal_area_string (w
, wx
, wy
, part
,
5214 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5215 if (STRINGP (object
))
5216 string_info
= Fcons (object
, make_number (charpos
));
5221 struct display_pos p
;
5222 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5223 posn
= make_number (CHARPOS (p
.pos
));
5224 if (STRINGP (object
))
5227 make_number (CHARPOS (p
.string_pos
)));
5234 Fcons (Fcons (event
->x
, event
->y
),
5235 Fcons (make_number (event
->timestamp
),
5238 : Fcons (string_info
, Qnil
))))));
5240 #ifndef USE_TOOLKIT_SCROLL_BARS
5243 /* It's a scrollbar click. */
5244 Lisp_Object portion_whole
;
5247 window
= event
->frame_or_window
;
5248 portion_whole
= Fcons (event
->x
, event
->y
);
5249 part
= *scroll_bar_parts
[(int) event
->part
];
5253 Fcons (Qvertical_scroll_bar
,
5254 Fcons (portion_whole
,
5255 Fcons (make_number (event
->timestamp
),
5256 Fcons (part
, Qnil
)))));
5258 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5260 if (button
>= ASIZE (button_down_location
))
5262 button_down_location
= larger_vector (button_down_location
,
5264 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5267 start_pos_ptr
= &AREF (button_down_location
, button
);
5268 start_pos
= *start_pos_ptr
;
5269 *start_pos_ptr
= Qnil
;
5272 /* On window-system frames, use the value of
5273 double-click-fuzz as is. On other frames, interpret it
5274 as a multiple of 1/8 characters. */
5278 if (WINDOWP (event
->frame_or_window
))
5279 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5280 else if (FRAMEP (event
->frame_or_window
))
5281 f
= XFRAME (event
->frame_or_window
);
5285 if (FRAME_WINDOW_P (f
))
5286 fuzz
= double_click_fuzz
;
5288 fuzz
= double_click_fuzz
/ 8;
5290 is_double
= (button
== last_mouse_button
5291 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5292 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5293 && button_down_time
!= 0
5294 && (EQ (Vdouble_click_time
, Qt
)
5295 || (INTEGERP (Vdouble_click_time
)
5296 && ((int)(event
->timestamp
- button_down_time
)
5297 < XINT (Vdouble_click_time
)))));
5300 last_mouse_button
= button
;
5301 last_mouse_x
= XINT (event
->x
);
5302 last_mouse_y
= XINT (event
->y
);
5304 /* If this is a button press, squirrel away the location, so
5305 we can decide later whether it was a click or a drag. */
5306 if (event
->modifiers
& down_modifier
)
5310 double_click_count
++;
5311 event
->modifiers
|= ((double_click_count
> 2)
5316 double_click_count
= 1;
5317 button_down_time
= event
->timestamp
;
5318 *start_pos_ptr
= Fcopy_alist (position
);
5321 /* Now we're releasing a button - check the co-ordinates to
5322 see if this was a click or a drag. */
5323 else if (event
->modifiers
& up_modifier
)
5325 /* If we did not see a down before this up, ignore the up.
5326 Probably this happened because the down event chose a
5327 menu item. It would be an annoyance to treat the
5328 release of the button that chose the menu item as a
5331 if (!CONSP (start_pos
))
5334 event
->modifiers
&= ~up_modifier
;
5335 #if 0 /* Formerly we treated an up with no down as a click event. */
5336 if (!CONSP (start_pos
))
5337 event
->modifiers
|= click_modifier
;
5342 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5344 /* The third element of every position
5345 should be the (x,y) pair. */
5346 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5348 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5350 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5351 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5354 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5355 && ydiff
< double_click_fuzz
5356 && ydiff
> - double_click_fuzz
)
5357 /* Mouse hasn't moved (much). */
5358 event
->modifiers
|= click_modifier
;
5361 button_down_time
= 0;
5362 event
->modifiers
|= drag_modifier
;
5365 /* Don't check is_double; treat this as multiple
5366 if the down-event was multiple. */
5367 if (double_click_count
> 1)
5368 event
->modifiers
|= ((double_click_count
> 2)
5374 /* Every mouse event should either have the down_modifier or
5375 the up_modifier set. */
5379 /* Get the symbol we should use for the mouse click. */
5382 head
= modify_event_symbol (button
,
5384 Qmouse_click
, Vlispy_mouse_stem
,
5387 XVECTOR (mouse_syms
)->size
);
5388 if (event
->modifiers
& drag_modifier
)
5393 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5396 Fcons (make_number (double_click_count
),
5407 Lisp_Object position
;
5411 /* Build the position as appropriate for this mouse click. */
5412 enum window_part part
;
5413 struct frame
*f
= XFRAME (event
->frame_or_window
);
5415 Lisp_Object string_info
= Qnil
;
5420 /* Ignore wheel events that were made on frame that have been
5422 if (! FRAME_LIVE_P (f
))
5425 /* EVENT->x and EVENT->y are frame-relative pixel
5426 coordinates at this place. Under old redisplay, COLUMN
5427 and ROW are set to frame relative glyph coordinates
5428 which are then used to determine whether this click is
5429 in a menu (non-toolkit version). */
5430 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5431 &column
, &row
, NULL
, 1);
5433 /* Set `window' to the window under frame pixel coordinates
5434 event->x/event->y. */
5435 window
= window_from_coordinates (f
, XINT (event
->x
),
5437 &part
, &wx
, &wy
, 0);
5439 if (!WINDOWP (window
))
5441 window
= event
->frame_or_window
;
5446 /* It's a click in window window at frame coordinates
5447 event->x/ event->y. */
5448 struct window
*w
= XWINDOW (window
);
5450 /* Set event coordinates to window-relative coordinates
5451 for constructing the Lisp event below. */
5452 XSETINT (event
->x
, wx
);
5453 XSETINT (event
->y
, wy
);
5455 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5457 /* Mode line or header line. Look for a string under
5458 the mouse that may have a `local-map' property. */
5462 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5463 string
= mode_line_string (w
, wx
, wy
, part
, &charpos
);
5464 if (STRINGP (string
))
5465 string_info
= Fcons (string
, make_number (charpos
));
5467 else if (part
== ON_VERTICAL_BORDER
)
5468 posn
= Qvertical_line
;
5469 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5472 Lisp_Object object
= marginal_area_string (w
, wx
, wy
, part
,
5474 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5475 if (STRINGP (object
))
5476 string_info
= Fcons (object
, make_number (charpos
));
5481 struct display_pos p
;
5482 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5483 posn
= make_number (CHARPOS (p
.pos
));
5484 if (STRINGP (object
))
5487 make_number (CHARPOS (p
.string_pos
)));
5494 Fcons (Fcons (event
->x
, event
->y
),
5495 Fcons (make_number (event
->timestamp
),
5498 : Fcons (string_info
, Qnil
))))));
5500 /* Set double or triple modifiers to indicate the wheel speed. */
5502 /* On window-system frames, use the value of
5503 double-click-fuzz as is. On other frames, interpret it
5504 as a multiple of 1/8 characters. */
5509 if (WINDOWP (event
->frame_or_window
))
5510 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5511 else if (FRAMEP (event
->frame_or_window
))
5512 f
= XFRAME (event
->frame_or_window
);
5516 if (FRAME_WINDOW_P (f
))
5517 fuzz
= double_click_fuzz
;
5519 fuzz
= double_click_fuzz
/ 8;
5521 is_double
= (last_mouse_button
< 0
5522 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5523 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5524 && button_down_time
!= 0
5525 && (EQ (Vdouble_click_time
, Qt
)
5526 || (INTEGERP (Vdouble_click_time
)
5527 && ((int)(event
->timestamp
- button_down_time
)
5528 < XINT (Vdouble_click_time
)))));
5531 double_click_count
++;
5532 event
->modifiers
|= ((double_click_count
> 2)
5538 double_click_count
= 1;
5539 event
->modifiers
|= click_modifier
;
5542 button_down_time
= event
->timestamp
;
5543 /* Use a negative value to distinguish wheel from mouse button. */
5544 last_mouse_button
= -1;
5545 last_mouse_x
= XINT (event
->x
);
5546 last_mouse_y
= XINT (event
->y
);
5552 if (event
->modifiers
& up_modifier
)
5554 /* Emit a wheel-up event. */
5555 event
->modifiers
&= ~up_modifier
;
5558 else if (event
->modifiers
& down_modifier
)
5560 /* Emit a wheel-down event. */
5561 event
->modifiers
&= ~down_modifier
;
5565 /* Every wheel event should either have the down_modifier or
5566 the up_modifier set. */
5569 /* Get the symbol we should use for the wheel event. */
5570 head
= modify_event_symbol (symbol_num
,
5576 ASIZE (wheel_syms
));
5579 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5582 Fcons (make_number (double_click_count
),
5591 #ifdef USE_TOOLKIT_SCROLL_BARS
5593 /* We don't have down and up events if using toolkit scroll bars,
5594 so make this always a click event. Store in the `part' of
5595 the Lisp event a symbol which maps to the following actions:
5597 `above_handle' page up
5598 `below_handle' page down
5602 `bottom' bottom of buffer
5603 `handle' thumb has been dragged.
5604 `end-scroll' end of interaction with scroll bar
5606 The incoming input_event contains in its `part' member an
5607 index of type `enum scroll_bar_part' which we can use as an
5608 index in scroll_bar_parts to get the appropriate symbol. */
5610 case SCROLL_BAR_CLICK_EVENT
:
5612 Lisp_Object position
, head
, window
, portion_whole
, part
;
5614 window
= event
->frame_or_window
;
5615 portion_whole
= Fcons (event
->x
, event
->y
);
5616 part
= *scroll_bar_parts
[(int) event
->part
];
5620 Fcons (Qvertical_scroll_bar
,
5621 Fcons (portion_whole
,
5622 Fcons (make_number (event
->timestamp
),
5623 Fcons (part
, Qnil
)))));
5625 /* Always treat scroll bar events as clicks. */
5626 event
->modifiers
|= click_modifier
;
5627 event
->modifiers
&= ~up_modifier
;
5629 if (event
->code
>= ASIZE (mouse_syms
))
5630 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5632 /* Get the symbol we should use for the mouse click. */
5633 head
= modify_event_symbol (event
->code
,
5638 XVECTOR (mouse_syms
)->size
);
5639 return Fcons (head
, Fcons (position
, Qnil
));
5642 #endif /* USE_TOOLKIT_SCROLL_BARS */
5645 case W32_SCROLL_BAR_CLICK_EVENT
:
5647 int button
= event
->code
;
5649 Lisp_Object position
;
5650 Lisp_Object
*start_pos_ptr
;
5651 Lisp_Object start_pos
;
5655 Lisp_Object portion_whole
;
5658 window
= event
->frame_or_window
;
5659 portion_whole
= Fcons (event
->x
, event
->y
);
5660 part
= *scroll_bar_parts
[(int) event
->part
];
5664 Fcons (Qvertical_scroll_bar
,
5665 Fcons (portion_whole
,
5666 Fcons (make_number (event
->timestamp
),
5667 Fcons (part
, Qnil
)))));
5670 /* Always treat W32 scroll bar events as clicks. */
5671 event
->modifiers
|= click_modifier
;
5674 /* Get the symbol we should use for the mouse click. */
5677 head
= modify_event_symbol (button
,
5682 XVECTOR (mouse_syms
)->size
);
5688 #endif /* WINDOWSNT */
5690 case DRAG_N_DROP_EVENT
:
5692 enum window_part part
;
5699 /* The frame_or_window field should be a cons of the frame in
5700 which the event occurred and a list of the filenames
5702 if (! CONSP (event
->frame_or_window
))
5705 f
= XFRAME (XCAR (event
->frame_or_window
));
5706 files
= XCDR (event
->frame_or_window
);
5708 /* Ignore mouse events that were made on frames that
5709 have been deleted. */
5710 if (! FRAME_LIVE_P (f
))
5713 window
= window_from_coordinates (f
, XINT (event
->x
),
5715 &part
, &wx
, &wy
, 0);
5717 if (!WINDOWP (window
))
5719 window
= XCAR (event
->frame_or_window
);
5724 /* It's an event in window `window' at frame coordinates
5725 event->x/ event->y. */
5726 struct window
*w
= XWINDOW (window
);
5728 /* Set event coordinates to window-relative coordinates
5729 for constructing the Lisp event below. */
5730 XSETINT (event
->x
, wx
);
5731 XSETINT (event
->y
, wy
);
5733 if (part
== ON_MODE_LINE
)
5735 else if (part
== ON_VERTICAL_BORDER
)
5736 posn
= Qvertical_line
;
5737 else if (part
== ON_HEADER_LINE
)
5738 posn
= Qheader_line
;
5742 struct display_pos p
;
5743 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5744 posn
= make_number (CHARPOS (p
.pos
));
5749 Lisp_Object head
, position
;
5754 Fcons (Fcons (event
->x
, event
->y
),
5755 Fcons (make_number (event
->timestamp
),
5758 head
= modify_event_symbol (0, event
->modifiers
,
5760 lispy_drag_n_drop_names
,
5761 &drag_n_drop_syms
, 1);
5768 #endif /* HAVE_MOUSE */
5770 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5771 || defined (USE_GTK)
5772 case MENU_BAR_EVENT
:
5773 if (EQ (event
->arg
, event
->frame_or_window
))
5774 /* This is the prefix key. We translate this to
5775 `(menu_bar)' because the code in keyboard.c for menu
5776 events, which we use, relies on this. */
5777 return Fcons (Qmenu_bar
, Qnil
);
5781 case SELECT_WINDOW_EVENT
:
5782 /* Make an event (select-window (WINDOW)). */
5783 return Fcons (Qselect_window
,
5784 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5787 case TOOL_BAR_EVENT
:
5788 if (EQ (event
->arg
, event
->frame_or_window
))
5789 /* This is the prefix key. We translate this to
5790 `(tool_bar)' because the code in keyboard.c for tool bar
5791 events, which we use, relies on this. */
5792 return Fcons (Qtool_bar
, Qnil
);
5793 else if (SYMBOLP (event
->arg
))
5794 return apply_modifiers (event
->modifiers
, event
->arg
);
5797 case USER_SIGNAL_EVENT
:
5798 /* A user signal. */
5799 return *lispy_user_signals
[event
->code
];
5801 case SAVE_SESSION_EVENT
:
5802 return Qsave_session
;
5804 /* The 'kind' field of the event is something we don't recognize. */
5813 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5815 Lisp_Object bar_window
;
5816 enum scroll_bar_part part
;
5820 /* Is it a scroll bar movement? */
5821 if (frame
&& ! NILP (bar_window
))
5823 Lisp_Object part_sym
;
5825 part_sym
= *scroll_bar_parts
[(int) part
];
5826 return Fcons (Qscroll_bar_movement
,
5827 (Fcons (Fcons (bar_window
,
5828 Fcons (Qvertical_scroll_bar
,
5829 Fcons (Fcons (x
, y
),
5830 Fcons (make_number (time
),
5836 /* Or is it an ordinary mouse movement? */
5839 enum window_part area
;
5845 /* It's in a frame; which window on that frame? */
5846 window
= window_from_coordinates (frame
, XINT (x
), XINT (y
),
5847 &area
, &wx
, &wy
, 0);
5851 if (WINDOWP (window
))
5853 struct window
*w
= XWINDOW (window
);
5855 /* Set window relative coordinates. */
5859 if (area
== ON_MODE_LINE
)
5861 else if (area
== ON_VERTICAL_BORDER
)
5862 posn
= Qvertical_line
;
5863 else if (area
== ON_HEADER_LINE
)
5864 posn
= Qheader_line
;
5868 struct display_pos p
;
5869 buffer_posn_from_coords (w
, &wx
, &wy
, &object
, &p
);
5870 posn
= make_number (CHARPOS (p
.pos
));
5873 else if (frame
!= 0)
5875 XSETFRAME (window
, frame
);
5886 return Fcons (Qmouse_movement
,
5887 Fcons (Fcons (window
,
5889 Fcons (Fcons (x
, y
),
5890 Fcons (make_number (time
),
5896 #endif /* HAVE_MOUSE */
5898 /* Construct a switch frame event. */
5900 make_lispy_switch_frame (frame
)
5903 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5906 /* Manipulating modifiers. */
5908 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5910 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5911 SYMBOL's name of the end of the modifiers; the string from this
5912 position is the unmodified symbol name.
5914 This doesn't use any caches. */
5917 parse_modifiers_uncached (symbol
, modifier_end
)
5925 CHECK_SYMBOL (symbol
);
5928 name
= SYMBOL_NAME (symbol
);
5930 for (i
= 0; i
+2 <= SBYTES (name
); )
5932 int this_mod_end
= 0;
5935 /* See if the name continues with a modifier word.
5936 Check that the word appears, but don't check what follows it.
5937 Set this_mod and this_mod_end to record what we find. */
5939 switch (SREF (name
, i
))
5941 #define SINGLE_LETTER_MOD(BIT) \
5942 (this_mod_end = i + 1, this_mod = BIT)
5945 SINGLE_LETTER_MOD (alt_modifier
);
5949 SINGLE_LETTER_MOD (ctrl_modifier
);
5953 SINGLE_LETTER_MOD (hyper_modifier
);
5957 SINGLE_LETTER_MOD (meta_modifier
);
5961 SINGLE_LETTER_MOD (shift_modifier
);
5965 SINGLE_LETTER_MOD (super_modifier
);
5968 #undef SINGLE_LETTER_MOD
5970 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5971 if (i + LEN + 1 <= SBYTES (name) \
5972 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5974 this_mod_end = i + LEN; \
5979 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5980 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5981 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5985 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5987 #undef MULTI_LETTER_MOD
5991 /* If we found no modifier, stop looking for them. */
5992 if (this_mod_end
== 0)
5995 /* Check there is a dash after the modifier, so that it
5996 really is a modifier. */
5997 if (this_mod_end
>= SBYTES (name
)
5998 || SREF (name
, this_mod_end
) != '-')
6001 /* This modifier is real; look for another. */
6002 modifiers
|= this_mod
;
6003 i
= this_mod_end
+ 1;
6006 /* Should we include the `click' modifier? */
6007 if (! (modifiers
& (down_modifier
| drag_modifier
6008 | double_modifier
| triple_modifier
))
6009 && i
+ 7 == SBYTES (name
)
6010 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6011 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6012 modifiers
|= click_modifier
;
6020 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6021 prepended to the string BASE[0..BASE_LEN-1].
6022 This doesn't use any caches. */
6024 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6027 int base_len
, base_len_byte
;
6029 /* Since BASE could contain nulls, we can't use intern here; we have
6030 to use Fintern, which expects a genuine Lisp_String, and keeps a
6033 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6039 /* Only the event queue may use the `up' modifier; it should always
6040 be turned into a click or drag event before presented to lisp code. */
6041 if (modifiers
& up_modifier
)
6044 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6045 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6046 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6047 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6048 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6049 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6050 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6051 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6052 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6053 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6054 /* The click modifier is denoted by the absence of other modifiers. */
6058 mod_len
= p
- new_mods
;
6062 Lisp_Object new_name
;
6064 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6065 mod_len
+ base_len_byte
);
6066 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6067 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6069 return Fintern (new_name
, Qnil
);
6074 static char *modifier_names
[] =
6076 "up", "down", "drag", "click", "double", "triple", 0, 0,
6077 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6078 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6080 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6082 static Lisp_Object modifier_symbols
;
6084 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6086 lispy_modifier_list (modifiers
)
6089 Lisp_Object modifier_list
;
6092 modifier_list
= Qnil
;
6093 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6094 if (modifiers
& (1<<i
))
6095 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6098 return modifier_list
;
6102 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6103 where UNMODIFIED is the unmodified form of SYMBOL,
6104 MASK is the set of modifiers present in SYMBOL's name.
6105 This is similar to parse_modifiers_uncached, but uses the cache in
6106 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6107 Qevent_symbol_elements property. */
6110 parse_modifiers (symbol
)
6113 Lisp_Object elements
;
6115 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6116 if (CONSP (elements
))
6121 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6122 Lisp_Object unmodified
;
6125 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6126 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6129 if (modifiers
& ~VALMASK
)
6131 XSETFASTINT (mask
, modifiers
);
6132 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6134 /* Cache the parsing results on SYMBOL. */
6135 Fput (symbol
, Qevent_symbol_element_mask
,
6137 Fput (symbol
, Qevent_symbol_elements
,
6138 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6140 /* Since we know that SYMBOL is modifiers applied to unmodified,
6141 it would be nice to put that in unmodified's cache.
6142 But we can't, since we're not sure that parse_modifiers is
6149 /* Apply the modifiers MODIFIERS to the symbol BASE.
6150 BASE must be unmodified.
6152 This is like apply_modifiers_uncached, but uses BASE's
6153 Qmodifier_cache property, if present. It also builds
6154 Qevent_symbol_elements properties, since it has that info anyway.
6156 apply_modifiers copies the value of BASE's Qevent_kind property to
6157 the modified symbol. */
6159 apply_modifiers (modifiers
, base
)
6163 Lisp_Object cache
, index
, entry
, new_symbol
;
6165 /* Mask out upper bits. We don't know where this value's been. */
6166 modifiers
&= VALMASK
;
6168 /* The click modifier never figures into cache indices. */
6169 cache
= Fget (base
, Qmodifier_cache
);
6170 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6171 entry
= assq_no_quit (index
, cache
);
6174 new_symbol
= XCDR (entry
);
6177 /* We have to create the symbol ourselves. */
6178 new_symbol
= apply_modifiers_uncached (modifiers
,
6179 SDATA (SYMBOL_NAME (base
)),
6180 SCHARS (SYMBOL_NAME (base
)),
6181 SBYTES (SYMBOL_NAME (base
)));
6183 /* Add the new symbol to the base's cache. */
6184 entry
= Fcons (index
, new_symbol
);
6185 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6187 /* We have the parsing info now for free, so we could add it to
6189 XSETFASTINT (index, modifiers);
6190 Fput (new_symbol, Qevent_symbol_element_mask,
6191 Fcons (base, Fcons (index, Qnil)));
6192 Fput (new_symbol, Qevent_symbol_elements,
6193 Fcons (base, lispy_modifier_list (modifiers)));
6194 Sadly, this is only correct if `base' is indeed a base event,
6195 which is not necessarily the case. -stef */
6198 /* Make sure this symbol is of the same kind as BASE.
6200 You'd think we could just set this once and for all when we
6201 intern the symbol above, but reorder_modifiers may call us when
6202 BASE's property isn't set right; we can't assume that just
6203 because it has a Qmodifier_cache property it must have its
6204 Qevent_kind set right as well. */
6205 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6209 kind
= Fget (base
, Qevent_kind
);
6211 Fput (new_symbol
, Qevent_kind
, kind
);
6218 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6219 return a symbol with the modifiers placed in the canonical order.
6220 Canonical order is alphabetical, except for down and drag, which
6221 always come last. The 'click' modifier is never written out.
6223 Fdefine_key calls this to make sure that (for example) C-M-foo
6224 and M-C-foo end up being equivalent in the keymap. */
6227 reorder_modifiers (symbol
)
6230 /* It's hopefully okay to write the code this way, since everything
6231 will soon be in caches, and no consing will be done at all. */
6234 parsed
= parse_modifiers (symbol
);
6235 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6240 /* For handling events, we often want to produce a symbol whose name
6241 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6242 to some base, like the name of a function key or mouse button.
6243 modify_event_symbol produces symbols of this sort.
6245 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6246 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6249 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6250 into symbol names, or a string specifying a name stem used to
6251 construct a symbol name or the form `STEM-N', where N is the decimal
6252 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6253 non-nil; otherwise NAME_TABLE is used.
6255 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6256 persist between calls to modify_event_symbol that it can use to
6257 store a cache of the symbols it's generated for this NAME_TABLE
6258 before. The object stored there may be a vector or an alist.
6260 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6262 MODIFIERS is a set of modifier bits (as given in struct input_events)
6263 whose prefixes should be applied to the symbol name.
6265 SYMBOL_KIND is the value to be placed in the event_kind property of
6266 the returned symbol.
6268 The symbols we create are supposed to have an
6269 `event-symbol-elements' property, which lists the modifiers present
6270 in the symbol's name. */
6273 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6274 name_table
, symbol_table
, table_size
)
6277 Lisp_Object symbol_kind
;
6278 Lisp_Object name_alist_or_stem
;
6280 Lisp_Object
*symbol_table
;
6281 unsigned int table_size
;
6284 Lisp_Object symbol_int
;
6286 /* Get rid of the "vendor-specific" bit here. */
6287 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6289 /* Is this a request for a valid symbol? */
6290 if (symbol_num
< 0 || symbol_num
>= table_size
)
6293 if (CONSP (*symbol_table
))
6294 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6296 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6297 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6298 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6299 we've never used that symbol before. */
6302 if (! VECTORP (*symbol_table
)
6303 || XVECTOR (*symbol_table
)->size
!= table_size
)
6307 XSETFASTINT (size
, table_size
);
6308 *symbol_table
= Fmake_vector (size
, Qnil
);
6311 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6314 /* Have we already used this symbol before? */
6317 /* No; let's create it. */
6318 if (CONSP (name_alist_or_stem
))
6319 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6320 else if (STRINGP (name_alist_or_stem
))
6322 int len
= SBYTES (name_alist_or_stem
);
6323 char *buf
= (char *) alloca (len
+ 50);
6324 if (sizeof (int) == sizeof (EMACS_INT
))
6325 sprintf (buf
, "%s-%d", SDATA (name_alist_or_stem
),
6326 XINT (symbol_int
) + 1);
6327 else if (sizeof (long) == sizeof (EMACS_INT
))
6328 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6329 XINT (symbol_int
) + 1);
6330 value
= intern (buf
);
6332 else if (name_table
!= 0 && name_table
[symbol_num
])
6333 value
= intern (name_table
[symbol_num
]);
6335 #ifdef HAVE_WINDOW_SYSTEM
6338 char *name
= x_get_keysym_name (symbol_num
);
6340 value
= intern (name
);
6347 sprintf (buf
, "key-%d", symbol_num
);
6348 value
= intern (buf
);
6351 if (CONSP (*symbol_table
))
6352 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6354 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6356 /* Fill in the cache entries for this symbol; this also
6357 builds the Qevent_symbol_elements property, which the user
6359 apply_modifiers (modifiers
& click_modifier
, value
);
6360 Fput (value
, Qevent_kind
, symbol_kind
);
6363 /* Apply modifiers to that symbol. */
6364 return apply_modifiers (modifiers
, value
);
6367 /* Convert a list that represents an event type,
6368 such as (ctrl meta backspace), into the usual representation of that
6369 event type as a number or a symbol. */
6371 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6372 doc
: /* Convert the event description list EVENT-DESC to an event type.
6373 EVENT-DESC should contain one base event type (a character or symbol)
6374 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6375 drag, down, double or triple). The base must be last.
6376 The return value is an event type (a character or symbol) which
6377 has the same base event type and all the specified modifiers. */)
6379 Lisp_Object event_desc
;
6387 while (CONSP (rest
))
6395 /* Given a symbol, see if it is a modifier name. */
6396 if (SYMBOLP (elt
) && CONSP (rest
))
6397 this = parse_solitary_modifier (elt
);
6401 else if (!NILP (base
))
6402 error ("Two bases given in one event");
6408 /* Let the symbol A refer to the character A. */
6409 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6410 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6412 if (INTEGERP (base
))
6414 /* Turn (shift a) into A. */
6415 if ((modifiers
& shift_modifier
) != 0
6416 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6418 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6419 modifiers
&= ~shift_modifier
;
6422 /* Turn (control a) into C-a. */
6423 if (modifiers
& ctrl_modifier
)
6424 return make_number ((modifiers
& ~ctrl_modifier
)
6425 | make_ctrl_char (XINT (base
)));
6427 return make_number (modifiers
| XINT (base
));
6429 else if (SYMBOLP (base
))
6430 return apply_modifiers (modifiers
, base
);
6433 error ("Invalid base event");
6438 /* Try to recognize SYMBOL as a modifier name.
6439 Return the modifier flag bit, or 0 if not recognized. */
6442 parse_solitary_modifier (symbol
)
6445 Lisp_Object name
= SYMBOL_NAME (symbol
);
6447 switch (SREF (name
, 0))
6449 #define SINGLE_LETTER_MOD(BIT) \
6450 if (SBYTES (name) == 1) \
6453 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6454 if (LEN == SBYTES (name) \
6455 && ! strncmp (SDATA (name), NAME, LEN)) \
6459 SINGLE_LETTER_MOD (alt_modifier
);
6463 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6467 SINGLE_LETTER_MOD (ctrl_modifier
);
6471 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6472 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6476 SINGLE_LETTER_MOD (hyper_modifier
);
6480 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6484 SINGLE_LETTER_MOD (meta_modifier
);
6488 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6492 SINGLE_LETTER_MOD (shift_modifier
);
6496 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6497 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6498 SINGLE_LETTER_MOD (super_modifier
);
6502 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6503 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6504 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6508 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6511 #undef SINGLE_LETTER_MOD
6512 #undef MULTI_LETTER_MOD
6518 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6519 Such a list is not valid as an event,
6520 but it can be a Lucid-style event type list. */
6523 lucid_event_type_list_p (object
)
6528 if (! CONSP (object
))
6531 if (EQ (XCAR (object
), Qhelp_echo
)
6532 || EQ (XCAR (object
), Qvertical_line
)
6533 || EQ (XCAR (object
), Qmode_line
)
6534 || EQ (XCAR (object
), Qheader_line
))
6537 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6541 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6548 /* Store into *addr a value nonzero if terminal input chars are available.
6549 Serves the purpose of ioctl (0, FIONREAD, addr)
6550 but works even if FIONREAD does not exist.
6551 (In fact, this may actually read some input.)
6553 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6554 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6557 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6562 /* First of all, have we already counted some input? */
6563 *addr
= (!NILP (Vquit_flag
)
6564 || readable_filtered_events (do_timers_now
, filter_events
));
6566 /* If input is being read as it arrives, and we have none, there is none. */
6567 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6570 /* Try to read some input and see how much we get. */
6572 *addr
= (!NILP (Vquit_flag
)
6573 || readable_filtered_events (do_timers_now
, filter_events
));
6576 /* Store into *addr a value nonzero if terminal input chars are available.
6577 Serves the purpose of ioctl (0, FIONREAD, addr)
6578 but works even if FIONREAD does not exist.
6579 (In fact, this may actually read some input.)
6581 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6584 get_input_pending (addr
, do_timers_now
)
6588 get_filtered_input_pending (addr
, do_timers_now
, 0);
6591 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6594 gobble_input (expected
)
6599 if (interrupt_input
)
6602 mask
= sigblock (sigmask (SIGIO
));
6603 read_avail_input (expected
);
6607 #ifdef POLL_FOR_INPUT
6608 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6611 mask
= sigblock (sigmask (SIGALRM
));
6612 read_avail_input (expected
);
6618 read_avail_input (expected
);
6622 /* Put a BUFFER_SWITCH_EVENT in the buffer
6623 so that read_key_sequence will notice the new current buffer. */
6626 record_asynch_buffer_change ()
6628 struct input_event event
;
6632 event
.kind
= BUFFER_SWITCH_EVENT
;
6633 event
.frame_or_window
= Qnil
;
6637 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6638 The purpose of the event is to make read_key_sequence look up the
6639 keymaps again. If we aren't in read_key_sequence, we don't need one,
6640 and the event could cause trouble by messing up (input-pending-p). */
6641 tem
= Fwaiting_for_user_input_p ();
6645 /* We never need these events if we have no asynchronous subprocesses. */
6649 /* Make sure no interrupt happens while storing the event. */
6651 if (interrupt_input
)
6654 mask
= sigblock (sigmask (SIGIO
));
6655 kbd_buffer_store_event (&event
);
6662 kbd_buffer_store_event (&event
);
6669 /* Read any terminal input already buffered up by the system
6670 into the kbd_buffer, but do not wait.
6672 EXPECTED should be nonzero if the caller knows there is some input.
6674 Except on VMS, all input is read by this function.
6675 If interrupt_input is nonzero, this function MUST be called
6676 only when SIGIO is blocked.
6678 Returns the number of keyboard chars read, or -1 meaning
6679 this is a bad time to try to read input. */
6682 read_avail_input (expected
)
6685 struct input_event buf
[KBD_BUFFER_SIZE
];
6689 for (i
= 0; i
< KBD_BUFFER_SIZE
; i
++)
6690 EVENT_INIT (buf
[i
]);
6692 if (read_socket_hook
)
6693 /* No need for FIONREAD or fcntl; just say don't wait. */
6694 nread
= (*read_socket_hook
) (input_fd
, buf
, KBD_BUFFER_SIZE
, expected
);
6697 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6698 the kbd_buffer can really hold. That may prevent loss
6699 of characters on some systems when input is stuffed at us. */
6700 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6703 /* Determine how many characters we should *try* to read. */
6706 #else /* not WINDOWSNT */
6708 n_to_read
= dos_keysns ();
6711 #else /* not MSDOS */
6713 /* Find out how much input is available. */
6714 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6715 /* Formerly simply reported no input, but that sometimes led to
6716 a failure of Emacs to terminate.
6717 SIGHUP seems appropriate if we can't reach the terminal. */
6718 /* ??? Is it really right to send the signal just to this process
6719 rather than to the whole process group?
6720 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6722 if (! noninteractive
)
6723 kill (getpid (), SIGHUP
);
6729 if (n_to_read
> sizeof cbuf
)
6730 n_to_read
= sizeof cbuf
;
6731 #else /* no FIONREAD */
6732 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6733 /* Read some input if available, but don't wait. */
6734 n_to_read
= sizeof cbuf
;
6735 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6740 #endif /* not MSDOS */
6741 #endif /* not WINDOWSNT */
6743 /* Now read; for one reason or another, this will not block.
6744 NREAD is set to the number of chars read. */
6748 cbuf
[0] = dos_keyread ();
6751 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6753 /* POSIX infers that processes which are not in the session leader's
6754 process group won't get SIGHUP's at logout time. BSDI adheres to
6755 this part standard and returns -1 from read (0) with errno==EIO
6756 when the control tty is taken away.
6757 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6758 if (nread
== -1 && errno
== EIO
)
6760 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6761 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6762 This looks incorrect, but it isn't, because _BSD causes
6763 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6764 and that causes a value other than 0 when there is no input. */
6770 /* We used to retry the read if it was interrupted.
6771 But this does the wrong thing when O_NDELAY causes
6772 an EAGAIN error. Does anybody know of a situation
6773 where a retry is actually needed? */
6775 nread
< 0 && (errno
== EAGAIN
6789 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6790 fcntl (input_fd
, F_SETFL
, 0);
6791 #endif /* USG or DGUX or CYGWIN */
6792 #endif /* no FIONREAD */
6793 for (i
= 0; i
< nread
; i
++)
6795 buf
[i
].kind
= ASCII_KEYSTROKE_EVENT
;
6796 buf
[i
].modifiers
= 0;
6797 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6798 buf
[i
].modifiers
= meta_modifier
;
6802 buf
[i
].code
= cbuf
[i
];
6803 buf
[i
].frame_or_window
= selected_frame
;
6808 /* Scan the chars for C-g and store them in kbd_buffer. */
6809 for (i
= 0; i
< nread
; i
++)
6811 kbd_buffer_store_event (&buf
[i
]);
6812 /* Don't look at input that follows a C-g too closely.
6813 This reduces lossage due to autorepeat on C-g. */
6814 if (buf
[i
].kind
== ASCII_KEYSTROKE_EVENT
6815 && buf
[i
].code
== quit_char
)
6821 #endif /* not VMS */
6823 #ifdef SIGIO /* for entire page */
6824 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6827 input_available_signal (signo
)
6830 /* Must preserve main program's value of errno. */
6831 int old_errno
= errno
;
6833 extern int select_alarmed
;
6836 #if defined (USG) && !defined (POSIX_SIGNALS)
6837 /* USG systems forget handlers when they are used;
6838 must reestablish each time */
6839 signal (signo
, input_available_signal
);
6846 if (input_available_clear_time
)
6847 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6852 nread
= read_avail_input (1);
6853 /* -1 means it's not ok to read the input now.
6854 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6855 0 means there was no keyboard input available. */
6860 select_alarmed
= 1; /* Force the select emulator back to life */
6871 /* Send ourselves a SIGIO.
6873 This function exists so that the UNBLOCK_INPUT macro in
6874 blockinput.h can have some way to take care of input we put off
6875 dealing with, without assuming that every file which uses
6876 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6878 reinvoke_input_signal ()
6881 kill (getpid (), SIGIO
);
6887 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6888 static Lisp_Object menu_bar_one_keymap_changed_items
;
6890 /* These variables hold the vector under construction within
6891 menu_bar_items and its subroutines, and the current index
6892 for storing into that vector. */
6893 static Lisp_Object menu_bar_items_vector
;
6894 static int menu_bar_items_index
;
6896 /* Return a vector of menu items for a menu bar, appropriate
6897 to the current buffer. Each item has three elements in the vector:
6900 OLD is an old vector we can optionally reuse, or nil. */
6903 menu_bar_items (old
)
6906 /* The number of keymaps we're scanning right now, and the number of
6907 keymaps we have allocated space for. */
6910 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6911 in the current keymaps, or nil where it is not a prefix. */
6914 Lisp_Object def
, tail
;
6923 struct gcpro gcpro1
;
6925 /* In order to build the menus, we need to call the keymap
6926 accessors. They all call QUIT. But this function is called
6927 during redisplay, during which a quit is fatal. So inhibit
6928 quitting while building the menus.
6929 We do this instead of specbind because (1) errors will clear it anyway
6930 and (2) this avoids risk of specpdl overflow. */
6931 oquit
= Vinhibit_quit
;
6935 menu_bar_items_vector
= old
;
6937 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6938 menu_bar_items_index
= 0;
6940 GCPRO1 (menu_bar_items_vector
);
6942 /* Build our list of keymaps.
6943 If we recognize a function key and replace its escape sequence in
6944 keybuf with its symbol, or if the sequence starts with a mouse
6945 click and we need to switch buffers, we jump back here to rebuild
6946 the initial keymaps from the current buffer. */
6950 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6951 if (!NILP (Voverriding_local_map_menu_flag
))
6953 /* Yes, use them (if non-nil) as well as the global map. */
6954 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6956 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6957 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6958 if (!NILP (Voverriding_local_map
))
6959 maps
[nmaps
++] = Voverriding_local_map
;
6963 /* No, so use major and minor mode keymaps and keymap property.
6964 Note that menu-bar bindings in the local-map and keymap
6965 properties may not work reliable, as they are only
6966 recognized when the menu-bar (or mode-line) is updated,
6967 which does not normally happen after every command. */
6970 nminor
= current_minor_maps (NULL
, &tmaps
);
6971 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6973 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6974 maps
[nmaps
++] = tem
;
6975 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6977 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6979 maps
[nmaps
++] = current_global_map
;
6982 /* Look up in each map the dummy prefix key `menu-bar'. */
6986 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6987 if (!NILP (maps
[mapno
]))
6989 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6993 menu_bar_one_keymap_changed_items
= Qnil
;
6994 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
6998 /* Move to the end those items that should be at the end. */
7000 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7003 int end
= menu_bar_items_index
;
7005 for (i
= 0; i
< end
; i
+= 4)
7006 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7008 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7009 /* Move the item at index I to the end,
7010 shifting all the others forward. */
7011 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7012 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7013 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7014 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7016 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7017 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7018 (end
- i
- 4) * sizeof (Lisp_Object
));
7019 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7020 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7021 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7022 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7027 /* Add nil, nil, nil, nil at the end. */
7028 i
= menu_bar_items_index
;
7029 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7032 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7033 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7034 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7035 menu_bar_items_vector
= tem
;
7037 /* Add this item. */
7038 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7039 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7040 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7041 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7042 menu_bar_items_index
= i
;
7044 Vinhibit_quit
= oquit
;
7046 return menu_bar_items_vector
;
7049 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7050 If there's already an item for KEY, add this DEF to it. */
7052 Lisp_Object item_properties
;
7055 menu_bar_item (key
, item
, dummy1
, dummy2
)
7056 Lisp_Object key
, item
, dummy1
;
7059 struct gcpro gcpro1
;
7063 if (EQ (item
, Qundefined
))
7065 /* If a map has an explicit `undefined' as definition,
7066 discard any previously made menu bar item. */
7068 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7069 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7071 if (menu_bar_items_index
> i
+ 4)
7072 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7073 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7074 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7075 menu_bar_items_index
-= 4;
7079 /* If this keymap has already contributed to this KEY,
7080 don't contribute to it a second time. */
7081 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7082 if (!NILP (tem
) || NILP (item
))
7085 menu_bar_one_keymap_changed_items
7086 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7088 /* We add to menu_bar_one_keymap_changed_items before doing the
7089 parse_menu_item, so that if it turns out it wasn't a menu item,
7090 it still correctly hides any further menu item. */
7092 i
= parse_menu_item (item
, 0, 1);
7097 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7099 /* Find any existing item for this KEY. */
7100 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7101 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7104 /* If we did not find this KEY, add it at the end. */
7105 if (i
== menu_bar_items_index
)
7107 /* If vector is too small, get a bigger one. */
7108 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7111 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7112 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7113 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7114 menu_bar_items_vector
= tem
;
7117 /* Add this item. */
7118 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7119 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7120 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7121 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7122 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7123 menu_bar_items_index
= i
;
7125 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7129 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7130 /* If the new and the old items are not both keymaps,
7131 the lookup will only find `item'. */
7132 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7133 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7137 /* This is used as the handler when calling menu_item_eval_property. */
7139 menu_item_eval_property_1 (arg
)
7142 /* If we got a quit from within the menu computation,
7143 quit all the way out of it. This takes care of C-] in the debugger. */
7144 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7145 Fsignal (Qquit
, Qnil
);
7150 /* Evaluate an expression and return the result (or nil if something
7151 went wrong). Used to evaluate dynamic parts of menu items. */
7153 menu_item_eval_property (sexpr
)
7156 int count
= SPECPDL_INDEX ();
7158 specbind (Qinhibit_redisplay
, Qt
);
7159 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7160 menu_item_eval_property_1
);
7161 return unbind_to (count
, val
);
7164 /* This function parses a menu item and leaves the result in the
7165 vector item_properties.
7166 ITEM is a key binding, a possible menu item.
7167 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7168 evaluate dynamic expressions in the menu item.
7169 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7171 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7172 parse_menu_item returns true if the item is a menu item and false
7176 parse_menu_item (item
, notreal
, inmenubar
)
7178 int notreal
, inmenubar
;
7180 Lisp_Object def
, tem
, item_string
, start
;
7181 Lisp_Object cachelist
;
7183 Lisp_Object keyhint
;
7194 /* Create item_properties vector if necessary. */
7195 if (NILP (item_properties
))
7197 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7199 /* Initialize optional entries. */
7200 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7201 AREF (item_properties
, i
) = Qnil
;
7202 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7204 /* Save the item here to protect it from GC. */
7205 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7207 item_string
= XCAR (item
);
7211 if (STRINGP (item_string
))
7213 /* Old format menu item. */
7214 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7216 /* Maybe help string. */
7217 if (CONSP (item
) && STRINGP (XCAR (item
)))
7219 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7224 /* Maybe key binding cache. */
7225 if (CONSP (item
) && CONSP (XCAR (item
))
7226 && (NILP (XCAR (XCAR (item
)))
7227 || VECTORP (XCAR (XCAR (item
)))))
7229 cachelist
= XCAR (item
);
7233 /* This is the real definition--the function to run. */
7234 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7236 /* Get enable property, if any. */
7239 tem
= Fget (item
, Qmenu_enable
);
7241 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7244 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7246 /* New format menu item. */
7247 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7248 start
= XCDR (item
);
7251 /* We have a real binding. */
7252 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7254 item
= XCDR (start
);
7255 /* Is there a cache list with key equivalences. */
7256 if (CONSP (item
) && CONSP (XCAR (item
)))
7258 cachelist
= XCAR (item
);
7262 /* Parse properties. */
7263 while (CONSP (item
) && CONSP (XCDR (item
)))
7268 if (EQ (tem
, QCenable
))
7269 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7270 else if (EQ (tem
, QCvisible
) && !notreal
)
7272 /* If got a visible property and that evaluates to nil
7273 then ignore this item. */
7274 tem
= menu_item_eval_property (XCAR (item
));
7278 else if (EQ (tem
, QChelp
))
7279 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7280 else if (EQ (tem
, QCfilter
))
7282 else if (EQ (tem
, QCkey_sequence
))
7285 if (NILP (cachelist
)
7286 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7287 /* Be GC protected. Set keyhint to item instead of tem. */
7290 else if (EQ (tem
, QCkeys
))
7293 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7294 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7296 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7301 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7303 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7305 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7312 else if (inmenubar
|| !NILP (start
))
7316 return 0; /* not a menu item */
7318 /* If item string is not a string, evaluate it to get string.
7319 If we don't get a string, skip this item. */
7320 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7321 if (!(STRINGP (item_string
) || notreal
))
7323 item_string
= menu_item_eval_property (item_string
);
7324 if (!STRINGP (item_string
))
7326 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7329 /* If got a filter apply it on definition. */
7330 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7333 def
= menu_item_eval_property (list2 (XCAR (filter
),
7334 list2 (Qquote
, def
)));
7336 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7339 /* Enable or disable selection of item. */
7340 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7346 tem
= menu_item_eval_property (tem
);
7347 if (inmenubar
&& NILP (tem
))
7348 return 0; /* Ignore disabled items in menu bar. */
7349 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7352 /* If we got no definition, this item is just unselectable text which
7353 is OK in a submenu but not in the menubar. */
7355 return (inmenubar
? 0 : 1);
7357 /* See if this is a separate pane or a submenu. */
7358 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7359 tem
= get_keymap (def
, 0, 1);
7360 /* For a subkeymap, just record its details and exit. */
7363 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7364 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7368 /* At the top level in the menu bar, do likewise for commands also.
7369 The menu bar does not display equivalent key bindings anyway.
7370 ITEM_PROPERTY_DEF is already set up properly. */
7374 /* This is a command. See if there is an equivalent key binding. */
7375 if (NILP (cachelist
))
7377 /* We have to create a cachelist. */
7378 CHECK_IMPURE (start
);
7379 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7380 cachelist
= XCAR (XCDR (start
));
7382 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7383 if (!NILP (keyhint
))
7385 XSETCAR (cachelist
, XCAR (keyhint
));
7388 else if (STRINGP (tem
))
7390 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7391 XSETCAR (cachelist
, Qt
);
7395 tem
= XCAR (cachelist
);
7402 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7404 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7407 def
= XCAR (prefix
);
7408 prefix
= XCDR (prefix
);
7411 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7413 if (!update_menu_bindings
)
7415 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7417 if (newcache
/* Always check first time. */
7418 /* Should we check everything when precomputing key
7420 /* If something had no key binding before, don't recheck it
7421 because that is too slow--except if we have a list of
7422 rebound commands in Vdefine_key_rebound_commands, do
7423 recheck any command that appears in that list. */
7424 || (CONSP (Vdefine_key_rebound_commands
)
7425 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7428 /* We had a saved key. Is it still bound to the command? */
7431 /* If the command is an alias for another
7432 (such as lmenu.el set it up), check if the
7433 original command matches the cached command. */
7434 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7435 chkcache
= 1; /* Need to recompute key binding. */
7439 /* Recompute equivalent key binding. If the command is an alias
7440 for another (such as lmenu.el set it up), see if the original
7441 command name has equivalent keys. Otherwise look up the
7442 specified command itself. We don't try both, because that
7443 makes lmenu menus slow. */
7445 && SYMBOLP (XSYMBOL (def
)->function
)
7446 && ! NILP (Fget (def
, Qmenu_alias
)))
7447 def
= XSYMBOL (def
)->function
;
7448 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7449 XSETCAR (cachelist
, tem
);
7452 XSETCDR (cachelist
, Qnil
);
7456 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7458 tem
= XCAR (cachelist
);
7462 newcache
= chkcache
;
7465 tem
= Fkey_description (tem
);
7468 if (STRINGP (XCAR (prefix
)))
7469 tem
= concat2 (XCAR (prefix
), tem
);
7470 if (STRINGP (XCDR (prefix
)))
7471 tem
= concat2 (tem
, XCDR (prefix
));
7473 XSETCDR (cachelist
, tem
);
7477 tem
= XCDR (cachelist
);
7478 if (newcache
&& !NILP (tem
))
7480 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7481 XSETCDR (cachelist
, tem
);
7484 /* If we only want to precompute equivalent key bindings, stop here. */
7488 /* If we have an equivalent key binding, use that. */
7489 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7491 /* Include this when menu help is implemented.
7492 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7493 if (!(NILP (tem) || STRINGP (tem)))
7495 tem = menu_item_eval_property (tem);
7498 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7502 /* Handle radio buttons or toggle boxes. */
7503 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7505 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7506 = menu_item_eval_property (tem
);
7513 /***********************************************************************
7515 ***********************************************************************/
7517 /* A vector holding tool bar items while they are parsed in function
7518 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7521 static Lisp_Object tool_bar_items_vector
;
7523 /* A vector holding the result of parse_tool_bar_item. Layout is like
7524 the one for a single item in tool_bar_items_vector. */
7526 static Lisp_Object tool_bar_item_properties
;
7528 /* Next free index in tool_bar_items_vector. */
7530 static int ntool_bar_items
;
7532 /* The symbols `tool-bar', and `:image'. */
7534 extern Lisp_Object Qtool_bar
;
7535 Lisp_Object QCimage
;
7537 /* Function prototypes. */
7539 static void init_tool_bar_items
P_ ((Lisp_Object
));
7540 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7541 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7542 static void append_tool_bar_item
P_ ((void));
7545 /* Return a vector of tool bar items for keymaps currently in effect.
7546 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7547 tool bar items found. */
7550 tool_bar_items (reuse
, nitems
)
7561 /* In order to build the menus, we need to call the keymap
7562 accessors. They all call QUIT. But this function is called
7563 during redisplay, during which a quit is fatal. So inhibit
7564 quitting while building the menus. We do this instead of
7565 specbind because (1) errors will clear it anyway and (2) this
7566 avoids risk of specpdl overflow. */
7567 oquit
= Vinhibit_quit
;
7570 /* Initialize tool_bar_items_vector and protect it from GC. */
7571 init_tool_bar_items (reuse
);
7573 /* Build list of keymaps in maps. Set nmaps to the number of maps
7576 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7577 if (!NILP (Voverriding_local_map_menu_flag
))
7579 /* Yes, use them (if non-nil) as well as the global map. */
7580 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7582 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7583 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7584 if (!NILP (Voverriding_local_map
))
7585 maps
[nmaps
++] = Voverriding_local_map
;
7589 /* No, so use major and minor mode keymaps and keymap property.
7590 Note that tool-bar bindings in the local-map and keymap
7591 properties may not work reliable, as they are only
7592 recognized when the tool-bar (or mode-line) is updated,
7593 which does not normally happen after every command. */
7596 nminor
= current_minor_maps (NULL
, &tmaps
);
7597 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7599 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7600 maps
[nmaps
++] = tem
;
7601 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7603 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7606 /* Add global keymap at the end. */
7607 maps
[nmaps
++] = current_global_map
;
7609 /* Process maps in reverse order and look up in each map the prefix
7611 for (i
= nmaps
- 1; i
>= 0; --i
)
7612 if (!NILP (maps
[i
]))
7616 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7621 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7622 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7624 Lisp_Object keydef
= XCAR (tail
);
7626 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7631 Vinhibit_quit
= oquit
;
7632 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7633 return tool_bar_items_vector
;
7637 /* Process the definition of KEY which is DEF. */
7640 process_tool_bar_item (key
, def
)
7641 Lisp_Object key
, def
;
7644 extern Lisp_Object Qundefined
;
7645 struct gcpro gcpro1
, gcpro2
;
7647 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7651 if (EQ (def
, Qundefined
))
7653 /* If a map has an explicit `undefined' as definition,
7654 discard any previously made item. */
7655 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7657 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7659 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7661 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7662 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7663 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7664 * sizeof (Lisp_Object
)));
7665 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7670 else if (parse_tool_bar_item (key
, def
))
7671 /* Append a new tool bar item to tool_bar_items_vector. Accept
7672 more than one definition for the same key. */
7673 append_tool_bar_item ();
7679 /* Parse a tool bar item specification ITEM for key KEY and return the
7680 result in tool_bar_item_properties. Value is zero if ITEM is
7683 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7685 CAPTION is the caption of the item, If it's not a string, it is
7686 evaluated to get a string.
7688 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7689 as binding are currently ignored.
7691 The following properties are recognized:
7695 FORM is evaluated and specifies whether the tool bar item is
7696 enabled or disabled.
7700 FORM is evaluated and specifies whether the tool bar item is visible.
7702 - `:filter FUNCTION'
7704 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7705 result is stored as the new binding.
7707 - `:button (TYPE SELECTED)'
7709 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7710 and specifies whether the button is selected (pressed) or not.
7714 IMAGES is either a single image specification or a vector of four
7715 image specifications. See enum tool_bar_item_images.
7717 - `:help HELP-STRING'.
7719 Gives a help string to display for the tool bar item. */
7722 parse_tool_bar_item (key
, item
)
7723 Lisp_Object key
, item
;
7725 /* Access slot with index IDX of vector tool_bar_item_properties. */
7726 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7728 Lisp_Object filter
= Qnil
;
7729 Lisp_Object caption
;
7732 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7733 Rule out items that aren't lists, don't start with
7734 `menu-item' or whose rest following `tool-bar-item' is not a
7737 || !EQ (XCAR (item
), Qmenu_item
)
7738 || (item
= XCDR (item
),
7742 /* Create tool_bar_item_properties vector if necessary. Reset it to
7744 if (VECTORP (tool_bar_item_properties
))
7746 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7750 tool_bar_item_properties
7751 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7754 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7755 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7757 /* Get the caption of the item. If the caption is not a string,
7758 evaluate it to get a string. If we don't get a string, skip this
7760 caption
= XCAR (item
);
7761 if (!STRINGP (caption
))
7763 caption
= menu_item_eval_property (caption
);
7764 if (!STRINGP (caption
))
7767 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7769 /* Give up if rest following the caption is not a list. */
7774 /* Store the binding. */
7775 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7778 /* Ignore cached key binding, if any. */
7779 if (CONSP (item
) && CONSP (XCAR (item
)))
7782 /* Process the rest of the properties. */
7783 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7785 Lisp_Object key
, value
;
7788 value
= XCAR (XCDR (item
));
7790 if (EQ (key
, QCenable
))
7791 /* `:enable FORM'. */
7792 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7793 else if (EQ (key
, QCvisible
))
7795 /* `:visible FORM'. If got a visible property and that
7796 evaluates to nil then ignore this item. */
7797 if (NILP (menu_item_eval_property (value
)))
7800 else if (EQ (key
, QChelp
))
7801 /* `:help HELP-STRING'. */
7802 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7803 else if (EQ (key
, QCfilter
))
7804 /* ':filter FORM'. */
7806 else if (EQ (key
, QCbutton
) && CONSP (value
))
7808 /* `:button (TYPE . SELECTED)'. */
7809 Lisp_Object type
, selected
;
7811 type
= XCAR (value
);
7812 selected
= XCDR (value
);
7813 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7815 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7816 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7819 else if (EQ (key
, QCimage
)
7821 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7822 /* Value is either a single image specification or a vector
7823 of 4 such specifications for the different button states. */
7824 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7827 /* If got a filter apply it on binding. */
7829 PROP (TOOL_BAR_ITEM_BINDING
)
7830 = menu_item_eval_property (list2 (filter
,
7832 PROP (TOOL_BAR_ITEM_BINDING
))));
7834 /* See if the binding is a keymap. Give up if it is. */
7835 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7838 /* Enable or disable selection of item. */
7839 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7840 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7841 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7843 /* Handle radio buttons or toggle boxes. */
7844 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7845 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7846 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7854 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7855 that can be reused. */
7858 init_tool_bar_items (reuse
)
7861 if (VECTORP (reuse
))
7862 tool_bar_items_vector
= reuse
;
7864 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7865 ntool_bar_items
= 0;
7869 /* Append parsed tool bar item properties from
7870 tool_bar_item_properties */
7873 append_tool_bar_item ()
7875 Lisp_Object
*to
, *from
;
7877 /* Enlarge tool_bar_items_vector if necessary. */
7878 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7879 >= XVECTOR (tool_bar_items_vector
)->size
)
7881 Lisp_Object new_vector
;
7882 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7884 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7885 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7886 XVECTOR (new_vector
)->contents
,
7887 old_size
* sizeof (Lisp_Object
));
7888 tool_bar_items_vector
= new_vector
;
7891 /* Append entries from tool_bar_item_properties to the end of
7892 tool_bar_items_vector. */
7893 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7894 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7895 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7896 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7903 /* Read a character using menus based on maps in the array MAPS.
7904 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7905 Return t if we displayed a menu but the user rejected it.
7907 PREV_EVENT is the previous input event, or nil if we are reading
7908 the first event of a key sequence.
7910 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7911 if we used a mouse menu to read the input, or zero otherwise. If
7912 USED_MOUSE_MENU is null, we don't dereference it.
7914 The prompting is done based on the prompt-string of the map
7915 and the strings associated with various map elements.
7917 This can be done with X menus or with menus put in the minibuf.
7918 These are done in different ways, depending on how the input will be read.
7919 Menus using X are done after auto-saving in read-char, getting the input
7920 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7921 and do auto-saving in the inner call of read_char. */
7924 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7927 Lisp_Object prev_event
;
7928 int *used_mouse_menu
;
7931 register Lisp_Object name
= Qnil
;
7933 if (used_mouse_menu
)
7934 *used_mouse_menu
= 0;
7936 /* Use local over global Menu maps */
7938 if (! menu_prompting
)
7941 /* Optionally disregard all but the global map. */
7942 if (inhibit_local_menu_bar_menus
)
7944 maps
+= (nmaps
- 1);
7948 /* Get the menu name from the first map that has one (a prompt string). */
7949 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7951 name
= Fkeymap_prompt (maps
[mapno
]);
7956 /* If we don't have any menus, just read a character normally. */
7957 if (!STRINGP (name
))
7961 /* If we got to this point via a mouse click,
7962 use a real menu for mouse selection. */
7963 if (EVENT_HAS_PARAMETERS (prev_event
)
7964 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7965 && !EQ (XCAR (prev_event
), Qtool_bar
))
7967 /* Display the menu and get the selection. */
7968 Lisp_Object
*realmaps
7969 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7973 /* Use the maps that are not nil. */
7974 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7975 if (!NILP (maps
[mapno
]))
7976 realmaps
[nmaps1
++] = maps
[mapno
];
7978 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7983 record_menu_key (XCAR (value
));
7985 /* If we got multiple events, unread all but
7987 There is no way to prevent those unread events
7988 from showing up later in last_nonmenu_event.
7989 So turn symbol and integer events into lists,
7990 to indicate that they came from a mouse menu,
7991 so that when present in last_nonmenu_event
7992 they won't confuse things. */
7993 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7995 record_menu_key (XCAR (tem
));
7996 if (SYMBOLP (XCAR (tem
))
7997 || INTEGERP (XCAR (tem
)))
7998 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8001 /* If we got more than one event, put all but the first
8002 onto this list to be read later.
8003 Return just the first event now. */
8004 Vunread_command_events
8005 = nconc2 (XCDR (value
), Vunread_command_events
);
8006 value
= XCAR (value
);
8008 else if (NILP (value
))
8010 if (used_mouse_menu
)
8011 *used_mouse_menu
= 1;
8014 #endif /* HAVE_MENUS */
8018 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8019 We make this bigger when necessary, and never free it. */
8020 static char *read_char_minibuf_menu_text
;
8021 /* Size of that buffer. */
8022 static int read_char_minibuf_menu_width
;
8025 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8031 register Lisp_Object name
;
8033 /* FIXME: Use the minibuffer's frame width. */
8034 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8037 Lisp_Object rest
, vector
;
8043 if (! menu_prompting
)
8046 /* Make sure we have a big enough buffer for the menu text. */
8047 if (read_char_minibuf_menu_text
== 0)
8049 read_char_minibuf_menu_width
= width
+ 4;
8050 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8052 else if (width
+ 4 > read_char_minibuf_menu_width
)
8054 read_char_minibuf_menu_width
= width
+ 4;
8055 read_char_minibuf_menu_text
8056 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8058 menu
= read_char_minibuf_menu_text
;
8060 /* Get the menu name from the first map that has one (a prompt string). */
8061 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8063 name
= Fkeymap_prompt (maps
[mapno
]);
8068 /* If we don't have any menus, just read a character normally. */
8069 if (!STRINGP (name
))
8072 /* Prompt string always starts with map's prompt, and a space. */
8073 strcpy (menu
, SDATA (name
));
8074 nlength
= SBYTES (name
);
8075 menu
[nlength
++] = ':';
8076 menu
[nlength
++] = ' ';
8079 /* Start prompting at start of first map. */
8083 /* Present the documented bindings, a line at a time. */
8090 Lisp_Object orig_defn_macro
;
8092 /* Loop over elements of map. */
8097 /* If reached end of map, start at beginning of next map. */
8101 /* At end of last map, wrap around to first map if just starting,
8102 or end this line if already have something on it. */
8106 if (notfirst
|| nobindings
) break;
8111 /* Look at the next element of the map. */
8113 elt
= XVECTOR (vector
)->contents
[idx
];
8115 elt
= Fcar_safe (rest
);
8117 if (idx
< 0 && VECTORP (elt
))
8119 /* If we found a dense table in the keymap,
8120 advanced past it, but start scanning its contents. */
8121 rest
= Fcdr_safe (rest
);
8127 /* An ordinary element. */
8128 Lisp_Object event
, tem
;
8132 event
= Fcar_safe (elt
); /* alist */
8133 elt
= Fcdr_safe (elt
);
8137 XSETINT (event
, idx
); /* vector */
8140 /* Ignore the element if it has no prompt string. */
8141 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8143 /* 1 if the char to type matches the string. */
8145 Lisp_Object upcased_event
, downcased_event
;
8146 Lisp_Object desc
= Qnil
;
8148 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8150 upcased_event
= Fupcase (event
);
8151 downcased_event
= Fdowncase (event
);
8152 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8153 || XINT (downcased_event
) == SREF (s
, 0));
8155 desc
= Fsingle_key_description (event
, Qnil
);
8157 #if 0 /* It is redundant to list the equivalent key bindings because
8158 the prefix is what the user has already typed. */
8160 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8162 /* Insert equivalent keybinding. */
8163 s
= concat2 (s
, tem
);
8166 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8167 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8169 /* Insert button prefix. */
8170 Lisp_Object selected
8171 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8172 if (EQ (tem
, QCradio
))
8173 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8175 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8176 s
= concat2 (tem
, s
);
8180 /* If we have room for the prompt string, add it to this line.
8181 If this is the first on the line, always add it. */
8182 if ((SCHARS (s
) + i
+ 2
8183 + (char_matches
? 0 : SCHARS (desc
) + 3))
8189 /* Punctuate between strings. */
8192 strcpy (menu
+ i
, ", ");
8198 /* If the char to type doesn't match the string's
8199 first char, explicitly show what char to type. */
8202 /* Add as much of string as fits. */
8203 thiswidth
= SCHARS (desc
);
8204 if (thiswidth
+ i
> width
)
8205 thiswidth
= width
- i
;
8206 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8208 strcpy (menu
+ i
, " = ");
8212 /* Add as much of string as fits. */
8213 thiswidth
= SCHARS (s
);
8214 if (thiswidth
+ i
> width
)
8215 thiswidth
= width
- i
;
8216 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8222 /* If this element does not fit, end the line now,
8223 and save the element for the next line. */
8224 strcpy (menu
+ i
, "...");
8229 /* Move past this element. */
8230 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8231 /* Handle reaching end of dense table. */
8236 rest
= Fcdr_safe (rest
);
8240 /* Prompt with that and read response. */
8241 message2_nolog (menu
, strlen (menu
),
8242 ! NILP (current_buffer
->enable_multibyte_characters
));
8244 /* Make believe its not a keyboard macro in case the help char
8245 is pressed. Help characters are not recorded because menu prompting
8246 is not used on replay.
8248 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8249 current_kboard
->defining_kbd_macro
= Qnil
;
8251 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8252 while (BUFFERP (obj
));
8253 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8255 if (!INTEGERP (obj
))
8260 if (! EQ (obj
, menu_prompt_more_char
)
8261 && (!INTEGERP (menu_prompt_more_char
)
8262 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8264 if (!NILP (current_kboard
->defining_kbd_macro
))
8265 store_kbd_macro_char (obj
);
8268 /* Help char - go round again */
8272 /* Reading key sequences. */
8274 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8275 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8276 keymap, or nil otherwise. Return the index of the first keymap in
8277 which KEY has any binding, or NMAPS if no map has a binding.
8279 If KEY is a meta ASCII character, treat it like meta-prefix-char
8280 followed by the corresponding non-meta character. Keymaps in
8281 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8284 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8287 NEXT may be the same array as CURRENT. */
8290 follow_key (key
, nmaps
, current
, defs
, next
)
8292 Lisp_Object
*current
, *defs
, *next
;
8295 int i
, first_binding
;
8297 first_binding
= nmaps
;
8298 for (i
= nmaps
- 1; i
>= 0; i
--)
8300 if (! NILP (current
[i
]))
8302 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8303 if (! NILP (defs
[i
]))
8310 /* Given the set of bindings we've found, produce the next set of maps. */
8311 if (first_binding
< nmaps
)
8312 for (i
= 0; i
< nmaps
; i
++)
8313 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8315 return first_binding
;
8318 /* Structure used to keep track of partial application of key remapping
8319 such as Vfunction_key_map and Vkey_translation_map. */
8320 typedef struct keyremap
8322 Lisp_Object map
, parent
;
8326 /* Lookup KEY in MAP.
8327 MAP is a keymap mapping keys to key vectors or functions.
8328 If the mapping is a function and DO_FUNCTION is non-zero, then
8329 the function is called with PROMPT as parameter and its return
8330 value is used as the return value of this function (after checking
8331 that it is indeed a vector). */
8334 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8335 Lisp_Object map
, key
, prompt
;
8340 next
= access_keymap (map
, key
, 1, 0, 1);
8342 /* Handle symbol with autoload definition. */
8343 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8344 && CONSP (XSYMBOL (next
)->function
)
8345 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8346 do_autoload (XSYMBOL (next
)->function
, next
);
8348 /* Handle a symbol whose function definition is a keymap
8350 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8351 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8352 || KEYMAPP (XSYMBOL (next
)->function
)))
8353 next
= XSYMBOL (next
)->function
;
8355 /* If the keymap gives a function, not an
8356 array, then call the function with one arg and use
8357 its value instead. */
8358 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8363 next
= call1 (next
, prompt
);
8364 /* If the function returned something invalid,
8365 barf--don't ignore it.
8366 (To ignore it safely, we would need to gcpro a bunch of
8367 other variables.) */
8368 if (! (VECTORP (next
) || STRINGP (next
)))
8369 error ("Function %s returns invalid key sequence", tem
);
8374 /* Do one step of the key remapping used for function-key-map and
8375 key-translation-map:
8376 KEYBUF is the buffer holding the input events.
8377 BUFSIZE is its maximum size.
8378 FKEY is a pointer to the keyremap structure to use.
8379 INPUT is the index of the last element in KEYBUF.
8380 DOIT if non-zero says that the remapping can actually take place.
8381 DIFF is used to return the number of keys added/removed by the remapping.
8382 PARENT is the root of the keymap.
8383 PROMPT is the prompt to use if the remapping happens through a function.
8384 The return value is non-zero if the remapping actually took place. */
8387 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8388 Lisp_Object
*keybuf
, prompt
;
8390 int input
, doit
, *diff
, bufsize
;
8392 Lisp_Object next
, key
;
8394 key
= keybuf
[fkey
->end
++];
8395 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8397 /* If keybuf[fkey->start..fkey->end] is bound in the
8398 map and we're in a position to do the key remapping, replace it with
8399 the binding and restart with fkey->start at the end. */
8400 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8402 int len
= XFASTINT (Flength (next
));
8405 *diff
= len
- (fkey
->end
- fkey
->start
);
8407 if (input
+ *diff
>= bufsize
)
8408 error ("Key sequence too long");
8410 /* Shift the keys that follow fkey->end. */
8412 for (i
= fkey
->end
; i
< input
; i
++)
8413 keybuf
[i
+ *diff
] = keybuf
[i
];
8415 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8416 keybuf
[i
+ *diff
] = keybuf
[i
];
8417 /* Overwrite the old keys with the new ones. */
8418 for (i
= 0; i
< len
; i
++)
8419 keybuf
[fkey
->start
+ i
]
8420 = Faref (next
, make_number (i
));
8422 fkey
->start
= fkey
->end
+= *diff
;
8423 fkey
->map
= fkey
->parent
;
8428 fkey
->map
= get_keymap (next
, 0, 1);
8430 /* If we no longer have a bound suffix, try a new position for
8432 if (!CONSP (fkey
->map
))
8434 fkey
->end
= ++fkey
->start
;
8435 fkey
->map
= fkey
->parent
;
8440 /* Read a sequence of keys that ends with a non prefix character,
8441 storing it in KEYBUF, a buffer of size BUFSIZE.
8443 Return the length of the key sequence stored.
8444 Return -1 if the user rejected a command menu.
8446 Echo starting immediately unless `prompt' is 0.
8448 Where a key sequence ends depends on the currently active keymaps.
8449 These include any minor mode keymaps active in the current buffer,
8450 the current buffer's local map, and the global map.
8452 If a key sequence has no other bindings, we check Vfunction_key_map
8453 to see if some trailing subsequence might be the beginning of a
8454 function key's sequence. If so, we try to read the whole function
8455 key, and substitute its symbolic name into the key sequence.
8457 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8458 `double-' events into similar click events, if that would make them
8459 bound. We try to turn `triple-' events first into `double-' events,
8462 If we get a mouse click in a mode line, vertical divider, or other
8463 non-text area, we treat the click as if it were prefixed by the
8464 symbol denoting that area - `mode-line', `vertical-line', or
8467 If the sequence starts with a mouse click, we read the key sequence
8468 with respect to the buffer clicked on, not the current buffer.
8470 If the user switches frames in the midst of a key sequence, we put
8471 off the switch-frame event until later; the next call to
8472 read_char will return it.
8474 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8475 from the selected window's buffer. */
8478 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8479 can_return_switch_frame
, fix_current_buffer
)
8480 Lisp_Object
*keybuf
;
8483 int dont_downcase_last
;
8484 int can_return_switch_frame
;
8485 int fix_current_buffer
;
8487 volatile Lisp_Object from_string
;
8488 volatile int count
= SPECPDL_INDEX ();
8490 /* How many keys there are in the current key sequence. */
8493 /* The length of the echo buffer when we started reading, and
8494 the length of this_command_keys when we started reading. */
8495 volatile int echo_start
;
8496 volatile int keys_start
;
8498 /* The number of keymaps we're scanning right now, and the number of
8499 keymaps we have allocated space for. */
8501 volatile int nmaps_allocated
= 0;
8503 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8504 the current keymaps. */
8505 Lisp_Object
*volatile defs
= NULL
;
8507 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8508 in the current keymaps, or nil where it is not a prefix. */
8509 Lisp_Object
*volatile submaps
= NULL
;
8511 /* The local map to start out with at start of key sequence. */
8512 volatile Lisp_Object orig_local_map
;
8514 /* The map from the `keymap' property to start out with at start of
8516 volatile Lisp_Object orig_keymap
;
8518 /* 1 if we have already considered switching to the local-map property
8519 of the place where a mouse click occurred. */
8520 volatile int localized_local_map
= 0;
8522 /* The index in defs[] of the first keymap that has a binding for
8523 this key sequence. In other words, the lowest i such that
8524 defs[i] is non-nil. */
8525 volatile int first_binding
;
8526 /* Index of the first key that has no binding.
8527 It is useless to try fkey.start larger than that. */
8528 volatile int first_unbound
;
8530 /* If t < mock_input, then KEYBUF[t] should be read as the next
8533 We use this to recover after recognizing a function key. Once we
8534 realize that a suffix of the current key sequence is actually a
8535 function key's escape sequence, we replace the suffix with the
8536 function key's binding from Vfunction_key_map. Now keybuf
8537 contains a new and different key sequence, so the echo area,
8538 this_command_keys, and the submaps and defs arrays are wrong. In
8539 this situation, we set mock_input to t, set t to 0, and jump to
8540 restart_sequence; the loop will read keys from keybuf up until
8541 mock_input, thus rebuilding the state; and then it will resume
8542 reading characters from the keyboard. */
8543 volatile int mock_input
= 0;
8545 /* If the sequence is unbound in submaps[], then
8546 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8547 and fkey.map is its binding.
8549 These might be > t, indicating that all function key scanning
8550 should hold off until t reaches them. We do this when we've just
8551 recognized a function key, to avoid searching for the function
8552 key's again in Vfunction_key_map. */
8553 volatile keyremap fkey
;
8555 /* Likewise, for key_translation_map. */
8556 volatile keyremap keytran
;
8558 /* If we receive a `switch-frame' or `select-window' event in the middle of
8559 a key sequence, we put it off for later.
8560 While we're reading, we keep the event here. */
8561 volatile Lisp_Object delayed_switch_frame
;
8563 /* See the comment below... */
8564 #if defined (GOBBLE_FIRST_EVENT)
8565 Lisp_Object first_event
;
8568 volatile Lisp_Object original_uppercase
;
8569 volatile int original_uppercase_position
= -1;
8571 /* Gets around Microsoft compiler limitations. */
8574 struct buffer
*starting_buffer
;
8576 /* List of events for which a fake prefix key has been generated. */
8577 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8579 #if defined (GOBBLE_FIRST_EVENT)
8583 struct gcpro gcpro1
;
8585 GCPRO1 (fake_prefixed_keys
);
8586 raw_keybuf_count
= 0;
8588 last_nonmenu_event
= Qnil
;
8590 delayed_switch_frame
= Qnil
;
8591 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8592 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8593 /* If there is no translation-map, turn off scanning. */
8594 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8595 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8600 echo_prompt (prompt
);
8601 else if (cursor_in_echo_area
8602 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8603 && NILP (Fzerop (Vecho_keystrokes
)))
8604 /* This doesn't put in a dash if the echo buffer is empty, so
8605 you don't always see a dash hanging out in the minibuffer. */
8609 /* Record the initial state of the echo area and this_command_keys;
8610 we will need to restore them if we replay a key sequence. */
8612 echo_start
= echo_length ();
8613 keys_start
= this_command_key_count
;
8614 this_single_command_key_start
= keys_start
;
8616 #if defined (GOBBLE_FIRST_EVENT)
8617 /* This doesn't quite work, because some of the things that read_char
8618 does cannot safely be bypassed. It seems too risky to try to make
8621 /* Read the first char of the sequence specially, before setting
8622 up any keymaps, in case a filter runs and switches buffers on us. */
8623 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8625 #endif /* GOBBLE_FIRST_EVENT */
8627 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8628 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8631 /* We jump here when the key sequence has been thoroughly changed, and
8632 we need to rescan it starting from the beginning. When we jump here,
8633 keybuf[0..mock_input] holds the sequence we should reread. */
8636 starting_buffer
= current_buffer
;
8637 first_unbound
= bufsize
+ 1;
8639 /* Build our list of keymaps.
8640 If we recognize a function key and replace its escape sequence in
8641 keybuf with its symbol, or if the sequence starts with a mouse
8642 click and we need to switch buffers, we jump back here to rebuild
8643 the initial keymaps from the current buffer. */
8646 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8647 || !NILP (Voverriding_local_map
))
8649 if (3 > nmaps_allocated
)
8651 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8652 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8653 nmaps_allocated
= 3;
8655 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8656 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8657 if (!NILP (Voverriding_local_map
))
8658 submaps
[nmaps
++] = Voverriding_local_map
;
8666 nminor
= current_minor_maps (0, &maps
);
8667 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8669 if (total
> nmaps_allocated
)
8671 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8672 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8673 nmaps_allocated
= total
;
8676 if (!NILP (orig_keymap
))
8677 submaps
[nmaps
++] = orig_keymap
;
8679 bcopy (maps
, (void *) (submaps
+ nmaps
),
8680 nminor
* sizeof (submaps
[0]));
8684 submaps
[nmaps
++] = orig_local_map
;
8686 submaps
[nmaps
++] = current_global_map
;
8688 /* Find an accurate initial value for first_binding. */
8689 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8690 if (! NILP (submaps
[first_binding
]))
8693 /* Start from the beginning in keybuf. */
8696 /* These are no-ops the first time through, but if we restart, they
8697 revert the echo area and this_command_keys to their original state. */
8698 this_command_key_count
= keys_start
;
8699 if (INTERACTIVE
&& t
< mock_input
)
8700 echo_truncate (echo_start
);
8702 /* If the best binding for the current key sequence is a keymap, or
8703 we may be looking at a function key's escape sequence, keep on
8705 while (first_binding
< nmaps
8706 /* Keep reading as long as there's a prefix binding. */
8707 ? !NILP (submaps
[first_binding
])
8708 /* Don't return in the middle of a possible function key sequence,
8709 if the only bindings we found were via case conversion.
8710 Thus, if ESC O a has a function-key-map translation
8711 and ESC o has a binding, don't return after ESC O,
8712 so that we can translate ESC O plus the next character. */
8713 : (fkey
.start
< t
|| keytran
.start
< t
))
8716 int used_mouse_menu
= 0;
8718 /* Where the last real key started. If we need to throw away a
8719 key that has expanded into more than one element of keybuf
8720 (say, a mouse click on the mode line which is being treated
8721 as [mode-line (mouse-...)], then we backtrack to this point
8723 volatile int last_real_key_start
;
8725 /* These variables are analogous to echo_start and keys_start;
8726 while those allow us to restart the entire key sequence,
8727 echo_local_start and keys_local_start allow us to throw away
8729 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8731 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8732 eassert (fkey
.start
<= fkey
.end
);
8733 eassert (keytran
.start
<= keytran
.end
);
8734 /* key-translation-map is applied *after* function-key-map. */
8735 eassert (keytran
.end
<= fkey
.start
);
8737 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8738 { /* The prefix upto first_unbound has no binding and has
8739 no translation left to do either, so we know it's unbound.
8740 If we don't stop now, we risk staying here indefinitely
8741 (if the user keeps entering fkey or keytran prefixes
8742 like C-c ESC ESC ESC ESC ...) */
8744 for (i
= first_unbound
+ 1; i
< t
; i
++)
8745 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8746 mock_input
= t
- first_unbound
- 1;
8747 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8748 fkey
.map
= fkey
.parent
;
8749 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8750 keytran
.map
= keytran
.parent
;
8751 goto replay_sequence
;
8755 error ("Key sequence too long");
8758 echo_local_start
= echo_length ();
8759 keys_local_start
= this_command_key_count
;
8760 local_first_binding
= first_binding
;
8763 /* These are no-ops, unless we throw away a keystroke below and
8764 jumped back up to replay_key; in that case, these restore the
8765 variables to their original state, allowing us to replay the
8767 if (INTERACTIVE
&& t
< mock_input
)
8768 echo_truncate (echo_local_start
);
8769 this_command_key_count
= keys_local_start
;
8770 first_binding
= local_first_binding
;
8772 /* By default, assume each event is "real". */
8773 last_real_key_start
= t
;
8775 /* Does mock_input indicate that we are re-reading a key sequence? */
8779 add_command_key (key
);
8780 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8781 && NILP (Fzerop (Vecho_keystrokes
)))
8785 /* If not, we should actually read a character. */
8790 KBOARD
*interrupted_kboard
= current_kboard
;
8791 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8792 if (setjmp (wrong_kboard_jmpbuf
))
8794 if (!NILP (delayed_switch_frame
))
8796 interrupted_kboard
->kbd_queue
8797 = Fcons (delayed_switch_frame
,
8798 interrupted_kboard
->kbd_queue
);
8799 delayed_switch_frame
= Qnil
;
8802 interrupted_kboard
->kbd_queue
8803 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8805 /* If the side queue is non-empty, ensure it begins with a
8806 switch-frame, so we'll replay it in the right context. */
8807 if (CONSP (interrupted_kboard
->kbd_queue
)
8808 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8809 !(EVENT_HAS_PARAMETERS (key
)
8810 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8814 XSETFRAME (frame
, interrupted_frame
);
8815 interrupted_kboard
->kbd_queue
8816 = Fcons (make_lispy_switch_frame (frame
),
8817 interrupted_kboard
->kbd_queue
);
8820 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8821 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8822 goto replay_sequence
;
8825 key
= read_char (NILP (prompt
), nmaps
,
8826 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8830 /* read_char returns t when it shows a menu and the user rejects it.
8834 unbind_to (count
, Qnil
);
8839 /* read_char returns -1 at the end of a macro.
8840 Emacs 18 handles this by returning immediately with a
8841 zero, so that's what we'll do. */
8842 if (INTEGERP (key
) && XINT (key
) == -1)
8845 /* The Microsoft C compiler can't handle the goto that
8851 /* If the current buffer has been changed from under us, the
8852 keymap may have changed, so replay the sequence. */
8855 EMACS_TIME initial_idleness_start_time
;
8856 EMACS_SET_SECS_USECS (initial_idleness_start_time
,
8857 EMACS_SECS (timer_last_idleness_start_time
),
8858 EMACS_USECS (timer_last_idleness_start_time
));
8860 /* Resume idle state, using the same start-time as before. */
8861 timer_start_idle ();
8862 timer_idleness_start_time
= initial_idleness_start_time
;
8865 /* Reset the current buffer from the selected window
8866 in case something changed the former and not the latter.
8867 This is to be more consistent with the behavior
8868 of the command_loop_1. */
8869 if (fix_current_buffer
)
8871 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8873 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8874 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8877 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8878 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8879 goto replay_sequence
;
8882 /* If we have a quit that was typed in another frame, and
8883 quit_throw_to_read_char switched buffers,
8884 replay to get the right keymap. */
8886 && XINT (key
) == quit_char
8887 && current_buffer
!= starting_buffer
)
8890 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8894 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8895 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8896 goto replay_sequence
;
8901 if (EVENT_HAS_PARAMETERS (key
)
8902 /* Either a `switch-frame' or a `select-window' event. */
8903 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8905 /* If we're at the beginning of a key sequence, and the caller
8906 says it's okay, go ahead and return this event. If we're
8907 in the midst of a key sequence, delay it until the end. */
8908 if (t
> 0 || !can_return_switch_frame
)
8910 delayed_switch_frame
= key
;
8916 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8919 /* Clicks in non-text areas get prefixed by the symbol
8920 in their CHAR-ADDRESS field. For example, a click on
8921 the mode line is prefixed by the symbol `mode-line'.
8923 Furthermore, key sequences beginning with mouse clicks
8924 are read using the keymaps of the buffer clicked on, not
8925 the current buffer. So we may have to switch the buffer
8928 When we turn one event into two events, we must make sure
8929 that neither of the two looks like the original--so that,
8930 if we replay the events, they won't be expanded again.
8931 If not for this, such reexpansion could happen either here
8932 or when user programs play with this-command-keys. */
8933 if (EVENT_HAS_PARAMETERS (key
))
8937 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8938 if (EQ (kind
, Qmouse_click
))
8940 Lisp_Object window
, posn
;
8942 window
= POSN_WINDOW (EVENT_START (key
));
8943 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
8946 || (!NILP (fake_prefixed_keys
)
8947 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8949 /* We're looking a second time at an event for which
8950 we generated a fake prefix key. Set
8951 last_real_key_start appropriately. */
8953 last_real_key_start
= t
- 1;
8956 /* Key sequences beginning with mouse clicks are
8957 read using the keymaps in the buffer clicked on,
8958 not the current buffer. If we're at the
8959 beginning of a key sequence, switch buffers. */
8960 if (last_real_key_start
== 0
8962 && BUFFERP (XWINDOW (window
)->buffer
)
8963 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8965 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8969 /* Arrange to go back to the original buffer once we're
8970 done reading the key sequence. Note that we can't
8971 use save_excursion_{save,restore} here, because they
8972 save point as well as the current buffer; we don't
8973 want to save point, because redisplay may change it,
8974 to accommodate a Fset_window_start or something. We
8975 don't want to do this at the top of the function,
8976 because we may get input from a subprocess which
8977 wants to change the selected window and stuff (say,
8979 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8981 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8983 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8984 orig_local_map
= get_local_map (PT
, current_buffer
,
8986 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8987 goto replay_sequence
;
8990 /* For a mouse click, get the local text-property keymap
8991 of the place clicked on, rather than point. */
8992 if (last_real_key_start
== 0
8993 && CONSP (XCDR (key
))
8994 && ! localized_local_map
)
8996 Lisp_Object map_here
, start
, pos
;
8998 localized_local_map
= 1;
8999 start
= EVENT_START (key
);
9001 if (CONSP (start
) && CONSP (XCDR (start
)))
9003 pos
= POSN_BUFFER_POSN (start
);
9005 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9007 map_here
= get_local_map (XINT (pos
),
9008 current_buffer
, Qlocal_map
);
9009 if (!EQ (map_here
, orig_local_map
))
9011 orig_local_map
= map_here
;
9015 goto replay_sequence
;
9017 map_here
= get_local_map (XINT (pos
),
9018 current_buffer
, Qkeymap
);
9019 if (!EQ (map_here
, orig_keymap
))
9021 orig_keymap
= map_here
;
9025 goto replay_sequence
;
9031 /* Expand mode-line and scroll-bar events into two events:
9032 use posn as a fake prefix key. */
9034 && (NILP (fake_prefixed_keys
)
9035 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9037 if (t
+ 1 >= bufsize
)
9038 error ("Key sequence too long");
9041 keybuf
[t
+ 1] = key
;
9044 /* Record that a fake prefix key has been generated
9045 for KEY. Don't modify the event; this would
9046 prevent proper action when the event is pushed
9047 back into unread-command-events. */
9048 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9050 /* If on a mode line string with a local keymap,
9051 reconsider the key sequence with that keymap. */
9052 if (CONSP (POSN_STRING (EVENT_START (key
))))
9054 Lisp_Object string
, pos
, map
, map2
;
9056 string
= POSN_STRING (EVENT_START (key
));
9057 pos
= XCDR (string
);
9058 string
= XCAR (string
);
9060 && XINT (pos
) < SCHARS (string
))
9062 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9064 orig_local_map
= map
;
9065 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9068 if (!NILP (map
) || !NILP (map2
))
9069 goto replay_sequence
;
9075 else if (CONSP (POSN_STRING (EVENT_START (key
)))
9076 && NILP (from_string
))
9078 /* For a click on a string, i.e. overlay string or a
9079 string displayed via the `display' property,
9080 consider `local-map' and `keymap' properties of
9082 Lisp_Object string
, pos
, map
, map2
;
9084 string
= POSN_STRING (EVENT_START (key
));
9085 pos
= XCDR (string
);
9086 string
= XCAR (string
);
9088 && XINT (pos
) < SCHARS (string
))
9090 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9092 orig_local_map
= map
;
9093 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9097 if (!NILP (map
) || !NILP (map2
))
9099 from_string
= string
;
9100 goto replay_sequence
;
9105 else if (CONSP (XCDR (key
))
9106 && CONSP (EVENT_START (key
))
9107 && CONSP (XCDR (EVENT_START (key
))))
9111 posn
= POSN_BUFFER_POSN (EVENT_START (key
));
9112 /* Handle menu-bar events:
9113 insert the dummy prefix event `menu-bar'. */
9114 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9116 if (t
+ 1 >= bufsize
)
9117 error ("Key sequence too long");
9121 /* Zap the position in key, so we know that we've
9122 expanded it, and don't try to do so again. */
9123 POSN_BUFFER_SET_POSN (EVENT_START (key
),
9124 Fcons (posn
, Qnil
));
9127 goto replay_sequence
;
9129 else if (CONSP (posn
))
9131 /* We're looking at the second event of a
9132 sequence which we expanded before. Set
9133 last_real_key_start appropriately. */
9134 if (last_real_key_start
== t
&& t
> 0)
9135 last_real_key_start
= t
- 1;
9140 /* We have finally decided that KEY is something we might want
9142 first_binding
= (follow_key (key
,
9143 nmaps
- first_binding
,
9144 submaps
+ first_binding
,
9145 defs
+ first_binding
,
9146 submaps
+ first_binding
)
9149 /* If KEY wasn't bound, we'll try some fallbacks. */
9150 if (first_binding
< nmaps
)
9151 /* This is needed for the following scenario:
9152 event 0: a down-event that gets dropped by calling replay_key.
9153 event 1: some normal prefix like C-h.
9154 After event 0, first_unbound is 0, after event 1 fkey.start
9155 and keytran.start are both 1, so when we see that C-h is bound,
9156 we need to update first_unbound. */
9157 first_unbound
= max (t
+ 1, first_unbound
);
9162 /* Remember the position to put an upper bound on fkey.start. */
9163 first_unbound
= min (t
, first_unbound
);
9165 head
= EVENT_HEAD (key
);
9166 if (help_char_p (head
) && t
> 0)
9168 read_key_sequence_cmd
= Vprefix_help_command
;
9170 last_nonmenu_event
= key
;
9171 /* The Microsoft C compiler can't handle the goto that
9179 Lisp_Object breakdown
;
9182 breakdown
= parse_modifiers (head
);
9183 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9184 /* Attempt to reduce an unbound mouse event to a simpler
9185 event that is bound:
9186 Drags reduce to clicks.
9187 Double-clicks reduce to clicks.
9188 Triple-clicks reduce to double-clicks, then to clicks.
9189 Down-clicks are eliminated.
9190 Double-downs reduce to downs, then are eliminated.
9191 Triple-downs reduce to double-downs, then to downs,
9192 then are eliminated. */
9193 if (modifiers
& (down_modifier
| drag_modifier
9194 | double_modifier
| triple_modifier
))
9196 while (modifiers
& (down_modifier
| drag_modifier
9197 | double_modifier
| triple_modifier
))
9199 Lisp_Object new_head
, new_click
;
9200 if (modifiers
& triple_modifier
)
9201 modifiers
^= (double_modifier
| triple_modifier
);
9202 else if (modifiers
& double_modifier
)
9203 modifiers
&= ~double_modifier
;
9204 else if (modifiers
& drag_modifier
)
9205 modifiers
&= ~drag_modifier
;
9208 /* Dispose of this `down' event by simply jumping
9209 back to replay_key, to get another event.
9211 Note that if this event came from mock input,
9212 then just jumping back to replay_key will just
9213 hand it to us again. So we have to wipe out any
9216 We could delete keybuf[t] and shift everything
9217 after that to the left by one spot, but we'd also
9218 have to fix up any variable that points into
9219 keybuf, and shifting isn't really necessary
9222 Adding prefixes for non-textual mouse clicks
9223 creates two characters of mock input, and both
9224 must be thrown away. If we're only looking at
9225 the prefix now, we can just jump back to
9226 replay_key. On the other hand, if we've already
9227 processed the prefix, and now the actual click
9228 itself is giving us trouble, then we've lost the
9229 state of the keymaps we want to backtrack to, and
9230 we need to replay the whole sequence to rebuild
9233 Beyond that, only function key expansion could
9234 create more than two keys, but that should never
9235 generate mouse events, so it's okay to zero
9236 mock_input in that case too.
9238 FIXME: The above paragraph seems just plain
9239 wrong, if you consider things like
9240 xterm-mouse-mode. -stef
9242 Isn't this just the most wonderful code ever? */
9244 /* If mock_input > t + 1, the above simplification
9245 will actually end up dropping keys on the floor.
9246 This is probably OK for now, but even
9247 if mock_input <= t + 1, we need to adjust fkey
9249 Typical case [header-line down-mouse-N]:
9250 mock_input = 2, t = 1, fkey.end = 1,
9251 last_real_key_start = 0. */
9252 if (fkey
.end
> last_real_key_start
)
9254 fkey
.end
= fkey
.start
9255 = min (last_real_key_start
, fkey
.start
);
9256 fkey
.map
= fkey
.parent
;
9257 if (keytran
.end
> last_real_key_start
)
9259 keytran
.end
= keytran
.start
9260 = min (last_real_key_start
, keytran
.start
);
9261 keytran
.map
= keytran
.parent
;
9264 if (t
== last_real_key_start
)
9271 mock_input
= last_real_key_start
;
9272 goto replay_sequence
;
9277 = apply_modifiers (modifiers
, XCAR (breakdown
));
9279 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9281 /* Look for a binding for this new key. follow_key
9282 promises that it didn't munge submaps the
9283 last time we called it, since key was unbound. */
9285 = (follow_key (new_click
,
9286 nmaps
- local_first_binding
,
9287 submaps
+ local_first_binding
,
9288 defs
+ local_first_binding
,
9289 submaps
+ local_first_binding
)
9290 + local_first_binding
);
9292 /* If that click is bound, go for it. */
9293 if (first_binding
< nmaps
)
9298 /* Otherwise, we'll leave key set to the drag event. */
9305 /* Normally, last_nonmenu_event gets the previous key we read.
9306 But when a mouse popup menu is being used,
9307 we don't update last_nonmenu_event; it continues to hold the mouse
9308 event that preceded the first level of menu. */
9309 if (!used_mouse_menu
)
9310 last_nonmenu_event
= key
;
9312 /* Record what part of this_command_keys is the current key sequence. */
9313 this_single_command_key_start
= this_command_key_count
- t
;
9315 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9316 /* There is a binding and it's not a prefix.
9317 There is thus no function-key in this sequence.
9318 Moving fkey.start is important in this case to allow keytran.start
9319 to go over the sequence before we return (since we keep the
9320 invariant that keytran.end <= fkey.start). */
9323 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9326 /* If the sequence is unbound, see if we can hang a function key
9327 off the end of it. */
9328 /* Continue scan from fkey.end until we find a bound suffix. */
9329 while (fkey
.end
< t
)
9331 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9334 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9335 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9336 max (t
, mock_input
),
9337 /* If there's a binding (i.e.
9338 first_binding >= nmaps) we don't want
9339 to apply this function-key-mapping. */
9340 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9345 mock_input
= diff
+ max (t
, mock_input
);
9346 goto replay_sequence
;
9350 /* Look for this sequence in key-translation-map.
9351 Scan from keytran.end until we find a bound suffix. */
9352 while (keytran
.end
< fkey
.start
)
9354 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9357 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9358 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9363 mock_input
= diff
+ max (t
, mock_input
);
9364 /* Adjust the function-key-map counters. */
9368 goto replay_sequence
;
9372 /* If KEY is not defined in any of the keymaps,
9373 and cannot be part of a function key or translation,
9374 and is an upper case letter
9375 use the corresponding lower-case letter instead. */
9376 if (first_binding
>= nmaps
9377 && fkey
.start
>= t
&& keytran
.start
>= t
9379 && ((((XINT (key
) & 0x3ffff)
9380 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9381 && UPPERCASEP (XINT (key
) & 0x3ffff))
9382 || (XINT (key
) & shift_modifier
)))
9384 Lisp_Object new_key
;
9386 original_uppercase
= key
;
9387 original_uppercase_position
= t
- 1;
9389 if (XINT (key
) & shift_modifier
)
9390 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9392 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9393 | (XINT (key
) & ~0x3ffff)));
9395 /* We have to do this unconditionally, regardless of whether
9396 the lower-case char is defined in the keymaps, because they
9397 might get translated through function-key-map. */
9398 keybuf
[t
- 1] = new_key
;
9399 mock_input
= max (t
, mock_input
);
9401 goto replay_sequence
;
9403 /* If KEY is not defined in any of the keymaps,
9404 and cannot be part of a function key or translation,
9405 and is a shifted function key,
9406 use the corresponding unshifted function key instead. */
9407 if (first_binding
>= nmaps
9408 && fkey
.start
>= t
&& keytran
.start
>= t
9411 Lisp_Object breakdown
;
9414 breakdown
= parse_modifiers (key
);
9415 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9416 if (modifiers
& shift_modifier
)
9418 Lisp_Object new_key
;
9420 original_uppercase
= key
;
9421 original_uppercase_position
= t
- 1;
9423 modifiers
&= ~shift_modifier
;
9424 new_key
= apply_modifiers (modifiers
,
9427 keybuf
[t
- 1] = new_key
;
9428 mock_input
= max (t
, mock_input
);
9429 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9430 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9432 goto replay_sequence
;
9438 read_key_sequence_cmd
= (first_binding
< nmaps
9439 ? defs
[first_binding
]
9442 unread_switch_frame
= delayed_switch_frame
;
9443 unbind_to (count
, Qnil
);
9445 /* Don't downcase the last character if the caller says don't.
9446 Don't downcase it if the result is undefined, either. */
9447 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9448 && t
- 1 == original_uppercase_position
)
9449 keybuf
[t
- 1] = original_uppercase
;
9451 /* Occasionally we fabricate events, perhaps by expanding something
9452 according to function-key-map, or by adding a prefix symbol to a
9453 mouse click in the scroll bar or modeline. In this cases, return
9454 the entire generated key sequence, even if we hit an unbound
9455 prefix or a definition before the end. This means that you will
9456 be able to push back the event properly, and also means that
9457 read-key-sequence will always return a logical unit.
9460 for (; t
< mock_input
; t
++)
9462 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9463 && NILP (Fzerop (Vecho_keystrokes
)))
9464 echo_char (keybuf
[t
]);
9465 add_command_key (keybuf
[t
]);
9474 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9475 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9476 The sequence is sufficient to specify a non-prefix command in the
9477 current local and global maps.
9479 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9480 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9481 as a continuation of the previous key.
9483 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9484 convert the last event to lower case. (Normally any upper case event
9485 is converted to lower case if the original event is undefined and the lower
9486 case equivalent is defined.) A non-nil value is appropriate for reading
9487 a key sequence to be defined.
9489 A C-g typed while in this function is treated like any other character,
9490 and `quit-flag' is not set.
9492 If the key sequence starts with a mouse click, then the sequence is read
9493 using the keymaps of the buffer of the window clicked in, not the buffer
9494 of the selected window as normal.
9496 `read-key-sequence' drops unbound button-down events, since you normally
9497 only care about the click or drag events which follow them. If a drag
9498 or multi-click event is unbound, but the corresponding click event would
9499 be bound, `read-key-sequence' turns the event into a click event at the
9500 drag's starting position. This means that you don't have to distinguish
9501 between click and drag, double, or triple events unless you want to.
9503 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9504 lines separating windows, and scroll bars with imaginary keys
9505 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9507 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9508 function will process a switch-frame event if the user switches frames
9509 before typing anything. If the user switches frames in the middle of a
9510 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9511 is nil, then the event will be put off until after the current key sequence.
9513 `read-key-sequence' checks `function-key-map' for function key
9514 sequences, where they wouldn't conflict with ordinary bindings. See
9515 `function-key-map' for more details.
9517 The optional fifth argument COMMAND-LOOP, if non-nil, means
9518 that this key sequence is being read by something that will
9519 read commands one after another. It should be nil if the caller
9520 will read just one key sequence. */)
9521 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9523 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9524 Lisp_Object can_return_switch_frame
, command_loop
;
9526 Lisp_Object keybuf
[30];
9528 struct gcpro gcpro1
;
9529 int count
= SPECPDL_INDEX ();
9532 CHECK_STRING (prompt
);
9535 specbind (Qinput_method_exit_on_first_char
,
9536 (NILP (command_loop
) ? Qt
: Qnil
));
9537 specbind (Qinput_method_use_echo_area
,
9538 (NILP (command_loop
) ? Qt
: Qnil
));
9540 bzero (keybuf
, sizeof keybuf
);
9542 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9544 if (NILP (continue_echo
))
9546 this_command_key_count
= 0;
9547 this_command_key_count_reset
= 0;
9548 this_single_command_key_start
= 0;
9551 #ifdef HAVE_X_WINDOWS
9552 if (display_hourglass_p
)
9553 cancel_hourglass ();
9556 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9557 prompt
, ! NILP (dont_downcase_last
),
9558 ! NILP (can_return_switch_frame
), 0);
9560 #if 0 /* The following is fine for code reading a key sequence and
9561 then proceeding with a lenghty computation, but it's not good
9562 for code reading keys in a loop, like an input method. */
9563 #ifdef HAVE_X_WINDOWS
9564 if (display_hourglass_p
)
9575 return unbind_to (count
, make_event_array (i
, keybuf
));
9578 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9579 Sread_key_sequence_vector
, 1, 5, 0,
9580 doc
: /* Like `read-key-sequence' but always return a vector. */)
9581 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9583 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9584 Lisp_Object can_return_switch_frame
, command_loop
;
9586 Lisp_Object keybuf
[30];
9588 struct gcpro gcpro1
;
9589 int count
= SPECPDL_INDEX ();
9592 CHECK_STRING (prompt
);
9595 specbind (Qinput_method_exit_on_first_char
,
9596 (NILP (command_loop
) ? Qt
: Qnil
));
9597 specbind (Qinput_method_use_echo_area
,
9598 (NILP (command_loop
) ? Qt
: Qnil
));
9600 bzero (keybuf
, sizeof keybuf
);
9602 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9604 if (NILP (continue_echo
))
9606 this_command_key_count
= 0;
9607 this_command_key_count_reset
= 0;
9608 this_single_command_key_start
= 0;
9611 #ifdef HAVE_X_WINDOWS
9612 if (display_hourglass_p
)
9613 cancel_hourglass ();
9616 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9617 prompt
, ! NILP (dont_downcase_last
),
9618 ! NILP (can_return_switch_frame
), 0);
9620 #ifdef HAVE_X_WINDOWS
9621 if (display_hourglass_p
)
9631 return unbind_to (count
, Fvector (i
, keybuf
));
9634 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9635 doc
: /* Execute CMD as an editor command.
9636 CMD must be a symbol that satisfies the `commandp' predicate.
9637 Optional second arg RECORD-FLAG non-nil
9638 means unconditionally put this command in `command-history'.
9639 Otherwise, that is done only if an arg is read using the minibuffer.
9640 The argument KEYS specifies the value to use instead of (this-command-keys)
9641 when reading the arguments; if it is nil, (this-command-keys) is used.
9642 The argument SPECIAL, if non-nil, means that this command is executing
9643 a special event, so ignore the prefix argument and don't clear it. */)
9644 (cmd
, record_flag
, keys
, special
)
9645 Lisp_Object cmd
, record_flag
, keys
, special
;
9647 register Lisp_Object final
;
9648 register Lisp_Object tem
;
9649 Lisp_Object prefixarg
;
9650 struct backtrace backtrace
;
9651 extern int debug_on_next_call
;
9653 debug_on_next_call
= 0;
9657 prefixarg
= current_kboard
->Vprefix_arg
;
9658 Vcurrent_prefix_arg
= prefixarg
;
9659 current_kboard
->Vprefix_arg
= Qnil
;
9666 tem
= Fget (cmd
, Qdisabled
);
9667 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9669 tem
= Fsymbol_value (Qdisabled_command_hook
);
9671 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9677 final
= Findirect_function (cmd
);
9679 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9681 struct gcpro gcpro1
, gcpro2
;
9683 GCPRO2 (cmd
, prefixarg
);
9684 do_autoload (final
, cmd
);
9691 if (STRINGP (final
) || VECTORP (final
))
9693 /* If requested, place the macro in the command history. For
9694 other sorts of commands, call-interactively takes care of
9696 if (!NILP (record_flag
))
9699 = Fcons (Fcons (Qexecute_kbd_macro
,
9700 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9703 /* Don't keep command history around forever. */
9704 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9706 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9708 XSETCDR (tem
, Qnil
);
9712 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9715 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9717 backtrace
.next
= backtrace_list
;
9718 backtrace_list
= &backtrace
;
9719 backtrace
.function
= &Qcall_interactively
;
9720 backtrace
.args
= &cmd
;
9721 backtrace
.nargs
= 1;
9722 backtrace
.evalargs
= 0;
9724 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9726 backtrace_list
= backtrace
.next
;
9734 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9736 doc
: /* Read function name, then read its arguments and call it. */)
9738 Lisp_Object prefixarg
;
9740 Lisp_Object function
;
9742 int saved_last_point_position
;
9743 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9744 Lisp_Object bindings
, value
;
9745 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9747 saved_keys
= Fvector (this_command_key_count
,
9748 XVECTOR (this_command_keys
)->contents
);
9749 saved_last_point_position_buffer
= last_point_position_buffer
;
9750 saved_last_point_position
= last_point_position
;
9752 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9754 if (EQ (prefixarg
, Qminus
))
9756 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9757 strcpy (buf
, "C-u ");
9758 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9760 if (sizeof (int) == sizeof (EMACS_INT
))
9761 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9762 else if (sizeof (long) == sizeof (EMACS_INT
))
9763 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9767 else if (INTEGERP (prefixarg
))
9769 if (sizeof (int) == sizeof (EMACS_INT
))
9770 sprintf (buf
, "%d ", XINT (prefixarg
));
9771 else if (sizeof (long) == sizeof (EMACS_INT
))
9772 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9777 /* This isn't strictly correct if execute-extended-command
9778 is bound to anything else. Perhaps it should use
9779 this_command_keys? */
9780 strcat (buf
, "M-x ");
9782 /* Prompt with buf, and then read a string, completing from and
9783 restricting to the set of all defined commands. Don't provide
9784 any initial input. Save the command read on the extended-command
9786 function
= Fcompleting_read (build_string (buf
),
9787 Vobarray
, Qcommandp
,
9788 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9791 if (STRINGP (function
) && SCHARS (function
) == 0)
9792 error ("No command name given");
9794 /* Set this_command_keys to the concatenation of saved_keys and
9795 function, followed by a RET. */
9800 this_command_key_count
= 0;
9801 this_command_key_count_reset
= 0;
9802 this_single_command_key_start
= 0;
9804 keys
= XVECTOR (saved_keys
)->contents
;
9805 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9806 add_command_key (keys
[i
]);
9808 for (i
= 0; i
< SCHARS (function
); i
++)
9809 add_command_key (Faref (function
, make_number (i
)));
9811 add_command_key (make_number ('\015'));
9814 last_point_position
= saved_last_point_position
;
9815 last_point_position_buffer
= saved_last_point_position_buffer
;
9819 function
= Fintern (function
, Qnil
);
9820 current_kboard
->Vprefix_arg
= prefixarg
;
9821 Vthis_command
= function
;
9822 real_this_command
= function
;
9824 /* If enabled, show which key runs this command. */
9825 if (!NILP (Vsuggest_key_bindings
)
9826 && NILP (Vexecuting_macro
)
9827 && SYMBOLP (function
))
9828 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9834 GCPRO2 (bindings
, value
);
9835 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9837 /* If the command has a key binding, print it now. */
9838 if (!NILP (bindings
)
9839 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9842 /* But first wait, and skip the message if there is input. */
9844 if (!NILP (echo_area_buffer
[0]))
9845 /* This command displayed something in the echo area;
9846 so wait a few seconds, then display our suggestion message. */
9847 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9848 ? XINT (Vsuggest_key_bindings
) : 2);
9850 /* This command left the echo area empty,
9851 so display our message immediately. */
9854 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9855 && ! CONSP (Vunread_command_events
))
9857 Lisp_Object binding
;
9859 int message_p
= push_message ();
9860 int count
= SPECPDL_INDEX ();
9862 record_unwind_protect (pop_message_unwind
, Qnil
);
9863 binding
= Fkey_description (bindings
);
9866 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9869 sprintf (newmessage
, "You can run the command `%s' with %s",
9870 SDATA (SYMBOL_NAME (function
)),
9872 message2_nolog (newmessage
,
9873 strlen (newmessage
),
9874 STRING_MULTIBYTE (binding
));
9875 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9876 ? Vsuggest_key_bindings
: make_number (2)),
9881 unbind_to (count
, Qnil
);
9885 RETURN_UNGCPRO (value
);
9889 /* Return nonzero if input events are pending. */
9892 detect_input_pending ()
9895 get_input_pending (&input_pending
, 0);
9897 return input_pending
;
9900 /* Return nonzero if input events are pending, and run any pending timers. */
9903 detect_input_pending_run_timers (do_display
)
9906 int old_timers_run
= timers_run
;
9909 get_input_pending (&input_pending
, 1);
9911 if (old_timers_run
!= timers_run
&& do_display
)
9913 redisplay_preserve_echo_area (8);
9914 /* The following fixes a bug when using lazy-lock with
9915 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9916 from an idle timer function. The symptom of the bug is that
9917 the cursor sometimes doesn't become visible until the next X
9918 event is processed. --gerd. */
9920 rif
->flush_display (NULL
);
9923 return input_pending
;
9926 /* This is called in some cases before a possible quit.
9927 It cases the next call to detect_input_pending to recompute input_pending.
9928 So calling this function unnecessarily can't do any harm. */
9931 clear_input_pending ()
9936 /* Return nonzero if there are pending requeued events.
9937 This isn't used yet. The hope is to make wait_reading_process_input
9938 call it, and return if it runs Lisp code that unreads something.
9939 The problem is, kbd_buffer_get_event needs to be fixed to know what
9940 to do in that case. It isn't trivial. */
9943 requeued_events_pending_p ()
9945 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9949 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9950 doc
: /* Return t if command input is currently available with no wait.
9951 Actually, the value is nil only if we can be sure that no input is available;
9952 if there is a doubt, the value is t. */)
9955 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9958 get_filtered_input_pending (&input_pending
, 1, 1);
9959 return input_pending
> 0 ? Qt
: Qnil
;
9962 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9963 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9966 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9969 if (total_keys
< NUM_RECENT_KEYS
)
9970 return Fvector (total_keys
, keys
);
9973 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9974 bcopy (keys
+ recent_keys_index
,
9975 XVECTOR (val
)->contents
,
9976 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9978 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9979 recent_keys_index
* sizeof (Lisp_Object
));
9984 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9985 doc
: /* Return the key sequence that invoked this command.
9986 However, if the command has called `read-key-sequence', it returns
9987 the last key sequence that has been read.
9988 The value is a string or a vector. */)
9991 return make_event_array (this_command_key_count
,
9992 XVECTOR (this_command_keys
)->contents
);
9995 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9996 doc
: /* Return the key sequence that invoked this command, as a vector.
9997 However, if the command has called `read-key-sequence', it returns
9998 the last key sequence that has been read. */)
10001 return Fvector (this_command_key_count
,
10002 XVECTOR (this_command_keys
)->contents
);
10005 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10006 Sthis_single_command_keys
, 0, 0, 0,
10007 doc
: /* Return the key sequence that invoked this command.
10008 More generally, it returns the last key sequence read, either by
10009 the command loop or by `read-key-sequence'.
10010 Unlike `this-command-keys', this function's value
10011 does not include prefix arguments.
10012 The value is always a vector. */)
10015 return Fvector (this_command_key_count
10016 - this_single_command_key_start
,
10017 (XVECTOR (this_command_keys
)->contents
10018 + this_single_command_key_start
));
10021 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10022 Sthis_single_command_raw_keys
, 0, 0, 0,
10023 doc
: /* Return the raw events that were read for this command.
10024 More generally, it returns the last key sequence read, either by
10025 the command loop or by `read-key-sequence'.
10026 Unlike `this-single-command-keys', this function's value
10027 shows the events before all translations (except for input methods).
10028 The value is always a vector. */)
10031 return Fvector (raw_keybuf_count
,
10032 (XVECTOR (raw_keybuf
)->contents
));
10035 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10036 Sreset_this_command_lengths
, 0, 0, 0,
10037 doc
: /* Make the unread events replace the last command and echo.
10038 Used in `universal-argument-other-key'.
10040 `universal-argument-other-key' rereads the event just typed.
10041 It then gets translated through `function-key-map'.
10042 The translated event has to replace the real events,
10043 both in the value of (this-command-keys) and in echoing.
10044 To achieve this, `universal-argument-other-key' calls
10045 `reset-this-command-lengths', which discards the record of reading
10046 these events the first time. */)
10049 this_command_key_count
= before_command_key_count
;
10050 if (this_command_key_count
< this_single_command_key_start
)
10051 this_single_command_key_start
= this_command_key_count
;
10053 echo_truncate (before_command_echo_length
);
10055 /* Cause whatever we put into unread-command-events
10056 to echo as if it were being freshly read from the keyboard. */
10057 this_command_key_count_reset
= 1;
10062 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10063 Sclear_this_command_keys
, 0, 1, 0,
10064 doc
: /* Clear out the vector that `this-command-keys' returns.
10065 Also clear the record of the last 100 events, unless optional arg
10066 KEEP-RECORD is non-nil. */)
10068 Lisp_Object keep_record
;
10072 this_command_key_count
= 0;
10073 this_command_key_count_reset
= 0;
10075 if (NILP (keep_record
))
10077 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10078 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10080 recent_keys_index
= 0;
10085 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10086 doc
: /* Return the current depth in recursive edits. */)
10090 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10094 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10095 "FOpen dribble file: ",
10096 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10097 If FILE is nil, close any open dribble file. */)
10108 file
= Fexpand_file_name (file
, Qnil
);
10109 dribble
= fopen (SDATA (file
), "w");
10111 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10116 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10117 doc
: /* Discard the contents of the terminal input buffer.
10118 Also end any kbd macro being defined. */)
10121 if (!NILP (current_kboard
->defining_kbd_macro
))
10123 /* Discard the last command from the macro. */
10124 Fcancel_kbd_macro_events ();
10128 update_mode_lines
++;
10130 Vunread_command_events
= Qnil
;
10131 unread_command_char
= -1;
10133 discard_tty_input ();
10135 kbd_fetch_ptr
= kbd_store_ptr
;
10136 Ffillarray (kbd_buffer_gcpro
, Qnil
);
10142 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10143 doc
: /* Stop Emacs and return to superior process. You can resume later.
10144 If `cannot-suspend' is non-nil, or if the system doesn't support job
10145 control, run a subshell instead.
10147 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10148 to be read as terminal input by Emacs's parent, after suspension.
10150 Before suspending, run the normal hook `suspend-hook'.
10151 After resumption run the normal hook `suspend-resume-hook'.
10153 Some operating systems cannot stop the Emacs process and resume it later.
10154 On such systems, Emacs starts a subshell instead of suspending. */)
10156 Lisp_Object stuffstring
;
10158 int count
= SPECPDL_INDEX ();
10159 int old_height
, old_width
;
10161 struct gcpro gcpro1
;
10163 if (!NILP (stuffstring
))
10164 CHECK_STRING (stuffstring
);
10166 /* Run the functions in suspend-hook. */
10167 if (!NILP (Vrun_hooks
))
10168 call1 (Vrun_hooks
, intern ("suspend-hook"));
10170 GCPRO1 (stuffstring
);
10171 get_frame_size (&old_width
, &old_height
);
10172 reset_sys_modes ();
10173 /* sys_suspend can get an error if it tries to fork a subshell
10174 and the system resources aren't available for that. */
10175 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10177 stuff_buffered_input (stuffstring
);
10178 if (cannot_suspend
)
10182 unbind_to (count
, Qnil
);
10184 /* Check if terminal/window size has changed.
10185 Note that this is not useful when we are running directly
10186 with a window system; but suspend should be disabled in that case. */
10187 get_frame_size (&width
, &height
);
10188 if (width
!= old_width
|| height
!= old_height
)
10189 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10191 /* Run suspend-resume-hook. */
10192 if (!NILP (Vrun_hooks
))
10193 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10199 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10200 Then in any case stuff anything Emacs has read ahead and not used. */
10203 stuff_buffered_input (stuffstring
)
10204 Lisp_Object stuffstring
;
10206 /* stuff_char works only in BSD, versions 4.2 and up. */
10209 register unsigned char *p
;
10211 if (STRINGP (stuffstring
))
10213 register int count
;
10215 p
= SDATA (stuffstring
);
10216 count
= SBYTES (stuffstring
);
10217 while (count
-- > 0)
10222 /* Anything we have read ahead, put back for the shell to read. */
10223 /* ?? What should this do when we have multiple keyboards??
10224 Should we ignore anything that was typed in at the "wrong" kboard? */
10225 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10229 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10230 kbd_fetch_ptr
= kbd_buffer
;
10231 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10232 stuff_char (kbd_fetch_ptr
->code
);
10234 kbd_fetch_ptr
->kind
= NO_EVENT
;
10235 idx
= 2 * (kbd_fetch_ptr
- kbd_buffer
);
10236 ASET (kbd_buffer_gcpro
, idx
, Qnil
);
10237 ASET (kbd_buffer_gcpro
, idx
+ 1, Qnil
);
10242 #endif /* BSD_SYSTEM and not BSD4_1 */
10246 set_waiting_for_input (time_to_clear
)
10247 EMACS_TIME
*time_to_clear
;
10249 input_available_clear_time
= time_to_clear
;
10251 /* Tell interrupt_signal to throw back to read_char, */
10252 waiting_for_input
= 1;
10254 /* If interrupt_signal was called before and buffered a C-g,
10255 make it run again now, to avoid timing error. */
10256 if (!NILP (Vquit_flag
))
10257 quit_throw_to_read_char ();
10261 clear_waiting_for_input ()
10263 /* Tell interrupt_signal not to throw back to read_char, */
10264 waiting_for_input
= 0;
10265 input_available_clear_time
= 0;
10268 /* This routine is called at interrupt level in response to C-g.
10270 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10271 is called from kbd_buffer_store_event, in handling SIGIO or
10274 If `waiting_for_input' is non zero, then unless `echoing' is
10275 nonzero, immediately throw back to read_char.
10277 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10278 eval to throw, when it gets a chance. If quit-flag is already
10279 non-nil, it stops the job right away. */
10282 interrupt_signal (signalnum
) /* If we don't have an argument, */
10283 int signalnum
; /* some compilers complain in signal calls. */
10286 /* Must preserve main program's value of errno. */
10287 int old_errno
= errno
;
10288 struct frame
*sf
= SELECTED_FRAME ();
10290 #if defined (USG) && !defined (POSIX_SIGNALS)
10291 if (!read_socket_hook
&& NILP (Vwindow_system
))
10293 /* USG systems forget handlers when they are used;
10294 must reestablish each time */
10295 signal (SIGINT
, interrupt_signal
);
10296 signal (SIGQUIT
, interrupt_signal
);
10302 if (!NILP (Vquit_flag
)
10303 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10305 /* If SIGINT isn't blocked, don't let us be interrupted by
10306 another SIGINT, it might be harmful due to non-reentrancy
10307 in I/O functions. */
10308 sigblock (sigmask (SIGINT
));
10311 reset_sys_modes ();
10313 #ifdef SIGTSTP /* Support possible in later USG versions */
10315 * On systems which can suspend the current process and return to the original
10316 * shell, this command causes the user to end up back at the shell.
10317 * The "Auto-save" and "Abort" questions are not asked until
10318 * the user elects to return to emacs, at which point he can save the current
10319 * job and either dump core or continue.
10324 if (sys_suspend () == -1)
10326 printf ("Not running as a subprocess;\n");
10327 printf ("you can continue or abort.\n");
10329 #else /* not VMS */
10330 /* Perhaps should really fork an inferior shell?
10331 But that would not provide any way to get back
10332 to the original shell, ever. */
10333 printf ("No support for stopping a process on this operating system;\n");
10334 printf ("you can continue or abort.\n");
10335 #endif /* not VMS */
10336 #endif /* not SIGTSTP */
10338 /* We must remain inside the screen area when the internal terminal
10339 is used. Note that [Enter] is not echoed by dos. */
10342 /* It doesn't work to autosave while GC is in progress;
10343 the code used for auto-saving doesn't cope with the mark bit. */
10344 if (!gc_in_progress
)
10346 printf ("Auto-save? (y or n) ");
10348 if (((c
= getchar ()) & ~040) == 'Y')
10350 Fdo_auto_save (Qt
, Qnil
);
10352 printf ("\r\nAuto-save done");
10353 #else /* not MSDOS */
10354 printf ("Auto-save done\n");
10355 #endif /* not MSDOS */
10357 while (c
!= '\n') c
= getchar ();
10361 /* During GC, it must be safe to reenable quitting again. */
10362 Vinhibit_quit
= Qnil
;
10365 #endif /* not MSDOS */
10366 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10367 printf ("but will instead do a real quit after garbage collection ends\r\n");
10372 printf ("\r\nAbort? (y or n) ");
10373 #else /* not MSDOS */
10375 printf ("Abort (and enter debugger)? (y or n) ");
10376 #else /* not VMS */
10377 printf ("Abort (and dump core)? (y or n) ");
10378 #endif /* not VMS */
10379 #endif /* not MSDOS */
10381 if (((c
= getchar ()) & ~040) == 'Y')
10383 while (c
!= '\n') c
= getchar ();
10385 printf ("\r\nContinuing...\r\n");
10386 #else /* not MSDOS */
10387 printf ("Continuing...\n");
10388 #endif /* not MSDOS */
10395 /* If executing a function that wants to be interrupted out of
10396 and the user has not deferred quitting by binding `inhibit-quit'
10397 then quit right away. */
10398 if (immediate_quit
&& NILP (Vinhibit_quit
))
10400 struct gl_state_s saved
;
10401 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10403 immediate_quit
= 0;
10406 GCPRO4 (saved
.object
, saved
.global_code
,
10407 saved
.current_syntax_table
, saved
.old_prop
);
10408 Fsignal (Qquit
, Qnil
);
10413 /* Else request quit when it's safe */
10417 if (waiting_for_input
&& !echoing
)
10418 quit_throw_to_read_char ();
10423 /* Handle a C-g by making read_char return C-g. */
10426 quit_throw_to_read_char ()
10429 /* Prevent another signal from doing this before we finish. */
10430 clear_waiting_for_input ();
10433 Vunread_command_events
= Qnil
;
10434 unread_command_char
= -1;
10436 #if 0 /* Currently, sit_for is called from read_char without turning
10437 off polling. And that can call set_waiting_for_input.
10438 It seems to be harmless. */
10439 #ifdef POLL_FOR_INPUT
10440 /* May be > 1 if in recursive minibuffer. */
10441 if (poll_suppress_count
== 0)
10445 if (FRAMEP (internal_last_event_frame
)
10446 && !EQ (internal_last_event_frame
, selected_frame
))
10447 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10450 _longjmp (getcjmp
, 1);
10453 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10454 doc
: /* Set mode of reading keyboard input.
10455 First arg INTERRUPT non-nil means use input interrupts;
10456 nil means use CBREAK mode.
10457 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10458 (no effect except in CBREAK mode).
10459 Third arg META t means accept 8-bit input (for a Meta key).
10460 META nil means ignore the top bit, on the assumption it is parity.
10461 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10462 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10463 See also `current-input-mode'. */)
10464 (interrupt
, flow
, meta
, quit
)
10465 Lisp_Object interrupt
, flow
, meta
, quit
;
10468 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10469 error ("set-input-mode: QUIT must be an ASCII character");
10471 #ifdef POLL_FOR_INPUT
10476 /* this causes startup screen to be restored and messes with the mouse */
10477 reset_sys_modes ();
10481 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10482 if (read_socket_hook
)
10484 /* When using X, don't give the user a real choice,
10485 because we haven't implemented the mechanisms to support it. */
10486 #ifdef NO_SOCK_SIGIO
10487 interrupt_input
= 0;
10488 #else /* not NO_SOCK_SIGIO */
10489 interrupt_input
= 1;
10490 #endif /* NO_SOCK_SIGIO */
10493 interrupt_input
= !NILP (interrupt
);
10494 #else /* not SIGIO */
10495 interrupt_input
= 0;
10496 #endif /* not SIGIO */
10498 /* Our VMS input only works by interrupts, as of now. */
10500 interrupt_input
= 1;
10503 flow_control
= !NILP (flow
);
10506 else if (EQ (meta
, Qt
))
10511 /* Don't let this value be out of range. */
10512 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10518 #ifdef POLL_FOR_INPUT
10519 poll_suppress_count
= 1;
10525 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10526 doc
: /* Return information about the way Emacs currently reads keyboard input.
10527 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10528 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10529 nil, Emacs is using CBREAK mode.
10530 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10531 terminal; this does not apply if Emacs uses interrupt-driven input.
10532 META is t if accepting 8-bit input with 8th bit as Meta flag.
10533 META nil means ignoring the top bit, on the assumption it is parity.
10534 META is neither t nor nil if accepting 8-bit input and using
10535 all 8 bits as the character code.
10536 QUIT is the character Emacs currently uses to quit.
10537 The elements of this list correspond to the arguments of
10538 `set-input-mode'. */)
10541 Lisp_Object val
[4];
10543 val
[0] = interrupt_input
? Qt
: Qnil
;
10544 val
[1] = flow_control
? Qt
: Qnil
;
10545 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10546 XSETFASTINT (val
[3], quit_char
);
10548 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10553 * Set up a new kboard object with reasonable initial values.
10559 kb
->Voverriding_terminal_local_map
= Qnil
;
10560 kb
->Vlast_command
= Qnil
;
10561 kb
->Vreal_last_command
= Qnil
;
10562 kb
->Vprefix_arg
= Qnil
;
10563 kb
->Vlast_prefix_arg
= Qnil
;
10564 kb
->kbd_queue
= Qnil
;
10565 kb
->kbd_queue_has_data
= 0;
10566 kb
->immediate_echo
= 0;
10567 kb
->echo_string
= Qnil
;
10568 kb
->echo_after_prompt
= -1;
10569 kb
->kbd_macro_buffer
= 0;
10570 kb
->kbd_macro_bufsize
= 0;
10571 kb
->defining_kbd_macro
= Qnil
;
10572 kb
->Vlast_kbd_macro
= Qnil
;
10573 kb
->reference_count
= 0;
10574 kb
->Vsystem_key_alist
= Qnil
;
10575 kb
->system_key_syms
= Qnil
;
10576 kb
->Vdefault_minibuffer_frame
= Qnil
;
10580 * Destroy the contents of a kboard object, but not the object itself.
10581 * We use this just before deleting it, or if we're going to initialize
10582 * it a second time.
10588 if (kb
->kbd_macro_buffer
)
10589 xfree (kb
->kbd_macro_buffer
);
10592 #ifdef MULTI_KBOARD
10594 /* Free KB and memory referenced from it. */
10602 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10605 *kbp
= kb
->next_kboard
;
10607 /* Prevent a dangling reference to KB. */
10608 if (kb
== current_kboard
10609 && FRAMEP (selected_frame
)
10610 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10612 current_kboard
= XFRAME (selected_frame
)->kboard
;
10613 if (current_kboard
== kb
)
10621 #endif /* MULTI_KBOARD */
10626 /* This is correct before outermost invocation of the editor loop */
10627 command_loop_level
= -1;
10628 immediate_quit
= 0;
10629 quit_char
= Ctl ('g');
10630 Vunread_command_events
= Qnil
;
10631 unread_command_char
= -1;
10632 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10634 recent_keys_index
= 0;
10635 kbd_fetch_ptr
= kbd_buffer
;
10636 kbd_store_ptr
= kbd_buffer
;
10637 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10639 do_mouse_tracking
= Qnil
;
10643 /* This means that command_loop_1 won't try to select anything the first
10645 internal_last_event_frame
= Qnil
;
10646 Vlast_event_frame
= internal_last_event_frame
;
10648 #ifdef MULTI_KBOARD
10649 current_kboard
= initial_kboard
;
10651 wipe_kboard (current_kboard
);
10652 init_kboard (current_kboard
);
10654 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10656 signal (SIGINT
, interrupt_signal
);
10657 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10658 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10659 SIGQUIT and we can't tell which one it will give us. */
10660 signal (SIGQUIT
, interrupt_signal
);
10661 #endif /* HAVE_TERMIO */
10663 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10665 if (!noninteractive
)
10666 signal (SIGIO
, input_available_signal
);
10669 /* Use interrupt input by default, if it works and noninterrupt input
10670 has deficiencies. */
10672 #ifdef INTERRUPT_INPUT
10673 interrupt_input
= 1;
10675 interrupt_input
= 0;
10678 /* Our VMS input only works by interrupts, as of now. */
10680 interrupt_input
= 1;
10686 if (keyboard_init_hook
)
10687 (*keyboard_init_hook
) ();
10689 #ifdef POLL_FOR_INPUT
10690 poll_suppress_count
= 1;
10695 /* At least provide an escape route since C-g doesn't work. */
10696 signal (SIGINT
, interrupt_signal
);
10700 /* This type's only use is in syms_of_keyboard, to initialize the
10701 event header symbols and put properties on them. */
10702 struct event_head
{
10708 struct event_head head_table
[] = {
10709 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10710 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10711 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10712 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10713 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10714 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10715 /* `select-window' should be handled just like `switch-frame'
10716 in read_key_sequence. */
10717 {&Qselect_window
, "select-window", &Qswitch_frame
}
10721 syms_of_keyboard ()
10723 Vpre_help_message
= Qnil
;
10724 staticpro (&Vpre_help_message
);
10726 Vlispy_mouse_stem
= build_string ("mouse");
10727 staticpro (&Vlispy_mouse_stem
);
10730 QCimage
= intern (":image");
10731 staticpro (&QCimage
);
10733 staticpro (&Qhelp_echo
);
10734 Qhelp_echo
= intern ("help-echo");
10736 staticpro (&item_properties
);
10737 item_properties
= Qnil
;
10739 staticpro (&tool_bar_item_properties
);
10740 tool_bar_item_properties
= Qnil
;
10741 staticpro (&tool_bar_items_vector
);
10742 tool_bar_items_vector
= Qnil
;
10744 staticpro (&real_this_command
);
10745 real_this_command
= Qnil
;
10747 Qtimer_event_handler
= intern ("timer-event-handler");
10748 staticpro (&Qtimer_event_handler
);
10750 Qdisabled_command_hook
= intern ("disabled-command-hook");
10751 staticpro (&Qdisabled_command_hook
);
10753 Qself_insert_command
= intern ("self-insert-command");
10754 staticpro (&Qself_insert_command
);
10756 Qforward_char
= intern ("forward-char");
10757 staticpro (&Qforward_char
);
10759 Qbackward_char
= intern ("backward-char");
10760 staticpro (&Qbackward_char
);
10762 Qdisabled
= intern ("disabled");
10763 staticpro (&Qdisabled
);
10765 Qundefined
= intern ("undefined");
10766 staticpro (&Qundefined
);
10768 Qpre_command_hook
= intern ("pre-command-hook");
10769 staticpro (&Qpre_command_hook
);
10771 Qpost_command_hook
= intern ("post-command-hook");
10772 staticpro (&Qpost_command_hook
);
10774 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10775 staticpro (&Qpost_command_idle_hook
);
10777 Qdeferred_action_function
= intern ("deferred-action-function");
10778 staticpro (&Qdeferred_action_function
);
10780 Qcommand_hook_internal
= intern ("command-hook-internal");
10781 staticpro (&Qcommand_hook_internal
);
10783 Qfunction_key
= intern ("function-key");
10784 staticpro (&Qfunction_key
);
10785 Qmouse_click
= intern ("mouse-click");
10786 staticpro (&Qmouse_click
);
10788 Qlanguage_change
= intern ("language-change");
10789 staticpro (&Qlanguage_change
);
10791 Qdrag_n_drop
= intern ("drag-n-drop");
10792 staticpro (&Qdrag_n_drop
);
10794 Qsave_session
= intern ("save-session");
10795 staticpro(&Qsave_session
);
10797 Qusr1_signal
= intern ("usr1-signal");
10798 staticpro (&Qusr1_signal
);
10799 Qusr2_signal
= intern ("usr2-signal");
10800 staticpro (&Qusr2_signal
);
10802 Qmenu_enable
= intern ("menu-enable");
10803 staticpro (&Qmenu_enable
);
10804 Qmenu_alias
= intern ("menu-alias");
10805 staticpro (&Qmenu_alias
);
10806 QCenable
= intern (":enable");
10807 staticpro (&QCenable
);
10808 QCvisible
= intern (":visible");
10809 staticpro (&QCvisible
);
10810 QChelp
= intern (":help");
10811 staticpro (&QChelp
);
10812 QCfilter
= intern (":filter");
10813 staticpro (&QCfilter
);
10814 QCbutton
= intern (":button");
10815 staticpro (&QCbutton
);
10816 QCkeys
= intern (":keys");
10817 staticpro (&QCkeys
);
10818 QCkey_sequence
= intern (":key-sequence");
10819 staticpro (&QCkey_sequence
);
10820 QCtoggle
= intern (":toggle");
10821 staticpro (&QCtoggle
);
10822 QCradio
= intern (":radio");
10823 staticpro (&QCradio
);
10825 Qmode_line
= intern ("mode-line");
10826 staticpro (&Qmode_line
);
10827 Qvertical_line
= intern ("vertical-line");
10828 staticpro (&Qvertical_line
);
10829 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10830 staticpro (&Qvertical_scroll_bar
);
10831 Qmenu_bar
= intern ("menu-bar");
10832 staticpro (&Qmenu_bar
);
10834 Qabove_handle
= intern ("above-handle");
10835 staticpro (&Qabove_handle
);
10836 Qhandle
= intern ("handle");
10837 staticpro (&Qhandle
);
10838 Qbelow_handle
= intern ("below-handle");
10839 staticpro (&Qbelow_handle
);
10840 Qup
= intern ("up");
10842 Qdown
= intern ("down");
10843 staticpro (&Qdown
);
10844 Qtop
= intern ("top");
10846 Qbottom
= intern ("bottom");
10847 staticpro (&Qbottom
);
10848 Qend_scroll
= intern ("end-scroll");
10849 staticpro (&Qend_scroll
);
10850 Qratio
= intern ("ratio");
10851 staticpro (&Qratio
);
10853 Qevent_kind
= intern ("event-kind");
10854 staticpro (&Qevent_kind
);
10855 Qevent_symbol_elements
= intern ("event-symbol-elements");
10856 staticpro (&Qevent_symbol_elements
);
10857 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10858 staticpro (&Qevent_symbol_element_mask
);
10859 Qmodifier_cache
= intern ("modifier-cache");
10860 staticpro (&Qmodifier_cache
);
10862 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10863 staticpro (&Qrecompute_lucid_menubar
);
10864 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10865 staticpro (&Qactivate_menubar_hook
);
10867 Qpolling_period
= intern ("polling-period");
10868 staticpro (&Qpolling_period
);
10870 Qinput_method_function
= intern ("input-method-function");
10871 staticpro (&Qinput_method_function
);
10873 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10874 staticpro (&Qinput_method_exit_on_first_char
);
10875 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10876 staticpro (&Qinput_method_use_echo_area
);
10878 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10879 Fset (Qinput_method_use_echo_area
, Qnil
);
10881 last_point_position_buffer
= Qnil
;
10884 struct event_head
*p
;
10886 for (p
= head_table
;
10887 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10890 *p
->var
= intern (p
->name
);
10891 staticpro (p
->var
);
10892 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10893 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10897 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10898 staticpro (&button_down_location
);
10899 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10900 staticpro (&mouse_syms
);
10901 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
10902 staticpro (&wheel_syms
);
10906 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10908 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10909 for (i
= 0; i
< len
; i
++)
10910 if (modifier_names
[i
])
10911 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10912 staticpro (&modifier_symbols
);
10915 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10916 staticpro (&recent_keys
);
10918 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10919 staticpro (&this_command_keys
);
10921 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10922 staticpro (&raw_keybuf
);
10924 Qextended_command_history
= intern ("extended-command-history");
10925 Fset (Qextended_command_history
, Qnil
);
10926 staticpro (&Qextended_command_history
);
10928 kbd_buffer_gcpro
= Fmake_vector (make_number (2 * KBD_BUFFER_SIZE
), Qnil
);
10929 staticpro (&kbd_buffer_gcpro
);
10931 accent_key_syms
= Qnil
;
10932 staticpro (&accent_key_syms
);
10934 func_key_syms
= Qnil
;
10935 staticpro (&func_key_syms
);
10937 drag_n_drop_syms
= Qnil
;
10938 staticpro (&drag_n_drop_syms
);
10940 unread_switch_frame
= Qnil
;
10941 staticpro (&unread_switch_frame
);
10943 internal_last_event_frame
= Qnil
;
10944 staticpro (&internal_last_event_frame
);
10946 read_key_sequence_cmd
= Qnil
;
10947 staticpro (&read_key_sequence_cmd
);
10949 menu_bar_one_keymap_changed_items
= Qnil
;
10950 staticpro (&menu_bar_one_keymap_changed_items
);
10952 defsubr (&Sevent_convert_list
);
10953 defsubr (&Sread_key_sequence
);
10954 defsubr (&Sread_key_sequence_vector
);
10955 defsubr (&Srecursive_edit
);
10957 defsubr (&Strack_mouse
);
10959 defsubr (&Sinput_pending_p
);
10960 defsubr (&Scommand_execute
);
10961 defsubr (&Srecent_keys
);
10962 defsubr (&Sthis_command_keys
);
10963 defsubr (&Sthis_command_keys_vector
);
10964 defsubr (&Sthis_single_command_keys
);
10965 defsubr (&Sthis_single_command_raw_keys
);
10966 defsubr (&Sreset_this_command_lengths
);
10967 defsubr (&Sclear_this_command_keys
);
10968 defsubr (&Ssuspend_emacs
);
10969 defsubr (&Sabort_recursive_edit
);
10970 defsubr (&Sexit_recursive_edit
);
10971 defsubr (&Srecursion_depth
);
10972 defsubr (&Stop_level
);
10973 defsubr (&Sdiscard_input
);
10974 defsubr (&Sopen_dribble_file
);
10975 defsubr (&Sset_input_mode
);
10976 defsubr (&Scurrent_input_mode
);
10977 defsubr (&Sexecute_extended_command
);
10979 DEFVAR_LISP ("last-command-char", &last_command_char
,
10980 doc
: /* Last input event that was part of a command. */);
10982 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10983 doc
: /* Last input event that was part of a command. */);
10985 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10986 doc
: /* Last input event in a command, except for mouse menu events.
10987 Mouse menus give back keys that don't look like mouse events;
10988 this variable holds the actual mouse event that led to the menu,
10989 so that you can determine whether the command was run by mouse or not. */);
10991 DEFVAR_LISP ("last-input-char", &last_input_char
,
10992 doc
: /* Last input event. */);
10994 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10995 doc
: /* Last input event. */);
10997 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10998 doc
: /* List of events to be read as the command input.
10999 These events are processed first, before actual keyboard input. */);
11000 Vunread_command_events
= Qnil
;
11002 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11003 doc
: /* If not -1, an object to be read as next command input event. */);
11005 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11006 doc
: /* List of events to be processed as input by input methods.
11007 These events are processed after `unread-command-events', but
11008 before actual keyboard input. */);
11009 Vunread_post_input_method_events
= Qnil
;
11011 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11012 doc
: /* List of events to be processed as input by input methods.
11013 These events are processed after `unread-command-events', but
11014 before actual keyboard input. */);
11015 Vunread_input_method_events
= Qnil
;
11017 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11018 doc
: /* Meta-prefix character code.
11019 Meta-foo as command input turns into this character followed by foo. */);
11020 XSETINT (meta_prefix_char
, 033);
11022 DEFVAR_KBOARD ("last-command", Vlast_command
,
11023 doc
: /* The last command executed.
11024 Normally a symbol with a function definition, but can be whatever was found
11025 in the keymap, or whatever the variable `this-command' was set to by that
11028 The value `mode-exit' is special; it means that the previous command
11029 read an event that told it to exit, and it did so and unread that event.
11030 In other words, the present command is the event that made the previous
11033 The value `kill-region' is special; it means that the previous command
11034 was a kill command. */);
11036 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11037 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11039 DEFVAR_LISP ("this-command", &Vthis_command
,
11040 doc
: /* The command now being executed.
11041 The command can set this variable; whatever is put here
11042 will be in `last-command' during the following command. */);
11043 Vthis_command
= Qnil
;
11045 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11046 doc
: /* The command bound to the current key sequence before remapping.
11047 It equals `this-command' if the original command was not remapped through
11048 any of the active keymaps. Otherwise, the value of `this-command' is the
11049 result of looking up the original command in the active keymaps. */);
11050 Vthis_original_command
= Qnil
;
11052 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11053 doc
: /* *Number of input events between auto-saves.
11054 Zero means disable autosaving due to number of characters typed. */);
11055 auto_save_interval
= 300;
11057 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11058 doc
: /* *Number of seconds idle time before auto-save.
11059 Zero or nil means disable auto-saving due to idleness.
11060 After auto-saving due to this many seconds of idle time,
11061 Emacs also does a garbage collection if that seems to be warranted. */);
11062 XSETFASTINT (Vauto_save_timeout
, 30);
11064 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11065 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11066 The value may be integer or floating point. */);
11067 Vecho_keystrokes
= make_number (1);
11069 DEFVAR_INT ("polling-period", &polling_period
,
11070 doc
: /* *Interval between polling for input during Lisp execution.
11071 The reason for polling is to make C-g work to stop a running program.
11072 Polling is needed only when using X windows and SIGIO does not work.
11073 Polling is automatically disabled in all other cases. */);
11074 polling_period
= 2;
11076 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11077 doc
: /* *Maximum time between mouse clicks to make a double-click.
11078 Measured in milliseconds. nil means disable double-click recognition;
11079 t means double-clicks have no time limit and are detected
11080 by position only. */);
11081 Vdouble_click_time
= make_number (500);
11083 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11084 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11085 On window-system frames, value is the number of pixels the mouse may have
11086 moved horizontally or vertically between two clicks to make a double-click.
11087 On non window-system frames, value is interpreted in units of 1/8 characters
11090 This variable is also the threshold for motion of the mouse
11091 to count as a drag. */);
11092 double_click_fuzz
= 3;
11094 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11095 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11096 inhibit_local_menu_bar_menus
= 0;
11098 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11099 doc
: /* Number of complete key sequences read as input so far.
11100 This includes key sequences read from keyboard macros.
11101 The number is effectively the number of interactive command invocations. */);
11102 num_input_keys
= 0;
11104 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11105 doc
: /* Number of input events read from the keyboard so far.
11106 This does not include events generated by keyboard macros. */);
11107 num_nonmacro_input_events
= 0;
11109 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11110 doc
: /* The frame in which the most recently read event occurred.
11111 If the last event came from a keyboard macro, this is set to `macro'. */);
11112 Vlast_event_frame
= Qnil
;
11114 /* This variable is set up in sysdep.c. */
11115 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11116 doc
: /* The ERASE character as set by the user with stty. */);
11118 DEFVAR_LISP ("help-char", &Vhelp_char
,
11119 doc
: /* Character to recognize as meaning Help.
11120 When it is read, do `(eval help-form)', and display result if it's a string.
11121 If the value of `help-form' is nil, this char can be read normally. */);
11122 XSETINT (Vhelp_char
, Ctl ('H'));
11124 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11125 doc
: /* List of input events to recognize as meaning Help.
11126 These work just like the value of `help-char' (see that). */);
11127 Vhelp_event_list
= Qnil
;
11129 DEFVAR_LISP ("help-form", &Vhelp_form
,
11130 doc
: /* Form to execute when character `help-char' is read.
11131 If the form returns a string, that string is displayed.
11132 If `help-form' is nil, the help char is not recognized. */);
11135 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11136 doc
: /* Command to run when `help-char' character follows a prefix key.
11137 This command is used only when there is no actual binding
11138 for that character after that prefix key. */);
11139 Vprefix_help_command
= Qnil
;
11141 DEFVAR_LISP ("top-level", &Vtop_level
,
11142 doc
: /* Form to evaluate when Emacs starts up.
11143 Useful to set before you dump a modified Emacs. */);
11146 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11147 doc
: /* Translate table for keyboard input, or nil.
11148 Each character is looked up in this string and the contents used instead.
11149 The value may be a string, a vector, or a char-table.
11150 If it is a string or vector of length N,
11151 character codes N and up are untranslated.
11152 In a vector or a char-table, an element which is nil means "no translation".
11154 This is applied to the characters supplied to input methods, not their
11155 output. See also `translation-table-for-input'. */);
11156 Vkeyboard_translate_table
= Qnil
;
11158 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11159 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11160 \(Even if the operating system has support for stopping a process.\) */);
11161 cannot_suspend
= 0;
11163 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11164 doc
: /* Non-nil means prompt with menus when appropriate.
11165 This is done when reading from a keymap that has a prompt string,
11166 for elements that have prompt strings.
11167 The menu is displayed on the screen
11168 if X menus were enabled at configuration
11169 time and the previous event was a mouse click prefix key.
11170 Otherwise, menu prompting uses the echo area. */);
11171 menu_prompting
= 1;
11173 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11174 doc
: /* Character to see next line of menu prompt.
11175 Type this character while in a menu prompt to rotate around the lines of it. */);
11176 XSETINT (menu_prompt_more_char
, ' ');
11178 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11179 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11180 Emacs applies the modifiers of the character stored here to each keyboard
11181 character it reads. For example, after evaluating the expression
11182 (setq extra-keyboard-modifiers ?\\C-x)
11183 all input characters will have the control modifier applied to them.
11185 Note that the character ?\\C-@, equivalent to the integer zero, does
11186 not count as a control character; rather, it counts as a character
11187 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11188 cancels any modification. */);
11189 extra_keyboard_modifiers
= 0;
11191 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11192 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11193 The command loop sets this to nil before each command,
11194 and tests the value when the command returns.
11195 Buffer modification stores t in this variable. */);
11196 Vdeactivate_mark
= Qnil
;
11198 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11199 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11200 Vcommand_hook_internal
= Qnil
;
11202 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11203 doc
: /* Normal hook run before each command is executed.
11204 If an unhandled error happens in running this hook,
11205 the hook value is set to nil, since otherwise the error
11206 might happen repeatedly and make Emacs nonfunctional. */);
11207 Vpre_command_hook
= Qnil
;
11209 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11210 doc
: /* Normal hook run after each command is executed.
11211 If an unhandled error happens in running this hook,
11212 the hook value is set to nil, since otherwise the error
11213 might happen repeatedly and make Emacs nonfunctional. */);
11214 Vpost_command_hook
= Qnil
;
11216 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11217 doc
: /* Normal hook run after each command is executed, if idle.
11218 Errors running the hook are caught and ignored. */);
11219 Vpost_command_idle_hook
= Qnil
;
11221 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11222 doc
: /* Delay time before running `post-command-idle-hook'.
11223 This is measured in microseconds. */);
11224 post_command_idle_delay
= 100000;
11227 DEFVAR_LISP ("echo-area-clear-hook", ...,
11228 doc
: /* Normal hook run when clearing the echo area. */);
11230 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11231 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11233 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11234 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11235 Vlucid_menu_bar_dirty_flag
= Qnil
;
11237 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11238 doc
: /* List of menu bar items to move to the end of the menu bar.
11239 The elements of the list are event types that may have menu bar bindings. */);
11240 Vmenu_bar_final_items
= Qnil
;
11242 DEFVAR_KBOARD ("overriding-terminal-local-map",
11243 Voverriding_terminal_local_map
,
11244 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11245 If this variable is non-nil, it is used as a keymap instead of the
11246 buffer's local map, and the minor mode keymaps and text property keymaps.
11247 This variable is intended to let commands such as `universal-argument'
11248 set up a different keymap for reading the next command. */);
11250 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11251 doc
: /* Keymap that overrides all other local keymaps.
11252 If this variable is non-nil, it is used as a keymap instead of the
11253 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11254 Voverriding_local_map
= Qnil
;
11256 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11257 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11258 Otherwise, the menu bar continues to reflect the buffer's local map
11259 and the minor mode maps regardless of `overriding-local-map'. */);
11260 Voverriding_local_map_menu_flag
= Qnil
;
11262 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11263 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11264 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11266 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11267 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11269 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11270 doc
: /* Alist of system-specific X windows key symbols.
11271 Each element should have the form (N . SYMBOL) where N is the
11272 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11273 and SYMBOL is its name. */);
11275 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11276 doc
: /* List of deferred actions to be performed at a later time.
11277 The precise format isn't relevant here; we just check whether it is nil. */);
11278 Vdeferred_action_list
= Qnil
;
11280 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11281 doc
: /* Function to call to handle deferred actions, after each command.
11282 This function is called with no arguments after each command
11283 whenever `deferred-action-list' is non-nil. */);
11284 Vdeferred_action_function
= Qnil
;
11286 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11287 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11288 The value can be a length of time to show the message for.
11289 If the value is non-nil and not a number, we wait 2 seconds. */);
11290 Vsuggest_key_bindings
= Qt
;
11292 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11293 doc
: /* List of active absolute time timers in order of increasing time. */);
11294 Vtimer_list
= Qnil
;
11296 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11297 doc
: /* List of active idle-time timers in order of increasing time. */);
11298 Vtimer_idle_list
= Qnil
;
11300 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11301 doc
: /* If non-nil, the function that implements the current input method.
11302 It's called with one argument, a printing character that was just read.
11303 \(That means a character with code 040...0176.)
11304 Typically this function uses `read-event' to read additional events.
11305 When it does so, it should first bind `input-method-function' to nil
11306 so it will not be called recursively.
11308 The function should return a list of zero or more events
11309 to be used as input. If it wants to put back some events
11310 to be reconsidered, separately, by the input method,
11311 it can add them to the beginning of `unread-command-events'.
11313 The input method function can find in `input-method-previous-method'
11314 the previous echo area message.
11316 The input method function should refer to the variables
11317 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11318 for guidance on what to do. */);
11319 Vinput_method_function
= Qnil
;
11321 DEFVAR_LISP ("input-method-previous-message",
11322 &Vinput_method_previous_message
,
11323 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11324 This variable exists because `read-event' clears the echo area
11325 before running the input method. It is nil if there was no message. */);
11326 Vinput_method_previous_message
= Qnil
;
11328 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11329 doc
: /* If non-nil, the function that implements the display of help.
11330 It's called with one argument, the help string to display. */);
11331 Vshow_help_function
= Qnil
;
11333 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11334 doc
: /* If non-nil, suppress point adjustment after executing a command.
11336 After a command is executed, if point is moved into a region that has
11337 special properties (e.g. composition, display), we adjust point to
11338 the boundary of the region. But, several special commands sets this
11339 variable to non-nil, then we suppress the point adjustment.
11341 This variable is set to nil before reading a command, and is checked
11342 just after executing the command. */);
11343 Vdisable_point_adjustment
= Qnil
;
11345 DEFVAR_LISP ("global-disable-point-adjustment",
11346 &Vglobal_disable_point_adjustment
,
11347 doc
: /* *If non-nil, always suppress point adjustment.
11349 The default value is nil, in which case, point adjustment are
11350 suppressed only after special commands that set
11351 `disable-point-adjustment' (which see) to non-nil. */);
11352 Vglobal_disable_point_adjustment
= Qnil
;
11354 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11355 doc
: /* Non-nil means updating menu bindings is allowed.
11356 A value of nil means menu bindings should not be updated.
11357 Used during Emacs' startup. */);
11358 update_menu_bindings
= 1;
11360 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11361 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11362 If the value is not a number, such messages don't time out. */);
11363 Vminibuffer_message_timeout
= make_number (2);
11367 keys_of_keyboard ()
11369 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11370 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11371 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11372 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11373 initial_define_key (meta_map
, 'x', "execute-extended-command");
11375 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11376 "handle-delete-frame");
11377 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11379 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11381 /* Handling it at such a low-level causes read_key_sequence to get
11382 * confused because it doesn't realize that the current_buffer was
11383 * changed by read_char.
11385 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11386 * "handle-select-window"); */
11387 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11388 "handle-save-session");
11391 /* Mark the pointers in the kboard objects.
11392 Called by the Fgarbage_collector. */
11398 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11400 if (kb
->kbd_macro_buffer
)
11401 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11403 mark_object (kb
->Voverriding_terminal_local_map
);
11404 mark_object (kb
->Vlast_command
);
11405 mark_object (kb
->Vreal_last_command
);
11406 mark_object (kb
->Vprefix_arg
);
11407 mark_object (kb
->Vlast_prefix_arg
);
11408 mark_object (kb
->kbd_queue
);
11409 mark_object (kb
->defining_kbd_macro
);
11410 mark_object (kb
->Vlast_kbd_macro
);
11411 mark_object (kb
->Vsystem_key_alist
);
11412 mark_object (kb
->system_key_syms
);
11413 mark_object (kb
->Vdefault_minibuffer_frame
);
11414 mark_object (kb
->echo_string
);
11417 struct input_event
*event
;
11418 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11420 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11421 event
= kbd_buffer
;
11422 mark_object (event
->x
);
11423 mark_object (event
->y
);
11424 mark_object (event
->frame_or_window
);
11425 mark_object (event
->arg
);