1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2012 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 3 of the License, or
10 (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>. */
22 #define KEYBOARD_INLINE EXTERN_INLINE
30 #include "termhooks.h"
35 #include "character.h"
38 #include "dispextern.h"
40 #include "intervals.h"
42 #include "blockinput.h"
56 #include <sys/ioctl.h>
57 #endif /* not MSDOS */
59 #if defined USABLE_FIONREAD && defined USG5_4
60 # include <sys/filio.h>
63 #include "syssignal.h"
65 #include <sys/types.h>
69 #ifdef HAVE_WINDOW_SYSTEM
71 #endif /* HAVE_WINDOW_SYSTEM */
73 /* Variables for blockinput.h: */
75 /* Non-zero if interrupt input is blocked right now. */
76 volatile int interrupt_input_blocked
;
78 /* Nonzero means an input interrupt has arrived
79 during the current critical section. */
80 int interrupt_input_pending
;
82 /* This var should be (interrupt_input_pending || pending_atimers).
83 The QUIT macro checks this instead of interrupt_input_pending and
84 pending_atimers separately, to reduce code size. So, any code that
85 changes interrupt_input_pending or pending_atimers should update
89 #define KBD_BUFFER_SIZE 4096
91 KBOARD
*initial_kboard
;
92 KBOARD
*current_kboard
;
95 /* Nonzero in the single-kboard state, 0 in the any-kboard state. */
96 static int single_kboard
;
98 /* Non-nil disable property on a command means
99 do not execute it; call disabled-command-function's value instead. */
100 Lisp_Object Qdisabled
;
101 static Lisp_Object Qdisabled_command_function
;
103 #define NUM_RECENT_KEYS (300)
105 /* Index for storing next element into recent_keys. */
106 static int recent_keys_index
;
108 /* Total number of elements stored into recent_keys. */
109 static int total_keys
;
111 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
112 static Lisp_Object recent_keys
;
114 /* Vector holding the key sequence that invoked the current command.
115 It is reused for each command, and it may be longer than the current
116 sequence; this_command_key_count indicates how many elements
117 actually mean something.
118 It's easier to staticpro a single Lisp_Object than an array. */
119 Lisp_Object this_command_keys
;
120 ptrdiff_t this_command_key_count
;
122 /* 1 after calling Freset_this_command_lengths.
124 static int this_command_key_count_reset
;
126 /* This vector is used as a buffer to record the events that were actually read
127 by read_key_sequence. */
128 static Lisp_Object raw_keybuf
;
129 static int raw_keybuf_count
;
131 #define GROW_RAW_KEYBUF \
132 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
133 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
135 /* Number of elements of this_command_keys
136 that precede this key sequence. */
137 static ptrdiff_t this_single_command_key_start
;
139 /* Record values of this_command_key_count and echo_length ()
140 before this command was read. */
141 static ptrdiff_t before_command_key_count
;
142 static ptrdiff_t before_command_echo_length
;
144 /* For longjmp to where kbd input is being done. */
146 static sys_jmp_buf getcjmp
;
148 /* True while doing kbd input. */
149 int waiting_for_input
;
151 /* True while displaying for echoing. Delays C-g throwing. */
155 /* Non-null means we can start echoing at the next input pause even
156 though there is something in the echo area. */
158 static struct kboard
*ok_to_echo_at_next_pause
;
160 /* The kboard last echoing, or null for none. Reset to 0 in
161 cancel_echoing. If non-null, and a current echo area message
162 exists, and echo_message_buffer is eq to the current message
163 buffer, we know that the message comes from echo_kboard. */
165 struct kboard
*echo_kboard
;
167 /* The buffer used for echoing. Set in echo_now, reset in
170 Lisp_Object echo_message_buffer
;
172 /* Nonzero means C-g should cause immediate error-signal. */
175 /* Character that causes a quit. Normally C-g.
177 If we are running on an ordinary terminal, this must be an ordinary
178 ASCII char, since we want to make it our interrupt character.
180 If we are not running on an ordinary terminal, it still needs to be
181 an ordinary ASCII char. This character needs to be recognized in
182 the input interrupt handler. At this point, the keystroke is
183 represented as a struct input_event, while the desired quit
184 character is specified as a lispy event. The mapping from struct
185 input_events to lispy events cannot run in an interrupt handler,
186 and the reverse mapping is difficult for anything but ASCII
189 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
193 /* Current depth in recursive edits. */
194 EMACS_INT command_loop_level
;
196 /* If not Qnil, this is a switch-frame event which we decided to put
197 off until the end of a key sequence. This should be read as the
198 next command input, after any unread_command_events.
200 read_key_sequence uses this to delay switch-frame events until the
201 end of the key sequence; Fread_char uses it to put off switch-frame
202 events until a non-ASCII event is acceptable as input. */
203 Lisp_Object unread_switch_frame
;
205 /* Last size recorded for a current buffer which is not a minibuffer. */
206 static ptrdiff_t last_non_minibuf_size
;
208 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
209 uintmax_t num_input_events
;
211 /* Value of num_nonmacro_input_events as of last auto save. */
213 static EMACS_INT last_auto_save
;
215 /* The value of point when the last command was started. */
216 static ptrdiff_t last_point_position
;
218 /* The buffer that was current when the last command was started. */
219 static Lisp_Object last_point_position_buffer
;
221 /* The window that was selected when the last command was started. */
222 static Lisp_Object last_point_position_window
;
224 /* The frame in which the last input event occurred, or Qmacro if the
225 last event came from a macro. We use this to determine when to
226 generate switch-frame events. This may be cleared by functions
227 like Fselect_frame, to make sure that a switch-frame event is
228 generated by the next character. */
229 Lisp_Object internal_last_event_frame
;
231 /* The timestamp of the last input event we received from the X server.
232 X Windows wants this for selection ownership. */
233 Time last_event_timestamp
;
235 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
236 static Lisp_Object Qhandle_select_window
;
237 Lisp_Object QPRIMARY
;
239 static Lisp_Object Qself_insert_command
;
240 static Lisp_Object Qforward_char
;
241 static Lisp_Object Qbackward_char
;
242 Lisp_Object Qundefined
;
243 static Lisp_Object Qtimer_event_handler
;
245 /* read_key_sequence stores here the command definition of the
246 key sequence that it reads. */
247 static Lisp_Object read_key_sequence_cmd
;
248 static Lisp_Object read_key_sequence_remapped
;
250 static Lisp_Object Qinput_method_function
;
252 static Lisp_Object Qdeactivate_mark
;
254 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
256 static Lisp_Object Qecho_area_clear_hook
;
258 /* Hooks to run before and after each command. */
259 static Lisp_Object Qpre_command_hook
;
260 static Lisp_Object Qpost_command_hook
;
262 static Lisp_Object Qdeferred_action_function
;
264 static Lisp_Object Qdelayed_warnings_hook
;
266 static Lisp_Object Qinput_method_exit_on_first_char
;
267 static Lisp_Object Qinput_method_use_echo_area
;
269 static Lisp_Object Qhelp_form_show
;
271 /* File in which we write all commands we read. */
272 static FILE *dribble
;
274 /* Nonzero if input is available. */
277 /* Circular buffer for pre-read keyboard input. */
279 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
281 /* Pointer to next available character in kbd_buffer.
282 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
283 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
284 next available char is in kbd_buffer[0]. */
285 static struct input_event
*kbd_fetch_ptr
;
287 /* Pointer to next place to store character in kbd_buffer. This
288 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
289 character should go in kbd_buffer[0]. */
290 static struct input_event
* volatile kbd_store_ptr
;
292 /* The above pair of variables forms a "queue empty" flag. When we
293 enqueue a non-hook event, we increment kbd_store_ptr. When we
294 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
295 there is input available if the two pointers are not equal.
297 Why not just have a flag set and cleared by the enqueuing and
298 dequeuing functions? Such a flag could be screwed up by interrupts
299 at inopportune times. */
301 /* Symbols to head events. */
302 static Lisp_Object Qmouse_movement
;
303 static Lisp_Object Qscroll_bar_movement
;
304 Lisp_Object Qswitch_frame
;
305 static Lisp_Object Qdelete_frame
;
306 static Lisp_Object Qiconify_frame
;
307 static Lisp_Object Qmake_frame_visible
;
308 static Lisp_Object Qselect_window
;
309 Lisp_Object Qhelp_echo
;
311 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
312 static Lisp_Object Qmouse_fixup_help_message
;
315 /* Symbols to denote kinds of events. */
316 static Lisp_Object Qfunction_key
;
317 Lisp_Object Qmouse_click
;
318 #if defined (WINDOWSNT)
319 Lisp_Object Qlanguage_change
;
321 static Lisp_Object Qdrag_n_drop
;
322 static Lisp_Object Qsave_session
;
324 static Lisp_Object Qdbus_event
;
326 static Lisp_Object Qconfig_changed_event
;
328 /* Lisp_Object Qmouse_movement; - also an event header */
330 /* Properties of event headers. */
331 Lisp_Object Qevent_kind
;
332 static Lisp_Object Qevent_symbol_elements
;
334 /* Menu and tool bar item parts. */
335 static Lisp_Object Qmenu_enable
;
336 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
337 Lisp_Object QCfilter
;
339 /* Non-nil disable property on a command means
340 do not execute it; call disabled-command-function's value instead. */
341 Lisp_Object QCtoggle
, QCradio
;
342 static Lisp_Object QCbutton
, QClabel
;
344 static Lisp_Object QCvert_only
;
346 /* An event header symbol HEAD may have a property named
347 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
348 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
349 mask of modifiers applied to it. If present, this is used to help
350 speed up parse_modifiers. */
351 Lisp_Object Qevent_symbol_element_mask
;
353 /* An unmodified event header BASE may have a property named
354 Qmodifier_cache, which is an alist mapping modifier masks onto
355 modified versions of BASE. If present, this helps speed up
357 static Lisp_Object Qmodifier_cache
;
359 /* Symbols to use for parts of windows. */
360 Lisp_Object Qmode_line
;
361 Lisp_Object Qvertical_line
;
362 static Lisp_Object Qvertical_scroll_bar
;
363 Lisp_Object Qmenu_bar
;
365 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
366 static Lisp_Object
command_loop (void);
367 static Lisp_Object Qextended_command_history
;
368 EMACS_TIME
timer_check (void);
370 static void record_menu_key (Lisp_Object c
);
371 static void echo_now (void);
372 static ptrdiff_t echo_length (void);
374 static Lisp_Object Qpolling_period
;
376 /* Incremented whenever a timer is run. */
379 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
381 EMACS_TIME
*input_available_clear_time
;
383 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
384 Default is 1 if INTERRUPT_INPUT is defined. */
387 /* Nonzero while interrupts are temporarily deferred during redisplay. */
388 int interrupts_deferred
;
390 /* If we support a window system, turn on the code to poll periodically
391 to detect C-g. It isn't actually used when doing interrupt input. */
392 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_ASYNC_EVENTS)
393 #define POLL_FOR_INPUT
396 /* The time when Emacs started being idle. */
398 static EMACS_TIME timer_idleness_start_time
;
400 /* After Emacs stops being idle, this saves the last value
401 of timer_idleness_start_time from when it was idle. */
403 static EMACS_TIME timer_last_idleness_start_time
;
406 /* Global variable declarations. */
408 /* Flags for readable_events. */
409 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
410 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
411 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
413 /* Function for init_keyboard to call with no args (if nonzero). */
414 static void (*keyboard_init_hook
) (void);
416 static int read_avail_input (void);
417 static void get_input_pending (int *, int);
418 static int readable_events (int);
419 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
421 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
423 static Lisp_Object
make_lispy_event (struct input_event
*);
424 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
425 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
426 enum scroll_bar_part
,
427 Lisp_Object
, Lisp_Object
,
430 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
431 Lisp_Object
, const char *const *,
432 Lisp_Object
*, ptrdiff_t);
433 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
434 static int help_char_p (Lisp_Object
);
435 static void save_getcjmp (sys_jmp_buf
);
436 static void restore_getcjmp (sys_jmp_buf
);
437 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
438 static void clear_event (struct input_event
*);
439 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
441 static void deliver_input_available_signal (int signo
);
443 static void handle_interrupt (void);
444 static _Noreturn
void quit_throw_to_read_char (int);
445 static void process_special_events (void);
446 static void timer_start_idle (void);
447 static void timer_stop_idle (void);
448 static void timer_resume_idle (void);
449 static void deliver_user_signal (int);
450 static char *find_user_signal_name (int);
451 static void store_user_signal_events (void);
453 /* These setters are used only in this file, so they can be private. */
455 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
457 kb
->INTERNAL_FIELD (echo_string
) = val
;
460 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
462 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
465 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
467 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
470 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
472 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
475 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
477 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
480 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
482 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
485 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
487 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
490 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
492 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
495 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
497 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
501 /* Add C to the echo string, if echoing is going on.
502 C can be a character, which is printed prettily ("M-C-x" and all that
503 jazz), or a symbol, whose name is printed. */
506 echo_char (Lisp_Object c
)
508 if (current_kboard
->immediate_echo
)
510 int size
= KEY_DESCRIPTION_SIZE
+ 100;
511 char *buffer
= alloca (size
);
513 Lisp_Object echo_string
;
515 echo_string
= KVAR (current_kboard
, echo_string
);
517 /* If someone has passed us a composite event, use its head symbol. */
522 ptr
= push_key_description (XINT (c
), ptr
, 1);
524 else if (SYMBOLP (c
))
526 Lisp_Object name
= SYMBOL_NAME (c
);
527 int nbytes
= SBYTES (name
);
529 if (size
- (ptr
- buffer
) < nbytes
)
531 int offset
= ptr
- buffer
;
532 size
= max (2 * size
, size
+ nbytes
);
533 buffer
= alloca (size
);
534 ptr
= buffer
+ offset
;
537 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
538 STRING_MULTIBYTE (name
), 1);
541 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
544 const char *text
= " (Type ? for further options)";
545 int len
= strlen (text
);
547 if (size
- (ptr
- buffer
) < len
)
549 int offset
= ptr
- buffer
;
551 buffer
= alloca (size
);
552 ptr
= buffer
+ offset
;
555 memcpy (ptr
, text
, len
);
559 /* Replace a dash from echo_dash with a space, otherwise
560 add a space at the end as a separator between keys. */
561 if (STRINGP (echo_string
)
562 && SCHARS (echo_string
) > 1)
564 Lisp_Object last_char
, prev_char
, idx
;
566 idx
= make_number (SCHARS (echo_string
) - 2);
567 prev_char
= Faref (echo_string
, idx
);
569 idx
= make_number (SCHARS (echo_string
) - 1);
570 last_char
= Faref (echo_string
, idx
);
572 /* We test PREV_CHAR to make sure this isn't the echoing
574 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
575 Faset (echo_string
, idx
, make_number (' '));
577 echo_string
= concat2 (echo_string
, build_string (" "));
579 else if (STRINGP (echo_string
))
580 echo_string
= concat2 (echo_string
, build_string (" "));
584 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
590 /* Temporarily add a dash to the end of the echo string if it's not
591 empty, so that it serves as a mini-prompt for the very next character. */
596 /* Do nothing if not echoing at all. */
597 if (NILP (KVAR (current_kboard
, echo_string
)))
600 if (this_command_key_count
== 0)
603 if (!current_kboard
->immediate_echo
604 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
607 /* Do nothing if we just printed a prompt. */
608 if (current_kboard
->echo_after_prompt
609 == SCHARS (KVAR (current_kboard
, echo_string
)))
612 /* Do nothing if we have already put a dash at the end. */
613 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
615 Lisp_Object last_char
, prev_char
, idx
;
617 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
618 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
620 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
621 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
623 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
627 /* Put a dash at the end of the buffer temporarily,
628 but make it go away when the next character is added. */
631 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
635 /* Display the current echo string, and begin echoing if not already
641 if (!current_kboard
->immediate_echo
)
644 current_kboard
->immediate_echo
= 1;
646 for (i
= 0; i
< this_command_key_count
; i
++)
650 /* Set before_command_echo_length to the value that would
651 have been saved before the start of this subcommand in
652 command_loop_1, if we had already been echoing then. */
653 if (i
== this_single_command_key_start
)
654 before_command_echo_length
= echo_length ();
656 c
= AREF (this_command_keys
, i
);
657 if (! (EVENT_HAS_PARAMETERS (c
)
658 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
662 /* Set before_command_echo_length to the value that would
663 have been saved before the start of this subcommand in
664 command_loop_1, if we had already been echoing then. */
665 if (this_command_key_count
== this_single_command_key_start
)
666 before_command_echo_length
= echo_length ();
668 /* Put a dash at the end to invite the user to type more. */
673 message3_nolog (KVAR (current_kboard
, echo_string
),
674 SBYTES (KVAR (current_kboard
, echo_string
)),
675 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
678 /* Record in what buffer we echoed, and from which kboard. */
679 echo_message_buffer
= echo_area_buffer
[0];
680 echo_kboard
= current_kboard
;
682 if (waiting_for_input
&& !NILP (Vquit_flag
))
683 quit_throw_to_read_char (0);
686 /* Turn off echoing, for the start of a new command. */
689 cancel_echoing (void)
691 current_kboard
->immediate_echo
= 0;
692 current_kboard
->echo_after_prompt
= -1;
693 kset_echo_string (current_kboard
, Qnil
);
694 ok_to_echo_at_next_pause
= NULL
;
696 echo_message_buffer
= Qnil
;
699 /* Return the length of the current echo string. */
704 return (STRINGP (KVAR (current_kboard
, echo_string
))
705 ? SCHARS (KVAR (current_kboard
, echo_string
))
709 /* Truncate the current echo message to its first LEN chars.
710 This and echo_char get used by read_key_sequence when the user
711 switches frames while entering a key sequence. */
714 echo_truncate (ptrdiff_t nchars
)
716 if (STRINGP (KVAR (current_kboard
, echo_string
)))
717 kset_echo_string (current_kboard
,
718 Fsubstring (KVAR (current_kboard
, echo_string
),
719 make_number (0), make_number (nchars
)));
720 truncate_echo_area (nchars
);
724 /* Functions for manipulating this_command_keys. */
726 add_command_key (Lisp_Object key
)
728 #if 0 /* Not needed after we made Freset_this_command_lengths
729 do the job immediately. */
730 /* If reset-this-command-length was called recently, obey it now.
731 See the doc string of that function for an explanation of why. */
732 if (before_command_restore_flag
)
734 this_command_key_count
= before_command_key_count_1
;
735 if (this_command_key_count
< this_single_command_key_start
)
736 this_single_command_key_start
= this_command_key_count
;
737 echo_truncate (before_command_echo_length_1
);
738 before_command_restore_flag
= 0;
742 if (this_command_key_count
>= ASIZE (this_command_keys
))
743 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
745 ASET (this_command_keys
, this_command_key_count
, key
);
746 ++this_command_key_count
;
751 recursive_edit_1 (void)
753 ptrdiff_t count
= SPECPDL_INDEX ();
756 if (command_loop_level
> 0)
758 specbind (Qstandard_output
, Qt
);
759 specbind (Qstandard_input
, Qt
);
762 #ifdef HAVE_WINDOW_SYSTEM
763 /* The command loop has started an hourglass timer, so we have to
764 cancel it here, otherwise it will fire because the recursive edit
765 can take some time. Do not check for display_hourglass_p here,
766 because it could already be nil. */
770 /* This function may have been called from a debugger called from
771 within redisplay, for instance by Edebugging a function called
772 from fontification-functions. We want to allow redisplay in
773 the debugging session.
775 The recursive edit is left with a `(throw exit ...)'. The `exit'
776 tag is not caught anywhere in redisplay, i.e. when we leave the
777 recursive edit, the original redisplay leading to the recursive
778 edit will be unwound. The outcome should therefore be safe. */
779 specbind (Qinhibit_redisplay
, Qnil
);
782 val
= command_loop ();
784 Fsignal (Qquit
, Qnil
);
785 /* Handle throw from read_minibuf when using minibuffer
786 while it's active but we're in another window. */
788 xsignal1 (Qerror
, val
);
790 return unbind_to (count
, Qnil
);
793 /* When an auto-save happens, record the "time", and don't do again soon. */
796 record_auto_save (void)
798 last_auto_save
= num_nonmacro_input_events
;
801 /* Make an auto save happen as soon as possible at command level. */
805 force_auto_save_soon (void)
807 last_auto_save
= - auto_save_interval
- 1;
809 record_asynch_buffer_change ();
813 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
814 doc
: /* Invoke the editor command loop recursively.
815 To get out of the recursive edit, a command can do `(throw 'exit nil)';
816 that tells this function to return.
817 Alternatively, `(throw 'exit t)' makes this function signal an error.
818 This function is called by the editor initialization to begin editing. */)
821 ptrdiff_t count
= SPECPDL_INDEX ();
824 /* If we enter while input is blocked, don't lock up here.
825 This may happen through the debugger during redisplay. */
829 command_loop_level
++;
830 update_mode_lines
= 1;
832 if (command_loop_level
833 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
834 buffer
= Fcurrent_buffer ();
838 /* If we leave recursive_edit_1 below with a `throw' for instance,
839 like it is done in the splash screen display, we have to
840 make sure that we restore single_kboard as command_loop_1
841 would have done if it were left normally. */
842 if (command_loop_level
> 0)
843 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
844 record_unwind_protect (recursive_edit_unwind
, buffer
);
847 return unbind_to (count
, Qnil
);
851 recursive_edit_unwind (Lisp_Object buffer
)
853 if (BUFFERP (buffer
))
854 Fset_buffer (buffer
);
856 command_loop_level
--;
857 update_mode_lines
= 1;
862 #if 0 /* These two functions are now replaced with
863 temporarily_switch_to_single_kboard. */
867 #if 0 /* Theory: if there's anything in Vunread_command_events,
868 it will right away be read by read_key_sequence,
869 and then if we do switch KBOARDS, it will go into the side
870 queue then. So we don't need to do anything special here -- rms. */
871 if (CONSP (Vunread_command_events
))
873 current_kboard
->kbd_queue
874 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
875 current_kboard
->kbd_queue_has_data
= 1;
877 Vunread_command_events
= Qnil
;
882 /* Switch to the single-kboard state, making current_kboard
883 the only KBOARD from which further input is accepted. */
886 single_kboard_state ()
892 /* If we're in single_kboard state for kboard KBOARD,
896 not_single_kboard_state (KBOARD
*kboard
)
898 if (kboard
== current_kboard
)
902 /* Maintain a stack of kboards, so other parts of Emacs
903 can switch temporarily to the kboard of a given frame
904 and then revert to the previous status. */
909 struct kboard_stack
*next
;
912 static struct kboard_stack
*kboard_stack
;
915 push_kboard (struct kboard
*k
)
917 struct kboard_stack
*p
= xmalloc (sizeof *p
);
919 p
->next
= kboard_stack
;
920 p
->kboard
= current_kboard
;
930 struct kboard_stack
*p
= kboard_stack
;
932 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
934 if (t
->kboard
== p
->kboard
)
936 current_kboard
= p
->kboard
;
943 /* The terminal we remembered has been deleted. */
944 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
947 kboard_stack
= p
->next
;
951 /* Switch to single_kboard mode, making current_kboard the only KBOARD
952 from which further input is accepted. If F is non-nil, set its
953 KBOARD as the current keyboard.
955 This function uses record_unwind_protect to return to the previous
958 If Emacs is already in single_kboard mode, and F's keyboard is
959 locked, then this function will throw an error. */
962 temporarily_switch_to_single_kboard (struct frame
*f
)
964 int was_locked
= single_kboard
;
967 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
968 /* We can not switch keyboards while in single_kboard mode.
969 In rare cases, Lisp code may call `recursive-edit' (or
970 `read-minibuffer' or `y-or-n-p') after it switched to a
971 locked frame. For example, this is likely to happen
972 when server.el connects to a new terminal while Emacs is in
973 single_kboard mode. It is best to throw an error instead
974 of presenting the user with a frozen screen. */
975 error ("Terminal %d is locked, cannot read from it",
976 FRAME_TERMINAL (f
)->id
);
978 /* This call is unnecessary, but helps
979 `restore_kboard_configuration' discover if somebody changed
980 `current_kboard' behind our back. */
981 push_kboard (current_kboard
);
984 current_kboard
= FRAME_KBOARD (f
);
986 record_unwind_protect (restore_kboard_configuration
,
987 (was_locked
? Qt
: Qnil
));
990 #if 0 /* This function is not needed anymore. */
992 record_single_kboard_state ()
995 push_kboard (current_kboard
);
996 record_unwind_protect (restore_kboard_configuration
,
997 (single_kboard
? Qt
: Qnil
));
1002 restore_kboard_configuration (Lisp_Object was_locked
)
1004 if (NILP (was_locked
))
1008 struct kboard
*prev
= current_kboard
;
1011 /* The pop should not change the kboard. */
1012 if (single_kboard
&& current_kboard
!= prev
)
1019 /* Handle errors that are not handled at inner levels
1020 by printing an error message and returning to the editor command loop. */
1023 cmd_error (Lisp_Object data
)
1025 Lisp_Object old_level
, old_length
;
1026 char macroerror
[sizeof "After..kbd macro iterations: "
1027 + INT_STRLEN_BOUND (EMACS_INT
)];
1029 #ifdef HAVE_WINDOW_SYSTEM
1030 if (display_hourglass_p
)
1031 cancel_hourglass ();
1034 if (!NILP (executing_kbd_macro
))
1036 if (executing_kbd_macro_iterations
== 1)
1037 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1039 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1040 executing_kbd_macro_iterations
);
1045 Vstandard_output
= Qt
;
1046 Vstandard_input
= Qt
;
1047 Vexecuting_kbd_macro
= Qnil
;
1048 executing_kbd_macro
= Qnil
;
1049 kset_prefix_arg (current_kboard
, Qnil
);
1050 kset_last_prefix_arg (current_kboard
, Qnil
);
1053 /* Avoid unquittable loop if data contains a circular list. */
1054 old_level
= Vprint_level
;
1055 old_length
= Vprint_length
;
1056 XSETFASTINT (Vprint_level
, 10);
1057 XSETFASTINT (Vprint_length
, 10);
1058 cmd_error_internal (data
, macroerror
);
1059 Vprint_level
= old_level
;
1060 Vprint_length
= old_length
;
1064 Vinhibit_quit
= Qnil
;
1065 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1066 if (command_loop_level
== 0 && minibuf_level
== 0)
1067 any_kboard_state ();
1070 return make_number (0);
1073 /* Take actions on handling an error. DATA is the data that describes
1076 CONTEXT is a C-string containing ASCII characters only which
1077 describes the context in which the error happened. If we need to
1078 generalize CONTEXT to allow multibyte characters, make it a Lisp
1082 cmd_error_internal (Lisp_Object data
, const char *context
)
1084 struct frame
*sf
= SELECTED_FRAME ();
1086 /* The immediate context is not interesting for Quits,
1087 since they are asynchronous. */
1088 if (EQ (XCAR (data
), Qquit
))
1089 Vsignaling_function
= Qnil
;
1094 /* Use user's specified output function if any. */
1095 if (!NILP (Vcommand_error_function
))
1096 call3 (Vcommand_error_function
, data
,
1097 context
? build_string (context
) : empty_unibyte_string
,
1098 Vsignaling_function
);
1099 /* If the window system or terminal frame hasn't been initialized
1100 yet, or we're not interactive, write the message to stderr and exit. */
1101 else if (!sf
->glyphs_initialized_p
1102 /* The initial frame is a special non-displaying frame. It
1103 will be current in daemon mode when there are no frames
1104 to display, and in non-daemon mode before the real frame
1105 has finished initializing. If an error is thrown in the
1106 latter case while creating the frame, then the frame
1107 will never be displayed, so the safest thing to do is
1108 write to stderr and quit. In daemon mode, there are
1109 many other potential errors that do not prevent frames
1110 from being created, so continuing as normal is better in
1112 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1115 print_error_message (data
, Qexternal_debugging_output
,
1116 context
, Vsignaling_function
);
1117 Fterpri (Qexternal_debugging_output
);
1118 Fkill_emacs (make_number (-1));
1122 clear_message (1, 0);
1124 message_log_maybe_newline ();
1127 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1130 Vsignaling_function
= Qnil
;
1133 Lisp_Object
command_loop_1 (void);
1134 static Lisp_Object
command_loop_2 (Lisp_Object
);
1135 static Lisp_Object
top_level_1 (Lisp_Object
);
1137 /* Entry to editor-command-loop.
1138 This level has the catches for exiting/returning to editor command loop.
1139 It returns nil to exit recursive edit, t to abort it. */
1144 if (command_loop_level
> 0 || minibuf_level
> 0)
1147 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1148 executing_kbd_macro
= Qnil
;
1154 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1155 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1156 /* Reset single_kboard in case top-level set it while
1157 evaluating an -f option, or we are stuck there for some
1159 any_kboard_state ();
1161 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1162 executing_kbd_macro
= Qnil
;
1164 /* End of file in -batch run causes exit here. */
1170 /* Here we catch errors in execution of commands within the
1171 editing loop, and reenter the editing loop.
1172 When there is an error, cmd_error runs and returns a non-nil
1173 value to us. A value of nil means that command_loop_1 itself
1174 returned due to end of file (or end of kbd macro). */
1177 command_loop_2 (Lisp_Object ignore
)
1179 register Lisp_Object val
;
1182 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1183 while (!NILP (val
));
1191 return Feval (Vtop_level
, Qnil
);
1195 top_level_1 (Lisp_Object ignore
)
1197 /* On entry to the outer level, run the startup file */
1198 if (!NILP (Vtop_level
))
1199 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1200 else if (!NILP (Vpurify_flag
))
1201 message ("Bare impure Emacs (standard Lisp code not loaded)");
1203 message ("Bare Emacs (standard Lisp code not loaded)");
1207 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1208 doc
: /* Exit all recursive editing levels.
1209 This also exits all active minibuffers. */)
1212 #ifdef HAVE_WINDOW_SYSTEM
1213 if (display_hourglass_p
)
1214 cancel_hourglass ();
1217 /* Unblock input if we enter with input blocked. This may happen if
1218 redisplay traps e.g. during tool-bar update with input blocked. */
1219 while (INPUT_BLOCKED_P
)
1222 Fthrow (Qtop_level
, Qnil
);
1225 static _Noreturn
void
1226 user_error (const char *msg
)
1228 xsignal1 (Quser_error
, build_string (msg
));
1232 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1233 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1236 if (command_loop_level
> 0 || minibuf_level
> 0)
1237 Fthrow (Qexit
, Qnil
);
1239 user_error ("No recursive edit is in progress");
1243 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1244 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1247 if (command_loop_level
> 0 || minibuf_level
> 0)
1250 user_error ("No recursive edit is in progress");
1253 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1255 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1256 of this function. */
1259 tracking_off (Lisp_Object old_value
)
1261 do_mouse_tracking
= old_value
;
1262 if (NILP (old_value
))
1264 /* Redisplay may have been preempted because there was input
1265 available, and it assumes it will be called again after the
1266 input has been processed. If the only input available was
1267 the sort that we have just disabled, then we need to call
1269 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1271 redisplay_preserve_echo_area (6);
1272 get_input_pending (&input_pending
,
1273 READABLE_EVENTS_DO_TIMERS_NOW
);
1279 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1280 doc
: /* Evaluate BODY with mouse movement events enabled.
1281 Within a `track-mouse' form, mouse motion generates input events that
1282 you can read with `read-event'.
1283 Normally, mouse motion is ignored.
1284 usage: (track-mouse BODY...) */)
1287 ptrdiff_t count
= SPECPDL_INDEX ();
1290 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1292 do_mouse_tracking
= Qt
;
1294 val
= Fprogn (args
);
1295 return unbind_to (count
, val
);
1298 /* If mouse has moved on some frame, return one of those frames.
1302 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1303 after resizing the tool-bar window. */
1305 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1308 int ignore_mouse_drag_p
;
1311 some_mouse_moved (void)
1313 Lisp_Object tail
, frame
;
1315 if (ignore_mouse_drag_p
)
1317 /* ignore_mouse_drag_p = 0; */
1321 FOR_EACH_FRAME (tail
, frame
)
1323 if (XFRAME (frame
)->mouse_moved
)
1324 return XFRAME (frame
);
1330 #endif /* HAVE_MOUSE || HAVE_GPM */
1332 /* This is the actual command reading loop,
1333 sans error-handling encapsulation. */
1335 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1337 void safe_run_hooks (Lisp_Object
);
1338 static void adjust_point_for_property (ptrdiff_t, int);
1340 /* Cancel hourglass from protect_unwind.
1342 #ifdef HAVE_WINDOW_SYSTEM
1344 cancel_hourglass_unwind (Lisp_Object arg
)
1346 cancel_hourglass ();
1351 /* The last boundary auto-added to buffer-undo-list. */
1352 Lisp_Object last_undo_boundary
;
1354 /* FIXME: This is wrong rather than test window-system, we should call
1355 a new set-selection, which will then dispatch to x-set-selection, or
1356 tty-set-selection, or w32-set-selection, ... */
1359 command_loop_1 (void)
1362 Lisp_Object keybuf
[30];
1364 EMACS_INT prev_modiff
= 0;
1365 struct buffer
*prev_buffer
= NULL
;
1366 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1367 int was_locked
= single_kboard
;
1369 int already_adjusted
= 0;
1371 kset_prefix_arg (current_kboard
, Qnil
);
1372 kset_last_prefix_arg (current_kboard
, Qnil
);
1373 Vdeactivate_mark
= Qnil
;
1374 waiting_for_input
= 0;
1377 this_command_key_count
= 0;
1378 this_command_key_count_reset
= 0;
1379 this_single_command_key_start
= 0;
1381 if (NILP (Vmemory_full
))
1383 /* Make sure this hook runs after commands that get errors and
1384 throw to top level. */
1385 /* Note that the value cell will never directly contain nil
1386 if the symbol is a local variable. */
1387 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1388 safe_run_hooks (Qpost_command_hook
);
1390 /* If displaying a message, resize the echo area window to fit
1391 that message's size exactly. */
1392 if (!NILP (echo_area_buffer
[0]))
1393 resize_echo_area_exactly ();
1395 /* If there are warnings waiting, process them. */
1396 if (!NILP (Vdelayed_warnings_list
))
1397 safe_run_hooks (Qdelayed_warnings_hook
);
1399 if (!NILP (Vdeferred_action_list
))
1400 safe_run_hooks (Qdeferred_action_function
);
1403 /* Do this after running Vpost_command_hook, for consistency. */
1404 kset_last_command (current_kboard
, Vthis_command
);
1405 kset_real_last_command (current_kboard
, Vreal_this_command
);
1406 if (!CONSP (last_command_event
))
1407 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1411 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1414 /* Make sure the current window's buffer is selected. */
1415 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1417 /* Display any malloc warning that just came out. Use while because
1418 displaying one warning can cause another. */
1420 while (pending_malloc_warning
)
1421 display_malloc_warning ();
1423 Vdeactivate_mark
= Qnil
;
1425 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1427 /* Don't ignore mouse movements for more than a single command
1428 loop. (This flag is set in xdisp.c whenever the tool bar is
1429 resized, because the resize moves text up or down, and would
1430 generate false mouse drag events if we don't ignore them.) */
1431 ignore_mouse_drag_p
= 0;
1434 /* If minibuffer on and echo area in use,
1435 wait a short time and redraw minibuffer. */
1438 && !NILP (echo_area_buffer
[0])
1439 && EQ (minibuf_window
, echo_area_window
)
1440 && NUMBERP (Vminibuffer_message_timeout
))
1442 /* Bind inhibit-quit to t so that C-g gets read in
1443 rather than quitting back to the minibuffer. */
1444 ptrdiff_t count
= SPECPDL_INDEX ();
1445 specbind (Qinhibit_quit
, Qt
);
1447 sit_for (Vminibuffer_message_timeout
, 0, 2);
1449 /* Clear the echo area. */
1451 safe_run_hooks (Qecho_area_clear_hook
);
1453 unbind_to (count
, Qnil
);
1455 /* If a C-g came in before, treat it as input now. */
1456 if (!NILP (Vquit_flag
))
1459 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1464 /* Select the frame that the last event came from. Usually,
1465 switch-frame events will take care of this, but if some lisp
1466 code swallows a switch-frame event, we'll fix things up here.
1467 Is this a good idea? */
1468 if (FRAMEP (internal_last_event_frame
)
1469 && !EQ (internal_last_event_frame
, selected_frame
))
1470 Fselect_frame (internal_last_event_frame
, Qnil
);
1472 /* If it has changed current-menubar from previous value,
1473 really recompute the menubar from the value. */
1474 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1475 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1476 call0 (Qrecompute_lucid_menubar
);
1478 before_command_key_count
= this_command_key_count
;
1479 before_command_echo_length
= echo_length ();
1481 Vthis_command
= Qnil
;
1482 Vreal_this_command
= Qnil
;
1483 Vthis_original_command
= Qnil
;
1484 Vthis_command_keys_shift_translated
= Qnil
;
1486 /* Read next key sequence; i gets its length. */
1487 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1490 /* A filter may have run while we were reading the input. */
1491 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1493 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1497 /* Now we have read a key sequence of length I,
1498 or else I is 0 and we found end of file. */
1500 if (i
== 0) /* End of file -- happens only in */
1501 return Qnil
; /* a kbd macro, at the end. */
1502 /* -1 means read_key_sequence got a menu that was rejected.
1503 Just loop around and read another command. */
1507 this_command_key_count
= 0;
1508 this_command_key_count_reset
= 0;
1509 this_single_command_key_start
= 0;
1513 last_command_event
= keybuf
[i
- 1];
1515 /* If the previous command tried to force a specific window-start,
1516 forget about that, in case this command moves point far away
1517 from that position. But also throw away beg_unchanged and
1518 end_unchanged information in that case, so that redisplay will
1519 update the whole window properly. */
1520 if (XWINDOW (selected_window
)->force_start
)
1523 XWINDOW (selected_window
)->force_start
= 0;
1524 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1525 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1528 cmd
= read_key_sequence_cmd
;
1529 if (!NILP (Vexecuting_kbd_macro
))
1531 if (!NILP (Vquit_flag
))
1533 Vexecuting_kbd_macro
= Qt
;
1534 QUIT
; /* Make some noise. */
1535 /* Will return since macro now empty. */
1539 /* Do redisplay processing after this command except in special
1540 cases identified below. */
1541 prev_buffer
= current_buffer
;
1542 prev_modiff
= MODIFF
;
1543 last_point_position
= PT
;
1544 last_point_position_window
= selected_window
;
1545 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1547 /* By default, we adjust point to a boundary of a region that
1548 has such a property that should be treated intangible
1549 (e.g. composition, display). But, some commands will set
1550 this variable differently. */
1551 Vdisable_point_adjustment
= Qnil
;
1553 /* Process filters and timers may have messed with deactivate-mark.
1554 reset it before we execute the command. */
1555 Vdeactivate_mark
= Qnil
;
1557 /* Remap command through active keymaps. */
1558 Vthis_original_command
= cmd
;
1559 if (!NILP (read_key_sequence_remapped
))
1560 cmd
= read_key_sequence_remapped
;
1562 /* Execute the command. */
1564 Vthis_command
= cmd
;
1565 Vreal_this_command
= cmd
;
1566 safe_run_hooks (Qpre_command_hook
);
1568 already_adjusted
= 0;
1570 if (NILP (Vthis_command
))
1572 /* nil means key is undefined. */
1573 Lisp_Object keys
= Fvector (i
, keybuf
);
1574 keys
= Fkey_description (keys
, Qnil
);
1576 message_with_string ("%s is undefined", keys
, 0);
1577 kset_defining_kbd_macro (current_kboard
, Qnil
);
1578 update_mode_lines
= 1;
1579 /* If this is a down-mouse event, don't reset prefix-arg;
1580 pass it to the command run by the up event. */
1581 if (EVENT_HAS_PARAMETERS (last_command_event
))
1583 Lisp_Object breakdown
1584 = parse_modifiers (EVENT_HEAD (last_command_event
));
1585 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1586 if (!(modifiers
& down_modifier
))
1587 kset_prefix_arg (current_kboard
, Qnil
);
1590 kset_prefix_arg (current_kboard
, Qnil
);
1594 /* Here for a command that isn't executed directly. */
1596 #ifdef HAVE_WINDOW_SYSTEM
1597 ptrdiff_t scount
= SPECPDL_INDEX ();
1599 if (display_hourglass_p
1600 && NILP (Vexecuting_kbd_macro
))
1602 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1607 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1609 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1612 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1613 ? Qnil
: BVAR (current_buffer
, undo_list
));
1615 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1617 #ifdef HAVE_WINDOW_SYSTEM
1618 /* Do not check display_hourglass_p here, because
1619 Fcommand_execute could change it, but we should cancel
1620 hourglass cursor anyway.
1621 But don't cancel the hourglass within a macro
1622 just because a command in the macro finishes. */
1623 if (NILP (Vexecuting_kbd_macro
))
1624 unbind_to (scount
, Qnil
);
1627 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1629 safe_run_hooks (Qpost_command_hook
);
1631 /* If displaying a message, resize the echo area window to fit
1632 that message's size exactly. */
1633 if (!NILP (echo_area_buffer
[0]))
1634 resize_echo_area_exactly ();
1636 /* If there are warnings waiting, process them. */
1637 if (!NILP (Vdelayed_warnings_list
))
1638 safe_run_hooks (Qdelayed_warnings_hook
);
1640 safe_run_hooks (Qdeferred_action_function
);
1642 /* If there is a prefix argument,
1643 1) We don't want Vlast_command to be ``universal-argument''
1644 (that would be dumb), so don't set Vlast_command,
1645 2) we want to leave echoing on so that the prefix will be
1646 echoed as part of this key sequence, so don't call
1648 3) we want to leave this_command_key_count non-zero, so that
1649 read_char will realize that it is re-reading a character, and
1650 not echo it a second time.
1652 If the command didn't actually create a prefix arg,
1653 but is merely a frame event that is transparent to prefix args,
1654 then the above doesn't apply. */
1655 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1656 || CONSP (last_command_event
))
1658 kset_last_command (current_kboard
, Vthis_command
);
1659 kset_real_last_command (current_kboard
, Vreal_this_command
);
1660 if (!CONSP (last_command_event
))
1661 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1663 this_command_key_count
= 0;
1664 this_command_key_count_reset
= 0;
1665 this_single_command_key_start
= 0;
1668 if (!NILP (BVAR (current_buffer
, mark_active
))
1669 && !NILP (Vrun_hooks
))
1671 /* In Emacs 22, setting transient-mark-mode to `only' was a
1672 way of turning it on for just one command. This usage is
1673 obsolete, but support it anyway. */
1674 if (EQ (Vtransient_mark_mode
, Qidentity
))
1675 Vtransient_mark_mode
= Qnil
;
1676 else if (EQ (Vtransient_mark_mode
, Qonly
))
1677 Vtransient_mark_mode
= Qidentity
;
1679 if (!NILP (Vdeactivate_mark
))
1680 /* If `select-active-regions' is non-nil, this call to
1681 `deactivate-mark' also sets the PRIMARY selection. */
1682 call0 (Qdeactivate_mark
);
1685 /* Even if not deactivating the mark, set PRIMARY if
1686 `select-active-regions' is non-nil. */
1687 if (!NILP (Fwindow_system (Qnil
))
1688 /* Even if mark_active is non-nil, the actual buffer
1689 marker may not have been set yet (Bug#7044). */
1690 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1691 && (EQ (Vselect_active_regions
, Qonly
)
1692 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1693 : (!NILP (Vselect_active_regions
)
1694 && !NILP (Vtransient_mark_mode
)))
1695 && NILP (Fmemq (Vthis_command
,
1696 Vselection_inhibit_update_commands
)))
1699 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1702 call2 (Qx_set_selection
, QPRIMARY
,
1703 make_buffer_string (beg
, end
, 0));
1705 call2 (Qx_set_selection
, QPRIMARY
,
1706 make_buffer_string (end
, beg
, 0));
1707 /* Don't set empty selections. */
1710 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1712 Lisp_Object hook
= intern ("activate-mark-hook");
1713 Frun_hooks (1, &hook
);
1717 Vsaved_region_selection
= Qnil
;
1722 if (current_buffer
== prev_buffer
1723 && last_point_position
!= PT
1724 && NILP (Vdisable_point_adjustment
)
1725 && NILP (Vglobal_disable_point_adjustment
))
1727 if (last_point_position
> BEGV
1728 && last_point_position
< ZV
1729 && (composition_adjust_point (last_point_position
,
1730 last_point_position
)
1731 != last_point_position
))
1732 /* The last point was temporarily set within a grapheme
1733 cluster to prevent automatic composition. To recover
1734 the automatic composition, we must update the
1736 windows_or_buffers_changed
++;
1737 if (!already_adjusted
)
1738 adjust_point_for_property (last_point_position
,
1739 MODIFF
!= prev_modiff
);
1742 /* Install chars successfully executed in kbd macro. */
1744 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1745 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1746 finalize_kbd_macro_chars ();
1747 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1749 any_kboard_state ();
1754 /* Adjust point to a boundary of a region that has such a property
1755 that should be treated intangible. For the moment, we check
1756 `composition', `display' and `invisible' properties.
1757 LAST_PT is the last position of point. */
1760 adjust_point_for_property (ptrdiff_t last_pt
, int modified
)
1763 Lisp_Object val
, overlay
, tmp
;
1764 /* When called after buffer modification, we should temporarily
1765 suppress the point adjustment for automatic composition so that a
1766 user can keep inserting another character at point or keep
1767 deleting characters around point. */
1768 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1769 ptrdiff_t orig_pt
= PT
;
1771 /* FIXME: cycling is probably not necessary because these properties
1772 can't be usefully combined anyway. */
1773 while (check_composition
|| check_display
|| check_invisible
)
1775 /* FIXME: check `intangible'. */
1776 if (check_composition
1777 && PT
> BEGV
&& PT
< ZV
1778 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1781 check_display
= check_invisible
= 1;
1783 check_composition
= 0;
1785 && PT
> BEGV
&& PT
< ZV
1786 && !NILP (val
= get_char_property_and_overlay
1787 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1788 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1789 && (!OVERLAYP (overlay
)
1790 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1791 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1792 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1793 && (beg
< PT
/* && end > PT <- It's always the case. */
1794 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1797 SET_PT (PT
< last_pt
1798 ? (STRINGP (val
) && SCHARS (val
) == 0
1799 ? max (beg
- 1, BEGV
)
1802 check_composition
= check_invisible
= 1;
1805 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1807 int inv
, ellipsis
= 0;
1810 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1813 /* FIXME: We should stop if we find a spot between
1814 two runs of `invisible' where inserted text would
1815 be visible. This is important when we have two
1816 invisible boundaries that enclose an area: if the
1817 area is empty, we need this test in order to make
1818 it possible to place point in the middle rather
1819 than skip both boundaries. However, this code
1820 also stops anywhere in a non-sticky text-property,
1821 which breaks (e.g.) Org mode. */
1822 && (val
= get_pos_property (make_number (end
),
1824 TEXT_PROP_MEANS_INVISIBLE (val
))
1826 && !NILP (val
= get_char_property_and_overlay
1827 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1828 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1830 ellipsis
= ellipsis
|| inv
> 1
1831 || (OVERLAYP (overlay
)
1832 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1833 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1834 tmp
= Fnext_single_char_property_change
1835 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1836 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1840 && (val
= get_pos_property (make_number (beg
),
1842 TEXT_PROP_MEANS_INVISIBLE (val
))
1844 && !NILP (val
= get_char_property_and_overlay
1845 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1846 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1848 ellipsis
= ellipsis
|| inv
> 1
1849 || (OVERLAYP (overlay
)
1850 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1851 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1852 tmp
= Fprevious_single_char_property_change
1853 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1854 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1857 /* Move away from the inside area. */
1858 if (beg
< PT
&& end
> PT
)
1860 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1861 /* We haven't moved yet (so we don't need to fear
1862 infinite-looping) and we were outside the range
1863 before (so either end of the range still corresponds
1864 to a move in the right direction): pretend we moved
1865 less than we actually did, so that we still have
1866 more freedom below in choosing which end of the range
1868 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1869 /* We either have moved already or the last point
1870 was already in the range: we don't get to choose
1871 which end of the range we have to go to. */
1872 : (PT
< last_pt
? beg
: end
));
1873 check_composition
= check_display
= 1;
1875 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1876 the point to something other than its argument, due to
1877 point-motion hooks, intangibility, etc. */
1878 eassert (PT
== beg
|| PT
== end
);
1881 /* Pretend the area doesn't exist if the buffer is not
1883 if (!modified
&& !ellipsis
&& beg
< end
)
1885 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1886 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1887 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1888 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1889 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1890 /* We've already moved as far as we can. Trying to go
1891 to the other end would mean moving backwards and thus
1892 could lead to an infinite loop. */
1894 else if (val
= get_pos_property (make_number (PT
),
1896 TEXT_PROP_MEANS_INVISIBLE (val
)
1897 && (val
= get_pos_property
1898 (make_number (PT
== beg
? end
: beg
),
1900 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1901 (check_composition
= check_display
= 1,
1902 SET_PT (PT
== beg
? end
: beg
));
1905 check_invisible
= 0;
1909 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1912 safe_run_hooks_1 (void)
1914 eassert (CONSP (Vinhibit_quit
));
1915 return call0 (XCDR (Vinhibit_quit
));
1918 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1922 safe_run_hooks_error (Lisp_Object error_data
)
1925 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1926 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1927 Lisp_Object args
[4];
1928 args
[0] = build_string ("Error in %s (%s): %S");
1931 args
[3] = error_data
;
1937 Lisp_Object newval
= Qnil
;
1938 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1939 if (EQ (fun
, XCAR (val
)))
1942 newval
= Fcons (XCAR (val
), newval
);
1944 return Fset (hook
, Fnreverse (newval
));
1945 /* Not found in the local part of the hook. Let's look at the global
1948 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1949 : Fdefault_value (hook
));
1950 CONSP (val
); val
= XCDR (val
))
1951 if (EQ (fun
, XCAR (val
)))
1954 newval
= Fcons (XCAR (val
), newval
);
1956 return Fset_default (hook
, Fnreverse (newval
));
1962 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1964 eassert (nargs
== 1);
1965 if (CONSP (Vinhibit_quit
))
1966 XSETCDR (Vinhibit_quit
, args
[0]);
1968 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1970 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1974 /* If we get an error while running the hook, cause the hook variable
1975 to be nil. Also inhibit quits, so that C-g won't cause the hook
1976 to mysteriously evaporate. */
1979 safe_run_hooks (Lisp_Object hook
)
1981 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1982 to its body or to its handlers other than via globals such as
1983 dynamically-bound variables ;-) */
1984 ptrdiff_t count
= SPECPDL_INDEX ();
1985 specbind (Qinhibit_quit
, hook
);
1987 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1989 unbind_to (count
, Qnil
);
1993 /* Nonzero means polling for input is temporarily suppressed. */
1995 int poll_suppress_count
;
1997 /* Asynchronous timer for polling. */
1999 static struct atimer
*poll_timer
;
2002 #ifdef POLL_FOR_INPUT
2004 /* Poll for input, so that we catch a C-g if it comes in. This
2005 function is called from x_make_frame_visible, see comment
2009 poll_for_input_1 (void)
2011 if (interrupt_input_blocked
== 0
2012 && !waiting_for_input
)
2013 read_avail_input ();
2016 /* Timer callback function for poll_timer. TIMER is equal to
2020 poll_for_input (struct atimer
*timer
)
2022 if (poll_suppress_count
== 0)
2024 interrupt_input_pending
= 1;
2025 pending_signals
= 1;
2029 #endif /* POLL_FOR_INPUT */
2031 /* Begin signals to poll for input, if they are appropriate.
2032 This function is called unconditionally from various places. */
2035 start_polling (void)
2037 #ifdef POLL_FOR_INPUT
2038 /* XXX This condition was (read_socket_hook && !interrupt_input),
2039 but read_socket_hook is not global anymore. Let's pretend that
2041 if (!interrupt_input
)
2043 /* Turn alarm handling on unconditionally. It might have
2044 been turned off in process.c. */
2045 turn_on_atimers (1);
2047 /* If poll timer doesn't exist, are we need one with
2048 a different interval, start a new one. */
2049 if (poll_timer
== NULL
2050 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2052 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2053 EMACS_TIME interval
= make_emacs_time (period
, 0);
2056 cancel_atimer (poll_timer
);
2058 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2059 poll_for_input
, NULL
);
2062 /* Let the timer's callback function poll for input
2063 if this becomes zero. */
2064 --poll_suppress_count
;
2069 /* Nonzero if we are using polling to handle input asynchronously. */
2072 input_polling_used (void)
2074 #ifdef POLL_FOR_INPUT
2075 /* XXX This condition was (read_socket_hook && !interrupt_input),
2076 but read_socket_hook is not global anymore. Let's pretend that
2078 return !interrupt_input
;
2084 /* Turn off polling. */
2089 #ifdef POLL_FOR_INPUT
2090 /* XXX This condition was (read_socket_hook && !interrupt_input),
2091 but read_socket_hook is not global anymore. Let's pretend that
2093 if (!interrupt_input
)
2094 ++poll_suppress_count
;
2098 /* Set the value of poll_suppress_count to COUNT
2099 and start or stop polling accordingly. */
2102 set_poll_suppress_count (int count
)
2104 #ifdef POLL_FOR_INPUT
2105 if (count
== 0 && poll_suppress_count
!= 0)
2107 poll_suppress_count
= 1;
2110 else if (count
!= 0 && poll_suppress_count
== 0)
2114 poll_suppress_count
= count
;
2118 /* Bind polling_period to a value at least N.
2119 But don't decrease it. */
2122 bind_polling_period (int n
)
2124 #ifdef POLL_FOR_INPUT
2125 EMACS_INT
new = polling_period
;
2130 stop_other_atimers (poll_timer
);
2132 specbind (Qpolling_period
, make_number (new));
2133 /* Start a new alarm with the new period. */
2138 /* Apply the control modifier to CHARACTER. */
2141 make_ctrl_char (int c
)
2143 /* Save the upper bits here. */
2144 int upper
= c
& ~0177;
2146 if (! ASCII_BYTE_P (c
))
2147 return c
|= ctrl_modifier
;
2151 /* Everything in the columns containing the upper-case letters
2152 denotes a control character. */
2153 if (c
>= 0100 && c
< 0140)
2157 /* Set the shift modifier for a control char
2158 made from a shifted letter. But only for letters! */
2159 if (oc
>= 'A' && oc
<= 'Z')
2160 c
|= shift_modifier
;
2163 /* The lower-case letters denote control characters too. */
2164 else if (c
>= 'a' && c
<= 'z')
2167 /* Include the bits for control and shift
2168 only if the basic ASCII code can't indicate them. */
2172 /* Replace the high bits. */
2173 c
|= (upper
& ~ctrl_modifier
);
2178 /* Display the help-echo property of the character after the mouse pointer.
2179 Either show it in the echo area, or call show-help-function to display
2180 it by other means (maybe in a tooltip).
2182 If HELP is nil, that means clear the previous help echo.
2184 If HELP is a string, display that string. If HELP is a function,
2185 call it with OBJECT and POS as arguments; the function should
2186 return a help string or nil for none. For all other types of HELP,
2187 evaluate it to obtain a string.
2189 WINDOW is the window in which the help was generated, if any.
2190 It is nil if not in a window.
2192 If OBJECT is a buffer, POS is the position in the buffer where the
2193 `help-echo' text property was found.
2195 If OBJECT is an overlay, that overlay has a `help-echo' property,
2196 and POS is the position in the overlay's buffer under the mouse.
2198 If OBJECT is a string (an overlay string or a string displayed with
2199 the `display' property). POS is the position in that string under
2202 Note: this function may only be called with HELP nil or a string
2203 from X code running asynchronously. */
2206 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2209 if (!NILP (help
) && !STRINGP (help
))
2211 if (FUNCTIONP (help
))
2212 help
= safe_call (4, help
, window
, object
, pos
);
2214 help
= safe_eval (help
);
2216 if (!STRINGP (help
))
2220 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2221 if (!noninteractive
&& STRINGP (help
))
2223 /* The mouse-fixup-help-message Lisp function can call
2224 mouse_position_hook, which resets the mouse_moved flags.
2225 This causes trouble if we are trying to read a mouse motion
2226 event (i.e., if we are inside a `track-mouse' form), so we
2227 restore the mouse_moved flag. */
2228 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2229 help
= call1 (Qmouse_fixup_help_message
, help
);
2235 if (STRINGP (help
) || NILP (help
))
2237 if (!NILP (Vshow_help_function
))
2238 call1 (Vshow_help_function
, help
);
2239 help_echo_showing_p
= STRINGP (help
);
2245 /* Input of single characters from keyboard */
2247 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2248 EMACS_TIME
*end_time
);
2249 static void record_char (Lisp_Object c
);
2251 static Lisp_Object help_form_saved_window_configs
;
2253 read_char_help_form_unwind (Lisp_Object arg
)
2255 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2256 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2257 if (!NILP (window_config
))
2258 Fset_window_configuration (window_config
);
2262 #define STOP_POLLING \
2263 do { if (! polling_stopped_here) stop_polling (); \
2264 polling_stopped_here = 1; } while (0)
2266 #define RESUME_POLLING \
2267 do { if (polling_stopped_here) start_polling (); \
2268 polling_stopped_here = 0; } while (0)
2270 /* read a character from the keyboard; call the redisplay if needed */
2271 /* commandflag 0 means do not autosave, but do redisplay.
2272 -1 means do not redisplay, but do autosave.
2275 /* The arguments MAPS and NMAPS are for menu prompting.
2276 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2278 PREV_EVENT is the previous input event, or nil if we are reading
2279 the first event of a key sequence (or not reading a key sequence).
2280 If PREV_EVENT is t, that is a "magic" value that says
2281 not to run input methods, but in other respects to act as if
2282 not reading a key sequence.
2284 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2285 if we used a mouse menu to read the input, or zero otherwise. If
2286 USED_MOUSE_MENU is null, we don't dereference it.
2288 Value is -2 when we find input on another keyboard. A second call
2289 to read_char will read it.
2291 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2292 specifying the maximum time to wait until. If no input arrives by
2293 that time, stop waiting and return nil.
2295 Value is t if we showed a menu and the user rejected it. */
2298 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2299 Lisp_Object prev_event
,
2300 int *used_mouse_menu
, EMACS_TIME
*end_time
)
2302 volatile Lisp_Object c
;
2304 sys_jmp_buf local_getcjmp
;
2305 sys_jmp_buf save_jump
;
2306 volatile int key_already_recorded
= 0;
2307 Lisp_Object tem
, save
;
2308 volatile Lisp_Object previous_echo_area_message
;
2309 volatile Lisp_Object also_record
;
2310 volatile int reread
;
2311 struct gcpro gcpro1
, gcpro2
;
2312 int volatile polling_stopped_here
= 0;
2313 struct kboard
*orig_kboard
= current_kboard
;
2317 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2318 before_command_key_count
= this_command_key_count
;
2319 before_command_echo_length
= echo_length ();
2322 previous_echo_area_message
= Qnil
;
2324 GCPRO2 (c
, previous_echo_area_message
);
2329 if (CONSP (Vunread_post_input_method_events
))
2331 c
= XCAR (Vunread_post_input_method_events
);
2332 Vunread_post_input_method_events
2333 = XCDR (Vunread_post_input_method_events
);
2335 /* Undo what read_char_x_menu_prompt did when it unread
2336 additional keys returned by Fx_popup_menu. */
2338 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2346 if (CONSP (Vunread_command_events
))
2348 int was_disabled
= 0;
2350 c
= XCAR (Vunread_command_events
);
2351 Vunread_command_events
= XCDR (Vunread_command_events
);
2355 /* Undo what sit-for did when it unread additional keys
2356 inside universal-argument. */
2359 && EQ (XCAR (c
), Qt
))
2365 /* Undo what read_char_x_menu_prompt did when it unread
2366 additional keys returned by Fx_popup_menu. */
2368 && EQ (XCDR (c
), Qdisabled
)
2369 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2375 /* If the queued event is something that used the mouse,
2376 set used_mouse_menu accordingly. */
2378 /* Also check was_disabled so last-nonmenu-event won't return
2379 a bad value when submenus are involved. (Bug#447) */
2380 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2381 *used_mouse_menu
= 1;
2383 goto reread_for_input_method
;
2386 if (CONSP (Vunread_input_method_events
))
2388 c
= XCAR (Vunread_input_method_events
);
2389 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2391 /* Undo what read_char_x_menu_prompt did when it unread
2392 additional keys returned by Fx_popup_menu. */
2394 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2398 goto reread_for_input_method
;
2401 this_command_key_count_reset
= 0;
2403 if (!NILP (Vexecuting_kbd_macro
))
2405 /* We set this to Qmacro; since that's not a frame, nobody will
2406 try to switch frames on us, and the selected window will
2409 Since this event came from a macro, it would be misleading to
2410 leave internal_last_event_frame set to wherever the last
2411 real event came from. Normally, a switch-frame event selects
2412 internal_last_event_frame after each command is read, but
2413 events read from a macro should never cause a new frame to be
2415 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2417 /* Exit the macro if we are at the end.
2418 Also, some things replace the macro with t
2419 to force an early exit. */
2420 if (EQ (Vexecuting_kbd_macro
, Qt
)
2421 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2427 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2428 if (STRINGP (Vexecuting_kbd_macro
)
2429 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2430 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2432 executing_kbd_macro_index
++;
2437 if (!NILP (unread_switch_frame
))
2439 c
= unread_switch_frame
;
2440 unread_switch_frame
= Qnil
;
2442 /* This event should make it into this_command_keys, and get echoed
2443 again, so we do not set `reread'. */
2447 /* if redisplay was requested */
2448 if (commandflag
>= 0)
2450 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2452 /* If there is pending input, process any events which are not
2453 user-visible, such as X selection_request events. */
2455 || detect_input_pending_run_timers (0))
2456 swallow_events (0); /* may clear input_pending */
2458 /* Redisplay if no pending input. */
2459 while (!input_pending
)
2461 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2462 redisplay_preserve_echo_area (5);
2467 /* Normal case: no input arrived during redisplay. */
2470 /* Input arrived and pre-empted redisplay.
2471 Process any events which are not user-visible. */
2473 /* If that cleared input_pending, try again to redisplay. */
2476 /* Prevent the redisplay we just did
2477 from messing up echoing of the input after the prompt. */
2478 if (commandflag
== 0 && echo_current
)
2479 echo_message_buffer
= echo_area_buffer
[0];
2483 /* Message turns off echoing unless more keystrokes turn it on again.
2485 The code in 20.x for the condition was
2487 1. echo_area_glyphs && *echo_area_glyphs
2488 2. && echo_area_glyphs != current_kboard->echobuf
2489 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2491 (1) means there's a current message displayed
2493 (2) means it's not the message from echoing from the current
2496 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2497 is set to a non-null value. This is done in read_char and it is
2498 set to echo_area_glyphs after a call to echo_char. That means
2499 ok_to_echo_at_next_pause is either null or
2500 current_kboard->echobuf with the appropriate current_kboard at
2503 So, condition (3) means in clear text ok_to_echo_at_next_pause
2504 must be either null, or the current message isn't from echoing at
2505 all, or it's from echoing from a different kboard than the
2508 if (/* There currently is something in the echo area. */
2509 !NILP (echo_area_buffer
[0])
2510 && (/* And it's either not from echoing. */
2511 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2512 /* Or it's an echo from a different kboard. */
2513 || echo_kboard
!= current_kboard
2514 /* Or we explicitly allow overwriting whatever there is. */
2515 || ok_to_echo_at_next_pause
== NULL
))
2520 /* Try reading a character via menu prompting in the minibuf.
2521 Try this before the sit-for, because the sit-for
2522 would do the wrong thing if we are supposed to do
2523 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2524 after a mouse event so don't try a minibuf menu. */
2526 if (nmaps
> 0 && INTERACTIVE
2527 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2528 /* Don't bring up a menu if we already have another event. */
2529 && NILP (Vunread_command_events
)
2530 && !detect_input_pending_run_timers (0))
2532 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2534 if (INTEGERP (c
) && XINT (c
) == -2)
2535 return c
; /* wrong_kboard_jmpbuf */
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 jmpcount
= SPECPDL_INDEX ();
2551 if (sys_setjmp (local_getcjmp
))
2553 /* Handle quits while reading the keyboard. */
2554 /* We must have saved the outer value of getcjmp here,
2555 so restore it now. */
2556 restore_getcjmp (save_jump
);
2557 unbind_to (jmpcount
, Qnil
);
2558 XSETINT (c
, quit_char
);
2559 internal_last_event_frame
= selected_frame
;
2560 Vlast_event_frame
= internal_last_event_frame
;
2561 /* If we report the quit char as an event,
2562 don't do so more than once. */
2563 if (!NILP (Vinhibit_quit
))
2567 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2568 if (kb
!= current_kboard
)
2570 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2571 /* We shouldn't get here if we were in single-kboard mode! */
2576 while (CONSP (XCDR (last
)))
2578 if (!NILP (XCDR (last
)))
2582 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2584 XSETCDR (last
, Fcons (c
, Qnil
));
2585 kb
->kbd_queue_has_data
= 1;
2586 current_kboard
= kb
;
2587 /* This is going to exit from read_char
2588 so we had better get rid of this frame's stuff. */
2590 return make_number (-2); /* wrong_kboard_jmpbuf */
2596 /* Start idle timers if no time limit is supplied. We don't do it
2597 if a time limit is supplied to avoid an infinite recursion in the
2598 situation where an idle timer calls `sit-for'. */
2601 timer_start_idle ();
2603 /* If in middle of key sequence and minibuffer not active,
2604 start echoing if enough time elapses. */
2606 if (minibuf_level
== 0
2608 && !current_kboard
->immediate_echo
2609 && this_command_key_count
> 0
2611 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2612 && NILP (Fzerop (Vecho_keystrokes
))
2613 && (/* No message. */
2614 NILP (echo_area_buffer
[0])
2615 /* Or empty message. */
2616 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2617 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2618 /* Or already echoing from same kboard. */
2619 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2620 /* Or not echoing before and echoing allowed. */
2621 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2623 /* After a mouse event, start echoing right away.
2624 This is because we are probably about to display a menu,
2625 and we don't want to delay before doing so. */
2626 if (EVENT_HAS_PARAMETERS (prev_event
))
2632 save_getcjmp (save_jump
);
2633 restore_getcjmp (local_getcjmp
);
2634 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2635 restore_getcjmp (save_jump
);
2637 && ! CONSP (Vunread_command_events
))
2642 /* Maybe auto save due to number of keystrokes. */
2644 if (commandflag
!= 0
2645 && auto_save_interval
> 0
2646 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2647 && !detect_input_pending_run_timers (0))
2649 Fdo_auto_save (Qnil
, Qnil
);
2650 /* Hooks can actually change some buffers in auto save. */
2654 /* Try reading using an X menu.
2655 This is never confused with reading using the minibuf
2656 because the recursive call of read_char in read_char_minibuf_menu_prompt
2657 does not pass on any keymaps. */
2659 if (nmaps
> 0 && INTERACTIVE
2660 && !NILP (prev_event
)
2661 && EVENT_HAS_PARAMETERS (prev_event
)
2662 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2663 && !EQ (XCAR (prev_event
), Qtool_bar
)
2664 /* Don't bring up a menu if we already have another event. */
2665 && NILP (Vunread_command_events
))
2667 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2669 /* Now that we have read an event, Emacs is not idle. */
2676 /* Maybe autosave and/or garbage collect due to idleness. */
2678 if (INTERACTIVE
&& NILP (c
))
2681 ptrdiff_t buffer_size
;
2683 /* Slow down auto saves logarithmically in size of current buffer,
2684 and garbage collect while we're at it. */
2685 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2686 last_non_minibuf_size
= Z
- BEG
;
2687 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2689 while (buffer_size
> 64)
2690 delay_level
++, buffer_size
-= buffer_size
>> 2;
2691 if (delay_level
< 4) delay_level
= 4;
2692 /* delay_level is 4 for files under around 50k, 7 at 100k,
2693 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2695 /* Auto save if enough time goes by without input. */
2696 if (commandflag
!= 0
2697 && num_nonmacro_input_events
> last_auto_save
2698 && INTEGERP (Vauto_save_timeout
)
2699 && XINT (Vauto_save_timeout
) > 0)
2702 EMACS_INT timeout
= (delay_level
2703 * min (XFASTINT (Vauto_save_timeout
) / 4,
2704 MOST_POSITIVE_FIXNUM
/ delay_level
));
2705 save_getcjmp (save_jump
);
2706 restore_getcjmp (local_getcjmp
);
2707 tem0
= sit_for (make_number (timeout
), 1, 1);
2708 restore_getcjmp (save_jump
);
2711 && ! CONSP (Vunread_command_events
))
2713 Fdo_auto_save (Qnil
, Qnil
);
2718 /* If there is still no input available, ask for GC. */
2719 if (!detect_input_pending_run_timers (0))
2723 /* Notify the caller if an autosave hook, or a timer, sentinel or
2724 filter in the sit_for calls above have changed the current
2725 kboard. This could happen if they use the minibuffer or start a
2726 recursive edit, like the fancy splash screen in server.el's
2727 filter. If this longjmp wasn't here, read_key_sequence would
2728 interpret the next key sequence using the wrong translation
2729 tables and function keymaps. */
2730 if (NILP (c
) && current_kboard
!= orig_kboard
)
2733 return make_number (-2); /* wrong_kboard_jmpbuf */
2736 /* If this has become non-nil here, it has been set by a timer
2737 or sentinel or filter. */
2738 if (CONSP (Vunread_command_events
))
2740 c
= XCAR (Vunread_command_events
);
2741 Vunread_command_events
= XCDR (Vunread_command_events
);
2744 /* Read something from current KBOARD's side queue, if possible. */
2748 if (current_kboard
->kbd_queue_has_data
)
2750 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2752 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2753 kset_kbd_queue (current_kboard
,
2754 XCDR (KVAR (current_kboard
, kbd_queue
)));
2755 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2756 current_kboard
->kbd_queue_has_data
= 0;
2757 input_pending
= readable_events (0);
2758 if (EVENT_HAS_PARAMETERS (c
)
2759 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2760 internal_last_event_frame
= XCAR (XCDR (c
));
2761 Vlast_event_frame
= internal_last_event_frame
;
2765 /* If current_kboard's side queue is empty check the other kboards.
2766 If one of them has data that we have not yet seen here,
2767 switch to it and process the data waiting for it.
2769 Note: if the events queued up for another kboard
2770 have already been seen here, and therefore are not a complete command,
2771 the kbd_queue_has_data field is 0, so we skip that kboard here.
2772 That's to avoid an infinite loop switching between kboards here. */
2773 if (NILP (c
) && !single_kboard
)
2776 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2777 if (kb
->kbd_queue_has_data
)
2779 current_kboard
= kb
;
2780 /* This is going to exit from read_char
2781 so we had better get rid of this frame's stuff. */
2783 return make_number (-2); /* wrong_kboard_jmpbuf */
2791 /* Finally, we read from the main queue,
2792 and if that gives us something we can't use yet, we put it on the
2793 appropriate side queue and try again. */
2797 KBOARD
*kb
IF_LINT (= NULL
);
2799 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2802 /* Actually read a character, waiting if necessary. */
2803 save_getcjmp (save_jump
);
2804 restore_getcjmp (local_getcjmp
);
2806 timer_start_idle ();
2807 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2808 restore_getcjmp (save_jump
);
2810 if (! NILP (c
) && (kb
!= current_kboard
))
2812 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2815 while (CONSP (XCDR (last
)))
2817 if (!NILP (XCDR (last
)))
2821 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2823 XSETCDR (last
, Fcons (c
, Qnil
));
2824 kb
->kbd_queue_has_data
= 1;
2828 current_kboard
= kb
;
2829 /* This is going to exit from read_char
2830 so we had better get rid of this frame's stuff. */
2832 return make_number (-2);
2836 /* Terminate Emacs in batch mode if at eof. */
2837 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2838 Fkill_emacs (make_number (1));
2842 /* Add in any extra modifiers, where appropriate. */
2843 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2844 || ((extra_keyboard_modifiers
& 0177) < ' '
2845 && (extra_keyboard_modifiers
& 0177) != 0))
2846 XSETINT (c
, make_ctrl_char (XINT (c
)));
2848 /* Transfer any other modifier bits directly from
2849 extra_keyboard_modifiers to c. Ignore the actual character code
2850 in the low 16 bits of extra_keyboard_modifiers. */
2851 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2862 if (commandflag
>= 0
2863 && !input_pending
&& !detect_input_pending_run_timers (0))
2871 /* Buffer switch events are only for internal wakeups
2872 so don't show them to the user.
2873 Also, don't record a key if we already did. */
2874 if (BUFFERP (c
) || key_already_recorded
)
2877 /* Process special events within read_char
2878 and loop around to read another event. */
2881 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2886 struct buffer
*prev_buffer
= current_buffer
;
2887 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2888 int was_locked
= single_kboard
;
2889 ptrdiff_t count
= SPECPDL_INDEX ();
2890 record_single_kboard_state ();
2893 last_input_event
= c
;
2894 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2896 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2897 /* We stopped being idle for this event; undo that. This
2898 prevents automatic window selection (under
2899 mouse_autoselect_window from acting as a real input event, for
2900 example banishing the mouse under mouse-avoidance-mode. */
2901 timer_resume_idle ();
2903 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2904 /* Resume allowing input from any kboard, if that was true before. */
2906 any_kboard_state ();
2907 unbind_to (count
, Qnil
);
2910 if (current_buffer
!= prev_buffer
)
2912 /* The command may have changed the keymaps. Pretend there
2913 is input in another keyboard and return. This will
2914 recalculate keymaps. */
2915 c
= make_number (-2);
2922 /* Handle things that only apply to characters. */
2925 /* If kbd_buffer_get_event gave us an EOF, return that. */
2929 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2930 && UNSIGNED_CMP (XFASTINT (c
), <,
2931 SCHARS (KVAR (current_kboard
,
2932 Vkeyboard_translate_table
))))
2933 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2934 && UNSIGNED_CMP (XFASTINT (c
), <,
2935 ASIZE (KVAR (current_kboard
,
2936 Vkeyboard_translate_table
))))
2937 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2941 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2942 /* nil in keyboard-translate-table means no translation. */
2948 /* If this event is a mouse click in the menu bar,
2949 return just menu-bar for now. Modify the mouse click event
2950 so we won't do this twice, then queue it up. */
2951 if (EVENT_HAS_PARAMETERS (c
)
2953 && CONSP (EVENT_START (c
))
2954 && CONSP (XCDR (EVENT_START (c
))))
2958 posn
= POSN_POSN (EVENT_START (c
));
2959 /* Handle menu-bar events:
2960 insert the dummy prefix event `menu-bar'. */
2961 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2963 /* Change menu-bar to (menu-bar) as the event "position". */
2964 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2967 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2972 /* Store these characters into recent_keys, the dribble file if any,
2973 and the keyboard macro being defined, if any. */
2975 if (! NILP (also_record
))
2976 record_char (also_record
);
2978 /* Wipe the echo area.
2979 But first, if we are about to use an input method,
2980 save the echo area contents for it to refer to. */
2982 && ! NILP (Vinput_method_function
)
2983 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2985 previous_echo_area_message
= Fcurrent_message ();
2986 Vinput_method_previous_message
= previous_echo_area_message
;
2989 /* Now wipe the echo area, except for help events which do their
2990 own stuff with the echo area. */
2992 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2993 && !(EQ (Qswitch_frame
, XCAR (c
)))
2994 /* Don't wipe echo area for select window events: These might
2995 get delayed via `mouse-autoselect-window' (Bug#11304). */
2996 && !(EQ (Qselect_window
, XCAR (c
)))))
2998 if (!NILP (echo_area_buffer
[0]))
3000 safe_run_hooks (Qecho_area_clear_hook
);
3001 clear_message (1, 0);
3005 reread_for_input_method
:
3007 /* Pass this to the input method, if appropriate. */
3009 && ! NILP (Vinput_method_function
)
3010 /* Don't run the input method within a key sequence,
3011 after the first event of the key sequence. */
3012 && NILP (prev_event
)
3013 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3016 ptrdiff_t key_count
;
3017 int key_count_reset
;
3018 struct gcpro gcpro1
;
3019 ptrdiff_t count
= SPECPDL_INDEX ();
3021 /* Save the echo status. */
3022 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3023 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3024 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3025 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3028 if (before_command_restore_flag
)
3030 this_command_key_count
= before_command_key_count_1
;
3031 if (this_command_key_count
< this_single_command_key_start
)
3032 this_single_command_key_start
= this_command_key_count
;
3033 echo_truncate (before_command_echo_length_1
);
3034 before_command_restore_flag
= 0;
3038 /* Save the this_command_keys status. */
3039 key_count
= this_command_key_count
;
3040 key_count_reset
= this_command_key_count_reset
;
3043 keys
= Fcopy_sequence (this_command_keys
);
3048 /* Clear out this_command_keys. */
3049 this_command_key_count
= 0;
3050 this_command_key_count_reset
= 0;
3052 /* Now wipe the echo area. */
3053 if (!NILP (echo_area_buffer
[0]))
3054 safe_run_hooks (Qecho_area_clear_hook
);
3055 clear_message (1, 0);
3058 /* If we are not reading a key sequence,
3059 never use the echo area. */
3062 specbind (Qinput_method_use_echo_area
, Qt
);
3065 /* Call the input method. */
3066 tem
= call1 (Vinput_method_function
, c
);
3068 tem
= unbind_to (count
, tem
);
3070 /* Restore the saved echoing state
3071 and this_command_keys state. */
3072 this_command_key_count
= key_count
;
3073 this_command_key_count_reset
= key_count_reset
;
3075 this_command_keys
= keys
;
3078 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3079 kset_echo_string (current_kboard
, saved_echo_string
);
3080 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3081 if (saved_immediate_echo
)
3086 /* The input method can return no events. */
3089 /* Bring back the previous message, if any. */
3090 if (! NILP (previous_echo_area_message
))
3091 message_with_string ("%s", previous_echo_area_message
, 0);
3094 /* It returned one event or more. */
3096 Vunread_post_input_method_events
3097 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3102 /* Display help if not echoing. */
3103 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3105 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3106 Lisp_Object help
, object
, position
, window
, htem
;
3108 htem
= Fcdr (XCDR (c
));
3111 window
= Fcar (htem
);
3113 object
= Fcar (htem
);
3115 position
= Fcar (htem
);
3117 show_help_echo (help
, window
, object
, position
);
3119 /* We stopped being idle for this event; undo that. */
3121 timer_resume_idle ();
3125 if ((! reread
|| this_command_key_count
== 0
3126 || this_command_key_count_reset
)
3130 /* Don't echo mouse motion events. */
3131 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3132 && NILP (Fzerop (Vecho_keystrokes
))
3133 && ! (EVENT_HAS_PARAMETERS (c
)
3134 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3137 if (! NILP (also_record
))
3138 echo_char (also_record
);
3139 /* Once we reread a character, echoing can happen
3140 the next time we pause to read a new one. */
3141 ok_to_echo_at_next_pause
= current_kboard
;
3144 /* Record this character as part of the current key. */
3145 add_command_key (c
);
3146 if (! NILP (also_record
))
3147 add_command_key (also_record
);
3150 last_input_event
= c
;
3153 /* Process the help character specially if enabled */
3154 if (!NILP (Vhelp_form
) && help_char_p (c
))
3156 ptrdiff_t count
= SPECPDL_INDEX ();
3158 help_form_saved_window_configs
3159 = Fcons (Fcurrent_window_configuration (Qnil
),
3160 help_form_saved_window_configs
);
3161 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3162 call0 (Qhelp_form_show
);
3167 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3168 if (EVENT_HAS_PARAMETERS (c
)
3169 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3170 XSETCAR (help_form_saved_window_configs
, Qnil
);
3172 while (BUFFERP (c
));
3173 /* Remove the help from the frame */
3174 unbind_to (count
, Qnil
);
3177 if (EQ (c
, make_number (040)))
3181 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3182 while (BUFFERP (c
));
3191 /* Record a key that came from a mouse menu.
3192 Record it for echoing, for this-command-keys, and so on. */
3195 record_menu_key (Lisp_Object c
)
3197 /* Wipe the echo area. */
3198 clear_message (1, 0);
3203 before_command_key_count
= this_command_key_count
;
3204 before_command_echo_length
= echo_length ();
3207 /* Don't echo mouse motion events. */
3208 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3209 && NILP (Fzerop (Vecho_keystrokes
)))
3213 /* Once we reread a character, echoing can happen
3214 the next time we pause to read a new one. */
3215 ok_to_echo_at_next_pause
= 0;
3218 /* Record this character as part of the current key. */
3219 add_command_key (c
);
3221 /* Re-reading in the middle of a command */
3222 last_input_event
= c
;
3226 /* Return 1 if should recognize C as "the help character". */
3229 help_char_p (Lisp_Object c
)
3233 if (EQ (c
, Vhelp_char
))
3235 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3236 if (EQ (c
, XCAR (tail
)))
3241 /* Record the input event C in various ways. */
3244 record_char (Lisp_Object c
)
3248 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3250 /* To avoid filling recent_keys with help-echo and mouse-movement
3251 events, we filter out repeated help-echo events, only store the
3252 first and last in a series of mouse-movement events, and don't
3253 store repeated help-echo events which are only separated by
3254 mouse-movement events. */
3256 Lisp_Object ev1
, ev2
, ev3
;
3259 if ((ix1
= recent_keys_index
- 1) < 0)
3260 ix1
= NUM_RECENT_KEYS
- 1;
3261 ev1
= AREF (recent_keys
, ix1
);
3263 if ((ix2
= ix1
- 1) < 0)
3264 ix2
= NUM_RECENT_KEYS
- 1;
3265 ev2
= AREF (recent_keys
, ix2
);
3267 if ((ix3
= ix2
- 1) < 0)
3268 ix3
= NUM_RECENT_KEYS
- 1;
3269 ev3
= AREF (recent_keys
, ix3
);
3271 if (EQ (XCAR (c
), Qhelp_echo
))
3273 /* Don't record `help-echo' in recent_keys unless it shows some help
3274 message, and a different help than the previously recorded
3276 Lisp_Object help
, last_help
;
3278 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3279 if (!STRINGP (help
))
3281 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3282 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3284 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3285 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3286 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3288 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3289 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3290 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3291 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3294 else if (EQ (XCAR (c
), Qmouse_movement
))
3296 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3297 So additional mouse movement events replace the last element. */
3298 Lisp_Object last_window
, window
;
3300 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3301 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3302 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3303 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3304 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3306 ASET (recent_keys
, ix1
, c
);
3312 store_kbd_macro_char (c
);
3316 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3317 ASET (recent_keys
, recent_keys_index
, c
);
3318 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3319 recent_keys_index
= 0;
3321 else if (recorded
< 0)
3323 /* We need to remove one or two events from recent_keys.
3324 To do this, we simply put nil at those events and move the
3325 recent_keys_index backwards over those events. Usually,
3326 users will never see those nil events, as they will be
3327 overwritten by the command keys entered to see recent_keys
3330 while (recorded
++ < 0 && total_keys
> 0)
3332 if (total_keys
< NUM_RECENT_KEYS
)
3334 if (--recent_keys_index
< 0)
3335 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3336 ASET (recent_keys
, recent_keys_index
, Qnil
);
3340 num_nonmacro_input_events
++;
3342 /* Write c to the dribble file. If c is a lispy event, write
3343 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3344 If you, dear reader, have a better idea, you've got the source. :-) */
3350 if (XUINT (c
) < 0x100)
3351 putc (XUINT (c
), dribble
);
3353 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3357 Lisp_Object dribblee
;
3359 /* If it's a structured event, take the event header. */
3360 dribblee
= EVENT_HEAD (c
);
3362 if (SYMBOLP (dribblee
))
3364 putc ('<', dribble
);
3365 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3366 SBYTES (SYMBOL_NAME (dribblee
)),
3368 putc ('>', dribble
);
3377 /* Copy out or in the info on where C-g should throw to.
3378 This is used when running Lisp code from within get_char,
3379 in case get_char is called recursively.
3380 See read_process_output. */
3383 save_getcjmp (sys_jmp_buf temp
)
3385 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3389 restore_getcjmp (sys_jmp_buf temp
)
3391 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3394 /* Low level keyboard/mouse input.
3395 kbd_buffer_store_event places events in kbd_buffer, and
3396 kbd_buffer_get_event retrieves them. */
3398 /* Return true if there are any events in the queue that read-char
3399 would return. If this returns false, a read-char would block. */
3401 readable_events (int flags
)
3403 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3406 /* If the buffer contains only FOCUS_IN_EVENT events, and
3407 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3408 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3410 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3411 #ifdef USE_TOOLKIT_SCROLL_BARS
3412 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3416 struct input_event
*event
;
3418 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3425 #ifdef USE_TOOLKIT_SCROLL_BARS
3426 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3428 event
->kind
== FOCUS_IN_EVENT
)
3429 #ifdef USE_TOOLKIT_SCROLL_BARS
3430 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3431 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3432 && event
->part
== scroll_bar_handle
3433 && event
->modifiers
== 0)
3438 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3441 while (event
!= kbd_store_ptr
);
3447 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3448 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3449 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3454 if (current_kboard
->kbd_queue_has_data
)
3460 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3461 if (kb
->kbd_queue_has_data
)
3467 /* Set this for debugging, to have a way to get out */
3468 int stop_character EXTERNALLY_VISIBLE
;
3471 event_to_kboard (struct input_event
*event
)
3474 frame
= event
->frame_or_window
;
3476 frame
= XCAR (frame
);
3477 else if (WINDOWP (frame
))
3478 frame
= WINDOW_FRAME (XWINDOW (frame
));
3480 /* There are still some events that don't set this field.
3481 For now, just ignore the problem.
3482 Also ignore dead frames here. */
3483 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3486 return FRAME_KBOARD (XFRAME (frame
));
3490 /* Return the number of slots occupied in kbd_buffer. */
3493 kbd_buffer_nr_stored (void)
3495 return kbd_fetch_ptr
== kbd_store_ptr
3497 : (kbd_fetch_ptr
< kbd_store_ptr
3498 ? kbd_store_ptr
- kbd_fetch_ptr
3499 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3500 + (kbd_store_ptr
- kbd_buffer
)));
3502 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3505 kbd_buffer_store_event (register struct input_event
*event
)
3507 kbd_buffer_store_event_hold (event
, 0);
3510 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3512 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3513 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3514 Else, if EVENT is a quit event, store the quit event
3515 in HOLD_QUIT, and return (thus ignoring further events).
3517 This is used in read_avail_input to postpone the processing
3518 of the quit event until all subsequent input events have been
3519 parsed (and discarded).
3523 kbd_buffer_store_event_hold (register struct input_event
*event
,
3524 struct input_event
*hold_quit
)
3526 if (event
->kind
== NO_EVENT
)
3529 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3532 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3534 register int c
= event
->code
& 0377;
3536 if (event
->modifiers
& ctrl_modifier
)
3537 c
= make_ctrl_char (c
);
3539 c
|= (event
->modifiers
3540 & (meta_modifier
| alt_modifier
3541 | hyper_modifier
| super_modifier
));
3545 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3546 struct input_event
*sp
;
3548 if (single_kboard
&& kb
!= current_kboard
)
3551 (kb
, Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3552 Fcons (make_number (c
), Qnil
)));
3553 kb
->kbd_queue_has_data
= 1;
3554 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3556 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3559 if (event_to_kboard (sp
) == kb
)
3561 sp
->kind
= NO_EVENT
;
3562 sp
->frame_or_window
= Qnil
;
3571 *hold_quit
= *event
;
3575 /* If this results in a quit_char being returned to Emacs as
3576 input, set Vlast_event_frame properly. If this doesn't
3577 get returned to Emacs as an event, the next event read
3578 will set Vlast_event_frame again, so this is safe to do. */
3582 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3584 focus
= event
->frame_or_window
;
3585 internal_last_event_frame
= focus
;
3586 Vlast_event_frame
= focus
;
3589 last_event_timestamp
= event
->timestamp
;
3590 handle_interrupt ();
3594 if (c
&& c
== stop_character
)
3600 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3601 Just ignore the second one. */
3602 else if (event
->kind
== BUFFER_SWITCH_EVENT
3603 && kbd_fetch_ptr
!= kbd_store_ptr
3604 && ((kbd_store_ptr
== kbd_buffer
3605 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3606 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3609 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3610 kbd_store_ptr
= kbd_buffer
;
3612 /* Don't let the very last slot in the buffer become full,
3613 since that would make the two pointers equal,
3614 and that is indistinguishable from an empty buffer.
3615 Discard the event if it would fill the last slot. */
3616 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3618 *kbd_store_ptr
= *event
;
3621 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3623 /* Don't read keyboard input until we have processed kbd_buffer.
3624 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3625 hold_keyboard_input ();
3626 if (!noninteractive
)
3630 #endif /* subprocesses */
3633 /* If we're inside while-no-input, and this event qualifies
3634 as input, set quit-flag to cause an interrupt. */
3635 if (!NILP (Vthrow_on_input
)
3636 && event
->kind
!= FOCUS_IN_EVENT
3637 && event
->kind
!= HELP_EVENT
3638 && event
->kind
!= DEICONIFY_EVENT
)
3640 Vquit_flag
= Vthrow_on_input
;
3641 /* If we're inside a function that wants immediate quits,
3643 if (immediate_quit
&& NILP (Vinhibit_quit
))
3646 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
3653 /* Put an input event back in the head of the event queue. */
3656 kbd_buffer_unget_event (register struct input_event
*event
)
3658 if (kbd_fetch_ptr
== kbd_buffer
)
3659 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3661 /* Don't let the very last slot in the buffer become full, */
3662 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3665 *kbd_fetch_ptr
= *event
;
3670 /* Generate a HELP_EVENT input_event and store it in the keyboard
3673 HELP is the help form.
3675 FRAME and WINDOW are the frame and window where the help is
3676 generated. OBJECT is the Lisp object where the help was found (a
3677 buffer, a string, an overlay, or nil if neither from a string nor
3678 from a buffer). POS is the position within OBJECT where the help
3682 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3683 Lisp_Object object
, ptrdiff_t pos
)
3685 struct input_event event
;
3689 event
.kind
= HELP_EVENT
;
3690 event
.frame_or_window
= frame
;
3692 event
.x
= WINDOWP (window
) ? window
: frame
;
3695 kbd_buffer_store_event (&event
);
3699 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3702 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3704 struct input_event event
;
3706 event
.kind
= HELP_EVENT
;
3707 event
.frame_or_window
= frame
;
3712 kbd_buffer_store_event (&event
);
3716 /* Discard any mouse events in the event buffer by setting them to
3719 discard_mouse_events (void)
3721 struct input_event
*sp
;
3722 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3724 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3727 if (sp
->kind
== MOUSE_CLICK_EVENT
3728 || sp
->kind
== WHEEL_EVENT
3729 || sp
->kind
== HORIZ_WHEEL_EVENT
3731 || sp
->kind
== GPM_CLICK_EVENT
3733 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3735 sp
->kind
= NO_EVENT
;
3741 /* Return non-zero if there are any real events waiting in the event
3742 buffer, not counting `NO_EVENT's.
3744 If DISCARD is non-zero, discard NO_EVENT events at the front of
3745 the input queue, possibly leaving the input queue empty if there
3746 are no real input events. */
3749 kbd_buffer_events_waiting (int discard
)
3751 struct input_event
*sp
;
3753 for (sp
= kbd_fetch_ptr
;
3754 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3757 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3764 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3768 /* Clear input event EVENT. */
3771 clear_event (struct input_event
*event
)
3773 event
->kind
= NO_EVENT
;
3777 /* Read one event from the event buffer, waiting if necessary.
3778 The value is a Lisp object representing the event.
3779 The value is nil for an event that should be ignored,
3780 or that was handled here.
3781 We always read and discard one event. */
3784 kbd_buffer_get_event (KBOARD
**kbp
,
3785 int *used_mouse_menu
,
3786 EMACS_TIME
*end_time
)
3791 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3793 /* Start reading input again, we have processed enough so we can
3794 accept new events again. */
3795 unhold_keyboard_input ();
3797 if (!noninteractive
)
3799 struct sigaction action
;
3800 emacs_sigaction_init (&action
, deliver_input_available_signal
);
3801 sigaction (SIGIO
, &action
, 0);
3806 #endif /* subprocesses */
3808 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3810 /* In case we are running as a daemon, only do this before
3811 detaching from the terminal. */
3812 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3816 *kbp
= current_kboard
;
3819 #endif /* ! HAVE_DBUS */
3821 /* Wait until there is input available. */
3824 /* Break loop if there's an unread command event. Needed in
3825 moused window autoselection which uses a timer to insert such
3827 if (CONSP (Vunread_command_events
))
3830 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3832 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3833 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3837 /* If the quit flag is set, then read_char will return
3838 quit_char, so that counts as "available input." */
3839 if (!NILP (Vquit_flag
))
3840 quit_throw_to_read_char (0);
3842 /* One way or another, wait until input is available; then, if
3843 interrupt handlers have not read it, read it now. */
3848 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3850 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3851 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3856 EMACS_TIME now
= current_emacs_time ();
3857 if (EMACS_TIME_LE (*end_time
, now
))
3858 return Qnil
; /* Finished waiting. */
3861 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3862 wait_reading_process_output (min (EMACS_SECS (duration
),
3864 EMACS_NSECS (duration
),
3865 -1, 1, Qnil
, NULL
, 0);
3869 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3871 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3872 read_avail_input ();
3875 if (CONSP (Vunread_command_events
))
3878 first
= XCAR (Vunread_command_events
);
3879 Vunread_command_events
= XCDR (Vunread_command_events
);
3880 *kbp
= current_kboard
;
3884 /* At this point, we know that there is a readable event available
3885 somewhere. If the event queue is empty, then there must be a
3886 mouse movement enabled and available. */
3887 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3889 struct input_event
*event
;
3891 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3895 last_event_timestamp
= event
->timestamp
;
3897 *kbp
= event_to_kboard (event
);
3899 *kbp
= current_kboard
; /* Better than returning null ptr? */
3903 /* These two kinds of events get special handling
3904 and don't actually appear to the command loop.
3905 We return nil for them. */
3906 if (event
->kind
== SELECTION_REQUEST_EVENT
3907 || event
->kind
== SELECTION_CLEAR_EVENT
)
3910 struct input_event copy
;
3912 /* Remove it from the buffer before processing it,
3913 since otherwise swallow_events will see it
3914 and process it again. */
3916 kbd_fetch_ptr
= event
+ 1;
3917 input_pending
= readable_events (0);
3918 x_handle_selection_event (©
);
3920 /* We're getting selection request events, but we don't have
3926 #if defined (HAVE_NS)
3927 else if (event
->kind
== NS_TEXT_EVENT
)
3929 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3930 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3932 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3933 kbd_fetch_ptr
= event
+ 1;
3934 if (used_mouse_menu
)
3935 *used_mouse_menu
= 1;
3939 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3940 || defined (HAVE_NS)
3941 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3943 /* Make an event (delete-frame (FRAME)). */
3944 obj
= Fcons (event
->frame_or_window
, Qnil
);
3945 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3946 kbd_fetch_ptr
= event
+ 1;
3949 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3950 || defined (HAVE_NS)
3951 else if (event
->kind
== ICONIFY_EVENT
)
3953 /* Make an event (iconify-frame (FRAME)). */
3954 obj
= Fcons (event
->frame_or_window
, Qnil
);
3955 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3956 kbd_fetch_ptr
= event
+ 1;
3958 else if (event
->kind
== DEICONIFY_EVENT
)
3960 /* Make an event (make-frame-visible (FRAME)). */
3961 obj
= Fcons (event
->frame_or_window
, Qnil
);
3962 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3963 kbd_fetch_ptr
= event
+ 1;
3966 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3968 /* The value doesn't matter here; only the type is tested. */
3969 XSETBUFFER (obj
, current_buffer
);
3970 kbd_fetch_ptr
= event
+ 1;
3972 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3973 || defined (HAVE_NS) || defined (USE_GTK)
3974 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3976 kbd_fetch_ptr
= event
+ 1;
3977 input_pending
= readable_events (0);
3978 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3979 x_activate_menubar (XFRAME (event
->frame_or_window
));
3982 #if defined (WINDOWSNT)
3983 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3985 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
3986 obj
= Fcons (Qlanguage_change
,
3987 list3 (event
->frame_or_window
,
3988 make_number (event
->code
),
3989 make_number (event
->modifiers
)));
3990 kbd_fetch_ptr
= event
+ 1;
3993 else if (event
->kind
== SAVE_SESSION_EVENT
)
3995 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3996 kbd_fetch_ptr
= event
+ 1;
3998 /* Just discard these, by returning nil.
3999 With MULTI_KBOARD, these events are used as placeholders
4000 when we need to randomly delete events from the queue.
4001 (They shouldn't otherwise be found in the buffer,
4002 but on some machines it appears they do show up
4003 even without MULTI_KBOARD.) */
4004 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4005 mouse events during a popup-menu call. */
4006 else if (event
->kind
== NO_EVENT
)
4007 kbd_fetch_ptr
= event
+ 1;
4008 else if (event
->kind
== HELP_EVENT
)
4010 Lisp_Object object
, position
, help
, frame
, window
;
4012 frame
= event
->frame_or_window
;
4013 object
= event
->arg
;
4014 position
= make_number (event
->code
);
4017 clear_event (event
);
4019 kbd_fetch_ptr
= event
+ 1;
4020 if (!WINDOWP (window
))
4022 obj
= Fcons (Qhelp_echo
,
4023 list5 (frame
, help
, window
, object
, position
));
4025 else if (event
->kind
== FOCUS_IN_EVENT
)
4027 /* Notification of a FocusIn event. The frame receiving the
4028 focus is in event->frame_or_window. Generate a
4029 switch-frame event if necessary. */
4030 Lisp_Object frame
, focus
;
4032 frame
= event
->frame_or_window
;
4033 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4037 if (!EQ (frame
, internal_last_event_frame
)
4038 && !EQ (frame
, selected_frame
))
4039 obj
= make_lispy_switch_frame (frame
);
4040 internal_last_event_frame
= frame
;
4041 kbd_fetch_ptr
= event
+ 1;
4044 else if (event
->kind
== DBUS_EVENT
)
4046 obj
= make_lispy_event (event
);
4047 kbd_fetch_ptr
= event
+ 1;
4050 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4052 obj
= make_lispy_event (event
);
4053 kbd_fetch_ptr
= event
+ 1;
4057 /* If this event is on a different frame, return a switch-frame this
4058 time, and leave the event in the queue for next time. */
4062 frame
= event
->frame_or_window
;
4064 frame
= XCAR (frame
);
4065 else if (WINDOWP (frame
))
4066 frame
= WINDOW_FRAME (XWINDOW (frame
));
4068 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4072 if (! EQ (frame
, internal_last_event_frame
)
4073 && !EQ (frame
, selected_frame
))
4074 obj
= make_lispy_switch_frame (frame
);
4075 internal_last_event_frame
= frame
;
4077 /* If we didn't decide to make a switch-frame event, go ahead
4078 and build a real event from the queue entry. */
4082 obj
= make_lispy_event (event
);
4084 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4085 || defined (HAVE_NS) || defined (USE_GTK)
4086 /* If this was a menu selection, then set the flag to inhibit
4087 writing to last_nonmenu_event. Don't do this if the event
4088 we're returning is (menu-bar), though; that indicates the
4089 beginning of the menu sequence, and we might as well leave
4090 that as the `event with parameters' for this selection. */
4092 && !EQ (event
->frame_or_window
, event
->arg
)
4093 && (event
->kind
== MENU_BAR_EVENT
4094 || event
->kind
== TOOL_BAR_EVENT
))
4095 *used_mouse_menu
= 1;
4098 /* Certain system events are non-key events. */
4100 && event
->kind
== NS_NONKEY_EVENT
)
4101 *used_mouse_menu
= 1;
4104 /* Wipe out this event, to catch bugs. */
4105 clear_event (event
);
4106 kbd_fetch_ptr
= event
+ 1;
4110 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4111 /* Try generating a mouse motion event. */
4112 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4114 FRAME_PTR f
= some_mouse_moved ();
4115 Lisp_Object bar_window
;
4116 enum scroll_bar_part part
;
4120 *kbp
= current_kboard
;
4121 /* Note that this uses F to determine which terminal to look at.
4122 If there is no valid info, it does not store anything
4123 so x remains nil. */
4126 /* XXX Can f or mouse_position_hook be NULL here? */
4127 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4128 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4133 /* Decide if we should generate a switch-frame event. Don't
4134 generate switch-frame events for motion outside of all Emacs
4140 frame
= FRAME_FOCUS_FRAME (f
);
4142 XSETFRAME (frame
, f
);
4144 if (! EQ (frame
, internal_last_event_frame
)
4145 && !EQ (frame
, selected_frame
))
4146 obj
= make_lispy_switch_frame (frame
);
4147 internal_last_event_frame
= frame
;
4150 /* If we didn't decide to make a switch-frame event, go ahead and
4151 return a mouse-motion event. */
4152 if (!NILP (x
) && NILP (obj
))
4153 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4155 #endif /* HAVE_MOUSE || HAVE GPM */
4157 /* We were promised by the above while loop that there was
4158 something for us to read! */
4161 input_pending
= readable_events (0);
4163 Vlast_event_frame
= internal_last_event_frame
;
4168 /* Process any non-user-visible events (currently X selection events),
4169 without reading any user-visible events. */
4172 process_special_events (void)
4174 struct input_event
*event
;
4176 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4178 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4181 if (event
== kbd_store_ptr
)
4185 /* If we find a stored X selection request, handle it now. */
4186 if (event
->kind
== SELECTION_REQUEST_EVENT
4187 || event
->kind
== SELECTION_CLEAR_EVENT
)
4191 /* Remove the event from the fifo buffer before processing;
4192 otherwise swallow_events called recursively could see it
4193 and process it again. To do this, we move the events
4194 between kbd_fetch_ptr and EVENT one slot to the right,
4197 struct input_event copy
= *event
;
4198 struct input_event
*beg
4199 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4200 ? kbd_buffer
: kbd_fetch_ptr
;
4203 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4204 else if (event
< beg
)
4206 if (event
> kbd_buffer
)
4207 memmove (kbd_buffer
+ 1, kbd_buffer
,
4208 (event
- kbd_buffer
) * sizeof (struct input_event
));
4209 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4210 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4211 memmove (beg
+ 1, beg
,
4212 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4213 * sizeof (struct input_event
));
4216 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4217 kbd_fetch_ptr
= kbd_buffer
+ 1;
4221 /* X wants last_event_timestamp for selection ownership. */
4222 last_event_timestamp
= copy
.timestamp
;
4223 input_pending
= readable_events (0);
4224 x_handle_selection_event (©
);
4226 /* We're getting selection request events, but we don't have
4234 /* Process any events that are not user-visible, run timer events that
4235 are ripe, and return, without reading any user-visible events. */
4238 swallow_events (int do_display
)
4242 process_special_events ();
4244 old_timers_run
= timers_run
;
4245 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4247 if (timers_run
!= old_timers_run
&& do_display
)
4248 redisplay_preserve_echo_area (7);
4251 /* Record the start of when Emacs is idle,
4252 for the sake of running idle-time timers. */
4255 timer_start_idle (void)
4259 /* If we are already in the idle state, do nothing. */
4260 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4263 timer_idleness_start_time
= current_emacs_time ();
4264 timer_last_idleness_start_time
= timer_idleness_start_time
;
4266 /* Mark all idle-time timers as once again candidates for running. */
4267 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4271 timer
= XCAR (timers
);
4273 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4275 ASET (timer
, 0, Qnil
);
4279 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4282 timer_stop_idle (void)
4284 timer_idleness_start_time
= invalid_emacs_time ();
4287 /* Resume idle timer from last idle start time. */
4290 timer_resume_idle (void)
4292 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4295 timer_idleness_start_time
= timer_last_idleness_start_time
;
4298 /* This is only for debugging. */
4299 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4301 /* List of elisp functions to call, delayed because they were generated in
4302 a context where Elisp could not be safely run (e.g. redisplay, signal,
4303 ...). Each element has the form (FUN . ARGS). */
4304 Lisp_Object pending_funcalls
;
4306 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4308 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4310 Lisp_Object
*vector
;
4312 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4314 vector
= XVECTOR (timer
)->contents
;
4315 if (! NILP (vector
[0]))
4318 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4323 /* Check whether a timer has fired. To prevent larger problems we simply
4324 disregard elements that are not proper timers. Do not make a circular
4325 timer list for the time being.
4327 Returns the time to wait until the next timer fires. If a
4328 timer is triggering now, return zero.
4329 If no timer is active, return -1.
4331 If a timer is ripe, we run it, with quitting turned off.
4332 In that case we return 0 to indicate that a new timer_check_2 call
4336 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4338 EMACS_TIME nexttime
;
4340 EMACS_TIME idleness_now
;
4341 Lisp_Object chosen_timer
;
4342 struct gcpro gcpro1
;
4344 nexttime
= invalid_emacs_time ();
4346 chosen_timer
= Qnil
;
4347 GCPRO1 (chosen_timer
);
4349 /* First run the code that was delayed. */
4350 while (CONSP (pending_funcalls
))
4352 Lisp_Object funcall
= XCAR (pending_funcalls
);
4353 pending_funcalls
= XCDR (pending_funcalls
);
4354 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4357 if (CONSP (timers
) || CONSP (idle_timers
))
4359 now
= current_emacs_time ();
4360 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4361 ? sub_emacs_time (now
, timer_idleness_start_time
)
4362 : make_emacs_time (0, 0));
4365 while (CONSP (timers
) || CONSP (idle_timers
))
4367 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4368 EMACS_TIME timer_time
, idle_timer_time
;
4369 EMACS_TIME difference
;
4370 EMACS_TIME timer_difference
= invalid_emacs_time ();
4371 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4372 int ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4374 /* Set TIMER and TIMER_DIFFERENCE
4375 based on the next ordinary timer.
4376 TIMER_DIFFERENCE is the distance in time from NOW to when
4377 this timer becomes ripe (negative if it's already ripe).
4378 Skip past invalid timers and timers already handled. */
4381 timer
= XCAR (timers
);
4382 if (! decode_timer (timer
, &timer_time
))
4384 timers
= XCDR (timers
);
4388 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4389 timer_difference
= (timer_ripe
4390 ? sub_emacs_time (now
, timer_time
)
4391 : sub_emacs_time (timer_time
, now
));
4394 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4395 based on the next idle timer. */
4396 if (CONSP (idle_timers
))
4398 idle_timer
= XCAR (idle_timers
);
4399 if (! decode_timer (idle_timer
, &idle_timer_time
))
4401 idle_timers
= XCDR (idle_timers
);
4405 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4406 idle_timer_difference
=
4408 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4409 : sub_emacs_time (idle_timer_time
, idleness_now
));
4412 /* Decide which timer is the next timer,
4413 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4414 Also step down the list where we found that timer. */
4416 if (EMACS_TIME_VALID_P (timer_difference
)
4417 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4418 || idle_timer_ripe
< timer_ripe
4419 || (idle_timer_ripe
== timer_ripe
4421 ? EMACS_TIME_LT (idle_timer_difference
,
4423 : EMACS_TIME_LT (timer_difference
,
4424 idle_timer_difference
)))))
4426 chosen_timer
= timer
;
4427 timers
= XCDR (timers
);
4428 difference
= timer_difference
;
4433 chosen_timer
= idle_timer
;
4434 idle_timers
= XCDR (idle_timers
);
4435 difference
= idle_timer_difference
;
4436 ripe
= idle_timer_ripe
;
4439 /* If timer is ripe, run it if it hasn't been run. */
4442 if (NILP (AREF (chosen_timer
, 0)))
4444 ptrdiff_t count
= SPECPDL_INDEX ();
4445 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4447 /* Mark the timer as triggered to prevent problems if the lisp
4448 code fails to reschedule it right. */
4449 ASET (chosen_timer
, 0, Qt
);
4451 specbind (Qinhibit_quit
, Qt
);
4453 call1 (Qtimer_event_handler
, chosen_timer
);
4454 Vdeactivate_mark
= old_deactivate_mark
;
4456 unbind_to (count
, Qnil
);
4458 /* Since we have handled the event,
4459 we don't need to tell the caller to wake up and do it. */
4460 /* But the caller must still wait for the next timer, so
4461 return 0 to indicate that. */
4464 nexttime
= make_emacs_time (0, 0);
4468 /* When we encounter a timer that is still waiting,
4469 return the amount of time to wait before it is ripe. */
4476 /* No timers are pending in the future. */
4477 /* Return 0 if we generated an event, and -1 if not. */
4483 /* Check whether a timer has fired. To prevent larger problems we simply
4484 disregard elements that are not proper timers. Do not make a circular
4485 timer list for the time being.
4487 Returns the time to wait until the next timer fires.
4488 If no timer is active, return an invalid value.
4490 As long as any timer is ripe, we run it. */
4495 EMACS_TIME nexttime
;
4496 Lisp_Object timers
, idle_timers
;
4497 struct gcpro gcpro1
, gcpro2
;
4499 Lisp_Object tem
= Vinhibit_quit
;
4502 /* We use copies of the timers' lists to allow a timer to add itself
4503 again, without locking up Emacs if the newly added timer is
4504 already ripe when added. */
4506 /* Always consider the ordinary timers. */
4507 timers
= Fcopy_sequence (Vtimer_list
);
4508 /* Consider the idle timers only if Emacs is idle. */
4509 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4510 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4514 Vinhibit_quit
= tem
;
4516 GCPRO2 (timers
, idle_timers
);
4520 nexttime
= timer_check_2 (timers
, idle_timers
);
4522 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4528 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4529 doc
: /* Return the current length of Emacs idleness, or nil.
4530 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4531 in the same style as (current-time).
4533 The value when Emacs is not idle is nil.
4535 PSEC is a multiple of the system clock resolution. */)
4538 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4539 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4540 timer_idleness_start_time
));
4545 /* Caches for modify_event_symbol. */
4546 static Lisp_Object accent_key_syms
;
4547 static Lisp_Object func_key_syms
;
4548 static Lisp_Object mouse_syms
;
4549 static Lisp_Object wheel_syms
;
4550 static Lisp_Object drag_n_drop_syms
;
4552 /* This is a list of keysym codes for special "accent" characters.
4553 It parallels lispy_accent_keys. */
4555 static const int lispy_accent_codes
[] =
4557 #ifdef XK_dead_circumflex
4562 #ifdef XK_dead_grave
4567 #ifdef XK_dead_tilde
4572 #ifdef XK_dead_diaeresis
4577 #ifdef XK_dead_macron
4582 #ifdef XK_dead_degree
4587 #ifdef XK_dead_acute
4592 #ifdef XK_dead_cedilla
4597 #ifdef XK_dead_breve
4602 #ifdef XK_dead_ogonek
4607 #ifdef XK_dead_caron
4612 #ifdef XK_dead_doubleacute
4613 XK_dead_doubleacute
,
4617 #ifdef XK_dead_abovedot
4622 #ifdef XK_dead_abovering
4632 #ifdef XK_dead_belowdot
4637 #ifdef XK_dead_voiced_sound
4638 XK_dead_voiced_sound
,
4642 #ifdef XK_dead_semivoiced_sound
4643 XK_dead_semivoiced_sound
,
4659 /* This is a list of Lisp names for special "accent" characters.
4660 It parallels lispy_accent_codes. */
4662 static const char *const lispy_accent_keys
[] =
4680 "dead-voiced-sound",
4681 "dead-semivoiced-sound",
4687 #define FUNCTION_KEY_OFFSET 0x0
4689 const char *const lispy_function_keys
[] =
4693 0, /* VK_LBUTTON 0x01 */
4694 0, /* VK_RBUTTON 0x02 */
4695 "cancel", /* VK_CANCEL 0x03 */
4696 0, /* VK_MBUTTON 0x04 */
4698 0, 0, 0, /* 0x05 .. 0x07 */
4700 "backspace", /* VK_BACK 0x08 */
4701 "tab", /* VK_TAB 0x09 */
4703 0, 0, /* 0x0A .. 0x0B */
4705 "clear", /* VK_CLEAR 0x0C */
4706 "return", /* VK_RETURN 0x0D */
4708 0, 0, /* 0x0E .. 0x0F */
4710 0, /* VK_SHIFT 0x10 */
4711 0, /* VK_CONTROL 0x11 */
4712 0, /* VK_MENU 0x12 */
4713 "pause", /* VK_PAUSE 0x13 */
4714 "capslock", /* VK_CAPITAL 0x14 */
4715 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4717 "junja", /* VK_JUNJA 0x17 */
4718 "final", /* VK_FINAL 0x18 */
4719 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4721 "escape", /* VK_ESCAPE 0x1B */
4722 "convert", /* VK_CONVERT 0x1C */
4723 "non-convert", /* VK_NONCONVERT 0x1D */
4724 "accept", /* VK_ACCEPT 0x1E */
4725 "mode-change", /* VK_MODECHANGE 0x1F */
4726 0, /* VK_SPACE 0x20 */
4727 "prior", /* VK_PRIOR 0x21 */
4728 "next", /* VK_NEXT 0x22 */
4729 "end", /* VK_END 0x23 */
4730 "home", /* VK_HOME 0x24 */
4731 "left", /* VK_LEFT 0x25 */
4732 "up", /* VK_UP 0x26 */
4733 "right", /* VK_RIGHT 0x27 */
4734 "down", /* VK_DOWN 0x28 */
4735 "select", /* VK_SELECT 0x29 */
4736 "print", /* VK_PRINT 0x2A */
4737 "execute", /* VK_EXECUTE 0x2B */
4738 "snapshot", /* VK_SNAPSHOT 0x2C */
4739 "insert", /* VK_INSERT 0x2D */
4740 "delete", /* VK_DELETE 0x2E */
4741 "help", /* VK_HELP 0x2F */
4743 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4745 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4747 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4749 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4751 0, 0, 0, 0, 0, 0, 0, 0, 0,
4752 0, 0, 0, 0, 0, 0, 0, 0, 0,
4753 0, 0, 0, 0, 0, 0, 0, 0,
4755 "lwindow", /* VK_LWIN 0x5B */
4756 "rwindow", /* VK_RWIN 0x5C */
4757 "apps", /* VK_APPS 0x5D */
4760 "kp-0", /* VK_NUMPAD0 0x60 */
4761 "kp-1", /* VK_NUMPAD1 0x61 */
4762 "kp-2", /* VK_NUMPAD2 0x62 */
4763 "kp-3", /* VK_NUMPAD3 0x63 */
4764 "kp-4", /* VK_NUMPAD4 0x64 */
4765 "kp-5", /* VK_NUMPAD5 0x65 */
4766 "kp-6", /* VK_NUMPAD6 0x66 */
4767 "kp-7", /* VK_NUMPAD7 0x67 */
4768 "kp-8", /* VK_NUMPAD8 0x68 */
4769 "kp-9", /* VK_NUMPAD9 0x69 */
4770 "kp-multiply", /* VK_MULTIPLY 0x6A */
4771 "kp-add", /* VK_ADD 0x6B */
4772 "kp-separator", /* VK_SEPARATOR 0x6C */
4773 "kp-subtract", /* VK_SUBTRACT 0x6D */
4774 "kp-decimal", /* VK_DECIMAL 0x6E */
4775 "kp-divide", /* VK_DIVIDE 0x6F */
4776 "f1", /* VK_F1 0x70 */
4777 "f2", /* VK_F2 0x71 */
4778 "f3", /* VK_F3 0x72 */
4779 "f4", /* VK_F4 0x73 */
4780 "f5", /* VK_F5 0x74 */
4781 "f6", /* VK_F6 0x75 */
4782 "f7", /* VK_F7 0x76 */
4783 "f8", /* VK_F8 0x77 */
4784 "f9", /* VK_F9 0x78 */
4785 "f10", /* VK_F10 0x79 */
4786 "f11", /* VK_F11 0x7A */
4787 "f12", /* VK_F12 0x7B */
4788 "f13", /* VK_F13 0x7C */
4789 "f14", /* VK_F14 0x7D */
4790 "f15", /* VK_F15 0x7E */
4791 "f16", /* VK_F16 0x7F */
4792 "f17", /* VK_F17 0x80 */
4793 "f18", /* VK_F18 0x81 */
4794 "f19", /* VK_F19 0x82 */
4795 "f20", /* VK_F20 0x83 */
4796 "f21", /* VK_F21 0x84 */
4797 "f22", /* VK_F22 0x85 */
4798 "f23", /* VK_F23 0x86 */
4799 "f24", /* VK_F24 0x87 */
4801 0, 0, 0, 0, /* 0x88 .. 0x8B */
4802 0, 0, 0, 0, /* 0x8C .. 0x8F */
4804 "kp-numlock", /* VK_NUMLOCK 0x90 */
4805 "scroll", /* VK_SCROLL 0x91 */
4806 /* Not sure where the following block comes from.
4807 Windows headers have NEC and Fujitsu specific keys in
4808 this block, but nothing generic. */
4809 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4810 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4811 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4812 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4813 "kp-end", /* VK_NUMPAD_END 0x96 */
4814 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4815 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4816 "kp-up", /* VK_NUMPAD_UP 0x99 */
4817 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4818 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4819 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4820 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4822 0, 0, /* 0x9E .. 0x9F */
4825 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4826 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4827 * No other API or message will distinguish left and right keys this way.
4832 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4833 to enable them selectively, and gives access to a few more functions.
4834 See lispy_multimedia_keys below. */
4835 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4836 0, 0, 0, /* 0xAD .. 0xAF Volume */
4837 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4838 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4840 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4841 0, 0, 0, 0, 0, 0, 0, 0, 0,
4843 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4844 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4845 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4848 "ax", /* VK_OEM_AX 0xE1 */
4849 0, /* VK_OEM_102 0xE2 */
4850 "ico-help", /* VK_ICO_HELP 0xE3 */
4851 "ico-00", /* VK_ICO_00 0xE4 */
4852 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4853 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4854 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4856 "reset", /* VK_OEM_RESET 0xE9 */
4857 "jump", /* VK_OEM_JUMP 0xEA */
4858 "oem-pa1", /* VK_OEM_PA1 0xEB */
4859 "oem-pa2", /* VK_OEM_PA2 0xEC */
4860 "oem-pa3", /* VK_OEM_PA3 0xED */
4861 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4862 "cusel", /* VK_OEM_CUSEL 0xEF */
4863 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4864 "finish", /* VK_OEM_FINISH 0xF1 */
4865 "copy", /* VK_OEM_COPY 0xF2 */
4866 "auto", /* VK_OEM_AUTO 0xF3 */
4867 "enlw", /* VK_OEM_ENLW 0xF4 */
4868 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4869 "attn", /* VK_ATTN 0xF6 */
4870 "crsel", /* VK_CRSEL 0xF7 */
4871 "exsel", /* VK_EXSEL 0xF8 */
4872 "ereof", /* VK_EREOF 0xF9 */
4873 "play", /* VK_PLAY 0xFA */
4874 "zoom", /* VK_ZOOM 0xFB */
4875 "noname", /* VK_NONAME 0xFC */
4876 "pa1", /* VK_PA1 0xFD */
4877 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4881 /* Some of these duplicate the "Media keys" on newer keyboards,
4882 but they are delivered to the application in a different way. */
4883 static const char *const lispy_multimedia_keys
[] =
4891 "browser-favorites",
4928 "toggle-dictate-command",
4934 "media-fast-forward",
4937 "media-channel-down"
4940 #else /* not HAVE_NTGUI */
4942 /* This should be dealt with in XTread_socket now, and that doesn't
4943 depend on the client system having the Kana syms defined. See also
4944 the XK_kana_A case below. */
4947 static const char *const lispy_kana_keys
[] =
4949 /* X Keysym value */
4950 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4951 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4952 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4953 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4954 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4955 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4956 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4957 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4958 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4959 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4960 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4961 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4962 "kana-i", "kana-u", "kana-e", "kana-o",
4963 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4964 "prolongedsound", "kana-A", "kana-I", "kana-U",
4965 "kana-E", "kana-O", "kana-KA", "kana-KI",
4966 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4967 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4968 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4969 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4970 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4971 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4972 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4973 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4974 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4975 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4976 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4977 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4979 #endif /* XK_kana_A */
4982 #define FUNCTION_KEY_OFFSET 0xff00
4984 /* You'll notice that this table is arranged to be conveniently
4985 indexed by X Windows keysym values. */
4986 static const char *const lispy_function_keys
[] =
4988 /* X Keysym value */
4990 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4991 "backspace", "tab", "linefeed", "clear",
4993 0, 0, 0, "pause", /* 0xff10...1f */
4994 0, 0, 0, 0, 0, 0, 0, "escape",
4996 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4997 "romaji", "hiragana", "katakana", "hiragana-katakana",
4998 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4999 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5000 "eisu-toggle", /* 0xff30...3f */
5001 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5002 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5004 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5005 "down", "prior", "next", "end",
5006 "begin", 0, 0, 0, 0, 0, 0, 0,
5007 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5018 "break", /* 0xff6b */
5021 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5022 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5023 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5024 0, 0, 0, 0, 0, 0, 0, 0,
5025 "kp-tab", /* 0xff89 */
5027 "kp-enter", /* 0xff8d */
5029 "kp-f1", /* 0xff91 */
5033 "kp-home", /* 0xff95 */
5038 "kp-prior", /* kp-page-up */
5039 "kp-next", /* kp-page-down */
5045 0, 0, 0, 0, 0, 0, 0, 0, 0,
5046 "kp-multiply", /* 0xffaa */
5051 "kp-divide", /* 0xffaf */
5052 "kp-0", /* 0xffb0 */
5053 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5056 "kp-equal", /* 0xffbd */
5057 "f1", /* 0xffbe */ /* IsFunctionKey */
5059 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5060 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5061 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5062 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5063 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5064 0, 0, 0, 0, 0, 0, 0, 0,
5065 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5066 0, 0, 0, 0, 0, 0, 0, "delete"
5069 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5070 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5072 static const char *const iso_lispy_function_keys
[] =
5074 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5075 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5076 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5077 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5078 "iso-lefttab", /* 0xfe20 */
5079 "iso-move-line-up", "iso-move-line-down",
5080 "iso-partial-line-up", "iso-partial-line-down",
5081 "iso-partial-space-left", "iso-partial-space-right",
5082 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5083 "iso-release-margin-left", "iso-release-margin-right",
5084 "iso-release-both-margins",
5085 "iso-fast-cursor-left", "iso-fast-cursor-right",
5086 "iso-fast-cursor-up", "iso-fast-cursor-down",
5087 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5088 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5091 #endif /* not HAVE_NTGUI */
5093 static Lisp_Object Vlispy_mouse_stem
;
5095 static const char *const lispy_wheel_names
[] =
5097 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5100 /* drag-n-drop events are generated when a set of selected files are
5101 dragged from another application and dropped onto an Emacs window. */
5102 static const char *const lispy_drag_n_drop_names
[] =
5107 /* Scroll bar parts. */
5108 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5109 Lisp_Object Qup
, Qdown
, Qbottom
;
5110 static Lisp_Object Qend_scroll
;
5112 static Lisp_Object Qratio
;
5114 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5115 static Lisp_Object
*const scroll_bar_parts
[] = {
5116 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5117 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5120 /* A vector, indexed by button number, giving the down-going location
5121 of currently depressed buttons, both scroll bar and non-scroll bar.
5123 The elements have the form
5124 (BUTTON-NUMBER MODIFIER-MASK . REST)
5125 where REST is the cdr of a position as it would be reported in the event.
5127 The make_lispy_event function stores positions here to tell the
5128 difference between click and drag events, and to store the starting
5129 location to be included in drag events. */
5131 static Lisp_Object button_down_location
;
5133 /* Information about the most recent up-going button event: Which
5134 button, what location, and what time. */
5136 static int last_mouse_button
;
5137 static int last_mouse_x
;
5138 static int last_mouse_y
;
5139 static Time button_down_time
;
5141 /* The number of clicks in this multiple-click. */
5143 static int double_click_count
;
5145 /* X and Y are frame-relative coordinates for a click or wheel event.
5146 Return a Lisp-style event list. */
5149 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5152 enum window_part part
;
5153 Lisp_Object posn
= Qnil
;
5154 Lisp_Object extra_info
= Qnil
;
5155 /* Coordinate pixel positions to return. */
5156 int xret
= 0, yret
= 0;
5157 /* The window under frame pixel coordinates (x,y) */
5158 Lisp_Object window
= f
5159 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5162 if (WINDOWP (window
))
5164 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5165 struct window
*w
= XWINDOW (window
);
5166 Lisp_Object string_info
= Qnil
;
5167 ptrdiff_t textpos
= -1;
5168 int col
= -1, row
= -1;
5169 int dx
= -1, dy
= -1;
5170 int width
= -1, height
= -1;
5171 Lisp_Object object
= Qnil
;
5173 /* Pixel coordinates relative to the window corner. */
5174 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5175 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5177 /* For text area clicks, return X, Y relative to the corner of
5178 this text area. Note that dX, dY etc are set below, by
5179 buffer_posn_from_coords. */
5180 if (part
== ON_TEXT
)
5182 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5183 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5185 /* For mode line and header line clicks, return X, Y relative to
5186 the left window edge. Use mode_line_string to look for a
5187 string on the click position. */
5188 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5193 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5194 /* Note that mode_line_string takes COL, ROW as pixels and
5195 converts them to characters. */
5198 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5199 &object
, &dx
, &dy
, &width
, &height
);
5200 if (STRINGP (string
))
5201 string_info
= Fcons (string
, make_number (charpos
));
5202 textpos
= (w
== XWINDOW (selected_window
)
5203 && current_buffer
== XBUFFER (w
->buffer
))
5204 ? PT
: XMARKER (w
->pointm
)->charpos
;
5209 /* For fringes and margins, Y is relative to the area's (and the
5210 window's) top edge, while X is meaningless. */
5211 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5216 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5219 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5220 &object
, &dx
, &dy
, &width
, &height
);
5221 if (STRINGP (string
))
5222 string_info
= Fcons (string
, make_number (charpos
));
5223 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5225 else if (part
== ON_LEFT_FRINGE
)
5227 posn
= Qleft_fringe
;
5230 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5231 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5232 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5234 else if (part
== ON_RIGHT_FRINGE
)
5236 posn
= Qright_fringe
;
5239 - window_box_width (w
, LEFT_MARGIN_AREA
)
5240 - window_box_width (w
, TEXT_AREA
)
5241 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5242 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5244 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5246 else if (part
== ON_VERTICAL_BORDER
)
5248 posn
= Qvertical_line
;
5253 /* Nothing special for part == ON_SCROLL_BAR. */
5255 /* For clicks in the text area, fringes, or margins, call
5256 buffer_posn_from_coords to extract TEXTPOS, the buffer
5257 position nearest to the click. */
5260 Lisp_Object string2
, object2
= Qnil
;
5261 struct display_pos p
;
5263 int width2
, height2
;
5264 /* The pixel X coordinate passed to buffer_posn_from_coords
5265 is the X coordinate relative to the text area for
5266 text-area and right-margin clicks, zero otherwise. */
5268 = (part
== ON_TEXT
) ? xret
5269 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5270 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5274 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5275 &object2
, &dx2
, &dy2
,
5277 textpos
= CHARPOS (p
.pos
);
5278 if (col
< 0) col
= x2
;
5279 if (row
< 0) row
= y2
;
5280 if (dx
< 0) dx
= dx2
;
5281 if (dy
< 0) dy
= dy2
;
5282 if (width
< 0) width
= width2
;
5283 if (height
< 0) height
= height2
;
5287 posn
= make_number (textpos
);
5288 if (STRINGP (string2
))
5289 string_info
= Fcons (string2
,
5290 make_number (CHARPOS (p
.string_pos
)));
5296 #ifdef HAVE_WINDOW_SYSTEM
5297 if (IMAGEP (object
))
5299 Lisp_Object image_map
, hotspot
;
5300 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5302 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5304 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5305 posn
= XCAR (hotspot
);
5312 Fcons (make_number (dx
), make_number (dy
)),
5313 Fcons (make_number (width
), make_number (height
)));
5316 extra_info
= Fcons (string_info
,
5317 Fcons (make_number (textpos
),
5318 Fcons (Fcons (make_number (col
),
5323 XSETFRAME (window
, f
);
5327 return Fcons (window
,
5329 Fcons (Fcons (make_number (xret
),
5330 make_number (yret
)),
5331 Fcons (make_number (t
),
5335 /* Given a struct input_event, build the lisp event which represents
5336 it. If EVENT is 0, build a mouse movement event from the mouse
5337 movement buffer, which should have a movement event in it.
5339 Note that events must be passed to this function in the order they
5340 are received; this function stores the location of button presses
5341 in order to build drag events when the button is released. */
5344 make_lispy_event (struct input_event
*event
)
5348 switch (event
->kind
)
5350 /* A simple keystroke. */
5351 case ASCII_KEYSTROKE_EVENT
:
5352 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5354 Lisp_Object lispy_c
;
5355 EMACS_INT c
= event
->code
;
5356 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5359 eassert (c
== event
->code
);
5360 /* Turn ASCII characters into control characters
5362 if (event
->modifiers
& ctrl_modifier
)
5364 c
= make_ctrl_char (c
);
5365 event
->modifiers
&= ~ctrl_modifier
;
5369 /* Add in the other modifier bits. The shift key was taken care
5370 of by the X code. */
5371 c
|= (event
->modifiers
5372 & (meta_modifier
| alt_modifier
5373 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5374 /* Distinguish Shift-SPC from SPC. */
5375 if ((event
->code
) == 040
5376 && event
->modifiers
& shift_modifier
)
5377 c
|= shift_modifier
;
5378 button_down_time
= 0;
5379 XSETFASTINT (lispy_c
, c
);
5384 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5385 except that they are non-key events (last-nonmenu-event is nil). */
5386 case NS_NONKEY_EVENT
:
5389 /* A function key. The symbol may need to have modifier prefixes
5391 case NON_ASCII_KEYSTROKE_EVENT
:
5392 button_down_time
= 0;
5394 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5395 if (event
->code
== lispy_accent_codes
[i
])
5396 return modify_event_symbol (i
,
5398 Qfunction_key
, Qnil
,
5399 lispy_accent_keys
, &accent_key_syms
,
5400 (sizeof (lispy_accent_keys
)
5401 / sizeof (lispy_accent_keys
[0])));
5405 if (event
->code
>= 0x400 && event
->code
< 0x500)
5406 return modify_event_symbol (event
->code
- 0x400,
5407 event
->modifiers
& ~shift_modifier
,
5408 Qfunction_key
, Qnil
,
5409 lispy_kana_keys
, &func_key_syms
,
5410 (sizeof (lispy_kana_keys
)
5411 / sizeof (lispy_kana_keys
[0])));
5412 #endif /* XK_kana_A */
5415 #ifdef ISO_FUNCTION_KEY_OFFSET
5416 if (event
->code
< FUNCTION_KEY_OFFSET
5417 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5418 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5420 Qfunction_key
, Qnil
,
5421 iso_lispy_function_keys
, &func_key_syms
,
5422 (sizeof (iso_lispy_function_keys
)
5423 / sizeof (iso_lispy_function_keys
[0])));
5426 /* Handle system-specific or unknown keysyms. */
5427 if (event
->code
& (1 << 28)
5428 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5429 || (event
->code
- FUNCTION_KEY_OFFSET
5430 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5431 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5433 /* We need to use an alist rather than a vector as the cache
5434 since we can't make a vector long enough. */
5435 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5436 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5437 return modify_event_symbol (event
->code
,
5440 KVAR (current_kboard
, Vsystem_key_alist
),
5441 0, &KVAR (current_kboard
, system_key_syms
),
5445 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5447 Qfunction_key
, Qnil
,
5448 lispy_function_keys
, &func_key_syms
,
5449 (sizeof (lispy_function_keys
)
5450 / sizeof (lispy_function_keys
[0])));
5453 case MULTIMEDIA_KEY_EVENT
:
5454 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5455 / sizeof (lispy_multimedia_keys
[0]))
5456 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5458 return modify_event_symbol (event
->code
, event
->modifiers
,
5459 Qfunction_key
, Qnil
,
5460 lispy_multimedia_keys
, &func_key_syms
,
5461 (sizeof (lispy_multimedia_keys
)
5462 / sizeof (lispy_multimedia_keys
[0])));
5468 /* A mouse click. Figure out where it is, decide whether it's
5469 a press, click or drag, and build the appropriate structure. */
5470 case MOUSE_CLICK_EVENT
:
5471 #ifndef USE_TOOLKIT_SCROLL_BARS
5472 case SCROLL_BAR_CLICK_EVENT
:
5475 int button
= event
->code
;
5477 Lisp_Object position
;
5478 Lisp_Object
*start_pos_ptr
;
5479 Lisp_Object start_pos
;
5483 /* Build the position as appropriate for this mouse click. */
5484 if (event
->kind
== MOUSE_CLICK_EVENT
)
5486 struct frame
*f
= XFRAME (event
->frame_or_window
);
5487 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5491 /* Ignore mouse events that were made on frame that
5492 have been deleted. */
5493 if (! FRAME_LIVE_P (f
))
5496 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5497 /* EVENT->x and EVENT->y are frame-relative pixel
5498 coordinates at this place. Under old redisplay, COLUMN
5499 and ROW are set to frame relative glyph coordinates
5500 which are then used to determine whether this click is
5501 in a menu (non-toolkit version). */
5502 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5503 &column
, &row
, NULL
, 1);
5505 /* In the non-toolkit version, clicks on the menu bar
5506 are ordinary button events in the event buffer.
5507 Distinguish them, and invoke the menu.
5509 (In the toolkit version, the toolkit handles the menu bar
5510 and Emacs doesn't know about it until after the user
5511 makes a selection.) */
5512 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5513 && (event
->modifiers
& down_modifier
))
5515 Lisp_Object items
, item
;
5517 /* Find the menu bar item under `column'. */
5519 items
= FRAME_MENU_BAR_ITEMS (f
);
5520 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5522 Lisp_Object pos
, string
;
5523 string
= AREF (items
, i
+ 1);
5524 pos
= AREF (items
, i
+ 3);
5527 if (column
>= XINT (pos
)
5528 && column
< XINT (pos
) + SCHARS (string
))
5530 item
= AREF (items
, i
);
5535 /* ELisp manual 2.4b says (x y) are window relative but
5536 code says they are frame-relative. */
5538 = Fcons (event
->frame_or_window
,
5540 Fcons (Fcons (event
->x
, event
->y
),
5541 Fcons (make_number (event
->timestamp
),
5544 return Fcons (item
, Fcons (position
, Qnil
));
5546 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5548 position
= make_lispy_position (f
, event
->x
, event
->y
,
5551 #ifndef USE_TOOLKIT_SCROLL_BARS
5554 /* It's a scrollbar click. */
5556 Lisp_Object portion_whole
;
5559 window
= event
->frame_or_window
;
5560 portion_whole
= Fcons (event
->x
, event
->y
);
5561 part
= *scroll_bar_parts
[(int) event
->part
];
5565 Fcons (Qvertical_scroll_bar
,
5566 Fcons (portion_whole
,
5567 Fcons (make_number (event
->timestamp
),
5568 Fcons (part
, Qnil
)))));
5570 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5572 if (button
>= ASIZE (button_down_location
))
5574 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5575 button_down_location
= larger_vector (button_down_location
,
5577 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5580 start_pos_ptr
= aref_addr (button_down_location
, button
);
5581 start_pos
= *start_pos_ptr
;
5582 *start_pos_ptr
= Qnil
;
5585 /* On window-system frames, use the value of
5586 double-click-fuzz as is. On other frames, interpret it
5587 as a multiple of 1/8 characters. */
5591 if (WINDOWP (event
->frame_or_window
))
5592 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5593 else if (FRAMEP (event
->frame_or_window
))
5594 f
= XFRAME (event
->frame_or_window
);
5598 if (FRAME_WINDOW_P (f
))
5599 fuzz
= double_click_fuzz
;
5601 fuzz
= double_click_fuzz
/ 8;
5603 is_double
= (button
== last_mouse_button
5604 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5605 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5606 && button_down_time
!= 0
5607 && (EQ (Vdouble_click_time
, Qt
)
5608 || (NATNUMP (Vdouble_click_time
)
5609 && (event
->timestamp
- button_down_time
5610 < XFASTINT (Vdouble_click_time
)))));
5613 last_mouse_button
= button
;
5614 last_mouse_x
= XINT (event
->x
);
5615 last_mouse_y
= XINT (event
->y
);
5617 /* If this is a button press, squirrel away the location, so
5618 we can decide later whether it was a click or a drag. */
5619 if (event
->modifiers
& down_modifier
)
5623 double_click_count
++;
5624 event
->modifiers
|= ((double_click_count
> 2)
5629 double_click_count
= 1;
5630 button_down_time
= event
->timestamp
;
5631 *start_pos_ptr
= Fcopy_alist (position
);
5632 ignore_mouse_drag_p
= 0;
5635 /* Now we're releasing a button - check the co-ordinates to
5636 see if this was a click or a drag. */
5637 else if (event
->modifiers
& up_modifier
)
5639 /* If we did not see a down before this up, ignore the up.
5640 Probably this happened because the down event chose a
5641 menu item. It would be an annoyance to treat the
5642 release of the button that chose the menu item as a
5645 if (!CONSP (start_pos
))
5648 event
->modifiers
&= ~up_modifier
;
5651 Lisp_Object new_down
, down
;
5652 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5654 /* The third element of every position
5655 should be the (x,y) pair. */
5656 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5657 new_down
= Fcar (Fcdr (Fcdr (position
)));
5660 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5662 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5663 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5666 if (ignore_mouse_drag_p
)
5668 event
->modifiers
|= click_modifier
;
5669 ignore_mouse_drag_p
= 0;
5671 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5672 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5673 /* Maybe the mouse has moved a lot, caused scrolling, and
5674 eventually ended up at the same screen position (but
5675 not buffer position) in which case it is a drag, not
5677 /* FIXME: OTOH if the buffer position has changed
5678 because of a timer or process filter rather than
5679 because of mouse movement, it should be considered as
5680 a click. But mouse-drag-region completely ignores
5681 this case and it hasn't caused any real problem, so
5682 it's probably OK to ignore it as well. */
5683 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5684 /* Mouse hasn't moved (much). */
5685 event
->modifiers
|= click_modifier
;
5688 button_down_time
= 0;
5689 event
->modifiers
|= drag_modifier
;
5692 /* Don't check is_double; treat this as multiple
5693 if the down-event was multiple. */
5694 if (double_click_count
> 1)
5695 event
->modifiers
|= ((double_click_count
> 2)
5701 /* Every mouse event should either have the down_modifier or
5702 the up_modifier set. */
5706 /* Get the symbol we should use for the mouse click. */
5709 head
= modify_event_symbol (button
,
5711 Qmouse_click
, Vlispy_mouse_stem
,
5714 ASIZE (mouse_syms
));
5715 if (event
->modifiers
& drag_modifier
)
5720 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5723 Fcons (make_number (double_click_count
),
5733 case HORIZ_WHEEL_EVENT
:
5735 Lisp_Object position
;
5738 /* Build the position as appropriate for this mouse click. */
5739 struct frame
*f
= XFRAME (event
->frame_or_window
);
5741 /* Ignore wheel events that were made on frame that have been
5743 if (! FRAME_LIVE_P (f
))
5746 position
= make_lispy_position (f
, event
->x
, event
->y
,
5749 /* Set double or triple modifiers to indicate the wheel speed. */
5751 /* On window-system frames, use the value of
5752 double-click-fuzz as is. On other frames, interpret it
5753 as a multiple of 1/8 characters. */
5759 if (WINDOWP (event
->frame_or_window
))
5760 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5761 else if (FRAMEP (event
->frame_or_window
))
5762 fr
= XFRAME (event
->frame_or_window
);
5766 fuzz
= FRAME_WINDOW_P (fr
)
5767 ? double_click_fuzz
: double_click_fuzz
/ 8;
5769 if (event
->modifiers
& up_modifier
)
5771 /* Emit a wheel-up event. */
5772 event
->modifiers
&= ~up_modifier
;
5775 else if (event
->modifiers
& down_modifier
)
5777 /* Emit a wheel-down event. */
5778 event
->modifiers
&= ~down_modifier
;
5782 /* Every wheel event should either have the down_modifier or
5783 the up_modifier set. */
5786 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5789 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5790 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5791 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5792 && button_down_time
!= 0
5793 && (EQ (Vdouble_click_time
, Qt
)
5794 || (NATNUMP (Vdouble_click_time
)
5795 && (event
->timestamp
- button_down_time
5796 < XFASTINT (Vdouble_click_time
)))));
5799 double_click_count
++;
5800 event
->modifiers
|= ((double_click_count
> 2)
5806 double_click_count
= 1;
5807 event
->modifiers
|= click_modifier
;
5810 button_down_time
= event
->timestamp
;
5811 /* Use a negative value to distinguish wheel from mouse button. */
5812 last_mouse_button
= - (1 + symbol_num
);
5813 last_mouse_x
= XINT (event
->x
);
5814 last_mouse_y
= XINT (event
->y
);
5816 /* Get the symbol we should use for the wheel event. */
5817 head
= modify_event_symbol (symbol_num
,
5823 ASIZE (wheel_syms
));
5826 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5829 Fcons (make_number (double_click_count
),
5838 #ifdef USE_TOOLKIT_SCROLL_BARS
5840 /* We don't have down and up events if using toolkit scroll bars,
5841 so make this always a click event. Store in the `part' of
5842 the Lisp event a symbol which maps to the following actions:
5844 `above_handle' page up
5845 `below_handle' page down
5849 `bottom' bottom of buffer
5850 `handle' thumb has been dragged.
5851 `end-scroll' end of interaction with scroll bar
5853 The incoming input_event contains in its `part' member an
5854 index of type `enum scroll_bar_part' which we can use as an
5855 index in scroll_bar_parts to get the appropriate symbol. */
5857 case SCROLL_BAR_CLICK_EVENT
:
5859 Lisp_Object position
, head
, window
, portion_whole
, part
;
5861 window
= event
->frame_or_window
;
5862 portion_whole
= Fcons (event
->x
, event
->y
);
5863 part
= *scroll_bar_parts
[(int) event
->part
];
5867 Fcons (Qvertical_scroll_bar
,
5868 Fcons (portion_whole
,
5869 Fcons (make_number (event
->timestamp
),
5870 Fcons (part
, Qnil
)))));
5872 /* Always treat scroll bar events as clicks. */
5873 event
->modifiers
|= click_modifier
;
5874 event
->modifiers
&= ~up_modifier
;
5876 if (event
->code
>= ASIZE (mouse_syms
))
5877 mouse_syms
= larger_vector (mouse_syms
,
5878 event
->code
- ASIZE (mouse_syms
) + 1,
5881 /* Get the symbol we should use for the mouse click. */
5882 head
= modify_event_symbol (event
->code
,
5887 ASIZE (mouse_syms
));
5888 return Fcons (head
, Fcons (position
, Qnil
));
5891 #endif /* USE_TOOLKIT_SCROLL_BARS */
5893 case DRAG_N_DROP_EVENT
:
5896 Lisp_Object head
, position
;
5899 f
= XFRAME (event
->frame_or_window
);
5902 /* Ignore mouse events that were made on frames that
5903 have been deleted. */
5904 if (! FRAME_LIVE_P (f
))
5907 position
= make_lispy_position (f
, event
->x
, event
->y
,
5910 head
= modify_event_symbol (0, event
->modifiers
,
5912 lispy_drag_n_drop_names
,
5913 &drag_n_drop_syms
, 1);
5919 #endif /* HAVE_MOUSE */
5921 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5922 || defined (HAVE_NS) || defined (USE_GTK)
5923 case MENU_BAR_EVENT
:
5924 if (EQ (event
->arg
, event
->frame_or_window
))
5925 /* This is the prefix key. We translate this to
5926 `(menu_bar)' because the code in keyboard.c for menu
5927 events, which we use, relies on this. */
5928 return Fcons (Qmenu_bar
, Qnil
);
5932 case SELECT_WINDOW_EVENT
:
5933 /* Make an event (select-window (WINDOW)). */
5934 return Fcons (Qselect_window
,
5935 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5938 case TOOL_BAR_EVENT
:
5939 if (EQ (event
->arg
, event
->frame_or_window
))
5940 /* This is the prefix key. We translate this to
5941 `(tool_bar)' because the code in keyboard.c for tool bar
5942 events, which we use, relies on this. */
5943 return Fcons (Qtool_bar
, Qnil
);
5944 else if (SYMBOLP (event
->arg
))
5945 return apply_modifiers (event
->modifiers
, event
->arg
);
5948 case USER_SIGNAL_EVENT
:
5949 /* A user signal. */
5951 char *name
= find_user_signal_name (event
->code
);
5954 return intern (name
);
5957 case SAVE_SESSION_EVENT
:
5958 return Qsave_session
;
5963 return Fcons (Qdbus_event
, event
->arg
);
5965 #endif /* HAVE_DBUS */
5967 case CONFIG_CHANGED_EVENT
:
5968 return Fcons (Qconfig_changed_event
,
5970 Fcons (event
->frame_or_window
, Qnil
)));
5972 case GPM_CLICK_EVENT
:
5974 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5975 Lisp_Object head
, position
;
5976 Lisp_Object
*start_pos_ptr
;
5977 Lisp_Object start_pos
;
5978 int button
= event
->code
;
5980 if (button
>= ASIZE (button_down_location
))
5982 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5983 button_down_location
= larger_vector (button_down_location
,
5985 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5988 start_pos_ptr
= aref_addr (button_down_location
, button
);
5989 start_pos
= *start_pos_ptr
;
5991 position
= make_lispy_position (f
, event
->x
, event
->y
,
5994 if (event
->modifiers
& down_modifier
)
5995 *start_pos_ptr
= Fcopy_alist (position
);
5996 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5998 if (!CONSP (start_pos
))
6000 event
->modifiers
&= ~up_modifier
;
6003 head
= modify_event_symbol (button
,
6005 Qmouse_click
, Vlispy_mouse_stem
,
6008 ASIZE (mouse_syms
));
6010 if (event
->modifiers
& drag_modifier
)
6015 else if (event
->modifiers
& double_modifier
)
6018 Fcons (make_number (2),
6020 else if (event
->modifiers
& triple_modifier
)
6023 Fcons (make_number (3),
6030 #endif /* HAVE_GPM */
6032 /* The 'kind' field of the event is something we don't recognize. */
6038 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6041 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6042 Lisp_Object x
, Lisp_Object y
, Time t
)
6044 /* Is it a scroll bar movement? */
6045 if (frame
&& ! NILP (bar_window
))
6047 Lisp_Object part_sym
;
6049 part_sym
= *scroll_bar_parts
[(int) part
];
6050 return Fcons (Qscroll_bar_movement
,
6051 Fcons (list5 (bar_window
,
6052 Qvertical_scroll_bar
,
6058 /* Or is it an ordinary mouse movement? */
6061 Lisp_Object position
;
6062 position
= make_lispy_position (frame
, x
, y
, t
);
6063 return list2 (Qmouse_movement
, position
);
6067 #endif /* HAVE_MOUSE || HAVE GPM */
6069 /* Construct a switch frame event. */
6071 make_lispy_switch_frame (Lisp_Object frame
)
6073 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6076 /* Manipulating modifiers. */
6078 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6080 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6081 SYMBOL's name of the end of the modifiers; the string from this
6082 position is the unmodified symbol name.
6084 This doesn't use any caches. */
6087 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6093 CHECK_SYMBOL (symbol
);
6096 name
= SYMBOL_NAME (symbol
);
6098 for (i
= 0; i
< SBYTES (name
) - 1; )
6100 ptrdiff_t this_mod_end
= 0;
6103 /* See if the name continues with a modifier word.
6104 Check that the word appears, but don't check what follows it.
6105 Set this_mod and this_mod_end to record what we find. */
6107 switch (SREF (name
, i
))
6109 #define SINGLE_LETTER_MOD(BIT) \
6110 (this_mod_end = i + 1, this_mod = BIT)
6113 SINGLE_LETTER_MOD (alt_modifier
);
6117 SINGLE_LETTER_MOD (ctrl_modifier
);
6121 SINGLE_LETTER_MOD (hyper_modifier
);
6125 SINGLE_LETTER_MOD (meta_modifier
);
6129 SINGLE_LETTER_MOD (shift_modifier
);
6133 SINGLE_LETTER_MOD (super_modifier
);
6136 #undef SINGLE_LETTER_MOD
6138 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6139 if (i + LEN + 1 <= SBYTES (name) \
6140 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6142 this_mod_end = i + LEN; \
6147 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6148 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6149 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6153 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6155 #undef MULTI_LETTER_MOD
6159 /* If we found no modifier, stop looking for them. */
6160 if (this_mod_end
== 0)
6163 /* Check there is a dash after the modifier, so that it
6164 really is a modifier. */
6165 if (this_mod_end
>= SBYTES (name
)
6166 || SREF (name
, this_mod_end
) != '-')
6169 /* This modifier is real; look for another. */
6170 modifiers
|= this_mod
;
6171 i
= this_mod_end
+ 1;
6174 /* Should we include the `click' modifier? */
6175 if (! (modifiers
& (down_modifier
| drag_modifier
6176 | double_modifier
| triple_modifier
))
6177 && i
+ 7 == SBYTES (name
)
6178 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6179 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6180 modifiers
|= click_modifier
;
6182 if (! (modifiers
& (double_modifier
| triple_modifier
))
6183 && i
+ 6 < SBYTES (name
)
6184 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6185 modifiers
|= click_modifier
;
6193 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6194 prepended to the string BASE[0..BASE_LEN-1].
6195 This doesn't use any caches. */
6197 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6199 /* Since BASE could contain nulls, we can't use intern here; we have
6200 to use Fintern, which expects a genuine Lisp_String, and keeps a
6202 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6208 /* Only the event queue may use the `up' modifier; it should always
6209 be turned into a click or drag event before presented to lisp code. */
6210 if (modifiers
& up_modifier
)
6213 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6214 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6215 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6216 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6217 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6218 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6219 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6220 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6221 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6222 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6223 /* The click modifier is denoted by the absence of other modifiers. */
6227 mod_len
= p
- new_mods
;
6231 Lisp_Object new_name
;
6233 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6234 mod_len
+ base_len_byte
);
6235 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6236 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6238 return Fintern (new_name
, Qnil
);
6243 static const char *const modifier_names
[] =
6245 "up", "down", "drag", "click", "double", "triple", 0, 0,
6246 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6247 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6249 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6251 static Lisp_Object modifier_symbols
;
6253 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6255 lispy_modifier_list (int modifiers
)
6257 Lisp_Object modifier_list
;
6260 modifier_list
= Qnil
;
6261 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6262 if (modifiers
& (1<<i
))
6263 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6266 return modifier_list
;
6270 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6271 where UNMODIFIED is the unmodified form of SYMBOL,
6272 MASK is the set of modifiers present in SYMBOL's name.
6273 This is similar to parse_modifiers_uncached, but uses the cache in
6274 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6275 Qevent_symbol_elements property. */
6277 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6280 parse_modifiers (Lisp_Object symbol
)
6282 Lisp_Object elements
;
6284 if (INTEGERP (symbol
))
6285 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6286 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6288 else if (!SYMBOLP (symbol
))
6291 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6292 if (CONSP (elements
))
6297 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6298 Lisp_Object unmodified
;
6301 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6302 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6305 if (modifiers
& ~INTMASK
)
6307 XSETFASTINT (mask
, modifiers
);
6308 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6310 /* Cache the parsing results on SYMBOL. */
6311 Fput (symbol
, Qevent_symbol_element_mask
,
6313 Fput (symbol
, Qevent_symbol_elements
,
6314 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6316 /* Since we know that SYMBOL is modifiers applied to unmodified,
6317 it would be nice to put that in unmodified's cache.
6318 But we can't, since we're not sure that parse_modifiers is
6325 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6326 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6327 doc
: /* Parse the event symbol. For internal use. */)
6328 (Lisp_Object symbol
)
6330 /* Fill the cache if needed. */
6331 parse_modifiers (symbol
);
6332 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6333 and use the Lispier representation stored on Qevent_symbol_elements
6335 return Fget (symbol
, Qevent_symbol_elements
);
6338 /* Apply the modifiers MODIFIERS to the symbol BASE.
6339 BASE must be unmodified.
6341 This is like apply_modifiers_uncached, but uses BASE's
6342 Qmodifier_cache property, if present. It also builds
6343 Qevent_symbol_elements properties, since it has that info anyway.
6345 apply_modifiers copies the value of BASE's Qevent_kind property to
6346 the modified symbol. */
6348 apply_modifiers (int modifiers
, Lisp_Object base
)
6350 Lisp_Object cache
, idx
, entry
, new_symbol
;
6352 /* Mask out upper bits. We don't know where this value's been. */
6353 modifiers
&= INTMASK
;
6355 if (INTEGERP (base
))
6356 return make_number (XINT (base
) | modifiers
);
6358 /* The click modifier never figures into cache indices. */
6359 cache
= Fget (base
, Qmodifier_cache
);
6360 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6361 entry
= assq_no_quit (idx
, cache
);
6364 new_symbol
= XCDR (entry
);
6367 /* We have to create the symbol ourselves. */
6368 new_symbol
= apply_modifiers_uncached (modifiers
,
6369 SSDATA (SYMBOL_NAME (base
)),
6370 SCHARS (SYMBOL_NAME (base
)),
6371 SBYTES (SYMBOL_NAME (base
)));
6373 /* Add the new symbol to the base's cache. */
6374 entry
= Fcons (idx
, new_symbol
);
6375 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6377 /* We have the parsing info now for free, so we could add it to
6379 XSETFASTINT (idx, modifiers);
6380 Fput (new_symbol, Qevent_symbol_element_mask,
6381 Fcons (base, Fcons (idx, Qnil)));
6382 Fput (new_symbol, Qevent_symbol_elements,
6383 Fcons (base, lispy_modifier_list (modifiers)));
6384 Sadly, this is only correct if `base' is indeed a base event,
6385 which is not necessarily the case. -stef */
6388 /* Make sure this symbol is of the same kind as BASE.
6390 You'd think we could just set this once and for all when we
6391 intern the symbol above, but reorder_modifiers may call us when
6392 BASE's property isn't set right; we can't assume that just
6393 because it has a Qmodifier_cache property it must have its
6394 Qevent_kind set right as well. */
6395 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6399 kind
= Fget (base
, Qevent_kind
);
6401 Fput (new_symbol
, Qevent_kind
, kind
);
6408 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6409 return a symbol with the modifiers placed in the canonical order.
6410 Canonical order is alphabetical, except for down and drag, which
6411 always come last. The 'click' modifier is never written out.
6413 Fdefine_key calls this to make sure that (for example) C-M-foo
6414 and M-C-foo end up being equivalent in the keymap. */
6417 reorder_modifiers (Lisp_Object symbol
)
6419 /* It's hopefully okay to write the code this way, since everything
6420 will soon be in caches, and no consing will be done at all. */
6423 parsed
= parse_modifiers (symbol
);
6424 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6429 /* For handling events, we often want to produce a symbol whose name
6430 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6431 to some base, like the name of a function key or mouse button.
6432 modify_event_symbol produces symbols of this sort.
6434 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6435 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6438 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6439 into symbol names, or a string specifying a name stem used to
6440 construct a symbol name or the form `STEM-N', where N is the decimal
6441 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6442 non-nil; otherwise NAME_TABLE is used.
6444 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6445 persist between calls to modify_event_symbol that it can use to
6446 store a cache of the symbols it's generated for this NAME_TABLE
6447 before. The object stored there may be a vector or an alist.
6449 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6451 MODIFIERS is a set of modifier bits (as given in struct input_events)
6452 whose prefixes should be applied to the symbol name.
6454 SYMBOL_KIND is the value to be placed in the event_kind property of
6455 the returned symbol.
6457 The symbols we create are supposed to have an
6458 `event-symbol-elements' property, which lists the modifiers present
6459 in the symbol's name. */
6462 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6463 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6464 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6467 Lisp_Object symbol_int
;
6469 /* Get rid of the "vendor-specific" bit here. */
6470 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6472 /* Is this a request for a valid symbol? */
6473 if (symbol_num
< 0 || symbol_num
>= table_size
)
6476 if (CONSP (*symbol_table
))
6477 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6479 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6480 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6481 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6482 we've never used that symbol before. */
6485 if (! VECTORP (*symbol_table
)
6486 || ASIZE (*symbol_table
) != table_size
)
6490 XSETFASTINT (size
, table_size
);
6491 *symbol_table
= Fmake_vector (size
, Qnil
);
6494 value
= AREF (*symbol_table
, symbol_num
);
6497 /* Have we already used this symbol before? */
6500 /* No; let's create it. */
6501 if (CONSP (name_alist_or_stem
))
6502 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6503 else if (STRINGP (name_alist_or_stem
))
6506 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6507 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6509 buf
= SAFE_ALLOCA (len
);
6510 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6511 XINT (symbol_int
) + 1);
6512 value
= intern (buf
);
6515 else if (name_table
!= 0 && name_table
[symbol_num
])
6516 value
= intern (name_table
[symbol_num
]);
6518 #ifdef HAVE_WINDOW_SYSTEM
6521 char *name
= x_get_keysym_name (symbol_num
);
6523 value
= intern (name
);
6529 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6530 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6531 value
= intern (buf
);
6534 if (CONSP (*symbol_table
))
6535 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6537 ASET (*symbol_table
, symbol_num
, value
);
6539 /* Fill in the cache entries for this symbol; this also
6540 builds the Qevent_symbol_elements property, which the user
6542 apply_modifiers (modifiers
& click_modifier
, value
);
6543 Fput (value
, Qevent_kind
, symbol_kind
);
6546 /* Apply modifiers to that symbol. */
6547 return apply_modifiers (modifiers
, value
);
6550 /* Convert a list that represents an event type,
6551 such as (ctrl meta backspace), into the usual representation of that
6552 event type as a number or a symbol. */
6554 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6555 doc
: /* Convert the event description list EVENT-DESC to an event type.
6556 EVENT-DESC should contain one base event type (a character or symbol)
6557 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6558 drag, down, double or triple). The base must be last.
6559 The return value is an event type (a character or symbol) which
6560 has the same base event type and all the specified modifiers. */)
6561 (Lisp_Object event_desc
)
6569 while (CONSP (rest
))
6577 /* Given a symbol, see if it is a modifier name. */
6578 if (SYMBOLP (elt
) && CONSP (rest
))
6579 this = parse_solitary_modifier (elt
);
6583 else if (!NILP (base
))
6584 error ("Two bases given in one event");
6590 /* Let the symbol A refer to the character A. */
6591 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6592 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6594 if (INTEGERP (base
))
6596 /* Turn (shift a) into A. */
6597 if ((modifiers
& shift_modifier
) != 0
6598 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6600 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6601 modifiers
&= ~shift_modifier
;
6604 /* Turn (control a) into C-a. */
6605 if (modifiers
& ctrl_modifier
)
6606 return make_number ((modifiers
& ~ctrl_modifier
)
6607 | make_ctrl_char (XINT (base
)));
6609 return make_number (modifiers
| XINT (base
));
6611 else if (SYMBOLP (base
))
6612 return apply_modifiers (modifiers
, base
);
6615 error ("Invalid base event");
6620 /* Try to recognize SYMBOL as a modifier name.
6621 Return the modifier flag bit, or 0 if not recognized. */
6624 parse_solitary_modifier (Lisp_Object symbol
)
6626 Lisp_Object name
= SYMBOL_NAME (symbol
);
6628 switch (SREF (name
, 0))
6630 #define SINGLE_LETTER_MOD(BIT) \
6631 if (SBYTES (name) == 1) \
6634 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6635 if (LEN == SBYTES (name) \
6636 && ! memcmp (SDATA (name), NAME, LEN)) \
6640 SINGLE_LETTER_MOD (alt_modifier
);
6644 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6648 SINGLE_LETTER_MOD (ctrl_modifier
);
6652 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6653 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6657 SINGLE_LETTER_MOD (hyper_modifier
);
6661 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6665 SINGLE_LETTER_MOD (meta_modifier
);
6669 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6673 SINGLE_LETTER_MOD (shift_modifier
);
6677 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6678 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6679 SINGLE_LETTER_MOD (super_modifier
);
6683 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6684 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6685 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6689 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6692 #undef SINGLE_LETTER_MOD
6693 #undef MULTI_LETTER_MOD
6699 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6700 Such a list is not valid as an event,
6701 but it can be a Lucid-style event type list. */
6704 lucid_event_type_list_p (Lisp_Object object
)
6708 if (! CONSP (object
))
6711 if (EQ (XCAR (object
), Qhelp_echo
)
6712 || EQ (XCAR (object
), Qvertical_line
)
6713 || EQ (XCAR (object
), Qmode_line
)
6714 || EQ (XCAR (object
), Qheader_line
))
6717 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6721 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6728 /* Store into *addr a value nonzero if terminal input chars are available.
6729 Serves the purpose of ioctl (0, FIONREAD, addr)
6730 but works even if FIONREAD does not exist.
6731 (In fact, this may actually read some input.)
6733 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6734 timer events that are ripe.
6735 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6736 events (FOCUS_IN_EVENT).
6737 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6738 movements and toolkit scroll bar thumb drags. */
6741 get_input_pending (int *addr
, int flags
)
6743 /* First of all, have we already counted some input? */
6744 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6746 /* If input is being read as it arrives, and we have none, there is none. */
6747 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6750 /* Try to read some input and see how much we get. */
6752 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6755 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6761 if (interrupt_input
)
6763 sigset_t blocked
, procmask
;
6764 sigemptyset (&blocked
);
6765 sigaddset (&blocked
, SIGIO
);
6766 pthread_sigmask (SIG_BLOCK
, &blocked
, &procmask
);
6767 read_avail_input ();
6768 pthread_sigmask (SIG_SETMASK
, &procmask
, 0);
6771 #ifdef POLL_FOR_INPUT
6772 /* XXX This condition was (read_socket_hook && !interrupt_input),
6773 but read_socket_hook is not global anymore. Let's pretend that
6775 if (!interrupt_input
&& poll_suppress_count
== 0)
6777 sigset_t blocked
, procmask
;
6778 sigemptyset (&blocked
);
6779 sigaddset (&blocked
, SIGALRM
);
6780 pthread_sigmask (SIG_BLOCK
, &blocked
, &procmask
);
6781 read_avail_input ();
6782 pthread_sigmask (SIG_SETMASK
, &procmask
, 0);
6787 read_avail_input ();
6790 /* Put a BUFFER_SWITCH_EVENT in the buffer
6791 so that read_key_sequence will notice the new current buffer. */
6794 record_asynch_buffer_change (void)
6796 struct input_event event
;
6800 event
.kind
= BUFFER_SWITCH_EVENT
;
6801 event
.frame_or_window
= Qnil
;
6804 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6805 The purpose of the event is to make read_key_sequence look up the
6806 keymaps again. If we aren't in read_key_sequence, we don't need one,
6807 and the event could cause trouble by messing up (input-pending-p).
6808 Note: Fwaiting_for_user_input_p always returns nil when async
6809 subprocesses aren't supported. */
6810 tem
= Fwaiting_for_user_input_p ();
6814 /* Make sure no interrupt happens while storing the event. */
6816 if (interrupt_input
)
6818 sigset_t blocked
, procmask
;
6819 sigemptyset (&blocked
);
6820 sigaddset (&blocked
, SIGIO
);
6821 pthread_sigmask (SIG_BLOCK
, &blocked
, &procmask
);
6822 kbd_buffer_store_event (&event
);
6823 pthread_sigmask (SIG_SETMASK
, &procmask
, 0);
6829 kbd_buffer_store_event (&event
);
6834 /* Read any terminal input already buffered up by the system
6835 into the kbd_buffer, but do not wait.
6837 EXPECTED should be nonzero if the caller knows there is some input.
6839 Returns the number of keyboard chars read, or -1 meaning
6840 this is a bad time to try to read input. */
6843 read_avail_input (void)
6849 /* Store pending user signal events, if any. */
6850 store_user_signal_events ();
6852 /* Loop through the available terminals, and call their input hooks. */
6856 struct terminal
*next
= t
->next_terminal
;
6858 if (t
->read_socket_hook
)
6861 struct input_event hold_quit
;
6863 EVENT_INIT (hold_quit
);
6864 hold_quit
.kind
= NO_EVENT
;
6866 /* No need for FIONREAD or fcntl; just say don't wait. */
6867 while (0 < (nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)))
6870 if (nr
== -1) /* Not OK to read input now. */
6874 else if (nr
== -2) /* Non-transient error. */
6876 /* The terminal device terminated; it should be closed. */
6878 /* Kill Emacs if this was our last terminal. */
6879 if (!terminal_list
->next_terminal
)
6880 /* Formerly simply reported no input, but that
6881 sometimes led to a failure of Emacs to terminate.
6882 SIGHUP seems appropriate if we can't reach the
6884 /* ??? Is it really right to send the signal just to
6885 this process rather than to the whole process
6886 group? Perhaps on systems with FIONREAD Emacs is
6887 alone in its group. */
6888 kill (getpid (), SIGHUP
);
6890 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6893 XSETTERMINAL (tmp
, t
);
6894 Fdelete_terminal (tmp
, Qnoelisp
);
6898 if (hold_quit
.kind
!= NO_EVENT
)
6899 kbd_buffer_store_event (&hold_quit
);
6908 frame_make_pointer_visible ();
6914 decode_keyboard_code (struct tty_display_info
*tty
,
6915 struct coding_system
*coding
,
6916 unsigned char *buf
, int nbytes
)
6918 unsigned char *src
= buf
;
6919 const unsigned char *p
;
6924 if (tty
->meta_key
!= 2)
6925 for (i
= 0; i
< nbytes
; i
++)
6927 if (coding
->carryover_bytes
> 0)
6929 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6930 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6931 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6932 nbytes
+= coding
->carryover_bytes
;
6934 coding
->destination
= alloca (nbytes
* 4);
6935 coding
->dst_bytes
= nbytes
* 4;
6936 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6937 if (coding
->produced_char
== 0)
6939 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6941 struct input_event event_buf
;
6943 EVENT_INIT (event_buf
);
6944 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6946 (ASCII_CHAR_P (event_buf
.code
)
6947 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6948 /* See the comment in tty_read_avail_input. */
6949 event_buf
.frame_or_window
= tty
->top_frame
;
6950 event_buf
.arg
= Qnil
;
6951 kbd_buffer_store_event (&event_buf
);
6955 /* This is the tty way of reading available input.
6957 Note that each terminal device has its own `struct terminal' object,
6958 and so this function is called once for each individual termcap
6959 terminal. The first parameter indicates which terminal to read from. */
6962 tty_read_avail_input (struct terminal
*terminal
,
6963 struct input_event
*hold_quit
)
6965 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6966 the kbd_buffer can really hold. That may prevent loss
6967 of characters on some systems when input is stuffed at us. */
6968 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6970 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6973 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6975 if (kbd_on_hold_p () || buffer_free
<= 0)
6977 #endif /* subprocesses */
6979 if (!terminal
->name
) /* Don't read from a dead terminal. */
6982 if (terminal
->type
!= output_termcap
6983 && terminal
->type
!= output_msdos_raw
)
6986 /* XXX I think the following code should be moved to separate hook
6987 functions in system-dependent files. */
6990 #else /* not WINDOWSNT */
6991 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6995 return 0; /* The terminal is suspended. */
6998 n_to_read
= dos_keysns ();
7002 cbuf
[0] = dos_keyread ();
7005 #else /* not MSDOS */
7010 struct input_event gpm_hold_quit
;
7011 int gpm
, fd
= gpm_fd
;
7013 EVENT_INIT (gpm_hold_quit
);
7014 gpm_hold_quit
.kind
= NO_EVENT
;
7016 /* gpm==1 if event received.
7017 gpm==0 if the GPM daemon has closed the connection, in which case
7018 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7019 we save it in `fd' so close_gpm can remove it from the
7021 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7022 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7023 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7026 /* Presumably the GPM daemon has closed the connection. */
7028 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7029 kbd_buffer_store_event (&gpm_hold_quit
);
7033 #endif /* HAVE_GPM */
7035 /* Determine how many characters we should *try* to read. */
7036 #ifdef USABLE_FIONREAD
7037 /* Find out how much input is available. */
7038 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7040 if (! noninteractive
)
7041 return -2; /* Close this terminal. */
7047 if (n_to_read
> sizeof cbuf
)
7048 n_to_read
= sizeof cbuf
;
7049 #elif defined USG || defined CYGWIN
7050 /* Read some input if available, but don't wait. */
7051 n_to_read
= sizeof cbuf
;
7052 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7054 # error "Cannot read without possibly delaying"
7058 /* Don't read more than we can store. */
7059 if (n_to_read
> buffer_free
)
7060 n_to_read
= buffer_free
;
7061 #endif /* subprocesses */
7063 /* Now read; for one reason or another, this will not block.
7064 NREAD is set to the number of chars read. */
7067 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7068 /* POSIX infers that processes which are not in the session leader's
7069 process group won't get SIGHUP's at logout time. BSDI adheres to
7070 this part standard and returns -1 from read (0) with errno==EIO
7071 when the control tty is taken away.
7072 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7073 if (nread
== -1 && errno
== EIO
)
7074 return -2; /* Close this terminal. */
7075 #if defined (AIX) && defined (_BSD)
7076 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7077 This looks incorrect, but it isn't, because _BSD causes
7078 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7079 and that causes a value other than 0 when there is no input. */
7081 return -2; /* Close this terminal. */
7085 /* We used to retry the read if it was interrupted.
7086 But this does the wrong thing when O_NDELAY causes
7087 an EAGAIN error. Does anybody know of a situation
7088 where a retry is actually needed? */
7090 nread
< 0 && (errno
== EAGAIN
7103 #ifndef USABLE_FIONREAD
7104 #if defined (USG) || defined (CYGWIN)
7105 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7106 #endif /* USG or CYGWIN */
7107 #endif /* no FIONREAD */
7112 #endif /* not MSDOS */
7113 #endif /* not WINDOWSNT */
7115 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7116 & CODING_REQUIRE_DECODING_MASK
)
7118 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7121 /* Decode the key sequence except for those with meta
7123 for (i
= from
= 0; ; i
++)
7124 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7126 struct input_event buf
;
7128 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7133 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7134 buf
.modifiers
= meta_modifier
;
7135 buf
.code
= cbuf
[i
] & ~0x80;
7136 /* See the comment below. */
7137 buf
.frame_or_window
= tty
->top_frame
;
7139 kbd_buffer_store_event (&buf
);
7145 for (i
= 0; i
< nread
; i
++)
7147 struct input_event buf
;
7149 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7151 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7152 buf
.modifiers
= meta_modifier
;
7153 if (tty
->meta_key
!= 2)
7157 /* Set the frame corresponding to the active tty. Note that the
7158 value of selected_frame is not reliable here, redisplay tends
7159 to temporarily change it. */
7160 buf
.frame_or_window
= tty
->top_frame
;
7163 kbd_buffer_store_event (&buf
);
7164 /* Don't look at input that follows a C-g too closely.
7165 This reduces lossage due to autorepeat on C-g. */
7166 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7167 && buf
.code
== quit_char
)
7175 handle_async_input (void)
7177 interrupt_input_pending
= 0;
7178 pending_signals
= pending_atimers
;
7182 int nread
= read_avail_input ();
7183 /* -1 means it's not ok to read the input now.
7184 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7185 0 means there was no keyboard input available. */
7192 process_pending_signals (void)
7194 if (interrupt_input_pending
)
7195 handle_async_input ();
7196 do_pending_atimers ();
7202 handle_input_available_signal (int sig
)
7204 interrupt_input_pending
= 1;
7205 pending_signals
= 1;
7207 if (input_available_clear_time
)
7208 *input_available_clear_time
= make_emacs_time (0, 0);
7212 deliver_input_available_signal (int sig
)
7214 handle_on_main_thread (sig
, handle_input_available_signal
);
7216 #endif /* USABLE_SIGIO */
7218 /* Send ourselves a SIGIO.
7220 This function exists so that the UNBLOCK_INPUT macro in
7221 blockinput.h can have some way to take care of input we put off
7222 dealing with, without assuming that every file which uses
7223 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7225 reinvoke_input_signal (void)
7228 handle_async_input ();
7234 /* User signal events. */
7236 struct user_signal_info
7238 /* Signal number. */
7241 /* Name of the signal. */
7244 /* Number of pending signals. */
7247 struct user_signal_info
*next
;
7250 /* List of user signals. */
7251 static struct user_signal_info
*user_signals
= NULL
;
7254 add_user_signal (int sig
, const char *name
)
7256 struct sigaction action
;
7257 struct user_signal_info
*p
;
7259 for (p
= user_signals
; p
; p
= p
->next
)
7261 /* Already added. */
7264 p
= xmalloc (sizeof *p
);
7266 p
->name
= xstrdup (name
);
7268 p
->next
= user_signals
;
7271 emacs_sigaction_init (&action
, deliver_user_signal
);
7272 sigaction (sig
, &action
, 0);
7276 handle_user_signal (int sig
)
7278 struct user_signal_info
*p
;
7279 const char *special_event_name
= NULL
;
7281 if (SYMBOLP (Vdebug_on_event
))
7282 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7284 for (p
= user_signals
; p
; p
= p
->next
)
7287 if (special_event_name
7288 && strcmp (special_event_name
, p
->name
) == 0)
7290 /* Enter the debugger in many ways. */
7291 debug_on_next_call
= 1;
7294 Vinhibit_quit
= Qnil
;
7296 /* Eat the event. */
7302 if (interrupt_input
)
7303 kill (getpid (), SIGIO
);
7307 /* Tell wait_reading_process_output that it needs to wake
7308 up and look around. */
7309 if (input_available_clear_time
)
7310 *input_available_clear_time
= make_emacs_time (0, 0);
7317 deliver_user_signal (int sig
)
7319 handle_on_main_thread (sig
, handle_user_signal
);
7323 find_user_signal_name (int sig
)
7325 struct user_signal_info
*p
;
7327 for (p
= user_signals
; p
; p
= p
->next
)
7335 store_user_signal_events (void)
7337 struct user_signal_info
*p
;
7338 struct input_event buf
;
7339 bool buf_initialized
= 0;
7341 for (p
= user_signals
; p
; p
= p
->next
)
7342 if (p
->npending
> 0)
7344 sigset_t blocked
, procmask
;
7346 if (! buf_initialized
)
7348 memset (&buf
, 0, sizeof buf
);
7349 buf
.kind
= USER_SIGNAL_EVENT
;
7350 buf
.frame_or_window
= selected_frame
;
7351 buf_initialized
= 1;
7354 sigemptyset (&blocked
);
7355 sigaddset (&blocked
, p
->sig
);
7356 pthread_sigmask (SIG_BLOCK
, &blocked
, &procmask
);
7361 kbd_buffer_store_event (&buf
);
7364 while (p
->npending
> 0);
7366 pthread_sigmask (SIG_SETMASK
, &procmask
, 0);
7371 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7372 static Lisp_Object menu_bar_one_keymap_changed_items
;
7374 /* These variables hold the vector under construction within
7375 menu_bar_items and its subroutines, and the current index
7376 for storing into that vector. */
7377 static Lisp_Object menu_bar_items_vector
;
7378 static int menu_bar_items_index
;
7381 static const char* separator_names
[] = {
7386 "single-dashed-line",
7387 "double-dashed-line",
7389 "shadow-etched-out",
7390 "shadow-etched-in-dash",
7391 "shadow-etched-out-dash",
7392 "shadow-double-etched-in",
7393 "shadow-double-etched-out",
7394 "shadow-double-etched-in-dash",
7395 "shadow-double-etched-out-dash",
7399 /* Return non-zero if LABEL specifies a separator. */
7402 menu_separator_name_p (const char *label
)
7406 else if (strlen (label
) > 3
7407 && memcmp (label
, "--", 2) == 0
7412 for (i
= 0; separator_names
[i
]; ++i
)
7413 if (strcmp (label
, separator_names
[i
]) == 0)
7418 /* It's a separator if it contains only dashes. */
7419 while (*label
== '-')
7421 return (*label
== 0);
7428 /* Return a vector of menu items for a menu bar, appropriate
7429 to the current buffer. Each item has three elements in the vector:
7432 OLD is an old vector we can optionally reuse, or nil. */
7435 menu_bar_items (Lisp_Object old
)
7437 /* The number of keymaps we're scanning right now, and the number of
7438 keymaps we have allocated space for. */
7441 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7442 in the current keymaps, or nil where it is not a prefix. */
7445 Lisp_Object def
, tail
;
7450 /* In order to build the menus, we need to call the keymap
7451 accessors. They all call QUIT. But this function is called
7452 during redisplay, during which a quit is fatal. So inhibit
7453 quitting while building the menus.
7454 We do this instead of specbind because (1) errors will clear it anyway
7455 and (2) this avoids risk of specpdl overflow. */
7456 oquit
= Vinhibit_quit
;
7460 menu_bar_items_vector
= old
;
7462 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7463 menu_bar_items_index
= 0;
7465 /* Build our list of keymaps.
7466 If we recognize a function key and replace its escape sequence in
7467 keybuf with its symbol, or if the sequence starts with a mouse
7468 click and we need to switch buffers, we jump back here to rebuild
7469 the initial keymaps from the current buffer. */
7473 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7474 if (!NILP (Voverriding_local_map_menu_flag
))
7476 /* Yes, use them (if non-nil) as well as the global map. */
7477 maps
= alloca (3 * sizeof (maps
[0]));
7479 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7480 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7481 if (!NILP (Voverriding_local_map
))
7482 maps
[nmaps
++] = Voverriding_local_map
;
7486 /* No, so use major and minor mode keymaps and keymap property.
7487 Note that menu-bar bindings in the local-map and keymap
7488 properties may not work reliable, as they are only
7489 recognized when the menu-bar (or mode-line) is updated,
7490 which does not normally happen after every command. */
7493 nminor
= current_minor_maps (NULL
, &tmaps
);
7494 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7496 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7497 maps
[nmaps
++] = tem
;
7498 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7500 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7502 maps
[nmaps
++] = current_global_map
;
7505 /* Look up in each map the dummy prefix key `menu-bar'. */
7507 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7508 if (!NILP (maps
[mapno
]))
7510 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7514 menu_bar_one_keymap_changed_items
= Qnil
;
7515 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7519 /* Move to the end those items that should be at the end. */
7521 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7524 int end
= menu_bar_items_index
;
7526 for (i
= 0; i
< end
; i
+= 4)
7527 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7529 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7530 /* Move the item at index I to the end,
7531 shifting all the others forward. */
7532 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7533 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7534 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7535 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7537 memmove (aref_addr (menu_bar_items_vector
, i
),
7538 aref_addr (menu_bar_items_vector
, i
+ 4),
7539 (end
- i
- 4) * word_size
);
7540 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7541 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7542 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7543 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7548 /* Add nil, nil, nil, nil at the end. */
7550 int i
= menu_bar_items_index
;
7551 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7552 menu_bar_items_vector
=
7553 larger_vector (menu_bar_items_vector
, 4, -1);
7554 /* Add this item. */
7555 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7556 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7557 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7558 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7559 menu_bar_items_index
= i
;
7562 Vinhibit_quit
= oquit
;
7563 return menu_bar_items_vector
;
7566 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7567 If there's already an item for KEY, add this DEF to it. */
7569 Lisp_Object item_properties
;
7572 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7574 struct gcpro gcpro1
;
7578 if (EQ (item
, Qundefined
))
7580 /* If a map has an explicit `undefined' as definition,
7581 discard any previously made menu bar item. */
7583 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7584 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7586 if (menu_bar_items_index
> i
+ 4)
7587 memmove (aref_addr (menu_bar_items_vector
, i
),
7588 aref_addr (menu_bar_items_vector
, i
+ 4),
7589 (menu_bar_items_index
- i
- 4) * word_size
);
7590 menu_bar_items_index
-= 4;
7594 /* If this keymap has already contributed to this KEY,
7595 don't contribute to it a second time. */
7596 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7597 if (!NILP (tem
) || NILP (item
))
7600 menu_bar_one_keymap_changed_items
7601 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7603 /* We add to menu_bar_one_keymap_changed_items before doing the
7604 parse_menu_item, so that if it turns out it wasn't a menu item,
7605 it still correctly hides any further menu item. */
7607 i
= parse_menu_item (item
, 1);
7612 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7614 /* Find any existing item for this KEY. */
7615 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7616 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7619 /* If we did not find this KEY, add it at the end. */
7620 if (i
== menu_bar_items_index
)
7622 /* If vector is too small, get a bigger one. */
7623 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7624 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7625 /* Add this item. */
7626 ASET (menu_bar_items_vector
, i
, key
); i
++;
7627 ASET (menu_bar_items_vector
, i
,
7628 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7629 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7630 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7631 menu_bar_items_index
= i
;
7633 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7637 old
= AREF (menu_bar_items_vector
, i
+ 2);
7638 /* If the new and the old items are not both keymaps,
7639 the lookup will only find `item'. */
7640 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7641 ASET (menu_bar_items_vector
, i
+ 2, item
);
7645 /* This is used as the handler when calling menu_item_eval_property. */
7647 menu_item_eval_property_1 (Lisp_Object arg
)
7649 /* If we got a quit from within the menu computation,
7650 quit all the way out of it. This takes care of C-] in the debugger. */
7651 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7652 Fsignal (Qquit
, Qnil
);
7658 eval_dyn (Lisp_Object form
)
7660 return Feval (form
, Qnil
);
7663 /* Evaluate an expression and return the result (or nil if something
7664 went wrong). Used to evaluate dynamic parts of menu items. */
7666 menu_item_eval_property (Lisp_Object sexpr
)
7668 ptrdiff_t count
= SPECPDL_INDEX ();
7670 specbind (Qinhibit_redisplay
, Qt
);
7671 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7672 menu_item_eval_property_1
);
7673 return unbind_to (count
, val
);
7676 /* This function parses a menu item and leaves the result in the
7677 vector item_properties.
7678 ITEM is a key binding, a possible menu item.
7679 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7681 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7682 parse_menu_item returns true if the item is a menu item and false
7686 parse_menu_item (Lisp_Object item
, int inmenubar
)
7688 Lisp_Object def
, tem
, item_string
, start
;
7690 Lisp_Object keyhint
;
7699 /* Create item_properties vector if necessary. */
7700 if (NILP (item_properties
))
7702 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7704 /* Initialize optional entries. */
7705 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7706 ASET (item_properties
, i
, Qnil
);
7707 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7709 /* Save the item here to protect it from GC. */
7710 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7712 item_string
= XCAR (item
);
7716 if (STRINGP (item_string
))
7718 /* Old format menu item. */
7719 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7721 /* Maybe help string. */
7722 if (CONSP (item
) && STRINGP (XCAR (item
)))
7724 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7729 /* Maybe an obsolete key binding cache. */
7730 if (CONSP (item
) && CONSP (XCAR (item
))
7731 && (NILP (XCAR (XCAR (item
)))
7732 || VECTORP (XCAR (XCAR (item
)))))
7735 /* This is the real definition--the function to run. */
7736 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7738 /* Get enable property, if any. */
7741 tem
= Fget (item
, Qmenu_enable
);
7742 if (!NILP (Venable_disabled_menus_and_buttons
))
7743 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7744 else if (!NILP (tem
))
7745 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7748 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7750 /* New format menu item. */
7751 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7752 start
= XCDR (item
);
7755 /* We have a real binding. */
7756 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7758 item
= XCDR (start
);
7759 /* Is there an obsolete cache list with key equivalences. */
7760 if (CONSP (item
) && CONSP (XCAR (item
)))
7763 /* Parse properties. */
7764 while (CONSP (item
) && CONSP (XCDR (item
)))
7769 if (EQ (tem
, QCenable
))
7771 if (!NILP (Venable_disabled_menus_and_buttons
))
7772 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7774 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7776 else if (EQ (tem
, QCvisible
))
7778 /* If got a visible property and that evaluates to nil
7779 then ignore this item. */
7780 tem
= menu_item_eval_property (XCAR (item
));
7784 else if (EQ (tem
, QChelp
))
7785 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7786 else if (EQ (tem
, QCfilter
))
7788 else if (EQ (tem
, QCkey_sequence
))
7791 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7792 /* Be GC protected. Set keyhint to item instead of tem. */
7795 else if (EQ (tem
, QCkeys
))
7798 if (CONSP (tem
) || STRINGP (tem
))
7799 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7801 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7806 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7808 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7810 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7816 else if (inmenubar
|| !NILP (start
))
7820 return 0; /* not a menu item */
7822 /* If item string is not a string, evaluate it to get string.
7823 If we don't get a string, skip this item. */
7824 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7825 if (!(STRINGP (item_string
)))
7827 item_string
= menu_item_eval_property (item_string
);
7828 if (!STRINGP (item_string
))
7830 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7833 /* If got a filter apply it on definition. */
7834 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7837 def
= menu_item_eval_property (list2 (XCAR (filter
),
7838 list2 (Qquote
, def
)));
7840 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7843 /* Enable or disable selection of item. */
7844 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7847 tem
= menu_item_eval_property (tem
);
7848 if (inmenubar
&& NILP (tem
))
7849 return 0; /* Ignore disabled items in menu bar. */
7850 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7853 /* If we got no definition, this item is just unselectable text which
7854 is OK in a submenu but not in the menubar. */
7856 return (!inmenubar
);
7858 /* See if this is a separate pane or a submenu. */
7859 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7860 tem
= get_keymap (def
, 0, 1);
7861 /* For a subkeymap, just record its details and exit. */
7864 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7865 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7869 /* At the top level in the menu bar, do likewise for commands also.
7870 The menu bar does not display equivalent key bindings anyway.
7871 ITEM_PROPERTY_DEF is already set up properly. */
7875 { /* This is a command. See if there is an equivalent key binding. */
7876 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7878 /* The previous code preferred :key-sequence to :keys, so we
7879 preserve this behavior. */
7880 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7881 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7884 Lisp_Object prefix
= keyeq
;
7885 Lisp_Object keys
= Qnil
;
7889 def
= XCAR (prefix
);
7890 prefix
= XCDR (prefix
);
7893 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7895 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7897 keys
= XCAR (keyhint
);
7898 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7900 /* We have a suggested key. Is it bound to the command? */
7903 /* If the command is an alias for another
7904 (such as lmenu.el set it up), check if the
7905 original command matches the cached command. */
7907 && EQ (tem
, XSYMBOL (def
)->function
))))
7912 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7916 tem
= Fkey_description (keys
, Qnil
);
7919 if (STRINGP (XCAR (prefix
)))
7920 tem
= concat2 (XCAR (prefix
), tem
);
7921 if (STRINGP (XCDR (prefix
)))
7922 tem
= concat2 (tem
, XCDR (prefix
));
7924 keyeq
= concat2 (build_string (" "), tem
);
7925 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7931 /* If we have an equivalent key binding, use that. */
7932 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7935 /* Include this when menu help is implemented.
7936 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7937 if (!(NILP (tem) || STRINGP (tem)))
7939 tem = menu_item_eval_property (tem);
7942 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7946 /* Handle radio buttons or toggle boxes. */
7947 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7949 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7950 menu_item_eval_property (tem
));
7957 /***********************************************************************
7959 ***********************************************************************/
7961 /* A vector holding tool bar items while they are parsed in function
7962 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7965 static Lisp_Object tool_bar_items_vector
;
7967 /* A vector holding the result of parse_tool_bar_item. Layout is like
7968 the one for a single item in tool_bar_items_vector. */
7970 static Lisp_Object tool_bar_item_properties
;
7972 /* Next free index in tool_bar_items_vector. */
7974 static int ntool_bar_items
;
7976 /* The symbols `:image' and `:rtl'. */
7978 static Lisp_Object QCimage
;
7979 static Lisp_Object QCrtl
;
7981 /* Function prototypes. */
7983 static void init_tool_bar_items (Lisp_Object
);
7984 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7985 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7986 static void append_tool_bar_item (void);
7989 /* Return a vector of tool bar items for keymaps currently in effect.
7990 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7991 tool bar items found. */
7994 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8003 /* In order to build the menus, we need to call the keymap
8004 accessors. They all call QUIT. But this function is called
8005 during redisplay, during which a quit is fatal. So inhibit
8006 quitting while building the menus. We do this instead of
8007 specbind because (1) errors will clear it anyway and (2) this
8008 avoids risk of specpdl overflow. */
8009 oquit
= Vinhibit_quit
;
8012 /* Initialize tool_bar_items_vector and protect it from GC. */
8013 init_tool_bar_items (reuse
);
8015 /* Build list of keymaps in maps. Set nmaps to the number of maps
8018 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8019 if (!NILP (Voverriding_local_map_menu_flag
))
8021 /* Yes, use them (if non-nil) as well as the global map. */
8022 maps
= alloca (3 * sizeof *maps
);
8024 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8025 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8026 if (!NILP (Voverriding_local_map
))
8027 maps
[nmaps
++] = Voverriding_local_map
;
8031 /* No, so use major and minor mode keymaps and keymap property.
8032 Note that tool-bar bindings in the local-map and keymap
8033 properties may not work reliable, as they are only
8034 recognized when the tool-bar (or mode-line) is updated,
8035 which does not normally happen after every command. */
8038 nminor
= current_minor_maps (NULL
, &tmaps
);
8039 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
8041 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8042 maps
[nmaps
++] = tem
;
8043 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8045 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8048 /* Add global keymap at the end. */
8049 maps
[nmaps
++] = current_global_map
;
8051 /* Process maps in reverse order and look up in each map the prefix
8053 for (i
= nmaps
- 1; i
>= 0; --i
)
8054 if (!NILP (maps
[i
]))
8058 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8060 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8063 Vinhibit_quit
= oquit
;
8064 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8065 return tool_bar_items_vector
;
8069 /* Process the definition of KEY which is DEF. */
8072 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8075 struct gcpro gcpro1
, gcpro2
;
8077 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8081 if (EQ (def
, Qundefined
))
8083 /* If a map has an explicit `undefined' as definition,
8084 discard any previously made item. */
8085 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8087 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8089 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8091 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8092 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8093 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8095 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8100 else if (parse_tool_bar_item (key
, def
))
8101 /* Append a new tool bar item to tool_bar_items_vector. Accept
8102 more than one definition for the same key. */
8103 append_tool_bar_item ();
8108 /* Access slot with index IDX of vector tool_bar_item_properties. */
8109 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8111 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8113 ASET (tool_bar_item_properties
, idx
, val
);
8117 /* Parse a tool bar item specification ITEM for key KEY and return the
8118 result in tool_bar_item_properties. Value is zero if ITEM is
8121 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8123 CAPTION is the caption of the item, If it's not a string, it is
8124 evaluated to get a string.
8126 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8127 as binding are currently ignored.
8129 The following properties are recognized:
8133 FORM is evaluated and specifies whether the tool bar item is
8134 enabled or disabled.
8138 FORM is evaluated and specifies whether the tool bar item is visible.
8140 - `:filter FUNCTION'
8142 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8143 result is stored as the new binding.
8145 - `:button (TYPE SELECTED)'
8147 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8148 and specifies whether the button is selected (pressed) or not.
8152 IMAGES is either a single image specification or a vector of four
8153 image specifications. See enum tool_bar_item_images.
8155 - `:help HELP-STRING'.
8157 Gives a help string to display for the tool bar item.
8159 - `:label LABEL-STRING'.
8161 A text label to show with the tool bar button if labels are enabled. */
8164 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8166 Lisp_Object filter
= Qnil
;
8167 Lisp_Object caption
;
8168 int i
, have_label
= 0;
8170 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8171 Rule out items that aren't lists, don't start with
8172 `menu-item' or whose rest following `tool-bar-item' is not a
8177 /* As an exception, allow old-style menu separators. */
8178 if (STRINGP (XCAR (item
)))
8179 item
= Fcons (XCAR (item
), Qnil
);
8180 else if (!EQ (XCAR (item
), Qmenu_item
)
8181 || (item
= XCDR (item
), !CONSP (item
)))
8184 /* Create tool_bar_item_properties vector if necessary. Reset it to
8186 if (VECTORP (tool_bar_item_properties
))
8188 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8192 tool_bar_item_properties
8193 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8196 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8197 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8199 /* Get the caption of the item. If the caption is not a string,
8200 evaluate it to get a string. If we don't get a string, skip this
8202 caption
= XCAR (item
);
8203 if (!STRINGP (caption
))
8205 caption
= menu_item_eval_property (caption
);
8206 if (!STRINGP (caption
))
8209 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8211 /* If the rest following the caption is not a list, the menu item is
8212 either a separator, or invalid. */
8216 if (menu_separator_name_p (SSDATA (caption
)))
8218 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8219 #if !defined (USE_GTK) && !defined (HAVE_NS)
8220 /* If we use build_desired_tool_bar_string to render the
8221 tool bar, the separator is rendered as an image. */
8222 PROP (TOOL_BAR_ITEM_IMAGES
)
8223 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8224 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8225 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8226 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8233 /* Store the binding. */
8234 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8237 /* Ignore cached key binding, if any. */
8238 if (CONSP (item
) && CONSP (XCAR (item
)))
8241 /* Process the rest of the properties. */
8242 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8244 Lisp_Object ikey
, value
;
8247 value
= XCAR (XCDR (item
));
8249 if (EQ (ikey
, QCenable
))
8251 /* `:enable FORM'. */
8252 if (!NILP (Venable_disabled_menus_and_buttons
))
8253 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8255 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8257 else if (EQ (ikey
, QCvisible
))
8259 /* `:visible FORM'. If got a visible property and that
8260 evaluates to nil then ignore this item. */
8261 if (NILP (menu_item_eval_property (value
)))
8264 else if (EQ (ikey
, QChelp
))
8265 /* `:help HELP-STRING'. */
8266 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8267 else if (EQ (ikey
, QCvert_only
))
8268 /* `:vert-only t/nil'. */
8269 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8270 else if (EQ (ikey
, QClabel
))
8272 const char *bad_label
= "!!?GARBLED ITEM?!!";
8273 /* `:label LABEL-STRING'. */
8274 set_prop (TOOL_BAR_ITEM_LABEL
,
8275 STRINGP (value
) ? value
: build_string (bad_label
));
8278 else if (EQ (ikey
, QCfilter
))
8279 /* ':filter FORM'. */
8281 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8283 /* `:button (TYPE . SELECTED)'. */
8284 Lisp_Object type
, selected
;
8286 type
= XCAR (value
);
8287 selected
= XCDR (value
);
8288 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8290 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8291 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8294 else if (EQ (ikey
, QCimage
)
8296 || (VECTORP (value
) && ASIZE (value
) == 4)))
8297 /* Value is either a single image specification or a vector
8298 of 4 such specifications for the different button states. */
8299 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8300 else if (EQ (ikey
, QCrtl
))
8302 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8308 /* Try to make one from caption and key. */
8309 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8310 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8311 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8312 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8314 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8315 char *buf
= xmalloc (max_lbl
+ 1);
8316 Lisp_Object new_lbl
;
8317 ptrdiff_t caption_len
= strlen (capt
);
8319 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8322 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8324 buf
[caption_len
] = '\0';
8328 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8332 strcpy (buf
, label
);
8334 for (j
= 0; buf
[j
] != '\0'; ++j
)
8342 new_lbl
= Fupcase_initials (build_string (label
));
8343 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8344 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8346 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8350 /* If got a filter apply it on binding. */
8352 set_prop (TOOL_BAR_ITEM_BINDING
,
8353 (menu_item_eval_property
8356 PROP (TOOL_BAR_ITEM_BINDING
))))));
8358 /* See if the binding is a keymap. Give up if it is. */
8359 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8362 /* Enable or disable selection of item. */
8363 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8364 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8365 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8367 /* Handle radio buttons or toggle boxes. */
8368 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8369 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8370 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8378 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8379 that can be reused. */
8382 init_tool_bar_items (Lisp_Object reuse
)
8384 if (VECTORP (reuse
))
8385 tool_bar_items_vector
= reuse
;
8387 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8388 ntool_bar_items
= 0;
8392 /* Append parsed tool bar item properties from
8393 tool_bar_item_properties */
8396 append_tool_bar_item (void)
8400 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8402 /* Enlarge tool_bar_items_vector if necessary. */
8404 tool_bar_items_vector
8405 = larger_vector (tool_bar_items_vector
, incr
, -1);
8407 /* Append entries from tool_bar_item_properties to the end of
8408 tool_bar_items_vector. */
8409 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8410 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8411 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8418 /* Read a character using menus based on maps in the array MAPS.
8419 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8420 Return t if we displayed a menu but the user rejected it.
8422 PREV_EVENT is the previous input event, or nil if we are reading
8423 the first event of a key sequence.
8425 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8426 if we used a mouse menu to read the input, or zero otherwise. If
8427 USED_MOUSE_MENU is null, we don't dereference it.
8429 The prompting is done based on the prompt-string of the map
8430 and the strings associated with various map elements.
8432 This can be done with X menus or with menus put in the minibuf.
8433 These are done in different ways, depending on how the input will be read.
8434 Menus using X are done after auto-saving in read-char, getting the input
8435 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8436 and do auto-saving in the inner call of read_char. */
8439 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8440 Lisp_Object prev_event
, int *used_mouse_menu
)
8446 if (used_mouse_menu
)
8447 *used_mouse_menu
= 0;
8449 /* Use local over global Menu maps */
8451 if (! menu_prompting
)
8454 /* Optionally disregard all but the global map. */
8455 if (inhibit_local_menu_bar_menus
)
8457 maps
+= (nmaps
- 1);
8462 /* If we got to this point via a mouse click,
8463 use a real menu for mouse selection. */
8464 if (EVENT_HAS_PARAMETERS (prev_event
)
8465 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8466 && !EQ (XCAR (prev_event
), Qtool_bar
))
8468 /* Display the menu and get the selection. */
8469 Lisp_Object
*realmaps
= alloca (nmaps
* sizeof *realmaps
);
8471 ptrdiff_t nmaps1
= 0;
8473 /* Use the maps that are not nil. */
8474 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8475 if (!NILP (maps
[mapno
]))
8476 realmaps
[nmaps1
++] = maps
[mapno
];
8478 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8483 record_menu_key (XCAR (value
));
8485 /* If we got multiple events, unread all but
8487 There is no way to prevent those unread events
8488 from showing up later in last_nonmenu_event.
8489 So turn symbol and integer events into lists,
8490 to indicate that they came from a mouse menu,
8491 so that when present in last_nonmenu_event
8492 they won't confuse things. */
8493 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8495 record_menu_key (XCAR (tem
));
8496 if (SYMBOLP (XCAR (tem
))
8497 || INTEGERP (XCAR (tem
)))
8498 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8501 /* If we got more than one event, put all but the first
8502 onto this list to be read later.
8503 Return just the first event now. */
8504 Vunread_command_events
8505 = nconc2 (XCDR (value
), Vunread_command_events
);
8506 value
= XCAR (value
);
8508 else if (NILP (value
))
8510 if (used_mouse_menu
)
8511 *used_mouse_menu
= 1;
8514 #endif /* HAVE_MENUS */
8518 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8519 We make this bigger when necessary, and never free it. */
8520 static char *read_char_minibuf_menu_text
;
8521 /* Size of that buffer. */
8522 static ptrdiff_t read_char_minibuf_menu_width
;
8525 read_char_minibuf_menu_prompt (int commandflag
,
8526 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8529 register Lisp_Object name
;
8531 /* FIXME: Use the minibuffer's frame width. */
8532 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8535 Lisp_Object rest
, vector
;
8541 if (! menu_prompting
)
8544 /* Get the menu name from the first map that has one (a prompt string). */
8545 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8547 name
= Fkeymap_prompt (maps
[mapno
]);
8552 /* If we don't have any menus, just read a character normally. */
8553 if (!STRINGP (name
))
8556 /* Make sure we have a big enough buffer for the menu text. */
8557 width
= max (width
, SBYTES (name
));
8558 if (STRING_BYTES_BOUND
- 4 < width
)
8559 memory_full (SIZE_MAX
);
8560 if (width
+ 4 > read_char_minibuf_menu_width
)
8562 read_char_minibuf_menu_text
8563 = xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8564 read_char_minibuf_menu_width
= width
+ 4;
8566 menu
= read_char_minibuf_menu_text
;
8568 /* Prompt string always starts with map's prompt, and a space. */
8569 strcpy (menu
, SSDATA (name
));
8570 nlength
= SBYTES (name
);
8571 menu
[nlength
++] = ':';
8572 menu
[nlength
++] = ' ';
8575 /* Start prompting at start of first map. */
8579 /* Present the documented bindings, a line at a time. */
8583 ptrdiff_t i
= nlength
;
8585 Lisp_Object orig_defn_macro
;
8587 /* Loop over elements of map. */
8592 /* If reached end of map, start at beginning of next map. */
8596 /* At end of last map, wrap around to first map if just starting,
8597 or end this line if already have something on it. */
8601 if (notfirst
|| nobindings
) break;
8606 /* Look at the next element of the map. */
8608 elt
= AREF (vector
, idx
);
8610 elt
= Fcar_safe (rest
);
8612 if (idx
< 0 && VECTORP (elt
))
8614 /* If we found a dense table in the keymap,
8615 advanced past it, but start scanning its contents. */
8616 rest
= Fcdr_safe (rest
);
8622 /* An ordinary element. */
8623 Lisp_Object event
, tem
;
8627 event
= Fcar_safe (elt
); /* alist */
8628 elt
= Fcdr_safe (elt
);
8632 XSETINT (event
, idx
); /* vector */
8635 /* Ignore the element if it has no prompt string. */
8636 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8638 /* 1 if the char to type matches the string. */
8640 Lisp_Object upcased_event
, downcased_event
;
8641 Lisp_Object desc
= Qnil
;
8643 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8645 upcased_event
= Fupcase (event
);
8646 downcased_event
= Fdowncase (event
);
8647 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8648 || XINT (downcased_event
) == SREF (s
, 0));
8650 desc
= Fsingle_key_description (event
, Qnil
);
8652 #if 0 /* It is redundant to list the equivalent key bindings because
8653 the prefix is what the user has already typed. */
8655 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8657 /* Insert equivalent keybinding. */
8658 s
= concat2 (s
, tem
);
8661 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8662 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8664 /* Insert button prefix. */
8665 Lisp_Object selected
8666 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8667 if (EQ (tem
, QCradio
))
8668 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8670 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8671 s
= concat2 (tem
, s
);
8675 /* If we have room for the prompt string, add it to this line.
8676 If this is the first on the line, always add it. */
8677 if ((SCHARS (s
) + i
+ 2
8678 + (char_matches
? 0 : SCHARS (desc
) + 3))
8682 ptrdiff_t thiswidth
;
8684 /* Punctuate between strings. */
8687 strcpy (menu
+ i
, ", ");
8693 /* If the char to type doesn't match the string's
8694 first char, explicitly show what char to type. */
8697 /* Add as much of string as fits. */
8698 thiswidth
= min (SCHARS (desc
), width
- i
);
8699 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8701 strcpy (menu
+ i
, " = ");
8705 /* Add as much of string as fits. */
8706 thiswidth
= min (SCHARS (s
), width
- i
);
8707 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8713 /* If this element does not fit, end the line now,
8714 and save the element for the next line. */
8715 strcpy (menu
+ i
, "...");
8720 /* Move past this element. */
8721 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8722 /* Handle reaching end of dense table. */
8727 rest
= Fcdr_safe (rest
);
8731 /* Prompt with that and read response. */
8732 message2_nolog (menu
, strlen (menu
),
8733 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8735 /* Make believe its not a keyboard macro in case the help char
8736 is pressed. Help characters are not recorded because menu prompting
8737 is not used on replay.
8739 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8740 kset_defining_kbd_macro (current_kboard
, Qnil
);
8742 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8743 while (BUFFERP (obj
));
8744 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8746 if (!INTEGERP (obj
))
8748 else if (XINT (obj
) == -2)
8751 if (! EQ (obj
, menu_prompt_more_char
)
8752 && (!INTEGERP (menu_prompt_more_char
)
8753 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8755 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8756 store_kbd_macro_char (obj
);
8759 /* Help char - go round again */
8763 /* Reading key sequences. */
8765 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8766 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8767 keymap, or nil otherwise. Return the index of the first keymap in
8768 which KEY has any binding, or NMAPS if no map has a binding.
8770 If KEY is a meta ASCII character, treat it like meta-prefix-char
8771 followed by the corresponding non-meta character. Keymaps in
8772 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8775 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8778 NEXT may be the same array as CURRENT. */
8781 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8782 Lisp_Object
*defs
, Lisp_Object
*next
)
8784 ptrdiff_t i
, first_binding
;
8786 first_binding
= nmaps
;
8787 for (i
= nmaps
- 1; i
>= 0; i
--)
8789 if (! NILP (current
[i
]))
8791 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8792 if (! NILP (defs
[i
]))
8799 /* Given the set of bindings we've found, produce the next set of maps. */
8800 if (first_binding
< nmaps
)
8801 for (i
= 0; i
< nmaps
; i
++)
8802 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8804 return first_binding
;
8807 /* Structure used to keep track of partial application of key remapping
8808 such as Vfunction_key_map and Vkey_translation_map. */
8809 typedef struct keyremap
8811 /* This is the map originally specified for this use. */
8813 /* This is a submap reached by looking up, in PARENT,
8814 the events from START to END. */
8816 /* Positions [START, END) in the key sequence buffer
8817 are the key that we have scanned so far.
8818 Those events are the ones that we will replace
8819 if PARENT maps them into a key sequence. */
8823 /* Lookup KEY in MAP.
8824 MAP is a keymap mapping keys to key vectors or functions.
8825 If the mapping is a function and DO_FUNCTION is non-zero, then
8826 the function is called with PROMPT as parameter and its return
8827 value is used as the return value of this function (after checking
8828 that it is indeed a vector). */
8831 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8836 next
= access_keymap (map
, key
, 1, 0, 1);
8838 /* Handle a symbol whose function definition is a keymap
8840 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8841 && (ARRAYP (XSYMBOL (next
)->function
)
8842 || KEYMAPP (XSYMBOL (next
)->function
)))
8843 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8845 /* If the keymap gives a function, not an
8846 array, then call the function with one arg and use
8847 its value instead. */
8848 if (do_funcall
&& FUNCTIONP (next
))
8853 next
= call1 (next
, prompt
);
8854 /* If the function returned something invalid,
8855 barf--don't ignore it.
8856 (To ignore it safely, we would need to gcpro a bunch of
8857 other variables.) */
8858 if (! (VECTORP (next
) || STRINGP (next
)))
8859 error ("Function %s returns invalid key sequence",
8860 SSDATA (SYMBOL_NAME (tem
)));
8865 /* Do one step of the key remapping used for function-key-map and
8866 key-translation-map:
8867 KEYBUF is the buffer holding the input events.
8868 BUFSIZE is its maximum size.
8869 FKEY is a pointer to the keyremap structure to use.
8870 INPUT is the index of the last element in KEYBUF.
8871 DOIT if non-zero says that the remapping can actually take place.
8872 DIFF is used to return the number of keys added/removed by the remapping.
8873 PARENT is the root of the keymap.
8874 PROMPT is the prompt to use if the remapping happens through a function.
8875 The return value is non-zero if the remapping actually took place. */
8878 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8879 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8881 Lisp_Object next
, key
;
8883 key
= keybuf
[fkey
->end
++];
8885 if (KEYMAPP (fkey
->parent
))
8886 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8890 /* If keybuf[fkey->start..fkey->end] is bound in the
8891 map and we're in a position to do the key remapping, replace it with
8892 the binding and restart with fkey->start at the end. */
8893 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8895 int len
= XFASTINT (Flength (next
));
8898 *diff
= len
- (fkey
->end
- fkey
->start
);
8900 if (bufsize
- input
<= *diff
)
8901 error ("Key sequence too long");
8903 /* Shift the keys that follow fkey->end. */
8905 for (i
= fkey
->end
; i
< input
; i
++)
8906 keybuf
[i
+ *diff
] = keybuf
[i
];
8908 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8909 keybuf
[i
+ *diff
] = keybuf
[i
];
8910 /* Overwrite the old keys with the new ones. */
8911 for (i
= 0; i
< len
; i
++)
8912 keybuf
[fkey
->start
+ i
]
8913 = Faref (next
, make_number (i
));
8915 fkey
->start
= fkey
->end
+= *diff
;
8916 fkey
->map
= fkey
->parent
;
8921 fkey
->map
= get_keymap (next
, 0, 1);
8923 /* If we no longer have a bound suffix, try a new position for
8925 if (!CONSP (fkey
->map
))
8927 fkey
->end
= ++fkey
->start
;
8928 fkey
->map
= fkey
->parent
;
8934 test_undefined (Lisp_Object binding
)
8936 return (EQ (binding
, Qundefined
)
8937 || (!NILP (binding
) && SYMBOLP (binding
)
8938 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8941 /* Read a sequence of keys that ends with a non prefix character,
8942 storing it in KEYBUF, a buffer of size BUFSIZE.
8944 Return the length of the key sequence stored.
8945 Return -1 if the user rejected a command menu.
8947 Echo starting immediately unless `prompt' is 0.
8949 Where a key sequence ends depends on the currently active keymaps.
8950 These include any minor mode keymaps active in the current buffer,
8951 the current buffer's local map, and the global map.
8953 If a key sequence has no other bindings, we check Vfunction_key_map
8954 to see if some trailing subsequence might be the beginning of a
8955 function key's sequence. If so, we try to read the whole function
8956 key, and substitute its symbolic name into the key sequence.
8958 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8959 `double-' events into similar click events, if that would make them
8960 bound. We try to turn `triple-' events first into `double-' events,
8963 If we get a mouse click in a mode line, vertical divider, or other
8964 non-text area, we treat the click as if it were prefixed by the
8965 symbol denoting that area - `mode-line', `vertical-line', or
8968 If the sequence starts with a mouse click, we read the key sequence
8969 with respect to the buffer clicked on, not the current buffer.
8971 If the user switches frames in the midst of a key sequence, we put
8972 off the switch-frame event until later; the next call to
8973 read_char will return it.
8975 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8976 from the selected window's buffer. */
8979 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8980 int dont_downcase_last
, int can_return_switch_frame
,
8981 int fix_current_buffer
)
8983 Lisp_Object from_string
;
8984 ptrdiff_t count
= SPECPDL_INDEX ();
8986 /* How many keys there are in the current key sequence. */
8989 /* The length of the echo buffer when we started reading, and
8990 the length of this_command_keys when we started reading. */
8991 ptrdiff_t echo_start
IF_LINT (= 0);
8992 ptrdiff_t keys_start
;
8994 /* The number of keymaps we're scanning right now, and the number of
8995 keymaps we have allocated space for. */
8997 ptrdiff_t nmaps_allocated
= 0;
8999 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9000 the current keymaps. */
9001 Lisp_Object
*defs
= NULL
;
9003 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9004 in the current keymaps, or nil where it is not a prefix. */
9005 Lisp_Object
*submaps
= NULL
;
9007 /* The local map to start out with at start of key sequence. */
9008 Lisp_Object orig_local_map
;
9010 /* The map from the `keymap' property to start out with at start of
9012 Lisp_Object orig_keymap
;
9014 /* 1 if we have already considered switching to the local-map property
9015 of the place where a mouse click occurred. */
9016 int localized_local_map
= 0;
9018 /* The index in submaps[] of the first keymap that has a binding for
9019 this key sequence. In other words, the lowest i such that
9020 submaps[i] is non-nil. */
9021 ptrdiff_t first_binding
;
9022 /* Index of the first key that has no binding.
9023 It is useless to try fkey.start larger than that. */
9026 /* If t < mock_input, then KEYBUF[t] should be read as the next
9029 We use this to recover after recognizing a function key. Once we
9030 realize that a suffix of the current key sequence is actually a
9031 function key's escape sequence, we replace the suffix with the
9032 function key's binding from Vfunction_key_map. Now keybuf
9033 contains a new and different key sequence, so the echo area,
9034 this_command_keys, and the submaps and defs arrays are wrong. In
9035 this situation, we set mock_input to t, set t to 0, and jump to
9036 restart_sequence; the loop will read keys from keybuf up until
9037 mock_input, thus rebuilding the state; and then it will resume
9038 reading characters from the keyboard. */
9041 /* If the sequence is unbound in submaps[], then
9042 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9043 and fkey.map is its binding.
9045 These might be > t, indicating that all function key scanning
9046 should hold off until t reaches them. We do this when we've just
9047 recognized a function key, to avoid searching for the function
9048 key's again in Vfunction_key_map. */
9051 /* Likewise, for key_translation_map and input-decode-map. */
9052 keyremap keytran
, indec
;
9054 /* Non-zero if we are trying to map a key by changing an upper-case
9055 letter to lower case, or a shifted function key to an unshifted
9057 int shift_translated
= 0;
9059 /* If we receive a `switch-frame' or `select-window' event in the middle of
9060 a key sequence, we put it off for later.
9061 While we're reading, we keep the event here. */
9062 Lisp_Object delayed_switch_frame
;
9064 /* See the comment below... */
9065 #if defined (GOBBLE_FIRST_EVENT)
9066 Lisp_Object first_event
;
9069 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9070 int original_uppercase_position
= -1;
9072 /* Gets around Microsoft compiler limitations. */
9075 struct buffer
*starting_buffer
;
9077 /* List of events for which a fake prefix key has been generated. */
9078 Lisp_Object fake_prefixed_keys
= Qnil
;
9080 #if defined (GOBBLE_FIRST_EVENT)
9084 struct gcpro gcpro1
;
9086 GCPRO1 (fake_prefixed_keys
);
9087 raw_keybuf_count
= 0;
9089 last_nonmenu_event
= Qnil
;
9091 delayed_switch_frame
= Qnil
;
9097 /* Install the string STR as the beginning of the string of
9098 echoing, so that it serves as a prompt for the next
9100 kset_echo_string (current_kboard
, prompt
);
9101 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9104 else if (cursor_in_echo_area
9105 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9106 && NILP (Fzerop (Vecho_keystrokes
)))
9107 /* This doesn't put in a dash if the echo buffer is empty, so
9108 you don't always see a dash hanging out in the minibuffer. */
9112 /* Record the initial state of the echo area and this_command_keys;
9113 we will need to restore them if we replay a key sequence. */
9115 echo_start
= echo_length ();
9116 keys_start
= this_command_key_count
;
9117 this_single_command_key_start
= keys_start
;
9119 #if defined (GOBBLE_FIRST_EVENT)
9120 /* This doesn't quite work, because some of the things that read_char
9121 does cannot safely be bypassed. It seems too risky to try to make
9124 /* Read the first char of the sequence specially, before setting
9125 up any keymaps, in case a filter runs and switches buffers on us. */
9126 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9128 #endif /* GOBBLE_FIRST_EVENT */
9130 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9131 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9134 /* We jump here when we need to reinitialize fkey and keytran; this
9135 happens if we switch keyboards between rescans. */
9136 replay_entire_sequence
:
9138 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9139 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9140 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9141 indec
.start
= indec
.end
= 0;
9142 fkey
.start
= fkey
.end
= 0;
9143 keytran
.start
= keytran
.end
= 0;
9145 /* We jump here when the key sequence has been thoroughly changed, and
9146 we need to rescan it starting from the beginning. When we jump here,
9147 keybuf[0..mock_input] holds the sequence we should reread. */
9150 starting_buffer
= current_buffer
;
9151 first_unbound
= bufsize
+ 1;
9153 /* Build our list of keymaps.
9154 If we recognize a function key and replace its escape sequence in
9155 keybuf with its symbol, or if the sequence starts with a mouse
9156 click and we need to switch buffers, we jump back here to rebuild
9157 the initial keymaps from the current buffer. */
9160 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9162 if (2 > nmaps_allocated
)
9164 submaps
= alloca (2 * sizeof *submaps
);
9165 defs
= alloca (2 * sizeof *defs
);
9166 nmaps_allocated
= 2;
9168 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9170 else if (!NILP (Voverriding_local_map
))
9172 if (2 > nmaps_allocated
)
9174 submaps
= alloca (2 * sizeof *submaps
);
9175 defs
= alloca (2 * sizeof *defs
);
9176 nmaps_allocated
= 2;
9178 submaps
[nmaps
++] = Voverriding_local_map
;
9186 nminor
= current_minor_maps (0, &maps
);
9187 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9189 if (total
> nmaps_allocated
)
9191 submaps
= alloca (total
* sizeof *submaps
);
9192 defs
= alloca (total
* sizeof *defs
);
9193 nmaps_allocated
= total
;
9196 if (!NILP (orig_keymap
))
9197 submaps
[nmaps
++] = orig_keymap
;
9199 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9203 submaps
[nmaps
++] = orig_local_map
;
9205 submaps
[nmaps
++] = current_global_map
;
9207 /* Find an accurate initial value for first_binding. */
9208 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9209 if (! NILP (submaps
[first_binding
]))
9212 /* Start from the beginning in keybuf. */
9215 /* These are no-ops the first time through, but if we restart, they
9216 revert the echo area and this_command_keys to their original state. */
9217 this_command_key_count
= keys_start
;
9218 if (INTERACTIVE
&& t
< mock_input
)
9219 echo_truncate (echo_start
);
9221 /* If the best binding for the current key sequence is a keymap, or
9222 we may be looking at a function key's escape sequence, keep on
9224 while (first_binding
< nmaps
9225 /* Keep reading as long as there's a prefix binding. */
9226 ? !NILP (submaps
[first_binding
])
9227 /* Don't return in the middle of a possible function key sequence,
9228 if the only bindings we found were via case conversion.
9229 Thus, if ESC O a has a function-key-map translation
9230 and ESC o has a binding, don't return after ESC O,
9231 so that we can translate ESC O plus the next character. */
9232 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9235 int used_mouse_menu
= 0;
9237 /* Where the last real key started. If we need to throw away a
9238 key that has expanded into more than one element of keybuf
9239 (say, a mouse click on the mode line which is being treated
9240 as [mode-line (mouse-...)], then we backtrack to this point
9242 int last_real_key_start
;
9244 /* These variables are analogous to echo_start and keys_start;
9245 while those allow us to restart the entire key sequence,
9246 echo_local_start and keys_local_start allow us to throw away
9248 ptrdiff_t echo_local_start
IF_LINT (= 0);
9249 int keys_local_start
;
9250 ptrdiff_t local_first_binding
;
9252 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9253 eassert (indec
.start
<= indec
.end
);
9254 eassert (fkey
.start
<= fkey
.end
);
9255 eassert (keytran
.start
<= keytran
.end
);
9256 /* key-translation-map is applied *after* function-key-map
9257 which is itself applied *after* input-decode-map. */
9258 eassert (fkey
.end
<= indec
.start
);
9259 eassert (keytran
.end
<= fkey
.start
);
9261 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9262 first_unbound
< keytran
.start
)
9263 { /* The prefix upto first_unbound has no binding and has
9264 no translation left to do either, so we know it's unbound.
9265 If we don't stop now, we risk staying here indefinitely
9266 (if the user keeps entering fkey or keytran prefixes
9267 like C-c ESC ESC ESC ESC ...) */
9269 for (i
= first_unbound
+ 1; i
< t
; i
++)
9270 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9271 mock_input
= t
- first_unbound
- 1;
9272 indec
.end
= indec
.start
-= first_unbound
+ 1;
9273 indec
.map
= indec
.parent
;
9274 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9275 fkey
.map
= fkey
.parent
;
9276 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9277 keytran
.map
= keytran
.parent
;
9278 goto replay_sequence
;
9282 error ("Key sequence too long");
9285 echo_local_start
= echo_length ();
9286 keys_local_start
= this_command_key_count
;
9287 local_first_binding
= first_binding
;
9290 /* These are no-ops, unless we throw away a keystroke below and
9291 jumped back up to replay_key; in that case, these restore the
9292 variables to their original state, allowing us to replay the
9294 if (INTERACTIVE
&& t
< mock_input
)
9295 echo_truncate (echo_local_start
);
9296 this_command_key_count
= keys_local_start
;
9297 first_binding
= local_first_binding
;
9299 /* By default, assume each event is "real". */
9300 last_real_key_start
= t
;
9302 /* Does mock_input indicate that we are re-reading a key sequence? */
9306 add_command_key (key
);
9307 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9308 && NILP (Fzerop (Vecho_keystrokes
)))
9312 /* If not, we should actually read a character. */
9316 KBOARD
*interrupted_kboard
= current_kboard
;
9317 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9318 key
= read_char (NILP (prompt
), nmaps
,
9319 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9320 &used_mouse_menu
, NULL
);
9321 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9322 /* When switching to a new tty (with a new keyboard),
9323 read_char returns the new buffer, rather than -2
9324 (Bug#5095). This is because `terminal-init-xterm'
9325 calls read-char, which eats the wrong_kboard_jmpbuf
9326 return. Any better way to fix this? -- cyd */
9327 || (interrupted_kboard
!= current_kboard
))
9332 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9333 if (k
== interrupted_kboard
)
9338 /* Don't touch interrupted_kboard when it's been
9340 delayed_switch_frame
= Qnil
;
9341 goto replay_entire_sequence
;
9344 if (!NILP (delayed_switch_frame
))
9347 (interrupted_kboard
,
9348 Fcons (delayed_switch_frame
,
9349 KVAR (interrupted_kboard
, kbd_queue
)));
9350 delayed_switch_frame
= Qnil
;
9355 (interrupted_kboard
,
9356 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9358 /* If the side queue is non-empty, ensure it begins with a
9359 switch-frame, so we'll replay it in the right context. */
9360 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9361 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9362 !(EVENT_HAS_PARAMETERS (key
)
9363 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9367 XSETFRAME (frame
, interrupted_frame
);
9369 (interrupted_kboard
,
9370 Fcons (make_lispy_switch_frame (frame
),
9371 KVAR (interrupted_kboard
, kbd_queue
)));
9374 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9375 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9376 goto replay_entire_sequence
;
9380 /* read_char returns t when it shows a menu and the user rejects it.
9384 unbind_to (count
, Qnil
);
9389 /* read_char returns -1 at the end of a macro.
9390 Emacs 18 handles this by returning immediately with a
9391 zero, so that's what we'll do. */
9392 if (INTEGERP (key
) && XINT (key
) == -1)
9395 /* The Microsoft C compiler can't handle the goto that
9401 /* If the current buffer has been changed from under us, the
9402 keymap may have changed, so replay the sequence. */
9405 timer_resume_idle ();
9408 /* Reset the current buffer from the selected window
9409 in case something changed the former and not the latter.
9410 This is to be more consistent with the behavior
9411 of the command_loop_1. */
9412 if (fix_current_buffer
)
9414 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9416 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9417 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9420 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9421 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9422 goto replay_sequence
;
9425 /* If we have a quit that was typed in another frame, and
9426 quit_throw_to_read_char switched buffers,
9427 replay to get the right keymap. */
9429 && XINT (key
) == quit_char
9430 && current_buffer
!= starting_buffer
)
9433 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9438 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9439 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9440 goto replay_sequence
;
9445 if (EVENT_HAS_PARAMETERS (key
)
9446 /* Either a `switch-frame' or a `select-window' event. */
9447 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9449 /* If we're at the beginning of a key sequence, and the caller
9450 says it's okay, go ahead and return this event. If we're
9451 in the midst of a key sequence, delay it until the end. */
9452 if (t
> 0 || !can_return_switch_frame
)
9454 delayed_switch_frame
= key
;
9460 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9464 /* Clicks in non-text areas get prefixed by the symbol
9465 in their CHAR-ADDRESS field. For example, a click on
9466 the mode line is prefixed by the symbol `mode-line'.
9468 Furthermore, key sequences beginning with mouse clicks
9469 are read using the keymaps of the buffer clicked on, not
9470 the current buffer. So we may have to switch the buffer
9473 When we turn one event into two events, we must make sure
9474 that neither of the two looks like the original--so that,
9475 if we replay the events, they won't be expanded again.
9476 If not for this, such reexpansion could happen either here
9477 or when user programs play with this-command-keys. */
9478 if (EVENT_HAS_PARAMETERS (key
))
9483 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9484 if (EQ (kind
, Qmouse_click
))
9486 Lisp_Object window
, posn
;
9488 window
= POSN_WINDOW (EVENT_START (key
));
9489 posn
= POSN_POSN (EVENT_START (key
));
9492 || (!NILP (fake_prefixed_keys
)
9493 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9495 /* We're looking a second time at an event for which
9496 we generated a fake prefix key. Set
9497 last_real_key_start appropriately. */
9499 last_real_key_start
= t
- 1;
9502 if (last_real_key_start
== 0)
9504 /* Key sequences beginning with mouse clicks are
9505 read using the keymaps in the buffer clicked on,
9506 not the current buffer. If we're at the
9507 beginning of a key sequence, switch buffers. */
9508 if (WINDOWP (window
)
9509 && BUFFERP (XWINDOW (window
)->buffer
)
9510 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9512 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9517 /* Arrange to go back to the original buffer once we're
9518 done reading the key sequence. Note that we can't
9519 use save_excursion_{save,restore} here, because they
9520 save point as well as the current buffer; we don't
9521 want to save point, because redisplay may change it,
9522 to accommodate a Fset_window_start or something. We
9523 don't want to do this at the top of the function,
9524 because we may get input from a subprocess which
9525 wants to change the selected window and stuff (say,
9527 record_unwind_current_buffer ();
9529 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9531 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9532 orig_local_map
= get_local_map (PT
, current_buffer
,
9534 orig_keymap
= get_local_map (PT
, current_buffer
,
9536 goto replay_sequence
;
9539 /* For a mouse click, get the local text-property keymap
9540 of the place clicked on, rather than point. */
9541 if (CONSP (XCDR (key
))
9542 && ! localized_local_map
)
9544 Lisp_Object map_here
, start
, pos
;
9546 localized_local_map
= 1;
9547 start
= EVENT_START (key
);
9549 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9551 pos
= POSN_BUFFER_POSN (start
);
9553 && XINT (pos
) >= BEGV
9554 && XINT (pos
) <= ZV
)
9556 map_here
= get_local_map (XINT (pos
),
9559 if (!EQ (map_here
, orig_local_map
))
9561 orig_local_map
= map_here
;
9562 ++localized_local_map
;
9565 map_here
= get_local_map (XINT (pos
),
9568 if (!EQ (map_here
, orig_keymap
))
9570 orig_keymap
= map_here
;
9571 ++localized_local_map
;
9574 if (localized_local_map
> 1)
9579 goto replay_sequence
;
9586 /* Expand mode-line and scroll-bar events into two events:
9587 use posn as a fake prefix key. */
9589 && (NILP (fake_prefixed_keys
)
9590 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9592 if (bufsize
- t
<= 1)
9593 error ("Key sequence too long");
9596 keybuf
[t
+ 1] = key
;
9599 /* Record that a fake prefix key has been generated
9600 for KEY. Don't modify the event; this would
9601 prevent proper action when the event is pushed
9602 back into unread-command-events. */
9603 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9605 /* If on a mode line string with a local keymap,
9606 reconsider the key sequence with that keymap. */
9607 if (string
= POSN_STRING (EVENT_START (key
)),
9608 (CONSP (string
) && STRINGP (XCAR (string
))))
9610 Lisp_Object pos
, map
, map2
;
9612 pos
= XCDR (string
);
9613 string
= XCAR (string
);
9615 && XINT (pos
) < SCHARS (string
))
9617 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9619 orig_local_map
= map
;
9620 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9623 if (!NILP (map
) || !NILP (map2
))
9624 goto replay_sequence
;
9630 else if (NILP (from_string
)
9631 && (string
= POSN_STRING (EVENT_START (key
)),
9632 (CONSP (string
) && STRINGP (XCAR (string
)))))
9634 /* For a click on a string, i.e. overlay string or a
9635 string displayed via the `display' property,
9636 consider `local-map' and `keymap' properties of
9638 Lisp_Object pos
, map
, map2
;
9640 pos
= XCDR (string
);
9641 string
= XCAR (string
);
9643 && XINT (pos
) < SCHARS (string
))
9645 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9647 orig_local_map
= map
;
9648 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9652 if (!NILP (map
) || !NILP (map2
))
9654 from_string
= string
;
9657 goto replay_sequence
;
9662 else if (CONSP (XCDR (key
))
9663 && CONSP (EVENT_START (key
))
9664 && CONSP (XCDR (EVENT_START (key
))))
9668 posn
= POSN_POSN (EVENT_START (key
));
9669 /* Handle menu-bar events:
9670 insert the dummy prefix event `menu-bar'. */
9671 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9673 if (bufsize
- t
<= 1)
9674 error ("Key sequence too long");
9678 /* Zap the position in key, so we know that we've
9679 expanded it, and don't try to do so again. */
9680 POSN_SET_POSN (EVENT_START (key
),
9681 Fcons (posn
, Qnil
));
9684 goto replay_sequence
;
9686 else if (CONSP (posn
))
9688 /* We're looking at the second event of a
9689 sequence which we expanded before. Set
9690 last_real_key_start appropriately. */
9691 if (last_real_key_start
== t
&& t
> 0)
9692 last_real_key_start
= t
- 1;
9697 /* We have finally decided that KEY is something we might want
9699 first_binding
= (follow_key (key
,
9700 nmaps
- first_binding
,
9701 submaps
+ first_binding
,
9702 defs
+ first_binding
,
9703 submaps
+ first_binding
)
9706 /* If KEY wasn't bound, we'll try some fallbacks. */
9707 if (first_binding
< nmaps
)
9708 /* This is needed for the following scenario:
9709 event 0: a down-event that gets dropped by calling replay_key.
9710 event 1: some normal prefix like C-h.
9711 After event 0, first_unbound is 0, after event 1 indec.start,
9712 fkey.start, and keytran.start are all 1, so when we see that
9713 C-h is bound, we need to update first_unbound. */
9714 first_unbound
= max (t
+ 1, first_unbound
);
9719 /* Remember the position to put an upper bound on indec.start. */
9720 first_unbound
= min (t
, first_unbound
);
9722 head
= EVENT_HEAD (key
);
9723 if (help_char_p (head
) && t
> 0)
9725 read_key_sequence_cmd
= Vprefix_help_command
;
9727 last_nonmenu_event
= key
;
9728 /* The Microsoft C compiler can't handle the goto that
9736 Lisp_Object breakdown
;
9739 breakdown
= parse_modifiers (head
);
9740 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9741 /* Attempt to reduce an unbound mouse event to a simpler
9742 event that is bound:
9743 Drags reduce to clicks.
9744 Double-clicks reduce to clicks.
9745 Triple-clicks reduce to double-clicks, then to clicks.
9746 Down-clicks are eliminated.
9747 Double-downs reduce to downs, then are eliminated.
9748 Triple-downs reduce to double-downs, then to downs,
9749 then are eliminated. */
9750 if (modifiers
& (down_modifier
| drag_modifier
9751 | double_modifier
| triple_modifier
))
9753 while (modifiers
& (down_modifier
| drag_modifier
9754 | double_modifier
| triple_modifier
))
9756 Lisp_Object new_head
, new_click
;
9757 if (modifiers
& triple_modifier
)
9758 modifiers
^= (double_modifier
| triple_modifier
);
9759 else if (modifiers
& double_modifier
)
9760 modifiers
&= ~double_modifier
;
9761 else if (modifiers
& drag_modifier
)
9762 modifiers
&= ~drag_modifier
;
9765 /* Dispose of this `down' event by simply jumping
9766 back to replay_key, to get another event.
9768 Note that if this event came from mock input,
9769 then just jumping back to replay_key will just
9770 hand it to us again. So we have to wipe out any
9773 We could delete keybuf[t] and shift everything
9774 after that to the left by one spot, but we'd also
9775 have to fix up any variable that points into
9776 keybuf, and shifting isn't really necessary
9779 Adding prefixes for non-textual mouse clicks
9780 creates two characters of mock input, and both
9781 must be thrown away. If we're only looking at
9782 the prefix now, we can just jump back to
9783 replay_key. On the other hand, if we've already
9784 processed the prefix, and now the actual click
9785 itself is giving us trouble, then we've lost the
9786 state of the keymaps we want to backtrack to, and
9787 we need to replay the whole sequence to rebuild
9790 Beyond that, only function key expansion could
9791 create more than two keys, but that should never
9792 generate mouse events, so it's okay to zero
9793 mock_input in that case too.
9795 FIXME: The above paragraph seems just plain
9796 wrong, if you consider things like
9797 xterm-mouse-mode. -stef
9799 Isn't this just the most wonderful code ever? */
9801 /* If mock_input > t + 1, the above simplification
9802 will actually end up dropping keys on the floor.
9803 This is probably OK for now, but even
9804 if mock_input <= t + 1, we need to adjust indec,
9806 Typical case [header-line down-mouse-N]:
9807 mock_input = 2, t = 1, fkey.end = 1,
9808 last_real_key_start = 0. */
9809 if (indec
.end
> last_real_key_start
)
9811 indec
.end
= indec
.start
9812 = min (last_real_key_start
, indec
.start
);
9813 indec
.map
= indec
.parent
;
9814 if (fkey
.end
> last_real_key_start
)
9816 fkey
.end
= fkey
.start
9817 = min (last_real_key_start
, fkey
.start
);
9818 fkey
.map
= fkey
.parent
;
9819 if (keytran
.end
> last_real_key_start
)
9821 keytran
.end
= keytran
.start
9822 = min (last_real_key_start
, keytran
.start
);
9823 keytran
.map
= keytran
.parent
;
9827 if (t
== last_real_key_start
)
9834 mock_input
= last_real_key_start
;
9835 goto replay_sequence
;
9840 = apply_modifiers (modifiers
, XCAR (breakdown
));
9842 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9844 /* Look for a binding for this new key. follow_key
9845 promises that it didn't munge submaps the
9846 last time we called it, since key was unbound. */
9848 = (follow_key (new_click
,
9849 nmaps
- local_first_binding
,
9850 submaps
+ local_first_binding
,
9851 defs
+ local_first_binding
,
9852 submaps
+ local_first_binding
)
9853 + local_first_binding
);
9855 /* If that click is bound, go for it. */
9856 if (first_binding
< nmaps
)
9861 /* Otherwise, we'll leave key set to the drag event. */
9868 /* Normally, last_nonmenu_event gets the previous key we read.
9869 But when a mouse popup menu is being used,
9870 we don't update last_nonmenu_event; it continues to hold the mouse
9871 event that preceded the first level of menu. */
9872 if (!used_mouse_menu
)
9873 last_nonmenu_event
= key
;
9875 /* Record what part of this_command_keys is the current key sequence. */
9876 this_single_command_key_start
= this_command_key_count
- t
;
9878 /* Look for this sequence in input-decode-map.
9879 Scan from indec.end until we find a bound suffix. */
9880 while (indec
.end
< t
)
9882 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9885 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9886 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9891 mock_input
= diff
+ max (t
, mock_input
);
9892 goto replay_sequence
;
9896 if (first_binding
< nmaps
9897 && NILP (submaps
[first_binding
])
9898 && !test_undefined (defs
[first_binding
])
9899 && indec
.start
>= t
)
9900 /* There is a binding and it's not a prefix.
9901 (and it doesn't have any input-decode-map translation pending).
9902 There is thus no function-key in this sequence.
9903 Moving fkey.start is important in this case to allow keytran.start
9904 to go over the sequence before we return (since we keep the
9905 invariant that keytran.end <= fkey.start). */
9908 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9911 /* If the sequence is unbound, see if we can hang a function key
9912 off the end of it. */
9913 /* Continue scan from fkey.end until we find a bound suffix. */
9914 while (fkey
.end
< indec
.start
)
9916 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9919 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9920 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9921 max (t
, mock_input
),
9922 /* If there's a binding (i.e.
9923 first_binding >= nmaps) we don't want
9924 to apply this function-key-mapping. */
9926 && (first_binding
>= nmaps
9927 || test_undefined (defs
[first_binding
])),
9932 mock_input
= diff
+ max (t
, mock_input
);
9933 /* Adjust the input-decode-map counters. */
9935 indec
.start
+= diff
;
9937 goto replay_sequence
;
9941 /* Look for this sequence in key-translation-map.
9942 Scan from keytran.end until we find a bound suffix. */
9943 while (keytran
.end
< fkey
.start
)
9945 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9948 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9949 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9954 mock_input
= diff
+ max (t
, mock_input
);
9955 /* Adjust the function-key-map and input-decode-map counters. */
9957 indec
.start
+= diff
;
9961 goto replay_sequence
;
9965 /* If KEY is not defined in any of the keymaps,
9966 and cannot be part of a function key or translation,
9967 and is an upper case letter
9968 use the corresponding lower-case letter instead. */
9969 if (first_binding
>= nmaps
9970 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9972 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9973 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9974 || (XINT (key
) & shift_modifier
)))
9976 Lisp_Object new_key
;
9978 original_uppercase
= key
;
9979 original_uppercase_position
= t
- 1;
9981 if (XINT (key
) & shift_modifier
)
9982 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9984 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9985 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9987 /* We have to do this unconditionally, regardless of whether
9988 the lower-case char is defined in the keymaps, because they
9989 might get translated through function-key-map. */
9990 keybuf
[t
- 1] = new_key
;
9991 mock_input
= max (t
, mock_input
);
9992 shift_translated
= 1;
9994 goto replay_sequence
;
9996 /* If KEY is not defined in any of the keymaps,
9997 and cannot be part of a function key or translation,
9998 and is a shifted function key,
9999 use the corresponding unshifted function key instead. */
10000 if (first_binding
>= nmaps
10001 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10003 Lisp_Object breakdown
= parse_modifiers (key
);
10005 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10007 if (modifiers
& shift_modifier
10008 /* Treat uppercase keys as shifted. */
10010 && (KEY_TO_CHAR (key
)
10011 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
10012 && uppercasep (KEY_TO_CHAR (key
))))
10014 Lisp_Object new_key
10015 = (modifiers
& shift_modifier
10016 ? apply_modifiers (modifiers
& ~shift_modifier
,
10018 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
10020 original_uppercase
= key
;
10021 original_uppercase_position
= t
- 1;
10023 /* We have to do this unconditionally, regardless of whether
10024 the lower-case char is defined in the keymaps, because they
10025 might get translated through function-key-map. */
10026 keybuf
[t
- 1] = new_key
;
10027 mock_input
= max (t
, mock_input
);
10028 /* Reset fkey (and consequently keytran) to apply
10029 function-key-map on the result, so that S-backspace is
10030 correctly mapped to DEL (via backspace). OTOH,
10031 input-decode-map doesn't need to go through it again. */
10032 fkey
.start
= fkey
.end
= 0;
10033 keytran
.start
= keytran
.end
= 0;
10034 shift_translated
= 1;
10036 goto replay_sequence
;
10041 read_key_sequence_cmd
= (first_binding
< nmaps
10042 ? defs
[first_binding
]
10044 read_key_sequence_remapped
10045 /* Remap command through active keymaps.
10046 Do the remapping here, before the unbind_to so it uses the keymaps
10047 of the appropriate buffer. */
10048 = SYMBOLP (read_key_sequence_cmd
)
10049 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
10052 unread_switch_frame
= delayed_switch_frame
;
10053 unbind_to (count
, Qnil
);
10055 /* Don't downcase the last character if the caller says don't.
10056 Don't downcase it if the result is undefined, either. */
10057 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10059 && t
- 1 == original_uppercase_position
)
10061 keybuf
[t
- 1] = original_uppercase
;
10062 shift_translated
= 0;
10065 if (shift_translated
)
10066 Vthis_command_keys_shift_translated
= Qt
;
10068 /* Occasionally we fabricate events, perhaps by expanding something
10069 according to function-key-map, or by adding a prefix symbol to a
10070 mouse click in the scroll bar or modeline. In this cases, return
10071 the entire generated key sequence, even if we hit an unbound
10072 prefix or a definition before the end. This means that you will
10073 be able to push back the event properly, and also means that
10074 read-key-sequence will always return a logical unit.
10077 for (; t
< mock_input
; t
++)
10079 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10080 && NILP (Fzerop (Vecho_keystrokes
)))
10081 echo_char (keybuf
[t
]);
10082 add_command_key (keybuf
[t
]);
10089 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10090 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10091 The sequence is sufficient to specify a non-prefix command in the
10092 current local and global maps.
10094 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10095 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10096 as a continuation of the previous key.
10098 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10099 convert the last event to lower case. (Normally any upper case event
10100 is converted to lower case if the original event is undefined and the lower
10101 case equivalent is defined.) A non-nil value is appropriate for reading
10102 a key sequence to be defined.
10104 A C-g typed while in this function is treated like any other character,
10105 and `quit-flag' is not set.
10107 If the key sequence starts with a mouse click, then the sequence is read
10108 using the keymaps of the buffer of the window clicked in, not the buffer
10109 of the selected window as normal.
10111 `read-key-sequence' drops unbound button-down events, since you normally
10112 only care about the click or drag events which follow them. If a drag
10113 or multi-click event is unbound, but the corresponding click event would
10114 be bound, `read-key-sequence' turns the event into a click event at the
10115 drag's starting position. This means that you don't have to distinguish
10116 between click and drag, double, or triple events unless you want to.
10118 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10119 lines separating windows, and scroll bars with imaginary keys
10120 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10122 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10123 function will process a switch-frame event if the user switches frames
10124 before typing anything. If the user switches frames in the middle of a
10125 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10126 is nil, then the event will be put off until after the current key sequence.
10128 `read-key-sequence' checks `function-key-map' for function key
10129 sequences, where they wouldn't conflict with ordinary bindings. See
10130 `function-key-map' for more details.
10132 The optional fifth argument CMD-LOOP, if non-nil, means
10133 that this key sequence is being read by something that will
10134 read commands one after another. It should be nil if the caller
10135 will read just one key sequence. */)
10136 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10138 Lisp_Object keybuf
[30];
10140 struct gcpro gcpro1
;
10141 ptrdiff_t count
= SPECPDL_INDEX ();
10143 if (!NILP (prompt
))
10144 CHECK_STRING (prompt
);
10147 specbind (Qinput_method_exit_on_first_char
,
10148 (NILP (cmd_loop
) ? Qt
: Qnil
));
10149 specbind (Qinput_method_use_echo_area
,
10150 (NILP (cmd_loop
) ? Qt
: Qnil
));
10152 memset (keybuf
, 0, sizeof keybuf
);
10153 GCPRO1 (keybuf
[0]);
10154 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10156 if (NILP (continue_echo
))
10158 this_command_key_count
= 0;
10159 this_command_key_count_reset
= 0;
10160 this_single_command_key_start
= 0;
10163 #ifdef HAVE_WINDOW_SYSTEM
10164 if (display_hourglass_p
)
10165 cancel_hourglass ();
10168 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10169 prompt
, ! NILP (dont_downcase_last
),
10170 ! NILP (can_return_switch_frame
), 0);
10172 #if 0 /* The following is fine for code reading a key sequence and
10173 then proceeding with a lengthy computation, but it's not good
10174 for code reading keys in a loop, like an input method. */
10175 #ifdef HAVE_WINDOW_SYSTEM
10176 if (display_hourglass_p
)
10177 start_hourglass ();
10187 return unbind_to (count
, make_event_array (i
, keybuf
));
10190 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10191 Sread_key_sequence_vector
, 1, 5, 0,
10192 doc
: /* Like `read-key-sequence' but always return a vector. */)
10193 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10195 Lisp_Object keybuf
[30];
10197 struct gcpro gcpro1
;
10198 ptrdiff_t count
= SPECPDL_INDEX ();
10200 if (!NILP (prompt
))
10201 CHECK_STRING (prompt
);
10204 specbind (Qinput_method_exit_on_first_char
,
10205 (NILP (cmd_loop
) ? Qt
: Qnil
));
10206 specbind (Qinput_method_use_echo_area
,
10207 (NILP (cmd_loop
) ? Qt
: Qnil
));
10209 memset (keybuf
, 0, sizeof keybuf
);
10210 GCPRO1 (keybuf
[0]);
10211 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10213 if (NILP (continue_echo
))
10215 this_command_key_count
= 0;
10216 this_command_key_count_reset
= 0;
10217 this_single_command_key_start
= 0;
10220 #ifdef HAVE_WINDOW_SYSTEM
10221 if (display_hourglass_p
)
10222 cancel_hourglass ();
10225 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10226 prompt
, ! NILP (dont_downcase_last
),
10227 ! NILP (can_return_switch_frame
), 0);
10229 #ifdef HAVE_WINDOW_SYSTEM
10230 if (display_hourglass_p
)
10231 start_hourglass ();
10240 return unbind_to (count
, Fvector (i
, keybuf
));
10243 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10244 doc
: /* Execute CMD as an editor command.
10245 CMD must be a symbol that satisfies the `commandp' predicate.
10246 Optional second arg RECORD-FLAG non-nil
10247 means unconditionally put this command in `command-history'.
10248 Otherwise, that is done only if an arg is read using the minibuffer.
10249 The argument KEYS specifies the value to use instead of (this-command-keys)
10250 when reading the arguments; if it is nil, (this-command-keys) is used.
10251 The argument SPECIAL, if non-nil, means that this command is executing
10252 a special event, so ignore the prefix argument and don't clear it. */)
10253 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10255 register Lisp_Object final
;
10256 register Lisp_Object tem
;
10257 Lisp_Object prefixarg
;
10259 debug_on_next_call
= 0;
10261 if (NILP (special
))
10263 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10264 Vcurrent_prefix_arg
= prefixarg
;
10265 kset_prefix_arg (current_kboard
, Qnil
);
10272 tem
= Fget (cmd
, Qdisabled
);
10275 tem
= Fsymbol_value (Qdisabled_command_function
);
10277 return Frun_hooks (1, &Qdisabled_command_function
);
10283 final
= Findirect_function (cmd
, Qnil
);
10285 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10287 struct gcpro gcpro1
, gcpro2
;
10289 GCPRO2 (cmd
, prefixarg
);
10290 Fautoload_do_load (final
, cmd
, Qnil
);
10297 if (STRINGP (final
) || VECTORP (final
))
10299 /* If requested, place the macro in the command history. For
10300 other sorts of commands, call-interactively takes care of
10302 if (!NILP (record_flag
))
10305 = Fcons (Fcons (Qexecute_kbd_macro
,
10306 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10309 /* Don't keep command history around forever. */
10310 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10312 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10314 XSETCDR (tem
, Qnil
);
10318 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10321 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10322 /* Don't call Fcall_interactively directly because we want to make
10323 sure the backtrace has an entry for `call-interactively'.
10324 For the same reason, pass `cmd' rather than `final'. */
10325 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10332 /* Return nonzero if input events are pending. */
10335 detect_input_pending (void)
10337 if (!input_pending
)
10338 get_input_pending (&input_pending
, 0);
10340 return input_pending
;
10343 /* Return nonzero if input events other than mouse movements are
10347 detect_input_pending_ignore_squeezables (void)
10349 if (!input_pending
)
10350 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10352 return input_pending
;
10355 /* Return nonzero if input events are pending, and run any pending timers. */
10358 detect_input_pending_run_timers (int do_display
)
10360 int old_timers_run
= timers_run
;
10362 if (!input_pending
)
10363 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10365 if (old_timers_run
!= timers_run
&& do_display
)
10367 redisplay_preserve_echo_area (8);
10368 /* The following fixes a bug when using lazy-lock with
10369 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10370 from an idle timer function. The symptom of the bug is that
10371 the cursor sometimes doesn't become visible until the next X
10372 event is processed. --gerd. */
10374 Lisp_Object tail
, frame
;
10375 FOR_EACH_FRAME (tail
, frame
)
10376 if (FRAME_RIF (XFRAME (frame
)))
10377 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10381 return input_pending
;
10384 /* This is called in some cases before a possible quit.
10385 It cases the next call to detect_input_pending to recompute input_pending.
10386 So calling this function unnecessarily can't do any harm. */
10389 clear_input_pending (void)
10394 /* Return nonzero if there are pending requeued events.
10395 This isn't used yet. The hope is to make wait_reading_process_output
10396 call it, and return if it runs Lisp code that unreads something.
10397 The problem is, kbd_buffer_get_event needs to be fixed to know what
10398 to do in that case. It isn't trivial. */
10401 requeued_events_pending_p (void)
10403 return (!NILP (Vunread_command_events
));
10407 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10408 doc
: /* Return t if command input is currently available with no wait.
10409 Actually, the value is nil only if we can be sure that no input is available;
10410 if there is a doubt, the value is t. */)
10413 if (!NILP (Vunread_command_events
)
10414 || !NILP (Vunread_post_input_method_events
)
10415 || !NILP (Vunread_input_method_events
))
10418 /* Process non-user-visible events (Bug#10195). */
10419 process_special_events ();
10421 get_input_pending (&input_pending
,
10422 READABLE_EVENTS_DO_TIMERS_NOW
10423 | READABLE_EVENTS_FILTER_EVENTS
);
10424 return input_pending
> 0 ? Qt
: Qnil
;
10427 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10428 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10431 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10434 if (total_keys
< NUM_RECENT_KEYS
)
10435 return Fvector (total_keys
, keys
);
10438 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10439 vcopy (val
, 0, keys
+ recent_keys_index
,
10440 NUM_RECENT_KEYS
- recent_keys_index
);
10441 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10442 keys
, recent_keys_index
);
10447 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10448 doc
: /* Return the key sequence that invoked this command.
10449 However, if the command has called `read-key-sequence', it returns
10450 the last key sequence that has been read.
10451 The value is a string or a vector.
10453 See also `this-command-keys-vector'. */)
10456 return make_event_array (this_command_key_count
,
10457 XVECTOR (this_command_keys
)->contents
);
10460 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10461 doc
: /* Return the key sequence that invoked this command, as a vector.
10462 However, if the command has called `read-key-sequence', it returns
10463 the last key sequence that has been read.
10465 See also `this-command-keys'. */)
10468 return Fvector (this_command_key_count
,
10469 XVECTOR (this_command_keys
)->contents
);
10472 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10473 Sthis_single_command_keys
, 0, 0, 0,
10474 doc
: /* Return the key sequence that invoked this command.
10475 More generally, it returns the last key sequence read, either by
10476 the command loop or by `read-key-sequence'.
10477 Unlike `this-command-keys', this function's value
10478 does not include prefix arguments.
10479 The value is always a vector. */)
10482 return Fvector (this_command_key_count
10483 - this_single_command_key_start
,
10484 (XVECTOR (this_command_keys
)->contents
10485 + this_single_command_key_start
));
10488 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10489 Sthis_single_command_raw_keys
, 0, 0, 0,
10490 doc
: /* Return the raw events that were read for this command.
10491 More generally, it returns the last key sequence read, either by
10492 the command loop or by `read-key-sequence'.
10493 Unlike `this-single-command-keys', this function's value
10494 shows the events before all translations (except for input methods).
10495 The value is always a vector. */)
10498 return Fvector (raw_keybuf_count
,
10499 (XVECTOR (raw_keybuf
)->contents
));
10502 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10503 Sreset_this_command_lengths
, 0, 0, 0,
10504 doc
: /* Make the unread events replace the last command and echo.
10505 Used in `universal-argument-other-key'.
10507 `universal-argument-other-key' rereads the event just typed.
10508 It then gets translated through `function-key-map'.
10509 The translated event has to replace the real events,
10510 both in the value of (this-command-keys) and in echoing.
10511 To achieve this, `universal-argument-other-key' calls
10512 `reset-this-command-lengths', which discards the record of reading
10513 these events the first time. */)
10516 this_command_key_count
= before_command_key_count
;
10517 if (this_command_key_count
< this_single_command_key_start
)
10518 this_single_command_key_start
= this_command_key_count
;
10520 echo_truncate (before_command_echo_length
);
10522 /* Cause whatever we put into unread-command-events
10523 to echo as if it were being freshly read from the keyboard. */
10524 this_command_key_count_reset
= 1;
10529 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10530 Sclear_this_command_keys
, 0, 1, 0,
10531 doc
: /* Clear out the vector that `this-command-keys' returns.
10532 Also clear the record of the last 100 events, unless optional arg
10533 KEEP-RECORD is non-nil. */)
10534 (Lisp_Object keep_record
)
10538 this_command_key_count
= 0;
10539 this_command_key_count_reset
= 0;
10541 if (NILP (keep_record
))
10543 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10544 ASET (recent_keys
, i
, Qnil
);
10546 recent_keys_index
= 0;
10551 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10552 doc
: /* Return the current depth in recursive edits. */)
10556 /* Wrap around reliably on integer overflow. */
10557 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10558 XSETINT (temp
, sum
);
10562 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10563 "FOpen dribble file: ",
10564 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10565 If FILE is nil, close any open dribble file.
10566 The file will be closed when Emacs exits. */)
10578 file
= Fexpand_file_name (file
, Qnil
);
10579 dribble
= fopen (SSDATA (file
), "w");
10581 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10586 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10587 doc
: /* Discard the contents of the terminal input buffer.
10588 Also end any kbd macro being defined. */)
10591 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10593 /* Discard the last command from the macro. */
10594 Fcancel_kbd_macro_events ();
10598 update_mode_lines
++;
10600 Vunread_command_events
= Qnil
;
10602 discard_tty_input ();
10604 kbd_fetch_ptr
= kbd_store_ptr
;
10610 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10611 doc
: /* Stop Emacs and return to superior process. You can resume later.
10612 If `cannot-suspend' is non-nil, or if the system doesn't support job
10613 control, run a subshell instead.
10615 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10616 to be read as terminal input by Emacs's parent, after suspension.
10618 Before suspending, run the normal hook `suspend-hook'.
10619 After resumption run the normal hook `suspend-resume-hook'.
10621 Some operating systems cannot stop the Emacs process and resume it later.
10622 On such systems, Emacs starts a subshell instead of suspending. */)
10623 (Lisp_Object stuffstring
)
10625 ptrdiff_t count
= SPECPDL_INDEX ();
10626 int old_height
, old_width
;
10628 struct gcpro gcpro1
;
10631 if (tty_list
&& tty_list
->next
)
10632 error ("There are other tty frames open; close them before suspending Emacs");
10634 if (!NILP (stuffstring
))
10635 CHECK_STRING (stuffstring
);
10637 /* Run the functions in suspend-hook. */
10638 hook
= intern ("suspend-hook");
10639 Frun_hooks (1, &hook
);
10641 GCPRO1 (stuffstring
);
10642 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10643 reset_all_sys_modes ();
10644 /* sys_suspend can get an error if it tries to fork a subshell
10645 and the system resources aren't available for that. */
10646 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10648 stuff_buffered_input (stuffstring
);
10649 if (cannot_suspend
)
10653 unbind_to (count
, Qnil
);
10655 /* Check if terminal/window size has changed.
10656 Note that this is not useful when we are running directly
10657 with a window system; but suspend should be disabled in that case. */
10658 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10659 if (width
!= old_width
|| height
!= old_height
)
10660 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10662 /* Run suspend-resume-hook. */
10663 hook
= intern ("suspend-resume-hook");
10664 Frun_hooks (1, &hook
);
10670 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10671 Then in any case stuff anything Emacs has read ahead and not used. */
10674 stuff_buffered_input (Lisp_Object stuffstring
)
10676 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10677 register unsigned char *p
;
10679 if (STRINGP (stuffstring
))
10681 register ptrdiff_t count
;
10683 p
= SDATA (stuffstring
);
10684 count
= SBYTES (stuffstring
);
10685 while (count
-- > 0)
10690 /* Anything we have read ahead, put back for the shell to read. */
10691 /* ?? What should this do when we have multiple keyboards??
10692 Should we ignore anything that was typed in at the "wrong" kboard?
10694 rms: we should stuff everything back into the kboard
10696 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10699 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10700 kbd_fetch_ptr
= kbd_buffer
;
10701 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10702 stuff_char (kbd_fetch_ptr
->code
);
10704 clear_event (kbd_fetch_ptr
);
10708 #endif /* SIGTSTP */
10712 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10714 input_available_clear_time
= time_to_clear
;
10716 /* Tell handle_interrupt to throw back to read_char, */
10717 waiting_for_input
= 1;
10719 /* If handle_interrupt was called before and buffered a C-g,
10720 make it run again now, to avoid timing error. */
10721 if (!NILP (Vquit_flag
))
10722 quit_throw_to_read_char (0);
10726 clear_waiting_for_input (void)
10728 /* Tell handle_interrupt not to throw back to read_char, */
10729 waiting_for_input
= 0;
10730 input_available_clear_time
= 0;
10733 /* The SIGINT handler.
10735 If we have a frame on the controlling tty, we assume that the
10736 SIGINT was generated by C-g, so we call handle_interrupt.
10737 Otherwise, tell QUIT to kill Emacs. */
10740 handle_interrupt_signal (int sig
)
10742 /* See if we have an active terminal on our controlling tty. */
10743 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10746 /* If there are no frames there, let's pretend that we are a
10747 well-behaving UN*X program and quit. We must not call Lisp
10748 in a signal handler, so tell QUIT to exit when it is
10750 Vquit_flag
= Qkill_emacs
;
10754 /* Otherwise, the SIGINT was probably generated by C-g. */
10756 /* Set internal_last_event_frame to the top frame of the
10757 controlling tty, if we have a frame there. We disable the
10758 interrupt key on secondary ttys, so the SIGINT must have come
10759 from the controlling tty. */
10760 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10762 handle_interrupt ();
10767 deliver_interrupt_signal (int sig
)
10769 handle_on_main_thread (sig
, handle_interrupt_signal
);
10773 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10774 of the number of times C-g has been requested. If C-g is pressed
10775 enough times, then quit anyway. See bug#6585. */
10776 static int force_quit_count
;
10778 /* This routine is called at interrupt level in response to C-g.
10780 It is called from the SIGINT handler or kbd_buffer_store_event.
10782 If `waiting_for_input' is non zero, then unless `echoing' is
10783 nonzero, immediately throw back to read_char.
10785 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10786 eval to throw, when it gets a chance. If quit-flag is already
10787 non-nil, it stops the job right away. */
10790 handle_interrupt (void)
10796 /* XXX This code needs to be revised for multi-tty support. */
10797 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10799 /* If SIGINT isn't blocked, don't let us be interrupted by
10800 another SIGINT, it might be harmful due to non-reentrancy
10801 in I/O functions. */
10803 sigemptyset (&blocked
);
10804 sigaddset (&blocked
, SIGINT
);
10805 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10808 reset_all_sys_modes ();
10810 #ifdef SIGTSTP /* Support possible in later USG versions */
10812 * On systems which can suspend the current process and return to the original
10813 * shell, this command causes the user to end up back at the shell.
10814 * The "Auto-save" and "Abort" questions are not asked until
10815 * the user elects to return to emacs, at which point he can save the current
10816 * job and either dump core or continue.
10820 /* Perhaps should really fork an inferior shell?
10821 But that would not provide any way to get back
10822 to the original shell, ever. */
10823 printf ("No support for stopping a process on this operating system;\n");
10824 printf ("you can continue or abort.\n");
10825 #endif /* not SIGTSTP */
10827 /* We must remain inside the screen area when the internal terminal
10828 is used. Note that [Enter] is not echoed by dos. */
10829 cursor_to (SELECTED_FRAME (), 0, 0);
10831 /* It doesn't work to autosave while GC is in progress;
10832 the code used for auto-saving doesn't cope with the mark bit. */
10833 if (!gc_in_progress
)
10835 printf ("Auto-save? (y or n) ");
10837 if (((c
= getchar ()) & ~040) == 'Y')
10839 Fdo_auto_save (Qt
, Qnil
);
10841 printf ("\r\nAuto-save done");
10842 #else /* not MSDOS */
10843 printf ("Auto-save done\n");
10844 #endif /* not MSDOS */
10846 while (c
!= '\n') c
= getchar ();
10850 /* During GC, it must be safe to reenable quitting again. */
10851 Vinhibit_quit
= Qnil
;
10854 #endif /* not MSDOS */
10855 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10856 printf ("but will instead do a real quit after garbage collection ends\r\n");
10861 printf ("\r\nAbort? (y or n) ");
10862 #else /* not MSDOS */
10863 printf ("Abort (and dump core)? (y or n) ");
10864 #endif /* not MSDOS */
10866 if (((c
= getchar ()) & ~040) == 'Y')
10868 while (c
!= '\n') c
= getchar ();
10870 printf ("\r\nContinuing...\r\n");
10871 #else /* not MSDOS */
10872 printf ("Continuing...\n");
10873 #endif /* not MSDOS */
10875 init_all_sys_modes ();
10876 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10880 /* If executing a function that wants to be interrupted out of
10881 and the user has not deferred quitting by binding `inhibit-quit'
10882 then quit right away. */
10883 if (immediate_quit
&& NILP (Vinhibit_quit
))
10885 struct gl_state_s saved
;
10886 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10888 immediate_quit
= 0;
10889 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10891 GCPRO4 (saved
.object
, saved
.global_code
,
10892 saved
.current_syntax_table
, saved
.old_prop
);
10893 Fsignal (Qquit
, Qnil
);
10894 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10899 { /* Else request quit when it's safe. */
10900 if (NILP (Vquit_flag
))
10901 force_quit_count
= 0;
10902 if (++force_quit_count
== 3)
10904 immediate_quit
= 1;
10905 Vinhibit_quit
= Qnil
;
10911 /* TODO: The longjmp in this call throws the NS event loop integration off,
10912 and it seems to do fine without this. Probably some attention
10913 needs to be paid to the setting of waiting_for_input in
10914 wait_reading_process_output() under HAVE_NS because of the call
10915 to ns_select there (needed because otherwise events aren't picked up
10916 outside of polling since we don't get SIGIO like X and we don't have a
10917 separate event loop thread like W32. */
10919 if (waiting_for_input
&& !echoing
)
10920 quit_throw_to_read_char (1);
10924 /* Handle a C-g by making read_char return C-g. */
10927 quit_throw_to_read_char (int from_signal
)
10929 /* When not called from a signal handler it is safe to call
10931 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10932 Fkill_emacs (Qnil
);
10934 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10935 /* Prevent another signal from doing this before we finish. */
10936 clear_waiting_for_input ();
10939 Vunread_command_events
= Qnil
;
10941 #if 0 /* Currently, sit_for is called from read_char without turning
10942 off polling. And that can call set_waiting_for_input.
10943 It seems to be harmless. */
10944 #ifdef POLL_FOR_INPUT
10945 /* May be > 1 if in recursive minibuffer. */
10946 if (poll_suppress_count
== 0)
10950 if (FRAMEP (internal_last_event_frame
)
10951 && !EQ (internal_last_event_frame
, selected_frame
))
10952 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10955 sys_longjmp (getcjmp
, 1);
10958 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10959 Sset_input_interrupt_mode
, 1, 1, 0,
10960 doc
: /* Set interrupt mode of reading keyboard input.
10961 If INTERRUPT is non-nil, Emacs will use input interrupts;
10962 otherwise Emacs uses CBREAK mode.
10964 See also `current-input-mode'. */)
10965 (Lisp_Object interrupt
)
10967 int new_interrupt_input
;
10968 #ifdef USABLE_SIGIO
10969 #ifdef HAVE_X_WINDOWS
10970 if (x_display_list
!= NULL
)
10972 /* When using X, don't give the user a real choice,
10973 because we haven't implemented the mechanisms to support it. */
10974 new_interrupt_input
= 1;
10977 #endif /* HAVE_X_WINDOWS */
10978 new_interrupt_input
= !NILP (interrupt
);
10979 #else /* not USABLE_SIGIO */
10980 new_interrupt_input
= 0;
10981 #endif /* not USABLE_SIGIO */
10983 if (new_interrupt_input
!= interrupt_input
)
10985 #ifdef POLL_FOR_INPUT
10989 /* this causes startup screen to be restored and messes with the mouse */
10990 reset_all_sys_modes ();
10991 interrupt_input
= new_interrupt_input
;
10992 init_all_sys_modes ();
10994 interrupt_input
= new_interrupt_input
;
10997 #ifdef POLL_FOR_INPUT
10998 poll_suppress_count
= 1;
11005 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11006 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11007 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11008 C-q in key sequences.
11010 This setting only has an effect on tty terminals and only when
11011 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11013 See also `current-input-mode'. */)
11014 (Lisp_Object flow
, Lisp_Object terminal
)
11016 struct terminal
*t
= get_terminal (terminal
, 1);
11017 struct tty_display_info
*tty
;
11018 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11020 tty
= t
->display_info
.tty
;
11022 if (tty
->flow_control
!= !NILP (flow
))
11025 /* this causes startup screen to be restored and messes with the mouse */
11026 reset_sys_modes (tty
);
11029 tty
->flow_control
= !NILP (flow
);
11032 init_sys_modes (tty
);
11038 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11039 doc
: /* Enable or disable 8-bit input on TERMINAL.
11040 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11041 bit as the Meta modifier.
11043 If META is nil, Emacs will ignore the top bit, on the assumption it is
11046 Otherwise, Emacs will accept and pass through 8-bit input without
11047 specially interpreting the top bit.
11049 This setting only has an effect on tty terminal devices.
11051 Optional parameter TERMINAL specifies the tty terminal device to use.
11052 It may be a terminal object, a frame, or nil for the terminal used by
11053 the currently selected frame.
11055 See also `current-input-mode'. */)
11056 (Lisp_Object meta
, Lisp_Object terminal
)
11058 struct terminal
*t
= get_terminal (terminal
, 1);
11059 struct tty_display_info
*tty
;
11062 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11064 tty
= t
->display_info
.tty
;
11068 else if (EQ (meta
, Qt
))
11073 if (tty
->meta_key
!= new_meta
)
11076 /* this causes startup screen to be restored and messes with the mouse */
11077 reset_sys_modes (tty
);
11080 tty
->meta_key
= new_meta
;
11083 init_sys_modes (tty
);
11089 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11090 doc
: /* Specify character used for quitting.
11091 QUIT must be an ASCII character.
11093 This function only has an effect on the controlling tty of the Emacs
11096 See also `current-input-mode'. */)
11099 struct terminal
*t
= get_named_tty ("/dev/tty");
11100 struct tty_display_info
*tty
;
11101 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11103 tty
= t
->display_info
.tty
;
11105 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11106 error ("QUIT must be an ASCII character");
11109 /* this causes startup screen to be restored and messes with the mouse */
11110 reset_sys_modes (tty
);
11113 /* Don't let this value be out of range. */
11114 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11117 init_sys_modes (tty
);
11123 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11124 doc
: /* Set mode of reading keyboard input.
11125 First arg INTERRUPT non-nil means use input interrupts;
11126 nil means use CBREAK mode.
11127 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11128 (no effect except in CBREAK mode).
11129 Third arg META t means accept 8-bit input (for a Meta key).
11130 META nil means ignore the top bit, on the assumption it is parity.
11131 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11132 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11133 See also `current-input-mode'. */)
11134 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11136 Fset_input_interrupt_mode (interrupt
);
11137 Fset_output_flow_control (flow
, Qnil
);
11138 Fset_input_meta_mode (meta
, Qnil
);
11140 Fset_quit_char (quit
);
11144 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11145 doc
: /* Return information about the way Emacs currently reads keyboard input.
11146 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11147 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11148 nil, Emacs is using CBREAK mode.
11149 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11150 terminal; this does not apply if Emacs uses interrupt-driven input.
11151 META is t if accepting 8-bit input with 8th bit as Meta flag.
11152 META nil means ignoring the top bit, on the assumption it is parity.
11153 META is neither t nor nil if accepting 8-bit input and using
11154 all 8 bits as the character code.
11155 QUIT is the character Emacs currently uses to quit.
11156 The elements of this list correspond to the arguments of
11157 `set-input-mode'. */)
11160 Lisp_Object val
[4];
11161 struct frame
*sf
= XFRAME (selected_frame
);
11163 val
[0] = interrupt_input
? Qt
: Qnil
;
11164 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11166 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11167 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11169 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11176 XSETFASTINT (val
[3], quit_char
);
11178 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11181 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11182 doc
: /* Return position information for pixel coordinates X and Y.
11183 By default, X and Y are relative to text area of the selected window.
11184 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11185 If optional fourth arg WHOLE is non-nil, X is relative to the left
11186 edge of the window.
11188 The return value is similar to a mouse click position:
11189 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11190 IMAGE (DX . DY) (WIDTH . HEIGHT))
11191 The `posn-' functions access elements of such lists. */)
11192 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11197 if (NILP (frame_or_window
))
11198 frame_or_window
= selected_window
;
11200 if (WINDOWP (frame_or_window
))
11202 struct window
*w
= decode_live_window (frame_or_window
);
11204 XSETINT (x
, (XINT (x
)
11205 + WINDOW_LEFT_EDGE_X (w
)
11207 ? window_box_left_offset (w
, TEXT_AREA
)
11209 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11210 frame_or_window
= w
->frame
;
11213 CHECK_LIVE_FRAME (frame_or_window
);
11215 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11218 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11219 doc
: /* Return position information for buffer POS in WINDOW.
11220 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11222 Return nil if position is not visible in window. Otherwise,
11223 the return value is similar to that returned by `event-start' for
11224 a mouse click at the upper left corner of the glyph corresponding
11225 to the given buffer position:
11226 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11227 IMAGE (DX . DY) (WIDTH . HEIGHT))
11228 The `posn-' functions access elements of such lists. */)
11229 (Lisp_Object pos
, Lisp_Object window
)
11234 window
= selected_window
;
11236 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11239 Lisp_Object x
= XCAR (tem
);
11240 Lisp_Object y
= XCAR (XCDR (tem
));
11242 /* Point invisible due to hscrolling? */
11245 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11253 * Set up a new kboard object with reasonable initial values.
11256 init_kboard (KBOARD
*kb
)
11258 kset_overriding_terminal_local_map (kb
, Qnil
);
11259 kset_last_command (kb
, Qnil
);
11260 kset_real_last_command (kb
, Qnil
);
11261 kset_keyboard_translate_table (kb
, Qnil
);
11262 kset_last_repeatable_command (kb
, Qnil
);
11263 kset_prefix_arg (kb
, Qnil
);
11264 kset_last_prefix_arg (kb
, Qnil
);
11265 kset_kbd_queue (kb
, Qnil
);
11266 kb
->kbd_queue_has_data
= 0;
11267 kb
->immediate_echo
= 0;
11268 kset_echo_string (kb
, Qnil
);
11269 kb
->echo_after_prompt
= -1;
11270 kb
->kbd_macro_buffer
= 0;
11271 kb
->kbd_macro_bufsize
= 0;
11272 kset_defining_kbd_macro (kb
, Qnil
);
11273 kset_last_kbd_macro (kb
, Qnil
);
11274 kb
->reference_count
= 0;
11275 kset_system_key_alist (kb
, Qnil
);
11276 kset_system_key_syms (kb
, Qnil
);
11277 kset_window_system (kb
, Qt
); /* Unset. */
11278 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
11279 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
11280 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11281 kset_default_minibuffer_frame (kb
, Qnil
);
11285 * Destroy the contents of a kboard object, but not the object itself.
11286 * We use this just before deleting it, or if we're going to initialize
11287 * it a second time.
11290 wipe_kboard (KBOARD
*kb
)
11292 xfree (kb
->kbd_macro_buffer
);
11295 /* Free KB and memory referenced from it. */
11298 delete_kboard (KBOARD
*kb
)
11302 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11305 *kbp
= kb
->next_kboard
;
11307 /* Prevent a dangling reference to KB. */
11308 if (kb
== current_kboard
11309 && FRAMEP (selected_frame
)
11310 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11312 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11314 if (current_kboard
== kb
)
11323 init_keyboard (void)
11325 /* This is correct before outermost invocation of the editor loop. */
11326 command_loop_level
= -1;
11327 immediate_quit
= 0;
11328 quit_char
= Ctl ('g');
11329 Vunread_command_events
= Qnil
;
11330 timer_idleness_start_time
= invalid_emacs_time ();
11332 recent_keys_index
= 0;
11333 kbd_fetch_ptr
= kbd_buffer
;
11334 kbd_store_ptr
= kbd_buffer
;
11335 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11336 do_mouse_tracking
= Qnil
;
11339 interrupt_input_blocked
= 0;
11340 interrupt_input_pending
= 0;
11341 pending_signals
= 0;
11343 /* This means that command_loop_1 won't try to select anything the first
11345 internal_last_event_frame
= Qnil
;
11346 Vlast_event_frame
= internal_last_event_frame
;
11348 current_kboard
= initial_kboard
;
11349 /* Re-initialize the keyboard again. */
11350 wipe_kboard (current_kboard
);
11351 init_kboard (current_kboard
);
11352 /* A value of nil for Vwindow_system normally means a tty, but we also use
11353 it for the initial terminal since there is no window system there. */
11354 kset_window_system (current_kboard
, Qnil
);
11356 if (!noninteractive
)
11358 /* Before multi-tty support, these handlers used to be installed
11359 only if the current session was a tty session. Now an Emacs
11360 session may have multiple display types, so we always handle
11361 SIGINT. There is special code in interrupt_signal to exit
11362 Emacs on SIGINT when there are no termcap frames on the
11363 controlling terminal. */
11364 struct sigaction action
;
11365 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
11366 sigaction (SIGINT
, &action
, 0);
11368 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11369 SIGQUIT and we can't tell which one it will give us. */
11370 sigaction (SIGQUIT
, &action
, 0);
11371 #endif /* not DOS_NT */
11373 #ifdef USABLE_SIGIO
11374 if (!noninteractive
)
11376 struct sigaction action
;
11377 emacs_sigaction_init (&action
, deliver_input_available_signal
);
11378 sigaction (SIGIO
, &action
, 0);
11382 /* Use interrupt input by default, if it works and noninterrupt input
11383 has deficiencies. */
11385 #ifdef INTERRUPT_INPUT
11386 interrupt_input
= 1;
11388 interrupt_input
= 0;
11391 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
11394 if (keyboard_init_hook
)
11395 (*keyboard_init_hook
) ();
11397 #ifdef POLL_FOR_INPUT
11399 poll_suppress_count
= 1;
11404 /* This type's only use is in syms_of_keyboard, to initialize the
11405 event header symbols and put properties on them. */
11406 struct event_head
{
11412 static const struct event_head head_table
[] = {
11413 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11414 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11415 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11416 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11417 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11418 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11419 /* `select-window' should be handled just like `switch-frame'
11420 in read_key_sequence. */
11421 {&Qselect_window
, "select-window", &Qswitch_frame
}
11425 syms_of_keyboard (void)
11427 pending_funcalls
= Qnil
;
11428 staticpro (&pending_funcalls
);
11430 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11431 staticpro (&Vlispy_mouse_stem
);
11434 DEFSYM (QCimage
, ":image");
11435 DEFSYM (Qhelp_echo
, "help-echo");
11436 DEFSYM (QCrtl
, ":rtl");
11438 staticpro (&item_properties
);
11439 item_properties
= Qnil
;
11441 staticpro (&tool_bar_item_properties
);
11442 tool_bar_item_properties
= Qnil
;
11443 staticpro (&tool_bar_items_vector
);
11444 tool_bar_items_vector
= Qnil
;
11446 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11447 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11448 DEFSYM (Qself_insert_command
, "self-insert-command");
11449 DEFSYM (Qforward_char
, "forward-char");
11450 DEFSYM (Qbackward_char
, "backward-char");
11451 DEFSYM (Qdisabled
, "disabled");
11452 DEFSYM (Qundefined
, "undefined");
11453 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11454 DEFSYM (Qpost_command_hook
, "post-command-hook");
11455 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11456 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11457 DEFSYM (Qfunction_key
, "function-key");
11458 DEFSYM (Qmouse_click
, "mouse-click");
11459 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11460 DEFSYM (Qsave_session
, "save-session");
11461 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11462 DEFSYM (Qmenu_enable
, "menu-enable");
11464 #if defined (WINDOWSNT)
11465 DEFSYM (Qlanguage_change
, "language-change");
11469 DEFSYM (Qdbus_event
, "dbus-event");
11472 DEFSYM (QCenable
, ":enable");
11473 DEFSYM (QCvisible
, ":visible");
11474 DEFSYM (QChelp
, ":help");
11475 DEFSYM (QCfilter
, ":filter");
11476 DEFSYM (QCbutton
, ":button");
11477 DEFSYM (QCkeys
, ":keys");
11478 DEFSYM (QCkey_sequence
, ":key-sequence");
11479 DEFSYM (QCtoggle
, ":toggle");
11480 DEFSYM (QCradio
, ":radio");
11481 DEFSYM (QClabel
, ":label");
11482 DEFSYM (QCvert_only
, ":vert-only");
11484 DEFSYM (Qmode_line
, "mode-line");
11485 DEFSYM (Qvertical_line
, "vertical-line");
11486 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11487 DEFSYM (Qmenu_bar
, "menu-bar");
11489 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11490 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11493 DEFSYM (Qabove_handle
, "above-handle");
11494 DEFSYM (Qhandle
, "handle");
11495 DEFSYM (Qbelow_handle
, "below-handle");
11496 DEFSYM (Qup
, "up");
11497 DEFSYM (Qdown
, "down");
11498 DEFSYM (Qtop
, "top");
11499 DEFSYM (Qbottom
, "bottom");
11500 DEFSYM (Qend_scroll
, "end-scroll");
11501 DEFSYM (Qratio
, "ratio");
11503 DEFSYM (Qevent_kind
, "event-kind");
11504 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11505 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11506 DEFSYM (Qmodifier_cache
, "modifier-cache");
11508 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11509 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11511 DEFSYM (Qpolling_period
, "polling-period");
11513 DEFSYM (Qx_set_selection
, "x-set-selection");
11514 DEFSYM (QPRIMARY
, "PRIMARY");
11515 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11516 DEFSYM (Qhandle_select_window
, "handle-select-window");
11518 DEFSYM (Qinput_method_function
, "input-method-function");
11519 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11520 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11522 DEFSYM (Qhelp_form_show
, "help-form-show");
11524 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11525 Fset (Qinput_method_use_echo_area
, Qnil
);
11527 last_point_position_buffer
= Qnil
;
11528 last_point_position_window
= Qnil
;
11532 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11534 for (i
= 0; i
< len
; i
++)
11536 const struct event_head
*p
= &head_table
[i
];
11537 *p
->var
= intern_c_string (p
->name
);
11538 staticpro (p
->var
);
11539 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11540 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11544 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11545 staticpro (&button_down_location
);
11546 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11547 staticpro (&mouse_syms
);
11548 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11549 / sizeof (lispy_wheel_names
[0])),
11551 staticpro (&wheel_syms
);
11555 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11557 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11558 for (i
= 0; i
< len
; i
++)
11559 if (modifier_names
[i
])
11560 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11561 staticpro (&modifier_symbols
);
11564 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11565 staticpro (&recent_keys
);
11567 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11568 staticpro (&this_command_keys
);
11570 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11571 staticpro (&raw_keybuf
);
11573 DEFSYM (Qextended_command_history
, "extended-command-history");
11574 Fset (Qextended_command_history
, Qnil
);
11576 accent_key_syms
= Qnil
;
11577 staticpro (&accent_key_syms
);
11579 func_key_syms
= Qnil
;
11580 staticpro (&func_key_syms
);
11582 drag_n_drop_syms
= Qnil
;
11583 staticpro (&drag_n_drop_syms
);
11585 unread_switch_frame
= Qnil
;
11586 staticpro (&unread_switch_frame
);
11588 internal_last_event_frame
= Qnil
;
11589 staticpro (&internal_last_event_frame
);
11591 read_key_sequence_cmd
= Qnil
;
11592 staticpro (&read_key_sequence_cmd
);
11593 read_key_sequence_remapped
= Qnil
;
11594 staticpro (&read_key_sequence_remapped
);
11596 menu_bar_one_keymap_changed_items
= Qnil
;
11597 staticpro (&menu_bar_one_keymap_changed_items
);
11599 menu_bar_items_vector
= Qnil
;
11600 staticpro (&menu_bar_items_vector
);
11602 help_form_saved_window_configs
= Qnil
;
11603 staticpro (&help_form_saved_window_configs
);
11605 defsubr (&Scurrent_idle_time
);
11606 defsubr (&Sevent_symbol_parse_modifiers
);
11607 defsubr (&Sevent_convert_list
);
11608 defsubr (&Sread_key_sequence
);
11609 defsubr (&Sread_key_sequence_vector
);
11610 defsubr (&Srecursive_edit
);
11611 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11612 defsubr (&Strack_mouse
);
11614 defsubr (&Sinput_pending_p
);
11615 defsubr (&Scommand_execute
);
11616 defsubr (&Srecent_keys
);
11617 defsubr (&Sthis_command_keys
);
11618 defsubr (&Sthis_command_keys_vector
);
11619 defsubr (&Sthis_single_command_keys
);
11620 defsubr (&Sthis_single_command_raw_keys
);
11621 defsubr (&Sreset_this_command_lengths
);
11622 defsubr (&Sclear_this_command_keys
);
11623 defsubr (&Ssuspend_emacs
);
11624 defsubr (&Sabort_recursive_edit
);
11625 defsubr (&Sexit_recursive_edit
);
11626 defsubr (&Srecursion_depth
);
11627 defsubr (&Stop_level
);
11628 defsubr (&Sdiscard_input
);
11629 defsubr (&Sopen_dribble_file
);
11630 defsubr (&Sset_input_interrupt_mode
);
11631 defsubr (&Sset_output_flow_control
);
11632 defsubr (&Sset_input_meta_mode
);
11633 defsubr (&Sset_quit_char
);
11634 defsubr (&Sset_input_mode
);
11635 defsubr (&Scurrent_input_mode
);
11636 defsubr (&Sposn_at_point
);
11637 defsubr (&Sposn_at_x_y
);
11639 DEFVAR_LISP ("last-command-event", last_command_event
,
11640 doc
: /* Last input event that was part of a command. */);
11642 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11643 doc
: /* Last input event in a command, except for mouse menu events.
11644 Mouse menus give back keys that don't look like mouse events;
11645 this variable holds the actual mouse event that led to the menu,
11646 so that you can determine whether the command was run by mouse or not. */);
11648 DEFVAR_LISP ("last-input-event", last_input_event
,
11649 doc
: /* Last input event. */);
11651 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11652 doc
: /* List of events to be read as the command input.
11653 These events are processed first, before actual keyboard input.
11654 Events read from this list are not normally added to `this-command-keys',
11655 as they will already have been added once as they were read for the first time.
11656 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11657 Vunread_command_events
= Qnil
;
11659 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11660 doc
: /* List of events to be processed as input by input methods.
11661 These events are processed before `unread-command-events'
11662 and actual keyboard input, but are not given to `input-method-function'. */);
11663 Vunread_post_input_method_events
= Qnil
;
11665 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11666 doc
: /* List of events to be processed as input by input methods.
11667 These events are processed after `unread-command-events', but
11668 before actual keyboard input.
11669 If there's an active input method, the events are given to
11670 `input-method-function'. */);
11671 Vunread_input_method_events
= Qnil
;
11673 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11674 doc
: /* Meta-prefix character code.
11675 Meta-foo as command input turns into this character followed by foo. */);
11676 XSETINT (meta_prefix_char
, 033);
11678 DEFVAR_KBOARD ("last-command", Vlast_command
,
11679 doc
: /* The last command executed.
11680 Normally a symbol with a function definition, but can be whatever was found
11681 in the keymap, or whatever the variable `this-command' was set to by that
11684 The value `mode-exit' is special; it means that the previous command
11685 read an event that told it to exit, and it did so and unread that event.
11686 In other words, the present command is the event that made the previous
11689 The value `kill-region' is special; it means that the previous command
11690 was a kill command.
11692 `last-command' has a separate binding for each terminal device.
11693 See Info node `(elisp)Multiple Terminals'. */);
11695 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11696 doc
: /* Same as `last-command', but never altered by Lisp code.
11697 Taken from the previous value of `real-this-command'. */);
11699 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11700 doc
: /* Last command that may be repeated.
11701 The last command executed that was not bound to an input event.
11702 This is the command `repeat' will try to repeat.
11703 Taken from a previous value of `real-this-command'. */);
11705 DEFVAR_LISP ("this-command", Vthis_command
,
11706 doc
: /* The command now being executed.
11707 The command can set this variable; whatever is put here
11708 will be in `last-command' during the following command. */);
11709 Vthis_command
= Qnil
;
11711 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11712 doc
: /* This is like `this-command', except that commands should never modify it. */);
11713 Vreal_this_command
= Qnil
;
11715 DEFVAR_LISP ("this-command-keys-shift-translated",
11716 Vthis_command_keys_shift_translated
,
11717 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11718 Shift-translation occurs when there is no binding for the key sequence
11719 as entered, but a binding was found by changing an upper-case letter
11720 to lower-case, or a shifted function key to an unshifted one. */);
11721 Vthis_command_keys_shift_translated
= Qnil
;
11723 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11724 doc
: /* The command bound to the current key sequence before remapping.
11725 It equals `this-command' if the original command was not remapped through
11726 any of the active keymaps. Otherwise, the value of `this-command' is the
11727 result of looking up the original command in the active keymaps. */);
11728 Vthis_original_command
= Qnil
;
11730 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11731 doc
: /* Number of input events between auto-saves.
11732 Zero means disable autosaving due to number of characters typed. */);
11733 auto_save_interval
= 300;
11735 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11736 doc
: /* Number of seconds idle time before auto-save.
11737 Zero or nil means disable auto-saving due to idleness.
11738 After auto-saving due to this many seconds of idle time,
11739 Emacs also does a garbage collection if that seems to be warranted. */);
11740 XSETFASTINT (Vauto_save_timeout
, 30);
11742 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11743 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11744 The value may be integer or floating point.
11745 If the value is zero, don't echo at all. */);
11746 Vecho_keystrokes
= make_number (1);
11748 DEFVAR_INT ("polling-period", polling_period
,
11749 doc
: /* Interval between polling for input during Lisp execution.
11750 The reason for polling is to make C-g work to stop a running program.
11751 Polling is needed only when using X windows and SIGIO does not work.
11752 Polling is automatically disabled in all other cases. */);
11753 polling_period
= 2;
11755 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11756 doc
: /* Maximum time between mouse clicks to make a double-click.
11757 Measured in milliseconds. The value nil means disable double-click
11758 recognition; t means double-clicks have no time limit and are detected
11759 by position only. */);
11760 Vdouble_click_time
= make_number (500);
11762 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11763 doc
: /* Maximum mouse movement between clicks to make a double-click.
11764 On window-system frames, value is the number of pixels the mouse may have
11765 moved horizontally or vertically between two clicks to make a double-click.
11766 On non window-system frames, value is interpreted in units of 1/8 characters
11769 This variable is also the threshold for motion of the mouse
11770 to count as a drag. */);
11771 double_click_fuzz
= 3;
11773 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11774 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11775 inhibit_local_menu_bar_menus
= 0;
11777 DEFVAR_INT ("num-input-keys", num_input_keys
,
11778 doc
: /* Number of complete key sequences read as input so far.
11779 This includes key sequences read from keyboard macros.
11780 The number is effectively the number of interactive command invocations. */);
11781 num_input_keys
= 0;
11783 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11784 doc
: /* Number of input events read from the keyboard so far.
11785 This does not include events generated by keyboard macros. */);
11786 num_nonmacro_input_events
= 0;
11788 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11789 doc
: /* The frame in which the most recently read event occurred.
11790 If the last event came from a keyboard macro, this is set to `macro'. */);
11791 Vlast_event_frame
= Qnil
;
11793 /* This variable is set up in sysdep.c. */
11794 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11795 doc
: /* The ERASE character as set by the user with stty. */);
11797 DEFVAR_LISP ("help-char", Vhelp_char
,
11798 doc
: /* Character to recognize as meaning Help.
11799 When it is read, do `(eval help-form)', and display result if it's a string.
11800 If the value of `help-form' is nil, this char can be read normally. */);
11801 XSETINT (Vhelp_char
, Ctl ('H'));
11803 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11804 doc
: /* List of input events to recognize as meaning Help.
11805 These work just like the value of `help-char' (see that). */);
11806 Vhelp_event_list
= Qnil
;
11808 DEFVAR_LISP ("help-form", Vhelp_form
,
11809 doc
: /* Form to execute when character `help-char' is read.
11810 If the form returns a string, that string is displayed.
11811 If `help-form' is nil, the help char is not recognized. */);
11814 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11815 doc
: /* Command to run when `help-char' character follows a prefix key.
11816 This command is used only when there is no actual binding
11817 for that character after that prefix key. */);
11818 Vprefix_help_command
= Qnil
;
11820 DEFVAR_LISP ("top-level", Vtop_level
,
11821 doc
: /* Form to evaluate when Emacs starts up.
11822 Useful to set before you dump a modified Emacs. */);
11825 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11826 doc
: /* Translate table for local keyboard input, or nil.
11827 If non-nil, the value should be a char-table. Each character read
11828 from the keyboard is looked up in this char-table. If the value found
11829 there is non-nil, then it is used instead of the actual input character.
11831 The value can also be a string or vector, but this is considered obsolete.
11832 If it is a string or vector of length N, character codes N and up are left
11833 untranslated. In a vector, an element which is nil means "no translation".
11835 This is applied to the characters supplied to input methods, not their
11836 output. See also `translation-table-for-input'.
11838 This variable has a separate binding for each terminal.
11839 See Info node `(elisp)Multiple Terminals'. */);
11841 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11842 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11843 \(Even if the operating system has support for stopping a process.\) */);
11844 cannot_suspend
= 0;
11846 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11847 doc
: /* Non-nil means prompt with menus when appropriate.
11848 This is done when reading from a keymap that has a prompt string,
11849 for elements that have prompt strings.
11850 The menu is displayed on the screen
11851 if X menus were enabled at configuration
11852 time and the previous event was a mouse click prefix key.
11853 Otherwise, menu prompting uses the echo area. */);
11854 menu_prompting
= 1;
11856 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11857 doc
: /* Character to see next line of menu prompt.
11858 Type this character while in a menu prompt to rotate around the lines of it. */);
11859 XSETINT (menu_prompt_more_char
, ' ');
11861 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11862 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11863 Emacs applies the modifiers of the character stored here to each keyboard
11864 character it reads. For example, after evaluating the expression
11865 (setq extra-keyboard-modifiers ?\\C-x)
11866 all input characters will have the control modifier applied to them.
11868 Note that the character ?\\C-@, equivalent to the integer zero, does
11869 not count as a control character; rather, it counts as a character
11870 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11871 cancels any modification. */);
11872 extra_keyboard_modifiers
= 0;
11874 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11875 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11876 The command loop sets this to nil before each command,
11877 and tests the value when the command returns.
11878 Buffer modification stores t in this variable. */);
11879 Vdeactivate_mark
= Qnil
;
11880 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11882 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11883 doc
: /* Normal hook run before each command is executed.
11884 If an unhandled error happens in running this hook,
11885 the function in which the error occurred is unconditionally removed, since
11886 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11887 Vpre_command_hook
= Qnil
;
11889 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11890 doc
: /* Normal hook run after each command is executed.
11891 If an unhandled error happens in running this hook,
11892 the function in which the error occurred is unconditionally removed, since
11893 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11894 Vpost_command_hook
= Qnil
;
11897 DEFVAR_LISP ("echo-area-clear-hook", ...,
11898 doc
: /* Normal hook run when clearing the echo area. */);
11900 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11901 Fset (Qecho_area_clear_hook
, Qnil
);
11903 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11904 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11905 Vlucid_menu_bar_dirty_flag
= Qnil
;
11907 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11908 doc
: /* List of menu bar items to move to the end of the menu bar.
11909 The elements of the list are event types that may have menu bar bindings. */);
11910 Vmenu_bar_final_items
= Qnil
;
11912 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11913 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11914 This is used internally by graphical displays that do not render
11915 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11916 Vtool_bar_separator_image_expression
= Qnil
;
11918 DEFVAR_KBOARD ("overriding-terminal-local-map",
11919 Voverriding_terminal_local_map
,
11920 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11921 If this variable is non-nil, it is used as a keymap instead of the
11922 buffer's local map, and the minor mode keymaps and text property keymaps.
11923 It also replaces `overriding-local-map'.
11925 This variable is intended to let commands such as `universal-argument'
11926 set up a different keymap for reading the next command.
11928 `overriding-terminal-local-map' has a separate binding for each
11930 See Info node `(elisp)Multiple Terminals'. */);
11932 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11933 doc
: /* Keymap that overrides all other local keymaps.
11934 If this variable is non-nil, it is used as a keymap--replacing the
11935 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11936 Voverriding_local_map
= Qnil
;
11938 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11939 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11940 Otherwise, the menu bar continues to reflect the buffer's local map
11941 and the minor mode maps regardless of `overriding-local-map'. */);
11942 Voverriding_local_map_menu_flag
= Qnil
;
11944 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11945 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11946 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11948 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11949 doc
: /* Non-nil means generate motion events for mouse motion. */);
11951 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11952 doc
: /* Alist of system-specific X windows key symbols.
11953 Each element should have the form (N . SYMBOL) where N is the
11954 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11955 and SYMBOL is its name.
11957 `system-key-alist' has a separate binding for each terminal device.
11958 See Info node `(elisp)Multiple Terminals'. */);
11960 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11961 doc
: /* Keymap that translates key sequences to key sequences during input.
11962 This is used mainly for mapping key sequences into some preferred
11963 key events (symbols).
11965 The `read-key-sequence' function replaces any subsequence bound by
11966 `local-function-key-map' with its binding. More precisely, when the
11967 active keymaps have no binding for the current key sequence but
11968 `local-function-key-map' binds a suffix of the sequence to a vector or
11969 string, `read-key-sequence' replaces the matching suffix with its
11970 binding, and continues with the new sequence.
11972 If the binding is a function, it is called with one argument (the prompt)
11973 and its return value (a key sequence) is used.
11975 The events that come from bindings in `local-function-key-map' are not
11976 themselves looked up in `local-function-key-map'.
11978 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11979 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11980 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11981 typing `ESC O P x' would return [f1 x].
11983 `local-function-key-map' has a separate binding for each terminal
11984 device. See Info node `(elisp)Multiple Terminals'. If you need to
11985 define a binding on all terminals, change `function-key-map'
11986 instead. Initially, `local-function-key-map' is an empty keymap that
11987 has `function-key-map' as its parent on all terminal devices. */);
11989 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11990 doc
: /* Keymap that decodes input escape sequences.
11991 This is used mainly for mapping ASCII function key sequences into
11992 real Emacs function key events (symbols).
11994 The `read-key-sequence' function replaces any subsequence bound by
11995 `input-decode-map' with its binding. Contrary to `function-key-map',
11996 this map applies its rebinding regardless of the presence of an ordinary
11997 binding. So it is more like `key-translation-map' except that it applies
11998 before `function-key-map' rather than after.
12000 If the binding is a function, it is called with one argument (the prompt)
12001 and its return value (a key sequence) is used.
12003 The events that come from bindings in `input-decode-map' are not
12004 themselves looked up in `input-decode-map'.
12006 This variable is keyboard-local. */);
12008 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12009 doc
: /* The parent keymap of all `local-function-key-map' instances.
12010 Function key definitions that apply to all terminal devices should go
12011 here. If a mapping is defined in both the current
12012 `local-function-key-map' binding and this variable, then the local
12013 definition will take precedence. */);
12014 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12016 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12017 doc
: /* Keymap of key translations that can override keymaps.
12018 This keymap works like `function-key-map', but comes after that,
12019 and its non-prefix bindings override ordinary bindings.
12020 Another difference is that it is global rather than keyboard-local. */);
12021 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12023 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12024 doc
: /* List of deferred actions to be performed at a later time.
12025 The precise format isn't relevant here; we just check whether it is nil. */);
12026 Vdeferred_action_list
= Qnil
;
12028 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12029 doc
: /* Function to call to handle deferred actions, after each command.
12030 This function is called with no arguments after each command
12031 whenever `deferred-action-list' is non-nil. */);
12032 Vdeferred_action_function
= Qnil
;
12034 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12035 doc
: /* List of warnings to be displayed after this command.
12036 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12037 as per the args of `display-warning' (which see).
12038 If this variable is non-nil, `delayed-warnings-hook' will be run
12039 immediately after running `post-command-hook'. */);
12040 Vdelayed_warnings_list
= Qnil
;
12042 DEFVAR_LISP ("timer-list", Vtimer_list
,
12043 doc
: /* List of active absolute time timers in order of increasing time. */);
12044 Vtimer_list
= Qnil
;
12046 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12047 doc
: /* List of active idle-time timers in order of increasing time. */);
12048 Vtimer_idle_list
= Qnil
;
12050 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12051 doc
: /* If non-nil, the function that implements the current input method.
12052 It's called with one argument, a printing character that was just read.
12053 \(That means a character with code 040...0176.)
12054 Typically this function uses `read-event' to read additional events.
12055 When it does so, it should first bind `input-method-function' to nil
12056 so it will not be called recursively.
12058 The function should return a list of zero or more events
12059 to be used as input. If it wants to put back some events
12060 to be reconsidered, separately, by the input method,
12061 it can add them to the beginning of `unread-command-events'.
12063 The input method function can find in `input-method-previous-message'
12064 the previous echo area message.
12066 The input method function should refer to the variables
12067 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12068 for guidance on what to do. */);
12069 Vinput_method_function
= Qnil
;
12071 DEFVAR_LISP ("input-method-previous-message",
12072 Vinput_method_previous_message
,
12073 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12074 This variable exists because `read-event' clears the echo area
12075 before running the input method. It is nil if there was no message. */);
12076 Vinput_method_previous_message
= Qnil
;
12078 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12079 doc
: /* If non-nil, the function that implements the display of help.
12080 It's called with one argument, the help string to display. */);
12081 Vshow_help_function
= Qnil
;
12083 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12084 doc
: /* If non-nil, suppress point adjustment after executing a command.
12086 After a command is executed, if point is moved into a region that has
12087 special properties (e.g. composition, display), we adjust point to
12088 the boundary of the region. But, when a command sets this variable to
12089 non-nil, we suppress the point adjustment.
12091 This variable is set to nil before reading a command, and is checked
12092 just after executing the command. */);
12093 Vdisable_point_adjustment
= Qnil
;
12095 DEFVAR_LISP ("global-disable-point-adjustment",
12096 Vglobal_disable_point_adjustment
,
12097 doc
: /* If non-nil, always suppress point adjustment.
12099 The default value is nil, in which case, point adjustment are
12100 suppressed only after special commands that set
12101 `disable-point-adjustment' (which see) to non-nil. */);
12102 Vglobal_disable_point_adjustment
= Qnil
;
12104 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12105 doc
: /* How long to display an echo-area message when the minibuffer is active.
12106 If the value is not a number, such messages don't time out. */);
12107 Vminibuffer_message_timeout
= make_number (2);
12109 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12110 doc
: /* If non-nil, any keyboard input throws to this symbol.
12111 The value of that variable is passed to `quit-flag' and later causes a
12112 peculiar kind of quitting. */);
12113 Vthrow_on_input
= Qnil
;
12115 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12116 doc
: /* If non-nil, function to output error messages.
12117 The arguments are the error data, a list of the form
12118 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12119 such as just as `condition-case' would bind its variable to,
12120 the context (a string which normally goes at the start of the message),
12121 and the Lisp function within which the error was signaled. */);
12122 Vcommand_error_function
= Qnil
;
12124 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12125 Venable_disabled_menus_and_buttons
,
12126 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12128 Help functions bind this to allow help on disabled menu items
12129 and tool-bar buttons. */);
12130 Venable_disabled_menus_and_buttons
= Qnil
;
12132 DEFVAR_LISP ("select-active-regions",
12133 Vselect_active_regions
,
12134 doc
: /* If non-nil, an active region automatically sets the primary selection.
12135 If the value is `only', only temporarily active regions (usually made
12136 by mouse-dragging or shift-selection) set the window selection.
12138 This takes effect only when Transient Mark mode is enabled. */);
12139 Vselect_active_regions
= Qt
;
12141 DEFVAR_LISP ("saved-region-selection",
12142 Vsaved_region_selection
,
12143 doc
: /* Contents of active region prior to buffer modification.
12144 If `select-active-regions' is non-nil, Emacs sets this to the
12145 text in the region before modifying the buffer. The next
12146 `deactivate-mark' call uses this to set the window selection. */);
12147 Vsaved_region_selection
= Qnil
;
12149 DEFVAR_LISP ("selection-inhibit-update-commands",
12150 Vselection_inhibit_update_commands
,
12151 doc
: /* List of commands which should not update the selection.
12152 Normally, if `select-active-regions' is non-nil and the mark remains
12153 active after a command (i.e. the mark was not deactivated), the Emacs
12154 command loop sets the selection to the text in the region. However,
12155 if the command is in this list, the selection is not updated. */);
12156 Vselection_inhibit_update_commands
12157 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12159 DEFVAR_LISP ("debug-on-event",
12161 doc
: /* Enter debugger on this event. When Emacs
12162 receives the special event specified by this variable, it will try to
12163 break into the debugger as soon as possible instead of processing the
12164 event normally through `special-event-map'.
12166 Currently, the only supported values for this
12167 variable are `sigusr1' and `sigusr2'. */);
12168 Vdebug_on_event
= intern_c_string ("sigusr2");
12170 /* Create the initial keyboard. */
12171 initial_kboard
= xmalloc (sizeof *initial_kboard
);
12172 init_kboard (initial_kboard
);
12173 /* Vwindow_system is left at t for now. */
12174 initial_kboard
->next_kboard
= all_kboards
;
12175 all_kboards
= initial_kboard
;
12179 keys_of_keyboard (void)
12181 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12182 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12183 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12184 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12185 initial_define_key (meta_map
, 'x', "execute-extended-command");
12187 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12188 "handle-delete-frame");
12189 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12190 "ns-put-working-text");
12191 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12192 "ns-unput-working-text");
12193 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12194 current-prefix-arg, as is done in `handle-switch-frame'.
12195 But `handle-switch-frame is not run from the special-map.
12196 Commands from that map are run in a special way that automatically
12197 preserves the prefix-arg. Restoring the prefix arg here is not just
12198 redundant but harmful:
12200 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12201 - after the first prompt, the exit-minibuffer-hook is run which may
12202 iconify a frame and thus push a `iconify-frame' event.
12203 - after running exit-minibuffer-hook, current-prefix-arg is
12204 restored to the non-nil value it had before the prompt.
12205 - we enter the second prompt.
12206 current-prefix-arg is non-nil, prefix-arg is nil.
12207 - before running the first real event, we run the special iconify-frame
12208 event, but we pass the `special' arg to execute-command so
12209 current-prefix-arg and prefix-arg are left untouched.
12210 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12211 - the next key event will have a spuriously non-nil current-prefix-arg. */
12212 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12214 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12216 /* Handling it at such a low-level causes read_key_sequence to get
12217 * confused because it doesn't realize that the current_buffer was
12218 * changed by read_char.
12220 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12221 * "handle-select-window"); */
12222 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12223 "handle-save-session");
12226 /* Define a special event which is raised for dbus callback
12228 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12229 "dbus-handle-event");
12232 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12234 #if defined (WINDOWSNT)
12235 initial_define_lispy_key (Vspecial_event_map
, "language-change",
12240 /* Mark the pointers in the kboard objects.
12241 Called by Fgarbage_collect. */
12243 mark_kboards (void)
12247 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12249 if (kb
->kbd_macro_buffer
)
12250 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12252 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12253 mark_object (KVAR (kb
, Vlast_command
));
12254 mark_object (KVAR (kb
, Vreal_last_command
));
12255 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12256 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12257 mark_object (KVAR (kb
, Vprefix_arg
));
12258 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12259 mark_object (KVAR (kb
, kbd_queue
));
12260 mark_object (KVAR (kb
, defining_kbd_macro
));
12261 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12262 mark_object (KVAR (kb
, Vsystem_key_alist
));
12263 mark_object (KVAR (kb
, system_key_syms
));
12264 mark_object (KVAR (kb
, Vwindow_system
));
12265 mark_object (KVAR (kb
, Vinput_decode_map
));
12266 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12267 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12268 mark_object (KVAR (kb
, echo_string
));
12271 struct input_event
*event
;
12272 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12274 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12275 event
= kbd_buffer
;
12276 if (event
->kind
!= SELECTION_REQUEST_EVENT
12277 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12279 mark_object (event
->x
);
12280 mark_object (event
->y
);
12282 mark_object (event
->frame_or_window
);
12283 mark_object (event
->arg
);