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,04
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
28 #include "termhooks.h"
35 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
53 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
60 #include <sys/types.h>
65 /* This is to get the definitions of the XK_ symbols. */
72 #endif /* HAVE_NTGUI */
82 /* Variables for blockinput.h: */
84 /* Non-zero if interrupt input is blocked right now. */
85 int interrupt_input_blocked
;
87 /* Nonzero means an input interrupt has arrived
88 during the current critical section. */
89 int interrupt_input_pending
;
92 /* File descriptor to use for input. */
95 #ifdef HAVE_WINDOW_SYSTEM
96 /* Make all keyboard buffers much bigger when using X windows. */
98 /* But not too big (local data > 32K error) if on Mac OS Classic. */
99 #define KBD_BUFFER_SIZE 512
101 #define KBD_BUFFER_SIZE 4096
103 #else /* No X-windows, character input */
104 #define KBD_BUFFER_SIZE 4096
105 #endif /* No X-windows */
107 #define abs(x) ((x) >= 0 ? (x) : -(x))
109 /* Following definition copied from eval.c */
113 struct backtrace
*next
;
114 Lisp_Object
*function
;
115 Lisp_Object
*args
; /* Points to vector of args. */
116 int nargs
; /* length of vector. If nargs is UNEVALLED,
117 args points to slot holding list of
123 KBOARD
*initial_kboard
;
124 KBOARD
*current_kboard
;
128 KBOARD the_only_kboard
;
131 /* Non-nil disable property on a command means
132 do not execute it; call disabled-command-hook's value instead. */
133 Lisp_Object Qdisabled
, Qdisabled_command_hook
;
135 #define NUM_RECENT_KEYS (100)
136 int recent_keys_index
; /* Index for storing next element into recent_keys */
137 int total_keys
; /* Total number of elements stored into recent_keys */
138 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
140 /* Vector holding the key sequence that invoked the current command.
141 It is reused for each command, and it may be longer than the current
142 sequence; this_command_key_count indicates how many elements
143 actually mean something.
144 It's easier to staticpro a single Lisp_Object than an array. */
145 Lisp_Object this_command_keys
;
146 int this_command_key_count
;
148 /* 1 after calling Freset_this_command_lengths.
150 int this_command_key_count_reset
;
152 /* This vector is used as a buffer to record the events that were actually read
153 by read_key_sequence. */
154 Lisp_Object raw_keybuf
;
155 int raw_keybuf_count
;
157 #define GROW_RAW_KEYBUF \
158 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
160 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
162 new = Fmake_vector (make_number (newsize), Qnil); \
163 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
164 raw_keybuf_count * sizeof (Lisp_Object)); \
168 /* Number of elements of this_command_keys
169 that precede this key sequence. */
170 int this_single_command_key_start
;
172 /* Record values of this_command_key_count and echo_length ()
173 before this command was read. */
174 static int before_command_key_count
;
175 static int before_command_echo_length
;
177 extern int minbuf_level
;
179 extern int message_enable_multibyte
;
181 extern struct backtrace
*backtrace_list
;
183 /* If non-nil, the function that implements the display of help.
184 It's called with one argument, the help string to display. */
186 Lisp_Object Vshow_help_function
;
188 /* If a string, the message displayed before displaying a help-echo
191 Lisp_Object Vpre_help_message
;
193 /* Nonzero means do menu prompting. */
195 static int menu_prompting
;
197 /* Character to see next line of menu prompt. */
199 static Lisp_Object menu_prompt_more_char
;
201 /* For longjmp to where kbd input is being done. */
203 static jmp_buf getcjmp
;
205 /* True while doing kbd input. */
206 int waiting_for_input
;
208 /* True while displaying for echoing. Delays C-g throwing. */
212 /* Non-null means we can start echoing at the next input pause even
213 though there is something in the echo area. */
215 static struct kboard
*ok_to_echo_at_next_pause
;
217 /* The kboard last echoing, or null for none. Reset to 0 in
218 cancel_echoing. If non-null, and a current echo area message
219 exists, and echo_message_buffer is eq to the current message
220 buffer, we know that the message comes from echo_kboard. */
222 struct kboard
*echo_kboard
;
224 /* The buffer used for echoing. Set in echo_now, reset in
227 Lisp_Object echo_message_buffer
;
229 /* Nonzero means disregard local maps for the menu bar. */
230 static int inhibit_local_menu_bar_menus
;
232 /* Nonzero means C-g should cause immediate error-signal. */
235 /* The user's ERASE setting. */
236 Lisp_Object Vtty_erase_char
;
238 /* Character to recognize as the help char. */
239 Lisp_Object Vhelp_char
;
241 /* List of other event types to recognize as meaning "help". */
242 Lisp_Object Vhelp_event_list
;
244 /* Form to execute when help char is typed. */
245 Lisp_Object Vhelp_form
;
247 /* Command to run when the help character follows a prefix key. */
248 Lisp_Object Vprefix_help_command
;
250 /* List of items that should move to the end of the menu bar. */
251 Lisp_Object Vmenu_bar_final_items
;
253 /* Non-nil means show the equivalent key-binding for
254 any M-x command that has one.
255 The value can be a length of time to show the message for.
256 If the value is non-nil and not a number, we wait 2 seconds. */
257 Lisp_Object Vsuggest_key_bindings
;
259 /* How long to display an echo-area message when the minibuffer is active.
260 If the value is not a number, such messages don't time out. */
261 Lisp_Object Vminibuffer_message_timeout
;
263 /* Character that causes a quit. Normally C-g.
265 If we are running on an ordinary terminal, this must be an ordinary
266 ASCII char, since we want to make it our interrupt character.
268 If we are not running on an ordinary terminal, it still needs to be
269 an ordinary ASCII char. This character needs to be recognized in
270 the input interrupt handler. At this point, the keystroke is
271 represented as a struct input_event, while the desired quit
272 character is specified as a lispy event. The mapping from struct
273 input_events to lispy events cannot run in an interrupt handler,
274 and the reverse mapping is difficult for anything but ASCII
277 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
281 extern Lisp_Object current_global_map
;
282 extern int minibuf_level
;
284 /* If non-nil, this is a map that overrides all other local maps. */
285 Lisp_Object Voverriding_local_map
;
287 /* If non-nil, Voverriding_local_map applies to the menu bar. */
288 Lisp_Object Voverriding_local_map_menu_flag
;
290 /* Keymap that defines special misc events that should
291 be processed immediately at a low level. */
292 Lisp_Object Vspecial_event_map
;
294 /* Current depth in recursive edits. */
295 int command_loop_level
;
297 /* Total number of times command_loop has read a key sequence. */
298 EMACS_INT num_input_keys
;
300 /* Last input character read as a command. */
301 Lisp_Object last_command_char
;
303 /* Last input character read as a command, not counting menus
304 reached by the mouse. */
305 Lisp_Object last_nonmenu_event
;
307 /* Last input character read for any purpose. */
308 Lisp_Object last_input_char
;
310 /* If not Qnil, a list of objects to be read as subsequent command input. */
311 Lisp_Object Vunread_command_events
;
313 /* If not Qnil, a list of objects to be read as subsequent command input
314 including input method processing. */
315 Lisp_Object Vunread_input_method_events
;
317 /* If not Qnil, a list of objects to be read as subsequent command input
318 but NOT including input method processing. */
319 Lisp_Object Vunread_post_input_method_events
;
321 /* If not -1, an event to be read as subsequent command input. */
322 EMACS_INT unread_command_char
;
324 /* If not Qnil, this is a switch-frame event which we decided to put
325 off until the end of a key sequence. This should be read as the
326 next command input, after any unread_command_events.
328 read_key_sequence uses this to delay switch-frame events until the
329 end of the key sequence; Fread_char uses it to put off switch-frame
330 events until a non-ASCII event is acceptable as input. */
331 Lisp_Object unread_switch_frame
;
333 /* A mask of extra modifier bits to put into every keyboard char. */
334 EMACS_INT extra_keyboard_modifiers
;
336 /* Char to use as prefix when a meta character is typed in.
337 This is bound on entry to minibuffer in case ESC is changed there. */
339 Lisp_Object meta_prefix_char
;
341 /* Last size recorded for a current buffer which is not a minibuffer. */
342 static int last_non_minibuf_size
;
344 /* Number of idle seconds before an auto-save and garbage collection. */
345 static Lisp_Object Vauto_save_timeout
;
347 /* Total number of times read_char has returned. */
348 int num_input_events
;
350 /* Total number of times read_char has returned, outside of macros. */
351 EMACS_INT num_nonmacro_input_events
;
353 /* Auto-save automatically when this many characters have been typed
354 since the last time. */
356 static EMACS_INT auto_save_interval
;
358 /* Value of num_nonmacro_input_events as of last auto save. */
362 /* The command being executed by the command loop.
363 Commands may set this, and the value set will be copied into
364 current_kboard->Vlast_command instead of the actual command. */
365 Lisp_Object Vthis_command
;
367 /* This is like Vthis_command, except that commands never set it. */
368 Lisp_Object real_this_command
;
370 /* If the lookup of the command returns a binding, the original
371 command is stored in this-original-command. It is nil otherwise. */
372 Lisp_Object Vthis_original_command
;
374 /* The value of point when the last command was executed. */
375 int last_point_position
;
377 /* The buffer that was current when the last command was started. */
378 Lisp_Object last_point_position_buffer
;
380 /* The frame in which the last input event occurred, or Qmacro if the
381 last event came from a macro. We use this to determine when to
382 generate switch-frame events. This may be cleared by functions
383 like Fselect_frame, to make sure that a switch-frame event is
384 generated by the next character. */
385 Lisp_Object internal_last_event_frame
;
387 /* A user-visible version of the above, intended to allow users to
388 figure out where the last event came from, if the event doesn't
389 carry that information itself (i.e. if it was a character). */
390 Lisp_Object Vlast_event_frame
;
392 /* The timestamp of the last input event we received from the X server.
393 X Windows wants this for selection ownership. */
394 unsigned long last_event_timestamp
;
396 Lisp_Object Qself_insert_command
;
397 Lisp_Object Qforward_char
;
398 Lisp_Object Qbackward_char
;
399 Lisp_Object Qundefined
;
400 Lisp_Object Qtimer_event_handler
;
402 /* read_key_sequence stores here the command definition of the
403 key sequence that it reads. */
404 Lisp_Object read_key_sequence_cmd
;
406 /* Echo unfinished commands after this many seconds of pause. */
407 Lisp_Object Vecho_keystrokes
;
409 /* Form to evaluate (if non-nil) when Emacs is started. */
410 Lisp_Object Vtop_level
;
412 /* User-supplied table to translate input characters. */
413 Lisp_Object Vkeyboard_translate_table
;
415 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
416 extern Lisp_Object Vfunction_key_map
;
418 /* Another keymap that maps key sequences into key sequences.
419 This one takes precedence over ordinary definitions. */
420 extern Lisp_Object Vkey_translation_map
;
422 /* If non-nil, this implements the current input method. */
423 Lisp_Object Vinput_method_function
;
424 Lisp_Object Qinput_method_function
;
426 /* When we call Vinput_method_function,
427 this holds the echo area message that was just erased. */
428 Lisp_Object Vinput_method_previous_message
;
430 /* Non-nil means deactivate the mark at end of this command. */
431 Lisp_Object Vdeactivate_mark
;
433 /* Menu bar specified in Lucid Emacs fashion. */
435 Lisp_Object Vlucid_menu_bar_dirty_flag
;
436 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
438 Lisp_Object Qecho_area_clear_hook
;
440 /* Hooks to run before and after each command. */
441 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
442 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
443 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
444 /* Hook run after a command if there's no more input soon. */
445 Lisp_Object Qpost_command_idle_hook
, Vpost_command_idle_hook
;
447 /* Delay time in microseconds before running post-command-idle-hook. */
448 EMACS_INT post_command_idle_delay
;
450 /* List of deferred actions to be performed at a later time.
451 The precise format isn't relevant here; we just check whether it is nil. */
452 Lisp_Object Vdeferred_action_list
;
454 /* Function to call to handle deferred actions, when there are any. */
455 Lisp_Object Vdeferred_action_function
;
456 Lisp_Object Qdeferred_action_function
;
458 Lisp_Object Qinput_method_exit_on_first_char
;
459 Lisp_Object Qinput_method_use_echo_area
;
461 /* File in which we write all commands we read. */
464 /* Nonzero if input is available. */
467 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
468 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
472 /* Non-zero means force key bindings update in parse_menu_item. */
474 int update_menu_bindings
;
476 extern char *pending_malloc_warning
;
478 /* Circular buffer for pre-read keyboard input. */
480 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
482 /* Pointer to next available character in kbd_buffer.
483 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
484 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
485 next available char is in kbd_buffer[0]. */
486 static struct input_event
*kbd_fetch_ptr
;
488 /* Pointer to next place to store character in kbd_buffer. This
489 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
490 character should go in kbd_buffer[0]. */
491 static struct input_event
* volatile kbd_store_ptr
;
493 /* The above pair of variables forms a "queue empty" flag. When we
494 enqueue a non-hook event, we increment kbd_store_ptr. When we
495 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
496 there is input available iff the two pointers are not equal.
498 Why not just have a flag set and cleared by the enqueuing and
499 dequeuing functions? Such a flag could be screwed up by interrupts
500 at inopportune times. */
502 /* If this flag is non-nil, we check mouse_moved to see when the
503 mouse moves, and motion events will appear in the input stream.
504 Otherwise, mouse motion is ignored. */
505 Lisp_Object do_mouse_tracking
;
507 /* Symbols to head events. */
508 Lisp_Object Qmouse_movement
;
509 Lisp_Object Qscroll_bar_movement
;
510 Lisp_Object Qswitch_frame
;
511 Lisp_Object Qdelete_frame
;
512 Lisp_Object Qiconify_frame
;
513 Lisp_Object Qmake_frame_visible
;
514 Lisp_Object Qselect_window
;
515 Lisp_Object Qhelp_echo
;
517 /* Symbols to denote kinds of events. */
518 Lisp_Object Qfunction_key
;
519 Lisp_Object Qmouse_click
;
521 Lisp_Object Qlanguage_change
;
523 Lisp_Object Qdrag_n_drop
;
524 Lisp_Object Qsave_session
;
526 /* Lisp_Object Qmouse_movement; - also an event header */
528 /* Properties of event headers. */
529 Lisp_Object Qevent_kind
;
530 Lisp_Object Qevent_symbol_elements
;
532 /* menu item parts */
533 Lisp_Object Qmenu_alias
;
534 Lisp_Object Qmenu_enable
;
535 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
536 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
537 extern Lisp_Object Vdefine_key_rebound_commands
;
538 extern Lisp_Object Qmenu_item
;
540 /* An event header symbol HEAD may have a property named
541 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
542 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
543 mask of modifiers applied to it. If present, this is used to help
544 speed up parse_modifiers. */
545 Lisp_Object Qevent_symbol_element_mask
;
547 /* An unmodified event header BASE may have a property named
548 Qmodifier_cache, which is an alist mapping modifier masks onto
549 modified versions of BASE. If present, this helps speed up
551 Lisp_Object Qmodifier_cache
;
553 /* Symbols to use for parts of windows. */
554 Lisp_Object Qmode_line
;
555 Lisp_Object Qvertical_line
;
556 Lisp_Object Qvertical_scroll_bar
;
557 Lisp_Object Qmenu_bar
;
558 extern Lisp_Object Qleft_margin
, Qright_margin
;
559 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
560 extern Lisp_Object QCmap
;
562 Lisp_Object
recursive_edit_unwind (), command_loop ();
563 Lisp_Object
Fthis_command_keys ();
564 Lisp_Object Qextended_command_history
;
565 EMACS_TIME
timer_check ();
567 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
569 extern char *x_get_keysym_name ();
571 static void record_menu_key ();
572 static int echo_length ();
574 Lisp_Object Qpolling_period
;
576 /* List of absolute timers. Appears in order of next scheduled event. */
577 Lisp_Object Vtimer_list
;
579 /* List of idle time timers. Appears in order of next scheduled event. */
580 Lisp_Object Vtimer_idle_list
;
582 /* Incremented whenever a timer is run. */
585 extern Lisp_Object Vprint_level
, Vprint_length
;
587 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
589 EMACS_TIME
*input_available_clear_time
;
591 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
592 Default is 1 if INTERRUPT_INPUT is defined. */
595 /* Nonzero while interrupts are temporarily deferred during redisplay. */
596 int interrupts_deferred
;
598 /* Nonzero means use ^S/^Q for flow control. */
601 /* Allow m- file to inhibit use of FIONREAD. */
602 #ifdef BROKEN_FIONREAD
606 /* We are unable to use interrupts if FIONREAD is not available,
607 so flush SIGIO so we won't try. */
614 /* If we support a window system, turn on the code to poll periodically
615 to detect C-g. It isn't actually used when doing interrupt input. */
616 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
617 #define POLL_FOR_INPUT
620 /* After a command is executed, if point is moved into a region that
621 has specific properties (e.g. composition, display), we adjust
622 point to the boundary of the region. But, if a command sets this
623 variable to non-nil, we suppress this point adjustment. This
624 variable is set to nil before reading a command. */
626 Lisp_Object Vdisable_point_adjustment
;
628 /* If non-nil, always disable point adjustment. */
630 Lisp_Object Vglobal_disable_point_adjustment
;
632 /* The time when Emacs started being idle. */
634 static EMACS_TIME timer_idleness_start_time
;
636 /* After Emacs stops being idle, this saves the last value
637 of timer_idleness_start_time from when it was idle. */
639 static EMACS_TIME timer_last_idleness_start_time
;
642 /* Global variable declarations. */
644 /* Function for init_keyboard to call with no args (if nonzero). */
645 void (*keyboard_init_hook
) ();
647 static int read_avail_input
P_ ((int));
648 static void get_input_pending
P_ ((int *, int));
649 static void get_filtered_input_pending
P_ ((int *, int, int));
650 static int readable_events
P_ ((int));
651 static int readable_filtered_events
P_ ((int, int));
652 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
653 Lisp_Object
, int *));
654 static Lisp_Object
read_char_x_menu_prompt ();
655 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
657 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
659 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
660 enum scroll_bar_part
,
661 Lisp_Object
, Lisp_Object
,
664 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
665 Lisp_Object
, char **,
666 Lisp_Object
*, unsigned));
667 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
668 static int parse_solitary_modifier
P_ ((Lisp_Object
));
669 static int parse_solitary_modifier ();
670 static void save_getcjmp
P_ ((jmp_buf));
671 static void save_getcjmp ();
672 static void restore_getcjmp
P_ ((jmp_buf));
673 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
674 static void clear_event
P_ ((struct input_event
*));
675 static void any_kboard_state
P_ ((void));
676 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
678 /* Nonzero means don't try to suspend even if the operating system seems
680 static int cannot_suspend
;
682 /* Install the string STR as the beginning of the string of echoing,
683 so that it serves as a prompt for the next character.
684 Also start echoing. */
690 current_kboard
->echo_string
= str
;
691 current_kboard
->echo_after_prompt
= SCHARS (str
);
695 /* Add C to the echo string, if echoing is going on.
696 C can be a character, which is printed prettily ("M-C-x" and all that
697 jazz), or a symbol, whose name is printed. */
703 if (current_kboard
->immediate_echo
)
705 int size
= KEY_DESCRIPTION_SIZE
+ 100;
706 char *buffer
= (char *) alloca (size
);
708 Lisp_Object echo_string
;
710 echo_string
= current_kboard
->echo_string
;
712 /* If someone has passed us a composite event, use its head symbol. */
717 ptr
= push_key_description (XINT (c
), ptr
, 1);
719 else if (SYMBOLP (c
))
721 Lisp_Object name
= SYMBOL_NAME (c
);
722 int nbytes
= SBYTES (name
);
724 if (size
- (ptr
- buffer
) < nbytes
)
726 int offset
= ptr
- buffer
;
727 size
= max (2 * size
, size
+ nbytes
);
728 buffer
= (char *) alloca (size
);
729 ptr
= buffer
+ offset
;
732 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
733 STRING_MULTIBYTE (name
), 1);
736 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
739 const char *text
= " (Type ? for further options)";
740 int len
= strlen (text
);
742 if (size
- (ptr
- buffer
) < len
)
744 int offset
= ptr
- buffer
;
746 buffer
= (char *) alloca (size
);
747 ptr
= buffer
+ offset
;
750 bcopy (text
, ptr
, len
);
754 /* Replace a dash from echo_dash with a space, otherwise
755 add a space at the end as a separator between keys. */
756 if (STRINGP (echo_string
)
757 && SCHARS (echo_string
) > 1)
759 Lisp_Object last_char
, prev_char
, idx
;
761 idx
= make_number (SCHARS (echo_string
) - 2);
762 prev_char
= Faref (echo_string
, idx
);
764 idx
= make_number (SCHARS (echo_string
) - 1);
765 last_char
= Faref (echo_string
, idx
);
767 /* We test PREV_CHAR to make sure this isn't the echoing
769 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
770 Faset (echo_string
, idx
, make_number (' '));
772 echo_string
= concat2 (echo_string
, build_string (" "));
775 current_kboard
->echo_string
776 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
782 /* Temporarily add a dash to the end of the echo string if it's not
783 empty, so that it serves as a mini-prompt for the very next character. */
788 /* Do nothing if not echoing at all. */
789 if (NILP (current_kboard
->echo_string
))
792 if (!current_kboard
->immediate_echo
793 && SCHARS (current_kboard
->echo_string
) == 0)
796 /* Do nothing if we just printed a prompt. */
797 if (current_kboard
->echo_after_prompt
798 == SCHARS (current_kboard
->echo_string
))
801 /* Put a dash at the end of the buffer temporarily,
802 but make it go away when the next character is added. */
803 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
808 /* Display the current echo string, and begin echoing if not already
814 if (!current_kboard
->immediate_echo
)
817 current_kboard
->immediate_echo
= 1;
819 for (i
= 0; i
< this_command_key_count
; i
++)
823 /* Set before_command_echo_length to the value that would
824 have been saved before the start of this subcommand in
825 command_loop_1, if we had already been echoing then. */
826 if (i
== this_single_command_key_start
)
827 before_command_echo_length
= echo_length ();
829 c
= XVECTOR (this_command_keys
)->contents
[i
];
830 if (! (EVENT_HAS_PARAMETERS (c
)
831 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
835 /* Set before_command_echo_length to the value that would
836 have been saved before the start of this subcommand in
837 command_loop_1, if we had already been echoing then. */
838 if (this_command_key_count
== this_single_command_key_start
)
839 before_command_echo_length
= echo_length ();
841 /* Put a dash at the end to invite the user to type more. */
846 message3_nolog (current_kboard
->echo_string
,
847 SBYTES (current_kboard
->echo_string
),
848 STRING_MULTIBYTE (current_kboard
->echo_string
));
851 /* Record in what buffer we echoed, and from which kboard. */
852 echo_message_buffer
= echo_area_buffer
[0];
853 echo_kboard
= current_kboard
;
855 if (waiting_for_input
&& !NILP (Vquit_flag
))
856 quit_throw_to_read_char ();
859 /* Turn off echoing, for the start of a new command. */
864 current_kboard
->immediate_echo
= 0;
865 current_kboard
->echo_after_prompt
= -1;
866 current_kboard
->echo_string
= Qnil
;
867 ok_to_echo_at_next_pause
= NULL
;
869 echo_message_buffer
= Qnil
;
872 /* Return the length of the current echo string. */
877 return (STRINGP (current_kboard
->echo_string
)
878 ? SCHARS (current_kboard
->echo_string
)
882 /* Truncate the current echo message to its first LEN chars.
883 This and echo_char get used by read_key_sequence when the user
884 switches frames while entering a key sequence. */
887 echo_truncate (nchars
)
890 if (STRINGP (current_kboard
->echo_string
))
891 current_kboard
->echo_string
892 = Fsubstring (current_kboard
->echo_string
,
893 make_number (0), make_number (nchars
));
894 truncate_echo_area (nchars
);
898 /* Functions for manipulating this_command_keys. */
900 add_command_key (key
)
903 #if 0 /* Not needed after we made Freset_this_command_lengths
904 do the job immediately. */
905 /* If reset-this-command-length was called recently, obey it now.
906 See the doc string of that function for an explanation of why. */
907 if (before_command_restore_flag
)
909 this_command_key_count
= before_command_key_count_1
;
910 if (this_command_key_count
< this_single_command_key_start
)
911 this_single_command_key_start
= this_command_key_count
;
912 echo_truncate (before_command_echo_length_1
);
913 before_command_restore_flag
= 0;
917 if (this_command_key_count
>= ASIZE (this_command_keys
))
918 this_command_keys
= larger_vector (this_command_keys
,
919 2 * ASIZE (this_command_keys
),
922 AREF (this_command_keys
, this_command_key_count
) = key
;
923 ++this_command_key_count
;
930 int count
= SPECPDL_INDEX ();
933 if (command_loop_level
> 0)
935 specbind (Qstandard_output
, Qt
);
936 specbind (Qstandard_input
, Qt
);
939 #ifdef HAVE_X_WINDOWS
940 /* The command loop has started an hourglass timer, so we have to
941 cancel it here, otherwise it will fire because the recursive edit
942 can take some time. Do not check for display_hourglass_p here,
943 because it could already be nil. */
947 /* This function may have been called from a debugger called from
948 within redisplay, for instance by Edebugging a function called
949 from fontification-functions. We want to allow redisplay in
950 the debugging session.
952 The recursive edit is left with a `(throw exit ...)'. The `exit'
953 tag is not caught anywhere in redisplay, i.e. when we leave the
954 recursive edit, the original redisplay leading to the recursive
955 edit will be unwound. The outcome should therefore be safe. */
956 specbind (Qinhibit_redisplay
, Qnil
);
959 val
= command_loop ();
961 Fsignal (Qquit
, Qnil
);
962 /* Handle throw from read_minibuf when using minibuffer
963 while it's active but we're in another window. */
965 Fsignal (Qerror
, Fcons (val
, Qnil
));
967 return unbind_to (count
, Qnil
);
970 /* When an auto-save happens, record the "time", and don't do again soon. */
975 last_auto_save
= num_nonmacro_input_events
;
978 /* Make an auto save happen as soon as possible at command level. */
981 force_auto_save_soon ()
983 last_auto_save
= - auto_save_interval
- 1;
985 record_asynch_buffer_change ();
988 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
989 doc
: /* Invoke the editor command loop recursively.
990 To get out of the recursive edit, a command can do `(throw 'exit nil)';
991 that tells this function to return.
992 Alternately, `(throw 'exit t)' makes this function signal an error.
993 This function is called by the editor initialization to begin editing. */)
996 int count
= SPECPDL_INDEX ();
999 command_loop_level
++;
1000 update_mode_lines
= 1;
1002 if (command_loop_level
1003 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1004 buffer
= Fcurrent_buffer ();
1008 /* If we leave recursive_edit_1 below with a `throw' for instance,
1009 like it is done in the splash screen display, we have to
1010 make sure that we restore single_kboard as command_loop_1
1011 would have done if it were left normally. */
1012 record_unwind_protect (recursive_edit_unwind
,
1013 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1015 recursive_edit_1 ();
1016 return unbind_to (count
, Qnil
);
1020 recursive_edit_unwind (info
)
1023 if (BUFFERP (XCAR (info
)))
1024 Fset_buffer (XCAR (info
));
1026 if (NILP (XCDR (info
)))
1027 any_kboard_state ();
1029 single_kboard_state ();
1031 command_loop_level
--;
1032 update_mode_lines
= 1;
1041 #if 0 /* Theory: if there's anything in Vunread_command_events,
1042 it will right away be read by read_key_sequence,
1043 and then if we do switch KBOARDS, it will go into the side
1044 queue then. So we don't need to do anything special here -- rms. */
1045 if (CONSP (Vunread_command_events
))
1047 current_kboard
->kbd_queue
1048 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1049 current_kboard
->kbd_queue_has_data
= 1;
1051 Vunread_command_events
= Qnil
;
1057 /* Switch to the single-kboard state, making current_kboard
1058 the only KBOARD from which further input is accepted. */
1061 single_kboard_state ()
1068 /* Maintain a stack of kboards, so other parts of Emacs
1069 can switch temporarily to the kboard of a given frame
1070 and then revert to the previous status. */
1075 struct kboard_stack
*next
;
1078 static struct kboard_stack
*kboard_stack
;
1081 push_frame_kboard (f
)
1085 struct kboard_stack
*p
1086 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1088 p
->next
= kboard_stack
;
1089 p
->kboard
= current_kboard
;
1092 current_kboard
= FRAME_KBOARD (f
);
1100 struct kboard_stack
*p
= kboard_stack
;
1101 current_kboard
= p
->kboard
;
1102 kboard_stack
= p
->next
;
1107 /* Handle errors that are not handled at inner levels
1108 by printing an error message and returning to the editor command loop. */
1114 Lisp_Object old_level
, old_length
;
1115 char macroerror
[50];
1117 #ifdef HAVE_X_WINDOWS
1118 if (display_hourglass_p
)
1119 cancel_hourglass ();
1122 if (!NILP (executing_macro
))
1124 if (executing_macro_iterations
== 1)
1125 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1127 sprintf (macroerror
, "After %d kbd macro iterations: ",
1128 executing_macro_iterations
);
1133 Vstandard_output
= Qt
;
1134 Vstandard_input
= Qt
;
1135 Vexecuting_macro
= Qnil
;
1136 executing_macro
= Qnil
;
1137 current_kboard
->Vprefix_arg
= Qnil
;
1138 current_kboard
->Vlast_prefix_arg
= Qnil
;
1141 /* Avoid unquittable loop if data contains a circular list. */
1142 old_level
= Vprint_level
;
1143 old_length
= Vprint_length
;
1144 XSETFASTINT (Vprint_level
, 10);
1145 XSETFASTINT (Vprint_length
, 10);
1146 cmd_error_internal (data
, macroerror
);
1147 Vprint_level
= old_level
;
1148 Vprint_length
= old_length
;
1152 Vinhibit_quit
= Qnil
;
1154 any_kboard_state ();
1157 return make_number (0);
1160 /* Take actions on handling an error. DATA is the data that describes
1163 CONTEXT is a C-string containing ASCII characters only which
1164 describes the context in which the error happened. If we need to
1165 generalize CONTEXT to allow multibyte characters, make it a Lisp
1169 cmd_error_internal (data
, context
)
1174 int kill_emacs_p
= 0;
1175 struct frame
*sf
= SELECTED_FRAME ();
1179 clear_message (1, 0);
1181 /* If the window system or terminal frame hasn't been initialized
1182 yet, or we're not interactive, it's best to dump this message out
1183 to stderr and exit. */
1184 if (!sf
->glyphs_initialized_p
1185 /* This is the case of the frame dumped with Emacs, when we're
1186 running under a window system. */
1187 || (!NILP (Vwindow_system
)
1188 && !inhibit_window_system
1189 && FRAME_TERMCAP_P (sf
))
1192 stream
= Qexternal_debugging_output
;
1198 message_log_maybe_newline ();
1203 /* The immediate context is not interesting for Quits,
1204 since they are asyncronous. */
1205 if (EQ (XCAR (data
), Qquit
))
1206 Vsignaling_function
= Qnil
;
1208 print_error_message (data
, stream
, context
, Vsignaling_function
);
1210 Vsignaling_function
= Qnil
;
1212 /* If the window system or terminal frame hasn't been initialized
1213 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1217 Fkill_emacs (make_number (-1));
1221 Lisp_Object
command_loop_1 ();
1222 Lisp_Object
command_loop_2 ();
1223 Lisp_Object
top_level_1 ();
1225 /* Entry to editor-command-loop.
1226 This level has the catches for exiting/returning to editor command loop.
1227 It returns nil to exit recursive edit, t to abort it. */
1232 if (command_loop_level
> 0 || minibuf_level
> 0)
1235 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1236 executing_macro
= Qnil
;
1242 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1243 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1244 executing_macro
= Qnil
;
1246 /* End of file in -batch run causes exit here. */
1252 /* Here we catch errors in execution of commands within the
1253 editing loop, and reenter the editing loop.
1254 When there is an error, cmd_error runs and returns a non-nil
1255 value to us. A value of nil means that command_loop_1 itself
1256 returned due to end of file (or end of kbd macro). */
1261 register Lisp_Object val
;
1264 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1265 while (!NILP (val
));
1273 return Feval (Vtop_level
);
1279 /* On entry to the outer level, run the startup file */
1280 if (!NILP (Vtop_level
))
1281 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1282 else if (!NILP (Vpurify_flag
))
1283 message ("Bare impure Emacs (standard Lisp code not loaded)");
1285 message ("Bare Emacs (standard Lisp code not loaded)");
1289 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1290 doc
: /* Exit all recursive editing levels. */)
1293 #ifdef HAVE_X_WINDOWS
1294 if (display_hourglass_p
)
1295 cancel_hourglass ();
1297 return Fthrow (Qtop_level
, Qnil
);
1300 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1301 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1304 if (command_loop_level
> 0 || minibuf_level
> 0)
1305 Fthrow (Qexit
, Qnil
);
1307 error ("No recursive edit is in progress");
1311 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1312 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1315 if (command_loop_level
> 0 || minibuf_level
> 0)
1318 error ("No recursive edit is in progress");
1322 /* This is the actual command reading loop,
1323 sans error-handling encapsulation. */
1325 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1327 void safe_run_hooks
P_ ((Lisp_Object
));
1328 static void adjust_point_for_property
P_ ((int, int));
1330 /* Cancel hourglass from protect_unwind.
1332 #ifdef HAVE_X_WINDOWS
1334 cancel_hourglass_unwind (arg
)
1337 cancel_hourglass ();
1348 Lisp_Object keybuf
[30];
1352 struct buffer
*prev_buffer
= NULL
;
1354 int was_locked
= single_kboard
;
1356 int already_adjusted
;
1358 current_kboard
->Vprefix_arg
= Qnil
;
1359 current_kboard
->Vlast_prefix_arg
= Qnil
;
1360 Vdeactivate_mark
= Qnil
;
1361 waiting_for_input
= 0;
1365 this_command_key_count
= 0;
1366 this_command_key_count_reset
= 0;
1367 this_single_command_key_start
= 0;
1369 if (NILP (Vmemory_full
))
1371 /* Make sure this hook runs after commands that get errors and
1372 throw to top level. */
1373 /* Note that the value cell will never directly contain nil
1374 if the symbol is a local variable. */
1375 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1376 safe_run_hooks (Qpost_command_hook
);
1378 /* If displaying a message, resize the echo area window to fit
1379 that message's size exactly. */
1380 if (!NILP (echo_area_buffer
[0]))
1381 resize_echo_area_exactly ();
1383 if (!NILP (Vdeferred_action_list
))
1384 call0 (Vdeferred_action_function
);
1386 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1388 if (NILP (Vunread_command_events
)
1389 && NILP (Vunread_input_method_events
)
1390 && NILP (Vunread_post_input_method_events
)
1391 && NILP (Vexecuting_macro
)
1392 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1393 safe_run_hooks (Qpost_command_idle_hook
);
1397 Vmemory_full
= Qnil
;
1399 /* Do this after running Vpost_command_hook, for consistency. */
1400 current_kboard
->Vlast_command
= Vthis_command
;
1401 current_kboard
->Vreal_last_command
= real_this_command
;
1405 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1408 /* Make sure the current window's buffer is selected. */
1409 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1410 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1412 /* Display any malloc warning that just came out. Use while because
1413 displaying one warning can cause another. */
1415 while (pending_malloc_warning
)
1416 display_malloc_warning ();
1420 Vdeactivate_mark
= Qnil
;
1422 /* If minibuffer on and echo area in use,
1423 wait a short time and redraw minibuffer. */
1426 && !NILP (echo_area_buffer
[0])
1427 && EQ (minibuf_window
, echo_area_window
)
1428 && NUMBERP (Vminibuffer_message_timeout
))
1430 /* Bind inhibit-quit to t so that C-g gets read in
1431 rather than quitting back to the minibuffer. */
1432 int count
= SPECPDL_INDEX ();
1433 specbind (Qinhibit_quit
, Qt
);
1435 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1436 /* Clear the echo area. */
1438 safe_run_hooks (Qecho_area_clear_hook
);
1440 unbind_to (count
, Qnil
);
1442 /* If a C-g came in before, treat it as input now. */
1443 if (!NILP (Vquit_flag
))
1446 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1451 alloca (0); /* Cause a garbage collection now */
1452 /* Since we can free the most stuff here. */
1453 #endif /* C_ALLOCA */
1456 /* Select the frame that the last event came from. Usually,
1457 switch-frame events will take care of this, but if some lisp
1458 code swallows a switch-frame event, we'll fix things up here.
1459 Is this a good idea? */
1460 if (FRAMEP (internal_last_event_frame
)
1461 && !EQ (internal_last_event_frame
, selected_frame
))
1462 Fselect_frame (internal_last_event_frame
, Qnil
);
1464 /* If it has changed current-menubar from previous value,
1465 really recompute the menubar from the value. */
1466 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1467 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1468 call0 (Qrecompute_lucid_menubar
);
1470 before_command_key_count
= this_command_key_count
;
1471 before_command_echo_length
= echo_length ();
1473 Vthis_command
= Qnil
;
1474 real_this_command
= Qnil
;
1476 /* Read next key sequence; i gets its length. */
1477 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1480 /* A filter may have run while we were reading the input. */
1481 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1483 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1484 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1488 /* Now we have read a key sequence of length I,
1489 or else I is 0 and we found end of file. */
1491 if (i
== 0) /* End of file -- happens only in */
1492 return Qnil
; /* a kbd macro, at the end. */
1493 /* -1 means read_key_sequence got a menu that was rejected.
1494 Just loop around and read another command. */
1498 this_command_key_count
= 0;
1499 this_command_key_count_reset
= 0;
1500 this_single_command_key_start
= 0;
1504 last_command_char
= keybuf
[i
- 1];
1506 /* If the previous command tried to force a specific window-start,
1507 forget about that, in case this command moves point far away
1508 from that position. But also throw away beg_unchanged and
1509 end_unchanged information in that case, so that redisplay will
1510 update the whole window properly. */
1511 if (!NILP (XWINDOW (selected_window
)->force_start
))
1514 XWINDOW (selected_window
)->force_start
= Qnil
;
1515 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1516 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1519 cmd
= read_key_sequence_cmd
;
1520 if (!NILP (Vexecuting_macro
))
1522 if (!NILP (Vquit_flag
))
1524 Vexecuting_macro
= Qt
;
1525 QUIT
; /* Make some noise. */
1526 /* Will return since macro now empty. */
1530 /* Do redisplay processing after this command except in special
1531 cases identified below. */
1532 prev_buffer
= current_buffer
;
1533 prev_modiff
= MODIFF
;
1534 last_point_position
= PT
;
1535 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1537 /* By default, we adjust point to a boundary of a region that
1538 has such a property that should be treated intangible
1539 (e.g. composition, display). But, some commands will set
1540 this variable differently. */
1541 Vdisable_point_adjustment
= Qnil
;
1543 /* Process filters and timers may have messed with deactivate-mark.
1544 reset it before we execute the command. */
1545 Vdeactivate_mark
= Qnil
;
1547 /* Remap command through active keymaps */
1548 Vthis_original_command
= cmd
;
1552 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1556 /* Execute the command. */
1558 Vthis_command
= cmd
;
1559 real_this_command
= cmd
;
1560 /* Note that the value cell will never directly contain nil
1561 if the symbol is a local variable. */
1562 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1563 safe_run_hooks (Qpre_command_hook
);
1565 already_adjusted
= 0;
1567 if (NILP (Vthis_command
))
1569 /* nil means key is undefined. */
1571 current_kboard
->defining_kbd_macro
= Qnil
;
1572 update_mode_lines
= 1;
1573 current_kboard
->Vprefix_arg
= Qnil
;
1577 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1579 /* In case we jump to directly_done. */
1580 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1582 /* Recognize some common commands in common situations and
1583 do them directly. */
1584 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1586 struct Lisp_Char_Table
*dp
1587 = window_display_table (XWINDOW (selected_window
));
1588 lose
= FETCH_CHAR (PT_BYTE
);
1590 if (! NILP (Vpost_command_hook
))
1591 /* Put this before calling adjust_point_for_property
1592 so it will only get called once in any case. */
1594 if (current_buffer
== prev_buffer
1595 && last_point_position
!= PT
1596 && NILP (Vdisable_point_adjustment
)
1597 && NILP (Vglobal_disable_point_adjustment
))
1598 adjust_point_for_property (last_point_position
, 0);
1599 already_adjusted
= 1;
1600 if (PT
== last_point_position
+ 1
1602 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1603 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1604 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1605 && (lose
>= 0x20 && lose
< 0x7f)))
1606 : (lose
>= 0x20 && lose
< 0x7f))
1607 /* To extract the case of continuation on
1608 wide-column characters. */
1609 && ASCII_BYTE_P (lose
)
1610 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1612 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1614 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1616 && !windows_or_buffers_changed
1617 && EQ (current_buffer
->selective_display
, Qnil
)
1618 && !detect_input_pending ()
1619 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1620 && NILP (Vexecuting_macro
))
1621 direct_output_forward_char (1);
1624 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1626 struct Lisp_Char_Table
*dp
1627 = window_display_table (XWINDOW (selected_window
));
1629 lose
= FETCH_CHAR (PT_BYTE
);
1630 if (! NILP (Vpost_command_hook
))
1632 if (current_buffer
== prev_buffer
1633 && last_point_position
!= PT
1634 && NILP (Vdisable_point_adjustment
)
1635 && NILP (Vglobal_disable_point_adjustment
))
1636 adjust_point_for_property (last_point_position
, 0);
1637 already_adjusted
= 1;
1638 if (PT
== last_point_position
- 1
1640 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1641 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1642 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1643 && (lose
>= 0x20 && lose
< 0x7f)))
1644 : (lose
>= 0x20 && lose
< 0x7f))
1645 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1647 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1649 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1651 && !windows_or_buffers_changed
1652 && EQ (current_buffer
->selective_display
, Qnil
)
1653 && !detect_input_pending ()
1654 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1655 && NILP (Vexecuting_macro
))
1656 direct_output_forward_char (-1);
1659 else if (EQ (Vthis_command
, Qself_insert_command
)
1660 /* Try this optimization only on char keystrokes. */
1661 && NATNUMP (last_command_char
)
1662 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1665 = translate_char (Vtranslation_table_for_input
,
1666 XFASTINT (last_command_char
));
1668 if (NILP (Vexecuting_macro
)
1669 && !EQ (minibuf_window
, selected_window
))
1671 if (!nonundocount
|| nonundocount
>= 20)
1679 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1681 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1683 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1685 || MODIFF
<= SAVE_MODIFF
1686 || windows_or_buffers_changed
1687 || !EQ (current_buffer
->selective_display
, Qnil
)
1688 || detect_input_pending ()
1689 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1690 || !NILP (Vexecuting_macro
));
1692 value
= internal_self_insert (c
, 0);
1697 if (! NILP (Vpost_command_hook
))
1698 /* Put this before calling adjust_point_for_property
1699 so it will only get called once in any case. */
1702 /* VALUE == 1 when AFTER-CHANGE functions are
1703 installed which is the case most of the time
1704 because FONT-LOCK installs one. */
1705 if (!lose
&& !value
)
1706 direct_output_for_insert (c
);
1711 /* Here for a command that isn't executed directly */
1714 #ifdef HAVE_X_WINDOWS
1715 int scount
= SPECPDL_INDEX ();
1717 if (display_hourglass_p
1718 && NILP (Vexecuting_macro
))
1720 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1726 if (NILP (current_kboard
->Vprefix_arg
))
1728 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1730 #ifdef HAVE_X_WINDOWS
1731 /* Do not check display_hourglass_p here, because
1732 Fcommand_execute could change it, but we should cancel
1733 hourglass cursor anyway.
1734 But don't cancel the hourglass within a macro
1735 just because a command in the macro finishes. */
1736 if (NILP (Vexecuting_macro
))
1737 unbind_to (scount
, Qnil
);
1742 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1744 /* Note that the value cell will never directly contain nil
1745 if the symbol is a local variable. */
1746 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1747 safe_run_hooks (Qpost_command_hook
);
1749 /* If displaying a message, resize the echo area window to fit
1750 that message's size exactly. */
1751 if (!NILP (echo_area_buffer
[0]))
1752 resize_echo_area_exactly ();
1754 if (!NILP (Vdeferred_action_list
))
1755 safe_run_hooks (Qdeferred_action_function
);
1757 if (!NILP (Vpost_command_idle_hook
) && !NILP (Vrun_hooks
))
1759 if (NILP (Vunread_command_events
)
1760 && NILP (Vunread_input_method_events
)
1761 && NILP (Vunread_post_input_method_events
)
1762 && NILP (Vexecuting_macro
)
1763 && !NILP (sit_for (0, post_command_idle_delay
, 0, 1, 1)))
1764 safe_run_hooks (Qpost_command_idle_hook
);
1767 /* If there is a prefix argument,
1768 1) We don't want Vlast_command to be ``universal-argument''
1769 (that would be dumb), so don't set Vlast_command,
1770 2) we want to leave echoing on so that the prefix will be
1771 echoed as part of this key sequence, so don't call
1773 3) we want to leave this_command_key_count non-zero, so that
1774 read_char will realize that it is re-reading a character, and
1775 not echo it a second time.
1777 If the command didn't actually create a prefix arg,
1778 but is merely a frame event that is transparent to prefix args,
1779 then the above doesn't apply. */
1780 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1782 current_kboard
->Vlast_command
= Vthis_command
;
1783 current_kboard
->Vreal_last_command
= real_this_command
;
1785 this_command_key_count
= 0;
1786 this_command_key_count_reset
= 0;
1787 this_single_command_key_start
= 0;
1790 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1792 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1794 /* We could also call `deactivate'mark'. */
1795 if (EQ (Vtransient_mark_mode
, Qlambda
))
1796 Vtransient_mark_mode
= Qnil
;
1799 current_buffer
->mark_active
= Qnil
;
1800 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1803 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1804 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1809 if (current_buffer
== prev_buffer
1810 && last_point_position
!= PT
1811 && NILP (Vdisable_point_adjustment
)
1812 && NILP (Vglobal_disable_point_adjustment
)
1813 && !already_adjusted
)
1814 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1816 /* Install chars successfully executed in kbd macro. */
1818 if (!NILP (current_kboard
->defining_kbd_macro
)
1819 && NILP (current_kboard
->Vprefix_arg
))
1820 finalize_kbd_macro_chars ();
1824 any_kboard_state ();
1829 extern Lisp_Object Qcomposition
, Qdisplay
;
1831 /* Adjust point to a boundary of a region that has such a property
1832 that should be treated intangible. For the moment, we check
1833 `composition', `display' and `invisible' properties.
1834 LAST_PT is the last position of point. */
1836 extern Lisp_Object Qafter_string
, Qbefore_string
;
1837 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1840 adjust_point_for_property (last_pt
, modified
)
1845 Lisp_Object val
, overlay
, tmp
;
1846 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1849 /* FIXME: cycling is probably not necessary because these properties
1850 can't be usefully combined anyway. */
1851 while (check_composition
|| check_display
|| check_invisible
)
1853 if (check_composition
1854 && PT
> BEGV
&& PT
< ZV
1855 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1856 && COMPOSITION_VALID_P (beg
, end
, val
)
1857 && beg
< PT
/* && end > PT <- It's always the case. */
1858 && (last_pt
<= beg
|| last_pt
>= end
))
1861 SET_PT (PT
< last_pt
? beg
: end
);
1862 check_display
= check_invisible
= 1;
1864 check_composition
= 0;
1866 && PT
> BEGV
&& PT
< ZV
1867 && !NILP (val
= get_char_property_and_overlay
1868 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1869 && display_prop_intangible_p (val
)
1870 && (!OVERLAYP (overlay
)
1871 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1872 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1873 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1874 && beg
< PT
) /* && end > PT <- It's always the case. */
1877 SET_PT (PT
< last_pt
? beg
: end
);
1878 check_composition
= check_invisible
= 1;
1881 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1883 int inv
, ellipsis
= 0;
1886 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1888 && !NILP (val
= get_char_property_and_overlay
1889 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1890 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1892 ellipsis
= ellipsis
|| inv
> 1
1893 || (OVERLAYP (overlay
)
1894 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1895 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1896 tmp
= Fnext_single_char_property_change
1897 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1898 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1901 && !NILP (val
= get_char_property_and_overlay
1902 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1903 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1905 ellipsis
= ellipsis
|| inv
> 1
1906 || (OVERLAYP (overlay
)
1907 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1908 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1909 tmp
= Fprevious_single_char_property_change
1910 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1911 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1914 /* Move away from the inside area. */
1915 if (beg
< PT
&& end
> PT
)
1917 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1918 /* We haven't moved yet (so we don't need to fear
1919 infinite-looping) and we were outside the range
1920 before (so either end of the range still corresponds
1921 to a move in the right direction): pretend we moved
1922 less than we actually did, so that we still have
1923 more freedom below in choosing which end of the range
1925 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1926 /* We either have moved already or the last point
1927 was already in the range: we don't get to choose
1928 which end of the range we have to go to. */
1929 : (PT
< last_pt
? beg
: end
));
1930 check_composition
= check_display
= 1;
1932 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1933 the point to something other than its argument, due to
1934 point-motion hooks, intangibility, etc. */
1935 xassert (PT
== beg
|| PT
== end
);
1938 /* Pretend the area doesn't exist if the buffer is not
1940 if (!modified
&& !ellipsis
&& beg
< end
)
1942 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1943 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1944 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1945 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1946 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1947 /* We've already moved as far as we can. Trying to go
1948 to the other end would mean moving backwards and thus
1949 could lead to an infinite loop. */
1951 else if (val
= get_pos_property (make_number (PT
),
1953 TEXT_PROP_MEANS_INVISIBLE (val
)
1954 && (val
= get_pos_property
1955 (make_number (PT
== beg
? end
: beg
),
1957 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1958 (check_composition
= check_display
= 1,
1959 SET_PT (PT
== beg
? end
: beg
));
1962 check_invisible
= 0;
1966 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1969 safe_run_hooks_1 (hook
)
1972 return call1 (Vrun_hooks
, Vinhibit_quit
);
1975 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1978 safe_run_hooks_error (data
)
1981 Lisp_Object args
[3];
1982 args
[0] = build_string ("Error in %s: %s");
1983 args
[1] = Vinhibit_quit
;
1986 return Fset (Vinhibit_quit
, Qnil
);
1989 /* If we get an error while running the hook, cause the hook variable
1990 to be nil. Also inhibit quits, so that C-g won't cause the hook
1991 to mysteriously evaporate. */
1994 safe_run_hooks (hook
)
1997 int count
= SPECPDL_INDEX ();
1998 specbind (Qinhibit_quit
, hook
);
2000 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2002 unbind_to (count
, Qnil
);
2006 /* Number of seconds between polling for input. This is a Lisp
2007 variable that can be bound. */
2009 EMACS_INT polling_period
;
2011 /* Nonzero means polling for input is temporarily suppressed. */
2013 int poll_suppress_count
;
2015 /* Asynchronous timer for polling. */
2017 struct atimer
*poll_timer
;
2020 #ifdef POLL_FOR_INPUT
2022 /* Poll for input, so what we catch a C-g if it comes in. This
2023 function is called from x_make_frame_visible, see comment
2029 if (interrupt_input_blocked
== 0
2030 && !waiting_for_input
)
2031 read_avail_input (0);
2034 /* Timer callback function for poll_timer. TIMER is equal to
2038 poll_for_input (timer
)
2039 struct atimer
*timer
;
2041 if (poll_suppress_count
== 0)
2042 poll_for_input_1 ();
2045 #endif /* POLL_FOR_INPUT */
2047 /* Begin signals to poll for input, if they are appropriate.
2048 This function is called unconditionally from various places. */
2053 #ifdef POLL_FOR_INPUT
2054 if (read_socket_hook
&& !interrupt_input
)
2056 /* Turn alarm handling on unconditionally. It might have
2057 been turned off in process.c. */
2058 turn_on_atimers (1);
2060 /* If poll timer doesn't exist, are we need one with
2061 a different interval, start a new one. */
2062 if (poll_timer
== NULL
2063 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2065 EMACS_TIME interval
;
2068 cancel_atimer (poll_timer
);
2070 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2071 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2072 poll_for_input
, NULL
);
2075 /* Let the timer's callback function poll for input
2076 if this becomes zero. */
2077 --poll_suppress_count
;
2082 /* Nonzero if we are using polling to handle input asynchronously. */
2085 input_polling_used ()
2087 #ifdef POLL_FOR_INPUT
2088 return read_socket_hook
&& !interrupt_input
;
2094 /* Turn off polling. */
2099 #ifdef POLL_FOR_INPUT
2100 if (read_socket_hook
&& !interrupt_input
)
2101 ++poll_suppress_count
;
2105 /* Set the value of poll_suppress_count to COUNT
2106 and start or stop polling accordingly. */
2109 set_poll_suppress_count (count
)
2112 #ifdef POLL_FOR_INPUT
2113 if (count
== 0 && poll_suppress_count
!= 0)
2115 poll_suppress_count
= 1;
2118 else if (count
!= 0 && poll_suppress_count
== 0)
2122 poll_suppress_count
= count
;
2126 /* Bind polling_period to a value at least N.
2127 But don't decrease it. */
2130 bind_polling_period (n
)
2133 #ifdef POLL_FOR_INPUT
2134 int new = polling_period
;
2139 stop_other_atimers (poll_timer
);
2141 specbind (Qpolling_period
, make_number (new));
2142 /* Start a new alarm with the new period. */
2147 /* Apply the control modifier to CHARACTER. */
2153 /* Save the upper bits here. */
2154 int upper
= c
& ~0177;
2158 /* Everything in the columns containing the upper-case letters
2159 denotes a control character. */
2160 if (c
>= 0100 && c
< 0140)
2164 /* Set the shift modifier for a control char
2165 made from a shifted letter. But only for letters! */
2166 if (oc
>= 'A' && oc
<= 'Z')
2167 c
|= shift_modifier
;
2170 /* The lower-case letters denote control characters too. */
2171 else if (c
>= 'a' && c
<= 'z')
2174 /* Include the bits for control and shift
2175 only if the basic ASCII code can't indicate them. */
2179 /* Replace the high bits. */
2180 c
|= (upper
& ~ctrl_modifier
);
2185 /* Display help echo in the echo area.
2187 HELP a string means display that string, HELP nil means clear the
2188 help echo. If HELP is a function, call it with OBJECT and POS as
2189 arguments; the function should return a help string or nil for
2190 none. For all other types of HELP evaluate it to obtain a string.
2192 WINDOW is the window in which the help was generated, if any.
2193 It is nil if not in a window.
2195 If OBJECT is a buffer, POS is the position in the buffer where the
2196 `help-echo' text property was found.
2198 If OBJECT is an overlay, that overlay has a `help-echo' property,
2199 and POS is the position in the overlay's buffer under the mouse.
2201 If OBJECT is a string (an overlay string or a string displayed with
2202 the `display' property). POS is the position in that string under
2205 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2206 echo overwrites a keystroke echo currently displayed in the echo
2209 Note: this function may only be called with HELP nil or a string
2210 from X code running asynchronously. */
2213 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2214 Lisp_Object help
, window
, object
, pos
;
2215 int ok_to_overwrite_keystroke_echo
;
2217 if (!NILP (help
) && !STRINGP (help
))
2219 if (FUNCTIONP (help
))
2221 Lisp_Object args
[4];
2226 help
= safe_call (4, args
);
2229 help
= safe_eval (help
);
2231 if (!STRINGP (help
))
2235 if (STRINGP (help
) || NILP (help
))
2237 if (!NILP (Vshow_help_function
))
2238 call1 (Vshow_help_function
, help
);
2239 else if (/* Don't overwrite minibuffer contents. */
2240 !MINI_WINDOW_P (XWINDOW (selected_window
))
2241 /* Don't overwrite a keystroke echo. */
2242 && (NILP (echo_message_buffer
)
2243 || ok_to_overwrite_keystroke_echo
)
2244 /* Don't overwrite a prompt. */
2245 && !cursor_in_echo_area
)
2249 int count
= SPECPDL_INDEX ();
2251 if (!help_echo_showing_p
)
2252 Vpre_help_message
= current_message ();
2254 specbind (Qmessage_truncate_lines
, Qt
);
2255 message3_nolog (help
, SBYTES (help
),
2256 STRING_MULTIBYTE (help
));
2257 unbind_to (count
, Qnil
);
2259 else if (STRINGP (Vpre_help_message
))
2261 message3_nolog (Vpre_help_message
,
2262 SBYTES (Vpre_help_message
),
2263 STRING_MULTIBYTE (Vpre_help_message
));
2264 Vpre_help_message
= Qnil
;
2270 help_echo_showing_p
= STRINGP (help
);
2276 /* Input of single characters from keyboard */
2278 Lisp_Object
print_help ();
2279 static Lisp_Object
kbd_buffer_get_event ();
2280 static void record_char ();
2283 static jmp_buf wrong_kboard_jmpbuf
;
2286 #define STOP_POLLING \
2287 do { if (! polling_stopped_here) stop_polling (); \
2288 polling_stopped_here = 1; } while (0)
2290 #define RESUME_POLLING \
2291 do { if (polling_stopped_here) start_polling (); \
2292 polling_stopped_here = 0; } while (0)
2294 /* read a character from the keyboard; call the redisplay if needed */
2295 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2296 -1 means do not do redisplay, but do do autosaving.
2299 /* The arguments MAPS and NMAPS are for menu prompting.
2300 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2302 PREV_EVENT is the previous input event, or nil if we are reading
2303 the first event of a key sequence (or not reading a key sequence).
2304 If PREV_EVENT is t, that is a "magic" value that says
2305 not to run input methods, but in other respects to act as if
2306 not reading a key sequence.
2308 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2309 if we used a mouse menu to read the input, or zero otherwise. If
2310 USED_MOUSE_MENU is null, we don't dereference it.
2312 Value is t if we showed a menu and the user rejected it. */
2315 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2319 Lisp_Object prev_event
;
2320 int *used_mouse_menu
;
2322 volatile Lisp_Object c
;
2324 jmp_buf local_getcjmp
;
2326 volatile int key_already_recorded
= 0;
2327 Lisp_Object tem
, save
;
2328 volatile Lisp_Object previous_echo_area_message
;
2329 volatile Lisp_Object also_record
;
2330 volatile int reread
;
2331 struct gcpro gcpro1
, gcpro2
;
2332 EMACS_TIME last_idle_start
;
2333 int polling_stopped_here
= 0;
2337 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2338 before_command_key_count
= this_command_key_count
;
2339 before_command_echo_length
= echo_length ();
2342 previous_echo_area_message
= Qnil
;
2344 GCPRO2 (c
, previous_echo_area_message
);
2349 if (CONSP (Vunread_post_input_method_events
))
2351 c
= XCAR (Vunread_post_input_method_events
);
2352 Vunread_post_input_method_events
2353 = XCDR (Vunread_post_input_method_events
);
2355 /* Undo what read_char_x_menu_prompt did when it unread
2356 additional keys returned by Fx_popup_menu. */
2358 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2366 if (unread_command_char
!= -1)
2368 XSETINT (c
, unread_command_char
);
2369 unread_command_char
= -1;
2375 if (CONSP (Vunread_command_events
))
2377 c
= XCAR (Vunread_command_events
);
2378 Vunread_command_events
= XCDR (Vunread_command_events
);
2380 /* Undo what read_char_x_menu_prompt did when it unread
2381 additional keys returned by Fx_popup_menu. */
2383 && EQ (XCDR (c
), Qdisabled
)
2384 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2387 /* If the queued event is something that used the mouse,
2388 set used_mouse_menu accordingly. */
2390 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2391 *used_mouse_menu
= 1;
2394 goto reread_for_input_method
;
2397 if (CONSP (Vunread_input_method_events
))
2399 c
= XCAR (Vunread_input_method_events
);
2400 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2402 /* Undo what read_char_x_menu_prompt did when it unread
2403 additional keys returned by Fx_popup_menu. */
2405 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2409 goto reread_for_input_method
;
2412 this_command_key_count_reset
= 0;
2414 if (!NILP (Vexecuting_macro
))
2416 /* We set this to Qmacro; since that's not a frame, nobody will
2417 try to switch frames on us, and the selected window will
2420 Since this event came from a macro, it would be misleading to
2421 leave internal_last_event_frame set to wherever the last
2422 real event came from. Normally, a switch-frame event selects
2423 internal_last_event_frame after each command is read, but
2424 events read from a macro should never cause a new frame to be
2426 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2428 /* Exit the macro if we are at the end.
2429 Also, some things replace the macro with t
2430 to force an early exit. */
2431 if (EQ (Vexecuting_macro
, Qt
)
2432 || executing_macro_index
>= XFASTINT (Flength (Vexecuting_macro
)))
2438 c
= Faref (Vexecuting_macro
, make_number (executing_macro_index
));
2439 if (STRINGP (Vexecuting_macro
)
2440 && (XINT (c
) & 0x80))
2441 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2443 executing_macro_index
++;
2448 if (!NILP (unread_switch_frame
))
2450 c
= unread_switch_frame
;
2451 unread_switch_frame
= Qnil
;
2453 /* This event should make it into this_command_keys, and get echoed
2454 again, so we do not set `reread'. */
2458 /* if redisplay was requested */
2459 if (commandflag
>= 0)
2461 /* If there is pending input, process any events which are not
2462 user-visible, such as X selection_request events. */
2464 || detect_input_pending_run_timers (0))
2465 swallow_events (0); /* may clear input_pending */
2467 /* Redisplay if no pending input. */
2468 while (!input_pending
)
2470 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2471 redisplay_preserve_echo_area (5);
2476 /* Normal case: no input arrived during redisplay. */
2479 /* Input arrived and pre-empted redisplay.
2480 Process any events which are not user-visible. */
2482 /* If that cleared input_pending, try again to redisplay. */
2486 /* Message turns off echoing unless more keystrokes turn it on again.
2488 The code in 20.x for the condition was
2490 1. echo_area_glyphs && *echo_area_glyphs
2491 2. && echo_area_glyphs != current_kboard->echobuf
2492 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2494 (1) means there's a current message displayed
2496 (2) means it's not the message from echoing from the current
2499 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2500 is set to a non-null value. This is done in read_char and it is
2501 set to echo_area_glyphs after a call to echo_char. That means
2502 ok_to_echo_at_next_pause is either null or
2503 current_kboard->echobuf with the appropriate current_kboard at
2506 So, condition (3) means in clear text ok_to_echo_at_next_pause
2507 must be either null, or the current message isn't from echoing at
2508 all, or it's from echoing from a different kboard than the
2511 if (/* There currently is something in the echo area. */
2512 !NILP (echo_area_buffer
[0])
2513 && (/* And it's either not from echoing. */
2514 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2515 /* Or it's an echo from a different kboard. */
2516 || echo_kboard
!= current_kboard
2517 /* Or we explicitly allow overwriting whatever there is. */
2518 || ok_to_echo_at_next_pause
== NULL
))
2523 /* Try reading a character via menu prompting in the minibuf.
2524 Try this before the sit-for, because the sit-for
2525 would do the wrong thing if we are supposed to do
2526 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2527 after a mouse event so don't try a minibuf menu. */
2529 if (nmaps
> 0 && INTERACTIVE
2530 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2531 /* Don't bring up a menu if we already have another event. */
2532 && NILP (Vunread_command_events
)
2533 && unread_command_char
< 0
2534 && !detect_input_pending_run_timers (0))
2536 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2539 key_already_recorded
= 1;
2544 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2545 We will do that below, temporarily for short sections of code,
2546 when appropriate. local_getcjmp must be in effect
2547 around any call to sit_for or kbd_buffer_get_event;
2548 it *must not* be in effect when we call redisplay. */
2550 if (_setjmp (local_getcjmp
))
2552 XSETINT (c
, quit_char
);
2553 internal_last_event_frame
= selected_frame
;
2554 Vlast_event_frame
= internal_last_event_frame
;
2555 /* If we report the quit char as an event,
2556 don't do so more than once. */
2557 if (!NILP (Vinhibit_quit
))
2562 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2563 if (kb
!= current_kboard
)
2565 Lisp_Object link
= kb
->kbd_queue
;
2566 /* We shouldn't get here if we were in single-kboard mode! */
2571 while (CONSP (XCDR (link
)))
2573 if (!NILP (XCDR (link
)))
2577 kb
->kbd_queue
= Fcons (c
, Qnil
);
2579 XSETCDR (link
, Fcons (c
, Qnil
));
2580 kb
->kbd_queue_has_data
= 1;
2581 current_kboard
= kb
;
2582 /* This is going to exit from read_char
2583 so we had better get rid of this frame's stuff. */
2585 longjmp (wrong_kboard_jmpbuf
, 1);
2592 timer_start_idle ();
2594 /* If in middle of key sequence and minibuffer not active,
2595 start echoing if enough time elapses. */
2597 if (minibuf_level
== 0
2598 && !current_kboard
->immediate_echo
2599 && this_command_key_count
> 0
2601 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2602 && NILP (Fzerop (Vecho_keystrokes
))
2603 && (/* No message. */
2604 NILP (echo_area_buffer
[0])
2605 /* Or empty message. */
2606 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2607 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2608 /* Or already echoing from same kboard. */
2609 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2610 /* Or not echoing before and echoing allowed. */
2611 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2615 /* After a mouse event, start echoing right away.
2616 This is because we are probably about to display a menu,
2617 and we don't want to delay before doing so. */
2618 if (EVENT_HAS_PARAMETERS (prev_event
))
2623 double duration
= extract_float (Vecho_keystrokes
);
2624 sec
= (int) duration
;
2625 usec
= (duration
- sec
) * 1000000;
2626 save_getcjmp (save_jump
);
2627 restore_getcjmp (local_getcjmp
);
2628 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2629 restore_getcjmp (save_jump
);
2631 && ! CONSP (Vunread_command_events
))
2636 /* Maybe auto save due to number of keystrokes. */
2638 if (commandflag
!= 0
2639 && auto_save_interval
> 0
2640 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2641 && !detect_input_pending_run_timers (0))
2643 Fdo_auto_save (Qnil
, Qnil
);
2644 /* Hooks can actually change some buffers in auto save. */
2648 /* Try reading using an X menu.
2649 This is never confused with reading using the minibuf
2650 because the recursive call of read_char in read_char_minibuf_menu_prompt
2651 does not pass on any keymaps. */
2653 if (nmaps
> 0 && INTERACTIVE
2654 && !NILP (prev_event
)
2655 && EVENT_HAS_PARAMETERS (prev_event
)
2656 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2657 && !EQ (XCAR (prev_event
), Qtool_bar
)
2658 /* Don't bring up a menu if we already have another event. */
2659 && NILP (Vunread_command_events
)
2660 && unread_command_char
< 0)
2662 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2664 /* Now that we have read an event, Emacs is not idle. */
2670 /* Maybe autosave and/or garbage collect due to idleness. */
2672 if (INTERACTIVE
&& NILP (c
))
2674 int delay_level
, buffer_size
;
2676 /* Slow down auto saves logarithmically in size of current buffer,
2677 and garbage collect while we're at it. */
2678 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2679 last_non_minibuf_size
= Z
- BEG
;
2680 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2682 while (buffer_size
> 64)
2683 delay_level
++, buffer_size
-= buffer_size
>> 2;
2684 if (delay_level
< 4) delay_level
= 4;
2685 /* delay_level is 4 for files under around 50k, 7 at 100k,
2686 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2688 /* Auto save if enough time goes by without input. */
2689 if (commandflag
!= 0
2690 && num_nonmacro_input_events
> last_auto_save
2691 && INTEGERP (Vauto_save_timeout
)
2692 && XINT (Vauto_save_timeout
) > 0)
2696 save_getcjmp (save_jump
);
2697 restore_getcjmp (local_getcjmp
);
2698 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2700 restore_getcjmp (save_jump
);
2703 && ! CONSP (Vunread_command_events
))
2705 Fdo_auto_save (Qnil
, Qnil
);
2707 /* If we have auto-saved and there is still no input
2708 available, garbage collect if there has been enough
2709 consing going on to make it worthwhile. */
2710 if (!detect_input_pending_run_timers (0)
2711 && consing_since_gc
> gc_cons_threshold
/ 2)
2712 Fgarbage_collect ();
2719 /* If this has become non-nil here, it has been set by a timer
2720 or sentinel or filter. */
2721 if (CONSP (Vunread_command_events
))
2723 c
= XCAR (Vunread_command_events
);
2724 Vunread_command_events
= XCDR (Vunread_command_events
);
2727 /* Read something from current KBOARD's side queue, if possible. */
2731 if (current_kboard
->kbd_queue_has_data
)
2733 if (!CONSP (current_kboard
->kbd_queue
))
2735 c
= XCAR (current_kboard
->kbd_queue
);
2736 current_kboard
->kbd_queue
2737 = XCDR (current_kboard
->kbd_queue
);
2738 if (NILP (current_kboard
->kbd_queue
))
2739 current_kboard
->kbd_queue_has_data
= 0;
2740 input_pending
= readable_events (0);
2741 if (EVENT_HAS_PARAMETERS (c
)
2742 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2743 internal_last_event_frame
= XCAR (XCDR (c
));
2744 Vlast_event_frame
= internal_last_event_frame
;
2749 /* If current_kboard's side queue is empty check the other kboards.
2750 If one of them has data that we have not yet seen here,
2751 switch to it and process the data waiting for it.
2753 Note: if the events queued up for another kboard
2754 have already been seen here, and therefore are not a complete command,
2755 the kbd_queue_has_data field is 0, so we skip that kboard here.
2756 That's to avoid an infinite loop switching between kboards here. */
2757 if (NILP (c
) && !single_kboard
)
2760 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2761 if (kb
->kbd_queue_has_data
)
2763 current_kboard
= kb
;
2764 /* This is going to exit from read_char
2765 so we had better get rid of this frame's stuff. */
2767 longjmp (wrong_kboard_jmpbuf
, 1);
2776 /* Finally, we read from the main queue,
2777 and if that gives us something we can't use yet, we put it on the
2778 appropriate side queue and try again. */
2784 /* Actually read a character, waiting if necessary. */
2785 save_getcjmp (save_jump
);
2786 restore_getcjmp (local_getcjmp
);
2787 timer_start_idle ();
2788 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2789 restore_getcjmp (save_jump
);
2792 if (! NILP (c
) && (kb
!= current_kboard
))
2794 Lisp_Object link
= kb
->kbd_queue
;
2797 while (CONSP (XCDR (link
)))
2799 if (!NILP (XCDR (link
)))
2803 kb
->kbd_queue
= Fcons (c
, Qnil
);
2805 XSETCDR (link
, Fcons (c
, Qnil
));
2806 kb
->kbd_queue_has_data
= 1;
2810 current_kboard
= kb
;
2811 /* This is going to exit from read_char
2812 so we had better get rid of this frame's stuff. */
2814 longjmp (wrong_kboard_jmpbuf
, 1);
2819 /* Terminate Emacs in batch mode if at eof. */
2820 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2821 Fkill_emacs (make_number (1));
2825 /* Add in any extra modifiers, where appropriate. */
2826 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2827 || ((extra_keyboard_modifiers
& 0177) < ' '
2828 && (extra_keyboard_modifiers
& 0177) != 0))
2829 XSETINT (c
, make_ctrl_char (XINT (c
)));
2831 /* Transfer any other modifier bits directly from
2832 extra_keyboard_modifiers to c. Ignore the actual character code
2833 in the low 16 bits of extra_keyboard_modifiers. */
2834 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2839 /* Record the last idle start time so that we can reset it
2840 should the next event read be a help-echo. */
2841 last_idle_start
= timer_idleness_start_time
;
2847 if (commandflag
>= 0
2848 && !input_pending
&& !detect_input_pending_run_timers (0))
2856 /* Buffer switch events are only for internal wakeups
2857 so don't show them to the user.
2858 Also, don't record a key if we already did. */
2859 if (BUFFERP (c
) || key_already_recorded
)
2862 /* Process special events within read_char
2863 and loop around to read another event. */
2866 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2871 int was_locked
= single_kboard
;
2873 last_input_char
= c
;
2874 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2876 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2877 /* We stopped being idle for this event; undo that. This
2878 prevents automatic window selection (under
2879 mouse_autoselect_window from acting as a real input event, for
2880 example banishing the mouse under mouse-avoidance-mode. */
2881 timer_idleness_start_time
= last_idle_start
;
2883 /* Resume allowing input from any kboard, if that was true before. */
2885 any_kboard_state ();
2890 /* Handle things that only apply to characters. */
2893 /* If kbd_buffer_get_event gave us an EOF, return that. */
2897 if ((STRINGP (Vkeyboard_translate_table
)
2898 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2899 || (VECTORP (Vkeyboard_translate_table
)
2900 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2901 || CHAR_TABLE_P (Vkeyboard_translate_table
))
2904 d
= Faref (Vkeyboard_translate_table
, c
);
2905 /* nil in keyboard-translate-table means no translation. */
2911 /* If this event is a mouse click in the menu bar,
2912 return just menu-bar for now. Modify the mouse click event
2913 so we won't do this twice, then queue it up. */
2914 if (EVENT_HAS_PARAMETERS (c
)
2916 && CONSP (EVENT_START (c
))
2917 && CONSP (XCDR (EVENT_START (c
))))
2921 posn
= POSN_POSN (EVENT_START (c
));
2922 /* Handle menu-bar events:
2923 insert the dummy prefix event `menu-bar'. */
2924 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2926 /* Change menu-bar to (menu-bar) as the event "position". */
2927 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2930 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2935 /* Store these characters into recent_keys, the dribble file if any,
2936 and the keyboard macro being defined, if any. */
2938 if (! NILP (also_record
))
2939 record_char (also_record
);
2941 /* Wipe the echo area.
2942 But first, if we are about to use an input method,
2943 save the echo area contents for it to refer to. */
2945 && ! NILP (Vinput_method_function
)
2946 && (unsigned) XINT (c
) >= ' '
2947 && (unsigned) XINT (c
) != 127
2948 && (unsigned) XINT (c
) < 256)
2950 previous_echo_area_message
= Fcurrent_message ();
2951 Vinput_method_previous_message
= previous_echo_area_message
;
2954 /* Now wipe the echo area, except for help events which do their
2955 own stuff with the echo area. */
2957 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2958 && !(EQ (Qswitch_frame
, XCAR (c
)))))
2960 if (!NILP (echo_area_buffer
[0]))
2961 safe_run_hooks (Qecho_area_clear_hook
);
2962 clear_message (1, 0);
2965 reread_for_input_method
:
2967 /* Pass this to the input method, if appropriate. */
2969 && ! NILP (Vinput_method_function
)
2970 /* Don't run the input method within a key sequence,
2971 after the first event of the key sequence. */
2972 && NILP (prev_event
)
2973 && (unsigned) XINT (c
) >= ' '
2974 && (unsigned) XINT (c
) != 127
2975 && (unsigned) XINT (c
) < 256)
2978 int key_count
, key_count_reset
;
2979 struct gcpro gcpro1
;
2980 int count
= SPECPDL_INDEX ();
2982 /* Save the echo status. */
2983 int saved_immediate_echo
= current_kboard
->immediate_echo
;
2984 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2985 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2988 if (before_command_restore_flag
)
2990 this_command_key_count
= before_command_key_count_1
;
2991 if (this_command_key_count
< this_single_command_key_start
)
2992 this_single_command_key_start
= this_command_key_count
;
2993 echo_truncate (before_command_echo_length_1
);
2994 before_command_restore_flag
= 0;
2998 /* Save the this_command_keys status. */
2999 key_count
= this_command_key_count
;
3000 key_count_reset
= this_command_key_count_reset
;
3003 keys
= Fcopy_sequence (this_command_keys
);
3008 /* Clear out this_command_keys. */
3009 this_command_key_count
= 0;
3010 this_command_key_count_reset
= 0;
3012 /* Now wipe the echo area. */
3013 if (!NILP (echo_area_buffer
[0]))
3014 safe_run_hooks (Qecho_area_clear_hook
);
3015 clear_message (1, 0);
3018 /* If we are not reading a key sequence,
3019 never use the echo area. */
3022 specbind (Qinput_method_use_echo_area
, Qt
);
3025 /* Call the input method. */
3026 tem
= call1 (Vinput_method_function
, c
);
3028 tem
= unbind_to (count
, tem
);
3030 /* Restore the saved echoing state
3031 and this_command_keys state. */
3032 this_command_key_count
= key_count
;
3033 this_command_key_count_reset
= key_count_reset
;
3035 this_command_keys
= keys
;
3038 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3039 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3040 if (saved_immediate_echo
)
3045 /* The input method can return no events. */
3048 /* Bring back the previous message, if any. */
3049 if (! NILP (previous_echo_area_message
))
3050 message_with_string ("%s", previous_echo_area_message
, 0);
3053 /* It returned one event or more. */
3055 Vunread_post_input_method_events
3056 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3061 /* Display help if not echoing. */
3062 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3064 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3065 Lisp_Object help
, object
, position
, window
, tem
;
3067 tem
= Fcdr (XCDR (c
));
3070 window
= Fcar (tem
);
3072 object
= Fcar (tem
);
3074 position
= Fcar (tem
);
3076 show_help_echo (help
, window
, object
, position
, 0);
3078 /* We stopped being idle for this event; undo that. */
3079 timer_idleness_start_time
= last_idle_start
;
3083 if (! reread
|| this_command_key_count
== 0
3084 || this_command_key_count_reset
)
3087 /* Don't echo mouse motion events. */
3088 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3089 && NILP (Fzerop (Vecho_keystrokes
))
3090 && ! (EVENT_HAS_PARAMETERS (c
)
3091 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3094 if (! NILP (also_record
))
3095 echo_char (also_record
);
3096 /* Once we reread a character, echoing can happen
3097 the next time we pause to read a new one. */
3098 ok_to_echo_at_next_pause
= current_kboard
;
3101 /* Record this character as part of the current key. */
3102 add_command_key (c
);
3103 if (! NILP (also_record
))
3104 add_command_key (also_record
);
3107 last_input_char
= c
;
3110 /* Process the help character specially if enabled */
3111 if (!NILP (Vhelp_form
) && help_char_p (c
))
3114 count
= SPECPDL_INDEX ();
3116 record_unwind_protect (Fset_window_configuration
,
3117 Fcurrent_window_configuration (Qnil
));
3119 tem0
= Feval (Vhelp_form
);
3121 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3125 c
= read_char (0, 0, 0, Qnil
, 0);
3126 while (BUFFERP (c
));
3127 /* Remove the help from the frame */
3128 unbind_to (count
, Qnil
);
3131 if (EQ (c
, make_number (040)))
3135 c
= read_char (0, 0, 0, Qnil
, 0);
3136 while (BUFFERP (c
));
3145 /* Record a key that came from a mouse menu.
3146 Record it for echoing, for this-command-keys, and so on. */
3152 /* Wipe the echo area. */
3153 clear_message (1, 0);
3158 before_command_key_count
= this_command_key_count
;
3159 before_command_echo_length
= echo_length ();
3162 /* Don't echo mouse motion events. */
3163 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3164 && NILP (Fzerop (Vecho_keystrokes
)))
3168 /* Once we reread a character, echoing can happen
3169 the next time we pause to read a new one. */
3170 ok_to_echo_at_next_pause
= 0;
3173 /* Record this character as part of the current key. */
3174 add_command_key (c
);
3176 /* Re-reading in the middle of a command */
3177 last_input_char
= c
;
3181 /* Return 1 if should recognize C as "the help character". */
3189 if (EQ (c
, Vhelp_char
))
3191 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3192 if (EQ (c
, XCAR (tail
)))
3197 /* Record the input event C in various ways. */
3205 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3207 /* To avoid filling recent_keys with help-echo and mouse-movement
3208 events, we filter out repeated help-echo events, only store the
3209 first and last in a series of mouse-movement events, and don't
3210 store repeated help-echo events which are only separated by
3211 mouse-movement events. */
3213 Lisp_Object ev1
, ev2
, ev3
;
3216 if ((ix1
= recent_keys_index
- 1) < 0)
3217 ix1
= NUM_RECENT_KEYS
- 1;
3218 ev1
= AREF (recent_keys
, ix1
);
3220 if ((ix2
= ix1
- 1) < 0)
3221 ix2
= NUM_RECENT_KEYS
- 1;
3222 ev2
= AREF (recent_keys
, ix2
);
3224 if ((ix3
= ix2
- 1) < 0)
3225 ix3
= NUM_RECENT_KEYS
- 1;
3226 ev3
= AREF (recent_keys
, ix3
);
3228 if (EQ (XCAR (c
), Qhelp_echo
))
3230 /* Don't record `help-echo' in recent_keys unless it shows some help
3231 message, and a different help than the previously recorded
3233 Lisp_Object help
, last_help
;
3235 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3236 if (!STRINGP (help
))
3238 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3239 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3241 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3242 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3243 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3245 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3246 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3247 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3248 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3251 else if (EQ (XCAR (c
), Qmouse_movement
))
3253 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3254 So additional mouse movement events replace the last element. */
3255 Lisp_Object last_window
, window
;
3257 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3258 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3259 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3260 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3261 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3263 ASET (recent_keys
, ix1
, c
);
3269 store_kbd_macro_char (c
);
3274 ASET (recent_keys
, recent_keys_index
, c
);
3275 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3276 recent_keys_index
= 0;
3278 else if (recorded
< 0)
3280 /* We need to remove one or two events from recent_keys.
3281 To do this, we simply put nil at those events and move the
3282 recent_keys_index backwards over those events. Usually,
3283 users will never see those nil events, as they will be
3284 overwritten by the command keys entered to see recent_keys
3287 while (recorded
++ < 0 && total_keys
> 0)
3289 if (total_keys
< NUM_RECENT_KEYS
)
3291 if (--recent_keys_index
< 0)
3292 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3293 ASET (recent_keys
, recent_keys_index
, Qnil
);
3297 num_nonmacro_input_events
++;
3299 /* Write c to the dribble file. If c is a lispy event, write
3300 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3301 If you, dear reader, have a better idea, you've got the source. :-) */
3306 if (XUINT (c
) < 0x100)
3307 putc (XINT (c
), dribble
);
3309 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3313 Lisp_Object dribblee
;
3315 /* If it's a structured event, take the event header. */
3316 dribblee
= EVENT_HEAD (c
);
3318 if (SYMBOLP (dribblee
))
3320 putc ('<', dribble
);
3321 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3322 SBYTES (SYMBOL_NAME (dribblee
)),
3324 putc ('>', dribble
);
3336 struct buffer
*old
= current_buffer
;
3337 Fprinc (object
, Qnil
);
3338 set_buffer_internal (XBUFFER (Vstandard_output
));
3339 call0 (intern ("help-mode"));
3340 set_buffer_internal (old
);
3344 /* Copy out or in the info on where C-g should throw to.
3345 This is used when running Lisp code from within get_char,
3346 in case get_char is called recursively.
3347 See read_process_output. */
3353 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3357 restore_getcjmp (temp
)
3360 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3365 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3366 of this function. */
3369 tracking_off (old_value
)
3370 Lisp_Object old_value
;
3372 do_mouse_tracking
= old_value
;
3373 if (NILP (old_value
))
3375 /* Redisplay may have been preempted because there was input
3376 available, and it assumes it will be called again after the
3377 input has been processed. If the only input available was
3378 the sort that we have just disabled, then we need to call
3380 if (!readable_events (1))
3382 redisplay_preserve_echo_area (6);
3383 get_input_pending (&input_pending
, 1);
3389 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3390 doc
: /* Evaluate BODY with mouse movement events enabled.
3391 Within a `track-mouse' form, mouse motion generates input events that
3392 you can read with `read-event'.
3393 Normally, mouse motion is ignored.
3394 usage: (track-mouse BODY ...) */)
3398 int count
= SPECPDL_INDEX ();
3401 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3403 do_mouse_tracking
= Qt
;
3405 val
= Fprogn (args
);
3406 return unbind_to (count
, val
);
3409 /* If mouse has moved on some frame, return one of those frames.
3410 Return 0 otherwise. */
3415 Lisp_Object tail
, frame
;
3417 FOR_EACH_FRAME (tail
, frame
)
3419 if (XFRAME (frame
)->mouse_moved
)
3420 return XFRAME (frame
);
3426 #endif /* HAVE_MOUSE */
3428 /* Low level keyboard/mouse input.
3429 kbd_buffer_store_event places events in kbd_buffer, and
3430 kbd_buffer_get_event retrieves them. */
3432 /* Return true iff there are any events in the queue that read-char
3433 would return. If this returns false, a read-char would block. */
3435 readable_filtered_events (do_timers_now
, filter_events
)
3440 timer_check (do_timers_now
);
3442 /* If the buffer contains only FOCUS_IN_EVENT events,
3443 and FILTER_EVENTS is nonzero, report it as empty. */
3444 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3446 int have_live_event
= 1;
3450 struct input_event
*event
;
3452 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3456 while (have_live_event
&& event
->kind
== FOCUS_IN_EVENT
)
3459 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3461 if (event
== kbd_store_ptr
)
3462 have_live_event
= 0;
3465 if (have_live_event
) return 1;
3469 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3474 if (current_kboard
->kbd_queue_has_data
)
3480 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3481 if (kb
->kbd_queue_has_data
)
3487 /* Return true iff there are any events in the queue that read-char
3488 would return. If this returns false, a read-char would block. */
3490 readable_events (do_timers_now
)
3493 return readable_filtered_events (do_timers_now
, 0);
3496 /* Set this for debugging, to have a way to get out */
3501 event_to_kboard (event
)
3502 struct input_event
*event
;
3505 frame
= event
->frame_or_window
;
3507 frame
= XCAR (frame
);
3508 else if (WINDOWP (frame
))
3509 frame
= WINDOW_FRAME (XWINDOW (frame
));
3511 /* There are still some events that don't set this field.
3512 For now, just ignore the problem.
3513 Also ignore dead frames here. */
3514 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3517 return FRAME_KBOARD (XFRAME (frame
));
3521 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3524 kbd_buffer_store_event (event
)
3525 register struct input_event
*event
;
3527 kbd_buffer_store_event_hold (event
, 0);
3530 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3532 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3533 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3534 Else, if EVENT is a quit event, store the quit event
3535 in HOLD_QUIT, and return (thus ignoring further events).
3537 This is used in read_avail_input to postpone the processing
3538 of the quit event until all subsequent input events have been
3539 parsed (and discarded).
3543 kbd_buffer_store_event_hold (event
, hold_quit
)
3544 register struct input_event
*event
;
3545 struct input_event
*hold_quit
;
3547 if (event
->kind
== NO_EVENT
)
3550 if (hold_quit
&& hold_quit
->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
;
3596 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3600 /* If this results in a quit_char being returned to Emacs as
3601 input, set Vlast_event_frame properly. If this doesn't
3602 get returned to Emacs as an event, the next event read
3603 will set Vlast_event_frame again, so this is safe to do. */
3607 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3609 focus
= event
->frame_or_window
;
3610 internal_last_event_frame
= focus
;
3611 Vlast_event_frame
= focus
;
3614 last_event_timestamp
= event
->timestamp
;
3615 interrupt_signal (0 /* dummy */);
3619 if (c
&& c
== stop_character
)
3625 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3626 Just ignore the second one. */
3627 else if (event
->kind
== BUFFER_SWITCH_EVENT
3628 && kbd_fetch_ptr
!= kbd_store_ptr
3629 && ((kbd_store_ptr
== kbd_buffer
3630 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3631 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3634 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3635 kbd_store_ptr
= kbd_buffer
;
3637 /* Don't let the very last slot in the buffer become full,
3638 since that would make the two pointers equal,
3639 and that is indistinguishable from an empty buffer.
3640 Discard the event if it would fill the last slot. */
3641 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3644 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3645 prone to assign individual members for other events, in case
3646 the input_event structure is changed. --2000-07-13, gerd. */
3647 struct input_event
*sp
= kbd_store_ptr
;
3648 sp
->kind
= event
->kind
;
3649 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3651 /* We must not use the ordinary copying code for this case,
3652 since `part' is an enum and copying it might not copy enough
3654 bcopy (event
, (char *) sp
, sizeof (*event
));
3659 sp
->code
= event
->code
;
3660 sp
->part
= event
->part
;
3661 sp
->frame_or_window
= event
->frame_or_window
;
3662 sp
->arg
= event
->arg
;
3663 sp
->modifiers
= event
->modifiers
;
3666 sp
->timestamp
= event
->timestamp
;
3669 *kbd_store_ptr
= *event
;
3677 /* Generate HELP_EVENT input_events in BUFP which has room for
3678 SIZE events. If there's not enough room in BUFP, ignore this
3681 HELP is the help form.
3683 FRAME is the frame on which the help is generated. OBJECT is the
3684 Lisp object where the help was found (a buffer, a string, an
3685 overlay, or nil if neither from a string nor from a buffer. POS is
3686 the position within OBJECT where the help was found.
3688 Value is the number of input_events generated. */
3691 gen_help_event (help
, frame
, window
, object
, pos
)
3692 Lisp_Object help
, frame
, object
, window
;
3695 struct input_event event
;
3699 event
.kind
= HELP_EVENT
;
3700 event
.frame_or_window
= frame
;
3702 event
.x
= WINDOWP (window
) ? window
: frame
;
3705 kbd_buffer_store_event (&event
);
3709 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3712 kbd_buffer_store_help_event (frame
, help
)
3713 Lisp_Object frame
, help
;
3715 struct input_event event
;
3717 event
.kind
= HELP_EVENT
;
3718 event
.frame_or_window
= frame
;
3723 kbd_buffer_store_event (&event
);
3727 /* Discard any mouse events in the event buffer by setting them to
3730 discard_mouse_events ()
3732 struct input_event
*sp
;
3733 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3735 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3738 if (sp
->kind
== MOUSE_CLICK_EVENT
3739 || sp
->kind
== WHEEL_EVENT
3741 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3743 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3745 sp
->kind
= NO_EVENT
;
3751 /* Return non-zero if there are any real events waiting in the event
3752 buffer, not counting `NO_EVENT's.
3754 If DISCARD is non-zero, discard NO_EVENT events at the front of
3755 the input queue, possibly leaving the input queue empty if there
3756 are no real input events. */
3759 kbd_buffer_events_waiting (discard
)
3762 struct input_event
*sp
;
3764 for (sp
= kbd_fetch_ptr
;
3765 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3768 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3775 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3779 /* Clear input event EVENT. */
3783 struct input_event
*event
;
3785 event
->kind
= NO_EVENT
;
3789 /* Read one event from the event buffer, waiting if necessary.
3790 The value is a Lisp object representing the event.
3791 The value is nil for an event that should be ignored,
3792 or that was handled here.
3793 We always read and discard one event. */
3796 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3798 int *used_mouse_menu
;
3807 *kbp
= current_kboard
;
3811 /* Wait until there is input available. */
3814 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3817 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3821 /* If the quit flag is set, then read_char will return
3822 quit_char, so that counts as "available input." */
3823 if (!NILP (Vquit_flag
))
3824 quit_throw_to_read_char ();
3826 /* One way or another, wait until input is available; then, if
3827 interrupt handlers have not read it, read it now. */
3830 wait_for_kbd_input ();
3832 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3836 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3839 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3843 Lisp_Object minus_one
;
3845 XSETINT (minus_one
, -1);
3846 wait_reading_process_input (0, 0, minus_one
, 1);
3848 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3849 /* Pass 1 for EXPECT since we just waited to have input. */
3850 read_avail_input (1);
3852 #endif /* not VMS */
3855 if (CONSP (Vunread_command_events
))
3858 first
= XCAR (Vunread_command_events
);
3859 Vunread_command_events
= XCDR (Vunread_command_events
);
3860 *kbp
= current_kboard
;
3864 /* At this point, we know that there is a readable event available
3865 somewhere. If the event queue is empty, then there must be a
3866 mouse movement enabled and available. */
3867 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3869 struct input_event
*event
;
3871 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3875 last_event_timestamp
= event
->timestamp
;
3878 *kbp
= event_to_kboard (event
);
3880 *kbp
= current_kboard
; /* Better than returning null ptr? */
3882 *kbp
= &the_only_kboard
;
3887 /* These two kinds of events get special handling
3888 and don't actually appear to the command loop.
3889 We return nil for them. */
3890 if (event
->kind
== SELECTION_REQUEST_EVENT
)
3893 struct input_event copy
;
3895 /* Remove it from the buffer before processing it,
3896 since otherwise swallow_events will see it
3897 and process it again. */
3899 kbd_fetch_ptr
= event
+ 1;
3900 input_pending
= readable_events (0);
3901 x_handle_selection_request (©
);
3903 /* We're getting selection request events, but we don't have
3909 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
3912 struct input_event copy
;
3914 /* Remove it from the buffer before processing it. */
3916 kbd_fetch_ptr
= event
+ 1;
3917 input_pending
= readable_events (0);
3918 x_handle_selection_clear (©
);
3920 /* We're getting selection request events, but we don't have
3925 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3926 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3928 /* Make an event (delete-frame (FRAME)). */
3929 obj
= Fcons (event
->frame_or_window
, Qnil
);
3930 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3931 kbd_fetch_ptr
= event
+ 1;
3934 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3935 else if (event
->kind
== ICONIFY_EVENT
)
3937 /* Make an event (iconify-frame (FRAME)). */
3938 obj
= Fcons (event
->frame_or_window
, Qnil
);
3939 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3940 kbd_fetch_ptr
= event
+ 1;
3942 else if (event
->kind
== DEICONIFY_EVENT
)
3944 /* Make an event (make-frame-visible (FRAME)). */
3945 obj
= Fcons (event
->frame_or_window
, Qnil
);
3946 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3947 kbd_fetch_ptr
= event
+ 1;
3950 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3952 /* The value doesn't matter here; only the type is tested. */
3953 XSETBUFFER (obj
, current_buffer
);
3954 kbd_fetch_ptr
= event
+ 1;
3956 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
3957 || defined (USE_GTK)
3958 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3960 kbd_fetch_ptr
= event
+ 1;
3961 input_pending
= readable_events (0);
3962 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3963 x_activate_menubar (XFRAME (event
->frame_or_window
));
3967 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3969 /* Make an event (language-change (FRAME CHARSET LCID)). */
3970 obj
= Fcons (event
->modifiers
, Qnil
);
3971 obj
= Fcons (event
->code
, obj
);
3972 obj
= Fcons (event
->frame_or_window
, obj
);
3973 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
3974 kbd_fetch_ptr
= event
+ 1;
3977 else if (event
->kind
== SAVE_SESSION_EVENT
)
3979 obj
= Fcons (Qsave_session
, Qnil
);
3980 kbd_fetch_ptr
= event
+ 1;
3982 /* Just discard these, by returning nil.
3983 With MULTI_KBOARD, these events are used as placeholders
3984 when we need to randomly delete events from the queue.
3985 (They shouldn't otherwise be found in the buffer,
3986 but on some machines it appears they do show up
3987 even without MULTI_KBOARD.) */
3988 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3989 mouse events during a popup-menu call. */
3990 else if (event
->kind
== NO_EVENT
)
3991 kbd_fetch_ptr
= event
+ 1;
3992 else if (event
->kind
== HELP_EVENT
)
3994 Lisp_Object object
, position
, help
, frame
, window
;
3996 frame
= event
->frame_or_window
;
3997 object
= event
->arg
;
3998 position
= make_number (event
->code
);
4001 clear_event (event
);
4003 kbd_fetch_ptr
= event
+ 1;
4004 if (!WINDOWP (window
))
4006 obj
= Fcons (Qhelp_echo
,
4007 list5 (frame
, help
, window
, object
, position
));
4009 else if (event
->kind
== FOCUS_IN_EVENT
)
4011 /* Notification of a FocusIn event. The frame receiving the
4012 focus is in event->frame_or_window. Generate a
4013 switch-frame event if necessary. */
4014 Lisp_Object frame
, focus
;
4016 frame
= event
->frame_or_window
;
4017 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4021 if (!EQ (frame
, internal_last_event_frame
)
4022 && !EQ (frame
, selected_frame
))
4023 obj
= make_lispy_switch_frame (frame
);
4024 internal_last_event_frame
= frame
;
4025 kbd_fetch_ptr
= event
+ 1;
4029 /* If this event is on a different frame, return a switch-frame this
4030 time, and leave the event in the queue for next time. */
4034 frame
= event
->frame_or_window
;
4036 frame
= XCAR (frame
);
4037 else if (WINDOWP (frame
))
4038 frame
= WINDOW_FRAME (XWINDOW (frame
));
4040 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4044 if (! EQ (frame
, internal_last_event_frame
)
4045 && !EQ (frame
, selected_frame
))
4046 obj
= make_lispy_switch_frame (frame
);
4047 internal_last_event_frame
= frame
;
4049 /* If we didn't decide to make a switch-frame event, go ahead
4050 and build a real event from the queue entry. */
4054 obj
= make_lispy_event (event
);
4056 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4057 || defined (USE_GTK)
4058 /* If this was a menu selection, then set the flag to inhibit
4059 writing to last_nonmenu_event. Don't do this if the event
4060 we're returning is (menu-bar), though; that indicates the
4061 beginning of the menu sequence, and we might as well leave
4062 that as the `event with parameters' for this selection. */
4064 && !EQ (event
->frame_or_window
, event
->arg
)
4065 && (event
->kind
== MENU_BAR_EVENT
4066 || event
->kind
== TOOL_BAR_EVENT
))
4067 *used_mouse_menu
= 1;
4070 /* Wipe out this event, to catch bugs. */
4071 clear_event (event
);
4072 kbd_fetch_ptr
= event
+ 1;
4077 /* Try generating a mouse motion event. */
4078 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4080 FRAME_PTR f
= some_mouse_moved ();
4081 Lisp_Object bar_window
;
4082 enum scroll_bar_part part
;
4086 *kbp
= current_kboard
;
4087 /* Note that this uses F to determine which display to look at.
4088 If there is no valid info, it does not store anything
4089 so x remains nil. */
4091 (*mouse_position_hook
) (&f
, 0, &bar_window
, &part
, &x
, &y
, &time
);
4095 /* Decide if we should generate a switch-frame event. Don't
4096 generate switch-frame events for motion outside of all Emacs
4102 frame
= FRAME_FOCUS_FRAME (f
);
4104 XSETFRAME (frame
, f
);
4106 if (! EQ (frame
, internal_last_event_frame
)
4107 && !EQ (frame
, selected_frame
))
4108 obj
= make_lispy_switch_frame (frame
);
4109 internal_last_event_frame
= frame
;
4112 /* If we didn't decide to make a switch-frame event, go ahead and
4113 return a mouse-motion event. */
4114 if (!NILP (x
) && NILP (obj
))
4115 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4117 #endif /* HAVE_MOUSE */
4119 /* We were promised by the above while loop that there was
4120 something for us to read! */
4123 input_pending
= readable_events (0);
4125 Vlast_event_frame
= internal_last_event_frame
;
4130 /* Process any events that are not user-visible,
4131 then return, without reading any user-visible events. */
4134 swallow_events (do_display
)
4139 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4141 struct input_event
*event
;
4143 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4147 last_event_timestamp
= event
->timestamp
;
4149 /* These two kinds of events get special handling
4150 and don't actually appear to the command loop. */
4151 if (event
->kind
== SELECTION_REQUEST_EVENT
)
4154 struct input_event copy
;
4156 /* Remove it from the buffer before processing it,
4157 since otherwise swallow_events called recursively could see it
4158 and process it again. */
4160 kbd_fetch_ptr
= event
+ 1;
4161 input_pending
= readable_events (0);
4162 x_handle_selection_request (©
);
4164 /* We're getting selection request events, but we don't have
4170 else if (event
->kind
== SELECTION_CLEAR_EVENT
)
4173 struct input_event copy
;
4175 /* Remove it from the buffer before processing it, */
4178 kbd_fetch_ptr
= event
+ 1;
4179 input_pending
= readable_events (0);
4180 x_handle_selection_clear (©
);
4182 /* We're getting selection request events, but we don't have
4191 old_timers_run
= timers_run
;
4192 get_input_pending (&input_pending
, 1);
4194 if (timers_run
!= old_timers_run
&& do_display
)
4195 redisplay_preserve_echo_area (7);
4198 /* Record the start of when Emacs is idle,
4199 for the sake of running idle-time timers. */
4206 /* If we are already in the idle state, do nothing. */
4207 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4210 EMACS_GET_TIME (timer_idleness_start_time
);
4212 timer_last_idleness_start_time
= timer_idleness_start_time
;
4214 /* Mark all idle-time timers as once again candidates for running. */
4215 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4219 timer
= XCAR (timers
);
4221 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4223 XVECTOR (timer
)->contents
[0] = Qnil
;
4227 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4232 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4235 /* This is only for debugging. */
4236 struct input_event last_timer_event
;
4238 /* Check whether a timer has fired. To prevent larger problems we simply
4239 disregard elements that are not proper timers. Do not make a circular
4240 timer list for the time being.
4242 Returns the number of seconds to wait until the next timer fires. If a
4243 timer is triggering now, return zero seconds.
4244 If no timer is active, return -1 seconds.
4246 If a timer is ripe, we run it, with quitting turned off.
4248 DO_IT_NOW is now ignored. It used to mean that we should
4249 run the timer directly instead of queueing a timer-event.
4250 Now we always run timers directly. */
4253 timer_check (do_it_now
)
4256 EMACS_TIME nexttime
;
4257 EMACS_TIME now
, idleness_now
;
4258 Lisp_Object timers
, idle_timers
, chosen_timer
;
4259 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4261 EMACS_SET_SECS (nexttime
, -1);
4262 EMACS_SET_USECS (nexttime
, -1);
4264 /* Always consider the ordinary timers. */
4265 timers
= Vtimer_list
;
4266 /* Consider the idle timers only if Emacs is idle. */
4267 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4268 idle_timers
= Vtimer_idle_list
;
4271 chosen_timer
= Qnil
;
4272 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4274 if (CONSP (timers
) || CONSP (idle_timers
))
4276 EMACS_GET_TIME (now
);
4277 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4278 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4281 while (CONSP (timers
) || CONSP (idle_timers
))
4283 Lisp_Object
*vector
;
4284 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4285 EMACS_TIME timer_time
, idle_timer_time
;
4286 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4288 /* Skip past invalid timers and timers already handled. */
4291 timer
= XCAR (timers
);
4292 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4294 timers
= XCDR (timers
);
4297 vector
= XVECTOR (timer
)->contents
;
4299 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4300 || !INTEGERP (vector
[3])
4301 || ! NILP (vector
[0]))
4303 timers
= XCDR (timers
);
4307 if (!NILP (idle_timers
))
4309 timer
= XCAR (idle_timers
);
4310 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4312 idle_timers
= XCDR (idle_timers
);
4315 vector
= XVECTOR (timer
)->contents
;
4317 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4318 || !INTEGERP (vector
[3])
4319 || ! NILP (vector
[0]))
4321 idle_timers
= XCDR (idle_timers
);
4326 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4327 based on the next ordinary timer.
4328 TIMER_DIFFERENCE is the distance in time from NOW to when
4329 this timer becomes ripe (negative if it's already ripe). */
4332 timer
= XCAR (timers
);
4333 vector
= XVECTOR (timer
)->contents
;
4334 EMACS_SET_SECS (timer_time
,
4335 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4336 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4337 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4340 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4341 based on the next idle timer. */
4342 if (!NILP (idle_timers
))
4344 idle_timer
= XCAR (idle_timers
);
4345 vector
= XVECTOR (idle_timer
)->contents
;
4346 EMACS_SET_SECS (idle_timer_time
,
4347 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4348 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4349 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4352 /* Decide which timer is the next timer,
4353 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4354 Also step down the list where we found that timer. */
4356 if (! NILP (timers
) && ! NILP (idle_timers
))
4359 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4360 if (EMACS_TIME_NEG_P (temp
))
4362 chosen_timer
= timer
;
4363 timers
= XCDR (timers
);
4364 difference
= timer_difference
;
4368 chosen_timer
= idle_timer
;
4369 idle_timers
= XCDR (idle_timers
);
4370 difference
= idle_timer_difference
;
4373 else if (! NILP (timers
))
4375 chosen_timer
= timer
;
4376 timers
= XCDR (timers
);
4377 difference
= timer_difference
;
4381 chosen_timer
= idle_timer
;
4382 idle_timers
= XCDR (idle_timers
);
4383 difference
= idle_timer_difference
;
4385 vector
= XVECTOR (chosen_timer
)->contents
;
4387 /* If timer is ripe, run it if it hasn't been run. */
4388 if (EMACS_TIME_NEG_P (difference
)
4389 || (EMACS_SECS (difference
) == 0
4390 && EMACS_USECS (difference
) == 0))
4392 if (NILP (vector
[0]))
4394 int was_locked
= single_kboard
;
4395 int count
= SPECPDL_INDEX ();
4396 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4398 /* Mark the timer as triggered to prevent problems if the lisp
4399 code fails to reschedule it right. */
4402 specbind (Qinhibit_quit
, Qt
);
4404 call1 (Qtimer_event_handler
, chosen_timer
);
4405 Vdeactivate_mark
= old_deactivate_mark
;
4407 unbind_to (count
, Qnil
);
4409 /* Resume allowing input from any kboard, if that was true before. */
4411 any_kboard_state ();
4413 /* Since we have handled the event,
4414 we don't need to tell the caller to wake up and do it. */
4418 /* When we encounter a timer that is still waiting,
4419 return the amount of time to wait before it is ripe. */
4426 /* No timers are pending in the future. */
4427 /* Return 0 if we generated an event, and -1 if not. */
4432 /* Caches for modify_event_symbol. */
4433 static Lisp_Object accent_key_syms
;
4434 static Lisp_Object func_key_syms
;
4435 static Lisp_Object mouse_syms
;
4436 static Lisp_Object wheel_syms
;
4437 static Lisp_Object drag_n_drop_syms
;
4439 /* This is a list of keysym codes for special "accent" characters.
4440 It parallels lispy_accent_keys. */
4442 static int lispy_accent_codes
[] =
4444 #ifdef XK_dead_circumflex
4449 #ifdef XK_dead_grave
4454 #ifdef XK_dead_tilde
4459 #ifdef XK_dead_diaeresis
4464 #ifdef XK_dead_macron
4469 #ifdef XK_dead_degree
4474 #ifdef XK_dead_acute
4479 #ifdef XK_dead_cedilla
4484 #ifdef XK_dead_breve
4489 #ifdef XK_dead_ogonek
4494 #ifdef XK_dead_caron
4499 #ifdef XK_dead_doubleacute
4500 XK_dead_doubleacute
,
4504 #ifdef XK_dead_abovedot
4509 #ifdef XK_dead_abovering
4519 #ifdef XK_dead_belowdot
4524 #ifdef XK_dead_voiced_sound
4525 XK_dead_voiced_sound
,
4529 #ifdef XK_dead_semivoiced_sound
4530 XK_dead_semivoiced_sound
,
4546 /* This is a list of Lisp names for special "accent" characters.
4547 It parallels lispy_accent_codes. */
4549 static char *lispy_accent_keys
[] =
4567 "dead-voiced-sound",
4568 "dead-semivoiced-sound",
4574 #define FUNCTION_KEY_OFFSET 0x0
4576 char *lispy_function_keys
[] =
4580 0, /* VK_LBUTTON 0x01 */
4581 0, /* VK_RBUTTON 0x02 */
4582 "cancel", /* VK_CANCEL 0x03 */
4583 0, /* VK_MBUTTON 0x04 */
4585 0, 0, 0, /* 0x05 .. 0x07 */
4587 "backspace", /* VK_BACK 0x08 */
4588 "tab", /* VK_TAB 0x09 */
4590 0, 0, /* 0x0A .. 0x0B */
4592 "clear", /* VK_CLEAR 0x0C */
4593 "return", /* VK_RETURN 0x0D */
4595 0, 0, /* 0x0E .. 0x0F */
4597 0, /* VK_SHIFT 0x10 */
4598 0, /* VK_CONTROL 0x11 */
4599 0, /* VK_MENU 0x12 */
4600 "pause", /* VK_PAUSE 0x13 */
4601 "capslock", /* VK_CAPITAL 0x14 */
4603 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4605 "escape", /* VK_ESCAPE 0x1B */
4607 0, 0, 0, 0, /* 0x1C .. 0x1F */
4609 0, /* VK_SPACE 0x20 */
4610 "prior", /* VK_PRIOR 0x21 */
4611 "next", /* VK_NEXT 0x22 */
4612 "end", /* VK_END 0x23 */
4613 "home", /* VK_HOME 0x24 */
4614 "left", /* VK_LEFT 0x25 */
4615 "up", /* VK_UP 0x26 */
4616 "right", /* VK_RIGHT 0x27 */
4617 "down", /* VK_DOWN 0x28 */
4618 "select", /* VK_SELECT 0x29 */
4619 "print", /* VK_PRINT 0x2A */
4620 "execute", /* VK_EXECUTE 0x2B */
4621 "snapshot", /* VK_SNAPSHOT 0x2C */
4622 "insert", /* VK_INSERT 0x2D */
4623 "delete", /* VK_DELETE 0x2E */
4624 "help", /* VK_HELP 0x2F */
4626 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4628 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4630 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4632 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4634 0, 0, 0, 0, 0, 0, 0, 0, 0,
4635 0, 0, 0, 0, 0, 0, 0, 0, 0,
4636 0, 0, 0, 0, 0, 0, 0, 0,
4638 "lwindow", /* VK_LWIN 0x5B */
4639 "rwindow", /* VK_RWIN 0x5C */
4640 "apps", /* VK_APPS 0x5D */
4642 0, 0, /* 0x5E .. 0x5F */
4644 "kp-0", /* VK_NUMPAD0 0x60 */
4645 "kp-1", /* VK_NUMPAD1 0x61 */
4646 "kp-2", /* VK_NUMPAD2 0x62 */
4647 "kp-3", /* VK_NUMPAD3 0x63 */
4648 "kp-4", /* VK_NUMPAD4 0x64 */
4649 "kp-5", /* VK_NUMPAD5 0x65 */
4650 "kp-6", /* VK_NUMPAD6 0x66 */
4651 "kp-7", /* VK_NUMPAD7 0x67 */
4652 "kp-8", /* VK_NUMPAD8 0x68 */
4653 "kp-9", /* VK_NUMPAD9 0x69 */
4654 "kp-multiply", /* VK_MULTIPLY 0x6A */
4655 "kp-add", /* VK_ADD 0x6B */
4656 "kp-separator", /* VK_SEPARATOR 0x6C */
4657 "kp-subtract", /* VK_SUBTRACT 0x6D */
4658 "kp-decimal", /* VK_DECIMAL 0x6E */
4659 "kp-divide", /* VK_DIVIDE 0x6F */
4660 "f1", /* VK_F1 0x70 */
4661 "f2", /* VK_F2 0x71 */
4662 "f3", /* VK_F3 0x72 */
4663 "f4", /* VK_F4 0x73 */
4664 "f5", /* VK_F5 0x74 */
4665 "f6", /* VK_F6 0x75 */
4666 "f7", /* VK_F7 0x76 */
4667 "f8", /* VK_F8 0x77 */
4668 "f9", /* VK_F9 0x78 */
4669 "f10", /* VK_F10 0x79 */
4670 "f11", /* VK_F11 0x7A */
4671 "f12", /* VK_F12 0x7B */
4672 "f13", /* VK_F13 0x7C */
4673 "f14", /* VK_F14 0x7D */
4674 "f15", /* VK_F15 0x7E */
4675 "f16", /* VK_F16 0x7F */
4676 "f17", /* VK_F17 0x80 */
4677 "f18", /* VK_F18 0x81 */
4678 "f19", /* VK_F19 0x82 */
4679 "f20", /* VK_F20 0x83 */
4680 "f21", /* VK_F21 0x84 */
4681 "f22", /* VK_F22 0x85 */
4682 "f23", /* VK_F23 0x86 */
4683 "f24", /* VK_F24 0x87 */
4685 0, 0, 0, 0, /* 0x88 .. 0x8B */
4686 0, 0, 0, 0, /* 0x8C .. 0x8F */
4688 "kp-numlock", /* VK_NUMLOCK 0x90 */
4689 "scroll", /* VK_SCROLL 0x91 */
4691 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4692 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4693 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4694 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4695 "kp-end", /* VK_NUMPAD_END 0x96 */
4696 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4697 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4698 "kp-up", /* VK_NUMPAD_UP 0x99 */
4699 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4700 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4701 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4702 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4704 0, 0, /* 0x9E .. 0x9F */
4707 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4708 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4709 * No other API or message will distinguish left and right keys this way.
4713 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4714 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4715 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4716 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4717 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4723 "attn", /* VK_ATTN 0xF6 */
4724 "crsel", /* VK_CRSEL 0xF7 */
4725 "exsel", /* VK_EXSEL 0xF8 */
4726 "ereof", /* VK_EREOF 0xF9 */
4727 "play", /* VK_PLAY 0xFA */
4728 "zoom", /* VK_ZOOM 0xFB */
4729 "noname", /* VK_NONAME 0xFC */
4730 "pa1", /* VK_PA1 0xFD */
4731 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4735 #else /* not HAVE_NTGUI */
4737 /* This should be dealt with in XTread_socket now, and that doesn't
4738 depend on the client system having the Kana syms defined. See also
4739 the XK_kana_A case below. */
4742 static char *lispy_kana_keys
[] =
4744 /* X Keysym value */
4745 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4746 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4747 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4748 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4749 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4750 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4751 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4752 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4753 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4754 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4755 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4756 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4757 "kana-i", "kana-u", "kana-e", "kana-o",
4758 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4759 "prolongedsound", "kana-A", "kana-I", "kana-U",
4760 "kana-E", "kana-O", "kana-KA", "kana-KI",
4761 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4762 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4763 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4764 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4765 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4766 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4767 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4768 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4769 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4770 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4771 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4772 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4774 #endif /* XK_kana_A */
4777 #define FUNCTION_KEY_OFFSET 0xff00
4779 /* You'll notice that this table is arranged to be conveniently
4780 indexed by X Windows keysym values. */
4781 static char *lispy_function_keys
[] =
4783 /* X Keysym value */
4785 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4786 "backspace", "tab", "linefeed", "clear",
4788 0, 0, 0, "pause", /* 0xff10...1f */
4789 0, 0, 0, 0, 0, 0, 0, "escape",
4791 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4792 "romaji", "hiragana", "katakana", "hiragana-katakana",
4793 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4794 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4795 "eisu-toggle", /* 0xff30...3f */
4796 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4797 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4799 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4800 "down", "prior", "next", "end",
4801 "begin", 0, 0, 0, 0, 0, 0, 0,
4802 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4813 "break", /* 0xff6b */
4816 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4817 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4818 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4819 0, 0, 0, 0, 0, 0, 0, 0,
4820 "kp-tab", /* 0xff89 */
4822 "kp-enter", /* 0xff8d */
4824 "kp-f1", /* 0xff91 */
4828 "kp-home", /* 0xff95 */
4833 "kp-prior", /* kp-page-up */
4834 "kp-next", /* kp-page-down */
4840 0, 0, 0, 0, 0, 0, 0, 0, 0,
4841 "kp-multiply", /* 0xffaa */
4846 "kp-divide", /* 0xffaf */
4847 "kp-0", /* 0xffb0 */
4848 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4851 "kp-equal", /* 0xffbd */
4852 "f1", /* 0xffbe */ /* IsFunctionKey */
4854 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4855 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4856 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4857 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4858 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4859 0, 0, 0, 0, 0, 0, 0, 0,
4860 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4861 0, 0, 0, 0, 0, 0, 0, "delete"
4864 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4865 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4867 static char *iso_lispy_function_keys
[] =
4869 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4870 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4871 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4872 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4873 "iso-lefttab", /* 0xfe20 */
4874 "iso-move-line-up", "iso-move-line-down",
4875 "iso-partial-line-up", "iso-partial-line-down",
4876 "iso-partial-space-left", "iso-partial-space-right",
4877 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4878 "iso-release-margin-left", "iso-release-margin-right",
4879 "iso-release-both-margins",
4880 "iso-fast-cursor-left", "iso-fast-cursor-right",
4881 "iso-fast-cursor-up", "iso-fast-cursor-down",
4882 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4883 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4886 #endif /* not HAVE_NTGUI */
4888 Lisp_Object Vlispy_mouse_stem
;
4890 static char *lispy_wheel_names
[] =
4892 "wheel-up", "wheel-down"
4895 /* drag-n-drop events are generated when a set of selected files are
4896 dragged from another application and dropped onto an Emacs window. */
4897 static char *lispy_drag_n_drop_names
[] =
4902 /* Scroll bar parts. */
4903 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4904 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4905 Lisp_Object Qtop
, Qratio
;
4907 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4908 Lisp_Object
*scroll_bar_parts
[] = {
4909 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4910 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4913 /* User signal events. */
4914 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4916 Lisp_Object
*lispy_user_signals
[] =
4918 &Qusr1_signal
, &Qusr2_signal
4922 /* A vector, indexed by button number, giving the down-going location
4923 of currently depressed buttons, both scroll bar and non-scroll bar.
4925 The elements have the form
4926 (BUTTON-NUMBER MODIFIER-MASK . REST)
4927 where REST is the cdr of a position as it would be reported in the event.
4929 The make_lispy_event function stores positions here to tell the
4930 difference between click and drag events, and to store the starting
4931 location to be included in drag events. */
4933 static Lisp_Object button_down_location
;
4935 /* Information about the most recent up-going button event: Which
4936 button, what location, and what time. */
4938 static int last_mouse_button
;
4939 static int last_mouse_x
;
4940 static int last_mouse_y
;
4941 static unsigned long button_down_time
;
4943 /* The maximum time between clicks to make a double-click, or Qnil to
4944 disable double-click detection, or Qt for no time limit. */
4946 Lisp_Object Vdouble_click_time
;
4948 /* Maximum number of pixels the mouse may be moved between clicks
4949 to make a double-click. */
4951 EMACS_INT double_click_fuzz
;
4953 /* The number of clicks in this multiple-click. */
4955 int double_click_count
;
4957 /* Return position of a mouse click or wheel event */
4960 make_lispy_position (f
, x
, y
, time
)
4966 enum window_part part
;
4967 Lisp_Object posn
= Qnil
;
4968 Lisp_Object extra_info
= Qnil
;
4971 /* Set `window' to the window under frame pixel coordinates (x,y) */
4973 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
4974 &part
, &wx
, &wy
, 0);
4978 if (WINDOWP (window
))
4980 /* It's a click in window window at frame coordinates (x,y) */
4981 struct window
*w
= XWINDOW (window
);
4982 Lisp_Object string_info
= Qnil
;
4983 int textpos
= -1, rx
= -1, ry
= -1;
4984 int dx
= -1, dy
= -1;
4985 int width
= -1, height
= -1;
4986 Lisp_Object object
= Qnil
;
4988 /* Set event coordinates to window-relative coordinates
4989 for constructing the Lisp event below. */
4993 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
4995 /* Mode line or header line. Look for a string under
4996 the mouse that may have a `local-map' property. */
5000 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5002 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5003 &object
, &dx
, &dy
, &width
, &height
);
5004 if (STRINGP (string
))
5005 string_info
= Fcons (string
, make_number (charpos
));
5006 if (w
== XWINDOW (selected_window
))
5009 textpos
= XMARKER (w
->pointm
)->charpos
;
5011 else if (part
== ON_VERTICAL_BORDER
)
5013 posn
= Qvertical_line
;
5018 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5023 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5025 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5026 &object
, &dx
, &dy
, &width
, &height
);
5027 if (STRINGP (string
))
5028 string_info
= Fcons (string
, make_number (charpos
));
5030 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
5032 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
5035 if (part
== ON_RIGHT_FRINGE
)
5036 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5037 + window_box_width (w
, TEXT_AREA
)
5038 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5039 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5041 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5042 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5047 Lisp_Object string2
, object2
= Qnil
;
5048 struct display_pos p
;
5050 int width2
, height2
;
5051 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5052 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5053 &object2
, &dx2
, &dy2
,
5055 textpos
= CHARPOS (p
.pos
);
5056 if (rx
< 0) rx
= wx
;
5057 if (ry
< 0) ry
= wy
;
5058 if (dx
< 0) dx
= dx2
;
5059 if (dy
< 0) dy
= dy2
;
5060 if (width
< 0) width
= width2
;
5061 if (height
< 0) height
= height2
;
5065 posn
= make_number (textpos
);
5066 if (STRINGP (string2
))
5067 string_info
= Fcons (string2
,
5068 make_number (CHARPOS (p
.string_pos
)));
5074 #ifdef HAVE_WINDOW_SYSTEM
5075 if (IMAGEP (object
))
5077 Lisp_Object image_map
, hotspot
;
5078 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5080 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5082 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5083 posn
= XCAR (hotspot
);
5088 extra_info
= Fcons (object
,
5089 Fcons (Fcons (make_number (dx
),
5091 Fcons (Fcons (make_number (width
),
5092 make_number (height
)),
5096 extra_info
= Fcons (string_info
,
5097 Fcons (make_number (textpos
),
5098 Fcons (Fcons (make_number (rx
),
5104 XSETFRAME (window
, f
);
5109 XSETFASTINT (*x
, 0);
5110 XSETFASTINT (*y
, 0);
5113 return Fcons (window
,
5115 Fcons (Fcons (*x
, *y
),
5116 Fcons (make_number (time
),
5120 /* Given a struct input_event, build the lisp event which represents
5121 it. If EVENT is 0, build a mouse movement event from the mouse
5122 movement buffer, which should have a movement event in it.
5124 Note that events must be passed to this function in the order they
5125 are received; this function stores the location of button presses
5126 in order to build drag events when the button is released. */
5129 make_lispy_event (event
)
5130 struct input_event
*event
;
5134 switch (SWITCH_ENUM_CAST (event
->kind
))
5136 /* A simple keystroke. */
5137 case ASCII_KEYSTROKE_EVENT
:
5139 Lisp_Object lispy_c
;
5140 int c
= event
->code
& 0377;
5141 /* Turn ASCII characters into control characters
5143 if (event
->modifiers
& ctrl_modifier
)
5144 c
= make_ctrl_char (c
);
5146 /* Add in the other modifier bits. We took care of ctrl_modifier
5147 just above, and the shift key was taken care of by the X code,
5148 and applied to control characters by make_ctrl_char. */
5149 c
|= (event
->modifiers
5150 & (meta_modifier
| alt_modifier
5151 | hyper_modifier
| super_modifier
));
5152 /* Distinguish Shift-SPC from SPC. */
5153 if ((event
->code
& 0377) == 040
5154 && event
->modifiers
& shift_modifier
)
5155 c
|= shift_modifier
;
5156 button_down_time
= 0;
5157 XSETFASTINT (lispy_c
, c
);
5161 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5163 Lisp_Object lispy_c
;
5164 int c
= event
->code
;
5166 /* Add in the other modifier bits. We took care of ctrl_modifier
5167 just above, and the shift key was taken care of by the X code,
5168 and applied to control characters by make_ctrl_char. */
5169 c
|= (event
->modifiers
5170 & (meta_modifier
| alt_modifier
5171 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5172 /* What about the `shift' modifier ? */
5173 button_down_time
= 0;
5174 XSETFASTINT (lispy_c
, c
);
5178 /* A function key. The symbol may need to have modifier prefixes
5180 case NON_ASCII_KEYSTROKE_EVENT
:
5181 button_down_time
= 0;
5183 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5184 if (event
->code
== lispy_accent_codes
[i
])
5185 return modify_event_symbol (i
,
5187 Qfunction_key
, Qnil
,
5188 lispy_accent_keys
, &accent_key_syms
,
5189 (sizeof (lispy_accent_keys
)
5190 / sizeof (lispy_accent_keys
[0])));
5194 if (event
->code
>= 0x400 && event
->code
< 0x500)
5195 return modify_event_symbol (event
->code
- 0x400,
5196 event
->modifiers
& ~shift_modifier
,
5197 Qfunction_key
, Qnil
,
5198 lispy_kana_keys
, &func_key_syms
,
5199 (sizeof (lispy_kana_keys
)
5200 / sizeof (lispy_kana_keys
[0])));
5201 #endif /* XK_kana_A */
5204 #ifdef ISO_FUNCTION_KEY_OFFSET
5205 if (event
->code
< FUNCTION_KEY_OFFSET
5206 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5207 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5209 Qfunction_key
, Qnil
,
5210 iso_lispy_function_keys
, &func_key_syms
,
5211 (sizeof (iso_lispy_function_keys
)
5212 / sizeof (iso_lispy_function_keys
[0])));
5215 /* Handle system-specific or unknown keysyms. */
5216 if (event
->code
& (1 << 28)
5217 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5218 || (event
->code
- FUNCTION_KEY_OFFSET
5219 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5220 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5222 /* We need to use an alist rather than a vector as the cache
5223 since we can't make a vector long enuf. */
5224 if (NILP (current_kboard
->system_key_syms
))
5225 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5226 return modify_event_symbol (event
->code
,
5229 current_kboard
->Vsystem_key_alist
,
5230 0, ¤t_kboard
->system_key_syms
,
5234 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5236 Qfunction_key
, Qnil
,
5237 lispy_function_keys
, &func_key_syms
,
5238 (sizeof (lispy_function_keys
)
5239 / sizeof (lispy_function_keys
[0])));
5242 /* A mouse click. Figure out where it is, decide whether it's
5243 a press, click or drag, and build the appropriate structure. */
5244 case MOUSE_CLICK_EVENT
:
5245 #ifndef USE_TOOLKIT_SCROLL_BARS
5246 case SCROLL_BAR_CLICK_EVENT
:
5249 int button
= event
->code
;
5251 Lisp_Object position
;
5252 Lisp_Object
*start_pos_ptr
;
5253 Lisp_Object start_pos
;
5257 /* Build the position as appropriate for this mouse click. */
5258 if (event
->kind
== MOUSE_CLICK_EVENT
)
5260 struct frame
*f
= XFRAME (event
->frame_or_window
);
5261 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5265 /* Ignore mouse events that were made on frame that
5266 have been deleted. */
5267 if (! FRAME_LIVE_P (f
))
5270 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5271 /* EVENT->x and EVENT->y are frame-relative pixel
5272 coordinates at this place. Under old redisplay, COLUMN
5273 and ROW are set to frame relative glyph coordinates
5274 which are then used to determine whether this click is
5275 in a menu (non-toolkit version). */
5276 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5277 &column
, &row
, NULL
, 1);
5279 /* In the non-toolkit version, clicks on the menu bar
5280 are ordinary button events in the event buffer.
5281 Distinguish them, and invoke the menu.
5283 (In the toolkit version, the toolkit handles the menu bar
5284 and Emacs doesn't know about it until after the user
5285 makes a selection.) */
5286 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5287 && (event
->modifiers
& down_modifier
))
5289 Lisp_Object items
, item
;
5294 /* Activate the menu bar on the down event. If the
5295 up event comes in before the menu code can deal with it,
5297 if (! (event
->modifiers
& down_modifier
))
5301 /* Find the menu bar item under `column'. */
5303 items
= FRAME_MENU_BAR_ITEMS (f
);
5304 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5306 Lisp_Object pos
, string
;
5307 string
= AREF (items
, i
+ 1);
5308 pos
= AREF (items
, i
+ 3);
5311 if (column
>= XINT (pos
)
5312 && column
< XINT (pos
) + SCHARS (string
))
5314 item
= AREF (items
, i
);
5319 /* ELisp manual 2.4b says (x y) are window relative but
5320 code says they are frame-relative. */
5322 = Fcons (event
->frame_or_window
,
5324 Fcons (Fcons (event
->x
, event
->y
),
5325 Fcons (make_number (event
->timestamp
),
5328 return Fcons (item
, Fcons (position
, Qnil
));
5330 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5332 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5335 #ifndef USE_TOOLKIT_SCROLL_BARS
5338 /* It's a scrollbar click. */
5340 Lisp_Object portion_whole
;
5343 window
= event
->frame_or_window
;
5344 portion_whole
= Fcons (event
->x
, event
->y
);
5345 part
= *scroll_bar_parts
[(int) event
->part
];
5349 Fcons (Qvertical_scroll_bar
,
5350 Fcons (portion_whole
,
5351 Fcons (make_number (event
->timestamp
),
5352 Fcons (part
, Qnil
)))));
5354 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5356 if (button
>= ASIZE (button_down_location
))
5358 button_down_location
= larger_vector (button_down_location
,
5360 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5363 start_pos_ptr
= &AREF (button_down_location
, button
);
5364 start_pos
= *start_pos_ptr
;
5365 *start_pos_ptr
= Qnil
;
5368 /* On window-system frames, use the value of
5369 double-click-fuzz as is. On other frames, interpret it
5370 as a multiple of 1/8 characters. */
5374 if (WINDOWP (event
->frame_or_window
))
5375 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5376 else if (FRAMEP (event
->frame_or_window
))
5377 f
= XFRAME (event
->frame_or_window
);
5381 if (FRAME_WINDOW_P (f
))
5382 fuzz
= double_click_fuzz
;
5384 fuzz
= double_click_fuzz
/ 8;
5386 is_double
= (button
== last_mouse_button
5387 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5388 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5389 && button_down_time
!= 0
5390 && (EQ (Vdouble_click_time
, Qt
)
5391 || (INTEGERP (Vdouble_click_time
)
5392 && ((int)(event
->timestamp
- button_down_time
)
5393 < XINT (Vdouble_click_time
)))));
5396 last_mouse_button
= button
;
5397 last_mouse_x
= XINT (event
->x
);
5398 last_mouse_y
= XINT (event
->y
);
5400 /* If this is a button press, squirrel away the location, so
5401 we can decide later whether it was a click or a drag. */
5402 if (event
->modifiers
& down_modifier
)
5406 double_click_count
++;
5407 event
->modifiers
|= ((double_click_count
> 2)
5412 double_click_count
= 1;
5413 button_down_time
= event
->timestamp
;
5414 *start_pos_ptr
= Fcopy_alist (position
);
5417 /* Now we're releasing a button - check the co-ordinates to
5418 see if this was a click or a drag. */
5419 else if (event
->modifiers
& up_modifier
)
5421 /* If we did not see a down before this up, ignore the up.
5422 Probably this happened because the down event chose a
5423 menu item. It would be an annoyance to treat the
5424 release of the button that chose the menu item as a
5427 if (!CONSP (start_pos
))
5430 event
->modifiers
&= ~up_modifier
;
5431 #if 0 /* Formerly we treated an up with no down as a click event. */
5432 if (!CONSP (start_pos
))
5433 event
->modifiers
|= click_modifier
;
5438 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5440 /* The third element of every position
5441 should be the (x,y) pair. */
5442 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5444 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5446 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5447 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5450 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5451 && ydiff
< double_click_fuzz
5452 && ydiff
> - double_click_fuzz
)
5453 /* Mouse hasn't moved (much). */
5454 event
->modifiers
|= click_modifier
;
5457 button_down_time
= 0;
5458 event
->modifiers
|= drag_modifier
;
5461 /* Don't check is_double; treat this as multiple
5462 if the down-event was multiple. */
5463 if (double_click_count
> 1)
5464 event
->modifiers
|= ((double_click_count
> 2)
5470 /* Every mouse event should either have the down_modifier or
5471 the up_modifier set. */
5475 /* Get the symbol we should use for the mouse click. */
5478 head
= modify_event_symbol (button
,
5480 Qmouse_click
, Vlispy_mouse_stem
,
5483 XVECTOR (mouse_syms
)->size
);
5484 if (event
->modifiers
& drag_modifier
)
5489 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5492 Fcons (make_number (double_click_count
),
5503 Lisp_Object position
;
5506 /* Build the position as appropriate for this mouse click. */
5507 struct frame
*f
= XFRAME (event
->frame_or_window
);
5509 /* Ignore wheel events that were made on frame that have been
5511 if (! FRAME_LIVE_P (f
))
5514 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5517 /* Set double or triple modifiers to indicate the wheel speed. */
5519 /* On window-system frames, use the value of
5520 double-click-fuzz as is. On other frames, interpret it
5521 as a multiple of 1/8 characters. */
5526 if (WINDOWP (event
->frame_or_window
))
5527 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5528 else if (FRAMEP (event
->frame_or_window
))
5529 f
= XFRAME (event
->frame_or_window
);
5533 if (FRAME_WINDOW_P (f
))
5534 fuzz
= double_click_fuzz
;
5536 fuzz
= double_click_fuzz
/ 8;
5538 is_double
= (last_mouse_button
< 0
5539 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5540 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5541 && button_down_time
!= 0
5542 && (EQ (Vdouble_click_time
, Qt
)
5543 || (INTEGERP (Vdouble_click_time
)
5544 && ((int)(event
->timestamp
- button_down_time
)
5545 < XINT (Vdouble_click_time
)))));
5548 double_click_count
++;
5549 event
->modifiers
|= ((double_click_count
> 2)
5555 double_click_count
= 1;
5556 event
->modifiers
|= click_modifier
;
5559 button_down_time
= event
->timestamp
;
5560 /* Use a negative value to distinguish wheel from mouse button. */
5561 last_mouse_button
= -1;
5562 last_mouse_x
= XINT (event
->x
);
5563 last_mouse_y
= XINT (event
->y
);
5569 if (event
->modifiers
& up_modifier
)
5571 /* Emit a wheel-up event. */
5572 event
->modifiers
&= ~up_modifier
;
5575 else if (event
->modifiers
& down_modifier
)
5577 /* Emit a wheel-down event. */
5578 event
->modifiers
&= ~down_modifier
;
5582 /* Every wheel event should either have the down_modifier or
5583 the up_modifier set. */
5586 /* Get the symbol we should use for the wheel event. */
5587 head
= modify_event_symbol (symbol_num
,
5593 ASIZE (wheel_syms
));
5596 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5599 Fcons (make_number (double_click_count
),
5608 #ifdef USE_TOOLKIT_SCROLL_BARS
5610 /* We don't have down and up events if using toolkit scroll bars,
5611 so make this always a click event. Store in the `part' of
5612 the Lisp event a symbol which maps to the following actions:
5614 `above_handle' page up
5615 `below_handle' page down
5619 `bottom' bottom of buffer
5620 `handle' thumb has been dragged.
5621 `end-scroll' end of interaction with scroll bar
5623 The incoming input_event contains in its `part' member an
5624 index of type `enum scroll_bar_part' which we can use as an
5625 index in scroll_bar_parts to get the appropriate symbol. */
5627 case SCROLL_BAR_CLICK_EVENT
:
5629 Lisp_Object position
, head
, window
, portion_whole
, part
;
5631 window
= event
->frame_or_window
;
5632 portion_whole
= Fcons (event
->x
, event
->y
);
5633 part
= *scroll_bar_parts
[(int) event
->part
];
5637 Fcons (Qvertical_scroll_bar
,
5638 Fcons (portion_whole
,
5639 Fcons (make_number (event
->timestamp
),
5640 Fcons (part
, Qnil
)))));
5642 /* Always treat scroll bar events as clicks. */
5643 event
->modifiers
|= click_modifier
;
5644 event
->modifiers
&= ~up_modifier
;
5646 if (event
->code
>= ASIZE (mouse_syms
))
5647 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5649 /* Get the symbol we should use for the mouse click. */
5650 head
= modify_event_symbol (event
->code
,
5655 XVECTOR (mouse_syms
)->size
);
5656 return Fcons (head
, Fcons (position
, Qnil
));
5659 #endif /* USE_TOOLKIT_SCROLL_BARS */
5662 case W32_SCROLL_BAR_CLICK_EVENT
:
5664 int button
= event
->code
;
5666 Lisp_Object position
;
5667 Lisp_Object
*start_pos_ptr
;
5668 Lisp_Object start_pos
;
5672 Lisp_Object portion_whole
;
5675 window
= event
->frame_or_window
;
5676 portion_whole
= Fcons (event
->x
, event
->y
);
5677 part
= *scroll_bar_parts
[(int) event
->part
];
5681 Fcons (Qvertical_scroll_bar
,
5682 Fcons (portion_whole
,
5683 Fcons (make_number (event
->timestamp
),
5684 Fcons (part
, Qnil
)))));
5687 /* Always treat W32 scroll bar events as clicks. */
5688 event
->modifiers
|= click_modifier
;
5691 /* Get the symbol we should use for the mouse click. */
5694 head
= modify_event_symbol (button
,
5699 XVECTOR (mouse_syms
)->size
);
5705 #endif /* WINDOWSNT */
5707 case DRAG_N_DROP_EVENT
:
5710 Lisp_Object head
, position
;
5713 /* The frame_or_window field should be a cons of the frame in
5714 which the event occurred and a list of the filenames
5716 if (! CONSP (event
->frame_or_window
))
5719 f
= XFRAME (XCAR (event
->frame_or_window
));
5720 files
= XCDR (event
->frame_or_window
);
5722 /* Ignore mouse events that were made on frames that
5723 have been deleted. */
5724 if (! FRAME_LIVE_P (f
))
5727 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5730 head
= modify_event_symbol (0, event
->modifiers
,
5732 lispy_drag_n_drop_names
,
5733 &drag_n_drop_syms
, 1);
5739 #endif /* HAVE_MOUSE */
5741 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5742 || defined (USE_GTK)
5743 case MENU_BAR_EVENT
:
5744 if (EQ (event
->arg
, event
->frame_or_window
))
5745 /* This is the prefix key. We translate this to
5746 `(menu_bar)' because the code in keyboard.c for menu
5747 events, which we use, relies on this. */
5748 return Fcons (Qmenu_bar
, Qnil
);
5752 case SELECT_WINDOW_EVENT
:
5753 /* Make an event (select-window (WINDOW)). */
5754 return Fcons (Qselect_window
,
5755 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5758 case TOOL_BAR_EVENT
:
5759 if (EQ (event
->arg
, event
->frame_or_window
))
5760 /* This is the prefix key. We translate this to
5761 `(tool_bar)' because the code in keyboard.c for tool bar
5762 events, which we use, relies on this. */
5763 return Fcons (Qtool_bar
, Qnil
);
5764 else if (SYMBOLP (event
->arg
))
5765 return apply_modifiers (event
->modifiers
, event
->arg
);
5768 case USER_SIGNAL_EVENT
:
5769 /* A user signal. */
5770 return *lispy_user_signals
[event
->code
];
5772 case SAVE_SESSION_EVENT
:
5773 return Qsave_session
;
5775 /* The 'kind' field of the event is something we don't recognize. */
5784 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5786 Lisp_Object bar_window
;
5787 enum scroll_bar_part part
;
5791 /* Is it a scroll bar movement? */
5792 if (frame
&& ! NILP (bar_window
))
5794 Lisp_Object part_sym
;
5796 part_sym
= *scroll_bar_parts
[(int) part
];
5797 return Fcons (Qscroll_bar_movement
,
5798 (Fcons (Fcons (bar_window
,
5799 Fcons (Qvertical_scroll_bar
,
5800 Fcons (Fcons (x
, y
),
5801 Fcons (make_number (time
),
5807 /* Or is it an ordinary mouse movement? */
5810 Lisp_Object position
;
5812 position
= make_lispy_position (frame
, &x
, &y
, time
);
5814 return Fcons (Qmouse_movement
,
5820 #endif /* HAVE_MOUSE */
5822 /* Construct a switch frame event. */
5824 make_lispy_switch_frame (frame
)
5827 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5830 /* Manipulating modifiers. */
5832 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5834 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5835 SYMBOL's name of the end of the modifiers; the string from this
5836 position is the unmodified symbol name.
5838 This doesn't use any caches. */
5841 parse_modifiers_uncached (symbol
, modifier_end
)
5849 CHECK_SYMBOL (symbol
);
5852 name
= SYMBOL_NAME (symbol
);
5854 for (i
= 0; i
+2 <= SBYTES (name
); )
5856 int this_mod_end
= 0;
5859 /* See if the name continues with a modifier word.
5860 Check that the word appears, but don't check what follows it.
5861 Set this_mod and this_mod_end to record what we find. */
5863 switch (SREF (name
, i
))
5865 #define SINGLE_LETTER_MOD(BIT) \
5866 (this_mod_end = i + 1, this_mod = BIT)
5869 SINGLE_LETTER_MOD (alt_modifier
);
5873 SINGLE_LETTER_MOD (ctrl_modifier
);
5877 SINGLE_LETTER_MOD (hyper_modifier
);
5881 SINGLE_LETTER_MOD (meta_modifier
);
5885 SINGLE_LETTER_MOD (shift_modifier
);
5889 SINGLE_LETTER_MOD (super_modifier
);
5892 #undef SINGLE_LETTER_MOD
5894 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5895 if (i + LEN + 1 <= SBYTES (name) \
5896 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5898 this_mod_end = i + LEN; \
5903 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5904 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5905 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5909 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5911 #undef MULTI_LETTER_MOD
5915 /* If we found no modifier, stop looking for them. */
5916 if (this_mod_end
== 0)
5919 /* Check there is a dash after the modifier, so that it
5920 really is a modifier. */
5921 if (this_mod_end
>= SBYTES (name
)
5922 || SREF (name
, this_mod_end
) != '-')
5925 /* This modifier is real; look for another. */
5926 modifiers
|= this_mod
;
5927 i
= this_mod_end
+ 1;
5930 /* Should we include the `click' modifier? */
5931 if (! (modifiers
& (down_modifier
| drag_modifier
5932 | double_modifier
| triple_modifier
))
5933 && i
+ 7 == SBYTES (name
)
5934 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
5935 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
5936 modifiers
|= click_modifier
;
5944 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5945 prepended to the string BASE[0..BASE_LEN-1].
5946 This doesn't use any caches. */
5948 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
5951 int base_len
, base_len_byte
;
5953 /* Since BASE could contain nulls, we can't use intern here; we have
5954 to use Fintern, which expects a genuine Lisp_String, and keeps a
5957 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5963 /* Only the event queue may use the `up' modifier; it should always
5964 be turned into a click or drag event before presented to lisp code. */
5965 if (modifiers
& up_modifier
)
5968 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
5969 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
5970 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
5971 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
5972 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
5973 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
5974 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
5975 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
5976 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
5977 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
5978 /* The click modifier is denoted by the absence of other modifiers. */
5982 mod_len
= p
- new_mods
;
5986 Lisp_Object new_name
;
5988 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
5989 mod_len
+ base_len_byte
);
5990 bcopy (new_mods
, SDATA (new_name
), mod_len
);
5991 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
5993 return Fintern (new_name
, Qnil
);
5998 static char *modifier_names
[] =
6000 "up", "down", "drag", "click", "double", "triple", 0, 0,
6001 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6002 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6004 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6006 static Lisp_Object modifier_symbols
;
6008 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6010 lispy_modifier_list (modifiers
)
6013 Lisp_Object modifier_list
;
6016 modifier_list
= Qnil
;
6017 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6018 if (modifiers
& (1<<i
))
6019 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6022 return modifier_list
;
6026 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6027 where UNMODIFIED is the unmodified form of SYMBOL,
6028 MASK is the set of modifiers present in SYMBOL's name.
6029 This is similar to parse_modifiers_uncached, but uses the cache in
6030 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6031 Qevent_symbol_elements property. */
6034 parse_modifiers (symbol
)
6037 Lisp_Object elements
;
6039 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6040 if (CONSP (elements
))
6045 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6046 Lisp_Object unmodified
;
6049 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6050 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6053 if (modifiers
& ~INTMASK
)
6055 XSETFASTINT (mask
, modifiers
);
6056 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6058 /* Cache the parsing results on SYMBOL. */
6059 Fput (symbol
, Qevent_symbol_element_mask
,
6061 Fput (symbol
, Qevent_symbol_elements
,
6062 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6064 /* Since we know that SYMBOL is modifiers applied to unmodified,
6065 it would be nice to put that in unmodified's cache.
6066 But we can't, since we're not sure that parse_modifiers is
6073 /* Apply the modifiers MODIFIERS to the symbol BASE.
6074 BASE must be unmodified.
6076 This is like apply_modifiers_uncached, but uses BASE's
6077 Qmodifier_cache property, if present. It also builds
6078 Qevent_symbol_elements properties, since it has that info anyway.
6080 apply_modifiers copies the value of BASE's Qevent_kind property to
6081 the modified symbol. */
6083 apply_modifiers (modifiers
, base
)
6087 Lisp_Object cache
, index
, entry
, new_symbol
;
6089 /* Mask out upper bits. We don't know where this value's been. */
6090 modifiers
&= INTMASK
;
6092 /* The click modifier never figures into cache indices. */
6093 cache
= Fget (base
, Qmodifier_cache
);
6094 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6095 entry
= assq_no_quit (index
, cache
);
6098 new_symbol
= XCDR (entry
);
6101 /* We have to create the symbol ourselves. */
6102 new_symbol
= apply_modifiers_uncached (modifiers
,
6103 SDATA (SYMBOL_NAME (base
)),
6104 SCHARS (SYMBOL_NAME (base
)),
6105 SBYTES (SYMBOL_NAME (base
)));
6107 /* Add the new symbol to the base's cache. */
6108 entry
= Fcons (index
, new_symbol
);
6109 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6111 /* We have the parsing info now for free, so we could add it to
6113 XSETFASTINT (index, modifiers);
6114 Fput (new_symbol, Qevent_symbol_element_mask,
6115 Fcons (base, Fcons (index, Qnil)));
6116 Fput (new_symbol, Qevent_symbol_elements,
6117 Fcons (base, lispy_modifier_list (modifiers)));
6118 Sadly, this is only correct if `base' is indeed a base event,
6119 which is not necessarily the case. -stef */
6122 /* Make sure this symbol is of the same kind as BASE.
6124 You'd think we could just set this once and for all when we
6125 intern the symbol above, but reorder_modifiers may call us when
6126 BASE's property isn't set right; we can't assume that just
6127 because it has a Qmodifier_cache property it must have its
6128 Qevent_kind set right as well. */
6129 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6133 kind
= Fget (base
, Qevent_kind
);
6135 Fput (new_symbol
, Qevent_kind
, kind
);
6142 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6143 return a symbol with the modifiers placed in the canonical order.
6144 Canonical order is alphabetical, except for down and drag, which
6145 always come last. The 'click' modifier is never written out.
6147 Fdefine_key calls this to make sure that (for example) C-M-foo
6148 and M-C-foo end up being equivalent in the keymap. */
6151 reorder_modifiers (symbol
)
6154 /* It's hopefully okay to write the code this way, since everything
6155 will soon be in caches, and no consing will be done at all. */
6158 parsed
= parse_modifiers (symbol
);
6159 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6164 /* For handling events, we often want to produce a symbol whose name
6165 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6166 to some base, like the name of a function key or mouse button.
6167 modify_event_symbol produces symbols of this sort.
6169 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6170 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6173 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6174 into symbol names, or a string specifying a name stem used to
6175 construct a symbol name or the form `STEM-N', where N is the decimal
6176 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6177 non-nil; otherwise NAME_TABLE is used.
6179 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6180 persist between calls to modify_event_symbol that it can use to
6181 store a cache of the symbols it's generated for this NAME_TABLE
6182 before. The object stored there may be a vector or an alist.
6184 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6186 MODIFIERS is a set of modifier bits (as given in struct input_events)
6187 whose prefixes should be applied to the symbol name.
6189 SYMBOL_KIND is the value to be placed in the event_kind property of
6190 the returned symbol.
6192 The symbols we create are supposed to have an
6193 `event-symbol-elements' property, which lists the modifiers present
6194 in the symbol's name. */
6197 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6198 name_table
, symbol_table
, table_size
)
6201 Lisp_Object symbol_kind
;
6202 Lisp_Object name_alist_or_stem
;
6204 Lisp_Object
*symbol_table
;
6205 unsigned int table_size
;
6208 Lisp_Object symbol_int
;
6210 /* Get rid of the "vendor-specific" bit here. */
6211 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6213 /* Is this a request for a valid symbol? */
6214 if (symbol_num
< 0 || symbol_num
>= table_size
)
6217 if (CONSP (*symbol_table
))
6218 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6220 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6221 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6222 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6223 we've never used that symbol before. */
6226 if (! VECTORP (*symbol_table
)
6227 || XVECTOR (*symbol_table
)->size
!= table_size
)
6231 XSETFASTINT (size
, table_size
);
6232 *symbol_table
= Fmake_vector (size
, Qnil
);
6235 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6238 /* Have we already used this symbol before? */
6241 /* No; let's create it. */
6242 if (CONSP (name_alist_or_stem
))
6243 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6244 else if (STRINGP (name_alist_or_stem
))
6246 int len
= SBYTES (name_alist_or_stem
);
6247 char *buf
= (char *) alloca (len
+ 50);
6248 if (sizeof (int) == sizeof (EMACS_INT
))
6249 sprintf (buf
, "%s-%d", SDATA (name_alist_or_stem
),
6250 XINT (symbol_int
) + 1);
6251 else if (sizeof (long) == sizeof (EMACS_INT
))
6252 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6253 XINT (symbol_int
) + 1);
6256 value
= intern (buf
);
6258 else if (name_table
!= 0 && name_table
[symbol_num
])
6259 value
= intern (name_table
[symbol_num
]);
6261 #ifdef HAVE_WINDOW_SYSTEM
6264 char *name
= x_get_keysym_name (symbol_num
);
6266 value
= intern (name
);
6273 sprintf (buf
, "key-%d", symbol_num
);
6274 value
= intern (buf
);
6277 if (CONSP (*symbol_table
))
6278 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6280 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6282 /* Fill in the cache entries for this symbol; this also
6283 builds the Qevent_symbol_elements property, which the user
6285 apply_modifiers (modifiers
& click_modifier
, value
);
6286 Fput (value
, Qevent_kind
, symbol_kind
);
6289 /* Apply modifiers to that symbol. */
6290 return apply_modifiers (modifiers
, value
);
6293 /* Convert a list that represents an event type,
6294 such as (ctrl meta backspace), into the usual representation of that
6295 event type as a number or a symbol. */
6297 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6298 doc
: /* Convert the event description list EVENT-DESC to an event type.
6299 EVENT-DESC should contain one base event type (a character or symbol)
6300 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6301 drag, down, double or triple). The base must be last.
6302 The return value is an event type (a character or symbol) which
6303 has the same base event type and all the specified modifiers. */)
6305 Lisp_Object event_desc
;
6313 while (CONSP (rest
))
6321 /* Given a symbol, see if it is a modifier name. */
6322 if (SYMBOLP (elt
) && CONSP (rest
))
6323 this = parse_solitary_modifier (elt
);
6327 else if (!NILP (base
))
6328 error ("Two bases given in one event");
6334 /* Let the symbol A refer to the character A. */
6335 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6336 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6338 if (INTEGERP (base
))
6340 /* Turn (shift a) into A. */
6341 if ((modifiers
& shift_modifier
) != 0
6342 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6344 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6345 modifiers
&= ~shift_modifier
;
6348 /* Turn (control a) into C-a. */
6349 if (modifiers
& ctrl_modifier
)
6350 return make_number ((modifiers
& ~ctrl_modifier
)
6351 | make_ctrl_char (XINT (base
)));
6353 return make_number (modifiers
| XINT (base
));
6355 else if (SYMBOLP (base
))
6356 return apply_modifiers (modifiers
, base
);
6359 error ("Invalid base event");
6364 /* Try to recognize SYMBOL as a modifier name.
6365 Return the modifier flag bit, or 0 if not recognized. */
6368 parse_solitary_modifier (symbol
)
6371 Lisp_Object name
= SYMBOL_NAME (symbol
);
6373 switch (SREF (name
, 0))
6375 #define SINGLE_LETTER_MOD(BIT) \
6376 if (SBYTES (name) == 1) \
6379 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6380 if (LEN == SBYTES (name) \
6381 && ! strncmp (SDATA (name), NAME, LEN)) \
6385 SINGLE_LETTER_MOD (alt_modifier
);
6389 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6393 SINGLE_LETTER_MOD (ctrl_modifier
);
6397 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6398 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6402 SINGLE_LETTER_MOD (hyper_modifier
);
6406 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6410 SINGLE_LETTER_MOD (meta_modifier
);
6414 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6418 SINGLE_LETTER_MOD (shift_modifier
);
6422 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6423 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6424 SINGLE_LETTER_MOD (super_modifier
);
6428 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6429 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6430 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6434 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6437 #undef SINGLE_LETTER_MOD
6438 #undef MULTI_LETTER_MOD
6444 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6445 Such a list is not valid as an event,
6446 but it can be a Lucid-style event type list. */
6449 lucid_event_type_list_p (object
)
6454 if (! CONSP (object
))
6457 if (EQ (XCAR (object
), Qhelp_echo
)
6458 || EQ (XCAR (object
), Qvertical_line
)
6459 || EQ (XCAR (object
), Qmode_line
)
6460 || EQ (XCAR (object
), Qheader_line
))
6463 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6467 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6474 /* Store into *addr a value nonzero if terminal input chars are available.
6475 Serves the purpose of ioctl (0, FIONREAD, addr)
6476 but works even if FIONREAD does not exist.
6477 (In fact, this may actually read some input.)
6479 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6480 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6483 get_filtered_input_pending (addr
, do_timers_now
, filter_events
)
6488 /* First of all, have we already counted some input? */
6489 *addr
= (!NILP (Vquit_flag
)
6490 || readable_filtered_events (do_timers_now
, filter_events
));
6492 /* If input is being read as it arrives, and we have none, there is none. */
6493 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6496 /* Try to read some input and see how much we get. */
6498 *addr
= (!NILP (Vquit_flag
)
6499 || readable_filtered_events (do_timers_now
, filter_events
));
6502 /* Store into *addr a value nonzero if terminal input chars are available.
6503 Serves the purpose of ioctl (0, FIONREAD, addr)
6504 but works even if FIONREAD does not exist.
6505 (In fact, this may actually read some input.)
6507 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6510 get_input_pending (addr
, do_timers_now
)
6514 get_filtered_input_pending (addr
, do_timers_now
, 0);
6517 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6520 gobble_input (expected
)
6525 if (interrupt_input
)
6528 mask
= sigblock (sigmask (SIGIO
));
6529 read_avail_input (expected
);
6533 #ifdef POLL_FOR_INPUT
6534 if (read_socket_hook
&& !interrupt_input
&& poll_suppress_count
== 0)
6537 mask
= sigblock (sigmask (SIGALRM
));
6538 read_avail_input (expected
);
6544 read_avail_input (expected
);
6548 /* Put a BUFFER_SWITCH_EVENT in the buffer
6549 so that read_key_sequence will notice the new current buffer. */
6552 record_asynch_buffer_change ()
6554 struct input_event event
;
6558 event
.kind
= BUFFER_SWITCH_EVENT
;
6559 event
.frame_or_window
= Qnil
;
6563 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6564 The purpose of the event is to make read_key_sequence look up the
6565 keymaps again. If we aren't in read_key_sequence, we don't need one,
6566 and the event could cause trouble by messing up (input-pending-p). */
6567 tem
= Fwaiting_for_user_input_p ();
6571 /* We never need these events if we have no asynchronous subprocesses. */
6575 /* Make sure no interrupt happens while storing the event. */
6577 if (interrupt_input
)
6580 mask
= sigblock (sigmask (SIGIO
));
6581 kbd_buffer_store_event (&event
);
6588 kbd_buffer_store_event (&event
);
6595 /* Read any terminal input already buffered up by the system
6596 into the kbd_buffer, but do not wait.
6598 EXPECTED should be nonzero if the caller knows there is some input.
6600 Except on VMS, all input is read by this function.
6601 If interrupt_input is nonzero, this function MUST be called
6602 only when SIGIO is blocked.
6604 Returns the number of keyboard chars read, or -1 meaning
6605 this is a bad time to try to read input. */
6608 read_avail_input (expected
)
6614 if (read_socket_hook
)
6618 struct input_event hold_quit
;
6620 EVENT_INIT (hold_quit
);
6621 hold_quit
.kind
= NO_EVENT
;
6623 /* No need for FIONREAD or fcntl; just say don't wait. */
6624 while (nr
= (*read_socket_hook
) (input_fd
, expected
, &hold_quit
), nr
> 0)
6629 if (hold_quit
.kind
!= NO_EVENT
)
6630 kbd_buffer_store_event (&hold_quit
);
6634 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6635 the kbd_buffer can really hold. That may prevent loss
6636 of characters on some systems when input is stuffed at us. */
6637 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6640 /* Determine how many characters we should *try* to read. */
6643 #else /* not WINDOWSNT */
6645 n_to_read
= dos_keysns ();
6648 #else /* not MSDOS */
6650 /* Find out how much input is available. */
6651 if (ioctl (input_fd
, FIONREAD
, &n_to_read
) < 0)
6652 /* Formerly simply reported no input, but that sometimes led to
6653 a failure of Emacs to terminate.
6654 SIGHUP seems appropriate if we can't reach the terminal. */
6655 /* ??? Is it really right to send the signal just to this process
6656 rather than to the whole process group?
6657 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6659 if (! noninteractive
)
6660 kill (getpid (), SIGHUP
);
6666 if (n_to_read
> sizeof cbuf
)
6667 n_to_read
= sizeof cbuf
;
6668 #else /* no FIONREAD */
6669 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6670 /* Read some input if available, but don't wait. */
6671 n_to_read
= sizeof cbuf
;
6672 fcntl (input_fd
, F_SETFL
, O_NDELAY
);
6677 #endif /* not MSDOS */
6678 #endif /* not WINDOWSNT */
6680 /* Now read; for one reason or another, this will not block.
6681 NREAD is set to the number of chars read. */
6685 cbuf
[0] = dos_keyread ();
6688 nread
= emacs_read (input_fd
, cbuf
, n_to_read
);
6690 /* POSIX infers that processes which are not in the session leader's
6691 process group won't get SIGHUP's at logout time. BSDI adheres to
6692 this part standard and returns -1 from read (0) with errno==EIO
6693 when the control tty is taken away.
6694 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6695 if (nread
== -1 && errno
== EIO
)
6697 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6698 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6699 This looks incorrect, but it isn't, because _BSD causes
6700 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6701 and that causes a value other than 0 when there is no input. */
6707 /* We used to retry the read if it was interrupted.
6708 But this does the wrong thing when O_NDELAY causes
6709 an EAGAIN error. Does anybody know of a situation
6710 where a retry is actually needed? */
6712 nread
< 0 && (errno
== EAGAIN
6726 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6727 fcntl (input_fd
, F_SETFL
, 0);
6728 #endif /* USG or DGUX or CYGWIN */
6729 #endif /* no FIONREAD */
6730 for (i
= 0; i
< nread
; i
++)
6732 struct input_event buf
;
6734 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6736 if (meta_key
== 1 && (cbuf
[i
] & 0x80))
6737 buf
.modifiers
= meta_modifier
;
6742 buf
.frame_or_window
= selected_frame
;
6745 kbd_buffer_store_event (&buf
);
6746 /* Don't look at input that follows a C-g too closely.
6747 This reduces lossage due to autorepeat on C-g. */
6748 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6749 && buf
.code
== quit_char
)
6756 #endif /* not VMS */
6759 handle_async_input ()
6762 extern int select_alarmed
;
6764 interrupt_input_pending
= 0;
6769 nread
= read_avail_input (1);
6770 /* -1 means it's not ok to read the input now.
6771 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6772 0 means there was no keyboard input available. */
6777 select_alarmed
= 1; /* Force the select emulator back to life */
6782 #ifdef SIGIO /* for entire page */
6783 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6786 input_available_signal (signo
)
6789 /* Must preserve main program's value of errno. */
6790 int old_errno
= errno
;
6792 #if defined (USG) && !defined (POSIX_SIGNALS)
6793 /* USG systems forget handlers when they are used;
6794 must reestablish each time */
6795 signal (signo
, input_available_signal
);
6802 if (input_available_clear_time
)
6803 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6806 interrupt_input_pending
= 1;
6808 handle_async_input ();
6818 /* Send ourselves a SIGIO.
6820 This function exists so that the UNBLOCK_INPUT macro in
6821 blockinput.h can have some way to take care of input we put off
6822 dealing with, without assuming that every file which uses
6823 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6825 reinvoke_input_signal ()
6828 handle_async_input ();
6834 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6835 static Lisp_Object menu_bar_one_keymap_changed_items
;
6837 /* These variables hold the vector under construction within
6838 menu_bar_items and its subroutines, and the current index
6839 for storing into that vector. */
6840 static Lisp_Object menu_bar_items_vector
;
6841 static int menu_bar_items_index
;
6843 /* Return a vector of menu items for a menu bar, appropriate
6844 to the current buffer. Each item has three elements in the vector:
6847 OLD is an old vector we can optionally reuse, or nil. */
6850 menu_bar_items (old
)
6853 /* The number of keymaps we're scanning right now, and the number of
6854 keymaps we have allocated space for. */
6857 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6858 in the current keymaps, or nil where it is not a prefix. */
6861 Lisp_Object def
, tail
;
6870 struct gcpro gcpro1
;
6872 /* In order to build the menus, we need to call the keymap
6873 accessors. They all call QUIT. But this function is called
6874 during redisplay, during which a quit is fatal. So inhibit
6875 quitting while building the menus.
6876 We do this instead of specbind because (1) errors will clear it anyway
6877 and (2) this avoids risk of specpdl overflow. */
6878 oquit
= Vinhibit_quit
;
6882 menu_bar_items_vector
= old
;
6884 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
6885 menu_bar_items_index
= 0;
6887 GCPRO1 (menu_bar_items_vector
);
6889 /* Build our list of keymaps.
6890 If we recognize a function key and replace its escape sequence in
6891 keybuf with its symbol, or if the sequence starts with a mouse
6892 click and we need to switch buffers, we jump back here to rebuild
6893 the initial keymaps from the current buffer. */
6897 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6898 if (!NILP (Voverriding_local_map_menu_flag
))
6900 /* Yes, use them (if non-nil) as well as the global map. */
6901 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
6903 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
6904 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
6905 if (!NILP (Voverriding_local_map
))
6906 maps
[nmaps
++] = Voverriding_local_map
;
6910 /* No, so use major and minor mode keymaps and keymap property.
6911 Note that menu-bar bindings in the local-map and keymap
6912 properties may not work reliable, as they are only
6913 recognized when the menu-bar (or mode-line) is updated,
6914 which does not normally happen after every command. */
6917 nminor
= current_minor_maps (NULL
, &tmaps
);
6918 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
6920 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
6921 maps
[nmaps
++] = tem
;
6922 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
6924 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
6926 maps
[nmaps
++] = current_global_map
;
6929 /* Look up in each map the dummy prefix key `menu-bar'. */
6933 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
6934 if (!NILP (maps
[mapno
]))
6936 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
6940 menu_bar_one_keymap_changed_items
= Qnil
;
6941 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
6945 /* Move to the end those items that should be at the end. */
6947 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
6950 int end
= menu_bar_items_index
;
6952 for (i
= 0; i
< end
; i
+= 4)
6953 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
6955 Lisp_Object tem0
, tem1
, tem2
, tem3
;
6956 /* Move the item at index I to the end,
6957 shifting all the others forward. */
6958 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
6959 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
6960 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
6961 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
6963 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
6964 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
6965 (end
- i
- 4) * sizeof (Lisp_Object
));
6966 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
6967 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
6968 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
6969 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
6974 /* Add nil, nil, nil, nil at the end. */
6975 i
= menu_bar_items_index
;
6976 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
6979 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
6980 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
6981 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
6982 menu_bar_items_vector
= tem
;
6984 /* Add this item. */
6985 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6986 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6987 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6988 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
6989 menu_bar_items_index
= i
;
6991 Vinhibit_quit
= oquit
;
6993 return menu_bar_items_vector
;
6996 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
6997 If there's already an item for KEY, add this DEF to it. */
6999 Lisp_Object item_properties
;
7002 menu_bar_item (key
, item
, dummy1
, dummy2
)
7003 Lisp_Object key
, item
, dummy1
;
7006 struct gcpro gcpro1
;
7010 if (EQ (item
, Qundefined
))
7012 /* If a map has an explicit `undefined' as definition,
7013 discard any previously made menu bar item. */
7015 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7016 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7018 if (menu_bar_items_index
> i
+ 4)
7019 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7020 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7021 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7022 menu_bar_items_index
-= 4;
7026 /* If this keymap has already contributed to this KEY,
7027 don't contribute to it a second time. */
7028 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7029 if (!NILP (tem
) || NILP (item
))
7032 menu_bar_one_keymap_changed_items
7033 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7035 /* We add to menu_bar_one_keymap_changed_items before doing the
7036 parse_menu_item, so that if it turns out it wasn't a menu item,
7037 it still correctly hides any further menu item. */
7039 i
= parse_menu_item (item
, 0, 1);
7044 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7046 /* Find any existing item for this KEY. */
7047 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7048 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7051 /* If we did not find this KEY, add it at the end. */
7052 if (i
== menu_bar_items_index
)
7054 /* If vector is too small, get a bigger one. */
7055 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7058 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7059 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7060 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7061 menu_bar_items_vector
= tem
;
7064 /* Add this item. */
7065 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7066 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7067 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7068 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7069 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7070 menu_bar_items_index
= i
;
7072 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7076 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7077 /* If the new and the old items are not both keymaps,
7078 the lookup will only find `item'. */
7079 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7080 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7084 /* This is used as the handler when calling menu_item_eval_property. */
7086 menu_item_eval_property_1 (arg
)
7089 /* If we got a quit from within the menu computation,
7090 quit all the way out of it. This takes care of C-] in the debugger. */
7091 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7092 Fsignal (Qquit
, Qnil
);
7097 /* Evaluate an expression and return the result (or nil if something
7098 went wrong). Used to evaluate dynamic parts of menu items. */
7100 menu_item_eval_property (sexpr
)
7103 int count
= SPECPDL_INDEX ();
7105 specbind (Qinhibit_redisplay
, Qt
);
7106 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7107 menu_item_eval_property_1
);
7108 return unbind_to (count
, val
);
7111 /* This function parses a menu item and leaves the result in the
7112 vector item_properties.
7113 ITEM is a key binding, a possible menu item.
7114 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7115 evaluate dynamic expressions in the menu item.
7116 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7118 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7119 parse_menu_item returns true if the item is a menu item and false
7123 parse_menu_item (item
, notreal
, inmenubar
)
7125 int notreal
, inmenubar
;
7127 Lisp_Object def
, tem
, item_string
, start
;
7128 Lisp_Object cachelist
;
7130 Lisp_Object keyhint
;
7141 /* Create item_properties vector if necessary. */
7142 if (NILP (item_properties
))
7144 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7146 /* Initialize optional entries. */
7147 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7148 AREF (item_properties
, i
) = Qnil
;
7149 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7151 /* Save the item here to protect it from GC. */
7152 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7154 item_string
= XCAR (item
);
7158 if (STRINGP (item_string
))
7160 /* Old format menu item. */
7161 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7163 /* Maybe help string. */
7164 if (CONSP (item
) && STRINGP (XCAR (item
)))
7166 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7171 /* Maybe key binding cache. */
7172 if (CONSP (item
) && CONSP (XCAR (item
))
7173 && (NILP (XCAR (XCAR (item
)))
7174 || VECTORP (XCAR (XCAR (item
)))))
7176 cachelist
= XCAR (item
);
7180 /* This is the real definition--the function to run. */
7181 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7183 /* Get enable property, if any. */
7186 tem
= Fget (item
, Qmenu_enable
);
7188 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7191 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7193 /* New format menu item. */
7194 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7195 start
= XCDR (item
);
7198 /* We have a real binding. */
7199 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7201 item
= XCDR (start
);
7202 /* Is there a cache list with key equivalences. */
7203 if (CONSP (item
) && CONSP (XCAR (item
)))
7205 cachelist
= XCAR (item
);
7209 /* Parse properties. */
7210 while (CONSP (item
) && CONSP (XCDR (item
)))
7215 if (EQ (tem
, QCenable
))
7216 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7217 else if (EQ (tem
, QCvisible
) && !notreal
)
7219 /* If got a visible property and that evaluates to nil
7220 then ignore this item. */
7221 tem
= menu_item_eval_property (XCAR (item
));
7225 else if (EQ (tem
, QChelp
))
7226 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7227 else if (EQ (tem
, QCfilter
))
7229 else if (EQ (tem
, QCkey_sequence
))
7232 if (NILP (cachelist
)
7233 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7234 /* Be GC protected. Set keyhint to item instead of tem. */
7237 else if (EQ (tem
, QCkeys
))
7240 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7241 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7243 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7248 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7250 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7252 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7259 else if (inmenubar
|| !NILP (start
))
7263 return 0; /* not a menu item */
7265 /* If item string is not a string, evaluate it to get string.
7266 If we don't get a string, skip this item. */
7267 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7268 if (!(STRINGP (item_string
) || notreal
))
7270 item_string
= menu_item_eval_property (item_string
);
7271 if (!STRINGP (item_string
))
7273 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7276 /* If got a filter apply it on definition. */
7277 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7280 def
= menu_item_eval_property (list2 (XCAR (filter
),
7281 list2 (Qquote
, def
)));
7283 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7286 /* Enable or disable selection of item. */
7287 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7293 tem
= menu_item_eval_property (tem
);
7294 if (inmenubar
&& NILP (tem
))
7295 return 0; /* Ignore disabled items in menu bar. */
7296 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7299 /* If we got no definition, this item is just unselectable text which
7300 is OK in a submenu but not in the menubar. */
7302 return (inmenubar
? 0 : 1);
7304 /* See if this is a separate pane or a submenu. */
7305 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7306 tem
= get_keymap (def
, 0, 1);
7307 /* For a subkeymap, just record its details and exit. */
7310 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7311 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7315 /* At the top level in the menu bar, do likewise for commands also.
7316 The menu bar does not display equivalent key bindings anyway.
7317 ITEM_PROPERTY_DEF is already set up properly. */
7321 /* This is a command. See if there is an equivalent key binding. */
7322 if (NILP (cachelist
))
7324 /* We have to create a cachelist. */
7325 CHECK_IMPURE (start
);
7326 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7327 cachelist
= XCAR (XCDR (start
));
7329 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7330 if (!NILP (keyhint
))
7332 XSETCAR (cachelist
, XCAR (keyhint
));
7335 else if (STRINGP (tem
))
7337 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7338 XSETCAR (cachelist
, Qt
);
7342 tem
= XCAR (cachelist
);
7349 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7351 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7354 def
= XCAR (prefix
);
7355 prefix
= XCDR (prefix
);
7358 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7360 if (!update_menu_bindings
)
7362 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7364 if (newcache
/* Always check first time. */
7365 /* Should we check everything when precomputing key
7367 /* If something had no key binding before, don't recheck it
7368 because that is too slow--except if we have a list of
7369 rebound commands in Vdefine_key_rebound_commands, do
7370 recheck any command that appears in that list. */
7371 || (CONSP (Vdefine_key_rebound_commands
)
7372 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7375 /* We had a saved key. Is it still bound to the command? */
7378 /* If the command is an alias for another
7379 (such as lmenu.el set it up), check if the
7380 original command matches the cached command. */
7381 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7382 chkcache
= 1; /* Need to recompute key binding. */
7386 /* Recompute equivalent key binding. If the command is an alias
7387 for another (such as lmenu.el set it up), see if the original
7388 command name has equivalent keys. Otherwise look up the
7389 specified command itself. We don't try both, because that
7390 makes lmenu menus slow. */
7392 && SYMBOLP (XSYMBOL (def
)->function
)
7393 && ! NILP (Fget (def
, Qmenu_alias
)))
7394 def
= XSYMBOL (def
)->function
;
7395 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7396 XSETCAR (cachelist
, tem
);
7399 XSETCDR (cachelist
, Qnil
);
7403 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7405 tem
= XCAR (cachelist
);
7409 newcache
= chkcache
;
7412 tem
= Fkey_description (tem
);
7415 if (STRINGP (XCAR (prefix
)))
7416 tem
= concat2 (XCAR (prefix
), tem
);
7417 if (STRINGP (XCDR (prefix
)))
7418 tem
= concat2 (tem
, XCDR (prefix
));
7420 XSETCDR (cachelist
, tem
);
7424 tem
= XCDR (cachelist
);
7425 if (newcache
&& !NILP (tem
))
7427 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7428 XSETCDR (cachelist
, tem
);
7431 /* If we only want to precompute equivalent key bindings, stop here. */
7435 /* If we have an equivalent key binding, use that. */
7436 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7438 /* Include this when menu help is implemented.
7439 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7440 if (!(NILP (tem) || STRINGP (tem)))
7442 tem = menu_item_eval_property (tem);
7445 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7449 /* Handle radio buttons or toggle boxes. */
7450 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7452 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7453 = menu_item_eval_property (tem
);
7460 /***********************************************************************
7462 ***********************************************************************/
7464 /* A vector holding tool bar items while they are parsed in function
7465 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7468 static Lisp_Object tool_bar_items_vector
;
7470 /* A vector holding the result of parse_tool_bar_item. Layout is like
7471 the one for a single item in tool_bar_items_vector. */
7473 static Lisp_Object tool_bar_item_properties
;
7475 /* Next free index in tool_bar_items_vector. */
7477 static int ntool_bar_items
;
7479 /* The symbols `tool-bar', and `:image'. */
7481 extern Lisp_Object Qtool_bar
;
7482 Lisp_Object QCimage
;
7484 /* Function prototypes. */
7486 static void init_tool_bar_items
P_ ((Lisp_Object
));
7487 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7488 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7489 static void append_tool_bar_item
P_ ((void));
7492 /* Return a vector of tool bar items for keymaps currently in effect.
7493 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7494 tool bar items found. */
7497 tool_bar_items (reuse
, nitems
)
7508 /* In order to build the menus, we need to call the keymap
7509 accessors. They all call QUIT. But this function is called
7510 during redisplay, during which a quit is fatal. So inhibit
7511 quitting while building the menus. We do this instead of
7512 specbind because (1) errors will clear it anyway and (2) this
7513 avoids risk of specpdl overflow. */
7514 oquit
= Vinhibit_quit
;
7517 /* Initialize tool_bar_items_vector and protect it from GC. */
7518 init_tool_bar_items (reuse
);
7520 /* Build list of keymaps in maps. Set nmaps to the number of maps
7523 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7524 if (!NILP (Voverriding_local_map_menu_flag
))
7526 /* Yes, use them (if non-nil) as well as the global map. */
7527 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7529 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7530 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7531 if (!NILP (Voverriding_local_map
))
7532 maps
[nmaps
++] = Voverriding_local_map
;
7536 /* No, so use major and minor mode keymaps and keymap property.
7537 Note that tool-bar bindings in the local-map and keymap
7538 properties may not work reliable, as they are only
7539 recognized when the tool-bar (or mode-line) is updated,
7540 which does not normally happen after every command. */
7543 nminor
= current_minor_maps (NULL
, &tmaps
);
7544 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7546 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7547 maps
[nmaps
++] = tem
;
7548 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7550 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7553 /* Add global keymap at the end. */
7554 maps
[nmaps
++] = current_global_map
;
7556 /* Process maps in reverse order and look up in each map the prefix
7558 for (i
= nmaps
- 1; i
>= 0; --i
)
7559 if (!NILP (maps
[i
]))
7563 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7568 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7569 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7571 Lisp_Object keydef
= XCAR (tail
);
7573 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7578 Vinhibit_quit
= oquit
;
7579 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7580 return tool_bar_items_vector
;
7584 /* Process the definition of KEY which is DEF. */
7587 process_tool_bar_item (key
, def
)
7588 Lisp_Object key
, def
;
7591 extern Lisp_Object Qundefined
;
7592 struct gcpro gcpro1
, gcpro2
;
7594 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7598 if (EQ (def
, Qundefined
))
7600 /* If a map has an explicit `undefined' as definition,
7601 discard any previously made item. */
7602 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7604 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7606 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7608 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7609 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7610 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7611 * sizeof (Lisp_Object
)));
7612 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7617 else if (parse_tool_bar_item (key
, def
))
7618 /* Append a new tool bar item to tool_bar_items_vector. Accept
7619 more than one definition for the same key. */
7620 append_tool_bar_item ();
7626 /* Parse a tool bar item specification ITEM for key KEY and return the
7627 result in tool_bar_item_properties. Value is zero if ITEM is
7630 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7632 CAPTION is the caption of the item, If it's not a string, it is
7633 evaluated to get a string.
7635 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7636 as binding are currently ignored.
7638 The following properties are recognized:
7642 FORM is evaluated and specifies whether the tool bar item is
7643 enabled or disabled.
7647 FORM is evaluated and specifies whether the tool bar item is visible.
7649 - `:filter FUNCTION'
7651 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7652 result is stored as the new binding.
7654 - `:button (TYPE SELECTED)'
7656 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7657 and specifies whether the button is selected (pressed) or not.
7661 IMAGES is either a single image specification or a vector of four
7662 image specifications. See enum tool_bar_item_images.
7664 - `:help HELP-STRING'.
7666 Gives a help string to display for the tool bar item. */
7669 parse_tool_bar_item (key
, item
)
7670 Lisp_Object key
, item
;
7672 /* Access slot with index IDX of vector tool_bar_item_properties. */
7673 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7675 Lisp_Object filter
= Qnil
;
7676 Lisp_Object caption
;
7679 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7680 Rule out items that aren't lists, don't start with
7681 `menu-item' or whose rest following `tool-bar-item' is not a
7684 || !EQ (XCAR (item
), Qmenu_item
)
7685 || (item
= XCDR (item
),
7689 /* Create tool_bar_item_properties vector if necessary. Reset it to
7691 if (VECTORP (tool_bar_item_properties
))
7693 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7697 tool_bar_item_properties
7698 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7701 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7702 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7704 /* Get the caption of the item. If the caption is not a string,
7705 evaluate it to get a string. If we don't get a string, skip this
7707 caption
= XCAR (item
);
7708 if (!STRINGP (caption
))
7710 caption
= menu_item_eval_property (caption
);
7711 if (!STRINGP (caption
))
7714 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7716 /* Give up if rest following the caption is not a list. */
7721 /* Store the binding. */
7722 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7725 /* Ignore cached key binding, if any. */
7726 if (CONSP (item
) && CONSP (XCAR (item
)))
7729 /* Process the rest of the properties. */
7730 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7732 Lisp_Object key
, value
;
7735 value
= XCAR (XCDR (item
));
7737 if (EQ (key
, QCenable
))
7738 /* `:enable FORM'. */
7739 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7740 else if (EQ (key
, QCvisible
))
7742 /* `:visible FORM'. If got a visible property and that
7743 evaluates to nil then ignore this item. */
7744 if (NILP (menu_item_eval_property (value
)))
7747 else if (EQ (key
, QChelp
))
7748 /* `:help HELP-STRING'. */
7749 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7750 else if (EQ (key
, QCfilter
))
7751 /* ':filter FORM'. */
7753 else if (EQ (key
, QCbutton
) && CONSP (value
))
7755 /* `:button (TYPE . SELECTED)'. */
7756 Lisp_Object type
, selected
;
7758 type
= XCAR (value
);
7759 selected
= XCDR (value
);
7760 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7762 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7763 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7766 else if (EQ (key
, QCimage
)
7768 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7769 /* Value is either a single image specification or a vector
7770 of 4 such specifications for the different button states. */
7771 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7774 /* If got a filter apply it on binding. */
7776 PROP (TOOL_BAR_ITEM_BINDING
)
7777 = menu_item_eval_property (list2 (filter
,
7779 PROP (TOOL_BAR_ITEM_BINDING
))));
7781 /* See if the binding is a keymap. Give up if it is. */
7782 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7785 /* Enable or disable selection of item. */
7786 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7787 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7788 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7790 /* Handle radio buttons or toggle boxes. */
7791 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7792 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7793 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7801 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7802 that can be reused. */
7805 init_tool_bar_items (reuse
)
7808 if (VECTORP (reuse
))
7809 tool_bar_items_vector
= reuse
;
7811 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7812 ntool_bar_items
= 0;
7816 /* Append parsed tool bar item properties from
7817 tool_bar_item_properties */
7820 append_tool_bar_item ()
7822 Lisp_Object
*to
, *from
;
7824 /* Enlarge tool_bar_items_vector if necessary. */
7825 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7826 >= XVECTOR (tool_bar_items_vector
)->size
)
7828 Lisp_Object new_vector
;
7829 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7831 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7832 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7833 XVECTOR (new_vector
)->contents
,
7834 old_size
* sizeof (Lisp_Object
));
7835 tool_bar_items_vector
= new_vector
;
7838 /* Append entries from tool_bar_item_properties to the end of
7839 tool_bar_items_vector. */
7840 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7841 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7842 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7843 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7850 /* Read a character using menus based on maps in the array MAPS.
7851 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7852 Return t if we displayed a menu but the user rejected it.
7854 PREV_EVENT is the previous input event, or nil if we are reading
7855 the first event of a key sequence.
7857 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7858 if we used a mouse menu to read the input, or zero otherwise. If
7859 USED_MOUSE_MENU is null, we don't dereference it.
7861 The prompting is done based on the prompt-string of the map
7862 and the strings associated with various map elements.
7864 This can be done with X menus or with menus put in the minibuf.
7865 These are done in different ways, depending on how the input will be read.
7866 Menus using X are done after auto-saving in read-char, getting the input
7867 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7868 and do auto-saving in the inner call of read_char. */
7871 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
7874 Lisp_Object prev_event
;
7875 int *used_mouse_menu
;
7878 register Lisp_Object name
= Qnil
;
7880 if (used_mouse_menu
)
7881 *used_mouse_menu
= 0;
7883 /* Use local over global Menu maps */
7885 if (! menu_prompting
)
7888 /* Optionally disregard all but the global map. */
7889 if (inhibit_local_menu_bar_menus
)
7891 maps
+= (nmaps
- 1);
7895 /* Get the menu name from the first map that has one (a prompt string). */
7896 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7898 name
= Fkeymap_prompt (maps
[mapno
]);
7903 /* If we don't have any menus, just read a character normally. */
7904 if (!STRINGP (name
))
7908 /* If we got to this point via a mouse click,
7909 use a real menu for mouse selection. */
7910 if (EVENT_HAS_PARAMETERS (prev_event
)
7911 && !EQ (XCAR (prev_event
), Qmenu_bar
)
7912 && !EQ (XCAR (prev_event
), Qtool_bar
))
7914 /* Display the menu and get the selection. */
7915 Lisp_Object
*realmaps
7916 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
7920 /* Use the maps that are not nil. */
7921 for (mapno
= 0; mapno
< nmaps
; mapno
++)
7922 if (!NILP (maps
[mapno
]))
7923 realmaps
[nmaps1
++] = maps
[mapno
];
7925 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
7930 record_menu_key (XCAR (value
));
7932 /* If we got multiple events, unread all but
7934 There is no way to prevent those unread events
7935 from showing up later in last_nonmenu_event.
7936 So turn symbol and integer events into lists,
7937 to indicate that they came from a mouse menu,
7938 so that when present in last_nonmenu_event
7939 they won't confuse things. */
7940 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
7942 record_menu_key (XCAR (tem
));
7943 if (SYMBOLP (XCAR (tem
))
7944 || INTEGERP (XCAR (tem
)))
7945 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
7948 /* If we got more than one event, put all but the first
7949 onto this list to be read later.
7950 Return just the first event now. */
7951 Vunread_command_events
7952 = nconc2 (XCDR (value
), Vunread_command_events
);
7953 value
= XCAR (value
);
7955 else if (NILP (value
))
7957 if (used_mouse_menu
)
7958 *used_mouse_menu
= 1;
7961 #endif /* HAVE_MENUS */
7965 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7966 We make this bigger when necessary, and never free it. */
7967 static char *read_char_minibuf_menu_text
;
7968 /* Size of that buffer. */
7969 static int read_char_minibuf_menu_width
;
7972 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
7978 register Lisp_Object name
;
7980 /* FIXME: Use the minibuffer's frame width. */
7981 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
7984 Lisp_Object rest
, vector
;
7990 if (! menu_prompting
)
7993 /* Make sure we have a big enough buffer for the menu text. */
7994 if (read_char_minibuf_menu_text
== 0)
7996 read_char_minibuf_menu_width
= width
+ 4;
7997 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
7999 else if (width
+ 4 > read_char_minibuf_menu_width
)
8001 read_char_minibuf_menu_width
= width
+ 4;
8002 read_char_minibuf_menu_text
8003 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8005 menu
= read_char_minibuf_menu_text
;
8007 /* Get the menu name from the first map that has one (a prompt string). */
8008 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8010 name
= Fkeymap_prompt (maps
[mapno
]);
8015 /* If we don't have any menus, just read a character normally. */
8016 if (!STRINGP (name
))
8019 /* Prompt string always starts with map's prompt, and a space. */
8020 strcpy (menu
, SDATA (name
));
8021 nlength
= SBYTES (name
);
8022 menu
[nlength
++] = ':';
8023 menu
[nlength
++] = ' ';
8026 /* Start prompting at start of first map. */
8030 /* Present the documented bindings, a line at a time. */
8037 Lisp_Object orig_defn_macro
;
8039 /* Loop over elements of map. */
8044 /* If reached end of map, start at beginning of next map. */
8048 /* At end of last map, wrap around to first map if just starting,
8049 or end this line if already have something on it. */
8053 if (notfirst
|| nobindings
) break;
8058 /* Look at the next element of the map. */
8060 elt
= XVECTOR (vector
)->contents
[idx
];
8062 elt
= Fcar_safe (rest
);
8064 if (idx
< 0 && VECTORP (elt
))
8066 /* If we found a dense table in the keymap,
8067 advanced past it, but start scanning its contents. */
8068 rest
= Fcdr_safe (rest
);
8074 /* An ordinary element. */
8075 Lisp_Object event
, tem
;
8079 event
= Fcar_safe (elt
); /* alist */
8080 elt
= Fcdr_safe (elt
);
8084 XSETINT (event
, idx
); /* vector */
8087 /* Ignore the element if it has no prompt string. */
8088 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8090 /* 1 if the char to type matches the string. */
8092 Lisp_Object upcased_event
, downcased_event
;
8093 Lisp_Object desc
= Qnil
;
8095 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8097 upcased_event
= Fupcase (event
);
8098 downcased_event
= Fdowncase (event
);
8099 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8100 || XINT (downcased_event
) == SREF (s
, 0));
8102 desc
= Fsingle_key_description (event
, Qnil
);
8104 #if 0 /* It is redundant to list the equivalent key bindings because
8105 the prefix is what the user has already typed. */
8107 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8109 /* Insert equivalent keybinding. */
8110 s
= concat2 (s
, tem
);
8113 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8114 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8116 /* Insert button prefix. */
8117 Lisp_Object selected
8118 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8119 if (EQ (tem
, QCradio
))
8120 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8122 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8123 s
= concat2 (tem
, s
);
8127 /* If we have room for the prompt string, add it to this line.
8128 If this is the first on the line, always add it. */
8129 if ((SCHARS (s
) + i
+ 2
8130 + (char_matches
? 0 : SCHARS (desc
) + 3))
8136 /* Punctuate between strings. */
8139 strcpy (menu
+ i
, ", ");
8145 /* If the char to type doesn't match the string's
8146 first char, explicitly show what char to type. */
8149 /* Add as much of string as fits. */
8150 thiswidth
= SCHARS (desc
);
8151 if (thiswidth
+ i
> width
)
8152 thiswidth
= width
- i
;
8153 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8155 strcpy (menu
+ i
, " = ");
8159 /* Add as much of string as fits. */
8160 thiswidth
= SCHARS (s
);
8161 if (thiswidth
+ i
> width
)
8162 thiswidth
= width
- i
;
8163 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8169 /* If this element does not fit, end the line now,
8170 and save the element for the next line. */
8171 strcpy (menu
+ i
, "...");
8176 /* Move past this element. */
8177 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8178 /* Handle reaching end of dense table. */
8183 rest
= Fcdr_safe (rest
);
8187 /* Prompt with that and read response. */
8188 message2_nolog (menu
, strlen (menu
),
8189 ! NILP (current_buffer
->enable_multibyte_characters
));
8191 /* Make believe its not a keyboard macro in case the help char
8192 is pressed. Help characters are not recorded because menu prompting
8193 is not used on replay.
8195 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8196 current_kboard
->defining_kbd_macro
= Qnil
;
8198 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8199 while (BUFFERP (obj
));
8200 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8202 if (!INTEGERP (obj
))
8207 if (! EQ (obj
, menu_prompt_more_char
)
8208 && (!INTEGERP (menu_prompt_more_char
)
8209 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8211 if (!NILP (current_kboard
->defining_kbd_macro
))
8212 store_kbd_macro_char (obj
);
8215 /* Help char - go round again */
8219 /* Reading key sequences. */
8221 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8222 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8223 keymap, or nil otherwise. Return the index of the first keymap in
8224 which KEY has any binding, or NMAPS if no map has a binding.
8226 If KEY is a meta ASCII character, treat it like meta-prefix-char
8227 followed by the corresponding non-meta character. Keymaps in
8228 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8231 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8234 NEXT may be the same array as CURRENT. */
8237 follow_key (key
, nmaps
, current
, defs
, next
)
8239 Lisp_Object
*current
, *defs
, *next
;
8242 int i
, first_binding
;
8244 first_binding
= nmaps
;
8245 for (i
= nmaps
- 1; i
>= 0; i
--)
8247 if (! NILP (current
[i
]))
8249 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8250 if (! NILP (defs
[i
]))
8257 /* Given the set of bindings we've found, produce the next set of maps. */
8258 if (first_binding
< nmaps
)
8259 for (i
= 0; i
< nmaps
; i
++)
8260 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8262 return first_binding
;
8265 /* Structure used to keep track of partial application of key remapping
8266 such as Vfunction_key_map and Vkey_translation_map. */
8267 typedef struct keyremap
8269 Lisp_Object map
, parent
;
8273 /* Lookup KEY in MAP.
8274 MAP is a keymap mapping keys to key vectors or functions.
8275 If the mapping is a function and DO_FUNCTION is non-zero, then
8276 the function is called with PROMPT as parameter and its return
8277 value is used as the return value of this function (after checking
8278 that it is indeed a vector). */
8281 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8282 Lisp_Object map
, key
, prompt
;
8287 next
= access_keymap (map
, key
, 1, 0, 1);
8289 /* Handle symbol with autoload definition. */
8290 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8291 && CONSP (XSYMBOL (next
)->function
)
8292 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8293 do_autoload (XSYMBOL (next
)->function
, next
);
8295 /* Handle a symbol whose function definition is a keymap
8297 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8298 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8299 || KEYMAPP (XSYMBOL (next
)->function
)))
8300 next
= XSYMBOL (next
)->function
;
8302 /* If the keymap gives a function, not an
8303 array, then call the function with one arg and use
8304 its value instead. */
8305 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8310 next
= call1 (next
, prompt
);
8311 /* If the function returned something invalid,
8312 barf--don't ignore it.
8313 (To ignore it safely, we would need to gcpro a bunch of
8314 other variables.) */
8315 if (! (VECTORP (next
) || STRINGP (next
)))
8316 error ("Function %s returns invalid key sequence", tem
);
8321 /* Do one step of the key remapping used for function-key-map and
8322 key-translation-map:
8323 KEYBUF is the buffer holding the input events.
8324 BUFSIZE is its maximum size.
8325 FKEY is a pointer to the keyremap structure to use.
8326 INPUT is the index of the last element in KEYBUF.
8327 DOIT if non-zero says that the remapping can actually take place.
8328 DIFF is used to return the number of keys added/removed by the remapping.
8329 PARENT is the root of the keymap.
8330 PROMPT is the prompt to use if the remapping happens through a function.
8331 The return value is non-zero if the remapping actually took place. */
8334 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8335 Lisp_Object
*keybuf
, prompt
;
8337 int input
, doit
, *diff
, bufsize
;
8339 Lisp_Object next
, key
;
8341 key
= keybuf
[fkey
->end
++];
8342 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8344 /* If keybuf[fkey->start..fkey->end] is bound in the
8345 map and we're in a position to do the key remapping, replace it with
8346 the binding and restart with fkey->start at the end. */
8347 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8349 int len
= XFASTINT (Flength (next
));
8352 *diff
= len
- (fkey
->end
- fkey
->start
);
8354 if (input
+ *diff
>= bufsize
)
8355 error ("Key sequence too long");
8357 /* Shift the keys that follow fkey->end. */
8359 for (i
= fkey
->end
; i
< input
; i
++)
8360 keybuf
[i
+ *diff
] = keybuf
[i
];
8362 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8363 keybuf
[i
+ *diff
] = keybuf
[i
];
8364 /* Overwrite the old keys with the new ones. */
8365 for (i
= 0; i
< len
; i
++)
8366 keybuf
[fkey
->start
+ i
]
8367 = Faref (next
, make_number (i
));
8369 fkey
->start
= fkey
->end
+= *diff
;
8370 fkey
->map
= fkey
->parent
;
8375 fkey
->map
= get_keymap (next
, 0, 1);
8377 /* If we no longer have a bound suffix, try a new position for
8379 if (!CONSP (fkey
->map
))
8381 fkey
->end
= ++fkey
->start
;
8382 fkey
->map
= fkey
->parent
;
8387 /* Read a sequence of keys that ends with a non prefix character,
8388 storing it in KEYBUF, a buffer of size BUFSIZE.
8390 Return the length of the key sequence stored.
8391 Return -1 if the user rejected a command menu.
8393 Echo starting immediately unless `prompt' is 0.
8395 Where a key sequence ends depends on the currently active keymaps.
8396 These include any minor mode keymaps active in the current buffer,
8397 the current buffer's local map, and the global map.
8399 If a key sequence has no other bindings, we check Vfunction_key_map
8400 to see if some trailing subsequence might be the beginning of a
8401 function key's sequence. If so, we try to read the whole function
8402 key, and substitute its symbolic name into the key sequence.
8404 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8405 `double-' events into similar click events, if that would make them
8406 bound. We try to turn `triple-' events first into `double-' events,
8409 If we get a mouse click in a mode line, vertical divider, or other
8410 non-text area, we treat the click as if it were prefixed by the
8411 symbol denoting that area - `mode-line', `vertical-line', or
8414 If the sequence starts with a mouse click, we read the key sequence
8415 with respect to the buffer clicked on, not the current buffer.
8417 If the user switches frames in the midst of a key sequence, we put
8418 off the switch-frame event until later; the next call to
8419 read_char will return it.
8421 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8422 from the selected window's buffer. */
8425 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8426 can_return_switch_frame
, fix_current_buffer
)
8427 Lisp_Object
*keybuf
;
8430 int dont_downcase_last
;
8431 int can_return_switch_frame
;
8432 int fix_current_buffer
;
8434 volatile Lisp_Object from_string
;
8435 volatile int count
= SPECPDL_INDEX ();
8437 /* How many keys there are in the current key sequence. */
8440 /* The length of the echo buffer when we started reading, and
8441 the length of this_command_keys when we started reading. */
8442 volatile int echo_start
;
8443 volatile int keys_start
;
8445 /* The number of keymaps we're scanning right now, and the number of
8446 keymaps we have allocated space for. */
8448 volatile int nmaps_allocated
= 0;
8450 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8451 the current keymaps. */
8452 Lisp_Object
*volatile defs
= NULL
;
8454 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8455 in the current keymaps, or nil where it is not a prefix. */
8456 Lisp_Object
*volatile submaps
= NULL
;
8458 /* The local map to start out with at start of key sequence. */
8459 volatile Lisp_Object orig_local_map
;
8461 /* The map from the `keymap' property to start out with at start of
8463 volatile Lisp_Object orig_keymap
;
8465 /* 1 if we have already considered switching to the local-map property
8466 of the place where a mouse click occurred. */
8467 volatile int localized_local_map
= 0;
8469 /* The index in defs[] of the first keymap that has a binding for
8470 this key sequence. In other words, the lowest i such that
8471 defs[i] is non-nil. */
8472 volatile int first_binding
;
8473 /* Index of the first key that has no binding.
8474 It is useless to try fkey.start larger than that. */
8475 volatile int first_unbound
;
8477 /* If t < mock_input, then KEYBUF[t] should be read as the next
8480 We use this to recover after recognizing a function key. Once we
8481 realize that a suffix of the current key sequence is actually a
8482 function key's escape sequence, we replace the suffix with the
8483 function key's binding from Vfunction_key_map. Now keybuf
8484 contains a new and different key sequence, so the echo area,
8485 this_command_keys, and the submaps and defs arrays are wrong. In
8486 this situation, we set mock_input to t, set t to 0, and jump to
8487 restart_sequence; the loop will read keys from keybuf up until
8488 mock_input, thus rebuilding the state; and then it will resume
8489 reading characters from the keyboard. */
8490 volatile int mock_input
= 0;
8492 /* If the sequence is unbound in submaps[], then
8493 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8494 and fkey.map is its binding.
8496 These might be > t, indicating that all function key scanning
8497 should hold off until t reaches them. We do this when we've just
8498 recognized a function key, to avoid searching for the function
8499 key's again in Vfunction_key_map. */
8500 volatile keyremap fkey
;
8502 /* Likewise, for key_translation_map. */
8503 volatile keyremap keytran
;
8505 /* If we receive a `switch-frame' or `select-window' event in the middle of
8506 a key sequence, we put it off for later.
8507 While we're reading, we keep the event here. */
8508 volatile Lisp_Object delayed_switch_frame
;
8510 /* See the comment below... */
8511 #if defined (GOBBLE_FIRST_EVENT)
8512 Lisp_Object first_event
;
8515 volatile Lisp_Object original_uppercase
;
8516 volatile int original_uppercase_position
= -1;
8518 /* Gets around Microsoft compiler limitations. */
8521 struct buffer
*starting_buffer
;
8523 /* List of events for which a fake prefix key has been generated. */
8524 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8526 #if defined (GOBBLE_FIRST_EVENT)
8530 struct gcpro gcpro1
;
8532 GCPRO1 (fake_prefixed_keys
);
8533 raw_keybuf_count
= 0;
8535 last_nonmenu_event
= Qnil
;
8537 delayed_switch_frame
= Qnil
;
8538 fkey
.map
= fkey
.parent
= Vfunction_key_map
;
8539 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8540 /* If there is no translation-map, turn off scanning. */
8541 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8542 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8547 echo_prompt (prompt
);
8548 else if (cursor_in_echo_area
8549 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8550 && NILP (Fzerop (Vecho_keystrokes
)))
8551 /* This doesn't put in a dash if the echo buffer is empty, so
8552 you don't always see a dash hanging out in the minibuffer. */
8556 /* Record the initial state of the echo area and this_command_keys;
8557 we will need to restore them if we replay a key sequence. */
8559 echo_start
= echo_length ();
8560 keys_start
= this_command_key_count
;
8561 this_single_command_key_start
= keys_start
;
8563 #if defined (GOBBLE_FIRST_EVENT)
8564 /* This doesn't quite work, because some of the things that read_char
8565 does cannot safely be bypassed. It seems too risky to try to make
8568 /* Read the first char of the sequence specially, before setting
8569 up any keymaps, in case a filter runs and switches buffers on us. */
8570 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8572 #endif /* GOBBLE_FIRST_EVENT */
8574 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8575 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8578 /* We jump here when the key sequence has been thoroughly changed, and
8579 we need to rescan it starting from the beginning. When we jump here,
8580 keybuf[0..mock_input] holds the sequence we should reread. */
8583 starting_buffer
= current_buffer
;
8584 first_unbound
= bufsize
+ 1;
8586 /* Build our list of keymaps.
8587 If we recognize a function key and replace its escape sequence in
8588 keybuf with its symbol, or if the sequence starts with a mouse
8589 click and we need to switch buffers, we jump back here to rebuild
8590 the initial keymaps from the current buffer. */
8593 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8594 || !NILP (Voverriding_local_map
))
8596 if (3 > nmaps_allocated
)
8598 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8599 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8600 nmaps_allocated
= 3;
8602 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8603 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8604 if (!NILP (Voverriding_local_map
))
8605 submaps
[nmaps
++] = Voverriding_local_map
;
8613 nminor
= current_minor_maps (0, &maps
);
8614 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8616 if (total
> nmaps_allocated
)
8618 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8619 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8620 nmaps_allocated
= total
;
8623 if (!NILP (orig_keymap
))
8624 submaps
[nmaps
++] = orig_keymap
;
8626 bcopy (maps
, (void *) (submaps
+ nmaps
),
8627 nminor
* sizeof (submaps
[0]));
8631 submaps
[nmaps
++] = orig_local_map
;
8633 submaps
[nmaps
++] = current_global_map
;
8635 /* Find an accurate initial value for first_binding. */
8636 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8637 if (! NILP (submaps
[first_binding
]))
8640 /* Start from the beginning in keybuf. */
8643 /* These are no-ops the first time through, but if we restart, they
8644 revert the echo area and this_command_keys to their original state. */
8645 this_command_key_count
= keys_start
;
8646 if (INTERACTIVE
&& t
< mock_input
)
8647 echo_truncate (echo_start
);
8649 /* If the best binding for the current key sequence is a keymap, or
8650 we may be looking at a function key's escape sequence, keep on
8652 while (first_binding
< nmaps
8653 /* Keep reading as long as there's a prefix binding. */
8654 ? !NILP (submaps
[first_binding
])
8655 /* Don't return in the middle of a possible function key sequence,
8656 if the only bindings we found were via case conversion.
8657 Thus, if ESC O a has a function-key-map translation
8658 and ESC o has a binding, don't return after ESC O,
8659 so that we can translate ESC O plus the next character. */
8660 : (fkey
.start
< t
|| keytran
.start
< t
))
8663 int used_mouse_menu
= 0;
8665 /* Where the last real key started. If we need to throw away a
8666 key that has expanded into more than one element of keybuf
8667 (say, a mouse click on the mode line which is being treated
8668 as [mode-line (mouse-...)], then we backtrack to this point
8670 volatile int last_real_key_start
;
8672 /* These variables are analogous to echo_start and keys_start;
8673 while those allow us to restart the entire key sequence,
8674 echo_local_start and keys_local_start allow us to throw away
8676 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8678 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8679 eassert (fkey
.start
<= fkey
.end
);
8680 eassert (keytran
.start
<= keytran
.end
);
8681 /* key-translation-map is applied *after* function-key-map. */
8682 eassert (keytran
.end
<= fkey
.start
);
8684 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8685 { /* The prefix upto first_unbound has no binding and has
8686 no translation left to do either, so we know it's unbound.
8687 If we don't stop now, we risk staying here indefinitely
8688 (if the user keeps entering fkey or keytran prefixes
8689 like C-c ESC ESC ESC ESC ...) */
8691 for (i
= first_unbound
+ 1; i
< t
; i
++)
8692 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8693 mock_input
= t
- first_unbound
- 1;
8694 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8695 fkey
.map
= fkey
.parent
;
8696 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8697 keytran
.map
= keytran
.parent
;
8698 goto replay_sequence
;
8702 error ("Key sequence too long");
8705 echo_local_start
= echo_length ();
8706 keys_local_start
= this_command_key_count
;
8707 local_first_binding
= first_binding
;
8710 /* These are no-ops, unless we throw away a keystroke below and
8711 jumped back up to replay_key; in that case, these restore the
8712 variables to their original state, allowing us to replay the
8714 if (INTERACTIVE
&& t
< mock_input
)
8715 echo_truncate (echo_local_start
);
8716 this_command_key_count
= keys_local_start
;
8717 first_binding
= local_first_binding
;
8719 /* By default, assume each event is "real". */
8720 last_real_key_start
= t
;
8722 /* Does mock_input indicate that we are re-reading a key sequence? */
8726 add_command_key (key
);
8727 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8728 && NILP (Fzerop (Vecho_keystrokes
)))
8732 /* If not, we should actually read a character. */
8737 KBOARD
*interrupted_kboard
= current_kboard
;
8738 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8739 if (setjmp (wrong_kboard_jmpbuf
))
8741 if (!NILP (delayed_switch_frame
))
8743 interrupted_kboard
->kbd_queue
8744 = Fcons (delayed_switch_frame
,
8745 interrupted_kboard
->kbd_queue
);
8746 delayed_switch_frame
= Qnil
;
8749 interrupted_kboard
->kbd_queue
8750 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8752 /* If the side queue is non-empty, ensure it begins with a
8753 switch-frame, so we'll replay it in the right context. */
8754 if (CONSP (interrupted_kboard
->kbd_queue
)
8755 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8756 !(EVENT_HAS_PARAMETERS (key
)
8757 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8761 XSETFRAME (frame
, interrupted_frame
);
8762 interrupted_kboard
->kbd_queue
8763 = Fcons (make_lispy_switch_frame (frame
),
8764 interrupted_kboard
->kbd_queue
);
8767 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8768 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8769 goto replay_sequence
;
8772 key
= read_char (NILP (prompt
), nmaps
,
8773 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8777 /* read_char returns t when it shows a menu and the user rejects it.
8781 unbind_to (count
, Qnil
);
8786 /* read_char returns -1 at the end of a macro.
8787 Emacs 18 handles this by returning immediately with a
8788 zero, so that's what we'll do. */
8789 if (INTEGERP (key
) && XINT (key
) == -1)
8792 /* The Microsoft C compiler can't handle the goto that
8798 /* If the current buffer has been changed from under us, the
8799 keymap may have changed, so replay the sequence. */
8802 EMACS_TIME initial_idleness_start_time
;
8803 EMACS_SET_SECS_USECS (initial_idleness_start_time
,
8804 EMACS_SECS (timer_last_idleness_start_time
),
8805 EMACS_USECS (timer_last_idleness_start_time
));
8807 /* Resume idle state, using the same start-time as before. */
8808 timer_start_idle ();
8809 timer_idleness_start_time
= initial_idleness_start_time
;
8812 /* Reset the current buffer from the selected window
8813 in case something changed the former and not the latter.
8814 This is to be more consistent with the behavior
8815 of the command_loop_1. */
8816 if (fix_current_buffer
)
8818 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8820 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8821 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8824 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8825 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8826 goto replay_sequence
;
8829 /* If we have a quit that was typed in another frame, and
8830 quit_throw_to_read_char switched buffers,
8831 replay to get the right keymap. */
8833 && XINT (key
) == quit_char
8834 && current_buffer
!= starting_buffer
)
8837 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8841 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8842 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8843 goto replay_sequence
;
8848 if (EVENT_HAS_PARAMETERS (key
)
8849 /* Either a `switch-frame' or a `select-window' event. */
8850 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8852 /* If we're at the beginning of a key sequence, and the caller
8853 says it's okay, go ahead and return this event. If we're
8854 in the midst of a key sequence, delay it until the end. */
8855 if (t
> 0 || !can_return_switch_frame
)
8857 delayed_switch_frame
= key
;
8863 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8866 /* Clicks in non-text areas get prefixed by the symbol
8867 in their CHAR-ADDRESS field. For example, a click on
8868 the mode line is prefixed by the symbol `mode-line'.
8870 Furthermore, key sequences beginning with mouse clicks
8871 are read using the keymaps of the buffer clicked on, not
8872 the current buffer. So we may have to switch the buffer
8875 When we turn one event into two events, we must make sure
8876 that neither of the two looks like the original--so that,
8877 if we replay the events, they won't be expanded again.
8878 If not for this, such reexpansion could happen either here
8879 or when user programs play with this-command-keys. */
8880 if (EVENT_HAS_PARAMETERS (key
))
8885 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
8886 if (EQ (kind
, Qmouse_click
))
8888 Lisp_Object window
, posn
;
8890 window
= POSN_WINDOW (EVENT_START (key
));
8891 posn
= POSN_POSN (EVENT_START (key
));
8894 || (!NILP (fake_prefixed_keys
)
8895 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
8897 /* We're looking a second time at an event for which
8898 we generated a fake prefix key. Set
8899 last_real_key_start appropriately. */
8901 last_real_key_start
= t
- 1;
8904 /* Key sequences beginning with mouse clicks are
8905 read using the keymaps in the buffer clicked on,
8906 not the current buffer. If we're at the
8907 beginning of a key sequence, switch buffers. */
8908 if (last_real_key_start
== 0
8910 && BUFFERP (XWINDOW (window
)->buffer
)
8911 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
8913 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8917 /* Arrange to go back to the original buffer once we're
8918 done reading the key sequence. Note that we can't
8919 use save_excursion_{save,restore} here, because they
8920 save point as well as the current buffer; we don't
8921 want to save point, because redisplay may change it,
8922 to accommodate a Fset_window_start or something. We
8923 don't want to do this at the top of the function,
8924 because we may get input from a subprocess which
8925 wants to change the selected window and stuff (say,
8927 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
8929 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8931 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
8932 orig_local_map
= get_local_map (PT
, current_buffer
,
8934 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8935 goto replay_sequence
;
8938 /* For a mouse click, get the local text-property keymap
8939 of the place clicked on, rather than point. */
8940 if (last_real_key_start
== 0
8941 && CONSP (XCDR (key
))
8942 && ! localized_local_map
)
8944 Lisp_Object map_here
, start
, pos
;
8946 localized_local_map
= 1;
8947 start
= EVENT_START (key
);
8949 if (CONSP (start
) && POSN_INBUFFER_P (start
))
8951 pos
= POSN_BUFFER_POSN (start
);
8953 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
8955 map_here
= get_local_map (XINT (pos
),
8956 current_buffer
, Qlocal_map
);
8957 if (!EQ (map_here
, orig_local_map
))
8959 orig_local_map
= map_here
;
8963 goto replay_sequence
;
8965 map_here
= get_local_map (XINT (pos
),
8966 current_buffer
, Qkeymap
);
8967 if (!EQ (map_here
, orig_keymap
))
8969 orig_keymap
= map_here
;
8973 goto replay_sequence
;
8979 /* Expand mode-line and scroll-bar events into two events:
8980 use posn as a fake prefix key. */
8982 && (NILP (fake_prefixed_keys
)
8983 || NILP (Fmemq (key
, fake_prefixed_keys
))))
8985 if (t
+ 1 >= bufsize
)
8986 error ("Key sequence too long");
8989 keybuf
[t
+ 1] = key
;
8992 /* Record that a fake prefix key has been generated
8993 for KEY. Don't modify the event; this would
8994 prevent proper action when the event is pushed
8995 back into unread-command-events. */
8996 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
8998 /* If on a mode line string with a local keymap,
8999 reconsider the key sequence with that keymap. */
9000 if (string
= POSN_STRING (EVENT_START (key
)),
9001 (CONSP (string
) && STRINGP (XCAR (string
))))
9003 Lisp_Object pos
, map
, map2
;
9005 pos
= XCDR (string
);
9006 string
= XCAR (string
);
9008 && XINT (pos
) < SCHARS (string
))
9010 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9012 orig_local_map
= map
;
9013 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9016 if (!NILP (map
) || !NILP (map2
))
9017 goto replay_sequence
;
9023 else if (NILP (from_string
)
9024 && (string
= POSN_STRING (EVENT_START (key
)),
9025 (CONSP (string
) && STRINGP (XCAR (string
)))))
9027 /* For a click on a string, i.e. overlay string or a
9028 string displayed via the `display' property,
9029 consider `local-map' and `keymap' properties of
9031 Lisp_Object pos
, map
, map2
;
9033 pos
= XCDR (string
);
9034 string
= XCAR (string
);
9036 && XINT (pos
) < SCHARS (string
))
9038 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9040 orig_local_map
= map
;
9041 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9045 if (!NILP (map
) || !NILP (map2
))
9047 from_string
= string
;
9048 goto replay_sequence
;
9053 else if (CONSP (XCDR (key
))
9054 && CONSP (EVENT_START (key
))
9055 && CONSP (XCDR (EVENT_START (key
))))
9059 posn
= POSN_POSN (EVENT_START (key
));
9060 /* Handle menu-bar events:
9061 insert the dummy prefix event `menu-bar'. */
9062 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9064 if (t
+ 1 >= bufsize
)
9065 error ("Key sequence too long");
9069 /* Zap the position in key, so we know that we've
9070 expanded it, and don't try to do so again. */
9071 POSN_SET_POSN (EVENT_START (key
),
9072 Fcons (posn
, Qnil
));
9075 goto replay_sequence
;
9077 else if (CONSP (posn
))
9079 /* We're looking at the second event of a
9080 sequence which we expanded before. Set
9081 last_real_key_start appropriately. */
9082 if (last_real_key_start
== t
&& t
> 0)
9083 last_real_key_start
= t
- 1;
9088 /* We have finally decided that KEY is something we might want
9090 first_binding
= (follow_key (key
,
9091 nmaps
- first_binding
,
9092 submaps
+ first_binding
,
9093 defs
+ first_binding
,
9094 submaps
+ first_binding
)
9097 /* If KEY wasn't bound, we'll try some fallbacks. */
9098 if (first_binding
< nmaps
)
9099 /* This is needed for the following scenario:
9100 event 0: a down-event that gets dropped by calling replay_key.
9101 event 1: some normal prefix like C-h.
9102 After event 0, first_unbound is 0, after event 1 fkey.start
9103 and keytran.start are both 1, so when we see that C-h is bound,
9104 we need to update first_unbound. */
9105 first_unbound
= max (t
+ 1, first_unbound
);
9110 /* Remember the position to put an upper bound on fkey.start. */
9111 first_unbound
= min (t
, first_unbound
);
9113 head
= EVENT_HEAD (key
);
9114 if (help_char_p (head
) && t
> 0)
9116 read_key_sequence_cmd
= Vprefix_help_command
;
9118 last_nonmenu_event
= key
;
9119 /* The Microsoft C compiler can't handle the goto that
9127 Lisp_Object breakdown
;
9130 breakdown
= parse_modifiers (head
);
9131 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9132 /* Attempt to reduce an unbound mouse event to a simpler
9133 event that is bound:
9134 Drags reduce to clicks.
9135 Double-clicks reduce to clicks.
9136 Triple-clicks reduce to double-clicks, then to clicks.
9137 Down-clicks are eliminated.
9138 Double-downs reduce to downs, then are eliminated.
9139 Triple-downs reduce to double-downs, then to downs,
9140 then are eliminated. */
9141 if (modifiers
& (down_modifier
| drag_modifier
9142 | double_modifier
| triple_modifier
))
9144 while (modifiers
& (down_modifier
| drag_modifier
9145 | double_modifier
| triple_modifier
))
9147 Lisp_Object new_head
, new_click
;
9148 if (modifiers
& triple_modifier
)
9149 modifiers
^= (double_modifier
| triple_modifier
);
9150 else if (modifiers
& double_modifier
)
9151 modifiers
&= ~double_modifier
;
9152 else if (modifiers
& drag_modifier
)
9153 modifiers
&= ~drag_modifier
;
9156 /* Dispose of this `down' event by simply jumping
9157 back to replay_key, to get another event.
9159 Note that if this event came from mock input,
9160 then just jumping back to replay_key will just
9161 hand it to us again. So we have to wipe out any
9164 We could delete keybuf[t] and shift everything
9165 after that to the left by one spot, but we'd also
9166 have to fix up any variable that points into
9167 keybuf, and shifting isn't really necessary
9170 Adding prefixes for non-textual mouse clicks
9171 creates two characters of mock input, and both
9172 must be thrown away. If we're only looking at
9173 the prefix now, we can just jump back to
9174 replay_key. On the other hand, if we've already
9175 processed the prefix, and now the actual click
9176 itself is giving us trouble, then we've lost the
9177 state of the keymaps we want to backtrack to, and
9178 we need to replay the whole sequence to rebuild
9181 Beyond that, only function key expansion could
9182 create more than two keys, but that should never
9183 generate mouse events, so it's okay to zero
9184 mock_input in that case too.
9186 FIXME: The above paragraph seems just plain
9187 wrong, if you consider things like
9188 xterm-mouse-mode. -stef
9190 Isn't this just the most wonderful code ever? */
9192 /* If mock_input > t + 1, the above simplification
9193 will actually end up dropping keys on the floor.
9194 This is probably OK for now, but even
9195 if mock_input <= t + 1, we need to adjust fkey
9197 Typical case [header-line down-mouse-N]:
9198 mock_input = 2, t = 1, fkey.end = 1,
9199 last_real_key_start = 0. */
9200 if (fkey
.end
> last_real_key_start
)
9202 fkey
.end
= fkey
.start
9203 = min (last_real_key_start
, fkey
.start
);
9204 fkey
.map
= fkey
.parent
;
9205 if (keytran
.end
> last_real_key_start
)
9207 keytran
.end
= keytran
.start
9208 = min (last_real_key_start
, keytran
.start
);
9209 keytran
.map
= keytran
.parent
;
9212 if (t
== last_real_key_start
)
9219 mock_input
= last_real_key_start
;
9220 goto replay_sequence
;
9225 = apply_modifiers (modifiers
, XCAR (breakdown
));
9227 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9229 /* Look for a binding for this new key. follow_key
9230 promises that it didn't munge submaps the
9231 last time we called it, since key was unbound. */
9233 = (follow_key (new_click
,
9234 nmaps
- local_first_binding
,
9235 submaps
+ local_first_binding
,
9236 defs
+ local_first_binding
,
9237 submaps
+ local_first_binding
)
9238 + local_first_binding
);
9240 /* If that click is bound, go for it. */
9241 if (first_binding
< nmaps
)
9246 /* Otherwise, we'll leave key set to the drag event. */
9253 /* Normally, last_nonmenu_event gets the previous key we read.
9254 But when a mouse popup menu is being used,
9255 we don't update last_nonmenu_event; it continues to hold the mouse
9256 event that preceded the first level of menu. */
9257 if (!used_mouse_menu
)
9258 last_nonmenu_event
= key
;
9260 /* Record what part of this_command_keys is the current key sequence. */
9261 this_single_command_key_start
= this_command_key_count
- t
;
9263 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9264 /* There is a binding and it's not a prefix.
9265 There is thus no function-key in this sequence.
9266 Moving fkey.start is important in this case to allow keytran.start
9267 to go over the sequence before we return (since we keep the
9268 invariant that keytran.end <= fkey.start). */
9271 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9274 /* If the sequence is unbound, see if we can hang a function key
9275 off the end of it. */
9276 /* Continue scan from fkey.end until we find a bound suffix. */
9277 while (fkey
.end
< t
)
9279 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9282 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9283 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9284 max (t
, mock_input
),
9285 /* If there's a binding (i.e.
9286 first_binding >= nmaps) we don't want
9287 to apply this function-key-mapping. */
9288 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9293 mock_input
= diff
+ max (t
, mock_input
);
9294 goto replay_sequence
;
9298 /* Look for this sequence in key-translation-map.
9299 Scan from keytran.end until we find a bound suffix. */
9300 while (keytran
.end
< fkey
.start
)
9302 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9305 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9306 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9311 mock_input
= diff
+ max (t
, mock_input
);
9312 /* Adjust the function-key-map counters. */
9316 goto replay_sequence
;
9320 /* If KEY is not defined in any of the keymaps,
9321 and cannot be part of a function key or translation,
9322 and is an upper case letter
9323 use the corresponding lower-case letter instead. */
9324 if (first_binding
>= nmaps
9325 && fkey
.start
>= t
&& keytran
.start
>= t
9327 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9328 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9329 || (XINT (key
) & shift_modifier
)))
9331 Lisp_Object new_key
;
9333 original_uppercase
= key
;
9334 original_uppercase_position
= t
- 1;
9336 if (XINT (key
) & shift_modifier
)
9337 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9339 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9340 | (XINT (key
) & ~CHAR_MODIFIER_MASK
)));
9342 /* We have to do this unconditionally, regardless of whether
9343 the lower-case char is defined in the keymaps, because they
9344 might get translated through function-key-map. */
9345 keybuf
[t
- 1] = new_key
;
9346 mock_input
= max (t
, mock_input
);
9348 goto replay_sequence
;
9350 /* If KEY is not defined in any of the keymaps,
9351 and cannot be part of a function key or translation,
9352 and is a shifted function key,
9353 use the corresponding unshifted function key instead. */
9354 if (first_binding
>= nmaps
9355 && fkey
.start
>= t
&& keytran
.start
>= t
9358 Lisp_Object breakdown
;
9361 breakdown
= parse_modifiers (key
);
9362 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9363 if (modifiers
& shift_modifier
)
9365 Lisp_Object new_key
;
9367 original_uppercase
= key
;
9368 original_uppercase_position
= t
- 1;
9370 modifiers
&= ~shift_modifier
;
9371 new_key
= apply_modifiers (modifiers
,
9374 keybuf
[t
- 1] = new_key
;
9375 mock_input
= max (t
, mock_input
);
9376 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9377 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9379 goto replay_sequence
;
9385 read_key_sequence_cmd
= (first_binding
< nmaps
9386 ? defs
[first_binding
]
9389 unread_switch_frame
= delayed_switch_frame
;
9390 unbind_to (count
, Qnil
);
9392 /* Don't downcase the last character if the caller says don't.
9393 Don't downcase it if the result is undefined, either. */
9394 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9395 && t
- 1 == original_uppercase_position
)
9396 keybuf
[t
- 1] = original_uppercase
;
9398 /* Occasionally we fabricate events, perhaps by expanding something
9399 according to function-key-map, or by adding a prefix symbol to a
9400 mouse click in the scroll bar or modeline. In this cases, return
9401 the entire generated key sequence, even if we hit an unbound
9402 prefix or a definition before the end. This means that you will
9403 be able to push back the event properly, and also means that
9404 read-key-sequence will always return a logical unit.
9407 for (; t
< mock_input
; t
++)
9409 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9410 && NILP (Fzerop (Vecho_keystrokes
)))
9411 echo_char (keybuf
[t
]);
9412 add_command_key (keybuf
[t
]);
9421 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9422 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9423 The sequence is sufficient to specify a non-prefix command in the
9424 current local and global maps.
9426 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9427 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9428 as a continuation of the previous key.
9430 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9431 convert the last event to lower case. (Normally any upper case event
9432 is converted to lower case if the original event is undefined and the lower
9433 case equivalent is defined.) A non-nil value is appropriate for reading
9434 a key sequence to be defined.
9436 A C-g typed while in this function is treated like any other character,
9437 and `quit-flag' is not set.
9439 If the key sequence starts with a mouse click, then the sequence is read
9440 using the keymaps of the buffer of the window clicked in, not the buffer
9441 of the selected window as normal.
9443 `read-key-sequence' drops unbound button-down events, since you normally
9444 only care about the click or drag events which follow them. If a drag
9445 or multi-click event is unbound, but the corresponding click event would
9446 be bound, `read-key-sequence' turns the event into a click event at the
9447 drag's starting position. This means that you don't have to distinguish
9448 between click and drag, double, or triple events unless you want to.
9450 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9451 lines separating windows, and scroll bars with imaginary keys
9452 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9454 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9455 function will process a switch-frame event if the user switches frames
9456 before typing anything. If the user switches frames in the middle of a
9457 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9458 is nil, then the event will be put off until after the current key sequence.
9460 `read-key-sequence' checks `function-key-map' for function key
9461 sequences, where they wouldn't conflict with ordinary bindings. See
9462 `function-key-map' for more details.
9464 The optional fifth argument COMMAND-LOOP, if non-nil, means
9465 that this key sequence is being read by something that will
9466 read commands one after another. It should be nil if the caller
9467 will read just one key sequence. */)
9468 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9470 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9471 Lisp_Object can_return_switch_frame
, command_loop
;
9473 Lisp_Object keybuf
[30];
9475 struct gcpro gcpro1
;
9476 int count
= SPECPDL_INDEX ();
9479 CHECK_STRING (prompt
);
9482 specbind (Qinput_method_exit_on_first_char
,
9483 (NILP (command_loop
) ? Qt
: Qnil
));
9484 specbind (Qinput_method_use_echo_area
,
9485 (NILP (command_loop
) ? Qt
: Qnil
));
9487 bzero (keybuf
, sizeof keybuf
);
9489 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9491 if (NILP (continue_echo
))
9493 this_command_key_count
= 0;
9494 this_command_key_count_reset
= 0;
9495 this_single_command_key_start
= 0;
9498 #ifdef HAVE_X_WINDOWS
9499 if (display_hourglass_p
)
9500 cancel_hourglass ();
9503 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9504 prompt
, ! NILP (dont_downcase_last
),
9505 ! NILP (can_return_switch_frame
), 0);
9507 #if 0 /* The following is fine for code reading a key sequence and
9508 then proceeding with a lenghty computation, but it's not good
9509 for code reading keys in a loop, like an input method. */
9510 #ifdef HAVE_X_WINDOWS
9511 if (display_hourglass_p
)
9522 return unbind_to (count
, make_event_array (i
, keybuf
));
9525 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9526 Sread_key_sequence_vector
, 1, 5, 0,
9527 doc
: /* Like `read-key-sequence' but always return a vector. */)
9528 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9530 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9531 Lisp_Object can_return_switch_frame
, command_loop
;
9533 Lisp_Object keybuf
[30];
9535 struct gcpro gcpro1
;
9536 int count
= SPECPDL_INDEX ();
9539 CHECK_STRING (prompt
);
9542 specbind (Qinput_method_exit_on_first_char
,
9543 (NILP (command_loop
) ? Qt
: Qnil
));
9544 specbind (Qinput_method_use_echo_area
,
9545 (NILP (command_loop
) ? Qt
: Qnil
));
9547 bzero (keybuf
, sizeof keybuf
);
9549 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9551 if (NILP (continue_echo
))
9553 this_command_key_count
= 0;
9554 this_command_key_count_reset
= 0;
9555 this_single_command_key_start
= 0;
9558 #ifdef HAVE_X_WINDOWS
9559 if (display_hourglass_p
)
9560 cancel_hourglass ();
9563 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9564 prompt
, ! NILP (dont_downcase_last
),
9565 ! NILP (can_return_switch_frame
), 0);
9567 #ifdef HAVE_X_WINDOWS
9568 if (display_hourglass_p
)
9578 return unbind_to (count
, Fvector (i
, keybuf
));
9581 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9582 doc
: /* Execute CMD as an editor command.
9583 CMD must be a symbol that satisfies the `commandp' predicate.
9584 Optional second arg RECORD-FLAG non-nil
9585 means unconditionally put this command in `command-history'.
9586 Otherwise, that is done only if an arg is read using the minibuffer.
9587 The argument KEYS specifies the value to use instead of (this-command-keys)
9588 when reading the arguments; if it is nil, (this-command-keys) is used.
9589 The argument SPECIAL, if non-nil, means that this command is executing
9590 a special event, so ignore the prefix argument and don't clear it. */)
9591 (cmd
, record_flag
, keys
, special
)
9592 Lisp_Object cmd
, record_flag
, keys
, special
;
9594 register Lisp_Object final
;
9595 register Lisp_Object tem
;
9596 Lisp_Object prefixarg
;
9597 struct backtrace backtrace
;
9598 extern int debug_on_next_call
;
9600 debug_on_next_call
= 0;
9604 prefixarg
= current_kboard
->Vprefix_arg
;
9605 Vcurrent_prefix_arg
= prefixarg
;
9606 current_kboard
->Vprefix_arg
= Qnil
;
9613 tem
= Fget (cmd
, Qdisabled
);
9614 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9616 tem
= Fsymbol_value (Qdisabled_command_hook
);
9618 return call1 (Vrun_hooks
, Qdisabled_command_hook
);
9624 final
= Findirect_function (cmd
);
9626 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9628 struct gcpro gcpro1
, gcpro2
;
9630 GCPRO2 (cmd
, prefixarg
);
9631 do_autoload (final
, cmd
);
9638 if (STRINGP (final
) || VECTORP (final
))
9640 /* If requested, place the macro in the command history. For
9641 other sorts of commands, call-interactively takes care of
9643 if (!NILP (record_flag
))
9646 = Fcons (Fcons (Qexecute_kbd_macro
,
9647 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9650 /* Don't keep command history around forever. */
9651 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9653 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9655 XSETCDR (tem
, Qnil
);
9659 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9662 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9664 backtrace
.next
= backtrace_list
;
9665 backtrace_list
= &backtrace
;
9666 backtrace
.function
= &Qcall_interactively
;
9667 backtrace
.args
= &cmd
;
9668 backtrace
.nargs
= 1;
9669 backtrace
.evalargs
= 0;
9671 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9673 backtrace_list
= backtrace
.next
;
9681 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9683 doc
: /* Read function name, then read its arguments and call it. */)
9685 Lisp_Object prefixarg
;
9687 Lisp_Object function
;
9689 int saved_last_point_position
;
9690 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9691 Lisp_Object bindings
, value
;
9692 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9694 saved_keys
= Fvector (this_command_key_count
,
9695 XVECTOR (this_command_keys
)->contents
);
9696 saved_last_point_position_buffer
= last_point_position_buffer
;
9697 saved_last_point_position
= last_point_position
;
9699 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9701 if (EQ (prefixarg
, Qminus
))
9703 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9704 strcpy (buf
, "C-u ");
9705 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9707 if (sizeof (int) == sizeof (EMACS_INT
))
9708 sprintf (buf
, "%d ", XINT (XCAR (prefixarg
)));
9709 else if (sizeof (long) == sizeof (EMACS_INT
))
9710 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9714 else if (INTEGERP (prefixarg
))
9716 if (sizeof (int) == sizeof (EMACS_INT
))
9717 sprintf (buf
, "%d ", XINT (prefixarg
));
9718 else if (sizeof (long) == sizeof (EMACS_INT
))
9719 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9724 /* This isn't strictly correct if execute-extended-command
9725 is bound to anything else. Perhaps it should use
9726 this_command_keys? */
9727 strcat (buf
, "M-x ");
9729 /* Prompt with buf, and then read a string, completing from and
9730 restricting to the set of all defined commands. Don't provide
9731 any initial input. Save the command read on the extended-command
9733 function
= Fcompleting_read (build_string (buf
),
9734 Vobarray
, Qcommandp
,
9735 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9738 if (STRINGP (function
) && SCHARS (function
) == 0)
9739 error ("No command name given");
9741 /* Set this_command_keys to the concatenation of saved_keys and
9742 function, followed by a RET. */
9747 this_command_key_count
= 0;
9748 this_command_key_count_reset
= 0;
9749 this_single_command_key_start
= 0;
9751 keys
= XVECTOR (saved_keys
)->contents
;
9752 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9753 add_command_key (keys
[i
]);
9755 for (i
= 0; i
< SCHARS (function
); i
++)
9756 add_command_key (Faref (function
, make_number (i
)));
9758 add_command_key (make_number ('\015'));
9761 last_point_position
= saved_last_point_position
;
9762 last_point_position_buffer
= saved_last_point_position_buffer
;
9766 function
= Fintern (function
, Qnil
);
9767 current_kboard
->Vprefix_arg
= prefixarg
;
9768 Vthis_command
= function
;
9769 real_this_command
= function
;
9771 /* If enabled, show which key runs this command. */
9772 if (!NILP (Vsuggest_key_bindings
)
9773 && NILP (Vexecuting_macro
)
9774 && SYMBOLP (function
))
9775 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9781 GCPRO2 (bindings
, value
);
9782 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9784 /* If the command has a key binding, print it now. */
9785 if (!NILP (bindings
)
9786 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9789 /* But first wait, and skip the message if there is input. */
9791 if (!NILP (echo_area_buffer
[0]))
9792 /* This command displayed something in the echo area;
9793 so wait a few seconds, then display our suggestion message. */
9794 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9795 ? XINT (Vsuggest_key_bindings
) : 2);
9797 /* This command left the echo area empty,
9798 so display our message immediately. */
9801 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9802 && ! CONSP (Vunread_command_events
))
9804 Lisp_Object binding
;
9806 int message_p
= push_message ();
9807 int count
= SPECPDL_INDEX ();
9809 record_unwind_protect (pop_message_unwind
, Qnil
);
9810 binding
= Fkey_description (bindings
);
9813 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9816 sprintf (newmessage
, "You can run the command `%s' with %s",
9817 SDATA (SYMBOL_NAME (function
)),
9819 message2_nolog (newmessage
,
9820 strlen (newmessage
),
9821 STRING_MULTIBYTE (binding
));
9822 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9823 ? Vsuggest_key_bindings
: make_number (2)),
9828 unbind_to (count
, Qnil
);
9832 RETURN_UNGCPRO (value
);
9836 /* Return nonzero if input events are pending. */
9839 detect_input_pending ()
9842 get_input_pending (&input_pending
, 0);
9844 return input_pending
;
9847 /* Return nonzero if input events are pending, and run any pending timers. */
9850 detect_input_pending_run_timers (do_display
)
9853 int old_timers_run
= timers_run
;
9856 get_input_pending (&input_pending
, 1);
9858 if (old_timers_run
!= timers_run
&& do_display
)
9860 redisplay_preserve_echo_area (8);
9861 /* The following fixes a bug when using lazy-lock with
9862 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9863 from an idle timer function. The symptom of the bug is that
9864 the cursor sometimes doesn't become visible until the next X
9865 event is processed. --gerd. */
9867 rif
->flush_display (NULL
);
9870 return input_pending
;
9873 /* This is called in some cases before a possible quit.
9874 It cases the next call to detect_input_pending to recompute input_pending.
9875 So calling this function unnecessarily can't do any harm. */
9878 clear_input_pending ()
9883 /* Return nonzero if there are pending requeued events.
9884 This isn't used yet. The hope is to make wait_reading_process_input
9885 call it, and return if it runs Lisp code that unreads something.
9886 The problem is, kbd_buffer_get_event needs to be fixed to know what
9887 to do in that case. It isn't trivial. */
9890 requeued_events_pending_p ()
9892 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
9896 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9897 doc
: /* Return t if command input is currently available with no wait.
9898 Actually, the value is nil only if we can be sure that no input is available;
9899 if there is a doubt, the value is t. */)
9902 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
9905 get_filtered_input_pending (&input_pending
, 1, 1);
9906 return input_pending
> 0 ? Qt
: Qnil
;
9909 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9910 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9913 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9916 if (total_keys
< NUM_RECENT_KEYS
)
9917 return Fvector (total_keys
, keys
);
9920 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9921 bcopy (keys
+ recent_keys_index
,
9922 XVECTOR (val
)->contents
,
9923 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
9925 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
9926 recent_keys_index
* sizeof (Lisp_Object
));
9931 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9932 doc
: /* Return the key sequence that invoked this command.
9933 However, if the command has called `read-key-sequence', it returns
9934 the last key sequence that has been read.
9935 The value is a string or a vector. */)
9938 return make_event_array (this_command_key_count
,
9939 XVECTOR (this_command_keys
)->contents
);
9942 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9943 doc
: /* Return the key sequence that invoked this command, as a vector.
9944 However, if the command has called `read-key-sequence', it returns
9945 the last key sequence that has been read. */)
9948 return Fvector (this_command_key_count
,
9949 XVECTOR (this_command_keys
)->contents
);
9952 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9953 Sthis_single_command_keys
, 0, 0, 0,
9954 doc
: /* Return the key sequence that invoked this command.
9955 More generally, it returns the last key sequence read, either by
9956 the command loop or by `read-key-sequence'.
9957 Unlike `this-command-keys', this function's value
9958 does not include prefix arguments.
9959 The value is always a vector. */)
9962 return Fvector (this_command_key_count
9963 - this_single_command_key_start
,
9964 (XVECTOR (this_command_keys
)->contents
9965 + this_single_command_key_start
));
9968 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9969 Sthis_single_command_raw_keys
, 0, 0, 0,
9970 doc
: /* Return the raw events that were read for this command.
9971 More generally, it returns the last key sequence read, either by
9972 the command loop or by `read-key-sequence'.
9973 Unlike `this-single-command-keys', this function's value
9974 shows the events before all translations (except for input methods).
9975 The value is always a vector. */)
9978 return Fvector (raw_keybuf_count
,
9979 (XVECTOR (raw_keybuf
)->contents
));
9982 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9983 Sreset_this_command_lengths
, 0, 0, 0,
9984 doc
: /* Make the unread events replace the last command and echo.
9985 Used in `universal-argument-other-key'.
9987 `universal-argument-other-key' rereads the event just typed.
9988 It then gets translated through `function-key-map'.
9989 The translated event has to replace the real events,
9990 both in the value of (this-command-keys) and in echoing.
9991 To achieve this, `universal-argument-other-key' calls
9992 `reset-this-command-lengths', which discards the record of reading
9993 these events the first time. */)
9996 this_command_key_count
= before_command_key_count
;
9997 if (this_command_key_count
< this_single_command_key_start
)
9998 this_single_command_key_start
= this_command_key_count
;
10000 echo_truncate (before_command_echo_length
);
10002 /* Cause whatever we put into unread-command-events
10003 to echo as if it were being freshly read from the keyboard. */
10004 this_command_key_count_reset
= 1;
10009 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10010 Sclear_this_command_keys
, 0, 1, 0,
10011 doc
: /* Clear out the vector that `this-command-keys' returns.
10012 Also clear the record of the last 100 events, unless optional arg
10013 KEEP-RECORD is non-nil. */)
10015 Lisp_Object keep_record
;
10019 this_command_key_count
= 0;
10020 this_command_key_count_reset
= 0;
10022 if (NILP (keep_record
))
10024 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10025 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10027 recent_keys_index
= 0;
10032 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10033 doc
: /* Return the current depth in recursive edits. */)
10037 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10041 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10042 "FOpen dribble file: ",
10043 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10044 If FILE is nil, close any open dribble file. */)
10055 file
= Fexpand_file_name (file
, Qnil
);
10056 dribble
= fopen (SDATA (file
), "w");
10058 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10063 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10064 doc
: /* Discard the contents of the terminal input buffer.
10065 Also end any kbd macro being defined. */)
10068 if (!NILP (current_kboard
->defining_kbd_macro
))
10070 /* Discard the last command from the macro. */
10071 Fcancel_kbd_macro_events ();
10075 update_mode_lines
++;
10077 Vunread_command_events
= Qnil
;
10078 unread_command_char
= -1;
10080 discard_tty_input ();
10082 kbd_fetch_ptr
= kbd_store_ptr
;
10088 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10089 doc
: /* Stop Emacs and return to superior process. You can resume later.
10090 If `cannot-suspend' is non-nil, or if the system doesn't support job
10091 control, run a subshell instead.
10093 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10094 to be read as terminal input by Emacs's parent, after suspension.
10096 Before suspending, run the normal hook `suspend-hook'.
10097 After resumption run the normal hook `suspend-resume-hook'.
10099 Some operating systems cannot stop the Emacs process and resume it later.
10100 On such systems, Emacs starts a subshell instead of suspending. */)
10102 Lisp_Object stuffstring
;
10104 int count
= SPECPDL_INDEX ();
10105 int old_height
, old_width
;
10107 struct gcpro gcpro1
;
10109 if (!NILP (stuffstring
))
10110 CHECK_STRING (stuffstring
);
10112 /* Run the functions in suspend-hook. */
10113 if (!NILP (Vrun_hooks
))
10114 call1 (Vrun_hooks
, intern ("suspend-hook"));
10116 GCPRO1 (stuffstring
);
10117 get_frame_size (&old_width
, &old_height
);
10118 reset_sys_modes ();
10119 /* sys_suspend can get an error if it tries to fork a subshell
10120 and the system resources aren't available for that. */
10121 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_sys_modes
,
10123 stuff_buffered_input (stuffstring
);
10124 if (cannot_suspend
)
10128 unbind_to (count
, Qnil
);
10130 /* Check if terminal/window size has changed.
10131 Note that this is not useful when we are running directly
10132 with a window system; but suspend should be disabled in that case. */
10133 get_frame_size (&width
, &height
);
10134 if (width
!= old_width
|| height
!= old_height
)
10135 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10137 /* Run suspend-resume-hook. */
10138 if (!NILP (Vrun_hooks
))
10139 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10145 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10146 Then in any case stuff anything Emacs has read ahead and not used. */
10149 stuff_buffered_input (stuffstring
)
10150 Lisp_Object stuffstring
;
10152 /* stuff_char works only in BSD, versions 4.2 and up. */
10155 register unsigned char *p
;
10157 if (STRINGP (stuffstring
))
10159 register int count
;
10161 p
= SDATA (stuffstring
);
10162 count
= SBYTES (stuffstring
);
10163 while (count
-- > 0)
10168 /* Anything we have read ahead, put back for the shell to read. */
10169 /* ?? What should this do when we have multiple keyboards??
10170 Should we ignore anything that was typed in at the "wrong" kboard? */
10171 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10174 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10175 kbd_fetch_ptr
= kbd_buffer
;
10176 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10177 stuff_char (kbd_fetch_ptr
->code
);
10179 clear_event (kbd_fetch_ptr
);
10184 #endif /* BSD_SYSTEM and not BSD4_1 */
10188 set_waiting_for_input (time_to_clear
)
10189 EMACS_TIME
*time_to_clear
;
10191 input_available_clear_time
= time_to_clear
;
10193 /* Tell interrupt_signal to throw back to read_char, */
10194 waiting_for_input
= 1;
10196 /* If interrupt_signal was called before and buffered a C-g,
10197 make it run again now, to avoid timing error. */
10198 if (!NILP (Vquit_flag
))
10199 quit_throw_to_read_char ();
10203 clear_waiting_for_input ()
10205 /* Tell interrupt_signal not to throw back to read_char, */
10206 waiting_for_input
= 0;
10207 input_available_clear_time
= 0;
10210 /* This routine is called at interrupt level in response to C-g.
10212 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10213 is called from kbd_buffer_store_event, in handling SIGIO or
10216 If `waiting_for_input' is non zero, then unless `echoing' is
10217 nonzero, immediately throw back to read_char.
10219 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10220 eval to throw, when it gets a chance. If quit-flag is already
10221 non-nil, it stops the job right away. */
10224 interrupt_signal (signalnum
) /* If we don't have an argument, */
10225 int signalnum
; /* some compilers complain in signal calls. */
10228 /* Must preserve main program's value of errno. */
10229 int old_errno
= errno
;
10230 struct frame
*sf
= SELECTED_FRAME ();
10232 #if defined (USG) && !defined (POSIX_SIGNALS)
10233 if (!read_socket_hook
&& NILP (Vwindow_system
))
10235 /* USG systems forget handlers when they are used;
10236 must reestablish each time */
10237 signal (SIGINT
, interrupt_signal
);
10238 signal (SIGQUIT
, interrupt_signal
);
10244 if (!NILP (Vquit_flag
)
10245 && (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
)))
10247 /* If SIGINT isn't blocked, don't let us be interrupted by
10248 another SIGINT, it might be harmful due to non-reentrancy
10249 in I/O functions. */
10250 sigblock (sigmask (SIGINT
));
10253 reset_sys_modes ();
10255 #ifdef SIGTSTP /* Support possible in later USG versions */
10257 * On systems which can suspend the current process and return to the original
10258 * shell, this command causes the user to end up back at the shell.
10259 * The "Auto-save" and "Abort" questions are not asked until
10260 * the user elects to return to emacs, at which point he can save the current
10261 * job and either dump core or continue.
10266 if (sys_suspend () == -1)
10268 printf ("Not running as a subprocess;\n");
10269 printf ("you can continue or abort.\n");
10271 #else /* not VMS */
10272 /* Perhaps should really fork an inferior shell?
10273 But that would not provide any way to get back
10274 to the original shell, ever. */
10275 printf ("No support for stopping a process on this operating system;\n");
10276 printf ("you can continue or abort.\n");
10277 #endif /* not VMS */
10278 #endif /* not SIGTSTP */
10280 /* We must remain inside the screen area when the internal terminal
10281 is used. Note that [Enter] is not echoed by dos. */
10284 /* It doesn't work to autosave while GC is in progress;
10285 the code used for auto-saving doesn't cope with the mark bit. */
10286 if (!gc_in_progress
)
10288 printf ("Auto-save? (y or n) ");
10290 if (((c
= getchar ()) & ~040) == 'Y')
10292 Fdo_auto_save (Qt
, Qnil
);
10294 printf ("\r\nAuto-save done");
10295 #else /* not MSDOS */
10296 printf ("Auto-save done\n");
10297 #endif /* not MSDOS */
10299 while (c
!= '\n') c
= getchar ();
10303 /* During GC, it must be safe to reenable quitting again. */
10304 Vinhibit_quit
= Qnil
;
10307 #endif /* not MSDOS */
10308 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10309 printf ("but will instead do a real quit after garbage collection ends\r\n");
10314 printf ("\r\nAbort? (y or n) ");
10315 #else /* not MSDOS */
10317 printf ("Abort (and enter debugger)? (y or n) ");
10318 #else /* not VMS */
10319 printf ("Abort (and dump core)? (y or n) ");
10320 #endif /* not VMS */
10321 #endif /* not MSDOS */
10323 if (((c
= getchar ()) & ~040) == 'Y')
10325 while (c
!= '\n') c
= getchar ();
10327 printf ("\r\nContinuing...\r\n");
10328 #else /* not MSDOS */
10329 printf ("Continuing...\n");
10330 #endif /* not MSDOS */
10337 /* If executing a function that wants to be interrupted out of
10338 and the user has not deferred quitting by binding `inhibit-quit'
10339 then quit right away. */
10340 if (immediate_quit
&& NILP (Vinhibit_quit
))
10342 struct gl_state_s saved
;
10343 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10345 immediate_quit
= 0;
10348 GCPRO4 (saved
.object
, saved
.global_code
,
10349 saved
.current_syntax_table
, saved
.old_prop
);
10350 Fsignal (Qquit
, Qnil
);
10355 /* Else request quit when it's safe */
10359 if (waiting_for_input
&& !echoing
)
10360 quit_throw_to_read_char ();
10365 /* Handle a C-g by making read_char return C-g. */
10368 quit_throw_to_read_char ()
10371 /* Prevent another signal from doing this before we finish. */
10372 clear_waiting_for_input ();
10375 Vunread_command_events
= Qnil
;
10376 unread_command_char
= -1;
10378 #if 0 /* Currently, sit_for is called from read_char without turning
10379 off polling. And that can call set_waiting_for_input.
10380 It seems to be harmless. */
10381 #ifdef POLL_FOR_INPUT
10382 /* May be > 1 if in recursive minibuffer. */
10383 if (poll_suppress_count
== 0)
10387 if (FRAMEP (internal_last_event_frame
)
10388 && !EQ (internal_last_event_frame
, selected_frame
))
10389 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10392 _longjmp (getcjmp
, 1);
10395 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10396 doc
: /* Set mode of reading keyboard input.
10397 First arg INTERRUPT non-nil means use input interrupts;
10398 nil means use CBREAK mode.
10399 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10400 (no effect except in CBREAK mode).
10401 Third arg META t means accept 8-bit input (for a Meta key).
10402 META nil means ignore the top bit, on the assumption it is parity.
10403 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10404 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10405 See also `current-input-mode'. */)
10406 (interrupt
, flow
, meta
, quit
)
10407 Lisp_Object interrupt
, flow
, meta
, quit
;
10410 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10411 error ("set-input-mode: QUIT must be an ASCII character");
10413 #ifdef POLL_FOR_INPUT
10418 /* this causes startup screen to be restored and messes with the mouse */
10419 reset_sys_modes ();
10423 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10424 if (read_socket_hook
)
10426 /* When using X, don't give the user a real choice,
10427 because we haven't implemented the mechanisms to support it. */
10428 #ifdef NO_SOCK_SIGIO
10429 interrupt_input
= 0;
10430 #else /* not NO_SOCK_SIGIO */
10431 interrupt_input
= 1;
10432 #endif /* NO_SOCK_SIGIO */
10435 interrupt_input
= !NILP (interrupt
);
10436 #else /* not SIGIO */
10437 interrupt_input
= 0;
10438 #endif /* not SIGIO */
10440 /* Our VMS input only works by interrupts, as of now. */
10442 interrupt_input
= 1;
10445 flow_control
= !NILP (flow
);
10448 else if (EQ (meta
, Qt
))
10453 /* Don't let this value be out of range. */
10454 quit_char
= XINT (quit
) & (meta_key
? 0377 : 0177);
10460 #ifdef POLL_FOR_INPUT
10461 poll_suppress_count
= 1;
10467 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10468 doc
: /* Return information about the way Emacs currently reads keyboard input.
10469 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10470 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10471 nil, Emacs is using CBREAK mode.
10472 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10473 terminal; this does not apply if Emacs uses interrupt-driven input.
10474 META is t if accepting 8-bit input with 8th bit as Meta flag.
10475 META nil means ignoring the top bit, on the assumption it is parity.
10476 META is neither t nor nil if accepting 8-bit input and using
10477 all 8 bits as the character code.
10478 QUIT is the character Emacs currently uses to quit.
10479 The elements of this list correspond to the arguments of
10480 `set-input-mode'. */)
10483 Lisp_Object val
[4];
10485 val
[0] = interrupt_input
? Qt
: Qnil
;
10486 val
[1] = flow_control
? Qt
: Qnil
;
10487 val
[2] = meta_key
== 2 ? make_number (0) : meta_key
== 1 ? Qt
: Qnil
;
10488 XSETFASTINT (val
[3], quit_char
);
10490 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10495 * Set up a new kboard object with reasonable initial values.
10501 kb
->Voverriding_terminal_local_map
= Qnil
;
10502 kb
->Vlast_command
= Qnil
;
10503 kb
->Vreal_last_command
= Qnil
;
10504 kb
->Vprefix_arg
= Qnil
;
10505 kb
->Vlast_prefix_arg
= Qnil
;
10506 kb
->kbd_queue
= Qnil
;
10507 kb
->kbd_queue_has_data
= 0;
10508 kb
->immediate_echo
= 0;
10509 kb
->echo_string
= Qnil
;
10510 kb
->echo_after_prompt
= -1;
10511 kb
->kbd_macro_buffer
= 0;
10512 kb
->kbd_macro_bufsize
= 0;
10513 kb
->defining_kbd_macro
= Qnil
;
10514 kb
->Vlast_kbd_macro
= Qnil
;
10515 kb
->reference_count
= 0;
10516 kb
->Vsystem_key_alist
= Qnil
;
10517 kb
->system_key_syms
= Qnil
;
10518 kb
->Vdefault_minibuffer_frame
= Qnil
;
10522 * Destroy the contents of a kboard object, but not the object itself.
10523 * We use this just before deleting it, or if we're going to initialize
10524 * it a second time.
10530 if (kb
->kbd_macro_buffer
)
10531 xfree (kb
->kbd_macro_buffer
);
10534 #ifdef MULTI_KBOARD
10536 /* Free KB and memory referenced from it. */
10544 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10547 *kbp
= kb
->next_kboard
;
10549 /* Prevent a dangling reference to KB. */
10550 if (kb
== current_kboard
10551 && FRAMEP (selected_frame
)
10552 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10554 current_kboard
= XFRAME (selected_frame
)->kboard
;
10555 if (current_kboard
== kb
)
10563 #endif /* MULTI_KBOARD */
10568 /* This is correct before outermost invocation of the editor loop */
10569 command_loop_level
= -1;
10570 immediate_quit
= 0;
10571 quit_char
= Ctl ('g');
10572 Vunread_command_events
= Qnil
;
10573 unread_command_char
= -1;
10574 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10576 recent_keys_index
= 0;
10577 kbd_fetch_ptr
= kbd_buffer
;
10578 kbd_store_ptr
= kbd_buffer
;
10580 do_mouse_tracking
= Qnil
;
10584 /* This means that command_loop_1 won't try to select anything the first
10586 internal_last_event_frame
= Qnil
;
10587 Vlast_event_frame
= internal_last_event_frame
;
10589 #ifdef MULTI_KBOARD
10590 current_kboard
= initial_kboard
;
10592 wipe_kboard (current_kboard
);
10593 init_kboard (current_kboard
);
10595 if (!noninteractive
&& !read_socket_hook
&& NILP (Vwindow_system
))
10597 signal (SIGINT
, interrupt_signal
);
10598 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10599 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10600 SIGQUIT and we can't tell which one it will give us. */
10601 signal (SIGQUIT
, interrupt_signal
);
10602 #endif /* HAVE_TERMIO */
10604 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10606 if (!noninteractive
)
10607 signal (SIGIO
, input_available_signal
);
10610 /* Use interrupt input by default, if it works and noninterrupt input
10611 has deficiencies. */
10613 #ifdef INTERRUPT_INPUT
10614 interrupt_input
= 1;
10616 interrupt_input
= 0;
10619 /* Our VMS input only works by interrupts, as of now. */
10621 interrupt_input
= 1;
10627 if (keyboard_init_hook
)
10628 (*keyboard_init_hook
) ();
10630 #ifdef POLL_FOR_INPUT
10631 poll_suppress_count
= 1;
10636 /* At least provide an escape route since C-g doesn't work. */
10637 signal (SIGINT
, interrupt_signal
);
10641 /* This type's only use is in syms_of_keyboard, to initialize the
10642 event header symbols and put properties on them. */
10643 struct event_head
{
10649 struct event_head head_table
[] = {
10650 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10651 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10652 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10653 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10654 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10655 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10656 /* `select-window' should be handled just like `switch-frame'
10657 in read_key_sequence. */
10658 {&Qselect_window
, "select-window", &Qswitch_frame
}
10662 syms_of_keyboard ()
10664 Vpre_help_message
= Qnil
;
10665 staticpro (&Vpre_help_message
);
10667 Vlispy_mouse_stem
= build_string ("mouse");
10668 staticpro (&Vlispy_mouse_stem
);
10671 QCimage
= intern (":image");
10672 staticpro (&QCimage
);
10674 staticpro (&Qhelp_echo
);
10675 Qhelp_echo
= intern ("help-echo");
10677 staticpro (&item_properties
);
10678 item_properties
= Qnil
;
10680 staticpro (&tool_bar_item_properties
);
10681 tool_bar_item_properties
= Qnil
;
10682 staticpro (&tool_bar_items_vector
);
10683 tool_bar_items_vector
= Qnil
;
10685 staticpro (&real_this_command
);
10686 real_this_command
= Qnil
;
10688 Qtimer_event_handler
= intern ("timer-event-handler");
10689 staticpro (&Qtimer_event_handler
);
10691 Qdisabled_command_hook
= intern ("disabled-command-hook");
10692 staticpro (&Qdisabled_command_hook
);
10694 Qself_insert_command
= intern ("self-insert-command");
10695 staticpro (&Qself_insert_command
);
10697 Qforward_char
= intern ("forward-char");
10698 staticpro (&Qforward_char
);
10700 Qbackward_char
= intern ("backward-char");
10701 staticpro (&Qbackward_char
);
10703 Qdisabled
= intern ("disabled");
10704 staticpro (&Qdisabled
);
10706 Qundefined
= intern ("undefined");
10707 staticpro (&Qundefined
);
10709 Qpre_command_hook
= intern ("pre-command-hook");
10710 staticpro (&Qpre_command_hook
);
10712 Qpost_command_hook
= intern ("post-command-hook");
10713 staticpro (&Qpost_command_hook
);
10715 Qpost_command_idle_hook
= intern ("post-command-idle-hook");
10716 staticpro (&Qpost_command_idle_hook
);
10718 Qdeferred_action_function
= intern ("deferred-action-function");
10719 staticpro (&Qdeferred_action_function
);
10721 Qcommand_hook_internal
= intern ("command-hook-internal");
10722 staticpro (&Qcommand_hook_internal
);
10724 Qfunction_key
= intern ("function-key");
10725 staticpro (&Qfunction_key
);
10726 Qmouse_click
= intern ("mouse-click");
10727 staticpro (&Qmouse_click
);
10729 Qlanguage_change
= intern ("language-change");
10730 staticpro (&Qlanguage_change
);
10732 Qdrag_n_drop
= intern ("drag-n-drop");
10733 staticpro (&Qdrag_n_drop
);
10735 Qsave_session
= intern ("save-session");
10736 staticpro(&Qsave_session
);
10738 Qusr1_signal
= intern ("usr1-signal");
10739 staticpro (&Qusr1_signal
);
10740 Qusr2_signal
= intern ("usr2-signal");
10741 staticpro (&Qusr2_signal
);
10743 Qmenu_enable
= intern ("menu-enable");
10744 staticpro (&Qmenu_enable
);
10745 Qmenu_alias
= intern ("menu-alias");
10746 staticpro (&Qmenu_alias
);
10747 QCenable
= intern (":enable");
10748 staticpro (&QCenable
);
10749 QCvisible
= intern (":visible");
10750 staticpro (&QCvisible
);
10751 QChelp
= intern (":help");
10752 staticpro (&QChelp
);
10753 QCfilter
= intern (":filter");
10754 staticpro (&QCfilter
);
10755 QCbutton
= intern (":button");
10756 staticpro (&QCbutton
);
10757 QCkeys
= intern (":keys");
10758 staticpro (&QCkeys
);
10759 QCkey_sequence
= intern (":key-sequence");
10760 staticpro (&QCkey_sequence
);
10761 QCtoggle
= intern (":toggle");
10762 staticpro (&QCtoggle
);
10763 QCradio
= intern (":radio");
10764 staticpro (&QCradio
);
10766 Qmode_line
= intern ("mode-line");
10767 staticpro (&Qmode_line
);
10768 Qvertical_line
= intern ("vertical-line");
10769 staticpro (&Qvertical_line
);
10770 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
10771 staticpro (&Qvertical_scroll_bar
);
10772 Qmenu_bar
= intern ("menu-bar");
10773 staticpro (&Qmenu_bar
);
10775 Qabove_handle
= intern ("above-handle");
10776 staticpro (&Qabove_handle
);
10777 Qhandle
= intern ("handle");
10778 staticpro (&Qhandle
);
10779 Qbelow_handle
= intern ("below-handle");
10780 staticpro (&Qbelow_handle
);
10781 Qup
= intern ("up");
10783 Qdown
= intern ("down");
10784 staticpro (&Qdown
);
10785 Qtop
= intern ("top");
10787 Qbottom
= intern ("bottom");
10788 staticpro (&Qbottom
);
10789 Qend_scroll
= intern ("end-scroll");
10790 staticpro (&Qend_scroll
);
10791 Qratio
= intern ("ratio");
10792 staticpro (&Qratio
);
10794 Qevent_kind
= intern ("event-kind");
10795 staticpro (&Qevent_kind
);
10796 Qevent_symbol_elements
= intern ("event-symbol-elements");
10797 staticpro (&Qevent_symbol_elements
);
10798 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
10799 staticpro (&Qevent_symbol_element_mask
);
10800 Qmodifier_cache
= intern ("modifier-cache");
10801 staticpro (&Qmodifier_cache
);
10803 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
10804 staticpro (&Qrecompute_lucid_menubar
);
10805 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
10806 staticpro (&Qactivate_menubar_hook
);
10808 Qpolling_period
= intern ("polling-period");
10809 staticpro (&Qpolling_period
);
10811 Qinput_method_function
= intern ("input-method-function");
10812 staticpro (&Qinput_method_function
);
10814 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
10815 staticpro (&Qinput_method_exit_on_first_char
);
10816 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
10817 staticpro (&Qinput_method_use_echo_area
);
10819 Fset (Qinput_method_exit_on_first_char
, Qnil
);
10820 Fset (Qinput_method_use_echo_area
, Qnil
);
10822 last_point_position_buffer
= Qnil
;
10825 struct event_head
*p
;
10827 for (p
= head_table
;
10828 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
10831 *p
->var
= intern (p
->name
);
10832 staticpro (p
->var
);
10833 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
10834 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
10838 button_down_location
= Fmake_vector (make_number (1), Qnil
);
10839 staticpro (&button_down_location
);
10840 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
10841 staticpro (&mouse_syms
);
10842 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
10843 staticpro (&wheel_syms
);
10847 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
10849 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
10850 for (i
= 0; i
< len
; i
++)
10851 if (modifier_names
[i
])
10852 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
10853 staticpro (&modifier_symbols
);
10856 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
10857 staticpro (&recent_keys
);
10859 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
10860 staticpro (&this_command_keys
);
10862 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
10863 staticpro (&raw_keybuf
);
10865 Qextended_command_history
= intern ("extended-command-history");
10866 Fset (Qextended_command_history
, Qnil
);
10867 staticpro (&Qextended_command_history
);
10869 accent_key_syms
= Qnil
;
10870 staticpro (&accent_key_syms
);
10872 func_key_syms
= Qnil
;
10873 staticpro (&func_key_syms
);
10875 drag_n_drop_syms
= Qnil
;
10876 staticpro (&drag_n_drop_syms
);
10878 unread_switch_frame
= Qnil
;
10879 staticpro (&unread_switch_frame
);
10881 internal_last_event_frame
= Qnil
;
10882 staticpro (&internal_last_event_frame
);
10884 read_key_sequence_cmd
= Qnil
;
10885 staticpro (&read_key_sequence_cmd
);
10887 menu_bar_one_keymap_changed_items
= Qnil
;
10888 staticpro (&menu_bar_one_keymap_changed_items
);
10890 defsubr (&Sevent_convert_list
);
10891 defsubr (&Sread_key_sequence
);
10892 defsubr (&Sread_key_sequence_vector
);
10893 defsubr (&Srecursive_edit
);
10895 defsubr (&Strack_mouse
);
10897 defsubr (&Sinput_pending_p
);
10898 defsubr (&Scommand_execute
);
10899 defsubr (&Srecent_keys
);
10900 defsubr (&Sthis_command_keys
);
10901 defsubr (&Sthis_command_keys_vector
);
10902 defsubr (&Sthis_single_command_keys
);
10903 defsubr (&Sthis_single_command_raw_keys
);
10904 defsubr (&Sreset_this_command_lengths
);
10905 defsubr (&Sclear_this_command_keys
);
10906 defsubr (&Ssuspend_emacs
);
10907 defsubr (&Sabort_recursive_edit
);
10908 defsubr (&Sexit_recursive_edit
);
10909 defsubr (&Srecursion_depth
);
10910 defsubr (&Stop_level
);
10911 defsubr (&Sdiscard_input
);
10912 defsubr (&Sopen_dribble_file
);
10913 defsubr (&Sset_input_mode
);
10914 defsubr (&Scurrent_input_mode
);
10915 defsubr (&Sexecute_extended_command
);
10917 DEFVAR_LISP ("last-command-char", &last_command_char
,
10918 doc
: /* Last input event that was part of a command. */);
10920 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
10921 doc
: /* Last input event that was part of a command. */);
10923 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
10924 doc
: /* Last input event in a command, except for mouse menu events.
10925 Mouse menus give back keys that don't look like mouse events;
10926 this variable holds the actual mouse event that led to the menu,
10927 so that you can determine whether the command was run by mouse or not. */);
10929 DEFVAR_LISP ("last-input-char", &last_input_char
,
10930 doc
: /* Last input event. */);
10932 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
10933 doc
: /* Last input event. */);
10935 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
10936 doc
: /* List of events to be read as the command input.
10937 These events are processed first, before actual keyboard input. */);
10938 Vunread_command_events
= Qnil
;
10940 DEFVAR_INT ("unread-command-char", &unread_command_char
,
10941 doc
: /* If not -1, an object to be read as next command input event. */);
10943 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
10944 doc
: /* List of events to be processed as input by input methods.
10945 These events are processed after `unread-command-events', but
10946 before actual keyboard input. */);
10947 Vunread_post_input_method_events
= Qnil
;
10949 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
10950 doc
: /* List of events to be processed as input by input methods.
10951 These events are processed after `unread-command-events', but
10952 before actual keyboard input. */);
10953 Vunread_input_method_events
= Qnil
;
10955 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
10956 doc
: /* Meta-prefix character code.
10957 Meta-foo as command input turns into this character followed by foo. */);
10958 XSETINT (meta_prefix_char
, 033);
10960 DEFVAR_KBOARD ("last-command", Vlast_command
,
10961 doc
: /* The last command executed.
10962 Normally a symbol with a function definition, but can be whatever was found
10963 in the keymap, or whatever the variable `this-command' was set to by that
10966 The value `mode-exit' is special; it means that the previous command
10967 read an event that told it to exit, and it did so and unread that event.
10968 In other words, the present command is the event that made the previous
10971 The value `kill-region' is special; it means that the previous command
10972 was a kill command. */);
10974 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
10975 doc
: /* Same as `last-command', but never altered by Lisp code. */);
10977 DEFVAR_LISP ("this-command", &Vthis_command
,
10978 doc
: /* The command now being executed.
10979 The command can set this variable; whatever is put here
10980 will be in `last-command' during the following command. */);
10981 Vthis_command
= Qnil
;
10983 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
10984 doc
: /* The command bound to the current key sequence before remapping.
10985 It equals `this-command' if the original command was not remapped through
10986 any of the active keymaps. Otherwise, the value of `this-command' is the
10987 result of looking up the original command in the active keymaps. */);
10988 Vthis_original_command
= Qnil
;
10990 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
10991 doc
: /* *Number of input events between auto-saves.
10992 Zero means disable autosaving due to number of characters typed. */);
10993 auto_save_interval
= 300;
10995 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
10996 doc
: /* *Number of seconds idle time before auto-save.
10997 Zero or nil means disable auto-saving due to idleness.
10998 After auto-saving due to this many seconds of idle time,
10999 Emacs also does a garbage collection if that seems to be warranted. */);
11000 XSETFASTINT (Vauto_save_timeout
, 30);
11002 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11003 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11004 The value may be integer or floating point. */);
11005 Vecho_keystrokes
= make_number (1);
11007 DEFVAR_INT ("polling-period", &polling_period
,
11008 doc
: /* *Interval between polling for input during Lisp execution.
11009 The reason for polling is to make C-g work to stop a running program.
11010 Polling is needed only when using X windows and SIGIO does not work.
11011 Polling is automatically disabled in all other cases. */);
11012 polling_period
= 2;
11014 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11015 doc
: /* *Maximum time between mouse clicks to make a double-click.
11016 Measured in milliseconds. nil means disable double-click recognition;
11017 t means double-clicks have no time limit and are detected
11018 by position only. */);
11019 Vdouble_click_time
= make_number (500);
11021 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11022 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11023 On window-system frames, value is the number of pixels the mouse may have
11024 moved horizontally or vertically between two clicks to make a double-click.
11025 On non window-system frames, value is interpreted in units of 1/8 characters
11028 This variable is also the threshold for motion of the mouse
11029 to count as a drag. */);
11030 double_click_fuzz
= 3;
11032 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11033 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11034 inhibit_local_menu_bar_menus
= 0;
11036 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11037 doc
: /* Number of complete key sequences read as input so far.
11038 This includes key sequences read from keyboard macros.
11039 The number is effectively the number of interactive command invocations. */);
11040 num_input_keys
= 0;
11042 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11043 doc
: /* Number of input events read from the keyboard so far.
11044 This does not include events generated by keyboard macros. */);
11045 num_nonmacro_input_events
= 0;
11047 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11048 doc
: /* The frame in which the most recently read event occurred.
11049 If the last event came from a keyboard macro, this is set to `macro'. */);
11050 Vlast_event_frame
= Qnil
;
11052 /* This variable is set up in sysdep.c. */
11053 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11054 doc
: /* The ERASE character as set by the user with stty. */);
11056 DEFVAR_LISP ("help-char", &Vhelp_char
,
11057 doc
: /* Character to recognize as meaning Help.
11058 When it is read, do `(eval help-form)', and display result if it's a string.
11059 If the value of `help-form' is nil, this char can be read normally. */);
11060 XSETINT (Vhelp_char
, Ctl ('H'));
11062 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11063 doc
: /* List of input events to recognize as meaning Help.
11064 These work just like the value of `help-char' (see that). */);
11065 Vhelp_event_list
= Qnil
;
11067 DEFVAR_LISP ("help-form", &Vhelp_form
,
11068 doc
: /* Form to execute when character `help-char' is read.
11069 If the form returns a string, that string is displayed.
11070 If `help-form' is nil, the help char is not recognized. */);
11073 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11074 doc
: /* Command to run when `help-char' character follows a prefix key.
11075 This command is used only when there is no actual binding
11076 for that character after that prefix key. */);
11077 Vprefix_help_command
= Qnil
;
11079 DEFVAR_LISP ("top-level", &Vtop_level
,
11080 doc
: /* Form to evaluate when Emacs starts up.
11081 Useful to set before you dump a modified Emacs. */);
11084 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11085 doc
: /* Translate table for keyboard input, or nil.
11086 Each character is looked up in this string and the contents used instead.
11087 The value may be a string, a vector, or a char-table.
11088 If it is a string or vector of length N,
11089 character codes N and up are untranslated.
11090 In a vector or a char-table, an element which is nil means "no translation".
11092 This is applied to the characters supplied to input methods, not their
11093 output. See also `translation-table-for-input'. */);
11094 Vkeyboard_translate_table
= Qnil
;
11096 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11097 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11098 \(Even if the operating system has support for stopping a process.\) */);
11099 cannot_suspend
= 0;
11101 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11102 doc
: /* Non-nil means prompt with menus when appropriate.
11103 This is done when reading from a keymap that has a prompt string,
11104 for elements that have prompt strings.
11105 The menu is displayed on the screen
11106 if X menus were enabled at configuration
11107 time and the previous event was a mouse click prefix key.
11108 Otherwise, menu prompting uses the echo area. */);
11109 menu_prompting
= 1;
11111 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11112 doc
: /* Character to see next line of menu prompt.
11113 Type this character while in a menu prompt to rotate around the lines of it. */);
11114 XSETINT (menu_prompt_more_char
, ' ');
11116 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11117 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11118 Emacs applies the modifiers of the character stored here to each keyboard
11119 character it reads. For example, after evaluating the expression
11120 (setq extra-keyboard-modifiers ?\\C-x)
11121 all input characters will have the control modifier applied to them.
11123 Note that the character ?\\C-@, equivalent to the integer zero, does
11124 not count as a control character; rather, it counts as a character
11125 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11126 cancels any modification. */);
11127 extra_keyboard_modifiers
= 0;
11129 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11130 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11131 The command loop sets this to nil before each command,
11132 and tests the value when the command returns.
11133 Buffer modification stores t in this variable. */);
11134 Vdeactivate_mark
= Qnil
;
11136 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11137 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11138 Vcommand_hook_internal
= Qnil
;
11140 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11141 doc
: /* Normal hook run before each command is executed.
11142 If an unhandled error happens in running this hook,
11143 the hook value is set to nil, since otherwise the error
11144 might happen repeatedly and make Emacs nonfunctional. */);
11145 Vpre_command_hook
= Qnil
;
11147 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11148 doc
: /* Normal hook run after each command is executed.
11149 If an unhandled error happens in running this hook,
11150 the hook value is set to nil, since otherwise the error
11151 might happen repeatedly and make Emacs nonfunctional. */);
11152 Vpost_command_hook
= Qnil
;
11154 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook
,
11155 doc
: /* Normal hook run after each command is executed, if idle.
11156 Errors running the hook are caught and ignored. */);
11157 Vpost_command_idle_hook
= Qnil
;
11159 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay
,
11160 doc
: /* Delay time before running `post-command-idle-hook'.
11161 This is measured in microseconds. */);
11162 post_command_idle_delay
= 100000;
11165 DEFVAR_LISP ("echo-area-clear-hook", ...,
11166 doc
: /* Normal hook run when clearing the echo area. */);
11168 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11169 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11171 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11172 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11173 Vlucid_menu_bar_dirty_flag
= Qnil
;
11175 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11176 doc
: /* List of menu bar items to move to the end of the menu bar.
11177 The elements of the list are event types that may have menu bar bindings. */);
11178 Vmenu_bar_final_items
= Qnil
;
11180 DEFVAR_KBOARD ("overriding-terminal-local-map",
11181 Voverriding_terminal_local_map
,
11182 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11183 If this variable is non-nil, it is used as a keymap instead of the
11184 buffer's local map, and the minor mode keymaps and text property keymaps.
11185 This variable is intended to let commands such as `universal-argument'
11186 set up a different keymap for reading the next command. */);
11188 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11189 doc
: /* Keymap that overrides all other local keymaps.
11190 If this variable is non-nil, it is used as a keymap instead of the
11191 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11192 Voverriding_local_map
= Qnil
;
11194 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11195 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11196 Otherwise, the menu bar continues to reflect the buffer's local map
11197 and the minor mode maps regardless of `overriding-local-map'. */);
11198 Voverriding_local_map_menu_flag
= Qnil
;
11200 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11201 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11202 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11204 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11205 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11207 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11208 doc
: /* Alist of system-specific X windows key symbols.
11209 Each element should have the form (N . SYMBOL) where N is the
11210 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11211 and SYMBOL is its name. */);
11213 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11214 doc
: /* List of deferred actions to be performed at a later time.
11215 The precise format isn't relevant here; we just check whether it is nil. */);
11216 Vdeferred_action_list
= Qnil
;
11218 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11219 doc
: /* Function to call to handle deferred actions, after each command.
11220 This function is called with no arguments after each command
11221 whenever `deferred-action-list' is non-nil. */);
11222 Vdeferred_action_function
= Qnil
;
11224 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11225 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11226 The value can be a length of time to show the message for.
11227 If the value is non-nil and not a number, we wait 2 seconds. */);
11228 Vsuggest_key_bindings
= Qt
;
11230 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11231 doc
: /* List of active absolute time timers in order of increasing time. */);
11232 Vtimer_list
= Qnil
;
11234 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11235 doc
: /* List of active idle-time timers in order of increasing time. */);
11236 Vtimer_idle_list
= Qnil
;
11238 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11239 doc
: /* If non-nil, the function that implements the current input method.
11240 It's called with one argument, a printing character that was just read.
11241 \(That means a character with code 040...0176.)
11242 Typically this function uses `read-event' to read additional events.
11243 When it does so, it should first bind `input-method-function' to nil
11244 so it will not be called recursively.
11246 The function should return a list of zero or more events
11247 to be used as input. If it wants to put back some events
11248 to be reconsidered, separately, by the input method,
11249 it can add them to the beginning of `unread-command-events'.
11251 The input method function can find in `input-method-previous-method'
11252 the previous echo area message.
11254 The input method function should refer to the variables
11255 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11256 for guidance on what to do. */);
11257 Vinput_method_function
= Qnil
;
11259 DEFVAR_LISP ("input-method-previous-message",
11260 &Vinput_method_previous_message
,
11261 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11262 This variable exists because `read-event' clears the echo area
11263 before running the input method. It is nil if there was no message. */);
11264 Vinput_method_previous_message
= Qnil
;
11266 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11267 doc
: /* If non-nil, the function that implements the display of help.
11268 It's called with one argument, the help string to display. */);
11269 Vshow_help_function
= Qnil
;
11271 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11272 doc
: /* If non-nil, suppress point adjustment after executing a command.
11274 After a command is executed, if point is moved into a region that has
11275 special properties (e.g. composition, display), we adjust point to
11276 the boundary of the region. But, several special commands sets this
11277 variable to non-nil, then we suppress the point adjustment.
11279 This variable is set to nil before reading a command, and is checked
11280 just after executing the command. */);
11281 Vdisable_point_adjustment
= Qnil
;
11283 DEFVAR_LISP ("global-disable-point-adjustment",
11284 &Vglobal_disable_point_adjustment
,
11285 doc
: /* *If non-nil, always suppress point adjustment.
11287 The default value is nil, in which case, point adjustment are
11288 suppressed only after special commands that set
11289 `disable-point-adjustment' (which see) to non-nil. */);
11290 Vglobal_disable_point_adjustment
= Qnil
;
11292 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11293 doc
: /* Non-nil means updating menu bindings is allowed.
11294 A value of nil means menu bindings should not be updated.
11295 Used during Emacs' startup. */);
11296 update_menu_bindings
= 1;
11298 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11299 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11300 If the value is not a number, such messages don't time out. */);
11301 Vminibuffer_message_timeout
= make_number (2);
11305 keys_of_keyboard ()
11307 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11308 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11309 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11310 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11311 initial_define_key (meta_map
, 'x', "execute-extended-command");
11313 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11314 "handle-delete-frame");
11315 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11317 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11319 /* Handling it at such a low-level causes read_key_sequence to get
11320 * confused because it doesn't realize that the current_buffer was
11321 * changed by read_char.
11323 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11324 * "handle-select-window"); */
11325 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11326 "handle-save-session");
11329 /* Mark the pointers in the kboard objects.
11330 Called by the Fgarbage_collector. */
11336 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11338 if (kb
->kbd_macro_buffer
)
11339 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11341 mark_object (kb
->Voverriding_terminal_local_map
);
11342 mark_object (kb
->Vlast_command
);
11343 mark_object (kb
->Vreal_last_command
);
11344 mark_object (kb
->Vprefix_arg
);
11345 mark_object (kb
->Vlast_prefix_arg
);
11346 mark_object (kb
->kbd_queue
);
11347 mark_object (kb
->defining_kbd_macro
);
11348 mark_object (kb
->Vlast_kbd_macro
);
11349 mark_object (kb
->Vsystem_key_alist
);
11350 mark_object (kb
->system_key_syms
);
11351 mark_object (kb
->Vdefault_minibuffer_frame
);
11352 mark_object (kb
->echo_string
);
11355 struct input_event
*event
;
11356 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11358 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11359 event
= kbd_buffer
;
11360 mark_object (event
->x
);
11361 mark_object (event
->y
);
11362 mark_object (event
->frame_or_window
);
11363 mark_object (event
->arg
);
11368 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11369 (do not change this comment) */