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 (void)
4338 EMACS_TIME nexttime
;
4340 EMACS_TIME idleness_now
;
4341 Lisp_Object timers
, idle_timers
, chosen_timer
;
4342 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4344 nexttime
= invalid_emacs_time ();
4346 /* Always consider the ordinary timers. */
4347 timers
= Vtimer_list
;
4348 /* Consider the idle timers only if Emacs is idle. */
4349 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4350 idle_timers
= Vtimer_idle_list
;
4353 chosen_timer
= Qnil
;
4354 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4356 /* First run the code that was delayed. */
4357 while (CONSP (pending_funcalls
))
4359 Lisp_Object funcall
= XCAR (pending_funcalls
);
4360 pending_funcalls
= XCDR (pending_funcalls
);
4361 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4364 if (CONSP (timers
) || CONSP (idle_timers
))
4366 now
= current_emacs_time ();
4367 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4368 ? sub_emacs_time (now
, timer_idleness_start_time
)
4369 : make_emacs_time (0, 0));
4372 while (CONSP (timers
) || CONSP (idle_timers
))
4374 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4375 EMACS_TIME timer_time
, idle_timer_time
;
4376 EMACS_TIME difference
;
4377 EMACS_TIME timer_difference
= invalid_emacs_time ();
4378 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4379 int ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4381 /* Set TIMER and TIMER_DIFFERENCE
4382 based on the next ordinary timer.
4383 TIMER_DIFFERENCE is the distance in time from NOW to when
4384 this timer becomes ripe (negative if it's already ripe).
4385 Skip past invalid timers and timers already handled. */
4388 timer
= XCAR (timers
);
4389 if (! decode_timer (timer
, &timer_time
))
4391 timers
= XCDR (timers
);
4395 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4396 timer_difference
= (timer_ripe
4397 ? sub_emacs_time (now
, timer_time
)
4398 : sub_emacs_time (timer_time
, now
));
4401 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4402 based on the next idle timer. */
4403 if (CONSP (idle_timers
))
4405 idle_timer
= XCAR (idle_timers
);
4406 if (! decode_timer (idle_timer
, &idle_timer_time
))
4408 idle_timers
= XCDR (idle_timers
);
4412 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4413 idle_timer_difference
=
4415 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4416 : sub_emacs_time (idle_timer_time
, idleness_now
));
4419 /* Decide which timer is the next timer,
4420 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4421 Also step down the list where we found that timer. */
4423 if (EMACS_TIME_VALID_P (timer_difference
)
4424 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4425 || idle_timer_ripe
< timer_ripe
4426 || (idle_timer_ripe
== timer_ripe
4428 ? EMACS_TIME_LT (idle_timer_difference
,
4430 : EMACS_TIME_LT (timer_difference
,
4431 idle_timer_difference
)))))
4433 chosen_timer
= timer
;
4434 timers
= XCDR (timers
);
4435 difference
= timer_difference
;
4440 chosen_timer
= idle_timer
;
4441 idle_timers
= XCDR (idle_timers
);
4442 difference
= idle_timer_difference
;
4443 ripe
= idle_timer_ripe
;
4446 /* If timer is ripe, run it if it hasn't been run. */
4449 if (NILP (AREF (chosen_timer
, 0)))
4451 ptrdiff_t count
= SPECPDL_INDEX ();
4452 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4454 /* Mark the timer as triggered to prevent problems if the lisp
4455 code fails to reschedule it right. */
4456 ASET (chosen_timer
, 0, Qt
);
4458 specbind (Qinhibit_quit
, Qt
);
4460 call1 (Qtimer_event_handler
, chosen_timer
);
4461 Vdeactivate_mark
= old_deactivate_mark
;
4463 unbind_to (count
, Qnil
);
4465 /* Since we have handled the event,
4466 we don't need to tell the caller to wake up and do it. */
4467 /* But the caller must still wait for the next timer, so
4468 return 0 to indicate that. */
4471 nexttime
= make_emacs_time (0, 0);
4475 /* When we encounter a timer that is still waiting,
4476 return the amount of time to wait before it is ripe. */
4483 /* No timers are pending in the future. */
4484 /* Return 0 if we generated an event, and -1 if not. */
4490 /* Check whether a timer has fired. To prevent larger problems we simply
4491 disregard elements that are not proper timers. Do not make a circular
4492 timer list for the time being.
4494 Returns the time to wait until the next timer fires.
4495 If no timer is active, return an invalid value.
4497 As long as any timer is ripe, we run it. */
4502 EMACS_TIME nexttime
;
4506 nexttime
= timer_check_2 ();
4508 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4513 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4514 doc
: /* Return the current length of Emacs idleness, or nil.
4515 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4516 in the same style as (current-time).
4518 The value when Emacs is not idle is nil.
4520 PSEC is a multiple of the system clock resolution. */)
4523 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4524 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4525 timer_idleness_start_time
));
4530 /* Caches for modify_event_symbol. */
4531 static Lisp_Object accent_key_syms
;
4532 static Lisp_Object func_key_syms
;
4533 static Lisp_Object mouse_syms
;
4534 static Lisp_Object wheel_syms
;
4535 static Lisp_Object drag_n_drop_syms
;
4537 /* This is a list of keysym codes for special "accent" characters.
4538 It parallels lispy_accent_keys. */
4540 static const int lispy_accent_codes
[] =
4542 #ifdef XK_dead_circumflex
4547 #ifdef XK_dead_grave
4552 #ifdef XK_dead_tilde
4557 #ifdef XK_dead_diaeresis
4562 #ifdef XK_dead_macron
4567 #ifdef XK_dead_degree
4572 #ifdef XK_dead_acute
4577 #ifdef XK_dead_cedilla
4582 #ifdef XK_dead_breve
4587 #ifdef XK_dead_ogonek
4592 #ifdef XK_dead_caron
4597 #ifdef XK_dead_doubleacute
4598 XK_dead_doubleacute
,
4602 #ifdef XK_dead_abovedot
4607 #ifdef XK_dead_abovering
4617 #ifdef XK_dead_belowdot
4622 #ifdef XK_dead_voiced_sound
4623 XK_dead_voiced_sound
,
4627 #ifdef XK_dead_semivoiced_sound
4628 XK_dead_semivoiced_sound
,
4644 /* This is a list of Lisp names for special "accent" characters.
4645 It parallels lispy_accent_codes. */
4647 static const char *const lispy_accent_keys
[] =
4665 "dead-voiced-sound",
4666 "dead-semivoiced-sound",
4672 #define FUNCTION_KEY_OFFSET 0x0
4674 const char *const lispy_function_keys
[] =
4678 0, /* VK_LBUTTON 0x01 */
4679 0, /* VK_RBUTTON 0x02 */
4680 "cancel", /* VK_CANCEL 0x03 */
4681 0, /* VK_MBUTTON 0x04 */
4683 0, 0, 0, /* 0x05 .. 0x07 */
4685 "backspace", /* VK_BACK 0x08 */
4686 "tab", /* VK_TAB 0x09 */
4688 0, 0, /* 0x0A .. 0x0B */
4690 "clear", /* VK_CLEAR 0x0C */
4691 "return", /* VK_RETURN 0x0D */
4693 0, 0, /* 0x0E .. 0x0F */
4695 0, /* VK_SHIFT 0x10 */
4696 0, /* VK_CONTROL 0x11 */
4697 0, /* VK_MENU 0x12 */
4698 "pause", /* VK_PAUSE 0x13 */
4699 "capslock", /* VK_CAPITAL 0x14 */
4700 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4702 "junja", /* VK_JUNJA 0x17 */
4703 "final", /* VK_FINAL 0x18 */
4704 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4706 "escape", /* VK_ESCAPE 0x1B */
4707 "convert", /* VK_CONVERT 0x1C */
4708 "non-convert", /* VK_NONCONVERT 0x1D */
4709 "accept", /* VK_ACCEPT 0x1E */
4710 "mode-change", /* VK_MODECHANGE 0x1F */
4711 0, /* VK_SPACE 0x20 */
4712 "prior", /* VK_PRIOR 0x21 */
4713 "next", /* VK_NEXT 0x22 */
4714 "end", /* VK_END 0x23 */
4715 "home", /* VK_HOME 0x24 */
4716 "left", /* VK_LEFT 0x25 */
4717 "up", /* VK_UP 0x26 */
4718 "right", /* VK_RIGHT 0x27 */
4719 "down", /* VK_DOWN 0x28 */
4720 "select", /* VK_SELECT 0x29 */
4721 "print", /* VK_PRINT 0x2A */
4722 "execute", /* VK_EXECUTE 0x2B */
4723 "snapshot", /* VK_SNAPSHOT 0x2C */
4724 "insert", /* VK_INSERT 0x2D */
4725 "delete", /* VK_DELETE 0x2E */
4726 "help", /* VK_HELP 0x2F */
4728 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4730 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4732 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4734 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4736 0, 0, 0, 0, 0, 0, 0, 0, 0,
4737 0, 0, 0, 0, 0, 0, 0, 0, 0,
4738 0, 0, 0, 0, 0, 0, 0, 0,
4740 "lwindow", /* VK_LWIN 0x5B */
4741 "rwindow", /* VK_RWIN 0x5C */
4742 "apps", /* VK_APPS 0x5D */
4745 "kp-0", /* VK_NUMPAD0 0x60 */
4746 "kp-1", /* VK_NUMPAD1 0x61 */
4747 "kp-2", /* VK_NUMPAD2 0x62 */
4748 "kp-3", /* VK_NUMPAD3 0x63 */
4749 "kp-4", /* VK_NUMPAD4 0x64 */
4750 "kp-5", /* VK_NUMPAD5 0x65 */
4751 "kp-6", /* VK_NUMPAD6 0x66 */
4752 "kp-7", /* VK_NUMPAD7 0x67 */
4753 "kp-8", /* VK_NUMPAD8 0x68 */
4754 "kp-9", /* VK_NUMPAD9 0x69 */
4755 "kp-multiply", /* VK_MULTIPLY 0x6A */
4756 "kp-add", /* VK_ADD 0x6B */
4757 "kp-separator", /* VK_SEPARATOR 0x6C */
4758 "kp-subtract", /* VK_SUBTRACT 0x6D */
4759 "kp-decimal", /* VK_DECIMAL 0x6E */
4760 "kp-divide", /* VK_DIVIDE 0x6F */
4761 "f1", /* VK_F1 0x70 */
4762 "f2", /* VK_F2 0x71 */
4763 "f3", /* VK_F3 0x72 */
4764 "f4", /* VK_F4 0x73 */
4765 "f5", /* VK_F5 0x74 */
4766 "f6", /* VK_F6 0x75 */
4767 "f7", /* VK_F7 0x76 */
4768 "f8", /* VK_F8 0x77 */
4769 "f9", /* VK_F9 0x78 */
4770 "f10", /* VK_F10 0x79 */
4771 "f11", /* VK_F11 0x7A */
4772 "f12", /* VK_F12 0x7B */
4773 "f13", /* VK_F13 0x7C */
4774 "f14", /* VK_F14 0x7D */
4775 "f15", /* VK_F15 0x7E */
4776 "f16", /* VK_F16 0x7F */
4777 "f17", /* VK_F17 0x80 */
4778 "f18", /* VK_F18 0x81 */
4779 "f19", /* VK_F19 0x82 */
4780 "f20", /* VK_F20 0x83 */
4781 "f21", /* VK_F21 0x84 */
4782 "f22", /* VK_F22 0x85 */
4783 "f23", /* VK_F23 0x86 */
4784 "f24", /* VK_F24 0x87 */
4786 0, 0, 0, 0, /* 0x88 .. 0x8B */
4787 0, 0, 0, 0, /* 0x8C .. 0x8F */
4789 "kp-numlock", /* VK_NUMLOCK 0x90 */
4790 "scroll", /* VK_SCROLL 0x91 */
4791 /* Not sure where the following block comes from.
4792 Windows headers have NEC and Fujitsu specific keys in
4793 this block, but nothing generic. */
4794 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4795 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4796 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4797 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4798 "kp-end", /* VK_NUMPAD_END 0x96 */
4799 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4800 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4801 "kp-up", /* VK_NUMPAD_UP 0x99 */
4802 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4803 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4804 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4805 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4807 0, 0, /* 0x9E .. 0x9F */
4810 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4811 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4812 * No other API or message will distinguish left and right keys this way.
4817 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4818 to enable them selectively, and gives access to a few more functions.
4819 See lispy_multimedia_keys below. */
4820 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4821 0, 0, 0, /* 0xAD .. 0xAF Volume */
4822 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4823 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4825 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4826 0, 0, 0, 0, 0, 0, 0, 0, 0,
4828 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4829 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4830 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4833 "ax", /* VK_OEM_AX 0xE1 */
4834 0, /* VK_OEM_102 0xE2 */
4835 "ico-help", /* VK_ICO_HELP 0xE3 */
4836 "ico-00", /* VK_ICO_00 0xE4 */
4837 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4838 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4839 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4841 "reset", /* VK_OEM_RESET 0xE9 */
4842 "jump", /* VK_OEM_JUMP 0xEA */
4843 "oem-pa1", /* VK_OEM_PA1 0xEB */
4844 "oem-pa2", /* VK_OEM_PA2 0xEC */
4845 "oem-pa3", /* VK_OEM_PA3 0xED */
4846 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4847 "cusel", /* VK_OEM_CUSEL 0xEF */
4848 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4849 "finish", /* VK_OEM_FINISH 0xF1 */
4850 "copy", /* VK_OEM_COPY 0xF2 */
4851 "auto", /* VK_OEM_AUTO 0xF3 */
4852 "enlw", /* VK_OEM_ENLW 0xF4 */
4853 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4854 "attn", /* VK_ATTN 0xF6 */
4855 "crsel", /* VK_CRSEL 0xF7 */
4856 "exsel", /* VK_EXSEL 0xF8 */
4857 "ereof", /* VK_EREOF 0xF9 */
4858 "play", /* VK_PLAY 0xFA */
4859 "zoom", /* VK_ZOOM 0xFB */
4860 "noname", /* VK_NONAME 0xFC */
4861 "pa1", /* VK_PA1 0xFD */
4862 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4866 /* Some of these duplicate the "Media keys" on newer keyboards,
4867 but they are delivered to the application in a different way. */
4868 static const char *const lispy_multimedia_keys
[] =
4876 "browser-favorites",
4913 "toggle-dictate-command",
4919 "media-fast-forward",
4922 "media-channel-down"
4925 #else /* not HAVE_NTGUI */
4927 /* This should be dealt with in XTread_socket now, and that doesn't
4928 depend on the client system having the Kana syms defined. See also
4929 the XK_kana_A case below. */
4932 static const char *const lispy_kana_keys
[] =
4934 /* X Keysym value */
4935 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4936 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4937 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4938 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4939 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4940 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4941 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4942 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4943 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4944 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4945 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4946 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4947 "kana-i", "kana-u", "kana-e", "kana-o",
4948 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4949 "prolongedsound", "kana-A", "kana-I", "kana-U",
4950 "kana-E", "kana-O", "kana-KA", "kana-KI",
4951 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4952 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4953 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4954 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4955 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4956 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4957 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4958 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4959 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4960 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4961 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4962 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4964 #endif /* XK_kana_A */
4967 #define FUNCTION_KEY_OFFSET 0xff00
4969 /* You'll notice that this table is arranged to be conveniently
4970 indexed by X Windows keysym values. */
4971 static const char *const lispy_function_keys
[] =
4973 /* X Keysym value */
4975 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4976 "backspace", "tab", "linefeed", "clear",
4978 0, 0, 0, "pause", /* 0xff10...1f */
4979 0, 0, 0, 0, 0, 0, 0, "escape",
4981 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4982 "romaji", "hiragana", "katakana", "hiragana-katakana",
4983 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4984 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4985 "eisu-toggle", /* 0xff30...3f */
4986 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4987 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4989 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4990 "down", "prior", "next", "end",
4991 "begin", 0, 0, 0, 0, 0, 0, 0,
4992 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5003 "break", /* 0xff6b */
5006 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5007 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5008 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5009 0, 0, 0, 0, 0, 0, 0, 0,
5010 "kp-tab", /* 0xff89 */
5012 "kp-enter", /* 0xff8d */
5014 "kp-f1", /* 0xff91 */
5018 "kp-home", /* 0xff95 */
5023 "kp-prior", /* kp-page-up */
5024 "kp-next", /* kp-page-down */
5030 0, 0, 0, 0, 0, 0, 0, 0, 0,
5031 "kp-multiply", /* 0xffaa */
5036 "kp-divide", /* 0xffaf */
5037 "kp-0", /* 0xffb0 */
5038 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5041 "kp-equal", /* 0xffbd */
5042 "f1", /* 0xffbe */ /* IsFunctionKey */
5044 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5045 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5046 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5047 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5048 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5049 0, 0, 0, 0, 0, 0, 0, 0,
5050 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5051 0, 0, 0, 0, 0, 0, 0, "delete"
5054 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5055 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5057 static const char *const iso_lispy_function_keys
[] =
5059 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5060 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5061 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5062 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5063 "iso-lefttab", /* 0xfe20 */
5064 "iso-move-line-up", "iso-move-line-down",
5065 "iso-partial-line-up", "iso-partial-line-down",
5066 "iso-partial-space-left", "iso-partial-space-right",
5067 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5068 "iso-release-margin-left", "iso-release-margin-right",
5069 "iso-release-both-margins",
5070 "iso-fast-cursor-left", "iso-fast-cursor-right",
5071 "iso-fast-cursor-up", "iso-fast-cursor-down",
5072 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5073 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5076 #endif /* not HAVE_NTGUI */
5078 static Lisp_Object Vlispy_mouse_stem
;
5080 static const char *const lispy_wheel_names
[] =
5082 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5085 /* drag-n-drop events are generated when a set of selected files are
5086 dragged from another application and dropped onto an Emacs window. */
5087 static const char *const lispy_drag_n_drop_names
[] =
5092 /* Scroll bar parts. */
5093 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5094 Lisp_Object Qup
, Qdown
, Qbottom
;
5095 static Lisp_Object Qend_scroll
;
5097 static Lisp_Object Qratio
;
5099 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5100 static Lisp_Object
*const scroll_bar_parts
[] = {
5101 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5102 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5105 /* A vector, indexed by button number, giving the down-going location
5106 of currently depressed buttons, both scroll bar and non-scroll bar.
5108 The elements have the form
5109 (BUTTON-NUMBER MODIFIER-MASK . REST)
5110 where REST is the cdr of a position as it would be reported in the event.
5112 The make_lispy_event function stores positions here to tell the
5113 difference between click and drag events, and to store the starting
5114 location to be included in drag events. */
5116 static Lisp_Object button_down_location
;
5118 /* Information about the most recent up-going button event: Which
5119 button, what location, and what time. */
5121 static int last_mouse_button
;
5122 static int last_mouse_x
;
5123 static int last_mouse_y
;
5124 static Time button_down_time
;
5126 /* The number of clicks in this multiple-click. */
5128 static int double_click_count
;
5130 /* X and Y are frame-relative coordinates for a click or wheel event.
5131 Return a Lisp-style event list. */
5134 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5137 enum window_part part
;
5138 Lisp_Object posn
= Qnil
;
5139 Lisp_Object extra_info
= Qnil
;
5140 /* Coordinate pixel positions to return. */
5141 int xret
= 0, yret
= 0;
5142 /* The window under frame pixel coordinates (x,y) */
5143 Lisp_Object window
= f
5144 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5147 if (WINDOWP (window
))
5149 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5150 struct window
*w
= XWINDOW (window
);
5151 Lisp_Object string_info
= Qnil
;
5152 ptrdiff_t textpos
= -1;
5153 int col
= -1, row
= -1;
5154 int dx
= -1, dy
= -1;
5155 int width
= -1, height
= -1;
5156 Lisp_Object object
= Qnil
;
5158 /* Pixel coordinates relative to the window corner. */
5159 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5160 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5162 /* For text area clicks, return X, Y relative to the corner of
5163 this text area. Note that dX, dY etc are set below, by
5164 buffer_posn_from_coords. */
5165 if (part
== ON_TEXT
)
5167 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5168 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5170 /* For mode line and header line clicks, return X, Y relative to
5171 the left window edge. Use mode_line_string to look for a
5172 string on the click position. */
5173 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5178 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5179 /* Note that mode_line_string takes COL, ROW as pixels and
5180 converts them to characters. */
5183 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5184 &object
, &dx
, &dy
, &width
, &height
);
5185 if (STRINGP (string
))
5186 string_info
= Fcons (string
, make_number (charpos
));
5187 textpos
= (w
== XWINDOW (selected_window
)
5188 && current_buffer
== XBUFFER (w
->buffer
))
5189 ? PT
: XMARKER (w
->pointm
)->charpos
;
5194 /* For fringes and margins, Y is relative to the area's (and the
5195 window's) top edge, while X is meaningless. */
5196 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5201 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5204 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5205 &object
, &dx
, &dy
, &width
, &height
);
5206 if (STRINGP (string
))
5207 string_info
= Fcons (string
, make_number (charpos
));
5208 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5210 else if (part
== ON_LEFT_FRINGE
)
5212 posn
= Qleft_fringe
;
5215 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5216 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5217 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5219 else if (part
== ON_RIGHT_FRINGE
)
5221 posn
= Qright_fringe
;
5224 - window_box_width (w
, LEFT_MARGIN_AREA
)
5225 - window_box_width (w
, TEXT_AREA
)
5226 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5227 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5229 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5231 else if (part
== ON_VERTICAL_BORDER
)
5233 posn
= Qvertical_line
;
5238 /* Nothing special for part == ON_SCROLL_BAR. */
5240 /* For clicks in the text area, fringes, or margins, call
5241 buffer_posn_from_coords to extract TEXTPOS, the buffer
5242 position nearest to the click. */
5245 Lisp_Object string2
, object2
= Qnil
;
5246 struct display_pos p
;
5248 int width2
, height2
;
5249 /* The pixel X coordinate passed to buffer_posn_from_coords
5250 is the X coordinate relative to the text area for
5251 text-area and right-margin clicks, zero otherwise. */
5253 = (part
== ON_TEXT
) ? xret
5254 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5255 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5259 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5260 &object2
, &dx2
, &dy2
,
5262 textpos
= CHARPOS (p
.pos
);
5263 if (col
< 0) col
= x2
;
5264 if (row
< 0) row
= y2
;
5265 if (dx
< 0) dx
= dx2
;
5266 if (dy
< 0) dy
= dy2
;
5267 if (width
< 0) width
= width2
;
5268 if (height
< 0) height
= height2
;
5272 posn
= make_number (textpos
);
5273 if (STRINGP (string2
))
5274 string_info
= Fcons (string2
,
5275 make_number (CHARPOS (p
.string_pos
)));
5281 #ifdef HAVE_WINDOW_SYSTEM
5282 if (IMAGEP (object
))
5284 Lisp_Object image_map
, hotspot
;
5285 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5287 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5289 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5290 posn
= XCAR (hotspot
);
5297 Fcons (make_number (dx
), make_number (dy
)),
5298 Fcons (make_number (width
), make_number (height
)));
5301 extra_info
= Fcons (string_info
,
5302 Fcons (make_number (textpos
),
5303 Fcons (Fcons (make_number (col
),
5308 XSETFRAME (window
, f
);
5312 return Fcons (window
,
5314 Fcons (Fcons (make_number (xret
),
5315 make_number (yret
)),
5316 Fcons (make_number (t
),
5320 /* Given a struct input_event, build the lisp event which represents
5321 it. If EVENT is 0, build a mouse movement event from the mouse
5322 movement buffer, which should have a movement event in it.
5324 Note that events must be passed to this function in the order they
5325 are received; this function stores the location of button presses
5326 in order to build drag events when the button is released. */
5329 make_lispy_event (struct input_event
*event
)
5333 switch (event
->kind
)
5335 /* A simple keystroke. */
5336 case ASCII_KEYSTROKE_EVENT
:
5337 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5339 Lisp_Object lispy_c
;
5340 EMACS_INT c
= event
->code
;
5341 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5344 eassert (c
== event
->code
);
5345 /* Turn ASCII characters into control characters
5347 if (event
->modifiers
& ctrl_modifier
)
5349 c
= make_ctrl_char (c
);
5350 event
->modifiers
&= ~ctrl_modifier
;
5354 /* Add in the other modifier bits. The shift key was taken care
5355 of by the X code. */
5356 c
|= (event
->modifiers
5357 & (meta_modifier
| alt_modifier
5358 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5359 /* Distinguish Shift-SPC from SPC. */
5360 if ((event
->code
) == 040
5361 && event
->modifiers
& shift_modifier
)
5362 c
|= shift_modifier
;
5363 button_down_time
= 0;
5364 XSETFASTINT (lispy_c
, c
);
5369 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5370 except that they are non-key events (last-nonmenu-event is nil). */
5371 case NS_NONKEY_EVENT
:
5374 /* A function key. The symbol may need to have modifier prefixes
5376 case NON_ASCII_KEYSTROKE_EVENT
:
5377 button_down_time
= 0;
5379 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5380 if (event
->code
== lispy_accent_codes
[i
])
5381 return modify_event_symbol (i
,
5383 Qfunction_key
, Qnil
,
5384 lispy_accent_keys
, &accent_key_syms
,
5385 (sizeof (lispy_accent_keys
)
5386 / sizeof (lispy_accent_keys
[0])));
5390 if (event
->code
>= 0x400 && event
->code
< 0x500)
5391 return modify_event_symbol (event
->code
- 0x400,
5392 event
->modifiers
& ~shift_modifier
,
5393 Qfunction_key
, Qnil
,
5394 lispy_kana_keys
, &func_key_syms
,
5395 (sizeof (lispy_kana_keys
)
5396 / sizeof (lispy_kana_keys
[0])));
5397 #endif /* XK_kana_A */
5400 #ifdef ISO_FUNCTION_KEY_OFFSET
5401 if (event
->code
< FUNCTION_KEY_OFFSET
5402 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5403 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5405 Qfunction_key
, Qnil
,
5406 iso_lispy_function_keys
, &func_key_syms
,
5407 (sizeof (iso_lispy_function_keys
)
5408 / sizeof (iso_lispy_function_keys
[0])));
5411 /* Handle system-specific or unknown keysyms. */
5412 if (event
->code
& (1 << 28)
5413 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5414 || (event
->code
- FUNCTION_KEY_OFFSET
5415 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5416 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5418 /* We need to use an alist rather than a vector as the cache
5419 since we can't make a vector long enough. */
5420 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5421 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5422 return modify_event_symbol (event
->code
,
5425 KVAR (current_kboard
, Vsystem_key_alist
),
5426 0, &KVAR (current_kboard
, system_key_syms
),
5430 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5432 Qfunction_key
, Qnil
,
5433 lispy_function_keys
, &func_key_syms
,
5434 (sizeof (lispy_function_keys
)
5435 / sizeof (lispy_function_keys
[0])));
5438 case MULTIMEDIA_KEY_EVENT
:
5439 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5440 / sizeof (lispy_multimedia_keys
[0]))
5441 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5443 return modify_event_symbol (event
->code
, event
->modifiers
,
5444 Qfunction_key
, Qnil
,
5445 lispy_multimedia_keys
, &func_key_syms
,
5446 (sizeof (lispy_multimedia_keys
)
5447 / sizeof (lispy_multimedia_keys
[0])));
5453 /* A mouse click. Figure out where it is, decide whether it's
5454 a press, click or drag, and build the appropriate structure. */
5455 case MOUSE_CLICK_EVENT
:
5456 #ifndef USE_TOOLKIT_SCROLL_BARS
5457 case SCROLL_BAR_CLICK_EVENT
:
5460 int button
= event
->code
;
5462 Lisp_Object position
;
5463 Lisp_Object
*start_pos_ptr
;
5464 Lisp_Object start_pos
;
5468 /* Build the position as appropriate for this mouse click. */
5469 if (event
->kind
== MOUSE_CLICK_EVENT
)
5471 struct frame
*f
= XFRAME (event
->frame_or_window
);
5472 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5476 /* Ignore mouse events that were made on frame that
5477 have been deleted. */
5478 if (! FRAME_LIVE_P (f
))
5481 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5482 /* EVENT->x and EVENT->y are frame-relative pixel
5483 coordinates at this place. Under old redisplay, COLUMN
5484 and ROW are set to frame relative glyph coordinates
5485 which are then used to determine whether this click is
5486 in a menu (non-toolkit version). */
5487 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5488 &column
, &row
, NULL
, 1);
5490 /* In the non-toolkit version, clicks on the menu bar
5491 are ordinary button events in the event buffer.
5492 Distinguish them, and invoke the menu.
5494 (In the toolkit version, the toolkit handles the menu bar
5495 and Emacs doesn't know about it until after the user
5496 makes a selection.) */
5497 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5498 && (event
->modifiers
& down_modifier
))
5500 Lisp_Object items
, item
;
5502 /* Find the menu bar item under `column'. */
5504 items
= FRAME_MENU_BAR_ITEMS (f
);
5505 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5507 Lisp_Object pos
, string
;
5508 string
= AREF (items
, i
+ 1);
5509 pos
= AREF (items
, i
+ 3);
5512 if (column
>= XINT (pos
)
5513 && column
< XINT (pos
) + SCHARS (string
))
5515 item
= AREF (items
, i
);
5520 /* ELisp manual 2.4b says (x y) are window relative but
5521 code says they are frame-relative. */
5523 = Fcons (event
->frame_or_window
,
5525 Fcons (Fcons (event
->x
, event
->y
),
5526 Fcons (make_number (event
->timestamp
),
5529 return Fcons (item
, Fcons (position
, Qnil
));
5531 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5533 position
= make_lispy_position (f
, event
->x
, event
->y
,
5536 #ifndef USE_TOOLKIT_SCROLL_BARS
5539 /* It's a scrollbar click. */
5541 Lisp_Object portion_whole
;
5544 window
= event
->frame_or_window
;
5545 portion_whole
= Fcons (event
->x
, event
->y
);
5546 part
= *scroll_bar_parts
[(int) event
->part
];
5550 Fcons (Qvertical_scroll_bar
,
5551 Fcons (portion_whole
,
5552 Fcons (make_number (event
->timestamp
),
5553 Fcons (part
, Qnil
)))));
5555 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5557 if (button
>= ASIZE (button_down_location
))
5559 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5560 button_down_location
= larger_vector (button_down_location
,
5562 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5565 start_pos_ptr
= aref_addr (button_down_location
, button
);
5566 start_pos
= *start_pos_ptr
;
5567 *start_pos_ptr
= Qnil
;
5570 /* On window-system frames, use the value of
5571 double-click-fuzz as is. On other frames, interpret it
5572 as a multiple of 1/8 characters. */
5576 if (WINDOWP (event
->frame_or_window
))
5577 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5578 else if (FRAMEP (event
->frame_or_window
))
5579 f
= XFRAME (event
->frame_or_window
);
5583 if (FRAME_WINDOW_P (f
))
5584 fuzz
= double_click_fuzz
;
5586 fuzz
= double_click_fuzz
/ 8;
5588 is_double
= (button
== last_mouse_button
5589 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5590 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5591 && button_down_time
!= 0
5592 && (EQ (Vdouble_click_time
, Qt
)
5593 || (NATNUMP (Vdouble_click_time
)
5594 && (event
->timestamp
- button_down_time
5595 < XFASTINT (Vdouble_click_time
)))));
5598 last_mouse_button
= button
;
5599 last_mouse_x
= XINT (event
->x
);
5600 last_mouse_y
= XINT (event
->y
);
5602 /* If this is a button press, squirrel away the location, so
5603 we can decide later whether it was a click or a drag. */
5604 if (event
->modifiers
& down_modifier
)
5608 double_click_count
++;
5609 event
->modifiers
|= ((double_click_count
> 2)
5614 double_click_count
= 1;
5615 button_down_time
= event
->timestamp
;
5616 *start_pos_ptr
= Fcopy_alist (position
);
5617 ignore_mouse_drag_p
= 0;
5620 /* Now we're releasing a button - check the co-ordinates to
5621 see if this was a click or a drag. */
5622 else if (event
->modifiers
& up_modifier
)
5624 /* If we did not see a down before this up, ignore the up.
5625 Probably this happened because the down event chose a
5626 menu item. It would be an annoyance to treat the
5627 release of the button that chose the menu item as a
5630 if (!CONSP (start_pos
))
5633 event
->modifiers
&= ~up_modifier
;
5636 Lisp_Object new_down
, down
;
5637 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5639 /* The third element of every position
5640 should be the (x,y) pair. */
5641 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5642 new_down
= Fcar (Fcdr (Fcdr (position
)));
5645 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5647 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5648 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5651 if (ignore_mouse_drag_p
)
5653 event
->modifiers
|= click_modifier
;
5654 ignore_mouse_drag_p
= 0;
5656 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5657 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5658 /* Maybe the mouse has moved a lot, caused scrolling, and
5659 eventually ended up at the same screen position (but
5660 not buffer position) in which case it is a drag, not
5662 /* FIXME: OTOH if the buffer position has changed
5663 because of a timer or process filter rather than
5664 because of mouse movement, it should be considered as
5665 a click. But mouse-drag-region completely ignores
5666 this case and it hasn't caused any real problem, so
5667 it's probably OK to ignore it as well. */
5668 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5669 /* Mouse hasn't moved (much). */
5670 event
->modifiers
|= click_modifier
;
5673 button_down_time
= 0;
5674 event
->modifiers
|= drag_modifier
;
5677 /* Don't check is_double; treat this as multiple
5678 if the down-event was multiple. */
5679 if (double_click_count
> 1)
5680 event
->modifiers
|= ((double_click_count
> 2)
5686 /* Every mouse event should either have the down_modifier or
5687 the up_modifier set. */
5691 /* Get the symbol we should use for the mouse click. */
5694 head
= modify_event_symbol (button
,
5696 Qmouse_click
, Vlispy_mouse_stem
,
5699 ASIZE (mouse_syms
));
5700 if (event
->modifiers
& drag_modifier
)
5705 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5708 Fcons (make_number (double_click_count
),
5718 case HORIZ_WHEEL_EVENT
:
5720 Lisp_Object position
;
5723 /* Build the position as appropriate for this mouse click. */
5724 struct frame
*f
= XFRAME (event
->frame_or_window
);
5726 /* Ignore wheel events that were made on frame that have been
5728 if (! FRAME_LIVE_P (f
))
5731 position
= make_lispy_position (f
, event
->x
, event
->y
,
5734 /* Set double or triple modifiers to indicate the wheel speed. */
5736 /* On window-system frames, use the value of
5737 double-click-fuzz as is. On other frames, interpret it
5738 as a multiple of 1/8 characters. */
5744 if (WINDOWP (event
->frame_or_window
))
5745 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5746 else if (FRAMEP (event
->frame_or_window
))
5747 fr
= XFRAME (event
->frame_or_window
);
5751 fuzz
= FRAME_WINDOW_P (fr
)
5752 ? double_click_fuzz
: double_click_fuzz
/ 8;
5754 if (event
->modifiers
& up_modifier
)
5756 /* Emit a wheel-up event. */
5757 event
->modifiers
&= ~up_modifier
;
5760 else if (event
->modifiers
& down_modifier
)
5762 /* Emit a wheel-down event. */
5763 event
->modifiers
&= ~down_modifier
;
5767 /* Every wheel event should either have the down_modifier or
5768 the up_modifier set. */
5771 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5774 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5775 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5776 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5777 && button_down_time
!= 0
5778 && (EQ (Vdouble_click_time
, Qt
)
5779 || (NATNUMP (Vdouble_click_time
)
5780 && (event
->timestamp
- button_down_time
5781 < XFASTINT (Vdouble_click_time
)))));
5784 double_click_count
++;
5785 event
->modifiers
|= ((double_click_count
> 2)
5791 double_click_count
= 1;
5792 event
->modifiers
|= click_modifier
;
5795 button_down_time
= event
->timestamp
;
5796 /* Use a negative value to distinguish wheel from mouse button. */
5797 last_mouse_button
= - (1 + symbol_num
);
5798 last_mouse_x
= XINT (event
->x
);
5799 last_mouse_y
= XINT (event
->y
);
5801 /* Get the symbol we should use for the wheel event. */
5802 head
= modify_event_symbol (symbol_num
,
5808 ASIZE (wheel_syms
));
5811 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5814 Fcons (make_number (double_click_count
),
5823 #ifdef USE_TOOLKIT_SCROLL_BARS
5825 /* We don't have down and up events if using toolkit scroll bars,
5826 so make this always a click event. Store in the `part' of
5827 the Lisp event a symbol which maps to the following actions:
5829 `above_handle' page up
5830 `below_handle' page down
5834 `bottom' bottom of buffer
5835 `handle' thumb has been dragged.
5836 `end-scroll' end of interaction with scroll bar
5838 The incoming input_event contains in its `part' member an
5839 index of type `enum scroll_bar_part' which we can use as an
5840 index in scroll_bar_parts to get the appropriate symbol. */
5842 case SCROLL_BAR_CLICK_EVENT
:
5844 Lisp_Object position
, head
, window
, portion_whole
, part
;
5846 window
= event
->frame_or_window
;
5847 portion_whole
= Fcons (event
->x
, event
->y
);
5848 part
= *scroll_bar_parts
[(int) event
->part
];
5852 Fcons (Qvertical_scroll_bar
,
5853 Fcons (portion_whole
,
5854 Fcons (make_number (event
->timestamp
),
5855 Fcons (part
, Qnil
)))));
5857 /* Always treat scroll bar events as clicks. */
5858 event
->modifiers
|= click_modifier
;
5859 event
->modifiers
&= ~up_modifier
;
5861 if (event
->code
>= ASIZE (mouse_syms
))
5862 mouse_syms
= larger_vector (mouse_syms
,
5863 event
->code
- ASIZE (mouse_syms
) + 1,
5866 /* Get the symbol we should use for the mouse click. */
5867 head
= modify_event_symbol (event
->code
,
5872 ASIZE (mouse_syms
));
5873 return Fcons (head
, Fcons (position
, Qnil
));
5876 #endif /* USE_TOOLKIT_SCROLL_BARS */
5878 case DRAG_N_DROP_EVENT
:
5881 Lisp_Object head
, position
;
5884 f
= XFRAME (event
->frame_or_window
);
5887 /* Ignore mouse events that were made on frames that
5888 have been deleted. */
5889 if (! FRAME_LIVE_P (f
))
5892 position
= make_lispy_position (f
, event
->x
, event
->y
,
5895 head
= modify_event_symbol (0, event
->modifiers
,
5897 lispy_drag_n_drop_names
,
5898 &drag_n_drop_syms
, 1);
5904 #endif /* HAVE_MOUSE */
5906 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5907 || defined (HAVE_NS) || defined (USE_GTK)
5908 case MENU_BAR_EVENT
:
5909 if (EQ (event
->arg
, event
->frame_or_window
))
5910 /* This is the prefix key. We translate this to
5911 `(menu_bar)' because the code in keyboard.c for menu
5912 events, which we use, relies on this. */
5913 return Fcons (Qmenu_bar
, Qnil
);
5917 case SELECT_WINDOW_EVENT
:
5918 /* Make an event (select-window (WINDOW)). */
5919 return Fcons (Qselect_window
,
5920 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5923 case TOOL_BAR_EVENT
:
5924 if (EQ (event
->arg
, event
->frame_or_window
))
5925 /* This is the prefix key. We translate this to
5926 `(tool_bar)' because the code in keyboard.c for tool bar
5927 events, which we use, relies on this. */
5928 return Fcons (Qtool_bar
, Qnil
);
5929 else if (SYMBOLP (event
->arg
))
5930 return apply_modifiers (event
->modifiers
, event
->arg
);
5933 case USER_SIGNAL_EVENT
:
5934 /* A user signal. */
5936 char *name
= find_user_signal_name (event
->code
);
5939 return intern (name
);
5942 case SAVE_SESSION_EVENT
:
5943 return Qsave_session
;
5948 return Fcons (Qdbus_event
, event
->arg
);
5950 #endif /* HAVE_DBUS */
5952 case CONFIG_CHANGED_EVENT
:
5953 return Fcons (Qconfig_changed_event
,
5955 Fcons (event
->frame_or_window
, Qnil
)));
5957 case GPM_CLICK_EVENT
:
5959 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5960 Lisp_Object head
, position
;
5961 Lisp_Object
*start_pos_ptr
;
5962 Lisp_Object start_pos
;
5963 int button
= event
->code
;
5965 if (button
>= ASIZE (button_down_location
))
5967 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5968 button_down_location
= larger_vector (button_down_location
,
5970 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5973 start_pos_ptr
= aref_addr (button_down_location
, button
);
5974 start_pos
= *start_pos_ptr
;
5976 position
= make_lispy_position (f
, event
->x
, event
->y
,
5979 if (event
->modifiers
& down_modifier
)
5980 *start_pos_ptr
= Fcopy_alist (position
);
5981 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5983 if (!CONSP (start_pos
))
5985 event
->modifiers
&= ~up_modifier
;
5988 head
= modify_event_symbol (button
,
5990 Qmouse_click
, Vlispy_mouse_stem
,
5993 ASIZE (mouse_syms
));
5995 if (event
->modifiers
& drag_modifier
)
6000 else if (event
->modifiers
& double_modifier
)
6003 Fcons (make_number (2),
6005 else if (event
->modifiers
& triple_modifier
)
6008 Fcons (make_number (3),
6015 #endif /* HAVE_GPM */
6017 /* The 'kind' field of the event is something we don't recognize. */
6023 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6026 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6027 Lisp_Object x
, Lisp_Object y
, Time t
)
6029 /* Is it a scroll bar movement? */
6030 if (frame
&& ! NILP (bar_window
))
6032 Lisp_Object part_sym
;
6034 part_sym
= *scroll_bar_parts
[(int) part
];
6035 return Fcons (Qscroll_bar_movement
,
6036 Fcons (list5 (bar_window
,
6037 Qvertical_scroll_bar
,
6043 /* Or is it an ordinary mouse movement? */
6046 Lisp_Object position
;
6047 position
= make_lispy_position (frame
, x
, y
, t
);
6048 return list2 (Qmouse_movement
, position
);
6052 #endif /* HAVE_MOUSE || HAVE GPM */
6054 /* Construct a switch frame event. */
6056 make_lispy_switch_frame (Lisp_Object frame
)
6058 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6061 /* Manipulating modifiers. */
6063 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6065 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6066 SYMBOL's name of the end of the modifiers; the string from this
6067 position is the unmodified symbol name.
6069 This doesn't use any caches. */
6072 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6078 CHECK_SYMBOL (symbol
);
6081 name
= SYMBOL_NAME (symbol
);
6083 for (i
= 0; i
< SBYTES (name
) - 1; )
6085 ptrdiff_t this_mod_end
= 0;
6088 /* See if the name continues with a modifier word.
6089 Check that the word appears, but don't check what follows it.
6090 Set this_mod and this_mod_end to record what we find. */
6092 switch (SREF (name
, i
))
6094 #define SINGLE_LETTER_MOD(BIT) \
6095 (this_mod_end = i + 1, this_mod = BIT)
6098 SINGLE_LETTER_MOD (alt_modifier
);
6102 SINGLE_LETTER_MOD (ctrl_modifier
);
6106 SINGLE_LETTER_MOD (hyper_modifier
);
6110 SINGLE_LETTER_MOD (meta_modifier
);
6114 SINGLE_LETTER_MOD (shift_modifier
);
6118 SINGLE_LETTER_MOD (super_modifier
);
6121 #undef SINGLE_LETTER_MOD
6123 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6124 if (i + LEN + 1 <= SBYTES (name) \
6125 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6127 this_mod_end = i + LEN; \
6132 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6133 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6134 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6138 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6140 #undef MULTI_LETTER_MOD
6144 /* If we found no modifier, stop looking for them. */
6145 if (this_mod_end
== 0)
6148 /* Check there is a dash after the modifier, so that it
6149 really is a modifier. */
6150 if (this_mod_end
>= SBYTES (name
)
6151 || SREF (name
, this_mod_end
) != '-')
6154 /* This modifier is real; look for another. */
6155 modifiers
|= this_mod
;
6156 i
= this_mod_end
+ 1;
6159 /* Should we include the `click' modifier? */
6160 if (! (modifiers
& (down_modifier
| drag_modifier
6161 | double_modifier
| triple_modifier
))
6162 && i
+ 7 == SBYTES (name
)
6163 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6164 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6165 modifiers
|= click_modifier
;
6167 if (! (modifiers
& (double_modifier
| triple_modifier
))
6168 && i
+ 6 < SBYTES (name
)
6169 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6170 modifiers
|= click_modifier
;
6178 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6179 prepended to the string BASE[0..BASE_LEN-1].
6180 This doesn't use any caches. */
6182 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6184 /* Since BASE could contain nulls, we can't use intern here; we have
6185 to use Fintern, which expects a genuine Lisp_String, and keeps a
6187 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6193 /* Only the event queue may use the `up' modifier; it should always
6194 be turned into a click or drag event before presented to lisp code. */
6195 if (modifiers
& up_modifier
)
6198 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6199 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6200 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6201 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6202 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6203 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6204 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6205 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6206 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6207 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6208 /* The click modifier is denoted by the absence of other modifiers. */
6212 mod_len
= p
- new_mods
;
6216 Lisp_Object new_name
;
6218 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6219 mod_len
+ base_len_byte
);
6220 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6221 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6223 return Fintern (new_name
, Qnil
);
6228 static const char *const modifier_names
[] =
6230 "up", "down", "drag", "click", "double", "triple", 0, 0,
6231 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6232 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6234 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6236 static Lisp_Object modifier_symbols
;
6238 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6240 lispy_modifier_list (int modifiers
)
6242 Lisp_Object modifier_list
;
6245 modifier_list
= Qnil
;
6246 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6247 if (modifiers
& (1<<i
))
6248 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6251 return modifier_list
;
6255 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6256 where UNMODIFIED is the unmodified form of SYMBOL,
6257 MASK is the set of modifiers present in SYMBOL's name.
6258 This is similar to parse_modifiers_uncached, but uses the cache in
6259 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6260 Qevent_symbol_elements property. */
6262 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6265 parse_modifiers (Lisp_Object symbol
)
6267 Lisp_Object elements
;
6269 if (INTEGERP (symbol
))
6270 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6271 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6273 else if (!SYMBOLP (symbol
))
6276 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6277 if (CONSP (elements
))
6282 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6283 Lisp_Object unmodified
;
6286 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6287 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6290 if (modifiers
& ~INTMASK
)
6292 XSETFASTINT (mask
, modifiers
);
6293 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6295 /* Cache the parsing results on SYMBOL. */
6296 Fput (symbol
, Qevent_symbol_element_mask
,
6298 Fput (symbol
, Qevent_symbol_elements
,
6299 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6301 /* Since we know that SYMBOL is modifiers applied to unmodified,
6302 it would be nice to put that in unmodified's cache.
6303 But we can't, since we're not sure that parse_modifiers is
6310 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6311 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6312 doc
: /* Parse the event symbol. For internal use. */)
6313 (Lisp_Object symbol
)
6315 /* Fill the cache if needed. */
6316 parse_modifiers (symbol
);
6317 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6318 and use the Lispier representation stored on Qevent_symbol_elements
6320 return Fget (symbol
, Qevent_symbol_elements
);
6323 /* Apply the modifiers MODIFIERS to the symbol BASE.
6324 BASE must be unmodified.
6326 This is like apply_modifiers_uncached, but uses BASE's
6327 Qmodifier_cache property, if present. It also builds
6328 Qevent_symbol_elements properties, since it has that info anyway.
6330 apply_modifiers copies the value of BASE's Qevent_kind property to
6331 the modified symbol. */
6333 apply_modifiers (int modifiers
, Lisp_Object base
)
6335 Lisp_Object cache
, idx
, entry
, new_symbol
;
6337 /* Mask out upper bits. We don't know where this value's been. */
6338 modifiers
&= INTMASK
;
6340 if (INTEGERP (base
))
6341 return make_number (XINT (base
) | modifiers
);
6343 /* The click modifier never figures into cache indices. */
6344 cache
= Fget (base
, Qmodifier_cache
);
6345 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6346 entry
= assq_no_quit (idx
, cache
);
6349 new_symbol
= XCDR (entry
);
6352 /* We have to create the symbol ourselves. */
6353 new_symbol
= apply_modifiers_uncached (modifiers
,
6354 SSDATA (SYMBOL_NAME (base
)),
6355 SCHARS (SYMBOL_NAME (base
)),
6356 SBYTES (SYMBOL_NAME (base
)));
6358 /* Add the new symbol to the base's cache. */
6359 entry
= Fcons (idx
, new_symbol
);
6360 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6362 /* We have the parsing info now for free, so we could add it to
6364 XSETFASTINT (idx, modifiers);
6365 Fput (new_symbol, Qevent_symbol_element_mask,
6366 Fcons (base, Fcons (idx, Qnil)));
6367 Fput (new_symbol, Qevent_symbol_elements,
6368 Fcons (base, lispy_modifier_list (modifiers)));
6369 Sadly, this is only correct if `base' is indeed a base event,
6370 which is not necessarily the case. -stef */
6373 /* Make sure this symbol is of the same kind as BASE.
6375 You'd think we could just set this once and for all when we
6376 intern the symbol above, but reorder_modifiers may call us when
6377 BASE's property isn't set right; we can't assume that just
6378 because it has a Qmodifier_cache property it must have its
6379 Qevent_kind set right as well. */
6380 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6384 kind
= Fget (base
, Qevent_kind
);
6386 Fput (new_symbol
, Qevent_kind
, kind
);
6393 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6394 return a symbol with the modifiers placed in the canonical order.
6395 Canonical order is alphabetical, except for down and drag, which
6396 always come last. The 'click' modifier is never written out.
6398 Fdefine_key calls this to make sure that (for example) C-M-foo
6399 and M-C-foo end up being equivalent in the keymap. */
6402 reorder_modifiers (Lisp_Object symbol
)
6404 /* It's hopefully okay to write the code this way, since everything
6405 will soon be in caches, and no consing will be done at all. */
6408 parsed
= parse_modifiers (symbol
);
6409 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6414 /* For handling events, we often want to produce a symbol whose name
6415 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6416 to some base, like the name of a function key or mouse button.
6417 modify_event_symbol produces symbols of this sort.
6419 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6420 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6423 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6424 into symbol names, or a string specifying a name stem used to
6425 construct a symbol name or the form `STEM-N', where N is the decimal
6426 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6427 non-nil; otherwise NAME_TABLE is used.
6429 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6430 persist between calls to modify_event_symbol that it can use to
6431 store a cache of the symbols it's generated for this NAME_TABLE
6432 before. The object stored there may be a vector or an alist.
6434 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6436 MODIFIERS is a set of modifier bits (as given in struct input_events)
6437 whose prefixes should be applied to the symbol name.
6439 SYMBOL_KIND is the value to be placed in the event_kind property of
6440 the returned symbol.
6442 The symbols we create are supposed to have an
6443 `event-symbol-elements' property, which lists the modifiers present
6444 in the symbol's name. */
6447 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6448 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6449 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6452 Lisp_Object symbol_int
;
6454 /* Get rid of the "vendor-specific" bit here. */
6455 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6457 /* Is this a request for a valid symbol? */
6458 if (symbol_num
< 0 || symbol_num
>= table_size
)
6461 if (CONSP (*symbol_table
))
6462 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6464 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6465 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6466 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6467 we've never used that symbol before. */
6470 if (! VECTORP (*symbol_table
)
6471 || ASIZE (*symbol_table
) != table_size
)
6475 XSETFASTINT (size
, table_size
);
6476 *symbol_table
= Fmake_vector (size
, Qnil
);
6479 value
= AREF (*symbol_table
, symbol_num
);
6482 /* Have we already used this symbol before? */
6485 /* No; let's create it. */
6486 if (CONSP (name_alist_or_stem
))
6487 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6488 else if (STRINGP (name_alist_or_stem
))
6491 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6492 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6494 buf
= SAFE_ALLOCA (len
);
6495 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6496 XINT (symbol_int
) + 1);
6497 value
= intern (buf
);
6500 else if (name_table
!= 0 && name_table
[symbol_num
])
6501 value
= intern (name_table
[symbol_num
]);
6503 #ifdef HAVE_WINDOW_SYSTEM
6506 char *name
= x_get_keysym_name (symbol_num
);
6508 value
= intern (name
);
6514 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6515 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6516 value
= intern (buf
);
6519 if (CONSP (*symbol_table
))
6520 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6522 ASET (*symbol_table
, symbol_num
, value
);
6524 /* Fill in the cache entries for this symbol; this also
6525 builds the Qevent_symbol_elements property, which the user
6527 apply_modifiers (modifiers
& click_modifier
, value
);
6528 Fput (value
, Qevent_kind
, symbol_kind
);
6531 /* Apply modifiers to that symbol. */
6532 return apply_modifiers (modifiers
, value
);
6535 /* Convert a list that represents an event type,
6536 such as (ctrl meta backspace), into the usual representation of that
6537 event type as a number or a symbol. */
6539 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6540 doc
: /* Convert the event description list EVENT-DESC to an event type.
6541 EVENT-DESC should contain one base event type (a character or symbol)
6542 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6543 drag, down, double or triple). The base must be last.
6544 The return value is an event type (a character or symbol) which
6545 has the same base event type and all the specified modifiers. */)
6546 (Lisp_Object event_desc
)
6554 while (CONSP (rest
))
6562 /* Given a symbol, see if it is a modifier name. */
6563 if (SYMBOLP (elt
) && CONSP (rest
))
6564 this = parse_solitary_modifier (elt
);
6568 else if (!NILP (base
))
6569 error ("Two bases given in one event");
6575 /* Let the symbol A refer to the character A. */
6576 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6577 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6579 if (INTEGERP (base
))
6581 /* Turn (shift a) into A. */
6582 if ((modifiers
& shift_modifier
) != 0
6583 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6585 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6586 modifiers
&= ~shift_modifier
;
6589 /* Turn (control a) into C-a. */
6590 if (modifiers
& ctrl_modifier
)
6591 return make_number ((modifiers
& ~ctrl_modifier
)
6592 | make_ctrl_char (XINT (base
)));
6594 return make_number (modifiers
| XINT (base
));
6596 else if (SYMBOLP (base
))
6597 return apply_modifiers (modifiers
, base
);
6600 error ("Invalid base event");
6605 /* Try to recognize SYMBOL as a modifier name.
6606 Return the modifier flag bit, or 0 if not recognized. */
6609 parse_solitary_modifier (Lisp_Object symbol
)
6611 Lisp_Object name
= SYMBOL_NAME (symbol
);
6613 switch (SREF (name
, 0))
6615 #define SINGLE_LETTER_MOD(BIT) \
6616 if (SBYTES (name) == 1) \
6619 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6620 if (LEN == SBYTES (name) \
6621 && ! memcmp (SDATA (name), NAME, LEN)) \
6625 SINGLE_LETTER_MOD (alt_modifier
);
6629 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6633 SINGLE_LETTER_MOD (ctrl_modifier
);
6637 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6638 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6642 SINGLE_LETTER_MOD (hyper_modifier
);
6646 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6650 SINGLE_LETTER_MOD (meta_modifier
);
6654 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6658 SINGLE_LETTER_MOD (shift_modifier
);
6662 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6663 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6664 SINGLE_LETTER_MOD (super_modifier
);
6668 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6669 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6670 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6674 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6677 #undef SINGLE_LETTER_MOD
6678 #undef MULTI_LETTER_MOD
6684 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6685 Such a list is not valid as an event,
6686 but it can be a Lucid-style event type list. */
6689 lucid_event_type_list_p (Lisp_Object object
)
6693 if (! CONSP (object
))
6696 if (EQ (XCAR (object
), Qhelp_echo
)
6697 || EQ (XCAR (object
), Qvertical_line
)
6698 || EQ (XCAR (object
), Qmode_line
)
6699 || EQ (XCAR (object
), Qheader_line
))
6702 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6706 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6713 /* Store into *addr a value nonzero if terminal input chars are available.
6714 Serves the purpose of ioctl (0, FIONREAD, addr)
6715 but works even if FIONREAD does not exist.
6716 (In fact, this may actually read some input.)
6718 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6719 timer events that are ripe.
6720 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6721 events (FOCUS_IN_EVENT).
6722 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6723 movements and toolkit scroll bar thumb drags. */
6726 get_input_pending (int *addr
, int flags
)
6728 /* First of all, have we already counted some input? */
6729 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6731 /* If input is being read as it arrives, and we have none, there is none. */
6732 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6735 /* Try to read some input and see how much we get. */
6737 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6740 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6746 if (interrupt_input
)
6748 sigset_t blocked
, procmask
;
6749 sigemptyset (&blocked
);
6750 sigaddset (&blocked
, SIGIO
);
6751 pthread_sigmask (SIG_BLOCK
, &blocked
, &procmask
);
6752 read_avail_input ();
6753 pthread_sigmask (SIG_SETMASK
, &procmask
, 0);
6756 #ifdef POLL_FOR_INPUT
6757 /* XXX This condition was (read_socket_hook && !interrupt_input),
6758 but read_socket_hook is not global anymore. Let's pretend that
6760 if (!interrupt_input
&& poll_suppress_count
== 0)
6762 sigset_t blocked
, procmask
;
6763 sigemptyset (&blocked
);
6764 sigaddset (&blocked
, SIGALRM
);
6765 pthread_sigmask (SIG_BLOCK
, &blocked
, &procmask
);
6766 read_avail_input ();
6767 pthread_sigmask (SIG_SETMASK
, &procmask
, 0);
6772 read_avail_input ();
6775 /* Put a BUFFER_SWITCH_EVENT in the buffer
6776 so that read_key_sequence will notice the new current buffer. */
6779 record_asynch_buffer_change (void)
6781 struct input_event event
;
6785 event
.kind
= BUFFER_SWITCH_EVENT
;
6786 event
.frame_or_window
= Qnil
;
6789 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6790 The purpose of the event is to make read_key_sequence look up the
6791 keymaps again. If we aren't in read_key_sequence, we don't need one,
6792 and the event could cause trouble by messing up (input-pending-p).
6793 Note: Fwaiting_for_user_input_p always returns nil when async
6794 subprocesses aren't supported. */
6795 tem
= Fwaiting_for_user_input_p ();
6799 /* Make sure no interrupt happens while storing the event. */
6801 if (interrupt_input
)
6803 sigset_t blocked
, procmask
;
6804 sigemptyset (&blocked
);
6805 sigaddset (&blocked
, SIGIO
);
6806 pthread_sigmask (SIG_BLOCK
, &blocked
, &procmask
);
6807 kbd_buffer_store_event (&event
);
6808 pthread_sigmask (SIG_SETMASK
, &procmask
, 0);
6814 kbd_buffer_store_event (&event
);
6819 /* Read any terminal input already buffered up by the system
6820 into the kbd_buffer, but do not wait.
6822 EXPECTED should be nonzero if the caller knows there is some input.
6824 Returns the number of keyboard chars read, or -1 meaning
6825 this is a bad time to try to read input. */
6828 read_avail_input (void)
6834 /* Store pending user signal events, if any. */
6835 store_user_signal_events ();
6837 /* Loop through the available terminals, and call their input hooks. */
6841 struct terminal
*next
= t
->next_terminal
;
6843 if (t
->read_socket_hook
)
6846 struct input_event hold_quit
;
6848 EVENT_INIT (hold_quit
);
6849 hold_quit
.kind
= NO_EVENT
;
6851 /* No need for FIONREAD or fcntl; just say don't wait. */
6852 while (0 < (nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)))
6855 if (nr
== -1) /* Not OK to read input now. */
6859 else if (nr
== -2) /* Non-transient error. */
6861 /* The terminal device terminated; it should be closed. */
6863 /* Kill Emacs if this was our last terminal. */
6864 if (!terminal_list
->next_terminal
)
6865 /* Formerly simply reported no input, but that
6866 sometimes led to a failure of Emacs to terminate.
6867 SIGHUP seems appropriate if we can't reach the
6869 /* ??? Is it really right to send the signal just to
6870 this process rather than to the whole process
6871 group? Perhaps on systems with FIONREAD Emacs is
6872 alone in its group. */
6873 kill (getpid (), SIGHUP
);
6875 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6878 XSETTERMINAL (tmp
, t
);
6879 Fdelete_terminal (tmp
, Qnoelisp
);
6883 if (hold_quit
.kind
!= NO_EVENT
)
6884 kbd_buffer_store_event (&hold_quit
);
6893 frame_make_pointer_visible ();
6899 decode_keyboard_code (struct tty_display_info
*tty
,
6900 struct coding_system
*coding
,
6901 unsigned char *buf
, int nbytes
)
6903 unsigned char *src
= buf
;
6904 const unsigned char *p
;
6909 if (tty
->meta_key
!= 2)
6910 for (i
= 0; i
< nbytes
; i
++)
6912 if (coding
->carryover_bytes
> 0)
6914 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6915 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6916 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6917 nbytes
+= coding
->carryover_bytes
;
6919 coding
->destination
= alloca (nbytes
* 4);
6920 coding
->dst_bytes
= nbytes
* 4;
6921 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6922 if (coding
->produced_char
== 0)
6924 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6926 struct input_event event_buf
;
6928 EVENT_INIT (event_buf
);
6929 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6931 (ASCII_CHAR_P (event_buf
.code
)
6932 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6933 /* See the comment in tty_read_avail_input. */
6934 event_buf
.frame_or_window
= tty
->top_frame
;
6935 event_buf
.arg
= Qnil
;
6936 kbd_buffer_store_event (&event_buf
);
6940 /* This is the tty way of reading available input.
6942 Note that each terminal device has its own `struct terminal' object,
6943 and so this function is called once for each individual termcap
6944 terminal. The first parameter indicates which terminal to read from. */
6947 tty_read_avail_input (struct terminal
*terminal
,
6948 struct input_event
*hold_quit
)
6950 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6951 the kbd_buffer can really hold. That may prevent loss
6952 of characters on some systems when input is stuffed at us. */
6953 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6955 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6958 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6960 if (kbd_on_hold_p () || buffer_free
<= 0)
6962 #endif /* subprocesses */
6964 if (!terminal
->name
) /* Don't read from a dead terminal. */
6967 if (terminal
->type
!= output_termcap
6968 && terminal
->type
!= output_msdos_raw
)
6971 /* XXX I think the following code should be moved to separate hook
6972 functions in system-dependent files. */
6975 #else /* not WINDOWSNT */
6976 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6980 return 0; /* The terminal is suspended. */
6983 n_to_read
= dos_keysns ();
6987 cbuf
[0] = dos_keyread ();
6990 #else /* not MSDOS */
6995 struct input_event gpm_hold_quit
;
6996 int gpm
, fd
= gpm_fd
;
6998 EVENT_INIT (gpm_hold_quit
);
6999 gpm_hold_quit
.kind
= NO_EVENT
;
7001 /* gpm==1 if event received.
7002 gpm==0 if the GPM daemon has closed the connection, in which case
7003 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7004 we save it in `fd' so close_gpm can remove it from the
7006 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7007 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7008 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7011 /* Presumably the GPM daemon has closed the connection. */
7013 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7014 kbd_buffer_store_event (&gpm_hold_quit
);
7018 #endif /* HAVE_GPM */
7020 /* Determine how many characters we should *try* to read. */
7021 #ifdef USABLE_FIONREAD
7022 /* Find out how much input is available. */
7023 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7025 if (! noninteractive
)
7026 return -2; /* Close this terminal. */
7032 if (n_to_read
> sizeof cbuf
)
7033 n_to_read
= sizeof cbuf
;
7034 #elif defined USG || defined CYGWIN
7035 /* Read some input if available, but don't wait. */
7036 n_to_read
= sizeof cbuf
;
7037 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7039 # error "Cannot read without possibly delaying"
7043 /* Don't read more than we can store. */
7044 if (n_to_read
> buffer_free
)
7045 n_to_read
= buffer_free
;
7046 #endif /* subprocesses */
7048 /* Now read; for one reason or another, this will not block.
7049 NREAD is set to the number of chars read. */
7052 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7053 /* POSIX infers that processes which are not in the session leader's
7054 process group won't get SIGHUP's at logout time. BSDI adheres to
7055 this part standard and returns -1 from read (0) with errno==EIO
7056 when the control tty is taken away.
7057 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7058 if (nread
== -1 && errno
== EIO
)
7059 return -2; /* Close this terminal. */
7060 #if defined (AIX) && defined (_BSD)
7061 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7062 This looks incorrect, but it isn't, because _BSD causes
7063 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7064 and that causes a value other than 0 when there is no input. */
7066 return -2; /* Close this terminal. */
7070 /* We used to retry the read if it was interrupted.
7071 But this does the wrong thing when O_NDELAY causes
7072 an EAGAIN error. Does anybody know of a situation
7073 where a retry is actually needed? */
7075 nread
< 0 && (errno
== EAGAIN
7088 #ifndef USABLE_FIONREAD
7089 #if defined (USG) || defined (CYGWIN)
7090 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7091 #endif /* USG or CYGWIN */
7092 #endif /* no FIONREAD */
7097 #endif /* not MSDOS */
7098 #endif /* not WINDOWSNT */
7100 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7101 & CODING_REQUIRE_DECODING_MASK
)
7103 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7106 /* Decode the key sequence except for those with meta
7108 for (i
= from
= 0; ; i
++)
7109 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7111 struct input_event buf
;
7113 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7118 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7119 buf
.modifiers
= meta_modifier
;
7120 buf
.code
= cbuf
[i
] & ~0x80;
7121 /* See the comment below. */
7122 buf
.frame_or_window
= tty
->top_frame
;
7124 kbd_buffer_store_event (&buf
);
7130 for (i
= 0; i
< nread
; i
++)
7132 struct input_event buf
;
7134 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7136 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7137 buf
.modifiers
= meta_modifier
;
7138 if (tty
->meta_key
!= 2)
7142 /* Set the frame corresponding to the active tty. Note that the
7143 value of selected_frame is not reliable here, redisplay tends
7144 to temporarily change it. */
7145 buf
.frame_or_window
= tty
->top_frame
;
7148 kbd_buffer_store_event (&buf
);
7149 /* Don't look at input that follows a C-g too closely.
7150 This reduces lossage due to autorepeat on C-g. */
7151 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7152 && buf
.code
== quit_char
)
7160 handle_async_input (void)
7162 interrupt_input_pending
= 0;
7163 pending_signals
= pending_atimers
;
7167 int nread
= read_avail_input ();
7168 /* -1 means it's not ok to read the input now.
7169 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7170 0 means there was no keyboard input available. */
7177 process_pending_signals (void)
7179 if (interrupt_input_pending
)
7180 handle_async_input ();
7181 do_pending_atimers ();
7187 handle_input_available_signal (int sig
)
7189 interrupt_input_pending
= 1;
7190 pending_signals
= 1;
7192 if (input_available_clear_time
)
7193 *input_available_clear_time
= make_emacs_time (0, 0);
7197 deliver_input_available_signal (int sig
)
7199 handle_on_main_thread (sig
, handle_input_available_signal
);
7201 #endif /* USABLE_SIGIO */
7203 /* Send ourselves a SIGIO.
7205 This function exists so that the UNBLOCK_INPUT macro in
7206 blockinput.h can have some way to take care of input we put off
7207 dealing with, without assuming that every file which uses
7208 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7210 reinvoke_input_signal (void)
7213 handle_async_input ();
7219 /* User signal events. */
7221 struct user_signal_info
7223 /* Signal number. */
7226 /* Name of the signal. */
7229 /* Number of pending signals. */
7232 struct user_signal_info
*next
;
7235 /* List of user signals. */
7236 static struct user_signal_info
*user_signals
= NULL
;
7239 add_user_signal (int sig
, const char *name
)
7241 struct sigaction action
;
7242 struct user_signal_info
*p
;
7244 for (p
= user_signals
; p
; p
= p
->next
)
7246 /* Already added. */
7249 p
= xmalloc (sizeof *p
);
7251 p
->name
= xstrdup (name
);
7253 p
->next
= user_signals
;
7256 emacs_sigaction_init (&action
, deliver_user_signal
);
7257 sigaction (sig
, &action
, 0);
7261 handle_user_signal (int sig
)
7263 struct user_signal_info
*p
;
7264 const char *special_event_name
= NULL
;
7266 if (SYMBOLP (Vdebug_on_event
))
7267 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7269 for (p
= user_signals
; p
; p
= p
->next
)
7272 if (special_event_name
7273 && strcmp (special_event_name
, p
->name
) == 0)
7275 /* Enter the debugger in many ways. */
7276 debug_on_next_call
= 1;
7279 Vinhibit_quit
= Qnil
;
7281 /* Eat the event. */
7287 if (interrupt_input
)
7288 kill (getpid (), SIGIO
);
7292 /* Tell wait_reading_process_output that it needs to wake
7293 up and look around. */
7294 if (input_available_clear_time
)
7295 *input_available_clear_time
= make_emacs_time (0, 0);
7302 deliver_user_signal (int sig
)
7304 handle_on_main_thread (sig
, handle_user_signal
);
7308 find_user_signal_name (int sig
)
7310 struct user_signal_info
*p
;
7312 for (p
= user_signals
; p
; p
= p
->next
)
7320 store_user_signal_events (void)
7322 struct user_signal_info
*p
;
7323 struct input_event buf
;
7324 bool buf_initialized
= 0;
7326 for (p
= user_signals
; p
; p
= p
->next
)
7327 if (p
->npending
> 0)
7329 sigset_t blocked
, procmask
;
7331 if (! buf_initialized
)
7333 memset (&buf
, 0, sizeof buf
);
7334 buf
.kind
= USER_SIGNAL_EVENT
;
7335 buf
.frame_or_window
= selected_frame
;
7336 buf_initialized
= 1;
7339 sigemptyset (&blocked
);
7340 sigaddset (&blocked
, p
->sig
);
7341 pthread_sigmask (SIG_BLOCK
, &blocked
, &procmask
);
7346 kbd_buffer_store_event (&buf
);
7349 while (p
->npending
> 0);
7351 pthread_sigmask (SIG_SETMASK
, &procmask
, 0);
7356 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7357 static Lisp_Object menu_bar_one_keymap_changed_items
;
7359 /* These variables hold the vector under construction within
7360 menu_bar_items and its subroutines, and the current index
7361 for storing into that vector. */
7362 static Lisp_Object menu_bar_items_vector
;
7363 static int menu_bar_items_index
;
7366 static const char* separator_names
[] = {
7371 "single-dashed-line",
7372 "double-dashed-line",
7374 "shadow-etched-out",
7375 "shadow-etched-in-dash",
7376 "shadow-etched-out-dash",
7377 "shadow-double-etched-in",
7378 "shadow-double-etched-out",
7379 "shadow-double-etched-in-dash",
7380 "shadow-double-etched-out-dash",
7384 /* Return non-zero if LABEL specifies a separator. */
7387 menu_separator_name_p (const char *label
)
7391 else if (strlen (label
) > 3
7392 && memcmp (label
, "--", 2) == 0
7397 for (i
= 0; separator_names
[i
]; ++i
)
7398 if (strcmp (label
, separator_names
[i
]) == 0)
7403 /* It's a separator if it contains only dashes. */
7404 while (*label
== '-')
7406 return (*label
== 0);
7413 /* Return a vector of menu items for a menu bar, appropriate
7414 to the current buffer. Each item has three elements in the vector:
7417 OLD is an old vector we can optionally reuse, or nil. */
7420 menu_bar_items (Lisp_Object old
)
7422 /* The number of keymaps we're scanning right now, and the number of
7423 keymaps we have allocated space for. */
7426 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7427 in the current keymaps, or nil where it is not a prefix. */
7430 Lisp_Object def
, tail
;
7435 /* In order to build the menus, we need to call the keymap
7436 accessors. They all call QUIT. But this function is called
7437 during redisplay, during which a quit is fatal. So inhibit
7438 quitting while building the menus.
7439 We do this instead of specbind because (1) errors will clear it anyway
7440 and (2) this avoids risk of specpdl overflow. */
7441 oquit
= Vinhibit_quit
;
7445 menu_bar_items_vector
= old
;
7447 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7448 menu_bar_items_index
= 0;
7450 /* Build our list of keymaps.
7451 If we recognize a function key and replace its escape sequence in
7452 keybuf with its symbol, or if the sequence starts with a mouse
7453 click and we need to switch buffers, we jump back here to rebuild
7454 the initial keymaps from the current buffer. */
7458 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7459 if (!NILP (Voverriding_local_map_menu_flag
))
7461 /* Yes, use them (if non-nil) as well as the global map. */
7462 maps
= alloca (3 * sizeof (maps
[0]));
7464 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7465 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7466 if (!NILP (Voverriding_local_map
))
7467 maps
[nmaps
++] = Voverriding_local_map
;
7471 /* No, so use major and minor mode keymaps and keymap property.
7472 Note that menu-bar bindings in the local-map and keymap
7473 properties may not work reliable, as they are only
7474 recognized when the menu-bar (or mode-line) is updated,
7475 which does not normally happen after every command. */
7478 nminor
= current_minor_maps (NULL
, &tmaps
);
7479 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7481 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7482 maps
[nmaps
++] = tem
;
7483 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7485 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7487 maps
[nmaps
++] = current_global_map
;
7490 /* Look up in each map the dummy prefix key `menu-bar'. */
7492 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7493 if (!NILP (maps
[mapno
]))
7495 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7499 menu_bar_one_keymap_changed_items
= Qnil
;
7500 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7504 /* Move to the end those items that should be at the end. */
7506 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7509 int end
= menu_bar_items_index
;
7511 for (i
= 0; i
< end
; i
+= 4)
7512 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7514 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7515 /* Move the item at index I to the end,
7516 shifting all the others forward. */
7517 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7518 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7519 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7520 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7522 memmove (aref_addr (menu_bar_items_vector
, i
),
7523 aref_addr (menu_bar_items_vector
, i
+ 4),
7524 (end
- i
- 4) * word_size
);
7525 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7526 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7527 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7528 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7533 /* Add nil, nil, nil, nil at the end. */
7535 int i
= menu_bar_items_index
;
7536 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7537 menu_bar_items_vector
=
7538 larger_vector (menu_bar_items_vector
, 4, -1);
7539 /* Add this item. */
7540 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7541 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7542 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7543 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7544 menu_bar_items_index
= i
;
7547 Vinhibit_quit
= oquit
;
7548 return menu_bar_items_vector
;
7551 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7552 If there's already an item for KEY, add this DEF to it. */
7554 Lisp_Object item_properties
;
7557 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7559 struct gcpro gcpro1
;
7563 if (EQ (item
, Qundefined
))
7565 /* If a map has an explicit `undefined' as definition,
7566 discard any previously made menu bar item. */
7568 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7569 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7571 if (menu_bar_items_index
> i
+ 4)
7572 memmove (aref_addr (menu_bar_items_vector
, i
),
7573 aref_addr (menu_bar_items_vector
, i
+ 4),
7574 (menu_bar_items_index
- i
- 4) * word_size
);
7575 menu_bar_items_index
-= 4;
7579 /* If this keymap has already contributed to this KEY,
7580 don't contribute to it a second time. */
7581 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7582 if (!NILP (tem
) || NILP (item
))
7585 menu_bar_one_keymap_changed_items
7586 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7588 /* We add to menu_bar_one_keymap_changed_items before doing the
7589 parse_menu_item, so that if it turns out it wasn't a menu item,
7590 it still correctly hides any further menu item. */
7592 i
= parse_menu_item (item
, 1);
7597 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7599 /* Find any existing item for this KEY. */
7600 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7601 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7604 /* If we did not find this KEY, add it at the end. */
7605 if (i
== menu_bar_items_index
)
7607 /* If vector is too small, get a bigger one. */
7608 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7609 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7610 /* Add this item. */
7611 ASET (menu_bar_items_vector
, i
, key
); i
++;
7612 ASET (menu_bar_items_vector
, i
,
7613 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7614 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7615 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7616 menu_bar_items_index
= i
;
7618 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7622 old
= AREF (menu_bar_items_vector
, i
+ 2);
7623 /* If the new and the old items are not both keymaps,
7624 the lookup will only find `item'. */
7625 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7626 ASET (menu_bar_items_vector
, i
+ 2, item
);
7630 /* This is used as the handler when calling menu_item_eval_property. */
7632 menu_item_eval_property_1 (Lisp_Object arg
)
7634 /* If we got a quit from within the menu computation,
7635 quit all the way out of it. This takes care of C-] in the debugger. */
7636 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7637 Fsignal (Qquit
, Qnil
);
7643 eval_dyn (Lisp_Object form
)
7645 return Feval (form
, Qnil
);
7648 /* Evaluate an expression and return the result (or nil if something
7649 went wrong). Used to evaluate dynamic parts of menu items. */
7651 menu_item_eval_property (Lisp_Object sexpr
)
7653 ptrdiff_t count
= SPECPDL_INDEX ();
7655 specbind (Qinhibit_redisplay
, Qt
);
7656 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7657 menu_item_eval_property_1
);
7658 return unbind_to (count
, val
);
7661 /* This function parses a menu item and leaves the result in the
7662 vector item_properties.
7663 ITEM is a key binding, a possible menu item.
7664 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7666 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7667 parse_menu_item returns true if the item is a menu item and false
7671 parse_menu_item (Lisp_Object item
, int inmenubar
)
7673 Lisp_Object def
, tem
, item_string
, start
;
7675 Lisp_Object keyhint
;
7684 /* Create item_properties vector if necessary. */
7685 if (NILP (item_properties
))
7687 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7689 /* Initialize optional entries. */
7690 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7691 ASET (item_properties
, i
, Qnil
);
7692 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7694 /* Save the item here to protect it from GC. */
7695 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7697 item_string
= XCAR (item
);
7701 if (STRINGP (item_string
))
7703 /* Old format menu item. */
7704 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7706 /* Maybe help string. */
7707 if (CONSP (item
) && STRINGP (XCAR (item
)))
7709 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7714 /* Maybe an obsolete key binding cache. */
7715 if (CONSP (item
) && CONSP (XCAR (item
))
7716 && (NILP (XCAR (XCAR (item
)))
7717 || VECTORP (XCAR (XCAR (item
)))))
7720 /* This is the real definition--the function to run. */
7721 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7723 /* Get enable property, if any. */
7726 tem
= Fget (item
, Qmenu_enable
);
7727 if (!NILP (Venable_disabled_menus_and_buttons
))
7728 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7729 else if (!NILP (tem
))
7730 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7733 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7735 /* New format menu item. */
7736 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7737 start
= XCDR (item
);
7740 /* We have a real binding. */
7741 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7743 item
= XCDR (start
);
7744 /* Is there an obsolete cache list with key equivalences. */
7745 if (CONSP (item
) && CONSP (XCAR (item
)))
7748 /* Parse properties. */
7749 while (CONSP (item
) && CONSP (XCDR (item
)))
7754 if (EQ (tem
, QCenable
))
7756 if (!NILP (Venable_disabled_menus_and_buttons
))
7757 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7759 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7761 else if (EQ (tem
, QCvisible
))
7763 /* If got a visible property and that evaluates to nil
7764 then ignore this item. */
7765 tem
= menu_item_eval_property (XCAR (item
));
7769 else if (EQ (tem
, QChelp
))
7770 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7771 else if (EQ (tem
, QCfilter
))
7773 else if (EQ (tem
, QCkey_sequence
))
7776 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7777 /* Be GC protected. Set keyhint to item instead of tem. */
7780 else if (EQ (tem
, QCkeys
))
7783 if (CONSP (tem
) || STRINGP (tem
))
7784 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7786 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7791 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7793 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7795 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7801 else if (inmenubar
|| !NILP (start
))
7805 return 0; /* not a menu item */
7807 /* If item string is not a string, evaluate it to get string.
7808 If we don't get a string, skip this item. */
7809 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7810 if (!(STRINGP (item_string
)))
7812 item_string
= menu_item_eval_property (item_string
);
7813 if (!STRINGP (item_string
))
7815 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7818 /* If got a filter apply it on definition. */
7819 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7822 def
= menu_item_eval_property (list2 (XCAR (filter
),
7823 list2 (Qquote
, def
)));
7825 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7828 /* Enable or disable selection of item. */
7829 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7832 tem
= menu_item_eval_property (tem
);
7833 if (inmenubar
&& NILP (tem
))
7834 return 0; /* Ignore disabled items in menu bar. */
7835 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7838 /* If we got no definition, this item is just unselectable text which
7839 is OK in a submenu but not in the menubar. */
7841 return (!inmenubar
);
7843 /* See if this is a separate pane or a submenu. */
7844 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7845 tem
= get_keymap (def
, 0, 1);
7846 /* For a subkeymap, just record its details and exit. */
7849 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7850 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7854 /* At the top level in the menu bar, do likewise for commands also.
7855 The menu bar does not display equivalent key bindings anyway.
7856 ITEM_PROPERTY_DEF is already set up properly. */
7860 { /* This is a command. See if there is an equivalent key binding. */
7861 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7863 /* The previous code preferred :key-sequence to :keys, so we
7864 preserve this behavior. */
7865 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7866 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7869 Lisp_Object prefix
= keyeq
;
7870 Lisp_Object keys
= Qnil
;
7874 def
= XCAR (prefix
);
7875 prefix
= XCDR (prefix
);
7878 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7880 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7882 keys
= XCAR (keyhint
);
7883 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7885 /* We have a suggested key. Is it bound to the command? */
7888 /* If the command is an alias for another
7889 (such as lmenu.el set it up), check if the
7890 original command matches the cached command. */
7892 && EQ (tem
, XSYMBOL (def
)->function
))))
7897 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7901 tem
= Fkey_description (keys
, Qnil
);
7904 if (STRINGP (XCAR (prefix
)))
7905 tem
= concat2 (XCAR (prefix
), tem
);
7906 if (STRINGP (XCDR (prefix
)))
7907 tem
= concat2 (tem
, XCDR (prefix
));
7909 keyeq
= concat2 (build_string (" "), tem
);
7910 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7916 /* If we have an equivalent key binding, use that. */
7917 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7920 /* Include this when menu help is implemented.
7921 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7922 if (!(NILP (tem) || STRINGP (tem)))
7924 tem = menu_item_eval_property (tem);
7927 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7931 /* Handle radio buttons or toggle boxes. */
7932 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7934 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7935 menu_item_eval_property (tem
));
7942 /***********************************************************************
7944 ***********************************************************************/
7946 /* A vector holding tool bar items while they are parsed in function
7947 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7950 static Lisp_Object tool_bar_items_vector
;
7952 /* A vector holding the result of parse_tool_bar_item. Layout is like
7953 the one for a single item in tool_bar_items_vector. */
7955 static Lisp_Object tool_bar_item_properties
;
7957 /* Next free index in tool_bar_items_vector. */
7959 static int ntool_bar_items
;
7961 /* The symbols `:image' and `:rtl'. */
7963 static Lisp_Object QCimage
;
7964 static Lisp_Object QCrtl
;
7966 /* Function prototypes. */
7968 static void init_tool_bar_items (Lisp_Object
);
7969 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7970 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7971 static void append_tool_bar_item (void);
7974 /* Return a vector of tool bar items for keymaps currently in effect.
7975 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7976 tool bar items found. */
7979 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7988 /* In order to build the menus, we need to call the keymap
7989 accessors. They all call QUIT. But this function is called
7990 during redisplay, during which a quit is fatal. So inhibit
7991 quitting while building the menus. We do this instead of
7992 specbind because (1) errors will clear it anyway and (2) this
7993 avoids risk of specpdl overflow. */
7994 oquit
= Vinhibit_quit
;
7997 /* Initialize tool_bar_items_vector and protect it from GC. */
7998 init_tool_bar_items (reuse
);
8000 /* Build list of keymaps in maps. Set nmaps to the number of maps
8003 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8004 if (!NILP (Voverriding_local_map_menu_flag
))
8006 /* Yes, use them (if non-nil) as well as the global map. */
8007 maps
= alloca (3 * sizeof *maps
);
8009 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8010 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8011 if (!NILP (Voverriding_local_map
))
8012 maps
[nmaps
++] = Voverriding_local_map
;
8016 /* No, so use major and minor mode keymaps and keymap property.
8017 Note that tool-bar bindings in the local-map and keymap
8018 properties may not work reliable, as they are only
8019 recognized when the tool-bar (or mode-line) is updated,
8020 which does not normally happen after every command. */
8023 nminor
= current_minor_maps (NULL
, &tmaps
);
8024 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
8026 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8027 maps
[nmaps
++] = tem
;
8028 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8030 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8033 /* Add global keymap at the end. */
8034 maps
[nmaps
++] = current_global_map
;
8036 /* Process maps in reverse order and look up in each map the prefix
8038 for (i
= nmaps
- 1; i
>= 0; --i
)
8039 if (!NILP (maps
[i
]))
8043 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8045 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8048 Vinhibit_quit
= oquit
;
8049 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8050 return tool_bar_items_vector
;
8054 /* Process the definition of KEY which is DEF. */
8057 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8060 struct gcpro gcpro1
, gcpro2
;
8062 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8066 if (EQ (def
, Qundefined
))
8068 /* If a map has an explicit `undefined' as definition,
8069 discard any previously made item. */
8070 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8072 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8074 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8076 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8077 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8078 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8080 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8085 else if (parse_tool_bar_item (key
, def
))
8086 /* Append a new tool bar item to tool_bar_items_vector. Accept
8087 more than one definition for the same key. */
8088 append_tool_bar_item ();
8093 /* Access slot with index IDX of vector tool_bar_item_properties. */
8094 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8096 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8098 ASET (tool_bar_item_properties
, idx
, val
);
8102 /* Parse a tool bar item specification ITEM for key KEY and return the
8103 result in tool_bar_item_properties. Value is zero if ITEM is
8106 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8108 CAPTION is the caption of the item, If it's not a string, it is
8109 evaluated to get a string.
8111 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8112 as binding are currently ignored.
8114 The following properties are recognized:
8118 FORM is evaluated and specifies whether the tool bar item is
8119 enabled or disabled.
8123 FORM is evaluated and specifies whether the tool bar item is visible.
8125 - `:filter FUNCTION'
8127 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8128 result is stored as the new binding.
8130 - `:button (TYPE SELECTED)'
8132 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8133 and specifies whether the button is selected (pressed) or not.
8137 IMAGES is either a single image specification or a vector of four
8138 image specifications. See enum tool_bar_item_images.
8140 - `:help HELP-STRING'.
8142 Gives a help string to display for the tool bar item.
8144 - `:label LABEL-STRING'.
8146 A text label to show with the tool bar button if labels are enabled. */
8149 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8151 Lisp_Object filter
= Qnil
;
8152 Lisp_Object caption
;
8153 int i
, have_label
= 0;
8155 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8156 Rule out items that aren't lists, don't start with
8157 `menu-item' or whose rest following `tool-bar-item' is not a
8162 /* As an exception, allow old-style menu separators. */
8163 if (STRINGP (XCAR (item
)))
8164 item
= Fcons (XCAR (item
), Qnil
);
8165 else if (!EQ (XCAR (item
), Qmenu_item
)
8166 || (item
= XCDR (item
), !CONSP (item
)))
8169 /* Create tool_bar_item_properties vector if necessary. Reset it to
8171 if (VECTORP (tool_bar_item_properties
))
8173 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8177 tool_bar_item_properties
8178 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8181 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8182 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8184 /* Get the caption of the item. If the caption is not a string,
8185 evaluate it to get a string. If we don't get a string, skip this
8187 caption
= XCAR (item
);
8188 if (!STRINGP (caption
))
8190 caption
= menu_item_eval_property (caption
);
8191 if (!STRINGP (caption
))
8194 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8196 /* If the rest following the caption is not a list, the menu item is
8197 either a separator, or invalid. */
8201 if (menu_separator_name_p (SSDATA (caption
)))
8203 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8204 #if !defined (USE_GTK) && !defined (HAVE_NS)
8205 /* If we use build_desired_tool_bar_string to render the
8206 tool bar, the separator is rendered as an image. */
8207 PROP (TOOL_BAR_ITEM_IMAGES
)
8208 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8209 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8210 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8211 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8218 /* Store the binding. */
8219 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8222 /* Ignore cached key binding, if any. */
8223 if (CONSP (item
) && CONSP (XCAR (item
)))
8226 /* Process the rest of the properties. */
8227 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8229 Lisp_Object ikey
, value
;
8232 value
= XCAR (XCDR (item
));
8234 if (EQ (ikey
, QCenable
))
8236 /* `:enable FORM'. */
8237 if (!NILP (Venable_disabled_menus_and_buttons
))
8238 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8240 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8242 else if (EQ (ikey
, QCvisible
))
8244 /* `:visible FORM'. If got a visible property and that
8245 evaluates to nil then ignore this item. */
8246 if (NILP (menu_item_eval_property (value
)))
8249 else if (EQ (ikey
, QChelp
))
8250 /* `:help HELP-STRING'. */
8251 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8252 else if (EQ (ikey
, QCvert_only
))
8253 /* `:vert-only t/nil'. */
8254 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8255 else if (EQ (ikey
, QClabel
))
8257 const char *bad_label
= "!!?GARBLED ITEM?!!";
8258 /* `:label LABEL-STRING'. */
8259 set_prop (TOOL_BAR_ITEM_LABEL
,
8260 STRINGP (value
) ? value
: build_string (bad_label
));
8263 else if (EQ (ikey
, QCfilter
))
8264 /* ':filter FORM'. */
8266 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8268 /* `:button (TYPE . SELECTED)'. */
8269 Lisp_Object type
, selected
;
8271 type
= XCAR (value
);
8272 selected
= XCDR (value
);
8273 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8275 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8276 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8279 else if (EQ (ikey
, QCimage
)
8281 || (VECTORP (value
) && ASIZE (value
) == 4)))
8282 /* Value is either a single image specification or a vector
8283 of 4 such specifications for the different button states. */
8284 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8285 else if (EQ (ikey
, QCrtl
))
8287 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8293 /* Try to make one from caption and key. */
8294 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8295 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8296 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8297 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8299 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8300 char *buf
= xmalloc (max_lbl
+ 1);
8301 Lisp_Object new_lbl
;
8302 ptrdiff_t caption_len
= strlen (capt
);
8304 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8307 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8309 buf
[caption_len
] = '\0';
8313 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8317 strcpy (buf
, label
);
8319 for (j
= 0; buf
[j
] != '\0'; ++j
)
8327 new_lbl
= Fupcase_initials (build_string (label
));
8328 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8329 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8331 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8335 /* If got a filter apply it on binding. */
8337 set_prop (TOOL_BAR_ITEM_BINDING
,
8338 (menu_item_eval_property
8341 PROP (TOOL_BAR_ITEM_BINDING
))))));
8343 /* See if the binding is a keymap. Give up if it is. */
8344 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8347 /* Enable or disable selection of item. */
8348 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8349 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8350 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8352 /* Handle radio buttons or toggle boxes. */
8353 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8354 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8355 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8363 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8364 that can be reused. */
8367 init_tool_bar_items (Lisp_Object reuse
)
8369 if (VECTORP (reuse
))
8370 tool_bar_items_vector
= reuse
;
8372 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8373 ntool_bar_items
= 0;
8377 /* Append parsed tool bar item properties from
8378 tool_bar_item_properties */
8381 append_tool_bar_item (void)
8385 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8387 /* Enlarge tool_bar_items_vector if necessary. */
8389 tool_bar_items_vector
8390 = larger_vector (tool_bar_items_vector
, incr
, -1);
8392 /* Append entries from tool_bar_item_properties to the end of
8393 tool_bar_items_vector. */
8394 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8395 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8396 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8403 /* Read a character using menus based on maps in the array MAPS.
8404 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8405 Return t if we displayed a menu but the user rejected it.
8407 PREV_EVENT is the previous input event, or nil if we are reading
8408 the first event of a key sequence.
8410 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8411 if we used a mouse menu to read the input, or zero otherwise. If
8412 USED_MOUSE_MENU is null, we don't dereference it.
8414 The prompting is done based on the prompt-string of the map
8415 and the strings associated with various map elements.
8417 This can be done with X menus or with menus put in the minibuf.
8418 These are done in different ways, depending on how the input will be read.
8419 Menus using X are done after auto-saving in read-char, getting the input
8420 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8421 and do auto-saving in the inner call of read_char. */
8424 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8425 Lisp_Object prev_event
, int *used_mouse_menu
)
8431 if (used_mouse_menu
)
8432 *used_mouse_menu
= 0;
8434 /* Use local over global Menu maps */
8436 if (! menu_prompting
)
8439 /* Optionally disregard all but the global map. */
8440 if (inhibit_local_menu_bar_menus
)
8442 maps
+= (nmaps
- 1);
8447 /* If we got to this point via a mouse click,
8448 use a real menu for mouse selection. */
8449 if (EVENT_HAS_PARAMETERS (prev_event
)
8450 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8451 && !EQ (XCAR (prev_event
), Qtool_bar
))
8453 /* Display the menu and get the selection. */
8454 Lisp_Object
*realmaps
= alloca (nmaps
* sizeof *realmaps
);
8456 ptrdiff_t nmaps1
= 0;
8458 /* Use the maps that are not nil. */
8459 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8460 if (!NILP (maps
[mapno
]))
8461 realmaps
[nmaps1
++] = maps
[mapno
];
8463 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8468 record_menu_key (XCAR (value
));
8470 /* If we got multiple events, unread all but
8472 There is no way to prevent those unread events
8473 from showing up later in last_nonmenu_event.
8474 So turn symbol and integer events into lists,
8475 to indicate that they came from a mouse menu,
8476 so that when present in last_nonmenu_event
8477 they won't confuse things. */
8478 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8480 record_menu_key (XCAR (tem
));
8481 if (SYMBOLP (XCAR (tem
))
8482 || INTEGERP (XCAR (tem
)))
8483 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8486 /* If we got more than one event, put all but the first
8487 onto this list to be read later.
8488 Return just the first event now. */
8489 Vunread_command_events
8490 = nconc2 (XCDR (value
), Vunread_command_events
);
8491 value
= XCAR (value
);
8493 else if (NILP (value
))
8495 if (used_mouse_menu
)
8496 *used_mouse_menu
= 1;
8499 #endif /* HAVE_MENUS */
8503 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8504 We make this bigger when necessary, and never free it. */
8505 static char *read_char_minibuf_menu_text
;
8506 /* Size of that buffer. */
8507 static ptrdiff_t read_char_minibuf_menu_width
;
8510 read_char_minibuf_menu_prompt (int commandflag
,
8511 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8514 register Lisp_Object name
;
8516 /* FIXME: Use the minibuffer's frame width. */
8517 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8520 Lisp_Object rest
, vector
;
8526 if (! menu_prompting
)
8529 /* Get the menu name from the first map that has one (a prompt string). */
8530 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8532 name
= Fkeymap_prompt (maps
[mapno
]);
8537 /* If we don't have any menus, just read a character normally. */
8538 if (!STRINGP (name
))
8541 /* Make sure we have a big enough buffer for the menu text. */
8542 width
= max (width
, SBYTES (name
));
8543 if (STRING_BYTES_BOUND
- 4 < width
)
8544 memory_full (SIZE_MAX
);
8545 if (width
+ 4 > read_char_minibuf_menu_width
)
8547 read_char_minibuf_menu_text
8548 = xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8549 read_char_minibuf_menu_width
= width
+ 4;
8551 menu
= read_char_minibuf_menu_text
;
8553 /* Prompt string always starts with map's prompt, and a space. */
8554 strcpy (menu
, SSDATA (name
));
8555 nlength
= SBYTES (name
);
8556 menu
[nlength
++] = ':';
8557 menu
[nlength
++] = ' ';
8560 /* Start prompting at start of first map. */
8564 /* Present the documented bindings, a line at a time. */
8568 ptrdiff_t i
= nlength
;
8570 Lisp_Object orig_defn_macro
;
8572 /* Loop over elements of map. */
8577 /* If reached end of map, start at beginning of next map. */
8581 /* At end of last map, wrap around to first map if just starting,
8582 or end this line if already have something on it. */
8586 if (notfirst
|| nobindings
) break;
8591 /* Look at the next element of the map. */
8593 elt
= AREF (vector
, idx
);
8595 elt
= Fcar_safe (rest
);
8597 if (idx
< 0 && VECTORP (elt
))
8599 /* If we found a dense table in the keymap,
8600 advanced past it, but start scanning its contents. */
8601 rest
= Fcdr_safe (rest
);
8607 /* An ordinary element. */
8608 Lisp_Object event
, tem
;
8612 event
= Fcar_safe (elt
); /* alist */
8613 elt
= Fcdr_safe (elt
);
8617 XSETINT (event
, idx
); /* vector */
8620 /* Ignore the element if it has no prompt string. */
8621 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8623 /* 1 if the char to type matches the string. */
8625 Lisp_Object upcased_event
, downcased_event
;
8626 Lisp_Object desc
= Qnil
;
8628 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8630 upcased_event
= Fupcase (event
);
8631 downcased_event
= Fdowncase (event
);
8632 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8633 || XINT (downcased_event
) == SREF (s
, 0));
8635 desc
= Fsingle_key_description (event
, Qnil
);
8637 #if 0 /* It is redundant to list the equivalent key bindings because
8638 the prefix is what the user has already typed. */
8640 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8642 /* Insert equivalent keybinding. */
8643 s
= concat2 (s
, tem
);
8646 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8647 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8649 /* Insert button prefix. */
8650 Lisp_Object selected
8651 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8652 if (EQ (tem
, QCradio
))
8653 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8655 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8656 s
= concat2 (tem
, s
);
8660 /* If we have room for the prompt string, add it to this line.
8661 If this is the first on the line, always add it. */
8662 if ((SCHARS (s
) + i
+ 2
8663 + (char_matches
? 0 : SCHARS (desc
) + 3))
8667 ptrdiff_t thiswidth
;
8669 /* Punctuate between strings. */
8672 strcpy (menu
+ i
, ", ");
8678 /* If the char to type doesn't match the string's
8679 first char, explicitly show what char to type. */
8682 /* Add as much of string as fits. */
8683 thiswidth
= min (SCHARS (desc
), width
- i
);
8684 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8686 strcpy (menu
+ i
, " = ");
8690 /* Add as much of string as fits. */
8691 thiswidth
= min (SCHARS (s
), width
- i
);
8692 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8698 /* If this element does not fit, end the line now,
8699 and save the element for the next line. */
8700 strcpy (menu
+ i
, "...");
8705 /* Move past this element. */
8706 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8707 /* Handle reaching end of dense table. */
8712 rest
= Fcdr_safe (rest
);
8716 /* Prompt with that and read response. */
8717 message2_nolog (menu
, strlen (menu
),
8718 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8720 /* Make believe its not a keyboard macro in case the help char
8721 is pressed. Help characters are not recorded because menu prompting
8722 is not used on replay.
8724 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8725 kset_defining_kbd_macro (current_kboard
, Qnil
);
8727 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8728 while (BUFFERP (obj
));
8729 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8731 if (!INTEGERP (obj
))
8733 else if (XINT (obj
) == -2)
8736 if (! EQ (obj
, menu_prompt_more_char
)
8737 && (!INTEGERP (menu_prompt_more_char
)
8738 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8740 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8741 store_kbd_macro_char (obj
);
8744 /* Help char - go round again */
8748 /* Reading key sequences. */
8750 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8751 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8752 keymap, or nil otherwise. Return the index of the first keymap in
8753 which KEY has any binding, or NMAPS if no map has a binding.
8755 If KEY is a meta ASCII character, treat it like meta-prefix-char
8756 followed by the corresponding non-meta character. Keymaps in
8757 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8760 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8763 NEXT may be the same array as CURRENT. */
8766 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8767 Lisp_Object
*defs
, Lisp_Object
*next
)
8769 ptrdiff_t i
, first_binding
;
8771 first_binding
= nmaps
;
8772 for (i
= nmaps
- 1; i
>= 0; i
--)
8774 if (! NILP (current
[i
]))
8776 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8777 if (! NILP (defs
[i
]))
8784 /* Given the set of bindings we've found, produce the next set of maps. */
8785 if (first_binding
< nmaps
)
8786 for (i
= 0; i
< nmaps
; i
++)
8787 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8789 return first_binding
;
8792 /* Structure used to keep track of partial application of key remapping
8793 such as Vfunction_key_map and Vkey_translation_map. */
8794 typedef struct keyremap
8796 /* This is the map originally specified for this use. */
8798 /* This is a submap reached by looking up, in PARENT,
8799 the events from START to END. */
8801 /* Positions [START, END) in the key sequence buffer
8802 are the key that we have scanned so far.
8803 Those events are the ones that we will replace
8804 if PARENT maps them into a key sequence. */
8808 /* Lookup KEY in MAP.
8809 MAP is a keymap mapping keys to key vectors or functions.
8810 If the mapping is a function and DO_FUNCTION is non-zero, then
8811 the function is called with PROMPT as parameter and its return
8812 value is used as the return value of this function (after checking
8813 that it is indeed a vector). */
8816 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8821 next
= access_keymap (map
, key
, 1, 0, 1);
8823 /* Handle a symbol whose function definition is a keymap
8825 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8826 && (ARRAYP (XSYMBOL (next
)->function
)
8827 || KEYMAPP (XSYMBOL (next
)->function
)))
8828 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8830 /* If the keymap gives a function, not an
8831 array, then call the function with one arg and use
8832 its value instead. */
8833 if (do_funcall
&& FUNCTIONP (next
))
8838 next
= call1 (next
, prompt
);
8839 /* If the function returned something invalid,
8840 barf--don't ignore it.
8841 (To ignore it safely, we would need to gcpro a bunch of
8842 other variables.) */
8843 if (! (VECTORP (next
) || STRINGP (next
)))
8844 error ("Function %s returns invalid key sequence",
8845 SSDATA (SYMBOL_NAME (tem
)));
8850 /* Do one step of the key remapping used for function-key-map and
8851 key-translation-map:
8852 KEYBUF is the buffer holding the input events.
8853 BUFSIZE is its maximum size.
8854 FKEY is a pointer to the keyremap structure to use.
8855 INPUT is the index of the last element in KEYBUF.
8856 DOIT if non-zero says that the remapping can actually take place.
8857 DIFF is used to return the number of keys added/removed by the remapping.
8858 PARENT is the root of the keymap.
8859 PROMPT is the prompt to use if the remapping happens through a function.
8860 The return value is non-zero if the remapping actually took place. */
8863 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8864 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8866 Lisp_Object next
, key
;
8868 key
= keybuf
[fkey
->end
++];
8870 if (KEYMAPP (fkey
->parent
))
8871 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8875 /* If keybuf[fkey->start..fkey->end] is bound in the
8876 map and we're in a position to do the key remapping, replace it with
8877 the binding and restart with fkey->start at the end. */
8878 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8880 int len
= XFASTINT (Flength (next
));
8883 *diff
= len
- (fkey
->end
- fkey
->start
);
8885 if (bufsize
- input
<= *diff
)
8886 error ("Key sequence too long");
8888 /* Shift the keys that follow fkey->end. */
8890 for (i
= fkey
->end
; i
< input
; i
++)
8891 keybuf
[i
+ *diff
] = keybuf
[i
];
8893 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8894 keybuf
[i
+ *diff
] = keybuf
[i
];
8895 /* Overwrite the old keys with the new ones. */
8896 for (i
= 0; i
< len
; i
++)
8897 keybuf
[fkey
->start
+ i
]
8898 = Faref (next
, make_number (i
));
8900 fkey
->start
= fkey
->end
+= *diff
;
8901 fkey
->map
= fkey
->parent
;
8906 fkey
->map
= get_keymap (next
, 0, 1);
8908 /* If we no longer have a bound suffix, try a new position for
8910 if (!CONSP (fkey
->map
))
8912 fkey
->end
= ++fkey
->start
;
8913 fkey
->map
= fkey
->parent
;
8919 test_undefined (Lisp_Object binding
)
8921 return (EQ (binding
, Qundefined
)
8922 || (!NILP (binding
) && SYMBOLP (binding
)
8923 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8926 /* Read a sequence of keys that ends with a non prefix character,
8927 storing it in KEYBUF, a buffer of size BUFSIZE.
8929 Return the length of the key sequence stored.
8930 Return -1 if the user rejected a command menu.
8932 Echo starting immediately unless `prompt' is 0.
8934 Where a key sequence ends depends on the currently active keymaps.
8935 These include any minor mode keymaps active in the current buffer,
8936 the current buffer's local map, and the global map.
8938 If a key sequence has no other bindings, we check Vfunction_key_map
8939 to see if some trailing subsequence might be the beginning of a
8940 function key's sequence. If so, we try to read the whole function
8941 key, and substitute its symbolic name into the key sequence.
8943 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8944 `double-' events into similar click events, if that would make them
8945 bound. We try to turn `triple-' events first into `double-' events,
8948 If we get a mouse click in a mode line, vertical divider, or other
8949 non-text area, we treat the click as if it were prefixed by the
8950 symbol denoting that area - `mode-line', `vertical-line', or
8953 If the sequence starts with a mouse click, we read the key sequence
8954 with respect to the buffer clicked on, not the current buffer.
8956 If the user switches frames in the midst of a key sequence, we put
8957 off the switch-frame event until later; the next call to
8958 read_char will return it.
8960 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8961 from the selected window's buffer. */
8964 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8965 int dont_downcase_last
, int can_return_switch_frame
,
8966 int fix_current_buffer
)
8968 Lisp_Object from_string
;
8969 ptrdiff_t count
= SPECPDL_INDEX ();
8971 /* How many keys there are in the current key sequence. */
8974 /* The length of the echo buffer when we started reading, and
8975 the length of this_command_keys when we started reading. */
8976 ptrdiff_t echo_start
IF_LINT (= 0);
8977 ptrdiff_t keys_start
;
8979 /* The number of keymaps we're scanning right now, and the number of
8980 keymaps we have allocated space for. */
8982 ptrdiff_t nmaps_allocated
= 0;
8984 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8985 the current keymaps. */
8986 Lisp_Object
*defs
= NULL
;
8988 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8989 in the current keymaps, or nil where it is not a prefix. */
8990 Lisp_Object
*submaps
= NULL
;
8992 /* The local map to start out with at start of key sequence. */
8993 Lisp_Object orig_local_map
;
8995 /* The map from the `keymap' property to start out with at start of
8997 Lisp_Object orig_keymap
;
8999 /* 1 if we have already considered switching to the local-map property
9000 of the place where a mouse click occurred. */
9001 int localized_local_map
= 0;
9003 /* The index in submaps[] of the first keymap that has a binding for
9004 this key sequence. In other words, the lowest i such that
9005 submaps[i] is non-nil. */
9006 ptrdiff_t first_binding
;
9007 /* Index of the first key that has no binding.
9008 It is useless to try fkey.start larger than that. */
9011 /* If t < mock_input, then KEYBUF[t] should be read as the next
9014 We use this to recover after recognizing a function key. Once we
9015 realize that a suffix of the current key sequence is actually a
9016 function key's escape sequence, we replace the suffix with the
9017 function key's binding from Vfunction_key_map. Now keybuf
9018 contains a new and different key sequence, so the echo area,
9019 this_command_keys, and the submaps and defs arrays are wrong. In
9020 this situation, we set mock_input to t, set t to 0, and jump to
9021 restart_sequence; the loop will read keys from keybuf up until
9022 mock_input, thus rebuilding the state; and then it will resume
9023 reading characters from the keyboard. */
9026 /* If the sequence is unbound in submaps[], then
9027 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9028 and fkey.map is its binding.
9030 These might be > t, indicating that all function key scanning
9031 should hold off until t reaches them. We do this when we've just
9032 recognized a function key, to avoid searching for the function
9033 key's again in Vfunction_key_map. */
9036 /* Likewise, for key_translation_map and input-decode-map. */
9037 keyremap keytran
, indec
;
9039 /* Non-zero if we are trying to map a key by changing an upper-case
9040 letter to lower case, or a shifted function key to an unshifted
9042 int shift_translated
= 0;
9044 /* If we receive a `switch-frame' or `select-window' event in the middle of
9045 a key sequence, we put it off for later.
9046 While we're reading, we keep the event here. */
9047 Lisp_Object delayed_switch_frame
;
9049 /* See the comment below... */
9050 #if defined (GOBBLE_FIRST_EVENT)
9051 Lisp_Object first_event
;
9054 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9055 int original_uppercase_position
= -1;
9057 /* Gets around Microsoft compiler limitations. */
9060 struct buffer
*starting_buffer
;
9062 /* List of events for which a fake prefix key has been generated. */
9063 Lisp_Object fake_prefixed_keys
= Qnil
;
9065 #if defined (GOBBLE_FIRST_EVENT)
9069 struct gcpro gcpro1
;
9071 GCPRO1 (fake_prefixed_keys
);
9072 raw_keybuf_count
= 0;
9074 last_nonmenu_event
= Qnil
;
9076 delayed_switch_frame
= Qnil
;
9082 /* Install the string STR as the beginning of the string of
9083 echoing, so that it serves as a prompt for the next
9085 kset_echo_string (current_kboard
, prompt
);
9086 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9089 else if (cursor_in_echo_area
9090 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9091 && NILP (Fzerop (Vecho_keystrokes
)))
9092 /* This doesn't put in a dash if the echo buffer is empty, so
9093 you don't always see a dash hanging out in the minibuffer. */
9097 /* Record the initial state of the echo area and this_command_keys;
9098 we will need to restore them if we replay a key sequence. */
9100 echo_start
= echo_length ();
9101 keys_start
= this_command_key_count
;
9102 this_single_command_key_start
= keys_start
;
9104 #if defined (GOBBLE_FIRST_EVENT)
9105 /* This doesn't quite work, because some of the things that read_char
9106 does cannot safely be bypassed. It seems too risky to try to make
9109 /* Read the first char of the sequence specially, before setting
9110 up any keymaps, in case a filter runs and switches buffers on us. */
9111 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9113 #endif /* GOBBLE_FIRST_EVENT */
9115 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9116 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9119 /* We jump here when we need to reinitialize fkey and keytran; this
9120 happens if we switch keyboards between rescans. */
9121 replay_entire_sequence
:
9123 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9124 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9125 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9126 indec
.start
= indec
.end
= 0;
9127 fkey
.start
= fkey
.end
= 0;
9128 keytran
.start
= keytran
.end
= 0;
9130 /* We jump here when the key sequence has been thoroughly changed, and
9131 we need to rescan it starting from the beginning. When we jump here,
9132 keybuf[0..mock_input] holds the sequence we should reread. */
9135 starting_buffer
= current_buffer
;
9136 first_unbound
= bufsize
+ 1;
9138 /* Build our list of keymaps.
9139 If we recognize a function key and replace its escape sequence in
9140 keybuf with its symbol, or if the sequence starts with a mouse
9141 click and we need to switch buffers, we jump back here to rebuild
9142 the initial keymaps from the current buffer. */
9145 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9147 if (2 > nmaps_allocated
)
9149 submaps
= alloca (2 * sizeof *submaps
);
9150 defs
= alloca (2 * sizeof *defs
);
9151 nmaps_allocated
= 2;
9153 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9155 else if (!NILP (Voverriding_local_map
))
9157 if (2 > nmaps_allocated
)
9159 submaps
= alloca (2 * sizeof *submaps
);
9160 defs
= alloca (2 * sizeof *defs
);
9161 nmaps_allocated
= 2;
9163 submaps
[nmaps
++] = Voverriding_local_map
;
9171 nminor
= current_minor_maps (0, &maps
);
9172 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9174 if (total
> nmaps_allocated
)
9176 submaps
= alloca (total
* sizeof *submaps
);
9177 defs
= alloca (total
* sizeof *defs
);
9178 nmaps_allocated
= total
;
9181 if (!NILP (orig_keymap
))
9182 submaps
[nmaps
++] = orig_keymap
;
9184 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9188 submaps
[nmaps
++] = orig_local_map
;
9190 submaps
[nmaps
++] = current_global_map
;
9192 /* Find an accurate initial value for first_binding. */
9193 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9194 if (! NILP (submaps
[first_binding
]))
9197 /* Start from the beginning in keybuf. */
9200 /* These are no-ops the first time through, but if we restart, they
9201 revert the echo area and this_command_keys to their original state. */
9202 this_command_key_count
= keys_start
;
9203 if (INTERACTIVE
&& t
< mock_input
)
9204 echo_truncate (echo_start
);
9206 /* If the best binding for the current key sequence is a keymap, or
9207 we may be looking at a function key's escape sequence, keep on
9209 while (first_binding
< nmaps
9210 /* Keep reading as long as there's a prefix binding. */
9211 ? !NILP (submaps
[first_binding
])
9212 /* Don't return in the middle of a possible function key sequence,
9213 if the only bindings we found were via case conversion.
9214 Thus, if ESC O a has a function-key-map translation
9215 and ESC o has a binding, don't return after ESC O,
9216 so that we can translate ESC O plus the next character. */
9217 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9220 int used_mouse_menu
= 0;
9222 /* Where the last real key started. If we need to throw away a
9223 key that has expanded into more than one element of keybuf
9224 (say, a mouse click on the mode line which is being treated
9225 as [mode-line (mouse-...)], then we backtrack to this point
9227 int last_real_key_start
;
9229 /* These variables are analogous to echo_start and keys_start;
9230 while those allow us to restart the entire key sequence,
9231 echo_local_start and keys_local_start allow us to throw away
9233 ptrdiff_t echo_local_start
IF_LINT (= 0);
9234 int keys_local_start
;
9235 ptrdiff_t local_first_binding
;
9237 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9238 eassert (indec
.start
<= indec
.end
);
9239 eassert (fkey
.start
<= fkey
.end
);
9240 eassert (keytran
.start
<= keytran
.end
);
9241 /* key-translation-map is applied *after* function-key-map
9242 which is itself applied *after* input-decode-map. */
9243 eassert (fkey
.end
<= indec
.start
);
9244 eassert (keytran
.end
<= fkey
.start
);
9246 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9247 first_unbound
< keytran
.start
)
9248 { /* The prefix upto first_unbound has no binding and has
9249 no translation left to do either, so we know it's unbound.
9250 If we don't stop now, we risk staying here indefinitely
9251 (if the user keeps entering fkey or keytran prefixes
9252 like C-c ESC ESC ESC ESC ...) */
9254 for (i
= first_unbound
+ 1; i
< t
; i
++)
9255 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9256 mock_input
= t
- first_unbound
- 1;
9257 indec
.end
= indec
.start
-= first_unbound
+ 1;
9258 indec
.map
= indec
.parent
;
9259 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9260 fkey
.map
= fkey
.parent
;
9261 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9262 keytran
.map
= keytran
.parent
;
9263 goto replay_sequence
;
9267 error ("Key sequence too long");
9270 echo_local_start
= echo_length ();
9271 keys_local_start
= this_command_key_count
;
9272 local_first_binding
= first_binding
;
9275 /* These are no-ops, unless we throw away a keystroke below and
9276 jumped back up to replay_key; in that case, these restore the
9277 variables to their original state, allowing us to replay the
9279 if (INTERACTIVE
&& t
< mock_input
)
9280 echo_truncate (echo_local_start
);
9281 this_command_key_count
= keys_local_start
;
9282 first_binding
= local_first_binding
;
9284 /* By default, assume each event is "real". */
9285 last_real_key_start
= t
;
9287 /* Does mock_input indicate that we are re-reading a key sequence? */
9291 add_command_key (key
);
9292 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9293 && NILP (Fzerop (Vecho_keystrokes
)))
9297 /* If not, we should actually read a character. */
9301 KBOARD
*interrupted_kboard
= current_kboard
;
9302 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9303 key
= read_char (NILP (prompt
), nmaps
,
9304 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9305 &used_mouse_menu
, NULL
);
9306 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9307 /* When switching to a new tty (with a new keyboard),
9308 read_char returns the new buffer, rather than -2
9309 (Bug#5095). This is because `terminal-init-xterm'
9310 calls read-char, which eats the wrong_kboard_jmpbuf
9311 return. Any better way to fix this? -- cyd */
9312 || (interrupted_kboard
!= current_kboard
))
9317 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9318 if (k
== interrupted_kboard
)
9323 /* Don't touch interrupted_kboard when it's been
9325 delayed_switch_frame
= Qnil
;
9326 goto replay_entire_sequence
;
9329 if (!NILP (delayed_switch_frame
))
9332 (interrupted_kboard
,
9333 Fcons (delayed_switch_frame
,
9334 KVAR (interrupted_kboard
, kbd_queue
)));
9335 delayed_switch_frame
= Qnil
;
9340 (interrupted_kboard
,
9341 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9343 /* If the side queue is non-empty, ensure it begins with a
9344 switch-frame, so we'll replay it in the right context. */
9345 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9346 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9347 !(EVENT_HAS_PARAMETERS (key
)
9348 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9352 XSETFRAME (frame
, interrupted_frame
);
9354 (interrupted_kboard
,
9355 Fcons (make_lispy_switch_frame (frame
),
9356 KVAR (interrupted_kboard
, kbd_queue
)));
9359 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9360 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9361 goto replay_entire_sequence
;
9365 /* read_char returns t when it shows a menu and the user rejects it.
9369 unbind_to (count
, Qnil
);
9374 /* read_char returns -1 at the end of a macro.
9375 Emacs 18 handles this by returning immediately with a
9376 zero, so that's what we'll do. */
9377 if (INTEGERP (key
) && XINT (key
) == -1)
9380 /* The Microsoft C compiler can't handle the goto that
9386 /* If the current buffer has been changed from under us, the
9387 keymap may have changed, so replay the sequence. */
9390 timer_resume_idle ();
9393 /* Reset the current buffer from the selected window
9394 in case something changed the former and not the latter.
9395 This is to be more consistent with the behavior
9396 of the command_loop_1. */
9397 if (fix_current_buffer
)
9399 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9401 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9402 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9405 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9406 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9407 goto replay_sequence
;
9410 /* If we have a quit that was typed in another frame, and
9411 quit_throw_to_read_char switched buffers,
9412 replay to get the right keymap. */
9414 && XINT (key
) == quit_char
9415 && current_buffer
!= starting_buffer
)
9418 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9423 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9424 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9425 goto replay_sequence
;
9430 if (EVENT_HAS_PARAMETERS (key
)
9431 /* Either a `switch-frame' or a `select-window' event. */
9432 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9434 /* If we're at the beginning of a key sequence, and the caller
9435 says it's okay, go ahead and return this event. If we're
9436 in the midst of a key sequence, delay it until the end. */
9437 if (t
> 0 || !can_return_switch_frame
)
9439 delayed_switch_frame
= key
;
9445 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9449 /* Clicks in non-text areas get prefixed by the symbol
9450 in their CHAR-ADDRESS field. For example, a click on
9451 the mode line is prefixed by the symbol `mode-line'.
9453 Furthermore, key sequences beginning with mouse clicks
9454 are read using the keymaps of the buffer clicked on, not
9455 the current buffer. So we may have to switch the buffer
9458 When we turn one event into two events, we must make sure
9459 that neither of the two looks like the original--so that,
9460 if we replay the events, they won't be expanded again.
9461 If not for this, such reexpansion could happen either here
9462 or when user programs play with this-command-keys. */
9463 if (EVENT_HAS_PARAMETERS (key
))
9468 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9469 if (EQ (kind
, Qmouse_click
))
9471 Lisp_Object window
, posn
;
9473 window
= POSN_WINDOW (EVENT_START (key
));
9474 posn
= POSN_POSN (EVENT_START (key
));
9477 || (!NILP (fake_prefixed_keys
)
9478 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9480 /* We're looking a second time at an event for which
9481 we generated a fake prefix key. Set
9482 last_real_key_start appropriately. */
9484 last_real_key_start
= t
- 1;
9487 if (last_real_key_start
== 0)
9489 /* Key sequences beginning with mouse clicks are
9490 read using the keymaps in the buffer clicked on,
9491 not the current buffer. If we're at the
9492 beginning of a key sequence, switch buffers. */
9493 if (WINDOWP (window
)
9494 && BUFFERP (XWINDOW (window
)->buffer
)
9495 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9497 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9502 /* Arrange to go back to the original buffer once we're
9503 done reading the key sequence. Note that we can't
9504 use save_excursion_{save,restore} here, because they
9505 save point as well as the current buffer; we don't
9506 want to save point, because redisplay may change it,
9507 to accommodate a Fset_window_start or something. We
9508 don't want to do this at the top of the function,
9509 because we may get input from a subprocess which
9510 wants to change the selected window and stuff (say,
9512 record_unwind_current_buffer ();
9514 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9516 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9517 orig_local_map
= get_local_map (PT
, current_buffer
,
9519 orig_keymap
= get_local_map (PT
, current_buffer
,
9521 goto replay_sequence
;
9524 /* For a mouse click, get the local text-property keymap
9525 of the place clicked on, rather than point. */
9526 if (CONSP (XCDR (key
))
9527 && ! localized_local_map
)
9529 Lisp_Object map_here
, start
, pos
;
9531 localized_local_map
= 1;
9532 start
= EVENT_START (key
);
9534 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9536 pos
= POSN_BUFFER_POSN (start
);
9538 && XINT (pos
) >= BEGV
9539 && XINT (pos
) <= ZV
)
9541 map_here
= get_local_map (XINT (pos
),
9544 if (!EQ (map_here
, orig_local_map
))
9546 orig_local_map
= map_here
;
9547 ++localized_local_map
;
9550 map_here
= get_local_map (XINT (pos
),
9553 if (!EQ (map_here
, orig_keymap
))
9555 orig_keymap
= map_here
;
9556 ++localized_local_map
;
9559 if (localized_local_map
> 1)
9564 goto replay_sequence
;
9571 /* Expand mode-line and scroll-bar events into two events:
9572 use posn as a fake prefix key. */
9574 && (NILP (fake_prefixed_keys
)
9575 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9577 if (bufsize
- t
<= 1)
9578 error ("Key sequence too long");
9581 keybuf
[t
+ 1] = key
;
9584 /* Record that a fake prefix key has been generated
9585 for KEY. Don't modify the event; this would
9586 prevent proper action when the event is pushed
9587 back into unread-command-events. */
9588 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9590 /* If on a mode line string with a local keymap,
9591 reconsider the key sequence with that keymap. */
9592 if (string
= POSN_STRING (EVENT_START (key
)),
9593 (CONSP (string
) && STRINGP (XCAR (string
))))
9595 Lisp_Object pos
, map
, map2
;
9597 pos
= XCDR (string
);
9598 string
= XCAR (string
);
9600 && XINT (pos
) < SCHARS (string
))
9602 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9604 orig_local_map
= map
;
9605 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9608 if (!NILP (map
) || !NILP (map2
))
9609 goto replay_sequence
;
9615 else if (NILP (from_string
)
9616 && (string
= POSN_STRING (EVENT_START (key
)),
9617 (CONSP (string
) && STRINGP (XCAR (string
)))))
9619 /* For a click on a string, i.e. overlay string or a
9620 string displayed via the `display' property,
9621 consider `local-map' and `keymap' properties of
9623 Lisp_Object pos
, map
, map2
;
9625 pos
= XCDR (string
);
9626 string
= XCAR (string
);
9628 && XINT (pos
) < SCHARS (string
))
9630 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9632 orig_local_map
= map
;
9633 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9637 if (!NILP (map
) || !NILP (map2
))
9639 from_string
= string
;
9642 goto replay_sequence
;
9647 else if (CONSP (XCDR (key
))
9648 && CONSP (EVENT_START (key
))
9649 && CONSP (XCDR (EVENT_START (key
))))
9653 posn
= POSN_POSN (EVENT_START (key
));
9654 /* Handle menu-bar events:
9655 insert the dummy prefix event `menu-bar'. */
9656 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9658 if (bufsize
- t
<= 1)
9659 error ("Key sequence too long");
9663 /* Zap the position in key, so we know that we've
9664 expanded it, and don't try to do so again. */
9665 POSN_SET_POSN (EVENT_START (key
),
9666 Fcons (posn
, Qnil
));
9669 goto replay_sequence
;
9671 else if (CONSP (posn
))
9673 /* We're looking at the second event of a
9674 sequence which we expanded before. Set
9675 last_real_key_start appropriately. */
9676 if (last_real_key_start
== t
&& t
> 0)
9677 last_real_key_start
= t
- 1;
9682 /* We have finally decided that KEY is something we might want
9684 first_binding
= (follow_key (key
,
9685 nmaps
- first_binding
,
9686 submaps
+ first_binding
,
9687 defs
+ first_binding
,
9688 submaps
+ first_binding
)
9691 /* If KEY wasn't bound, we'll try some fallbacks. */
9692 if (first_binding
< nmaps
)
9693 /* This is needed for the following scenario:
9694 event 0: a down-event that gets dropped by calling replay_key.
9695 event 1: some normal prefix like C-h.
9696 After event 0, first_unbound is 0, after event 1 indec.start,
9697 fkey.start, and keytran.start are all 1, so when we see that
9698 C-h is bound, we need to update first_unbound. */
9699 first_unbound
= max (t
+ 1, first_unbound
);
9704 /* Remember the position to put an upper bound on indec.start. */
9705 first_unbound
= min (t
, first_unbound
);
9707 head
= EVENT_HEAD (key
);
9708 if (help_char_p (head
) && t
> 0)
9710 read_key_sequence_cmd
= Vprefix_help_command
;
9712 last_nonmenu_event
= key
;
9713 /* The Microsoft C compiler can't handle the goto that
9721 Lisp_Object breakdown
;
9724 breakdown
= parse_modifiers (head
);
9725 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9726 /* Attempt to reduce an unbound mouse event to a simpler
9727 event that is bound:
9728 Drags reduce to clicks.
9729 Double-clicks reduce to clicks.
9730 Triple-clicks reduce to double-clicks, then to clicks.
9731 Down-clicks are eliminated.
9732 Double-downs reduce to downs, then are eliminated.
9733 Triple-downs reduce to double-downs, then to downs,
9734 then are eliminated. */
9735 if (modifiers
& (down_modifier
| drag_modifier
9736 | double_modifier
| triple_modifier
))
9738 while (modifiers
& (down_modifier
| drag_modifier
9739 | double_modifier
| triple_modifier
))
9741 Lisp_Object new_head
, new_click
;
9742 if (modifiers
& triple_modifier
)
9743 modifiers
^= (double_modifier
| triple_modifier
);
9744 else if (modifiers
& double_modifier
)
9745 modifiers
&= ~double_modifier
;
9746 else if (modifiers
& drag_modifier
)
9747 modifiers
&= ~drag_modifier
;
9750 /* Dispose of this `down' event by simply jumping
9751 back to replay_key, to get another event.
9753 Note that if this event came from mock input,
9754 then just jumping back to replay_key will just
9755 hand it to us again. So we have to wipe out any
9758 We could delete keybuf[t] and shift everything
9759 after that to the left by one spot, but we'd also
9760 have to fix up any variable that points into
9761 keybuf, and shifting isn't really necessary
9764 Adding prefixes for non-textual mouse clicks
9765 creates two characters of mock input, and both
9766 must be thrown away. If we're only looking at
9767 the prefix now, we can just jump back to
9768 replay_key. On the other hand, if we've already
9769 processed the prefix, and now the actual click
9770 itself is giving us trouble, then we've lost the
9771 state of the keymaps we want to backtrack to, and
9772 we need to replay the whole sequence to rebuild
9775 Beyond that, only function key expansion could
9776 create more than two keys, but that should never
9777 generate mouse events, so it's okay to zero
9778 mock_input in that case too.
9780 FIXME: The above paragraph seems just plain
9781 wrong, if you consider things like
9782 xterm-mouse-mode. -stef
9784 Isn't this just the most wonderful code ever? */
9786 /* If mock_input > t + 1, the above simplification
9787 will actually end up dropping keys on the floor.
9788 This is probably OK for now, but even
9789 if mock_input <= t + 1, we need to adjust indec,
9791 Typical case [header-line down-mouse-N]:
9792 mock_input = 2, t = 1, fkey.end = 1,
9793 last_real_key_start = 0. */
9794 if (indec
.end
> last_real_key_start
)
9796 indec
.end
= indec
.start
9797 = min (last_real_key_start
, indec
.start
);
9798 indec
.map
= indec
.parent
;
9799 if (fkey
.end
> last_real_key_start
)
9801 fkey
.end
= fkey
.start
9802 = min (last_real_key_start
, fkey
.start
);
9803 fkey
.map
= fkey
.parent
;
9804 if (keytran
.end
> last_real_key_start
)
9806 keytran
.end
= keytran
.start
9807 = min (last_real_key_start
, keytran
.start
);
9808 keytran
.map
= keytran
.parent
;
9812 if (t
== last_real_key_start
)
9819 mock_input
= last_real_key_start
;
9820 goto replay_sequence
;
9825 = apply_modifiers (modifiers
, XCAR (breakdown
));
9827 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9829 /* Look for a binding for this new key. follow_key
9830 promises that it didn't munge submaps the
9831 last time we called it, since key was unbound. */
9833 = (follow_key (new_click
,
9834 nmaps
- local_first_binding
,
9835 submaps
+ local_first_binding
,
9836 defs
+ local_first_binding
,
9837 submaps
+ local_first_binding
)
9838 + local_first_binding
);
9840 /* If that click is bound, go for it. */
9841 if (first_binding
< nmaps
)
9846 /* Otherwise, we'll leave key set to the drag event. */
9853 /* Normally, last_nonmenu_event gets the previous key we read.
9854 But when a mouse popup menu is being used,
9855 we don't update last_nonmenu_event; it continues to hold the mouse
9856 event that preceded the first level of menu. */
9857 if (!used_mouse_menu
)
9858 last_nonmenu_event
= key
;
9860 /* Record what part of this_command_keys is the current key sequence. */
9861 this_single_command_key_start
= this_command_key_count
- t
;
9863 /* Look for this sequence in input-decode-map.
9864 Scan from indec.end until we find a bound suffix. */
9865 while (indec
.end
< t
)
9867 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9870 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9871 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9876 mock_input
= diff
+ max (t
, mock_input
);
9877 goto replay_sequence
;
9881 if (first_binding
< nmaps
9882 && NILP (submaps
[first_binding
])
9883 && !test_undefined (defs
[first_binding
])
9884 && indec
.start
>= t
)
9885 /* There is a binding and it's not a prefix.
9886 (and it doesn't have any input-decode-map translation pending).
9887 There is thus no function-key in this sequence.
9888 Moving fkey.start is important in this case to allow keytran.start
9889 to go over the sequence before we return (since we keep the
9890 invariant that keytran.end <= fkey.start). */
9893 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9896 /* If the sequence is unbound, see if we can hang a function key
9897 off the end of it. */
9898 /* Continue scan from fkey.end until we find a bound suffix. */
9899 while (fkey
.end
< indec
.start
)
9901 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9904 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9905 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9906 max (t
, mock_input
),
9907 /* If there's a binding (i.e.
9908 first_binding >= nmaps) we don't want
9909 to apply this function-key-mapping. */
9911 && (first_binding
>= nmaps
9912 || test_undefined (defs
[first_binding
])),
9917 mock_input
= diff
+ max (t
, mock_input
);
9918 /* Adjust the input-decode-map counters. */
9920 indec
.start
+= diff
;
9922 goto replay_sequence
;
9926 /* Look for this sequence in key-translation-map.
9927 Scan from keytran.end until we find a bound suffix. */
9928 while (keytran
.end
< fkey
.start
)
9930 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9933 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9934 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9939 mock_input
= diff
+ max (t
, mock_input
);
9940 /* Adjust the function-key-map and input-decode-map counters. */
9942 indec
.start
+= diff
;
9946 goto replay_sequence
;
9950 /* If KEY is not defined in any of the keymaps,
9951 and cannot be part of a function key or translation,
9952 and is an upper case letter
9953 use the corresponding lower-case letter instead. */
9954 if (first_binding
>= nmaps
9955 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9957 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9958 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9959 || (XINT (key
) & shift_modifier
)))
9961 Lisp_Object new_key
;
9963 original_uppercase
= key
;
9964 original_uppercase_position
= t
- 1;
9966 if (XINT (key
) & shift_modifier
)
9967 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9969 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9970 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9972 /* We have to do this unconditionally, regardless of whether
9973 the lower-case char is defined in the keymaps, because they
9974 might get translated through function-key-map. */
9975 keybuf
[t
- 1] = new_key
;
9976 mock_input
= max (t
, mock_input
);
9977 shift_translated
= 1;
9979 goto replay_sequence
;
9981 /* If KEY is not defined in any of the keymaps,
9982 and cannot be part of a function key or translation,
9983 and is a shifted function key,
9984 use the corresponding unshifted function key instead. */
9985 if (first_binding
>= nmaps
9986 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9988 Lisp_Object breakdown
= parse_modifiers (key
);
9990 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9992 if (modifiers
& shift_modifier
9993 /* Treat uppercase keys as shifted. */
9995 && (KEY_TO_CHAR (key
)
9996 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9997 && uppercasep (KEY_TO_CHAR (key
))))
10000 = (modifiers
& shift_modifier
10001 ? apply_modifiers (modifiers
& ~shift_modifier
,
10003 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
10005 original_uppercase
= key
;
10006 original_uppercase_position
= t
- 1;
10008 /* We have to do this unconditionally, regardless of whether
10009 the lower-case char is defined in the keymaps, because they
10010 might get translated through function-key-map. */
10011 keybuf
[t
- 1] = new_key
;
10012 mock_input
= max (t
, mock_input
);
10013 /* Reset fkey (and consequently keytran) to apply
10014 function-key-map on the result, so that S-backspace is
10015 correctly mapped to DEL (via backspace). OTOH,
10016 input-decode-map doesn't need to go through it again. */
10017 fkey
.start
= fkey
.end
= 0;
10018 keytran
.start
= keytran
.end
= 0;
10019 shift_translated
= 1;
10021 goto replay_sequence
;
10026 read_key_sequence_cmd
= (first_binding
< nmaps
10027 ? defs
[first_binding
]
10029 read_key_sequence_remapped
10030 /* Remap command through active keymaps.
10031 Do the remapping here, before the unbind_to so it uses the keymaps
10032 of the appropriate buffer. */
10033 = SYMBOLP (read_key_sequence_cmd
)
10034 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
10037 unread_switch_frame
= delayed_switch_frame
;
10038 unbind_to (count
, Qnil
);
10040 /* Don't downcase the last character if the caller says don't.
10041 Don't downcase it if the result is undefined, either. */
10042 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10044 && t
- 1 == original_uppercase_position
)
10046 keybuf
[t
- 1] = original_uppercase
;
10047 shift_translated
= 0;
10050 if (shift_translated
)
10051 Vthis_command_keys_shift_translated
= Qt
;
10053 /* Occasionally we fabricate events, perhaps by expanding something
10054 according to function-key-map, or by adding a prefix symbol to a
10055 mouse click in the scroll bar or modeline. In this cases, return
10056 the entire generated key sequence, even if we hit an unbound
10057 prefix or a definition before the end. This means that you will
10058 be able to push back the event properly, and also means that
10059 read-key-sequence will always return a logical unit.
10062 for (; t
< mock_input
; t
++)
10064 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10065 && NILP (Fzerop (Vecho_keystrokes
)))
10066 echo_char (keybuf
[t
]);
10067 add_command_key (keybuf
[t
]);
10074 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10075 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10076 The sequence is sufficient to specify a non-prefix command in the
10077 current local and global maps.
10079 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10080 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10081 as a continuation of the previous key.
10083 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10084 convert the last event to lower case. (Normally any upper case event
10085 is converted to lower case if the original event is undefined and the lower
10086 case equivalent is defined.) A non-nil value is appropriate for reading
10087 a key sequence to be defined.
10089 A C-g typed while in this function is treated like any other character,
10090 and `quit-flag' is not set.
10092 If the key sequence starts with a mouse click, then the sequence is read
10093 using the keymaps of the buffer of the window clicked in, not the buffer
10094 of the selected window as normal.
10096 `read-key-sequence' drops unbound button-down events, since you normally
10097 only care about the click or drag events which follow them. If a drag
10098 or multi-click event is unbound, but the corresponding click event would
10099 be bound, `read-key-sequence' turns the event into a click event at the
10100 drag's starting position. This means that you don't have to distinguish
10101 between click and drag, double, or triple events unless you want to.
10103 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10104 lines separating windows, and scroll bars with imaginary keys
10105 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10107 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10108 function will process a switch-frame event if the user switches frames
10109 before typing anything. If the user switches frames in the middle of a
10110 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10111 is nil, then the event will be put off until after the current key sequence.
10113 `read-key-sequence' checks `function-key-map' for function key
10114 sequences, where they wouldn't conflict with ordinary bindings. See
10115 `function-key-map' for more details.
10117 The optional fifth argument CMD-LOOP, if non-nil, means
10118 that this key sequence is being read by something that will
10119 read commands one after another. It should be nil if the caller
10120 will read just one key sequence. */)
10121 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10123 Lisp_Object keybuf
[30];
10125 struct gcpro gcpro1
;
10126 ptrdiff_t count
= SPECPDL_INDEX ();
10128 if (!NILP (prompt
))
10129 CHECK_STRING (prompt
);
10132 specbind (Qinput_method_exit_on_first_char
,
10133 (NILP (cmd_loop
) ? Qt
: Qnil
));
10134 specbind (Qinput_method_use_echo_area
,
10135 (NILP (cmd_loop
) ? Qt
: Qnil
));
10137 memset (keybuf
, 0, sizeof keybuf
);
10138 GCPRO1 (keybuf
[0]);
10139 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10141 if (NILP (continue_echo
))
10143 this_command_key_count
= 0;
10144 this_command_key_count_reset
= 0;
10145 this_single_command_key_start
= 0;
10148 #ifdef HAVE_WINDOW_SYSTEM
10149 if (display_hourglass_p
)
10150 cancel_hourglass ();
10153 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10154 prompt
, ! NILP (dont_downcase_last
),
10155 ! NILP (can_return_switch_frame
), 0);
10157 #if 0 /* The following is fine for code reading a key sequence and
10158 then proceeding with a lengthy computation, but it's not good
10159 for code reading keys in a loop, like an input method. */
10160 #ifdef HAVE_WINDOW_SYSTEM
10161 if (display_hourglass_p
)
10162 start_hourglass ();
10172 return unbind_to (count
, make_event_array (i
, keybuf
));
10175 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10176 Sread_key_sequence_vector
, 1, 5, 0,
10177 doc
: /* Like `read-key-sequence' but always return a vector. */)
10178 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10180 Lisp_Object keybuf
[30];
10182 struct gcpro gcpro1
;
10183 ptrdiff_t count
= SPECPDL_INDEX ();
10185 if (!NILP (prompt
))
10186 CHECK_STRING (prompt
);
10189 specbind (Qinput_method_exit_on_first_char
,
10190 (NILP (cmd_loop
) ? Qt
: Qnil
));
10191 specbind (Qinput_method_use_echo_area
,
10192 (NILP (cmd_loop
) ? Qt
: Qnil
));
10194 memset (keybuf
, 0, sizeof keybuf
);
10195 GCPRO1 (keybuf
[0]);
10196 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10198 if (NILP (continue_echo
))
10200 this_command_key_count
= 0;
10201 this_command_key_count_reset
= 0;
10202 this_single_command_key_start
= 0;
10205 #ifdef HAVE_WINDOW_SYSTEM
10206 if (display_hourglass_p
)
10207 cancel_hourglass ();
10210 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10211 prompt
, ! NILP (dont_downcase_last
),
10212 ! NILP (can_return_switch_frame
), 0);
10214 #ifdef HAVE_WINDOW_SYSTEM
10215 if (display_hourglass_p
)
10216 start_hourglass ();
10225 return unbind_to (count
, Fvector (i
, keybuf
));
10228 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10229 doc
: /* Execute CMD as an editor command.
10230 CMD must be a symbol that satisfies the `commandp' predicate.
10231 Optional second arg RECORD-FLAG non-nil
10232 means unconditionally put this command in `command-history'.
10233 Otherwise, that is done only if an arg is read using the minibuffer.
10234 The argument KEYS specifies the value to use instead of (this-command-keys)
10235 when reading the arguments; if it is nil, (this-command-keys) is used.
10236 The argument SPECIAL, if non-nil, means that this command is executing
10237 a special event, so ignore the prefix argument and don't clear it. */)
10238 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10240 register Lisp_Object final
;
10241 register Lisp_Object tem
;
10242 Lisp_Object prefixarg
;
10244 debug_on_next_call
= 0;
10246 if (NILP (special
))
10248 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10249 Vcurrent_prefix_arg
= prefixarg
;
10250 kset_prefix_arg (current_kboard
, Qnil
);
10257 tem
= Fget (cmd
, Qdisabled
);
10260 tem
= Fsymbol_value (Qdisabled_command_function
);
10262 return Frun_hooks (1, &Qdisabled_command_function
);
10268 final
= Findirect_function (cmd
, Qnil
);
10270 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10272 struct gcpro gcpro1
, gcpro2
;
10274 GCPRO2 (cmd
, prefixarg
);
10275 Fautoload_do_load (final
, cmd
, Qnil
);
10282 if (STRINGP (final
) || VECTORP (final
))
10284 /* If requested, place the macro in the command history. For
10285 other sorts of commands, call-interactively takes care of
10287 if (!NILP (record_flag
))
10290 = Fcons (Fcons (Qexecute_kbd_macro
,
10291 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10294 /* Don't keep command history around forever. */
10295 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10297 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10299 XSETCDR (tem
, Qnil
);
10303 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10306 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10307 /* Don't call Fcall_interactively directly because we want to make
10308 sure the backtrace has an entry for `call-interactively'.
10309 For the same reason, pass `cmd' rather than `final'. */
10310 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10317 /* Return nonzero if input events are pending. */
10320 detect_input_pending (void)
10322 if (!input_pending
)
10323 get_input_pending (&input_pending
, 0);
10325 return input_pending
;
10328 /* Return nonzero if input events other than mouse movements are
10332 detect_input_pending_ignore_squeezables (void)
10334 if (!input_pending
)
10335 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10337 return input_pending
;
10340 /* Return nonzero if input events are pending, and run any pending timers. */
10343 detect_input_pending_run_timers (int do_display
)
10345 int old_timers_run
= timers_run
;
10347 if (!input_pending
)
10348 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10350 if (old_timers_run
!= timers_run
&& do_display
)
10352 redisplay_preserve_echo_area (8);
10353 /* The following fixes a bug when using lazy-lock with
10354 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10355 from an idle timer function. The symptom of the bug is that
10356 the cursor sometimes doesn't become visible until the next X
10357 event is processed. --gerd. */
10359 Lisp_Object tail
, frame
;
10360 FOR_EACH_FRAME (tail
, frame
)
10361 if (FRAME_RIF (XFRAME (frame
)))
10362 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10366 return input_pending
;
10369 /* This is called in some cases before a possible quit.
10370 It cases the next call to detect_input_pending to recompute input_pending.
10371 So calling this function unnecessarily can't do any harm. */
10374 clear_input_pending (void)
10379 /* Return nonzero if there are pending requeued events.
10380 This isn't used yet. The hope is to make wait_reading_process_output
10381 call it, and return if it runs Lisp code that unreads something.
10382 The problem is, kbd_buffer_get_event needs to be fixed to know what
10383 to do in that case. It isn't trivial. */
10386 requeued_events_pending_p (void)
10388 return (!NILP (Vunread_command_events
));
10392 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10393 doc
: /* Return t if command input is currently available with no wait.
10394 Actually, the value is nil only if we can be sure that no input is available;
10395 if there is a doubt, the value is t. */)
10398 if (!NILP (Vunread_command_events
)
10399 || !NILP (Vunread_post_input_method_events
)
10400 || !NILP (Vunread_input_method_events
))
10403 /* Process non-user-visible events (Bug#10195). */
10404 process_special_events ();
10406 get_input_pending (&input_pending
,
10407 READABLE_EVENTS_DO_TIMERS_NOW
10408 | READABLE_EVENTS_FILTER_EVENTS
);
10409 return input_pending
> 0 ? Qt
: Qnil
;
10412 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10413 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10416 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10419 if (total_keys
< NUM_RECENT_KEYS
)
10420 return Fvector (total_keys
, keys
);
10423 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10424 vcopy (val
, 0, keys
+ recent_keys_index
,
10425 NUM_RECENT_KEYS
- recent_keys_index
);
10426 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10427 keys
, recent_keys_index
);
10432 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10433 doc
: /* Return the key sequence that invoked this command.
10434 However, if the command has called `read-key-sequence', it returns
10435 the last key sequence that has been read.
10436 The value is a string or a vector.
10438 See also `this-command-keys-vector'. */)
10441 return make_event_array (this_command_key_count
,
10442 XVECTOR (this_command_keys
)->contents
);
10445 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10446 doc
: /* Return the key sequence that invoked this command, as a vector.
10447 However, if the command has called `read-key-sequence', it returns
10448 the last key sequence that has been read.
10450 See also `this-command-keys'. */)
10453 return Fvector (this_command_key_count
,
10454 XVECTOR (this_command_keys
)->contents
);
10457 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10458 Sthis_single_command_keys
, 0, 0, 0,
10459 doc
: /* Return the key sequence that invoked this command.
10460 More generally, it returns the last key sequence read, either by
10461 the command loop or by `read-key-sequence'.
10462 Unlike `this-command-keys', this function's value
10463 does not include prefix arguments.
10464 The value is always a vector. */)
10467 return Fvector (this_command_key_count
10468 - this_single_command_key_start
,
10469 (XVECTOR (this_command_keys
)->contents
10470 + this_single_command_key_start
));
10473 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10474 Sthis_single_command_raw_keys
, 0, 0, 0,
10475 doc
: /* Return the raw events that were read for this command.
10476 More generally, it returns the last key sequence read, either by
10477 the command loop or by `read-key-sequence'.
10478 Unlike `this-single-command-keys', this function's value
10479 shows the events before all translations (except for input methods).
10480 The value is always a vector. */)
10483 return Fvector (raw_keybuf_count
,
10484 (XVECTOR (raw_keybuf
)->contents
));
10487 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10488 Sreset_this_command_lengths
, 0, 0, 0,
10489 doc
: /* Make the unread events replace the last command and echo.
10490 Used in `universal-argument-other-key'.
10492 `universal-argument-other-key' rereads the event just typed.
10493 It then gets translated through `function-key-map'.
10494 The translated event has to replace the real events,
10495 both in the value of (this-command-keys) and in echoing.
10496 To achieve this, `universal-argument-other-key' calls
10497 `reset-this-command-lengths', which discards the record of reading
10498 these events the first time. */)
10501 this_command_key_count
= before_command_key_count
;
10502 if (this_command_key_count
< this_single_command_key_start
)
10503 this_single_command_key_start
= this_command_key_count
;
10505 echo_truncate (before_command_echo_length
);
10507 /* Cause whatever we put into unread-command-events
10508 to echo as if it were being freshly read from the keyboard. */
10509 this_command_key_count_reset
= 1;
10514 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10515 Sclear_this_command_keys
, 0, 1, 0,
10516 doc
: /* Clear out the vector that `this-command-keys' returns.
10517 Also clear the record of the last 100 events, unless optional arg
10518 KEEP-RECORD is non-nil. */)
10519 (Lisp_Object keep_record
)
10523 this_command_key_count
= 0;
10524 this_command_key_count_reset
= 0;
10526 if (NILP (keep_record
))
10528 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10529 ASET (recent_keys
, i
, Qnil
);
10531 recent_keys_index
= 0;
10536 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10537 doc
: /* Return the current depth in recursive edits. */)
10541 /* Wrap around reliably on integer overflow. */
10542 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10543 XSETINT (temp
, sum
);
10547 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10548 "FOpen dribble file: ",
10549 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10550 If FILE is nil, close any open dribble file.
10551 The file will be closed when Emacs exits. */)
10563 file
= Fexpand_file_name (file
, Qnil
);
10564 dribble
= fopen (SSDATA (file
), "w");
10566 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10571 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10572 doc
: /* Discard the contents of the terminal input buffer.
10573 Also end any kbd macro being defined. */)
10576 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10578 /* Discard the last command from the macro. */
10579 Fcancel_kbd_macro_events ();
10583 update_mode_lines
++;
10585 Vunread_command_events
= Qnil
;
10587 discard_tty_input ();
10589 kbd_fetch_ptr
= kbd_store_ptr
;
10595 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10596 doc
: /* Stop Emacs and return to superior process. You can resume later.
10597 If `cannot-suspend' is non-nil, or if the system doesn't support job
10598 control, run a subshell instead.
10600 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10601 to be read as terminal input by Emacs's parent, after suspension.
10603 Before suspending, run the normal hook `suspend-hook'.
10604 After resumption run the normal hook `suspend-resume-hook'.
10606 Some operating systems cannot stop the Emacs process and resume it later.
10607 On such systems, Emacs starts a subshell instead of suspending. */)
10608 (Lisp_Object stuffstring
)
10610 ptrdiff_t count
= SPECPDL_INDEX ();
10611 int old_height
, old_width
;
10613 struct gcpro gcpro1
;
10616 if (tty_list
&& tty_list
->next
)
10617 error ("There are other tty frames open; close them before suspending Emacs");
10619 if (!NILP (stuffstring
))
10620 CHECK_STRING (stuffstring
);
10622 /* Run the functions in suspend-hook. */
10623 hook
= intern ("suspend-hook");
10624 Frun_hooks (1, &hook
);
10626 GCPRO1 (stuffstring
);
10627 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10628 reset_all_sys_modes ();
10629 /* sys_suspend can get an error if it tries to fork a subshell
10630 and the system resources aren't available for that. */
10631 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10633 stuff_buffered_input (stuffstring
);
10634 if (cannot_suspend
)
10638 unbind_to (count
, Qnil
);
10640 /* Check if terminal/window size has changed.
10641 Note that this is not useful when we are running directly
10642 with a window system; but suspend should be disabled in that case. */
10643 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10644 if (width
!= old_width
|| height
!= old_height
)
10645 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10647 /* Run suspend-resume-hook. */
10648 hook
= intern ("suspend-resume-hook");
10649 Frun_hooks (1, &hook
);
10655 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10656 Then in any case stuff anything Emacs has read ahead and not used. */
10659 stuff_buffered_input (Lisp_Object stuffstring
)
10661 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10662 register unsigned char *p
;
10664 if (STRINGP (stuffstring
))
10666 register ptrdiff_t count
;
10668 p
= SDATA (stuffstring
);
10669 count
= SBYTES (stuffstring
);
10670 while (count
-- > 0)
10675 /* Anything we have read ahead, put back for the shell to read. */
10676 /* ?? What should this do when we have multiple keyboards??
10677 Should we ignore anything that was typed in at the "wrong" kboard?
10679 rms: we should stuff everything back into the kboard
10681 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10684 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10685 kbd_fetch_ptr
= kbd_buffer
;
10686 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10687 stuff_char (kbd_fetch_ptr
->code
);
10689 clear_event (kbd_fetch_ptr
);
10693 #endif /* SIGTSTP */
10697 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10699 input_available_clear_time
= time_to_clear
;
10701 /* Tell handle_interrupt to throw back to read_char, */
10702 waiting_for_input
= 1;
10704 /* If handle_interrupt was called before and buffered a C-g,
10705 make it run again now, to avoid timing error. */
10706 if (!NILP (Vquit_flag
))
10707 quit_throw_to_read_char (0);
10711 clear_waiting_for_input (void)
10713 /* Tell handle_interrupt not to throw back to read_char, */
10714 waiting_for_input
= 0;
10715 input_available_clear_time
= 0;
10718 /* The SIGINT handler.
10720 If we have a frame on the controlling tty, we assume that the
10721 SIGINT was generated by C-g, so we call handle_interrupt.
10722 Otherwise, tell QUIT to kill Emacs. */
10725 handle_interrupt_signal (int sig
)
10727 /* See if we have an active terminal on our controlling tty. */
10728 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10731 /* If there are no frames there, let's pretend that we are a
10732 well-behaving UN*X program and quit. We must not call Lisp
10733 in a signal handler, so tell QUIT to exit when it is
10735 Vquit_flag
= Qkill_emacs
;
10739 /* Otherwise, the SIGINT was probably generated by C-g. */
10741 /* Set internal_last_event_frame to the top frame of the
10742 controlling tty, if we have a frame there. We disable the
10743 interrupt key on secondary ttys, so the SIGINT must have come
10744 from the controlling tty. */
10745 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10747 handle_interrupt ();
10752 deliver_interrupt_signal (int sig
)
10754 handle_on_main_thread (sig
, handle_interrupt_signal
);
10758 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10759 of the number of times C-g has been requested. If C-g is pressed
10760 enough times, then quit anyway. See bug#6585. */
10761 static int force_quit_count
;
10763 /* This routine is called at interrupt level in response to C-g.
10765 It is called from the SIGINT handler or kbd_buffer_store_event.
10767 If `waiting_for_input' is non zero, then unless `echoing' is
10768 nonzero, immediately throw back to read_char.
10770 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10771 eval to throw, when it gets a chance. If quit-flag is already
10772 non-nil, it stops the job right away. */
10775 handle_interrupt (void)
10781 /* XXX This code needs to be revised for multi-tty support. */
10782 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10784 /* If SIGINT isn't blocked, don't let us be interrupted by
10785 another SIGINT, it might be harmful due to non-reentrancy
10786 in I/O functions. */
10788 sigemptyset (&blocked
);
10789 sigaddset (&blocked
, SIGINT
);
10790 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10793 reset_all_sys_modes ();
10795 #ifdef SIGTSTP /* Support possible in later USG versions */
10797 * On systems which can suspend the current process and return to the original
10798 * shell, this command causes the user to end up back at the shell.
10799 * The "Auto-save" and "Abort" questions are not asked until
10800 * the user elects to return to emacs, at which point he can save the current
10801 * job and either dump core or continue.
10805 /* Perhaps should really fork an inferior shell?
10806 But that would not provide any way to get back
10807 to the original shell, ever. */
10808 printf ("No support for stopping a process on this operating system;\n");
10809 printf ("you can continue or abort.\n");
10810 #endif /* not SIGTSTP */
10812 /* We must remain inside the screen area when the internal terminal
10813 is used. Note that [Enter] is not echoed by dos. */
10814 cursor_to (SELECTED_FRAME (), 0, 0);
10816 /* It doesn't work to autosave while GC is in progress;
10817 the code used for auto-saving doesn't cope with the mark bit. */
10818 if (!gc_in_progress
)
10820 printf ("Auto-save? (y or n) ");
10822 if (((c
= getchar ()) & ~040) == 'Y')
10824 Fdo_auto_save (Qt
, Qnil
);
10826 printf ("\r\nAuto-save done");
10827 #else /* not MSDOS */
10828 printf ("Auto-save done\n");
10829 #endif /* not MSDOS */
10831 while (c
!= '\n') c
= getchar ();
10835 /* During GC, it must be safe to reenable quitting again. */
10836 Vinhibit_quit
= Qnil
;
10839 #endif /* not MSDOS */
10840 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10841 printf ("but will instead do a real quit after garbage collection ends\r\n");
10846 printf ("\r\nAbort? (y or n) ");
10847 #else /* not MSDOS */
10848 printf ("Abort (and dump core)? (y or n) ");
10849 #endif /* not MSDOS */
10851 if (((c
= getchar ()) & ~040) == 'Y')
10853 while (c
!= '\n') c
= getchar ();
10855 printf ("\r\nContinuing...\r\n");
10856 #else /* not MSDOS */
10857 printf ("Continuing...\n");
10858 #endif /* not MSDOS */
10860 init_all_sys_modes ();
10861 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10865 /* If executing a function that wants to be interrupted out of
10866 and the user has not deferred quitting by binding `inhibit-quit'
10867 then quit right away. */
10868 if (immediate_quit
&& NILP (Vinhibit_quit
))
10870 struct gl_state_s saved
;
10871 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10873 immediate_quit
= 0;
10874 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10876 GCPRO4 (saved
.object
, saved
.global_code
,
10877 saved
.current_syntax_table
, saved
.old_prop
);
10878 Fsignal (Qquit
, Qnil
);
10879 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10884 { /* Else request quit when it's safe. */
10885 if (NILP (Vquit_flag
))
10886 force_quit_count
= 0;
10887 if (++force_quit_count
== 3)
10889 immediate_quit
= 1;
10890 Vinhibit_quit
= Qnil
;
10896 /* TODO: The longjmp in this call throws the NS event loop integration off,
10897 and it seems to do fine without this. Probably some attention
10898 needs to be paid to the setting of waiting_for_input in
10899 wait_reading_process_output() under HAVE_NS because of the call
10900 to ns_select there (needed because otherwise events aren't picked up
10901 outside of polling since we don't get SIGIO like X and we don't have a
10902 separate event loop thread like W32. */
10904 if (waiting_for_input
&& !echoing
)
10905 quit_throw_to_read_char (1);
10909 /* Handle a C-g by making read_char return C-g. */
10912 quit_throw_to_read_char (int from_signal
)
10914 /* When not called from a signal handler it is safe to call
10916 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10917 Fkill_emacs (Qnil
);
10919 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10920 /* Prevent another signal from doing this before we finish. */
10921 clear_waiting_for_input ();
10924 Vunread_command_events
= Qnil
;
10926 #if 0 /* Currently, sit_for is called from read_char without turning
10927 off polling. And that can call set_waiting_for_input.
10928 It seems to be harmless. */
10929 #ifdef POLL_FOR_INPUT
10930 /* May be > 1 if in recursive minibuffer. */
10931 if (poll_suppress_count
== 0)
10935 if (FRAMEP (internal_last_event_frame
)
10936 && !EQ (internal_last_event_frame
, selected_frame
))
10937 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10940 sys_longjmp (getcjmp
, 1);
10943 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10944 Sset_input_interrupt_mode
, 1, 1, 0,
10945 doc
: /* Set interrupt mode of reading keyboard input.
10946 If INTERRUPT is non-nil, Emacs will use input interrupts;
10947 otherwise Emacs uses CBREAK mode.
10949 See also `current-input-mode'. */)
10950 (Lisp_Object interrupt
)
10952 int new_interrupt_input
;
10953 #ifdef USABLE_SIGIO
10954 #ifdef HAVE_X_WINDOWS
10955 if (x_display_list
!= NULL
)
10957 /* When using X, don't give the user a real choice,
10958 because we haven't implemented the mechanisms to support it. */
10959 new_interrupt_input
= 1;
10962 #endif /* HAVE_X_WINDOWS */
10963 new_interrupt_input
= !NILP (interrupt
);
10964 #else /* not USABLE_SIGIO */
10965 new_interrupt_input
= 0;
10966 #endif /* not USABLE_SIGIO */
10968 if (new_interrupt_input
!= interrupt_input
)
10970 #ifdef POLL_FOR_INPUT
10974 /* this causes startup screen to be restored and messes with the mouse */
10975 reset_all_sys_modes ();
10976 interrupt_input
= new_interrupt_input
;
10977 init_all_sys_modes ();
10979 interrupt_input
= new_interrupt_input
;
10982 #ifdef POLL_FOR_INPUT
10983 poll_suppress_count
= 1;
10990 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10991 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10992 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10993 C-q in key sequences.
10995 This setting only has an effect on tty terminals and only when
10996 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10998 See also `current-input-mode'. */)
10999 (Lisp_Object flow
, Lisp_Object terminal
)
11001 struct terminal
*t
= get_terminal (terminal
, 1);
11002 struct tty_display_info
*tty
;
11003 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11005 tty
= t
->display_info
.tty
;
11007 if (tty
->flow_control
!= !NILP (flow
))
11010 /* this causes startup screen to be restored and messes with the mouse */
11011 reset_sys_modes (tty
);
11014 tty
->flow_control
= !NILP (flow
);
11017 init_sys_modes (tty
);
11023 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11024 doc
: /* Enable or disable 8-bit input on TERMINAL.
11025 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11026 bit as the Meta modifier.
11028 If META is nil, Emacs will ignore the top bit, on the assumption it is
11031 Otherwise, Emacs will accept and pass through 8-bit input without
11032 specially interpreting the top bit.
11034 This setting only has an effect on tty terminal devices.
11036 Optional parameter TERMINAL specifies the tty terminal device to use.
11037 It may be a terminal object, a frame, or nil for the terminal used by
11038 the currently selected frame.
11040 See also `current-input-mode'. */)
11041 (Lisp_Object meta
, Lisp_Object terminal
)
11043 struct terminal
*t
= get_terminal (terminal
, 1);
11044 struct tty_display_info
*tty
;
11047 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11049 tty
= t
->display_info
.tty
;
11053 else if (EQ (meta
, Qt
))
11058 if (tty
->meta_key
!= new_meta
)
11061 /* this causes startup screen to be restored and messes with the mouse */
11062 reset_sys_modes (tty
);
11065 tty
->meta_key
= new_meta
;
11068 init_sys_modes (tty
);
11074 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11075 doc
: /* Specify character used for quitting.
11076 QUIT must be an ASCII character.
11078 This function only has an effect on the controlling tty of the Emacs
11081 See also `current-input-mode'. */)
11084 struct terminal
*t
= get_named_tty ("/dev/tty");
11085 struct tty_display_info
*tty
;
11086 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11088 tty
= t
->display_info
.tty
;
11090 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11091 error ("QUIT must be an ASCII character");
11094 /* this causes startup screen to be restored and messes with the mouse */
11095 reset_sys_modes (tty
);
11098 /* Don't let this value be out of range. */
11099 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11102 init_sys_modes (tty
);
11108 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11109 doc
: /* Set mode of reading keyboard input.
11110 First arg INTERRUPT non-nil means use input interrupts;
11111 nil means use CBREAK mode.
11112 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11113 (no effect except in CBREAK mode).
11114 Third arg META t means accept 8-bit input (for a Meta key).
11115 META nil means ignore the top bit, on the assumption it is parity.
11116 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11117 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11118 See also `current-input-mode'. */)
11119 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11121 Fset_input_interrupt_mode (interrupt
);
11122 Fset_output_flow_control (flow
, Qnil
);
11123 Fset_input_meta_mode (meta
, Qnil
);
11125 Fset_quit_char (quit
);
11129 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11130 doc
: /* Return information about the way Emacs currently reads keyboard input.
11131 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11132 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11133 nil, Emacs is using CBREAK mode.
11134 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11135 terminal; this does not apply if Emacs uses interrupt-driven input.
11136 META is t if accepting 8-bit input with 8th bit as Meta flag.
11137 META nil means ignoring the top bit, on the assumption it is parity.
11138 META is neither t nor nil if accepting 8-bit input and using
11139 all 8 bits as the character code.
11140 QUIT is the character Emacs currently uses to quit.
11141 The elements of this list correspond to the arguments of
11142 `set-input-mode'. */)
11145 Lisp_Object val
[4];
11146 struct frame
*sf
= XFRAME (selected_frame
);
11148 val
[0] = interrupt_input
? Qt
: Qnil
;
11149 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11151 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11152 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11154 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11161 XSETFASTINT (val
[3], quit_char
);
11163 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11166 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11167 doc
: /* Return position information for pixel coordinates X and Y.
11168 By default, X and Y are relative to text area of the selected window.
11169 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11170 If optional fourth arg WHOLE is non-nil, X is relative to the left
11171 edge of the window.
11173 The return value is similar to a mouse click position:
11174 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11175 IMAGE (DX . DY) (WIDTH . HEIGHT))
11176 The `posn-' functions access elements of such lists. */)
11177 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11182 if (NILP (frame_or_window
))
11183 frame_or_window
= selected_window
;
11185 if (WINDOWP (frame_or_window
))
11187 struct window
*w
= decode_live_window (frame_or_window
);
11189 XSETINT (x
, (XINT (x
)
11190 + WINDOW_LEFT_EDGE_X (w
)
11192 ? window_box_left_offset (w
, TEXT_AREA
)
11194 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11195 frame_or_window
= w
->frame
;
11198 CHECK_LIVE_FRAME (frame_or_window
);
11200 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11203 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11204 doc
: /* Return position information for buffer POS in WINDOW.
11205 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11207 Return nil if position is not visible in window. Otherwise,
11208 the return value is similar to that returned by `event-start' for
11209 a mouse click at the upper left corner of the glyph corresponding
11210 to the given buffer position:
11211 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11212 IMAGE (DX . DY) (WIDTH . HEIGHT))
11213 The `posn-' functions access elements of such lists. */)
11214 (Lisp_Object pos
, Lisp_Object window
)
11219 window
= selected_window
;
11221 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11224 Lisp_Object x
= XCAR (tem
);
11225 Lisp_Object y
= XCAR (XCDR (tem
));
11227 /* Point invisible due to hscrolling? */
11230 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11238 * Set up a new kboard object with reasonable initial values.
11241 init_kboard (KBOARD
*kb
)
11243 kset_overriding_terminal_local_map (kb
, Qnil
);
11244 kset_last_command (kb
, Qnil
);
11245 kset_real_last_command (kb
, Qnil
);
11246 kset_keyboard_translate_table (kb
, Qnil
);
11247 kset_last_repeatable_command (kb
, Qnil
);
11248 kset_prefix_arg (kb
, Qnil
);
11249 kset_last_prefix_arg (kb
, Qnil
);
11250 kset_kbd_queue (kb
, Qnil
);
11251 kb
->kbd_queue_has_data
= 0;
11252 kb
->immediate_echo
= 0;
11253 kset_echo_string (kb
, Qnil
);
11254 kb
->echo_after_prompt
= -1;
11255 kb
->kbd_macro_buffer
= 0;
11256 kb
->kbd_macro_bufsize
= 0;
11257 kset_defining_kbd_macro (kb
, Qnil
);
11258 kset_last_kbd_macro (kb
, Qnil
);
11259 kb
->reference_count
= 0;
11260 kset_system_key_alist (kb
, Qnil
);
11261 kset_system_key_syms (kb
, Qnil
);
11262 kset_window_system (kb
, Qt
); /* Unset. */
11263 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
11264 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
11265 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11266 kset_default_minibuffer_frame (kb
, Qnil
);
11270 * Destroy the contents of a kboard object, but not the object itself.
11271 * We use this just before deleting it, or if we're going to initialize
11272 * it a second time.
11275 wipe_kboard (KBOARD
*kb
)
11277 xfree (kb
->kbd_macro_buffer
);
11280 /* Free KB and memory referenced from it. */
11283 delete_kboard (KBOARD
*kb
)
11287 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11290 *kbp
= kb
->next_kboard
;
11292 /* Prevent a dangling reference to KB. */
11293 if (kb
== current_kboard
11294 && FRAMEP (selected_frame
)
11295 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11297 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11299 if (current_kboard
== kb
)
11308 init_keyboard (void)
11310 /* This is correct before outermost invocation of the editor loop. */
11311 command_loop_level
= -1;
11312 immediate_quit
= 0;
11313 quit_char
= Ctl ('g');
11314 Vunread_command_events
= Qnil
;
11315 timer_idleness_start_time
= invalid_emacs_time ();
11317 recent_keys_index
= 0;
11318 kbd_fetch_ptr
= kbd_buffer
;
11319 kbd_store_ptr
= kbd_buffer
;
11320 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11321 do_mouse_tracking
= Qnil
;
11324 interrupt_input_blocked
= 0;
11325 interrupt_input_pending
= 0;
11326 pending_signals
= 0;
11328 /* This means that command_loop_1 won't try to select anything the first
11330 internal_last_event_frame
= Qnil
;
11331 Vlast_event_frame
= internal_last_event_frame
;
11333 current_kboard
= initial_kboard
;
11334 /* Re-initialize the keyboard again. */
11335 wipe_kboard (current_kboard
);
11336 init_kboard (current_kboard
);
11337 /* A value of nil for Vwindow_system normally means a tty, but we also use
11338 it for the initial terminal since there is no window system there. */
11339 kset_window_system (current_kboard
, Qnil
);
11341 if (!noninteractive
)
11343 /* Before multi-tty support, these handlers used to be installed
11344 only if the current session was a tty session. Now an Emacs
11345 session may have multiple display types, so we always handle
11346 SIGINT. There is special code in interrupt_signal to exit
11347 Emacs on SIGINT when there are no termcap frames on the
11348 controlling terminal. */
11349 struct sigaction action
;
11350 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
11351 sigaction (SIGINT
, &action
, 0);
11353 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11354 SIGQUIT and we can't tell which one it will give us. */
11355 sigaction (SIGQUIT
, &action
, 0);
11356 #endif /* not DOS_NT */
11358 #ifdef USABLE_SIGIO
11359 if (!noninteractive
)
11361 struct sigaction action
;
11362 emacs_sigaction_init (&action
, deliver_input_available_signal
);
11363 sigaction (SIGIO
, &action
, 0);
11367 /* Use interrupt input by default, if it works and noninterrupt input
11368 has deficiencies. */
11370 #ifdef INTERRUPT_INPUT
11371 interrupt_input
= 1;
11373 interrupt_input
= 0;
11376 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
11379 if (keyboard_init_hook
)
11380 (*keyboard_init_hook
) ();
11382 #ifdef POLL_FOR_INPUT
11384 poll_suppress_count
= 1;
11389 /* This type's only use is in syms_of_keyboard, to initialize the
11390 event header symbols and put properties on them. */
11391 struct event_head
{
11397 static const struct event_head head_table
[] = {
11398 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11399 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11400 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11401 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11402 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11403 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11404 /* `select-window' should be handled just like `switch-frame'
11405 in read_key_sequence. */
11406 {&Qselect_window
, "select-window", &Qswitch_frame
}
11410 syms_of_keyboard (void)
11412 pending_funcalls
= Qnil
;
11413 staticpro (&pending_funcalls
);
11415 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11416 staticpro (&Vlispy_mouse_stem
);
11419 DEFSYM (QCimage
, ":image");
11420 DEFSYM (Qhelp_echo
, "help-echo");
11421 DEFSYM (QCrtl
, ":rtl");
11423 staticpro (&item_properties
);
11424 item_properties
= Qnil
;
11426 staticpro (&tool_bar_item_properties
);
11427 tool_bar_item_properties
= Qnil
;
11428 staticpro (&tool_bar_items_vector
);
11429 tool_bar_items_vector
= Qnil
;
11431 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11432 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11433 DEFSYM (Qself_insert_command
, "self-insert-command");
11434 DEFSYM (Qforward_char
, "forward-char");
11435 DEFSYM (Qbackward_char
, "backward-char");
11436 DEFSYM (Qdisabled
, "disabled");
11437 DEFSYM (Qundefined
, "undefined");
11438 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11439 DEFSYM (Qpost_command_hook
, "post-command-hook");
11440 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11441 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11442 DEFSYM (Qfunction_key
, "function-key");
11443 DEFSYM (Qmouse_click
, "mouse-click");
11444 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11445 DEFSYM (Qsave_session
, "save-session");
11446 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11447 DEFSYM (Qmenu_enable
, "menu-enable");
11449 #if defined (WINDOWSNT)
11450 DEFSYM (Qlanguage_change
, "language-change");
11454 DEFSYM (Qdbus_event
, "dbus-event");
11457 DEFSYM (QCenable
, ":enable");
11458 DEFSYM (QCvisible
, ":visible");
11459 DEFSYM (QChelp
, ":help");
11460 DEFSYM (QCfilter
, ":filter");
11461 DEFSYM (QCbutton
, ":button");
11462 DEFSYM (QCkeys
, ":keys");
11463 DEFSYM (QCkey_sequence
, ":key-sequence");
11464 DEFSYM (QCtoggle
, ":toggle");
11465 DEFSYM (QCradio
, ":radio");
11466 DEFSYM (QClabel
, ":label");
11467 DEFSYM (QCvert_only
, ":vert-only");
11469 DEFSYM (Qmode_line
, "mode-line");
11470 DEFSYM (Qvertical_line
, "vertical-line");
11471 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11472 DEFSYM (Qmenu_bar
, "menu-bar");
11474 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11475 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11478 DEFSYM (Qabove_handle
, "above-handle");
11479 DEFSYM (Qhandle
, "handle");
11480 DEFSYM (Qbelow_handle
, "below-handle");
11481 DEFSYM (Qup
, "up");
11482 DEFSYM (Qdown
, "down");
11483 DEFSYM (Qtop
, "top");
11484 DEFSYM (Qbottom
, "bottom");
11485 DEFSYM (Qend_scroll
, "end-scroll");
11486 DEFSYM (Qratio
, "ratio");
11488 DEFSYM (Qevent_kind
, "event-kind");
11489 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11490 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11491 DEFSYM (Qmodifier_cache
, "modifier-cache");
11493 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11494 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11496 DEFSYM (Qpolling_period
, "polling-period");
11498 DEFSYM (Qx_set_selection
, "x-set-selection");
11499 DEFSYM (QPRIMARY
, "PRIMARY");
11500 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11501 DEFSYM (Qhandle_select_window
, "handle-select-window");
11503 DEFSYM (Qinput_method_function
, "input-method-function");
11504 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11505 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11507 DEFSYM (Qhelp_form_show
, "help-form-show");
11509 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11510 Fset (Qinput_method_use_echo_area
, Qnil
);
11512 last_point_position_buffer
= Qnil
;
11513 last_point_position_window
= Qnil
;
11517 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11519 for (i
= 0; i
< len
; i
++)
11521 const struct event_head
*p
= &head_table
[i
];
11522 *p
->var
= intern_c_string (p
->name
);
11523 staticpro (p
->var
);
11524 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11525 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11529 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11530 staticpro (&button_down_location
);
11531 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11532 staticpro (&mouse_syms
);
11533 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11534 / sizeof (lispy_wheel_names
[0])),
11536 staticpro (&wheel_syms
);
11540 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11542 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11543 for (i
= 0; i
< len
; i
++)
11544 if (modifier_names
[i
])
11545 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11546 staticpro (&modifier_symbols
);
11549 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11550 staticpro (&recent_keys
);
11552 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11553 staticpro (&this_command_keys
);
11555 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11556 staticpro (&raw_keybuf
);
11558 DEFSYM (Qextended_command_history
, "extended-command-history");
11559 Fset (Qextended_command_history
, Qnil
);
11561 accent_key_syms
= Qnil
;
11562 staticpro (&accent_key_syms
);
11564 func_key_syms
= Qnil
;
11565 staticpro (&func_key_syms
);
11567 drag_n_drop_syms
= Qnil
;
11568 staticpro (&drag_n_drop_syms
);
11570 unread_switch_frame
= Qnil
;
11571 staticpro (&unread_switch_frame
);
11573 internal_last_event_frame
= Qnil
;
11574 staticpro (&internal_last_event_frame
);
11576 read_key_sequence_cmd
= Qnil
;
11577 staticpro (&read_key_sequence_cmd
);
11578 read_key_sequence_remapped
= Qnil
;
11579 staticpro (&read_key_sequence_remapped
);
11581 menu_bar_one_keymap_changed_items
= Qnil
;
11582 staticpro (&menu_bar_one_keymap_changed_items
);
11584 menu_bar_items_vector
= Qnil
;
11585 staticpro (&menu_bar_items_vector
);
11587 help_form_saved_window_configs
= Qnil
;
11588 staticpro (&help_form_saved_window_configs
);
11590 defsubr (&Scurrent_idle_time
);
11591 defsubr (&Sevent_symbol_parse_modifiers
);
11592 defsubr (&Sevent_convert_list
);
11593 defsubr (&Sread_key_sequence
);
11594 defsubr (&Sread_key_sequence_vector
);
11595 defsubr (&Srecursive_edit
);
11596 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11597 defsubr (&Strack_mouse
);
11599 defsubr (&Sinput_pending_p
);
11600 defsubr (&Scommand_execute
);
11601 defsubr (&Srecent_keys
);
11602 defsubr (&Sthis_command_keys
);
11603 defsubr (&Sthis_command_keys_vector
);
11604 defsubr (&Sthis_single_command_keys
);
11605 defsubr (&Sthis_single_command_raw_keys
);
11606 defsubr (&Sreset_this_command_lengths
);
11607 defsubr (&Sclear_this_command_keys
);
11608 defsubr (&Ssuspend_emacs
);
11609 defsubr (&Sabort_recursive_edit
);
11610 defsubr (&Sexit_recursive_edit
);
11611 defsubr (&Srecursion_depth
);
11612 defsubr (&Stop_level
);
11613 defsubr (&Sdiscard_input
);
11614 defsubr (&Sopen_dribble_file
);
11615 defsubr (&Sset_input_interrupt_mode
);
11616 defsubr (&Sset_output_flow_control
);
11617 defsubr (&Sset_input_meta_mode
);
11618 defsubr (&Sset_quit_char
);
11619 defsubr (&Sset_input_mode
);
11620 defsubr (&Scurrent_input_mode
);
11621 defsubr (&Sposn_at_point
);
11622 defsubr (&Sposn_at_x_y
);
11624 DEFVAR_LISP ("last-command-event", last_command_event
,
11625 doc
: /* Last input event that was part of a command. */);
11627 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11628 doc
: /* Last input event in a command, except for mouse menu events.
11629 Mouse menus give back keys that don't look like mouse events;
11630 this variable holds the actual mouse event that led to the menu,
11631 so that you can determine whether the command was run by mouse or not. */);
11633 DEFVAR_LISP ("last-input-event", last_input_event
,
11634 doc
: /* Last input event. */);
11636 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11637 doc
: /* List of events to be read as the command input.
11638 These events are processed first, before actual keyboard input.
11639 Events read from this list are not normally added to `this-command-keys',
11640 as they will already have been added once as they were read for the first time.
11641 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11642 Vunread_command_events
= Qnil
;
11644 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11645 doc
: /* List of events to be processed as input by input methods.
11646 These events are processed before `unread-command-events'
11647 and actual keyboard input, but are not given to `input-method-function'. */);
11648 Vunread_post_input_method_events
= Qnil
;
11650 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11651 doc
: /* List of events to be processed as input by input methods.
11652 These events are processed after `unread-command-events', but
11653 before actual keyboard input.
11654 If there's an active input method, the events are given to
11655 `input-method-function'. */);
11656 Vunread_input_method_events
= Qnil
;
11658 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11659 doc
: /* Meta-prefix character code.
11660 Meta-foo as command input turns into this character followed by foo. */);
11661 XSETINT (meta_prefix_char
, 033);
11663 DEFVAR_KBOARD ("last-command", Vlast_command
,
11664 doc
: /* The last command executed.
11665 Normally a symbol with a function definition, but can be whatever was found
11666 in the keymap, or whatever the variable `this-command' was set to by that
11669 The value `mode-exit' is special; it means that the previous command
11670 read an event that told it to exit, and it did so and unread that event.
11671 In other words, the present command is the event that made the previous
11674 The value `kill-region' is special; it means that the previous command
11675 was a kill command.
11677 `last-command' has a separate binding for each terminal device.
11678 See Info node `(elisp)Multiple Terminals'. */);
11680 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11681 doc
: /* Same as `last-command', but never altered by Lisp code.
11682 Taken from the previous value of `real-this-command'. */);
11684 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11685 doc
: /* Last command that may be repeated.
11686 The last command executed that was not bound to an input event.
11687 This is the command `repeat' will try to repeat.
11688 Taken from a previous value of `real-this-command'. */);
11690 DEFVAR_LISP ("this-command", Vthis_command
,
11691 doc
: /* The command now being executed.
11692 The command can set this variable; whatever is put here
11693 will be in `last-command' during the following command. */);
11694 Vthis_command
= Qnil
;
11696 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11697 doc
: /* This is like `this-command', except that commands should never modify it. */);
11698 Vreal_this_command
= Qnil
;
11700 DEFVAR_LISP ("this-command-keys-shift-translated",
11701 Vthis_command_keys_shift_translated
,
11702 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11703 Shift-translation occurs when there is no binding for the key sequence
11704 as entered, but a binding was found by changing an upper-case letter
11705 to lower-case, or a shifted function key to an unshifted one. */);
11706 Vthis_command_keys_shift_translated
= Qnil
;
11708 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11709 doc
: /* The command bound to the current key sequence before remapping.
11710 It equals `this-command' if the original command was not remapped through
11711 any of the active keymaps. Otherwise, the value of `this-command' is the
11712 result of looking up the original command in the active keymaps. */);
11713 Vthis_original_command
= Qnil
;
11715 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11716 doc
: /* Number of input events between auto-saves.
11717 Zero means disable autosaving due to number of characters typed. */);
11718 auto_save_interval
= 300;
11720 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11721 doc
: /* Number of seconds idle time before auto-save.
11722 Zero or nil means disable auto-saving due to idleness.
11723 After auto-saving due to this many seconds of idle time,
11724 Emacs also does a garbage collection if that seems to be warranted. */);
11725 XSETFASTINT (Vauto_save_timeout
, 30);
11727 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11728 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11729 The value may be integer or floating point.
11730 If the value is zero, don't echo at all. */);
11731 Vecho_keystrokes
= make_number (1);
11733 DEFVAR_INT ("polling-period", polling_period
,
11734 doc
: /* Interval between polling for input during Lisp execution.
11735 The reason for polling is to make C-g work to stop a running program.
11736 Polling is needed only when using X windows and SIGIO does not work.
11737 Polling is automatically disabled in all other cases. */);
11738 polling_period
= 2;
11740 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11741 doc
: /* Maximum time between mouse clicks to make a double-click.
11742 Measured in milliseconds. The value nil means disable double-click
11743 recognition; t means double-clicks have no time limit and are detected
11744 by position only. */);
11745 Vdouble_click_time
= make_number (500);
11747 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11748 doc
: /* Maximum mouse movement between clicks to make a double-click.
11749 On window-system frames, value is the number of pixels the mouse may have
11750 moved horizontally or vertically between two clicks to make a double-click.
11751 On non window-system frames, value is interpreted in units of 1/8 characters
11754 This variable is also the threshold for motion of the mouse
11755 to count as a drag. */);
11756 double_click_fuzz
= 3;
11758 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11759 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11760 inhibit_local_menu_bar_menus
= 0;
11762 DEFVAR_INT ("num-input-keys", num_input_keys
,
11763 doc
: /* Number of complete key sequences read as input so far.
11764 This includes key sequences read from keyboard macros.
11765 The number is effectively the number of interactive command invocations. */);
11766 num_input_keys
= 0;
11768 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11769 doc
: /* Number of input events read from the keyboard so far.
11770 This does not include events generated by keyboard macros. */);
11771 num_nonmacro_input_events
= 0;
11773 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11774 doc
: /* The frame in which the most recently read event occurred.
11775 If the last event came from a keyboard macro, this is set to `macro'. */);
11776 Vlast_event_frame
= Qnil
;
11778 /* This variable is set up in sysdep.c. */
11779 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11780 doc
: /* The ERASE character as set by the user with stty. */);
11782 DEFVAR_LISP ("help-char", Vhelp_char
,
11783 doc
: /* Character to recognize as meaning Help.
11784 When it is read, do `(eval help-form)', and display result if it's a string.
11785 If the value of `help-form' is nil, this char can be read normally. */);
11786 XSETINT (Vhelp_char
, Ctl ('H'));
11788 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11789 doc
: /* List of input events to recognize as meaning Help.
11790 These work just like the value of `help-char' (see that). */);
11791 Vhelp_event_list
= Qnil
;
11793 DEFVAR_LISP ("help-form", Vhelp_form
,
11794 doc
: /* Form to execute when character `help-char' is read.
11795 If the form returns a string, that string is displayed.
11796 If `help-form' is nil, the help char is not recognized. */);
11799 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11800 doc
: /* Command to run when `help-char' character follows a prefix key.
11801 This command is used only when there is no actual binding
11802 for that character after that prefix key. */);
11803 Vprefix_help_command
= Qnil
;
11805 DEFVAR_LISP ("top-level", Vtop_level
,
11806 doc
: /* Form to evaluate when Emacs starts up.
11807 Useful to set before you dump a modified Emacs. */);
11810 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11811 doc
: /* Translate table for local keyboard input, or nil.
11812 If non-nil, the value should be a char-table. Each character read
11813 from the keyboard is looked up in this char-table. If the value found
11814 there is non-nil, then it is used instead of the actual input character.
11816 The value can also be a string or vector, but this is considered obsolete.
11817 If it is a string or vector of length N, character codes N and up are left
11818 untranslated. In a vector, an element which is nil means "no translation".
11820 This is applied to the characters supplied to input methods, not their
11821 output. See also `translation-table-for-input'.
11823 This variable has a separate binding for each terminal.
11824 See Info node `(elisp)Multiple Terminals'. */);
11826 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11827 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11828 \(Even if the operating system has support for stopping a process.\) */);
11829 cannot_suspend
= 0;
11831 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11832 doc
: /* Non-nil means prompt with menus when appropriate.
11833 This is done when reading from a keymap that has a prompt string,
11834 for elements that have prompt strings.
11835 The menu is displayed on the screen
11836 if X menus were enabled at configuration
11837 time and the previous event was a mouse click prefix key.
11838 Otherwise, menu prompting uses the echo area. */);
11839 menu_prompting
= 1;
11841 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11842 doc
: /* Character to see next line of menu prompt.
11843 Type this character while in a menu prompt to rotate around the lines of it. */);
11844 XSETINT (menu_prompt_more_char
, ' ');
11846 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11847 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11848 Emacs applies the modifiers of the character stored here to each keyboard
11849 character it reads. For example, after evaluating the expression
11850 (setq extra-keyboard-modifiers ?\\C-x)
11851 all input characters will have the control modifier applied to them.
11853 Note that the character ?\\C-@, equivalent to the integer zero, does
11854 not count as a control character; rather, it counts as a character
11855 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11856 cancels any modification. */);
11857 extra_keyboard_modifiers
= 0;
11859 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11860 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11861 The command loop sets this to nil before each command,
11862 and tests the value when the command returns.
11863 Buffer modification stores t in this variable. */);
11864 Vdeactivate_mark
= Qnil
;
11865 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11867 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11868 doc
: /* Normal hook run before each command is executed.
11869 If an unhandled error happens in running this hook,
11870 the function in which the error occurred is unconditionally removed, since
11871 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11872 Vpre_command_hook
= Qnil
;
11874 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11875 doc
: /* Normal hook run after each command is executed.
11876 If an unhandled error happens in running this hook,
11877 the function in which the error occurred is unconditionally removed, since
11878 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11879 Vpost_command_hook
= Qnil
;
11882 DEFVAR_LISP ("echo-area-clear-hook", ...,
11883 doc
: /* Normal hook run when clearing the echo area. */);
11885 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11886 Fset (Qecho_area_clear_hook
, Qnil
);
11888 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11889 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11890 Vlucid_menu_bar_dirty_flag
= Qnil
;
11892 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11893 doc
: /* List of menu bar items to move to the end of the menu bar.
11894 The elements of the list are event types that may have menu bar bindings. */);
11895 Vmenu_bar_final_items
= Qnil
;
11897 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11898 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11899 This is used internally by graphical displays that do not render
11900 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11901 Vtool_bar_separator_image_expression
= Qnil
;
11903 DEFVAR_KBOARD ("overriding-terminal-local-map",
11904 Voverriding_terminal_local_map
,
11905 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11906 If this variable is non-nil, it is used as a keymap instead of the
11907 buffer's local map, and the minor mode keymaps and text property keymaps.
11908 It also replaces `overriding-local-map'.
11910 This variable is intended to let commands such as `universal-argument'
11911 set up a different keymap for reading the next command.
11913 `overriding-terminal-local-map' has a separate binding for each
11915 See Info node `(elisp)Multiple Terminals'. */);
11917 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11918 doc
: /* Keymap that overrides all other local keymaps.
11919 If this variable is non-nil, it is used as a keymap--replacing the
11920 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11921 Voverriding_local_map
= Qnil
;
11923 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11924 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11925 Otherwise, the menu bar continues to reflect the buffer's local map
11926 and the minor mode maps regardless of `overriding-local-map'. */);
11927 Voverriding_local_map_menu_flag
= Qnil
;
11929 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11930 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11931 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11933 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11934 doc
: /* Non-nil means generate motion events for mouse motion. */);
11936 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11937 doc
: /* Alist of system-specific X windows key symbols.
11938 Each element should have the form (N . SYMBOL) where N is the
11939 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11940 and SYMBOL is its name.
11942 `system-key-alist' has a separate binding for each terminal device.
11943 See Info node `(elisp)Multiple Terminals'. */);
11945 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11946 doc
: /* Keymap that translates key sequences to key sequences during input.
11947 This is used mainly for mapping key sequences into some preferred
11948 key events (symbols).
11950 The `read-key-sequence' function replaces any subsequence bound by
11951 `local-function-key-map' with its binding. More precisely, when the
11952 active keymaps have no binding for the current key sequence but
11953 `local-function-key-map' binds a suffix of the sequence to a vector or
11954 string, `read-key-sequence' replaces the matching suffix with its
11955 binding, and continues with the new sequence.
11957 If the binding is a function, it is called with one argument (the prompt)
11958 and its return value (a key sequence) is used.
11960 The events that come from bindings in `local-function-key-map' are not
11961 themselves looked up in `local-function-key-map'.
11963 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11964 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11965 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11966 typing `ESC O P x' would return [f1 x].
11968 `local-function-key-map' has a separate binding for each terminal
11969 device. See Info node `(elisp)Multiple Terminals'. If you need to
11970 define a binding on all terminals, change `function-key-map'
11971 instead. Initially, `local-function-key-map' is an empty keymap that
11972 has `function-key-map' as its parent on all terminal devices. */);
11974 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11975 doc
: /* Keymap that decodes input escape sequences.
11976 This is used mainly for mapping ASCII function key sequences into
11977 real Emacs function key events (symbols).
11979 The `read-key-sequence' function replaces any subsequence bound by
11980 `input-decode-map' with its binding. Contrary to `function-key-map',
11981 this map applies its rebinding regardless of the presence of an ordinary
11982 binding. So it is more like `key-translation-map' except that it applies
11983 before `function-key-map' rather than after.
11985 If the binding is a function, it is called with one argument (the prompt)
11986 and its return value (a key sequence) is used.
11988 The events that come from bindings in `input-decode-map' are not
11989 themselves looked up in `input-decode-map'.
11991 This variable is keyboard-local. */);
11993 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11994 doc
: /* The parent keymap of all `local-function-key-map' instances.
11995 Function key definitions that apply to all terminal devices should go
11996 here. If a mapping is defined in both the current
11997 `local-function-key-map' binding and this variable, then the local
11998 definition will take precedence. */);
11999 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12001 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12002 doc
: /* Keymap of key translations that can override keymaps.
12003 This keymap works like `function-key-map', but comes after that,
12004 and its non-prefix bindings override ordinary bindings.
12005 Another difference is that it is global rather than keyboard-local. */);
12006 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12008 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12009 doc
: /* List of deferred actions to be performed at a later time.
12010 The precise format isn't relevant here; we just check whether it is nil. */);
12011 Vdeferred_action_list
= Qnil
;
12013 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12014 doc
: /* Function to call to handle deferred actions, after each command.
12015 This function is called with no arguments after each command
12016 whenever `deferred-action-list' is non-nil. */);
12017 Vdeferred_action_function
= Qnil
;
12019 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12020 doc
: /* List of warnings to be displayed after this command.
12021 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12022 as per the args of `display-warning' (which see).
12023 If this variable is non-nil, `delayed-warnings-hook' will be run
12024 immediately after running `post-command-hook'. */);
12025 Vdelayed_warnings_list
= Qnil
;
12027 DEFVAR_LISP ("timer-list", Vtimer_list
,
12028 doc
: /* List of active absolute time timers in order of increasing time. */);
12029 Vtimer_list
= Qnil
;
12031 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12032 doc
: /* List of active idle-time timers in order of increasing time. */);
12033 Vtimer_idle_list
= Qnil
;
12035 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12036 doc
: /* If non-nil, the function that implements the current input method.
12037 It's called with one argument, a printing character that was just read.
12038 \(That means a character with code 040...0176.)
12039 Typically this function uses `read-event' to read additional events.
12040 When it does so, it should first bind `input-method-function' to nil
12041 so it will not be called recursively.
12043 The function should return a list of zero or more events
12044 to be used as input. If it wants to put back some events
12045 to be reconsidered, separately, by the input method,
12046 it can add them to the beginning of `unread-command-events'.
12048 The input method function can find in `input-method-previous-message'
12049 the previous echo area message.
12051 The input method function should refer to the variables
12052 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12053 for guidance on what to do. */);
12054 Vinput_method_function
= Qnil
;
12056 DEFVAR_LISP ("input-method-previous-message",
12057 Vinput_method_previous_message
,
12058 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12059 This variable exists because `read-event' clears the echo area
12060 before running the input method. It is nil if there was no message. */);
12061 Vinput_method_previous_message
= Qnil
;
12063 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12064 doc
: /* If non-nil, the function that implements the display of help.
12065 It's called with one argument, the help string to display. */);
12066 Vshow_help_function
= Qnil
;
12068 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12069 doc
: /* If non-nil, suppress point adjustment after executing a command.
12071 After a command is executed, if point is moved into a region that has
12072 special properties (e.g. composition, display), we adjust point to
12073 the boundary of the region. But, when a command sets this variable to
12074 non-nil, we suppress the point adjustment.
12076 This variable is set to nil before reading a command, and is checked
12077 just after executing the command. */);
12078 Vdisable_point_adjustment
= Qnil
;
12080 DEFVAR_LISP ("global-disable-point-adjustment",
12081 Vglobal_disable_point_adjustment
,
12082 doc
: /* If non-nil, always suppress point adjustment.
12084 The default value is nil, in which case, point adjustment are
12085 suppressed only after special commands that set
12086 `disable-point-adjustment' (which see) to non-nil. */);
12087 Vglobal_disable_point_adjustment
= Qnil
;
12089 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12090 doc
: /* How long to display an echo-area message when the minibuffer is active.
12091 If the value is not a number, such messages don't time out. */);
12092 Vminibuffer_message_timeout
= make_number (2);
12094 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12095 doc
: /* If non-nil, any keyboard input throws to this symbol.
12096 The value of that variable is passed to `quit-flag' and later causes a
12097 peculiar kind of quitting. */);
12098 Vthrow_on_input
= Qnil
;
12100 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12101 doc
: /* If non-nil, function to output error messages.
12102 The arguments are the error data, a list of the form
12103 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12104 such as just as `condition-case' would bind its variable to,
12105 the context (a string which normally goes at the start of the message),
12106 and the Lisp function within which the error was signaled. */);
12107 Vcommand_error_function
= Qnil
;
12109 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12110 Venable_disabled_menus_and_buttons
,
12111 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12113 Help functions bind this to allow help on disabled menu items
12114 and tool-bar buttons. */);
12115 Venable_disabled_menus_and_buttons
= Qnil
;
12117 DEFVAR_LISP ("select-active-regions",
12118 Vselect_active_regions
,
12119 doc
: /* If non-nil, an active region automatically sets the primary selection.
12120 If the value is `only', only temporarily active regions (usually made
12121 by mouse-dragging or shift-selection) set the window selection.
12123 This takes effect only when Transient Mark mode is enabled. */);
12124 Vselect_active_regions
= Qt
;
12126 DEFVAR_LISP ("saved-region-selection",
12127 Vsaved_region_selection
,
12128 doc
: /* Contents of active region prior to buffer modification.
12129 If `select-active-regions' is non-nil, Emacs sets this to the
12130 text in the region before modifying the buffer. The next
12131 `deactivate-mark' call uses this to set the window selection. */);
12132 Vsaved_region_selection
= Qnil
;
12134 DEFVAR_LISP ("selection-inhibit-update-commands",
12135 Vselection_inhibit_update_commands
,
12136 doc
: /* List of commands which should not update the selection.
12137 Normally, if `select-active-regions' is non-nil and the mark remains
12138 active after a command (i.e. the mark was not deactivated), the Emacs
12139 command loop sets the selection to the text in the region. However,
12140 if the command is in this list, the selection is not updated. */);
12141 Vselection_inhibit_update_commands
12142 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12144 DEFVAR_LISP ("debug-on-event",
12146 doc
: /* Enter debugger on this event. When Emacs
12147 receives the special event specified by this variable, it will try to
12148 break into the debugger as soon as possible instead of processing the
12149 event normally through `special-event-map'.
12151 Currently, the only supported values for this
12152 variable are `sigusr1' and `sigusr2'. */);
12153 Vdebug_on_event
= intern_c_string ("sigusr2");
12155 /* Create the initial keyboard. */
12156 initial_kboard
= xmalloc (sizeof *initial_kboard
);
12157 init_kboard (initial_kboard
);
12158 /* Vwindow_system is left at t for now. */
12159 initial_kboard
->next_kboard
= all_kboards
;
12160 all_kboards
= initial_kboard
;
12164 keys_of_keyboard (void)
12166 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12167 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12168 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12169 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12170 initial_define_key (meta_map
, 'x', "execute-extended-command");
12172 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12173 "handle-delete-frame");
12174 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12175 "ns-put-working-text");
12176 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12177 "ns-unput-working-text");
12178 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12179 current-prefix-arg, as is done in `handle-switch-frame'.
12180 But `handle-switch-frame is not run from the special-map.
12181 Commands from that map are run in a special way that automatically
12182 preserves the prefix-arg. Restoring the prefix arg here is not just
12183 redundant but harmful:
12185 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12186 - after the first prompt, the exit-minibuffer-hook is run which may
12187 iconify a frame and thus push a `iconify-frame' event.
12188 - after running exit-minibuffer-hook, current-prefix-arg is
12189 restored to the non-nil value it had before the prompt.
12190 - we enter the second prompt.
12191 current-prefix-arg is non-nil, prefix-arg is nil.
12192 - before running the first real event, we run the special iconify-frame
12193 event, but we pass the `special' arg to execute-command so
12194 current-prefix-arg and prefix-arg are left untouched.
12195 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12196 - the next key event will have a spuriously non-nil current-prefix-arg. */
12197 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12199 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12201 /* Handling it at such a low-level causes read_key_sequence to get
12202 * confused because it doesn't realize that the current_buffer was
12203 * changed by read_char.
12205 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12206 * "handle-select-window"); */
12207 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12208 "handle-save-session");
12211 /* Define a special event which is raised for dbus callback
12213 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12214 "dbus-handle-event");
12217 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12219 #if defined (WINDOWSNT)
12220 initial_define_lispy_key (Vspecial_event_map
, "language-change",
12225 /* Mark the pointers in the kboard objects.
12226 Called by Fgarbage_collect. */
12228 mark_kboards (void)
12232 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12234 if (kb
->kbd_macro_buffer
)
12235 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12237 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12238 mark_object (KVAR (kb
, Vlast_command
));
12239 mark_object (KVAR (kb
, Vreal_last_command
));
12240 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12241 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12242 mark_object (KVAR (kb
, Vprefix_arg
));
12243 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12244 mark_object (KVAR (kb
, kbd_queue
));
12245 mark_object (KVAR (kb
, defining_kbd_macro
));
12246 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12247 mark_object (KVAR (kb
, Vsystem_key_alist
));
12248 mark_object (KVAR (kb
, system_key_syms
));
12249 mark_object (KVAR (kb
, Vwindow_system
));
12250 mark_object (KVAR (kb
, Vinput_decode_map
));
12251 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12252 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12253 mark_object (KVAR (kb
, echo_string
));
12256 struct input_event
*event
;
12257 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12259 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12260 event
= kbd_buffer
;
12261 if (event
->kind
!= SELECTION_REQUEST_EVENT
12262 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12264 mark_object (event
->x
);
12265 mark_object (event
->y
);
12267 mark_object (event
->frame_or_window
);
12268 mark_object (event
->arg
);