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"
56 #include <sys/ioctl.h>
57 #endif /* not MSDOS */
59 #if defined USABLE_FIONREAD && defined USG5_4
60 # include <sys/filio.h>
63 #include "syssignal.h"
65 #include <sys/types.h>
69 #ifdef HAVE_WINDOW_SYSTEM
71 #endif /* HAVE_WINDOW_SYSTEM */
73 #include <gc.h> /* for GC_collect_a_little */
75 /* Variables for blockinput.h: */
77 /* Positive if interrupt input is blocked right now. */
78 volatile int interrupt_input_blocked
;
80 /* True means an input interrupt or alarm signal has arrived.
81 The QUIT macro checks this. */
82 volatile bool pending_signals
;
84 #define KBD_BUFFER_SIZE 4096
86 KBOARD
*initial_kboard
;
87 KBOARD
*current_kboard
;
88 static KBOARD
*all_kboards
;
90 /* True in the single-kboard state, false in the any-kboard state. */
91 static bool single_kboard
;
93 /* Non-nil disable property on a command means
94 do not execute it; call disabled-command-function's value instead. */
95 Lisp_Object Qdisabled
;
96 static Lisp_Object Qdisabled_command_function
;
98 #define NUM_RECENT_KEYS (300)
100 /* Index for storing next element into recent_keys. */
101 static int recent_keys_index
;
103 /* Total number of elements stored into recent_keys. */
104 static int total_keys
;
106 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
107 static Lisp_Object recent_keys
;
109 /* Vector holding the key sequence that invoked the current command.
110 It is reused for each command, and it may be longer than the current
111 sequence; this_command_key_count indicates how many elements
112 actually mean something.
113 It's easier to staticpro a single Lisp_Object than an array. */
114 Lisp_Object this_command_keys
;
115 ptrdiff_t this_command_key_count
;
117 /* True after calling Freset_this_command_lengths.
118 Usually it is false. */
119 static bool this_command_key_count_reset
;
121 /* This vector is used as a buffer to record the events that were actually read
122 by read_key_sequence. */
123 static Lisp_Object raw_keybuf
;
124 static int raw_keybuf_count
;
126 #define GROW_RAW_KEYBUF \
127 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
128 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
130 /* Number of elements of this_command_keys
131 that precede this key sequence. */
132 static ptrdiff_t this_single_command_key_start
;
134 /* Record values of this_command_key_count and echo_length ()
135 before this command was read. */
136 static ptrdiff_t before_command_key_count
;
137 static ptrdiff_t before_command_echo_length
;
139 /* For longjmp to where kbd input is being done. */
141 static Lisp_Object getctag
;
143 /* True while doing kbd input. */
144 bool waiting_for_input
;
146 /* True while displaying for echoing. Delays C-g throwing. */
150 /* Non-null means we can start echoing at the next input pause even
151 though there is something in the echo area. */
153 static struct kboard
*ok_to_echo_at_next_pause
;
155 /* The kboard last echoing, or null for none. Reset to 0 in
156 cancel_echoing. If non-null, and a current echo area message
157 exists, and echo_message_buffer is eq to the current message
158 buffer, we know that the message comes from echo_kboard. */
160 struct kboard
*echo_kboard
;
162 /* The buffer used for echoing. Set in echo_now, reset in
165 Lisp_Object echo_message_buffer
;
167 /* True means C-g should cause immediate error-signal. */
170 /* Character that causes a quit. Normally C-g.
172 If we are running on an ordinary terminal, this must be an ordinary
173 ASCII char, since we want to make it our interrupt character.
175 If we are not running on an ordinary terminal, it still needs to be
176 an ordinary ASCII char. This character needs to be recognized in
177 the input interrupt handler. At this point, the keystroke is
178 represented as a struct input_event, while the desired quit
179 character is specified as a lispy event. The mapping from struct
180 input_events to lispy events cannot run in an interrupt handler,
181 and the reverse mapping is difficult for anything but ASCII
184 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
188 /* Current depth in recursive edits. */
189 EMACS_INT command_loop_level
;
191 /* If not Qnil, this is a switch-frame event which we decided to put
192 off until the end of a key sequence. This should be read as the
193 next command input, after any unread_command_events.
195 read_key_sequence uses this to delay switch-frame events until the
196 end of the key sequence; Fread_char uses it to put off switch-frame
197 events until a non-ASCII event is acceptable as input. */
198 Lisp_Object unread_switch_frame
;
200 /* Last size recorded for a current buffer which is not a minibuffer. */
201 static ptrdiff_t last_non_minibuf_size
;
203 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
204 uintmax_t num_input_events
;
206 /* Value of num_nonmacro_input_events as of last auto save. */
208 static EMACS_INT last_auto_save
;
210 /* The value of point when the last command was started. */
211 static ptrdiff_t last_point_position
;
213 /* The frame in which the last input event occurred, or Qmacro if the
214 last event came from a macro. We use this to determine when to
215 generate switch-frame events. This may be cleared by functions
216 like Fselect_frame, to make sure that a switch-frame event is
217 generated by the next character.
219 FIXME: This is modified by a signal handler so it should be volatile.
220 It's exported to Lisp, though, so it can't simply be marked
222 Lisp_Object internal_last_event_frame
;
224 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
225 static Lisp_Object Qhandle_select_window
;
226 Lisp_Object QPRIMARY
;
228 static Lisp_Object Qself_insert_command
;
229 static Lisp_Object Qforward_char
;
230 static Lisp_Object Qbackward_char
;
231 Lisp_Object Qundefined
;
232 static Lisp_Object Qtimer_event_handler
;
234 /* `read_key_sequence' stores here the command definition of the
235 key sequence that it reads. */
236 static Lisp_Object read_key_sequence_cmd
;
237 static Lisp_Object read_key_sequence_remapped
;
239 static Lisp_Object Qinput_method_function
;
241 static Lisp_Object Qdeactivate_mark
;
243 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
245 static Lisp_Object Qecho_area_clear_hook
;
247 /* Hooks to run before and after each command. */
248 static Lisp_Object Qpre_command_hook
;
249 static Lisp_Object Qpost_command_hook
;
251 static Lisp_Object Qdeferred_action_function
;
253 static Lisp_Object Qdelayed_warnings_hook
;
255 static Lisp_Object Qinput_method_exit_on_first_char
;
256 static Lisp_Object Qinput_method_use_echo_area
;
258 static Lisp_Object Qhelp_form_show
;
260 /* File in which we write all commands we read. */
261 static FILE *dribble
;
263 /* Nonzero if input is available. */
266 /* Circular buffer for pre-read keyboard input. */
268 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
270 /* Pointer to next available character in kbd_buffer.
271 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
272 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
273 next available char is in kbd_buffer[0]. */
274 static struct input_event
*kbd_fetch_ptr
;
276 /* Pointer to next place to store character in kbd_buffer. This
277 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
278 character should go in kbd_buffer[0]. */
279 static struct input_event
* volatile kbd_store_ptr
;
281 /* The above pair of variables forms a "queue empty" flag. When we
282 enqueue a non-hook event, we increment kbd_store_ptr. When we
283 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
284 there is input available if the two pointers are not equal.
286 Why not just have a flag set and cleared by the enqueuing and
287 dequeuing functions? Such a flag could be screwed up by interrupts
288 at inopportune times. */
290 /* Symbols to head events. */
291 static Lisp_Object Qmouse_movement
;
292 static Lisp_Object Qscroll_bar_movement
;
293 Lisp_Object Qswitch_frame
;
294 static Lisp_Object Qfocus_in
, Qfocus_out
;
295 static Lisp_Object Qdelete_frame
;
296 static Lisp_Object Qiconify_frame
;
297 static Lisp_Object Qmake_frame_visible
;
298 static Lisp_Object Qselect_window
;
299 Lisp_Object Qhelp_echo
;
301 static Lisp_Object Qmouse_fixup_help_message
;
303 /* Symbols to denote kinds of events. */
304 static Lisp_Object Qfunction_key
;
305 Lisp_Object Qmouse_click
;
307 Lisp_Object Qlanguage_change
;
309 static Lisp_Object Qdrag_n_drop
;
310 static Lisp_Object Qsave_session
;
312 static Lisp_Object Qdbus_event
;
314 #ifdef USE_FILE_NOTIFY
315 static Lisp_Object Qfile_notify
;
316 #endif /* USE_FILE_NOTIFY */
317 static Lisp_Object Qconfig_changed_event
;
319 /* Lisp_Object Qmouse_movement; - also an event header */
321 /* Properties of event headers. */
322 Lisp_Object Qevent_kind
;
323 static Lisp_Object Qevent_symbol_elements
;
325 /* Menu and tool bar item parts. */
326 static Lisp_Object Qmenu_enable
;
327 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
328 Lisp_Object QCfilter
;
330 /* Non-nil disable property on a command means
331 do not execute it; call disabled-command-function's value instead. */
332 Lisp_Object QCtoggle
, QCradio
;
333 static Lisp_Object QCbutton
, QClabel
;
335 static Lisp_Object QCvert_only
;
337 /* An event header symbol HEAD may have a property named
338 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
339 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
340 mask of modifiers applied to it. If present, this is used to help
341 speed up parse_modifiers. */
342 Lisp_Object Qevent_symbol_element_mask
;
344 /* An unmodified event header BASE may have a property named
345 Qmodifier_cache, which is an alist mapping modifier masks onto
346 modified versions of BASE. If present, this helps speed up
348 static Lisp_Object Qmodifier_cache
;
350 /* Symbols to use for parts of windows. */
351 Lisp_Object Qmode_line
;
352 Lisp_Object Qvertical_line
;
353 Lisp_Object Qright_divider
, Qbottom_divider
;
354 static Lisp_Object Qvertical_scroll_bar
;
355 Lisp_Object Qmenu_bar
;
357 static Lisp_Object Qecho_keystrokes
;
359 static void recursive_edit_unwind (Lisp_Object buffer
);
360 static Lisp_Object
command_loop (void);
361 static Lisp_Object Qcommand_execute
;
363 static void echo_now (void);
364 static ptrdiff_t echo_length (void);
366 static Lisp_Object Qpolling_period
;
368 /* Incremented whenever a timer is run. */
371 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
373 struct timespec
*input_available_clear_time
;
375 /* True means use SIGIO interrupts; false means use CBREAK mode.
376 Default is true if INTERRUPT_INPUT is defined. */
377 bool interrupt_input
;
379 /* Nonzero while interrupts are temporarily deferred during redisplay. */
380 bool interrupts_deferred
;
382 /* The time when Emacs started being idle. */
384 static struct timespec timer_idleness_start_time
;
386 /* After Emacs stops being idle, this saves the last value
387 of timer_idleness_start_time from when it was idle. */
389 static struct timespec timer_last_idleness_start_time
;
392 /* Global variable declarations. */
394 /* Flags for readable_events. */
395 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
396 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
397 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
399 /* Function for init_keyboard to call with no args (if nonzero). */
400 static void (*keyboard_init_hook
) (void);
402 static bool get_input_pending (int);
403 static bool readable_events (int);
404 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
405 Lisp_Object
, bool *);
406 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
407 static Lisp_Object
make_lispy_event (struct input_event
*);
408 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
409 enum scroll_bar_part
,
410 Lisp_Object
, Lisp_Object
,
412 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
413 Lisp_Object
, const char *const *,
414 Lisp_Object
*, ptrdiff_t);
415 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
416 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
417 #ifdef HAVE_WINDOW_SYSTEM
418 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
419 #endif /* HAVE_WINDOW_SYSTEM */
420 static bool help_char_p (Lisp_Object
);
421 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
422 static void clear_event (struct input_event
*);
423 static void restore_kboard_configuration (int);
425 static void deliver_input_available_signal (int signo
);
427 static void handle_interrupt (bool);
428 static _Noreturn
void quit_throw_to_read_char (bool);
429 static void process_special_events (void);
430 static void timer_start_idle (void);
431 static void timer_stop_idle (void);
432 static void timer_resume_idle (void);
433 static void deliver_user_signal (int);
434 static char *find_user_signal_name (int);
435 static void store_user_signal_events (void);
437 /* These setters are used only in this file, so they can be private. */
439 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
441 kb
->INTERNAL_FIELD (echo_string
) = val
;
444 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
446 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
449 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
451 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
454 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
456 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
459 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
461 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
464 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
466 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
469 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
471 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
474 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
476 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
479 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
481 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
485 /* Add C to the echo string, without echoing it immediately. C can be
486 a character, which is pretty-printed, or a symbol, whose name is
490 echo_add_key (Lisp_Object c
)
492 int size
= KEY_DESCRIPTION_SIZE
+ 100;
493 char *buffer
= alloca (size
);
495 Lisp_Object echo_string
;
497 echo_string
= KVAR (current_kboard
, echo_string
);
499 /* If someone has passed us a composite event, use its head symbol. */
503 ptr
= push_key_description (XINT (c
), ptr
);
504 else if (SYMBOLP (c
))
506 Lisp_Object name
= SYMBOL_NAME (c
);
507 int nbytes
= SBYTES (name
);
509 if (size
- (ptr
- buffer
) < nbytes
)
511 int offset
= ptr
- buffer
;
512 size
= max (2 * size
, size
+ nbytes
);
513 buffer
= alloca (size
);
514 ptr
= buffer
+ offset
;
517 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
518 STRING_MULTIBYTE (name
), 1);
521 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
524 const char *text
= " (Type ? for further options)";
525 int len
= strlen (text
);
527 if (size
- (ptr
- buffer
) < len
)
529 int offset
= ptr
- buffer
;
531 buffer
= alloca (size
);
532 ptr
= buffer
+ offset
;
535 memcpy (ptr
, text
, len
);
539 /* Replace a dash from echo_dash with a space, otherwise add a space
540 at the end as a separator between keys. */
541 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
543 Lisp_Object last_char
, prev_char
, idx
;
545 idx
= make_number (SCHARS (echo_string
) - 2);
546 prev_char
= Faref (echo_string
, idx
);
548 idx
= make_number (SCHARS (echo_string
) - 1);
549 last_char
= Faref (echo_string
, idx
);
551 /* We test PREV_CHAR to make sure this isn't the echoing of a
553 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
554 Faset (echo_string
, idx
, make_number (' '));
556 echo_string
= concat2 (echo_string
, build_string (" "));
558 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
559 echo_string
= concat2 (echo_string
, build_string (" "));
563 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
566 /* Add C to the echo string, if echoing is going on. C can be a
567 character or a symbol. */
570 echo_char (Lisp_Object c
)
572 if (current_kboard
->immediate_echo
)
579 /* Temporarily add a dash to the end of the echo string if it's not
580 empty, so that it serves as a mini-prompt for the very next
586 /* Do nothing if not echoing at all. */
587 if (NILP (KVAR (current_kboard
, echo_string
)))
590 if (this_command_key_count
== 0)
593 if (!current_kboard
->immediate_echo
594 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
597 /* Do nothing if we just printed a prompt. */
598 if (current_kboard
->echo_after_prompt
599 == SCHARS (KVAR (current_kboard
, echo_string
)))
602 /* Do nothing if we have already put a dash at the end. */
603 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
605 Lisp_Object last_char
, prev_char
, idx
;
607 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
608 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
610 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
611 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
613 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
617 /* Put a dash at the end of the buffer temporarily,
618 but make it go away when the next character is added. */
621 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
625 /* Display the current echo string, and begin echoing if not already
631 if (!current_kboard
->immediate_echo
)
634 current_kboard
->immediate_echo
= 1;
636 for (i
= 0; i
< this_command_key_count
; i
++)
640 /* Set before_command_echo_length to the value that would
641 have been saved before the start of this subcommand in
642 command_loop_1, if we had already been echoing then. */
643 if (i
== this_single_command_key_start
)
644 before_command_echo_length
= echo_length ();
646 c
= AREF (this_command_keys
, i
);
647 if (! (EVENT_HAS_PARAMETERS (c
)
648 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
652 /* Set before_command_echo_length to the value that would
653 have been saved before the start of this subcommand in
654 command_loop_1, if we had already been echoing then. */
655 if (this_command_key_count
== this_single_command_key_start
)
656 before_command_echo_length
= echo_length ();
658 /* Put a dash at the end to invite the user to type more. */
663 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
664 message3_nolog (KVAR (current_kboard
, echo_string
));
667 /* Record in what buffer we echoed, and from which kboard. */
668 echo_message_buffer
= echo_area_buffer
[0];
669 echo_kboard
= current_kboard
;
671 if (waiting_for_input
&& !NILP (Vquit_flag
))
672 quit_throw_to_read_char (0);
675 /* Turn off echoing, for the start of a new command. */
678 cancel_echoing (void)
680 current_kboard
->immediate_echo
= 0;
681 current_kboard
->echo_after_prompt
= -1;
682 kset_echo_string (current_kboard
, Qnil
);
683 ok_to_echo_at_next_pause
= NULL
;
685 echo_message_buffer
= Qnil
;
688 /* Return the length of the current echo string. */
693 return (STRINGP (KVAR (current_kboard
, echo_string
))
694 ? SCHARS (KVAR (current_kboard
, echo_string
))
698 /* Truncate the current echo message to its first LEN chars.
699 This and echo_char get used by read_key_sequence when the user
700 switches frames while entering a key sequence. */
703 echo_truncate (ptrdiff_t nchars
)
705 if (STRINGP (KVAR (current_kboard
, echo_string
)))
706 kset_echo_string (current_kboard
,
707 Fsubstring (KVAR (current_kboard
, echo_string
),
708 make_number (0), make_number (nchars
)));
709 truncate_echo_area (nchars
);
713 /* Functions for manipulating this_command_keys. */
715 add_command_key (Lisp_Object key
)
717 #if 0 /* Not needed after we made Freset_this_command_lengths
718 do the job immediately. */
719 /* If reset-this-command-length was called recently, obey it now.
720 See the doc string of that function for an explanation of why. */
721 if (before_command_restore_flag
)
723 this_command_key_count
= before_command_key_count_1
;
724 if (this_command_key_count
< this_single_command_key_start
)
725 this_single_command_key_start
= this_command_key_count
;
726 echo_truncate (before_command_echo_length_1
);
727 before_command_restore_flag
= 0;
731 if (this_command_key_count
>= ASIZE (this_command_keys
))
732 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
734 ASET (this_command_keys
, this_command_key_count
, key
);
735 ++this_command_key_count
;
740 recursive_edit_1 (void)
745 if (command_loop_level
> 0)
747 specbind (Qstandard_output
, Qt
);
748 specbind (Qstandard_input
, Qt
);
751 #ifdef HAVE_WINDOW_SYSTEM
752 /* The command loop has started an hourglass timer, so we have to
753 cancel it here, otherwise it will fire because the recursive edit
754 can take some time. Do not check for display_hourglass_p here,
755 because it could already be nil. */
759 /* This function may have been called from a debugger called from
760 within redisplay, for instance by Edebugging a function called
761 from fontification-functions. We want to allow redisplay in
762 the debugging session.
764 The recursive edit is left with a `(throw exit ...)'. The `exit'
765 tag is not caught anywhere in redisplay, i.e. when we leave the
766 recursive edit, the original redisplay leading to the recursive
767 edit will be unwound. The outcome should therefore be safe. */
768 specbind (Qinhibit_redisplay
, Qnil
);
771 val
= command_loop ();
773 Fsignal (Qquit
, Qnil
);
774 /* Handle throw from read_minibuf when using minibuffer
775 while it's active but we're in another window. */
777 xsignal1 (Qerror
, val
);
783 /* When an auto-save happens, record the "time", and don't do again soon. */
786 record_auto_save (void)
788 last_auto_save
= num_nonmacro_input_events
;
791 /* Make an auto save happen as soon as possible at command level. */
795 force_auto_save_soon (void)
797 last_auto_save
= - auto_save_interval
- 1;
799 record_asynch_buffer_change ();
803 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
804 doc
: /* Invoke the editor command loop recursively.
805 To get out of the recursive edit, a command can throw to `exit' -- for
806 instance `(throw 'exit nil)'.
807 If you throw a value other than t, `recursive-edit' returns normally
808 to the function that called it. Throwing a t value causes
809 `recursive-edit' to quit, so that control returns to the command loop
812 This function is called by the editor initialization to begin editing. */)
818 /* If we enter while input is blocked, don't lock up here.
819 This may happen through the debugger during redisplay. */
820 if (input_blocked_p ()) {
825 if (command_loop_level
>= 0
826 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
827 buffer
= Fcurrent_buffer ();
831 /* Don't do anything interesting between the increment and the
832 record_unwind_protect! Otherwise, we could get distracted and
833 never decrement the counter again. */
834 command_loop_level
++;
835 update_mode_lines
= 17;
836 record_unwind_protect (recursive_edit_unwind
, buffer
);
838 /* If we leave recursive_edit_1 below with a `throw' for instance,
839 like it is done in the splash screen display, we have to
840 make sure that we restore single_kboard as command_loop_1
841 would have done if it were left normally. */
842 if (command_loop_level
> 0)
843 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
851 recursive_edit_unwind (Lisp_Object buffer
)
853 if (BUFFERP (buffer
))
854 Fset_buffer (buffer
);
856 command_loop_level
--;
857 update_mode_lines
= 18;
861 #if 0 /* These two functions are now replaced with
862 temporarily_switch_to_single_kboard. */
866 #if 0 /* Theory: if there's anything in Vunread_command_events,
867 it will right away be read by read_key_sequence,
868 and then if we do switch KBOARDS, it will go into the side
869 queue then. So we don't need to do anything special here -- rms. */
870 if (CONSP (Vunread_command_events
))
872 current_kboard
->kbd_queue
873 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
874 current_kboard
->kbd_queue_has_data
= 1;
876 Vunread_command_events
= Qnil
;
881 /* Switch to the single-kboard state, making current_kboard
882 the only KBOARD from which further input is accepted. */
885 single_kboard_state ()
891 /* If we're in single_kboard state for kboard KBOARD,
895 not_single_kboard_state (KBOARD
*kboard
)
897 if (kboard
== current_kboard
)
901 /* Maintain a stack of kboards, so other parts of Emacs
902 can switch temporarily to the kboard of a given frame
903 and then revert to the previous status. */
908 struct kboard_stack
*next
;
911 static struct kboard_stack
*kboard_stack
;
914 push_kboard (struct kboard
*k
)
916 struct kboard_stack
*p
= xmalloc (sizeof *p
);
918 p
->next
= kboard_stack
;
919 p
->kboard
= current_kboard
;
929 struct kboard_stack
*p
= kboard_stack
;
931 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
933 if (t
->kboard
== p
->kboard
)
935 current_kboard
= p
->kboard
;
942 /* The terminal we remembered has been deleted. */
943 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
946 kboard_stack
= p
->next
;
950 /* Switch to single_kboard mode, making current_kboard the only KBOARD
951 from which further input is accepted. If F is non-nil, set its
952 KBOARD as the current keyboard.
954 This function uses record_unwind_protect_int to return to the previous
957 If Emacs is already in single_kboard mode, and F's keyboard is
958 locked, then this function will throw an error. */
961 temporarily_switch_to_single_kboard (struct frame
*f
)
963 bool was_locked
= single_kboard
;
966 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
967 /* We can not switch keyboards while in single_kboard mode.
968 In rare cases, Lisp code may call `recursive-edit' (or
969 `read-minibuffer' or `y-or-n-p') after it switched to a
970 locked frame. For example, this is likely to happen
971 when server.el connects to a new terminal while Emacs is in
972 single_kboard mode. It is best to throw an error instead
973 of presenting the user with a frozen screen. */
974 error ("Terminal %d is locked, cannot read from it",
975 FRAME_TERMINAL (f
)->id
);
977 /* This call is unnecessary, but helps
978 `restore_kboard_configuration' discover if somebody changed
979 `current_kboard' behind our back. */
980 push_kboard (current_kboard
);
983 current_kboard
= FRAME_KBOARD (f
);
985 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
988 #if 0 /* This function is not needed anymore. */
990 record_single_kboard_state ()
993 push_kboard (current_kboard
);
994 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
999 restore_kboard_configuration (int was_locked
)
1001 single_kboard
= was_locked
;
1004 struct kboard
*prev
= current_kboard
;
1006 /* The pop should not change the kboard. */
1007 if (single_kboard
&& current_kboard
!= prev
)
1013 /* Handle errors that are not handled at inner levels
1014 by printing an error message and returning to the editor command loop. */
1017 cmd_error (Lisp_Object data
)
1019 Lisp_Object old_level
, old_length
;
1020 char macroerror
[sizeof "After..kbd macro iterations: "
1021 + INT_STRLEN_BOUND (EMACS_INT
)];
1023 #ifdef HAVE_WINDOW_SYSTEM
1024 if (display_hourglass_p
)
1025 cancel_hourglass ();
1028 if (!NILP (executing_kbd_macro
))
1030 if (executing_kbd_macro_iterations
== 1)
1031 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1033 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1034 executing_kbd_macro_iterations
);
1039 Vstandard_output
= Qt
;
1040 Vstandard_input
= Qt
;
1041 Vexecuting_kbd_macro
= Qnil
;
1042 executing_kbd_macro
= Qnil
;
1043 kset_prefix_arg (current_kboard
, Qnil
);
1044 kset_last_prefix_arg (current_kboard
, Qnil
);
1047 /* Avoid unquittable loop if data contains a circular list. */
1048 old_level
= Vprint_level
;
1049 old_length
= Vprint_length
;
1050 XSETFASTINT (Vprint_level
, 10);
1051 XSETFASTINT (Vprint_length
, 10);
1052 cmd_error_internal (data
, macroerror
);
1053 Vprint_level
= old_level
;
1054 Vprint_length
= old_length
;
1057 Vinhibit_quit
= Qnil
;
1059 return make_number (0);
1062 /* Take actions on handling an error. DATA is the data that describes
1065 CONTEXT is a C-string containing ASCII characters only which
1066 describes the context in which the error happened. If we need to
1067 generalize CONTEXT to allow multibyte characters, make it a Lisp
1071 cmd_error_internal (Lisp_Object data
, const char *context
)
1073 /* The immediate context is not interesting for Quits,
1074 since they are asynchronous. */
1075 if (EQ (XCAR (data
), Qquit
))
1076 Vsignaling_function
= Qnil
;
1081 /* Use user's specified output function if any. */
1082 if (!NILP (Vcommand_error_function
))
1083 call3 (Vcommand_error_function
, data
,
1084 context
? build_string (context
) : empty_unibyte_string
,
1085 Vsignaling_function
);
1087 Vsignaling_function
= Qnil
;
1090 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1091 Scommand_error_default_function
, 3, 3, 0,
1092 doc
: /* Produce default output for unhandled error message.
1093 Default value of `command-error-function'. */)
1094 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1096 struct frame
*sf
= SELECTED_FRAME ();
1098 CHECK_STRING (context
);
1100 /* If the window system or terminal frame hasn't been initialized
1101 yet, or we're not interactive, write the message to stderr and exit. */
1102 if (!sf
->glyphs_initialized_p
1103 /* The initial frame is a special non-displaying frame. It
1104 will be current in daemon mode when there are no frames
1105 to display, and in non-daemon mode before the real frame
1106 has finished initializing. If an error is thrown in the
1107 latter case while creating the frame, then the frame
1108 will never be displayed, so the safest thing to do is
1109 write to stderr and quit. In daemon mode, there are
1110 many other potential errors that do not prevent frames
1111 from being created, so continuing as normal is better in
1113 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1116 print_error_message (data
, Qexternal_debugging_output
,
1117 SSDATA (context
), signal
);
1118 Fterpri (Qexternal_debugging_output
);
1119 Fkill_emacs (make_number (-1));
1123 clear_message (1, 0);
1125 message_log_maybe_newline ();
1128 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1133 static Lisp_Object
command_loop_2 (Lisp_Object
);
1134 static Lisp_Object
top_level_1 (Lisp_Object
);
1136 /* Entry to editor-command-loop.
1137 This level has the catches for exiting/returning to editor command loop.
1138 It returns nil to exit recursive edit, t to abort it. */
1143 if (command_loop_level
> 0 || minibuf_level
> 0)
1146 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1147 executing_kbd_macro
= Qnil
;
1153 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1154 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1155 executing_kbd_macro
= Qnil
;
1157 /* End of file in -batch run causes exit here. */
1163 /* Here we catch errors in execution of commands within the
1164 editing loop, and reenter the editing loop.
1165 When there is an error, cmd_error runs and returns a non-nil
1166 value to us. A value of nil means that command_loop_1 itself
1167 returned due to end of file (or end of kbd macro). */
1170 command_loop_2 (Lisp_Object ignore
)
1172 register Lisp_Object val
;
1175 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1176 while (!NILP (val
));
1184 return Feval (Vtop_level
, Qnil
);
1188 top_level_1 (Lisp_Object ignore
)
1190 /* On entry to the outer level, run the startup file. */
1191 if (!NILP (Vtop_level
))
1192 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1193 else if (!NILP (Vpurify_flag
))
1194 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1196 message1 ("Bare Emacs (standard Lisp code not loaded)");
1200 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1201 doc
: /* Exit all recursive editing levels.
1202 This also exits all active minibuffers. */)
1205 #ifdef HAVE_WINDOW_SYSTEM
1206 if (display_hourglass_p
)
1207 cancel_hourglass ();
1210 /* Unblock input if we enter with input blocked. This may happen if
1211 redisplay traps e.g. during tool-bar update with input blocked. */
1212 totally_unblock_input ();
1214 Fthrow (Qtop_level
, Qnil
);
1217 static _Noreturn
void
1218 user_error (const char *msg
)
1220 xsignal1 (Quser_error
, build_string (msg
));
1223 /* _Noreturn will be added to prototype by make-docfile. */
1224 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1225 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1228 if (command_loop_level
> 0 || minibuf_level
> 0)
1229 Fthrow (Qexit
, Qnil
);
1231 user_error ("No recursive edit is in progress");
1234 /* _Noreturn will be added to prototype by make-docfile. */
1235 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1236 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1239 if (command_loop_level
> 0 || minibuf_level
> 0)
1242 user_error ("No recursive edit is in progress");
1245 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1246 of this function. */
1249 tracking_off (Lisp_Object old_value
)
1251 do_mouse_tracking
= old_value
;
1252 if (NILP (old_value
))
1254 /* Redisplay may have been preempted because there was input
1255 available, and it assumes it will be called again after the
1256 input has been processed. If the only input available was
1257 the sort that we have just disabled, then we need to call
1259 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1261 redisplay_preserve_echo_area (6);
1262 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1267 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1268 doc
: /* Evaluate BODY with mouse movement events enabled.
1269 Within a `track-mouse' form, mouse motion generates input events that
1270 you can read with `read-event'.
1271 Normally, mouse motion is ignored.
1272 usage: (track-mouse BODY...) */)
1278 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1280 do_mouse_tracking
= Qt
;
1282 val
= Fprogn (args
);
1287 /* If mouse has moved on some frame, return one of those frames.
1291 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1292 after resizing the tool-bar window. */
1294 bool ignore_mouse_drag_p
;
1296 static struct frame
*
1297 some_mouse_moved (void)
1299 Lisp_Object tail
, frame
;
1301 if (ignore_mouse_drag_p
)
1303 /* ignore_mouse_drag_p = 0; */
1307 FOR_EACH_FRAME (tail
, frame
)
1309 if (XFRAME (frame
)->mouse_moved
)
1310 return XFRAME (frame
);
1317 /* This is the actual command reading loop,
1318 sans error-handling encapsulation. */
1320 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1321 bool, bool, bool, bool);
1322 static void adjust_point_for_property (ptrdiff_t, bool);
1324 /* The last boundary auto-added to buffer-undo-list. */
1325 Lisp_Object last_undo_boundary
;
1327 /* FIXME: This is wrong rather than test window-system, we should call
1328 a new set-selection, which will then dispatch to x-set-selection, or
1329 tty-set-selection, or w32-set-selection, ... */
1332 command_loop_1 (void)
1335 Lisp_Object keybuf
[30];
1337 EMACS_INT prev_modiff
= 0;
1338 struct buffer
*prev_buffer
= NULL
;
1339 bool already_adjusted
= 0;
1341 kset_prefix_arg (current_kboard
, Qnil
);
1342 kset_last_prefix_arg (current_kboard
, Qnil
);
1343 Vdeactivate_mark
= Qnil
;
1344 waiting_for_input
= 0;
1347 this_command_key_count
= 0;
1348 this_command_key_count_reset
= 0;
1349 this_single_command_key_start
= 0;
1351 if (NILP (Vmemory_full
))
1353 /* Make sure this hook runs after commands that get errors and
1354 throw to top level. */
1355 /* Note that the value cell will never directly contain nil
1356 if the symbol is a local variable. */
1357 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1358 safe_run_hooks (Qpost_command_hook
);
1360 /* If displaying a message, resize the echo area window to fit
1361 that message's size exactly. */
1362 if (!NILP (echo_area_buffer
[0]))
1363 resize_echo_area_exactly ();
1365 /* If there are warnings waiting, process them. */
1366 if (!NILP (Vdelayed_warnings_list
))
1367 safe_run_hooks (Qdelayed_warnings_hook
);
1369 if (!NILP (Vdeferred_action_list
))
1370 safe_run_hooks (Qdeferred_action_function
);
1373 /* Do this after running Vpost_command_hook, for consistency. */
1374 kset_last_command (current_kboard
, Vthis_command
);
1375 kset_real_last_command (current_kboard
, Vreal_this_command
);
1376 if (!CONSP (last_command_event
))
1377 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1381 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1384 /* Make sure the current window's buffer is selected. */
1385 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1387 /* Display any malloc warning that just came out. Use while because
1388 displaying one warning can cause another. */
1390 while (pending_malloc_warning
)
1391 display_malloc_warning ();
1393 Vdeactivate_mark
= Qnil
;
1395 /* Don't ignore mouse movements for more than a single command
1396 loop. (This flag is set in xdisp.c whenever the tool bar is
1397 resized, because the resize moves text up or down, and would
1398 generate false mouse drag events if we don't ignore them.) */
1399 ignore_mouse_drag_p
= 0;
1401 /* If minibuffer on and echo area in use,
1402 wait a short time and redraw minibuffer. */
1405 && !NILP (echo_area_buffer
[0])
1406 && EQ (minibuf_window
, echo_area_window
)
1407 && NUMBERP (Vminibuffer_message_timeout
))
1409 /* Bind inhibit-quit to t so that C-g gets read in
1410 rather than quitting back to the minibuffer. */
1412 specbind (Qinhibit_quit
, Qt
);
1414 sit_for (Vminibuffer_message_timeout
, 0, 2);
1416 /* Clear the echo area. */
1418 safe_run_hooks (Qecho_area_clear_hook
);
1422 /* If a C-g came in before, treat it as input now. */
1423 if (!NILP (Vquit_flag
))
1426 Vunread_command_events
= list1 (make_number (quit_char
));
1430 /* If it has changed current-menubar from previous value,
1431 really recompute the menubar from the value. */
1432 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1433 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1434 call0 (Qrecompute_lucid_menubar
);
1436 before_command_key_count
= this_command_key_count
;
1437 before_command_echo_length
= echo_length ();
1439 Vthis_command
= Qnil
;
1440 Vreal_this_command
= Qnil
;
1441 Vthis_original_command
= Qnil
;
1442 Vthis_command_keys_shift_translated
= Qnil
;
1444 /* Read next key sequence; i gets its length. */
1445 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1448 /* A filter may have run while we were reading the input. */
1449 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1451 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1455 /* Now we have read a key sequence of length I,
1456 or else I is 0 and we found end of file. */
1458 if (i
== 0) /* End of file -- happens only in */
1459 return Qnil
; /* a kbd macro, at the end. */
1460 /* -1 means read_key_sequence got a menu that was rejected.
1461 Just loop around and read another command. */
1465 this_command_key_count
= 0;
1466 this_command_key_count_reset
= 0;
1467 this_single_command_key_start
= 0;
1471 last_command_event
= keybuf
[i
- 1];
1473 /* If the previous command tried to force a specific window-start,
1474 forget about that, in case this command moves point far away
1475 from that position. But also throw away beg_unchanged and
1476 end_unchanged information in that case, so that redisplay will
1477 update the whole window properly. */
1478 if (XWINDOW (selected_window
)->force_start
)
1481 XWINDOW (selected_window
)->force_start
= 0;
1482 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1483 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1486 cmd
= read_key_sequence_cmd
;
1487 if (!NILP (Vexecuting_kbd_macro
))
1489 if (!NILP (Vquit_flag
))
1491 Vexecuting_kbd_macro
= Qt
;
1492 QUIT
; /* Make some noise. */
1493 /* Will return since macro now empty. */
1497 /* Do redisplay processing after this command except in special
1498 cases identified below. */
1499 prev_buffer
= current_buffer
;
1500 prev_modiff
= MODIFF
;
1501 last_point_position
= PT
;
1503 /* By default, we adjust point to a boundary of a region that
1504 has such a property that should be treated intangible
1505 (e.g. composition, display). But, some commands will set
1506 this variable differently. */
1507 Vdisable_point_adjustment
= Qnil
;
1509 /* Process filters and timers may have messed with deactivate-mark.
1510 reset it before we execute the command. */
1511 Vdeactivate_mark
= Qnil
;
1513 /* Remap command through active keymaps. */
1514 Vthis_original_command
= cmd
;
1515 if (!NILP (read_key_sequence_remapped
))
1516 cmd
= read_key_sequence_remapped
;
1518 /* Execute the command. */
1520 Vthis_command
= cmd
;
1521 Vreal_this_command
= cmd
;
1522 safe_run_hooks (Qpre_command_hook
);
1524 already_adjusted
= 0;
1526 if (NILP (Vthis_command
))
1527 /* nil means key is undefined. */
1531 /* Here for a command that isn't executed directly. */
1533 #ifdef HAVE_WINDOW_SYSTEM
1536 if (display_hourglass_p
1537 && NILP (Vexecuting_kbd_macro
))
1539 record_unwind_protect_void (cancel_hourglass
);
1544 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1546 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1549 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1550 ? Qnil
: BVAR (current_buffer
, undo_list
));
1552 call1 (Qcommand_execute
, Vthis_command
);
1554 #ifdef HAVE_WINDOW_SYSTEM
1555 /* Do not check display_hourglass_p here, because
1556 `command-execute' could change it, but we should cancel
1557 hourglass cursor anyway.
1558 But don't cancel the hourglass within a macro
1559 just because a command in the macro finishes. */
1563 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1565 safe_run_hooks (Qpost_command_hook
);
1567 /* If displaying a message, resize the echo area window to fit
1568 that message's size exactly. */
1569 if (!NILP (echo_area_buffer
[0]))
1570 resize_echo_area_exactly ();
1572 /* If there are warnings waiting, process them. */
1573 if (!NILP (Vdelayed_warnings_list
))
1574 safe_run_hooks (Qdelayed_warnings_hook
);
1576 safe_run_hooks (Qdeferred_action_function
);
1578 /* If there is a prefix argument,
1579 1) We don't want Vlast_command to be ``universal-argument''
1580 (that would be dumb), so don't set Vlast_command,
1581 2) we want to leave echoing on so that the prefix will be
1582 echoed as part of this key sequence, so don't call
1584 3) we want to leave this_command_key_count non-zero, so that
1585 read_char will realize that it is re-reading a character, and
1586 not echo it a second time.
1588 If the command didn't actually create a prefix arg,
1589 but is merely a frame event that is transparent to prefix args,
1590 then the above doesn't apply. */
1591 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1592 || CONSP (last_command_event
))
1594 kset_last_command (current_kboard
, Vthis_command
);
1595 kset_real_last_command (current_kboard
, Vreal_this_command
);
1596 if (!CONSP (last_command_event
))
1597 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1599 this_command_key_count
= 0;
1600 this_command_key_count_reset
= 0;
1601 this_single_command_key_start
= 0;
1604 if (!NILP (BVAR (current_buffer
, mark_active
))
1605 && !NILP (Vrun_hooks
))
1607 /* In Emacs 22, setting transient-mark-mode to `only' was a
1608 way of turning it on for just one command. This usage is
1609 obsolete, but support it anyway. */
1610 if (EQ (Vtransient_mark_mode
, Qidentity
))
1611 Vtransient_mark_mode
= Qnil
;
1612 else if (EQ (Vtransient_mark_mode
, Qonly
))
1613 Vtransient_mark_mode
= Qidentity
;
1615 if (!NILP (Vdeactivate_mark
))
1616 /* If `select-active-regions' is non-nil, this call to
1617 `deactivate-mark' also sets the PRIMARY selection. */
1618 call0 (Qdeactivate_mark
);
1621 /* Even if not deactivating the mark, set PRIMARY if
1622 `select-active-regions' is non-nil. */
1623 if (!NILP (Fwindow_system (Qnil
))
1624 /* Even if mark_active is non-nil, the actual buffer
1625 marker may not have been set yet (Bug#7044). */
1626 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1627 && (EQ (Vselect_active_regions
, Qonly
)
1628 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1629 : (!NILP (Vselect_active_regions
)
1630 && !NILP (Vtransient_mark_mode
)))
1631 && NILP (Fmemq (Vthis_command
,
1632 Vselection_inhibit_update_commands
)))
1635 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1636 if (XINT (Flength (txt
)) > 0)
1637 /* Don't set empty selections. */
1638 call2 (Qx_set_selection
, QPRIMARY
, txt
);
1641 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1643 Lisp_Object hook
= intern ("activate-mark-hook");
1644 Frun_hooks (1, &hook
);
1648 Vsaved_region_selection
= Qnil
;
1653 if (current_buffer
== prev_buffer
1654 && last_point_position
!= PT
1655 && NILP (Vdisable_point_adjustment
)
1656 && NILP (Vglobal_disable_point_adjustment
))
1658 if (last_point_position
> BEGV
1659 && last_point_position
< ZV
1660 && (composition_adjust_point (last_point_position
,
1661 last_point_position
)
1662 != last_point_position
))
1663 /* The last point was temporarily set within a grapheme
1664 cluster to prevent automatic composition. To recover
1665 the automatic composition, we must update the
1667 windows_or_buffers_changed
= 21;
1668 if (!already_adjusted
)
1669 adjust_point_for_property (last_point_position
,
1670 MODIFF
!= prev_modiff
);
1673 /* Install chars successfully executed in kbd macro. */
1675 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1676 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1677 finalize_kbd_macro_chars ();
1682 read_menu_command (void)
1684 Lisp_Object keybuf
[30];
1685 scm_dynwind_begin (0);
1688 /* We don't want to echo the keystrokes while navigating the
1690 specbind (Qecho_keystrokes
, make_number (0));
1692 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1697 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1699 if (i
== 0 || i
== -1)
1702 return read_key_sequence_cmd
;
1705 /* Adjust point to a boundary of a region that has such a property
1706 that should be treated intangible. For the moment, we check
1707 `composition', `display' and `invisible' properties.
1708 LAST_PT is the last position of point. */
1711 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1714 Lisp_Object val
, overlay
, tmp
;
1715 /* When called after buffer modification, we should temporarily
1716 suppress the point adjustment for automatic composition so that a
1717 user can keep inserting another character at point or keep
1718 deleting characters around point. */
1719 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1720 ptrdiff_t orig_pt
= PT
;
1722 /* FIXME: cycling is probably not necessary because these properties
1723 can't be usefully combined anyway. */
1724 while (check_composition
|| check_display
|| check_invisible
)
1726 /* FIXME: check `intangible'. */
1727 if (check_composition
1728 && PT
> BEGV
&& PT
< ZV
1729 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1732 check_display
= check_invisible
= 1;
1734 check_composition
= 0;
1736 && PT
> BEGV
&& PT
< ZV
1737 && !NILP (val
= get_char_property_and_overlay
1738 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1739 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1740 && (!OVERLAYP (overlay
)
1741 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1742 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1743 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1744 && (beg
< PT
/* && end > PT <- It's always the case. */
1745 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1748 SET_PT (PT
< last_pt
1749 ? (STRINGP (val
) && SCHARS (val
) == 0
1750 ? max (beg
- 1, BEGV
)
1753 check_composition
= check_invisible
= 1;
1756 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1762 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1765 /* FIXME: We should stop if we find a spot between
1766 two runs of `invisible' where inserted text would
1767 be visible. This is important when we have two
1768 invisible boundaries that enclose an area: if the
1769 area is empty, we need this test in order to make
1770 it possible to place point in the middle rather
1771 than skip both boundaries. However, this code
1772 also stops anywhere in a non-sticky text-property,
1773 which breaks (e.g.) Org mode. */
1774 && (val
= Fget_pos_property (make_number (end
),
1776 TEXT_PROP_MEANS_INVISIBLE (val
))
1778 && !NILP (val
= get_char_property_and_overlay
1779 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1780 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1782 ellipsis
= ellipsis
|| inv
> 1
1783 || (OVERLAYP (overlay
)
1784 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1785 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1786 tmp
= Fnext_single_char_property_change
1787 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1788 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1792 && (val
= Fget_pos_property (make_number (beg
),
1794 TEXT_PROP_MEANS_INVISIBLE (val
))
1796 && !NILP (val
= get_char_property_and_overlay
1797 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1798 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1800 ellipsis
= ellipsis
|| inv
> 1
1801 || (OVERLAYP (overlay
)
1802 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1803 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1804 tmp
= Fprevious_single_char_property_change
1805 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1806 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1809 /* Move away from the inside area. */
1810 if (beg
< PT
&& end
> PT
)
1812 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1813 /* We haven't moved yet (so we don't need to fear
1814 infinite-looping) and we were outside the range
1815 before (so either end of the range still corresponds
1816 to a move in the right direction): pretend we moved
1817 less than we actually did, so that we still have
1818 more freedom below in choosing which end of the range
1820 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1821 /* We either have moved already or the last point
1822 was already in the range: we don't get to choose
1823 which end of the range we have to go to. */
1824 : (PT
< last_pt
? beg
: end
));
1825 check_composition
= check_display
= 1;
1827 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1828 the point to something other than its argument, due to
1829 point-motion hooks, intangibility, etc. */
1830 eassert (PT
== beg
|| PT
== end
);
1833 /* Pretend the area doesn't exist if the buffer is not
1835 if (!modified
&& !ellipsis
&& beg
< end
)
1837 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1838 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1839 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1840 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1841 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1842 /* We've already moved as far as we can. Trying to go
1843 to the other end would mean moving backwards and thus
1844 could lead to an infinite loop. */
1846 else if (val
= Fget_pos_property (make_number (PT
),
1848 TEXT_PROP_MEANS_INVISIBLE (val
)
1849 && (val
= (Fget_pos_property
1850 (make_number (PT
== beg
? end
: beg
),
1852 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1853 (check_composition
= check_display
= 1,
1854 SET_PT (PT
== beg
? end
: beg
));
1857 check_invisible
= 0;
1861 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1864 safe_run_hooks_1 (void)
1866 eassert (CONSP (Vinhibit_quit
));
1867 return call0 (XCDR (Vinhibit_quit
));
1870 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1874 safe_run_hooks_error (Lisp_Object error_data
)
1877 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1878 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1879 Lisp_Object args
[4];
1880 args
[0] = build_string ("Error in %s (%S): %S");
1883 args
[3] = error_data
;
1889 Lisp_Object newval
= Qnil
;
1890 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1891 if (EQ (fun
, XCAR (val
)))
1894 newval
= Fcons (XCAR (val
), newval
);
1896 return Fset (hook
, Fnreverse (newval
));
1897 /* Not found in the local part of the hook. Let's look at the global
1900 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1901 : Fdefault_value (hook
));
1902 CONSP (val
); val
= XCDR (val
))
1903 if (EQ (fun
, XCAR (val
)))
1906 newval
= Fcons (XCAR (val
), newval
);
1908 return Fset_default (hook
, Fnreverse (newval
));
1914 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1916 eassert (nargs
== 1);
1917 if (CONSP (Vinhibit_quit
))
1918 XSETCDR (Vinhibit_quit
, args
[0]);
1920 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1922 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1926 /* If we get an error while running the hook, cause the hook variable
1927 to be nil. Also inhibit quits, so that C-g won't cause the hook
1928 to mysteriously evaporate. */
1931 safe_run_hooks (Lisp_Object hook
)
1933 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1934 to its body or to its handlers other than via globals such as
1935 dynamically-bound variables ;-) */
1937 specbind (Qinhibit_quit
, hook
);
1939 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1945 /* Nonzero means polling for input is temporarily suppressed. */
1947 int poll_suppress_count
;
1950 #ifdef POLL_FOR_INPUT
1952 /* Asynchronous timer for polling. */
1954 static struct atimer
*poll_timer
;
1956 /* Poll for input, so that we catch a C-g if it comes in. */
1958 poll_for_input_1 (void)
1960 if (! input_blocked_p ()
1961 && !waiting_for_input
)
1965 /* Timer callback function for poll_timer. TIMER is equal to
1969 poll_for_input (struct atimer
*timer
)
1971 if (poll_suppress_count
== 0)
1972 pending_signals
= 1;
1975 #endif /* POLL_FOR_INPUT */
1977 /* Begin signals to poll for input, if they are appropriate.
1978 This function is called unconditionally from various places. */
1981 start_polling (void)
1983 #ifdef POLL_FOR_INPUT
1984 /* XXX This condition was (read_socket_hook && !interrupt_input),
1985 but read_socket_hook is not global anymore. Let's pretend that
1987 if (!interrupt_input
)
1989 /* Turn alarm handling on unconditionally. It might have
1990 been turned off in process.c. */
1991 turn_on_atimers (1);
1993 /* If poll timer doesn't exist, or we need one with
1994 a different interval, start a new one. */
1995 if (poll_timer
== NULL
1996 || poll_timer
->interval
.tv_sec
!= polling_period
)
1998 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1999 struct timespec interval
= make_timespec (period
, 0);
2002 cancel_atimer (poll_timer
);
2004 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2005 poll_for_input
, NULL
);
2008 /* Let the timer's callback function poll for input
2009 if this becomes zero. */
2010 --poll_suppress_count
;
2015 /* True if we are using polling to handle input asynchronously. */
2018 input_polling_used (void)
2020 #ifdef POLL_FOR_INPUT
2021 /* XXX This condition was (read_socket_hook && !interrupt_input),
2022 but read_socket_hook is not global anymore. Let's pretend that
2024 return !interrupt_input
;
2030 /* Turn off polling. */
2035 #ifdef POLL_FOR_INPUT
2036 /* XXX This condition was (read_socket_hook && !interrupt_input),
2037 but read_socket_hook is not global anymore. Let's pretend that
2039 if (!interrupt_input
)
2040 ++poll_suppress_count
;
2044 /* Set the value of poll_suppress_count to COUNT
2045 and start or stop polling accordingly. */
2048 set_poll_suppress_count (int count
)
2050 #ifdef POLL_FOR_INPUT
2051 if (count
== 0 && poll_suppress_count
!= 0)
2053 poll_suppress_count
= 1;
2056 else if (count
!= 0 && poll_suppress_count
== 0)
2060 poll_suppress_count
= count
;
2064 /* Bind polling_period to a value at least N.
2065 But don't decrease it. */
2068 bind_polling_period (int n
)
2070 #ifdef POLL_FOR_INPUT
2071 EMACS_INT
new = polling_period
;
2076 stop_other_atimers (poll_timer
);
2078 specbind (Qpolling_period
, make_number (new));
2079 /* Start a new alarm with the new period. */
2084 /* Apply the control modifier to CHARACTER. */
2087 make_ctrl_char (int c
)
2089 /* Save the upper bits here. */
2090 int upper
= c
& ~0177;
2092 if (! ASCII_CHAR_P (c
))
2093 return c
|= ctrl_modifier
;
2097 /* Everything in the columns containing the upper-case letters
2098 denotes a control character. */
2099 if (c
>= 0100 && c
< 0140)
2103 /* Set the shift modifier for a control char
2104 made from a shifted letter. But only for letters! */
2105 if (oc
>= 'A' && oc
<= 'Z')
2106 c
|= shift_modifier
;
2109 /* The lower-case letters denote control characters too. */
2110 else if (c
>= 'a' && c
<= 'z')
2113 /* Include the bits for control and shift
2114 only if the basic ASCII code can't indicate them. */
2118 /* Replace the high bits. */
2119 c
|= (upper
& ~ctrl_modifier
);
2124 /* Display the help-echo property of the character after the mouse pointer.
2125 Either show it in the echo area, or call show-help-function to display
2126 it by other means (maybe in a tooltip).
2128 If HELP is nil, that means clear the previous help echo.
2130 If HELP is a string, display that string. If HELP is a function,
2131 call it with OBJECT and POS as arguments; the function should
2132 return a help string or nil for none. For all other types of HELP,
2133 evaluate it to obtain a string.
2135 WINDOW is the window in which the help was generated, if any.
2136 It is nil if not in a window.
2138 If OBJECT is a buffer, POS is the position in the buffer where the
2139 `help-echo' text property was found.
2141 If OBJECT is an overlay, that overlay has a `help-echo' property,
2142 and POS is the position in the overlay's buffer under the mouse.
2144 If OBJECT is a string (an overlay string or a string displayed with
2145 the `display' property). POS is the position in that string under
2148 Note: this function may only be called with HELP nil or a string
2149 from X code running asynchronously. */
2152 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2155 if (!NILP (help
) && !STRINGP (help
))
2157 if (FUNCTIONP (help
))
2158 help
= safe_call (4, help
, window
, object
, pos
);
2160 help
= safe_eval (help
);
2162 if (!STRINGP (help
))
2166 if (!noninteractive
&& STRINGP (help
))
2168 /* The mouse-fixup-help-message Lisp function can call
2169 mouse_position_hook, which resets the mouse_moved flags.
2170 This causes trouble if we are trying to read a mouse motion
2171 event (i.e., if we are inside a `track-mouse' form), so we
2172 restore the mouse_moved flag. */
2173 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2174 help
= call1 (Qmouse_fixup_help_message
, help
);
2179 if (STRINGP (help
) || NILP (help
))
2181 if (!NILP (Vshow_help_function
))
2182 call1 (Vshow_help_function
, help
);
2183 help_echo_showing_p
= STRINGP (help
);
2189 /* Input of single characters from keyboard. */
2191 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2192 struct timespec
*end_time
);
2193 static void record_char (Lisp_Object c
);
2195 static Lisp_Object help_form_saved_window_configs
;
2197 read_char_help_form_unwind (void)
2199 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2200 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2201 if (!NILP (window_config
))
2202 Fset_window_configuration (window_config
);
2205 #define STOP_POLLING \
2206 do { if (! polling_stopped_here) stop_polling (); \
2207 polling_stopped_here = 1; } while (0)
2209 #define RESUME_POLLING \
2210 do { if (polling_stopped_here) start_polling (); \
2211 polling_stopped_here = 0; } while (0)
2214 read_event_from_main_queue (struct timespec
*end_time
,
2215 Lisp_Object local_tag
,
2216 bool *used_mouse_menu
)
2218 Lisp_Object c
= Qnil
;
2219 Lisp_Object save_tag
= Qnil
;
2220 sys_jmp_buf
*save_jump
= xmalloc (sizeof *save_jump
);
2221 KBOARD
*kb
IF_LINT (= NULL
);
2225 /* Read from the main queue, and if that gives us something we can't use yet,
2226 we put it on the appropriate side queue and try again. */
2228 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2231 /* Actually read a character, waiting if necessary. */
2233 getctag
= local_tag
;
2235 timer_start_idle ();
2236 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2239 if (! NILP (c
) && (kb
!= current_kboard
))
2241 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2244 while (CONSP (XCDR (last
)))
2246 if (!NILP (XCDR (last
)))
2250 kset_kbd_queue (kb
, list1 (c
));
2252 XSETCDR (last
, list1 (c
));
2253 kb
->kbd_queue_has_data
= 1;
2257 current_kboard
= kb
;
2258 /* This is going to exit from read_char
2259 so we had better get rid of this frame's stuff. */
2260 return make_number (-2);
2263 /* Terminate Emacs in batch mode if at eof. */
2264 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2265 Fkill_emacs (make_number (1));
2269 /* Add in any extra modifiers, where appropriate. */
2270 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2271 || ((extra_keyboard_modifiers
& 0177) < ' '
2272 && (extra_keyboard_modifiers
& 0177) != 0))
2273 XSETINT (c
, make_ctrl_char (XINT (c
)));
2275 /* Transfer any other modifier bits directly from
2276 extra_keyboard_modifiers to c. Ignore the actual character code
2277 in the low 16 bits of extra_keyboard_modifiers. */
2278 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2286 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2289 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2290 Lisp_Object local_getcjmp
,
2291 Lisp_Object prev_event
,
2292 bool *used_mouse_menu
)
2294 #define MAX_ENCODED_BYTES 16
2296 Lisp_Object events
[MAX_ENCODED_BYTES
];
2302 = read_event_from_main_queue (end_time
, local_getcjmp
,
2305 /* w32_console already returns decoded events. It either reads
2306 Unicode characters from the Windows keyboard input, or
2307 converts characters encoded in the current codepage into
2308 Unicode. See w32inevt.c:key_event, near its end. */
2311 struct frame
*frame
= XFRAME (selected_frame
);
2312 struct terminal
*terminal
= frame
->terminal
;
2313 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2314 /* Don't apply decoding if we're just reading a raw event
2315 (e.g. reading bytes sent by the xterm to specify the position
2316 of a mouse click). */
2317 && (!EQ (prev_event
, Qt
))
2318 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2319 & CODING_REQUIRE_DECODING_MASK
)))
2320 return nextevt
; /* No decoding needed. */
2323 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2324 eassert (n
< MAX_ENCODED_BYTES
);
2325 events
[n
++] = nextevt
;
2326 if (NATNUMP (nextevt
)
2327 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2328 { /* An encoded byte sequence, let's try to decode it. */
2329 struct coding_system
*coding
2330 = TERMINAL_KEYBOARD_CODING (terminal
);
2331 unsigned char *src
= alloca (n
);
2333 for (i
= 0; i
< n
; i
++)
2334 src
[i
] = XINT (events
[i
]);
2336 for (i
= 0; i
< n
; i
++)
2338 coding
->destination
= alloca (n
* 4);
2339 coding
->dst_bytes
= n
* 4;
2340 decode_coding_c_string (coding
, src
, n
, Qnil
);
2341 eassert (coding
->produced_char
<= n
);
2342 if (coding
->produced_char
== 0)
2343 { /* The encoded sequence is incomplete. */
2344 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2345 continue; /* Read on! */
2349 const unsigned char *p
= coding
->destination
;
2350 eassert (coding
->carryover_bytes
== 0);
2352 while (n
< coding
->produced_char
)
2353 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2356 /* Now `events' should hold decoded events.
2357 Normally, n should be equal to 1, but better not rely on it.
2358 We can only return one event here, so return the first we
2359 had and keep the others (if any) for later. */
2361 Vunread_command_events
2362 = Fcons (events
[--n
], Vunread_command_events
);
2370 echo_keystrokes_p (void)
2372 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2373 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2376 /* Read a character from the keyboard; call the redisplay if needed. */
2377 /* commandflag 0 means do not autosave, but do redisplay.
2378 -1 means do not redisplay, but do autosave.
2379 -2 means do neither.
2382 /* The argument MAP is a keymap for menu prompting.
2384 PREV_EVENT is the previous input event, or nil if we are reading
2385 the first event of a key sequence (or not reading a key sequence).
2386 If PREV_EVENT is t, that is a "magic" value that says
2387 not to run input methods, but in other respects to act as if
2388 not reading a key sequence.
2390 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2391 if we used a mouse menu to read the input, or false otherwise. If
2392 USED_MOUSE_MENU is null, don't dereference it.
2394 Value is -2 when we find input on another keyboard. A second call
2395 to read_char will read it.
2397 If END_TIME is non-null, it is a pointer to a struct timespec
2398 specifying the maximum time to wait until. If no input arrives by
2399 that time, stop waiting and return nil.
2401 Value is t if we showed a menu and the user rejected it. */
2403 struct read_char_state
2407 Lisp_Object prev_event
;
2408 bool *used_mouse_menu
;
2409 struct timespec
*end_time
;
2412 Lisp_Object local_tag
;
2413 Lisp_Object save_tag
;
2414 Lisp_Object previous_echo_area_message
;
2415 Lisp_Object also_record
;
2417 bool polling_stopped_here
;
2418 struct kboard
*orig_kboard
;
2421 static Lisp_Object
read_char_1 (bool, volatile struct read_char_state
*);
2424 read_char_thunk (void *data
)
2426 return read_char_1 (false, data
);
2430 read_char_handle_quit (void *data
, Lisp_Object k
)
2432 struct read_char_state
*state
= data
;
2433 /* Handle quits while reading the keyboard. */
2434 /* We must have saved the outer value of getcjmp here,
2435 so restore it now. */
2436 getctag
= state
->save_tag
;
2437 XSETINT (state
->c
, quit_char
);
2438 internal_last_event_frame
= selected_frame
;
2439 Vlast_event_frame
= internal_last_event_frame
;
2440 /* If we report the quit char as an event,
2441 don't do so more than once. */
2442 if (!NILP (Vinhibit_quit
))
2446 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2447 if (kb
!= current_kboard
)
2449 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2450 /* We shouldn't get here if we were in single-kboard mode! */
2455 while (CONSP (XCDR (last
)))
2457 if (!NILP (XCDR (last
)))
2461 kset_kbd_queue (kb
, list1 (state
->c
));
2463 XSETCDR (last
, list1 (state
->c
));
2464 kb
->kbd_queue_has_data
= 1;
2465 current_kboard
= kb
;
2466 /* This is going to exit from read_char
2467 so we had better get rid of this frame's stuff. */
2469 return make_number (-2); /* wrong_kboard_jmpbuf */
2472 return read_char_1 (true, state
);
2475 /* {{coccinelle:skip_start}} */
2477 read_char (int commandflag
, Lisp_Object map
,
2478 Lisp_Object prev_event
,
2479 bool *used_mouse_menu
, struct timespec
*end_time
)
2481 struct read_char_state
*state
= xmalloc (sizeof *state
);
2483 state
->commandflag
= commandflag
;
2485 state
->prev_event
= prev_event
;
2486 state
->used_mouse_menu
= used_mouse_menu
;
2487 state
->end_time
= end_time
;
2489 state
->local_tag
= Qnil
;
2490 state
->save_tag
= Qnil
;
2491 state
->previous_echo_area_message
= Qnil
;
2492 state
->also_record
= Qnil
;
2493 state
->reread
= false;
2494 state
->polling_stopped_here
= false;
2495 state
->orig_kboard
= current_kboard
;
2497 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2498 We will do that below, temporarily for short sections of code,
2499 when appropriate. local_getcjmp must be in effect
2500 around any call to sit_for or kbd_buffer_get_event;
2501 it *must not* be in effect when we call redisplay. */
2503 state
->tag
= state
->local_tag
= make_prompt_tag ();
2505 return call_with_prompt (state
->tag
,
2506 make_c_closure (read_char_thunk
, state
, 0, 0),
2507 make_c_closure (read_char_handle_quit
, state
, 1, 0));
2511 read_char_1 (bool jump
, volatile struct read_char_state
*state
)
2513 #define commandflag state->commandflag
2514 #define map state->map
2515 #define prev_event state->prev_event
2516 #define used_mouse_menu state->used_mouse_menu
2517 #define end_time state->end_time
2519 #define jmpcount state->jmpcount
2520 #define local_getcjmp state->local_tag
2521 #define save_jump state->save_tag
2522 #define previous_echo_area_message state->previous_echo_area_message
2523 #define also_record state->also_record
2524 #define reread state->reread
2525 #define polling_stopped_here state->polling_stopped_here
2526 #define orig_kboard state->orig_kboard
2527 #define save_getcjmp(x) (x = getctag)
2528 #define restore_getcjmp(x) (getctag = x)
2529 Lisp_Object tem
, save
;
2536 if (CONSP (Vunread_post_input_method_events
))
2538 c
= XCAR (Vunread_post_input_method_events
);
2539 Vunread_post_input_method_events
2540 = XCDR (Vunread_post_input_method_events
);
2542 /* Undo what read_char_x_menu_prompt did when it unread
2543 additional keys returned by Fx_popup_menu. */
2545 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2556 if (CONSP (Vunread_command_events
))
2558 bool was_disabled
= 0;
2560 c
= XCAR (Vunread_command_events
);
2561 Vunread_command_events
= XCDR (Vunread_command_events
);
2563 /* Undo what sit-for did when it unread additional keys
2564 inside universal-argument. */
2566 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2571 /* Undo what read_char_x_menu_prompt did when it unread
2572 additional keys returned by Fx_popup_menu. */
2574 && EQ (XCDR (c
), Qdisabled
)
2575 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2581 /* If the queued event is something that used the mouse,
2582 set used_mouse_menu accordingly. */
2584 /* Also check was_disabled so last-nonmenu-event won't return
2585 a bad value when submenus are involved. (Bug#447) */
2586 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2587 *used_mouse_menu
= 1;
2589 goto reread_for_input_method
;
2592 if (CONSP (Vunread_input_method_events
))
2594 c
= XCAR (Vunread_input_method_events
);
2595 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2597 /* Undo what read_char_x_menu_prompt did when it unread
2598 additional keys returned by Fx_popup_menu. */
2600 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2604 goto reread_for_input_method
;
2607 this_command_key_count_reset
= 0;
2609 if (!NILP (Vexecuting_kbd_macro
))
2611 /* We set this to Qmacro; since that's not a frame, nobody will
2612 try to switch frames on us, and the selected window will
2615 Since this event came from a macro, it would be misleading to
2616 leave internal_last_event_frame set to wherever the last
2617 real event came from. Normally, a switch-frame event selects
2618 internal_last_event_frame after each command is read, but
2619 events read from a macro should never cause a new frame to be
2621 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2623 /* Exit the macro if we are at the end.
2624 Also, some things replace the macro with t
2625 to force an early exit. */
2626 if (EQ (Vexecuting_kbd_macro
, Qt
)
2627 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2633 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2634 if (STRINGP (Vexecuting_kbd_macro
)
2635 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2636 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2638 executing_kbd_macro_index
++;
2643 if (!NILP (unread_switch_frame
))
2645 c
= unread_switch_frame
;
2646 unread_switch_frame
= Qnil
;
2648 /* This event should make it into this_command_keys, and get echoed
2649 again, so we do not set `reread'. */
2653 /* If redisplay was requested. */
2654 if (commandflag
>= 0)
2656 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2658 /* If there is pending input, process any events which are not
2659 user-visible, such as X selection_request events. */
2661 || detect_input_pending_run_timers (0))
2662 swallow_events (0); /* May clear input_pending. */
2664 /* Redisplay if no pending input. */
2665 while (!input_pending
)
2667 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2668 redisplay_preserve_echo_area (5);
2673 /* Normal case: no input arrived during redisplay. */
2676 /* Input arrived and pre-empted redisplay.
2677 Process any events which are not user-visible. */
2679 /* If that cleared input_pending, try again to redisplay. */
2682 /* Prevent the redisplay we just did
2683 from messing up echoing of the input after the prompt. */
2684 if (commandflag
== 0 && echo_current
)
2685 echo_message_buffer
= echo_area_buffer
[0];
2689 /* Message turns off echoing unless more keystrokes turn it on again.
2691 The code in 20.x for the condition was
2693 1. echo_area_glyphs && *echo_area_glyphs
2694 2. && echo_area_glyphs != current_kboard->echobuf
2695 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2697 (1) means there's a current message displayed
2699 (2) means it's not the message from echoing from the current
2702 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2703 is set to a non-null value. This is done in read_char and it is
2704 set to echo_area_glyphs after a call to echo_char. That means
2705 ok_to_echo_at_next_pause is either null or
2706 current_kboard->echobuf with the appropriate current_kboard at
2709 So, condition (3) means in clear text ok_to_echo_at_next_pause
2710 must be either null, or the current message isn't from echoing at
2711 all, or it's from echoing from a different kboard than the
2714 if (/* There currently is something in the echo area. */
2715 !NILP (echo_area_buffer
[0])
2716 && (/* It's an echo from a different kboard. */
2717 echo_kboard
!= current_kboard
2718 /* Or we explicitly allow overwriting whatever there is. */
2719 || ok_to_echo_at_next_pause
== NULL
))
2724 /* Try reading a character via menu prompting in the minibuf.
2725 Try this before the sit-for, because the sit-for
2726 would do the wrong thing if we are supposed to do
2727 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2728 after a mouse event so don't try a minibuf menu. */
2730 if (KEYMAPP (map
) && INTERACTIVE
2731 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2732 /* Don't bring up a menu if we already have another event. */
2733 && NILP (Vunread_command_events
)
2734 && !detect_input_pending_run_timers (0))
2736 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2738 if (INTEGERP (c
) && XINT (c
) == -2)
2739 return c
; /* wrong_kboard_jmpbuf */
2745 /* Start idle timers if no time limit is supplied. We don't do it
2746 if a time limit is supplied to avoid an infinite recursion in the
2747 situation where an idle timer calls `sit-for'. */
2750 timer_start_idle ();
2752 /* If in middle of key sequence and minibuffer not active,
2753 start echoing if enough time elapses. */
2755 if (minibuf_level
== 0
2757 && !current_kboard
->immediate_echo
2758 && this_command_key_count
> 0
2760 && echo_keystrokes_p ()
2761 && (/* No message. */
2762 NILP (echo_area_buffer
[0])
2763 /* Or empty message. */
2764 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2765 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2766 /* Or already echoing from same kboard. */
2767 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2768 /* Or not echoing before and echoing allowed. */
2769 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2771 /* After a mouse event, start echoing right away.
2772 This is because we are probably about to display a menu,
2773 and we don't want to delay before doing so. */
2774 if (EVENT_HAS_PARAMETERS (prev_event
))
2780 save_getcjmp (save_jump
);
2781 restore_getcjmp (local_getcjmp
);
2782 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2783 restore_getcjmp (save_jump
);
2785 && ! CONSP (Vunread_command_events
))
2790 /* Maybe auto save due to number of keystrokes. */
2792 if (commandflag
!= 0 && commandflag
!= -2
2793 && auto_save_interval
> 0
2794 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2795 && !detect_input_pending_run_timers (0))
2797 Fdo_auto_save (Qnil
, Qnil
);
2798 /* Hooks can actually change some buffers in auto save. */
2802 /* Try reading using an X menu.
2803 This is never confused with reading using the minibuf
2804 because the recursive call of read_char in read_char_minibuf_menu_prompt
2805 does not pass on any keymaps. */
2807 if (KEYMAPP (map
) && INTERACTIVE
2808 && !NILP (prev_event
)
2809 && EVENT_HAS_PARAMETERS (prev_event
)
2810 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2811 && !EQ (XCAR (prev_event
), Qtool_bar
)
2812 /* Don't bring up a menu if we already have another event. */
2813 && NILP (Vunread_command_events
))
2815 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2817 /* Now that we have read an event, Emacs is not idle. */
2824 /* Maybe autosave and/or garbage collect due to idleness. */
2826 if (INTERACTIVE
&& NILP (c
))
2829 ptrdiff_t buffer_size
;
2831 /* Slow down auto saves logarithmically in size of current buffer,
2832 and garbage collect while we're at it. */
2833 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2834 last_non_minibuf_size
= Z
- BEG
;
2835 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2837 while (buffer_size
> 64)
2838 delay_level
++, buffer_size
-= buffer_size
>> 2;
2839 if (delay_level
< 4) delay_level
= 4;
2840 /* delay_level is 4 for files under around 50k, 7 at 100k,
2841 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2843 /* Auto save if enough time goes by without input. */
2844 if (commandflag
!= 0 && commandflag
!= -2
2845 && num_nonmacro_input_events
> last_auto_save
2846 && INTEGERP (Vauto_save_timeout
)
2847 && XINT (Vauto_save_timeout
) > 0)
2850 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2852 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2853 timeout
= delay_level
* timeout
/ 4;
2854 save_getcjmp (save_jump
);
2855 restore_getcjmp (local_getcjmp
);
2856 tem0
= sit_for (make_number (timeout
), 1, 1);
2857 restore_getcjmp (save_jump
);
2860 && ! CONSP (Vunread_command_events
))
2862 Fdo_auto_save (Qnil
, Qnil
);
2867 /* If there is still no input available, ask for GC. */
2868 if (!detect_input_pending_run_timers (0))
2869 GC_collect_a_little ();
2872 /* Notify the caller if an autosave hook, or a timer, sentinel or
2873 filter in the sit_for calls above have changed the current
2874 kboard. This could happen if they use the minibuffer or start a
2875 recursive edit, like the fancy splash screen in server.el's
2876 filter. If this longjmp wasn't here, read_key_sequence would
2877 interpret the next key sequence using the wrong translation
2878 tables and function keymaps. */
2879 if (NILP (c
) && current_kboard
!= orig_kboard
)
2882 return make_number (-2); /* wrong_kboard_jmpbuf */
2885 /* If this has become non-nil here, it has been set by a timer
2886 or sentinel or filter. */
2887 if (CONSP (Vunread_command_events
))
2889 c
= XCAR (Vunread_command_events
);
2890 Vunread_command_events
= XCDR (Vunread_command_events
);
2892 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2898 /* Read something from current KBOARD's side queue, if possible. */
2902 if (current_kboard
->kbd_queue_has_data
)
2904 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2906 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2907 kset_kbd_queue (current_kboard
,
2908 XCDR (KVAR (current_kboard
, kbd_queue
)));
2909 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2910 current_kboard
->kbd_queue_has_data
= 0;
2911 input_pending
= readable_events (0);
2912 if (EVENT_HAS_PARAMETERS (c
)
2913 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2914 internal_last_event_frame
= XCAR (XCDR (c
));
2915 Vlast_event_frame
= internal_last_event_frame
;
2919 /* If current_kboard's side queue is empty check the other kboards.
2920 If one of them has data that we have not yet seen here,
2921 switch to it and process the data waiting for it.
2923 Note: if the events queued up for another kboard
2924 have already been seen here, and therefore are not a complete command,
2925 the kbd_queue_has_data field is 0, so we skip that kboard here.
2926 That's to avoid an infinite loop switching between kboards here. */
2927 if (NILP (c
) && !single_kboard
)
2930 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2931 if (kb
->kbd_queue_has_data
)
2933 current_kboard
= kb
;
2934 /* This is going to exit from read_char
2935 so we had better get rid of this frame's stuff. */
2937 return make_number (-2); /* wrong_kboard_jmpbuf */
2947 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2948 prev_event
, used_mouse_menu
);
2949 if (NILP (c
) && end_time
2950 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2955 if (EQ (c
, make_number (-2)))
2957 /* This is going to exit from read_char
2958 so we had better get rid of this frame's stuff. */
2972 if (commandflag
>= 0
2973 && !input_pending
&& !detect_input_pending_run_timers (0))
2979 /* Buffer switch events are only for internal wakeups
2980 so don't show them to the user.
2981 Also, don't record a key if we already did. */
2985 /* Process special events within read_char
2986 and loop around to read another event. */
2989 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2994 struct buffer
*prev_buffer
= current_buffer
;
2995 last_input_event
= c
;
2996 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2998 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2999 /* We stopped being idle for this event; undo that. This
3000 prevents automatic window selection (under
3001 mouse_autoselect_window from acting as a real input event, for
3002 example banishing the mouse under mouse-avoidance-mode. */
3003 timer_resume_idle ();
3005 if (current_buffer
!= prev_buffer
)
3007 /* The command may have changed the keymaps. Pretend there
3008 is input in another keyboard and return. This will
3009 recalculate keymaps. */
3010 c
= make_number (-2);
3017 /* Handle things that only apply to characters. */
3020 /* If kbd_buffer_get_event gave us an EOF, return that. */
3024 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
3025 && UNSIGNED_CMP (XFASTINT (c
), <,
3026 SCHARS (KVAR (current_kboard
,
3027 Vkeyboard_translate_table
))))
3028 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
3029 && UNSIGNED_CMP (XFASTINT (c
), <,
3030 ASIZE (KVAR (current_kboard
,
3031 Vkeyboard_translate_table
))))
3032 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
3036 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
3037 /* nil in keyboard-translate-table means no translation. */
3043 /* If this event is a mouse click in the menu bar,
3044 return just menu-bar for now. Modify the mouse click event
3045 so we won't do this twice, then queue it up. */
3046 if (EVENT_HAS_PARAMETERS (c
)
3048 && CONSP (EVENT_START (c
))
3049 && CONSP (XCDR (EVENT_START (c
))))
3053 posn
= POSN_POSN (EVENT_START (c
));
3054 /* Handle menu-bar events:
3055 insert the dummy prefix event `menu-bar'. */
3056 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3058 /* Change menu-bar to (menu-bar) as the event "position". */
3059 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
3062 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3067 /* Store these characters into recent_keys, the dribble file if any,
3068 and the keyboard macro being defined, if any. */
3070 if (! NILP (also_record
))
3071 record_char (also_record
);
3073 /* Wipe the echo area.
3074 But first, if we are about to use an input method,
3075 save the echo area contents for it to refer to. */
3077 && ! NILP (Vinput_method_function
)
3078 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3080 previous_echo_area_message
= Fcurrent_message ();
3081 Vinput_method_previous_message
= previous_echo_area_message
;
3084 /* Now wipe the echo area, except for help events which do their
3085 own stuff with the echo area. */
3087 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3088 && !(EQ (Qswitch_frame
, XCAR (c
)))
3089 /* Don't wipe echo area for select window events: These might
3090 get delayed via `mouse-autoselect-window' (Bug#11304). */
3091 && !(EQ (Qselect_window
, XCAR (c
)))))
3093 if (!NILP (echo_area_buffer
[0]))
3095 safe_run_hooks (Qecho_area_clear_hook
);
3096 clear_message (1, 0);
3100 reread_for_input_method
:
3102 /* Pass this to the input method, if appropriate. */
3104 && ! NILP (Vinput_method_function
)
3105 /* Don't run the input method within a key sequence,
3106 after the first event of the key sequence. */
3107 && NILP (prev_event
)
3108 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3111 ptrdiff_t key_count
;
3112 bool key_count_reset
;
3113 struct gcpro gcpro1
;
3115 /* Save the echo status. */
3116 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3117 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3118 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3119 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3124 if (before_command_restore_flag
)
3126 this_command_key_count
= before_command_key_count_1
;
3127 if (this_command_key_count
< this_single_command_key_start
)
3128 this_single_command_key_start
= this_command_key_count
;
3129 echo_truncate (before_command_echo_length_1
);
3130 before_command_restore_flag
= 0;
3134 /* Save the this_command_keys status. */
3135 key_count
= this_command_key_count
;
3136 key_count_reset
= this_command_key_count_reset
;
3139 keys
= Fcopy_sequence (this_command_keys
);
3144 /* Clear out this_command_keys. */
3145 this_command_key_count
= 0;
3146 this_command_key_count_reset
= 0;
3148 /* Now wipe the echo area. */
3149 if (!NILP (echo_area_buffer
[0]))
3150 safe_run_hooks (Qecho_area_clear_hook
);
3151 clear_message (1, 0);
3154 /* If we are not reading a key sequence,
3155 never use the echo area. */
3158 specbind (Qinput_method_use_echo_area
, Qt
);
3161 /* Call the input method. */
3162 tem
= call1 (Vinput_method_function
, c
);
3166 /* Restore the saved echoing state
3167 and this_command_keys state. */
3168 this_command_key_count
= key_count
;
3169 this_command_key_count_reset
= key_count_reset
;
3171 this_command_keys
= keys
;
3174 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3175 kset_echo_string (current_kboard
, saved_echo_string
);
3176 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3177 if (saved_immediate_echo
)
3182 /* The input method can return no events. */
3185 /* Bring back the previous message, if any. */
3186 if (! NILP (previous_echo_area_message
))
3187 message_with_string ("%s", previous_echo_area_message
, 0);
3190 /* It returned one event or more. */
3192 Vunread_post_input_method_events
3193 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3198 /* Display help if not echoing. */
3199 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3201 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3202 Lisp_Object help
, object
, position
, window
, htem
;
3204 htem
= Fcdr (XCDR (c
));
3207 window
= Fcar (htem
);
3209 object
= Fcar (htem
);
3211 position
= Fcar (htem
);
3213 show_help_echo (help
, window
, object
, position
);
3215 /* We stopped being idle for this event; undo that. */
3217 timer_resume_idle ();
3221 if ((! reread
|| this_command_key_count
== 0
3222 || this_command_key_count_reset
)
3226 /* Don't echo mouse motion events. */
3227 if (echo_keystrokes_p ()
3228 && ! (EVENT_HAS_PARAMETERS (c
)
3229 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3232 if (! NILP (also_record
))
3233 echo_char (also_record
);
3234 /* Once we reread a character, echoing can happen
3235 the next time we pause to read a new one. */
3236 ok_to_echo_at_next_pause
= current_kboard
;
3239 /* Record this character as part of the current key. */
3240 add_command_key (c
);
3241 if (! NILP (also_record
))
3242 add_command_key (also_record
);
3245 last_input_event
= c
;
3248 /* Process the help character specially if enabled. */
3249 if (!NILP (Vhelp_form
) && help_char_p (c
))
3253 help_form_saved_window_configs
3254 = Fcons (Fcurrent_window_configuration (Qnil
),
3255 help_form_saved_window_configs
);
3256 record_unwind_protect_void (read_char_help_form_unwind
);
3257 call0 (Qhelp_form_show
);
3262 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3263 if (EVENT_HAS_PARAMETERS (c
)
3264 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3265 XSETCAR (help_form_saved_window_configs
, Qnil
);
3267 while (BUFFERP (c
));
3268 /* Remove the help from the frame. */
3272 if (EQ (c
, make_number (040)))
3276 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3277 while (BUFFERP (c
));
3287 #undef used_mouse_menu
3291 #undef local_getcjmp
3293 #undef previous_echo_area_message
3296 #undef polling_stopped_here
3299 #undef restore_getcjmp
3301 /* {{coccinelle:skip_end}} */
3303 /* Record a key that came from a mouse menu.
3304 Record it for echoing, for this-command-keys, and so on. */
3307 record_menu_key (Lisp_Object c
)
3309 /* Wipe the echo area. */
3310 clear_message (1, 0);
3315 before_command_key_count
= this_command_key_count
;
3316 before_command_echo_length
= echo_length ();
3319 /* Don't echo mouse motion events. */
3320 if (echo_keystrokes_p ())
3324 /* Once we reread a character, echoing can happen
3325 the next time we pause to read a new one. */
3326 ok_to_echo_at_next_pause
= 0;
3329 /* Record this character as part of the current key. */
3330 add_command_key (c
);
3332 /* Re-reading in the middle of a command. */
3333 last_input_event
= c
;
3337 /* Return true if should recognize C as "the help character". */
3340 help_char_p (Lisp_Object c
)
3344 if (EQ (c
, Vhelp_char
))
3346 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3347 if (EQ (c
, XCAR (tail
)))
3352 /* Record the input event C in various ways. */
3355 record_char (Lisp_Object c
)
3359 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3361 /* To avoid filling recent_keys with help-echo and mouse-movement
3362 events, we filter out repeated help-echo events, only store the
3363 first and last in a series of mouse-movement events, and don't
3364 store repeated help-echo events which are only separated by
3365 mouse-movement events. */
3367 Lisp_Object ev1
, ev2
, ev3
;
3370 if ((ix1
= recent_keys_index
- 1) < 0)
3371 ix1
= NUM_RECENT_KEYS
- 1;
3372 ev1
= AREF (recent_keys
, ix1
);
3374 if ((ix2
= ix1
- 1) < 0)
3375 ix2
= NUM_RECENT_KEYS
- 1;
3376 ev2
= AREF (recent_keys
, ix2
);
3378 if ((ix3
= ix2
- 1) < 0)
3379 ix3
= NUM_RECENT_KEYS
- 1;
3380 ev3
= AREF (recent_keys
, ix3
);
3382 if (EQ (XCAR (c
), Qhelp_echo
))
3384 /* Don't record `help-echo' in recent_keys unless it shows some help
3385 message, and a different help than the previously recorded
3387 Lisp_Object help
, last_help
;
3389 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3390 if (!STRINGP (help
))
3392 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3393 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3395 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3396 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3397 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3399 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3400 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3401 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3402 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3405 else if (EQ (XCAR (c
), Qmouse_movement
))
3407 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3408 So additional mouse movement events replace the last element. */
3409 Lisp_Object last_window
, window
;
3411 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3412 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3413 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3414 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3415 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3417 ASET (recent_keys
, ix1
, c
);
3423 store_kbd_macro_char (c
);
3427 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3428 ASET (recent_keys
, recent_keys_index
, c
);
3429 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3430 recent_keys_index
= 0;
3432 else if (recorded
< 0)
3434 /* We need to remove one or two events from recent_keys.
3435 To do this, we simply put nil at those events and move the
3436 recent_keys_index backwards over those events. Usually,
3437 users will never see those nil events, as they will be
3438 overwritten by the command keys entered to see recent_keys
3441 while (recorded
++ < 0 && total_keys
> 0)
3443 if (total_keys
< NUM_RECENT_KEYS
)
3445 if (--recent_keys_index
< 0)
3446 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3447 ASET (recent_keys
, recent_keys_index
, Qnil
);
3451 num_nonmacro_input_events
++;
3453 /* Write c to the dribble file. If c is a lispy event, write
3454 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3455 If you, dear reader, have a better idea, you've got the source. :-) */
3461 if (XUINT (c
) < 0x100)
3462 putc (XUINT (c
), dribble
);
3464 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3468 Lisp_Object dribblee
;
3470 /* If it's a structured event, take the event header. */
3471 dribblee
= EVENT_HEAD (c
);
3473 if (SYMBOLP (dribblee
))
3475 putc ('<', dribble
);
3476 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3477 SBYTES (SYMBOL_NAME (dribblee
)),
3479 putc ('>', dribble
);
3488 /* Low level keyboard/mouse input.
3489 kbd_buffer_store_event places events in kbd_buffer, and
3490 kbd_buffer_get_event retrieves them. */
3492 /* Return true if there are any events in the queue that read-char
3493 would return. If this returns false, a read-char would block. */
3495 readable_events (int flags
)
3497 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3500 /* If the buffer contains only FOCUS_IN_EVENT events, and
3501 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3502 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3504 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3505 #ifdef USE_TOOLKIT_SCROLL_BARS
3506 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3510 struct input_event
*event
;
3512 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3519 #ifdef USE_TOOLKIT_SCROLL_BARS
3520 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3522 event
->kind
== FOCUS_IN_EVENT
)
3523 #ifdef USE_TOOLKIT_SCROLL_BARS
3524 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3525 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3526 && event
->part
== scroll_bar_handle
3527 && event
->modifiers
== 0)
3532 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3535 while (event
!= kbd_store_ptr
);
3541 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3542 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3546 if (current_kboard
->kbd_queue_has_data
)
3552 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3553 if (kb
->kbd_queue_has_data
)
3559 /* Set this for debugging, to have a way to get out */
3560 int stop_character EXTERNALLY_VISIBLE
;
3563 event_to_kboard (struct input_event
*event
)
3565 /* Not applicable for these special events. */
3566 if (event
->kind
== SELECTION_REQUEST_EVENT
3567 || event
->kind
== SELECTION_CLEAR_EVENT
)
3571 Lisp_Object obj
= event
->frame_or_window
;
3572 /* There are some events that set this field to nil or string. */
3574 obj
= WINDOW_FRAME (XWINDOW (obj
));
3575 /* Also ignore dead frames here. */
3576 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3577 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3582 /* Return the number of slots occupied in kbd_buffer. */
3585 kbd_buffer_nr_stored (void)
3587 return kbd_fetch_ptr
== kbd_store_ptr
3589 : (kbd_fetch_ptr
< kbd_store_ptr
3590 ? kbd_store_ptr
- kbd_fetch_ptr
3591 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3592 + (kbd_store_ptr
- kbd_buffer
)));
3594 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3597 kbd_buffer_store_event (register struct input_event
*event
)
3599 kbd_buffer_store_event_hold (event
, 0);
3602 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3604 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3605 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3606 Else, if EVENT is a quit event, store the quit event
3607 in HOLD_QUIT, and return (thus ignoring further events).
3609 This is used to postpone the processing of the quit event until all
3610 subsequent input events have been parsed (and discarded). */
3613 kbd_buffer_store_event_hold (register struct input_event
*event
,
3614 struct input_event
*hold_quit
)
3616 if (event
->kind
== NO_EVENT
)
3619 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3622 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3624 register int c
= event
->code
& 0377;
3626 if (event
->modifiers
& ctrl_modifier
)
3627 c
= make_ctrl_char (c
);
3629 c
|= (event
->modifiers
3630 & (meta_modifier
| alt_modifier
3631 | hyper_modifier
| super_modifier
));
3635 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3636 struct input_event
*sp
;
3638 if (single_kboard
&& kb
!= current_kboard
)
3641 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3643 kb
->kbd_queue_has_data
= 1;
3644 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3646 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3649 if (event_to_kboard (sp
) == kb
)
3651 sp
->kind
= NO_EVENT
;
3652 sp
->frame_or_window
= Qnil
;
3661 *hold_quit
= *event
;
3665 /* If this results in a quit_char being returned to Emacs as
3666 input, set Vlast_event_frame properly. If this doesn't
3667 get returned to Emacs as an event, the next event read
3668 will set Vlast_event_frame again, so this is safe to do. */
3672 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3674 focus
= event
->frame_or_window
;
3675 internal_last_event_frame
= focus
;
3676 Vlast_event_frame
= focus
;
3679 handle_interrupt (0);
3683 if (c
&& c
== stop_character
)
3689 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3690 Just ignore the second one. */
3691 else if (event
->kind
== BUFFER_SWITCH_EVENT
3692 && kbd_fetch_ptr
!= kbd_store_ptr
3693 && ((kbd_store_ptr
== kbd_buffer
3694 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3695 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3698 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3699 kbd_store_ptr
= kbd_buffer
;
3701 /* Don't let the very last slot in the buffer become full,
3702 since that would make the two pointers equal,
3703 and that is indistinguishable from an empty buffer.
3704 Discard the event if it would fill the last slot. */
3705 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3707 *kbd_store_ptr
= *event
;
3710 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3711 && ! kbd_on_hold_p ())
3713 /* Don't read keyboard input until we have processed kbd_buffer.
3714 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3715 hold_keyboard_input ();
3716 if (!noninteractive
)
3720 #endif /* subprocesses */
3723 /* If we're inside while-no-input, and this event qualifies
3724 as input, set quit-flag to cause an interrupt. */
3725 if (!NILP (Vthrow_on_input
)
3726 && event
->kind
!= FOCUS_IN_EVENT
3727 && event
->kind
!= HELP_EVENT
3728 && event
->kind
!= DEICONIFY_EVENT
)
3730 Vquit_flag
= Vthrow_on_input
;
3731 /* If we're inside a function that wants immediate quits,
3733 if (immediate_quit
&& NILP (Vinhibit_quit
))
3742 /* Put an input event back in the head of the event queue. */
3745 kbd_buffer_unget_event (register struct input_event
*event
)
3747 if (kbd_fetch_ptr
== kbd_buffer
)
3748 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3750 /* Don't let the very last slot in the buffer become full, */
3751 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3754 *kbd_fetch_ptr
= *event
;
3759 /* Generate a HELP_EVENT input_event and store it in the keyboard
3762 HELP is the help form.
3764 FRAME and WINDOW are the frame and window where the help is
3765 generated. OBJECT is the Lisp object where the help was found (a
3766 buffer, a string, an overlay, or nil if neither from a string nor
3767 from a buffer). POS is the position within OBJECT where the help
3771 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3772 Lisp_Object object
, ptrdiff_t pos
)
3774 struct input_event event
;
3778 event
.kind
= HELP_EVENT
;
3779 event
.frame_or_window
= frame
;
3781 event
.x
= WINDOWP (window
) ? window
: frame
;
3784 kbd_buffer_store_event (&event
);
3788 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3791 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3793 struct input_event event
;
3795 event
.kind
= HELP_EVENT
;
3796 event
.frame_or_window
= frame
;
3801 kbd_buffer_store_event (&event
);
3805 /* Discard any mouse events in the event buffer by setting them to
3808 discard_mouse_events (void)
3810 struct input_event
*sp
;
3811 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3813 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3816 if (sp
->kind
== MOUSE_CLICK_EVENT
3817 || sp
->kind
== WHEEL_EVENT
3818 || sp
->kind
== HORIZ_WHEEL_EVENT
3820 || sp
->kind
== GPM_CLICK_EVENT
3822 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3824 sp
->kind
= NO_EVENT
;
3830 /* Return true if there are any real events waiting in the event
3831 buffer, not counting `NO_EVENT's.
3833 Discard NO_EVENT events at the front of the input queue, possibly
3834 leaving the input queue empty if there are no real input events. */
3837 kbd_buffer_events_waiting (void)
3839 struct input_event
*sp
;
3841 for (sp
= kbd_fetch_ptr
;
3842 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3845 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3850 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3854 /* Clear input event EVENT. */
3857 clear_event (struct input_event
*event
)
3859 event
->kind
= NO_EVENT
;
3863 /* Read one event from the event buffer, waiting if necessary.
3864 The value is a Lisp object representing the event.
3865 The value is nil for an event that should be ignored,
3866 or that was handled here.
3867 We always read and discard one event. */
3870 kbd_buffer_get_event (KBOARD
**kbp
,
3871 bool *used_mouse_menu
,
3872 struct timespec
*end_time
)
3877 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3879 /* Start reading input again because we have processed enough to
3880 be able to accept new events again. */
3881 unhold_keyboard_input ();
3884 #endif /* subprocesses */
3886 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3888 /* In case we are running as a daemon, only do this before
3889 detaching from the terminal. */
3890 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3894 *kbp
= current_kboard
;
3897 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3899 /* Wait until there is input available. */
3902 /* Break loop if there's an unread command event. Needed in
3903 moused window autoselection which uses a timer to insert such
3905 if (CONSP (Vunread_command_events
))
3908 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3910 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3913 /* If the quit flag is set, then read_char will return
3914 quit_char, so that counts as "available input." */
3915 if (!NILP (Vquit_flag
))
3916 quit_throw_to_read_char (0);
3918 /* One way or another, wait until input is available; then, if
3919 interrupt handlers have not read it, read it now. */
3924 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3926 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3930 struct timespec now
= current_timespec ();
3931 if (timespec_cmp (*end_time
, now
) <= 0)
3932 return Qnil
; /* Finished waiting. */
3935 struct timespec duration
= timespec_sub (*end_time
, now
);
3936 wait_reading_process_output (min (duration
.tv_sec
,
3939 -1, 1, Qnil
, NULL
, 0);
3944 bool do_display
= true;
3946 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3948 struct tty_display_info
*tty
= CURTTY ();
3950 /* When this TTY is displaying a menu, we must prevent
3951 any redisplay, because we modify the frame's glyph
3952 matrix behind the back of the display engine. */
3953 if (tty
->showing_menu
)
3957 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3960 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3964 if (CONSP (Vunread_command_events
))
3967 first
= XCAR (Vunread_command_events
);
3968 Vunread_command_events
= XCDR (Vunread_command_events
);
3969 *kbp
= current_kboard
;
3973 /* At this point, we know that there is a readable event available
3974 somewhere. If the event queue is empty, then there must be a
3975 mouse movement enabled and available. */
3976 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3978 struct input_event
*event
;
3980 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3984 *kbp
= event_to_kboard (event
);
3986 *kbp
= current_kboard
; /* Better than returning null ptr? */
3990 /* These two kinds of events get special handling
3991 and don't actually appear to the command loop.
3992 We return nil for them. */
3993 if (event
->kind
== SELECTION_REQUEST_EVENT
3994 || event
->kind
== SELECTION_CLEAR_EVENT
)
3997 struct input_event copy
;
3999 /* Remove it from the buffer before processing it,
4000 since otherwise swallow_events will see it
4001 and process it again. */
4003 kbd_fetch_ptr
= event
+ 1;
4004 input_pending
= readable_events (0);
4005 x_handle_selection_event (©
);
4007 /* We're getting selection request events, but we don't have
4013 #if defined (HAVE_NS)
4014 else if (event
->kind
== NS_TEXT_EVENT
)
4016 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
4017 obj
= list1 (intern ("ns-put-working-text"));
4019 obj
= list1 (intern ("ns-unput-working-text"));
4020 kbd_fetch_ptr
= event
+ 1;
4021 if (used_mouse_menu
)
4022 *used_mouse_menu
= 1;
4026 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4027 || defined (HAVE_NS)
4028 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4030 /* Make an event (delete-frame (FRAME)). */
4031 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
4032 kbd_fetch_ptr
= event
+ 1;
4035 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4036 || defined (HAVE_NS)
4037 else if (event
->kind
== ICONIFY_EVENT
)
4039 /* Make an event (iconify-frame (FRAME)). */
4040 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
4041 kbd_fetch_ptr
= event
+ 1;
4043 else if (event
->kind
== DEICONIFY_EVENT
)
4045 /* Make an event (make-frame-visible (FRAME)). */
4046 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
4047 kbd_fetch_ptr
= event
+ 1;
4050 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4052 /* The value doesn't matter here; only the type is tested. */
4053 XSETBUFFER (obj
, current_buffer
);
4054 kbd_fetch_ptr
= event
+ 1;
4056 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4057 || defined (HAVE_NS) || defined (USE_GTK)
4058 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4060 kbd_fetch_ptr
= event
+ 1;
4061 input_pending
= readable_events (0);
4062 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4063 x_activate_menubar (XFRAME (event
->frame_or_window
));
4067 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4069 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4070 obj
= list4 (Qlanguage_change
,
4071 event
->frame_or_window
,
4072 make_number (event
->code
),
4073 make_number (event
->modifiers
));
4074 kbd_fetch_ptr
= event
+ 1;
4077 #ifdef USE_FILE_NOTIFY
4078 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4080 #ifdef HAVE_W32NOTIFY
4081 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4082 obj
= list3 (Qfile_notify
,
4083 list3 (make_number (event
->code
),
4086 event
->frame_or_window
);
4088 obj
= make_lispy_event (event
);
4090 kbd_fetch_ptr
= event
+ 1;
4092 #endif /* USE_FILE_NOTIFY */
4093 else if (event
->kind
== SAVE_SESSION_EVENT
)
4095 obj
= list2 (Qsave_session
, event
->arg
);
4096 kbd_fetch_ptr
= event
+ 1;
4098 /* Just discard these, by returning nil.
4099 With MULTI_KBOARD, these events are used as placeholders
4100 when we need to randomly delete events from the queue.
4101 (They shouldn't otherwise be found in the buffer,
4102 but on some machines it appears they do show up
4103 even without MULTI_KBOARD.) */
4104 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4105 mouse events during a popup-menu call. */
4106 else if (event
->kind
== NO_EVENT
)
4107 kbd_fetch_ptr
= event
+ 1;
4108 else if (event
->kind
== HELP_EVENT
)
4110 Lisp_Object object
, position
, help
, frame
, window
;
4112 frame
= event
->frame_or_window
;
4113 object
= event
->arg
;
4114 position
= make_number (event
->code
);
4117 clear_event (event
);
4119 kbd_fetch_ptr
= event
+ 1;
4120 if (!WINDOWP (window
))
4122 obj
= Fcons (Qhelp_echo
,
4123 list5 (frame
, help
, window
, object
, position
));
4125 else if (event
->kind
== FOCUS_IN_EVENT
)
4127 /* Notification of a FocusIn event. The frame receiving the
4128 focus is in event->frame_or_window. Generate a
4129 switch-frame event if necessary. */
4130 Lisp_Object frame
, focus
;
4132 frame
= event
->frame_or_window
;
4133 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4142 !EQ (frame
, internal_last_event_frame
)
4143 && !EQ (frame
, selected_frame
))
4144 obj
= make_lispy_switch_frame (frame
);
4146 obj
= make_lispy_focus_in (frame
);
4148 internal_last_event_frame
= frame
;
4149 kbd_fetch_ptr
= event
+ 1;
4151 else if (event
->kind
== FOCUS_OUT_EVENT
)
4153 #ifdef HAVE_WINDOW_SYSTEM
4156 Lisp_Object frame
= event
->frame_or_window
;
4157 bool focused
= false;
4159 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4160 focused
= di
->x_highlight_frame
!= 0;
4163 obj
= make_lispy_focus_out (frame
);
4165 #endif /* HAVE_WINDOW_SYSTEM */
4167 kbd_fetch_ptr
= event
+ 1;
4170 else if (event
->kind
== DBUS_EVENT
)
4172 obj
= make_lispy_event (event
);
4173 kbd_fetch_ptr
= event
+ 1;
4176 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4178 obj
= make_lispy_event (event
);
4179 kbd_fetch_ptr
= event
+ 1;
4183 /* If this event is on a different frame, return a switch-frame this
4184 time, and leave the event in the queue for next time. */
4188 frame
= event
->frame_or_window
;
4190 frame
= XCAR (frame
);
4191 else if (WINDOWP (frame
))
4192 frame
= WINDOW_FRAME (XWINDOW (frame
));
4194 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4198 if (! EQ (frame
, internal_last_event_frame
)
4199 && !EQ (frame
, selected_frame
))
4200 obj
= make_lispy_switch_frame (frame
);
4201 internal_last_event_frame
= frame
;
4203 /* If we didn't decide to make a switch-frame event, go ahead
4204 and build a real event from the queue entry. */
4208 obj
= make_lispy_event (event
);
4210 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4211 || defined (HAVE_NS) || defined (USE_GTK)
4212 /* If this was a menu selection, then set the flag to inhibit
4213 writing to last_nonmenu_event. Don't do this if the event
4214 we're returning is (menu-bar), though; that indicates the
4215 beginning of the menu sequence, and we might as well leave
4216 that as the `event with parameters' for this selection. */
4218 && !EQ (event
->frame_or_window
, event
->arg
)
4219 && (event
->kind
== MENU_BAR_EVENT
4220 || event
->kind
== TOOL_BAR_EVENT
))
4221 *used_mouse_menu
= 1;
4224 /* Certain system events are non-key events. */
4226 && event
->kind
== NS_NONKEY_EVENT
)
4227 *used_mouse_menu
= 1;
4230 /* Wipe out this event, to catch bugs. */
4231 clear_event (event
);
4232 kbd_fetch_ptr
= event
+ 1;
4236 /* Try generating a mouse motion event. */
4237 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4239 struct frame
*f
= some_mouse_moved ();
4240 Lisp_Object bar_window
;
4241 enum scroll_bar_part part
;
4245 *kbp
= current_kboard
;
4246 /* Note that this uses F to determine which terminal to look at.
4247 If there is no valid info, it does not store anything
4248 so x remains nil. */
4251 /* XXX Can f or mouse_position_hook be NULL here? */
4252 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4253 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4258 /* Decide if we should generate a switch-frame event. Don't
4259 generate switch-frame events for motion outside of all Emacs
4265 frame
= FRAME_FOCUS_FRAME (f
);
4267 XSETFRAME (frame
, f
);
4269 if (! EQ (frame
, internal_last_event_frame
)
4270 && !EQ (frame
, selected_frame
))
4271 obj
= make_lispy_switch_frame (frame
);
4272 internal_last_event_frame
= frame
;
4275 /* If we didn't decide to make a switch-frame event, go ahead and
4276 return a mouse-motion event. */
4277 if (!NILP (x
) && NILP (obj
))
4278 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4281 /* We were promised by the above while loop that there was
4282 something for us to read! */
4285 input_pending
= readable_events (0);
4287 Vlast_event_frame
= internal_last_event_frame
;
4292 /* Process any non-user-visible events (currently X selection events),
4293 without reading any user-visible events. */
4296 process_special_events (void)
4298 struct input_event
*event
;
4300 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4302 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4305 if (event
== kbd_store_ptr
)
4309 /* If we find a stored X selection request, handle it now. */
4310 if (event
->kind
== SELECTION_REQUEST_EVENT
4311 || event
->kind
== SELECTION_CLEAR_EVENT
)
4315 /* Remove the event from the fifo buffer before processing;
4316 otherwise swallow_events called recursively could see it
4317 and process it again. To do this, we move the events
4318 between kbd_fetch_ptr and EVENT one slot to the right,
4321 struct input_event copy
= *event
;
4322 struct input_event
*beg
4323 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4324 ? kbd_buffer
: kbd_fetch_ptr
;
4327 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4328 else if (event
< beg
)
4330 if (event
> kbd_buffer
)
4331 memmove (kbd_buffer
+ 1, kbd_buffer
,
4332 (event
- kbd_buffer
) * sizeof (struct input_event
));
4333 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4334 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4335 memmove (beg
+ 1, beg
,
4336 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4337 * sizeof (struct input_event
));
4340 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4341 kbd_fetch_ptr
= kbd_buffer
+ 1;
4345 input_pending
= readable_events (0);
4346 x_handle_selection_event (©
);
4348 /* We're getting selection request events, but we don't have
4356 /* Process any events that are not user-visible, run timer events that
4357 are ripe, and return, without reading any user-visible events. */
4360 swallow_events (bool do_display
)
4362 unsigned old_timers_run
;
4364 process_special_events ();
4366 old_timers_run
= timers_run
;
4367 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4369 if (timers_run
!= old_timers_run
&& do_display
)
4370 redisplay_preserve_echo_area (7);
4373 /* Record the start of when Emacs is idle,
4374 for the sake of running idle-time timers. */
4377 timer_start_idle (void)
4379 /* If we are already in the idle state, do nothing. */
4380 if (timespec_valid_p (timer_idleness_start_time
))
4383 timer_idleness_start_time
= current_timespec ();
4384 timer_last_idleness_start_time
= timer_idleness_start_time
;
4386 /* Mark all idle-time timers as once again candidates for running. */
4387 call0 (intern ("internal-timer-start-idle"));
4390 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4393 timer_stop_idle (void)
4395 timer_idleness_start_time
= invalid_timespec ();
4398 /* Resume idle timer from last idle start time. */
4401 timer_resume_idle (void)
4403 if (timespec_valid_p (timer_idleness_start_time
))
4406 timer_idleness_start_time
= timer_last_idleness_start_time
;
4409 /* This is only for debugging. */
4410 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4412 /* List of elisp functions to call, delayed because they were generated in
4413 a context where Elisp could not be safely run (e.g. redisplay, signal,
4414 ...). Each element has the form (FUN . ARGS). */
4415 Lisp_Object pending_funcalls
;
4417 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4419 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4421 Lisp_Object
*vector
;
4423 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4425 vector
= XVECTOR (timer
)->contents
;
4426 if (! NILP (vector
[0]))
4429 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4434 /* Check whether a timer has fired. To prevent larger problems we simply
4435 disregard elements that are not proper timers. Do not make a circular
4436 timer list for the time being.
4438 Returns the time to wait until the next timer fires. If a
4439 timer is triggering now, return zero.
4440 If no timer is active, return -1.
4442 If a timer is ripe, we run it, with quitting turned off.
4443 In that case we return 0 to indicate that a new timer_check_2 call
4446 static struct timespec
4447 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4449 struct timespec nexttime
;
4450 struct timespec now
;
4451 struct timespec idleness_now
;
4452 Lisp_Object chosen_timer
;
4453 struct gcpro gcpro1
;
4455 nexttime
= invalid_timespec ();
4457 chosen_timer
= Qnil
;
4458 GCPRO1 (chosen_timer
);
4460 /* First run the code that was delayed. */
4461 while (CONSP (pending_funcalls
))
4463 Lisp_Object funcall
= XCAR (pending_funcalls
);
4464 pending_funcalls
= XCDR (pending_funcalls
);
4465 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4468 if (CONSP (timers
) || CONSP (idle_timers
))
4470 now
= current_timespec ();
4471 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4472 ? timespec_sub (now
, timer_idleness_start_time
)
4473 : make_timespec (0, 0));
4476 while (CONSP (timers
) || CONSP (idle_timers
))
4478 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4479 struct timespec timer_time
, idle_timer_time
;
4480 struct timespec difference
;
4481 struct timespec timer_difference
= invalid_timespec ();
4482 struct timespec idle_timer_difference
= invalid_timespec ();
4483 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4485 /* Set TIMER and TIMER_DIFFERENCE
4486 based on the next ordinary timer.
4487 TIMER_DIFFERENCE is the distance in time from NOW to when
4488 this timer becomes ripe (negative if it's already ripe).
4489 Skip past invalid timers and timers already handled. */
4492 timer
= XCAR (timers
);
4493 if (! decode_timer (timer
, &timer_time
))
4495 timers
= XCDR (timers
);
4499 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4500 timer_difference
= (timer_ripe
4501 ? timespec_sub (now
, timer_time
)
4502 : timespec_sub (timer_time
, now
));
4505 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4506 based on the next idle timer. */
4507 if (CONSP (idle_timers
))
4509 idle_timer
= XCAR (idle_timers
);
4510 if (! decode_timer (idle_timer
, &idle_timer_time
))
4512 idle_timers
= XCDR (idle_timers
);
4516 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4517 idle_timer_difference
4519 ? timespec_sub (idleness_now
, idle_timer_time
)
4520 : timespec_sub (idle_timer_time
, idleness_now
));
4523 /* Decide which timer is the next timer,
4524 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4525 Also step down the list where we found that timer. */
4527 if (timespec_valid_p (timer_difference
)
4528 && (! timespec_valid_p (idle_timer_difference
)
4529 || idle_timer_ripe
< timer_ripe
4530 || (idle_timer_ripe
== timer_ripe
4532 ? timespec_cmp (idle_timer_difference
,
4534 : timespec_cmp (timer_difference
,
4535 idle_timer_difference
))
4538 chosen_timer
= timer
;
4539 timers
= XCDR (timers
);
4540 difference
= timer_difference
;
4545 chosen_timer
= idle_timer
;
4546 idle_timers
= XCDR (idle_timers
);
4547 difference
= idle_timer_difference
;
4548 ripe
= idle_timer_ripe
;
4551 /* If timer is ripe, run it if it hasn't been run. */
4554 if (NILP (AREF (chosen_timer
, 0)))
4557 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4559 /* Mark the timer as triggered to prevent problems if the lisp
4560 code fails to reschedule it right. */
4561 ASET (chosen_timer
, 0, Qt
);
4563 specbind (Qinhibit_quit
, Qt
);
4565 call1 (Qtimer_event_handler
, chosen_timer
);
4566 Vdeactivate_mark
= old_deactivate_mark
;
4570 /* Since we have handled the event,
4571 we don't need to tell the caller to wake up and do it. */
4572 /* But the caller must still wait for the next timer, so
4573 return 0 to indicate that. */
4576 nexttime
= make_timespec (0, 0);
4580 /* When we encounter a timer that is still waiting,
4581 return the amount of time to wait before it is ripe. */
4588 /* No timers are pending in the future. */
4589 /* Return 0 if we generated an event, and -1 if not. */
4595 /* Check whether a timer has fired. To prevent larger problems we simply
4596 disregard elements that are not proper timers. Do not make a circular
4597 timer list for the time being.
4599 Returns the time to wait until the next timer fires.
4600 If no timer is active, return an invalid value.
4602 As long as any timer is ripe, we run it. */
4607 struct timespec nexttime
;
4608 Lisp_Object timers
, idle_timers
;
4609 struct gcpro gcpro1
, gcpro2
;
4611 Lisp_Object tem
= Vinhibit_quit
;
4614 /* We use copies of the timers' lists to allow a timer to add itself
4615 again, without locking up Emacs if the newly added timer is
4616 already ripe when added. */
4618 /* Always consider the ordinary timers. */
4619 timers
= Fcopy_sequence (Vtimer_list
);
4620 /* Consider the idle timers only if Emacs is idle. */
4621 if (timespec_valid_p (timer_idleness_start_time
))
4622 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4626 Vinhibit_quit
= tem
;
4628 GCPRO2 (timers
, idle_timers
);
4632 nexttime
= timer_check_2 (timers
, idle_timers
);
4634 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4640 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4641 doc
: /* Return the current length of Emacs idleness, or nil.
4642 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4643 in the same style as (current-time).
4645 The value when Emacs is not idle is nil.
4647 PSEC is a multiple of the system clock resolution. */)
4650 if (timespec_valid_p (timer_idleness_start_time
))
4651 return make_lisp_time (timespec_sub (current_timespec (),
4652 timer_idleness_start_time
));
4657 /* Caches for modify_event_symbol. */
4658 static Lisp_Object accent_key_syms
;
4659 static Lisp_Object func_key_syms
;
4660 static Lisp_Object mouse_syms
;
4661 static Lisp_Object wheel_syms
;
4662 static Lisp_Object drag_n_drop_syms
;
4664 /* This is a list of keysym codes for special "accent" characters.
4665 It parallels lispy_accent_keys. */
4667 static const int lispy_accent_codes
[] =
4669 #ifdef XK_dead_circumflex
4674 #ifdef XK_dead_grave
4679 #ifdef XK_dead_tilde
4684 #ifdef XK_dead_diaeresis
4689 #ifdef XK_dead_macron
4694 #ifdef XK_dead_degree
4699 #ifdef XK_dead_acute
4704 #ifdef XK_dead_cedilla
4709 #ifdef XK_dead_breve
4714 #ifdef XK_dead_ogonek
4719 #ifdef XK_dead_caron
4724 #ifdef XK_dead_doubleacute
4725 XK_dead_doubleacute
,
4729 #ifdef XK_dead_abovedot
4734 #ifdef XK_dead_abovering
4744 #ifdef XK_dead_belowdot
4749 #ifdef XK_dead_voiced_sound
4750 XK_dead_voiced_sound
,
4754 #ifdef XK_dead_semivoiced_sound
4755 XK_dead_semivoiced_sound
,
4771 /* This is a list of Lisp names for special "accent" characters.
4772 It parallels lispy_accent_codes. */
4774 static const char *const lispy_accent_keys
[] =
4792 "dead-voiced-sound",
4793 "dead-semivoiced-sound",
4799 #define FUNCTION_KEY_OFFSET 0x0
4801 const char *const lispy_function_keys
[] =
4805 0, /* VK_LBUTTON 0x01 */
4806 0, /* VK_RBUTTON 0x02 */
4807 "cancel", /* VK_CANCEL 0x03 */
4808 0, /* VK_MBUTTON 0x04 */
4810 0, 0, 0, /* 0x05 .. 0x07 */
4812 "backspace", /* VK_BACK 0x08 */
4813 "tab", /* VK_TAB 0x09 */
4815 0, 0, /* 0x0A .. 0x0B */
4817 "clear", /* VK_CLEAR 0x0C */
4818 "return", /* VK_RETURN 0x0D */
4820 0, 0, /* 0x0E .. 0x0F */
4822 0, /* VK_SHIFT 0x10 */
4823 0, /* VK_CONTROL 0x11 */
4824 0, /* VK_MENU 0x12 */
4825 "pause", /* VK_PAUSE 0x13 */
4826 "capslock", /* VK_CAPITAL 0x14 */
4827 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4829 "junja", /* VK_JUNJA 0x17 */
4830 "final", /* VK_FINAL 0x18 */
4831 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4833 "escape", /* VK_ESCAPE 0x1B */
4834 "convert", /* VK_CONVERT 0x1C */
4835 "non-convert", /* VK_NONCONVERT 0x1D */
4836 "accept", /* VK_ACCEPT 0x1E */
4837 "mode-change", /* VK_MODECHANGE 0x1F */
4838 0, /* VK_SPACE 0x20 */
4839 "prior", /* VK_PRIOR 0x21 */
4840 "next", /* VK_NEXT 0x22 */
4841 "end", /* VK_END 0x23 */
4842 "home", /* VK_HOME 0x24 */
4843 "left", /* VK_LEFT 0x25 */
4844 "up", /* VK_UP 0x26 */
4845 "right", /* VK_RIGHT 0x27 */
4846 "down", /* VK_DOWN 0x28 */
4847 "select", /* VK_SELECT 0x29 */
4848 "print", /* VK_PRINT 0x2A */
4849 "execute", /* VK_EXECUTE 0x2B */
4850 "snapshot", /* VK_SNAPSHOT 0x2C */
4851 "insert", /* VK_INSERT 0x2D */
4852 "delete", /* VK_DELETE 0x2E */
4853 "help", /* VK_HELP 0x2F */
4855 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4857 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4859 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4861 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4863 0, 0, 0, 0, 0, 0, 0, 0, 0,
4864 0, 0, 0, 0, 0, 0, 0, 0, 0,
4865 0, 0, 0, 0, 0, 0, 0, 0,
4867 "lwindow", /* VK_LWIN 0x5B */
4868 "rwindow", /* VK_RWIN 0x5C */
4869 "apps", /* VK_APPS 0x5D */
4872 "kp-0", /* VK_NUMPAD0 0x60 */
4873 "kp-1", /* VK_NUMPAD1 0x61 */
4874 "kp-2", /* VK_NUMPAD2 0x62 */
4875 "kp-3", /* VK_NUMPAD3 0x63 */
4876 "kp-4", /* VK_NUMPAD4 0x64 */
4877 "kp-5", /* VK_NUMPAD5 0x65 */
4878 "kp-6", /* VK_NUMPAD6 0x66 */
4879 "kp-7", /* VK_NUMPAD7 0x67 */
4880 "kp-8", /* VK_NUMPAD8 0x68 */
4881 "kp-9", /* VK_NUMPAD9 0x69 */
4882 "kp-multiply", /* VK_MULTIPLY 0x6A */
4883 "kp-add", /* VK_ADD 0x6B */
4884 "kp-separator", /* VK_SEPARATOR 0x6C */
4885 "kp-subtract", /* VK_SUBTRACT 0x6D */
4886 "kp-decimal", /* VK_DECIMAL 0x6E */
4887 "kp-divide", /* VK_DIVIDE 0x6F */
4888 "f1", /* VK_F1 0x70 */
4889 "f2", /* VK_F2 0x71 */
4890 "f3", /* VK_F3 0x72 */
4891 "f4", /* VK_F4 0x73 */
4892 "f5", /* VK_F5 0x74 */
4893 "f6", /* VK_F6 0x75 */
4894 "f7", /* VK_F7 0x76 */
4895 "f8", /* VK_F8 0x77 */
4896 "f9", /* VK_F9 0x78 */
4897 "f10", /* VK_F10 0x79 */
4898 "f11", /* VK_F11 0x7A */
4899 "f12", /* VK_F12 0x7B */
4900 "f13", /* VK_F13 0x7C */
4901 "f14", /* VK_F14 0x7D */
4902 "f15", /* VK_F15 0x7E */
4903 "f16", /* VK_F16 0x7F */
4904 "f17", /* VK_F17 0x80 */
4905 "f18", /* VK_F18 0x81 */
4906 "f19", /* VK_F19 0x82 */
4907 "f20", /* VK_F20 0x83 */
4908 "f21", /* VK_F21 0x84 */
4909 "f22", /* VK_F22 0x85 */
4910 "f23", /* VK_F23 0x86 */
4911 "f24", /* VK_F24 0x87 */
4913 0, 0, 0, 0, /* 0x88 .. 0x8B */
4914 0, 0, 0, 0, /* 0x8C .. 0x8F */
4916 "kp-numlock", /* VK_NUMLOCK 0x90 */
4917 "scroll", /* VK_SCROLL 0x91 */
4918 /* Not sure where the following block comes from.
4919 Windows headers have NEC and Fujitsu specific keys in
4920 this block, but nothing generic. */
4921 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4922 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4923 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4924 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4925 "kp-end", /* VK_NUMPAD_END 0x96 */
4926 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4927 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4928 "kp-up", /* VK_NUMPAD_UP 0x99 */
4929 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4930 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4931 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4932 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4934 0, 0, /* 0x9E .. 0x9F */
4937 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4938 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4939 * No other API or message will distinguish left and right keys this way.
4944 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4945 to enable them selectively, and gives access to a few more functions.
4946 See lispy_multimedia_keys below. */
4947 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4948 0, 0, 0, /* 0xAD .. 0xAF Volume */
4949 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4950 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4952 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4953 0, 0, 0, 0, 0, 0, 0, 0, 0,
4955 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4956 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4957 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4960 "ax", /* VK_OEM_AX 0xE1 */
4961 0, /* VK_OEM_102 0xE2 */
4962 "ico-help", /* VK_ICO_HELP 0xE3 */
4963 "ico-00", /* VK_ICO_00 0xE4 */
4964 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4965 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4966 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4968 "reset", /* VK_OEM_RESET 0xE9 */
4969 "jump", /* VK_OEM_JUMP 0xEA */
4970 "oem-pa1", /* VK_OEM_PA1 0xEB */
4971 "oem-pa2", /* VK_OEM_PA2 0xEC */
4972 "oem-pa3", /* VK_OEM_PA3 0xED */
4973 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4974 "cusel", /* VK_OEM_CUSEL 0xEF */
4975 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4976 "finish", /* VK_OEM_FINISH 0xF1 */
4977 "copy", /* VK_OEM_COPY 0xF2 */
4978 "auto", /* VK_OEM_AUTO 0xF3 */
4979 "enlw", /* VK_OEM_ENLW 0xF4 */
4980 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4981 "attn", /* VK_ATTN 0xF6 */
4982 "crsel", /* VK_CRSEL 0xF7 */
4983 "exsel", /* VK_EXSEL 0xF8 */
4984 "ereof", /* VK_EREOF 0xF9 */
4985 "play", /* VK_PLAY 0xFA */
4986 "zoom", /* VK_ZOOM 0xFB */
4987 "noname", /* VK_NONAME 0xFC */
4988 "pa1", /* VK_PA1 0xFD */
4989 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4993 /* Some of these duplicate the "Media keys" on newer keyboards,
4994 but they are delivered to the application in a different way. */
4995 static const char *const lispy_multimedia_keys
[] =
5003 "browser-favorites",
5040 "toggle-dictate-command",
5046 "media-fast-forward",
5049 "media-channel-down"
5052 #else /* not HAVE_NTGUI */
5054 /* This should be dealt with in XTread_socket now, and that doesn't
5055 depend on the client system having the Kana syms defined. See also
5056 the XK_kana_A case below. */
5059 static const char *const lispy_kana_keys
[] =
5061 /* X Keysym value */
5062 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5063 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5064 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5065 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5066 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5067 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5068 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5069 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5070 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5071 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5072 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5073 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5074 "kana-i", "kana-u", "kana-e", "kana-o",
5075 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5076 "prolongedsound", "kana-A", "kana-I", "kana-U",
5077 "kana-E", "kana-O", "kana-KA", "kana-KI",
5078 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5079 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5080 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5081 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5082 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5083 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5084 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5085 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5086 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5087 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5088 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5089 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5091 #endif /* XK_kana_A */
5094 #define FUNCTION_KEY_OFFSET 0xff00
5096 /* You'll notice that this table is arranged to be conveniently
5097 indexed by X Windows keysym values. */
5098 static const char *const lispy_function_keys
[] =
5100 /* X Keysym value */
5102 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5103 "backspace", "tab", "linefeed", "clear",
5105 0, 0, 0, "pause", /* 0xff10...1f */
5106 0, 0, 0, 0, 0, 0, 0, "escape",
5108 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5109 "romaji", "hiragana", "katakana", "hiragana-katakana",
5110 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5111 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5112 "eisu-toggle", /* 0xff30...3f */
5113 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5114 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5116 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5117 "down", "prior", "next", "end",
5118 "begin", 0, 0, 0, 0, 0, 0, 0,
5119 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5130 "break", /* 0xff6b */
5133 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5134 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5135 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5136 0, 0, 0, 0, 0, 0, 0, 0,
5137 "kp-tab", /* 0xff89 */
5139 "kp-enter", /* 0xff8d */
5141 "kp-f1", /* 0xff91 */
5145 "kp-home", /* 0xff95 */
5150 "kp-prior", /* kp-page-up */
5151 "kp-next", /* kp-page-down */
5157 0, 0, 0, 0, 0, 0, 0, 0, 0,
5158 "kp-multiply", /* 0xffaa */
5163 "kp-divide", /* 0xffaf */
5164 "kp-0", /* 0xffb0 */
5165 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5168 "kp-equal", /* 0xffbd */
5169 "f1", /* 0xffbe */ /* IsFunctionKey */
5171 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5172 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5173 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5174 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5175 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5176 0, 0, 0, 0, 0, 0, 0, 0,
5177 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5178 0, 0, 0, 0, 0, 0, 0, "delete"
5181 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5182 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5184 static const char *const iso_lispy_function_keys
[] =
5186 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5187 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5188 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5189 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5190 "iso-lefttab", /* 0xfe20 */
5191 "iso-move-line-up", "iso-move-line-down",
5192 "iso-partial-line-up", "iso-partial-line-down",
5193 "iso-partial-space-left", "iso-partial-space-right",
5194 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5195 "iso-release-margin-left", "iso-release-margin-right",
5196 "iso-release-both-margins",
5197 "iso-fast-cursor-left", "iso-fast-cursor-right",
5198 "iso-fast-cursor-up", "iso-fast-cursor-down",
5199 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5200 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5203 #endif /* not HAVE_NTGUI */
5205 static Lisp_Object Vlispy_mouse_stem
;
5207 static const char *const lispy_wheel_names
[] =
5209 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5212 /* drag-n-drop events are generated when a set of selected files are
5213 dragged from another application and dropped onto an Emacs window. */
5214 static const char *const lispy_drag_n_drop_names
[] =
5219 /* Scroll bar parts. */
5220 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5221 Lisp_Object Qup
, Qdown
, Qbottom
;
5222 static Lisp_Object Qend_scroll
;
5224 static Lisp_Object Qratio
;
5226 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5227 static Lisp_Object
*const scroll_bar_parts
[] = {
5228 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5229 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5232 /* A vector, indexed by button number, giving the down-going location
5233 of currently depressed buttons, both scroll bar and non-scroll bar.
5235 The elements have the form
5236 (BUTTON-NUMBER MODIFIER-MASK . REST)
5237 where REST is the cdr of a position as it would be reported in the event.
5239 The make_lispy_event function stores positions here to tell the
5240 difference between click and drag events, and to store the starting
5241 location to be included in drag events. */
5243 static Lisp_Object button_down_location
;
5245 /* Information about the most recent up-going button event: Which
5246 button, what location, and what time. */
5248 static int last_mouse_button
;
5249 static int last_mouse_x
;
5250 static int last_mouse_y
;
5251 static Time button_down_time
;
5253 /* The number of clicks in this multiple-click. */
5255 static int double_click_count
;
5257 /* X and Y are frame-relative coordinates for a click or wheel event.
5258 Return a Lisp-style event list. */
5261 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5264 enum window_part part
;
5265 Lisp_Object posn
= Qnil
;
5266 Lisp_Object extra_info
= Qnil
;
5267 /* Coordinate pixel positions to return. */
5268 int xret
= 0, yret
= 0;
5269 /* The window under frame pixel coordinates (x,y) */
5270 Lisp_Object window
= f
5271 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5274 if (WINDOWP (window
))
5276 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5277 struct window
*w
= XWINDOW (window
);
5278 Lisp_Object string_info
= Qnil
;
5279 ptrdiff_t textpos
= 0;
5280 int col
= -1, row
= -1;
5281 int dx
= -1, dy
= -1;
5282 int width
= -1, height
= -1;
5283 Lisp_Object object
= Qnil
;
5285 /* Pixel coordinates relative to the window corner. */
5286 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5287 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5289 /* For text area clicks, return X, Y relative to the corner of
5290 this text area. Note that dX, dY etc are set below, by
5291 buffer_posn_from_coords. */
5292 if (part
== ON_TEXT
)
5294 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5295 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5297 /* For mode line and header line clicks, return X, Y relative to
5298 the left window edge. Use mode_line_string to look for a
5299 string on the click position. */
5300 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5305 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5306 /* Note that mode_line_string takes COL, ROW as pixels and
5307 converts them to characters. */
5310 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5311 &object
, &dx
, &dy
, &width
, &height
);
5312 if (STRINGP (string
))
5313 string_info
= Fcons (string
, make_number (charpos
));
5319 /* For fringes and margins, Y is relative to the area's (and the
5320 window's) top edge, while X is meaningless. */
5321 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5326 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5329 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5330 &object
, &dx
, &dy
, &width
, &height
);
5331 if (STRINGP (string
))
5332 string_info
= Fcons (string
, make_number (charpos
));
5333 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5335 else if (part
== ON_LEFT_FRINGE
)
5337 posn
= Qleft_fringe
;
5340 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5341 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5342 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5344 else if (part
== ON_RIGHT_FRINGE
)
5346 posn
= Qright_fringe
;
5349 - window_box_width (w
, LEFT_MARGIN_AREA
)
5350 - window_box_width (w
, TEXT_AREA
)
5351 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5352 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5354 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5356 else if (part
== ON_VERTICAL_BORDER
)
5358 posn
= Qvertical_line
;
5363 /* Nothing special for part == ON_SCROLL_BAR. */
5364 else if (part
== ON_RIGHT_DIVIDER
)
5366 posn
= Qright_divider
;
5367 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5371 else if (part
== ON_BOTTOM_DIVIDER
)
5373 posn
= Qbottom_divider
;
5374 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5379 /* For clicks in the text area, fringes, or margins, call
5380 buffer_posn_from_coords to extract TEXTPOS, the buffer
5381 position nearest to the click. */
5384 Lisp_Object string2
, object2
= Qnil
;
5385 struct display_pos p
;
5387 int width2
, height2
;
5388 /* The pixel X coordinate passed to buffer_posn_from_coords
5389 is the X coordinate relative to the text area for
5390 text-area and right-margin clicks, zero otherwise. */
5392 = (part
== ON_TEXT
) ? xret
5393 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5394 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5398 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5399 &object2
, &dx2
, &dy2
,
5401 textpos
= CHARPOS (p
.pos
);
5402 if (col
< 0) col
= x2
;
5403 if (row
< 0) row
= y2
;
5404 if (dx
< 0) dx
= dx2
;
5405 if (dy
< 0) dy
= dy2
;
5406 if (width
< 0) width
= width2
;
5407 if (height
< 0) height
= height2
;
5411 posn
= make_number (textpos
);
5412 if (STRINGP (string2
))
5413 string_info
= Fcons (string2
,
5414 make_number (CHARPOS (p
.string_pos
)));
5420 #ifdef HAVE_WINDOW_SYSTEM
5421 if (IMAGEP (object
))
5423 Lisp_Object image_map
, hotspot
;
5424 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5426 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5428 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5429 posn
= XCAR (hotspot
);
5436 Fcons (make_number (dx
), make_number (dy
)),
5437 Fcons (make_number (width
), make_number (height
)));
5440 extra_info
= Fcons (string_info
,
5441 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5442 Fcons (Fcons (make_number (col
),
5447 XSETFRAME (window
, f
);
5451 return Fcons (window
,
5453 Fcons (Fcons (make_number (xret
),
5454 make_number (yret
)),
5455 Fcons (make_number (t
),
5459 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5460 menu bar. This really means that Emacs draws and manages the menu
5461 bar as part of its normal display, and therefore can compute its
5464 toolkit_menubar_in_use (struct frame
*f
)
5466 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5467 return !(!FRAME_WINDOW_P (f
));
5473 /* Given a struct input_event, build the lisp event which represents
5474 it. If EVENT is 0, build a mouse movement event from the mouse
5475 movement buffer, which should have a movement event in it.
5477 Note that events must be passed to this function in the order they
5478 are received; this function stores the location of button presses
5479 in order to build drag events when the button is released. */
5482 make_lispy_event (struct input_event
*event
)
5486 switch (event
->kind
)
5488 /* A simple keystroke. */
5489 case ASCII_KEYSTROKE_EVENT
:
5490 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5492 Lisp_Object lispy_c
;
5493 EMACS_INT c
= event
->code
;
5494 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5497 eassert (c
== event
->code
);
5498 /* Turn ASCII characters into control characters
5500 if (event
->modifiers
& ctrl_modifier
)
5502 c
= make_ctrl_char (c
);
5503 event
->modifiers
&= ~ctrl_modifier
;
5507 /* Add in the other modifier bits. The shift key was taken care
5508 of by the X code. */
5509 c
|= (event
->modifiers
5510 & (meta_modifier
| alt_modifier
5511 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5512 /* Distinguish Shift-SPC from SPC. */
5513 if ((event
->code
) == 040
5514 && event
->modifiers
& shift_modifier
)
5515 c
|= shift_modifier
;
5516 button_down_time
= 0;
5517 XSETFASTINT (lispy_c
, c
);
5522 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5523 except that they are non-key events (last-nonmenu-event is nil). */
5524 case NS_NONKEY_EVENT
:
5527 /* A function key. The symbol may need to have modifier prefixes
5529 case NON_ASCII_KEYSTROKE_EVENT
:
5530 button_down_time
= 0;
5532 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5533 if (event
->code
== lispy_accent_codes
[i
])
5534 return modify_event_symbol (i
,
5536 Qfunction_key
, Qnil
,
5537 lispy_accent_keys
, &accent_key_syms
,
5538 ARRAYELTS (lispy_accent_keys
));
5542 if (event
->code
>= 0x400 && event
->code
< 0x500)
5543 return modify_event_symbol (event
->code
- 0x400,
5544 event
->modifiers
& ~shift_modifier
,
5545 Qfunction_key
, Qnil
,
5546 lispy_kana_keys
, &func_key_syms
,
5547 ARRAYELTS (lispy_kana_keys
));
5548 #endif /* XK_kana_A */
5551 #ifdef ISO_FUNCTION_KEY_OFFSET
5552 if (event
->code
< FUNCTION_KEY_OFFSET
5553 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5554 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5556 Qfunction_key
, Qnil
,
5557 iso_lispy_function_keys
, &func_key_syms
,
5558 ARRAYELTS (iso_lispy_function_keys
));
5561 /* Handle system-specific or unknown keysyms. */
5562 if (event
->code
& (1 << 28)
5563 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5564 || (event
->code
- FUNCTION_KEY_OFFSET
5565 >= ARRAYELTS (lispy_function_keys
))
5566 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5568 /* We need to use an alist rather than a vector as the cache
5569 since we can't make a vector long enough. */
5570 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5571 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5572 return modify_event_symbol (event
->code
,
5575 KVAR (current_kboard
, Vsystem_key_alist
),
5576 0, &KVAR (current_kboard
, system_key_syms
),
5580 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5582 Qfunction_key
, Qnil
,
5583 lispy_function_keys
, &func_key_syms
,
5584 ARRAYELTS (lispy_function_keys
));
5587 case MULTIMEDIA_KEY_EVENT
:
5588 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5589 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5591 return modify_event_symbol (event
->code
, event
->modifiers
,
5592 Qfunction_key
, Qnil
,
5593 lispy_multimedia_keys
, &func_key_syms
,
5594 ARRAYELTS (lispy_multimedia_keys
));
5599 /* A mouse click. Figure out where it is, decide whether it's
5600 a press, click or drag, and build the appropriate structure. */
5601 case MOUSE_CLICK_EVENT
:
5603 case GPM_CLICK_EVENT
:
5605 #ifndef USE_TOOLKIT_SCROLL_BARS
5606 case SCROLL_BAR_CLICK_EVENT
:
5609 int button
= event
->code
;
5611 Lisp_Object position
;
5612 Lisp_Object
*start_pos_ptr
;
5613 Lisp_Object start_pos
;
5617 /* Build the position as appropriate for this mouse click. */
5618 if (event
->kind
== MOUSE_CLICK_EVENT
5620 || event
->kind
== GPM_CLICK_EVENT
5624 struct frame
*f
= XFRAME (event
->frame_or_window
);
5627 /* Ignore mouse events that were made on frame that
5628 have been deleted. */
5629 if (! FRAME_LIVE_P (f
))
5632 /* EVENT->x and EVENT->y are frame-relative pixel
5633 coordinates at this place. Under old redisplay, COLUMN
5634 and ROW are set to frame relative glyph coordinates
5635 which are then used to determine whether this click is
5636 in a menu (non-toolkit version). */
5637 if (!toolkit_menubar_in_use (f
))
5639 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5640 &column
, &row
, NULL
, 1);
5642 /* In the non-toolkit version, clicks on the menu bar
5643 are ordinary button events in the event buffer.
5644 Distinguish them, and invoke the menu.
5646 (In the toolkit version, the toolkit handles the
5647 menu bar and Emacs doesn't know about it until
5648 after the user makes a selection.) */
5649 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5650 && (event
->modifiers
& down_modifier
))
5652 Lisp_Object items
, item
;
5654 /* Find the menu bar item under `column'. */
5656 items
= FRAME_MENU_BAR_ITEMS (f
);
5657 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5659 Lisp_Object pos
, string
;
5660 string
= AREF (items
, i
+ 1);
5661 pos
= AREF (items
, i
+ 3);
5664 if (column
>= XINT (pos
)
5665 && column
< XINT (pos
) + SCHARS (string
))
5667 item
= AREF (items
, i
);
5672 /* ELisp manual 2.4b says (x y) are window
5673 relative but code says they are
5675 position
= list4 (event
->frame_or_window
,
5677 Fcons (event
->x
, event
->y
),
5678 make_number (event
->timestamp
));
5680 return list2 (item
, position
);
5684 position
= make_lispy_position (f
, event
->x
, event
->y
,
5687 #ifndef USE_TOOLKIT_SCROLL_BARS
5690 /* It's a scrollbar click. */
5692 Lisp_Object portion_whole
;
5695 window
= event
->frame_or_window
;
5696 portion_whole
= Fcons (event
->x
, event
->y
);
5697 part
= *scroll_bar_parts
[(int) event
->part
];
5699 position
= list5 (window
, Qvertical_scroll_bar
,
5700 portion_whole
, make_number (event
->timestamp
),
5703 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5705 if (button
>= ASIZE (button_down_location
))
5707 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5708 button_down_location
= larger_vector (button_down_location
,
5710 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5713 start_pos_ptr
= aref_addr (button_down_location
, button
);
5714 start_pos
= *start_pos_ptr
;
5715 *start_pos_ptr
= Qnil
;
5718 /* On window-system frames, use the value of
5719 double-click-fuzz as is. On other frames, interpret it
5720 as a multiple of 1/8 characters. */
5724 if (WINDOWP (event
->frame_or_window
))
5725 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5726 else if (FRAMEP (event
->frame_or_window
))
5727 f
= XFRAME (event
->frame_or_window
);
5731 if (FRAME_WINDOW_P (f
))
5732 fuzz
= double_click_fuzz
;
5734 fuzz
= double_click_fuzz
/ 8;
5736 is_double
= (button
== last_mouse_button
5737 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5738 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5739 && button_down_time
!= 0
5740 && (EQ (Vdouble_click_time
, Qt
)
5741 || (NATNUMP (Vdouble_click_time
)
5742 && (event
->timestamp
- button_down_time
5743 < XFASTINT (Vdouble_click_time
)))));
5746 last_mouse_button
= button
;
5747 last_mouse_x
= XINT (event
->x
);
5748 last_mouse_y
= XINT (event
->y
);
5750 /* If this is a button press, squirrel away the location, so
5751 we can decide later whether it was a click or a drag. */
5752 if (event
->modifiers
& down_modifier
)
5756 double_click_count
++;
5757 event
->modifiers
|= ((double_click_count
> 2)
5762 double_click_count
= 1;
5763 button_down_time
= event
->timestamp
;
5764 *start_pos_ptr
= Fcopy_alist (position
);
5765 ignore_mouse_drag_p
= 0;
5768 /* Now we're releasing a button - check the co-ordinates to
5769 see if this was a click or a drag. */
5770 else if (event
->modifiers
& up_modifier
)
5772 /* If we did not see a down before this up, ignore the up.
5773 Probably this happened because the down event chose a
5774 menu item. It would be an annoyance to treat the
5775 release of the button that chose the menu item as a
5778 if (!CONSP (start_pos
))
5781 event
->modifiers
&= ~up_modifier
;
5784 Lisp_Object new_down
, down
;
5785 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5787 /* The third element of every position
5788 should be the (x,y) pair. */
5789 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5790 new_down
= Fcar (Fcdr (Fcdr (position
)));
5793 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5795 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5796 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5799 if (ignore_mouse_drag_p
)
5801 event
->modifiers
|= click_modifier
;
5802 ignore_mouse_drag_p
= 0;
5804 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5805 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5806 /* Maybe the mouse has moved a lot, caused scrolling, and
5807 eventually ended up at the same screen position (but
5808 not buffer position) in which case it is a drag, not
5810 /* FIXME: OTOH if the buffer position has changed
5811 because of a timer or process filter rather than
5812 because of mouse movement, it should be considered as
5813 a click. But mouse-drag-region completely ignores
5814 this case and it hasn't caused any real problem, so
5815 it's probably OK to ignore it as well. */
5816 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5817 /* Mouse hasn't moved (much). */
5818 event
->modifiers
|= click_modifier
;
5821 button_down_time
= 0;
5822 event
->modifiers
|= drag_modifier
;
5825 /* Don't check is_double; treat this as multiple
5826 if the down-event was multiple. */
5827 if (double_click_count
> 1)
5828 event
->modifiers
|= ((double_click_count
> 2)
5834 /* Every mouse event should either have the down_modifier or
5835 the up_modifier set. */
5839 /* Get the symbol we should use for the mouse click. */
5842 head
= modify_event_symbol (button
,
5844 Qmouse_click
, Vlispy_mouse_stem
,
5847 ASIZE (mouse_syms
));
5848 if (event
->modifiers
& drag_modifier
)
5849 return list3 (head
, start_pos
, position
);
5850 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5851 return list3 (head
, position
, make_number (double_click_count
));
5853 return list2 (head
, position
);
5858 case HORIZ_WHEEL_EVENT
:
5860 Lisp_Object position
;
5863 /* Build the position as appropriate for this mouse click. */
5864 struct frame
*f
= XFRAME (event
->frame_or_window
);
5866 /* Ignore wheel events that were made on frame that have been
5868 if (! FRAME_LIVE_P (f
))
5871 position
= make_lispy_position (f
, event
->x
, event
->y
,
5874 /* Set double or triple modifiers to indicate the wheel speed. */
5876 /* On window-system frames, use the value of
5877 double-click-fuzz as is. On other frames, interpret it
5878 as a multiple of 1/8 characters. */
5884 if (WINDOWP (event
->frame_or_window
))
5885 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5886 else if (FRAMEP (event
->frame_or_window
))
5887 fr
= XFRAME (event
->frame_or_window
);
5891 fuzz
= FRAME_WINDOW_P (fr
)
5892 ? double_click_fuzz
: double_click_fuzz
/ 8;
5894 if (event
->modifiers
& up_modifier
)
5896 /* Emit a wheel-up event. */
5897 event
->modifiers
&= ~up_modifier
;
5900 else if (event
->modifiers
& down_modifier
)
5902 /* Emit a wheel-down event. */
5903 event
->modifiers
&= ~down_modifier
;
5907 /* Every wheel event should either have the down_modifier or
5908 the up_modifier set. */
5911 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5914 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5915 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5916 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5917 && button_down_time
!= 0
5918 && (EQ (Vdouble_click_time
, Qt
)
5919 || (NATNUMP (Vdouble_click_time
)
5920 && (event
->timestamp
- button_down_time
5921 < XFASTINT (Vdouble_click_time
)))));
5924 double_click_count
++;
5925 event
->modifiers
|= ((double_click_count
> 2)
5931 double_click_count
= 1;
5932 event
->modifiers
|= click_modifier
;
5935 button_down_time
= event
->timestamp
;
5936 /* Use a negative value to distinguish wheel from mouse button. */
5937 last_mouse_button
= - (1 + symbol_num
);
5938 last_mouse_x
= XINT (event
->x
);
5939 last_mouse_y
= XINT (event
->y
);
5941 /* Get the symbol we should use for the wheel event. */
5942 head
= modify_event_symbol (symbol_num
,
5948 ASIZE (wheel_syms
));
5951 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5952 return list3 (head
, position
, make_number (double_click_count
));
5954 return list2 (head
, position
);
5958 #ifdef USE_TOOLKIT_SCROLL_BARS
5960 /* We don't have down and up events if using toolkit scroll bars,
5961 so make this always a click event. Store in the `part' of
5962 the Lisp event a symbol which maps to the following actions:
5964 `above_handle' page up
5965 `below_handle' page down
5969 `bottom' bottom of buffer
5970 `handle' thumb has been dragged.
5971 `end-scroll' end of interaction with scroll bar
5973 The incoming input_event contains in its `part' member an
5974 index of type `enum scroll_bar_part' which we can use as an
5975 index in scroll_bar_parts to get the appropriate symbol. */
5977 case SCROLL_BAR_CLICK_EVENT
:
5979 Lisp_Object position
, head
, window
, portion_whole
, part
;
5981 window
= event
->frame_or_window
;
5982 portion_whole
= Fcons (event
->x
, event
->y
);
5983 part
= *scroll_bar_parts
[(int) event
->part
];
5985 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5986 make_number (event
->timestamp
), part
);
5988 /* Always treat scroll bar events as clicks. */
5989 event
->modifiers
|= click_modifier
;
5990 event
->modifiers
&= ~up_modifier
;
5992 if (event
->code
>= ASIZE (mouse_syms
))
5993 mouse_syms
= larger_vector (mouse_syms
,
5994 event
->code
- ASIZE (mouse_syms
) + 1,
5997 /* Get the symbol we should use for the mouse click. */
5998 head
= modify_event_symbol (event
->code
,
6003 ASIZE (mouse_syms
));
6004 return list2 (head
, position
);
6007 #endif /* USE_TOOLKIT_SCROLL_BARS */
6009 case DRAG_N_DROP_EVENT
:
6012 Lisp_Object head
, position
;
6015 f
= XFRAME (event
->frame_or_window
);
6018 /* Ignore mouse events that were made on frames that
6019 have been deleted. */
6020 if (! FRAME_LIVE_P (f
))
6023 position
= make_lispy_position (f
, event
->x
, event
->y
,
6026 head
= modify_event_symbol (0, event
->modifiers
,
6028 lispy_drag_n_drop_names
,
6029 &drag_n_drop_syms
, 1);
6030 return list3 (head
, position
, files
);
6033 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6034 || defined (HAVE_NS) || defined (USE_GTK)
6035 case MENU_BAR_EVENT
:
6036 if (EQ (event
->arg
, event
->frame_or_window
))
6037 /* This is the prefix key. We translate this to
6038 `(menu_bar)' because the code in keyboard.c for menu
6039 events, which we use, relies on this. */
6040 return list1 (Qmenu_bar
);
6044 case SELECT_WINDOW_EVENT
:
6045 /* Make an event (select-window (WINDOW)). */
6046 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6048 case TOOL_BAR_EVENT
:
6049 if (EQ (event
->arg
, event
->frame_or_window
))
6050 /* This is the prefix key. We translate this to
6051 `(tool_bar)' because the code in keyboard.c for tool bar
6052 events, which we use, relies on this. */
6053 return list1 (Qtool_bar
);
6054 else if (SYMBOLP (event
->arg
))
6055 return apply_modifiers (event
->modifiers
, event
->arg
);
6058 case USER_SIGNAL_EVENT
:
6059 /* A user signal. */
6061 char *name
= find_user_signal_name (event
->code
);
6064 return intern (name
);
6067 case SAVE_SESSION_EVENT
:
6068 return Qsave_session
;
6073 return Fcons (Qdbus_event
, event
->arg
);
6075 #endif /* HAVE_DBUS */
6077 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6078 case FILE_NOTIFY_EVENT
:
6080 return Fcons (Qfile_notify
, event
->arg
);
6082 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6084 case CONFIG_CHANGED_EVENT
:
6085 return list3 (Qconfig_changed_event
,
6086 event
->arg
, event
->frame_or_window
);
6088 /* The 'kind' field of the event is something we don't recognize. */
6095 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6096 Lisp_Object x
, Lisp_Object y
, Time t
)
6098 /* Is it a scroll bar movement? */
6099 if (frame
&& ! NILP (bar_window
))
6101 Lisp_Object part_sym
;
6103 part_sym
= *scroll_bar_parts
[(int) part
];
6104 return list2 (Qscroll_bar_movement
,
6106 Qvertical_scroll_bar
,
6111 /* Or is it an ordinary mouse movement? */
6114 Lisp_Object position
;
6115 position
= make_lispy_position (frame
, x
, y
, t
);
6116 return list2 (Qmouse_movement
, position
);
6120 /* Construct a switch frame event. */
6122 make_lispy_switch_frame (Lisp_Object frame
)
6124 return list2 (Qswitch_frame
, frame
);
6128 make_lispy_focus_in (Lisp_Object frame
)
6130 return list2 (Qfocus_in
, frame
);
6133 #ifdef HAVE_WINDOW_SYSTEM
6136 make_lispy_focus_out (Lisp_Object frame
)
6138 return list2 (Qfocus_out
, frame
);
6141 #endif /* HAVE_WINDOW_SYSTEM */
6143 /* Manipulating modifiers. */
6145 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6147 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6148 SYMBOL's name of the end of the modifiers; the string from this
6149 position is the unmodified symbol name.
6151 This doesn't use any caches. */
6154 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6160 CHECK_SYMBOL (symbol
);
6163 name
= SYMBOL_NAME (symbol
);
6165 for (i
= 0; i
< SBYTES (name
) - 1; )
6167 ptrdiff_t this_mod_end
= 0;
6170 /* See if the name continues with a modifier word.
6171 Check that the word appears, but don't check what follows it.
6172 Set this_mod and this_mod_end to record what we find. */
6174 switch (SREF (name
, i
))
6176 #define SINGLE_LETTER_MOD(BIT) \
6177 (this_mod_end = i + 1, this_mod = BIT)
6180 SINGLE_LETTER_MOD (alt_modifier
);
6184 SINGLE_LETTER_MOD (ctrl_modifier
);
6188 SINGLE_LETTER_MOD (hyper_modifier
);
6192 SINGLE_LETTER_MOD (meta_modifier
);
6196 SINGLE_LETTER_MOD (shift_modifier
);
6200 SINGLE_LETTER_MOD (super_modifier
);
6203 #undef SINGLE_LETTER_MOD
6205 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6206 if (i + LEN + 1 <= SBYTES (name) \
6207 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6209 this_mod_end = i + LEN; \
6214 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6215 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6216 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6220 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6222 #undef MULTI_LETTER_MOD
6226 /* If we found no modifier, stop looking for them. */
6227 if (this_mod_end
== 0)
6230 /* Check there is a dash after the modifier, so that it
6231 really is a modifier. */
6232 if (this_mod_end
>= SBYTES (name
)
6233 || SREF (name
, this_mod_end
) != '-')
6236 /* This modifier is real; look for another. */
6237 modifiers
|= this_mod
;
6238 i
= this_mod_end
+ 1;
6241 /* Should we include the `click' modifier? */
6242 if (! (modifiers
& (down_modifier
| drag_modifier
6243 | double_modifier
| triple_modifier
))
6244 && i
+ 7 == SBYTES (name
)
6245 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6246 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6247 modifiers
|= click_modifier
;
6249 if (! (modifiers
& (double_modifier
| triple_modifier
))
6250 && i
+ 6 < SBYTES (name
)
6251 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6252 modifiers
|= click_modifier
;
6260 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6261 prepended to the string BASE[0..BASE_LEN-1].
6262 This doesn't use any caches. */
6264 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6266 /* Since BASE could contain nulls, we can't use intern here; we have
6267 to use Fintern, which expects a genuine Lisp_String, and keeps a
6269 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6275 /* Only the event queue may use the `up' modifier; it should always
6276 be turned into a click or drag event before presented to lisp code. */
6277 if (modifiers
& up_modifier
)
6280 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6281 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6282 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6283 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6284 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6285 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6286 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6287 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6288 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6289 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6290 /* The click modifier is denoted by the absence of other modifiers. */
6294 mod_len
= p
- new_mods
;
6298 Lisp_Object new_name
;
6300 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6301 mod_len
+ base_len_byte
);
6302 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6303 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6305 return Fintern (new_name
, Qnil
);
6310 static const char *const modifier_names
[] =
6312 "up", "down", "drag", "click", "double", "triple", 0, 0,
6313 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6314 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6316 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6318 static Lisp_Object modifier_symbols
;
6320 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6322 lispy_modifier_list (int modifiers
)
6324 Lisp_Object modifier_list
;
6327 modifier_list
= Qnil
;
6328 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6329 if (modifiers
& (1<<i
))
6330 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6333 return modifier_list
;
6337 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6338 where UNMODIFIED is the unmodified form of SYMBOL,
6339 MASK is the set of modifiers present in SYMBOL's name.
6340 This is similar to parse_modifiers_uncached, but uses the cache in
6341 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6342 Qevent_symbol_elements property. */
6344 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6347 parse_modifiers (Lisp_Object symbol
)
6349 Lisp_Object elements
;
6351 if (INTEGERP (symbol
))
6352 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6353 else if (!SYMBOLP (symbol
))
6356 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6357 if (CONSP (elements
))
6362 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6363 Lisp_Object unmodified
;
6366 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6367 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6370 if (modifiers
& ~INTMASK
)
6372 XSETFASTINT (mask
, modifiers
);
6373 elements
= list2 (unmodified
, mask
);
6375 /* Cache the parsing results on SYMBOL. */
6376 Fput (symbol
, Qevent_symbol_element_mask
,
6378 Fput (symbol
, Qevent_symbol_elements
,
6379 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6381 /* Since we know that SYMBOL is modifiers applied to unmodified,
6382 it would be nice to put that in unmodified's cache.
6383 But we can't, since we're not sure that parse_modifiers is
6390 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6391 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6392 doc
: /* Parse the event symbol. For internal use. */)
6393 (Lisp_Object symbol
)
6395 /* Fill the cache if needed. */
6396 parse_modifiers (symbol
);
6397 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6398 and use the Lispier representation stored on Qevent_symbol_elements
6400 return Fget (symbol
, Qevent_symbol_elements
);
6403 /* Apply the modifiers MODIFIERS to the symbol BASE.
6404 BASE must be unmodified.
6406 This is like apply_modifiers_uncached, but uses BASE's
6407 Qmodifier_cache property, if present. It also builds
6408 Qevent_symbol_elements properties, since it has that info anyway.
6410 apply_modifiers copies the value of BASE's Qevent_kind property to
6411 the modified symbol. */
6413 apply_modifiers (int modifiers
, Lisp_Object base
)
6415 Lisp_Object cache
, idx
, entry
, new_symbol
;
6417 /* Mask out upper bits. We don't know where this value's been. */
6418 modifiers
&= INTMASK
;
6420 if (INTEGERP (base
))
6421 return make_number (XINT (base
) | modifiers
);
6423 /* The click modifier never figures into cache indices. */
6424 cache
= Fget (base
, Qmodifier_cache
);
6425 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6426 entry
= assq_no_quit (idx
, cache
);
6429 new_symbol
= XCDR (entry
);
6432 /* We have to create the symbol ourselves. */
6433 new_symbol
= apply_modifiers_uncached (modifiers
,
6434 SSDATA (SYMBOL_NAME (base
)),
6435 SCHARS (SYMBOL_NAME (base
)),
6436 SBYTES (SYMBOL_NAME (base
)));
6438 /* Add the new symbol to the base's cache. */
6439 entry
= Fcons (idx
, new_symbol
);
6440 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6442 /* We have the parsing info now for free, so we could add it to
6444 XSETFASTINT (idx, modifiers);
6445 Fput (new_symbol, Qevent_symbol_element_mask,
6447 Fput (new_symbol, Qevent_symbol_elements,
6448 Fcons (base, lispy_modifier_list (modifiers)));
6449 Sadly, this is only correct if `base' is indeed a base event,
6450 which is not necessarily the case. -stef */
6453 /* Make sure this symbol is of the same kind as BASE.
6455 You'd think we could just set this once and for all when we
6456 intern the symbol above, but reorder_modifiers may call us when
6457 BASE's property isn't set right; we can't assume that just
6458 because it has a Qmodifier_cache property it must have its
6459 Qevent_kind set right as well. */
6460 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6464 kind
= Fget (base
, Qevent_kind
);
6466 Fput (new_symbol
, Qevent_kind
, kind
);
6473 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6474 return a symbol with the modifiers placed in the canonical order.
6475 Canonical order is alphabetical, except for down and drag, which
6476 always come last. The 'click' modifier is never written out.
6478 Fdefine_key calls this to make sure that (for example) C-M-foo
6479 and M-C-foo end up being equivalent in the keymap. */
6482 reorder_modifiers (Lisp_Object symbol
)
6484 /* It's hopefully okay to write the code this way, since everything
6485 will soon be in caches, and no consing will be done at all. */
6488 parsed
= parse_modifiers (symbol
);
6489 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6494 /* For handling events, we often want to produce a symbol whose name
6495 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6496 to some base, like the name of a function key or mouse button.
6497 modify_event_symbol produces symbols of this sort.
6499 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6500 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6503 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6504 into symbol names, or a string specifying a name stem used to
6505 construct a symbol name or the form `STEM-N', where N is the decimal
6506 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6507 non-nil; otherwise NAME_TABLE is used.
6509 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6510 persist between calls to modify_event_symbol that it can use to
6511 store a cache of the symbols it's generated for this NAME_TABLE
6512 before. The object stored there may be a vector or an alist.
6514 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6516 MODIFIERS is a set of modifier bits (as given in struct input_events)
6517 whose prefixes should be applied to the symbol name.
6519 SYMBOL_KIND is the value to be placed in the event_kind property of
6520 the returned symbol.
6522 The symbols we create are supposed to have an
6523 `event-symbol-elements' property, which lists the modifiers present
6524 in the symbol's name. */
6527 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6528 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6529 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6532 Lisp_Object symbol_int
;
6534 /* Get rid of the "vendor-specific" bit here. */
6535 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6537 /* Is this a request for a valid symbol? */
6538 if (symbol_num
< 0 || symbol_num
>= table_size
)
6541 if (CONSP (*symbol_table
))
6542 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6544 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6545 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6546 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6547 we've never used that symbol before. */
6550 if (! VECTORP (*symbol_table
)
6551 || ASIZE (*symbol_table
) != table_size
)
6555 XSETFASTINT (size
, table_size
);
6556 *symbol_table
= Fmake_vector (size
, Qnil
);
6559 value
= AREF (*symbol_table
, symbol_num
);
6562 /* Have we already used this symbol before? */
6565 /* No; let's create it. */
6566 if (CONSP (name_alist_or_stem
))
6567 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6568 else if (STRINGP (name_alist_or_stem
))
6571 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6572 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6574 buf
= SAFE_ALLOCA (len
);
6575 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6576 XINT (symbol_int
) + 1);
6577 value
= intern (buf
);
6580 else if (name_table
!= 0 && name_table
[symbol_num
])
6581 value
= intern (name_table
[symbol_num
]);
6583 #ifdef HAVE_WINDOW_SYSTEM
6586 char *name
= x_get_keysym_name (symbol_num
);
6588 value
= intern (name
);
6594 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6595 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6596 value
= intern (buf
);
6599 if (CONSP (*symbol_table
))
6600 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6602 ASET (*symbol_table
, symbol_num
, value
);
6604 /* Fill in the cache entries for this symbol; this also
6605 builds the Qevent_symbol_elements property, which the user
6607 apply_modifiers (modifiers
& click_modifier
, value
);
6608 Fput (value
, Qevent_kind
, symbol_kind
);
6611 /* Apply modifiers to that symbol. */
6612 return apply_modifiers (modifiers
, value
);
6615 /* Convert a list that represents an event type,
6616 such as (ctrl meta backspace), into the usual representation of that
6617 event type as a number or a symbol. */
6619 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6620 doc
: /* Convert the event description list EVENT-DESC to an event type.
6621 EVENT-DESC should contain one base event type (a character or symbol)
6622 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6623 drag, down, double or triple). The base must be last.
6624 The return value is an event type (a character or symbol) which
6625 has the same base event type and all the specified modifiers. */)
6626 (Lisp_Object event_desc
)
6634 while (CONSP (rest
))
6642 /* Given a symbol, see if it is a modifier name. */
6643 if (SYMBOLP (elt
) && CONSP (rest
))
6644 this = parse_solitary_modifier (elt
);
6648 else if (!NILP (base
))
6649 error ("Two bases given in one event");
6655 /* Let the symbol A refer to the character A. */
6656 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6657 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6659 if (INTEGERP (base
))
6661 /* Turn (shift a) into A. */
6662 if ((modifiers
& shift_modifier
) != 0
6663 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6665 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6666 modifiers
&= ~shift_modifier
;
6669 /* Turn (control a) into C-a. */
6670 if (modifiers
& ctrl_modifier
)
6671 return make_number ((modifiers
& ~ctrl_modifier
)
6672 | make_ctrl_char (XINT (base
)));
6674 return make_number (modifiers
| XINT (base
));
6676 else if (SYMBOLP (base
))
6677 return apply_modifiers (modifiers
, base
);
6679 error ("Invalid base event");
6682 /* Try to recognize SYMBOL as a modifier name.
6683 Return the modifier flag bit, or 0 if not recognized. */
6686 parse_solitary_modifier (Lisp_Object symbol
)
6688 Lisp_Object name
= SYMBOL_NAME (symbol
);
6690 switch (SREF (name
, 0))
6692 #define SINGLE_LETTER_MOD(BIT) \
6693 if (SBYTES (name) == 1) \
6696 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6697 if (LEN == SBYTES (name) \
6698 && ! memcmp (SDATA (name), NAME, LEN)) \
6702 SINGLE_LETTER_MOD (alt_modifier
);
6706 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6710 SINGLE_LETTER_MOD (ctrl_modifier
);
6714 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6715 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6719 SINGLE_LETTER_MOD (hyper_modifier
);
6723 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6727 SINGLE_LETTER_MOD (meta_modifier
);
6731 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6735 SINGLE_LETTER_MOD (shift_modifier
);
6739 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6740 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6741 SINGLE_LETTER_MOD (super_modifier
);
6745 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6746 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6747 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6751 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6754 #undef SINGLE_LETTER_MOD
6755 #undef MULTI_LETTER_MOD
6761 /* Return true if EVENT is a list whose elements are all integers or symbols.
6762 Such a list is not valid as an event,
6763 but it can be a Lucid-style event type list. */
6766 lucid_event_type_list_p (Lisp_Object object
)
6770 if (! CONSP (object
))
6773 if (EQ (XCAR (object
), Qhelp_echo
)
6774 || EQ (XCAR (object
), Qvertical_line
)
6775 || EQ (XCAR (object
), Qmode_line
)
6776 || EQ (XCAR (object
), Qheader_line
))
6779 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6783 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6790 /* Return true if terminal input chars are available.
6791 Also, store the return value into INPUT_PENDING.
6793 Serves the purpose of ioctl (0, FIONREAD, ...)
6794 but works even if FIONREAD does not exist.
6795 (In fact, this may actually read some input.)
6797 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6798 timer events that are ripe.
6799 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6800 events (FOCUS_IN_EVENT).
6801 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6802 movements and toolkit scroll bar thumb drags. */
6805 get_input_pending (int flags
)
6807 /* First of all, have we already counted some input? */
6808 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6810 /* If input is being read as it arrives, and we have none, there is none. */
6811 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6813 /* Try to read some input and see how much we get. */
6815 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6818 return input_pending
;
6821 /* Put a BUFFER_SWITCH_EVENT in the buffer
6822 so that read_key_sequence will notice the new current buffer. */
6825 record_asynch_buffer_change (void)
6827 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6828 The purpose of the event is to make read_key_sequence look up the
6829 keymaps again. If we aren't in read_key_sequence, we don't need one,
6830 and the event could cause trouble by messing up (input-pending-p).
6831 Note: Fwaiting_for_user_input_p always returns nil when async
6832 subprocesses aren't supported. */
6833 if (!NILP (Fwaiting_for_user_input_p ()))
6835 struct input_event event
;
6838 event
.kind
= BUFFER_SWITCH_EVENT
;
6839 event
.frame_or_window
= Qnil
;
6842 /* Make sure no interrupt happens while storing the event. */
6844 if (interrupt_input
)
6845 kbd_buffer_store_event (&event
);
6850 kbd_buffer_store_event (&event
);
6856 /* Read any terminal input already buffered up by the system
6857 into the kbd_buffer, but do not wait.
6859 Return the number of keyboard chars read, or -1 meaning
6860 this is a bad time to try to read input. */
6869 /* Store pending user signal events, if any. */
6870 store_user_signal_events ();
6872 /* Loop through the available terminals, and call their input hooks. */
6876 struct terminal
*next
= t
->next_terminal
;
6878 if (t
->read_socket_hook
)
6881 struct input_event hold_quit
;
6883 if (input_blocked_p ())
6885 pending_signals
= 1;
6889 EVENT_INIT (hold_quit
);
6890 hold_quit
.kind
= NO_EVENT
;
6892 /* No need for FIONREAD or fcntl; just say don't wait. */
6893 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6896 if (nr
== -1) /* Not OK to read input now. */
6900 else if (nr
== -2) /* Non-transient error. */
6902 /* The terminal device terminated; it should be closed. */
6904 /* Kill Emacs if this was our last terminal. */
6905 if (!terminal_list
->next_terminal
)
6906 /* Formerly simply reported no input, but that
6907 sometimes led to a failure of Emacs to terminate.
6908 SIGHUP seems appropriate if we can't reach the
6910 /* ??? Is it really right to send the signal just to
6911 this process rather than to the whole process
6912 group? Perhaps on systems with FIONREAD Emacs is
6913 alone in its group. */
6914 terminate_due_to_signal (SIGHUP
, 10);
6916 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6919 XSETTERMINAL (tmp
, t
);
6920 Fdelete_terminal (tmp
, Qnoelisp
);
6924 /* If there was no error, make sure the pointer
6925 is visible for all frames on this terminal. */
6928 Lisp_Object tail
, frame
;
6930 FOR_EACH_FRAME (tail
, frame
)
6932 struct frame
*f
= XFRAME (frame
);
6933 if (FRAME_TERMINAL (f
) == t
)
6934 frame_make_pointer_visible (f
);
6938 if (hold_quit
.kind
!= NO_EVENT
)
6939 kbd_buffer_store_event (&hold_quit
);
6951 /* This is the tty way of reading available input.
6953 Note that each terminal device has its own `struct terminal' object,
6954 and so this function is called once for each individual termcap
6955 terminal. The first parameter indicates which terminal to read from. */
6958 tty_read_avail_input (struct terminal
*terminal
,
6959 struct input_event
*hold_quit
)
6961 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6962 the kbd_buffer can really hold. That may prevent loss
6963 of characters on some systems when input is stuffed at us. */
6964 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6966 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6969 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6971 if (kbd_on_hold_p () || buffer_free
<= 0)
6973 #endif /* subprocesses */
6975 if (!terminal
->name
) /* Don't read from a dead terminal. */
6978 if (terminal
->type
!= output_termcap
6979 && terminal
->type
!= output_msdos_raw
)
6982 /* XXX I think the following code should be moved to separate hook
6983 functions in system-dependent files. */
6985 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6986 code sets read_socket_hook to w32_console_read_socket instead! */
6988 #else /* not WINDOWSNT */
6989 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6993 return 0; /* The terminal is suspended. */
6996 n_to_read
= dos_keysns ();
7000 cbuf
[0] = dos_keyread ();
7003 #else /* not MSDOS */
7008 struct input_event gpm_hold_quit
;
7009 int gpm
, fd
= gpm_fd
;
7011 EVENT_INIT (gpm_hold_quit
);
7012 gpm_hold_quit
.kind
= NO_EVENT
;
7014 /* gpm==1 if event received.
7015 gpm==0 if the GPM daemon has closed the connection, in which case
7016 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7017 we save it in `fd' so close_gpm can remove it from the
7019 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7020 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7021 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7024 /* Presumably the GPM daemon has closed the connection. */
7026 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7027 kbd_buffer_store_event (&gpm_hold_quit
);
7031 #endif /* HAVE_GPM */
7033 /* Determine how many characters we should *try* to read. */
7034 #ifdef USABLE_FIONREAD
7035 /* Find out how much input is available. */
7036 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7038 if (! noninteractive
)
7039 return -2; /* Close this terminal. */
7045 if (n_to_read
> sizeof cbuf
)
7046 n_to_read
= sizeof cbuf
;
7047 #elif defined USG || defined CYGWIN
7048 /* Read some input if available, but don't wait. */
7049 n_to_read
= sizeof cbuf
;
7050 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7052 # error "Cannot read without possibly delaying"
7056 /* Don't read more than we can store. */
7057 if (n_to_read
> buffer_free
)
7058 n_to_read
= buffer_free
;
7059 #endif /* subprocesses */
7061 /* Now read; for one reason or another, this will not block.
7062 NREAD is set to the number of chars read. */
7065 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7066 /* POSIX infers that processes which are not in the session leader's
7067 process group won't get SIGHUPs at logout time. BSDI adheres to
7068 this part standard and returns -1 from read (0) with errno==EIO
7069 when the control tty is taken away.
7070 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7071 if (nread
== -1 && errno
== EIO
)
7072 return -2; /* Close this terminal. */
7073 #if defined (AIX) && defined (_BSD)
7074 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7075 This looks incorrect, but it isn't, because _BSD causes
7076 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7077 and that causes a value other than 0 when there is no input. */
7079 return -2; /* Close this terminal. */
7083 /* We used to retry the read if it was interrupted.
7084 But this does the wrong thing when O_NONBLOCK causes
7085 an EAGAIN error. Does anybody know of a situation
7086 where a retry is actually needed? */
7088 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7098 #ifndef USABLE_FIONREAD
7099 #if defined (USG) || defined (CYGWIN)
7100 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7101 #endif /* USG or CYGWIN */
7102 #endif /* no FIONREAD */
7107 #endif /* not MSDOS */
7108 #endif /* not WINDOWSNT */
7110 for (i
= 0; i
< nread
; i
++)
7112 struct input_event buf
;
7114 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7116 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7117 buf
.modifiers
= meta_modifier
;
7118 if (tty
->meta_key
!= 2)
7122 /* Set the frame corresponding to the active tty. Note that the
7123 value of selected_frame is not reliable here, redisplay tends
7124 to temporarily change it. */
7125 buf
.frame_or_window
= tty
->top_frame
;
7128 kbd_buffer_store_event (&buf
);
7129 /* Don't look at input that follows a C-g too closely.
7130 This reduces lossage due to autorepeat on C-g. */
7131 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7132 && buf
.code
== quit_char
)
7140 handle_async_input (void)
7145 int nread
= gobble_input ();
7146 /* -1 means it's not ok to read the input now.
7147 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7148 0 means there was no keyboard input available. */
7156 process_pending_signals (void)
7158 pending_signals
= 0;
7159 handle_async_input ();
7160 do_pending_atimers ();
7163 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7164 and reinvoke any pending signal if the level is now 0 and
7165 a fatal error is not already in progress. */
7168 unblock_input_to (int level
)
7170 interrupt_input_blocked
= level
;
7173 if (pending_signals
&& !fatal_error_in_progress
)
7174 process_pending_signals ();
7180 /* End critical section.
7182 If doing signal-driven input, and a signal came in when input was
7183 blocked, reinvoke the signal handler now to deal with it.
7185 It will also process queued input, if it was not read before.
7186 When a longer code sequence does not use block/unblock input
7187 at all, the whole input gathered up to the next call to
7188 unblock_input will be processed inside that call. */
7191 unblock_input (void)
7193 unblock_input_to (interrupt_input_blocked
- 1);
7196 /* Undo any number of BLOCK_INPUT calls,
7197 and also reinvoke any pending signal. */
7200 totally_unblock_input (void)
7202 unblock_input_to (0);
7208 handle_input_available_signal (int sig
)
7210 pending_signals
= 1;
7212 if (input_available_clear_time
)
7213 *input_available_clear_time
= make_timespec (0, 0);
7217 deliver_input_available_signal (int sig
)
7219 deliver_process_signal (sig
, handle_input_available_signal
);
7221 #endif /* USABLE_SIGIO */
7224 /* User signal events. */
7226 struct user_signal_info
7228 /* Signal number. */
7231 /* Name of the signal. */
7234 /* Number of pending signals. */
7237 struct user_signal_info
*next
;
7240 /* List of user signals. */
7241 static struct user_signal_info
*user_signals
= NULL
;
7244 add_user_signal (int sig
, const char *name
)
7246 struct sigaction action
;
7247 struct user_signal_info
*p
;
7249 for (p
= user_signals
; p
; p
= p
->next
)
7251 /* Already added. */
7254 p
= xmalloc (sizeof *p
);
7256 p
->name
= xstrdup (name
);
7258 p
->next
= user_signals
;
7261 emacs_sigaction_init (&action
, deliver_user_signal
);
7262 sigaction (sig
, &action
, 0);
7266 handle_user_signal (int sig
)
7268 struct user_signal_info
*p
;
7269 const char *special_event_name
= NULL
;
7271 if (SYMBOLP (Vdebug_on_event
))
7272 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7274 for (p
= user_signals
; p
; p
= p
->next
)
7277 if (special_event_name
7278 && strcmp (special_event_name
, p
->name
) == 0)
7280 /* Enter the debugger in many ways. */
7281 debug_on_next_call
= 1;
7284 Vinhibit_quit
= Qnil
;
7286 /* Eat the event. */
7292 if (interrupt_input
)
7293 handle_input_available_signal (sig
);
7297 /* Tell wait_reading_process_output that it needs to wake
7298 up and look around. */
7299 if (input_available_clear_time
)
7300 *input_available_clear_time
= make_timespec (0, 0);
7307 deliver_user_signal (int sig
)
7309 deliver_process_signal (sig
, handle_user_signal
);
7313 find_user_signal_name (int sig
)
7315 struct user_signal_info
*p
;
7317 for (p
= user_signals
; p
; p
= p
->next
)
7325 store_user_signal_events (void)
7327 struct user_signal_info
*p
;
7328 struct input_event buf
;
7329 bool buf_initialized
= 0;
7331 for (p
= user_signals
; p
; p
= p
->next
)
7332 if (p
->npending
> 0)
7334 if (! buf_initialized
)
7336 memset (&buf
, 0, sizeof buf
);
7337 buf
.kind
= USER_SIGNAL_EVENT
;
7338 buf
.frame_or_window
= selected_frame
;
7339 buf_initialized
= 1;
7345 kbd_buffer_store_event (&buf
);
7348 while (p
->npending
> 0);
7353 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7354 static Lisp_Object menu_bar_one_keymap_changed_items
;
7356 /* These variables hold the vector under construction within
7357 menu_bar_items and its subroutines, and the current index
7358 for storing into that vector. */
7359 static Lisp_Object menu_bar_items_vector
;
7360 static int menu_bar_items_index
;
7363 static const char *separator_names
[] = {
7368 "single-dashed-line",
7369 "double-dashed-line",
7371 "shadow-etched-out",
7372 "shadow-etched-in-dash",
7373 "shadow-etched-out-dash",
7374 "shadow-double-etched-in",
7375 "shadow-double-etched-out",
7376 "shadow-double-etched-in-dash",
7377 "shadow-double-etched-out-dash",
7381 /* Return true if LABEL specifies a separator. */
7384 menu_separator_name_p (const char *label
)
7388 else if (strlen (label
) > 3
7389 && memcmp (label
, "--", 2) == 0
7394 for (i
= 0; separator_names
[i
]; ++i
)
7395 if (strcmp (label
, separator_names
[i
]) == 0)
7400 /* It's a separator if it contains only dashes. */
7401 while (*label
== '-')
7403 return (*label
== 0);
7410 /* Return a vector of menu items for a menu bar, appropriate
7411 to the current buffer. Each item has three elements in the vector:
7414 OLD is an old vector we can optionally reuse, or nil. */
7417 menu_bar_items (Lisp_Object old
)
7419 /* The number of keymaps we're scanning right now, and the number of
7420 keymaps we have allocated space for. */
7423 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7424 in the current keymaps, or nil where it is not a prefix. */
7427 Lisp_Object def
, tail
;
7432 /* In order to build the menus, we need to call the keymap
7433 accessors. They all call QUIT. But this function is called
7434 during redisplay, during which a quit is fatal. So inhibit
7435 quitting while building the menus.
7436 We do this instead of specbind because (1) errors will clear it anyway
7437 and (2) this avoids risk of specpdl overflow. */
7438 oquit
= Vinhibit_quit
;
7442 menu_bar_items_vector
= old
;
7444 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7445 menu_bar_items_index
= 0;
7447 /* Build our list of keymaps.
7448 If we recognize a function key and replace its escape sequence in
7449 keybuf with its symbol, or if the sequence starts with a mouse
7450 click and we need to switch buffers, we jump back here to rebuild
7451 the initial keymaps from the current buffer. */
7455 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7456 if (!NILP (Voverriding_local_map_menu_flag
)
7457 && !NILP (Voverriding_local_map
))
7459 /* Yes, use them (if non-nil) as well as the global map. */
7460 maps
= alloca (3 * sizeof (maps
[0]));
7462 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7463 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7464 if (!NILP (Voverriding_local_map
))
7465 maps
[nmaps
++] = Voverriding_local_map
;
7469 /* No, so use major and minor mode keymaps and keymap property.
7470 Note that menu-bar bindings in the local-map and keymap
7471 properties may not work reliable, as they are only
7472 recognized when the menu-bar (or mode-line) is updated,
7473 which does not normally happen after every command. */
7476 nminor
= current_minor_maps (NULL
, &tmaps
);
7477 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7479 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7480 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7481 maps
[nmaps
++] = tem
;
7482 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7483 maps
[nmaps
++] = tem
;
7484 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7486 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7488 maps
[nmaps
++] = current_global_map
;
7491 /* Look up in each map the dummy prefix key `menu-bar'. */
7493 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7494 if (!NILP (maps
[mapno
]))
7496 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7500 menu_bar_one_keymap_changed_items
= Qnil
;
7501 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7505 /* Move to the end those items that should be at the end. */
7507 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7510 int end
= menu_bar_items_index
;
7512 for (i
= 0; i
< end
; i
+= 4)
7513 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7515 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7516 /* Move the item at index I to the end,
7517 shifting all the others forward. */
7518 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7519 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7520 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7521 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7523 memmove (aref_addr (menu_bar_items_vector
, i
),
7524 aref_addr (menu_bar_items_vector
, i
+ 4),
7525 (end
- i
- 4) * word_size
);
7526 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7527 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7528 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7529 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7534 /* Add nil, nil, nil, nil at the end. */
7536 int i
= menu_bar_items_index
;
7537 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7538 menu_bar_items_vector
7539 = larger_vector (menu_bar_items_vector
, 4, -1);
7540 /* Add this item. */
7541 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7542 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7543 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7544 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7545 menu_bar_items_index
= i
;
7548 Vinhibit_quit
= oquit
;
7549 return menu_bar_items_vector
;
7552 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7553 If there's already an item for KEY, add this DEF to it. */
7555 Lisp_Object item_properties
;
7558 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7560 struct gcpro gcpro1
;
7565 if (EQ (item
, Qundefined
))
7567 /* If a map has an explicit `undefined' as definition,
7568 discard any previously made menu bar item. */
7570 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7571 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7573 if (menu_bar_items_index
> i
+ 4)
7574 memmove (aref_addr (menu_bar_items_vector
, i
),
7575 aref_addr (menu_bar_items_vector
, i
+ 4),
7576 (menu_bar_items_index
- i
- 4) * word_size
);
7577 menu_bar_items_index
-= 4;
7581 /* If this keymap has already contributed to this KEY,
7582 don't contribute to it a second time. */
7583 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7584 if (!NILP (tem
) || NILP (item
))
7587 menu_bar_one_keymap_changed_items
7588 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7590 /* We add to menu_bar_one_keymap_changed_items before doing the
7591 parse_menu_item, so that if it turns out it wasn't a menu item,
7592 it still correctly hides any further menu item. */
7594 parsed
= parse_menu_item (item
, 1);
7599 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7601 /* Find any existing item for this KEY. */
7602 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7603 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7606 /* If we did not find this KEY, add it at the end. */
7607 if (i
== menu_bar_items_index
)
7609 /* If vector is too small, get a bigger one. */
7610 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7611 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7612 /* Add this item. */
7613 ASET (menu_bar_items_vector
, i
, key
); i
++;
7614 ASET (menu_bar_items_vector
, i
,
7615 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7616 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7617 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7618 menu_bar_items_index
= i
;
7620 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7624 old
= AREF (menu_bar_items_vector
, i
+ 2);
7625 /* If the new and the old items are not both keymaps,
7626 the lookup will only find `item'. */
7627 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7628 ASET (menu_bar_items_vector
, i
+ 2, item
);
7632 /* This is used as the handler when calling menu_item_eval_property. */
7634 menu_item_eval_property_1 (Lisp_Object arg
)
7636 /* If we got a quit from within the menu computation,
7637 quit all the way out of it. This takes care of C-] in the debugger. */
7638 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7639 Fsignal (Qquit
, Qnil
);
7645 eval_dyn (Lisp_Object form
)
7647 return Feval (form
, Qnil
);
7650 /* Evaluate an expression and return the result (or nil if something
7651 went wrong). Used to evaluate dynamic parts of menu items. */
7653 menu_item_eval_property (Lisp_Object sexpr
)
7657 specbind (Qinhibit_redisplay
, Qt
);
7658 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7659 menu_item_eval_property_1
);
7664 /* This function parses a menu item and leaves the result in the
7665 vector item_properties.
7666 ITEM is a key binding, a possible menu item.
7667 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7669 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7670 parse_menu_item returns true if the item is a menu item and false
7674 parse_menu_item (Lisp_Object item
, int inmenubar
)
7676 Lisp_Object def
, tem
, item_string
, start
;
7678 Lisp_Object keyhint
;
7687 /* Create item_properties vector if necessary. */
7688 if (NILP (item_properties
))
7690 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7692 /* Initialize optional entries. */
7693 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7694 ASET (item_properties
, i
, Qnil
);
7695 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7697 /* Save the item here to protect it from GC. */
7698 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7700 item_string
= XCAR (item
);
7704 if (STRINGP (item_string
))
7706 /* Old format menu item. */
7707 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7709 /* Maybe help string. */
7710 if (CONSP (item
) && STRINGP (XCAR (item
)))
7712 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7717 /* Maybe an obsolete key binding cache. */
7718 if (CONSP (item
) && CONSP (XCAR (item
))
7719 && (NILP (XCAR (XCAR (item
)))
7720 || VECTORP (XCAR (XCAR (item
)))))
7723 /* This is the real definition--the function to run. */
7724 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7726 /* Get enable property, if any. */
7729 tem
= Fget (item
, Qmenu_enable
);
7730 if (!NILP (Venable_disabled_menus_and_buttons
))
7731 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7732 else if (!NILP (tem
))
7733 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7736 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7738 /* New format menu item. */
7739 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7740 start
= XCDR (item
);
7743 /* We have a real binding. */
7744 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7746 item
= XCDR (start
);
7747 /* Is there an obsolete cache list with key equivalences. */
7748 if (CONSP (item
) && CONSP (XCAR (item
)))
7751 /* Parse properties. */
7752 while (CONSP (item
) && CONSP (XCDR (item
)))
7757 if (EQ (tem
, QCenable
))
7759 if (!NILP (Venable_disabled_menus_and_buttons
))
7760 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7762 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7764 else if (EQ (tem
, QCvisible
))
7766 /* If got a visible property and that evaluates to nil
7767 then ignore this item. */
7768 tem
= menu_item_eval_property (XCAR (item
));
7772 else if (EQ (tem
, QChelp
))
7773 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7774 else if (EQ (tem
, QCfilter
))
7776 else if (EQ (tem
, QCkey_sequence
))
7779 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7780 /* Be GC protected. Set keyhint to item instead of tem. */
7783 else if (EQ (tem
, QCkeys
))
7786 if (CONSP (tem
) || STRINGP (tem
))
7787 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7789 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7794 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7796 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7798 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7804 else if (inmenubar
|| !NILP (start
))
7808 return 0; /* not a menu item */
7810 /* If item string is not a string, evaluate it to get string.
7811 If we don't get a string, skip this item. */
7812 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7813 if (!(STRINGP (item_string
)))
7815 item_string
= menu_item_eval_property (item_string
);
7816 if (!STRINGP (item_string
))
7818 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7821 /* If got a filter apply it on definition. */
7822 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7825 def
= menu_item_eval_property (list2 (XCAR (filter
),
7826 list2 (Qquote
, def
)));
7828 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7831 /* Enable or disable selection of item. */
7832 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7835 tem
= menu_item_eval_property (tem
);
7836 if (inmenubar
&& NILP (tem
))
7837 return 0; /* Ignore disabled items in menu bar. */
7838 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7841 /* If we got no definition, this item is just unselectable text which
7842 is OK in a submenu but not in the menubar. */
7844 return (!inmenubar
);
7846 /* See if this is a separate pane or a submenu. */
7847 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7848 tem
= get_keymap (def
, 0, 1);
7849 /* For a subkeymap, just record its details and exit. */
7852 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7853 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7857 /* At the top level in the menu bar, do likewise for commands also.
7858 The menu bar does not display equivalent key bindings anyway.
7859 ITEM_PROPERTY_DEF is already set up properly. */
7863 { /* This is a command. See if there is an equivalent key binding. */
7864 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7866 /* The previous code preferred :key-sequence to :keys, so we
7867 preserve this behavior. */
7868 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7869 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7872 Lisp_Object prefix
= keyeq
;
7873 Lisp_Object keys
= Qnil
;
7877 def
= XCAR (prefix
);
7878 prefix
= XCDR (prefix
);
7881 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7883 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7885 keys
= XCAR (keyhint
);
7886 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7888 /* We have a suggested key. Is it bound to the command? */
7891 /* If the command is an alias for another
7892 (such as lmenu.el set it up), check if the
7893 original command matches the cached command. */
7895 && EQ (tem
, XSYMBOL (def
)->function
))))
7900 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7904 tem
= Fkey_description (keys
, Qnil
);
7907 if (STRINGP (XCAR (prefix
)))
7908 tem
= concat2 (XCAR (prefix
), tem
);
7909 if (STRINGP (XCDR (prefix
)))
7910 tem
= concat2 (tem
, XCDR (prefix
));
7912 keyeq
= concat2 (build_string (" "), tem
);
7913 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7919 /* If we have an equivalent key binding, use that. */
7920 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7923 /* Include this when menu help is implemented.
7924 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7925 if (!(NILP (tem) || STRINGP (tem)))
7927 tem = menu_item_eval_property (tem);
7930 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7934 /* Handle radio buttons or toggle boxes. */
7935 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7937 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7938 menu_item_eval_property (tem
));
7945 /***********************************************************************
7947 ***********************************************************************/
7949 /* A vector holding tool bar items while they are parsed in function
7950 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7953 static Lisp_Object tool_bar_items_vector
;
7955 /* A vector holding the result of parse_tool_bar_item. Layout is like
7956 the one for a single item in tool_bar_items_vector. */
7958 static Lisp_Object tool_bar_item_properties
;
7960 /* Next free index in tool_bar_items_vector. */
7962 static int ntool_bar_items
;
7964 /* The symbols `:image' and `:rtl'. */
7966 static Lisp_Object QCimage
;
7967 static Lisp_Object QCrtl
;
7969 /* Function prototypes. */
7971 static void init_tool_bar_items (Lisp_Object
);
7972 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7974 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7975 static void append_tool_bar_item (void);
7978 /* Return a vector of tool bar items for keymaps currently in effect.
7979 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7980 tool bar items found. */
7983 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7992 /* In order to build the menus, we need to call the keymap
7993 accessors. They all call QUIT. But this function is called
7994 during redisplay, during which a quit is fatal. So inhibit
7995 quitting while building the menus. We do this instead of
7996 specbind because (1) errors will clear it anyway and (2) this
7997 avoids risk of specpdl overflow. */
7998 oquit
= Vinhibit_quit
;
8001 /* Initialize tool_bar_items_vector and protect it from GC. */
8002 init_tool_bar_items (reuse
);
8004 /* Build list of keymaps in maps. Set nmaps to the number of maps
8007 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8008 if (!NILP (Voverriding_local_map_menu_flag
)
8009 && !NILP (Voverriding_local_map
))
8011 /* Yes, use them (if non-nil) as well as the global map. */
8012 maps
= alloca (3 * sizeof *maps
);
8014 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8015 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8016 if (!NILP (Voverriding_local_map
))
8017 maps
[nmaps
++] = Voverriding_local_map
;
8021 /* No, so use major and minor mode keymaps and keymap property.
8022 Note that tool-bar bindings in the local-map and keymap
8023 properties may not work reliable, as they are only
8024 recognized when the tool-bar (or mode-line) is updated,
8025 which does not normally happen after every command. */
8028 nminor
= current_minor_maps (NULL
, &tmaps
);
8029 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
8031 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8032 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8033 maps
[nmaps
++] = tem
;
8034 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8035 maps
[nmaps
++] = tem
;
8036 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8038 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8041 /* Add global keymap at the end. */
8042 maps
[nmaps
++] = current_global_map
;
8044 /* Process maps in reverse order and look up in each map the prefix
8046 for (i
= nmaps
- 1; i
>= 0; --i
)
8047 if (!NILP (maps
[i
]))
8051 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8053 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8056 Vinhibit_quit
= oquit
;
8057 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8058 return tool_bar_items_vector
;
8062 /* Process the definition of KEY which is DEF. */
8065 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8068 struct gcpro gcpro1
, gcpro2
;
8070 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8074 if (EQ (def
, Qundefined
))
8076 /* If a map has an explicit `undefined' as definition,
8077 discard any previously made item. */
8078 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8080 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8082 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8084 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8085 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8086 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8088 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8093 else if (parse_tool_bar_item (key
, def
))
8094 /* Append a new tool bar item to tool_bar_items_vector. Accept
8095 more than one definition for the same key. */
8096 append_tool_bar_item ();
8101 /* Access slot with index IDX of vector tool_bar_item_properties. */
8102 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8104 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8106 ASET (tool_bar_item_properties
, idx
, val
);
8110 /* Parse a tool bar item specification ITEM for key KEY and return the
8111 result in tool_bar_item_properties. Value is false if ITEM is
8114 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8116 CAPTION is the caption of the item, If it's not a string, it is
8117 evaluated to get a string.
8119 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8120 as binding are currently ignored.
8122 The following properties are recognized:
8126 FORM is evaluated and specifies whether the tool bar item is
8127 enabled or disabled.
8131 FORM is evaluated and specifies whether the tool bar item is visible.
8133 - `:filter FUNCTION'
8135 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8136 result is stored as the new binding.
8138 - `:button (TYPE SELECTED)'
8140 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8141 and specifies whether the button is selected (pressed) or not.
8145 IMAGES is either a single image specification or a vector of four
8146 image specifications. See enum tool_bar_item_images.
8148 - `:help HELP-STRING'.
8150 Gives a help string to display for the tool bar item.
8152 - `:label LABEL-STRING'.
8154 A text label to show with the tool bar button if labels are enabled. */
8157 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8159 Lisp_Object filter
= Qnil
;
8160 Lisp_Object caption
;
8162 bool have_label
= 0;
8164 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8165 Rule out items that aren't lists, don't start with
8166 `menu-item' or whose rest following `tool-bar-item' is not a
8171 /* As an exception, allow old-style menu separators. */
8172 if (STRINGP (XCAR (item
)))
8173 item
= list1 (XCAR (item
));
8174 else if (!EQ (XCAR (item
), Qmenu_item
)
8175 || (item
= XCDR (item
), !CONSP (item
)))
8178 /* Create tool_bar_item_properties vector if necessary. Reset it to
8180 if (VECTORP (tool_bar_item_properties
))
8182 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8186 tool_bar_item_properties
8187 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8190 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8191 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8193 /* Get the caption of the item. If the caption is not a string,
8194 evaluate it to get a string. If we don't get a string, skip this
8196 caption
= XCAR (item
);
8197 if (!STRINGP (caption
))
8199 caption
= menu_item_eval_property (caption
);
8200 if (!STRINGP (caption
))
8203 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8205 /* If the rest following the caption is not a list, the menu item is
8206 either a separator, or invalid. */
8210 if (menu_separator_name_p (SSDATA (caption
)))
8212 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8213 #if !defined (USE_GTK) && !defined (HAVE_NS)
8214 /* If we use build_desired_tool_bar_string to render the
8215 tool bar, the separator is rendered as an image. */
8216 set_prop (TOOL_BAR_ITEM_IMAGES
,
8217 (menu_item_eval_property
8218 (Vtool_bar_separator_image_expression
)));
8219 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8220 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8221 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8228 /* Store the binding. */
8229 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8232 /* Ignore cached key binding, if any. */
8233 if (CONSP (item
) && CONSP (XCAR (item
)))
8236 /* Process the rest of the properties. */
8237 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8239 Lisp_Object ikey
, value
;
8242 value
= XCAR (XCDR (item
));
8244 if (EQ (ikey
, QCenable
))
8246 /* `:enable FORM'. */
8247 if (!NILP (Venable_disabled_menus_and_buttons
))
8248 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8250 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8252 else if (EQ (ikey
, QCvisible
))
8254 /* `:visible FORM'. If got a visible property and that
8255 evaluates to nil then ignore this item. */
8256 if (NILP (menu_item_eval_property (value
)))
8259 else if (EQ (ikey
, QChelp
))
8260 /* `:help HELP-STRING'. */
8261 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8262 else if (EQ (ikey
, QCvert_only
))
8263 /* `:vert-only t/nil'. */
8264 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8265 else if (EQ (ikey
, QClabel
))
8267 const char *bad_label
= "!!?GARBLED ITEM?!!";
8268 /* `:label LABEL-STRING'. */
8269 set_prop (TOOL_BAR_ITEM_LABEL
,
8270 STRINGP (value
) ? value
: build_string (bad_label
));
8273 else if (EQ (ikey
, QCfilter
))
8274 /* ':filter FORM'. */
8276 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8278 /* `:button (TYPE . SELECTED)'. */
8279 Lisp_Object type
, selected
;
8281 type
= XCAR (value
);
8282 selected
= XCDR (value
);
8283 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8285 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8286 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8289 else if (EQ (ikey
, QCimage
)
8291 || (VECTORP (value
) && ASIZE (value
) == 4)))
8292 /* Value is either a single image specification or a vector
8293 of 4 such specifications for the different button states. */
8294 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8295 else if (EQ (ikey
, QCrtl
))
8297 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8303 /* Try to make one from caption and key. */
8304 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8305 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8306 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8307 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8309 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8310 char *buf
= xmalloc_atomic (max_lbl
+ 1);
8311 Lisp_Object new_lbl
;
8312 ptrdiff_t caption_len
= strlen (capt
);
8314 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8317 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8319 buf
[caption_len
] = '\0';
8323 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8327 strcpy (buf
, label
);
8329 for (j
= 0; buf
[j
] != '\0'; ++j
)
8337 new_lbl
= Fupcase_initials (build_string (label
));
8338 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8339 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8341 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8345 /* If got a filter apply it on binding. */
8347 set_prop (TOOL_BAR_ITEM_BINDING
,
8348 (menu_item_eval_property
8351 PROP (TOOL_BAR_ITEM_BINDING
))))));
8353 /* See if the binding is a keymap. Give up if it is. */
8354 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8357 /* Enable or disable selection of item. */
8358 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8359 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8360 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8362 /* Handle radio buttons or toggle boxes. */
8363 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8364 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8365 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8373 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8374 that can be reused. */
8377 init_tool_bar_items (Lisp_Object reuse
)
8379 if (VECTORP (reuse
))
8380 tool_bar_items_vector
= reuse
;
8382 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8383 ntool_bar_items
= 0;
8387 /* Append parsed tool bar item properties from
8388 tool_bar_item_properties */
8391 append_tool_bar_item (void)
8395 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8397 /* Enlarge tool_bar_items_vector if necessary. */
8399 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8401 /* Append entries from tool_bar_item_properties to the end of
8402 tool_bar_items_vector. */
8403 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8404 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8405 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8412 /* Read a character using menus based on the keymap MAP.
8413 Return nil if there are no menus in the maps.
8414 Return t if we displayed a menu but the user rejected it.
8416 PREV_EVENT is the previous input event, or nil if we are reading
8417 the first event of a key sequence.
8419 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8420 if we used a mouse menu to read the input, or false otherwise. If
8421 USED_MOUSE_MENU is null, don't dereference it.
8423 The prompting is done based on the prompt-string of the map
8424 and the strings associated with various map elements.
8426 This can be done with X menus or with menus put in the minibuf.
8427 These are done in different ways, depending on how the input will be read.
8428 Menus using X are done after auto-saving in read-char, getting the input
8429 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8430 and do auto-saving in the inner call of read_char. */
8433 read_char_x_menu_prompt (Lisp_Object map
,
8434 Lisp_Object prev_event
, bool *used_mouse_menu
)
8436 if (used_mouse_menu
)
8437 *used_mouse_menu
= 0;
8439 /* Use local over global Menu maps. */
8441 if (! menu_prompting
)
8444 /* If we got to this point via a mouse click,
8445 use a real menu for mouse selection. */
8446 if (EVENT_HAS_PARAMETERS (prev_event
)
8447 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8448 && !EQ (XCAR (prev_event
), Qtool_bar
))
8450 /* Display the menu and get the selection. */
8453 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8458 record_menu_key (XCAR (value
));
8460 /* If we got multiple events, unread all but
8462 There is no way to prevent those unread events
8463 from showing up later in last_nonmenu_event.
8464 So turn symbol and integer events into lists,
8465 to indicate that they came from a mouse menu,
8466 so that when present in last_nonmenu_event
8467 they won't confuse things. */
8468 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8470 record_menu_key (XCAR (tem
));
8471 if (SYMBOLP (XCAR (tem
))
8472 || INTEGERP (XCAR (tem
)))
8473 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8476 /* If we got more than one event, put all but the first
8477 onto this list to be read later.
8478 Return just the first event now. */
8479 Vunread_command_events
8480 = nconc2 (XCDR (value
), Vunread_command_events
);
8481 value
= XCAR (value
);
8483 else if (NILP (value
))
8485 if (used_mouse_menu
)
8486 *used_mouse_menu
= 1;
8493 read_char_minibuf_menu_prompt (int commandflag
,
8496 register Lisp_Object name
;
8498 /* FIXME: Use the minibuffer's frame width. */
8499 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8501 bool nobindings
= 1;
8502 Lisp_Object rest
, vector
;
8503 Lisp_Object prompt_strings
= Qnil
;
8507 if (! menu_prompting
)
8510 map
= get_keymap (map
, 0, 1);
8511 name
= Fkeymap_prompt (map
);
8513 /* If we don't have any menus, just read a character normally. */
8514 if (!STRINGP (name
))
8517 #define PUSH_C_STR(str, listvar) \
8518 listvar = Fcons (build_unibyte_string (str), listvar)
8520 /* Prompt string always starts with map's prompt, and a space. */
8521 prompt_strings
= Fcons (name
, prompt_strings
);
8522 PUSH_C_STR (": ", prompt_strings
);
8523 nlength
= SCHARS (name
) + 2;
8527 /* Present the documented bindings, a line at a time. */
8531 Lisp_Object menu_strings
= prompt_strings
;
8532 ptrdiff_t i
= nlength
;
8534 Lisp_Object orig_defn_macro
;
8536 /* Loop over elements of map. */
8541 /* FIXME: Use map_keymap to handle new keymap formats. */
8543 /* At end of map, wrap around if just starting,
8544 or end this line if already have something on it. */
8547 if (notfirst
|| nobindings
)
8553 /* Look at the next element of the map. */
8555 elt
= AREF (vector
, idx
);
8557 elt
= Fcar_safe (rest
);
8559 if (idx
< 0 && VECTORP (elt
))
8561 /* If we found a dense table in the keymap,
8562 advanced past it, but start scanning its contents. */
8563 rest
= Fcdr_safe (rest
);
8569 /* An ordinary element. */
8570 Lisp_Object event
, tem
;
8574 event
= Fcar_safe (elt
); /* alist */
8575 elt
= Fcdr_safe (elt
);
8579 XSETINT (event
, idx
); /* vector */
8582 /* Ignore the element if it has no prompt string. */
8583 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8585 /* True if the char to type matches the string. */
8587 Lisp_Object upcased_event
, downcased_event
;
8588 Lisp_Object desc
= Qnil
;
8590 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8592 upcased_event
= Fupcase (event
);
8593 downcased_event
= Fdowncase (event
);
8594 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8595 || XINT (downcased_event
) == SREF (s
, 0));
8597 desc
= Fsingle_key_description (event
, Qnil
);
8599 #if 0 /* It is redundant to list the equivalent key bindings because
8600 the prefix is what the user has already typed. */
8602 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8604 /* Insert equivalent keybinding. */
8605 s
= concat2 (s
, tem
);
8608 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8609 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8611 /* Insert button prefix. */
8612 Lisp_Object selected
8613 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8614 if (EQ (tem
, QCradio
))
8615 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8617 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8618 s
= concat2 (tem
, s
);
8622 /* If we have room for the prompt string, add it to this line.
8623 If this is the first on the line, always add it. */
8624 if ((SCHARS (s
) + i
+ 2
8625 + (char_matches
? 0 : SCHARS (desc
) + 3))
8629 ptrdiff_t thiswidth
;
8631 /* Punctuate between strings. */
8634 PUSH_C_STR (", ", menu_strings
);
8640 /* If the char to type doesn't match the string's
8641 first char, explicitly show what char to type. */
8644 /* Add as much of string as fits. */
8645 thiswidth
= min (SCHARS (desc
), width
- i
);
8647 = Fcons (Fsubstring (desc
, make_number (0),
8648 make_number (thiswidth
)),
8651 PUSH_C_STR (" = ", menu_strings
);
8655 /* Add as much of string as fits. */
8656 thiswidth
= min (SCHARS (s
), width
- i
);
8658 = Fcons (Fsubstring (s
, make_number (0),
8659 make_number (thiswidth
)),
8665 /* If this element does not fit, end the line now,
8666 and save the element for the next line. */
8667 PUSH_C_STR ("...", menu_strings
);
8672 /* Move past this element. */
8673 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8674 /* Handle reaching end of dense table. */
8679 rest
= Fcdr_safe (rest
);
8683 /* Prompt with that and read response. */
8684 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8686 /* Make believe it's not a keyboard macro in case the help char
8687 is pressed. Help characters are not recorded because menu prompting
8688 is not used on replay. */
8689 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8690 kset_defining_kbd_macro (current_kboard
, Qnil
);
8692 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8693 while (BUFFERP (obj
));
8694 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8696 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8699 if (! EQ (obj
, menu_prompt_more_char
)
8700 && (!INTEGERP (menu_prompt_more_char
)
8701 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8703 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8704 store_kbd_macro_char (obj
);
8707 /* Help char - go round again. */
8711 /* Reading key sequences. */
8714 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8716 return access_keymap (get_keymap (keymap
, 0, 1),
8721 active_maps (Lisp_Object first_event
)
8723 Lisp_Object position
8724 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8725 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8728 /* Structure used to keep track of partial application of key remapping
8729 such as Vfunction_key_map and Vkey_translation_map. */
8730 typedef struct keyremap
8732 /* This is the map originally specified for this use. */
8734 /* This is a submap reached by looking up, in PARENT,
8735 the events from START to END. */
8737 /* Positions [START, END) in the key sequence buffer
8738 are the key that we have scanned so far.
8739 Those events are the ones that we will replace
8740 if PARENT maps them into a key sequence. */
8744 /* Lookup KEY in MAP.
8745 MAP is a keymap mapping keys to key vectors or functions.
8746 If the mapping is a function and DO_FUNCALL is true,
8747 the function is called with PROMPT as parameter and its return
8748 value is used as the return value of this function (after checking
8749 that it is indeed a vector). */
8752 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8757 next
= access_keymap (map
, key
, 1, 0, 1);
8759 /* Handle a symbol whose function definition is a keymap
8761 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8762 && (ARRAYP (XSYMBOL (next
)->function
)
8763 || KEYMAPP (XSYMBOL (next
)->function
)))
8764 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8766 /* If the keymap gives a function, not an
8767 array, then call the function with one arg and use
8768 its value instead. */
8769 if (do_funcall
&& FUNCTIONP (next
))
8774 next
= call1 (next
, prompt
);
8775 /* If the function returned something invalid,
8776 barf--don't ignore it.
8777 (To ignore it safely, we would need to gcpro a bunch of
8778 other variables.) */
8779 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8780 error ("Function %s returns invalid key sequence",
8781 SSDATA (SYMBOL_NAME (tem
)));
8786 /* Do one step of the key remapping used for function-key-map and
8787 key-translation-map:
8788 KEYBUF is the buffer holding the input events.
8789 BUFSIZE is its maximum size.
8790 FKEY is a pointer to the keyremap structure to use.
8791 INPUT is the index of the last element in KEYBUF.
8792 DOIT if true says that the remapping can actually take place.
8793 DIFF is used to return the number of keys added/removed by the remapping.
8794 PARENT is the root of the keymap.
8795 PROMPT is the prompt to use if the remapping happens through a function.
8796 Return true if the remapping actually took place. */
8799 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8800 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8802 Lisp_Object next
, key
;
8804 key
= keybuf
[fkey
->end
++];
8806 if (KEYMAPP (fkey
->parent
))
8807 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8811 /* If keybuf[fkey->start..fkey->end] is bound in the
8812 map and we're in a position to do the key remapping, replace it with
8813 the binding and restart with fkey->start at the end. */
8814 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8816 int len
= XFASTINT (Flength (next
));
8819 *diff
= len
- (fkey
->end
- fkey
->start
);
8821 if (bufsize
- input
<= *diff
)
8822 error ("Key sequence too long");
8824 /* Shift the keys that follow fkey->end. */
8826 for (i
= fkey
->end
; i
< input
; i
++)
8827 keybuf
[i
+ *diff
] = keybuf
[i
];
8829 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8830 keybuf
[i
+ *diff
] = keybuf
[i
];
8831 /* Overwrite the old keys with the new ones. */
8832 for (i
= 0; i
< len
; i
++)
8833 keybuf
[fkey
->start
+ i
]
8834 = Faref (next
, make_number (i
));
8836 fkey
->start
= fkey
->end
+= *diff
;
8837 fkey
->map
= fkey
->parent
;
8842 fkey
->map
= get_keymap (next
, 0, 1);
8844 /* If we no longer have a bound suffix, try a new position for
8846 if (!CONSP (fkey
->map
))
8848 fkey
->end
= ++fkey
->start
;
8849 fkey
->map
= fkey
->parent
;
8855 test_undefined (Lisp_Object binding
)
8857 return (NILP (binding
)
8858 || EQ (binding
, Qundefined
)
8859 || (SYMBOLP (binding
)
8860 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8863 /* Read a sequence of keys that ends with a non prefix character,
8864 storing it in KEYBUF, a buffer of size BUFSIZE.
8866 Return the length of the key sequence stored.
8867 Return -1 if the user rejected a command menu.
8869 Echo starting immediately unless `prompt' is 0.
8871 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8872 read_char with a suitable COMMANDFLAG argument.
8874 Where a key sequence ends depends on the currently active keymaps.
8875 These include any minor mode keymaps active in the current buffer,
8876 the current buffer's local map, and the global map.
8878 If a key sequence has no other bindings, we check Vfunction_key_map
8879 to see if some trailing subsequence might be the beginning of a
8880 function key's sequence. If so, we try to read the whole function
8881 key, and substitute its symbolic name into the key sequence.
8883 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8884 `double-' events into similar click events, if that would make them
8885 bound. We try to turn `triple-' events first into `double-' events,
8888 If we get a mouse click in a mode line, vertical divider, or other
8889 non-text area, we treat the click as if it were prefixed by the
8890 symbol denoting that area - `mode-line', `vertical-line', or
8893 If the sequence starts with a mouse click, we read the key sequence
8894 with respect to the buffer clicked on, not the current buffer.
8896 If the user switches frames in the midst of a key sequence, we put
8897 off the switch-frame event until later; the next call to
8898 read_char will return it.
8900 If FIX_CURRENT_BUFFER, we restore current_buffer
8901 from the selected window's buffer. */
8904 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8905 bool dont_downcase_last
, bool can_return_switch_frame
,
8906 bool fix_current_buffer
, bool prevent_redisplay
)
8908 /* How many keys there are in the current key sequence. */
8911 /* The length of the echo buffer when we started reading, and
8912 the length of this_command_keys when we started reading. */
8913 ptrdiff_t echo_start
IF_LINT (= 0);
8914 ptrdiff_t keys_start
;
8916 Lisp_Object current_binding
= Qnil
;
8917 Lisp_Object first_event
= Qnil
;
8919 /* Index of the first key that has no binding.
8920 It is useless to try fkey.start larger than that. */
8923 /* If t < mock_input, then KEYBUF[t] should be read as the next
8926 We use this to recover after recognizing a function key. Once we
8927 realize that a suffix of the current key sequence is actually a
8928 function key's escape sequence, we replace the suffix with the
8929 function key's binding from Vfunction_key_map. Now keybuf
8930 contains a new and different key sequence, so the echo area,
8931 this_command_keys, and the submaps and defs arrays are wrong. In
8932 this situation, we set mock_input to t, set t to 0, and jump to
8933 restart_sequence; the loop will read keys from keybuf up until
8934 mock_input, thus rebuilding the state; and then it will resume
8935 reading characters from the keyboard. */
8938 /* If the sequence is unbound in submaps[], then
8939 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8940 and fkey.map is its binding.
8942 These might be > t, indicating that all function key scanning
8943 should hold off until t reaches them. We do this when we've just
8944 recognized a function key, to avoid searching for the function
8945 key's again in Vfunction_key_map. */
8948 /* Likewise, for key_translation_map and input-decode-map. */
8949 keyremap keytran
, indec
;
8951 /* True if we are trying to map a key by changing an upper-case
8952 letter to lower case, or a shifted function key to an unshifted
8954 bool shift_translated
= 0;
8956 /* If we receive a `switch-frame' or `select-window' event in the middle of
8957 a key sequence, we put it off for later.
8958 While we're reading, we keep the event here. */
8959 Lisp_Object delayed_switch_frame
;
8961 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8962 int original_uppercase_position
= -1;
8964 /* Gets around Microsoft compiler limitations. */
8967 struct buffer
*starting_buffer
;
8969 /* List of events for which a fake prefix key has been generated. */
8970 Lisp_Object fake_prefixed_keys
= Qnil
;
8972 struct gcpro gcpro1
;
8976 GCPRO1 (fake_prefixed_keys
);
8977 raw_keybuf_count
= 0;
8979 last_nonmenu_event
= Qnil
;
8981 delayed_switch_frame
= Qnil
;
8987 /* Install the string PROMPT as the beginning of the string
8988 of echoing, so that it serves as a prompt for the next
8990 kset_echo_string (current_kboard
, prompt
);
8991 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8994 else if (cursor_in_echo_area
8995 && echo_keystrokes_p ())
8996 /* This doesn't put in a dash if the echo buffer is empty, so
8997 you don't always see a dash hanging out in the minibuffer. */
9001 /* Record the initial state of the echo area and this_command_keys;
9002 we will need to restore them if we replay a key sequence. */
9004 echo_start
= echo_length ();
9005 keys_start
= this_command_key_count
;
9006 this_single_command_key_start
= keys_start
;
9008 /* We jump here when we need to reinitialize fkey and keytran; this
9009 happens if we switch keyboards between rescans. */
9010 replay_entire_sequence
:
9012 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9013 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9014 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9015 indec
.start
= indec
.end
= 0;
9016 fkey
.start
= fkey
.end
= 0;
9017 keytran
.start
= keytran
.end
= 0;
9019 /* We jump here when the key sequence has been thoroughly changed, and
9020 we need to rescan it starting from the beginning. When we jump here,
9021 keybuf[0..mock_input] holds the sequence we should reread. */
9024 starting_buffer
= current_buffer
;
9025 first_unbound
= bufsize
+ 1;
9027 /* Build our list of keymaps.
9028 If we recognize a function key and replace its escape sequence in
9029 keybuf with its symbol, or if the sequence starts with a mouse
9030 click and we need to switch buffers, we jump back here to rebuild
9031 the initial keymaps from the current buffer. */
9032 current_binding
= active_maps (first_event
);
9034 /* Start from the beginning in keybuf. */
9037 /* These are no-ops the first time through, but if we restart, they
9038 revert the echo area and this_command_keys to their original state. */
9039 this_command_key_count
= keys_start
;
9040 if (INTERACTIVE
&& t
< mock_input
)
9041 echo_truncate (echo_start
);
9043 /* If the best binding for the current key sequence is a keymap, or
9044 we may be looking at a function key's escape sequence, keep on
9046 while (!NILP (current_binding
)
9047 /* Keep reading as long as there's a prefix binding. */
9048 ? KEYMAPP (current_binding
)
9049 /* Don't return in the middle of a possible function key sequence,
9050 if the only bindings we found were via case conversion.
9051 Thus, if ESC O a has a function-key-map translation
9052 and ESC o has a binding, don't return after ESC O,
9053 so that we can translate ESC O plus the next character. */
9054 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9057 bool used_mouse_menu
= 0;
9059 /* Where the last real key started. If we need to throw away a
9060 key that has expanded into more than one element of keybuf
9061 (say, a mouse click on the mode line which is being treated
9062 as [mode-line (mouse-...)], then we backtrack to this point
9064 int last_real_key_start
;
9066 /* These variables are analogous to echo_start and keys_start;
9067 while those allow us to restart the entire key sequence,
9068 echo_local_start and keys_local_start allow us to throw away
9070 ptrdiff_t echo_local_start
IF_LINT (= 0);
9071 int keys_local_start
;
9072 Lisp_Object new_binding
;
9074 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9075 eassert (indec
.start
<= indec
.end
);
9076 eassert (fkey
.start
<= fkey
.end
);
9077 eassert (keytran
.start
<= keytran
.end
);
9078 /* key-translation-map is applied *after* function-key-map
9079 which is itself applied *after* input-decode-map. */
9080 eassert (fkey
.end
<= indec
.start
);
9081 eassert (keytran
.end
<= fkey
.start
);
9083 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9084 first_unbound
< keytran
.start
)
9085 { /* The prefix upto first_unbound has no binding and has
9086 no translation left to do either, so we know it's unbound.
9087 If we don't stop now, we risk staying here indefinitely
9088 (if the user keeps entering fkey or keytran prefixes
9089 like C-c ESC ESC ESC ESC ...) */
9091 for (i
= first_unbound
+ 1; i
< t
; i
++)
9092 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9093 mock_input
= t
- first_unbound
- 1;
9094 indec
.end
= indec
.start
-= first_unbound
+ 1;
9095 indec
.map
= indec
.parent
;
9096 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9097 fkey
.map
= fkey
.parent
;
9098 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9099 keytran
.map
= keytran
.parent
;
9100 goto replay_sequence
;
9104 error ("Key sequence too long");
9107 echo_local_start
= echo_length ();
9108 keys_local_start
= this_command_key_count
;
9111 /* These are no-ops, unless we throw away a keystroke below and
9112 jumped back up to replay_key; in that case, these restore the
9113 variables to their original state, allowing us to replay the
9115 if (INTERACTIVE
&& t
< mock_input
)
9116 echo_truncate (echo_local_start
);
9117 this_command_key_count
= keys_local_start
;
9119 /* By default, assume each event is "real". */
9120 last_real_key_start
= t
;
9122 /* Does mock_input indicate that we are re-reading a key sequence? */
9126 add_command_key (key
);
9127 if (echo_keystrokes_p ()
9128 && current_kboard
->immediate_echo
)
9135 /* If not, we should actually read a character. */
9139 KBOARD
*interrupted_kboard
= current_kboard
;
9140 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9141 /* Calling read_char with COMMANDFLAG = -2 avoids
9142 redisplay in read_char and its subroutines. */
9143 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9144 current_binding
, last_nonmenu_event
,
9145 &used_mouse_menu
, NULL
);
9146 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9147 /* When switching to a new tty (with a new keyboard),
9148 read_char returns the new buffer, rather than -2
9149 (Bug#5095). This is because `terminal-init-xterm'
9150 calls read-char, which eats the wrong_kboard_jmpbuf
9151 return. Any better way to fix this? -- cyd */
9152 || (interrupted_kboard
!= current_kboard
))
9157 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9158 if (k
== interrupted_kboard
)
9163 /* Don't touch interrupted_kboard when it's been
9165 delayed_switch_frame
= Qnil
;
9166 goto replay_entire_sequence
;
9169 if (!NILP (delayed_switch_frame
))
9172 (interrupted_kboard
,
9173 Fcons (delayed_switch_frame
,
9174 KVAR (interrupted_kboard
, kbd_queue
)));
9175 delayed_switch_frame
= Qnil
;
9180 (interrupted_kboard
,
9181 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9183 /* If the side queue is non-empty, ensure it begins with a
9184 switch-frame, so we'll replay it in the right context. */
9185 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9186 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9187 !(EVENT_HAS_PARAMETERS (key
)
9188 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9192 XSETFRAME (frame
, interrupted_frame
);
9194 (interrupted_kboard
,
9195 Fcons (make_lispy_switch_frame (frame
),
9196 KVAR (interrupted_kboard
, kbd_queue
)));
9199 goto replay_entire_sequence
;
9203 /* read_char returns t when it shows a menu and the user rejects it.
9212 /* read_char returns -1 at the end of a macro.
9213 Emacs 18 handles this by returning immediately with a
9214 zero, so that's what we'll do. */
9215 if (INTEGERP (key
) && XINT (key
) == -1)
9218 /* The Microsoft C compiler can't handle the goto that
9224 /* If the current buffer has been changed from under us, the
9225 keymap may have changed, so replay the sequence. */
9228 timer_resume_idle ();
9231 /* Reset the current buffer from the selected window
9232 in case something changed the former and not the latter.
9233 This is to be more consistent with the behavior
9234 of the command_loop_1. */
9235 if (fix_current_buffer
)
9237 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9239 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9241 Fset_buffer (XWINDOW (selected_window
)->contents
);
9244 goto replay_sequence
;
9247 /* If we have a quit that was typed in another frame, and
9248 quit_throw_to_read_char switched buffers,
9249 replay to get the right keymap. */
9251 && XINT (key
) == quit_char
9252 && current_buffer
!= starting_buffer
)
9255 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9260 goto replay_sequence
;
9265 if (EVENT_HAS_PARAMETERS (key
)
9266 /* Either a `switch-frame' or a `select-window' event. */
9267 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9269 /* If we're at the beginning of a key sequence, and the caller
9270 says it's okay, go ahead and return this event. If we're
9271 in the midst of a key sequence, delay it until the end. */
9272 if (t
> 0 || !can_return_switch_frame
)
9274 delayed_switch_frame
= key
;
9279 if (NILP (first_event
))
9282 /* Even if first_event does not specify a particular
9283 window/position, it's important to recompute the maps here
9284 since a long time might have passed since we entered
9285 read_key_sequence, and a timer (or process-filter or
9286 special-event-map, ...) might have switched the current buffer
9287 or the selected window from under us in the mean time. */
9288 if (fix_current_buffer
9289 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9291 Fset_buffer (XWINDOW (selected_window
)->contents
);
9292 current_binding
= active_maps (first_event
);
9296 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9300 /* Clicks in non-text areas get prefixed by the symbol
9301 in their CHAR-ADDRESS field. For example, a click on
9302 the mode line is prefixed by the symbol `mode-line'.
9304 Furthermore, key sequences beginning with mouse clicks
9305 are read using the keymaps of the buffer clicked on, not
9306 the current buffer. So we may have to switch the buffer
9309 When we turn one event into two events, we must make sure
9310 that neither of the two looks like the original--so that,
9311 if we replay the events, they won't be expanded again.
9312 If not for this, such reexpansion could happen either here
9313 or when user programs play with this-command-keys. */
9314 if (EVENT_HAS_PARAMETERS (key
))
9316 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9317 if (EQ (kind
, Qmouse_click
))
9319 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9320 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9323 || (!NILP (fake_prefixed_keys
)
9324 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9326 /* We're looking a second time at an event for which
9327 we generated a fake prefix key. Set
9328 last_real_key_start appropriately. */
9330 last_real_key_start
= t
- 1;
9333 if (last_real_key_start
== 0)
9335 /* Key sequences beginning with mouse clicks are
9336 read using the keymaps in the buffer clicked on,
9337 not the current buffer. If we're at the
9338 beginning of a key sequence, switch buffers. */
9339 if (WINDOWP (window
)
9340 && BUFFERP (XWINDOW (window
)->contents
)
9341 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9343 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9348 /* Arrange to go back to the original buffer once we're
9349 done reading the key sequence. Note that we can't
9350 use save_excursion_{save,restore} here, because they
9351 save point as well as the current buffer; we don't
9352 want to save point, because redisplay may change it,
9353 to accommodate a Fset_window_start or something. We
9354 don't want to do this at the top of the function,
9355 because we may get input from a subprocess which
9356 wants to change the selected window and stuff (say,
9358 record_unwind_current_buffer ();
9360 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9362 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9363 goto replay_sequence
;
9367 /* Expand mode-line and scroll-bar events into two events:
9368 use posn as a fake prefix key. */
9370 && (NILP (fake_prefixed_keys
)
9371 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9373 if (bufsize
- t
<= 1)
9374 error ("Key sequence too long");
9377 keybuf
[t
+ 1] = key
;
9380 /* Record that a fake prefix key has been generated
9381 for KEY. Don't modify the event; this would
9382 prevent proper action when the event is pushed
9383 back into unread-command-events. */
9384 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9388 else if (CONSP (XCDR (key
))
9389 && CONSP (EVENT_START (key
))
9390 && CONSP (XCDR (EVENT_START (key
))))
9394 posn
= POSN_POSN (EVENT_START (key
));
9395 /* Handle menu-bar events:
9396 insert the dummy prefix event `menu-bar'. */
9397 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9399 if (bufsize
- t
<= 1)
9400 error ("Key sequence too long");
9402 keybuf
[t
+ 1] = key
;
9404 /* Zap the position in key, so we know that we've
9405 expanded it, and don't try to do so again. */
9406 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9409 goto replay_sequence
;
9411 else if (CONSP (posn
))
9413 /* We're looking at the second event of a
9414 sequence which we expanded before. Set
9415 last_real_key_start appropriately. */
9416 if (last_real_key_start
== t
&& t
> 0)
9417 last_real_key_start
= t
- 1;
9422 /* We have finally decided that KEY is something we might want
9424 new_binding
= follow_key (current_binding
, key
);
9426 /* If KEY wasn't bound, we'll try some fallbacks. */
9427 if (!NILP (new_binding
))
9428 /* This is needed for the following scenario:
9429 event 0: a down-event that gets dropped by calling replay_key.
9430 event 1: some normal prefix like C-h.
9431 After event 0, first_unbound is 0, after event 1 indec.start,
9432 fkey.start, and keytran.start are all 1, so when we see that
9433 C-h is bound, we need to update first_unbound. */
9434 first_unbound
= max (t
+ 1, first_unbound
);
9439 /* Remember the position to put an upper bound on indec.start. */
9440 first_unbound
= min (t
, first_unbound
);
9442 head
= EVENT_HEAD (key
);
9446 Lisp_Object breakdown
;
9449 breakdown
= parse_modifiers (head
);
9450 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9451 /* Attempt to reduce an unbound mouse event to a simpler
9452 event that is bound:
9453 Drags reduce to clicks.
9454 Double-clicks reduce to clicks.
9455 Triple-clicks reduce to double-clicks, then to clicks.
9456 Down-clicks are eliminated.
9457 Double-downs reduce to downs, then are eliminated.
9458 Triple-downs reduce to double-downs, then to downs,
9459 then are eliminated. */
9460 if (modifiers
& (down_modifier
| drag_modifier
9461 | double_modifier
| triple_modifier
))
9463 while (modifiers
& (down_modifier
| drag_modifier
9464 | double_modifier
| triple_modifier
))
9466 Lisp_Object new_head
, new_click
;
9467 if (modifiers
& triple_modifier
)
9468 modifiers
^= (double_modifier
| triple_modifier
);
9469 else if (modifiers
& double_modifier
)
9470 modifiers
&= ~double_modifier
;
9471 else if (modifiers
& drag_modifier
)
9472 modifiers
&= ~drag_modifier
;
9475 /* Dispose of this `down' event by simply jumping
9476 back to replay_key, to get another event.
9478 Note that if this event came from mock input,
9479 then just jumping back to replay_key will just
9480 hand it to us again. So we have to wipe out any
9483 We could delete keybuf[t] and shift everything
9484 after that to the left by one spot, but we'd also
9485 have to fix up any variable that points into
9486 keybuf, and shifting isn't really necessary
9489 Adding prefixes for non-textual mouse clicks
9490 creates two characters of mock input, and both
9491 must be thrown away. If we're only looking at
9492 the prefix now, we can just jump back to
9493 replay_key. On the other hand, if we've already
9494 processed the prefix, and now the actual click
9495 itself is giving us trouble, then we've lost the
9496 state of the keymaps we want to backtrack to, and
9497 we need to replay the whole sequence to rebuild
9500 Beyond that, only function key expansion could
9501 create more than two keys, but that should never
9502 generate mouse events, so it's okay to zero
9503 mock_input in that case too.
9505 FIXME: The above paragraph seems just plain
9506 wrong, if you consider things like
9507 xterm-mouse-mode. -stef
9509 Isn't this just the most wonderful code ever? */
9511 /* If mock_input > t + 1, the above simplification
9512 will actually end up dropping keys on the floor.
9513 This is probably OK for now, but even
9514 if mock_input <= t + 1, we need to adjust indec,
9516 Typical case [header-line down-mouse-N]:
9517 mock_input = 2, t = 1, fkey.end = 1,
9518 last_real_key_start = 0. */
9519 if (indec
.end
> last_real_key_start
)
9521 indec
.end
= indec
.start
9522 = min (last_real_key_start
, indec
.start
);
9523 indec
.map
= indec
.parent
;
9524 if (fkey
.end
> last_real_key_start
)
9526 fkey
.end
= fkey
.start
9527 = min (last_real_key_start
, fkey
.start
);
9528 fkey
.map
= fkey
.parent
;
9529 if (keytran
.end
> last_real_key_start
)
9531 keytran
.end
= keytran
.start
9532 = min (last_real_key_start
, keytran
.start
);
9533 keytran
.map
= keytran
.parent
;
9537 if (t
== last_real_key_start
)
9544 mock_input
= last_real_key_start
;
9545 goto replay_sequence
;
9550 = apply_modifiers (modifiers
, XCAR (breakdown
));
9551 new_click
= list2 (new_head
, EVENT_START (key
));
9553 /* Look for a binding for this new key. */
9554 new_binding
= follow_key (current_binding
, new_click
);
9556 /* If that click is bound, go for it. */
9557 if (!NILP (new_binding
))
9559 current_binding
= new_binding
;
9563 /* Otherwise, we'll leave key set to the drag event. */
9568 current_binding
= new_binding
;
9571 /* Normally, last_nonmenu_event gets the previous key we read.
9572 But when a mouse popup menu is being used,
9573 we don't update last_nonmenu_event; it continues to hold the mouse
9574 event that preceded the first level of menu. */
9575 if (!used_mouse_menu
)
9576 last_nonmenu_event
= key
;
9578 /* Record what part of this_command_keys is the current key sequence. */
9579 this_single_command_key_start
= this_command_key_count
- t
;
9581 /* Look for this sequence in input-decode-map.
9582 Scan from indec.end until we find a bound suffix. */
9583 while (indec
.end
< t
)
9585 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9589 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9590 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9595 mock_input
= diff
+ max (t
, mock_input
);
9596 goto replay_sequence
;
9600 if (!KEYMAPP (current_binding
)
9601 && !test_undefined (current_binding
)
9602 && indec
.start
>= t
)
9603 /* There is a binding and it's not a prefix.
9604 (and it doesn't have any input-decode-map translation pending).
9605 There is thus no function-key in this sequence.
9606 Moving fkey.start is important in this case to allow keytran.start
9607 to go over the sequence before we return (since we keep the
9608 invariant that keytran.end <= fkey.start). */
9611 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9614 /* If the sequence is unbound, see if we can hang a function key
9615 off the end of it. */
9616 /* Continue scan from fkey.end until we find a bound suffix. */
9617 while (fkey
.end
< indec
.start
)
9619 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9623 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9624 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9625 max (t
, mock_input
),
9626 /* If there's a binding (i.e.
9627 first_binding >= nmaps) we don't want
9628 to apply this function-key-mapping. */
9630 && (test_undefined (current_binding
)),
9635 mock_input
= diff
+ max (t
, mock_input
);
9636 /* Adjust the input-decode-map counters. */
9638 indec
.start
+= diff
;
9640 goto replay_sequence
;
9644 /* Look for this sequence in key-translation-map.
9645 Scan from keytran.end until we find a bound suffix. */
9646 while (keytran
.end
< fkey
.start
)
9648 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9652 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9653 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9658 mock_input
= diff
+ max (t
, mock_input
);
9659 /* Adjust the function-key-map and input-decode-map counters. */
9661 indec
.start
+= diff
;
9665 goto replay_sequence
;
9669 /* If KEY is not defined in any of the keymaps,
9670 and cannot be part of a function key or translation,
9671 and is an upper case letter
9672 use the corresponding lower-case letter instead. */
9673 if (NILP (current_binding
)
9674 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9676 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9677 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9678 || (XINT (key
) & shift_modifier
)))
9680 Lisp_Object new_key
;
9682 original_uppercase
= key
;
9683 original_uppercase_position
= t
- 1;
9685 if (XINT (key
) & shift_modifier
)
9686 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9688 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9689 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9691 /* We have to do this unconditionally, regardless of whether
9692 the lower-case char is defined in the keymaps, because they
9693 might get translated through function-key-map. */
9694 keybuf
[t
- 1] = new_key
;
9695 mock_input
= max (t
, mock_input
);
9696 shift_translated
= 1;
9698 goto replay_sequence
;
9701 if (NILP (current_binding
)
9702 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9704 read_key_sequence_cmd
= Vprefix_help_command
;
9705 /* The Microsoft C compiler can't handle the goto that
9711 /* If KEY is not defined in any of the keymaps,
9712 and cannot be part of a function key or translation,
9713 and is a shifted function key,
9714 use the corresponding unshifted function key instead. */
9715 if (NILP (current_binding
)
9716 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9718 Lisp_Object breakdown
= parse_modifiers (key
);
9720 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9722 if (modifiers
& shift_modifier
9723 /* Treat uppercase keys as shifted. */
9725 && (KEY_TO_CHAR (key
)
9726 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9727 && uppercasep (KEY_TO_CHAR (key
))))
9730 = (modifiers
& shift_modifier
9731 ? apply_modifiers (modifiers
& ~shift_modifier
,
9733 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9735 original_uppercase
= key
;
9736 original_uppercase_position
= t
- 1;
9738 /* We have to do this unconditionally, regardless of whether
9739 the lower-case char is defined in the keymaps, because they
9740 might get translated through function-key-map. */
9741 keybuf
[t
- 1] = new_key
;
9742 mock_input
= max (t
, mock_input
);
9743 /* Reset fkey (and consequently keytran) to apply
9744 function-key-map on the result, so that S-backspace is
9745 correctly mapped to DEL (via backspace). OTOH,
9746 input-decode-map doesn't need to go through it again. */
9747 fkey
.start
= fkey
.end
= 0;
9748 keytran
.start
= keytran
.end
= 0;
9749 shift_translated
= 1;
9751 goto replay_sequence
;
9756 read_key_sequence_cmd
= current_binding
;
9757 read_key_sequence_remapped
9758 /* Remap command through active keymaps.
9759 Do the remapping here, before the unbind_to so it uses the keymaps
9760 of the appropriate buffer. */
9761 = SYMBOLP (read_key_sequence_cmd
)
9762 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9765 unread_switch_frame
= delayed_switch_frame
;
9768 /* Don't downcase the last character if the caller says don't.
9769 Don't downcase it if the result is undefined, either. */
9770 if ((dont_downcase_last
|| NILP (current_binding
))
9772 && t
- 1 == original_uppercase_position
)
9774 keybuf
[t
- 1] = original_uppercase
;
9775 shift_translated
= 0;
9778 if (shift_translated
)
9779 Vthis_command_keys_shift_translated
= Qt
;
9781 /* Occasionally we fabricate events, perhaps by expanding something
9782 according to function-key-map, or by adding a prefix symbol to a
9783 mouse click in the scroll bar or modeline. In this cases, return
9784 the entire generated key sequence, even if we hit an unbound
9785 prefix or a definition before the end. This means that you will
9786 be able to push back the event properly, and also means that
9787 read-key-sequence will always return a logical unit.
9790 for (; t
< mock_input
; t
++)
9792 if (echo_keystrokes_p ())
9793 echo_char (keybuf
[t
]);
9794 add_command_key (keybuf
[t
]);
9802 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9803 Lisp_Object dont_downcase_last
,
9804 Lisp_Object can_return_switch_frame
,
9805 Lisp_Object cmd_loop
, bool allow_string
)
9807 Lisp_Object keybuf
[30];
9809 struct gcpro gcpro1
;
9813 CHECK_STRING (prompt
);
9816 specbind (Qinput_method_exit_on_first_char
,
9817 (NILP (cmd_loop
) ? Qt
: Qnil
));
9818 specbind (Qinput_method_use_echo_area
,
9819 (NILP (cmd_loop
) ? Qt
: Qnil
));
9821 memset (keybuf
, 0, sizeof keybuf
);
9823 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9825 if (NILP (continue_echo
))
9827 this_command_key_count
= 0;
9828 this_command_key_count_reset
= 0;
9829 this_single_command_key_start
= 0;
9832 #ifdef HAVE_WINDOW_SYSTEM
9833 if (display_hourglass_p
)
9834 cancel_hourglass ();
9837 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9838 prompt
, ! NILP (dont_downcase_last
),
9839 ! NILP (can_return_switch_frame
), 0, 0);
9841 #if 0 /* The following is fine for code reading a key sequence and
9842 then proceeding with a lengthy computation, but it's not good
9843 for code reading keys in a loop, like an input method. */
9844 #ifdef HAVE_WINDOW_SYSTEM
9845 if (display_hourglass_p
)
9856 Lisp_Object tem0
= ((allow_string
? make_event_array
: Fvector
) (i
, keybuf
));
9861 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9862 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9863 The sequence is sufficient to specify a non-prefix command in the
9864 current local and global maps.
9866 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9867 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9868 as a continuation of the previous key.
9870 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9871 convert the last event to lower case. (Normally any upper case event
9872 is converted to lower case if the original event is undefined and the lower
9873 case equivalent is defined.) A non-nil value is appropriate for reading
9874 a key sequence to be defined.
9876 A C-g typed while in this function is treated like any other character,
9877 and `quit-flag' is not set.
9879 If the key sequence starts with a mouse click, then the sequence is read
9880 using the keymaps of the buffer of the window clicked in, not the buffer
9881 of the selected window as normal.
9883 `read-key-sequence' drops unbound button-down events, since you normally
9884 only care about the click or drag events which follow them. If a drag
9885 or multi-click event is unbound, but the corresponding click event would
9886 be bound, `read-key-sequence' turns the event into a click event at the
9887 drag's starting position. This means that you don't have to distinguish
9888 between click and drag, double, or triple events unless you want to.
9890 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9891 lines separating windows, and scroll bars with imaginary keys
9892 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9894 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9895 function will process a switch-frame event if the user switches frames
9896 before typing anything. If the user switches frames in the middle of a
9897 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9898 is nil, then the event will be put off until after the current key sequence.
9900 `read-key-sequence' checks `function-key-map' for function key
9901 sequences, where they wouldn't conflict with ordinary bindings. See
9902 `function-key-map' for more details.
9904 The optional fifth argument CMD-LOOP, if non-nil, means
9905 that this key sequence is being read by something that will
9906 read commands one after another. It should be nil if the caller
9907 will read just one key sequence. */)
9908 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9910 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9911 can_return_switch_frame
, cmd_loop
, true);
9914 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9915 Sread_key_sequence_vector
, 1, 5, 0,
9916 doc
: /* Like `read-key-sequence' but always return a vector. */)
9917 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9919 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9920 can_return_switch_frame
, cmd_loop
, false);
9923 /* Return true if input events are pending. */
9926 detect_input_pending (void)
9928 return input_pending
|| get_input_pending (0);
9931 /* Return true if input events other than mouse movements are
9935 detect_input_pending_ignore_squeezables (void)
9937 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9940 /* Return true if input events are pending, and run any pending timers. */
9943 detect_input_pending_run_timers (bool do_display
)
9945 unsigned old_timers_run
= timers_run
;
9948 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9950 if (old_timers_run
!= timers_run
&& do_display
)
9951 redisplay_preserve_echo_area (8);
9953 return input_pending
;
9956 /* This is called in some cases before a possible quit.
9957 It cases the next call to detect_input_pending to recompute input_pending.
9958 So calling this function unnecessarily can't do any harm. */
9961 clear_input_pending (void)
9966 /* Return true if there are pending requeued events.
9967 This isn't used yet. The hope is to make wait_reading_process_output
9968 call it, and return if it runs Lisp code that unreads something.
9969 The problem is, kbd_buffer_get_event needs to be fixed to know what
9970 to do in that case. It isn't trivial. */
9973 requeued_events_pending_p (void)
9975 return (!NILP (Vunread_command_events
));
9978 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9979 doc
: /* Return t if command input is currently available with no wait.
9980 Actually, the value is nil only if we can be sure that no input is available;
9981 if there is a doubt, the value is t.
9983 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9984 (Lisp_Object check_timers
)
9986 if (!NILP (Vunread_command_events
)
9987 || !NILP (Vunread_post_input_method_events
)
9988 || !NILP (Vunread_input_method_events
))
9991 /* Process non-user-visible events (Bug#10195). */
9992 process_special_events ();
9994 return (get_input_pending ((NILP (check_timers
)
9995 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9996 | READABLE_EVENTS_FILTER_EVENTS
)
10000 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10001 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10004 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10007 if (total_keys
< NUM_RECENT_KEYS
)
10008 return Fvector (total_keys
, keys
);
10011 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10012 vcopy (val
, 0, keys
+ recent_keys_index
,
10013 NUM_RECENT_KEYS
- recent_keys_index
);
10014 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10015 keys
, recent_keys_index
);
10020 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10021 doc
: /* Return the key sequence that invoked this command.
10022 However, if the command has called `read-key-sequence', it returns
10023 the last key sequence that has been read.
10024 The value is a string or a vector.
10026 See also `this-command-keys-vector'. */)
10029 return make_event_array (this_command_key_count
,
10030 XVECTOR (this_command_keys
)->contents
);
10033 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10034 doc
: /* Return the key sequence that invoked this command, as a vector.
10035 However, if the command has called `read-key-sequence', it returns
10036 the last key sequence that has been read.
10038 See also `this-command-keys'. */)
10041 return Fvector (this_command_key_count
,
10042 XVECTOR (this_command_keys
)->contents
);
10045 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10046 Sthis_single_command_keys
, 0, 0, 0,
10047 doc
: /* Return the key sequence that invoked this command.
10048 More generally, it returns the last key sequence read, either by
10049 the command loop or by `read-key-sequence'.
10050 Unlike `this-command-keys', this function's value
10051 does not include prefix arguments.
10052 The value is always a vector. */)
10055 return Fvector (this_command_key_count
10056 - this_single_command_key_start
,
10057 (XVECTOR (this_command_keys
)->contents
10058 + this_single_command_key_start
));
10061 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10062 Sthis_single_command_raw_keys
, 0, 0, 0,
10063 doc
: /* Return the raw events that were read for this command.
10064 More generally, it returns the last key sequence read, either by
10065 the command loop or by `read-key-sequence'.
10066 Unlike `this-single-command-keys', this function's value
10067 shows the events before all translations (except for input methods).
10068 The value is always a vector. */)
10071 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10074 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10075 Sreset_this_command_lengths
, 0, 0, 0,
10076 doc
: /* Make the unread events replace the last command and echo.
10077 Used in `universal-argument-other-key'.
10079 `universal-argument-other-key' rereads the event just typed.
10080 It then gets translated through `function-key-map'.
10081 The translated event has to replace the real events,
10082 both in the value of (this-command-keys) and in echoing.
10083 To achieve this, `universal-argument-other-key' calls
10084 `reset-this-command-lengths', which discards the record of reading
10085 these events the first time. */)
10088 this_command_key_count
= before_command_key_count
;
10089 if (this_command_key_count
< this_single_command_key_start
)
10090 this_single_command_key_start
= this_command_key_count
;
10092 echo_truncate (before_command_echo_length
);
10094 /* Cause whatever we put into unread-command-events
10095 to echo as if it were being freshly read from the keyboard. */
10096 this_command_key_count_reset
= 1;
10101 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10102 Sclear_this_command_keys
, 0, 1, 0,
10103 doc
: /* Clear out the vector that `this-command-keys' returns.
10104 Also clear the record of the last 100 events, unless optional arg
10105 KEEP-RECORD is non-nil. */)
10106 (Lisp_Object keep_record
)
10110 this_command_key_count
= 0;
10111 this_command_key_count_reset
= 0;
10113 if (NILP (keep_record
))
10115 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10116 ASET (recent_keys
, i
, Qnil
);
10118 recent_keys_index
= 0;
10123 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10124 doc
: /* Return the current depth in recursive edits. */)
10128 /* Wrap around reliably on integer overflow. */
10129 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10130 XSETINT (temp
, sum
);
10134 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10135 "FOpen dribble file: ",
10136 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10137 If FILE is nil, close any open dribble file.
10138 The file will be closed when Emacs exits.
10140 Be aware that this records ALL characters you type!
10141 This may include sensitive information such as passwords. */)
10154 Lisp_Object encfile
;
10156 file
= Fexpand_file_name (file
, Qnil
);
10157 encfile
= ENCODE_FILE (file
);
10158 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10159 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10160 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10161 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10163 report_file_error ("Opening dribble", file
);
10168 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10169 doc
: /* Discard the contents of the terminal input buffer.
10170 Also end any kbd macro being defined. */)
10173 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10175 /* Discard the last command from the macro. */
10176 Fcancel_kbd_macro_events ();
10180 Vunread_command_events
= Qnil
;
10182 discard_tty_input ();
10184 kbd_fetch_ptr
= kbd_store_ptr
;
10190 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10191 doc
: /* Stop Emacs and return to superior process. You can resume later.
10192 If `cannot-suspend' is non-nil, or if the system doesn't support job
10193 control, run a subshell instead.
10195 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10196 to be read as terminal input by Emacs's parent, after suspension.
10198 Before suspending, run the normal hook `suspend-hook'.
10199 After resumption run the normal hook `suspend-resume-hook'.
10201 Some operating systems cannot stop the Emacs process and resume it later.
10202 On such systems, Emacs starts a subshell instead of suspending. */)
10203 (Lisp_Object stuffstring
)
10206 int old_height
, old_width
;
10208 struct gcpro gcpro1
;
10211 if (tty_list
&& tty_list
->next
)
10212 error ("There are other tty frames open; close them before suspending Emacs");
10214 if (!NILP (stuffstring
))
10215 CHECK_STRING (stuffstring
);
10217 /* Run the functions in suspend-hook. */
10218 hook
= intern ("suspend-hook");
10219 Frun_hooks (1, &hook
);
10221 GCPRO1 (stuffstring
);
10222 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10223 reset_all_sys_modes ();
10224 /* sys_suspend can get an error if it tries to fork a subshell
10225 and the system resources aren't available for that. */
10226 record_unwind_protect_void (init_all_sys_modes
);
10227 stuff_buffered_input (stuffstring
);
10228 if (cannot_suspend
)
10234 /* Check if terminal/window size has changed.
10235 Note that this is not useful when we are running directly
10236 with a window system; but suspend should be disabled in that case. */
10237 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10238 if (width
!= old_width
|| height
!= old_height
)
10239 change_frame_size (SELECTED_FRAME (), width
, height
, 0, 0, 0, 0);
10241 /* Run suspend-resume-hook. */
10242 hook
= intern ("suspend-resume-hook");
10243 Frun_hooks (1, &hook
);
10249 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10250 Then in any case stuff anything Emacs has read ahead and not used. */
10253 stuff_buffered_input (Lisp_Object stuffstring
)
10255 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10256 register unsigned char *p
;
10258 if (STRINGP (stuffstring
))
10260 register ptrdiff_t count
;
10262 p
= SDATA (stuffstring
);
10263 count
= SBYTES (stuffstring
);
10264 while (count
-- > 0)
10269 /* Anything we have read ahead, put back for the shell to read. */
10270 /* ?? What should this do when we have multiple keyboards??
10271 Should we ignore anything that was typed in at the "wrong" kboard?
10273 rms: we should stuff everything back into the kboard
10275 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10278 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10279 kbd_fetch_ptr
= kbd_buffer
;
10280 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10281 stuff_char (kbd_fetch_ptr
->code
);
10283 clear_event (kbd_fetch_ptr
);
10287 #endif /* SIGTSTP */
10291 set_waiting_for_input (struct timespec
*time_to_clear
)
10293 input_available_clear_time
= time_to_clear
;
10295 /* Tell handle_interrupt to throw back to read_char, */
10296 waiting_for_input
= 1;
10298 /* If handle_interrupt was called before and buffered a C-g,
10299 make it run again now, to avoid timing error. */
10300 if (!NILP (Vquit_flag
))
10301 quit_throw_to_read_char (0);
10305 clear_waiting_for_input (void)
10307 /* Tell handle_interrupt not to throw back to read_char, */
10308 waiting_for_input
= 0;
10309 input_available_clear_time
= 0;
10312 /* The SIGINT handler.
10314 If we have a frame on the controlling tty, we assume that the
10315 SIGINT was generated by C-g, so we call handle_interrupt.
10316 Otherwise, tell QUIT to kill Emacs. */
10319 handle_interrupt_signal (int sig
)
10321 /* See if we have an active terminal on our controlling tty. */
10322 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10325 /* If there are no frames there, let's pretend that we are a
10326 well-behaving UN*X program and quit. We must not call Lisp
10327 in a signal handler, so tell QUIT to exit when it is
10329 Vquit_flag
= Qkill_emacs
;
10333 /* Otherwise, the SIGINT was probably generated by C-g. */
10335 /* Set internal_last_event_frame to the top frame of the
10336 controlling tty, if we have a frame there. We disable the
10337 interrupt key on secondary ttys, so the SIGINT must have come
10338 from the controlling tty. */
10339 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10341 handle_interrupt (1);
10346 deliver_interrupt_signal (int sig
)
10348 deliver_process_signal (sig
, handle_interrupt_signal
);
10352 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10353 of the number of times C-g has been requested. If C-g is pressed
10354 enough times, then quit anyway. See bug#6585. */
10355 static int volatile force_quit_count
;
10357 /* This routine is called at interrupt level in response to C-g.
10359 It is called from the SIGINT handler or kbd_buffer_store_event.
10361 If `waiting_for_input' is non zero, then unless `echoing' is
10362 nonzero, immediately throw back to read_char.
10364 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10365 eval to throw, when it gets a chance. If quit-flag is already
10366 non-nil, it stops the job right away. */
10369 handle_interrupt (bool in_signal_handler
)
10375 /* XXX This code needs to be revised for multi-tty support. */
10376 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10378 if (! in_signal_handler
)
10380 /* If SIGINT isn't blocked, don't let us be interrupted by
10381 a SIGINT. It might be harmful due to non-reentrancy
10382 in I/O functions. */
10384 sigemptyset (&blocked
);
10385 sigaddset (&blocked
, SIGINT
);
10386 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10390 reset_all_sys_modes ();
10394 * On systems which can suspend the current process and return to the original
10395 * shell, this command causes the user to end up back at the shell.
10396 * The "Auto-save" and "Abort" questions are not asked until
10397 * the user elects to return to emacs, at which point he can save the current
10398 * job and either dump core or continue.
10402 /* Perhaps should really fork an inferior shell?
10403 But that would not provide any way to get back
10404 to the original shell, ever. */
10405 printf ("No support for stopping a process on this operating system;\n");
10406 printf ("you can continue or abort.\n");
10407 #endif /* not SIGTSTP */
10409 /* We must remain inside the screen area when the internal terminal
10410 is used. Note that [Enter] is not echoed by dos. */
10411 cursor_to (SELECTED_FRAME (), 0, 0);
10413 printf ("Auto-save? (y or n) ");
10415 if (((c
= getchar ()) & ~040) == 'Y')
10417 Fdo_auto_save (Qt
, Qnil
);
10419 printf ("\r\nAuto-save done");
10420 #else /* not MSDOS */
10421 printf ("Auto-save done\n");
10422 #endif /* not MSDOS */
10424 while (c
!= '\n') c
= getchar ();
10427 printf ("\r\nAbort? (y or n) ");
10428 #else /* not MSDOS */
10429 printf ("Abort (and dump core)? (y or n) ");
10430 #endif /* not MSDOS */
10432 if (((c
= getchar ()) & ~040) == 'Y')
10434 while (c
!= '\n') c
= getchar ();
10436 printf ("\r\nContinuing...\r\n");
10437 #else /* not MSDOS */
10438 printf ("Continuing...\n");
10439 #endif /* not MSDOS */
10441 init_all_sys_modes ();
10445 /* If executing a function that wants to be interrupted out of
10446 and the user has not deferred quitting by binding `inhibit-quit'
10447 then quit right away. */
10448 if (immediate_quit
&& NILP (Vinhibit_quit
))
10450 struct gl_state_s saved
;
10451 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10453 immediate_quit
= 0;
10454 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10456 GCPRO4 (saved
.object
, saved
.global_code
,
10457 saved
.current_syntax_table
, saved
.old_prop
);
10458 Fsignal (Qquit
, Qnil
);
10463 { /* Else request quit when it's safe. */
10464 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10465 force_quit_count
= count
;
10468 immediate_quit
= 1;
10469 Vinhibit_quit
= Qnil
;
10475 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10477 /* TODO: The longjmp in this call throws the NS event loop integration off,
10478 and it seems to do fine without this. Probably some attention
10479 needs to be paid to the setting of waiting_for_input in
10480 wait_reading_process_output() under HAVE_NS because of the call
10481 to ns_select there (needed because otherwise events aren't picked up
10482 outside of polling since we don't get SIGIO like X and we don't have a
10483 separate event loop thread like W32. */
10485 if (waiting_for_input
&& !echoing
)
10486 quit_throw_to_read_char (in_signal_handler
);
10490 /* Handle a C-g by making read_char return C-g. */
10493 quit_throw_to_read_char (bool from_signal
)
10495 /* When not called from a signal handler it is safe to call
10497 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10498 Fkill_emacs (Qnil
);
10500 /* Prevent another signal from doing this before we finish. */
10501 clear_waiting_for_input ();
10504 Vunread_command_events
= Qnil
;
10506 if (FRAMEP (internal_last_event_frame
)
10507 && !EQ (internal_last_event_frame
, selected_frame
))
10508 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10511 abort_to_prompt (getctag
, SCM_EOL
);
10514 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10515 Sset_input_interrupt_mode
, 1, 1, 0,
10516 doc
: /* Set interrupt mode of reading keyboard input.
10517 If INTERRUPT is non-nil, Emacs will use input interrupts;
10518 otherwise Emacs uses CBREAK mode.
10520 See also `current-input-mode'. */)
10521 (Lisp_Object interrupt
)
10523 bool new_interrupt_input
;
10524 #ifdef USABLE_SIGIO
10525 #ifdef HAVE_X_WINDOWS
10526 if (x_display_list
!= NULL
)
10528 /* When using X, don't give the user a real choice,
10529 because we haven't implemented the mechanisms to support it. */
10530 new_interrupt_input
= 1;
10533 #endif /* HAVE_X_WINDOWS */
10534 new_interrupt_input
= !NILP (interrupt
);
10535 #else /* not USABLE_SIGIO */
10536 new_interrupt_input
= 0;
10537 #endif /* not USABLE_SIGIO */
10539 if (new_interrupt_input
!= interrupt_input
)
10541 #ifdef POLL_FOR_INPUT
10545 /* this causes startup screen to be restored and messes with the mouse */
10546 reset_all_sys_modes ();
10547 interrupt_input
= new_interrupt_input
;
10548 init_all_sys_modes ();
10550 interrupt_input
= new_interrupt_input
;
10553 #ifdef POLL_FOR_INPUT
10554 poll_suppress_count
= 1;
10561 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10562 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10563 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10564 C-q in key sequences.
10566 This setting only has an effect on tty terminals and only when
10567 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10569 See also `current-input-mode'. */)
10570 (Lisp_Object flow
, Lisp_Object terminal
)
10572 struct terminal
*t
= get_terminal (terminal
, 1);
10573 struct tty_display_info
*tty
;
10574 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10576 tty
= t
->display_info
.tty
;
10578 if (tty
->flow_control
!= !NILP (flow
))
10581 /* This causes startup screen to be restored and messes with the mouse. */
10582 reset_sys_modes (tty
);
10585 tty
->flow_control
= !NILP (flow
);
10588 init_sys_modes (tty
);
10594 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10595 doc
: /* Enable or disable 8-bit input on TERMINAL.
10596 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10597 bit as the Meta modifier.
10599 If META is nil, Emacs will ignore the top bit, on the assumption it is
10602 Otherwise, Emacs will accept and pass through 8-bit input without
10603 specially interpreting the top bit.
10605 This setting only has an effect on tty terminal devices.
10607 Optional parameter TERMINAL specifies the tty terminal device to use.
10608 It may be a terminal object, a frame, or nil for the terminal used by
10609 the currently selected frame.
10611 See also `current-input-mode'. */)
10612 (Lisp_Object meta
, Lisp_Object terminal
)
10614 struct terminal
*t
= get_terminal (terminal
, 1);
10615 struct tty_display_info
*tty
;
10618 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10620 tty
= t
->display_info
.tty
;
10624 else if (EQ (meta
, Qt
))
10629 if (tty
->meta_key
!= new_meta
)
10632 /* this causes startup screen to be restored and messes with the mouse */
10633 reset_sys_modes (tty
);
10636 tty
->meta_key
= new_meta
;
10639 init_sys_modes (tty
);
10645 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10646 doc
: /* Specify character used for quitting.
10647 QUIT must be an ASCII character.
10649 This function only has an effect on the controlling tty of the Emacs
10652 See also `current-input-mode'. */)
10655 struct terminal
*t
= get_named_tty ("/dev/tty");
10656 struct tty_display_info
*tty
;
10657 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10659 tty
= t
->display_info
.tty
;
10661 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10662 error ("QUIT must be an ASCII character");
10665 /* this causes startup screen to be restored and messes with the mouse */
10666 reset_sys_modes (tty
);
10669 /* Don't let this value be out of range. */
10670 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10673 init_sys_modes (tty
);
10679 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10680 doc
: /* Set mode of reading keyboard input.
10681 First arg INTERRUPT non-nil means use input interrupts;
10682 nil means use CBREAK mode.
10683 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10684 (no effect except in CBREAK mode).
10685 Third arg META t means accept 8-bit input (for a Meta key).
10686 META nil means ignore the top bit, on the assumption it is parity.
10687 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10688 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10689 See also `current-input-mode'. */)
10690 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10692 Fset_input_interrupt_mode (interrupt
);
10693 Fset_output_flow_control (flow
, Qnil
);
10694 Fset_input_meta_mode (meta
, Qnil
);
10696 Fset_quit_char (quit
);
10700 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10701 doc
: /* Return information about the way Emacs currently reads keyboard input.
10702 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10703 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10704 nil, Emacs is using CBREAK mode.
10705 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10706 terminal; this does not apply if Emacs uses interrupt-driven input.
10707 META is t if accepting 8-bit input with 8th bit as Meta flag.
10708 META nil means ignoring the top bit, on the assumption it is parity.
10709 META is neither t nor nil if accepting 8-bit input and using
10710 all 8 bits as the character code.
10711 QUIT is the character Emacs currently uses to quit.
10712 The elements of this list correspond to the arguments of
10713 `set-input-mode'. */)
10716 Lisp_Object val
[4];
10717 struct frame
*sf
= XFRAME (selected_frame
);
10719 val
[0] = interrupt_input
? Qt
: Qnil
;
10720 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10722 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10723 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10725 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10732 XSETFASTINT (val
[3], quit_char
);
10734 return Flist (ARRAYELTS (val
), val
);
10737 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10738 doc
: /* Return position information for pixel coordinates X and Y.
10739 By default, X and Y are relative to text area of the selected window.
10740 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10741 If optional fourth arg WHOLE is non-nil, X is relative to the left
10742 edge of the window.
10744 The return value is similar to a mouse click position:
10745 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10746 IMAGE (DX . DY) (WIDTH . HEIGHT))
10747 The `posn-' functions access elements of such lists. */)
10748 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10753 if (NILP (frame_or_window
))
10754 frame_or_window
= selected_window
;
10756 if (WINDOWP (frame_or_window
))
10758 struct window
*w
= decode_live_window (frame_or_window
);
10760 XSETINT (x
, (XINT (x
)
10761 + WINDOW_LEFT_EDGE_X (w
)
10763 ? window_box_left_offset (w
, TEXT_AREA
)
10765 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10766 frame_or_window
= w
->frame
;
10769 CHECK_LIVE_FRAME (frame_or_window
);
10771 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10774 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10775 doc
: /* Return position information for buffer POS in WINDOW.
10776 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10778 Return nil if position is not visible in window. Otherwise,
10779 the return value is similar to that returned by `event-start' for
10780 a mouse click at the upper left corner of the glyph corresponding
10781 to the given buffer position:
10782 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10783 IMAGE (DX . DY) (WIDTH . HEIGHT))
10784 The `posn-' functions access elements of such lists. */)
10785 (Lisp_Object pos
, Lisp_Object window
)
10790 window
= selected_window
;
10792 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10795 Lisp_Object x
= XCAR (tem
);
10796 Lisp_Object y
= XCAR (XCDR (tem
));
10798 /* Point invisible due to hscrolling? */
10801 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10807 /* Set up a new kboard object with reasonable initial values.
10808 TYPE is a window system for which this keyboard is used. */
10811 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10813 kset_overriding_terminal_local_map (kb
, Qnil
);
10814 kset_last_command (kb
, Qnil
);
10815 kset_real_last_command (kb
, Qnil
);
10816 kset_keyboard_translate_table (kb
, Qnil
);
10817 kset_last_repeatable_command (kb
, Qnil
);
10818 kset_prefix_arg (kb
, Qnil
);
10819 kset_last_prefix_arg (kb
, Qnil
);
10820 kset_kbd_queue (kb
, Qnil
);
10821 kb
->kbd_queue_has_data
= 0;
10822 kb
->immediate_echo
= 0;
10823 kset_echo_string (kb
, Qnil
);
10824 kb
->echo_after_prompt
= -1;
10825 kb
->kbd_macro_buffer
= 0;
10826 kb
->kbd_macro_bufsize
= 0;
10827 kset_defining_kbd_macro (kb
, Qnil
);
10828 kset_last_kbd_macro (kb
, Qnil
);
10829 kb
->reference_count
= 0;
10830 kset_system_key_alist (kb
, Qnil
);
10831 kset_system_key_syms (kb
, Qnil
);
10832 kset_window_system (kb
, type
);
10833 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10834 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10835 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10836 kset_default_minibuffer_frame (kb
, Qnil
);
10839 /* Allocate and basically initialize keyboard
10840 object to use with window system TYPE. */
10843 allocate_kboard (Lisp_Object type
)
10845 KBOARD
*kb
= xmalloc (sizeof *kb
);
10847 init_kboard (kb
, type
);
10848 kb
->next_kboard
= all_kboards
;
10854 * Destroy the contents of a kboard object, but not the object itself.
10855 * We use this just before deleting it, or if we're going to initialize
10856 * it a second time.
10859 wipe_kboard (KBOARD
*kb
)
10861 xfree (kb
->kbd_macro_buffer
);
10864 /* Free KB and memory referenced from it. */
10867 delete_kboard (KBOARD
*kb
)
10871 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10874 *kbp
= kb
->next_kboard
;
10876 /* Prevent a dangling reference to KB. */
10877 if (kb
== current_kboard
10878 && FRAMEP (selected_frame
)
10879 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10881 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10883 if (current_kboard
== kb
)
10892 init_keyboard (void)
10894 /* This is correct before outermost invocation of the editor loop. */
10895 command_loop_level
= -1;
10896 immediate_quit
= 0;
10897 quit_char
= Ctl ('g');
10898 Vunread_command_events
= Qnil
;
10899 timer_idleness_start_time
= invalid_timespec ();
10901 recent_keys_index
= 0;
10902 kbd_fetch_ptr
= kbd_buffer
;
10903 kbd_store_ptr
= kbd_buffer
;
10904 do_mouse_tracking
= Qnil
;
10906 interrupt_input_blocked
= 0;
10907 pending_signals
= 0;
10909 /* This means that command_loop_1 won't try to select anything the first
10911 internal_last_event_frame
= Qnil
;
10912 Vlast_event_frame
= internal_last_event_frame
;
10914 current_kboard
= initial_kboard
;
10915 /* Re-initialize the keyboard again. */
10916 wipe_kboard (current_kboard
);
10917 /* A value of nil for Vwindow_system normally means a tty, but we also use
10918 it for the initial terminal since there is no window system there. */
10919 init_kboard (current_kboard
, Qnil
);
10921 if (!noninteractive
)
10923 /* Before multi-tty support, these handlers used to be installed
10924 only if the current session was a tty session. Now an Emacs
10925 session may have multiple display types, so we always handle
10926 SIGINT. There is special code in handle_interrupt_signal to exit
10927 Emacs on SIGINT when there are no termcap frames on the
10928 controlling terminal. */
10929 struct sigaction action
;
10930 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10931 sigaction (SIGINT
, &action
, 0);
10933 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10934 SIGQUIT and we can't tell which one it will give us. */
10935 sigaction (SIGQUIT
, &action
, 0);
10936 #endif /* not DOS_NT */
10938 #ifdef USABLE_SIGIO
10939 if (!noninteractive
)
10941 struct sigaction action
;
10942 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10943 sigaction (SIGIO
, &action
, 0);
10947 /* Use interrupt input by default, if it works and noninterrupt input
10948 has deficiencies. */
10950 #ifdef INTERRUPT_INPUT
10951 interrupt_input
= 1;
10953 interrupt_input
= 0;
10956 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10959 if (keyboard_init_hook
)
10960 (*keyboard_init_hook
) ();
10962 #ifdef POLL_FOR_INPUT
10964 poll_suppress_count
= 1;
10969 /* This type's only use is in syms_of_keyboard, to initialize the
10970 event header symbols and put properties on them. */
10971 struct event_head
{
10977 static const struct event_head head_table
[] = {
10978 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10979 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10980 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10981 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10982 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10983 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10984 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10985 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10986 /* `select-window' should be handled just like `switch-frame'
10987 in read_key_sequence. */
10988 {&Qselect_window
, "select-window", &Qswitch_frame
}
10992 syms_of_keyboard (void)
10994 #include "keyboard.x"
10996 pending_funcalls
= Qnil
;
10997 staticpro (&pending_funcalls
);
10999 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11000 staticpro (&Vlispy_mouse_stem
);
11003 DEFSYM (QCimage
, ":image");
11004 DEFSYM (Qhelp_echo
, "help-echo");
11005 DEFSYM (QCrtl
, ":rtl");
11007 staticpro (&item_properties
);
11008 item_properties
= Qnil
;
11010 staticpro (&tool_bar_item_properties
);
11011 tool_bar_item_properties
= Qnil
;
11012 staticpro (&tool_bar_items_vector
);
11013 tool_bar_items_vector
= Qnil
;
11015 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11016 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11017 DEFSYM (Qself_insert_command
, "self-insert-command");
11018 DEFSYM (Qforward_char
, "forward-char");
11019 DEFSYM (Qbackward_char
, "backward-char");
11020 DEFSYM (Qdisabled
, "disabled");
11021 DEFSYM (Qundefined
, "undefined");
11022 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11023 DEFSYM (Qpost_command_hook
, "post-command-hook");
11024 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11025 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11026 DEFSYM (Qfunction_key
, "function-key");
11027 DEFSYM (Qmouse_click
, "mouse-click");
11028 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11029 DEFSYM (Qsave_session
, "save-session");
11030 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11031 DEFSYM (Qmenu_enable
, "menu-enable");
11034 DEFSYM (Qlanguage_change
, "language-change");
11038 DEFSYM (Qdbus_event
, "dbus-event");
11041 #ifdef USE_FILE_NOTIFY
11042 DEFSYM (Qfile_notify
, "file-notify");
11043 #endif /* USE_FILE_NOTIFY */
11045 DEFSYM (QCenable
, ":enable");
11046 DEFSYM (QCvisible
, ":visible");
11047 DEFSYM (QChelp
, ":help");
11048 DEFSYM (QCfilter
, ":filter");
11049 DEFSYM (QCbutton
, ":button");
11050 DEFSYM (QCkeys
, ":keys");
11051 DEFSYM (QCkey_sequence
, ":key-sequence");
11052 DEFSYM (QCtoggle
, ":toggle");
11053 DEFSYM (QCradio
, ":radio");
11054 DEFSYM (QClabel
, ":label");
11055 DEFSYM (QCvert_only
, ":vert-only");
11057 DEFSYM (Qmode_line
, "mode-line");
11058 DEFSYM (Qvertical_line
, "vertical-line");
11059 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11060 DEFSYM (Qmenu_bar
, "menu-bar");
11061 DEFSYM (Qright_divider
, "right-divider");
11062 DEFSYM (Qbottom_divider
, "bottom-divider");
11064 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11066 DEFSYM (Qabove_handle
, "above-handle");
11067 DEFSYM (Qhandle
, "handle");
11068 DEFSYM (Qbelow_handle
, "below-handle");
11069 DEFSYM (Qup
, "up");
11070 DEFSYM (Qdown
, "down");
11071 DEFSYM (Qtop
, "top");
11072 DEFSYM (Qbottom
, "bottom");
11073 DEFSYM (Qend_scroll
, "end-scroll");
11074 DEFSYM (Qratio
, "ratio");
11076 DEFSYM (Qevent_kind
, "event-kind");
11077 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11078 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11079 DEFSYM (Qmodifier_cache
, "modifier-cache");
11081 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11082 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11084 DEFSYM (Qpolling_period
, "polling-period");
11086 DEFSYM (Qx_set_selection
, "x-set-selection");
11087 DEFSYM (QPRIMARY
, "PRIMARY");
11088 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11089 DEFSYM (Qhandle_select_window
, "handle-select-window");
11091 DEFSYM (Qinput_method_function
, "input-method-function");
11092 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11093 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11095 DEFSYM (Qhelp_form_show
, "help-form-show");
11097 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11099 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11100 Fset (Qinput_method_use_echo_area
, Qnil
);
11104 int len
= ARRAYELTS (head_table
);
11106 for (i
= 0; i
< len
; i
++)
11108 const struct event_head
*p
= &head_table
[i
];
11109 *p
->var
= intern_c_string (p
->name
);
11110 staticpro (p
->var
);
11111 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11112 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11116 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11117 staticpro (&button_down_location
);
11118 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11119 staticpro (&mouse_syms
);
11120 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11122 staticpro (&wheel_syms
);
11126 int len
= ARRAYELTS (modifier_names
);
11128 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11129 for (i
= 0; i
< len
; i
++)
11130 if (modifier_names
[i
])
11131 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11132 staticpro (&modifier_symbols
);
11135 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11136 staticpro (&recent_keys
);
11138 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11139 staticpro (&this_command_keys
);
11141 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11142 staticpro (&raw_keybuf
);
11144 DEFSYM (Qcommand_execute
, "command-execute");
11146 accent_key_syms
= Qnil
;
11147 staticpro (&accent_key_syms
);
11149 func_key_syms
= Qnil
;
11150 staticpro (&func_key_syms
);
11152 drag_n_drop_syms
= Qnil
;
11153 staticpro (&drag_n_drop_syms
);
11155 unread_switch_frame
= Qnil
;
11156 staticpro (&unread_switch_frame
);
11158 internal_last_event_frame
= Qnil
;
11159 staticpro (&internal_last_event_frame
);
11161 read_key_sequence_cmd
= Qnil
;
11162 staticpro (&read_key_sequence_cmd
);
11163 read_key_sequence_remapped
= Qnil
;
11164 staticpro (&read_key_sequence_remapped
);
11166 menu_bar_one_keymap_changed_items
= Qnil
;
11167 staticpro (&menu_bar_one_keymap_changed_items
);
11169 menu_bar_items_vector
= Qnil
;
11170 staticpro (&menu_bar_items_vector
);
11172 help_form_saved_window_configs
= Qnil
;
11173 staticpro (&help_form_saved_window_configs
);
11175 DEFVAR_LISP ("last-command-event", last_command_event
,
11176 doc
: /* Last input event that was part of a command. */);
11178 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11179 doc
: /* Last input event in a command, except for mouse menu events.
11180 Mouse menus give back keys that don't look like mouse events;
11181 this variable holds the actual mouse event that led to the menu,
11182 so that you can determine whether the command was run by mouse or not. */);
11184 DEFVAR_LISP ("last-input-event", last_input_event
,
11185 doc
: /* Last input event. */);
11187 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11188 doc
: /* List of events to be read as the command input.
11189 These events are processed first, before actual keyboard input.
11190 Events read from this list are not normally added to `this-command-keys',
11191 as they will already have been added once as they were read for the first time.
11192 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11193 Vunread_command_events
= Qnil
;
11195 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11196 doc
: /* List of events to be processed as input by input methods.
11197 These events are processed before `unread-command-events'
11198 and actual keyboard input, but are not given to `input-method-function'. */);
11199 Vunread_post_input_method_events
= Qnil
;
11201 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11202 doc
: /* List of events to be processed as input by input methods.
11203 These events are processed after `unread-command-events', but
11204 before actual keyboard input.
11205 If there's an active input method, the events are given to
11206 `input-method-function'. */);
11207 Vunread_input_method_events
= Qnil
;
11209 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11210 doc
: /* Meta-prefix character code.
11211 Meta-foo as command input turns into this character followed by foo. */);
11212 XSETINT (meta_prefix_char
, 033);
11214 DEFVAR_KBOARD ("last-command", Vlast_command
,
11215 doc
: /* The last command executed.
11216 Normally a symbol with a function definition, but can be whatever was found
11217 in the keymap, or whatever the variable `this-command' was set to by that
11220 The value `mode-exit' is special; it means that the previous command
11221 read an event that told it to exit, and it did so and unread that event.
11222 In other words, the present command is the event that made the previous
11225 The value `kill-region' is special; it means that the previous command
11226 was a kill command.
11228 `last-command' has a separate binding for each terminal device.
11229 See Info node `(elisp)Multiple Terminals'. */);
11231 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11232 doc
: /* Same as `last-command', but never altered by Lisp code.
11233 Taken from the previous value of `real-this-command'. */);
11235 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11236 doc
: /* Last command that may be repeated.
11237 The last command executed that was not bound to an input event.
11238 This is the command `repeat' will try to repeat.
11239 Taken from a previous value of `real-this-command'. */);
11241 DEFVAR_LISP ("this-command", Vthis_command
,
11242 doc
: /* The command now being executed.
11243 The command can set this variable; whatever is put here
11244 will be in `last-command' during the following command. */);
11245 Vthis_command
= Qnil
;
11247 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11248 doc
: /* This is like `this-command', except that commands should never modify it. */);
11249 Vreal_this_command
= Qnil
;
11251 DEFVAR_LISP ("this-command-keys-shift-translated",
11252 Vthis_command_keys_shift_translated
,
11253 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11254 Shift-translation occurs when there is no binding for the key sequence
11255 as entered, but a binding was found by changing an upper-case letter
11256 to lower-case, or a shifted function key to an unshifted one. */);
11257 Vthis_command_keys_shift_translated
= Qnil
;
11259 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11260 doc
: /* The command bound to the current key sequence before remapping.
11261 It equals `this-command' if the original command was not remapped through
11262 any of the active keymaps. Otherwise, the value of `this-command' is the
11263 result of looking up the original command in the active keymaps. */);
11264 Vthis_original_command
= Qnil
;
11266 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11267 doc
: /* Number of input events between auto-saves.
11268 Zero means disable autosaving due to number of characters typed. */);
11269 auto_save_interval
= 300;
11271 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11272 doc
: /* Number of seconds idle time before auto-save.
11273 Zero or nil means disable auto-saving due to idleness.
11274 After auto-saving due to this many seconds of idle time,
11275 Emacs also does a garbage collection if that seems to be warranted. */);
11276 XSETFASTINT (Vauto_save_timeout
, 30);
11278 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11279 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11280 The value may be integer or floating point.
11281 If the value is zero, don't echo at all. */);
11282 Vecho_keystrokes
= make_number (1);
11284 DEFVAR_INT ("polling-period", polling_period
,
11285 doc
: /* Interval between polling for input during Lisp execution.
11286 The reason for polling is to make C-g work to stop a running program.
11287 Polling is needed only when using X windows and SIGIO does not work.
11288 Polling is automatically disabled in all other cases. */);
11289 polling_period
= 2;
11291 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11292 doc
: /* Maximum time between mouse clicks to make a double-click.
11293 Measured in milliseconds. The value nil means disable double-click
11294 recognition; t means double-clicks have no time limit and are detected
11295 by position only. */);
11296 Vdouble_click_time
= make_number (500);
11298 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11299 doc
: /* Maximum mouse movement between clicks to make a double-click.
11300 On window-system frames, value is the number of pixels the mouse may have
11301 moved horizontally or vertically between two clicks to make a double-click.
11302 On non window-system frames, value is interpreted in units of 1/8 characters
11305 This variable is also the threshold for motion of the mouse
11306 to count as a drag. */);
11307 double_click_fuzz
= 3;
11309 DEFVAR_INT ("num-input-keys", num_input_keys
,
11310 doc
: /* Number of complete key sequences read as input so far.
11311 This includes key sequences read from keyboard macros.
11312 The number is effectively the number of interactive command invocations. */);
11313 num_input_keys
= 0;
11315 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11316 doc
: /* Number of input events read from the keyboard so far.
11317 This does not include events generated by keyboard macros. */);
11318 num_nonmacro_input_events
= 0;
11320 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11321 doc
: /* The frame in which the most recently read event occurred.
11322 If the last event came from a keyboard macro, this is set to `macro'. */);
11323 Vlast_event_frame
= Qnil
;
11325 /* This variable is set up in sysdep.c. */
11326 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11327 doc
: /* The ERASE character as set by the user with stty. */);
11329 DEFVAR_LISP ("help-char", Vhelp_char
,
11330 doc
: /* Character to recognize as meaning Help.
11331 When it is read, do `(eval help-form)', and display result if it's a string.
11332 If the value of `help-form' is nil, this char can be read normally. */);
11333 XSETINT (Vhelp_char
, Ctl ('H'));
11335 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11336 doc
: /* List of input events to recognize as meaning Help.
11337 These work just like the value of `help-char' (see that). */);
11338 Vhelp_event_list
= Qnil
;
11340 DEFVAR_LISP ("help-form", Vhelp_form
,
11341 doc
: /* Form to execute when character `help-char' is read.
11342 If the form returns a string, that string is displayed.
11343 If `help-form' is nil, the help char is not recognized. */);
11346 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11347 doc
: /* Command to run when `help-char' character follows a prefix key.
11348 This command is used only when there is no actual binding
11349 for that character after that prefix key. */);
11350 Vprefix_help_command
= Qnil
;
11352 DEFVAR_LISP ("top-level", Vtop_level
,
11353 doc
: /* Form to evaluate when Emacs starts up.
11354 Useful to set before you dump a modified Emacs. */);
11357 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11358 doc
: /* Translate table for local keyboard input, or nil.
11359 If non-nil, the value should be a char-table. Each character read
11360 from the keyboard is looked up in this char-table. If the value found
11361 there is non-nil, then it is used instead of the actual input character.
11363 The value can also be a string or vector, but this is considered obsolete.
11364 If it is a string or vector of length N, character codes N and up are left
11365 untranslated. In a vector, an element which is nil means "no translation".
11367 This is applied to the characters supplied to input methods, not their
11368 output. See also `translation-table-for-input'.
11370 This variable has a separate binding for each terminal.
11371 See Info node `(elisp)Multiple Terminals'. */);
11373 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11374 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11375 \(Even if the operating system has support for stopping a process.\) */);
11376 cannot_suspend
= 0;
11378 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11379 doc
: /* Non-nil means prompt with menus when appropriate.
11380 This is done when reading from a keymap that has a prompt string,
11381 for elements that have prompt strings.
11382 The menu is displayed on the screen
11383 if X menus were enabled at configuration
11384 time and the previous event was a mouse click prefix key.
11385 Otherwise, menu prompting uses the echo area. */);
11386 menu_prompting
= 1;
11388 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11389 doc
: /* Character to see next line of menu prompt.
11390 Type this character while in a menu prompt to rotate around the lines of it. */);
11391 XSETINT (menu_prompt_more_char
, ' ');
11393 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11394 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11395 Emacs applies the modifiers of the character stored here to each keyboard
11396 character it reads. For example, after evaluating the expression
11397 (setq extra-keyboard-modifiers ?\\C-x)
11398 all input characters will have the control modifier applied to them.
11400 Note that the character ?\\C-@, equivalent to the integer zero, does
11401 not count as a control character; rather, it counts as a character
11402 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11403 cancels any modification. */);
11404 extra_keyboard_modifiers
= 0;
11406 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11407 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11408 The command loop sets this to nil before each command,
11409 and tests the value when the command returns.
11410 Buffer modification stores t in this variable. */);
11411 Vdeactivate_mark
= Qnil
;
11412 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11413 Fmake_variable_buffer_local (Qdeactivate_mark
);
11415 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11416 doc
: /* Normal hook run before each command is executed.
11417 If an unhandled error happens in running this hook,
11418 the function in which the error occurred is unconditionally removed, since
11419 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11420 Vpre_command_hook
= Qnil
;
11422 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11423 doc
: /* Normal hook run after each command is executed.
11424 If an unhandled error happens in running this hook,
11425 the function in which the error occurred is unconditionally removed, since
11426 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11427 Vpost_command_hook
= Qnil
;
11430 DEFVAR_LISP ("echo-area-clear-hook", ...,
11431 doc
: /* Normal hook run when clearing the echo area. */);
11433 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11434 Fset (Qecho_area_clear_hook
, Qnil
);
11436 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11437 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11438 Vlucid_menu_bar_dirty_flag
= Qnil
;
11440 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11441 doc
: /* List of menu bar items to move to the end of the menu bar.
11442 The elements of the list are event types that may have menu bar bindings. */);
11443 Vmenu_bar_final_items
= Qnil
;
11445 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11446 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11447 This is used internally by graphical displays that do not render
11448 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11449 Vtool_bar_separator_image_expression
= Qnil
;
11451 DEFVAR_KBOARD ("overriding-terminal-local-map",
11452 Voverriding_terminal_local_map
,
11453 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11454 This variable is intended to let commands such as `universal-argument'
11455 set up a different keymap for reading the next command.
11457 `overriding-terminal-local-map' has a separate binding for each
11458 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11460 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11461 doc
: /* Keymap that replaces (overrides) local keymaps.
11462 If this variable is non-nil, Emacs looks up key bindings in this
11463 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11464 buffer's local map. Hence, the only active keymaps would be
11465 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11466 order of precedence. */);
11467 Voverriding_local_map
= Qnil
;
11469 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11470 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11471 Otherwise, the menu bar continues to reflect the buffer's local map
11472 and the minor mode maps regardless of `overriding-local-map'. */);
11473 Voverriding_local_map_menu_flag
= Qnil
;
11475 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11476 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11477 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11479 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11480 doc
: /* Non-nil means generate motion events for mouse motion. */);
11482 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11483 doc
: /* Alist of system-specific X windows key symbols.
11484 Each element should have the form (N . SYMBOL) where N is the
11485 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11486 and SYMBOL is its name.
11488 `system-key-alist' has a separate binding for each terminal device.
11489 See Info node `(elisp)Multiple Terminals'. */);
11491 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11492 doc
: /* Keymap that translates key sequences to key sequences during input.
11493 This is used mainly for mapping key sequences into some preferred
11494 key events (symbols).
11496 The `read-key-sequence' function replaces any subsequence bound by
11497 `local-function-key-map' with its binding. More precisely, when the
11498 active keymaps have no binding for the current key sequence but
11499 `local-function-key-map' binds a suffix of the sequence to a vector or
11500 string, `read-key-sequence' replaces the matching suffix with its
11501 binding, and continues with the new sequence.
11503 If the binding is a function, it is called with one argument (the prompt)
11504 and its return value (a key sequence) is used.
11506 The events that come from bindings in `local-function-key-map' are not
11507 themselves looked up in `local-function-key-map'.
11509 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11510 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11511 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11512 typing `ESC O P x' would return [f1 x].
11514 `local-function-key-map' has a separate binding for each terminal
11515 device. See Info node `(elisp)Multiple Terminals'. If you need to
11516 define a binding on all terminals, change `function-key-map'
11517 instead. Initially, `local-function-key-map' is an empty keymap that
11518 has `function-key-map' as its parent on all terminal devices. */);
11520 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11521 doc
: /* Keymap that decodes input escape sequences.
11522 This is used mainly for mapping ASCII function key sequences into
11523 real Emacs function key events (symbols).
11525 The `read-key-sequence' function replaces any subsequence bound by
11526 `input-decode-map' with its binding. Contrary to `function-key-map',
11527 this map applies its rebinding regardless of the presence of an ordinary
11528 binding. So it is more like `key-translation-map' except that it applies
11529 before `function-key-map' rather than after.
11531 If the binding is a function, it is called with one argument (the prompt)
11532 and its return value (a key sequence) is used.
11534 The events that come from bindings in `input-decode-map' are not
11535 themselves looked up in `input-decode-map'. */);
11537 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11538 doc
: /* The parent keymap of all `local-function-key-map' instances.
11539 Function key definitions that apply to all terminal devices should go
11540 here. If a mapping is defined in both the current
11541 `local-function-key-map' binding and this variable, then the local
11542 definition will take precedence. */);
11543 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11545 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11546 doc
: /* Keymap of key translations that can override keymaps.
11547 This keymap works like `input-decode-map', but comes after `function-key-map'.
11548 Another difference is that it is global rather than terminal-local. */);
11549 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11551 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11552 doc
: /* List of deferred actions to be performed at a later time.
11553 The precise format isn't relevant here; we just check whether it is nil. */);
11554 Vdeferred_action_list
= Qnil
;
11556 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11557 doc
: /* Function to call to handle deferred actions, after each command.
11558 This function is called with no arguments after each command
11559 whenever `deferred-action-list' is non-nil. */);
11560 Vdeferred_action_function
= Qnil
;
11562 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11563 doc
: /* List of warnings to be displayed after this command.
11564 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11565 as per the args of `display-warning' (which see).
11566 If this variable is non-nil, `delayed-warnings-hook' will be run
11567 immediately after running `post-command-hook'. */);
11568 Vdelayed_warnings_list
= Qnil
;
11570 DEFVAR_LISP ("timer-list", Vtimer_list
,
11571 doc
: /* List of active absolute time timers in order of increasing time. */);
11572 Vtimer_list
= Qnil
;
11574 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11575 doc
: /* List of active idle-time timers in order of increasing time. */);
11576 Vtimer_idle_list
= Qnil
;
11578 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11579 doc
: /* If non-nil, the function that implements the current input method.
11580 It's called with one argument, a printing character that was just read.
11581 \(That means a character with code 040...0176.)
11582 Typically this function uses `read-event' to read additional events.
11583 When it does so, it should first bind `input-method-function' to nil
11584 so it will not be called recursively.
11586 The function should return a list of zero or more events
11587 to be used as input. If it wants to put back some events
11588 to be reconsidered, separately, by the input method,
11589 it can add them to the beginning of `unread-command-events'.
11591 The input method function can find in `input-method-previous-message'
11592 the previous echo area message.
11594 The input method function should refer to the variables
11595 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11596 for guidance on what to do. */);
11597 Vinput_method_function
= Qnil
;
11599 DEFVAR_LISP ("input-method-previous-message",
11600 Vinput_method_previous_message
,
11601 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11602 This variable exists because `read-event' clears the echo area
11603 before running the input method. It is nil if there was no message. */);
11604 Vinput_method_previous_message
= Qnil
;
11606 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11607 doc
: /* If non-nil, the function that implements the display of help.
11608 It's called with one argument, the help string to display. */);
11609 Vshow_help_function
= Qnil
;
11611 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11612 doc
: /* If non-nil, suppress point adjustment after executing a command.
11614 After a command is executed, if point is moved into a region that has
11615 special properties (e.g. composition, display), we adjust point to
11616 the boundary of the region. But, when a command sets this variable to
11617 non-nil, we suppress the point adjustment.
11619 This variable is set to nil before reading a command, and is checked
11620 just after executing the command. */);
11621 Vdisable_point_adjustment
= Qnil
;
11623 DEFVAR_LISP ("global-disable-point-adjustment",
11624 Vglobal_disable_point_adjustment
,
11625 doc
: /* If non-nil, always suppress point adjustment.
11627 The default value is nil, in which case, point adjustment are
11628 suppressed only after special commands that set
11629 `disable-point-adjustment' (which see) to non-nil. */);
11630 Vglobal_disable_point_adjustment
= Qnil
;
11632 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11633 doc
: /* How long to display an echo-area message when the minibuffer is active.
11634 If the value is not a number, such messages don't time out. */);
11635 Vminibuffer_message_timeout
= make_number (2);
11637 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11638 doc
: /* If non-nil, any keyboard input throws to this symbol.
11639 The value of that variable is passed to `quit-flag' and later causes a
11640 peculiar kind of quitting. */);
11641 Vthrow_on_input
= Qnil
;
11643 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11644 doc
: /* Function to output error messages.
11645 Called with three arguments:
11646 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11647 such as what `condition-case' would bind its variable to,
11648 - the context (a string which normally goes at the start of the message),
11649 - the Lisp function within which the error was signaled. */);
11650 Vcommand_error_function
= intern ("command-error-default-function");
11652 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11653 Venable_disabled_menus_and_buttons
,
11654 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11656 Help functions bind this to allow help on disabled menu items
11657 and tool-bar buttons. */);
11658 Venable_disabled_menus_and_buttons
= Qnil
;
11660 DEFVAR_LISP ("select-active-regions",
11661 Vselect_active_regions
,
11662 doc
: /* If non-nil, an active region automatically sets the primary selection.
11663 If the value is `only', only temporarily active regions (usually made
11664 by mouse-dragging or shift-selection) set the window selection.
11666 This takes effect only when Transient Mark mode is enabled. */);
11667 Vselect_active_regions
= Qt
;
11669 DEFVAR_LISP ("saved-region-selection",
11670 Vsaved_region_selection
,
11671 doc
: /* Contents of active region prior to buffer modification.
11672 If `select-active-regions' is non-nil, Emacs sets this to the
11673 text in the region before modifying the buffer. The next call to
11674 the function `deactivate-mark' uses this to set the window selection. */);
11675 Vsaved_region_selection
= Qnil
;
11677 DEFVAR_LISP ("selection-inhibit-update-commands",
11678 Vselection_inhibit_update_commands
,
11679 doc
: /* List of commands which should not update the selection.
11680 Normally, if `select-active-regions' is non-nil and the mark remains
11681 active after a command (i.e. the mark was not deactivated), the Emacs
11682 command loop sets the selection to the text in the region. However,
11683 if the command is in this list, the selection is not updated. */);
11684 Vselection_inhibit_update_commands
11685 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11687 DEFVAR_LISP ("debug-on-event",
11689 doc
: /* Enter debugger on this event. When Emacs
11690 receives the special event specified by this variable, it will try to
11691 break into the debugger as soon as possible instead of processing the
11692 event normally through `special-event-map'.
11694 Currently, the only supported values for this
11695 variable are `sigusr1' and `sigusr2'. */);
11696 Vdebug_on_event
= intern_c_string ("sigusr2");
11698 /* Create the initial keyboard. Qt means 'unset'. */
11699 initial_kboard
= allocate_kboard (Qt
);
11703 keys_of_keyboard (void)
11705 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11706 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11707 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11708 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11709 initial_define_key (meta_map
, 'x', "execute-extended-command");
11711 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11712 "handle-delete-frame");
11713 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11714 "ns-put-working-text");
11715 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11716 "ns-unput-working-text");
11717 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11718 current-prefix-arg, as is done in `handle-switch-frame'.
11719 But `handle-switch-frame is not run from the special-map.
11720 Commands from that map are run in a special way that automatically
11721 preserves the prefix-arg. Restoring the prefix arg here is not just
11722 redundant but harmful:
11724 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11725 - after the first prompt, the exit-minibuffer-hook is run which may
11726 iconify a frame and thus push a `iconify-frame' event.
11727 - after running exit-minibuffer-hook, current-prefix-arg is
11728 restored to the non-nil value it had before the prompt.
11729 - we enter the second prompt.
11730 current-prefix-arg is non-nil, prefix-arg is nil.
11731 - before running the first real event, we run the special iconify-frame
11732 event, but we pass the `special' arg to execute-command so
11733 current-prefix-arg and prefix-arg are left untouched.
11734 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11735 - the next key event will have a spuriously non-nil current-prefix-arg. */
11736 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11738 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11740 /* Handling it at such a low-level causes read_key_sequence to get
11741 * confused because it doesn't realize that the current_buffer was
11742 * changed by read_char.
11744 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11745 * "handle-select-window"); */
11746 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11747 "handle-save-session");
11750 /* Define a special event which is raised for dbus callback
11752 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11753 "dbus-handle-event");
11756 #ifdef USE_FILE_NOTIFY
11757 /* Define a special event which is raised for notification callback
11759 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11760 "file-notify-handle-event");
11761 #endif /* USE_FILE_NOTIFY */
11763 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11765 #if defined (WINDOWSNT)
11766 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11769 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11770 "handle-focus-in");
11771 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11772 "handle-focus-out");