1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2014 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/>. */
29 #include "termhooks.h"
34 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
55 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #if defined USABLE_FIONREAD && defined USG5_4
59 # include <sys/filio.h>
62 #include "syssignal.h"
64 #include <sys/types.h>
68 #ifdef HAVE_WINDOW_SYSTEM
70 #endif /* HAVE_WINDOW_SYSTEM */
72 /* Variables for blockinput.h: */
74 /* Positive if interrupt input is blocked right now. */
75 volatile int interrupt_input_blocked
;
77 /* True means an input interrupt or alarm signal has arrived.
78 The QUIT macro checks this. */
79 volatile bool pending_signals
;
81 #define KBD_BUFFER_SIZE 4096
83 KBOARD
*initial_kboard
;
84 KBOARD
*current_kboard
;
85 static KBOARD
*all_kboards
;
87 /* True in the single-kboard state, false in the any-kboard state. */
88 static bool single_kboard
;
90 /* Non-nil disable property on a command means
91 do not execute it; call disabled-command-function's value instead. */
92 Lisp_Object Qdisabled
;
93 static Lisp_Object Qdisabled_command_function
;
95 #define NUM_RECENT_KEYS (300)
97 /* Index for storing next element into recent_keys. */
98 static int recent_keys_index
;
100 /* Total number of elements stored into recent_keys. */
101 static int total_keys
;
103 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
104 static Lisp_Object recent_keys
;
106 /* Vector holding the key sequence that invoked the current command.
107 It is reused for each command, and it may be longer than the current
108 sequence; this_command_key_count indicates how many elements
109 actually mean something.
110 It's easier to staticpro a single Lisp_Object than an array. */
111 Lisp_Object this_command_keys
;
112 ptrdiff_t this_command_key_count
;
114 /* True after calling Freset_this_command_lengths.
115 Usually it is false. */
116 static bool this_command_key_count_reset
;
118 /* This vector is used as a buffer to record the events that were actually read
119 by read_key_sequence. */
120 static Lisp_Object raw_keybuf
;
121 static int raw_keybuf_count
;
123 #define GROW_RAW_KEYBUF \
124 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
125 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
127 /* Number of elements of this_command_keys
128 that precede this key sequence. */
129 static ptrdiff_t this_single_command_key_start
;
131 /* Record values of this_command_key_count and echo_length ()
132 before this command was read. */
133 static ptrdiff_t before_command_key_count
;
134 static ptrdiff_t before_command_echo_length
;
136 /* For longjmp to where kbd input is being done. */
138 static sys_jmp_buf getcjmp
;
140 /* True while doing kbd input. */
141 bool waiting_for_input
;
143 /* True while displaying for echoing. Delays C-g throwing. */
147 /* Non-null means we can start echoing at the next input pause even
148 though there is something in the echo area. */
150 static struct kboard
*ok_to_echo_at_next_pause
;
152 /* The kboard last echoing, or null for none. Reset to 0 in
153 cancel_echoing. If non-null, and a current echo area message
154 exists, and echo_message_buffer is eq to the current message
155 buffer, we know that the message comes from echo_kboard. */
157 struct kboard
*echo_kboard
;
159 /* The buffer used for echoing. Set in echo_now, reset in
162 Lisp_Object echo_message_buffer
;
164 /* True means C-g should cause immediate error-signal. */
167 /* Character that causes a quit. Normally C-g.
169 If we are running on an ordinary terminal, this must be an ordinary
170 ASCII char, since we want to make it our interrupt character.
172 If we are not running on an ordinary terminal, it still needs to be
173 an ordinary ASCII char. This character needs to be recognized in
174 the input interrupt handler. At this point, the keystroke is
175 represented as a struct input_event, while the desired quit
176 character is specified as a lispy event. The mapping from struct
177 input_events to lispy events cannot run in an interrupt handler,
178 and the reverse mapping is difficult for anything but ASCII
181 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
185 /* Current depth in recursive edits. */
186 EMACS_INT command_loop_level
;
188 /* If not Qnil, this is a switch-frame event which we decided to put
189 off until the end of a key sequence. This should be read as the
190 next command input, after any unread_command_events.
192 read_key_sequence uses this to delay switch-frame events until the
193 end of the key sequence; Fread_char uses it to put off switch-frame
194 events until a non-ASCII event is acceptable as input. */
195 Lisp_Object unread_switch_frame
;
197 /* Last size recorded for a current buffer which is not a minibuffer. */
198 static ptrdiff_t last_non_minibuf_size
;
200 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
201 uintmax_t num_input_events
;
203 /* Value of num_nonmacro_input_events as of last auto save. */
205 static EMACS_INT last_auto_save
;
207 /* The value of point when the last command was started. */
208 static ptrdiff_t last_point_position
;
210 /* The frame in which the last input event occurred, or Qmacro if the
211 last event came from a macro. We use this to determine when to
212 generate switch-frame events. This may be cleared by functions
213 like Fselect_frame, to make sure that a switch-frame event is
214 generated by the next character.
216 FIXME: This is modified by a signal handler so it should be volatile.
217 It's exported to Lisp, though, so it can't simply be marked
219 Lisp_Object internal_last_event_frame
;
221 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
222 static Lisp_Object Qhandle_select_window
;
223 Lisp_Object QPRIMARY
;
225 static Lisp_Object Qself_insert_command
;
226 static Lisp_Object Qforward_char
;
227 static Lisp_Object Qbackward_char
;
228 Lisp_Object Qundefined
;
229 static Lisp_Object Qtimer_event_handler
;
231 /* `read_key_sequence' stores here the command definition of the
232 key sequence that it reads. */
233 static Lisp_Object read_key_sequence_cmd
;
234 static Lisp_Object read_key_sequence_remapped
;
236 static Lisp_Object Qinput_method_function
;
238 static Lisp_Object Qdeactivate_mark
;
240 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
242 static Lisp_Object Qecho_area_clear_hook
;
244 /* Hooks to run before and after each command. */
245 static Lisp_Object Qpre_command_hook
;
246 static Lisp_Object Qpost_command_hook
;
248 static Lisp_Object Qdeferred_action_function
;
250 static Lisp_Object Qdelayed_warnings_hook
;
252 static Lisp_Object Qinput_method_exit_on_first_char
;
253 static Lisp_Object Qinput_method_use_echo_area
;
255 static Lisp_Object Qhelp_form_show
;
257 /* File in which we write all commands we read. */
258 static FILE *dribble
;
260 /* Nonzero if input is available. */
263 /* Circular buffer for pre-read keyboard input. */
265 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
267 /* Pointer to next available character in kbd_buffer.
268 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
269 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
270 next available char is in kbd_buffer[0]. */
271 static struct input_event
*kbd_fetch_ptr
;
273 /* Pointer to next place to store character in kbd_buffer. This
274 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
275 character should go in kbd_buffer[0]. */
276 static struct input_event
* volatile kbd_store_ptr
;
278 /* The above pair of variables forms a "queue empty" flag. When we
279 enqueue a non-hook event, we increment kbd_store_ptr. When we
280 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
281 there is input available if the two pointers are not equal.
283 Why not just have a flag set and cleared by the enqueuing and
284 dequeuing functions? Such a flag could be screwed up by interrupts
285 at inopportune times. */
287 /* Symbols to head events. */
288 static Lisp_Object Qmouse_movement
;
289 static Lisp_Object Qscroll_bar_movement
;
290 Lisp_Object Qswitch_frame
;
291 static Lisp_Object Qfocus_in
, Qfocus_out
;
292 static Lisp_Object Qdelete_frame
;
293 static Lisp_Object Qiconify_frame
;
294 static Lisp_Object Qmake_frame_visible
;
295 static Lisp_Object Qselect_window
;
296 Lisp_Object Qhelp_echo
;
298 static Lisp_Object Qmouse_fixup_help_message
;
300 /* Symbols to denote kinds of events. */
301 static Lisp_Object Qfunction_key
;
302 Lisp_Object Qmouse_click
;
304 Lisp_Object Qlanguage_change
;
306 static Lisp_Object Qdrag_n_drop
;
307 static Lisp_Object Qsave_session
;
309 static Lisp_Object Qdbus_event
;
311 #ifdef USE_FILE_NOTIFY
312 static Lisp_Object Qfile_notify
;
313 #endif /* USE_FILE_NOTIFY */
314 static Lisp_Object Qconfig_changed_event
;
316 /* Lisp_Object Qmouse_movement; - also an event header */
318 /* Properties of event headers. */
319 Lisp_Object Qevent_kind
;
320 static Lisp_Object Qevent_symbol_elements
;
322 /* Menu and tool bar item parts. */
323 static Lisp_Object Qmenu_enable
;
324 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
325 Lisp_Object QCfilter
;
327 /* Non-nil disable property on a command means
328 do not execute it; call disabled-command-function's value instead. */
329 Lisp_Object QCtoggle
, QCradio
;
330 static Lisp_Object QCbutton
, QClabel
;
332 static Lisp_Object QCvert_only
;
334 /* An event header symbol HEAD may have a property named
335 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
336 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
337 mask of modifiers applied to it. If present, this is used to help
338 speed up parse_modifiers. */
339 Lisp_Object Qevent_symbol_element_mask
;
341 /* An unmodified event header BASE may have a property named
342 Qmodifier_cache, which is an alist mapping modifier masks onto
343 modified versions of BASE. If present, this helps speed up
345 static Lisp_Object Qmodifier_cache
;
347 /* Symbols to use for parts of windows. */
348 Lisp_Object Qmode_line
;
349 Lisp_Object Qvertical_line
;
350 Lisp_Object Qright_divider
, Qbottom_divider
;
351 Lisp_Object Qmenu_bar
;
353 static Lisp_Object Qecho_keystrokes
;
355 static void recursive_edit_unwind (Lisp_Object buffer
);
356 static Lisp_Object
command_loop (void);
357 static Lisp_Object Qcommand_execute
;
359 static void echo_now (void);
360 static ptrdiff_t echo_length (void);
362 static Lisp_Object Qpolling_period
;
364 /* Incremented whenever a timer is run. */
367 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
369 struct timespec
*input_available_clear_time
;
371 /* True means use SIGIO interrupts; false means use CBREAK mode.
372 Default is true if INTERRUPT_INPUT is defined. */
373 bool interrupt_input
;
375 /* Nonzero while interrupts are temporarily deferred during redisplay. */
376 bool interrupts_deferred
;
378 /* The time when Emacs started being idle. */
380 static struct timespec timer_idleness_start_time
;
382 /* After Emacs stops being idle, this saves the last value
383 of timer_idleness_start_time from when it was idle. */
385 static struct timespec timer_last_idleness_start_time
;
388 /* Global variable declarations. */
390 /* Flags for readable_events. */
391 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
392 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
393 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
395 /* Function for init_keyboard to call with no args (if nonzero). */
396 static void (*keyboard_init_hook
) (void);
398 static bool get_input_pending (int);
399 static bool readable_events (int);
400 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
401 Lisp_Object
, bool *);
402 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
403 static Lisp_Object
make_lispy_event (struct input_event
*);
404 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
405 enum scroll_bar_part
,
406 Lisp_Object
, Lisp_Object
,
408 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
409 Lisp_Object
, const char *const *,
410 Lisp_Object
*, ptrdiff_t);
411 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
412 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
413 #ifdef HAVE_WINDOW_SYSTEM
414 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
415 #endif /* HAVE_WINDOW_SYSTEM */
416 static bool help_char_p (Lisp_Object
);
417 static void save_getcjmp (sys_jmp_buf
);
418 static void restore_getcjmp (sys_jmp_buf
);
419 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
420 static void clear_event (struct input_event
*);
421 static void restore_kboard_configuration (int);
423 static void deliver_input_available_signal (int signo
);
425 static void handle_interrupt (bool);
426 static _Noreturn
void quit_throw_to_read_char (bool);
427 static void process_special_events (void);
428 static void timer_start_idle (void);
429 static void timer_stop_idle (void);
430 static void timer_resume_idle (void);
431 static void deliver_user_signal (int);
432 static char *find_user_signal_name (int);
433 static void store_user_signal_events (void);
435 /* These setters are used only in this file, so they can be private. */
437 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
439 kb
->INTERNAL_FIELD (echo_string
) = val
;
442 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
444 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
447 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
449 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
452 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
454 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
457 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
459 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
462 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
464 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
467 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
469 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
472 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
474 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
477 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
479 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
483 /* Add C to the echo string, without echoing it immediately. C can be
484 a character, which is pretty-printed, or a symbol, whose name is
488 echo_add_key (Lisp_Object c
)
490 int size
= KEY_DESCRIPTION_SIZE
+ 100;
491 char *buffer
= alloca (size
);
493 Lisp_Object echo_string
;
495 echo_string
= KVAR (current_kboard
, echo_string
);
497 /* If someone has passed us a composite event, use its head symbol. */
501 ptr
= push_key_description (XINT (c
), ptr
);
502 else if (SYMBOLP (c
))
504 Lisp_Object name
= SYMBOL_NAME (c
);
505 int nbytes
= SBYTES (name
);
507 if (size
- (ptr
- buffer
) < nbytes
)
509 int offset
= ptr
- buffer
;
510 size
= max (2 * size
, size
+ nbytes
);
511 buffer
= alloca (size
);
512 ptr
= buffer
+ offset
;
515 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
516 STRING_MULTIBYTE (name
), 1);
519 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
522 const char *text
= " (Type ? for further options)";
523 int len
= strlen (text
);
525 if (size
- (ptr
- buffer
) < len
)
527 int offset
= ptr
- buffer
;
529 buffer
= alloca (size
);
530 ptr
= buffer
+ offset
;
533 memcpy (ptr
, text
, len
);
537 /* Replace a dash from echo_dash with a space, otherwise add a space
538 at the end as a separator between keys. */
539 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
541 Lisp_Object last_char
, prev_char
, idx
;
543 idx
= make_number (SCHARS (echo_string
) - 2);
544 prev_char
= Faref (echo_string
, idx
);
546 idx
= make_number (SCHARS (echo_string
) - 1);
547 last_char
= Faref (echo_string
, idx
);
549 /* We test PREV_CHAR to make sure this isn't the echoing of a
551 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
552 Faset (echo_string
, idx
, make_number (' '));
554 echo_string
= concat2 (echo_string
, build_string (" "));
556 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
557 echo_string
= concat2 (echo_string
, build_string (" "));
561 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
564 /* Add C to the echo string, if echoing is going on. C can be a
565 character or a symbol. */
568 echo_char (Lisp_Object c
)
570 if (current_kboard
->immediate_echo
)
577 /* Temporarily add a dash to the end of the echo string if it's not
578 empty, so that it serves as a mini-prompt for the very next
584 /* Do nothing if not echoing at all. */
585 if (NILP (KVAR (current_kboard
, echo_string
)))
588 if (this_command_key_count
== 0)
591 if (!current_kboard
->immediate_echo
592 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
595 /* Do nothing if we just printed a prompt. */
596 if (current_kboard
->echo_after_prompt
597 == SCHARS (KVAR (current_kboard
, echo_string
)))
600 /* Do nothing if we have already put a dash at the end. */
601 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
603 Lisp_Object last_char
, prev_char
, idx
;
605 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
606 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
608 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
609 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
611 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
615 /* Put a dash at the end of the buffer temporarily,
616 but make it go away when the next character is added. */
619 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
623 /* Display the current echo string, and begin echoing if not already
629 if (!current_kboard
->immediate_echo
)
632 current_kboard
->immediate_echo
= 1;
634 for (i
= 0; i
< this_command_key_count
; i
++)
638 /* Set before_command_echo_length to the value that would
639 have been saved before the start of this subcommand in
640 command_loop_1, if we had already been echoing then. */
641 if (i
== this_single_command_key_start
)
642 before_command_echo_length
= echo_length ();
644 c
= AREF (this_command_keys
, i
);
645 if (! (EVENT_HAS_PARAMETERS (c
)
646 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
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 (this_command_key_count
== this_single_command_key_start
)
654 before_command_echo_length
= echo_length ();
656 /* Put a dash at the end to invite the user to type more. */
661 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
662 message3_nolog (KVAR (current_kboard
, echo_string
));
665 /* Record in what buffer we echoed, and from which kboard. */
666 echo_message_buffer
= echo_area_buffer
[0];
667 echo_kboard
= current_kboard
;
669 if (waiting_for_input
&& !NILP (Vquit_flag
))
670 quit_throw_to_read_char (0);
673 /* Turn off echoing, for the start of a new command. */
676 cancel_echoing (void)
678 current_kboard
->immediate_echo
= 0;
679 current_kboard
->echo_after_prompt
= -1;
680 kset_echo_string (current_kboard
, Qnil
);
681 ok_to_echo_at_next_pause
= NULL
;
683 echo_message_buffer
= Qnil
;
686 /* Return the length of the current echo string. */
691 return (STRINGP (KVAR (current_kboard
, echo_string
))
692 ? SCHARS (KVAR (current_kboard
, echo_string
))
696 /* Truncate the current echo message to its first LEN chars.
697 This and echo_char get used by read_key_sequence when the user
698 switches frames while entering a key sequence. */
701 echo_truncate (ptrdiff_t nchars
)
703 if (STRINGP (KVAR (current_kboard
, echo_string
)))
704 kset_echo_string (current_kboard
,
705 Fsubstring (KVAR (current_kboard
, echo_string
),
706 make_number (0), make_number (nchars
)));
707 truncate_echo_area (nchars
);
711 /* Functions for manipulating this_command_keys. */
713 add_command_key (Lisp_Object key
)
715 #if 0 /* Not needed after we made Freset_this_command_lengths
716 do the job immediately. */
717 /* If reset-this-command-length was called recently, obey it now.
718 See the doc string of that function for an explanation of why. */
719 if (before_command_restore_flag
)
721 this_command_key_count
= before_command_key_count_1
;
722 if (this_command_key_count
< this_single_command_key_start
)
723 this_single_command_key_start
= this_command_key_count
;
724 echo_truncate (before_command_echo_length_1
);
725 before_command_restore_flag
= 0;
729 if (this_command_key_count
>= ASIZE (this_command_keys
))
730 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
732 ASET (this_command_keys
, this_command_key_count
, key
);
733 ++this_command_key_count
;
738 recursive_edit_1 (void)
740 ptrdiff_t count
= SPECPDL_INDEX ();
743 if (command_loop_level
> 0)
745 specbind (Qstandard_output
, Qt
);
746 specbind (Qstandard_input
, Qt
);
749 #ifdef HAVE_WINDOW_SYSTEM
750 /* The command loop has started an hourglass timer, so we have to
751 cancel it here, otherwise it will fire because the recursive edit
752 can take some time. Do not check for display_hourglass_p here,
753 because it could already be nil. */
757 /* This function may have been called from a debugger called from
758 within redisplay, for instance by Edebugging a function called
759 from fontification-functions. We want to allow redisplay in
760 the debugging session.
762 The recursive edit is left with a `(throw exit ...)'. The `exit'
763 tag is not caught anywhere in redisplay, i.e. when we leave the
764 recursive edit, the original redisplay leading to the recursive
765 edit will be unwound. The outcome should therefore be safe. */
766 specbind (Qinhibit_redisplay
, Qnil
);
769 val
= command_loop ();
771 Fsignal (Qquit
, Qnil
);
772 /* Handle throw from read_minibuf when using minibuffer
773 while it's active but we're in another window. */
775 xsignal1 (Qerror
, val
);
777 return unbind_to (count
, Qnil
);
780 /* When an auto-save happens, record the "time", and don't do again soon. */
783 record_auto_save (void)
785 last_auto_save
= num_nonmacro_input_events
;
788 /* Make an auto save happen as soon as possible at command level. */
792 force_auto_save_soon (void)
794 last_auto_save
= - auto_save_interval
- 1;
796 record_asynch_buffer_change ();
800 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
801 doc
: /* Invoke the editor command loop recursively.
802 To get out of the recursive edit, a command can throw to `exit' -- for
803 instance `(throw 'exit nil)'.
804 If you throw a value other than t, `recursive-edit' returns normally
805 to the function that called it. Throwing a t value causes
806 `recursive-edit' to quit, so that control returns to the command loop
809 This function is called by the editor initialization to begin editing. */)
812 ptrdiff_t count
= SPECPDL_INDEX ();
815 /* If we enter while input is blocked, don't lock up here.
816 This may happen through the debugger during redisplay. */
817 if (input_blocked_p ())
820 if (command_loop_level
>= 0
821 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
822 buffer
= Fcurrent_buffer ();
826 /* Don't do anything interesting between the increment and the
827 record_unwind_protect! Otherwise, we could get distracted and
828 never decrement the counter again. */
829 command_loop_level
++;
830 update_mode_lines
= 17;
831 record_unwind_protect (recursive_edit_unwind
, buffer
);
833 /* If we leave recursive_edit_1 below with a `throw' for instance,
834 like it is done in the splash screen display, we have to
835 make sure that we restore single_kboard as command_loop_1
836 would have done if it were left normally. */
837 if (command_loop_level
> 0)
838 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
841 return unbind_to (count
, Qnil
);
845 recursive_edit_unwind (Lisp_Object buffer
)
847 if (BUFFERP (buffer
))
848 Fset_buffer (buffer
);
850 command_loop_level
--;
851 update_mode_lines
= 18;
855 #if 0 /* These two functions are now replaced with
856 temporarily_switch_to_single_kboard. */
860 #if 0 /* Theory: if there's anything in Vunread_command_events,
861 it will right away be read by read_key_sequence,
862 and then if we do switch KBOARDS, it will go into the side
863 queue then. So we don't need to do anything special here -- rms. */
864 if (CONSP (Vunread_command_events
))
866 current_kboard
->kbd_queue
867 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
868 current_kboard
->kbd_queue_has_data
= 1;
870 Vunread_command_events
= Qnil
;
875 /* Switch to the single-kboard state, making current_kboard
876 the only KBOARD from which further input is accepted. */
879 single_kboard_state ()
885 /* If we're in single_kboard state for kboard KBOARD,
889 not_single_kboard_state (KBOARD
*kboard
)
891 if (kboard
== current_kboard
)
895 /* Maintain a stack of kboards, so other parts of Emacs
896 can switch temporarily to the kboard of a given frame
897 and then revert to the previous status. */
902 struct kboard_stack
*next
;
905 static struct kboard_stack
*kboard_stack
;
908 push_kboard (struct kboard
*k
)
910 struct kboard_stack
*p
= xmalloc (sizeof *p
);
912 p
->next
= kboard_stack
;
913 p
->kboard
= current_kboard
;
923 struct kboard_stack
*p
= kboard_stack
;
925 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
927 if (t
->kboard
== p
->kboard
)
929 current_kboard
= p
->kboard
;
936 /* The terminal we remembered has been deleted. */
937 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
940 kboard_stack
= p
->next
;
944 /* Switch to single_kboard mode, making current_kboard the only KBOARD
945 from which further input is accepted. If F is non-nil, set its
946 KBOARD as the current keyboard.
948 This function uses record_unwind_protect_int to return to the previous
951 If Emacs is already in single_kboard mode, and F's keyboard is
952 locked, then this function will throw an error. */
955 temporarily_switch_to_single_kboard (struct frame
*f
)
957 bool was_locked
= single_kboard
;
960 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
961 /* We can not switch keyboards while in single_kboard mode.
962 In rare cases, Lisp code may call `recursive-edit' (or
963 `read-minibuffer' or `y-or-n-p') after it switched to a
964 locked frame. For example, this is likely to happen
965 when server.el connects to a new terminal while Emacs is in
966 single_kboard mode. It is best to throw an error instead
967 of presenting the user with a frozen screen. */
968 error ("Terminal %d is locked, cannot read from it",
969 FRAME_TERMINAL (f
)->id
);
971 /* This call is unnecessary, but helps
972 `restore_kboard_configuration' discover if somebody changed
973 `current_kboard' behind our back. */
974 push_kboard (current_kboard
);
977 current_kboard
= FRAME_KBOARD (f
);
979 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
982 #if 0 /* This function is not needed anymore. */
984 record_single_kboard_state ()
987 push_kboard (current_kboard
);
988 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
993 restore_kboard_configuration (int was_locked
)
995 single_kboard
= was_locked
;
998 struct kboard
*prev
= current_kboard
;
1000 /* The pop should not change the kboard. */
1001 if (single_kboard
&& current_kboard
!= prev
)
1007 /* Handle errors that are not handled at inner levels
1008 by printing an error message and returning to the editor command loop. */
1011 cmd_error (Lisp_Object data
)
1013 Lisp_Object old_level
, old_length
;
1014 char macroerror
[sizeof "After..kbd macro iterations: "
1015 + INT_STRLEN_BOUND (EMACS_INT
)];
1017 #ifdef HAVE_WINDOW_SYSTEM
1018 if (display_hourglass_p
)
1019 cancel_hourglass ();
1022 if (!NILP (executing_kbd_macro
))
1024 if (executing_kbd_macro_iterations
== 1)
1025 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1027 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1028 executing_kbd_macro_iterations
);
1033 Vstandard_output
= Qt
;
1034 Vstandard_input
= Qt
;
1035 Vexecuting_kbd_macro
= Qnil
;
1036 executing_kbd_macro
= Qnil
;
1037 kset_prefix_arg (current_kboard
, Qnil
);
1038 kset_last_prefix_arg (current_kboard
, Qnil
);
1041 /* Avoid unquittable loop if data contains a circular list. */
1042 old_level
= Vprint_level
;
1043 old_length
= Vprint_length
;
1044 XSETFASTINT (Vprint_level
, 10);
1045 XSETFASTINT (Vprint_length
, 10);
1046 cmd_error_internal (data
, macroerror
);
1047 Vprint_level
= old_level
;
1048 Vprint_length
= old_length
;
1051 Vinhibit_quit
= Qnil
;
1053 return make_number (0);
1056 /* Take actions on handling an error. DATA is the data that describes
1059 CONTEXT is a C-string containing ASCII characters only which
1060 describes the context in which the error happened. If we need to
1061 generalize CONTEXT to allow multibyte characters, make it a Lisp
1065 cmd_error_internal (Lisp_Object data
, const char *context
)
1067 /* The immediate context is not interesting for Quits,
1068 since they are asynchronous. */
1069 if (EQ (XCAR (data
), Qquit
))
1070 Vsignaling_function
= Qnil
;
1075 /* Use user's specified output function if any. */
1076 if (!NILP (Vcommand_error_function
))
1077 call3 (Vcommand_error_function
, data
,
1078 context
? build_string (context
) : empty_unibyte_string
,
1079 Vsignaling_function
);
1081 Vsignaling_function
= Qnil
;
1084 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1085 Scommand_error_default_function
, 3, 3, 0,
1086 doc
: /* Produce default output for unhandled error message.
1087 Default value of `command-error-function'. */)
1088 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1090 struct frame
*sf
= SELECTED_FRAME ();
1092 CHECK_STRING (context
);
1094 /* If the window system or terminal frame hasn't been initialized
1095 yet, or we're not interactive, write the message to stderr and exit. */
1096 if (!sf
->glyphs_initialized_p
1097 /* The initial frame is a special non-displaying frame. It
1098 will be current in daemon mode when there are no frames
1099 to display, and in non-daemon mode before the real frame
1100 has finished initializing. If an error is thrown in the
1101 latter case while creating the frame, then the frame
1102 will never be displayed, so the safest thing to do is
1103 write to stderr and quit. In daemon mode, there are
1104 many other potential errors that do not prevent frames
1105 from being created, so continuing as normal is better in
1107 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1110 print_error_message (data
, Qexternal_debugging_output
,
1111 SSDATA (context
), signal
);
1112 Fterpri (Qexternal_debugging_output
);
1113 Fkill_emacs (make_number (-1));
1117 clear_message (1, 0);
1119 message_log_maybe_newline ();
1122 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1127 static Lisp_Object
command_loop_2 (Lisp_Object
);
1128 static Lisp_Object
top_level_1 (Lisp_Object
);
1130 /* Entry to editor-command-loop.
1131 This level has the catches for exiting/returning to editor command loop.
1132 It returns nil to exit recursive edit, t to abort it. */
1137 if (command_loop_level
> 0 || minibuf_level
> 0)
1140 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1141 executing_kbd_macro
= Qnil
;
1147 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1148 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1149 executing_kbd_macro
= Qnil
;
1151 /* End of file in -batch run causes exit here. */
1157 /* Here we catch errors in execution of commands within the
1158 editing loop, and reenter the editing loop.
1159 When there is an error, cmd_error runs and returns a non-nil
1160 value to us. A value of nil means that command_loop_1 itself
1161 returned due to end of file (or end of kbd macro). */
1164 command_loop_2 (Lisp_Object ignore
)
1166 register Lisp_Object val
;
1169 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1170 while (!NILP (val
));
1178 return Feval (Vtop_level
, Qnil
);
1182 top_level_1 (Lisp_Object ignore
)
1184 /* On entry to the outer level, run the startup file. */
1185 if (!NILP (Vtop_level
))
1186 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1187 else if (!NILP (Vpurify_flag
))
1188 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1190 message1 ("Bare Emacs (standard Lisp code not loaded)");
1194 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1195 doc
: /* Exit all recursive editing levels.
1196 This also exits all active minibuffers. */)
1199 #ifdef HAVE_WINDOW_SYSTEM
1200 if (display_hourglass_p
)
1201 cancel_hourglass ();
1204 /* Unblock input if we enter with input blocked. This may happen if
1205 redisplay traps e.g. during tool-bar update with input blocked. */
1206 totally_unblock_input ();
1208 Fthrow (Qtop_level
, Qnil
);
1211 static _Noreturn
void
1212 user_error (const char *msg
)
1214 xsignal1 (Quser_error
, build_string (msg
));
1217 /* _Noreturn will be added to prototype by make-docfile. */
1218 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1219 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1222 if (command_loop_level
> 0 || minibuf_level
> 0)
1223 Fthrow (Qexit
, Qnil
);
1225 user_error ("No recursive edit is in progress");
1228 /* _Noreturn will be added to prototype by make-docfile. */
1229 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1230 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1233 if (command_loop_level
> 0 || minibuf_level
> 0)
1236 user_error ("No recursive edit is in progress");
1239 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1240 of this function. */
1243 tracking_off (Lisp_Object old_value
)
1245 do_mouse_tracking
= old_value
;
1246 if (NILP (old_value
))
1248 /* Redisplay may have been preempted because there was input
1249 available, and it assumes it will be called again after the
1250 input has been processed. If the only input available was
1251 the sort that we have just disabled, then we need to call
1253 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1255 redisplay_preserve_echo_area (6);
1256 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1261 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1262 doc
: /* Evaluate BODY with mouse movement events enabled.
1263 Within a `track-mouse' form, mouse motion generates input events that
1264 you can read with `read-event'.
1265 Normally, mouse motion is ignored.
1266 usage: (track-mouse BODY...) */)
1269 ptrdiff_t count
= SPECPDL_INDEX ();
1272 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1274 do_mouse_tracking
= Qt
;
1276 val
= Fprogn (args
);
1277 return unbind_to (count
, val
);
1280 /* If mouse has moved on some frame, return one of those frames.
1284 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1285 after resizing the tool-bar window. */
1287 bool ignore_mouse_drag_p
;
1289 static struct frame
*
1290 some_mouse_moved (void)
1292 Lisp_Object tail
, frame
;
1294 if (ignore_mouse_drag_p
)
1296 /* ignore_mouse_drag_p = 0; */
1300 FOR_EACH_FRAME (tail
, frame
)
1302 if (XFRAME (frame
)->mouse_moved
)
1303 return XFRAME (frame
);
1310 /* This is the actual command reading loop,
1311 sans error-handling encapsulation. */
1313 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1314 bool, bool, bool, bool);
1315 static void adjust_point_for_property (ptrdiff_t, bool);
1317 /* The last boundary auto-added to buffer-undo-list. */
1318 Lisp_Object last_undo_boundary
;
1320 /* FIXME: This is wrong rather than test window-system, we should call
1321 a new set-selection, which will then dispatch to x-set-selection, or
1322 tty-set-selection, or w32-set-selection, ... */
1325 command_loop_1 (void)
1328 Lisp_Object keybuf
[30];
1330 EMACS_INT prev_modiff
= 0;
1331 struct buffer
*prev_buffer
= NULL
;
1332 bool already_adjusted
= 0;
1334 kset_prefix_arg (current_kboard
, Qnil
);
1335 kset_last_prefix_arg (current_kboard
, Qnil
);
1336 Vdeactivate_mark
= Qnil
;
1337 waiting_for_input
= 0;
1340 this_command_key_count
= 0;
1341 this_command_key_count_reset
= 0;
1342 this_single_command_key_start
= 0;
1344 if (NILP (Vmemory_full
))
1346 /* Make sure this hook runs after commands that get errors and
1347 throw to top level. */
1348 /* Note that the value cell will never directly contain nil
1349 if the symbol is a local variable. */
1350 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1351 safe_run_hooks (Qpost_command_hook
);
1353 /* If displaying a message, resize the echo area window to fit
1354 that message's size exactly. */
1355 if (!NILP (echo_area_buffer
[0]))
1356 resize_echo_area_exactly ();
1358 /* If there are warnings waiting, process them. */
1359 if (!NILP (Vdelayed_warnings_list
))
1360 safe_run_hooks (Qdelayed_warnings_hook
);
1362 if (!NILP (Vdeferred_action_list
))
1363 safe_run_hooks (Qdeferred_action_function
);
1366 /* Do this after running Vpost_command_hook, for consistency. */
1367 kset_last_command (current_kboard
, Vthis_command
);
1368 kset_real_last_command (current_kboard
, Vreal_this_command
);
1369 if (!CONSP (last_command_event
))
1370 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1374 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1377 /* Make sure the current window's buffer is selected. */
1378 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1380 /* Display any malloc warning that just came out. Use while because
1381 displaying one warning can cause another. */
1383 while (pending_malloc_warning
)
1384 display_malloc_warning ();
1386 Vdeactivate_mark
= Qnil
;
1388 /* Don't ignore mouse movements for more than a single command
1389 loop. (This flag is set in xdisp.c whenever the tool bar is
1390 resized, because the resize moves text up or down, and would
1391 generate false mouse drag events if we don't ignore them.) */
1392 ignore_mouse_drag_p
= 0;
1394 /* If minibuffer on and echo area in use,
1395 wait a short time and redraw minibuffer. */
1398 && !NILP (echo_area_buffer
[0])
1399 && EQ (minibuf_window
, echo_area_window
)
1400 && NUMBERP (Vminibuffer_message_timeout
))
1402 /* Bind inhibit-quit to t so that C-g gets read in
1403 rather than quitting back to the minibuffer. */
1404 ptrdiff_t count
= SPECPDL_INDEX ();
1405 specbind (Qinhibit_quit
, Qt
);
1407 sit_for (Vminibuffer_message_timeout
, 0, 2);
1409 /* Clear the echo area. */
1411 safe_run_hooks (Qecho_area_clear_hook
);
1413 unbind_to (count
, Qnil
);
1415 /* If a C-g came in before, treat it as input now. */
1416 if (!NILP (Vquit_flag
))
1419 Vunread_command_events
= list1 (make_number (quit_char
));
1423 /* If it has changed current-menubar from previous value,
1424 really recompute the menubar from the value. */
1425 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1426 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1427 call0 (Qrecompute_lucid_menubar
);
1429 before_command_key_count
= this_command_key_count
;
1430 before_command_echo_length
= echo_length ();
1432 Vthis_command
= Qnil
;
1433 Vreal_this_command
= Qnil
;
1434 Vthis_original_command
= Qnil
;
1435 Vthis_command_keys_shift_translated
= Qnil
;
1437 /* Read next key sequence; i gets its length. */
1438 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1441 /* A filter may have run while we were reading the input. */
1442 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1444 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1448 /* Now we have read a key sequence of length I,
1449 or else I is 0 and we found end of file. */
1451 if (i
== 0) /* End of file -- happens only in */
1452 return Qnil
; /* a kbd macro, at the end. */
1453 /* -1 means read_key_sequence got a menu that was rejected.
1454 Just loop around and read another command. */
1458 this_command_key_count
= 0;
1459 this_command_key_count_reset
= 0;
1460 this_single_command_key_start
= 0;
1464 last_command_event
= keybuf
[i
- 1];
1466 /* If the previous command tried to force a specific window-start,
1467 forget about that, in case this command moves point far away
1468 from that position. But also throw away beg_unchanged and
1469 end_unchanged information in that case, so that redisplay will
1470 update the whole window properly. */
1471 if (XWINDOW (selected_window
)->force_start
)
1474 XWINDOW (selected_window
)->force_start
= 0;
1475 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1476 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1479 cmd
= read_key_sequence_cmd
;
1480 if (!NILP (Vexecuting_kbd_macro
))
1482 if (!NILP (Vquit_flag
))
1484 Vexecuting_kbd_macro
= Qt
;
1485 QUIT
; /* Make some noise. */
1486 /* Will return since macro now empty. */
1490 /* Do redisplay processing after this command except in special
1491 cases identified below. */
1492 prev_buffer
= current_buffer
;
1493 prev_modiff
= MODIFF
;
1494 last_point_position
= PT
;
1496 /* By default, we adjust point to a boundary of a region that
1497 has such a property that should be treated intangible
1498 (e.g. composition, display). But, some commands will set
1499 this variable differently. */
1500 Vdisable_point_adjustment
= Qnil
;
1502 /* Process filters and timers may have messed with deactivate-mark.
1503 reset it before we execute the command. */
1504 Vdeactivate_mark
= Qnil
;
1506 /* Remap command through active keymaps. */
1507 Vthis_original_command
= cmd
;
1508 if (!NILP (read_key_sequence_remapped
))
1509 cmd
= read_key_sequence_remapped
;
1511 /* Execute the command. */
1513 Vthis_command
= cmd
;
1514 Vreal_this_command
= cmd
;
1515 safe_run_hooks (Qpre_command_hook
);
1517 already_adjusted
= 0;
1519 if (NILP (Vthis_command
))
1520 /* nil means key is undefined. */
1524 /* Here for a command that isn't executed directly. */
1526 #ifdef HAVE_WINDOW_SYSTEM
1527 ptrdiff_t scount
= SPECPDL_INDEX ();
1529 if (display_hourglass_p
1530 && NILP (Vexecuting_kbd_macro
))
1532 record_unwind_protect_void (cancel_hourglass
);
1537 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1539 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1542 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1543 ? Qnil
: BVAR (current_buffer
, undo_list
));
1545 call1 (Qcommand_execute
, Vthis_command
);
1547 #ifdef HAVE_WINDOW_SYSTEM
1548 /* Do not check display_hourglass_p here, because
1549 `command-execute' could change it, but we should cancel
1550 hourglass cursor anyway.
1551 But don't cancel the hourglass within a macro
1552 just because a command in the macro finishes. */
1553 if (NILP (Vexecuting_kbd_macro
))
1554 unbind_to (scount
, Qnil
);
1557 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1559 safe_run_hooks (Qpost_command_hook
);
1561 /* If displaying a message, resize the echo area window to fit
1562 that message's size exactly. */
1563 if (!NILP (echo_area_buffer
[0]))
1564 resize_echo_area_exactly ();
1566 /* If there are warnings waiting, process them. */
1567 if (!NILP (Vdelayed_warnings_list
))
1568 safe_run_hooks (Qdelayed_warnings_hook
);
1570 safe_run_hooks (Qdeferred_action_function
);
1572 /* If there is a prefix argument,
1573 1) We don't want Vlast_command to be ``universal-argument''
1574 (that would be dumb), so don't set Vlast_command,
1575 2) we want to leave echoing on so that the prefix will be
1576 echoed as part of this key sequence, so don't call
1578 3) we want to leave this_command_key_count non-zero, so that
1579 read_char will realize that it is re-reading a character, and
1580 not echo it a second time.
1582 If the command didn't actually create a prefix arg,
1583 but is merely a frame event that is transparent to prefix args,
1584 then the above doesn't apply. */
1585 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1586 || CONSP (last_command_event
))
1588 kset_last_command (current_kboard
, Vthis_command
);
1589 kset_real_last_command (current_kboard
, Vreal_this_command
);
1590 if (!CONSP (last_command_event
))
1591 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1593 this_command_key_count
= 0;
1594 this_command_key_count_reset
= 0;
1595 this_single_command_key_start
= 0;
1598 if (!NILP (BVAR (current_buffer
, mark_active
))
1599 && !NILP (Vrun_hooks
))
1601 /* In Emacs 22, setting transient-mark-mode to `only' was a
1602 way of turning it on for just one command. This usage is
1603 obsolete, but support it anyway. */
1604 if (EQ (Vtransient_mark_mode
, Qidentity
))
1605 Vtransient_mark_mode
= Qnil
;
1606 else if (EQ (Vtransient_mark_mode
, Qonly
))
1607 Vtransient_mark_mode
= Qidentity
;
1609 if (!NILP (Vdeactivate_mark
))
1610 /* If `select-active-regions' is non-nil, this call to
1611 `deactivate-mark' also sets the PRIMARY selection. */
1612 call0 (Qdeactivate_mark
);
1615 /* Even if not deactivating the mark, set PRIMARY if
1616 `select-active-regions' is non-nil. */
1617 if (!NILP (Fwindow_system (Qnil
))
1618 /* Even if mark_active is non-nil, the actual buffer
1619 marker may not have been set yet (Bug#7044). */
1620 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1621 && (EQ (Vselect_active_regions
, Qonly
)
1622 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1623 : (!NILP (Vselect_active_regions
)
1624 && !NILP (Vtransient_mark_mode
)))
1625 && NILP (Fmemq (Vthis_command
,
1626 Vselection_inhibit_update_commands
)))
1629 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1630 if (XINT (Flength (txt
)) > 0)
1631 /* Don't set empty selections. */
1632 call2 (Qx_set_selection
, QPRIMARY
, txt
);
1635 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1637 Lisp_Object hook
= intern ("activate-mark-hook");
1638 Frun_hooks (1, &hook
);
1642 Vsaved_region_selection
= Qnil
;
1647 if (current_buffer
== prev_buffer
1648 && last_point_position
!= PT
1649 && NILP (Vdisable_point_adjustment
)
1650 && NILP (Vglobal_disable_point_adjustment
))
1652 if (last_point_position
> BEGV
1653 && last_point_position
< ZV
1654 && (composition_adjust_point (last_point_position
,
1655 last_point_position
)
1656 != last_point_position
))
1657 /* The last point was temporarily set within a grapheme
1658 cluster to prevent automatic composition. To recover
1659 the automatic composition, we must update the
1661 windows_or_buffers_changed
= 21;
1662 if (!already_adjusted
)
1663 adjust_point_for_property (last_point_position
,
1664 MODIFF
!= prev_modiff
);
1667 /* Install chars successfully executed in kbd macro. */
1669 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1670 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1671 finalize_kbd_macro_chars ();
1676 read_menu_command (void)
1678 Lisp_Object keybuf
[30];
1679 ptrdiff_t count
= SPECPDL_INDEX ();
1682 /* We don't want to echo the keystrokes while navigating the
1684 specbind (Qecho_keystrokes
, make_number (0));
1686 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1689 unbind_to (count
, Qnil
);
1691 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1693 if (i
== 0 || i
== -1)
1696 return read_key_sequence_cmd
;
1699 /* Adjust point to a boundary of a region that has such a property
1700 that should be treated intangible. For the moment, we check
1701 `composition', `display' and `invisible' properties.
1702 LAST_PT is the last position of point. */
1705 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1708 Lisp_Object val
, overlay
, tmp
;
1709 /* When called after buffer modification, we should temporarily
1710 suppress the point adjustment for automatic composition so that a
1711 user can keep inserting another character at point or keep
1712 deleting characters around point. */
1713 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1714 ptrdiff_t orig_pt
= PT
;
1716 /* FIXME: cycling is probably not necessary because these properties
1717 can't be usefully combined anyway. */
1718 while (check_composition
|| check_display
|| check_invisible
)
1720 /* FIXME: check `intangible'. */
1721 if (check_composition
1722 && PT
> BEGV
&& PT
< ZV
1723 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1726 check_display
= check_invisible
= 1;
1728 check_composition
= 0;
1730 && PT
> BEGV
&& PT
< ZV
1731 && !NILP (val
= get_char_property_and_overlay
1732 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1733 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1734 && (!OVERLAYP (overlay
)
1735 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1736 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1737 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1738 && (beg
< PT
/* && end > PT <- It's always the case. */
1739 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1742 SET_PT (PT
< last_pt
1743 ? (STRINGP (val
) && SCHARS (val
) == 0
1744 ? max (beg
- 1, BEGV
)
1747 check_composition
= check_invisible
= 1;
1750 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1756 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1759 /* FIXME: We should stop if we find a spot between
1760 two runs of `invisible' where inserted text would
1761 be visible. This is important when we have two
1762 invisible boundaries that enclose an area: if the
1763 area is empty, we need this test in order to make
1764 it possible to place point in the middle rather
1765 than skip both boundaries. However, this code
1766 also stops anywhere in a non-sticky text-property,
1767 which breaks (e.g.) Org mode. */
1768 && (val
= Fget_pos_property (make_number (end
),
1770 TEXT_PROP_MEANS_INVISIBLE (val
))
1772 && !NILP (val
= get_char_property_and_overlay
1773 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1774 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1776 ellipsis
= ellipsis
|| inv
> 1
1777 || (OVERLAYP (overlay
)
1778 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1779 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1780 tmp
= Fnext_single_char_property_change
1781 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1782 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1786 && (val
= Fget_pos_property (make_number (beg
),
1788 TEXT_PROP_MEANS_INVISIBLE (val
))
1790 && !NILP (val
= get_char_property_and_overlay
1791 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1792 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1794 ellipsis
= ellipsis
|| inv
> 1
1795 || (OVERLAYP (overlay
)
1796 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1797 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1798 tmp
= Fprevious_single_char_property_change
1799 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1800 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1803 /* Move away from the inside area. */
1804 if (beg
< PT
&& end
> PT
)
1806 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1807 /* We haven't moved yet (so we don't need to fear
1808 infinite-looping) and we were outside the range
1809 before (so either end of the range still corresponds
1810 to a move in the right direction): pretend we moved
1811 less than we actually did, so that we still have
1812 more freedom below in choosing which end of the range
1814 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1815 /* We either have moved already or the last point
1816 was already in the range: we don't get to choose
1817 which end of the range we have to go to. */
1818 : (PT
< last_pt
? beg
: end
));
1819 check_composition
= check_display
= 1;
1821 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1822 the point to something other than its argument, due to
1823 point-motion hooks, intangibility, etc. */
1824 eassert (PT
== beg
|| PT
== end
);
1827 /* Pretend the area doesn't exist if the buffer is not
1829 if (!modified
&& !ellipsis
&& beg
< end
)
1831 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1832 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1833 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1834 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1835 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1836 /* We've already moved as far as we can. Trying to go
1837 to the other end would mean moving backwards and thus
1838 could lead to an infinite loop. */
1840 else if (val
= Fget_pos_property (make_number (PT
),
1842 TEXT_PROP_MEANS_INVISIBLE (val
)
1843 && (val
= (Fget_pos_property
1844 (make_number (PT
== beg
? end
: beg
),
1846 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1847 (check_composition
= check_display
= 1,
1848 SET_PT (PT
== beg
? end
: beg
));
1851 check_invisible
= 0;
1855 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1858 safe_run_hooks_1 (void)
1860 eassert (CONSP (Vinhibit_quit
));
1861 return call0 (XCDR (Vinhibit_quit
));
1864 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1868 safe_run_hooks_error (Lisp_Object error_data
)
1871 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1872 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1873 Lisp_Object args
[4];
1874 args
[0] = build_string ("Error in %s (%S): %S");
1877 args
[3] = error_data
;
1883 Lisp_Object newval
= Qnil
;
1884 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1885 if (EQ (fun
, XCAR (val
)))
1888 newval
= Fcons (XCAR (val
), newval
);
1890 return Fset (hook
, Fnreverse (newval
));
1891 /* Not found in the local part of the hook. Let's look at the global
1894 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1895 : Fdefault_value (hook
));
1896 CONSP (val
); val
= XCDR (val
))
1897 if (EQ (fun
, XCAR (val
)))
1900 newval
= Fcons (XCAR (val
), newval
);
1902 return Fset_default (hook
, Fnreverse (newval
));
1908 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1910 eassert (nargs
== 1);
1911 if (CONSP (Vinhibit_quit
))
1912 XSETCDR (Vinhibit_quit
, args
[0]);
1914 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1916 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1920 /* If we get an error while running the hook, cause the hook variable
1921 to be nil. Also inhibit quits, so that C-g won't cause the hook
1922 to mysteriously evaporate. */
1925 safe_run_hooks (Lisp_Object hook
)
1927 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1928 to its body or to its handlers other than via globals such as
1929 dynamically-bound variables ;-) */
1930 ptrdiff_t count
= SPECPDL_INDEX ();
1931 specbind (Qinhibit_quit
, hook
);
1933 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1935 unbind_to (count
, Qnil
);
1939 /* Nonzero means polling for input is temporarily suppressed. */
1941 int poll_suppress_count
;
1944 #ifdef POLL_FOR_INPUT
1946 /* Asynchronous timer for polling. */
1948 static struct atimer
*poll_timer
;
1950 /* Poll for input, so that we catch a C-g if it comes in. */
1952 poll_for_input_1 (void)
1954 if (! input_blocked_p ()
1955 && !waiting_for_input
)
1959 /* Timer callback function for poll_timer. TIMER is equal to
1963 poll_for_input (struct atimer
*timer
)
1965 if (poll_suppress_count
== 0)
1966 pending_signals
= 1;
1969 #endif /* POLL_FOR_INPUT */
1971 /* Begin signals to poll for input, if they are appropriate.
1972 This function is called unconditionally from various places. */
1975 start_polling (void)
1977 #ifdef POLL_FOR_INPUT
1978 /* XXX This condition was (read_socket_hook && !interrupt_input),
1979 but read_socket_hook is not global anymore. Let's pretend that
1981 if (!interrupt_input
)
1983 /* Turn alarm handling on unconditionally. It might have
1984 been turned off in process.c. */
1985 turn_on_atimers (1);
1987 /* If poll timer doesn't exist, or we need one with
1988 a different interval, start a new one. */
1989 if (poll_timer
== NULL
1990 || poll_timer
->interval
.tv_sec
!= polling_period
)
1992 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1993 struct timespec interval
= make_timespec (period
, 0);
1996 cancel_atimer (poll_timer
);
1998 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1999 poll_for_input
, NULL
);
2002 /* Let the timer's callback function poll for input
2003 if this becomes zero. */
2004 --poll_suppress_count
;
2009 /* True if we are using polling to handle input asynchronously. */
2012 input_polling_used (void)
2014 #ifdef POLL_FOR_INPUT
2015 /* XXX This condition was (read_socket_hook && !interrupt_input),
2016 but read_socket_hook is not global anymore. Let's pretend that
2018 return !interrupt_input
;
2024 /* Turn off polling. */
2029 #ifdef POLL_FOR_INPUT
2030 /* XXX This condition was (read_socket_hook && !interrupt_input),
2031 but read_socket_hook is not global anymore. Let's pretend that
2033 if (!interrupt_input
)
2034 ++poll_suppress_count
;
2038 /* Set the value of poll_suppress_count to COUNT
2039 and start or stop polling accordingly. */
2042 set_poll_suppress_count (int count
)
2044 #ifdef POLL_FOR_INPUT
2045 if (count
== 0 && poll_suppress_count
!= 0)
2047 poll_suppress_count
= 1;
2050 else if (count
!= 0 && poll_suppress_count
== 0)
2054 poll_suppress_count
= count
;
2058 /* Bind polling_period to a value at least N.
2059 But don't decrease it. */
2062 bind_polling_period (int n
)
2064 #ifdef POLL_FOR_INPUT
2065 EMACS_INT
new = polling_period
;
2070 stop_other_atimers (poll_timer
);
2072 specbind (Qpolling_period
, make_number (new));
2073 /* Start a new alarm with the new period. */
2078 /* Apply the control modifier to CHARACTER. */
2081 make_ctrl_char (int c
)
2083 /* Save the upper bits here. */
2084 int upper
= c
& ~0177;
2086 if (! ASCII_CHAR_P (c
))
2087 return c
|= ctrl_modifier
;
2091 /* Everything in the columns containing the upper-case letters
2092 denotes a control character. */
2093 if (c
>= 0100 && c
< 0140)
2097 /* Set the shift modifier for a control char
2098 made from a shifted letter. But only for letters! */
2099 if (oc
>= 'A' && oc
<= 'Z')
2100 c
|= shift_modifier
;
2103 /* The lower-case letters denote control characters too. */
2104 else if (c
>= 'a' && c
<= 'z')
2107 /* Include the bits for control and shift
2108 only if the basic ASCII code can't indicate them. */
2112 /* Replace the high bits. */
2113 c
|= (upper
& ~ctrl_modifier
);
2118 /* Display the help-echo property of the character after the mouse pointer.
2119 Either show it in the echo area, or call show-help-function to display
2120 it by other means (maybe in a tooltip).
2122 If HELP is nil, that means clear the previous help echo.
2124 If HELP is a string, display that string. If HELP is a function,
2125 call it with OBJECT and POS as arguments; the function should
2126 return a help string or nil for none. For all other types of HELP,
2127 evaluate it to obtain a string.
2129 WINDOW is the window in which the help was generated, if any.
2130 It is nil if not in a window.
2132 If OBJECT is a buffer, POS is the position in the buffer where the
2133 `help-echo' text property was found.
2135 If OBJECT is an overlay, that overlay has a `help-echo' property,
2136 and POS is the position in the overlay's buffer under the mouse.
2138 If OBJECT is a string (an overlay string or a string displayed with
2139 the `display' property). POS is the position in that string under
2142 Note: this function may only be called with HELP nil or a string
2143 from X code running asynchronously. */
2146 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2149 if (!NILP (help
) && !STRINGP (help
))
2151 if (FUNCTIONP (help
))
2152 help
= safe_call (4, help
, window
, object
, pos
);
2154 help
= safe_eval (help
);
2156 if (!STRINGP (help
))
2160 if (!noninteractive
&& STRINGP (help
))
2162 /* The mouse-fixup-help-message Lisp function can call
2163 mouse_position_hook, which resets the mouse_moved flags.
2164 This causes trouble if we are trying to read a mouse motion
2165 event (i.e., if we are inside a `track-mouse' form), so we
2166 restore the mouse_moved flag. */
2167 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2168 help
= call1 (Qmouse_fixup_help_message
, help
);
2173 if (STRINGP (help
) || NILP (help
))
2175 if (!NILP (Vshow_help_function
))
2176 call1 (Vshow_help_function
, help
);
2177 help_echo_showing_p
= STRINGP (help
);
2183 /* Input of single characters from keyboard. */
2185 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2186 struct timespec
*end_time
);
2187 static void record_char (Lisp_Object c
);
2189 static Lisp_Object help_form_saved_window_configs
;
2191 read_char_help_form_unwind (void)
2193 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2194 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2195 if (!NILP (window_config
))
2196 Fset_window_configuration (window_config
);
2199 #define STOP_POLLING \
2200 do { if (! polling_stopped_here) stop_polling (); \
2201 polling_stopped_here = 1; } while (0)
2203 #define RESUME_POLLING \
2204 do { if (polling_stopped_here) start_polling (); \
2205 polling_stopped_here = 0; } while (0)
2208 read_event_from_main_queue (struct timespec
*end_time
,
2209 sys_jmp_buf local_getcjmp
,
2210 bool *used_mouse_menu
)
2212 Lisp_Object c
= Qnil
;
2213 sys_jmp_buf save_jump
;
2214 KBOARD
*kb
IF_LINT (= NULL
);
2218 /* Read from the main queue, and if that gives us something we can't use yet,
2219 we put it on the appropriate side queue and try again. */
2221 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2224 /* Actually read a character, waiting if necessary. */
2225 save_getcjmp (save_jump
);
2226 restore_getcjmp (local_getcjmp
);
2228 timer_start_idle ();
2229 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2230 restore_getcjmp (save_jump
);
2232 if (! NILP (c
) && (kb
!= current_kboard
))
2234 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2237 while (CONSP (XCDR (last
)))
2239 if (!NILP (XCDR (last
)))
2243 kset_kbd_queue (kb
, list1 (c
));
2245 XSETCDR (last
, list1 (c
));
2246 kb
->kbd_queue_has_data
= 1;
2250 current_kboard
= kb
;
2251 /* This is going to exit from read_char
2252 so we had better get rid of this frame's stuff. */
2253 return make_number (-2);
2256 /* Terminate Emacs in batch mode if at eof. */
2257 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2258 Fkill_emacs (make_number (1));
2262 /* Add in any extra modifiers, where appropriate. */
2263 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2264 || ((extra_keyboard_modifiers
& 0177) < ' '
2265 && (extra_keyboard_modifiers
& 0177) != 0))
2266 XSETINT (c
, make_ctrl_char (XINT (c
)));
2268 /* Transfer any other modifier bits directly from
2269 extra_keyboard_modifiers to c. Ignore the actual character code
2270 in the low 16 bits of extra_keyboard_modifiers. */
2271 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2279 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2282 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2283 sys_jmp_buf local_getcjmp
,
2284 Lisp_Object prev_event
,
2285 bool *used_mouse_menu
)
2287 #define MAX_ENCODED_BYTES 16
2289 Lisp_Object events
[MAX_ENCODED_BYTES
];
2295 = read_event_from_main_queue (end_time
, local_getcjmp
,
2298 /* w32_console already returns decoded events. It either reads
2299 Unicode characters from the Windows keyboard input, or
2300 converts characters encoded in the current codepage into
2301 Unicode. See w32inevt.c:key_event, near its end. */
2304 struct frame
*frame
= XFRAME (selected_frame
);
2305 struct terminal
*terminal
= frame
->terminal
;
2306 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2307 /* Don't apply decoding if we're just reading a raw event
2308 (e.g. reading bytes sent by the xterm to specify the position
2309 of a mouse click). */
2310 && (!EQ (prev_event
, Qt
))
2311 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2312 & CODING_REQUIRE_DECODING_MASK
)))
2313 return nextevt
; /* No decoding needed. */
2316 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2317 eassert (n
< MAX_ENCODED_BYTES
);
2318 events
[n
++] = nextevt
;
2319 if (NATNUMP (nextevt
)
2320 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2321 { /* An encoded byte sequence, let's try to decode it. */
2322 struct coding_system
*coding
2323 = TERMINAL_KEYBOARD_CODING (terminal
);
2324 unsigned char *src
= alloca (n
);
2326 for (i
= 0; i
< n
; i
++)
2327 src
[i
] = XINT (events
[i
]);
2329 for (i
= 0; i
< n
; i
++)
2331 coding
->destination
= alloca (n
* 4);
2332 coding
->dst_bytes
= n
* 4;
2333 decode_coding_c_string (coding
, src
, n
, Qnil
);
2334 eassert (coding
->produced_char
<= n
);
2335 if (coding
->produced_char
== 0)
2336 { /* The encoded sequence is incomplete. */
2337 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2338 continue; /* Read on! */
2342 const unsigned char *p
= coding
->destination
;
2343 eassert (coding
->carryover_bytes
== 0);
2345 while (n
< coding
->produced_char
)
2346 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2349 /* Now `events' should hold decoded events.
2350 Normally, n should be equal to 1, but better not rely on it.
2351 We can only return one event here, so return the first we
2352 had and keep the others (if any) for later. */
2354 Vunread_command_events
2355 = Fcons (events
[--n
], Vunread_command_events
);
2363 echo_keystrokes_p (void)
2365 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2366 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2369 /* Read a character from the keyboard; call the redisplay if needed. */
2370 /* commandflag 0 means do not autosave, but do redisplay.
2371 -1 means do not redisplay, but do autosave.
2372 -2 means do neither.
2375 /* The argument MAP is a keymap for menu prompting.
2377 PREV_EVENT is the previous input event, or nil if we are reading
2378 the first event of a key sequence (or not reading a key sequence).
2379 If PREV_EVENT is t, that is a "magic" value that says
2380 not to run input methods, but in other respects to act as if
2381 not reading a key sequence.
2383 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2384 if we used a mouse menu to read the input, or false otherwise. If
2385 USED_MOUSE_MENU is null, don't dereference it.
2387 Value is -2 when we find input on another keyboard. A second call
2388 to read_char will read it.
2390 If END_TIME is non-null, it is a pointer to a struct timespec
2391 specifying the maximum time to wait until. If no input arrives by
2392 that time, stop waiting and return nil.
2394 Value is t if we showed a menu and the user rejected it. */
2397 read_char (int commandflag
, Lisp_Object map
,
2398 Lisp_Object prev_event
,
2399 bool *used_mouse_menu
, struct timespec
*end_time
)
2403 sys_jmp_buf local_getcjmp
;
2404 sys_jmp_buf save_jump
;
2405 Lisp_Object tem
, save
;
2406 volatile Lisp_Object previous_echo_area_message
;
2407 volatile Lisp_Object also_record
;
2408 volatile bool reread
;
2409 struct gcpro gcpro1
, gcpro2
;
2410 bool volatile polling_stopped_here
= 0;
2411 struct kboard
*orig_kboard
= current_kboard
;
2415 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2416 before_command_key_count
= this_command_key_count
;
2417 before_command_echo_length
= echo_length ();
2420 previous_echo_area_message
= Qnil
;
2422 GCPRO2 (c
, previous_echo_area_message
);
2426 if (CONSP (Vunread_post_input_method_events
))
2428 c
= XCAR (Vunread_post_input_method_events
);
2429 Vunread_post_input_method_events
2430 = XCDR (Vunread_post_input_method_events
);
2432 /* Undo what read_char_x_menu_prompt did when it unread
2433 additional keys returned by Fx_popup_menu. */
2435 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2446 if (CONSP (Vunread_command_events
))
2448 bool was_disabled
= 0;
2450 c
= XCAR (Vunread_command_events
);
2451 Vunread_command_events
= XCDR (Vunread_command_events
);
2453 /* Undo what sit-for did when it unread additional keys
2454 inside universal-argument. */
2456 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2461 /* Undo what read_char_x_menu_prompt did when it unread
2462 additional keys returned by Fx_popup_menu. */
2464 && EQ (XCDR (c
), Qdisabled
)
2465 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2471 /* If the queued event is something that used the mouse,
2472 set used_mouse_menu accordingly. */
2474 /* Also check was_disabled so last-nonmenu-event won't return
2475 a bad value when submenus are involved. (Bug#447) */
2476 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2477 *used_mouse_menu
= 1;
2479 goto reread_for_input_method
;
2482 if (CONSP (Vunread_input_method_events
))
2484 c
= XCAR (Vunread_input_method_events
);
2485 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2487 /* Undo what read_char_x_menu_prompt did when it unread
2488 additional keys returned by Fx_popup_menu. */
2490 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2494 goto reread_for_input_method
;
2497 this_command_key_count_reset
= 0;
2499 if (!NILP (Vexecuting_kbd_macro
))
2501 /* We set this to Qmacro; since that's not a frame, nobody will
2502 try to switch frames on us, and the selected window will
2505 Since this event came from a macro, it would be misleading to
2506 leave internal_last_event_frame set to wherever the last
2507 real event came from. Normally, a switch-frame event selects
2508 internal_last_event_frame after each command is read, but
2509 events read from a macro should never cause a new frame to be
2511 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2513 /* Exit the macro if we are at the end.
2514 Also, some things replace the macro with t
2515 to force an early exit. */
2516 if (EQ (Vexecuting_kbd_macro
, Qt
)
2517 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2523 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2524 if (STRINGP (Vexecuting_kbd_macro
)
2525 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2526 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2528 executing_kbd_macro_index
++;
2533 if (!NILP (unread_switch_frame
))
2535 c
= unread_switch_frame
;
2536 unread_switch_frame
= Qnil
;
2538 /* This event should make it into this_command_keys, and get echoed
2539 again, so we do not set `reread'. */
2543 /* If redisplay was requested. */
2544 if (commandflag
>= 0)
2546 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2548 /* If there is pending input, process any events which are not
2549 user-visible, such as X selection_request events. */
2551 || detect_input_pending_run_timers (0))
2552 swallow_events (0); /* May clear input_pending. */
2554 /* Redisplay if no pending input. */
2555 while (!input_pending
)
2557 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2558 redisplay_preserve_echo_area (5);
2563 /* Normal case: no input arrived during redisplay. */
2566 /* Input arrived and pre-empted redisplay.
2567 Process any events which are not user-visible. */
2569 /* If that cleared input_pending, try again to redisplay. */
2572 /* Prevent the redisplay we just did
2573 from messing up echoing of the input after the prompt. */
2574 if (commandflag
== 0 && echo_current
)
2575 echo_message_buffer
= echo_area_buffer
[0];
2579 /* Message turns off echoing unless more keystrokes turn it on again.
2581 The code in 20.x for the condition was
2583 1. echo_area_glyphs && *echo_area_glyphs
2584 2. && echo_area_glyphs != current_kboard->echobuf
2585 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2587 (1) means there's a current message displayed
2589 (2) means it's not the message from echoing from the current
2592 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2593 is set to a non-null value. This is done in read_char and it is
2594 set to echo_area_glyphs after a call to echo_char. That means
2595 ok_to_echo_at_next_pause is either null or
2596 current_kboard->echobuf with the appropriate current_kboard at
2599 So, condition (3) means in clear text ok_to_echo_at_next_pause
2600 must be either null, or the current message isn't from echoing at
2601 all, or it's from echoing from a different kboard than the
2604 if (/* There currently is something in the echo area. */
2605 !NILP (echo_area_buffer
[0])
2606 && (/* It's an echo from a different kboard. */
2607 echo_kboard
!= current_kboard
2608 /* Or we explicitly allow overwriting whatever there is. */
2609 || ok_to_echo_at_next_pause
== NULL
))
2614 /* Try reading a character via menu prompting in the minibuf.
2615 Try this before the sit-for, because the sit-for
2616 would do the wrong thing if we are supposed to do
2617 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2618 after a mouse event so don't try a minibuf menu. */
2620 if (KEYMAPP (map
) && INTERACTIVE
2621 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2622 /* Don't bring up a menu if we already have another event. */
2623 && NILP (Vunread_command_events
)
2624 && !detect_input_pending_run_timers (0))
2626 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2628 if (INTEGERP (c
) && XINT (c
) == -2)
2629 return c
; /* wrong_kboard_jmpbuf */
2635 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2636 We will do that below, temporarily for short sections of code,
2637 when appropriate. local_getcjmp must be in effect
2638 around any call to sit_for or kbd_buffer_get_event;
2639 it *must not* be in effect when we call redisplay. */
2641 jmpcount
= SPECPDL_INDEX ();
2642 if (sys_setjmp (local_getcjmp
))
2644 /* Handle quits while reading the keyboard. */
2645 /* We must have saved the outer value of getcjmp here,
2646 so restore it now. */
2647 restore_getcjmp (save_jump
);
2648 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2649 unbind_to (jmpcount
, Qnil
);
2650 XSETINT (c
, quit_char
);
2651 internal_last_event_frame
= selected_frame
;
2652 Vlast_event_frame
= internal_last_event_frame
;
2653 /* If we report the quit char as an event,
2654 don't do so more than once. */
2655 if (!NILP (Vinhibit_quit
))
2659 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2660 if (kb
!= current_kboard
)
2662 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2663 /* We shouldn't get here if we were in single-kboard mode! */
2668 while (CONSP (XCDR (last
)))
2670 if (!NILP (XCDR (last
)))
2674 kset_kbd_queue (kb
, list1 (c
));
2676 XSETCDR (last
, list1 (c
));
2677 kb
->kbd_queue_has_data
= 1;
2678 current_kboard
= kb
;
2679 /* This is going to exit from read_char
2680 so we had better get rid of this frame's stuff. */
2682 return make_number (-2); /* wrong_kboard_jmpbuf */
2688 /* Start idle timers if no time limit is supplied. We don't do it
2689 if a time limit is supplied to avoid an infinite recursion in the
2690 situation where an idle timer calls `sit-for'. */
2693 timer_start_idle ();
2695 /* If in middle of key sequence and minibuffer not active,
2696 start echoing if enough time elapses. */
2698 if (minibuf_level
== 0
2700 && !current_kboard
->immediate_echo
2701 && this_command_key_count
> 0
2703 && echo_keystrokes_p ()
2704 && (/* No message. */
2705 NILP (echo_area_buffer
[0])
2706 /* Or empty message. */
2707 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2708 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2709 /* Or already echoing from same kboard. */
2710 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2711 /* Or not echoing before and echoing allowed. */
2712 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2714 /* After a mouse event, start echoing right away.
2715 This is because we are probably about to display a menu,
2716 and we don't want to delay before doing so. */
2717 if (EVENT_HAS_PARAMETERS (prev_event
))
2723 save_getcjmp (save_jump
);
2724 restore_getcjmp (local_getcjmp
);
2725 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2726 restore_getcjmp (save_jump
);
2728 && ! CONSP (Vunread_command_events
))
2733 /* Maybe auto save due to number of keystrokes. */
2735 if (commandflag
!= 0 && commandflag
!= -2
2736 && auto_save_interval
> 0
2737 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2738 && !detect_input_pending_run_timers (0))
2740 Fdo_auto_save (Qnil
, Qnil
);
2741 /* Hooks can actually change some buffers in auto save. */
2745 /* Try reading using an X menu.
2746 This is never confused with reading using the minibuf
2747 because the recursive call of read_char in read_char_minibuf_menu_prompt
2748 does not pass on any keymaps. */
2750 if (KEYMAPP (map
) && INTERACTIVE
2751 && !NILP (prev_event
)
2752 && EVENT_HAS_PARAMETERS (prev_event
)
2753 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2754 && !EQ (XCAR (prev_event
), Qtool_bar
)
2755 /* Don't bring up a menu if we already have another event. */
2756 && NILP (Vunread_command_events
))
2758 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2760 /* Now that we have read an event, Emacs is not idle. */
2767 /* Maybe autosave and/or garbage collect due to idleness. */
2769 if (INTERACTIVE
&& NILP (c
))
2772 ptrdiff_t buffer_size
;
2774 /* Slow down auto saves logarithmically in size of current buffer,
2775 and garbage collect while we're at it. */
2776 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2777 last_non_minibuf_size
= Z
- BEG
;
2778 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2780 while (buffer_size
> 64)
2781 delay_level
++, buffer_size
-= buffer_size
>> 2;
2782 if (delay_level
< 4) delay_level
= 4;
2783 /* delay_level is 4 for files under around 50k, 7 at 100k,
2784 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2786 /* Auto save if enough time goes by without input. */
2787 if (commandflag
!= 0 && commandflag
!= -2
2788 && num_nonmacro_input_events
> last_auto_save
2789 && INTEGERP (Vauto_save_timeout
)
2790 && XINT (Vauto_save_timeout
) > 0)
2793 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2795 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2796 timeout
= delay_level
* timeout
/ 4;
2797 save_getcjmp (save_jump
);
2798 restore_getcjmp (local_getcjmp
);
2799 tem0
= sit_for (make_number (timeout
), 1, 1);
2800 restore_getcjmp (save_jump
);
2803 && ! CONSP (Vunread_command_events
))
2805 Fdo_auto_save (Qnil
, Qnil
);
2810 /* If there is still no input available, ask for GC. */
2811 if (!detect_input_pending_run_timers (0))
2815 /* Notify the caller if an autosave hook, or a timer, sentinel or
2816 filter in the sit_for calls above have changed the current
2817 kboard. This could happen if they use the minibuffer or start a
2818 recursive edit, like the fancy splash screen in server.el's
2819 filter. If this longjmp wasn't here, read_key_sequence would
2820 interpret the next key sequence using the wrong translation
2821 tables and function keymaps. */
2822 if (NILP (c
) && current_kboard
!= orig_kboard
)
2825 return make_number (-2); /* wrong_kboard_jmpbuf */
2828 /* If this has become non-nil here, it has been set by a timer
2829 or sentinel or filter. */
2830 if (CONSP (Vunread_command_events
))
2832 c
= XCAR (Vunread_command_events
);
2833 Vunread_command_events
= XCDR (Vunread_command_events
);
2835 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2841 /* Read something from current KBOARD's side queue, if possible. */
2845 if (current_kboard
->kbd_queue_has_data
)
2847 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2849 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2850 kset_kbd_queue (current_kboard
,
2851 XCDR (KVAR (current_kboard
, kbd_queue
)));
2852 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2853 current_kboard
->kbd_queue_has_data
= 0;
2854 input_pending
= readable_events (0);
2855 if (EVENT_HAS_PARAMETERS (c
)
2856 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2857 internal_last_event_frame
= XCAR (XCDR (c
));
2858 Vlast_event_frame
= internal_last_event_frame
;
2862 /* If current_kboard's side queue is empty check the other kboards.
2863 If one of them has data that we have not yet seen here,
2864 switch to it and process the data waiting for it.
2866 Note: if the events queued up for another kboard
2867 have already been seen here, and therefore are not a complete command,
2868 the kbd_queue_has_data field is 0, so we skip that kboard here.
2869 That's to avoid an infinite loop switching between kboards here. */
2870 if (NILP (c
) && !single_kboard
)
2873 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2874 if (kb
->kbd_queue_has_data
)
2876 current_kboard
= kb
;
2877 /* This is going to exit from read_char
2878 so we had better get rid of this frame's stuff. */
2880 return make_number (-2); /* wrong_kboard_jmpbuf */
2890 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2891 prev_event
, used_mouse_menu
);
2892 if (NILP (c
) && end_time
2893 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2898 if (EQ (c
, make_number (-2)))
2900 /* This is going to exit from read_char
2901 so we had better get rid of this frame's stuff. */
2915 if (commandflag
>= 0
2916 && !input_pending
&& !detect_input_pending_run_timers (0))
2922 /* Buffer switch events are only for internal wakeups
2923 so don't show them to the user.
2924 Also, don't record a key if we already did. */
2928 /* Process special events within read_char
2929 and loop around to read another event. */
2932 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2937 struct buffer
*prev_buffer
= current_buffer
;
2938 last_input_event
= c
;
2939 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2941 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2942 /* We stopped being idle for this event; undo that. This
2943 prevents automatic window selection (under
2944 mouse_autoselect_window from acting as a real input event, for
2945 example banishing the mouse under mouse-avoidance-mode. */
2946 timer_resume_idle ();
2948 if (current_buffer
!= prev_buffer
)
2950 /* The command may have changed the keymaps. Pretend there
2951 is input in another keyboard and return. This will
2952 recalculate keymaps. */
2953 c
= make_number (-2);
2960 /* Handle things that only apply to characters. */
2963 /* If kbd_buffer_get_event gave us an EOF, return that. */
2967 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2968 && UNSIGNED_CMP (XFASTINT (c
), <,
2969 SCHARS (KVAR (current_kboard
,
2970 Vkeyboard_translate_table
))))
2971 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2972 && UNSIGNED_CMP (XFASTINT (c
), <,
2973 ASIZE (KVAR (current_kboard
,
2974 Vkeyboard_translate_table
))))
2975 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2979 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2980 /* nil in keyboard-translate-table means no translation. */
2986 /* If this event is a mouse click in the menu bar,
2987 return just menu-bar for now. Modify the mouse click event
2988 so we won't do this twice, then queue it up. */
2989 if (EVENT_HAS_PARAMETERS (c
)
2991 && CONSP (EVENT_START (c
))
2992 && CONSP (XCDR (EVENT_START (c
))))
2996 posn
= POSN_POSN (EVENT_START (c
));
2997 /* Handle menu-bar events:
2998 insert the dummy prefix event `menu-bar'. */
2999 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3001 /* Change menu-bar to (menu-bar) as the event "position". */
3002 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
3005 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3010 /* Store these characters into recent_keys, the dribble file if any,
3011 and the keyboard macro being defined, if any. */
3013 if (! NILP (also_record
))
3014 record_char (also_record
);
3016 /* Wipe the echo area.
3017 But first, if we are about to use an input method,
3018 save the echo area contents for it to refer to. */
3020 && ! NILP (Vinput_method_function
)
3021 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3023 previous_echo_area_message
= Fcurrent_message ();
3024 Vinput_method_previous_message
= previous_echo_area_message
;
3027 /* Now wipe the echo area, except for help events which do their
3028 own stuff with the echo area. */
3030 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3031 && !(EQ (Qswitch_frame
, XCAR (c
)))
3032 /* Don't wipe echo area for select window events: These might
3033 get delayed via `mouse-autoselect-window' (Bug#11304). */
3034 && !(EQ (Qselect_window
, XCAR (c
)))))
3036 if (!NILP (echo_area_buffer
[0]))
3038 safe_run_hooks (Qecho_area_clear_hook
);
3039 clear_message (1, 0);
3043 reread_for_input_method
:
3045 /* Pass this to the input method, if appropriate. */
3047 && ! NILP (Vinput_method_function
)
3048 /* Don't run the input method within a key sequence,
3049 after the first event of the key sequence. */
3050 && NILP (prev_event
)
3051 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3054 ptrdiff_t key_count
;
3055 bool key_count_reset
;
3056 struct gcpro gcpro1
;
3057 ptrdiff_t count
= SPECPDL_INDEX ();
3059 /* Save the echo status. */
3060 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3061 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3062 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3063 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3066 if (before_command_restore_flag
)
3068 this_command_key_count
= before_command_key_count_1
;
3069 if (this_command_key_count
< this_single_command_key_start
)
3070 this_single_command_key_start
= this_command_key_count
;
3071 echo_truncate (before_command_echo_length_1
);
3072 before_command_restore_flag
= 0;
3076 /* Save the this_command_keys status. */
3077 key_count
= this_command_key_count
;
3078 key_count_reset
= this_command_key_count_reset
;
3081 keys
= Fcopy_sequence (this_command_keys
);
3086 /* Clear out this_command_keys. */
3087 this_command_key_count
= 0;
3088 this_command_key_count_reset
= 0;
3090 /* Now wipe the echo area. */
3091 if (!NILP (echo_area_buffer
[0]))
3092 safe_run_hooks (Qecho_area_clear_hook
);
3093 clear_message (1, 0);
3096 /* If we are not reading a key sequence,
3097 never use the echo area. */
3100 specbind (Qinput_method_use_echo_area
, Qt
);
3103 /* Call the input method. */
3104 tem
= call1 (Vinput_method_function
, c
);
3106 tem
= unbind_to (count
, tem
);
3108 /* Restore the saved echoing state
3109 and this_command_keys state. */
3110 this_command_key_count
= key_count
;
3111 this_command_key_count_reset
= key_count_reset
;
3113 this_command_keys
= keys
;
3116 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3117 kset_echo_string (current_kboard
, saved_echo_string
);
3118 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3119 if (saved_immediate_echo
)
3124 /* The input method can return no events. */
3127 /* Bring back the previous message, if any. */
3128 if (! NILP (previous_echo_area_message
))
3129 message_with_string ("%s", previous_echo_area_message
, 0);
3132 /* It returned one event or more. */
3134 Vunread_post_input_method_events
3135 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3140 /* Display help if not echoing. */
3141 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3143 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3144 Lisp_Object help
, object
, position
, window
, htem
;
3146 htem
= Fcdr (XCDR (c
));
3149 window
= Fcar (htem
);
3151 object
= Fcar (htem
);
3153 position
= Fcar (htem
);
3155 show_help_echo (help
, window
, object
, position
);
3157 /* We stopped being idle for this event; undo that. */
3159 timer_resume_idle ();
3163 if ((! reread
|| this_command_key_count
== 0
3164 || this_command_key_count_reset
)
3168 /* Don't echo mouse motion events. */
3169 if (echo_keystrokes_p ()
3170 && ! (EVENT_HAS_PARAMETERS (c
)
3171 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3174 if (! NILP (also_record
))
3175 echo_char (also_record
);
3176 /* Once we reread a character, echoing can happen
3177 the next time we pause to read a new one. */
3178 ok_to_echo_at_next_pause
= current_kboard
;
3181 /* Record this character as part of the current key. */
3182 add_command_key (c
);
3183 if (! NILP (also_record
))
3184 add_command_key (also_record
);
3187 last_input_event
= c
;
3190 /* Process the help character specially if enabled. */
3191 if (!NILP (Vhelp_form
) && help_char_p (c
))
3193 ptrdiff_t count
= SPECPDL_INDEX ();
3195 help_form_saved_window_configs
3196 = Fcons (Fcurrent_window_configuration (Qnil
),
3197 help_form_saved_window_configs
);
3198 record_unwind_protect_void (read_char_help_form_unwind
);
3199 call0 (Qhelp_form_show
);
3204 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3205 if (EVENT_HAS_PARAMETERS (c
)
3206 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3207 XSETCAR (help_form_saved_window_configs
, Qnil
);
3209 while (BUFFERP (c
));
3210 /* Remove the help from the frame. */
3211 unbind_to (count
, Qnil
);
3214 if (EQ (c
, make_number (040)))
3218 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3219 while (BUFFERP (c
));
3228 /* Record a key that came from a mouse menu.
3229 Record it for echoing, for this-command-keys, and so on. */
3232 record_menu_key (Lisp_Object c
)
3234 /* Wipe the echo area. */
3235 clear_message (1, 0);
3240 before_command_key_count
= this_command_key_count
;
3241 before_command_echo_length
= echo_length ();
3244 /* Don't echo mouse motion events. */
3245 if (echo_keystrokes_p ())
3249 /* Once we reread a character, echoing can happen
3250 the next time we pause to read a new one. */
3251 ok_to_echo_at_next_pause
= 0;
3254 /* Record this character as part of the current key. */
3255 add_command_key (c
);
3257 /* Re-reading in the middle of a command. */
3258 last_input_event
= c
;
3262 /* Return true if should recognize C as "the help character". */
3265 help_char_p (Lisp_Object c
)
3269 if (EQ (c
, Vhelp_char
))
3271 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3272 if (EQ (c
, XCAR (tail
)))
3277 /* Record the input event C in various ways. */
3280 record_char (Lisp_Object c
)
3284 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3286 /* To avoid filling recent_keys with help-echo and mouse-movement
3287 events, we filter out repeated help-echo events, only store the
3288 first and last in a series of mouse-movement events, and don't
3289 store repeated help-echo events which are only separated by
3290 mouse-movement events. */
3292 Lisp_Object ev1
, ev2
, ev3
;
3295 if ((ix1
= recent_keys_index
- 1) < 0)
3296 ix1
= NUM_RECENT_KEYS
- 1;
3297 ev1
= AREF (recent_keys
, ix1
);
3299 if ((ix2
= ix1
- 1) < 0)
3300 ix2
= NUM_RECENT_KEYS
- 1;
3301 ev2
= AREF (recent_keys
, ix2
);
3303 if ((ix3
= ix2
- 1) < 0)
3304 ix3
= NUM_RECENT_KEYS
- 1;
3305 ev3
= AREF (recent_keys
, ix3
);
3307 if (EQ (XCAR (c
), Qhelp_echo
))
3309 /* Don't record `help-echo' in recent_keys unless it shows some help
3310 message, and a different help than the previously recorded
3312 Lisp_Object help
, last_help
;
3314 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3315 if (!STRINGP (help
))
3317 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3318 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3320 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3321 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3322 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3324 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3325 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3326 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3327 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3330 else if (EQ (XCAR (c
), Qmouse_movement
))
3332 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3333 So additional mouse movement events replace the last element. */
3334 Lisp_Object last_window
, window
;
3336 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3337 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3338 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3339 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3340 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3342 ASET (recent_keys
, ix1
, c
);
3348 store_kbd_macro_char (c
);
3352 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3353 ASET (recent_keys
, recent_keys_index
, c
);
3354 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3355 recent_keys_index
= 0;
3357 else if (recorded
< 0)
3359 /* We need to remove one or two events from recent_keys.
3360 To do this, we simply put nil at those events and move the
3361 recent_keys_index backwards over those events. Usually,
3362 users will never see those nil events, as they will be
3363 overwritten by the command keys entered to see recent_keys
3366 while (recorded
++ < 0 && total_keys
> 0)
3368 if (total_keys
< NUM_RECENT_KEYS
)
3370 if (--recent_keys_index
< 0)
3371 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3372 ASET (recent_keys
, recent_keys_index
, Qnil
);
3376 num_nonmacro_input_events
++;
3378 /* Write c to the dribble file. If c is a lispy event, write
3379 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3380 If you, dear reader, have a better idea, you've got the source. :-) */
3386 if (XUINT (c
) < 0x100)
3387 putc (XUINT (c
), dribble
);
3389 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3393 Lisp_Object dribblee
;
3395 /* If it's a structured event, take the event header. */
3396 dribblee
= EVENT_HEAD (c
);
3398 if (SYMBOLP (dribblee
))
3400 putc ('<', dribble
);
3401 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3402 SBYTES (SYMBOL_NAME (dribblee
)),
3404 putc ('>', dribble
);
3413 /* Copy out or in the info on where C-g should throw to.
3414 This is used when running Lisp code from within get_char,
3415 in case get_char is called recursively.
3416 See read_process_output. */
3419 save_getcjmp (sys_jmp_buf temp
)
3421 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3425 restore_getcjmp (sys_jmp_buf temp
)
3427 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3430 /* Low level keyboard/mouse input.
3431 kbd_buffer_store_event places events in kbd_buffer, and
3432 kbd_buffer_get_event retrieves them. */
3434 /* Return true if there are any events in the queue that read-char
3435 would return. If this returns false, a read-char would block. */
3437 readable_events (int flags
)
3439 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3442 /* If the buffer contains only FOCUS_IN_EVENT events, and
3443 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3444 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3446 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3447 #ifdef USE_TOOLKIT_SCROLL_BARS
3448 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3452 struct input_event
*event
;
3454 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3461 #ifdef USE_TOOLKIT_SCROLL_BARS
3462 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3464 event
->kind
== FOCUS_IN_EVENT
)
3465 #ifdef USE_TOOLKIT_SCROLL_BARS
3466 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3467 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3468 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3469 && event
->part
== scroll_bar_handle
3470 && event
->modifiers
== 0)
3475 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3478 while (event
!= kbd_store_ptr
);
3484 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3485 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3489 if (current_kboard
->kbd_queue_has_data
)
3495 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3496 if (kb
->kbd_queue_has_data
)
3502 /* Set this for debugging, to have a way to get out */
3503 int stop_character EXTERNALLY_VISIBLE
;
3506 event_to_kboard (struct input_event
*event
)
3508 /* Not applicable for these special events. */
3509 if (event
->kind
== SELECTION_REQUEST_EVENT
3510 || event
->kind
== SELECTION_CLEAR_EVENT
)
3514 Lisp_Object obj
= event
->frame_or_window
;
3515 /* There are some events that set this field to nil or string. */
3517 obj
= WINDOW_FRAME (XWINDOW (obj
));
3518 /* Also ignore dead frames here. */
3519 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3520 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3525 /* Return the number of slots occupied in kbd_buffer. */
3528 kbd_buffer_nr_stored (void)
3530 return kbd_fetch_ptr
== kbd_store_ptr
3532 : (kbd_fetch_ptr
< kbd_store_ptr
3533 ? kbd_store_ptr
- kbd_fetch_ptr
3534 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3535 + (kbd_store_ptr
- kbd_buffer
)));
3537 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3540 kbd_buffer_store_event (register struct input_event
*event
)
3542 kbd_buffer_store_event_hold (event
, 0);
3545 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3547 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3548 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3549 Else, if EVENT is a quit event, store the quit event
3550 in HOLD_QUIT, and return (thus ignoring further events).
3552 This is used to postpone the processing of the quit event until all
3553 subsequent input events have been parsed (and discarded). */
3556 kbd_buffer_store_event_hold (register struct input_event
*event
,
3557 struct input_event
*hold_quit
)
3559 if (event
->kind
== NO_EVENT
)
3562 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3565 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3567 register int c
= event
->code
& 0377;
3569 if (event
->modifiers
& ctrl_modifier
)
3570 c
= make_ctrl_char (c
);
3572 c
|= (event
->modifiers
3573 & (meta_modifier
| alt_modifier
3574 | hyper_modifier
| super_modifier
));
3578 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3579 struct input_event
*sp
;
3581 if (single_kboard
&& kb
!= current_kboard
)
3584 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3586 kb
->kbd_queue_has_data
= 1;
3587 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3589 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3592 if (event_to_kboard (sp
) == kb
)
3594 sp
->kind
= NO_EVENT
;
3595 sp
->frame_or_window
= Qnil
;
3604 *hold_quit
= *event
;
3608 /* If this results in a quit_char being returned to Emacs as
3609 input, set Vlast_event_frame properly. If this doesn't
3610 get returned to Emacs as an event, the next event read
3611 will set Vlast_event_frame again, so this is safe to do. */
3615 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3617 focus
= event
->frame_or_window
;
3618 internal_last_event_frame
= focus
;
3619 Vlast_event_frame
= focus
;
3622 handle_interrupt (0);
3626 if (c
&& c
== stop_character
)
3632 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3633 Just ignore the second one. */
3634 else if (event
->kind
== BUFFER_SWITCH_EVENT
3635 && kbd_fetch_ptr
!= kbd_store_ptr
3636 && ((kbd_store_ptr
== kbd_buffer
3637 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3638 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3641 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3642 kbd_store_ptr
= kbd_buffer
;
3644 /* Don't let the very last slot in the buffer become full,
3645 since that would make the two pointers equal,
3646 and that is indistinguishable from an empty buffer.
3647 Discard the event if it would fill the last slot. */
3648 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3650 *kbd_store_ptr
= *event
;
3653 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3654 && ! kbd_on_hold_p ())
3656 /* Don't read keyboard input until we have processed kbd_buffer.
3657 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3658 hold_keyboard_input ();
3659 if (!noninteractive
)
3663 #endif /* subprocesses */
3666 /* If we're inside while-no-input, and this event qualifies
3667 as input, set quit-flag to cause an interrupt. */
3668 if (!NILP (Vthrow_on_input
)
3669 && event
->kind
!= FOCUS_IN_EVENT
3670 && event
->kind
!= HELP_EVENT
3671 && event
->kind
!= DEICONIFY_EVENT
)
3673 Vquit_flag
= Vthrow_on_input
;
3674 /* If we're inside a function that wants immediate quits,
3676 if (immediate_quit
&& NILP (Vinhibit_quit
))
3685 /* Put an input event back in the head of the event queue. */
3688 kbd_buffer_unget_event (register struct input_event
*event
)
3690 if (kbd_fetch_ptr
== kbd_buffer
)
3691 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3693 /* Don't let the very last slot in the buffer become full, */
3694 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3697 *kbd_fetch_ptr
= *event
;
3702 /* Generate a HELP_EVENT input_event and store it in the keyboard
3705 HELP is the help form.
3707 FRAME and WINDOW are the frame and window where the help is
3708 generated. OBJECT is the Lisp object where the help was found (a
3709 buffer, a string, an overlay, or nil if neither from a string nor
3710 from a buffer). POS is the position within OBJECT where the help
3714 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3715 Lisp_Object object
, ptrdiff_t pos
)
3717 struct input_event event
;
3721 event
.kind
= HELP_EVENT
;
3722 event
.frame_or_window
= frame
;
3724 event
.x
= WINDOWP (window
) ? window
: frame
;
3727 kbd_buffer_store_event (&event
);
3731 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3734 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3736 struct input_event event
;
3738 event
.kind
= HELP_EVENT
;
3739 event
.frame_or_window
= frame
;
3744 kbd_buffer_store_event (&event
);
3748 /* Discard any mouse events in the event buffer by setting them to
3751 discard_mouse_events (void)
3753 struct input_event
*sp
;
3754 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3756 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3759 if (sp
->kind
== MOUSE_CLICK_EVENT
3760 || sp
->kind
== WHEEL_EVENT
3761 || sp
->kind
== HORIZ_WHEEL_EVENT
3763 || sp
->kind
== GPM_CLICK_EVENT
3765 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3766 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3768 sp
->kind
= NO_EVENT
;
3774 /* Return true if there are any real events waiting in the event
3775 buffer, not counting `NO_EVENT's.
3777 Discard NO_EVENT events at the front of the input queue, possibly
3778 leaving the input queue empty if there are no real input events. */
3781 kbd_buffer_events_waiting (void)
3783 struct input_event
*sp
;
3785 for (sp
= kbd_fetch_ptr
;
3786 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3789 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3794 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3798 /* Clear input event EVENT. */
3801 clear_event (struct input_event
*event
)
3803 event
->kind
= NO_EVENT
;
3807 /* Read one event from the event buffer, waiting if necessary.
3808 The value is a Lisp object representing the event.
3809 The value is nil for an event that should be ignored,
3810 or that was handled here.
3811 We always read and discard one event. */
3814 kbd_buffer_get_event (KBOARD
**kbp
,
3815 bool *used_mouse_menu
,
3816 struct timespec
*end_time
)
3821 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3823 /* Start reading input again because we have processed enough to
3824 be able to accept new events again. */
3825 unhold_keyboard_input ();
3828 #endif /* subprocesses */
3830 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3832 /* In case we are running as a daemon, only do this before
3833 detaching from the terminal. */
3834 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3838 *kbp
= current_kboard
;
3841 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3843 /* Wait until there is input available. */
3846 /* Break loop if there's an unread command event. Needed in
3847 moused window autoselection which uses a timer to insert such
3849 if (CONSP (Vunread_command_events
))
3852 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3854 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3857 /* If the quit flag is set, then read_char will return
3858 quit_char, so that counts as "available input." */
3859 if (!NILP (Vquit_flag
))
3860 quit_throw_to_read_char (0);
3862 /* One way or another, wait until input is available; then, if
3863 interrupt handlers have not read it, read it now. */
3868 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3870 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3874 struct timespec now
= current_timespec ();
3875 if (timespec_cmp (*end_time
, now
) <= 0)
3876 return Qnil
; /* Finished waiting. */
3879 struct timespec duration
= timespec_sub (*end_time
, now
);
3880 wait_reading_process_output (min (duration
.tv_sec
,
3883 -1, 1, Qnil
, NULL
, 0);
3888 bool do_display
= true;
3890 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3892 struct tty_display_info
*tty
= CURTTY ();
3894 /* When this TTY is displaying a menu, we must prevent
3895 any redisplay, because we modify the frame's glyph
3896 matrix behind the back of the display engine. */
3897 if (tty
->showing_menu
)
3901 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3904 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3908 if (CONSP (Vunread_command_events
))
3911 first
= XCAR (Vunread_command_events
);
3912 Vunread_command_events
= XCDR (Vunread_command_events
);
3913 *kbp
= current_kboard
;
3917 /* At this point, we know that there is a readable event available
3918 somewhere. If the event queue is empty, then there must be a
3919 mouse movement enabled and available. */
3920 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3922 struct input_event
*event
;
3924 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3928 *kbp
= event_to_kboard (event
);
3930 *kbp
= current_kboard
; /* Better than returning null ptr? */
3934 /* These two kinds of events get special handling
3935 and don't actually appear to the command loop.
3936 We return nil for them. */
3937 if (event
->kind
== SELECTION_REQUEST_EVENT
3938 || event
->kind
== SELECTION_CLEAR_EVENT
)
3941 struct input_event copy
;
3943 /* Remove it from the buffer before processing it,
3944 since otherwise swallow_events will see it
3945 and process it again. */
3947 kbd_fetch_ptr
= event
+ 1;
3948 input_pending
= readable_events (0);
3949 x_handle_selection_event (©
);
3951 /* We're getting selection request events, but we don't have
3957 #if defined (HAVE_NS)
3958 else if (event
->kind
== NS_TEXT_EVENT
)
3960 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3961 obj
= list1 (intern ("ns-put-working-text"));
3963 obj
= list1 (intern ("ns-unput-working-text"));
3964 kbd_fetch_ptr
= event
+ 1;
3965 if (used_mouse_menu
)
3966 *used_mouse_menu
= 1;
3970 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3971 || defined (HAVE_NS)
3972 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3974 /* Make an event (delete-frame (FRAME)). */
3975 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3976 kbd_fetch_ptr
= event
+ 1;
3979 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3980 || defined (HAVE_NS)
3981 else if (event
->kind
== ICONIFY_EVENT
)
3983 /* Make an event (iconify-frame (FRAME)). */
3984 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
3985 kbd_fetch_ptr
= event
+ 1;
3987 else if (event
->kind
== DEICONIFY_EVENT
)
3989 /* Make an event (make-frame-visible (FRAME)). */
3990 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
3991 kbd_fetch_ptr
= event
+ 1;
3994 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3996 /* The value doesn't matter here; only the type is tested. */
3997 XSETBUFFER (obj
, current_buffer
);
3998 kbd_fetch_ptr
= event
+ 1;
4000 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4001 || defined (HAVE_NS) || defined (USE_GTK)
4002 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4004 kbd_fetch_ptr
= event
+ 1;
4005 input_pending
= readable_events (0);
4006 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4007 x_activate_menubar (XFRAME (event
->frame_or_window
));
4011 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4013 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4014 obj
= list4 (Qlanguage_change
,
4015 event
->frame_or_window
,
4016 make_number (event
->code
),
4017 make_number (event
->modifiers
));
4018 kbd_fetch_ptr
= event
+ 1;
4021 #ifdef USE_FILE_NOTIFY
4022 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4024 #ifdef HAVE_W32NOTIFY
4025 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4026 obj
= list3 (Qfile_notify
,
4027 list3 (make_number (event
->code
),
4030 event
->frame_or_window
);
4032 obj
= make_lispy_event (event
);
4034 kbd_fetch_ptr
= event
+ 1;
4036 #endif /* USE_FILE_NOTIFY */
4037 else if (event
->kind
== SAVE_SESSION_EVENT
)
4039 obj
= list2 (Qsave_session
, event
->arg
);
4040 kbd_fetch_ptr
= event
+ 1;
4042 /* Just discard these, by returning nil.
4043 With MULTI_KBOARD, these events are used as placeholders
4044 when we need to randomly delete events from the queue.
4045 (They shouldn't otherwise be found in the buffer,
4046 but on some machines it appears they do show up
4047 even without MULTI_KBOARD.) */
4048 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4049 mouse events during a popup-menu call. */
4050 else if (event
->kind
== NO_EVENT
)
4051 kbd_fetch_ptr
= event
+ 1;
4052 else if (event
->kind
== HELP_EVENT
)
4054 Lisp_Object object
, position
, help
, frame
, window
;
4056 frame
= event
->frame_or_window
;
4057 object
= event
->arg
;
4058 position
= make_number (event
->code
);
4061 clear_event (event
);
4063 kbd_fetch_ptr
= event
+ 1;
4064 if (!WINDOWP (window
))
4066 obj
= Fcons (Qhelp_echo
,
4067 list5 (frame
, help
, window
, object
, position
));
4069 else if (event
->kind
== FOCUS_IN_EVENT
)
4071 /* Notification of a FocusIn event. The frame receiving the
4072 focus is in event->frame_or_window. Generate a
4073 switch-frame event if necessary. */
4074 Lisp_Object frame
, focus
;
4076 frame
= event
->frame_or_window
;
4077 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4086 !EQ (frame
, internal_last_event_frame
)
4087 && !EQ (frame
, selected_frame
))
4088 obj
= make_lispy_switch_frame (frame
);
4090 obj
= make_lispy_focus_in (frame
);
4092 internal_last_event_frame
= frame
;
4093 kbd_fetch_ptr
= event
+ 1;
4095 else if (event
->kind
== FOCUS_OUT_EVENT
)
4097 #ifdef HAVE_WINDOW_SYSTEM
4100 Lisp_Object frame
= event
->frame_or_window
;
4101 bool focused
= false;
4103 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4104 focused
= di
->x_highlight_frame
!= 0;
4107 obj
= make_lispy_focus_out (frame
);
4109 #endif /* HAVE_WINDOW_SYSTEM */
4111 kbd_fetch_ptr
= event
+ 1;
4114 else if (event
->kind
== DBUS_EVENT
)
4116 obj
= make_lispy_event (event
);
4117 kbd_fetch_ptr
= event
+ 1;
4120 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4122 obj
= make_lispy_event (event
);
4123 kbd_fetch_ptr
= event
+ 1;
4127 /* If this event is on a different frame, return a switch-frame this
4128 time, and leave the event in the queue for next time. */
4132 frame
= event
->frame_or_window
;
4134 frame
= XCAR (frame
);
4135 else if (WINDOWP (frame
))
4136 frame
= WINDOW_FRAME (XWINDOW (frame
));
4138 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4142 if (! EQ (frame
, internal_last_event_frame
)
4143 && !EQ (frame
, selected_frame
))
4144 obj
= make_lispy_switch_frame (frame
);
4145 internal_last_event_frame
= frame
;
4147 /* If we didn't decide to make a switch-frame event, go ahead
4148 and build a real event from the queue entry. */
4152 obj
= make_lispy_event (event
);
4154 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4155 || defined (HAVE_NS) || defined (USE_GTK)
4156 /* If this was a menu selection, then set the flag to inhibit
4157 writing to last_nonmenu_event. Don't do this if the event
4158 we're returning is (menu-bar), though; that indicates the
4159 beginning of the menu sequence, and we might as well leave
4160 that as the `event with parameters' for this selection. */
4162 && !EQ (event
->frame_or_window
, event
->arg
)
4163 && (event
->kind
== MENU_BAR_EVENT
4164 || event
->kind
== TOOL_BAR_EVENT
))
4165 *used_mouse_menu
= 1;
4168 /* Certain system events are non-key events. */
4170 && event
->kind
== NS_NONKEY_EVENT
)
4171 *used_mouse_menu
= 1;
4174 /* Wipe out this event, to catch bugs. */
4175 clear_event (event
);
4176 kbd_fetch_ptr
= event
+ 1;
4180 /* Try generating a mouse motion event. */
4181 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4183 struct frame
*f
= some_mouse_moved ();
4184 Lisp_Object bar_window
;
4185 enum scroll_bar_part part
;
4189 *kbp
= current_kboard
;
4190 /* Note that this uses F to determine which terminal to look at.
4191 If there is no valid info, it does not store anything
4192 so x remains nil. */
4195 /* XXX Can f or mouse_position_hook be NULL here? */
4196 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4197 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4202 /* Decide if we should generate a switch-frame event. Don't
4203 generate switch-frame events for motion outside of all Emacs
4209 frame
= FRAME_FOCUS_FRAME (f
);
4211 XSETFRAME (frame
, f
);
4213 if (! EQ (frame
, internal_last_event_frame
)
4214 && !EQ (frame
, selected_frame
))
4215 obj
= make_lispy_switch_frame (frame
);
4216 internal_last_event_frame
= frame
;
4219 /* If we didn't decide to make a switch-frame event, go ahead and
4220 return a mouse-motion event. */
4221 if (!NILP (x
) && NILP (obj
))
4222 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4225 /* We were promised by the above while loop that there was
4226 something for us to read! */
4229 input_pending
= readable_events (0);
4231 Vlast_event_frame
= internal_last_event_frame
;
4236 /* Process any non-user-visible events (currently X selection events),
4237 without reading any user-visible events. */
4240 process_special_events (void)
4242 struct input_event
*event
;
4244 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4246 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4249 if (event
== kbd_store_ptr
)
4253 /* If we find a stored X selection request, handle it now. */
4254 if (event
->kind
== SELECTION_REQUEST_EVENT
4255 || event
->kind
== SELECTION_CLEAR_EVENT
)
4259 /* Remove the event from the fifo buffer before processing;
4260 otherwise swallow_events called recursively could see it
4261 and process it again. To do this, we move the events
4262 between kbd_fetch_ptr and EVENT one slot to the right,
4265 struct input_event copy
= *event
;
4266 struct input_event
*beg
4267 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4268 ? kbd_buffer
: kbd_fetch_ptr
;
4271 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4272 else if (event
< beg
)
4274 if (event
> kbd_buffer
)
4275 memmove (kbd_buffer
+ 1, kbd_buffer
,
4276 (event
- kbd_buffer
) * sizeof (struct input_event
));
4277 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4278 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4279 memmove (beg
+ 1, beg
,
4280 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4281 * sizeof (struct input_event
));
4284 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4285 kbd_fetch_ptr
= kbd_buffer
+ 1;
4289 input_pending
= readable_events (0);
4290 x_handle_selection_event (©
);
4292 /* We're getting selection request events, but we don't have
4300 /* Process any events that are not user-visible, run timer events that
4301 are ripe, and return, without reading any user-visible events. */
4304 swallow_events (bool do_display
)
4306 unsigned old_timers_run
;
4308 process_special_events ();
4310 old_timers_run
= timers_run
;
4311 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4313 if (timers_run
!= old_timers_run
&& do_display
)
4314 redisplay_preserve_echo_area (7);
4317 /* Record the start of when Emacs is idle,
4318 for the sake of running idle-time timers. */
4321 timer_start_idle (void)
4323 /* If we are already in the idle state, do nothing. */
4324 if (timespec_valid_p (timer_idleness_start_time
))
4327 timer_idleness_start_time
= current_timespec ();
4328 timer_last_idleness_start_time
= timer_idleness_start_time
;
4330 /* Mark all idle-time timers as once again candidates for running. */
4331 call0 (intern ("internal-timer-start-idle"));
4334 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4337 timer_stop_idle (void)
4339 timer_idleness_start_time
= invalid_timespec ();
4342 /* Resume idle timer from last idle start time. */
4345 timer_resume_idle (void)
4347 if (timespec_valid_p (timer_idleness_start_time
))
4350 timer_idleness_start_time
= timer_last_idleness_start_time
;
4353 /* This is only for debugging. */
4354 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4356 /* List of elisp functions to call, delayed because they were generated in
4357 a context where Elisp could not be safely run (e.g. redisplay, signal,
4358 ...). Each element has the form (FUN . ARGS). */
4359 Lisp_Object pending_funcalls
;
4361 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4363 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4365 Lisp_Object
*vector
;
4367 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4369 vector
= XVECTOR (timer
)->contents
;
4370 if (! NILP (vector
[0]))
4373 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4378 /* Check whether a timer has fired. To prevent larger problems we simply
4379 disregard elements that are not proper timers. Do not make a circular
4380 timer list for the time being.
4382 Returns the time to wait until the next timer fires. If a
4383 timer is triggering now, return zero.
4384 If no timer is active, return -1.
4386 If a timer is ripe, we run it, with quitting turned off.
4387 In that case we return 0 to indicate that a new timer_check_2 call
4390 static struct timespec
4391 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4393 struct timespec nexttime
;
4394 struct timespec now
;
4395 struct timespec idleness_now
;
4396 Lisp_Object chosen_timer
;
4397 struct gcpro gcpro1
;
4399 nexttime
= invalid_timespec ();
4401 chosen_timer
= Qnil
;
4402 GCPRO1 (chosen_timer
);
4404 /* First run the code that was delayed. */
4405 while (CONSP (pending_funcalls
))
4407 Lisp_Object funcall
= XCAR (pending_funcalls
);
4408 pending_funcalls
= XCDR (pending_funcalls
);
4409 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4412 if (CONSP (timers
) || CONSP (idle_timers
))
4414 now
= current_timespec ();
4415 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4416 ? timespec_sub (now
, timer_idleness_start_time
)
4417 : make_timespec (0, 0));
4420 while (CONSP (timers
) || CONSP (idle_timers
))
4422 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4423 struct timespec timer_time
, idle_timer_time
;
4424 struct timespec difference
;
4425 struct timespec timer_difference
= invalid_timespec ();
4426 struct timespec idle_timer_difference
= invalid_timespec ();
4427 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4429 /* Set TIMER and TIMER_DIFFERENCE
4430 based on the next ordinary timer.
4431 TIMER_DIFFERENCE is the distance in time from NOW to when
4432 this timer becomes ripe (negative if it's already ripe).
4433 Skip past invalid timers and timers already handled. */
4436 timer
= XCAR (timers
);
4437 if (! decode_timer (timer
, &timer_time
))
4439 timers
= XCDR (timers
);
4443 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4444 timer_difference
= (timer_ripe
4445 ? timespec_sub (now
, timer_time
)
4446 : timespec_sub (timer_time
, now
));
4449 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4450 based on the next idle timer. */
4451 if (CONSP (idle_timers
))
4453 idle_timer
= XCAR (idle_timers
);
4454 if (! decode_timer (idle_timer
, &idle_timer_time
))
4456 idle_timers
= XCDR (idle_timers
);
4460 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4461 idle_timer_difference
4463 ? timespec_sub (idleness_now
, idle_timer_time
)
4464 : timespec_sub (idle_timer_time
, idleness_now
));
4467 /* Decide which timer is the next timer,
4468 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4469 Also step down the list where we found that timer. */
4471 if (timespec_valid_p (timer_difference
)
4472 && (! timespec_valid_p (idle_timer_difference
)
4473 || idle_timer_ripe
< timer_ripe
4474 || (idle_timer_ripe
== timer_ripe
4476 ? timespec_cmp (idle_timer_difference
,
4478 : timespec_cmp (timer_difference
,
4479 idle_timer_difference
))
4482 chosen_timer
= timer
;
4483 timers
= XCDR (timers
);
4484 difference
= timer_difference
;
4489 chosen_timer
= idle_timer
;
4490 idle_timers
= XCDR (idle_timers
);
4491 difference
= idle_timer_difference
;
4492 ripe
= idle_timer_ripe
;
4495 /* If timer is ripe, run it if it hasn't been run. */
4498 if (NILP (AREF (chosen_timer
, 0)))
4500 ptrdiff_t count
= SPECPDL_INDEX ();
4501 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4503 /* Mark the timer as triggered to prevent problems if the lisp
4504 code fails to reschedule it right. */
4505 ASET (chosen_timer
, 0, Qt
);
4507 specbind (Qinhibit_quit
, Qt
);
4509 call1 (Qtimer_event_handler
, chosen_timer
);
4510 Vdeactivate_mark
= old_deactivate_mark
;
4512 unbind_to (count
, Qnil
);
4514 /* Since we have handled the event,
4515 we don't need to tell the caller to wake up and do it. */
4516 /* But the caller must still wait for the next timer, so
4517 return 0 to indicate that. */
4520 nexttime
= make_timespec (0, 0);
4524 /* When we encounter a timer that is still waiting,
4525 return the amount of time to wait before it is ripe. */
4532 /* No timers are pending in the future. */
4533 /* Return 0 if we generated an event, and -1 if not. */
4539 /* Check whether a timer has fired. To prevent larger problems we simply
4540 disregard elements that are not proper timers. Do not make a circular
4541 timer list for the time being.
4543 Returns the time to wait until the next timer fires.
4544 If no timer is active, return an invalid value.
4546 As long as any timer is ripe, we run it. */
4551 struct timespec nexttime
;
4552 Lisp_Object timers
, idle_timers
;
4553 struct gcpro gcpro1
, gcpro2
;
4555 Lisp_Object tem
= Vinhibit_quit
;
4558 /* We use copies of the timers' lists to allow a timer to add itself
4559 again, without locking up Emacs if the newly added timer is
4560 already ripe when added. */
4562 /* Always consider the ordinary timers. */
4563 timers
= Fcopy_sequence (Vtimer_list
);
4564 /* Consider the idle timers only if Emacs is idle. */
4565 if (timespec_valid_p (timer_idleness_start_time
))
4566 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4570 Vinhibit_quit
= tem
;
4572 GCPRO2 (timers
, idle_timers
);
4576 nexttime
= timer_check_2 (timers
, idle_timers
);
4578 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4584 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4585 doc
: /* Return the current length of Emacs idleness, or nil.
4586 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4587 in the same style as (current-time).
4589 The value when Emacs is not idle is nil.
4591 PSEC is a multiple of the system clock resolution. */)
4594 if (timespec_valid_p (timer_idleness_start_time
))
4595 return make_lisp_time (timespec_sub (current_timespec (),
4596 timer_idleness_start_time
));
4601 /* Caches for modify_event_symbol. */
4602 static Lisp_Object accent_key_syms
;
4603 static Lisp_Object func_key_syms
;
4604 static Lisp_Object mouse_syms
;
4605 static Lisp_Object wheel_syms
;
4606 static Lisp_Object drag_n_drop_syms
;
4608 /* This is a list of keysym codes for special "accent" characters.
4609 It parallels lispy_accent_keys. */
4611 static const int lispy_accent_codes
[] =
4613 #ifdef XK_dead_circumflex
4618 #ifdef XK_dead_grave
4623 #ifdef XK_dead_tilde
4628 #ifdef XK_dead_diaeresis
4633 #ifdef XK_dead_macron
4638 #ifdef XK_dead_degree
4643 #ifdef XK_dead_acute
4648 #ifdef XK_dead_cedilla
4653 #ifdef XK_dead_breve
4658 #ifdef XK_dead_ogonek
4663 #ifdef XK_dead_caron
4668 #ifdef XK_dead_doubleacute
4669 XK_dead_doubleacute
,
4673 #ifdef XK_dead_abovedot
4678 #ifdef XK_dead_abovering
4688 #ifdef XK_dead_belowdot
4693 #ifdef XK_dead_voiced_sound
4694 XK_dead_voiced_sound
,
4698 #ifdef XK_dead_semivoiced_sound
4699 XK_dead_semivoiced_sound
,
4715 /* This is a list of Lisp names for special "accent" characters.
4716 It parallels lispy_accent_codes. */
4718 static const char *const lispy_accent_keys
[] =
4736 "dead-voiced-sound",
4737 "dead-semivoiced-sound",
4743 #define FUNCTION_KEY_OFFSET 0x0
4745 const char *const lispy_function_keys
[] =
4749 0, /* VK_LBUTTON 0x01 */
4750 0, /* VK_RBUTTON 0x02 */
4751 "cancel", /* VK_CANCEL 0x03 */
4752 0, /* VK_MBUTTON 0x04 */
4754 0, 0, 0, /* 0x05 .. 0x07 */
4756 "backspace", /* VK_BACK 0x08 */
4757 "tab", /* VK_TAB 0x09 */
4759 0, 0, /* 0x0A .. 0x0B */
4761 "clear", /* VK_CLEAR 0x0C */
4762 "return", /* VK_RETURN 0x0D */
4764 0, 0, /* 0x0E .. 0x0F */
4766 0, /* VK_SHIFT 0x10 */
4767 0, /* VK_CONTROL 0x11 */
4768 0, /* VK_MENU 0x12 */
4769 "pause", /* VK_PAUSE 0x13 */
4770 "capslock", /* VK_CAPITAL 0x14 */
4771 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4773 "junja", /* VK_JUNJA 0x17 */
4774 "final", /* VK_FINAL 0x18 */
4775 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4777 "escape", /* VK_ESCAPE 0x1B */
4778 "convert", /* VK_CONVERT 0x1C */
4779 "non-convert", /* VK_NONCONVERT 0x1D */
4780 "accept", /* VK_ACCEPT 0x1E */
4781 "mode-change", /* VK_MODECHANGE 0x1F */
4782 0, /* VK_SPACE 0x20 */
4783 "prior", /* VK_PRIOR 0x21 */
4784 "next", /* VK_NEXT 0x22 */
4785 "end", /* VK_END 0x23 */
4786 "home", /* VK_HOME 0x24 */
4787 "left", /* VK_LEFT 0x25 */
4788 "up", /* VK_UP 0x26 */
4789 "right", /* VK_RIGHT 0x27 */
4790 "down", /* VK_DOWN 0x28 */
4791 "select", /* VK_SELECT 0x29 */
4792 "print", /* VK_PRINT 0x2A */
4793 "execute", /* VK_EXECUTE 0x2B */
4794 "snapshot", /* VK_SNAPSHOT 0x2C */
4795 "insert", /* VK_INSERT 0x2D */
4796 "delete", /* VK_DELETE 0x2E */
4797 "help", /* VK_HELP 0x2F */
4799 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4801 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4803 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4805 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4807 0, 0, 0, 0, 0, 0, 0, 0, 0,
4808 0, 0, 0, 0, 0, 0, 0, 0, 0,
4809 0, 0, 0, 0, 0, 0, 0, 0,
4811 "lwindow", /* VK_LWIN 0x5B */
4812 "rwindow", /* VK_RWIN 0x5C */
4813 "apps", /* VK_APPS 0x5D */
4816 "kp-0", /* VK_NUMPAD0 0x60 */
4817 "kp-1", /* VK_NUMPAD1 0x61 */
4818 "kp-2", /* VK_NUMPAD2 0x62 */
4819 "kp-3", /* VK_NUMPAD3 0x63 */
4820 "kp-4", /* VK_NUMPAD4 0x64 */
4821 "kp-5", /* VK_NUMPAD5 0x65 */
4822 "kp-6", /* VK_NUMPAD6 0x66 */
4823 "kp-7", /* VK_NUMPAD7 0x67 */
4824 "kp-8", /* VK_NUMPAD8 0x68 */
4825 "kp-9", /* VK_NUMPAD9 0x69 */
4826 "kp-multiply", /* VK_MULTIPLY 0x6A */
4827 "kp-add", /* VK_ADD 0x6B */
4828 "kp-separator", /* VK_SEPARATOR 0x6C */
4829 "kp-subtract", /* VK_SUBTRACT 0x6D */
4830 "kp-decimal", /* VK_DECIMAL 0x6E */
4831 "kp-divide", /* VK_DIVIDE 0x6F */
4832 "f1", /* VK_F1 0x70 */
4833 "f2", /* VK_F2 0x71 */
4834 "f3", /* VK_F3 0x72 */
4835 "f4", /* VK_F4 0x73 */
4836 "f5", /* VK_F5 0x74 */
4837 "f6", /* VK_F6 0x75 */
4838 "f7", /* VK_F7 0x76 */
4839 "f8", /* VK_F8 0x77 */
4840 "f9", /* VK_F9 0x78 */
4841 "f10", /* VK_F10 0x79 */
4842 "f11", /* VK_F11 0x7A */
4843 "f12", /* VK_F12 0x7B */
4844 "f13", /* VK_F13 0x7C */
4845 "f14", /* VK_F14 0x7D */
4846 "f15", /* VK_F15 0x7E */
4847 "f16", /* VK_F16 0x7F */
4848 "f17", /* VK_F17 0x80 */
4849 "f18", /* VK_F18 0x81 */
4850 "f19", /* VK_F19 0x82 */
4851 "f20", /* VK_F20 0x83 */
4852 "f21", /* VK_F21 0x84 */
4853 "f22", /* VK_F22 0x85 */
4854 "f23", /* VK_F23 0x86 */
4855 "f24", /* VK_F24 0x87 */
4857 0, 0, 0, 0, /* 0x88 .. 0x8B */
4858 0, 0, 0, 0, /* 0x8C .. 0x8F */
4860 "kp-numlock", /* VK_NUMLOCK 0x90 */
4861 "scroll", /* VK_SCROLL 0x91 */
4862 /* Not sure where the following block comes from.
4863 Windows headers have NEC and Fujitsu specific keys in
4864 this block, but nothing generic. */
4865 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4866 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4867 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4868 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4869 "kp-end", /* VK_NUMPAD_END 0x96 */
4870 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4871 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4872 "kp-up", /* VK_NUMPAD_UP 0x99 */
4873 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4874 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4875 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4876 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4878 0, 0, /* 0x9E .. 0x9F */
4881 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4882 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4883 * No other API or message will distinguish left and right keys this way.
4888 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4889 to enable them selectively, and gives access to a few more functions.
4890 See lispy_multimedia_keys below. */
4891 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4892 0, 0, 0, /* 0xAD .. 0xAF Volume */
4893 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4894 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4896 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4897 0, 0, 0, 0, 0, 0, 0, 0, 0,
4899 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4900 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4901 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4904 "ax", /* VK_OEM_AX 0xE1 */
4905 0, /* VK_OEM_102 0xE2 */
4906 "ico-help", /* VK_ICO_HELP 0xE3 */
4907 "ico-00", /* VK_ICO_00 0xE4 */
4908 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4909 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4910 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4912 "reset", /* VK_OEM_RESET 0xE9 */
4913 "jump", /* VK_OEM_JUMP 0xEA */
4914 "oem-pa1", /* VK_OEM_PA1 0xEB */
4915 "oem-pa2", /* VK_OEM_PA2 0xEC */
4916 "oem-pa3", /* VK_OEM_PA3 0xED */
4917 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4918 "cusel", /* VK_OEM_CUSEL 0xEF */
4919 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4920 "finish", /* VK_OEM_FINISH 0xF1 */
4921 "copy", /* VK_OEM_COPY 0xF2 */
4922 "auto", /* VK_OEM_AUTO 0xF3 */
4923 "enlw", /* VK_OEM_ENLW 0xF4 */
4924 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4925 "attn", /* VK_ATTN 0xF6 */
4926 "crsel", /* VK_CRSEL 0xF7 */
4927 "exsel", /* VK_EXSEL 0xF8 */
4928 "ereof", /* VK_EREOF 0xF9 */
4929 "play", /* VK_PLAY 0xFA */
4930 "zoom", /* VK_ZOOM 0xFB */
4931 "noname", /* VK_NONAME 0xFC */
4932 "pa1", /* VK_PA1 0xFD */
4933 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4937 /* Some of these duplicate the "Media keys" on newer keyboards,
4938 but they are delivered to the application in a different way. */
4939 static const char *const lispy_multimedia_keys
[] =
4947 "browser-favorites",
4984 "toggle-dictate-command",
4990 "media-fast-forward",
4993 "media-channel-down"
4996 #else /* not HAVE_NTGUI */
4998 /* This should be dealt with in XTread_socket now, and that doesn't
4999 depend on the client system having the Kana syms defined. See also
5000 the XK_kana_A case below. */
5003 static const char *const lispy_kana_keys
[] =
5005 /* X Keysym value */
5006 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5007 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5008 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5009 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5010 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5011 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5012 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5013 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5014 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5015 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5016 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5017 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5018 "kana-i", "kana-u", "kana-e", "kana-o",
5019 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5020 "prolongedsound", "kana-A", "kana-I", "kana-U",
5021 "kana-E", "kana-O", "kana-KA", "kana-KI",
5022 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5023 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5024 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5025 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5026 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5027 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5028 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5029 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5030 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5031 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5032 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5033 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5035 #endif /* XK_kana_A */
5038 #define FUNCTION_KEY_OFFSET 0xff00
5040 /* You'll notice that this table is arranged to be conveniently
5041 indexed by X Windows keysym values. */
5042 static const char *const lispy_function_keys
[] =
5044 /* X Keysym value */
5046 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5047 "backspace", "tab", "linefeed", "clear",
5049 0, 0, 0, "pause", /* 0xff10...1f */
5050 0, 0, 0, 0, 0, 0, 0, "escape",
5052 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5053 "romaji", "hiragana", "katakana", "hiragana-katakana",
5054 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5055 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5056 "eisu-toggle", /* 0xff30...3f */
5057 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5058 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5060 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5061 "down", "prior", "next", "end",
5062 "begin", 0, 0, 0, 0, 0, 0, 0,
5063 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5074 "break", /* 0xff6b */
5077 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5078 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5079 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5080 0, 0, 0, 0, 0, 0, 0, 0,
5081 "kp-tab", /* 0xff89 */
5083 "kp-enter", /* 0xff8d */
5085 "kp-f1", /* 0xff91 */
5089 "kp-home", /* 0xff95 */
5094 "kp-prior", /* kp-page-up */
5095 "kp-next", /* kp-page-down */
5101 0, 0, 0, 0, 0, 0, 0, 0, 0,
5102 "kp-multiply", /* 0xffaa */
5107 "kp-divide", /* 0xffaf */
5108 "kp-0", /* 0xffb0 */
5109 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5112 "kp-equal", /* 0xffbd */
5113 "f1", /* 0xffbe */ /* IsFunctionKey */
5115 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5116 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5117 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5118 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5119 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5120 0, 0, 0, 0, 0, 0, 0, 0,
5121 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5122 0, 0, 0, 0, 0, 0, 0, "delete"
5125 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5126 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5128 static const char *const iso_lispy_function_keys
[] =
5130 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5131 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5132 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5133 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5134 "iso-lefttab", /* 0xfe20 */
5135 "iso-move-line-up", "iso-move-line-down",
5136 "iso-partial-line-up", "iso-partial-line-down",
5137 "iso-partial-space-left", "iso-partial-space-right",
5138 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5139 "iso-release-margin-left", "iso-release-margin-right",
5140 "iso-release-both-margins",
5141 "iso-fast-cursor-left", "iso-fast-cursor-right",
5142 "iso-fast-cursor-up", "iso-fast-cursor-down",
5143 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5144 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5147 #endif /* not HAVE_NTGUI */
5149 static Lisp_Object Vlispy_mouse_stem
;
5151 static const char *const lispy_wheel_names
[] =
5153 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5156 /* drag-n-drop events are generated when a set of selected files are
5157 dragged from another application and dropped onto an Emacs window. */
5158 static const char *const lispy_drag_n_drop_names
[] =
5163 /* Scroll bar parts. */
5164 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5165 static Lisp_Object Qbefore_handle
, Qhorizontal_handle
, Qafter_handle
;
5166 Lisp_Object Qup
, Qdown
, Qtop
, Qbottom
;
5167 Lisp_Object Qleft
, Qright
;
5168 static Lisp_Object Qleftmost
, Qrightmost
;
5169 static Lisp_Object Qend_scroll
;
5170 static Lisp_Object Qratio
;
5172 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5173 static Lisp_Object
*const scroll_bar_parts
[] = {
5174 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5175 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
,
5176 &Qbefore_handle
, &Qhorizontal_handle
, &Qafter_handle
,
5177 &Qleft
, &Qright
, &Qleftmost
, &Qrightmost
, &Qend_scroll
, &Qratio
5180 /* A vector, indexed by button number, giving the down-going location
5181 of currently depressed buttons, both scroll bar and non-scroll bar.
5183 The elements have the form
5184 (BUTTON-NUMBER MODIFIER-MASK . REST)
5185 where REST is the cdr of a position as it would be reported in the event.
5187 The make_lispy_event function stores positions here to tell the
5188 difference between click and drag events, and to store the starting
5189 location to be included in drag events. */
5191 static Lisp_Object button_down_location
;
5193 /* Information about the most recent up-going button event: Which
5194 button, what location, and what time. */
5196 static int last_mouse_button
;
5197 static int last_mouse_x
;
5198 static int last_mouse_y
;
5199 static Time button_down_time
;
5201 /* The number of clicks in this multiple-click. */
5203 static int double_click_count
;
5205 /* X and Y are frame-relative coordinates for a click or wheel event.
5206 Return a Lisp-style event list. */
5209 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5212 enum window_part part
;
5213 Lisp_Object posn
= Qnil
;
5214 Lisp_Object extra_info
= Qnil
;
5215 /* Coordinate pixel positions to return. */
5216 int xret
= 0, yret
= 0;
5217 /* The window under frame pixel coordinates (x,y) */
5218 Lisp_Object window
= f
5219 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5222 if (WINDOWP (window
))
5224 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5225 struct window
*w
= XWINDOW (window
);
5226 Lisp_Object string_info
= Qnil
;
5227 ptrdiff_t textpos
= 0;
5228 int col
= -1, row
= -1;
5229 int dx
= -1, dy
= -1;
5230 int width
= -1, height
= -1;
5231 Lisp_Object object
= Qnil
;
5233 /* Pixel coordinates relative to the window corner. */
5234 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5235 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5237 /* For text area clicks, return X, Y relative to the corner of
5238 this text area. Note that dX, dY etc are set below, by
5239 buffer_posn_from_coords. */
5240 if (part
== ON_TEXT
)
5242 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5243 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5245 /* For mode line and header line clicks, return X, Y relative to
5246 the left window edge. Use mode_line_string to look for a
5247 string on the click position. */
5248 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5253 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5254 /* Note that mode_line_string takes COL, ROW as pixels and
5255 converts them to characters. */
5258 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5259 &object
, &dx
, &dy
, &width
, &height
);
5260 if (STRINGP (string
))
5261 string_info
= Fcons (string
, make_number (charpos
));
5267 /* For fringes and margins, Y is relative to the area's (and the
5268 window's) top edge, while X is meaningless. */
5269 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5274 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5277 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5278 &object
, &dx
, &dy
, &width
, &height
);
5279 if (STRINGP (string
))
5280 string_info
= Fcons (string
, make_number (charpos
));
5281 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5283 else if (part
== ON_LEFT_FRINGE
)
5285 posn
= Qleft_fringe
;
5288 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5289 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5290 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5292 else if (part
== ON_RIGHT_FRINGE
)
5294 posn
= Qright_fringe
;
5297 - window_box_width (w
, LEFT_MARGIN_AREA
)
5298 - window_box_width (w
, TEXT_AREA
)
5299 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5300 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5302 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5304 else if (part
== ON_VERTICAL_BORDER
)
5306 posn
= Qvertical_line
;
5311 /* Nothing special for part == ON_SCROLL_BAR. */
5312 else if (part
== ON_RIGHT_DIVIDER
)
5314 posn
= Qright_divider
;
5315 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5319 else if (part
== ON_BOTTOM_DIVIDER
)
5321 posn
= Qbottom_divider
;
5322 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5327 /* For clicks in the text area, fringes, or margins, call
5328 buffer_posn_from_coords to extract TEXTPOS, the buffer
5329 position nearest to the click. */
5332 Lisp_Object string2
, object2
= Qnil
;
5333 struct display_pos p
;
5335 int width2
, height2
;
5336 /* The pixel X coordinate passed to buffer_posn_from_coords
5337 is the X coordinate relative to the text area for
5338 text-area and right-margin clicks, zero otherwise. */
5340 = (part
== ON_TEXT
) ? xret
5341 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5342 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5346 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5347 &object2
, &dx2
, &dy2
,
5349 textpos
= CHARPOS (p
.pos
);
5350 if (col
< 0) col
= x2
;
5351 if (row
< 0) row
= y2
;
5352 if (dx
< 0) dx
= dx2
;
5353 if (dy
< 0) dy
= dy2
;
5354 if (width
< 0) width
= width2
;
5355 if (height
< 0) height
= height2
;
5359 posn
= make_number (textpos
);
5360 if (STRINGP (string2
))
5361 string_info
= Fcons (string2
,
5362 make_number (CHARPOS (p
.string_pos
)));
5368 #ifdef HAVE_WINDOW_SYSTEM
5369 if (IMAGEP (object
))
5371 Lisp_Object image_map
, hotspot
;
5372 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5374 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5376 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5377 posn
= XCAR (hotspot
);
5384 Fcons (make_number (dx
), make_number (dy
)),
5385 Fcons (make_number (width
), make_number (height
)));
5388 extra_info
= Fcons (string_info
,
5389 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5390 Fcons (Fcons (make_number (col
),
5395 XSETFRAME (window
, f
);
5399 return Fcons (window
,
5401 Fcons (Fcons (make_number (xret
),
5402 make_number (yret
)),
5403 Fcons (make_number (t
),
5407 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5408 menu bar. This really means that Emacs draws and manages the menu
5409 bar as part of its normal display, and therefore can compute its
5412 toolkit_menubar_in_use (struct frame
*f
)
5414 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5415 return !(!FRAME_WINDOW_P (f
));
5421 /* Given a struct input_event, build the lisp event which represents
5422 it. If EVENT is 0, build a mouse movement event from the mouse
5423 movement buffer, which should have a movement event in it.
5425 Note that events must be passed to this function in the order they
5426 are received; this function stores the location of button presses
5427 in order to build drag events when the button is released. */
5430 make_lispy_event (struct input_event
*event
)
5434 switch (event
->kind
)
5436 /* A simple keystroke. */
5437 case ASCII_KEYSTROKE_EVENT
:
5438 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5440 Lisp_Object lispy_c
;
5441 EMACS_INT c
= event
->code
;
5442 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5445 eassert (c
== event
->code
);
5446 /* Turn ASCII characters into control characters
5448 if (event
->modifiers
& ctrl_modifier
)
5450 c
= make_ctrl_char (c
);
5451 event
->modifiers
&= ~ctrl_modifier
;
5455 /* Add in the other modifier bits. The shift key was taken care
5456 of by the X code. */
5457 c
|= (event
->modifiers
5458 & (meta_modifier
| alt_modifier
5459 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5460 /* Distinguish Shift-SPC from SPC. */
5461 if ((event
->code
) == 040
5462 && event
->modifiers
& shift_modifier
)
5463 c
|= shift_modifier
;
5464 button_down_time
= 0;
5465 XSETFASTINT (lispy_c
, c
);
5470 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5471 except that they are non-key events (last-nonmenu-event is nil). */
5472 case NS_NONKEY_EVENT
:
5475 /* A function key. The symbol may need to have modifier prefixes
5477 case NON_ASCII_KEYSTROKE_EVENT
:
5478 button_down_time
= 0;
5480 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5481 if (event
->code
== lispy_accent_codes
[i
])
5482 return modify_event_symbol (i
,
5484 Qfunction_key
, Qnil
,
5485 lispy_accent_keys
, &accent_key_syms
,
5486 ARRAYELTS (lispy_accent_keys
));
5490 if (event
->code
>= 0x400 && event
->code
< 0x500)
5491 return modify_event_symbol (event
->code
- 0x400,
5492 event
->modifiers
& ~shift_modifier
,
5493 Qfunction_key
, Qnil
,
5494 lispy_kana_keys
, &func_key_syms
,
5495 ARRAYELTS (lispy_kana_keys
));
5496 #endif /* XK_kana_A */
5499 #ifdef ISO_FUNCTION_KEY_OFFSET
5500 if (event
->code
< FUNCTION_KEY_OFFSET
5501 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5502 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5504 Qfunction_key
, Qnil
,
5505 iso_lispy_function_keys
, &func_key_syms
,
5506 ARRAYELTS (iso_lispy_function_keys
));
5509 /* Handle system-specific or unknown keysyms. */
5510 if (event
->code
& (1 << 28)
5511 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5512 || (event
->code
- FUNCTION_KEY_OFFSET
5513 >= ARRAYELTS (lispy_function_keys
))
5514 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5516 /* We need to use an alist rather than a vector as the cache
5517 since we can't make a vector long enough. */
5518 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5519 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5520 return modify_event_symbol (event
->code
,
5523 KVAR (current_kboard
, Vsystem_key_alist
),
5524 0, &KVAR (current_kboard
, system_key_syms
),
5528 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5530 Qfunction_key
, Qnil
,
5531 lispy_function_keys
, &func_key_syms
,
5532 ARRAYELTS (lispy_function_keys
));
5535 case MULTIMEDIA_KEY_EVENT
:
5536 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5537 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5539 return modify_event_symbol (event
->code
, event
->modifiers
,
5540 Qfunction_key
, Qnil
,
5541 lispy_multimedia_keys
, &func_key_syms
,
5542 ARRAYELTS (lispy_multimedia_keys
));
5547 /* A mouse click. Figure out where it is, decide whether it's
5548 a press, click or drag, and build the appropriate structure. */
5549 case MOUSE_CLICK_EVENT
:
5551 case GPM_CLICK_EVENT
:
5553 #ifndef USE_TOOLKIT_SCROLL_BARS
5554 case SCROLL_BAR_CLICK_EVENT
:
5555 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5558 int button
= event
->code
;
5560 Lisp_Object position
;
5561 Lisp_Object
*start_pos_ptr
;
5562 Lisp_Object start_pos
;
5566 /* Build the position as appropriate for this mouse click. */
5567 if (event
->kind
== MOUSE_CLICK_EVENT
5569 || event
->kind
== GPM_CLICK_EVENT
5573 struct frame
*f
= XFRAME (event
->frame_or_window
);
5576 /* Ignore mouse events that were made on frame that
5577 have been deleted. */
5578 if (! FRAME_LIVE_P (f
))
5581 /* EVENT->x and EVENT->y are frame-relative pixel
5582 coordinates at this place. Under old redisplay, COLUMN
5583 and ROW are set to frame relative glyph coordinates
5584 which are then used to determine whether this click is
5585 in a menu (non-toolkit version). */
5586 if (!toolkit_menubar_in_use (f
))
5588 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5589 &column
, &row
, NULL
, 1);
5591 /* In the non-toolkit version, clicks on the menu bar
5592 are ordinary button events in the event buffer.
5593 Distinguish them, and invoke the menu.
5595 (In the toolkit version, the toolkit handles the
5596 menu bar and Emacs doesn't know about it until
5597 after the user makes a selection.) */
5598 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5599 && (event
->modifiers
& down_modifier
))
5601 Lisp_Object items
, item
;
5603 /* Find the menu bar item under `column'. */
5605 items
= FRAME_MENU_BAR_ITEMS (f
);
5606 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5608 Lisp_Object pos
, string
;
5609 string
= AREF (items
, i
+ 1);
5610 pos
= AREF (items
, i
+ 3);
5613 if (column
>= XINT (pos
)
5614 && column
< XINT (pos
) + SCHARS (string
))
5616 item
= AREF (items
, i
);
5621 /* ELisp manual 2.4b says (x y) are window
5622 relative but code says they are
5624 position
= list4 (event
->frame_or_window
,
5626 Fcons (event
->x
, event
->y
),
5627 make_number (event
->timestamp
));
5629 return list2 (item
, position
);
5633 position
= make_lispy_position (f
, event
->x
, event
->y
,
5636 #ifndef USE_TOOLKIT_SCROLL_BARS
5639 /* It's a scrollbar click. */
5641 Lisp_Object portion_whole
;
5644 window
= event
->frame_or_window
;
5645 portion_whole
= Fcons (event
->x
, event
->y
);
5646 part
= *scroll_bar_parts
[(int) event
->part
];
5648 position
= list5 (window
, Qvertical_scroll_bar
,
5649 portion_whole
, make_number (event
->timestamp
),
5652 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5654 if (button
>= ASIZE (button_down_location
))
5656 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5657 button_down_location
= larger_vector (button_down_location
,
5659 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5662 start_pos_ptr
= aref_addr (button_down_location
, button
);
5663 start_pos
= *start_pos_ptr
;
5664 *start_pos_ptr
= Qnil
;
5667 /* On window-system frames, use the value of
5668 double-click-fuzz as is. On other frames, interpret it
5669 as a multiple of 1/8 characters. */
5673 if (WINDOWP (event
->frame_or_window
))
5674 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5675 else if (FRAMEP (event
->frame_or_window
))
5676 f
= XFRAME (event
->frame_or_window
);
5680 if (FRAME_WINDOW_P (f
))
5681 fuzz
= double_click_fuzz
;
5683 fuzz
= double_click_fuzz
/ 8;
5685 is_double
= (button
== last_mouse_button
5686 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5687 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5688 && button_down_time
!= 0
5689 && (EQ (Vdouble_click_time
, Qt
)
5690 || (NATNUMP (Vdouble_click_time
)
5691 && (event
->timestamp
- button_down_time
5692 < XFASTINT (Vdouble_click_time
)))));
5695 last_mouse_button
= button
;
5696 last_mouse_x
= XINT (event
->x
);
5697 last_mouse_y
= XINT (event
->y
);
5699 /* If this is a button press, squirrel away the location, so
5700 we can decide later whether it was a click or a drag. */
5701 if (event
->modifiers
& down_modifier
)
5705 double_click_count
++;
5706 event
->modifiers
|= ((double_click_count
> 2)
5711 double_click_count
= 1;
5712 button_down_time
= event
->timestamp
;
5713 *start_pos_ptr
= Fcopy_alist (position
);
5714 ignore_mouse_drag_p
= 0;
5717 /* Now we're releasing a button - check the co-ordinates to
5718 see if this was a click or a drag. */
5719 else if (event
->modifiers
& up_modifier
)
5721 /* If we did not see a down before this up, ignore the up.
5722 Probably this happened because the down event chose a
5723 menu item. It would be an annoyance to treat the
5724 release of the button that chose the menu item as a
5727 if (!CONSP (start_pos
))
5730 event
->modifiers
&= ~up_modifier
;
5733 Lisp_Object new_down
, down
;
5734 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5736 /* The third element of every position
5737 should be the (x,y) pair. */
5738 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5739 new_down
= Fcar (Fcdr (Fcdr (position
)));
5742 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5744 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5745 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5748 if (ignore_mouse_drag_p
)
5750 event
->modifiers
|= click_modifier
;
5751 ignore_mouse_drag_p
= 0;
5753 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5754 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5755 /* Maybe the mouse has moved a lot, caused scrolling, and
5756 eventually ended up at the same screen position (but
5757 not buffer position) in which case it is a drag, not
5759 /* FIXME: OTOH if the buffer position has changed
5760 because of a timer or process filter rather than
5761 because of mouse movement, it should be considered as
5762 a click. But mouse-drag-region completely ignores
5763 this case and it hasn't caused any real problem, so
5764 it's probably OK to ignore it as well. */
5765 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5766 /* Mouse hasn't moved (much). */
5767 event
->modifiers
|= click_modifier
;
5770 button_down_time
= 0;
5771 event
->modifiers
|= drag_modifier
;
5774 /* Don't check is_double; treat this as multiple
5775 if the down-event was multiple. */
5776 if (double_click_count
> 1)
5777 event
->modifiers
|= ((double_click_count
> 2)
5783 /* Every mouse event should either have the down_modifier or
5784 the up_modifier set. */
5788 /* Get the symbol we should use for the mouse click. */
5791 head
= modify_event_symbol (button
,
5793 Qmouse_click
, Vlispy_mouse_stem
,
5796 ASIZE (mouse_syms
));
5797 if (event
->modifiers
& drag_modifier
)
5798 return list3 (head
, start_pos
, position
);
5799 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5800 return list3 (head
, position
, make_number (double_click_count
));
5802 return list2 (head
, position
);
5807 case HORIZ_WHEEL_EVENT
:
5809 Lisp_Object position
;
5812 /* Build the position as appropriate for this mouse click. */
5813 struct frame
*f
= XFRAME (event
->frame_or_window
);
5815 /* Ignore wheel events that were made on frame that have been
5817 if (! FRAME_LIVE_P (f
))
5820 position
= make_lispy_position (f
, event
->x
, event
->y
,
5823 /* Set double or triple modifiers to indicate the wheel speed. */
5825 /* On window-system frames, use the value of
5826 double-click-fuzz as is. On other frames, interpret it
5827 as a multiple of 1/8 characters. */
5833 if (WINDOWP (event
->frame_or_window
))
5834 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5835 else if (FRAMEP (event
->frame_or_window
))
5836 fr
= XFRAME (event
->frame_or_window
);
5840 fuzz
= FRAME_WINDOW_P (fr
)
5841 ? double_click_fuzz
: double_click_fuzz
/ 8;
5843 if (event
->modifiers
& up_modifier
)
5845 /* Emit a wheel-up event. */
5846 event
->modifiers
&= ~up_modifier
;
5849 else if (event
->modifiers
& down_modifier
)
5851 /* Emit a wheel-down event. */
5852 event
->modifiers
&= ~down_modifier
;
5856 /* Every wheel event should either have the down_modifier or
5857 the up_modifier set. */
5860 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5863 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5864 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5865 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5866 && button_down_time
!= 0
5867 && (EQ (Vdouble_click_time
, Qt
)
5868 || (NATNUMP (Vdouble_click_time
)
5869 && (event
->timestamp
- button_down_time
5870 < XFASTINT (Vdouble_click_time
)))));
5873 double_click_count
++;
5874 event
->modifiers
|= ((double_click_count
> 2)
5880 double_click_count
= 1;
5881 event
->modifiers
|= click_modifier
;
5884 button_down_time
= event
->timestamp
;
5885 /* Use a negative value to distinguish wheel from mouse button. */
5886 last_mouse_button
= - (1 + symbol_num
);
5887 last_mouse_x
= XINT (event
->x
);
5888 last_mouse_y
= XINT (event
->y
);
5890 /* Get the symbol we should use for the wheel event. */
5891 head
= modify_event_symbol (symbol_num
,
5897 ASIZE (wheel_syms
));
5900 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5901 return list3 (head
, position
, make_number (double_click_count
));
5903 return list2 (head
, position
);
5907 #ifdef USE_TOOLKIT_SCROLL_BARS
5909 /* We don't have down and up events if using toolkit scroll bars,
5910 so make this always a click event. Store in the `part' of
5911 the Lisp event a symbol which maps to the following actions:
5913 `above_handle' page up
5914 `below_handle' page down
5918 `bottom' bottom of buffer
5919 `handle' thumb has been dragged.
5920 `end-scroll' end of interaction with scroll bar
5922 The incoming input_event contains in its `part' member an
5923 index of type `enum scroll_bar_part' which we can use as an
5924 index in scroll_bar_parts to get the appropriate symbol. */
5926 case SCROLL_BAR_CLICK_EVENT
:
5928 Lisp_Object position
, head
, window
, portion_whole
, part
;
5930 window
= event
->frame_or_window
;
5931 portion_whole
= Fcons (event
->x
, event
->y
);
5932 part
= *scroll_bar_parts
[(int) event
->part
];
5934 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5935 make_number (event
->timestamp
), part
);
5937 /* Always treat scroll bar events as clicks. */
5938 event
->modifiers
|= click_modifier
;
5939 event
->modifiers
&= ~up_modifier
;
5941 if (event
->code
>= ASIZE (mouse_syms
))
5942 mouse_syms
= larger_vector (mouse_syms
,
5943 event
->code
- ASIZE (mouse_syms
) + 1,
5946 /* Get the symbol we should use for the mouse click. */
5947 head
= modify_event_symbol (event
->code
,
5952 ASIZE (mouse_syms
));
5953 return list2 (head
, position
);
5956 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5958 Lisp_Object position
, head
, window
, portion_whole
, part
;
5960 window
= event
->frame_or_window
;
5961 portion_whole
= Fcons (event
->x
, event
->y
);
5962 part
= *scroll_bar_parts
[(int) event
->part
];
5964 position
= list5 (window
, Qhorizontal_scroll_bar
, portion_whole
,
5965 make_number (event
->timestamp
), part
);
5967 /* Always treat scroll bar events as clicks. */
5968 event
->modifiers
|= click_modifier
;
5969 event
->modifiers
&= ~up_modifier
;
5971 if (event
->code
>= ASIZE (mouse_syms
))
5972 mouse_syms
= larger_vector (mouse_syms
,
5973 event
->code
- ASIZE (mouse_syms
) + 1,
5976 /* Get the symbol we should use for the mouse click. */
5977 head
= modify_event_symbol (event
->code
,
5982 ASIZE (mouse_syms
));
5983 return list2 (head
, position
);
5986 #endif /* USE_TOOLKIT_SCROLL_BARS */
5988 case DRAG_N_DROP_EVENT
:
5991 Lisp_Object head
, position
;
5994 f
= XFRAME (event
->frame_or_window
);
5997 /* Ignore mouse events that were made on frames that
5998 have been deleted. */
5999 if (! FRAME_LIVE_P (f
))
6002 position
= make_lispy_position (f
, event
->x
, event
->y
,
6005 head
= modify_event_symbol (0, event
->modifiers
,
6007 lispy_drag_n_drop_names
,
6008 &drag_n_drop_syms
, 1);
6009 return list3 (head
, position
, files
);
6012 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6013 || defined (HAVE_NS) || defined (USE_GTK)
6014 case MENU_BAR_EVENT
:
6015 if (EQ (event
->arg
, event
->frame_or_window
))
6016 /* This is the prefix key. We translate this to
6017 `(menu_bar)' because the code in keyboard.c for menu
6018 events, which we use, relies on this. */
6019 return list1 (Qmenu_bar
);
6023 case SELECT_WINDOW_EVENT
:
6024 /* Make an event (select-window (WINDOW)). */
6025 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6027 case TOOL_BAR_EVENT
:
6028 if (EQ (event
->arg
, event
->frame_or_window
))
6029 /* This is the prefix key. We translate this to
6030 `(tool_bar)' because the code in keyboard.c for tool bar
6031 events, which we use, relies on this. */
6032 return list1 (Qtool_bar
);
6033 else if (SYMBOLP (event
->arg
))
6034 return apply_modifiers (event
->modifiers
, event
->arg
);
6037 case USER_SIGNAL_EVENT
:
6038 /* A user signal. */
6040 char *name
= find_user_signal_name (event
->code
);
6043 return intern (name
);
6046 case SAVE_SESSION_EVENT
:
6047 return Qsave_session
;
6052 return Fcons (Qdbus_event
, event
->arg
);
6054 #endif /* HAVE_DBUS */
6056 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6057 case FILE_NOTIFY_EVENT
:
6059 return Fcons (Qfile_notify
, event
->arg
);
6061 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6063 case CONFIG_CHANGED_EVENT
:
6064 return list3 (Qconfig_changed_event
,
6065 event
->arg
, event
->frame_or_window
);
6067 /* The 'kind' field of the event is something we don't recognize. */
6074 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6075 Lisp_Object x
, Lisp_Object y
, Time t
)
6077 /* Is it a scroll bar movement? */
6078 if (frame
&& ! NILP (bar_window
))
6080 Lisp_Object part_sym
;
6082 part_sym
= *scroll_bar_parts
[(int) part
];
6083 return list2 (Qscroll_bar_movement
,
6085 Qvertical_scroll_bar
,
6090 /* Or is it an ordinary mouse movement? */
6093 Lisp_Object position
;
6094 position
= make_lispy_position (frame
, x
, y
, t
);
6095 return list2 (Qmouse_movement
, position
);
6099 /* Construct a switch frame event. */
6101 make_lispy_switch_frame (Lisp_Object frame
)
6103 return list2 (Qswitch_frame
, frame
);
6107 make_lispy_focus_in (Lisp_Object frame
)
6109 return list2 (Qfocus_in
, frame
);
6112 #ifdef HAVE_WINDOW_SYSTEM
6115 make_lispy_focus_out (Lisp_Object frame
)
6117 return list2 (Qfocus_out
, frame
);
6120 #endif /* HAVE_WINDOW_SYSTEM */
6122 /* Manipulating modifiers. */
6124 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6126 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6127 SYMBOL's name of the end of the modifiers; the string from this
6128 position is the unmodified symbol name.
6130 This doesn't use any caches. */
6133 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6139 CHECK_SYMBOL (symbol
);
6142 name
= SYMBOL_NAME (symbol
);
6144 for (i
= 0; i
< SBYTES (name
) - 1; )
6146 ptrdiff_t this_mod_end
= 0;
6149 /* See if the name continues with a modifier word.
6150 Check that the word appears, but don't check what follows it.
6151 Set this_mod and this_mod_end to record what we find. */
6153 switch (SREF (name
, i
))
6155 #define SINGLE_LETTER_MOD(BIT) \
6156 (this_mod_end = i + 1, this_mod = BIT)
6159 SINGLE_LETTER_MOD (alt_modifier
);
6163 SINGLE_LETTER_MOD (ctrl_modifier
);
6167 SINGLE_LETTER_MOD (hyper_modifier
);
6171 SINGLE_LETTER_MOD (meta_modifier
);
6175 SINGLE_LETTER_MOD (shift_modifier
);
6179 SINGLE_LETTER_MOD (super_modifier
);
6182 #undef SINGLE_LETTER_MOD
6184 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6185 if (i + LEN + 1 <= SBYTES (name) \
6186 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6188 this_mod_end = i + LEN; \
6193 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6194 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6195 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6199 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6201 #undef MULTI_LETTER_MOD
6205 /* If we found no modifier, stop looking for them. */
6206 if (this_mod_end
== 0)
6209 /* Check there is a dash after the modifier, so that it
6210 really is a modifier. */
6211 if (this_mod_end
>= SBYTES (name
)
6212 || SREF (name
, this_mod_end
) != '-')
6215 /* This modifier is real; look for another. */
6216 modifiers
|= this_mod
;
6217 i
= this_mod_end
+ 1;
6220 /* Should we include the `click' modifier? */
6221 if (! (modifiers
& (down_modifier
| drag_modifier
6222 | double_modifier
| triple_modifier
))
6223 && i
+ 7 == SBYTES (name
)
6224 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6225 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6226 modifiers
|= click_modifier
;
6228 if (! (modifiers
& (double_modifier
| triple_modifier
))
6229 && i
+ 6 < SBYTES (name
)
6230 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6231 modifiers
|= click_modifier
;
6239 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6240 prepended to the string BASE[0..BASE_LEN-1].
6241 This doesn't use any caches. */
6243 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6245 /* Since BASE could contain nulls, we can't use intern here; we have
6246 to use Fintern, which expects a genuine Lisp_String, and keeps a
6248 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6254 /* Only the event queue may use the `up' modifier; it should always
6255 be turned into a click or drag event before presented to lisp code. */
6256 if (modifiers
& up_modifier
)
6259 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6260 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6261 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6262 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6263 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6264 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6265 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6266 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6267 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6268 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6269 /* The click modifier is denoted by the absence of other modifiers. */
6273 mod_len
= p
- new_mods
;
6277 Lisp_Object new_name
;
6279 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6280 mod_len
+ base_len_byte
);
6281 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6282 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6284 return Fintern (new_name
, Qnil
);
6289 static const char *const modifier_names
[] =
6291 "up", "down", "drag", "click", "double", "triple", 0, 0,
6292 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6293 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6295 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6297 static Lisp_Object modifier_symbols
;
6299 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6301 lispy_modifier_list (int modifiers
)
6303 Lisp_Object modifier_list
;
6306 modifier_list
= Qnil
;
6307 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6308 if (modifiers
& (1<<i
))
6309 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6312 return modifier_list
;
6316 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6317 where UNMODIFIED is the unmodified form of SYMBOL,
6318 MASK is the set of modifiers present in SYMBOL's name.
6319 This is similar to parse_modifiers_uncached, but uses the cache in
6320 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6321 Qevent_symbol_elements property. */
6323 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6326 parse_modifiers (Lisp_Object symbol
)
6328 Lisp_Object elements
;
6330 if (INTEGERP (symbol
))
6331 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6332 else if (!SYMBOLP (symbol
))
6335 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6336 if (CONSP (elements
))
6341 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6342 Lisp_Object unmodified
;
6345 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6346 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6349 if (modifiers
& ~INTMASK
)
6351 XSETFASTINT (mask
, modifiers
);
6352 elements
= list2 (unmodified
, mask
);
6354 /* Cache the parsing results on SYMBOL. */
6355 Fput (symbol
, Qevent_symbol_element_mask
,
6357 Fput (symbol
, Qevent_symbol_elements
,
6358 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6360 /* Since we know that SYMBOL is modifiers applied to unmodified,
6361 it would be nice to put that in unmodified's cache.
6362 But we can't, since we're not sure that parse_modifiers is
6369 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6370 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6371 doc
: /* Parse the event symbol. For internal use. */)
6372 (Lisp_Object symbol
)
6374 /* Fill the cache if needed. */
6375 parse_modifiers (symbol
);
6376 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6377 and use the Lispier representation stored on Qevent_symbol_elements
6379 return Fget (symbol
, Qevent_symbol_elements
);
6382 /* Apply the modifiers MODIFIERS to the symbol BASE.
6383 BASE must be unmodified.
6385 This is like apply_modifiers_uncached, but uses BASE's
6386 Qmodifier_cache property, if present. It also builds
6387 Qevent_symbol_elements properties, since it has that info anyway.
6389 apply_modifiers copies the value of BASE's Qevent_kind property to
6390 the modified symbol. */
6392 apply_modifiers (int modifiers
, Lisp_Object base
)
6394 Lisp_Object cache
, idx
, entry
, new_symbol
;
6396 /* Mask out upper bits. We don't know where this value's been. */
6397 modifiers
&= INTMASK
;
6399 if (INTEGERP (base
))
6400 return make_number (XINT (base
) | modifiers
);
6402 /* The click modifier never figures into cache indices. */
6403 cache
= Fget (base
, Qmodifier_cache
);
6404 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6405 entry
= assq_no_quit (idx
, cache
);
6408 new_symbol
= XCDR (entry
);
6411 /* We have to create the symbol ourselves. */
6412 new_symbol
= apply_modifiers_uncached (modifiers
,
6413 SSDATA (SYMBOL_NAME (base
)),
6414 SCHARS (SYMBOL_NAME (base
)),
6415 SBYTES (SYMBOL_NAME (base
)));
6417 /* Add the new symbol to the base's cache. */
6418 entry
= Fcons (idx
, new_symbol
);
6419 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6421 /* We have the parsing info now for free, so we could add it to
6423 XSETFASTINT (idx, modifiers);
6424 Fput (new_symbol, Qevent_symbol_element_mask,
6426 Fput (new_symbol, Qevent_symbol_elements,
6427 Fcons (base, lispy_modifier_list (modifiers)));
6428 Sadly, this is only correct if `base' is indeed a base event,
6429 which is not necessarily the case. -stef */
6432 /* Make sure this symbol is of the same kind as BASE.
6434 You'd think we could just set this once and for all when we
6435 intern the symbol above, but reorder_modifiers may call us when
6436 BASE's property isn't set right; we can't assume that just
6437 because it has a Qmodifier_cache property it must have its
6438 Qevent_kind set right as well. */
6439 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6443 kind
= Fget (base
, Qevent_kind
);
6445 Fput (new_symbol
, Qevent_kind
, kind
);
6452 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6453 return a symbol with the modifiers placed in the canonical order.
6454 Canonical order is alphabetical, except for down and drag, which
6455 always come last. The 'click' modifier is never written out.
6457 Fdefine_key calls this to make sure that (for example) C-M-foo
6458 and M-C-foo end up being equivalent in the keymap. */
6461 reorder_modifiers (Lisp_Object symbol
)
6463 /* It's hopefully okay to write the code this way, since everything
6464 will soon be in caches, and no consing will be done at all. */
6467 parsed
= parse_modifiers (symbol
);
6468 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6473 /* For handling events, we often want to produce a symbol whose name
6474 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6475 to some base, like the name of a function key or mouse button.
6476 modify_event_symbol produces symbols of this sort.
6478 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6479 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6482 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6483 into symbol names, or a string specifying a name stem used to
6484 construct a symbol name or the form `STEM-N', where N is the decimal
6485 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6486 non-nil; otherwise NAME_TABLE is used.
6488 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6489 persist between calls to modify_event_symbol that it can use to
6490 store a cache of the symbols it's generated for this NAME_TABLE
6491 before. The object stored there may be a vector or an alist.
6493 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6495 MODIFIERS is a set of modifier bits (as given in struct input_events)
6496 whose prefixes should be applied to the symbol name.
6498 SYMBOL_KIND is the value to be placed in the event_kind property of
6499 the returned symbol.
6501 The symbols we create are supposed to have an
6502 `event-symbol-elements' property, which lists the modifiers present
6503 in the symbol's name. */
6506 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6507 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6508 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6511 Lisp_Object symbol_int
;
6513 /* Get rid of the "vendor-specific" bit here. */
6514 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6516 /* Is this a request for a valid symbol? */
6517 if (symbol_num
< 0 || symbol_num
>= table_size
)
6520 if (CONSP (*symbol_table
))
6521 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6523 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6524 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6525 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6526 we've never used that symbol before. */
6529 if (! VECTORP (*symbol_table
)
6530 || ASIZE (*symbol_table
) != table_size
)
6534 XSETFASTINT (size
, table_size
);
6535 *symbol_table
= Fmake_vector (size
, Qnil
);
6538 value
= AREF (*symbol_table
, symbol_num
);
6541 /* Have we already used this symbol before? */
6544 /* No; let's create it. */
6545 if (CONSP (name_alist_or_stem
))
6546 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6547 else if (STRINGP (name_alist_or_stem
))
6550 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6551 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6553 buf
= SAFE_ALLOCA (len
);
6554 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6555 XINT (symbol_int
) + 1);
6556 value
= intern (buf
);
6559 else if (name_table
!= 0 && name_table
[symbol_num
])
6560 value
= intern (name_table
[symbol_num
]);
6562 #ifdef HAVE_WINDOW_SYSTEM
6565 char *name
= x_get_keysym_name (symbol_num
);
6567 value
= intern (name
);
6573 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6574 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6575 value
= intern (buf
);
6578 if (CONSP (*symbol_table
))
6579 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6581 ASET (*symbol_table
, symbol_num
, value
);
6583 /* Fill in the cache entries for this symbol; this also
6584 builds the Qevent_symbol_elements property, which the user
6586 apply_modifiers (modifiers
& click_modifier
, value
);
6587 Fput (value
, Qevent_kind
, symbol_kind
);
6590 /* Apply modifiers to that symbol. */
6591 return apply_modifiers (modifiers
, value
);
6594 /* Convert a list that represents an event type,
6595 such as (ctrl meta backspace), into the usual representation of that
6596 event type as a number or a symbol. */
6598 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6599 doc
: /* Convert the event description list EVENT-DESC to an event type.
6600 EVENT-DESC should contain one base event type (a character or symbol)
6601 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6602 drag, down, double or triple). The base must be last.
6603 The return value is an event type (a character or symbol) which
6604 has the same base event type and all the specified modifiers. */)
6605 (Lisp_Object event_desc
)
6613 while (CONSP (rest
))
6621 /* Given a symbol, see if it is a modifier name. */
6622 if (SYMBOLP (elt
) && CONSP (rest
))
6623 this = parse_solitary_modifier (elt
);
6627 else if (!NILP (base
))
6628 error ("Two bases given in one event");
6634 /* Let the symbol A refer to the character A. */
6635 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6636 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6638 if (INTEGERP (base
))
6640 /* Turn (shift a) into A. */
6641 if ((modifiers
& shift_modifier
) != 0
6642 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6644 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6645 modifiers
&= ~shift_modifier
;
6648 /* Turn (control a) into C-a. */
6649 if (modifiers
& ctrl_modifier
)
6650 return make_number ((modifiers
& ~ctrl_modifier
)
6651 | make_ctrl_char (XINT (base
)));
6653 return make_number (modifiers
| XINT (base
));
6655 else if (SYMBOLP (base
))
6656 return apply_modifiers (modifiers
, base
);
6658 error ("Invalid base event");
6661 /* Try to recognize SYMBOL as a modifier name.
6662 Return the modifier flag bit, or 0 if not recognized. */
6665 parse_solitary_modifier (Lisp_Object symbol
)
6667 Lisp_Object name
= SYMBOL_NAME (symbol
);
6669 switch (SREF (name
, 0))
6671 #define SINGLE_LETTER_MOD(BIT) \
6672 if (SBYTES (name) == 1) \
6675 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6676 if (LEN == SBYTES (name) \
6677 && ! memcmp (SDATA (name), NAME, LEN)) \
6681 SINGLE_LETTER_MOD (alt_modifier
);
6685 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6689 SINGLE_LETTER_MOD (ctrl_modifier
);
6693 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6694 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6698 SINGLE_LETTER_MOD (hyper_modifier
);
6702 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6706 SINGLE_LETTER_MOD (meta_modifier
);
6710 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6714 SINGLE_LETTER_MOD (shift_modifier
);
6718 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6719 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6720 SINGLE_LETTER_MOD (super_modifier
);
6724 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6725 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6726 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6730 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6733 #undef SINGLE_LETTER_MOD
6734 #undef MULTI_LETTER_MOD
6740 /* Return true if EVENT is a list whose elements are all integers or symbols.
6741 Such a list is not valid as an event,
6742 but it can be a Lucid-style event type list. */
6745 lucid_event_type_list_p (Lisp_Object object
)
6749 if (! CONSP (object
))
6752 if (EQ (XCAR (object
), Qhelp_echo
)
6753 || EQ (XCAR (object
), Qvertical_line
)
6754 || EQ (XCAR (object
), Qmode_line
)
6755 || EQ (XCAR (object
), Qheader_line
))
6758 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6762 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6769 /* Return true if terminal input chars are available.
6770 Also, store the return value into INPUT_PENDING.
6772 Serves the purpose of ioctl (0, FIONREAD, ...)
6773 but works even if FIONREAD does not exist.
6774 (In fact, this may actually read some input.)
6776 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6777 timer events that are ripe.
6778 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6779 events (FOCUS_IN_EVENT).
6780 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6781 movements and toolkit scroll bar thumb drags. */
6784 get_input_pending (int flags
)
6786 /* First of all, have we already counted some input? */
6787 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6789 /* If input is being read as it arrives, and we have none, there is none. */
6790 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6792 /* Try to read some input and see how much we get. */
6794 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6797 return input_pending
;
6800 /* Put a BUFFER_SWITCH_EVENT in the buffer
6801 so that read_key_sequence will notice the new current buffer. */
6804 record_asynch_buffer_change (void)
6806 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6807 The purpose of the event is to make read_key_sequence look up the
6808 keymaps again. If we aren't in read_key_sequence, we don't need one,
6809 and the event could cause trouble by messing up (input-pending-p).
6810 Note: Fwaiting_for_user_input_p always returns nil when async
6811 subprocesses aren't supported. */
6812 if (!NILP (Fwaiting_for_user_input_p ()))
6814 struct input_event event
;
6817 event
.kind
= BUFFER_SWITCH_EVENT
;
6818 event
.frame_or_window
= Qnil
;
6821 /* Make sure no interrupt happens while storing the event. */
6823 if (interrupt_input
)
6824 kbd_buffer_store_event (&event
);
6829 kbd_buffer_store_event (&event
);
6835 /* Read any terminal input already buffered up by the system
6836 into the kbd_buffer, but do not wait.
6838 Return the number of keyboard chars read, or -1 meaning
6839 this is a bad time to try to read input. */
6848 /* Store pending user signal events, if any. */
6849 store_user_signal_events ();
6851 /* Loop through the available terminals, and call their input hooks. */
6855 struct terminal
*next
= t
->next_terminal
;
6857 if (t
->read_socket_hook
)
6860 struct input_event hold_quit
;
6862 if (input_blocked_p ())
6864 pending_signals
= 1;
6868 EVENT_INIT (hold_quit
);
6869 hold_quit
.kind
= NO_EVENT
;
6871 /* No need for FIONREAD or fcntl; just say don't wait. */
6872 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6875 if (nr
== -1) /* Not OK to read input now. */
6879 else if (nr
== -2) /* Non-transient error. */
6881 /* The terminal device terminated; it should be closed. */
6883 /* Kill Emacs if this was our last terminal. */
6884 if (!terminal_list
->next_terminal
)
6885 /* Formerly simply reported no input, but that
6886 sometimes led to a failure of Emacs to terminate.
6887 SIGHUP seems appropriate if we can't reach the
6889 /* ??? Is it really right to send the signal just to
6890 this process rather than to the whole process
6891 group? Perhaps on systems with FIONREAD Emacs is
6892 alone in its group. */
6893 terminate_due_to_signal (SIGHUP
, 10);
6895 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6898 XSETTERMINAL (tmp
, t
);
6899 Fdelete_terminal (tmp
, Qnoelisp
);
6903 /* If there was no error, make sure the pointer
6904 is visible for all frames on this terminal. */
6907 Lisp_Object tail
, frame
;
6909 FOR_EACH_FRAME (tail
, frame
)
6911 struct frame
*f
= XFRAME (frame
);
6912 if (FRAME_TERMINAL (f
) == t
)
6913 frame_make_pointer_visible (f
);
6917 if (hold_quit
.kind
!= NO_EVENT
)
6918 kbd_buffer_store_event (&hold_quit
);
6930 /* This is the tty way of reading available input.
6932 Note that each terminal device has its own `struct terminal' object,
6933 and so this function is called once for each individual termcap
6934 terminal. The first parameter indicates which terminal to read from. */
6937 tty_read_avail_input (struct terminal
*terminal
,
6938 struct input_event
*hold_quit
)
6940 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6941 the kbd_buffer can really hold. That may prevent loss
6942 of characters on some systems when input is stuffed at us. */
6943 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6945 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6948 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6950 if (kbd_on_hold_p () || buffer_free
<= 0)
6952 #endif /* subprocesses */
6954 if (!terminal
->name
) /* Don't read from a dead terminal. */
6957 if (terminal
->type
!= output_termcap
6958 && terminal
->type
!= output_msdos_raw
)
6961 /* XXX I think the following code should be moved to separate hook
6962 functions in system-dependent files. */
6964 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6965 code sets read_socket_hook to w32_console_read_socket instead! */
6967 #else /* not WINDOWSNT */
6968 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6972 return 0; /* The terminal is suspended. */
6975 n_to_read
= dos_keysns ();
6979 cbuf
[0] = dos_keyread ();
6982 #else /* not MSDOS */
6987 struct input_event gpm_hold_quit
;
6988 int gpm
, fd
= gpm_fd
;
6990 EVENT_INIT (gpm_hold_quit
);
6991 gpm_hold_quit
.kind
= NO_EVENT
;
6993 /* gpm==1 if event received.
6994 gpm==0 if the GPM daemon has closed the connection, in which case
6995 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6996 we save it in `fd' so close_gpm can remove it from the
6998 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6999 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7000 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7003 /* Presumably the GPM daemon has closed the connection. */
7005 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7006 kbd_buffer_store_event (&gpm_hold_quit
);
7010 #endif /* HAVE_GPM */
7012 /* Determine how many characters we should *try* to read. */
7013 #ifdef USABLE_FIONREAD
7014 /* Find out how much input is available. */
7015 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7017 if (! noninteractive
)
7018 return -2; /* Close this terminal. */
7024 if (n_to_read
> sizeof cbuf
)
7025 n_to_read
= sizeof cbuf
;
7026 #elif defined USG || defined CYGWIN
7027 /* Read some input if available, but don't wait. */
7028 n_to_read
= sizeof cbuf
;
7029 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7031 # error "Cannot read without possibly delaying"
7035 /* Don't read more than we can store. */
7036 if (n_to_read
> buffer_free
)
7037 n_to_read
= buffer_free
;
7038 #endif /* subprocesses */
7040 /* Now read; for one reason or another, this will not block.
7041 NREAD is set to the number of chars read. */
7044 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7045 /* POSIX infers that processes which are not in the session leader's
7046 process group won't get SIGHUPs at logout time. BSDI adheres to
7047 this part standard and returns -1 from read (0) with errno==EIO
7048 when the control tty is taken away.
7049 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7050 if (nread
== -1 && errno
== EIO
)
7051 return -2; /* Close this terminal. */
7052 #if defined (AIX) && defined (_BSD)
7053 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7054 This looks incorrect, but it isn't, because _BSD causes
7055 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7056 and that causes a value other than 0 when there is no input. */
7058 return -2; /* Close this terminal. */
7062 /* We used to retry the read if it was interrupted.
7063 But this does the wrong thing when O_NONBLOCK causes
7064 an EAGAIN error. Does anybody know of a situation
7065 where a retry is actually needed? */
7067 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7077 #ifndef USABLE_FIONREAD
7078 #if defined (USG) || defined (CYGWIN)
7079 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7080 #endif /* USG or CYGWIN */
7081 #endif /* no FIONREAD */
7086 #endif /* not MSDOS */
7087 #endif /* not WINDOWSNT */
7089 for (i
= 0; i
< nread
; i
++)
7091 struct input_event buf
;
7093 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7095 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7096 buf
.modifiers
= meta_modifier
;
7097 if (tty
->meta_key
!= 2)
7101 /* Set the frame corresponding to the active tty. Note that the
7102 value of selected_frame is not reliable here, redisplay tends
7103 to temporarily change it. */
7104 buf
.frame_or_window
= tty
->top_frame
;
7107 kbd_buffer_store_event (&buf
);
7108 /* Don't look at input that follows a C-g too closely.
7109 This reduces lossage due to autorepeat on C-g. */
7110 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7111 && buf
.code
== quit_char
)
7119 handle_async_input (void)
7124 int nread
= gobble_input ();
7125 /* -1 means it's not ok to read the input now.
7126 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7127 0 means there was no keyboard input available. */
7135 process_pending_signals (void)
7137 pending_signals
= 0;
7138 handle_async_input ();
7139 do_pending_atimers ();
7142 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7143 and reinvoke any pending signal if the level is now 0 and
7144 a fatal error is not already in progress. */
7147 unblock_input_to (int level
)
7149 interrupt_input_blocked
= level
;
7152 if (pending_signals
&& !fatal_error_in_progress
)
7153 process_pending_signals ();
7159 /* End critical section.
7161 If doing signal-driven input, and a signal came in when input was
7162 blocked, reinvoke the signal handler now to deal with it.
7164 It will also process queued input, if it was not read before.
7165 When a longer code sequence does not use block/unblock input
7166 at all, the whole input gathered up to the next call to
7167 unblock_input will be processed inside that call. */
7170 unblock_input (void)
7172 unblock_input_to (interrupt_input_blocked
- 1);
7175 /* Undo any number of BLOCK_INPUT calls,
7176 and also reinvoke any pending signal. */
7179 totally_unblock_input (void)
7181 unblock_input_to (0);
7187 handle_input_available_signal (int sig
)
7189 pending_signals
= 1;
7191 if (input_available_clear_time
)
7192 *input_available_clear_time
= make_timespec (0, 0);
7196 deliver_input_available_signal (int sig
)
7198 deliver_process_signal (sig
, handle_input_available_signal
);
7200 #endif /* USABLE_SIGIO */
7203 /* User signal events. */
7205 struct user_signal_info
7207 /* Signal number. */
7210 /* Name of the signal. */
7213 /* Number of pending signals. */
7216 struct user_signal_info
*next
;
7219 /* List of user signals. */
7220 static struct user_signal_info
*user_signals
= NULL
;
7223 add_user_signal (int sig
, const char *name
)
7225 struct sigaction action
;
7226 struct user_signal_info
*p
;
7228 for (p
= user_signals
; p
; p
= p
->next
)
7230 /* Already added. */
7233 p
= xmalloc (sizeof *p
);
7235 p
->name
= xstrdup (name
);
7237 p
->next
= user_signals
;
7240 emacs_sigaction_init (&action
, deliver_user_signal
);
7241 sigaction (sig
, &action
, 0);
7245 handle_user_signal (int sig
)
7247 struct user_signal_info
*p
;
7248 const char *special_event_name
= NULL
;
7250 if (SYMBOLP (Vdebug_on_event
))
7251 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7253 for (p
= user_signals
; p
; p
= p
->next
)
7256 if (special_event_name
7257 && strcmp (special_event_name
, p
->name
) == 0)
7259 /* Enter the debugger in many ways. */
7260 debug_on_next_call
= 1;
7263 Vinhibit_quit
= Qnil
;
7265 /* Eat the event. */
7271 if (interrupt_input
)
7272 handle_input_available_signal (sig
);
7276 /* Tell wait_reading_process_output that it needs to wake
7277 up and look around. */
7278 if (input_available_clear_time
)
7279 *input_available_clear_time
= make_timespec (0, 0);
7286 deliver_user_signal (int sig
)
7288 deliver_process_signal (sig
, handle_user_signal
);
7292 find_user_signal_name (int sig
)
7294 struct user_signal_info
*p
;
7296 for (p
= user_signals
; p
; p
= p
->next
)
7304 store_user_signal_events (void)
7306 struct user_signal_info
*p
;
7307 struct input_event buf
;
7308 bool buf_initialized
= 0;
7310 for (p
= user_signals
; p
; p
= p
->next
)
7311 if (p
->npending
> 0)
7313 if (! buf_initialized
)
7315 memset (&buf
, 0, sizeof buf
);
7316 buf
.kind
= USER_SIGNAL_EVENT
;
7317 buf
.frame_or_window
= selected_frame
;
7318 buf_initialized
= 1;
7324 kbd_buffer_store_event (&buf
);
7327 while (p
->npending
> 0);
7332 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7333 static Lisp_Object menu_bar_one_keymap_changed_items
;
7335 /* These variables hold the vector under construction within
7336 menu_bar_items and its subroutines, and the current index
7337 for storing into that vector. */
7338 static Lisp_Object menu_bar_items_vector
;
7339 static int menu_bar_items_index
;
7342 static const char *separator_names
[] = {
7347 "single-dashed-line",
7348 "double-dashed-line",
7350 "shadow-etched-out",
7351 "shadow-etched-in-dash",
7352 "shadow-etched-out-dash",
7353 "shadow-double-etched-in",
7354 "shadow-double-etched-out",
7355 "shadow-double-etched-in-dash",
7356 "shadow-double-etched-out-dash",
7360 /* Return true if LABEL specifies a separator. */
7363 menu_separator_name_p (const char *label
)
7367 else if (strlen (label
) > 3
7368 && memcmp (label
, "--", 2) == 0
7373 for (i
= 0; separator_names
[i
]; ++i
)
7374 if (strcmp (label
, separator_names
[i
]) == 0)
7379 /* It's a separator if it contains only dashes. */
7380 while (*label
== '-')
7382 return (*label
== 0);
7389 /* Return a vector of menu items for a menu bar, appropriate
7390 to the current buffer. Each item has three elements in the vector:
7393 OLD is an old vector we can optionally reuse, or nil. */
7396 menu_bar_items (Lisp_Object old
)
7398 /* The number of keymaps we're scanning right now, and the number of
7399 keymaps we have allocated space for. */
7402 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7403 in the current keymaps, or nil where it is not a prefix. */
7406 Lisp_Object def
, tail
;
7411 /* In order to build the menus, we need to call the keymap
7412 accessors. They all call QUIT. But this function is called
7413 during redisplay, during which a quit is fatal. So inhibit
7414 quitting while building the menus.
7415 We do this instead of specbind because (1) errors will clear it anyway
7416 and (2) this avoids risk of specpdl overflow. */
7417 oquit
= Vinhibit_quit
;
7421 menu_bar_items_vector
= old
;
7423 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7424 menu_bar_items_index
= 0;
7426 /* Build our list of keymaps.
7427 If we recognize a function key and replace its escape sequence in
7428 keybuf with its symbol, or if the sequence starts with a mouse
7429 click and we need to switch buffers, we jump back here to rebuild
7430 the initial keymaps from the current buffer. */
7434 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7435 if (!NILP (Voverriding_local_map_menu_flag
)
7436 && !NILP (Voverriding_local_map
))
7438 /* Yes, use them (if non-nil) as well as the global map. */
7439 maps
= alloca (3 * sizeof (maps
[0]));
7441 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7442 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7443 if (!NILP (Voverriding_local_map
))
7444 maps
[nmaps
++] = Voverriding_local_map
;
7448 /* No, so use major and minor mode keymaps and keymap property.
7449 Note that menu-bar bindings in the local-map and keymap
7450 properties may not work reliable, as they are only
7451 recognized when the menu-bar (or mode-line) is updated,
7452 which does not normally happen after every command. */
7455 nminor
= current_minor_maps (NULL
, &tmaps
);
7456 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7458 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7459 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7460 maps
[nmaps
++] = tem
;
7461 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7462 maps
[nmaps
++] = tem
;
7463 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7465 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7467 maps
[nmaps
++] = current_global_map
;
7470 /* Look up in each map the dummy prefix key `menu-bar'. */
7472 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7473 if (!NILP (maps
[mapno
]))
7475 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7479 menu_bar_one_keymap_changed_items
= Qnil
;
7480 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7484 /* Move to the end those items that should be at the end. */
7486 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7489 int end
= menu_bar_items_index
;
7491 for (i
= 0; i
< end
; i
+= 4)
7492 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7494 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7495 /* Move the item at index I to the end,
7496 shifting all the others forward. */
7497 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7498 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7499 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7500 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7502 memmove (aref_addr (menu_bar_items_vector
, i
),
7503 aref_addr (menu_bar_items_vector
, i
+ 4),
7504 (end
- i
- 4) * word_size
);
7505 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7506 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7507 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7508 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7513 /* Add nil, nil, nil, nil at the end. */
7515 int i
= menu_bar_items_index
;
7516 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7517 menu_bar_items_vector
7518 = larger_vector (menu_bar_items_vector
, 4, -1);
7519 /* Add this item. */
7520 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7521 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7522 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7523 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7524 menu_bar_items_index
= i
;
7527 Vinhibit_quit
= oquit
;
7528 return menu_bar_items_vector
;
7531 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7532 If there's already an item for KEY, add this DEF to it. */
7534 Lisp_Object item_properties
;
7537 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7539 struct gcpro gcpro1
;
7544 if (EQ (item
, Qundefined
))
7546 /* If a map has an explicit `undefined' as definition,
7547 discard any previously made menu bar item. */
7549 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7550 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7552 if (menu_bar_items_index
> i
+ 4)
7553 memmove (aref_addr (menu_bar_items_vector
, i
),
7554 aref_addr (menu_bar_items_vector
, i
+ 4),
7555 (menu_bar_items_index
- i
- 4) * word_size
);
7556 menu_bar_items_index
-= 4;
7560 /* If this keymap has already contributed to this KEY,
7561 don't contribute to it a second time. */
7562 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7563 if (!NILP (tem
) || NILP (item
))
7566 menu_bar_one_keymap_changed_items
7567 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7569 /* We add to menu_bar_one_keymap_changed_items before doing the
7570 parse_menu_item, so that if it turns out it wasn't a menu item,
7571 it still correctly hides any further menu item. */
7573 parsed
= parse_menu_item (item
, 1);
7578 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7580 /* Find any existing item for this KEY. */
7581 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7582 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7585 /* If we did not find this KEY, add it at the end. */
7586 if (i
== menu_bar_items_index
)
7588 /* If vector is too small, get a bigger one. */
7589 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7590 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7591 /* Add this item. */
7592 ASET (menu_bar_items_vector
, i
, key
); i
++;
7593 ASET (menu_bar_items_vector
, i
,
7594 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7595 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7596 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7597 menu_bar_items_index
= i
;
7599 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7603 old
= AREF (menu_bar_items_vector
, i
+ 2);
7604 /* If the new and the old items are not both keymaps,
7605 the lookup will only find `item'. */
7606 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7607 ASET (menu_bar_items_vector
, i
+ 2, item
);
7611 /* This is used as the handler when calling menu_item_eval_property. */
7613 menu_item_eval_property_1 (Lisp_Object arg
)
7615 /* If we got a quit from within the menu computation,
7616 quit all the way out of it. This takes care of C-] in the debugger. */
7617 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7618 Fsignal (Qquit
, Qnil
);
7624 eval_dyn (Lisp_Object form
)
7626 return Feval (form
, Qnil
);
7629 /* Evaluate an expression and return the result (or nil if something
7630 went wrong). Used to evaluate dynamic parts of menu items. */
7632 menu_item_eval_property (Lisp_Object sexpr
)
7634 ptrdiff_t count
= SPECPDL_INDEX ();
7636 specbind (Qinhibit_redisplay
, Qt
);
7637 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7638 menu_item_eval_property_1
);
7639 return unbind_to (count
, val
);
7642 /* This function parses a menu item and leaves the result in the
7643 vector item_properties.
7644 ITEM is a key binding, a possible menu item.
7645 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7647 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7648 parse_menu_item returns true if the item is a menu item and false
7652 parse_menu_item (Lisp_Object item
, int inmenubar
)
7654 Lisp_Object def
, tem
, item_string
, start
;
7656 Lisp_Object keyhint
;
7665 /* Create item_properties vector if necessary. */
7666 if (NILP (item_properties
))
7668 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7670 /* Initialize optional entries. */
7671 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7672 ASET (item_properties
, i
, Qnil
);
7673 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7675 /* Save the item here to protect it from GC. */
7676 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7678 item_string
= XCAR (item
);
7682 if (STRINGP (item_string
))
7684 /* Old format menu item. */
7685 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7687 /* Maybe help string. */
7688 if (CONSP (item
) && STRINGP (XCAR (item
)))
7690 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7695 /* Maybe an obsolete key binding cache. */
7696 if (CONSP (item
) && CONSP (XCAR (item
))
7697 && (NILP (XCAR (XCAR (item
)))
7698 || VECTORP (XCAR (XCAR (item
)))))
7701 /* This is the real definition--the function to run. */
7702 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7704 /* Get enable property, if any. */
7707 tem
= Fget (item
, Qmenu_enable
);
7708 if (!NILP (Venable_disabled_menus_and_buttons
))
7709 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7710 else if (!NILP (tem
))
7711 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7714 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7716 /* New format menu item. */
7717 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7718 start
= XCDR (item
);
7721 /* We have a real binding. */
7722 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7724 item
= XCDR (start
);
7725 /* Is there an obsolete cache list with key equivalences. */
7726 if (CONSP (item
) && CONSP (XCAR (item
)))
7729 /* Parse properties. */
7730 while (CONSP (item
) && CONSP (XCDR (item
)))
7735 if (EQ (tem
, QCenable
))
7737 if (!NILP (Venable_disabled_menus_and_buttons
))
7738 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7740 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7742 else if (EQ (tem
, QCvisible
))
7744 /* If got a visible property and that evaluates to nil
7745 then ignore this item. */
7746 tem
= menu_item_eval_property (XCAR (item
));
7750 else if (EQ (tem
, QChelp
))
7751 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7752 else if (EQ (tem
, QCfilter
))
7754 else if (EQ (tem
, QCkey_sequence
))
7757 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7758 /* Be GC protected. Set keyhint to item instead of tem. */
7761 else if (EQ (tem
, QCkeys
))
7764 if (CONSP (tem
) || STRINGP (tem
))
7765 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7767 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7772 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7774 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7776 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7782 else if (inmenubar
|| !NILP (start
))
7786 return 0; /* not a menu item */
7788 /* If item string is not a string, evaluate it to get string.
7789 If we don't get a string, skip this item. */
7790 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7791 if (!(STRINGP (item_string
)))
7793 item_string
= menu_item_eval_property (item_string
);
7794 if (!STRINGP (item_string
))
7796 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7799 /* If got a filter apply it on definition. */
7800 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7803 def
= menu_item_eval_property (list2 (XCAR (filter
),
7804 list2 (Qquote
, def
)));
7806 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7809 /* Enable or disable selection of item. */
7810 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7813 tem
= menu_item_eval_property (tem
);
7814 if (inmenubar
&& NILP (tem
))
7815 return 0; /* Ignore disabled items in menu bar. */
7816 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7819 /* If we got no definition, this item is just unselectable text which
7820 is OK in a submenu but not in the menubar. */
7822 return (!inmenubar
);
7824 /* See if this is a separate pane or a submenu. */
7825 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7826 tem
= get_keymap (def
, 0, 1);
7827 /* For a subkeymap, just record its details and exit. */
7830 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7831 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7835 /* At the top level in the menu bar, do likewise for commands also.
7836 The menu bar does not display equivalent key bindings anyway.
7837 ITEM_PROPERTY_DEF is already set up properly. */
7841 { /* This is a command. See if there is an equivalent key binding. */
7842 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7844 /* The previous code preferred :key-sequence to :keys, so we
7845 preserve this behavior. */
7846 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7847 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7850 Lisp_Object prefix
= keyeq
;
7851 Lisp_Object keys
= Qnil
;
7855 def
= XCAR (prefix
);
7856 prefix
= XCDR (prefix
);
7859 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7861 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7863 keys
= XCAR (keyhint
);
7864 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7866 /* We have a suggested key. Is it bound to the command? */
7869 /* If the command is an alias for another
7870 (such as lmenu.el set it up), check if the
7871 original command matches the cached command. */
7873 && EQ (tem
, XSYMBOL (def
)->function
))))
7878 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7882 tem
= Fkey_description (keys
, Qnil
);
7885 if (STRINGP (XCAR (prefix
)))
7886 tem
= concat2 (XCAR (prefix
), tem
);
7887 if (STRINGP (XCDR (prefix
)))
7888 tem
= concat2 (tem
, XCDR (prefix
));
7890 keyeq
= concat2 (build_string (" "), tem
);
7891 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7897 /* If we have an equivalent key binding, use that. */
7898 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7901 /* Include this when menu help is implemented.
7902 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7903 if (!(NILP (tem) || STRINGP (tem)))
7905 tem = menu_item_eval_property (tem);
7908 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7912 /* Handle radio buttons or toggle boxes. */
7913 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7915 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7916 menu_item_eval_property (tem
));
7923 /***********************************************************************
7925 ***********************************************************************/
7927 /* A vector holding tool bar items while they are parsed in function
7928 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7931 static Lisp_Object tool_bar_items_vector
;
7933 /* A vector holding the result of parse_tool_bar_item. Layout is like
7934 the one for a single item in tool_bar_items_vector. */
7936 static Lisp_Object tool_bar_item_properties
;
7938 /* Next free index in tool_bar_items_vector. */
7940 static int ntool_bar_items
;
7942 /* The symbols `:image' and `:rtl'. */
7944 static Lisp_Object QCimage
;
7945 static Lisp_Object QCrtl
;
7947 /* Function prototypes. */
7949 static void init_tool_bar_items (Lisp_Object
);
7950 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7952 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7953 static void append_tool_bar_item (void);
7956 /* Return a vector of tool bar items for keymaps currently in effect.
7957 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7958 tool bar items found. */
7961 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7970 /* In order to build the menus, we need to call the keymap
7971 accessors. They all call QUIT. But this function is called
7972 during redisplay, during which a quit is fatal. So inhibit
7973 quitting while building the menus. We do this instead of
7974 specbind because (1) errors will clear it anyway and (2) this
7975 avoids risk of specpdl overflow. */
7976 oquit
= Vinhibit_quit
;
7979 /* Initialize tool_bar_items_vector and protect it from GC. */
7980 init_tool_bar_items (reuse
);
7982 /* Build list of keymaps in maps. Set nmaps to the number of maps
7985 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7986 if (!NILP (Voverriding_local_map_menu_flag
)
7987 && !NILP (Voverriding_local_map
))
7989 /* Yes, use them (if non-nil) as well as the global map. */
7990 maps
= alloca (3 * sizeof *maps
);
7992 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7993 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7994 if (!NILP (Voverriding_local_map
))
7995 maps
[nmaps
++] = Voverriding_local_map
;
7999 /* No, so use major and minor mode keymaps and keymap property.
8000 Note that tool-bar bindings in the local-map and keymap
8001 properties may not work reliable, as they are only
8002 recognized when the tool-bar (or mode-line) is updated,
8003 which does not normally happen after every command. */
8006 nminor
= current_minor_maps (NULL
, &tmaps
);
8007 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
8009 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8010 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8011 maps
[nmaps
++] = tem
;
8012 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8013 maps
[nmaps
++] = tem
;
8014 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8016 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8019 /* Add global keymap at the end. */
8020 maps
[nmaps
++] = current_global_map
;
8022 /* Process maps in reverse order and look up in each map the prefix
8024 for (i
= nmaps
- 1; i
>= 0; --i
)
8025 if (!NILP (maps
[i
]))
8029 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8031 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8034 Vinhibit_quit
= oquit
;
8035 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8036 return tool_bar_items_vector
;
8040 /* Process the definition of KEY which is DEF. */
8043 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8046 struct gcpro gcpro1
, gcpro2
;
8048 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8052 if (EQ (def
, Qundefined
))
8054 /* If a map has an explicit `undefined' as definition,
8055 discard any previously made item. */
8056 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8058 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8060 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8062 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8063 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8064 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8066 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8071 else if (parse_tool_bar_item (key
, def
))
8072 /* Append a new tool bar item to tool_bar_items_vector. Accept
8073 more than one definition for the same key. */
8074 append_tool_bar_item ();
8079 /* Access slot with index IDX of vector tool_bar_item_properties. */
8080 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8082 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8084 ASET (tool_bar_item_properties
, idx
, val
);
8088 /* Parse a tool bar item specification ITEM for key KEY and return the
8089 result in tool_bar_item_properties. Value is false if ITEM is
8092 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8094 CAPTION is the caption of the item, If it's not a string, it is
8095 evaluated to get a string.
8097 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8098 as binding are currently ignored.
8100 The following properties are recognized:
8104 FORM is evaluated and specifies whether the tool bar item is
8105 enabled or disabled.
8109 FORM is evaluated and specifies whether the tool bar item is visible.
8111 - `:filter FUNCTION'
8113 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8114 result is stored as the new binding.
8116 - `:button (TYPE SELECTED)'
8118 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8119 and specifies whether the button is selected (pressed) or not.
8123 IMAGES is either a single image specification or a vector of four
8124 image specifications. See enum tool_bar_item_images.
8126 - `:help HELP-STRING'.
8128 Gives a help string to display for the tool bar item.
8130 - `:label LABEL-STRING'.
8132 A text label to show with the tool bar button if labels are enabled. */
8135 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8137 Lisp_Object filter
= Qnil
;
8138 Lisp_Object caption
;
8140 bool have_label
= 0;
8142 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8143 Rule out items that aren't lists, don't start with
8144 `menu-item' or whose rest following `tool-bar-item' is not a
8149 /* As an exception, allow old-style menu separators. */
8150 if (STRINGP (XCAR (item
)))
8151 item
= list1 (XCAR (item
));
8152 else if (!EQ (XCAR (item
), Qmenu_item
)
8153 || (item
= XCDR (item
), !CONSP (item
)))
8156 /* Create tool_bar_item_properties vector if necessary. Reset it to
8158 if (VECTORP (tool_bar_item_properties
))
8160 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8164 tool_bar_item_properties
8165 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8168 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8169 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8171 /* Get the caption of the item. If the caption is not a string,
8172 evaluate it to get a string. If we don't get a string, skip this
8174 caption
= XCAR (item
);
8175 if (!STRINGP (caption
))
8177 caption
= menu_item_eval_property (caption
);
8178 if (!STRINGP (caption
))
8181 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8183 /* If the rest following the caption is not a list, the menu item is
8184 either a separator, or invalid. */
8188 if (menu_separator_name_p (SSDATA (caption
)))
8190 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8191 #if !defined (USE_GTK) && !defined (HAVE_NS)
8192 /* If we use build_desired_tool_bar_string to render the
8193 tool bar, the separator is rendered as an image. */
8194 set_prop (TOOL_BAR_ITEM_IMAGES
,
8195 (menu_item_eval_property
8196 (Vtool_bar_separator_image_expression
)));
8197 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8198 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8199 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8206 /* Store the binding. */
8207 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8210 /* Ignore cached key binding, if any. */
8211 if (CONSP (item
) && CONSP (XCAR (item
)))
8214 /* Process the rest of the properties. */
8215 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8217 Lisp_Object ikey
, value
;
8220 value
= XCAR (XCDR (item
));
8222 if (EQ (ikey
, QCenable
))
8224 /* `:enable FORM'. */
8225 if (!NILP (Venable_disabled_menus_and_buttons
))
8226 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8228 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8230 else if (EQ (ikey
, QCvisible
))
8232 /* `:visible FORM'. If got a visible property and that
8233 evaluates to nil then ignore this item. */
8234 if (NILP (menu_item_eval_property (value
)))
8237 else if (EQ (ikey
, QChelp
))
8238 /* `:help HELP-STRING'. */
8239 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8240 else if (EQ (ikey
, QCvert_only
))
8241 /* `:vert-only t/nil'. */
8242 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8243 else if (EQ (ikey
, QClabel
))
8245 const char *bad_label
= "!!?GARBLED ITEM?!!";
8246 /* `:label LABEL-STRING'. */
8247 set_prop (TOOL_BAR_ITEM_LABEL
,
8248 STRINGP (value
) ? value
: build_string (bad_label
));
8251 else if (EQ (ikey
, QCfilter
))
8252 /* ':filter FORM'. */
8254 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8256 /* `:button (TYPE . SELECTED)'. */
8257 Lisp_Object type
, selected
;
8259 type
= XCAR (value
);
8260 selected
= XCDR (value
);
8261 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8263 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8264 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8267 else if (EQ (ikey
, QCimage
)
8269 || (VECTORP (value
) && ASIZE (value
) == 4)))
8270 /* Value is either a single image specification or a vector
8271 of 4 such specifications for the different button states. */
8272 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8273 else if (EQ (ikey
, QCrtl
))
8275 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8281 /* Try to make one from caption and key. */
8282 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8283 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8284 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8285 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8287 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8288 char *buf
= xmalloc (max_lbl
+ 1);
8289 Lisp_Object new_lbl
;
8290 ptrdiff_t caption_len
= strlen (capt
);
8292 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8295 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8297 buf
[caption_len
] = '\0';
8301 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8305 strcpy (buf
, label
);
8307 for (j
= 0; buf
[j
] != '\0'; ++j
)
8315 new_lbl
= Fupcase_initials (build_string (label
));
8316 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8317 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8319 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8323 /* If got a filter apply it on binding. */
8325 set_prop (TOOL_BAR_ITEM_BINDING
,
8326 (menu_item_eval_property
8329 PROP (TOOL_BAR_ITEM_BINDING
))))));
8331 /* See if the binding is a keymap. Give up if it is. */
8332 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8335 /* Enable or disable selection of item. */
8336 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8337 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8338 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8340 /* Handle radio buttons or toggle boxes. */
8341 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8342 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8343 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8351 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8352 that can be reused. */
8355 init_tool_bar_items (Lisp_Object reuse
)
8357 if (VECTORP (reuse
))
8358 tool_bar_items_vector
= reuse
;
8360 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8361 ntool_bar_items
= 0;
8365 /* Append parsed tool bar item properties from
8366 tool_bar_item_properties */
8369 append_tool_bar_item (void)
8373 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8375 /* Enlarge tool_bar_items_vector if necessary. */
8377 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8379 /* Append entries from tool_bar_item_properties to the end of
8380 tool_bar_items_vector. */
8381 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8382 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8383 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8390 /* Read a character using menus based on the keymap MAP.
8391 Return nil if there are no menus in the maps.
8392 Return t if we displayed a menu but the user rejected it.
8394 PREV_EVENT is the previous input event, or nil if we are reading
8395 the first event of a key sequence.
8397 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8398 if we used a mouse menu to read the input, or false otherwise. If
8399 USED_MOUSE_MENU is null, don't dereference it.
8401 The prompting is done based on the prompt-string of the map
8402 and the strings associated with various map elements.
8404 This can be done with X menus or with menus put in the minibuf.
8405 These are done in different ways, depending on how the input will be read.
8406 Menus using X are done after auto-saving in read-char, getting the input
8407 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8408 and do auto-saving in the inner call of read_char. */
8411 read_char_x_menu_prompt (Lisp_Object map
,
8412 Lisp_Object prev_event
, bool *used_mouse_menu
)
8414 if (used_mouse_menu
)
8415 *used_mouse_menu
= 0;
8417 /* Use local over global Menu maps. */
8419 if (! menu_prompting
)
8422 /* If we got to this point via a mouse click,
8423 use a real menu for mouse selection. */
8424 if (EVENT_HAS_PARAMETERS (prev_event
)
8425 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8426 && !EQ (XCAR (prev_event
), Qtool_bar
))
8428 /* Display the menu and get the selection. */
8431 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8436 record_menu_key (XCAR (value
));
8438 /* If we got multiple events, unread all but
8440 There is no way to prevent those unread events
8441 from showing up later in last_nonmenu_event.
8442 So turn symbol and integer events into lists,
8443 to indicate that they came from a mouse menu,
8444 so that when present in last_nonmenu_event
8445 they won't confuse things. */
8446 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8448 record_menu_key (XCAR (tem
));
8449 if (SYMBOLP (XCAR (tem
))
8450 || INTEGERP (XCAR (tem
)))
8451 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8454 /* If we got more than one event, put all but the first
8455 onto this list to be read later.
8456 Return just the first event now. */
8457 Vunread_command_events
8458 = nconc2 (XCDR (value
), Vunread_command_events
);
8459 value
= XCAR (value
);
8461 else if (NILP (value
))
8463 if (used_mouse_menu
)
8464 *used_mouse_menu
= 1;
8471 read_char_minibuf_menu_prompt (int commandflag
,
8474 register Lisp_Object name
;
8476 /* FIXME: Use the minibuffer's frame width. */
8477 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8479 bool nobindings
= 1;
8480 Lisp_Object rest
, vector
;
8481 Lisp_Object prompt_strings
= Qnil
;
8485 if (! menu_prompting
)
8488 map
= get_keymap (map
, 0, 1);
8489 name
= Fkeymap_prompt (map
);
8491 /* If we don't have any menus, just read a character normally. */
8492 if (!STRINGP (name
))
8495 #define PUSH_C_STR(str, listvar) \
8496 listvar = Fcons (build_unibyte_string (str), listvar)
8498 /* Prompt string always starts with map's prompt, and a space. */
8499 prompt_strings
= Fcons (name
, prompt_strings
);
8500 PUSH_C_STR (": ", prompt_strings
);
8501 nlength
= SCHARS (name
) + 2;
8505 /* Present the documented bindings, a line at a time. */
8509 Lisp_Object menu_strings
= prompt_strings
;
8510 ptrdiff_t i
= nlength
;
8512 Lisp_Object orig_defn_macro
;
8514 /* Loop over elements of map. */
8519 /* FIXME: Use map_keymap to handle new keymap formats. */
8521 /* At end of map, wrap around if just starting,
8522 or end this line if already have something on it. */
8525 if (notfirst
|| nobindings
)
8531 /* Look at the next element of the map. */
8533 elt
= AREF (vector
, idx
);
8535 elt
= Fcar_safe (rest
);
8537 if (idx
< 0 && VECTORP (elt
))
8539 /* If we found a dense table in the keymap,
8540 advanced past it, but start scanning its contents. */
8541 rest
= Fcdr_safe (rest
);
8547 /* An ordinary element. */
8548 Lisp_Object event
, tem
;
8552 event
= Fcar_safe (elt
); /* alist */
8553 elt
= Fcdr_safe (elt
);
8557 XSETINT (event
, idx
); /* vector */
8560 /* Ignore the element if it has no prompt string. */
8561 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8563 /* True if the char to type matches the string. */
8565 Lisp_Object upcased_event
, downcased_event
;
8566 Lisp_Object desc
= Qnil
;
8568 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8570 upcased_event
= Fupcase (event
);
8571 downcased_event
= Fdowncase (event
);
8572 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8573 || XINT (downcased_event
) == SREF (s
, 0));
8575 desc
= Fsingle_key_description (event
, Qnil
);
8577 #if 0 /* It is redundant to list the equivalent key bindings because
8578 the prefix is what the user has already typed. */
8580 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8582 /* Insert equivalent keybinding. */
8583 s
= concat2 (s
, tem
);
8586 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8587 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8589 /* Insert button prefix. */
8590 Lisp_Object selected
8591 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8592 if (EQ (tem
, QCradio
))
8593 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8595 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8596 s
= concat2 (tem
, s
);
8600 /* If we have room for the prompt string, add it to this line.
8601 If this is the first on the line, always add it. */
8602 if ((SCHARS (s
) + i
+ 2
8603 + (char_matches
? 0 : SCHARS (desc
) + 3))
8607 ptrdiff_t thiswidth
;
8609 /* Punctuate between strings. */
8612 PUSH_C_STR (", ", menu_strings
);
8618 /* If the char to type doesn't match the string's
8619 first char, explicitly show what char to type. */
8622 /* Add as much of string as fits. */
8623 thiswidth
= min (SCHARS (desc
), width
- i
);
8625 = Fcons (Fsubstring (desc
, make_number (0),
8626 make_number (thiswidth
)),
8629 PUSH_C_STR (" = ", menu_strings
);
8633 /* Add as much of string as fits. */
8634 thiswidth
= min (SCHARS (s
), width
- i
);
8636 = Fcons (Fsubstring (s
, make_number (0),
8637 make_number (thiswidth
)),
8643 /* If this element does not fit, end the line now,
8644 and save the element for the next line. */
8645 PUSH_C_STR ("...", menu_strings
);
8650 /* Move past this element. */
8651 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8652 /* Handle reaching end of dense table. */
8657 rest
= Fcdr_safe (rest
);
8661 /* Prompt with that and read response. */
8662 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8664 /* Make believe it's not a keyboard macro in case the help char
8665 is pressed. Help characters are not recorded because menu prompting
8666 is not used on replay. */
8667 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8668 kset_defining_kbd_macro (current_kboard
, Qnil
);
8670 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8671 while (BUFFERP (obj
));
8672 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8674 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8677 if (! EQ (obj
, menu_prompt_more_char
)
8678 && (!INTEGERP (menu_prompt_more_char
)
8679 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8681 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8682 store_kbd_macro_char (obj
);
8685 /* Help char - go round again. */
8689 /* Reading key sequences. */
8692 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8694 return access_keymap (get_keymap (keymap
, 0, 1),
8699 active_maps (Lisp_Object first_event
)
8701 Lisp_Object position
8702 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8703 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8706 /* Structure used to keep track of partial application of key remapping
8707 such as Vfunction_key_map and Vkey_translation_map. */
8708 typedef struct keyremap
8710 /* This is the map originally specified for this use. */
8712 /* This is a submap reached by looking up, in PARENT,
8713 the events from START to END. */
8715 /* Positions [START, END) in the key sequence buffer
8716 are the key that we have scanned so far.
8717 Those events are the ones that we will replace
8718 if PARENT maps them into a key sequence. */
8722 /* Lookup KEY in MAP.
8723 MAP is a keymap mapping keys to key vectors or functions.
8724 If the mapping is a function and DO_FUNCALL is true,
8725 the function is called with PROMPT as parameter and its return
8726 value is used as the return value of this function (after checking
8727 that it is indeed a vector). */
8730 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8735 next
= access_keymap (map
, key
, 1, 0, 1);
8737 /* Handle a symbol whose function definition is a keymap
8739 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8740 && (ARRAYP (XSYMBOL (next
)->function
)
8741 || KEYMAPP (XSYMBOL (next
)->function
)))
8742 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8744 /* If the keymap gives a function, not an
8745 array, then call the function with one arg and use
8746 its value instead. */
8747 if (do_funcall
&& FUNCTIONP (next
))
8752 next
= call1 (next
, prompt
);
8753 /* If the function returned something invalid,
8754 barf--don't ignore it.
8755 (To ignore it safely, we would need to gcpro a bunch of
8756 other variables.) */
8757 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8758 error ("Function %s returns invalid key sequence",
8759 SSDATA (SYMBOL_NAME (tem
)));
8764 /* Do one step of the key remapping used for function-key-map and
8765 key-translation-map:
8766 KEYBUF is the buffer holding the input events.
8767 BUFSIZE is its maximum size.
8768 FKEY is a pointer to the keyremap structure to use.
8769 INPUT is the index of the last element in KEYBUF.
8770 DOIT if true says that the remapping can actually take place.
8771 DIFF is used to return the number of keys added/removed by the remapping.
8772 PARENT is the root of the keymap.
8773 PROMPT is the prompt to use if the remapping happens through a function.
8774 Return true if the remapping actually took place. */
8777 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8778 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8780 Lisp_Object next
, key
;
8782 key
= keybuf
[fkey
->end
++];
8784 if (KEYMAPP (fkey
->parent
))
8785 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8789 /* If keybuf[fkey->start..fkey->end] is bound in the
8790 map and we're in a position to do the key remapping, replace it with
8791 the binding and restart with fkey->start at the end. */
8792 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8794 int len
= XFASTINT (Flength (next
));
8797 *diff
= len
- (fkey
->end
- fkey
->start
);
8799 if (bufsize
- input
<= *diff
)
8800 error ("Key sequence too long");
8802 /* Shift the keys that follow fkey->end. */
8804 for (i
= fkey
->end
; i
< input
; i
++)
8805 keybuf
[i
+ *diff
] = keybuf
[i
];
8807 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8808 keybuf
[i
+ *diff
] = keybuf
[i
];
8809 /* Overwrite the old keys with the new ones. */
8810 for (i
= 0; i
< len
; i
++)
8811 keybuf
[fkey
->start
+ i
]
8812 = Faref (next
, make_number (i
));
8814 fkey
->start
= fkey
->end
+= *diff
;
8815 fkey
->map
= fkey
->parent
;
8820 fkey
->map
= get_keymap (next
, 0, 1);
8822 /* If we no longer have a bound suffix, try a new position for
8824 if (!CONSP (fkey
->map
))
8826 fkey
->end
= ++fkey
->start
;
8827 fkey
->map
= fkey
->parent
;
8833 test_undefined (Lisp_Object binding
)
8835 return (NILP (binding
)
8836 || EQ (binding
, Qundefined
)
8837 || (SYMBOLP (binding
)
8838 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8841 /* Read a sequence of keys that ends with a non prefix character,
8842 storing it in KEYBUF, a buffer of size BUFSIZE.
8844 Return the length of the key sequence stored.
8845 Return -1 if the user rejected a command menu.
8847 Echo starting immediately unless `prompt' is 0.
8849 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8850 read_char with a suitable COMMANDFLAG argument.
8852 Where a key sequence ends depends on the currently active keymaps.
8853 These include any minor mode keymaps active in the current buffer,
8854 the current buffer's local map, and the global map.
8856 If a key sequence has no other bindings, we check Vfunction_key_map
8857 to see if some trailing subsequence might be the beginning of a
8858 function key's sequence. If so, we try to read the whole function
8859 key, and substitute its symbolic name into the key sequence.
8861 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8862 `double-' events into similar click events, if that would make them
8863 bound. We try to turn `triple-' events first into `double-' events,
8866 If we get a mouse click in a mode line, vertical divider, or other
8867 non-text area, we treat the click as if it were prefixed by the
8868 symbol denoting that area - `mode-line', `vertical-line', or
8871 If the sequence starts with a mouse click, we read the key sequence
8872 with respect to the buffer clicked on, not the current buffer.
8874 If the user switches frames in the midst of a key sequence, we put
8875 off the switch-frame event until later; the next call to
8876 read_char will return it.
8878 If FIX_CURRENT_BUFFER, we restore current_buffer
8879 from the selected window's buffer. */
8882 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8883 bool dont_downcase_last
, bool can_return_switch_frame
,
8884 bool fix_current_buffer
, bool prevent_redisplay
)
8886 ptrdiff_t count
= SPECPDL_INDEX ();
8888 /* How many keys there are in the current key sequence. */
8891 /* The length of the echo buffer when we started reading, and
8892 the length of this_command_keys when we started reading. */
8893 ptrdiff_t echo_start
IF_LINT (= 0);
8894 ptrdiff_t keys_start
;
8896 Lisp_Object current_binding
= Qnil
;
8897 Lisp_Object first_event
= Qnil
;
8899 /* Index of the first key that has no binding.
8900 It is useless to try fkey.start larger than that. */
8903 /* If t < mock_input, then KEYBUF[t] should be read as the next
8906 We use this to recover after recognizing a function key. Once we
8907 realize that a suffix of the current key sequence is actually a
8908 function key's escape sequence, we replace the suffix with the
8909 function key's binding from Vfunction_key_map. Now keybuf
8910 contains a new and different key sequence, so the echo area,
8911 this_command_keys, and the submaps and defs arrays are wrong. In
8912 this situation, we set mock_input to t, set t to 0, and jump to
8913 restart_sequence; the loop will read keys from keybuf up until
8914 mock_input, thus rebuilding the state; and then it will resume
8915 reading characters from the keyboard. */
8918 /* If the sequence is unbound in submaps[], then
8919 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8920 and fkey.map is its binding.
8922 These might be > t, indicating that all function key scanning
8923 should hold off until t reaches them. We do this when we've just
8924 recognized a function key, to avoid searching for the function
8925 key's again in Vfunction_key_map. */
8928 /* Likewise, for key_translation_map and input-decode-map. */
8929 keyremap keytran
, indec
;
8931 /* True if we are trying to map a key by changing an upper-case
8932 letter to lower case, or a shifted function key to an unshifted
8934 bool shift_translated
= 0;
8936 /* If we receive a `switch-frame' or `select-window' event in the middle of
8937 a key sequence, we put it off for later.
8938 While we're reading, we keep the event here. */
8939 Lisp_Object delayed_switch_frame
;
8941 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8942 int original_uppercase_position
= -1;
8944 /* Gets around Microsoft compiler limitations. */
8947 struct buffer
*starting_buffer
;
8949 /* List of events for which a fake prefix key has been generated. */
8950 Lisp_Object fake_prefixed_keys
= Qnil
;
8952 struct gcpro gcpro1
;
8954 GCPRO1 (fake_prefixed_keys
);
8955 raw_keybuf_count
= 0;
8957 last_nonmenu_event
= Qnil
;
8959 delayed_switch_frame
= Qnil
;
8965 /* Install the string PROMPT as the beginning of the string
8966 of echoing, so that it serves as a prompt for the next
8968 kset_echo_string (current_kboard
, prompt
);
8969 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8972 else if (cursor_in_echo_area
8973 && echo_keystrokes_p ())
8974 /* This doesn't put in a dash if the echo buffer is empty, so
8975 you don't always see a dash hanging out in the minibuffer. */
8979 /* Record the initial state of the echo area and this_command_keys;
8980 we will need to restore them if we replay a key sequence. */
8982 echo_start
= echo_length ();
8983 keys_start
= this_command_key_count
;
8984 this_single_command_key_start
= keys_start
;
8986 /* We jump here when we need to reinitialize fkey and keytran; this
8987 happens if we switch keyboards between rescans. */
8988 replay_entire_sequence
:
8990 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8991 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8992 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8993 indec
.start
= indec
.end
= 0;
8994 fkey
.start
= fkey
.end
= 0;
8995 keytran
.start
= keytran
.end
= 0;
8997 /* We jump here when the key sequence has been thoroughly changed, and
8998 we need to rescan it starting from the beginning. When we jump here,
8999 keybuf[0..mock_input] holds the sequence we should reread. */
9002 starting_buffer
= current_buffer
;
9003 first_unbound
= bufsize
+ 1;
9005 /* Build our list of keymaps.
9006 If we recognize a function key and replace its escape sequence in
9007 keybuf with its symbol, or if the sequence starts with a mouse
9008 click and we need to switch buffers, we jump back here to rebuild
9009 the initial keymaps from the current buffer. */
9010 current_binding
= active_maps (first_event
);
9012 /* Start from the beginning in keybuf. */
9015 /* These are no-ops the first time through, but if we restart, they
9016 revert the echo area and this_command_keys to their original state. */
9017 this_command_key_count
= keys_start
;
9018 if (INTERACTIVE
&& t
< mock_input
)
9019 echo_truncate (echo_start
);
9021 /* If the best binding for the current key sequence is a keymap, or
9022 we may be looking at a function key's escape sequence, keep on
9024 while (!NILP (current_binding
)
9025 /* Keep reading as long as there's a prefix binding. */
9026 ? KEYMAPP (current_binding
)
9027 /* Don't return in the middle of a possible function key sequence,
9028 if the only bindings we found were via case conversion.
9029 Thus, if ESC O a has a function-key-map translation
9030 and ESC o has a binding, don't return after ESC O,
9031 so that we can translate ESC O plus the next character. */
9032 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9035 bool used_mouse_menu
= 0;
9037 /* Where the last real key started. If we need to throw away a
9038 key that has expanded into more than one element of keybuf
9039 (say, a mouse click on the mode line which is being treated
9040 as [mode-line (mouse-...)], then we backtrack to this point
9042 int last_real_key_start
;
9044 /* These variables are analogous to echo_start and keys_start;
9045 while those allow us to restart the entire key sequence,
9046 echo_local_start and keys_local_start allow us to throw away
9048 ptrdiff_t echo_local_start
IF_LINT (= 0);
9049 int keys_local_start
;
9050 Lisp_Object new_binding
;
9052 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9053 eassert (indec
.start
<= indec
.end
);
9054 eassert (fkey
.start
<= fkey
.end
);
9055 eassert (keytran
.start
<= keytran
.end
);
9056 /* key-translation-map is applied *after* function-key-map
9057 which is itself applied *after* input-decode-map. */
9058 eassert (fkey
.end
<= indec
.start
);
9059 eassert (keytran
.end
<= fkey
.start
);
9061 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9062 first_unbound
< keytran
.start
)
9063 { /* The prefix upto first_unbound has no binding and has
9064 no translation left to do either, so we know it's unbound.
9065 If we don't stop now, we risk staying here indefinitely
9066 (if the user keeps entering fkey or keytran prefixes
9067 like C-c ESC ESC ESC ESC ...) */
9069 for (i
= first_unbound
+ 1; i
< t
; i
++)
9070 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9071 mock_input
= t
- first_unbound
- 1;
9072 indec
.end
= indec
.start
-= first_unbound
+ 1;
9073 indec
.map
= indec
.parent
;
9074 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9075 fkey
.map
= fkey
.parent
;
9076 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9077 keytran
.map
= keytran
.parent
;
9078 goto replay_sequence
;
9082 error ("Key sequence too long");
9085 echo_local_start
= echo_length ();
9086 keys_local_start
= this_command_key_count
;
9089 /* These are no-ops, unless we throw away a keystroke below and
9090 jumped back up to replay_key; in that case, these restore the
9091 variables to their original state, allowing us to replay the
9093 if (INTERACTIVE
&& t
< mock_input
)
9094 echo_truncate (echo_local_start
);
9095 this_command_key_count
= keys_local_start
;
9097 /* By default, assume each event is "real". */
9098 last_real_key_start
= t
;
9100 /* Does mock_input indicate that we are re-reading a key sequence? */
9104 add_command_key (key
);
9105 if (echo_keystrokes_p ()
9106 && current_kboard
->immediate_echo
)
9113 /* If not, we should actually read a character. */
9117 KBOARD
*interrupted_kboard
= current_kboard
;
9118 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9119 /* Calling read_char with COMMANDFLAG = -2 avoids
9120 redisplay in read_char and its subroutines. */
9121 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9122 current_binding
, last_nonmenu_event
,
9123 &used_mouse_menu
, NULL
);
9124 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9125 /* When switching to a new tty (with a new keyboard),
9126 read_char returns the new buffer, rather than -2
9127 (Bug#5095). This is because `terminal-init-xterm'
9128 calls read-char, which eats the wrong_kboard_jmpbuf
9129 return. Any better way to fix this? -- cyd */
9130 || (interrupted_kboard
!= current_kboard
))
9135 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9136 if (k
== interrupted_kboard
)
9141 /* Don't touch interrupted_kboard when it's been
9143 delayed_switch_frame
= Qnil
;
9144 goto replay_entire_sequence
;
9147 if (!NILP (delayed_switch_frame
))
9150 (interrupted_kboard
,
9151 Fcons (delayed_switch_frame
,
9152 KVAR (interrupted_kboard
, kbd_queue
)));
9153 delayed_switch_frame
= Qnil
;
9158 (interrupted_kboard
,
9159 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9161 /* If the side queue is non-empty, ensure it begins with a
9162 switch-frame, so we'll replay it in the right context. */
9163 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9164 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9165 !(EVENT_HAS_PARAMETERS (key
)
9166 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9170 XSETFRAME (frame
, interrupted_frame
);
9172 (interrupted_kboard
,
9173 Fcons (make_lispy_switch_frame (frame
),
9174 KVAR (interrupted_kboard
, kbd_queue
)));
9177 goto replay_entire_sequence
;
9181 /* read_char returns t when it shows a menu and the user rejects it.
9185 unbind_to (count
, Qnil
);
9190 /* read_char returns -1 at the end of a macro.
9191 Emacs 18 handles this by returning immediately with a
9192 zero, so that's what we'll do. */
9193 if (INTEGERP (key
) && XINT (key
) == -1)
9196 /* The Microsoft C compiler can't handle the goto that
9202 /* If the current buffer has been changed from under us, the
9203 keymap may have changed, so replay the sequence. */
9206 timer_resume_idle ();
9209 /* Reset the current buffer from the selected window
9210 in case something changed the former and not the latter.
9211 This is to be more consistent with the behavior
9212 of the command_loop_1. */
9213 if (fix_current_buffer
)
9215 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9217 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9219 Fset_buffer (XWINDOW (selected_window
)->contents
);
9222 goto replay_sequence
;
9225 /* If we have a quit that was typed in another frame, and
9226 quit_throw_to_read_char switched buffers,
9227 replay to get the right keymap. */
9229 && XINT (key
) == quit_char
9230 && current_buffer
!= starting_buffer
)
9233 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9238 goto replay_sequence
;
9243 if (EVENT_HAS_PARAMETERS (key
)
9244 /* Either a `switch-frame' or a `select-window' event. */
9245 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9247 /* If we're at the beginning of a key sequence, and the caller
9248 says it's okay, go ahead and return this event. If we're
9249 in the midst of a key sequence, delay it until the end. */
9250 if (t
> 0 || !can_return_switch_frame
)
9252 delayed_switch_frame
= key
;
9257 if (NILP (first_event
))
9260 /* Even if first_event does not specify a particular
9261 window/position, it's important to recompute the maps here
9262 since a long time might have passed since we entered
9263 read_key_sequence, and a timer (or process-filter or
9264 special-event-map, ...) might have switched the current buffer
9265 or the selected window from under us in the mean time. */
9266 if (fix_current_buffer
9267 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9269 Fset_buffer (XWINDOW (selected_window
)->contents
);
9270 current_binding
= active_maps (first_event
);
9274 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9278 /* Clicks in non-text areas get prefixed by the symbol
9279 in their CHAR-ADDRESS field. For example, a click on
9280 the mode line is prefixed by the symbol `mode-line'.
9282 Furthermore, key sequences beginning with mouse clicks
9283 are read using the keymaps of the buffer clicked on, not
9284 the current buffer. So we may have to switch the buffer
9287 When we turn one event into two events, we must make sure
9288 that neither of the two looks like the original--so that,
9289 if we replay the events, they won't be expanded again.
9290 If not for this, such reexpansion could happen either here
9291 or when user programs play with this-command-keys. */
9292 if (EVENT_HAS_PARAMETERS (key
))
9294 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9295 if (EQ (kind
, Qmouse_click
))
9297 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9298 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9301 || (!NILP (fake_prefixed_keys
)
9302 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9304 /* We're looking a second time at an event for which
9305 we generated a fake prefix key. Set
9306 last_real_key_start appropriately. */
9308 last_real_key_start
= t
- 1;
9311 if (last_real_key_start
== 0)
9313 /* Key sequences beginning with mouse clicks are
9314 read using the keymaps in the buffer clicked on,
9315 not the current buffer. If we're at the
9316 beginning of a key sequence, switch buffers. */
9317 if (WINDOWP (window
)
9318 && BUFFERP (XWINDOW (window
)->contents
)
9319 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9321 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9326 /* Arrange to go back to the original buffer once we're
9327 done reading the key sequence. Note that we can't
9328 use save_excursion_{save,restore} here, because they
9329 save point as well as the current buffer; we don't
9330 want to save point, because redisplay may change it,
9331 to accommodate a Fset_window_start or something. We
9332 don't want to do this at the top of the function,
9333 because we may get input from a subprocess which
9334 wants to change the selected window and stuff (say,
9336 record_unwind_current_buffer ();
9338 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9340 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9341 goto replay_sequence
;
9345 /* Expand mode-line and scroll-bar events into two events:
9346 use posn as a fake prefix key. */
9348 && (NILP (fake_prefixed_keys
)
9349 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9351 if (bufsize
- t
<= 1)
9352 error ("Key sequence too long");
9355 keybuf
[t
+ 1] = key
;
9358 /* Record that a fake prefix key has been generated
9359 for KEY. Don't modify the event; this would
9360 prevent proper action when the event is pushed
9361 back into unread-command-events. */
9362 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9366 else if (CONSP (XCDR (key
))
9367 && CONSP (EVENT_START (key
))
9368 && CONSP (XCDR (EVENT_START (key
))))
9372 posn
= POSN_POSN (EVENT_START (key
));
9373 /* Handle menu-bar events:
9374 insert the dummy prefix event `menu-bar'. */
9375 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9377 if (bufsize
- t
<= 1)
9378 error ("Key sequence too long");
9380 keybuf
[t
+ 1] = key
;
9382 /* Zap the position in key, so we know that we've
9383 expanded it, and don't try to do so again. */
9384 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9387 goto replay_sequence
;
9389 else if (CONSP (posn
))
9391 /* We're looking at the second event of a
9392 sequence which we expanded before. Set
9393 last_real_key_start appropriately. */
9394 if (last_real_key_start
== t
&& t
> 0)
9395 last_real_key_start
= t
- 1;
9400 /* We have finally decided that KEY is something we might want
9402 new_binding
= follow_key (current_binding
, key
);
9404 /* If KEY wasn't bound, we'll try some fallbacks. */
9405 if (!NILP (new_binding
))
9406 /* This is needed for the following scenario:
9407 event 0: a down-event that gets dropped by calling replay_key.
9408 event 1: some normal prefix like C-h.
9409 After event 0, first_unbound is 0, after event 1 indec.start,
9410 fkey.start, and keytran.start are all 1, so when we see that
9411 C-h is bound, we need to update first_unbound. */
9412 first_unbound
= max (t
+ 1, first_unbound
);
9417 /* Remember the position to put an upper bound on indec.start. */
9418 first_unbound
= min (t
, first_unbound
);
9420 head
= EVENT_HEAD (key
);
9424 Lisp_Object breakdown
;
9427 breakdown
= parse_modifiers (head
);
9428 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9429 /* Attempt to reduce an unbound mouse event to a simpler
9430 event that is bound:
9431 Drags reduce to clicks.
9432 Double-clicks reduce to clicks.
9433 Triple-clicks reduce to double-clicks, then to clicks.
9434 Down-clicks are eliminated.
9435 Double-downs reduce to downs, then are eliminated.
9436 Triple-downs reduce to double-downs, then to downs,
9437 then are eliminated. */
9438 if (modifiers
& (down_modifier
| drag_modifier
9439 | double_modifier
| triple_modifier
))
9441 while (modifiers
& (down_modifier
| drag_modifier
9442 | double_modifier
| triple_modifier
))
9444 Lisp_Object new_head
, new_click
;
9445 if (modifiers
& triple_modifier
)
9446 modifiers
^= (double_modifier
| triple_modifier
);
9447 else if (modifiers
& double_modifier
)
9448 modifiers
&= ~double_modifier
;
9449 else if (modifiers
& drag_modifier
)
9450 modifiers
&= ~drag_modifier
;
9453 /* Dispose of this `down' event by simply jumping
9454 back to replay_key, to get another event.
9456 Note that if this event came from mock input,
9457 then just jumping back to replay_key will just
9458 hand it to us again. So we have to wipe out any
9461 We could delete keybuf[t] and shift everything
9462 after that to the left by one spot, but we'd also
9463 have to fix up any variable that points into
9464 keybuf, and shifting isn't really necessary
9467 Adding prefixes for non-textual mouse clicks
9468 creates two characters of mock input, and both
9469 must be thrown away. If we're only looking at
9470 the prefix now, we can just jump back to
9471 replay_key. On the other hand, if we've already
9472 processed the prefix, and now the actual click
9473 itself is giving us trouble, then we've lost the
9474 state of the keymaps we want to backtrack to, and
9475 we need to replay the whole sequence to rebuild
9478 Beyond that, only function key expansion could
9479 create more than two keys, but that should never
9480 generate mouse events, so it's okay to zero
9481 mock_input in that case too.
9483 FIXME: The above paragraph seems just plain
9484 wrong, if you consider things like
9485 xterm-mouse-mode. -stef
9487 Isn't this just the most wonderful code ever? */
9489 /* If mock_input > t + 1, the above simplification
9490 will actually end up dropping keys on the floor.
9491 This is probably OK for now, but even
9492 if mock_input <= t + 1, we need to adjust indec,
9494 Typical case [header-line down-mouse-N]:
9495 mock_input = 2, t = 1, fkey.end = 1,
9496 last_real_key_start = 0. */
9497 if (indec
.end
> last_real_key_start
)
9499 indec
.end
= indec
.start
9500 = min (last_real_key_start
, indec
.start
);
9501 indec
.map
= indec
.parent
;
9502 if (fkey
.end
> last_real_key_start
)
9504 fkey
.end
= fkey
.start
9505 = min (last_real_key_start
, fkey
.start
);
9506 fkey
.map
= fkey
.parent
;
9507 if (keytran
.end
> last_real_key_start
)
9509 keytran
.end
= keytran
.start
9510 = min (last_real_key_start
, keytran
.start
);
9511 keytran
.map
= keytran
.parent
;
9515 if (t
== last_real_key_start
)
9522 mock_input
= last_real_key_start
;
9523 goto replay_sequence
;
9528 = apply_modifiers (modifiers
, XCAR (breakdown
));
9529 new_click
= list2 (new_head
, EVENT_START (key
));
9531 /* Look for a binding for this new key. */
9532 new_binding
= follow_key (current_binding
, new_click
);
9534 /* If that click is bound, go for it. */
9535 if (!NILP (new_binding
))
9537 current_binding
= new_binding
;
9541 /* Otherwise, we'll leave key set to the drag event. */
9546 current_binding
= new_binding
;
9549 /* Normally, last_nonmenu_event gets the previous key we read.
9550 But when a mouse popup menu is being used,
9551 we don't update last_nonmenu_event; it continues to hold the mouse
9552 event that preceded the first level of menu. */
9553 if (!used_mouse_menu
)
9554 last_nonmenu_event
= key
;
9556 /* Record what part of this_command_keys is the current key sequence. */
9557 this_single_command_key_start
= this_command_key_count
- t
;
9559 /* Look for this sequence in input-decode-map.
9560 Scan from indec.end until we find a bound suffix. */
9561 while (indec
.end
< t
)
9563 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9567 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9568 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9573 mock_input
= diff
+ max (t
, mock_input
);
9574 goto replay_sequence
;
9578 if (!KEYMAPP (current_binding
)
9579 && !test_undefined (current_binding
)
9580 && indec
.start
>= t
)
9581 /* There is a binding and it's not a prefix.
9582 (and it doesn't have any input-decode-map translation pending).
9583 There is thus no function-key in this sequence.
9584 Moving fkey.start is important in this case to allow keytran.start
9585 to go over the sequence before we return (since we keep the
9586 invariant that keytran.end <= fkey.start). */
9589 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9592 /* If the sequence is unbound, see if we can hang a function key
9593 off the end of it. */
9594 /* Continue scan from fkey.end until we find a bound suffix. */
9595 while (fkey
.end
< indec
.start
)
9597 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9601 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9602 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9603 max (t
, mock_input
),
9604 /* If there's a binding (i.e.
9605 first_binding >= nmaps) we don't want
9606 to apply this function-key-mapping. */
9608 && (test_undefined (current_binding
)),
9613 mock_input
= diff
+ max (t
, mock_input
);
9614 /* Adjust the input-decode-map counters. */
9616 indec
.start
+= diff
;
9618 goto replay_sequence
;
9622 /* Look for this sequence in key-translation-map.
9623 Scan from keytran.end until we find a bound suffix. */
9624 while (keytran
.end
< fkey
.start
)
9626 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9630 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9631 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9636 mock_input
= diff
+ max (t
, mock_input
);
9637 /* Adjust the function-key-map and input-decode-map counters. */
9639 indec
.start
+= diff
;
9643 goto replay_sequence
;
9647 /* If KEY is not defined in any of the keymaps,
9648 and cannot be part of a function key or translation,
9649 and is an upper case letter
9650 use the corresponding lower-case letter instead. */
9651 if (NILP (current_binding
)
9652 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9654 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9655 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9656 || (XINT (key
) & shift_modifier
)))
9658 Lisp_Object new_key
;
9660 original_uppercase
= key
;
9661 original_uppercase_position
= t
- 1;
9663 if (XINT (key
) & shift_modifier
)
9664 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9666 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9667 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9669 /* We have to do this unconditionally, regardless of whether
9670 the lower-case char is defined in the keymaps, because they
9671 might get translated through function-key-map. */
9672 keybuf
[t
- 1] = new_key
;
9673 mock_input
= max (t
, mock_input
);
9674 shift_translated
= 1;
9676 goto replay_sequence
;
9679 if (NILP (current_binding
)
9680 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9682 read_key_sequence_cmd
= Vprefix_help_command
;
9683 /* The Microsoft C compiler can't handle the goto that
9689 /* If KEY is not defined in any of the keymaps,
9690 and cannot be part of a function key or translation,
9691 and is a shifted function key,
9692 use the corresponding unshifted function key instead. */
9693 if (NILP (current_binding
)
9694 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9696 Lisp_Object breakdown
= parse_modifiers (key
);
9698 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9700 if (modifiers
& shift_modifier
9701 /* Treat uppercase keys as shifted. */
9703 && (KEY_TO_CHAR (key
)
9704 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9705 && uppercasep (KEY_TO_CHAR (key
))))
9708 = (modifiers
& shift_modifier
9709 ? apply_modifiers (modifiers
& ~shift_modifier
,
9711 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9713 original_uppercase
= key
;
9714 original_uppercase_position
= t
- 1;
9716 /* We have to do this unconditionally, regardless of whether
9717 the lower-case char is defined in the keymaps, because they
9718 might get translated through function-key-map. */
9719 keybuf
[t
- 1] = new_key
;
9720 mock_input
= max (t
, mock_input
);
9721 /* Reset fkey (and consequently keytran) to apply
9722 function-key-map on the result, so that S-backspace is
9723 correctly mapped to DEL (via backspace). OTOH,
9724 input-decode-map doesn't need to go through it again. */
9725 fkey
.start
= fkey
.end
= 0;
9726 keytran
.start
= keytran
.end
= 0;
9727 shift_translated
= 1;
9729 goto replay_sequence
;
9734 read_key_sequence_cmd
= current_binding
;
9735 read_key_sequence_remapped
9736 /* Remap command through active keymaps.
9737 Do the remapping here, before the unbind_to so it uses the keymaps
9738 of the appropriate buffer. */
9739 = SYMBOLP (read_key_sequence_cmd
)
9740 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9743 unread_switch_frame
= delayed_switch_frame
;
9744 unbind_to (count
, Qnil
);
9746 /* Don't downcase the last character if the caller says don't.
9747 Don't downcase it if the result is undefined, either. */
9748 if ((dont_downcase_last
|| NILP (current_binding
))
9750 && t
- 1 == original_uppercase_position
)
9752 keybuf
[t
- 1] = original_uppercase
;
9753 shift_translated
= 0;
9756 if (shift_translated
)
9757 Vthis_command_keys_shift_translated
= Qt
;
9759 /* Occasionally we fabricate events, perhaps by expanding something
9760 according to function-key-map, or by adding a prefix symbol to a
9761 mouse click in the scroll bar or modeline. In this cases, return
9762 the entire generated key sequence, even if we hit an unbound
9763 prefix or a definition before the end. This means that you will
9764 be able to push back the event properly, and also means that
9765 read-key-sequence will always return a logical unit.
9768 for (; t
< mock_input
; t
++)
9770 if (echo_keystrokes_p ())
9771 echo_char (keybuf
[t
]);
9772 add_command_key (keybuf
[t
]);
9780 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9781 Lisp_Object dont_downcase_last
,
9782 Lisp_Object can_return_switch_frame
,
9783 Lisp_Object cmd_loop
, bool allow_string
)
9785 Lisp_Object keybuf
[30];
9787 struct gcpro gcpro1
;
9788 ptrdiff_t count
= SPECPDL_INDEX ();
9791 CHECK_STRING (prompt
);
9794 specbind (Qinput_method_exit_on_first_char
,
9795 (NILP (cmd_loop
) ? Qt
: Qnil
));
9796 specbind (Qinput_method_use_echo_area
,
9797 (NILP (cmd_loop
) ? Qt
: Qnil
));
9799 memset (keybuf
, 0, sizeof keybuf
);
9801 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9803 if (NILP (continue_echo
))
9805 this_command_key_count
= 0;
9806 this_command_key_count_reset
= 0;
9807 this_single_command_key_start
= 0;
9810 #ifdef HAVE_WINDOW_SYSTEM
9811 if (display_hourglass_p
)
9812 cancel_hourglass ();
9815 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9816 prompt
, ! NILP (dont_downcase_last
),
9817 ! NILP (can_return_switch_frame
), 0, 0);
9819 #if 0 /* The following is fine for code reading a key sequence and
9820 then proceeding with a lengthy computation, but it's not good
9821 for code reading keys in a loop, like an input method. */
9822 #ifdef HAVE_WINDOW_SYSTEM
9823 if (display_hourglass_p
)
9834 return unbind_to (count
,
9835 ((allow_string
? make_event_array
: Fvector
)
9839 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9840 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9841 The sequence is sufficient to specify a non-prefix command in the
9842 current local and global maps.
9844 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9845 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9846 as a continuation of the previous key.
9848 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9849 convert the last event to lower case. (Normally any upper case event
9850 is converted to lower case if the original event is undefined and the lower
9851 case equivalent is defined.) A non-nil value is appropriate for reading
9852 a key sequence to be defined.
9854 A C-g typed while in this function is treated like any other character,
9855 and `quit-flag' is not set.
9857 If the key sequence starts with a mouse click, then the sequence is read
9858 using the keymaps of the buffer of the window clicked in, not the buffer
9859 of the selected window as normal.
9861 `read-key-sequence' drops unbound button-down events, since you normally
9862 only care about the click or drag events which follow them. If a drag
9863 or multi-click event is unbound, but the corresponding click event would
9864 be bound, `read-key-sequence' turns the event into a click event at the
9865 drag's starting position. This means that you don't have to distinguish
9866 between click and drag, double, or triple events unless you want to.
9868 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9869 lines separating windows, and scroll bars with imaginary keys
9870 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9872 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9873 function will process a switch-frame event if the user switches frames
9874 before typing anything. If the user switches frames in the middle of a
9875 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9876 is nil, then the event will be put off until after the current key sequence.
9878 `read-key-sequence' checks `function-key-map' for function key
9879 sequences, where they wouldn't conflict with ordinary bindings. See
9880 `function-key-map' for more details.
9882 The optional fifth argument CMD-LOOP, if non-nil, means
9883 that this key sequence is being read by something that will
9884 read commands one after another. It should be nil if the caller
9885 will read just one key sequence. */)
9886 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9888 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9889 can_return_switch_frame
, cmd_loop
, true);
9892 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9893 Sread_key_sequence_vector
, 1, 5, 0,
9894 doc
: /* Like `read-key-sequence' but always return a vector. */)
9895 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9897 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9898 can_return_switch_frame
, cmd_loop
, false);
9901 /* Return true if input events are pending. */
9904 detect_input_pending (void)
9906 return input_pending
|| get_input_pending (0);
9909 /* Return true if input events other than mouse movements are
9913 detect_input_pending_ignore_squeezables (void)
9915 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9918 /* Return true if input events are pending, and run any pending timers. */
9921 detect_input_pending_run_timers (bool do_display
)
9923 unsigned old_timers_run
= timers_run
;
9926 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9928 if (old_timers_run
!= timers_run
&& do_display
)
9929 redisplay_preserve_echo_area (8);
9931 return input_pending
;
9934 /* This is called in some cases before a possible quit.
9935 It cases the next call to detect_input_pending to recompute input_pending.
9936 So calling this function unnecessarily can't do any harm. */
9939 clear_input_pending (void)
9944 /* Return true if there are pending requeued events.
9945 This isn't used yet. The hope is to make wait_reading_process_output
9946 call it, and return if it runs Lisp code that unreads something.
9947 The problem is, kbd_buffer_get_event needs to be fixed to know what
9948 to do in that case. It isn't trivial. */
9951 requeued_events_pending_p (void)
9953 return (!NILP (Vunread_command_events
));
9956 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9957 doc
: /* Return t if command input is currently available with no wait.
9958 Actually, the value is nil only if we can be sure that no input is available;
9959 if there is a doubt, the value is t.
9961 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9962 (Lisp_Object check_timers
)
9964 if (!NILP (Vunread_command_events
)
9965 || !NILP (Vunread_post_input_method_events
)
9966 || !NILP (Vunread_input_method_events
))
9969 /* Process non-user-visible events (Bug#10195). */
9970 process_special_events ();
9972 return (get_input_pending ((NILP (check_timers
)
9973 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9974 | READABLE_EVENTS_FILTER_EVENTS
)
9978 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9979 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9982 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9985 if (total_keys
< NUM_RECENT_KEYS
)
9986 return Fvector (total_keys
, keys
);
9989 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9990 vcopy (val
, 0, keys
+ recent_keys_index
,
9991 NUM_RECENT_KEYS
- recent_keys_index
);
9992 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9993 keys
, recent_keys_index
);
9998 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9999 doc
: /* Return the key sequence that invoked this command.
10000 However, if the command has called `read-key-sequence', it returns
10001 the last key sequence that has been read.
10002 The value is a string or a vector.
10004 See also `this-command-keys-vector'. */)
10007 return make_event_array (this_command_key_count
,
10008 XVECTOR (this_command_keys
)->contents
);
10011 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10012 doc
: /* Return the key sequence that invoked this command, as a vector.
10013 However, if the command has called `read-key-sequence', it returns
10014 the last key sequence that has been read.
10016 See also `this-command-keys'. */)
10019 return Fvector (this_command_key_count
,
10020 XVECTOR (this_command_keys
)->contents
);
10023 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10024 Sthis_single_command_keys
, 0, 0, 0,
10025 doc
: /* Return the key sequence that invoked this command.
10026 More generally, it returns the last key sequence read, either by
10027 the command loop or by `read-key-sequence'.
10028 Unlike `this-command-keys', this function's value
10029 does not include prefix arguments.
10030 The value is always a vector. */)
10033 return Fvector (this_command_key_count
10034 - this_single_command_key_start
,
10035 (XVECTOR (this_command_keys
)->contents
10036 + this_single_command_key_start
));
10039 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10040 Sthis_single_command_raw_keys
, 0, 0, 0,
10041 doc
: /* Return the raw events that were read for this command.
10042 More generally, it returns the last key sequence read, either by
10043 the command loop or by `read-key-sequence'.
10044 Unlike `this-single-command-keys', this function's value
10045 shows the events before all translations (except for input methods).
10046 The value is always a vector. */)
10049 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10052 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10053 Sreset_this_command_lengths
, 0, 0, 0,
10054 doc
: /* Make the unread events replace the last command and echo.
10055 Used in `universal-argument-other-key'.
10057 `universal-argument-other-key' rereads the event just typed.
10058 It then gets translated through `function-key-map'.
10059 The translated event has to replace the real events,
10060 both in the value of (this-command-keys) and in echoing.
10061 To achieve this, `universal-argument-other-key' calls
10062 `reset-this-command-lengths', which discards the record of reading
10063 these events the first time. */)
10066 this_command_key_count
= before_command_key_count
;
10067 if (this_command_key_count
< this_single_command_key_start
)
10068 this_single_command_key_start
= this_command_key_count
;
10070 echo_truncate (before_command_echo_length
);
10072 /* Cause whatever we put into unread-command-events
10073 to echo as if it were being freshly read from the keyboard. */
10074 this_command_key_count_reset
= 1;
10079 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10080 Sclear_this_command_keys
, 0, 1, 0,
10081 doc
: /* Clear out the vector that `this-command-keys' returns.
10082 Also clear the record of the last 100 events, unless optional arg
10083 KEEP-RECORD is non-nil. */)
10084 (Lisp_Object keep_record
)
10088 this_command_key_count
= 0;
10089 this_command_key_count_reset
= 0;
10091 if (NILP (keep_record
))
10093 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10094 ASET (recent_keys
, i
, Qnil
);
10096 recent_keys_index
= 0;
10101 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10102 doc
: /* Return the current depth in recursive edits. */)
10106 /* Wrap around reliably on integer overflow. */
10107 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10108 XSETINT (temp
, sum
);
10112 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10113 "FOpen dribble file: ",
10114 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10115 If FILE is nil, close any open dribble file.
10116 The file will be closed when Emacs exits.
10118 Be aware that this records ALL characters you type!
10119 This may include sensitive information such as passwords. */)
10132 Lisp_Object encfile
;
10134 file
= Fexpand_file_name (file
, Qnil
);
10135 encfile
= ENCODE_FILE (file
);
10136 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10137 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10138 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10139 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10141 report_file_error ("Opening dribble", file
);
10146 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10147 doc
: /* Discard the contents of the terminal input buffer.
10148 Also end any kbd macro being defined. */)
10151 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10153 /* Discard the last command from the macro. */
10154 Fcancel_kbd_macro_events ();
10158 Vunread_command_events
= Qnil
;
10160 discard_tty_input ();
10162 kbd_fetch_ptr
= kbd_store_ptr
;
10168 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10169 doc
: /* Stop Emacs and return to superior process. You can resume later.
10170 If `cannot-suspend' is non-nil, or if the system doesn't support job
10171 control, run a subshell instead.
10173 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10174 to be read as terminal input by Emacs's parent, after suspension.
10176 Before suspending, run the normal hook `suspend-hook'.
10177 After resumption run the normal hook `suspend-resume-hook'.
10179 Some operating systems cannot stop the Emacs process and resume it later.
10180 On such systems, Emacs starts a subshell instead of suspending. */)
10181 (Lisp_Object stuffstring
)
10183 ptrdiff_t count
= SPECPDL_INDEX ();
10184 int old_height
, old_width
;
10186 struct gcpro gcpro1
;
10189 if (tty_list
&& tty_list
->next
)
10190 error ("There are other tty frames open; close them before suspending Emacs");
10192 if (!NILP (stuffstring
))
10193 CHECK_STRING (stuffstring
);
10195 /* Run the functions in suspend-hook. */
10196 hook
= intern ("suspend-hook");
10197 Frun_hooks (1, &hook
);
10199 GCPRO1 (stuffstring
);
10200 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10201 reset_all_sys_modes ();
10202 /* sys_suspend can get an error if it tries to fork a subshell
10203 and the system resources aren't available for that. */
10204 record_unwind_protect_void (init_all_sys_modes
);
10205 stuff_buffered_input (stuffstring
);
10206 if (cannot_suspend
)
10210 unbind_to (count
, Qnil
);
10212 /* Check if terminal/window size has changed.
10213 Note that this is not useful when we are running directly
10214 with a window system; but suspend should be disabled in that case. */
10215 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10216 if (width
!= old_width
|| height
!= old_height
)
10217 change_frame_size (SELECTED_FRAME (), width
, height
10218 - FRAME_MENU_BAR_LINES (SELECTED_FRAME ()), 0, 0, 0, 0);
10220 /* Run suspend-resume-hook. */
10221 hook
= intern ("suspend-resume-hook");
10222 Frun_hooks (1, &hook
);
10228 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10229 Then in any case stuff anything Emacs has read ahead and not used. */
10232 stuff_buffered_input (Lisp_Object stuffstring
)
10234 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10235 register unsigned char *p
;
10237 if (STRINGP (stuffstring
))
10239 register ptrdiff_t count
;
10241 p
= SDATA (stuffstring
);
10242 count
= SBYTES (stuffstring
);
10243 while (count
-- > 0)
10248 /* Anything we have read ahead, put back for the shell to read. */
10249 /* ?? What should this do when we have multiple keyboards??
10250 Should we ignore anything that was typed in at the "wrong" kboard?
10252 rms: we should stuff everything back into the kboard
10254 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10257 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10258 kbd_fetch_ptr
= kbd_buffer
;
10259 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10260 stuff_char (kbd_fetch_ptr
->code
);
10262 clear_event (kbd_fetch_ptr
);
10266 #endif /* SIGTSTP */
10270 set_waiting_for_input (struct timespec
*time_to_clear
)
10272 input_available_clear_time
= time_to_clear
;
10274 /* Tell handle_interrupt to throw back to read_char, */
10275 waiting_for_input
= 1;
10277 /* If handle_interrupt was called before and buffered a C-g,
10278 make it run again now, to avoid timing error. */
10279 if (!NILP (Vquit_flag
))
10280 quit_throw_to_read_char (0);
10284 clear_waiting_for_input (void)
10286 /* Tell handle_interrupt not to throw back to read_char, */
10287 waiting_for_input
= 0;
10288 input_available_clear_time
= 0;
10291 /* The SIGINT handler.
10293 If we have a frame on the controlling tty, we assume that the
10294 SIGINT was generated by C-g, so we call handle_interrupt.
10295 Otherwise, tell QUIT to kill Emacs. */
10298 handle_interrupt_signal (int sig
)
10300 /* See if we have an active terminal on our controlling tty. */
10301 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10304 /* If there are no frames there, let's pretend that we are a
10305 well-behaving UN*X program and quit. We must not call Lisp
10306 in a signal handler, so tell QUIT to exit when it is
10308 Vquit_flag
= Qkill_emacs
;
10312 /* Otherwise, the SIGINT was probably generated by C-g. */
10314 /* Set internal_last_event_frame to the top frame of the
10315 controlling tty, if we have a frame there. We disable the
10316 interrupt key on secondary ttys, so the SIGINT must have come
10317 from the controlling tty. */
10318 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10320 handle_interrupt (1);
10325 deliver_interrupt_signal (int sig
)
10327 deliver_process_signal (sig
, handle_interrupt_signal
);
10331 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10332 of the number of times C-g has been requested. If C-g is pressed
10333 enough times, then quit anyway. See bug#6585. */
10334 static int volatile force_quit_count
;
10336 /* This routine is called at interrupt level in response to C-g.
10338 It is called from the SIGINT handler or kbd_buffer_store_event.
10340 If `waiting_for_input' is non zero, then unless `echoing' is
10341 nonzero, immediately throw back to read_char.
10343 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10344 eval to throw, when it gets a chance. If quit-flag is already
10345 non-nil, it stops the job right away. */
10348 handle_interrupt (bool in_signal_handler
)
10354 /* XXX This code needs to be revised for multi-tty support. */
10355 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10357 if (! in_signal_handler
)
10359 /* If SIGINT isn't blocked, don't let us be interrupted by
10360 a SIGINT. It might be harmful due to non-reentrancy
10361 in I/O functions. */
10363 sigemptyset (&blocked
);
10364 sigaddset (&blocked
, SIGINT
);
10365 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10369 reset_all_sys_modes ();
10373 * On systems which can suspend the current process and return to the original
10374 * shell, this command causes the user to end up back at the shell.
10375 * The "Auto-save" and "Abort" questions are not asked until
10376 * the user elects to return to emacs, at which point he can save the current
10377 * job and either dump core or continue.
10381 /* Perhaps should really fork an inferior shell?
10382 But that would not provide any way to get back
10383 to the original shell, ever. */
10384 printf ("No support for stopping a process on this operating system;\n");
10385 printf ("you can continue or abort.\n");
10386 #endif /* not SIGTSTP */
10388 /* We must remain inside the screen area when the internal terminal
10389 is used. Note that [Enter] is not echoed by dos. */
10390 cursor_to (SELECTED_FRAME (), 0, 0);
10392 /* It doesn't work to autosave while GC is in progress;
10393 the code used for auto-saving doesn't cope with the mark bit. */
10394 if (!gc_in_progress
)
10396 printf ("Auto-save? (y or n) ");
10398 if (((c
= getchar ()) & ~040) == 'Y')
10400 Fdo_auto_save (Qt
, Qnil
);
10402 printf ("\r\nAuto-save done");
10403 #else /* not MSDOS */
10404 printf ("Auto-save done\n");
10405 #endif /* not MSDOS */
10407 while (c
!= '\n') c
= getchar ();
10411 /* During GC, it must be safe to reenable quitting again. */
10412 Vinhibit_quit
= Qnil
;
10415 #endif /* not MSDOS */
10416 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10417 printf ("but will instead do a real quit after garbage collection ends\r\n");
10422 printf ("\r\nAbort? (y or n) ");
10423 #else /* not MSDOS */
10424 printf ("Abort (and dump core)? (y or n) ");
10425 #endif /* not MSDOS */
10427 if (((c
= getchar ()) & ~040) == 'Y')
10429 while (c
!= '\n') c
= getchar ();
10431 printf ("\r\nContinuing...\r\n");
10432 #else /* not MSDOS */
10433 printf ("Continuing...\n");
10434 #endif /* not MSDOS */
10436 init_all_sys_modes ();
10440 /* If executing a function that wants to be interrupted out of
10441 and the user has not deferred quitting by binding `inhibit-quit'
10442 then quit right away. */
10443 if (immediate_quit
&& NILP (Vinhibit_quit
))
10445 struct gl_state_s saved
;
10446 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10448 immediate_quit
= 0;
10449 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10451 GCPRO4 (saved
.object
, saved
.global_code
,
10452 saved
.current_syntax_table
, saved
.old_prop
);
10453 Fsignal (Qquit
, Qnil
);
10458 { /* Else request quit when it's safe. */
10459 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10460 force_quit_count
= count
;
10463 immediate_quit
= 1;
10464 Vinhibit_quit
= Qnil
;
10470 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10472 /* TODO: The longjmp in this call throws the NS event loop integration off,
10473 and it seems to do fine without this. Probably some attention
10474 needs to be paid to the setting of waiting_for_input in
10475 wait_reading_process_output() under HAVE_NS because of the call
10476 to ns_select there (needed because otherwise events aren't picked up
10477 outside of polling since we don't get SIGIO like X and we don't have a
10478 separate event loop thread like W32. */
10480 if (waiting_for_input
&& !echoing
)
10481 quit_throw_to_read_char (in_signal_handler
);
10485 /* Handle a C-g by making read_char return C-g. */
10488 quit_throw_to_read_char (bool from_signal
)
10490 /* When not called from a signal handler it is safe to call
10492 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10493 Fkill_emacs (Qnil
);
10495 /* Prevent another signal from doing this before we finish. */
10496 clear_waiting_for_input ();
10499 Vunread_command_events
= Qnil
;
10501 if (FRAMEP (internal_last_event_frame
)
10502 && !EQ (internal_last_event_frame
, selected_frame
))
10503 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10506 sys_longjmp (getcjmp
, 1);
10509 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10510 Sset_input_interrupt_mode
, 1, 1, 0,
10511 doc
: /* Set interrupt mode of reading keyboard input.
10512 If INTERRUPT is non-nil, Emacs will use input interrupts;
10513 otherwise Emacs uses CBREAK mode.
10515 See also `current-input-mode'. */)
10516 (Lisp_Object interrupt
)
10518 bool new_interrupt_input
;
10519 #ifdef USABLE_SIGIO
10520 #ifdef HAVE_X_WINDOWS
10521 if (x_display_list
!= NULL
)
10523 /* When using X, don't give the user a real choice,
10524 because we haven't implemented the mechanisms to support it. */
10525 new_interrupt_input
= 1;
10528 #endif /* HAVE_X_WINDOWS */
10529 new_interrupt_input
= !NILP (interrupt
);
10530 #else /* not USABLE_SIGIO */
10531 new_interrupt_input
= 0;
10532 #endif /* not USABLE_SIGIO */
10534 if (new_interrupt_input
!= interrupt_input
)
10536 #ifdef POLL_FOR_INPUT
10540 /* this causes startup screen to be restored and messes with the mouse */
10541 reset_all_sys_modes ();
10542 interrupt_input
= new_interrupt_input
;
10543 init_all_sys_modes ();
10545 interrupt_input
= new_interrupt_input
;
10548 #ifdef POLL_FOR_INPUT
10549 poll_suppress_count
= 1;
10556 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10557 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10558 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10559 C-q in key sequences.
10561 This setting only has an effect on tty terminals and only when
10562 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10564 See also `current-input-mode'. */)
10565 (Lisp_Object flow
, Lisp_Object terminal
)
10567 struct terminal
*t
= get_terminal (terminal
, 1);
10568 struct tty_display_info
*tty
;
10569 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10571 tty
= t
->display_info
.tty
;
10573 if (tty
->flow_control
!= !NILP (flow
))
10576 /* This causes startup screen to be restored and messes with the mouse. */
10577 reset_sys_modes (tty
);
10580 tty
->flow_control
= !NILP (flow
);
10583 init_sys_modes (tty
);
10589 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10590 doc
: /* Enable or disable 8-bit input on TERMINAL.
10591 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10592 bit as the Meta modifier.
10594 If META is nil, Emacs will ignore the top bit, on the assumption it is
10597 Otherwise, Emacs will accept and pass through 8-bit input without
10598 specially interpreting the top bit.
10600 This setting only has an effect on tty terminal devices.
10602 Optional parameter TERMINAL specifies the tty terminal device to use.
10603 It may be a terminal object, a frame, or nil for the terminal used by
10604 the currently selected frame.
10606 See also `current-input-mode'. */)
10607 (Lisp_Object meta
, Lisp_Object terminal
)
10609 struct terminal
*t
= get_terminal (terminal
, 1);
10610 struct tty_display_info
*tty
;
10613 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10615 tty
= t
->display_info
.tty
;
10619 else if (EQ (meta
, Qt
))
10624 if (tty
->meta_key
!= new_meta
)
10627 /* this causes startup screen to be restored and messes with the mouse */
10628 reset_sys_modes (tty
);
10631 tty
->meta_key
= new_meta
;
10634 init_sys_modes (tty
);
10640 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10641 doc
: /* Specify character used for quitting.
10642 QUIT must be an ASCII character.
10644 This function only has an effect on the controlling tty of the Emacs
10647 See also `current-input-mode'. */)
10650 struct terminal
*t
= get_named_tty ("/dev/tty");
10651 struct tty_display_info
*tty
;
10652 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10654 tty
= t
->display_info
.tty
;
10656 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10657 error ("QUIT must be an ASCII character");
10660 /* this causes startup screen to be restored and messes with the mouse */
10661 reset_sys_modes (tty
);
10664 /* Don't let this value be out of range. */
10665 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10668 init_sys_modes (tty
);
10674 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10675 doc
: /* Set mode of reading keyboard input.
10676 First arg INTERRUPT non-nil means use input interrupts;
10677 nil means use CBREAK mode.
10678 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10679 (no effect except in CBREAK mode).
10680 Third arg META t means accept 8-bit input (for a Meta key).
10681 META nil means ignore the top bit, on the assumption it is parity.
10682 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10683 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10684 See also `current-input-mode'. */)
10685 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10687 Fset_input_interrupt_mode (interrupt
);
10688 Fset_output_flow_control (flow
, Qnil
);
10689 Fset_input_meta_mode (meta
, Qnil
);
10691 Fset_quit_char (quit
);
10695 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10696 doc
: /* Return information about the way Emacs currently reads keyboard input.
10697 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10698 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10699 nil, Emacs is using CBREAK mode.
10700 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10701 terminal; this does not apply if Emacs uses interrupt-driven input.
10702 META is t if accepting 8-bit input with 8th bit as Meta flag.
10703 META nil means ignoring the top bit, on the assumption it is parity.
10704 META is neither t nor nil if accepting 8-bit input and using
10705 all 8 bits as the character code.
10706 QUIT is the character Emacs currently uses to quit.
10707 The elements of this list correspond to the arguments of
10708 `set-input-mode'. */)
10711 Lisp_Object val
[4];
10712 struct frame
*sf
= XFRAME (selected_frame
);
10714 val
[0] = interrupt_input
? Qt
: Qnil
;
10715 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10717 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10718 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10720 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10727 XSETFASTINT (val
[3], quit_char
);
10729 return Flist (ARRAYELTS (val
), val
);
10732 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10733 doc
: /* Return position information for pixel coordinates X and Y.
10734 By default, X and Y are relative to text area of the selected window.
10735 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10736 If optional fourth arg WHOLE is non-nil, X is relative to the left
10737 edge of the window.
10739 The return value is similar to a mouse click position:
10740 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10741 IMAGE (DX . DY) (WIDTH . HEIGHT))
10742 The `posn-' functions access elements of such lists. */)
10743 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10748 if (NILP (frame_or_window
))
10749 frame_or_window
= selected_window
;
10751 if (WINDOWP (frame_or_window
))
10753 struct window
*w
= decode_live_window (frame_or_window
);
10755 XSETINT (x
, (XINT (x
)
10756 + WINDOW_LEFT_EDGE_X (w
)
10758 ? window_box_left_offset (w
, TEXT_AREA
)
10760 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10761 frame_or_window
= w
->frame
;
10764 CHECK_LIVE_FRAME (frame_or_window
);
10766 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10769 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10770 doc
: /* Return position information for buffer POS in WINDOW.
10771 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10773 Return nil if position is not visible in window. Otherwise,
10774 the return value is similar to that returned by `event-start' for
10775 a mouse click at the upper left corner of the glyph corresponding
10776 to the given buffer position:
10777 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10778 IMAGE (DX . DY) (WIDTH . HEIGHT))
10779 The `posn-' functions access elements of such lists. */)
10780 (Lisp_Object pos
, Lisp_Object window
)
10785 window
= selected_window
;
10787 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10790 Lisp_Object x
= XCAR (tem
);
10791 Lisp_Object y
= XCAR (XCDR (tem
));
10793 /* Point invisible due to hscrolling? */
10796 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10802 /* Set up a new kboard object with reasonable initial values.
10803 TYPE is a window system for which this keyboard is used. */
10806 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10808 kset_overriding_terminal_local_map (kb
, Qnil
);
10809 kset_last_command (kb
, Qnil
);
10810 kset_real_last_command (kb
, Qnil
);
10811 kset_keyboard_translate_table (kb
, Qnil
);
10812 kset_last_repeatable_command (kb
, Qnil
);
10813 kset_prefix_arg (kb
, Qnil
);
10814 kset_last_prefix_arg (kb
, Qnil
);
10815 kset_kbd_queue (kb
, Qnil
);
10816 kb
->kbd_queue_has_data
= 0;
10817 kb
->immediate_echo
= 0;
10818 kset_echo_string (kb
, Qnil
);
10819 kb
->echo_after_prompt
= -1;
10820 kb
->kbd_macro_buffer
= 0;
10821 kb
->kbd_macro_bufsize
= 0;
10822 kset_defining_kbd_macro (kb
, Qnil
);
10823 kset_last_kbd_macro (kb
, Qnil
);
10824 kb
->reference_count
= 0;
10825 kset_system_key_alist (kb
, Qnil
);
10826 kset_system_key_syms (kb
, Qnil
);
10827 kset_window_system (kb
, type
);
10828 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10829 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10830 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10831 kset_default_minibuffer_frame (kb
, Qnil
);
10834 /* Allocate and basically initialize keyboard
10835 object to use with window system TYPE. */
10838 allocate_kboard (Lisp_Object type
)
10840 KBOARD
*kb
= xmalloc (sizeof *kb
);
10842 init_kboard (kb
, type
);
10843 kb
->next_kboard
= all_kboards
;
10849 * Destroy the contents of a kboard object, but not the object itself.
10850 * We use this just before deleting it, or if we're going to initialize
10851 * it a second time.
10854 wipe_kboard (KBOARD
*kb
)
10856 xfree (kb
->kbd_macro_buffer
);
10859 /* Free KB and memory referenced from it. */
10862 delete_kboard (KBOARD
*kb
)
10866 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10869 *kbp
= kb
->next_kboard
;
10871 /* Prevent a dangling reference to KB. */
10872 if (kb
== current_kboard
10873 && FRAMEP (selected_frame
)
10874 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10876 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10878 if (current_kboard
== kb
)
10887 init_keyboard (void)
10889 /* This is correct before outermost invocation of the editor loop. */
10890 command_loop_level
= -1;
10891 immediate_quit
= 0;
10892 quit_char
= Ctl ('g');
10893 Vunread_command_events
= Qnil
;
10894 timer_idleness_start_time
= invalid_timespec ();
10896 recent_keys_index
= 0;
10897 kbd_fetch_ptr
= kbd_buffer
;
10898 kbd_store_ptr
= kbd_buffer
;
10899 do_mouse_tracking
= Qnil
;
10901 interrupt_input_blocked
= 0;
10902 pending_signals
= 0;
10904 /* This means that command_loop_1 won't try to select anything the first
10906 internal_last_event_frame
= Qnil
;
10907 Vlast_event_frame
= internal_last_event_frame
;
10909 current_kboard
= initial_kboard
;
10910 /* Re-initialize the keyboard again. */
10911 wipe_kboard (current_kboard
);
10912 /* A value of nil for Vwindow_system normally means a tty, but we also use
10913 it for the initial terminal since there is no window system there. */
10914 init_kboard (current_kboard
, Qnil
);
10916 if (!noninteractive
)
10918 /* Before multi-tty support, these handlers used to be installed
10919 only if the current session was a tty session. Now an Emacs
10920 session may have multiple display types, so we always handle
10921 SIGINT. There is special code in handle_interrupt_signal to exit
10922 Emacs on SIGINT when there are no termcap frames on the
10923 controlling terminal. */
10924 struct sigaction action
;
10925 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10926 sigaction (SIGINT
, &action
, 0);
10928 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10929 SIGQUIT and we can't tell which one it will give us. */
10930 sigaction (SIGQUIT
, &action
, 0);
10931 #endif /* not DOS_NT */
10933 #ifdef USABLE_SIGIO
10934 if (!noninteractive
)
10936 struct sigaction action
;
10937 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10938 sigaction (SIGIO
, &action
, 0);
10942 /* Use interrupt input by default, if it works and noninterrupt input
10943 has deficiencies. */
10945 #ifdef INTERRUPT_INPUT
10946 interrupt_input
= 1;
10948 interrupt_input
= 0;
10951 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10954 if (keyboard_init_hook
)
10955 (*keyboard_init_hook
) ();
10957 #ifdef POLL_FOR_INPUT
10959 poll_suppress_count
= 1;
10964 /* This type's only use is in syms_of_keyboard, to initialize the
10965 event header symbols and put properties on them. */
10966 struct event_head
{
10972 static const struct event_head head_table
[] = {
10973 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10974 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10975 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10976 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10977 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10978 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10979 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10980 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10981 /* `select-window' should be handled just like `switch-frame'
10982 in read_key_sequence. */
10983 {&Qselect_window
, "select-window", &Qswitch_frame
}
10987 syms_of_keyboard (void)
10989 pending_funcalls
= Qnil
;
10990 staticpro (&pending_funcalls
);
10992 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10993 staticpro (&Vlispy_mouse_stem
);
10996 DEFSYM (QCimage
, ":image");
10997 DEFSYM (Qhelp_echo
, "help-echo");
10998 DEFSYM (QCrtl
, ":rtl");
11000 staticpro (&item_properties
);
11001 item_properties
= Qnil
;
11003 staticpro (&tool_bar_item_properties
);
11004 tool_bar_item_properties
= Qnil
;
11005 staticpro (&tool_bar_items_vector
);
11006 tool_bar_items_vector
= Qnil
;
11008 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11009 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11010 DEFSYM (Qself_insert_command
, "self-insert-command");
11011 DEFSYM (Qforward_char
, "forward-char");
11012 DEFSYM (Qbackward_char
, "backward-char");
11013 DEFSYM (Qdisabled
, "disabled");
11014 DEFSYM (Qundefined
, "undefined");
11015 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11016 DEFSYM (Qpost_command_hook
, "post-command-hook");
11017 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11018 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11019 DEFSYM (Qfunction_key
, "function-key");
11020 DEFSYM (Qmouse_click
, "mouse-click");
11021 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11022 DEFSYM (Qsave_session
, "save-session");
11023 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11024 DEFSYM (Qmenu_enable
, "menu-enable");
11027 DEFSYM (Qlanguage_change
, "language-change");
11031 DEFSYM (Qdbus_event
, "dbus-event");
11034 #ifdef USE_FILE_NOTIFY
11035 DEFSYM (Qfile_notify
, "file-notify");
11036 #endif /* USE_FILE_NOTIFY */
11038 DEFSYM (QCenable
, ":enable");
11039 DEFSYM (QCvisible
, ":visible");
11040 DEFSYM (QChelp
, ":help");
11041 DEFSYM (QCfilter
, ":filter");
11042 DEFSYM (QCbutton
, ":button");
11043 DEFSYM (QCkeys
, ":keys");
11044 DEFSYM (QCkey_sequence
, ":key-sequence");
11045 DEFSYM (QCtoggle
, ":toggle");
11046 DEFSYM (QCradio
, ":radio");
11047 DEFSYM (QClabel
, ":label");
11048 DEFSYM (QCvert_only
, ":vert-only");
11050 DEFSYM (Qmode_line
, "mode-line");
11051 DEFSYM (Qvertical_line
, "vertical-line");
11052 DEFSYM (Qmenu_bar
, "menu-bar");
11053 DEFSYM (Qright_divider
, "right-divider");
11054 DEFSYM (Qbottom_divider
, "bottom-divider");
11056 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11058 DEFSYM (Qabove_handle
, "above-handle");
11059 DEFSYM (Qhandle
, "handle");
11060 DEFSYM (Qbelow_handle
, "below-handle");
11061 DEFSYM (Qup
, "up");
11062 DEFSYM (Qdown
, "down");
11063 DEFSYM (Qtop
, "top");
11064 DEFSYM (Qbottom
, "bottom");
11065 DEFSYM (Qend_scroll
, "end-scroll");
11066 DEFSYM (Qratio
, "ratio");
11067 DEFSYM (Qbefore_handle
, "before-handle");
11068 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11069 DEFSYM (Qafter_handle
, "after-handle");
11070 DEFSYM (Qleft
, "left");
11071 DEFSYM (Qright
, "right");
11072 DEFSYM (Qleftmost
, "leftmost");
11073 DEFSYM (Qrightmost
, "rightmost");
11075 DEFSYM (Qevent_kind
, "event-kind");
11076 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11077 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11078 DEFSYM (Qmodifier_cache
, "modifier-cache");
11080 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11081 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11083 DEFSYM (Qpolling_period
, "polling-period");
11085 DEFSYM (Qx_set_selection
, "x-set-selection");
11086 DEFSYM (QPRIMARY
, "PRIMARY");
11087 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11088 DEFSYM (Qhandle_select_window
, "handle-select-window");
11090 DEFSYM (Qinput_method_function
, "input-method-function");
11091 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11092 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11094 DEFSYM (Qhelp_form_show
, "help-form-show");
11096 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11098 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11099 Fset (Qinput_method_use_echo_area
, Qnil
);
11103 int len
= ARRAYELTS (head_table
);
11105 for (i
= 0; i
< len
; i
++)
11107 const struct event_head
*p
= &head_table
[i
];
11108 *p
->var
= intern_c_string (p
->name
);
11109 staticpro (p
->var
);
11110 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11111 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11115 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11116 staticpro (&button_down_location
);
11117 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11118 staticpro (&mouse_syms
);
11119 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11121 staticpro (&wheel_syms
);
11125 int len
= ARRAYELTS (modifier_names
);
11127 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11128 for (i
= 0; i
< len
; i
++)
11129 if (modifier_names
[i
])
11130 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11131 staticpro (&modifier_symbols
);
11134 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11135 staticpro (&recent_keys
);
11137 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11138 staticpro (&this_command_keys
);
11140 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11141 staticpro (&raw_keybuf
);
11143 DEFSYM (Qcommand_execute
, "command-execute");
11145 accent_key_syms
= Qnil
;
11146 staticpro (&accent_key_syms
);
11148 func_key_syms
= Qnil
;
11149 staticpro (&func_key_syms
);
11151 drag_n_drop_syms
= Qnil
;
11152 staticpro (&drag_n_drop_syms
);
11154 unread_switch_frame
= Qnil
;
11155 staticpro (&unread_switch_frame
);
11157 internal_last_event_frame
= Qnil
;
11158 staticpro (&internal_last_event_frame
);
11160 read_key_sequence_cmd
= Qnil
;
11161 staticpro (&read_key_sequence_cmd
);
11162 read_key_sequence_remapped
= Qnil
;
11163 staticpro (&read_key_sequence_remapped
);
11165 menu_bar_one_keymap_changed_items
= Qnil
;
11166 staticpro (&menu_bar_one_keymap_changed_items
);
11168 menu_bar_items_vector
= Qnil
;
11169 staticpro (&menu_bar_items_vector
);
11171 help_form_saved_window_configs
= Qnil
;
11172 staticpro (&help_form_saved_window_configs
);
11174 defsubr (&Scurrent_idle_time
);
11175 defsubr (&Sevent_symbol_parse_modifiers
);
11176 defsubr (&Sevent_convert_list
);
11177 defsubr (&Sread_key_sequence
);
11178 defsubr (&Sread_key_sequence_vector
);
11179 defsubr (&Srecursive_edit
);
11180 defsubr (&Strack_mouse
);
11181 defsubr (&Sinput_pending_p
);
11182 defsubr (&Srecent_keys
);
11183 defsubr (&Sthis_command_keys
);
11184 defsubr (&Sthis_command_keys_vector
);
11185 defsubr (&Sthis_single_command_keys
);
11186 defsubr (&Sthis_single_command_raw_keys
);
11187 defsubr (&Sreset_this_command_lengths
);
11188 defsubr (&Sclear_this_command_keys
);
11189 defsubr (&Ssuspend_emacs
);
11190 defsubr (&Sabort_recursive_edit
);
11191 defsubr (&Sexit_recursive_edit
);
11192 defsubr (&Srecursion_depth
);
11193 defsubr (&Scommand_error_default_function
);
11194 defsubr (&Stop_level
);
11195 defsubr (&Sdiscard_input
);
11196 defsubr (&Sopen_dribble_file
);
11197 defsubr (&Sset_input_interrupt_mode
);
11198 defsubr (&Sset_output_flow_control
);
11199 defsubr (&Sset_input_meta_mode
);
11200 defsubr (&Sset_quit_char
);
11201 defsubr (&Sset_input_mode
);
11202 defsubr (&Scurrent_input_mode
);
11203 defsubr (&Sposn_at_point
);
11204 defsubr (&Sposn_at_x_y
);
11206 DEFVAR_LISP ("last-command-event", last_command_event
,
11207 doc
: /* Last input event that was part of a command. */);
11209 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11210 doc
: /* Last input event in a command, except for mouse menu events.
11211 Mouse menus give back keys that don't look like mouse events;
11212 this variable holds the actual mouse event that led to the menu,
11213 so that you can determine whether the command was run by mouse or not. */);
11215 DEFVAR_LISP ("last-input-event", last_input_event
,
11216 doc
: /* Last input event. */);
11218 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11219 doc
: /* List of events to be read as the command input.
11220 These events are processed first, before actual keyboard input.
11221 Events read from this list are not normally added to `this-command-keys',
11222 as they will already have been added once as they were read for the first time.
11223 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11224 Vunread_command_events
= Qnil
;
11226 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11227 doc
: /* List of events to be processed as input by input methods.
11228 These events are processed before `unread-command-events'
11229 and actual keyboard input, but are not given to `input-method-function'. */);
11230 Vunread_post_input_method_events
= Qnil
;
11232 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11233 doc
: /* List of events to be processed as input by input methods.
11234 These events are processed after `unread-command-events', but
11235 before actual keyboard input.
11236 If there's an active input method, the events are given to
11237 `input-method-function'. */);
11238 Vunread_input_method_events
= Qnil
;
11240 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11241 doc
: /* Meta-prefix character code.
11242 Meta-foo as command input turns into this character followed by foo. */);
11243 XSETINT (meta_prefix_char
, 033);
11245 DEFVAR_KBOARD ("last-command", Vlast_command
,
11246 doc
: /* The last command executed.
11247 Normally a symbol with a function definition, but can be whatever was found
11248 in the keymap, or whatever the variable `this-command' was set to by that
11251 The value `mode-exit' is special; it means that the previous command
11252 read an event that told it to exit, and it did so and unread that event.
11253 In other words, the present command is the event that made the previous
11256 The value `kill-region' is special; it means that the previous command
11257 was a kill command.
11259 `last-command' has a separate binding for each terminal device.
11260 See Info node `(elisp)Multiple Terminals'. */);
11262 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11263 doc
: /* Same as `last-command', but never altered by Lisp code.
11264 Taken from the previous value of `real-this-command'. */);
11266 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11267 doc
: /* Last command that may be repeated.
11268 The last command executed that was not bound to an input event.
11269 This is the command `repeat' will try to repeat.
11270 Taken from a previous value of `real-this-command'. */);
11272 DEFVAR_LISP ("this-command", Vthis_command
,
11273 doc
: /* The command now being executed.
11274 The command can set this variable; whatever is put here
11275 will be in `last-command' during the following command. */);
11276 Vthis_command
= Qnil
;
11278 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11279 doc
: /* This is like `this-command', except that commands should never modify it. */);
11280 Vreal_this_command
= Qnil
;
11282 DEFVAR_LISP ("this-command-keys-shift-translated",
11283 Vthis_command_keys_shift_translated
,
11284 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11285 Shift-translation occurs when there is no binding for the key sequence
11286 as entered, but a binding was found by changing an upper-case letter
11287 to lower-case, or a shifted function key to an unshifted one. */);
11288 Vthis_command_keys_shift_translated
= Qnil
;
11290 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11291 doc
: /* The command bound to the current key sequence before remapping.
11292 It equals `this-command' if the original command was not remapped through
11293 any of the active keymaps. Otherwise, the value of `this-command' is the
11294 result of looking up the original command in the active keymaps. */);
11295 Vthis_original_command
= Qnil
;
11297 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11298 doc
: /* Number of input events between auto-saves.
11299 Zero means disable autosaving due to number of characters typed. */);
11300 auto_save_interval
= 300;
11302 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11303 doc
: /* Number of seconds idle time before auto-save.
11304 Zero or nil means disable auto-saving due to idleness.
11305 After auto-saving due to this many seconds of idle time,
11306 Emacs also does a garbage collection if that seems to be warranted. */);
11307 XSETFASTINT (Vauto_save_timeout
, 30);
11309 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11310 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11311 The value may be integer or floating point.
11312 If the value is zero, don't echo at all. */);
11313 Vecho_keystrokes
= make_number (1);
11315 DEFVAR_INT ("polling-period", polling_period
,
11316 doc
: /* Interval between polling for input during Lisp execution.
11317 The reason for polling is to make C-g work to stop a running program.
11318 Polling is needed only when using X windows and SIGIO does not work.
11319 Polling is automatically disabled in all other cases. */);
11320 polling_period
= 2;
11322 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11323 doc
: /* Maximum time between mouse clicks to make a double-click.
11324 Measured in milliseconds. The value nil means disable double-click
11325 recognition; t means double-clicks have no time limit and are detected
11326 by position only. */);
11327 Vdouble_click_time
= make_number (500);
11329 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11330 doc
: /* Maximum mouse movement between clicks to make a double-click.
11331 On window-system frames, value is the number of pixels the mouse may have
11332 moved horizontally or vertically between two clicks to make a double-click.
11333 On non window-system frames, value is interpreted in units of 1/8 characters
11336 This variable is also the threshold for motion of the mouse
11337 to count as a drag. */);
11338 double_click_fuzz
= 3;
11340 DEFVAR_INT ("num-input-keys", num_input_keys
,
11341 doc
: /* Number of complete key sequences read as input so far.
11342 This includes key sequences read from keyboard macros.
11343 The number is effectively the number of interactive command invocations. */);
11344 num_input_keys
= 0;
11346 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11347 doc
: /* Number of input events read from the keyboard so far.
11348 This does not include events generated by keyboard macros. */);
11349 num_nonmacro_input_events
= 0;
11351 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11352 doc
: /* The frame in which the most recently read event occurred.
11353 If the last event came from a keyboard macro, this is set to `macro'. */);
11354 Vlast_event_frame
= Qnil
;
11356 /* This variable is set up in sysdep.c. */
11357 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11358 doc
: /* The ERASE character as set by the user with stty. */);
11360 DEFVAR_LISP ("help-char", Vhelp_char
,
11361 doc
: /* Character to recognize as meaning Help.
11362 When it is read, do `(eval help-form)', and display result if it's a string.
11363 If the value of `help-form' is nil, this char can be read normally. */);
11364 XSETINT (Vhelp_char
, Ctl ('H'));
11366 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11367 doc
: /* List of input events to recognize as meaning Help.
11368 These work just like the value of `help-char' (see that). */);
11369 Vhelp_event_list
= Qnil
;
11371 DEFVAR_LISP ("help-form", Vhelp_form
,
11372 doc
: /* Form to execute when character `help-char' is read.
11373 If the form returns a string, that string is displayed.
11374 If `help-form' is nil, the help char is not recognized. */);
11377 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11378 doc
: /* Command to run when `help-char' character follows a prefix key.
11379 This command is used only when there is no actual binding
11380 for that character after that prefix key. */);
11381 Vprefix_help_command
= Qnil
;
11383 DEFVAR_LISP ("top-level", Vtop_level
,
11384 doc
: /* Form to evaluate when Emacs starts up.
11385 Useful to set before you dump a modified Emacs. */);
11388 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11389 doc
: /* Translate table for local keyboard input, or nil.
11390 If non-nil, the value should be a char-table. Each character read
11391 from the keyboard is looked up in this char-table. If the value found
11392 there is non-nil, then it is used instead of the actual input character.
11394 The value can also be a string or vector, but this is considered obsolete.
11395 If it is a string or vector of length N, character codes N and up are left
11396 untranslated. In a vector, an element which is nil means "no translation".
11398 This is applied to the characters supplied to input methods, not their
11399 output. See also `translation-table-for-input'.
11401 This variable has a separate binding for each terminal.
11402 See Info node `(elisp)Multiple Terminals'. */);
11404 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11405 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11406 \(Even if the operating system has support for stopping a process.\) */);
11407 cannot_suspend
= 0;
11409 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11410 doc
: /* Non-nil means prompt with menus when appropriate.
11411 This is done when reading from a keymap that has a prompt string,
11412 for elements that have prompt strings.
11413 The menu is displayed on the screen
11414 if X menus were enabled at configuration
11415 time and the previous event was a mouse click prefix key.
11416 Otherwise, menu prompting uses the echo area. */);
11417 menu_prompting
= 1;
11419 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11420 doc
: /* Character to see next line of menu prompt.
11421 Type this character while in a menu prompt to rotate around the lines of it. */);
11422 XSETINT (menu_prompt_more_char
, ' ');
11424 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11425 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11426 Emacs applies the modifiers of the character stored here to each keyboard
11427 character it reads. For example, after evaluating the expression
11428 (setq extra-keyboard-modifiers ?\\C-x)
11429 all input characters will have the control modifier applied to them.
11431 Note that the character ?\\C-@, equivalent to the integer zero, does
11432 not count as a control character; rather, it counts as a character
11433 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11434 cancels any modification. */);
11435 extra_keyboard_modifiers
= 0;
11437 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11438 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11439 The command loop sets this to nil before each command,
11440 and tests the value when the command returns.
11441 Buffer modification stores t in this variable. */);
11442 Vdeactivate_mark
= Qnil
;
11443 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11444 Fmake_variable_buffer_local (Qdeactivate_mark
);
11446 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11447 doc
: /* Normal hook run before each command is executed.
11448 If an unhandled error happens in running this hook,
11449 the function in which the error occurred is unconditionally removed, since
11450 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11451 Vpre_command_hook
= Qnil
;
11453 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11454 doc
: /* Normal hook run after each command is executed.
11455 If an unhandled error happens in running this hook,
11456 the function in which the error occurred is unconditionally removed, since
11457 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11458 Vpost_command_hook
= Qnil
;
11461 DEFVAR_LISP ("echo-area-clear-hook", ...,
11462 doc
: /* Normal hook run when clearing the echo area. */);
11464 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11465 Fset (Qecho_area_clear_hook
, Qnil
);
11467 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11468 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11469 Vlucid_menu_bar_dirty_flag
= Qnil
;
11471 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11472 doc
: /* List of menu bar items to move to the end of the menu bar.
11473 The elements of the list are event types that may have menu bar bindings. */);
11474 Vmenu_bar_final_items
= Qnil
;
11476 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11477 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11478 This is used internally by graphical displays that do not render
11479 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11480 Vtool_bar_separator_image_expression
= Qnil
;
11482 DEFVAR_KBOARD ("overriding-terminal-local-map",
11483 Voverriding_terminal_local_map
,
11484 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11485 This variable is intended to let commands such as `universal-argument'
11486 set up a different keymap for reading the next command.
11488 `overriding-terminal-local-map' has a separate binding for each
11489 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11491 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11492 doc
: /* Keymap that replaces (overrides) local keymaps.
11493 If this variable is non-nil, Emacs looks up key bindings in this
11494 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11495 buffer's local map. Hence, the only active keymaps would be
11496 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11497 order of precedence. */);
11498 Voverriding_local_map
= Qnil
;
11500 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11501 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11502 Otherwise, the menu bar continues to reflect the buffer's local map
11503 and the minor mode maps regardless of `overriding-local-map'. */);
11504 Voverriding_local_map_menu_flag
= Qnil
;
11506 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11507 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11508 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11510 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11511 doc
: /* Non-nil means generate motion events for mouse motion. */);
11513 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11514 doc
: /* Alist of system-specific X windows key symbols.
11515 Each element should have the form (N . SYMBOL) where N is the
11516 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11517 and SYMBOL is its name.
11519 `system-key-alist' has a separate binding for each terminal device.
11520 See Info node `(elisp)Multiple Terminals'. */);
11522 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11523 doc
: /* Keymap that translates key sequences to key sequences during input.
11524 This is used mainly for mapping key sequences into some preferred
11525 key events (symbols).
11527 The `read-key-sequence' function replaces any subsequence bound by
11528 `local-function-key-map' with its binding. More precisely, when the
11529 active keymaps have no binding for the current key sequence but
11530 `local-function-key-map' binds a suffix of the sequence to a vector or
11531 string, `read-key-sequence' replaces the matching suffix with its
11532 binding, and continues with the new sequence.
11534 If the binding is a function, it is called with one argument (the prompt)
11535 and its return value (a key sequence) is used.
11537 The events that come from bindings in `local-function-key-map' are not
11538 themselves looked up in `local-function-key-map'.
11540 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11541 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11542 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11543 typing `ESC O P x' would return [f1 x].
11545 `local-function-key-map' has a separate binding for each terminal
11546 device. See Info node `(elisp)Multiple Terminals'. If you need to
11547 define a binding on all terminals, change `function-key-map'
11548 instead. Initially, `local-function-key-map' is an empty keymap that
11549 has `function-key-map' as its parent on all terminal devices. */);
11551 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11552 doc
: /* Keymap that decodes input escape sequences.
11553 This is used mainly for mapping ASCII function key sequences into
11554 real Emacs function key events (symbols).
11556 The `read-key-sequence' function replaces any subsequence bound by
11557 `input-decode-map' with its binding. Contrary to `function-key-map',
11558 this map applies its rebinding regardless of the presence of an ordinary
11559 binding. So it is more like `key-translation-map' except that it applies
11560 before `function-key-map' rather than after.
11562 If the binding is a function, it is called with one argument (the prompt)
11563 and its return value (a key sequence) is used.
11565 The events that come from bindings in `input-decode-map' are not
11566 themselves looked up in `input-decode-map'. */);
11568 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11569 doc
: /* The parent keymap of all `local-function-key-map' instances.
11570 Function key definitions that apply to all terminal devices should go
11571 here. If a mapping is defined in both the current
11572 `local-function-key-map' binding and this variable, then the local
11573 definition will take precedence. */);
11574 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11576 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11577 doc
: /* Keymap of key translations that can override keymaps.
11578 This keymap works like `input-decode-map', but comes after `function-key-map'.
11579 Another difference is that it is global rather than terminal-local. */);
11580 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11582 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11583 doc
: /* List of deferred actions to be performed at a later time.
11584 The precise format isn't relevant here; we just check whether it is nil. */);
11585 Vdeferred_action_list
= Qnil
;
11587 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11588 doc
: /* Function to call to handle deferred actions, after each command.
11589 This function is called with no arguments after each command
11590 whenever `deferred-action-list' is non-nil. */);
11591 Vdeferred_action_function
= Qnil
;
11593 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11594 doc
: /* List of warnings to be displayed after this command.
11595 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11596 as per the args of `display-warning' (which see).
11597 If this variable is non-nil, `delayed-warnings-hook' will be run
11598 immediately after running `post-command-hook'. */);
11599 Vdelayed_warnings_list
= Qnil
;
11601 DEFVAR_LISP ("timer-list", Vtimer_list
,
11602 doc
: /* List of active absolute time timers in order of increasing time. */);
11603 Vtimer_list
= Qnil
;
11605 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11606 doc
: /* List of active idle-time timers in order of increasing time. */);
11607 Vtimer_idle_list
= Qnil
;
11609 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11610 doc
: /* If non-nil, the function that implements the current input method.
11611 It's called with one argument, a printing character that was just read.
11612 \(That means a character with code 040...0176.)
11613 Typically this function uses `read-event' to read additional events.
11614 When it does so, it should first bind `input-method-function' to nil
11615 so it will not be called recursively.
11617 The function should return a list of zero or more events
11618 to be used as input. If it wants to put back some events
11619 to be reconsidered, separately, by the input method,
11620 it can add them to the beginning of `unread-command-events'.
11622 The input method function can find in `input-method-previous-message'
11623 the previous echo area message.
11625 The input method function should refer to the variables
11626 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11627 for guidance on what to do. */);
11628 Vinput_method_function
= Qnil
;
11630 DEFVAR_LISP ("input-method-previous-message",
11631 Vinput_method_previous_message
,
11632 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11633 This variable exists because `read-event' clears the echo area
11634 before running the input method. It is nil if there was no message. */);
11635 Vinput_method_previous_message
= Qnil
;
11637 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11638 doc
: /* If non-nil, the function that implements the display of help.
11639 It's called with one argument, the help string to display. */);
11640 Vshow_help_function
= Qnil
;
11642 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11643 doc
: /* If non-nil, suppress point adjustment after executing a command.
11645 After a command is executed, if point is moved into a region that has
11646 special properties (e.g. composition, display), we adjust point to
11647 the boundary of the region. But, when a command sets this variable to
11648 non-nil, we suppress the point adjustment.
11650 This variable is set to nil before reading a command, and is checked
11651 just after executing the command. */);
11652 Vdisable_point_adjustment
= Qnil
;
11654 DEFVAR_LISP ("global-disable-point-adjustment",
11655 Vglobal_disable_point_adjustment
,
11656 doc
: /* If non-nil, always suppress point adjustment.
11658 The default value is nil, in which case, point adjustment are
11659 suppressed only after special commands that set
11660 `disable-point-adjustment' (which see) to non-nil. */);
11661 Vglobal_disable_point_adjustment
= Qnil
;
11663 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11664 doc
: /* How long to display an echo-area message when the minibuffer is active.
11665 If the value is not a number, such messages don't time out. */);
11666 Vminibuffer_message_timeout
= make_number (2);
11668 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11669 doc
: /* If non-nil, any keyboard input throws to this symbol.
11670 The value of that variable is passed to `quit-flag' and later causes a
11671 peculiar kind of quitting. */);
11672 Vthrow_on_input
= Qnil
;
11674 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11675 doc
: /* Function to output error messages.
11676 Called with three arguments:
11677 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11678 such as what `condition-case' would bind its variable to,
11679 - the context (a string which normally goes at the start of the message),
11680 - the Lisp function within which the error was signaled. */);
11681 Vcommand_error_function
= intern ("command-error-default-function");
11683 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11684 Venable_disabled_menus_and_buttons
,
11685 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11687 Help functions bind this to allow help on disabled menu items
11688 and tool-bar buttons. */);
11689 Venable_disabled_menus_and_buttons
= Qnil
;
11691 DEFVAR_LISP ("select-active-regions",
11692 Vselect_active_regions
,
11693 doc
: /* If non-nil, an active region automatically sets the primary selection.
11694 If the value is `only', only temporarily active regions (usually made
11695 by mouse-dragging or shift-selection) set the window selection.
11697 This takes effect only when Transient Mark mode is enabled. */);
11698 Vselect_active_regions
= Qt
;
11700 DEFVAR_LISP ("saved-region-selection",
11701 Vsaved_region_selection
,
11702 doc
: /* Contents of active region prior to buffer modification.
11703 If `select-active-regions' is non-nil, Emacs sets this to the
11704 text in the region before modifying the buffer. The next call to
11705 the function `deactivate-mark' uses this to set the window selection. */);
11706 Vsaved_region_selection
= Qnil
;
11708 DEFVAR_LISP ("selection-inhibit-update-commands",
11709 Vselection_inhibit_update_commands
,
11710 doc
: /* List of commands which should not update the selection.
11711 Normally, if `select-active-regions' is non-nil and the mark remains
11712 active after a command (i.e. the mark was not deactivated), the Emacs
11713 command loop sets the selection to the text in the region. However,
11714 if the command is in this list, the selection is not updated. */);
11715 Vselection_inhibit_update_commands
11716 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11718 DEFVAR_LISP ("debug-on-event",
11720 doc
: /* Enter debugger on this event. When Emacs
11721 receives the special event specified by this variable, it will try to
11722 break into the debugger as soon as possible instead of processing the
11723 event normally through `special-event-map'.
11725 Currently, the only supported values for this
11726 variable are `sigusr1' and `sigusr2'. */);
11727 Vdebug_on_event
= intern_c_string ("sigusr2");
11729 /* Create the initial keyboard. Qt means 'unset'. */
11730 initial_kboard
= allocate_kboard (Qt
);
11734 keys_of_keyboard (void)
11736 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11737 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11738 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11739 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11740 initial_define_key (meta_map
, 'x', "execute-extended-command");
11742 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11743 "handle-delete-frame");
11744 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11745 "ns-put-working-text");
11746 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11747 "ns-unput-working-text");
11748 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11749 current-prefix-arg, as is done in `handle-switch-frame'.
11750 But `handle-switch-frame is not run from the special-map.
11751 Commands from that map are run in a special way that automatically
11752 preserves the prefix-arg. Restoring the prefix arg here is not just
11753 redundant but harmful:
11755 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11756 - after the first prompt, the exit-minibuffer-hook is run which may
11757 iconify a frame and thus push a `iconify-frame' event.
11758 - after running exit-minibuffer-hook, current-prefix-arg is
11759 restored to the non-nil value it had before the prompt.
11760 - we enter the second prompt.
11761 current-prefix-arg is non-nil, prefix-arg is nil.
11762 - before running the first real event, we run the special iconify-frame
11763 event, but we pass the `special' arg to execute-command so
11764 current-prefix-arg and prefix-arg are left untouched.
11765 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11766 - the next key event will have a spuriously non-nil current-prefix-arg. */
11767 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11769 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11771 /* Handling it at such a low-level causes read_key_sequence to get
11772 * confused because it doesn't realize that the current_buffer was
11773 * changed by read_char.
11775 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11776 * "handle-select-window"); */
11777 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11778 "handle-save-session");
11781 /* Define a special event which is raised for dbus callback
11783 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11784 "dbus-handle-event");
11787 #ifdef USE_FILE_NOTIFY
11788 /* Define a special event which is raised for notification callback
11790 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11791 "file-notify-handle-event");
11792 #endif /* USE_FILE_NOTIFY */
11794 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11796 #if defined (WINDOWSNT)
11797 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11800 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11801 "handle-focus-in");
11802 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11803 "handle-focus-out");
11806 /* Mark the pointers in the kboard objects.
11807 Called by Fgarbage_collect. */
11809 mark_kboards (void)
11813 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11815 if (kb
->kbd_macro_buffer
)
11816 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11818 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11819 mark_object (KVAR (kb
, Vlast_command
));
11820 mark_object (KVAR (kb
, Vreal_last_command
));
11821 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11822 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11823 mark_object (KVAR (kb
, Vprefix_arg
));
11824 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11825 mark_object (KVAR (kb
, kbd_queue
));
11826 mark_object (KVAR (kb
, defining_kbd_macro
));
11827 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11828 mark_object (KVAR (kb
, Vsystem_key_alist
));
11829 mark_object (KVAR (kb
, system_key_syms
));
11830 mark_object (KVAR (kb
, Vwindow_system
));
11831 mark_object (KVAR (kb
, Vinput_decode_map
));
11832 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11833 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11834 mark_object (KVAR (kb
, echo_string
));
11837 struct input_event
*event
;
11838 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11840 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11841 event
= kbd_buffer
;
11842 /* These two special event types has no Lisp_Objects to mark. */
11843 if (event
->kind
!= SELECTION_REQUEST_EVENT
11844 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11846 mark_object (event
->x
);
11847 mark_object (event
->y
);
11848 mark_object (event
->frame_or_window
);
11849 mark_object (event
->arg
);