1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
28 #include "termhooks.h"
33 #include "character.h"
36 #include "dispextern.h"
38 #include "intervals.h"
40 #include "blockinput.h"
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
59 #include <sys/types.h>
63 /* This is to get the definitions of the XK_ symbols. */
70 #endif /* HAVE_NTGUI */
76 /* Variables for blockinput.h: */
78 /* Non-zero if interrupt input is blocked right now. */
79 volatile int interrupt_input_blocked
;
81 /* Nonzero means an input interrupt has arrived
82 during the current critical section. */
83 int interrupt_input_pending
;
85 /* This var should be (interrupt_input_pending || pending_atimers).
86 The QUIT macro checks this instead of interrupt_input_pending and
87 pending_atimers separately, to reduce code size. So, any code that
88 changes interrupt_input_pending or pending_atimers should update
94 #define KBD_BUFFER_SIZE 4096
96 KBOARD
*initial_kboard
;
97 KBOARD
*current_kboard
;
100 /* Nonzero in the single-kboard state, 0 in the any-kboard state. */
101 static int single_kboard
;
103 /* Non-nil disable property on a command means
104 do not execute it; call disabled-command-function's value instead. */
105 Lisp_Object Qdisabled
;
106 static Lisp_Object Qdisabled_command_function
;
108 #define NUM_RECENT_KEYS (300)
110 /* Index for storing next element into recent_keys. */
111 static int recent_keys_index
;
113 /* Total number of elements stored into recent_keys. */
114 static int total_keys
;
116 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
117 static Lisp_Object recent_keys
;
119 /* Vector holding the key sequence that invoked the current command.
120 It is reused for each command, and it may be longer than the current
121 sequence; this_command_key_count indicates how many elements
122 actually mean something.
123 It's easier to staticpro a single Lisp_Object than an array. */
124 Lisp_Object this_command_keys
;
125 ptrdiff_t this_command_key_count
;
127 /* 1 after calling Freset_this_command_lengths.
129 static int this_command_key_count_reset
;
131 /* This vector is used as a buffer to record the events that were actually read
132 by read_key_sequence. */
133 static Lisp_Object raw_keybuf
;
134 static int raw_keybuf_count
;
136 #define GROW_RAW_KEYBUF \
137 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
138 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
140 /* Number of elements of this_command_keys
141 that precede this key sequence. */
142 static ptrdiff_t this_single_command_key_start
;
144 /* Record values of this_command_key_count and echo_length ()
145 before this command was read. */
146 static ptrdiff_t before_command_key_count
;
147 static ptrdiff_t before_command_echo_length
;
149 /* For longjmp to where kbd input is being done. */
151 static jmp_buf getcjmp
;
153 /* True while doing kbd input. */
154 int waiting_for_input
;
156 /* True while displaying for echoing. Delays C-g throwing. */
160 /* Non-null means we can start echoing at the next input pause even
161 though there is something in the echo area. */
163 static struct kboard
*ok_to_echo_at_next_pause
;
165 /* The kboard last echoing, or null for none. Reset to 0 in
166 cancel_echoing. If non-null, and a current echo area message
167 exists, and echo_message_buffer is eq to the current message
168 buffer, we know that the message comes from echo_kboard. */
170 struct kboard
*echo_kboard
;
172 /* The buffer used for echoing. Set in echo_now, reset in
175 Lisp_Object echo_message_buffer
;
177 /* Nonzero means C-g should cause immediate error-signal. */
180 /* Character that causes a quit. Normally C-g.
182 If we are running on an ordinary terminal, this must be an ordinary
183 ASCII char, since we want to make it our interrupt character.
185 If we are not running on an ordinary terminal, it still needs to be
186 an ordinary ASCII char. This character needs to be recognized in
187 the input interrupt handler. At this point, the keystroke is
188 represented as a struct input_event, while the desired quit
189 character is specified as a lispy event. The mapping from struct
190 input_events to lispy events cannot run in an interrupt handler,
191 and the reverse mapping is difficult for anything but ASCII
194 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
198 /* Current depth in recursive edits. */
199 EMACS_INT command_loop_level
;
201 /* If not Qnil, this is a switch-frame event which we decided to put
202 off until the end of a key sequence. This should be read as the
203 next command input, after any unread_command_events.
205 read_key_sequence uses this to delay switch-frame events until the
206 end of the key sequence; Fread_char uses it to put off switch-frame
207 events until a non-ASCII event is acceptable as input. */
208 Lisp_Object unread_switch_frame
;
210 /* Last size recorded for a current buffer which is not a minibuffer. */
211 static ptrdiff_t last_non_minibuf_size
;
213 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
214 uintmax_t num_input_events
;
216 /* Value of num_nonmacro_input_events as of last auto save. */
218 static EMACS_INT last_auto_save
;
220 /* The value of point when the last command was started. */
221 static ptrdiff_t last_point_position
;
223 /* The buffer that was current when the last command was started. */
224 static Lisp_Object last_point_position_buffer
;
226 /* The window that was selected when the last command was started. */
227 static Lisp_Object last_point_position_window
;
229 /* The frame in which the last input event occurred, or Qmacro if the
230 last event came from a macro. We use this to determine when to
231 generate switch-frame events. This may be cleared by functions
232 like Fselect_frame, to make sure that a switch-frame event is
233 generated by the next character. */
234 Lisp_Object internal_last_event_frame
;
236 /* The timestamp of the last input event we received from the X server.
237 X Windows wants this for selection ownership. */
238 Time last_event_timestamp
;
240 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
241 static Lisp_Object Qhandle_select_window
;
242 Lisp_Object QPRIMARY
;
244 static Lisp_Object Qself_insert_command
;
245 static Lisp_Object Qforward_char
;
246 static Lisp_Object Qbackward_char
;
247 Lisp_Object Qundefined
;
248 static Lisp_Object Qtimer_event_handler
;
250 /* read_key_sequence stores here the command definition of the
251 key sequence that it reads. */
252 static Lisp_Object read_key_sequence_cmd
;
253 static Lisp_Object read_key_sequence_remapped
;
255 static Lisp_Object Qinput_method_function
;
257 static Lisp_Object Qdeactivate_mark
;
259 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
261 static Lisp_Object Qecho_area_clear_hook
;
263 /* Hooks to run before and after each command. */
264 static Lisp_Object Qpre_command_hook
;
265 static Lisp_Object Qpost_command_hook
;
267 static Lisp_Object Qdeferred_action_function
;
269 static Lisp_Object Qdelayed_warnings_hook
;
271 static Lisp_Object Qinput_method_exit_on_first_char
;
272 static Lisp_Object Qinput_method_use_echo_area
;
274 static Lisp_Object Qhelp_form_show
;
276 /* File in which we write all commands we read. */
277 static FILE *dribble
;
279 /* Nonzero if input is available. */
282 /* Circular buffer for pre-read keyboard input. */
284 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
286 /* Pointer to next available character in kbd_buffer.
287 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
288 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
289 next available char is in kbd_buffer[0]. */
290 static struct input_event
*kbd_fetch_ptr
;
292 /* Pointer to next place to store character in kbd_buffer. This
293 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
294 character should go in kbd_buffer[0]. */
295 static struct input_event
* volatile kbd_store_ptr
;
297 /* The above pair of variables forms a "queue empty" flag. When we
298 enqueue a non-hook event, we increment kbd_store_ptr. When we
299 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
300 there is input available if the two pointers are not equal.
302 Why not just have a flag set and cleared by the enqueuing and
303 dequeuing functions? Such a flag could be screwed up by interrupts
304 at inopportune times. */
306 /* Symbols to head events. */
307 static Lisp_Object Qmouse_movement
;
308 static Lisp_Object Qscroll_bar_movement
;
309 Lisp_Object Qswitch_frame
;
310 static Lisp_Object Qdelete_frame
;
311 static Lisp_Object Qiconify_frame
;
312 static Lisp_Object Qmake_frame_visible
;
313 static Lisp_Object Qselect_window
;
314 Lisp_Object Qhelp_echo
;
316 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
317 static Lisp_Object Qmouse_fixup_help_message
;
320 /* Symbols to denote kinds of events. */
321 static Lisp_Object Qfunction_key
;
322 Lisp_Object Qmouse_click
;
323 #if defined (WINDOWSNT)
324 Lisp_Object Qlanguage_change
;
326 static Lisp_Object Qdrag_n_drop
;
327 static Lisp_Object Qsave_session
;
329 static Lisp_Object Qdbus_event
;
331 static Lisp_Object Qconfig_changed_event
;
333 /* Lisp_Object Qmouse_movement; - also an event header */
335 /* Properties of event headers. */
336 Lisp_Object Qevent_kind
;
337 static Lisp_Object Qevent_symbol_elements
;
339 /* Menu and tool bar item parts. */
340 static Lisp_Object Qmenu_enable
;
341 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
342 Lisp_Object QCfilter
;
344 /* Non-nil disable property on a command means
345 do not execute it; call disabled-command-function's value instead. */
346 Lisp_Object QCtoggle
, QCradio
;
347 static Lisp_Object QCbutton
, QClabel
;
349 static Lisp_Object QCvert_only
;
351 /* An event header symbol HEAD may have a property named
352 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
353 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
354 mask of modifiers applied to it. If present, this is used to help
355 speed up parse_modifiers. */
356 Lisp_Object Qevent_symbol_element_mask
;
358 /* An unmodified event header BASE may have a property named
359 Qmodifier_cache, which is an alist mapping modifier masks onto
360 modified versions of BASE. If present, this helps speed up
362 static Lisp_Object Qmodifier_cache
;
364 /* Symbols to use for parts of windows. */
365 Lisp_Object Qmode_line
;
366 Lisp_Object Qvertical_line
;
367 static Lisp_Object Qvertical_scroll_bar
;
368 Lisp_Object Qmenu_bar
;
370 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
371 static Lisp_Object
command_loop (void);
372 static Lisp_Object Qextended_command_history
;
373 EMACS_TIME
timer_check (void);
375 static void record_menu_key (Lisp_Object c
);
376 static void echo_now (void);
377 static ptrdiff_t echo_length (void);
379 static Lisp_Object Qpolling_period
;
381 /* Incremented whenever a timer is run. */
384 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
386 EMACS_TIME
*input_available_clear_time
;
388 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
389 Default is 1 if INTERRUPT_INPUT is defined. */
392 /* Nonzero while interrupts are temporarily deferred during redisplay. */
393 int interrupts_deferred
;
395 /* Allow m- file to inhibit use of FIONREAD. */
396 #ifdef BROKEN_FIONREAD
400 /* We are unable to use interrupts if FIONREAD is not available,
401 so flush SIGIO so we won't try. */
402 #if !defined (FIONREAD)
408 /* If we support a window system, turn on the code to poll periodically
409 to detect C-g. It isn't actually used when doing interrupt input. */
410 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_ASYNC_EVENTS)
411 #define POLL_FOR_INPUT
414 /* The time when Emacs started being idle. */
416 static EMACS_TIME timer_idleness_start_time
;
418 /* After Emacs stops being idle, this saves the last value
419 of timer_idleness_start_time from when it was idle. */
421 static EMACS_TIME timer_last_idleness_start_time
;
424 /* Global variable declarations. */
426 /* Flags for readable_events. */
427 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
428 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
429 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
431 /* Function for init_keyboard to call with no args (if nonzero). */
432 static void (*keyboard_init_hook
) (void);
434 static int read_avail_input (int);
435 static void get_input_pending (int *, int);
436 static int readable_events (int);
437 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
439 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
441 static Lisp_Object
make_lispy_event (struct input_event
*);
442 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
443 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
444 enum scroll_bar_part
,
445 Lisp_Object
, Lisp_Object
,
448 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
449 Lisp_Object
, const char *const *,
450 Lisp_Object
*, ptrdiff_t);
451 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
452 static int help_char_p (Lisp_Object
);
453 static void save_getcjmp (jmp_buf);
454 static void restore_getcjmp (jmp_buf);
455 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
456 static void clear_event (struct input_event
*);
457 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
458 static void interrupt_signal (int signalnum
);
460 static void input_available_signal (int signo
);
462 static void handle_interrupt (void);
463 static _Noreturn
void quit_throw_to_read_char (int);
464 static void process_special_events (void);
465 static void timer_start_idle (void);
466 static void timer_stop_idle (void);
467 static void timer_resume_idle (void);
468 static void handle_user_signal (int);
469 static char *find_user_signal_name (int);
470 static int store_user_signal_events (void);
473 /* Add C to the echo string, if echoing is going on.
474 C can be a character, which is printed prettily ("M-C-x" and all that
475 jazz), or a symbol, whose name is printed. */
478 echo_char (Lisp_Object c
)
480 if (current_kboard
->immediate_echo
)
482 int size
= KEY_DESCRIPTION_SIZE
+ 100;
483 char *buffer
= alloca (size
);
485 Lisp_Object echo_string
;
487 echo_string
= KVAR (current_kboard
, echo_string
);
489 /* If someone has passed us a composite event, use its head symbol. */
494 ptr
= push_key_description (XINT (c
), ptr
, 1);
496 else if (SYMBOLP (c
))
498 Lisp_Object name
= SYMBOL_NAME (c
);
499 int nbytes
= SBYTES (name
);
501 if (size
- (ptr
- buffer
) < nbytes
)
503 int offset
= ptr
- buffer
;
504 size
= max (2 * size
, size
+ nbytes
);
505 buffer
= alloca (size
);
506 ptr
= buffer
+ offset
;
509 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
510 STRING_MULTIBYTE (name
), 1);
513 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
516 const char *text
= " (Type ? for further options)";
517 int len
= strlen (text
);
519 if (size
- (ptr
- buffer
) < len
)
521 int offset
= ptr
- buffer
;
523 buffer
= alloca (size
);
524 ptr
= buffer
+ offset
;
527 memcpy (ptr
, text
, len
);
531 /* Replace a dash from echo_dash with a space, otherwise
532 add a space at the end as a separator between keys. */
533 if (STRINGP (echo_string
)
534 && SCHARS (echo_string
) > 1)
536 Lisp_Object last_char
, prev_char
, idx
;
538 idx
= make_number (SCHARS (echo_string
) - 2);
539 prev_char
= Faref (echo_string
, idx
);
541 idx
= make_number (SCHARS (echo_string
) - 1);
542 last_char
= Faref (echo_string
, idx
);
544 /* We test PREV_CHAR to make sure this isn't the echoing
546 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
547 Faset (echo_string
, idx
, make_number (' '));
549 echo_string
= concat2 (echo_string
, build_string (" "));
551 else if (STRINGP (echo_string
))
552 echo_string
= concat2 (echo_string
, build_string (" "));
554 KVAR (current_kboard
, echo_string
)
555 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
561 /* Temporarily add a dash to the end of the echo string if it's not
562 empty, so that it serves as a mini-prompt for the very next character. */
567 /* Do nothing if not echoing at all. */
568 if (NILP (KVAR (current_kboard
, echo_string
)))
571 if (this_command_key_count
== 0)
574 if (!current_kboard
->immediate_echo
575 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
578 /* Do nothing if we just printed a prompt. */
579 if (current_kboard
->echo_after_prompt
580 == SCHARS (KVAR (current_kboard
, echo_string
)))
583 /* Do nothing if we have already put a dash at the end. */
584 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
586 Lisp_Object last_char
, prev_char
, idx
;
588 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
589 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
591 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
592 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
594 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
598 /* Put a dash at the end of the buffer temporarily,
599 but make it go away when the next character is added. */
600 KVAR (current_kboard
, echo_string
) = concat2 (KVAR (current_kboard
, echo_string
),
605 /* Display the current echo string, and begin echoing if not already
611 if (!current_kboard
->immediate_echo
)
614 current_kboard
->immediate_echo
= 1;
616 for (i
= 0; i
< this_command_key_count
; i
++)
620 /* Set before_command_echo_length to the value that would
621 have been saved before the start of this subcommand in
622 command_loop_1, if we had already been echoing then. */
623 if (i
== this_single_command_key_start
)
624 before_command_echo_length
= echo_length ();
626 c
= AREF (this_command_keys
, i
);
627 if (! (EVENT_HAS_PARAMETERS (c
)
628 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
632 /* Set before_command_echo_length to the value that would
633 have been saved before the start of this subcommand in
634 command_loop_1, if we had already been echoing then. */
635 if (this_command_key_count
== this_single_command_key_start
)
636 before_command_echo_length
= echo_length ();
638 /* Put a dash at the end to invite the user to type more. */
643 message3_nolog (KVAR (current_kboard
, echo_string
),
644 SBYTES (KVAR (current_kboard
, echo_string
)),
645 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
648 /* Record in what buffer we echoed, and from which kboard. */
649 echo_message_buffer
= echo_area_buffer
[0];
650 echo_kboard
= current_kboard
;
652 if (waiting_for_input
&& !NILP (Vquit_flag
))
653 quit_throw_to_read_char (0);
656 /* Turn off echoing, for the start of a new command. */
659 cancel_echoing (void)
661 current_kboard
->immediate_echo
= 0;
662 current_kboard
->echo_after_prompt
= -1;
663 KVAR (current_kboard
, echo_string
) = Qnil
;
664 ok_to_echo_at_next_pause
= NULL
;
666 echo_message_buffer
= Qnil
;
669 /* Return the length of the current echo string. */
674 return (STRINGP (KVAR (current_kboard
, echo_string
))
675 ? SCHARS (KVAR (current_kboard
, echo_string
))
679 /* Truncate the current echo message to its first LEN chars.
680 This and echo_char get used by read_key_sequence when the user
681 switches frames while entering a key sequence. */
684 echo_truncate (ptrdiff_t nchars
)
686 if (STRINGP (KVAR (current_kboard
, echo_string
)))
687 KVAR (current_kboard
, echo_string
)
688 = Fsubstring (KVAR (current_kboard
, echo_string
),
689 make_number (0), make_number (nchars
));
690 truncate_echo_area (nchars
);
694 /* Functions for manipulating this_command_keys. */
696 add_command_key (Lisp_Object key
)
698 #if 0 /* Not needed after we made Freset_this_command_lengths
699 do the job immediately. */
700 /* If reset-this-command-length was called recently, obey it now.
701 See the doc string of that function for an explanation of why. */
702 if (before_command_restore_flag
)
704 this_command_key_count
= before_command_key_count_1
;
705 if (this_command_key_count
< this_single_command_key_start
)
706 this_single_command_key_start
= this_command_key_count
;
707 echo_truncate (before_command_echo_length_1
);
708 before_command_restore_flag
= 0;
712 if (this_command_key_count
>= ASIZE (this_command_keys
))
713 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
715 ASET (this_command_keys
, this_command_key_count
, key
);
716 ++this_command_key_count
;
721 recursive_edit_1 (void)
723 ptrdiff_t count
= SPECPDL_INDEX ();
726 if (command_loop_level
> 0)
728 specbind (Qstandard_output
, Qt
);
729 specbind (Qstandard_input
, Qt
);
732 #ifdef HAVE_WINDOW_SYSTEM
733 /* The command loop has started an hourglass timer, so we have to
734 cancel it here, otherwise it will fire because the recursive edit
735 can take some time. Do not check for display_hourglass_p here,
736 because it could already be nil. */
740 /* This function may have been called from a debugger called from
741 within redisplay, for instance by Edebugging a function called
742 from fontification-functions. We want to allow redisplay in
743 the debugging session.
745 The recursive edit is left with a `(throw exit ...)'. The `exit'
746 tag is not caught anywhere in redisplay, i.e. when we leave the
747 recursive edit, the original redisplay leading to the recursive
748 edit will be unwound. The outcome should therefore be safe. */
749 specbind (Qinhibit_redisplay
, Qnil
);
752 val
= command_loop ();
754 Fsignal (Qquit
, Qnil
);
755 /* Handle throw from read_minibuf when using minibuffer
756 while it's active but we're in another window. */
758 xsignal1 (Qerror
, val
);
760 return unbind_to (count
, Qnil
);
763 /* When an auto-save happens, record the "time", and don't do again soon. */
766 record_auto_save (void)
768 last_auto_save
= num_nonmacro_input_events
;
771 /* Make an auto save happen as soon as possible at command level. */
775 force_auto_save_soon (void)
777 last_auto_save
= - auto_save_interval
- 1;
779 record_asynch_buffer_change ();
783 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
784 doc
: /* Invoke the editor command loop recursively.
785 To get out of the recursive edit, a command can do `(throw 'exit nil)';
786 that tells this function to return.
787 Alternatively, `(throw 'exit t)' makes this function signal an error.
788 This function is called by the editor initialization to begin editing. */)
791 ptrdiff_t count
= SPECPDL_INDEX ();
794 /* If we enter while input is blocked, don't lock up here.
795 This may happen through the debugger during redisplay. */
799 command_loop_level
++;
800 update_mode_lines
= 1;
802 if (command_loop_level
803 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
804 buffer
= Fcurrent_buffer ();
808 /* If we leave recursive_edit_1 below with a `throw' for instance,
809 like it is done in the splash screen display, we have to
810 make sure that we restore single_kboard as command_loop_1
811 would have done if it were left normally. */
812 if (command_loop_level
> 0)
813 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
814 record_unwind_protect (recursive_edit_unwind
, buffer
);
817 return unbind_to (count
, Qnil
);
821 recursive_edit_unwind (Lisp_Object buffer
)
823 if (BUFFERP (buffer
))
824 Fset_buffer (buffer
);
826 command_loop_level
--;
827 update_mode_lines
= 1;
832 #if 0 /* These two functions are now replaced with
833 temporarily_switch_to_single_kboard. */
837 #if 0 /* Theory: if there's anything in Vunread_command_events,
838 it will right away be read by read_key_sequence,
839 and then if we do switch KBOARDS, it will go into the side
840 queue then. So we don't need to do anything special here -- rms. */
841 if (CONSP (Vunread_command_events
))
843 current_kboard
->kbd_queue
844 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
845 current_kboard
->kbd_queue_has_data
= 1;
847 Vunread_command_events
= Qnil
;
852 /* Switch to the single-kboard state, making current_kboard
853 the only KBOARD from which further input is accepted. */
856 single_kboard_state ()
862 /* If we're in single_kboard state for kboard KBOARD,
866 not_single_kboard_state (KBOARD
*kboard
)
868 if (kboard
== current_kboard
)
872 /* Maintain a stack of kboards, so other parts of Emacs
873 can switch temporarily to the kboard of a given frame
874 and then revert to the previous status. */
879 struct kboard_stack
*next
;
882 static struct kboard_stack
*kboard_stack
;
885 push_kboard (struct kboard
*k
)
887 struct kboard_stack
*p
= xmalloc (sizeof *p
);
889 p
->next
= kboard_stack
;
890 p
->kboard
= current_kboard
;
900 struct kboard_stack
*p
= kboard_stack
;
902 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
904 if (t
->kboard
== p
->kboard
)
906 current_kboard
= p
->kboard
;
913 /* The terminal we remembered has been deleted. */
914 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
917 kboard_stack
= p
->next
;
921 /* Switch to single_kboard mode, making current_kboard the only KBOARD
922 from which further input is accepted. If F is non-nil, set its
923 KBOARD as the current keyboard.
925 This function uses record_unwind_protect to return to the previous
928 If Emacs is already in single_kboard mode, and F's keyboard is
929 locked, then this function will throw an error. */
932 temporarily_switch_to_single_kboard (struct frame
*f
)
934 int was_locked
= single_kboard
;
937 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
938 /* We can not switch keyboards while in single_kboard mode.
939 In rare cases, Lisp code may call `recursive-edit' (or
940 `read-minibuffer' or `y-or-n-p') after it switched to a
941 locked frame. For example, this is likely to happen
942 when server.el connects to a new terminal while Emacs is in
943 single_kboard mode. It is best to throw an error instead
944 of presenting the user with a frozen screen. */
945 error ("Terminal %d is locked, cannot read from it",
946 FRAME_TERMINAL (f
)->id
);
948 /* This call is unnecessary, but helps
949 `restore_kboard_configuration' discover if somebody changed
950 `current_kboard' behind our back. */
951 push_kboard (current_kboard
);
954 current_kboard
= FRAME_KBOARD (f
);
956 record_unwind_protect (restore_kboard_configuration
,
957 (was_locked
? Qt
: Qnil
));
960 #if 0 /* This function is not needed anymore. */
962 record_single_kboard_state ()
965 push_kboard (current_kboard
);
966 record_unwind_protect (restore_kboard_configuration
,
967 (single_kboard
? Qt
: Qnil
));
972 restore_kboard_configuration (Lisp_Object was_locked
)
974 if (NILP (was_locked
))
978 struct kboard
*prev
= current_kboard
;
981 /* The pop should not change the kboard. */
982 if (single_kboard
&& current_kboard
!= prev
)
989 /* Handle errors that are not handled at inner levels
990 by printing an error message and returning to the editor command loop. */
993 cmd_error (Lisp_Object data
)
995 Lisp_Object old_level
, old_length
;
996 char macroerror
[sizeof "After..kbd macro iterations: "
997 + INT_STRLEN_BOUND (EMACS_INT
)];
999 #ifdef HAVE_WINDOW_SYSTEM
1000 if (display_hourglass_p
)
1001 cancel_hourglass ();
1004 if (!NILP (executing_kbd_macro
))
1006 if (executing_kbd_macro_iterations
== 1)
1007 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1009 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1010 executing_kbd_macro_iterations
);
1015 Vstandard_output
= Qt
;
1016 Vstandard_input
= Qt
;
1017 Vexecuting_kbd_macro
= Qnil
;
1018 executing_kbd_macro
= Qnil
;
1019 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1020 KVAR (current_kboard
, Vlast_prefix_arg
) = Qnil
;
1023 /* Avoid unquittable loop if data contains a circular list. */
1024 old_level
= Vprint_level
;
1025 old_length
= Vprint_length
;
1026 XSETFASTINT (Vprint_level
, 10);
1027 XSETFASTINT (Vprint_length
, 10);
1028 cmd_error_internal (data
, macroerror
);
1029 Vprint_level
= old_level
;
1030 Vprint_length
= old_length
;
1034 Vinhibit_quit
= Qnil
;
1035 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1036 if (command_loop_level
== 0 && minibuf_level
== 0)
1037 any_kboard_state ();
1040 return make_number (0);
1043 /* Take actions on handling an error. DATA is the data that describes
1046 CONTEXT is a C-string containing ASCII characters only which
1047 describes the context in which the error happened. If we need to
1048 generalize CONTEXT to allow multibyte characters, make it a Lisp
1052 cmd_error_internal (Lisp_Object data
, const char *context
)
1054 struct frame
*sf
= SELECTED_FRAME ();
1056 /* The immediate context is not interesting for Quits,
1057 since they are asynchronous. */
1058 if (EQ (XCAR (data
), Qquit
))
1059 Vsignaling_function
= Qnil
;
1064 /* Use user's specified output function if any. */
1065 if (!NILP (Vcommand_error_function
))
1066 call3 (Vcommand_error_function
, data
,
1067 context
? build_string (context
) : empty_unibyte_string
,
1068 Vsignaling_function
);
1069 /* If the window system or terminal frame hasn't been initialized
1070 yet, or we're not interactive, write the message to stderr and exit. */
1071 else if (!sf
->glyphs_initialized_p
1072 /* The initial frame is a special non-displaying frame. It
1073 will be current in daemon mode when there are no frames
1074 to display, and in non-daemon mode before the real frame
1075 has finished initializing. If an error is thrown in the
1076 latter case while creating the frame, then the frame
1077 will never be displayed, so the safest thing to do is
1078 write to stderr and quit. In daemon mode, there are
1079 many other potential errors that do not prevent frames
1080 from being created, so continuing as normal is better in
1082 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1085 print_error_message (data
, Qexternal_debugging_output
,
1086 context
, Vsignaling_function
);
1087 Fterpri (Qexternal_debugging_output
);
1088 Fkill_emacs (make_number (-1));
1092 clear_message (1, 0);
1094 message_log_maybe_newline ();
1097 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1100 Vsignaling_function
= Qnil
;
1103 Lisp_Object
command_loop_1 (void);
1104 static Lisp_Object
command_loop_2 (Lisp_Object
);
1105 static Lisp_Object
top_level_1 (Lisp_Object
);
1107 /* Entry to editor-command-loop.
1108 This level has the catches for exiting/returning to editor command loop.
1109 It returns nil to exit recursive edit, t to abort it. */
1114 if (command_loop_level
> 0 || minibuf_level
> 0)
1117 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1118 executing_kbd_macro
= Qnil
;
1124 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1125 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1126 /* Reset single_kboard in case top-level set it while
1127 evaluating an -f option, or we are stuck there for some
1129 any_kboard_state ();
1131 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1132 executing_kbd_macro
= Qnil
;
1134 /* End of file in -batch run causes exit here. */
1140 /* Here we catch errors in execution of commands within the
1141 editing loop, and reenter the editing loop.
1142 When there is an error, cmd_error runs and returns a non-nil
1143 value to us. A value of nil means that command_loop_1 itself
1144 returned due to end of file (or end of kbd macro). */
1147 command_loop_2 (Lisp_Object ignore
)
1149 register Lisp_Object val
;
1152 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1153 while (!NILP (val
));
1161 return Feval (Vtop_level
, Qnil
);
1165 top_level_1 (Lisp_Object ignore
)
1167 /* On entry to the outer level, run the startup file */
1168 if (!NILP (Vtop_level
))
1169 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1170 else if (!NILP (Vpurify_flag
))
1171 message ("Bare impure Emacs (standard Lisp code not loaded)");
1173 message ("Bare Emacs (standard Lisp code not loaded)");
1177 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1178 doc
: /* Exit all recursive editing levels.
1179 This also exits all active minibuffers. */)
1182 #ifdef HAVE_WINDOW_SYSTEM
1183 if (display_hourglass_p
)
1184 cancel_hourglass ();
1187 /* Unblock input if we enter with input blocked. This may happen if
1188 redisplay traps e.g. during tool-bar update with input blocked. */
1189 while (INPUT_BLOCKED_P
)
1192 Fthrow (Qtop_level
, Qnil
);
1195 static _Noreturn
void
1196 user_error (const char *msg
)
1198 xsignal1 (Quser_error
, build_string (msg
));
1202 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1203 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1206 if (command_loop_level
> 0 || minibuf_level
> 0)
1207 Fthrow (Qexit
, Qnil
);
1209 user_error ("No recursive edit is in progress");
1213 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1214 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1217 if (command_loop_level
> 0 || minibuf_level
> 0)
1220 user_error ("No recursive edit is in progress");
1223 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1225 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1226 of this function. */
1229 tracking_off (Lisp_Object old_value
)
1231 do_mouse_tracking
= old_value
;
1232 if (NILP (old_value
))
1234 /* Redisplay may have been preempted because there was input
1235 available, and it assumes it will be called again after the
1236 input has been processed. If the only input available was
1237 the sort that we have just disabled, then we need to call
1239 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1241 redisplay_preserve_echo_area (6);
1242 get_input_pending (&input_pending
,
1243 READABLE_EVENTS_DO_TIMERS_NOW
);
1249 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1250 doc
: /* Evaluate BODY with mouse movement events enabled.
1251 Within a `track-mouse' form, mouse motion generates input events that
1252 you can read with `read-event'.
1253 Normally, mouse motion is ignored.
1254 usage: (track-mouse BODY...) */)
1257 ptrdiff_t count
= SPECPDL_INDEX ();
1260 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1262 do_mouse_tracking
= Qt
;
1264 val
= Fprogn (args
);
1265 return unbind_to (count
, val
);
1268 /* If mouse has moved on some frame, return one of those frames.
1272 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1273 after resizing the tool-bar window. */
1275 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1278 int ignore_mouse_drag_p
;
1281 some_mouse_moved (void)
1283 Lisp_Object tail
, frame
;
1285 if (ignore_mouse_drag_p
)
1287 /* ignore_mouse_drag_p = 0; */
1291 FOR_EACH_FRAME (tail
, frame
)
1293 if (XFRAME (frame
)->mouse_moved
)
1294 return XFRAME (frame
);
1300 #endif /* HAVE_MOUSE || HAVE_GPM */
1302 /* This is the actual command reading loop,
1303 sans error-handling encapsulation. */
1305 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1307 void safe_run_hooks (Lisp_Object
);
1308 static void adjust_point_for_property (ptrdiff_t, int);
1310 /* Cancel hourglass from protect_unwind.
1312 #ifdef HAVE_WINDOW_SYSTEM
1314 cancel_hourglass_unwind (Lisp_Object arg
)
1316 cancel_hourglass ();
1321 /* The last boundary auto-added to buffer-undo-list. */
1322 Lisp_Object last_undo_boundary
;
1324 /* FIXME: This is wrong rather than test window-system, we should call
1325 a new set-selection, which will then dispatch to x-set-selection, or
1326 tty-set-selection, or w32-set-selection, ... */
1329 command_loop_1 (void)
1332 Lisp_Object keybuf
[30];
1334 EMACS_INT prev_modiff
= 0;
1335 struct buffer
*prev_buffer
= NULL
;
1336 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1337 int was_locked
= single_kboard
;
1339 int already_adjusted
= 0;
1341 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1342 KVAR (current_kboard
, Vlast_prefix_arg
) = 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 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1375 KVAR (current_kboard
, Vreal_last_command
) = Vreal_this_command
;
1376 if (!CONSP (last_command_event
))
1377 KVAR (current_kboard
, Vlast_repeatable_command
) = Vreal_this_command
;
1381 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1384 /* Make sure the current window's buffer is selected. */
1385 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1386 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1388 /* Display any malloc warning that just came out. Use while because
1389 displaying one warning can cause another. */
1391 while (pending_malloc_warning
)
1392 display_malloc_warning ();
1394 Vdeactivate_mark
= Qnil
;
1396 /* If minibuffer on and echo area in use,
1397 wait a short time and redraw minibuffer. */
1400 && !NILP (echo_area_buffer
[0])
1401 && EQ (minibuf_window
, echo_area_window
)
1402 && NUMBERP (Vminibuffer_message_timeout
))
1404 /* Bind inhibit-quit to t so that C-g gets read in
1405 rather than quitting back to the minibuffer. */
1406 ptrdiff_t count
= SPECPDL_INDEX ();
1407 specbind (Qinhibit_quit
, Qt
);
1409 sit_for (Vminibuffer_message_timeout
, 0, 2);
1411 /* Clear the echo area. */
1413 safe_run_hooks (Qecho_area_clear_hook
);
1415 unbind_to (count
, Qnil
);
1417 /* If a C-g came in before, treat it as input now. */
1418 if (!NILP (Vquit_flag
))
1421 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1426 /* Select the frame that the last event came from. Usually,
1427 switch-frame events will take care of this, but if some lisp
1428 code swallows a switch-frame event, we'll fix things up here.
1429 Is this a good idea? */
1430 if (FRAMEP (internal_last_event_frame
)
1431 && !EQ (internal_last_event_frame
, selected_frame
))
1432 Fselect_frame (internal_last_event_frame
, Qnil
);
1434 /* If it has changed current-menubar from previous value,
1435 really recompute the menubar from the value. */
1436 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1437 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1438 call0 (Qrecompute_lucid_menubar
);
1440 before_command_key_count
= this_command_key_count
;
1441 before_command_echo_length
= echo_length ();
1443 Vthis_command
= Qnil
;
1444 Vreal_this_command
= Qnil
;
1445 Vthis_original_command
= Qnil
;
1446 Vthis_command_keys_shift_translated
= Qnil
;
1448 /* Read next key sequence; i gets its length. */
1449 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1452 /* A filter may have run while we were reading the input. */
1453 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1455 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1456 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1460 /* Now we have read a key sequence of length I,
1461 or else I is 0 and we found end of file. */
1463 if (i
== 0) /* End of file -- happens only in */
1464 return Qnil
; /* a kbd macro, at the end. */
1465 /* -1 means read_key_sequence got a menu that was rejected.
1466 Just loop around and read another command. */
1470 this_command_key_count
= 0;
1471 this_command_key_count_reset
= 0;
1472 this_single_command_key_start
= 0;
1476 last_command_event
= keybuf
[i
- 1];
1478 /* If the previous command tried to force a specific window-start,
1479 forget about that, in case this command moves point far away
1480 from that position. But also throw away beg_unchanged and
1481 end_unchanged information in that case, so that redisplay will
1482 update the whole window properly. */
1483 if (XWINDOW (selected_window
)->force_start
)
1486 XWINDOW (selected_window
)->force_start
= 0;
1487 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1488 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1491 cmd
= read_key_sequence_cmd
;
1492 if (!NILP (Vexecuting_kbd_macro
))
1494 if (!NILP (Vquit_flag
))
1496 Vexecuting_kbd_macro
= Qt
;
1497 QUIT
; /* Make some noise. */
1498 /* Will return since macro now empty. */
1502 /* Do redisplay processing after this command except in special
1503 cases identified below. */
1504 prev_buffer
= current_buffer
;
1505 prev_modiff
= MODIFF
;
1506 last_point_position
= PT
;
1507 last_point_position_window
= selected_window
;
1508 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1510 /* By default, we adjust point to a boundary of a region that
1511 has such a property that should be treated intangible
1512 (e.g. composition, display). But, some commands will set
1513 this variable differently. */
1514 Vdisable_point_adjustment
= Qnil
;
1516 /* Process filters and timers may have messed with deactivate-mark.
1517 reset it before we execute the command. */
1518 Vdeactivate_mark
= Qnil
;
1520 /* Remap command through active keymaps. */
1521 Vthis_original_command
= cmd
;
1522 if (!NILP (read_key_sequence_remapped
))
1523 cmd
= read_key_sequence_remapped
;
1525 /* Execute the command. */
1527 Vthis_command
= cmd
;
1528 Vreal_this_command
= cmd
;
1529 safe_run_hooks (Qpre_command_hook
);
1531 already_adjusted
= 0;
1533 if (NILP (Vthis_command
))
1535 /* nil means key is undefined. */
1536 Lisp_Object keys
= Fvector (i
, keybuf
);
1537 keys
= Fkey_description (keys
, Qnil
);
1539 message_with_string ("%s is undefined", keys
, 0);
1540 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
1541 update_mode_lines
= 1;
1542 /* If this is a down-mouse event, don't reset prefix-arg;
1543 pass it to the command run by the up event. */
1544 if (EVENT_HAS_PARAMETERS (last_command_event
))
1546 Lisp_Object breakdown
1547 = parse_modifiers (EVENT_HEAD (last_command_event
));
1548 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1549 if (!(modifiers
& down_modifier
))
1550 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1553 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
1557 /* Here for a command that isn't executed directly. */
1559 #ifdef HAVE_WINDOW_SYSTEM
1560 ptrdiff_t scount
= SPECPDL_INDEX ();
1562 if (display_hourglass_p
1563 && NILP (Vexecuting_kbd_macro
))
1565 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1570 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1572 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1575 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1576 ? Qnil
: BVAR (current_buffer
, undo_list
));
1578 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1580 #ifdef HAVE_WINDOW_SYSTEM
1581 /* Do not check display_hourglass_p here, because
1582 Fcommand_execute could change it, but we should cancel
1583 hourglass cursor anyway.
1584 But don't cancel the hourglass within a macro
1585 just because a command in the macro finishes. */
1586 if (NILP (Vexecuting_kbd_macro
))
1587 unbind_to (scount
, Qnil
);
1590 KVAR (current_kboard
, Vlast_prefix_arg
) = Vcurrent_prefix_arg
;
1592 safe_run_hooks (Qpost_command_hook
);
1594 /* If displaying a message, resize the echo area window to fit
1595 that message's size exactly. */
1596 if (!NILP (echo_area_buffer
[0]))
1597 resize_echo_area_exactly ();
1599 /* If there are warnings waiting, process them. */
1600 if (!NILP (Vdelayed_warnings_list
))
1601 safe_run_hooks (Qdelayed_warnings_hook
);
1603 safe_run_hooks (Qdeferred_action_function
);
1605 /* If there is a prefix argument,
1606 1) We don't want Vlast_command to be ``universal-argument''
1607 (that would be dumb), so don't set Vlast_command,
1608 2) we want to leave echoing on so that the prefix will be
1609 echoed as part of this key sequence, so don't call
1611 3) we want to leave this_command_key_count non-zero, so that
1612 read_char will realize that it is re-reading a character, and
1613 not echo it a second time.
1615 If the command didn't actually create a prefix arg,
1616 but is merely a frame event that is transparent to prefix args,
1617 then the above doesn't apply. */
1618 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1619 || CONSP (last_command_event
))
1621 KVAR (current_kboard
, Vlast_command
) = Vthis_command
;
1622 KVAR (current_kboard
, Vreal_last_command
) = Vreal_this_command
;
1623 if (!CONSP (last_command_event
))
1624 KVAR (current_kboard
, Vlast_repeatable_command
)
1625 = Vreal_this_command
;
1627 this_command_key_count
= 0;
1628 this_command_key_count_reset
= 0;
1629 this_single_command_key_start
= 0;
1632 if (!NILP (BVAR (current_buffer
, mark_active
))
1633 && !NILP (Vrun_hooks
))
1635 /* In Emacs 22, setting transient-mark-mode to `only' was a
1636 way of turning it on for just one command. This usage is
1637 obsolete, but support it anyway. */
1638 if (EQ (Vtransient_mark_mode
, Qidentity
))
1639 Vtransient_mark_mode
= Qnil
;
1640 else if (EQ (Vtransient_mark_mode
, Qonly
))
1641 Vtransient_mark_mode
= Qidentity
;
1643 if (!NILP (Vdeactivate_mark
))
1644 /* If `select-active-regions' is non-nil, this call to
1645 `deactivate-mark' also sets the PRIMARY selection. */
1646 call0 (Qdeactivate_mark
);
1649 /* Even if not deactivating the mark, set PRIMARY if
1650 `select-active-regions' is non-nil. */
1651 if (!NILP (Fwindow_system (Qnil
))
1652 /* Even if mark_active is non-nil, the actual buffer
1653 marker may not have been set yet (Bug#7044). */
1654 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1655 && (EQ (Vselect_active_regions
, Qonly
)
1656 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1657 : (!NILP (Vselect_active_regions
)
1658 && !NILP (Vtransient_mark_mode
)))
1659 && NILP (Fmemq (Vthis_command
,
1660 Vselection_inhibit_update_commands
)))
1663 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1666 call2 (Qx_set_selection
, QPRIMARY
,
1667 make_buffer_string (beg
, end
, 0));
1669 call2 (Qx_set_selection
, QPRIMARY
,
1670 make_buffer_string (end
, beg
, 0));
1671 /* Don't set empty selections. */
1674 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1676 Lisp_Object hook
= intern ("activate-mark-hook");
1677 Frun_hooks (1, &hook
);
1681 Vsaved_region_selection
= Qnil
;
1686 if (current_buffer
== prev_buffer
1687 && last_point_position
!= PT
1688 && NILP (Vdisable_point_adjustment
)
1689 && NILP (Vglobal_disable_point_adjustment
))
1691 if (last_point_position
> BEGV
1692 && last_point_position
< ZV
1693 && (composition_adjust_point (last_point_position
,
1694 last_point_position
)
1695 != last_point_position
))
1696 /* The last point was temporarily set within a grapheme
1697 cluster to prevent automatic composition. To recover
1698 the automatic composition, we must update the
1700 windows_or_buffers_changed
++;
1701 if (!already_adjusted
)
1702 adjust_point_for_property (last_point_position
,
1703 MODIFF
!= prev_modiff
);
1706 /* Install chars successfully executed in kbd macro. */
1708 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1709 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1710 finalize_kbd_macro_chars ();
1711 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1713 any_kboard_state ();
1718 /* Adjust point to a boundary of a region that has such a property
1719 that should be treated intangible. For the moment, we check
1720 `composition', `display' and `invisible' properties.
1721 LAST_PT is the last position of point. */
1724 adjust_point_for_property (ptrdiff_t last_pt
, int modified
)
1727 Lisp_Object val
, overlay
, tmp
;
1728 /* When called after buffer modification, we should temporarily
1729 suppress the point adjustment for automatic composition so that a
1730 user can keep inserting another character at point or keep
1731 deleting characters around point. */
1732 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1733 ptrdiff_t orig_pt
= PT
;
1735 /* FIXME: cycling is probably not necessary because these properties
1736 can't be usefully combined anyway. */
1737 while (check_composition
|| check_display
|| check_invisible
)
1739 /* FIXME: check `intangible'. */
1740 if (check_composition
1741 && PT
> BEGV
&& PT
< ZV
1742 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1745 check_display
= check_invisible
= 1;
1747 check_composition
= 0;
1749 && PT
> BEGV
&& PT
< ZV
1750 && !NILP (val
= get_char_property_and_overlay
1751 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1752 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1753 && (!OVERLAYP (overlay
)
1754 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1755 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1756 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1757 && (beg
< PT
/* && end > PT <- It's always the case. */
1758 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1761 SET_PT (PT
< last_pt
1762 ? (STRINGP (val
) && SCHARS (val
) == 0
1763 ? max (beg
- 1, BEGV
)
1766 check_composition
= check_invisible
= 1;
1769 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1771 int inv
, ellipsis
= 0;
1774 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1777 /* FIXME: We should stop if we find a spot between
1778 two runs of `invisible' where inserted text would
1779 be visible. This is important when we have two
1780 invisible boundaries that enclose an area: if the
1781 area is empty, we need this test in order to make
1782 it possible to place point in the middle rather
1783 than skip both boundaries. However, this code
1784 also stops anywhere in a non-sticky text-property,
1785 which breaks (e.g.) Org mode. */
1786 && (val
= get_pos_property (make_number (end
),
1788 TEXT_PROP_MEANS_INVISIBLE (val
))
1790 && !NILP (val
= get_char_property_and_overlay
1791 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1792 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1794 ellipsis
= ellipsis
|| inv
> 1
1795 || (OVERLAYP (overlay
)
1796 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1797 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1798 tmp
= Fnext_single_char_property_change
1799 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1800 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1804 && (val
= get_pos_property (make_number (beg
),
1806 TEXT_PROP_MEANS_INVISIBLE (val
))
1808 && !NILP (val
= get_char_property_and_overlay
1809 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1810 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1812 ellipsis
= ellipsis
|| inv
> 1
1813 || (OVERLAYP (overlay
)
1814 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1815 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1816 tmp
= Fprevious_single_char_property_change
1817 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1818 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1821 /* Move away from the inside area. */
1822 if (beg
< PT
&& end
> PT
)
1824 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1825 /* We haven't moved yet (so we don't need to fear
1826 infinite-looping) and we were outside the range
1827 before (so either end of the range still corresponds
1828 to a move in the right direction): pretend we moved
1829 less than we actually did, so that we still have
1830 more freedom below in choosing which end of the range
1832 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1833 /* We either have moved already or the last point
1834 was already in the range: we don't get to choose
1835 which end of the range we have to go to. */
1836 : (PT
< last_pt
? beg
: end
));
1837 check_composition
= check_display
= 1;
1839 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1840 the point to something other than its argument, due to
1841 point-motion hooks, intangibility, etc. */
1842 eassert (PT
== beg
|| PT
== end
);
1845 /* Pretend the area doesn't exist if the buffer is not
1847 if (!modified
&& !ellipsis
&& beg
< end
)
1849 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1850 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1851 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1852 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1853 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1854 /* We've already moved as far as we can. Trying to go
1855 to the other end would mean moving backwards and thus
1856 could lead to an infinite loop. */
1858 else if (val
= get_pos_property (make_number (PT
),
1860 TEXT_PROP_MEANS_INVISIBLE (val
)
1861 && (val
= get_pos_property
1862 (make_number (PT
== beg
? end
: beg
),
1864 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1865 (check_composition
= check_display
= 1,
1866 SET_PT (PT
== beg
? end
: beg
));
1869 check_invisible
= 0;
1873 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1876 safe_run_hooks_1 (void)
1878 eassert (CONSP (Vinhibit_quit
));
1879 return call0 (XCDR (Vinhibit_quit
));
1882 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1886 safe_run_hooks_error (Lisp_Object error_data
)
1889 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1890 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1891 Lisp_Object args
[4];
1892 args
[0] = build_string ("Error in %s (%s): %S");
1895 args
[3] = error_data
;
1901 Lisp_Object newval
= Qnil
;
1902 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1903 if (EQ (fun
, XCAR (val
)))
1906 newval
= Fcons (XCAR (val
), newval
);
1908 return Fset (hook
, Fnreverse (newval
));
1909 /* Not found in the local part of the hook. Let's look at the global
1912 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1913 : Fdefault_value (hook
));
1914 CONSP (val
); val
= XCDR (val
))
1915 if (EQ (fun
, XCAR (val
)))
1918 newval
= Fcons (XCAR (val
), newval
);
1920 return Fset_default (hook
, Fnreverse (newval
));
1926 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1928 eassert (nargs
== 1);
1929 if (CONSP (Vinhibit_quit
))
1930 XSETCDR (Vinhibit_quit
, args
[0]);
1932 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1934 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1938 /* If we get an error while running the hook, cause the hook variable
1939 to be nil. Also inhibit quits, so that C-g won't cause the hook
1940 to mysteriously evaporate. */
1943 safe_run_hooks (Lisp_Object hook
)
1945 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1946 to its body or to its handlers other than via globals such as
1947 dynamically-bound variables ;-) */
1948 ptrdiff_t count
= SPECPDL_INDEX ();
1949 specbind (Qinhibit_quit
, hook
);
1951 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1953 unbind_to (count
, Qnil
);
1957 /* Nonzero means polling for input is temporarily suppressed. */
1959 int poll_suppress_count
;
1961 /* Asynchronous timer for polling. */
1963 static struct atimer
*poll_timer
;
1966 #ifdef POLL_FOR_INPUT
1968 /* Poll for input, so that we catch a C-g if it comes in. This
1969 function is called from x_make_frame_visible, see comment
1973 poll_for_input_1 (void)
1975 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
1976 doing anything dangerous. */
1980 if (interrupt_input_blocked
== 0
1981 && !waiting_for_input
)
1982 read_avail_input (0);
1988 /* Timer callback function for poll_timer. TIMER is equal to
1992 poll_for_input (struct atimer
*timer
)
1994 if (poll_suppress_count
== 0)
1997 interrupt_input_pending
= 1;
1998 pending_signals
= 1;
2000 poll_for_input_1 ();
2005 #endif /* POLL_FOR_INPUT */
2007 /* Begin signals to poll for input, if they are appropriate.
2008 This function is called unconditionally from various places. */
2011 start_polling (void)
2013 #ifdef POLL_FOR_INPUT
2014 /* XXX This condition was (read_socket_hook && !interrupt_input),
2015 but read_socket_hook is not global anymore. Let's pretend that
2017 if (!interrupt_input
)
2019 /* Turn alarm handling on unconditionally. It might have
2020 been turned off in process.c. */
2021 turn_on_atimers (1);
2023 /* If poll timer doesn't exist, are we need one with
2024 a different interval, start a new one. */
2025 if (poll_timer
== NULL
2026 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2028 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2029 EMACS_TIME interval
= make_emacs_time (period
, 0);
2032 cancel_atimer (poll_timer
);
2034 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2035 poll_for_input
, NULL
);
2038 /* Let the timer's callback function poll for input
2039 if this becomes zero. */
2040 --poll_suppress_count
;
2045 /* Nonzero if we are using polling to handle input asynchronously. */
2048 input_polling_used (void)
2050 #ifdef POLL_FOR_INPUT
2051 /* XXX This condition was (read_socket_hook && !interrupt_input),
2052 but read_socket_hook is not global anymore. Let's pretend that
2054 return !interrupt_input
;
2060 /* Turn off polling. */
2065 #ifdef POLL_FOR_INPUT
2066 /* XXX This condition was (read_socket_hook && !interrupt_input),
2067 but read_socket_hook is not global anymore. Let's pretend that
2069 if (!interrupt_input
)
2070 ++poll_suppress_count
;
2074 /* Set the value of poll_suppress_count to COUNT
2075 and start or stop polling accordingly. */
2078 set_poll_suppress_count (int count
)
2080 #ifdef POLL_FOR_INPUT
2081 if (count
== 0 && poll_suppress_count
!= 0)
2083 poll_suppress_count
= 1;
2086 else if (count
!= 0 && poll_suppress_count
== 0)
2090 poll_suppress_count
= count
;
2094 /* Bind polling_period to a value at least N.
2095 But don't decrease it. */
2098 bind_polling_period (int n
)
2100 #ifdef POLL_FOR_INPUT
2101 EMACS_INT
new = polling_period
;
2106 stop_other_atimers (poll_timer
);
2108 specbind (Qpolling_period
, make_number (new));
2109 /* Start a new alarm with the new period. */
2114 /* Apply the control modifier to CHARACTER. */
2117 make_ctrl_char (int c
)
2119 /* Save the upper bits here. */
2120 int upper
= c
& ~0177;
2122 if (! ASCII_BYTE_P (c
))
2123 return c
|= ctrl_modifier
;
2127 /* Everything in the columns containing the upper-case letters
2128 denotes a control character. */
2129 if (c
>= 0100 && c
< 0140)
2133 /* Set the shift modifier for a control char
2134 made from a shifted letter. But only for letters! */
2135 if (oc
>= 'A' && oc
<= 'Z')
2136 c
|= shift_modifier
;
2139 /* The lower-case letters denote control characters too. */
2140 else if (c
>= 'a' && c
<= 'z')
2143 /* Include the bits for control and shift
2144 only if the basic ASCII code can't indicate them. */
2148 /* Replace the high bits. */
2149 c
|= (upper
& ~ctrl_modifier
);
2154 /* Display the help-echo property of the character after the mouse pointer.
2155 Either show it in the echo area, or call show-help-function to display
2156 it by other means (maybe in a tooltip).
2158 If HELP is nil, that means clear the previous help echo.
2160 If HELP is a string, display that string. If HELP is a function,
2161 call it with OBJECT and POS as arguments; the function should
2162 return a help string or nil for none. For all other types of HELP,
2163 evaluate it to obtain a string.
2165 WINDOW is the window in which the help was generated, if any.
2166 It is nil if not in a window.
2168 If OBJECT is a buffer, POS is the position in the buffer where the
2169 `help-echo' text property was found.
2171 If OBJECT is an overlay, that overlay has a `help-echo' property,
2172 and POS is the position in the overlay's buffer under the mouse.
2174 If OBJECT is a string (an overlay string or a string displayed with
2175 the `display' property). POS is the position in that string under
2178 Note: this function may only be called with HELP nil or a string
2179 from X code running asynchronously. */
2182 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2185 if (!NILP (help
) && !STRINGP (help
))
2187 if (FUNCTIONP (help
))
2189 Lisp_Object args
[4];
2194 help
= safe_call (4, args
);
2197 help
= safe_eval (help
);
2199 if (!STRINGP (help
))
2203 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2204 if (!noninteractive
&& STRINGP (help
))
2206 /* The mouse-fixup-help-message Lisp function can call
2207 mouse_position_hook, which resets the mouse_moved flags.
2208 This causes trouble if we are trying to read a mouse motion
2209 event (i.e., if we are inside a `track-mouse' form), so we
2210 restore the mouse_moved flag. */
2211 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2212 help
= call1 (Qmouse_fixup_help_message
, help
);
2218 if (STRINGP (help
) || NILP (help
))
2220 if (!NILP (Vshow_help_function
))
2221 call1 (Vshow_help_function
, help
);
2222 help_echo_showing_p
= STRINGP (help
);
2228 /* Input of single characters from keyboard */
2230 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2231 EMACS_TIME
*end_time
);
2232 static void record_char (Lisp_Object c
);
2234 static Lisp_Object help_form_saved_window_configs
;
2236 read_char_help_form_unwind (Lisp_Object arg
)
2238 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2239 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2240 if (!NILP (window_config
))
2241 Fset_window_configuration (window_config
);
2245 #define STOP_POLLING \
2246 do { if (! polling_stopped_here) stop_polling (); \
2247 polling_stopped_here = 1; } while (0)
2249 #define RESUME_POLLING \
2250 do { if (polling_stopped_here) start_polling (); \
2251 polling_stopped_here = 0; } while (0)
2253 /* read a character from the keyboard; call the redisplay if needed */
2254 /* commandflag 0 means do not autosave, but do redisplay.
2255 -1 means do not redisplay, but do autosave.
2258 /* The arguments MAPS and NMAPS are for menu prompting.
2259 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2261 PREV_EVENT is the previous input event, or nil if we are reading
2262 the first event of a key sequence (or not reading a key sequence).
2263 If PREV_EVENT is t, that is a "magic" value that says
2264 not to run input methods, but in other respects to act as if
2265 not reading a key sequence.
2267 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2268 if we used a mouse menu to read the input, or zero otherwise. If
2269 USED_MOUSE_MENU is null, we don't dereference it.
2271 Value is -2 when we find input on another keyboard. A second call
2272 to read_char will read it.
2274 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2275 specifying the maximum time to wait until. If no input arrives by
2276 that time, stop waiting and return nil.
2278 Value is t if we showed a menu and the user rejected it. */
2281 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2282 Lisp_Object prev_event
,
2283 int *used_mouse_menu
, EMACS_TIME
*end_time
)
2285 volatile Lisp_Object c
;
2287 jmp_buf local_getcjmp
;
2289 volatile int key_already_recorded
= 0;
2290 Lisp_Object tem
, save
;
2291 volatile Lisp_Object previous_echo_area_message
;
2292 volatile Lisp_Object also_record
;
2293 volatile int reread
;
2294 struct gcpro gcpro1
, gcpro2
;
2295 int volatile polling_stopped_here
= 0;
2296 struct kboard
*orig_kboard
= current_kboard
;
2300 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2301 before_command_key_count
= this_command_key_count
;
2302 before_command_echo_length
= echo_length ();
2305 previous_echo_area_message
= Qnil
;
2307 GCPRO2 (c
, previous_echo_area_message
);
2312 if (CONSP (Vunread_post_input_method_events
))
2314 c
= XCAR (Vunread_post_input_method_events
);
2315 Vunread_post_input_method_events
2316 = XCDR (Vunread_post_input_method_events
);
2318 /* Undo what read_char_x_menu_prompt did when it unread
2319 additional keys returned by Fx_popup_menu. */
2321 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2329 if (unread_command_char
!= -1)
2331 XSETINT (c
, unread_command_char
);
2332 unread_command_char
= -1;
2338 if (CONSP (Vunread_command_events
))
2340 int was_disabled
= 0;
2342 c
= XCAR (Vunread_command_events
);
2343 Vunread_command_events
= XCDR (Vunread_command_events
);
2347 /* Undo what sit-for did when it unread additional keys
2348 inside universal-argument. */
2351 && EQ (XCAR (c
), Qt
))
2357 /* Undo what read_char_x_menu_prompt did when it unread
2358 additional keys returned by Fx_popup_menu. */
2360 && EQ (XCDR (c
), Qdisabled
)
2361 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2367 /* If the queued event is something that used the mouse,
2368 set used_mouse_menu accordingly. */
2370 /* Also check was_disabled so last-nonmenu-event won't return
2371 a bad value when submenus are involved. (Bug#447) */
2372 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2373 *used_mouse_menu
= 1;
2375 goto reread_for_input_method
;
2378 if (CONSP (Vunread_input_method_events
))
2380 c
= XCAR (Vunread_input_method_events
);
2381 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2383 /* Undo what read_char_x_menu_prompt did when it unread
2384 additional keys returned by Fx_popup_menu. */
2386 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2390 goto reread_for_input_method
;
2393 this_command_key_count_reset
= 0;
2395 if (!NILP (Vexecuting_kbd_macro
))
2397 /* We set this to Qmacro; since that's not a frame, nobody will
2398 try to switch frames on us, and the selected window will
2401 Since this event came from a macro, it would be misleading to
2402 leave internal_last_event_frame set to wherever the last
2403 real event came from. Normally, a switch-frame event selects
2404 internal_last_event_frame after each command is read, but
2405 events read from a macro should never cause a new frame to be
2407 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2409 /* Exit the macro if we are at the end.
2410 Also, some things replace the macro with t
2411 to force an early exit. */
2412 if (EQ (Vexecuting_kbd_macro
, Qt
)
2413 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2419 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2420 if (STRINGP (Vexecuting_kbd_macro
)
2421 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2422 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2424 executing_kbd_macro_index
++;
2429 if (!NILP (unread_switch_frame
))
2431 c
= unread_switch_frame
;
2432 unread_switch_frame
= Qnil
;
2434 /* This event should make it into this_command_keys, and get echoed
2435 again, so we do not set `reread'. */
2439 /* if redisplay was requested */
2440 if (commandflag
>= 0)
2442 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2444 /* If there is pending input, process any events which are not
2445 user-visible, such as X selection_request events. */
2447 || detect_input_pending_run_timers (0))
2448 swallow_events (0); /* may clear input_pending */
2450 /* Redisplay if no pending input. */
2451 while (!input_pending
)
2453 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2454 redisplay_preserve_echo_area (5);
2459 /* Normal case: no input arrived during redisplay. */
2462 /* Input arrived and pre-empted redisplay.
2463 Process any events which are not user-visible. */
2465 /* If that cleared input_pending, try again to redisplay. */
2468 /* Prevent the redisplay we just did
2469 from messing up echoing of the input after the prompt. */
2470 if (commandflag
== 0 && echo_current
)
2471 echo_message_buffer
= echo_area_buffer
[0];
2475 /* Message turns off echoing unless more keystrokes turn it on again.
2477 The code in 20.x for the condition was
2479 1. echo_area_glyphs && *echo_area_glyphs
2480 2. && echo_area_glyphs != current_kboard->echobuf
2481 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2483 (1) means there's a current message displayed
2485 (2) means it's not the message from echoing from the current
2488 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2489 is set to a non-null value. This is done in read_char and it is
2490 set to echo_area_glyphs after a call to echo_char. That means
2491 ok_to_echo_at_next_pause is either null or
2492 current_kboard->echobuf with the appropriate current_kboard at
2495 So, condition (3) means in clear text ok_to_echo_at_next_pause
2496 must be either null, or the current message isn't from echoing at
2497 all, or it's from echoing from a different kboard than the
2500 if (/* There currently is something in the echo area. */
2501 !NILP (echo_area_buffer
[0])
2502 && (/* And it's either not from echoing. */
2503 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2504 /* Or it's an echo from a different kboard. */
2505 || echo_kboard
!= current_kboard
2506 /* Or we explicitly allow overwriting whatever there is. */
2507 || ok_to_echo_at_next_pause
== NULL
))
2512 /* Try reading a character via menu prompting in the minibuf.
2513 Try this before the sit-for, because the sit-for
2514 would do the wrong thing if we are supposed to do
2515 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2516 after a mouse event so don't try a minibuf menu. */
2518 if (nmaps
> 0 && INTERACTIVE
2519 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2520 /* Don't bring up a menu if we already have another event. */
2521 && NILP (Vunread_command_events
)
2522 && unread_command_char
< 0
2523 && !detect_input_pending_run_timers (0))
2525 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2527 if (INTEGERP (c
) && XINT (c
) == -2)
2528 return c
; /* wrong_kboard_jmpbuf */
2532 key_already_recorded
= 1;
2537 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2538 We will do that below, temporarily for short sections of code,
2539 when appropriate. local_getcjmp must be in effect
2540 around any call to sit_for or kbd_buffer_get_event;
2541 it *must not* be in effect when we call redisplay. */
2543 jmpcount
= SPECPDL_INDEX ();
2544 if (_setjmp (local_getcjmp
))
2546 /* Handle quits while reading the keyboard. */
2547 /* We must have saved the outer value of getcjmp here,
2548 so restore it now. */
2549 restore_getcjmp (save_jump
);
2550 unbind_to (jmpcount
, Qnil
);
2551 XSETINT (c
, quit_char
);
2552 internal_last_event_frame
= selected_frame
;
2553 Vlast_event_frame
= internal_last_event_frame
;
2554 /* If we report the quit char as an event,
2555 don't do so more than once. */
2556 if (!NILP (Vinhibit_quit
))
2560 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2561 if (kb
!= current_kboard
)
2563 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2564 /* We shouldn't get here if we were in single-kboard mode! */
2569 while (CONSP (XCDR (last
)))
2571 if (!NILP (XCDR (last
)))
2575 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2577 XSETCDR (last
, Fcons (c
, Qnil
));
2578 kb
->kbd_queue_has_data
= 1;
2579 current_kboard
= kb
;
2580 /* This is going to exit from read_char
2581 so we had better get rid of this frame's stuff. */
2583 return make_number (-2); /* wrong_kboard_jmpbuf */
2589 /* Start idle timers if no time limit is supplied. We don't do it
2590 if a time limit is supplied to avoid an infinite recursion in the
2591 situation where an idle timer calls `sit-for'. */
2594 timer_start_idle ();
2596 /* If in middle of key sequence and minibuffer not active,
2597 start echoing if enough time elapses. */
2599 if (minibuf_level
== 0
2601 && !current_kboard
->immediate_echo
2602 && this_command_key_count
> 0
2604 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2605 && NILP (Fzerop (Vecho_keystrokes
))
2606 && (/* No message. */
2607 NILP (echo_area_buffer
[0])
2608 /* Or empty message. */
2609 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2610 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2611 /* Or already echoing from same kboard. */
2612 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2613 /* Or not echoing before and echoing allowed. */
2614 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2616 /* After a mouse event, start echoing right away.
2617 This is because we are probably about to display a menu,
2618 and we don't want to delay before doing so. */
2619 if (EVENT_HAS_PARAMETERS (prev_event
))
2625 save_getcjmp (save_jump
);
2626 restore_getcjmp (local_getcjmp
);
2627 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2628 restore_getcjmp (save_jump
);
2630 && ! CONSP (Vunread_command_events
))
2635 /* Maybe auto save due to number of keystrokes. */
2637 if (commandflag
!= 0
2638 && auto_save_interval
> 0
2639 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2640 && !detect_input_pending_run_timers (0))
2642 Fdo_auto_save (Qnil
, Qnil
);
2643 /* Hooks can actually change some buffers in auto save. */
2647 /* Try reading using an X menu.
2648 This is never confused with reading using the minibuf
2649 because the recursive call of read_char in read_char_minibuf_menu_prompt
2650 does not pass on any keymaps. */
2652 if (nmaps
> 0 && INTERACTIVE
2653 && !NILP (prev_event
)
2654 && EVENT_HAS_PARAMETERS (prev_event
)
2655 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2656 && !EQ (XCAR (prev_event
), Qtool_bar
)
2657 /* Don't bring up a menu if we already have another event. */
2658 && NILP (Vunread_command_events
)
2659 && unread_command_char
< 0)
2661 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2663 /* Now that we have read an event, Emacs is not idle. */
2670 /* Maybe autosave and/or garbage collect due to idleness. */
2672 if (INTERACTIVE
&& NILP (c
))
2675 ptrdiff_t buffer_size
;
2677 /* Slow down auto saves logarithmically in size of current buffer,
2678 and garbage collect while we're at it. */
2679 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2680 last_non_minibuf_size
= Z
- BEG
;
2681 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2683 while (buffer_size
> 64)
2684 delay_level
++, buffer_size
-= buffer_size
>> 2;
2685 if (delay_level
< 4) delay_level
= 4;
2686 /* delay_level is 4 for files under around 50k, 7 at 100k,
2687 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2689 /* Auto save if enough time goes by without input. */
2690 if (commandflag
!= 0
2691 && num_nonmacro_input_events
> last_auto_save
2692 && INTEGERP (Vauto_save_timeout
)
2693 && XINT (Vauto_save_timeout
) > 0)
2696 EMACS_INT timeout
= (delay_level
2697 * min (XFASTINT (Vauto_save_timeout
) / 4,
2698 MOST_POSITIVE_FIXNUM
/ delay_level
));
2699 save_getcjmp (save_jump
);
2700 restore_getcjmp (local_getcjmp
);
2701 tem0
= sit_for (make_number (timeout
), 1, 1);
2702 restore_getcjmp (save_jump
);
2705 && ! CONSP (Vunread_command_events
))
2707 Fdo_auto_save (Qnil
, Qnil
);
2712 /* If there is still no input available, ask for GC. */
2713 if (!detect_input_pending_run_timers (0))
2717 /* Notify the caller if an autosave hook, or a timer, sentinel or
2718 filter in the sit_for calls above have changed the current
2719 kboard. This could happen if they use the minibuffer or start a
2720 recursive edit, like the fancy splash screen in server.el's
2721 filter. If this longjmp wasn't here, read_key_sequence would
2722 interpret the next key sequence using the wrong translation
2723 tables and function keymaps. */
2724 if (NILP (c
) && current_kboard
!= orig_kboard
)
2727 return make_number (-2); /* wrong_kboard_jmpbuf */
2730 /* If this has become non-nil here, it has been set by a timer
2731 or sentinel or filter. */
2732 if (CONSP (Vunread_command_events
))
2734 c
= XCAR (Vunread_command_events
);
2735 Vunread_command_events
= XCDR (Vunread_command_events
);
2738 /* Read something from current KBOARD's side queue, if possible. */
2742 if (current_kboard
->kbd_queue_has_data
)
2744 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2746 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2747 KVAR (current_kboard
, kbd_queue
)
2748 = XCDR (KVAR (current_kboard
, kbd_queue
));
2749 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2750 current_kboard
->kbd_queue_has_data
= 0;
2751 input_pending
= readable_events (0);
2752 if (EVENT_HAS_PARAMETERS (c
)
2753 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2754 internal_last_event_frame
= XCAR (XCDR (c
));
2755 Vlast_event_frame
= internal_last_event_frame
;
2759 /* If current_kboard's side queue is empty check the other kboards.
2760 If one of them has data that we have not yet seen here,
2761 switch to it and process the data waiting for it.
2763 Note: if the events queued up for another kboard
2764 have already been seen here, and therefore are not a complete command,
2765 the kbd_queue_has_data field is 0, so we skip that kboard here.
2766 That's to avoid an infinite loop switching between kboards here. */
2767 if (NILP (c
) && !single_kboard
)
2770 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2771 if (kb
->kbd_queue_has_data
)
2773 current_kboard
= kb
;
2774 /* This is going to exit from read_char
2775 so we had better get rid of this frame's stuff. */
2777 return make_number (-2); /* wrong_kboard_jmpbuf */
2785 /* Finally, we read from the main queue,
2786 and if that gives us something we can't use yet, we put it on the
2787 appropriate side queue and try again. */
2791 KBOARD
*kb
IF_LINT (= NULL
);
2793 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2796 /* Actually read a character, waiting if necessary. */
2797 save_getcjmp (save_jump
);
2798 restore_getcjmp (local_getcjmp
);
2800 timer_start_idle ();
2801 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2802 restore_getcjmp (save_jump
);
2804 if (! NILP (c
) && (kb
!= current_kboard
))
2806 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2809 while (CONSP (XCDR (last
)))
2811 if (!NILP (XCDR (last
)))
2815 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2817 XSETCDR (last
, Fcons (c
, Qnil
));
2818 kb
->kbd_queue_has_data
= 1;
2822 current_kboard
= kb
;
2823 /* This is going to exit from read_char
2824 so we had better get rid of this frame's stuff. */
2826 return make_number (-2);
2830 /* Terminate Emacs in batch mode if at eof. */
2831 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2832 Fkill_emacs (make_number (1));
2836 /* Add in any extra modifiers, where appropriate. */
2837 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2838 || ((extra_keyboard_modifiers
& 0177) < ' '
2839 && (extra_keyboard_modifiers
& 0177) != 0))
2840 XSETINT (c
, make_ctrl_char (XINT (c
)));
2842 /* Transfer any other modifier bits directly from
2843 extra_keyboard_modifiers to c. Ignore the actual character code
2844 in the low 16 bits of extra_keyboard_modifiers. */
2845 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2856 if (commandflag
>= 0
2857 && !input_pending
&& !detect_input_pending_run_timers (0))
2865 /* Buffer switch events are only for internal wakeups
2866 so don't show them to the user.
2867 Also, don't record a key if we already did. */
2868 if (BUFFERP (c
) || key_already_recorded
)
2871 /* Process special events within read_char
2872 and loop around to read another event. */
2875 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2880 struct buffer
*prev_buffer
= current_buffer
;
2881 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2882 int was_locked
= single_kboard
;
2883 ptrdiff_t count
= SPECPDL_INDEX ();
2884 record_single_kboard_state ();
2887 last_input_event
= c
;
2888 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2890 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2891 /* We stopped being idle for this event; undo that. This
2892 prevents automatic window selection (under
2893 mouse_autoselect_window from acting as a real input event, for
2894 example banishing the mouse under mouse-avoidance-mode. */
2895 timer_resume_idle ();
2897 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2898 /* Resume allowing input from any kboard, if that was true before. */
2900 any_kboard_state ();
2901 unbind_to (count
, Qnil
);
2904 if (current_buffer
!= prev_buffer
)
2906 /* The command may have changed the keymaps. Pretend there
2907 is input in another keyboard and return. This will
2908 recalculate keymaps. */
2909 c
= make_number (-2);
2916 /* Handle things that only apply to characters. */
2919 /* If kbd_buffer_get_event gave us an EOF, return that. */
2923 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2924 && UNSIGNED_CMP (XFASTINT (c
), <,
2925 SCHARS (KVAR (current_kboard
,
2926 Vkeyboard_translate_table
))))
2927 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2928 && UNSIGNED_CMP (XFASTINT (c
), <,
2929 ASIZE (KVAR (current_kboard
,
2930 Vkeyboard_translate_table
))))
2931 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2935 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2936 /* nil in keyboard-translate-table means no translation. */
2942 /* If this event is a mouse click in the menu bar,
2943 return just menu-bar for now. Modify the mouse click event
2944 so we won't do this twice, then queue it up. */
2945 if (EVENT_HAS_PARAMETERS (c
)
2947 && CONSP (EVENT_START (c
))
2948 && CONSP (XCDR (EVENT_START (c
))))
2952 posn
= POSN_POSN (EVENT_START (c
));
2953 /* Handle menu-bar events:
2954 insert the dummy prefix event `menu-bar'. */
2955 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2957 /* Change menu-bar to (menu-bar) as the event "position". */
2958 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2961 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2966 /* Store these characters into recent_keys, the dribble file if any,
2967 and the keyboard macro being defined, if any. */
2969 if (! NILP (also_record
))
2970 record_char (also_record
);
2972 /* Wipe the echo area.
2973 But first, if we are about to use an input method,
2974 save the echo area contents for it to refer to. */
2976 && ! NILP (Vinput_method_function
)
2977 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2979 previous_echo_area_message
= Fcurrent_message ();
2980 Vinput_method_previous_message
= previous_echo_area_message
;
2983 /* Now wipe the echo area, except for help events which do their
2984 own stuff with the echo area. */
2986 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2987 && !(EQ (Qswitch_frame
, XCAR (c
)))
2988 /* Don't wipe echo area for select window events: These might
2989 get delayed via `mouse-autoselect-window' (Bug#11304). */
2990 && !(EQ (Qselect_window
, XCAR (c
)))))
2992 if (!NILP (echo_area_buffer
[0]))
2994 safe_run_hooks (Qecho_area_clear_hook
);
2995 clear_message (1, 0);
2999 reread_for_input_method
:
3001 /* Pass this to the input method, if appropriate. */
3003 && ! NILP (Vinput_method_function
)
3004 /* Don't run the input method within a key sequence,
3005 after the first event of the key sequence. */
3006 && NILP (prev_event
)
3007 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3010 ptrdiff_t key_count
;
3011 int key_count_reset
;
3012 struct gcpro gcpro1
;
3013 ptrdiff_t count
= SPECPDL_INDEX ();
3015 /* Save the echo status. */
3016 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3017 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3018 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3019 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3022 if (before_command_restore_flag
)
3024 this_command_key_count
= before_command_key_count_1
;
3025 if (this_command_key_count
< this_single_command_key_start
)
3026 this_single_command_key_start
= this_command_key_count
;
3027 echo_truncate (before_command_echo_length_1
);
3028 before_command_restore_flag
= 0;
3032 /* Save the this_command_keys status. */
3033 key_count
= this_command_key_count
;
3034 key_count_reset
= this_command_key_count_reset
;
3037 keys
= Fcopy_sequence (this_command_keys
);
3042 /* Clear out this_command_keys. */
3043 this_command_key_count
= 0;
3044 this_command_key_count_reset
= 0;
3046 /* Now wipe the echo area. */
3047 if (!NILP (echo_area_buffer
[0]))
3048 safe_run_hooks (Qecho_area_clear_hook
);
3049 clear_message (1, 0);
3052 /* If we are not reading a key sequence,
3053 never use the echo area. */
3056 specbind (Qinput_method_use_echo_area
, Qt
);
3059 /* Call the input method. */
3060 tem
= call1 (Vinput_method_function
, c
);
3062 tem
= unbind_to (count
, tem
);
3064 /* Restore the saved echoing state
3065 and this_command_keys state. */
3066 this_command_key_count
= key_count
;
3067 this_command_key_count_reset
= key_count_reset
;
3069 this_command_keys
= keys
;
3072 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3073 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3074 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3075 if (saved_immediate_echo
)
3080 /* The input method can return no events. */
3083 /* Bring back the previous message, if any. */
3084 if (! NILP (previous_echo_area_message
))
3085 message_with_string ("%s", previous_echo_area_message
, 0);
3088 /* It returned one event or more. */
3090 Vunread_post_input_method_events
3091 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3096 /* Display help if not echoing. */
3097 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3099 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3100 Lisp_Object help
, object
, position
, window
, htem
;
3102 htem
= Fcdr (XCDR (c
));
3105 window
= Fcar (htem
);
3107 object
= Fcar (htem
);
3109 position
= Fcar (htem
);
3111 show_help_echo (help
, window
, object
, position
);
3113 /* We stopped being idle for this event; undo that. */
3115 timer_resume_idle ();
3119 if ((! reread
|| this_command_key_count
== 0
3120 || this_command_key_count_reset
)
3124 /* Don't echo mouse motion events. */
3125 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3126 && NILP (Fzerop (Vecho_keystrokes
))
3127 && ! (EVENT_HAS_PARAMETERS (c
)
3128 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3131 if (! NILP (also_record
))
3132 echo_char (also_record
);
3133 /* Once we reread a character, echoing can happen
3134 the next time we pause to read a new one. */
3135 ok_to_echo_at_next_pause
= current_kboard
;
3138 /* Record this character as part of the current key. */
3139 add_command_key (c
);
3140 if (! NILP (also_record
))
3141 add_command_key (also_record
);
3144 last_input_event
= c
;
3147 /* Process the help character specially if enabled */
3148 if (!NILP (Vhelp_form
) && help_char_p (c
))
3150 ptrdiff_t count
= SPECPDL_INDEX ();
3152 help_form_saved_window_configs
3153 = Fcons (Fcurrent_window_configuration (Qnil
),
3154 help_form_saved_window_configs
);
3155 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3156 call0 (Qhelp_form_show
);
3161 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3162 if (EVENT_HAS_PARAMETERS (c
)
3163 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3164 XSETCAR (help_form_saved_window_configs
, Qnil
);
3166 while (BUFFERP (c
));
3167 /* Remove the help from the frame */
3168 unbind_to (count
, Qnil
);
3171 if (EQ (c
, make_number (040)))
3175 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3176 while (BUFFERP (c
));
3185 /* Record a key that came from a mouse menu.
3186 Record it for echoing, for this-command-keys, and so on. */
3189 record_menu_key (Lisp_Object c
)
3191 /* Wipe the echo area. */
3192 clear_message (1, 0);
3197 before_command_key_count
= this_command_key_count
;
3198 before_command_echo_length
= echo_length ();
3201 /* Don't echo mouse motion events. */
3202 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3203 && NILP (Fzerop (Vecho_keystrokes
)))
3207 /* Once we reread a character, echoing can happen
3208 the next time we pause to read a new one. */
3209 ok_to_echo_at_next_pause
= 0;
3212 /* Record this character as part of the current key. */
3213 add_command_key (c
);
3215 /* Re-reading in the middle of a command */
3216 last_input_event
= c
;
3220 /* Return 1 if should recognize C as "the help character". */
3223 help_char_p (Lisp_Object c
)
3227 if (EQ (c
, Vhelp_char
))
3229 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3230 if (EQ (c
, XCAR (tail
)))
3235 /* Record the input event C in various ways. */
3238 record_char (Lisp_Object c
)
3242 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3244 /* To avoid filling recent_keys with help-echo and mouse-movement
3245 events, we filter out repeated help-echo events, only store the
3246 first and last in a series of mouse-movement events, and don't
3247 store repeated help-echo events which are only separated by
3248 mouse-movement events. */
3250 Lisp_Object ev1
, ev2
, ev3
;
3253 if ((ix1
= recent_keys_index
- 1) < 0)
3254 ix1
= NUM_RECENT_KEYS
- 1;
3255 ev1
= AREF (recent_keys
, ix1
);
3257 if ((ix2
= ix1
- 1) < 0)
3258 ix2
= NUM_RECENT_KEYS
- 1;
3259 ev2
= AREF (recent_keys
, ix2
);
3261 if ((ix3
= ix2
- 1) < 0)
3262 ix3
= NUM_RECENT_KEYS
- 1;
3263 ev3
= AREF (recent_keys
, ix3
);
3265 if (EQ (XCAR (c
), Qhelp_echo
))
3267 /* Don't record `help-echo' in recent_keys unless it shows some help
3268 message, and a different help than the previously recorded
3270 Lisp_Object help
, last_help
;
3272 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3273 if (!STRINGP (help
))
3275 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3276 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3278 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3279 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3280 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3282 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3283 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3284 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3285 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3288 else if (EQ (XCAR (c
), Qmouse_movement
))
3290 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3291 So additional mouse movement events replace the last element. */
3292 Lisp_Object last_window
, window
;
3294 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3295 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3296 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3297 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3298 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3300 ASET (recent_keys
, ix1
, c
);
3306 store_kbd_macro_char (c
);
3310 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3311 ASET (recent_keys
, recent_keys_index
, c
);
3312 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3313 recent_keys_index
= 0;
3315 else if (recorded
< 0)
3317 /* We need to remove one or two events from recent_keys.
3318 To do this, we simply put nil at those events and move the
3319 recent_keys_index backwards over those events. Usually,
3320 users will never see those nil events, as they will be
3321 overwritten by the command keys entered to see recent_keys
3324 while (recorded
++ < 0 && total_keys
> 0)
3326 if (total_keys
< NUM_RECENT_KEYS
)
3328 if (--recent_keys_index
< 0)
3329 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3330 ASET (recent_keys
, recent_keys_index
, Qnil
);
3334 num_nonmacro_input_events
++;
3336 /* Write c to the dribble file. If c is a lispy event, write
3337 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3338 If you, dear reader, have a better idea, you've got the source. :-) */
3344 if (XUINT (c
) < 0x100)
3345 putc (XUINT (c
), dribble
);
3347 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3351 Lisp_Object dribblee
;
3353 /* If it's a structured event, take the event header. */
3354 dribblee
= EVENT_HEAD (c
);
3356 if (SYMBOLP (dribblee
))
3358 putc ('<', dribble
);
3359 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3360 SBYTES (SYMBOL_NAME (dribblee
)),
3362 putc ('>', dribble
);
3371 /* Copy out or in the info on where C-g should throw to.
3372 This is used when running Lisp code from within get_char,
3373 in case get_char is called recursively.
3374 See read_process_output. */
3377 save_getcjmp (jmp_buf temp
)
3379 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3383 restore_getcjmp (jmp_buf temp
)
3385 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3388 /* Low level keyboard/mouse input.
3389 kbd_buffer_store_event places events in kbd_buffer, and
3390 kbd_buffer_get_event retrieves them. */
3392 /* Return true if there are any events in the queue that read-char
3393 would return. If this returns false, a read-char would block. */
3395 readable_events (int flags
)
3397 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3400 /* If the buffer contains only FOCUS_IN_EVENT events, and
3401 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3402 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3404 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3405 #ifdef USE_TOOLKIT_SCROLL_BARS
3406 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3410 struct input_event
*event
;
3412 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3419 #ifdef USE_TOOLKIT_SCROLL_BARS
3420 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3422 event
->kind
== FOCUS_IN_EVENT
)
3423 #ifdef USE_TOOLKIT_SCROLL_BARS
3424 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3425 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3426 && event
->part
== scroll_bar_handle
3427 && event
->modifiers
== 0)
3432 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3435 while (event
!= kbd_store_ptr
);
3441 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3442 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3443 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3448 if (current_kboard
->kbd_queue_has_data
)
3454 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3455 if (kb
->kbd_queue_has_data
)
3461 /* Set this for debugging, to have a way to get out */
3462 int stop_character EXTERNALLY_VISIBLE
;
3465 event_to_kboard (struct input_event
*event
)
3468 frame
= event
->frame_or_window
;
3470 frame
= XCAR (frame
);
3471 else if (WINDOWP (frame
))
3472 frame
= WINDOW_FRAME (XWINDOW (frame
));
3474 /* There are still some events that don't set this field.
3475 For now, just ignore the problem.
3476 Also ignore dead frames here. */
3477 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3480 return FRAME_KBOARD (XFRAME (frame
));
3484 /* Return the number of slots occupied in kbd_buffer. */
3487 kbd_buffer_nr_stored (void)
3489 return kbd_fetch_ptr
== kbd_store_ptr
3491 : (kbd_fetch_ptr
< kbd_store_ptr
3492 ? kbd_store_ptr
- kbd_fetch_ptr
3493 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3494 + (kbd_store_ptr
- kbd_buffer
)));
3496 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3499 kbd_buffer_store_event (register struct input_event
*event
)
3501 kbd_buffer_store_event_hold (event
, 0);
3504 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3506 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3507 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3508 Else, if EVENT is a quit event, store the quit event
3509 in HOLD_QUIT, and return (thus ignoring further events).
3511 This is used in read_avail_input to postpone the processing
3512 of the quit event until all subsequent input events have been
3513 parsed (and discarded).
3517 kbd_buffer_store_event_hold (register struct input_event
*event
,
3518 struct input_event
*hold_quit
)
3520 if (event
->kind
== NO_EVENT
)
3523 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3526 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3528 register int c
= event
->code
& 0377;
3530 if (event
->modifiers
& ctrl_modifier
)
3531 c
= make_ctrl_char (c
);
3533 c
|= (event
->modifiers
3534 & (meta_modifier
| alt_modifier
3535 | hyper_modifier
| super_modifier
));
3539 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3540 struct input_event
*sp
;
3542 if (single_kboard
&& kb
!= current_kboard
)
3544 KVAR (kb
, kbd_queue
)
3545 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3546 Fcons (make_number (c
), Qnil
));
3547 kb
->kbd_queue_has_data
= 1;
3548 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3550 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3553 if (event_to_kboard (sp
) == kb
)
3555 sp
->kind
= NO_EVENT
;
3556 sp
->frame_or_window
= Qnil
;
3565 memcpy (hold_quit
, event
, sizeof (*event
));
3569 /* If this results in a quit_char being returned to Emacs as
3570 input, set Vlast_event_frame properly. If this doesn't
3571 get returned to Emacs as an event, the next event read
3572 will set Vlast_event_frame again, so this is safe to do. */
3576 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3578 focus
= event
->frame_or_window
;
3579 internal_last_event_frame
= focus
;
3580 Vlast_event_frame
= focus
;
3583 last_event_timestamp
= event
->timestamp
;
3584 handle_interrupt ();
3588 if (c
&& c
== stop_character
)
3594 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3595 Just ignore the second one. */
3596 else if (event
->kind
== BUFFER_SWITCH_EVENT
3597 && kbd_fetch_ptr
!= kbd_store_ptr
3598 && ((kbd_store_ptr
== kbd_buffer
3599 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3600 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3603 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3604 kbd_store_ptr
= kbd_buffer
;
3606 /* Don't let the very last slot in the buffer become full,
3607 since that would make the two pointers equal,
3608 and that is indistinguishable from an empty buffer.
3609 Discard the event if it would fill the last slot. */
3610 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3612 *kbd_store_ptr
= *event
;
3615 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3617 /* Don't read keyboard input until we have processed kbd_buffer.
3618 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3619 hold_keyboard_input ();
3621 if (!noninteractive
)
3622 signal (SIGIO
, SIG_IGN
);
3626 #endif /* subprocesses */
3629 /* If we're inside while-no-input, and this event qualifies
3630 as input, set quit-flag to cause an interrupt. */
3631 if (!NILP (Vthrow_on_input
)
3632 && event
->kind
!= FOCUS_IN_EVENT
3633 && event
->kind
!= HELP_EVENT
3634 && event
->kind
!= DEICONIFY_EVENT
)
3636 Vquit_flag
= Vthrow_on_input
;
3637 /* If we're inside a function that wants immediate quits,
3639 if (immediate_quit
&& NILP (Vinhibit_quit
))
3649 /* Put an input event back in the head of the event queue. */
3652 kbd_buffer_unget_event (register struct input_event
*event
)
3654 if (kbd_fetch_ptr
== kbd_buffer
)
3655 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3657 /* Don't let the very last slot in the buffer become full, */
3658 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3661 *kbd_fetch_ptr
= *event
;
3666 /* Generate a HELP_EVENT input_event and store it in the keyboard
3669 HELP is the help form.
3671 FRAME and WINDOW are the frame and window where the help is
3672 generated. OBJECT is the Lisp object where the help was found (a
3673 buffer, a string, an overlay, or nil if neither from a string nor
3674 from a buffer). POS is the position within OBJECT where the help
3678 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3679 Lisp_Object object
, ptrdiff_t pos
)
3681 struct input_event event
;
3685 event
.kind
= HELP_EVENT
;
3686 event
.frame_or_window
= frame
;
3688 event
.x
= WINDOWP (window
) ? window
: frame
;
3691 kbd_buffer_store_event (&event
);
3695 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3698 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3700 struct input_event event
;
3702 event
.kind
= HELP_EVENT
;
3703 event
.frame_or_window
= frame
;
3708 kbd_buffer_store_event (&event
);
3712 /* Discard any mouse events in the event buffer by setting them to
3715 discard_mouse_events (void)
3717 struct input_event
*sp
;
3718 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3720 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3723 if (sp
->kind
== MOUSE_CLICK_EVENT
3724 || sp
->kind
== WHEEL_EVENT
3725 || sp
->kind
== HORIZ_WHEEL_EVENT
3727 || sp
->kind
== GPM_CLICK_EVENT
3729 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3731 sp
->kind
= NO_EVENT
;
3737 /* Return non-zero if there are any real events waiting in the event
3738 buffer, not counting `NO_EVENT's.
3740 If DISCARD is non-zero, discard NO_EVENT events at the front of
3741 the input queue, possibly leaving the input queue empty if there
3742 are no real input events. */
3745 kbd_buffer_events_waiting (int discard
)
3747 struct input_event
*sp
;
3749 for (sp
= kbd_fetch_ptr
;
3750 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3753 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3760 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3764 /* Clear input event EVENT. */
3767 clear_event (struct input_event
*event
)
3769 event
->kind
= NO_EVENT
;
3773 /* Read one event from the event buffer, waiting if necessary.
3774 The value is a Lisp object representing the event.
3775 The value is nil for an event that should be ignored,
3776 or that was handled here.
3777 We always read and discard one event. */
3780 kbd_buffer_get_event (KBOARD
**kbp
,
3781 int *used_mouse_menu
,
3782 EMACS_TIME
*end_time
)
3787 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3789 /* Start reading input again, we have processed enough so we can
3790 accept new events again. */
3791 unhold_keyboard_input ();
3793 if (!noninteractive
)
3794 signal (SIGIO
, input_available_signal
);
3798 #endif /* subprocesses */
3800 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3802 /* In case we are running as a daemon, only do this before
3803 detaching from the terminal. */
3804 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3808 *kbp
= current_kboard
;
3811 #endif /* ! HAVE_DBUS */
3813 /* Wait until there is input available. */
3816 /* Break loop if there's an unread command event. Needed in
3817 moused window autoselection which uses a timer to insert such
3819 if (CONSP (Vunread_command_events
))
3822 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3824 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3825 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3829 /* If the quit flag is set, then read_char will return
3830 quit_char, so that counts as "available input." */
3831 if (!NILP (Vquit_flag
))
3832 quit_throw_to_read_char (0);
3834 /* One way or another, wait until input is available; then, if
3835 interrupt handlers have not read it, read it now. */
3837 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3841 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3843 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3844 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3849 EMACS_TIME now
= current_emacs_time ();
3850 if (EMACS_TIME_LE (*end_time
, now
))
3851 return Qnil
; /* Finished waiting. */
3854 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3855 wait_reading_process_output (min (EMACS_SECS (duration
),
3857 EMACS_NSECS (duration
),
3858 -1, 1, Qnil
, NULL
, 0);
3862 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3864 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3865 /* Pass 1 for EXPECT since we just waited to have input. */
3866 read_avail_input (1);
3869 if (CONSP (Vunread_command_events
))
3872 first
= XCAR (Vunread_command_events
);
3873 Vunread_command_events
= XCDR (Vunread_command_events
);
3874 *kbp
= current_kboard
;
3878 /* At this point, we know that there is a readable event available
3879 somewhere. If the event queue is empty, then there must be a
3880 mouse movement enabled and available. */
3881 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3883 struct input_event
*event
;
3885 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3889 last_event_timestamp
= event
->timestamp
;
3891 *kbp
= event_to_kboard (event
);
3893 *kbp
= current_kboard
; /* Better than returning null ptr? */
3897 /* These two kinds of events get special handling
3898 and don't actually appear to the command loop.
3899 We return nil for them. */
3900 if (event
->kind
== SELECTION_REQUEST_EVENT
3901 || event
->kind
== SELECTION_CLEAR_EVENT
)
3904 struct input_event copy
;
3906 /* Remove it from the buffer before processing it,
3907 since otherwise swallow_events will see it
3908 and process it again. */
3910 kbd_fetch_ptr
= event
+ 1;
3911 input_pending
= readable_events (0);
3912 x_handle_selection_event (©
);
3914 /* We're getting selection request events, but we don't have
3920 #if defined (HAVE_NS)
3921 else if (event
->kind
== NS_TEXT_EVENT
)
3923 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3924 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3926 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3927 kbd_fetch_ptr
= event
+ 1;
3928 if (used_mouse_menu
)
3929 *used_mouse_menu
= 1;
3933 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3934 || defined (HAVE_NS)
3935 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3937 /* Make an event (delete-frame (FRAME)). */
3938 obj
= Fcons (event
->frame_or_window
, Qnil
);
3939 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3940 kbd_fetch_ptr
= event
+ 1;
3943 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3944 || defined (HAVE_NS)
3945 else if (event
->kind
== ICONIFY_EVENT
)
3947 /* Make an event (iconify-frame (FRAME)). */
3948 obj
= Fcons (event
->frame_or_window
, Qnil
);
3949 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3950 kbd_fetch_ptr
= event
+ 1;
3952 else if (event
->kind
== DEICONIFY_EVENT
)
3954 /* Make an event (make-frame-visible (FRAME)). */
3955 obj
= Fcons (event
->frame_or_window
, Qnil
);
3956 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3957 kbd_fetch_ptr
= event
+ 1;
3960 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3962 /* The value doesn't matter here; only the type is tested. */
3963 XSETBUFFER (obj
, current_buffer
);
3964 kbd_fetch_ptr
= event
+ 1;
3966 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3967 || defined (HAVE_NS) || defined (USE_GTK)
3968 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3970 kbd_fetch_ptr
= event
+ 1;
3971 input_pending
= readable_events (0);
3972 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3973 x_activate_menubar (XFRAME (event
->frame_or_window
));
3976 #if defined (WINDOWSNT)
3977 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3979 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
3980 obj
= Fcons (Qlanguage_change
,
3981 list3 (event
->frame_or_window
,
3982 make_number (event
->code
),
3983 make_number (event
->modifiers
)));
3984 kbd_fetch_ptr
= event
+ 1;
3987 else if (event
->kind
== SAVE_SESSION_EVENT
)
3989 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3990 kbd_fetch_ptr
= event
+ 1;
3992 /* Just discard these, by returning nil.
3993 With MULTI_KBOARD, these events are used as placeholders
3994 when we need to randomly delete events from the queue.
3995 (They shouldn't otherwise be found in the buffer,
3996 but on some machines it appears they do show up
3997 even without MULTI_KBOARD.) */
3998 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3999 mouse events during a popup-menu call. */
4000 else if (event
->kind
== NO_EVENT
)
4001 kbd_fetch_ptr
= event
+ 1;
4002 else if (event
->kind
== HELP_EVENT
)
4004 Lisp_Object object
, position
, help
, frame
, window
;
4006 frame
= event
->frame_or_window
;
4007 object
= event
->arg
;
4008 position
= make_number (event
->code
);
4011 clear_event (event
);
4013 kbd_fetch_ptr
= event
+ 1;
4014 if (!WINDOWP (window
))
4016 obj
= Fcons (Qhelp_echo
,
4017 list5 (frame
, help
, window
, object
, position
));
4019 else if (event
->kind
== FOCUS_IN_EVENT
)
4021 /* Notification of a FocusIn event. The frame receiving the
4022 focus is in event->frame_or_window. Generate a
4023 switch-frame event if necessary. */
4024 Lisp_Object frame
, focus
;
4026 frame
= event
->frame_or_window
;
4027 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4031 if (!EQ (frame
, internal_last_event_frame
)
4032 && !EQ (frame
, selected_frame
))
4033 obj
= make_lispy_switch_frame (frame
);
4034 internal_last_event_frame
= frame
;
4035 kbd_fetch_ptr
= event
+ 1;
4038 else if (event
->kind
== DBUS_EVENT
)
4040 obj
= make_lispy_event (event
);
4041 kbd_fetch_ptr
= event
+ 1;
4044 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4046 obj
= make_lispy_event (event
);
4047 kbd_fetch_ptr
= event
+ 1;
4051 /* If this event is on a different frame, return a switch-frame this
4052 time, and leave the event in the queue for next time. */
4056 frame
= event
->frame_or_window
;
4058 frame
= XCAR (frame
);
4059 else if (WINDOWP (frame
))
4060 frame
= WINDOW_FRAME (XWINDOW (frame
));
4062 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4066 if (! EQ (frame
, internal_last_event_frame
)
4067 && !EQ (frame
, selected_frame
))
4068 obj
= make_lispy_switch_frame (frame
);
4069 internal_last_event_frame
= frame
;
4071 /* If we didn't decide to make a switch-frame event, go ahead
4072 and build a real event from the queue entry. */
4076 obj
= make_lispy_event (event
);
4078 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4079 || defined (HAVE_NS) || defined (USE_GTK)
4080 /* If this was a menu selection, then set the flag to inhibit
4081 writing to last_nonmenu_event. Don't do this if the event
4082 we're returning is (menu-bar), though; that indicates the
4083 beginning of the menu sequence, and we might as well leave
4084 that as the `event with parameters' for this selection. */
4086 && !EQ (event
->frame_or_window
, event
->arg
)
4087 && (event
->kind
== MENU_BAR_EVENT
4088 || event
->kind
== TOOL_BAR_EVENT
))
4089 *used_mouse_menu
= 1;
4092 /* certain system events are non-key events */
4094 && event
->kind
== NS_NONKEY_EVENT
)
4095 *used_mouse_menu
= 1;
4098 /* Wipe out this event, to catch bugs. */
4099 clear_event (event
);
4100 kbd_fetch_ptr
= event
+ 1;
4104 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4105 /* Try generating a mouse motion event. */
4106 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4108 FRAME_PTR f
= some_mouse_moved ();
4109 Lisp_Object bar_window
;
4110 enum scroll_bar_part part
;
4114 *kbp
= current_kboard
;
4115 /* Note that this uses F to determine which terminal to look at.
4116 If there is no valid info, it does not store anything
4117 so x remains nil. */
4120 /* XXX Can f or mouse_position_hook be NULL here? */
4121 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4122 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4127 /* Decide if we should generate a switch-frame event. Don't
4128 generate switch-frame events for motion outside of all Emacs
4134 frame
= FRAME_FOCUS_FRAME (f
);
4136 XSETFRAME (frame
, f
);
4138 if (! EQ (frame
, internal_last_event_frame
)
4139 && !EQ (frame
, selected_frame
))
4140 obj
= make_lispy_switch_frame (frame
);
4141 internal_last_event_frame
= frame
;
4144 /* If we didn't decide to make a switch-frame event, go ahead and
4145 return a mouse-motion event. */
4146 if (!NILP (x
) && NILP (obj
))
4147 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4149 #endif /* HAVE_MOUSE || HAVE GPM */
4151 /* We were promised by the above while loop that there was
4152 something for us to read! */
4155 input_pending
= readable_events (0);
4157 Vlast_event_frame
= internal_last_event_frame
;
4162 /* Process any non-user-visible events (currently X selection events),
4163 without reading any user-visible events. */
4166 process_special_events (void)
4168 struct input_event
*event
;
4170 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4172 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4175 if (event
== kbd_store_ptr
)
4179 /* If we find a stored X selection request, handle it now. */
4180 if (event
->kind
== SELECTION_REQUEST_EVENT
4181 || event
->kind
== SELECTION_CLEAR_EVENT
)
4185 /* Remove the event from the fifo buffer before processing;
4186 otherwise swallow_events called recursively could see it
4187 and process it again. To do this, we move the events
4188 between kbd_fetch_ptr and EVENT one slot to the right,
4191 struct input_event copy
= *event
;
4192 struct input_event
*beg
4193 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4194 ? kbd_buffer
: kbd_fetch_ptr
;
4197 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4198 else if (event
< beg
)
4200 if (event
> kbd_buffer
)
4201 memmove (kbd_buffer
+ 1, kbd_buffer
,
4202 (event
- kbd_buffer
) * sizeof (struct input_event
));
4203 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4204 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4205 memmove (beg
+ 1, beg
,
4206 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4207 * sizeof (struct input_event
));
4210 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4211 kbd_fetch_ptr
= kbd_buffer
+ 1;
4215 /* X wants last_event_timestamp for selection ownership. */
4216 last_event_timestamp
= copy
.timestamp
;
4217 input_pending
= readable_events (0);
4218 x_handle_selection_event (©
);
4220 /* We're getting selection request events, but we don't have
4228 /* Process any events that are not user-visible, run timer events that
4229 are ripe, and return, without reading any user-visible events. */
4232 swallow_events (int do_display
)
4236 process_special_events ();
4238 old_timers_run
= timers_run
;
4239 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4241 if (timers_run
!= old_timers_run
&& do_display
)
4242 redisplay_preserve_echo_area (7);
4245 /* Record the start of when Emacs is idle,
4246 for the sake of running idle-time timers. */
4249 timer_start_idle (void)
4253 /* If we are already in the idle state, do nothing. */
4254 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4257 timer_idleness_start_time
= current_emacs_time ();
4258 timer_last_idleness_start_time
= timer_idleness_start_time
;
4260 /* Mark all idle-time timers as once again candidates for running. */
4261 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4265 timer
= XCAR (timers
);
4267 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4269 ASET (timer
, 0, Qnil
);
4273 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4276 timer_stop_idle (void)
4278 timer_idleness_start_time
= invalid_emacs_time ();
4281 /* Resume idle timer from last idle start time. */
4284 timer_resume_idle (void)
4286 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4289 timer_idleness_start_time
= timer_last_idleness_start_time
;
4292 /* This is only for debugging. */
4293 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4295 /* List of elisp functions to call, delayed because they were generated in
4296 a context where Elisp could not be safely run (e.g. redisplay, signal,
4297 ...). Each element has the form (FUN . ARGS). */
4298 Lisp_Object pending_funcalls
;
4300 /* If TIMER is a valid timer, return nonzero and place its value into
4301 *RESULT. Otherwise return zero. */
4303 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4305 Lisp_Object
*vector
;
4307 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4309 vector
= XVECTOR (timer
)->contents
;
4310 if (! NILP (vector
[0]))
4313 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[4],
4318 /* Check whether a timer has fired. To prevent larger problems we simply
4319 disregard elements that are not proper timers. Do not make a circular
4320 timer list for the time being.
4322 Returns the time to wait until the next timer fires. If a
4323 timer is triggering now, return zero.
4324 If no timer is active, return -1.
4326 If a timer is ripe, we run it, with quitting turned off.
4327 In that case we return 0 to indicate that a new timer_check_2 call
4331 timer_check_2 (void)
4333 EMACS_TIME nexttime
;
4335 EMACS_TIME idleness_now
;
4336 Lisp_Object timers
, idle_timers
, chosen_timer
;
4337 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4339 nexttime
= invalid_emacs_time ();
4341 /* Always consider the ordinary timers. */
4342 timers
= Vtimer_list
;
4343 /* Consider the idle timers only if Emacs is idle. */
4344 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4345 idle_timers
= Vtimer_idle_list
;
4348 chosen_timer
= Qnil
;
4349 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4351 /* First run the code that was delayed. */
4352 while (CONSP (pending_funcalls
))
4354 Lisp_Object funcall
= XCAR (pending_funcalls
);
4355 pending_funcalls
= XCDR (pending_funcalls
);
4356 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4359 if (CONSP (timers
) || CONSP (idle_timers
))
4361 now
= current_emacs_time ();
4362 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4363 ? sub_emacs_time (now
, timer_idleness_start_time
)
4364 : make_emacs_time (0, 0));
4367 while (CONSP (timers
) || CONSP (idle_timers
))
4369 Lisp_Object
*vector
;
4370 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4371 EMACS_TIME timer_time
, idle_timer_time
;
4372 EMACS_TIME difference
;
4373 EMACS_TIME timer_difference
= invalid_emacs_time ();
4374 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4375 int ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4377 /* Set TIMER and TIMER_DIFFERENCE
4378 based on the next ordinary timer.
4379 TIMER_DIFFERENCE is the distance in time from NOW to when
4380 this timer becomes ripe (negative if it's already ripe).
4381 Skip past invalid timers and timers already handled. */
4384 timer
= XCAR (timers
);
4385 if (! decode_timer (timer
, &timer_time
))
4387 timers
= XCDR (timers
);
4391 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4392 timer_difference
= (timer_ripe
4393 ? sub_emacs_time (now
, timer_time
)
4394 : sub_emacs_time (timer_time
, now
));
4397 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4398 based on the next idle timer. */
4399 if (CONSP (idle_timers
))
4401 idle_timer
= XCAR (idle_timers
);
4402 if (! decode_timer (idle_timer
, &idle_timer_time
))
4404 idle_timers
= XCDR (idle_timers
);
4408 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4409 idle_timer_difference
=
4411 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4412 : sub_emacs_time (idle_timer_time
, idleness_now
));
4415 /* Decide which timer is the next timer,
4416 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4417 Also step down the list where we found that timer. */
4419 if (EMACS_TIME_VALID_P (timer_difference
)
4420 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4421 || idle_timer_ripe
< timer_ripe
4422 || (idle_timer_ripe
== timer_ripe
4424 ? EMACS_TIME_LT (idle_timer_difference
,
4426 : EMACS_TIME_LT (timer_difference
,
4427 idle_timer_difference
)))))
4429 chosen_timer
= timer
;
4430 timers
= XCDR (timers
);
4431 difference
= timer_difference
;
4436 chosen_timer
= idle_timer
;
4437 idle_timers
= XCDR (idle_timers
);
4438 difference
= idle_timer_difference
;
4439 ripe
= idle_timer_ripe
;
4442 /* If timer is ripe, run it if it hasn't been run. */
4445 vector
= XVECTOR (chosen_timer
)->contents
;
4446 if (NILP (vector
[0]))
4448 ptrdiff_t count
= SPECPDL_INDEX ();
4449 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4451 /* Mark the timer as triggered to prevent problems if the lisp
4452 code fails to reschedule it right. */
4455 specbind (Qinhibit_quit
, Qt
);
4457 call1 (Qtimer_event_handler
, chosen_timer
);
4458 Vdeactivate_mark
= old_deactivate_mark
;
4460 unbind_to (count
, Qnil
);
4462 /* Since we have handled the event,
4463 we don't need to tell the caller to wake up and do it. */
4464 /* But the caller must still wait for the next timer, so
4465 return 0 to indicate that. */
4468 nexttime
= make_emacs_time (0, 0);
4471 /* When we encounter a timer that is still waiting,
4472 return the amount of time to wait before it is ripe. */
4479 /* No timers are pending in the future. */
4480 /* Return 0 if we generated an event, and -1 if not. */
4486 /* Check whether a timer has fired. To prevent larger problems we simply
4487 disregard elements that are not proper timers. Do not make a circular
4488 timer list for the time being.
4490 Returns the time to wait until the next timer fires.
4491 If no timer is active, return an invalid value.
4493 As long as any timer is ripe, we run it. */
4498 EMACS_TIME nexttime
;
4502 nexttime
= timer_check_2 ();
4504 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4509 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4510 doc
: /* Return the current length of Emacs idleness, or nil.
4511 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4512 in the same style as (current-time).
4514 The value when Emacs is not idle is nil.
4516 NSEC is a multiple of the system clock resolution. */)
4519 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4520 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4521 timer_idleness_start_time
));
4526 /* Caches for modify_event_symbol. */
4527 static Lisp_Object accent_key_syms
;
4528 static Lisp_Object func_key_syms
;
4529 static Lisp_Object mouse_syms
;
4530 static Lisp_Object wheel_syms
;
4531 static Lisp_Object drag_n_drop_syms
;
4533 /* This is a list of keysym codes for special "accent" characters.
4534 It parallels lispy_accent_keys. */
4536 static const int lispy_accent_codes
[] =
4538 #ifdef XK_dead_circumflex
4543 #ifdef XK_dead_grave
4548 #ifdef XK_dead_tilde
4553 #ifdef XK_dead_diaeresis
4558 #ifdef XK_dead_macron
4563 #ifdef XK_dead_degree
4568 #ifdef XK_dead_acute
4573 #ifdef XK_dead_cedilla
4578 #ifdef XK_dead_breve
4583 #ifdef XK_dead_ogonek
4588 #ifdef XK_dead_caron
4593 #ifdef XK_dead_doubleacute
4594 XK_dead_doubleacute
,
4598 #ifdef XK_dead_abovedot
4603 #ifdef XK_dead_abovering
4613 #ifdef XK_dead_belowdot
4618 #ifdef XK_dead_voiced_sound
4619 XK_dead_voiced_sound
,
4623 #ifdef XK_dead_semivoiced_sound
4624 XK_dead_semivoiced_sound
,
4640 /* This is a list of Lisp names for special "accent" characters.
4641 It parallels lispy_accent_codes. */
4643 static const char *const lispy_accent_keys
[] =
4661 "dead-voiced-sound",
4662 "dead-semivoiced-sound",
4668 #define FUNCTION_KEY_OFFSET 0x0
4670 const char *const lispy_function_keys
[] =
4674 0, /* VK_LBUTTON 0x01 */
4675 0, /* VK_RBUTTON 0x02 */
4676 "cancel", /* VK_CANCEL 0x03 */
4677 0, /* VK_MBUTTON 0x04 */
4679 0, 0, 0, /* 0x05 .. 0x07 */
4681 "backspace", /* VK_BACK 0x08 */
4682 "tab", /* VK_TAB 0x09 */
4684 0, 0, /* 0x0A .. 0x0B */
4686 "clear", /* VK_CLEAR 0x0C */
4687 "return", /* VK_RETURN 0x0D */
4689 0, 0, /* 0x0E .. 0x0F */
4691 0, /* VK_SHIFT 0x10 */
4692 0, /* VK_CONTROL 0x11 */
4693 0, /* VK_MENU 0x12 */
4694 "pause", /* VK_PAUSE 0x13 */
4695 "capslock", /* VK_CAPITAL 0x14 */
4696 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4698 "junja", /* VK_JUNJA 0x17 */
4699 "final", /* VK_FINAL 0x18 */
4700 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4702 "escape", /* VK_ESCAPE 0x1B */
4703 "convert", /* VK_CONVERT 0x1C */
4704 "non-convert", /* VK_NONCONVERT 0x1D */
4705 "accept", /* VK_ACCEPT 0x1E */
4706 "mode-change", /* VK_MODECHANGE 0x1F */
4707 0, /* VK_SPACE 0x20 */
4708 "prior", /* VK_PRIOR 0x21 */
4709 "next", /* VK_NEXT 0x22 */
4710 "end", /* VK_END 0x23 */
4711 "home", /* VK_HOME 0x24 */
4712 "left", /* VK_LEFT 0x25 */
4713 "up", /* VK_UP 0x26 */
4714 "right", /* VK_RIGHT 0x27 */
4715 "down", /* VK_DOWN 0x28 */
4716 "select", /* VK_SELECT 0x29 */
4717 "print", /* VK_PRINT 0x2A */
4718 "execute", /* VK_EXECUTE 0x2B */
4719 "snapshot", /* VK_SNAPSHOT 0x2C */
4720 "insert", /* VK_INSERT 0x2D */
4721 "delete", /* VK_DELETE 0x2E */
4722 "help", /* VK_HELP 0x2F */
4724 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4726 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4728 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4730 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4732 0, 0, 0, 0, 0, 0, 0, 0, 0,
4733 0, 0, 0, 0, 0, 0, 0, 0, 0,
4734 0, 0, 0, 0, 0, 0, 0, 0,
4736 "lwindow", /* VK_LWIN 0x5B */
4737 "rwindow", /* VK_RWIN 0x5C */
4738 "apps", /* VK_APPS 0x5D */
4741 "kp-0", /* VK_NUMPAD0 0x60 */
4742 "kp-1", /* VK_NUMPAD1 0x61 */
4743 "kp-2", /* VK_NUMPAD2 0x62 */
4744 "kp-3", /* VK_NUMPAD3 0x63 */
4745 "kp-4", /* VK_NUMPAD4 0x64 */
4746 "kp-5", /* VK_NUMPAD5 0x65 */
4747 "kp-6", /* VK_NUMPAD6 0x66 */
4748 "kp-7", /* VK_NUMPAD7 0x67 */
4749 "kp-8", /* VK_NUMPAD8 0x68 */
4750 "kp-9", /* VK_NUMPAD9 0x69 */
4751 "kp-multiply", /* VK_MULTIPLY 0x6A */
4752 "kp-add", /* VK_ADD 0x6B */
4753 "kp-separator", /* VK_SEPARATOR 0x6C */
4754 "kp-subtract", /* VK_SUBTRACT 0x6D */
4755 "kp-decimal", /* VK_DECIMAL 0x6E */
4756 "kp-divide", /* VK_DIVIDE 0x6F */
4757 "f1", /* VK_F1 0x70 */
4758 "f2", /* VK_F2 0x71 */
4759 "f3", /* VK_F3 0x72 */
4760 "f4", /* VK_F4 0x73 */
4761 "f5", /* VK_F5 0x74 */
4762 "f6", /* VK_F6 0x75 */
4763 "f7", /* VK_F7 0x76 */
4764 "f8", /* VK_F8 0x77 */
4765 "f9", /* VK_F9 0x78 */
4766 "f10", /* VK_F10 0x79 */
4767 "f11", /* VK_F11 0x7A */
4768 "f12", /* VK_F12 0x7B */
4769 "f13", /* VK_F13 0x7C */
4770 "f14", /* VK_F14 0x7D */
4771 "f15", /* VK_F15 0x7E */
4772 "f16", /* VK_F16 0x7F */
4773 "f17", /* VK_F17 0x80 */
4774 "f18", /* VK_F18 0x81 */
4775 "f19", /* VK_F19 0x82 */
4776 "f20", /* VK_F20 0x83 */
4777 "f21", /* VK_F21 0x84 */
4778 "f22", /* VK_F22 0x85 */
4779 "f23", /* VK_F23 0x86 */
4780 "f24", /* VK_F24 0x87 */
4782 0, 0, 0, 0, /* 0x88 .. 0x8B */
4783 0, 0, 0, 0, /* 0x8C .. 0x8F */
4785 "kp-numlock", /* VK_NUMLOCK 0x90 */
4786 "scroll", /* VK_SCROLL 0x91 */
4787 /* Not sure where the following block comes from.
4788 Windows headers have NEC and Fujitsu specific keys in
4789 this block, but nothing generic. */
4790 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4791 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4792 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4793 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4794 "kp-end", /* VK_NUMPAD_END 0x96 */
4795 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4796 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4797 "kp-up", /* VK_NUMPAD_UP 0x99 */
4798 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4799 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4800 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4801 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4803 0, 0, /* 0x9E .. 0x9F */
4806 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4807 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4808 * No other API or message will distinguish left and right keys this way.
4813 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4814 to enable them selectively, and gives access to a few more functions.
4815 See lispy_multimedia_keys below. */
4816 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4817 0, 0, 0, /* 0xAD .. 0xAF Volume */
4818 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4819 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4821 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4822 0, 0, 0, 0, 0, 0, 0, 0, 0,
4824 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4825 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4826 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4829 "ax", /* VK_OEM_AX 0xE1 */
4830 0, /* VK_OEM_102 0xE2 */
4831 "ico-help", /* VK_ICO_HELP 0xE3 */
4832 "ico-00", /* VK_ICO_00 0xE4 */
4833 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4834 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4835 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4837 "reset", /* VK_OEM_RESET 0xE9 */
4838 "jump", /* VK_OEM_JUMP 0xEA */
4839 "oem-pa1", /* VK_OEM_PA1 0xEB */
4840 "oem-pa2", /* VK_OEM_PA2 0xEC */
4841 "oem-pa3", /* VK_OEM_PA3 0xED */
4842 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4843 "cusel", /* VK_OEM_CUSEL 0xEF */
4844 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4845 "finish", /* VK_OEM_FINISH 0xF1 */
4846 "copy", /* VK_OEM_COPY 0xF2 */
4847 "auto", /* VK_OEM_AUTO 0xF3 */
4848 "enlw", /* VK_OEM_ENLW 0xF4 */
4849 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4850 "attn", /* VK_ATTN 0xF6 */
4851 "crsel", /* VK_CRSEL 0xF7 */
4852 "exsel", /* VK_EXSEL 0xF8 */
4853 "ereof", /* VK_EREOF 0xF9 */
4854 "play", /* VK_PLAY 0xFA */
4855 "zoom", /* VK_ZOOM 0xFB */
4856 "noname", /* VK_NONAME 0xFC */
4857 "pa1", /* VK_PA1 0xFD */
4858 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4862 /* Some of these duplicate the "Media keys" on newer keyboards,
4863 but they are delivered to the application in a different way. */
4864 static const char *const lispy_multimedia_keys
[] =
4872 "browser-favorites",
4909 "toggle-dictate-command",
4915 "media-fast-forward",
4918 "media-channel-down"
4921 #else /* not HAVE_NTGUI */
4923 /* This should be dealt with in XTread_socket now, and that doesn't
4924 depend on the client system having the Kana syms defined. See also
4925 the XK_kana_A case below. */
4928 static const char *const lispy_kana_keys
[] =
4930 /* X Keysym value */
4931 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4932 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4933 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4934 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4935 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4936 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4937 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4938 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4939 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4940 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4941 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4942 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4943 "kana-i", "kana-u", "kana-e", "kana-o",
4944 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4945 "prolongedsound", "kana-A", "kana-I", "kana-U",
4946 "kana-E", "kana-O", "kana-KA", "kana-KI",
4947 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4948 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4949 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4950 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4951 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4952 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4953 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4954 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4955 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4956 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4957 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4958 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4960 #endif /* XK_kana_A */
4963 #define FUNCTION_KEY_OFFSET 0xff00
4965 /* You'll notice that this table is arranged to be conveniently
4966 indexed by X Windows keysym values. */
4967 static const char *const lispy_function_keys
[] =
4969 /* X Keysym value */
4971 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4972 "backspace", "tab", "linefeed", "clear",
4974 0, 0, 0, "pause", /* 0xff10...1f */
4975 0, 0, 0, 0, 0, 0, 0, "escape",
4977 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4978 "romaji", "hiragana", "katakana", "hiragana-katakana",
4979 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4980 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4981 "eisu-toggle", /* 0xff30...3f */
4982 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4983 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4985 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4986 "down", "prior", "next", "end",
4987 "begin", 0, 0, 0, 0, 0, 0, 0,
4988 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4999 "break", /* 0xff6b */
5002 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5003 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5004 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5005 0, 0, 0, 0, 0, 0, 0, 0,
5006 "kp-tab", /* 0xff89 */
5008 "kp-enter", /* 0xff8d */
5010 "kp-f1", /* 0xff91 */
5014 "kp-home", /* 0xff95 */
5019 "kp-prior", /* kp-page-up */
5020 "kp-next", /* kp-page-down */
5026 0, 0, 0, 0, 0, 0, 0, 0, 0,
5027 "kp-multiply", /* 0xffaa */
5032 "kp-divide", /* 0xffaf */
5033 "kp-0", /* 0xffb0 */
5034 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5037 "kp-equal", /* 0xffbd */
5038 "f1", /* 0xffbe */ /* IsFunctionKey */
5040 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5041 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5042 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5043 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5044 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5045 0, 0, 0, 0, 0, 0, 0, 0,
5046 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5047 0, 0, 0, 0, 0, 0, 0, "delete"
5050 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5051 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5053 static const char *const iso_lispy_function_keys
[] =
5055 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5056 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5057 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5058 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5059 "iso-lefttab", /* 0xfe20 */
5060 "iso-move-line-up", "iso-move-line-down",
5061 "iso-partial-line-up", "iso-partial-line-down",
5062 "iso-partial-space-left", "iso-partial-space-right",
5063 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5064 "iso-release-margin-left", "iso-release-margin-right",
5065 "iso-release-both-margins",
5066 "iso-fast-cursor-left", "iso-fast-cursor-right",
5067 "iso-fast-cursor-up", "iso-fast-cursor-down",
5068 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5069 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5072 #endif /* not HAVE_NTGUI */
5074 static Lisp_Object Vlispy_mouse_stem
;
5076 static const char *const lispy_wheel_names
[] =
5078 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5081 /* drag-n-drop events are generated when a set of selected files are
5082 dragged from another application and dropped onto an Emacs window. */
5083 static const char *const lispy_drag_n_drop_names
[] =
5088 /* Scroll bar parts. */
5089 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5090 Lisp_Object Qup
, Qdown
, Qbottom
;
5091 static Lisp_Object Qend_scroll
;
5093 static Lisp_Object Qratio
;
5095 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5096 static Lisp_Object
*const scroll_bar_parts
[] = {
5097 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5098 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5101 /* A vector, indexed by button number, giving the down-going location
5102 of currently depressed buttons, both scroll bar and non-scroll bar.
5104 The elements have the form
5105 (BUTTON-NUMBER MODIFIER-MASK . REST)
5106 where REST is the cdr of a position as it would be reported in the event.
5108 The make_lispy_event function stores positions here to tell the
5109 difference between click and drag events, and to store the starting
5110 location to be included in drag events. */
5112 static Lisp_Object button_down_location
;
5114 /* Information about the most recent up-going button event: Which
5115 button, what location, and what time. */
5117 static int last_mouse_button
;
5118 static int last_mouse_x
;
5119 static int last_mouse_y
;
5120 static Time button_down_time
;
5122 /* The number of clicks in this multiple-click. */
5124 static int double_click_count
;
5126 /* X and Y are frame-relative coordinates for a click or wheel event.
5127 Return a Lisp-style event list. */
5130 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5133 enum window_part part
;
5134 Lisp_Object posn
= Qnil
;
5135 Lisp_Object extra_info
= Qnil
;
5136 /* Coordinate pixel positions to return. */
5137 int xret
= 0, yret
= 0;
5138 /* The window under frame pixel coordinates (x,y) */
5139 Lisp_Object window
= f
5140 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5143 if (WINDOWP (window
))
5145 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5146 struct window
*w
= XWINDOW (window
);
5147 Lisp_Object string_info
= Qnil
;
5148 ptrdiff_t textpos
= -1;
5149 int col
= -1, row
= -1;
5150 int dx
= -1, dy
= -1;
5151 int width
= -1, height
= -1;
5152 Lisp_Object object
= Qnil
;
5154 /* Pixel coordinates relative to the window corner. */
5155 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5156 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5158 /* For text area clicks, return X, Y relative to the corner of
5159 this text area. Note that dX, dY etc are set below, by
5160 buffer_posn_from_coords. */
5161 if (part
== ON_TEXT
)
5163 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5164 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5166 /* For mode line and header line clicks, return X, Y relative to
5167 the left window edge. Use mode_line_string to look for a
5168 string on the click position. */
5169 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5174 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5175 /* Note that mode_line_string takes COL, ROW as pixels and
5176 converts them to characters. */
5179 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5180 &object
, &dx
, &dy
, &width
, &height
);
5181 if (STRINGP (string
))
5182 string_info
= Fcons (string
, make_number (charpos
));
5183 textpos
= (w
== XWINDOW (selected_window
)
5184 && current_buffer
== XBUFFER (w
->buffer
))
5185 ? PT
: XMARKER (w
->pointm
)->charpos
;
5190 /* For fringes and margins, Y is relative to the area's (and the
5191 window's) top edge, while X is meaningless. */
5192 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5197 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5200 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5201 &object
, &dx
, &dy
, &width
, &height
);
5202 if (STRINGP (string
))
5203 string_info
= Fcons (string
, make_number (charpos
));
5204 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5206 else if (part
== ON_LEFT_FRINGE
)
5208 posn
= Qleft_fringe
;
5211 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5212 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5213 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5215 else if (part
== ON_RIGHT_FRINGE
)
5217 posn
= Qright_fringe
;
5220 - window_box_width (w
, LEFT_MARGIN_AREA
)
5221 - window_box_width (w
, TEXT_AREA
)
5222 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5223 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5225 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5227 else if (part
== ON_VERTICAL_BORDER
)
5229 posn
= Qvertical_line
;
5234 /* Nothing special for part == ON_SCROLL_BAR. */
5236 /* For clicks in the text area, fringes, or margins, call
5237 buffer_posn_from_coords to extract TEXTPOS, the buffer
5238 position nearest to the click. */
5241 Lisp_Object string2
, object2
= Qnil
;
5242 struct display_pos p
;
5244 int width2
, height2
;
5245 /* The pixel X coordinate passed to buffer_posn_from_coords
5246 is the X coordinate relative to the text area for
5247 text-area and right-margin clicks, zero otherwise. */
5249 = (part
== ON_TEXT
) ? xret
5250 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5251 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5255 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5256 &object2
, &dx2
, &dy2
,
5258 textpos
= CHARPOS (p
.pos
);
5259 if (col
< 0) col
= x2
;
5260 if (row
< 0) row
= y2
;
5261 if (dx
< 0) dx
= dx2
;
5262 if (dy
< 0) dy
= dy2
;
5263 if (width
< 0) width
= width2
;
5264 if (height
< 0) height
= height2
;
5268 posn
= make_number (textpos
);
5269 if (STRINGP (string2
))
5270 string_info
= Fcons (string2
,
5271 make_number (CHARPOS (p
.string_pos
)));
5277 #ifdef HAVE_WINDOW_SYSTEM
5278 if (IMAGEP (object
))
5280 Lisp_Object image_map
, hotspot
;
5281 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5283 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5285 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5286 posn
= XCAR (hotspot
);
5293 Fcons (make_number (dx
), make_number (dy
)),
5294 Fcons (make_number (width
), make_number (height
)));
5297 extra_info
= Fcons (string_info
,
5298 Fcons (make_number (textpos
),
5299 Fcons (Fcons (make_number (col
),
5304 XSETFRAME (window
, f
);
5308 return Fcons (window
,
5310 Fcons (Fcons (make_number (xret
),
5311 make_number (yret
)),
5312 Fcons (make_number (t
),
5316 /* Given a struct input_event, build the lisp event which represents
5317 it. If EVENT is 0, build a mouse movement event from the mouse
5318 movement buffer, which should have a movement event in it.
5320 Note that events must be passed to this function in the order they
5321 are received; this function stores the location of button presses
5322 in order to build drag events when the button is released. */
5325 make_lispy_event (struct input_event
*event
)
5329 switch (SWITCH_ENUM_CAST (event
->kind
))
5331 /* A simple keystroke. */
5332 case ASCII_KEYSTROKE_EVENT
:
5333 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5335 Lisp_Object lispy_c
;
5336 EMACS_INT c
= event
->code
;
5337 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5340 eassert (c
== event
->code
);
5341 /* Turn ASCII characters into control characters
5343 if (event
->modifiers
& ctrl_modifier
)
5345 c
= make_ctrl_char (c
);
5346 event
->modifiers
&= ~ctrl_modifier
;
5350 /* Add in the other modifier bits. The shift key was taken care
5351 of by the X code. */
5352 c
|= (event
->modifiers
5353 & (meta_modifier
| alt_modifier
5354 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5355 /* Distinguish Shift-SPC from SPC. */
5356 if ((event
->code
) == 040
5357 && event
->modifiers
& shift_modifier
)
5358 c
|= shift_modifier
;
5359 button_down_time
= 0;
5360 XSETFASTINT (lispy_c
, c
);
5365 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5366 except that they are non-key events (last-nonmenu-event is nil). */
5367 case NS_NONKEY_EVENT
:
5370 /* A function key. The symbol may need to have modifier prefixes
5372 case NON_ASCII_KEYSTROKE_EVENT
:
5373 button_down_time
= 0;
5375 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5376 if (event
->code
== lispy_accent_codes
[i
])
5377 return modify_event_symbol (i
,
5379 Qfunction_key
, Qnil
,
5380 lispy_accent_keys
, &accent_key_syms
,
5381 (sizeof (lispy_accent_keys
)
5382 / sizeof (lispy_accent_keys
[0])));
5386 if (event
->code
>= 0x400 && event
->code
< 0x500)
5387 return modify_event_symbol (event
->code
- 0x400,
5388 event
->modifiers
& ~shift_modifier
,
5389 Qfunction_key
, Qnil
,
5390 lispy_kana_keys
, &func_key_syms
,
5391 (sizeof (lispy_kana_keys
)
5392 / sizeof (lispy_kana_keys
[0])));
5393 #endif /* XK_kana_A */
5396 #ifdef ISO_FUNCTION_KEY_OFFSET
5397 if (event
->code
< FUNCTION_KEY_OFFSET
5398 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5399 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5401 Qfunction_key
, Qnil
,
5402 iso_lispy_function_keys
, &func_key_syms
,
5403 (sizeof (iso_lispy_function_keys
)
5404 / sizeof (iso_lispy_function_keys
[0])));
5407 /* Handle system-specific or unknown keysyms. */
5408 if (event
->code
& (1 << 28)
5409 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5410 || (event
->code
- FUNCTION_KEY_OFFSET
5411 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5412 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5414 /* We need to use an alist rather than a vector as the cache
5415 since we can't make a vector long enough. */
5416 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5417 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5418 return modify_event_symbol (event
->code
,
5421 KVAR (current_kboard
, Vsystem_key_alist
),
5422 0, &KVAR (current_kboard
, system_key_syms
),
5426 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5428 Qfunction_key
, Qnil
,
5429 lispy_function_keys
, &func_key_syms
,
5430 (sizeof (lispy_function_keys
)
5431 / sizeof (lispy_function_keys
[0])));
5434 case MULTIMEDIA_KEY_EVENT
:
5435 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5436 / sizeof (lispy_multimedia_keys
[0]))
5437 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5439 return modify_event_symbol (event
->code
, event
->modifiers
,
5440 Qfunction_key
, Qnil
,
5441 lispy_multimedia_keys
, &func_key_syms
,
5442 (sizeof (lispy_multimedia_keys
)
5443 / sizeof (lispy_multimedia_keys
[0])));
5449 /* A mouse click. Figure out where it is, decide whether it's
5450 a press, click or drag, and build the appropriate structure. */
5451 case MOUSE_CLICK_EVENT
:
5452 #ifndef USE_TOOLKIT_SCROLL_BARS
5453 case SCROLL_BAR_CLICK_EVENT
:
5456 int button
= event
->code
;
5458 Lisp_Object position
;
5459 Lisp_Object
*start_pos_ptr
;
5460 Lisp_Object start_pos
;
5464 /* Build the position as appropriate for this mouse click. */
5465 if (event
->kind
== MOUSE_CLICK_EVENT
)
5467 struct frame
*f
= XFRAME (event
->frame_or_window
);
5468 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5472 /* Ignore mouse events that were made on frame that
5473 have been deleted. */
5474 if (! FRAME_LIVE_P (f
))
5477 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5478 /* EVENT->x and EVENT->y are frame-relative pixel
5479 coordinates at this place. Under old redisplay, COLUMN
5480 and ROW are set to frame relative glyph coordinates
5481 which are then used to determine whether this click is
5482 in a menu (non-toolkit version). */
5483 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5484 &column
, &row
, NULL
, 1);
5486 /* In the non-toolkit version, clicks on the menu bar
5487 are ordinary button events in the event buffer.
5488 Distinguish them, and invoke the menu.
5490 (In the toolkit version, the toolkit handles the menu bar
5491 and Emacs doesn't know about it until after the user
5492 makes a selection.) */
5493 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5494 && (event
->modifiers
& down_modifier
))
5496 Lisp_Object items
, item
;
5498 /* Find the menu bar item under `column'. */
5500 items
= FRAME_MENU_BAR_ITEMS (f
);
5501 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5503 Lisp_Object pos
, string
;
5504 string
= AREF (items
, i
+ 1);
5505 pos
= AREF (items
, i
+ 3);
5508 if (column
>= XINT (pos
)
5509 && column
< XINT (pos
) + SCHARS (string
))
5511 item
= AREF (items
, i
);
5516 /* ELisp manual 2.4b says (x y) are window relative but
5517 code says they are frame-relative. */
5519 = Fcons (event
->frame_or_window
,
5521 Fcons (Fcons (event
->x
, event
->y
),
5522 Fcons (make_number (event
->timestamp
),
5525 return Fcons (item
, Fcons (position
, Qnil
));
5527 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5529 position
= make_lispy_position (f
, event
->x
, event
->y
,
5532 #ifndef USE_TOOLKIT_SCROLL_BARS
5535 /* It's a scrollbar click. */
5537 Lisp_Object portion_whole
;
5540 window
= event
->frame_or_window
;
5541 portion_whole
= Fcons (event
->x
, event
->y
);
5542 part
= *scroll_bar_parts
[(int) event
->part
];
5546 Fcons (Qvertical_scroll_bar
,
5547 Fcons (portion_whole
,
5548 Fcons (make_number (event
->timestamp
),
5549 Fcons (part
, Qnil
)))));
5551 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5553 if (button
>= ASIZE (button_down_location
))
5555 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5556 button_down_location
= larger_vector (button_down_location
,
5558 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5561 start_pos_ptr
= &AREF (button_down_location
, button
);
5562 start_pos
= *start_pos_ptr
;
5563 *start_pos_ptr
= Qnil
;
5566 /* On window-system frames, use the value of
5567 double-click-fuzz as is. On other frames, interpret it
5568 as a multiple of 1/8 characters. */
5572 if (WINDOWP (event
->frame_or_window
))
5573 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5574 else if (FRAMEP (event
->frame_or_window
))
5575 f
= XFRAME (event
->frame_or_window
);
5579 if (FRAME_WINDOW_P (f
))
5580 fuzz
= double_click_fuzz
;
5582 fuzz
= double_click_fuzz
/ 8;
5584 is_double
= (button
== last_mouse_button
5585 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5586 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5587 && button_down_time
!= 0
5588 && (EQ (Vdouble_click_time
, Qt
)
5589 || (NATNUMP (Vdouble_click_time
)
5590 && (event
->timestamp
- button_down_time
5591 < XFASTINT (Vdouble_click_time
)))));
5594 last_mouse_button
= button
;
5595 last_mouse_x
= XINT (event
->x
);
5596 last_mouse_y
= XINT (event
->y
);
5598 /* If this is a button press, squirrel away the location, so
5599 we can decide later whether it was a click or a drag. */
5600 if (event
->modifiers
& down_modifier
)
5604 double_click_count
++;
5605 event
->modifiers
|= ((double_click_count
> 2)
5610 double_click_count
= 1;
5611 button_down_time
= event
->timestamp
;
5612 *start_pos_ptr
= Fcopy_alist (position
);
5613 ignore_mouse_drag_p
= 0;
5616 /* Now we're releasing a button - check the co-ordinates to
5617 see if this was a click or a drag. */
5618 else if (event
->modifiers
& up_modifier
)
5620 /* If we did not see a down before this up, ignore the up.
5621 Probably this happened because the down event chose a
5622 menu item. It would be an annoyance to treat the
5623 release of the button that chose the menu item as a
5626 if (!CONSP (start_pos
))
5629 event
->modifiers
&= ~up_modifier
;
5632 Lisp_Object new_down
, down
;
5633 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5635 /* The third element of every position
5636 should be the (x,y) pair. */
5637 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5638 new_down
= Fcar (Fcdr (Fcdr (position
)));
5641 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5643 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5644 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5647 if (ignore_mouse_drag_p
)
5649 event
->modifiers
|= click_modifier
;
5650 ignore_mouse_drag_p
= 0;
5652 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5653 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5654 /* Maybe the mouse has moved a lot, caused scrolling, and
5655 eventually ended up at the same screen position (but
5656 not buffer position) in which case it is a drag, not
5658 /* FIXME: OTOH if the buffer position has changed
5659 because of a timer or process filter rather than
5660 because of mouse movement, it should be considered as
5661 a click. But mouse-drag-region completely ignores
5662 this case and it hasn't caused any real problem, so
5663 it's probably OK to ignore it as well. */
5664 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5665 /* Mouse hasn't moved (much). */
5666 event
->modifiers
|= click_modifier
;
5669 button_down_time
= 0;
5670 event
->modifiers
|= drag_modifier
;
5673 /* Don't check is_double; treat this as multiple
5674 if the down-event was multiple. */
5675 if (double_click_count
> 1)
5676 event
->modifiers
|= ((double_click_count
> 2)
5682 /* Every mouse event should either have the down_modifier or
5683 the up_modifier set. */
5687 /* Get the symbol we should use for the mouse click. */
5690 head
= modify_event_symbol (button
,
5692 Qmouse_click
, Vlispy_mouse_stem
,
5695 ASIZE (mouse_syms
));
5696 if (event
->modifiers
& drag_modifier
)
5701 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5704 Fcons (make_number (double_click_count
),
5714 case HORIZ_WHEEL_EVENT
:
5716 Lisp_Object position
;
5719 /* Build the position as appropriate for this mouse click. */
5720 struct frame
*f
= XFRAME (event
->frame_or_window
);
5722 /* Ignore wheel events that were made on frame that have been
5724 if (! FRAME_LIVE_P (f
))
5727 position
= make_lispy_position (f
, event
->x
, event
->y
,
5730 /* Set double or triple modifiers to indicate the wheel speed. */
5732 /* On window-system frames, use the value of
5733 double-click-fuzz as is. On other frames, interpret it
5734 as a multiple of 1/8 characters. */
5740 if (WINDOWP (event
->frame_or_window
))
5741 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5742 else if (FRAMEP (event
->frame_or_window
))
5743 fr
= XFRAME (event
->frame_or_window
);
5747 fuzz
= FRAME_WINDOW_P (fr
)
5748 ? double_click_fuzz
: double_click_fuzz
/ 8;
5750 if (event
->modifiers
& up_modifier
)
5752 /* Emit a wheel-up event. */
5753 event
->modifiers
&= ~up_modifier
;
5756 else if (event
->modifiers
& down_modifier
)
5758 /* Emit a wheel-down event. */
5759 event
->modifiers
&= ~down_modifier
;
5763 /* Every wheel event should either have the down_modifier or
5764 the up_modifier set. */
5767 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5770 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5771 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5772 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5773 && button_down_time
!= 0
5774 && (EQ (Vdouble_click_time
, Qt
)
5775 || (NATNUMP (Vdouble_click_time
)
5776 && (event
->timestamp
- button_down_time
5777 < XFASTINT (Vdouble_click_time
)))));
5780 double_click_count
++;
5781 event
->modifiers
|= ((double_click_count
> 2)
5787 double_click_count
= 1;
5788 event
->modifiers
|= click_modifier
;
5791 button_down_time
= event
->timestamp
;
5792 /* Use a negative value to distinguish wheel from mouse button. */
5793 last_mouse_button
= - (1 + symbol_num
);
5794 last_mouse_x
= XINT (event
->x
);
5795 last_mouse_y
= XINT (event
->y
);
5797 /* Get the symbol we should use for the wheel event. */
5798 head
= modify_event_symbol (symbol_num
,
5804 ASIZE (wheel_syms
));
5807 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5810 Fcons (make_number (double_click_count
),
5819 #ifdef USE_TOOLKIT_SCROLL_BARS
5821 /* We don't have down and up events if using toolkit scroll bars,
5822 so make this always a click event. Store in the `part' of
5823 the Lisp event a symbol which maps to the following actions:
5825 `above_handle' page up
5826 `below_handle' page down
5830 `bottom' bottom of buffer
5831 `handle' thumb has been dragged.
5832 `end-scroll' end of interaction with scroll bar
5834 The incoming input_event contains in its `part' member an
5835 index of type `enum scroll_bar_part' which we can use as an
5836 index in scroll_bar_parts to get the appropriate symbol. */
5838 case SCROLL_BAR_CLICK_EVENT
:
5840 Lisp_Object position
, head
, window
, portion_whole
, part
;
5842 window
= event
->frame_or_window
;
5843 portion_whole
= Fcons (event
->x
, event
->y
);
5844 part
= *scroll_bar_parts
[(int) event
->part
];
5848 Fcons (Qvertical_scroll_bar
,
5849 Fcons (portion_whole
,
5850 Fcons (make_number (event
->timestamp
),
5851 Fcons (part
, Qnil
)))));
5853 /* Always treat scroll bar events as clicks. */
5854 event
->modifiers
|= click_modifier
;
5855 event
->modifiers
&= ~up_modifier
;
5857 if (event
->code
>= ASIZE (mouse_syms
))
5858 mouse_syms
= larger_vector (mouse_syms
,
5859 event
->code
- ASIZE (mouse_syms
) + 1,
5862 /* Get the symbol we should use for the mouse click. */
5863 head
= modify_event_symbol (event
->code
,
5868 ASIZE (mouse_syms
));
5869 return Fcons (head
, Fcons (position
, Qnil
));
5872 #endif /* USE_TOOLKIT_SCROLL_BARS */
5874 case DRAG_N_DROP_EVENT
:
5877 Lisp_Object head
, position
;
5880 f
= XFRAME (event
->frame_or_window
);
5883 /* Ignore mouse events that were made on frames that
5884 have been deleted. */
5885 if (! FRAME_LIVE_P (f
))
5888 position
= make_lispy_position (f
, event
->x
, event
->y
,
5891 head
= modify_event_symbol (0, event
->modifiers
,
5893 lispy_drag_n_drop_names
,
5894 &drag_n_drop_syms
, 1);
5900 #endif /* HAVE_MOUSE */
5902 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5903 || defined (HAVE_NS) || defined (USE_GTK)
5904 case MENU_BAR_EVENT
:
5905 if (EQ (event
->arg
, event
->frame_or_window
))
5906 /* This is the prefix key. We translate this to
5907 `(menu_bar)' because the code in keyboard.c for menu
5908 events, which we use, relies on this. */
5909 return Fcons (Qmenu_bar
, Qnil
);
5913 case SELECT_WINDOW_EVENT
:
5914 /* Make an event (select-window (WINDOW)). */
5915 return Fcons (Qselect_window
,
5916 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5919 case TOOL_BAR_EVENT
:
5920 if (EQ (event
->arg
, event
->frame_or_window
))
5921 /* This is the prefix key. We translate this to
5922 `(tool_bar)' because the code in keyboard.c for tool bar
5923 events, which we use, relies on this. */
5924 return Fcons (Qtool_bar
, Qnil
);
5925 else if (SYMBOLP (event
->arg
))
5926 return apply_modifiers (event
->modifiers
, event
->arg
);
5929 case USER_SIGNAL_EVENT
:
5930 /* A user signal. */
5932 char *name
= find_user_signal_name (event
->code
);
5935 return intern (name
);
5938 case SAVE_SESSION_EVENT
:
5939 return Qsave_session
;
5944 return Fcons (Qdbus_event
, event
->arg
);
5946 #endif /* HAVE_DBUS */
5948 case CONFIG_CHANGED_EVENT
:
5949 return Fcons (Qconfig_changed_event
,
5951 Fcons (event
->frame_or_window
, Qnil
)));
5953 case GPM_CLICK_EVENT
:
5955 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5956 Lisp_Object head
, position
;
5957 Lisp_Object
*start_pos_ptr
;
5958 Lisp_Object start_pos
;
5959 int button
= event
->code
;
5961 if (button
>= ASIZE (button_down_location
))
5963 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5964 button_down_location
= larger_vector (button_down_location
,
5966 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5969 start_pos_ptr
= &AREF (button_down_location
, button
);
5970 start_pos
= *start_pos_ptr
;
5972 position
= make_lispy_position (f
, event
->x
, event
->y
,
5975 if (event
->modifiers
& down_modifier
)
5976 *start_pos_ptr
= Fcopy_alist (position
);
5977 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5979 if (!CONSP (start_pos
))
5981 event
->modifiers
&= ~up_modifier
;
5984 head
= modify_event_symbol (button
,
5986 Qmouse_click
, Vlispy_mouse_stem
,
5989 ASIZE (mouse_syms
));
5991 if (event
->modifiers
& drag_modifier
)
5996 else if (event
->modifiers
& double_modifier
)
5999 Fcons (make_number (2),
6001 else if (event
->modifiers
& triple_modifier
)
6004 Fcons (make_number (3),
6011 #endif /* HAVE_GPM */
6013 /* The 'kind' field of the event is something we don't recognize. */
6019 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6022 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6023 Lisp_Object x
, Lisp_Object y
, Time t
)
6025 /* Is it a scroll bar movement? */
6026 if (frame
&& ! NILP (bar_window
))
6028 Lisp_Object part_sym
;
6030 part_sym
= *scroll_bar_parts
[(int) part
];
6031 return Fcons (Qscroll_bar_movement
,
6032 Fcons (list5 (bar_window
,
6033 Qvertical_scroll_bar
,
6039 /* Or is it an ordinary mouse movement? */
6042 Lisp_Object position
;
6043 position
= make_lispy_position (frame
, x
, y
, t
);
6044 return list2 (Qmouse_movement
, position
);
6048 #endif /* HAVE_MOUSE || HAVE GPM */
6050 /* Construct a switch frame event. */
6052 make_lispy_switch_frame (Lisp_Object frame
)
6054 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6057 /* Manipulating modifiers. */
6059 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6061 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6062 SYMBOL's name of the end of the modifiers; the string from this
6063 position is the unmodified symbol name.
6065 This doesn't use any caches. */
6068 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6074 CHECK_SYMBOL (symbol
);
6077 name
= SYMBOL_NAME (symbol
);
6079 for (i
= 0; i
< SBYTES (name
) - 1; )
6081 ptrdiff_t this_mod_end
= 0;
6084 /* See if the name continues with a modifier word.
6085 Check that the word appears, but don't check what follows it.
6086 Set this_mod and this_mod_end to record what we find. */
6088 switch (SREF (name
, i
))
6090 #define SINGLE_LETTER_MOD(BIT) \
6091 (this_mod_end = i + 1, this_mod = BIT)
6094 SINGLE_LETTER_MOD (alt_modifier
);
6098 SINGLE_LETTER_MOD (ctrl_modifier
);
6102 SINGLE_LETTER_MOD (hyper_modifier
);
6106 SINGLE_LETTER_MOD (meta_modifier
);
6110 SINGLE_LETTER_MOD (shift_modifier
);
6114 SINGLE_LETTER_MOD (super_modifier
);
6117 #undef SINGLE_LETTER_MOD
6119 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6120 if (i + LEN + 1 <= SBYTES (name) \
6121 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6123 this_mod_end = i + LEN; \
6128 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6129 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6130 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6134 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6136 #undef MULTI_LETTER_MOD
6140 /* If we found no modifier, stop looking for them. */
6141 if (this_mod_end
== 0)
6144 /* Check there is a dash after the modifier, so that it
6145 really is a modifier. */
6146 if (this_mod_end
>= SBYTES (name
)
6147 || SREF (name
, this_mod_end
) != '-')
6150 /* This modifier is real; look for another. */
6151 modifiers
|= this_mod
;
6152 i
= this_mod_end
+ 1;
6155 /* Should we include the `click' modifier? */
6156 if (! (modifiers
& (down_modifier
| drag_modifier
6157 | double_modifier
| triple_modifier
))
6158 && i
+ 7 == SBYTES (name
)
6159 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6160 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6161 modifiers
|= click_modifier
;
6163 if (! (modifiers
& (double_modifier
| triple_modifier
))
6164 && i
+ 6 < SBYTES (name
)
6165 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6166 modifiers
|= click_modifier
;
6174 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6175 prepended to the string BASE[0..BASE_LEN-1].
6176 This doesn't use any caches. */
6178 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6180 /* Since BASE could contain nulls, we can't use intern here; we have
6181 to use Fintern, which expects a genuine Lisp_String, and keeps a
6183 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6189 /* Only the event queue may use the `up' modifier; it should always
6190 be turned into a click or drag event before presented to lisp code. */
6191 if (modifiers
& up_modifier
)
6194 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6195 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6196 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6197 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6198 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6199 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6200 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6201 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6202 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6203 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6204 /* The click modifier is denoted by the absence of other modifiers. */
6208 mod_len
= p
- new_mods
;
6212 Lisp_Object new_name
;
6214 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6215 mod_len
+ base_len_byte
);
6216 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6217 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6219 return Fintern (new_name
, Qnil
);
6224 static const char *const modifier_names
[] =
6226 "up", "down", "drag", "click", "double", "triple", 0, 0,
6227 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6228 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6230 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6232 static Lisp_Object modifier_symbols
;
6234 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6236 lispy_modifier_list (int modifiers
)
6238 Lisp_Object modifier_list
;
6241 modifier_list
= Qnil
;
6242 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6243 if (modifiers
& (1<<i
))
6244 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6247 return modifier_list
;
6251 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6252 where UNMODIFIED is the unmodified form of SYMBOL,
6253 MASK is the set of modifiers present in SYMBOL's name.
6254 This is similar to parse_modifiers_uncached, but uses the cache in
6255 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6256 Qevent_symbol_elements property. */
6258 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6261 parse_modifiers (Lisp_Object symbol
)
6263 Lisp_Object elements
;
6265 if (INTEGERP (symbol
))
6266 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6267 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6269 else if (!SYMBOLP (symbol
))
6272 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6273 if (CONSP (elements
))
6278 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6279 Lisp_Object unmodified
;
6282 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6283 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6286 if (modifiers
& ~INTMASK
)
6288 XSETFASTINT (mask
, modifiers
);
6289 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6291 /* Cache the parsing results on SYMBOL. */
6292 Fput (symbol
, Qevent_symbol_element_mask
,
6294 Fput (symbol
, Qevent_symbol_elements
,
6295 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6297 /* Since we know that SYMBOL is modifiers applied to unmodified,
6298 it would be nice to put that in unmodified's cache.
6299 But we can't, since we're not sure that parse_modifiers is
6306 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6307 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6308 doc
: /* Parse the event symbol. For internal use. */)
6309 (Lisp_Object symbol
)
6311 /* Fill the cache if needed. */
6312 parse_modifiers (symbol
);
6313 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6314 and use the Lispier representation stored on Qevent_symbol_elements
6316 return Fget (symbol
, Qevent_symbol_elements
);
6319 /* Apply the modifiers MODIFIERS to the symbol BASE.
6320 BASE must be unmodified.
6322 This is like apply_modifiers_uncached, but uses BASE's
6323 Qmodifier_cache property, if present. It also builds
6324 Qevent_symbol_elements properties, since it has that info anyway.
6326 apply_modifiers copies the value of BASE's Qevent_kind property to
6327 the modified symbol. */
6329 apply_modifiers (int modifiers
, Lisp_Object base
)
6331 Lisp_Object cache
, idx
, entry
, new_symbol
;
6333 /* Mask out upper bits. We don't know where this value's been. */
6334 modifiers
&= INTMASK
;
6336 if (INTEGERP (base
))
6337 return make_number (XINT (base
) | modifiers
);
6339 /* The click modifier never figures into cache indices. */
6340 cache
= Fget (base
, Qmodifier_cache
);
6341 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6342 entry
= assq_no_quit (idx
, cache
);
6345 new_symbol
= XCDR (entry
);
6348 /* We have to create the symbol ourselves. */
6349 new_symbol
= apply_modifiers_uncached (modifiers
,
6350 SSDATA (SYMBOL_NAME (base
)),
6351 SCHARS (SYMBOL_NAME (base
)),
6352 SBYTES (SYMBOL_NAME (base
)));
6354 /* Add the new symbol to the base's cache. */
6355 entry
= Fcons (idx
, new_symbol
);
6356 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6358 /* We have the parsing info now for free, so we could add it to
6360 XSETFASTINT (idx, modifiers);
6361 Fput (new_symbol, Qevent_symbol_element_mask,
6362 Fcons (base, Fcons (idx, Qnil)));
6363 Fput (new_symbol, Qevent_symbol_elements,
6364 Fcons (base, lispy_modifier_list (modifiers)));
6365 Sadly, this is only correct if `base' is indeed a base event,
6366 which is not necessarily the case. -stef */
6369 /* Make sure this symbol is of the same kind as BASE.
6371 You'd think we could just set this once and for all when we
6372 intern the symbol above, but reorder_modifiers may call us when
6373 BASE's property isn't set right; we can't assume that just
6374 because it has a Qmodifier_cache property it must have its
6375 Qevent_kind set right as well. */
6376 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6380 kind
= Fget (base
, Qevent_kind
);
6382 Fput (new_symbol
, Qevent_kind
, kind
);
6389 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6390 return a symbol with the modifiers placed in the canonical order.
6391 Canonical order is alphabetical, except for down and drag, which
6392 always come last. The 'click' modifier is never written out.
6394 Fdefine_key calls this to make sure that (for example) C-M-foo
6395 and M-C-foo end up being equivalent in the keymap. */
6398 reorder_modifiers (Lisp_Object symbol
)
6400 /* It's hopefully okay to write the code this way, since everything
6401 will soon be in caches, and no consing will be done at all. */
6404 parsed
= parse_modifiers (symbol
);
6405 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6410 /* For handling events, we often want to produce a symbol whose name
6411 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6412 to some base, like the name of a function key or mouse button.
6413 modify_event_symbol produces symbols of this sort.
6415 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6416 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6419 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6420 into symbol names, or a string specifying a name stem used to
6421 construct a symbol name or the form `STEM-N', where N is the decimal
6422 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6423 non-nil; otherwise NAME_TABLE is used.
6425 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6426 persist between calls to modify_event_symbol that it can use to
6427 store a cache of the symbols it's generated for this NAME_TABLE
6428 before. The object stored there may be a vector or an alist.
6430 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6432 MODIFIERS is a set of modifier bits (as given in struct input_events)
6433 whose prefixes should be applied to the symbol name.
6435 SYMBOL_KIND is the value to be placed in the event_kind property of
6436 the returned symbol.
6438 The symbols we create are supposed to have an
6439 `event-symbol-elements' property, which lists the modifiers present
6440 in the symbol's name. */
6443 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6444 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6445 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6448 Lisp_Object symbol_int
;
6450 /* Get rid of the "vendor-specific" bit here. */
6451 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6453 /* Is this a request for a valid symbol? */
6454 if (symbol_num
< 0 || symbol_num
>= table_size
)
6457 if (CONSP (*symbol_table
))
6458 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6460 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6461 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6462 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6463 we've never used that symbol before. */
6466 if (! VECTORP (*symbol_table
)
6467 || ASIZE (*symbol_table
) != table_size
)
6471 XSETFASTINT (size
, table_size
);
6472 *symbol_table
= Fmake_vector (size
, Qnil
);
6475 value
= AREF (*symbol_table
, symbol_num
);
6478 /* Have we already used this symbol before? */
6481 /* No; let's create it. */
6482 if (CONSP (name_alist_or_stem
))
6483 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6484 else if (STRINGP (name_alist_or_stem
))
6487 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6488 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6490 SAFE_ALLOCA (buf
, char *, len
);
6491 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6492 XINT (symbol_int
) + 1);
6493 value
= intern (buf
);
6496 else if (name_table
!= 0 && name_table
[symbol_num
])
6497 value
= intern (name_table
[symbol_num
]);
6499 #ifdef HAVE_WINDOW_SYSTEM
6502 char *name
= x_get_keysym_name (symbol_num
);
6504 value
= intern (name
);
6510 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6511 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6512 value
= intern (buf
);
6515 if (CONSP (*symbol_table
))
6516 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6518 ASET (*symbol_table
, symbol_num
, value
);
6520 /* Fill in the cache entries for this symbol; this also
6521 builds the Qevent_symbol_elements property, which the user
6523 apply_modifiers (modifiers
& click_modifier
, value
);
6524 Fput (value
, Qevent_kind
, symbol_kind
);
6527 /* Apply modifiers to that symbol. */
6528 return apply_modifiers (modifiers
, value
);
6531 /* Convert a list that represents an event type,
6532 such as (ctrl meta backspace), into the usual representation of that
6533 event type as a number or a symbol. */
6535 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6536 doc
: /* Convert the event description list EVENT-DESC to an event type.
6537 EVENT-DESC should contain one base event type (a character or symbol)
6538 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6539 drag, down, double or triple). The base must be last.
6540 The return value is an event type (a character or symbol) which
6541 has the same base event type and all the specified modifiers. */)
6542 (Lisp_Object event_desc
)
6550 while (CONSP (rest
))
6558 /* Given a symbol, see if it is a modifier name. */
6559 if (SYMBOLP (elt
) && CONSP (rest
))
6560 this = parse_solitary_modifier (elt
);
6564 else if (!NILP (base
))
6565 error ("Two bases given in one event");
6571 /* Let the symbol A refer to the character A. */
6572 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6573 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6575 if (INTEGERP (base
))
6577 /* Turn (shift a) into A. */
6578 if ((modifiers
& shift_modifier
) != 0
6579 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6581 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6582 modifiers
&= ~shift_modifier
;
6585 /* Turn (control a) into C-a. */
6586 if (modifiers
& ctrl_modifier
)
6587 return make_number ((modifiers
& ~ctrl_modifier
)
6588 | make_ctrl_char (XINT (base
)));
6590 return make_number (modifiers
| XINT (base
));
6592 else if (SYMBOLP (base
))
6593 return apply_modifiers (modifiers
, base
);
6596 error ("Invalid base event");
6601 /* Try to recognize SYMBOL as a modifier name.
6602 Return the modifier flag bit, or 0 if not recognized. */
6605 parse_solitary_modifier (Lisp_Object symbol
)
6607 Lisp_Object name
= SYMBOL_NAME (symbol
);
6609 switch (SREF (name
, 0))
6611 #define SINGLE_LETTER_MOD(BIT) \
6612 if (SBYTES (name) == 1) \
6615 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6616 if (LEN == SBYTES (name) \
6617 && ! memcmp (SDATA (name), NAME, LEN)) \
6621 SINGLE_LETTER_MOD (alt_modifier
);
6625 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6629 SINGLE_LETTER_MOD (ctrl_modifier
);
6633 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6634 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6638 SINGLE_LETTER_MOD (hyper_modifier
);
6642 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6646 SINGLE_LETTER_MOD (meta_modifier
);
6650 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6654 SINGLE_LETTER_MOD (shift_modifier
);
6658 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6659 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6660 SINGLE_LETTER_MOD (super_modifier
);
6664 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6665 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6666 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6670 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6673 #undef SINGLE_LETTER_MOD
6674 #undef MULTI_LETTER_MOD
6680 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6681 Such a list is not valid as an event,
6682 but it can be a Lucid-style event type list. */
6685 lucid_event_type_list_p (Lisp_Object object
)
6689 if (! CONSP (object
))
6692 if (EQ (XCAR (object
), Qhelp_echo
)
6693 || EQ (XCAR (object
), Qvertical_line
)
6694 || EQ (XCAR (object
), Qmode_line
)
6695 || EQ (XCAR (object
), Qheader_line
))
6698 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6702 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6709 /* Store into *addr a value nonzero if terminal input chars are available.
6710 Serves the purpose of ioctl (0, FIONREAD, addr)
6711 but works even if FIONREAD does not exist.
6712 (In fact, this may actually read some input.)
6714 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6715 timer events that are ripe.
6716 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6717 events (FOCUS_IN_EVENT).
6718 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6719 movements and toolkit scroll bar thumb drags. */
6722 get_input_pending (int *addr
, int flags
)
6724 /* First of all, have we already counted some input? */
6725 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6727 /* If input is being read as it arrives, and we have none, there is none. */
6728 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6731 /* Try to read some input and see how much we get. */
6733 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6736 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6739 gobble_input (int expected
)
6742 if (interrupt_input
)
6745 mask
= sigblock (sigmask (SIGIO
));
6746 read_avail_input (expected
);
6750 #ifdef POLL_FOR_INPUT
6751 /* XXX This condition was (read_socket_hook && !interrupt_input),
6752 but read_socket_hook is not global anymore. Let's pretend that
6754 if (!interrupt_input
&& poll_suppress_count
== 0)
6757 mask
= sigblock (sigmask (SIGALRM
));
6758 read_avail_input (expected
);
6764 read_avail_input (expected
);
6767 /* Put a BUFFER_SWITCH_EVENT in the buffer
6768 so that read_key_sequence will notice the new current buffer. */
6771 record_asynch_buffer_change (void)
6773 struct input_event event
;
6777 event
.kind
= BUFFER_SWITCH_EVENT
;
6778 event
.frame_or_window
= Qnil
;
6781 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6782 The purpose of the event is to make read_key_sequence look up the
6783 keymaps again. If we aren't in read_key_sequence, we don't need one,
6784 and the event could cause trouble by messing up (input-pending-p).
6785 Note: Fwaiting_for_user_input_p always returns nil when async
6786 subprocesses aren't supported. */
6787 tem
= Fwaiting_for_user_input_p ();
6791 /* Make sure no interrupt happens while storing the event. */
6793 if (interrupt_input
)
6796 mask
= sigblock (sigmask (SIGIO
));
6797 kbd_buffer_store_event (&event
);
6804 kbd_buffer_store_event (&event
);
6809 /* Read any terminal input already buffered up by the system
6810 into the kbd_buffer, but do not wait.
6812 EXPECTED should be nonzero if the caller knows there is some input.
6814 Returns the number of keyboard chars read, or -1 meaning
6815 this is a bad time to try to read input. */
6818 read_avail_input (int expected
)
6824 /* Store pending user signal events, if any. */
6825 if (store_user_signal_events ())
6828 /* Loop through the available terminals, and call their input hooks. */
6832 struct terminal
*next
= t
->next_terminal
;
6834 if (t
->read_socket_hook
)
6837 struct input_event hold_quit
;
6839 EVENT_INIT (hold_quit
);
6840 hold_quit
.kind
= NO_EVENT
;
6842 /* No need for FIONREAD or fcntl; just say don't wait. */
6843 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6849 if (nr
== -1) /* Not OK to read input now. */
6853 else if (nr
== -2) /* Non-transient error. */
6855 /* The terminal device terminated; it should be closed. */
6857 /* Kill Emacs if this was our last terminal. */
6858 if (!terminal_list
->next_terminal
)
6859 /* Formerly simply reported no input, but that
6860 sometimes led to a failure of Emacs to terminate.
6861 SIGHUP seems appropriate if we can't reach the
6863 /* ??? Is it really right to send the signal just to
6864 this process rather than to the whole process
6865 group? Perhaps on systems with FIONREAD Emacs is
6866 alone in its group. */
6867 kill (getpid (), SIGHUP
);
6869 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6872 XSETTERMINAL (tmp
, t
);
6873 Fdelete_terminal (tmp
, Qnoelisp
);
6877 if (hold_quit
.kind
!= NO_EVENT
)
6878 kbd_buffer_store_event (&hold_quit
);
6887 frame_make_pointer_visible ();
6893 decode_keyboard_code (struct tty_display_info
*tty
,
6894 struct coding_system
*coding
,
6895 unsigned char *buf
, int nbytes
)
6897 unsigned char *src
= buf
;
6898 const unsigned char *p
;
6903 if (tty
->meta_key
!= 2)
6904 for (i
= 0; i
< nbytes
; i
++)
6906 if (coding
->carryover_bytes
> 0)
6908 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6909 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6910 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6911 nbytes
+= coding
->carryover_bytes
;
6913 coding
->destination
= alloca (nbytes
* 4);
6914 coding
->dst_bytes
= nbytes
* 4;
6915 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6916 if (coding
->produced_char
== 0)
6918 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6920 struct input_event event_buf
;
6922 EVENT_INIT (event_buf
);
6923 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6925 (ASCII_CHAR_P (event_buf
.code
)
6926 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6927 /* See the comment in tty_read_avail_input. */
6928 event_buf
.frame_or_window
= tty
->top_frame
;
6929 event_buf
.arg
= Qnil
;
6930 kbd_buffer_store_event (&event_buf
);
6934 /* This is the tty way of reading available input.
6936 Note that each terminal device has its own `struct terminal' object,
6937 and so this function is called once for each individual termcap
6938 terminal. The first parameter indicates which terminal to read from. */
6941 tty_read_avail_input (struct terminal
*terminal
,
6943 struct input_event
*hold_quit
)
6945 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6946 the kbd_buffer can really hold. That may prevent loss
6947 of characters on some systems when input is stuffed at us. */
6948 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6950 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6953 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6955 if (kbd_on_hold_p () || buffer_free
<= 0)
6957 #endif /* subprocesses */
6959 if (!terminal
->name
) /* Don't read from a dead terminal. */
6962 if (terminal
->type
!= output_termcap
6963 && terminal
->type
!= output_msdos_raw
)
6966 /* XXX I think the following code should be moved to separate hook
6967 functions in system-dependent files. */
6970 #else /* not WINDOWSNT */
6971 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6975 return 0; /* The terminal is suspended. */
6978 n_to_read
= dos_keysns ();
6982 cbuf
[0] = dos_keyread ();
6985 #else /* not MSDOS */
6990 struct input_event gpm_hold_quit
;
6991 int gpm
, fd
= gpm_fd
;
6993 EVENT_INIT (gpm_hold_quit
);
6994 gpm_hold_quit
.kind
= NO_EVENT
;
6996 /* gpm==1 if event received.
6997 gpm==0 if the GPM daemon has closed the connection, in which case
6998 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6999 we save it in `fd' so close_gpm can remove it from the
7001 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7002 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7003 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7006 /* Presumably the GPM daemon has closed the connection. */
7008 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7009 kbd_buffer_store_event (&gpm_hold_quit
);
7013 #endif /* HAVE_GPM */
7015 /* Determine how many characters we should *try* to read. */
7017 /* Find out how much input is available. */
7018 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7020 if (! noninteractive
)
7021 return -2; /* Close this terminal. */
7027 if (n_to_read
> sizeof cbuf
)
7028 n_to_read
= sizeof cbuf
;
7029 #else /* no FIONREAD */
7030 #if defined (USG) || defined (CYGWIN)
7031 /* Read some input if available, but don't wait. */
7032 n_to_read
= sizeof cbuf
;
7033 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7040 /* Don't read more than we can store. */
7041 if (n_to_read
> buffer_free
)
7042 n_to_read
= buffer_free
;
7043 #endif /* subprocesses */
7045 /* Now read; for one reason or another, this will not block.
7046 NREAD is set to the number of chars read. */
7049 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7050 /* POSIX infers that processes which are not in the session leader's
7051 process group won't get SIGHUP's at logout time. BSDI adheres to
7052 this part standard and returns -1 from read (0) with errno==EIO
7053 when the control tty is taken away.
7054 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7055 if (nread
== -1 && errno
== EIO
)
7056 return -2; /* Close this terminal. */
7057 #if defined (AIX) && defined (_BSD)
7058 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7059 This looks incorrect, but it isn't, because _BSD causes
7060 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7061 and that causes a value other than 0 when there is no input. */
7063 return -2; /* Close this terminal. */
7067 /* We used to retry the read if it was interrupted.
7068 But this does the wrong thing when O_NDELAY causes
7069 an EAGAIN error. Does anybody know of a situation
7070 where a retry is actually needed? */
7072 nread
< 0 && (errno
== EAGAIN
7086 #if defined (USG) || defined (CYGWIN)
7087 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7088 #endif /* USG or CYGWIN */
7089 #endif /* no FIONREAD */
7094 #endif /* not MSDOS */
7095 #endif /* not WINDOWSNT */
7097 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7098 & CODING_REQUIRE_DECODING_MASK
)
7100 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7103 /* Decode the key sequence except for those with meta
7105 for (i
= from
= 0; ; i
++)
7106 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7108 struct input_event buf
;
7110 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7115 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7116 buf
.modifiers
= meta_modifier
;
7117 buf
.code
= cbuf
[i
] & ~0x80;
7118 /* See the comment below. */
7119 buf
.frame_or_window
= tty
->top_frame
;
7121 kbd_buffer_store_event (&buf
);
7127 for (i
= 0; i
< nread
; i
++)
7129 struct input_event buf
;
7131 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7133 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7134 buf
.modifiers
= meta_modifier
;
7135 if (tty
->meta_key
!= 2)
7139 /* Set the frame corresponding to the active tty. Note that the
7140 value of selected_frame is not reliable here, redisplay tends
7141 to temporarily change it. */
7142 buf
.frame_or_window
= tty
->top_frame
;
7145 kbd_buffer_store_event (&buf
);
7146 /* Don't look at input that follows a C-g too closely.
7147 This reduces lossage due to autorepeat on C-g. */
7148 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7149 && buf
.code
== quit_char
)
7156 #if defined SYNC_INPUT || defined SIGIO
7158 handle_async_input (void)
7160 interrupt_input_pending
= 0;
7162 pending_signals
= pending_atimers
;
7164 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7165 doing anything dangerous. */
7172 nread
= read_avail_input (1);
7173 /* -1 means it's not ok to read the input now.
7174 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7175 0 means there was no keyboard input available. */
7183 #endif /* SYNC_INPUT || SIGIO */
7187 process_pending_signals (void)
7189 if (interrupt_input_pending
)
7190 handle_async_input ();
7191 do_pending_atimers ();
7195 #ifdef SIGIO /* for entire page */
7196 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7199 input_available_signal (int signo
)
7201 /* Must preserve main program's value of errno. */
7202 int old_errno
= errno
;
7203 SIGNAL_THREAD_CHECK (signo
);
7206 interrupt_input_pending
= 1;
7207 pending_signals
= 1;
7210 if (input_available_clear_time
)
7211 *input_available_clear_time
= make_emacs_time (0, 0);
7214 handle_async_input ();
7221 /* Send ourselves a SIGIO.
7223 This function exists so that the UNBLOCK_INPUT macro in
7224 blockinput.h can have some way to take care of input we put off
7225 dealing with, without assuming that every file which uses
7226 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7228 reinvoke_input_signal (void)
7231 handle_async_input ();
7237 /* User signal events. */
7239 struct user_signal_info
7241 /* Signal number. */
7244 /* Name of the signal. */
7247 /* Number of pending signals. */
7250 struct user_signal_info
*next
;
7253 /* List of user signals. */
7254 static struct user_signal_info
*user_signals
= NULL
;
7257 add_user_signal (int sig
, const char *name
)
7259 struct user_signal_info
*p
;
7261 for (p
= user_signals
; p
; p
= p
->next
)
7263 /* Already added. */
7266 p
= xmalloc (sizeof *p
);
7268 p
->name
= xstrdup (name
);
7270 p
->next
= user_signals
;
7273 signal (sig
, handle_user_signal
);
7277 handle_user_signal (int sig
)
7279 int old_errno
= errno
;
7280 struct user_signal_info
*p
;
7281 const char *special_event_name
= NULL
;
7283 SIGNAL_THREAD_CHECK (sig
);
7285 if (SYMBOLP (Vdebug_on_event
))
7286 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7288 for (p
= user_signals
; p
; p
= p
->next
)
7291 if (special_event_name
7292 && strcmp (special_event_name
, p
->name
) == 0)
7294 /* Enter the debugger in many ways. */
7295 debug_on_next_call
= 1;
7298 Vinhibit_quit
= Qnil
;
7300 /* Eat the event. */
7306 if (interrupt_input
)
7307 kill (getpid (), SIGIO
);
7311 /* Tell wait_reading_process_output that it needs to wake
7312 up and look around. */
7313 if (input_available_clear_time
)
7314 *input_available_clear_time
= make_emacs_time (0, 0);
7323 find_user_signal_name (int sig
)
7325 struct user_signal_info
*p
;
7327 for (p
= user_signals
; p
; p
= p
->next
)
7335 store_user_signal_events (void)
7337 struct user_signal_info
*p
;
7338 struct input_event buf
;
7341 for (p
= user_signals
; p
; p
= p
->next
)
7342 if (p
->npending
> 0)
7348 memset (&buf
, 0, sizeof buf
);
7349 buf
.kind
= USER_SIGNAL_EVENT
;
7350 buf
.frame_or_window
= selected_frame
;
7352 nstored
+= p
->npending
;
7354 mask
= sigblock (sigmask (p
->sig
));
7358 kbd_buffer_store_event (&buf
);
7361 while (p
->npending
> 0);
7369 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7370 static Lisp_Object menu_bar_one_keymap_changed_items
;
7372 /* These variables hold the vector under construction within
7373 menu_bar_items and its subroutines, and the current index
7374 for storing into that vector. */
7375 static Lisp_Object menu_bar_items_vector
;
7376 static int menu_bar_items_index
;
7379 static const char* separator_names
[] = {
7384 "single-dashed-line",
7385 "double-dashed-line",
7387 "shadow-etched-out",
7388 "shadow-etched-in-dash",
7389 "shadow-etched-out-dash",
7390 "shadow-double-etched-in",
7391 "shadow-double-etched-out",
7392 "shadow-double-etched-in-dash",
7393 "shadow-double-etched-out-dash",
7397 /* Return non-zero if LABEL specifies a separator. */
7400 menu_separator_name_p (const char *label
)
7404 else if (strlen (label
) > 3
7405 && memcmp (label
, "--", 2) == 0
7410 for (i
= 0; separator_names
[i
]; ++i
)
7411 if (strcmp (label
, separator_names
[i
]) == 0)
7416 /* It's a separator if it contains only dashes. */
7417 while (*label
== '-')
7419 return (*label
== 0);
7426 /* Return a vector of menu items for a menu bar, appropriate
7427 to the current buffer. Each item has three elements in the vector:
7430 OLD is an old vector we can optionally reuse, or nil. */
7433 menu_bar_items (Lisp_Object old
)
7435 /* The number of keymaps we're scanning right now, and the number of
7436 keymaps we have allocated space for. */
7439 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7440 in the current keymaps, or nil where it is not a prefix. */
7443 Lisp_Object def
, tail
;
7448 /* In order to build the menus, we need to call the keymap
7449 accessors. They all call QUIT. But this function is called
7450 during redisplay, during which a quit is fatal. So inhibit
7451 quitting while building the menus.
7452 We do this instead of specbind because (1) errors will clear it anyway
7453 and (2) this avoids risk of specpdl overflow. */
7454 oquit
= Vinhibit_quit
;
7458 menu_bar_items_vector
= old
;
7460 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7461 menu_bar_items_index
= 0;
7463 /* Build our list of keymaps.
7464 If we recognize a function key and replace its escape sequence in
7465 keybuf with its symbol, or if the sequence starts with a mouse
7466 click and we need to switch buffers, we jump back here to rebuild
7467 the initial keymaps from the current buffer. */
7471 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7472 if (!NILP (Voverriding_local_map_menu_flag
))
7474 /* Yes, use them (if non-nil) as well as the global map. */
7475 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7477 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7478 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7479 if (!NILP (Voverriding_local_map
))
7480 maps
[nmaps
++] = Voverriding_local_map
;
7484 /* No, so use major and minor mode keymaps and keymap property.
7485 Note that menu-bar bindings in the local-map and keymap
7486 properties may not work reliable, as they are only
7487 recognized when the menu-bar (or mode-line) is updated,
7488 which does not normally happen after every command. */
7491 nminor
= current_minor_maps (NULL
, &tmaps
);
7492 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7494 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7495 maps
[nmaps
++] = tem
;
7496 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7498 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7500 maps
[nmaps
++] = current_global_map
;
7503 /* Look up in each map the dummy prefix key `menu-bar'. */
7505 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7506 if (!NILP (maps
[mapno
]))
7508 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7512 menu_bar_one_keymap_changed_items
= Qnil
;
7513 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7517 /* Move to the end those items that should be at the end. */
7519 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7522 int end
= menu_bar_items_index
;
7524 for (i
= 0; i
< end
; i
+= 4)
7525 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7527 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7528 /* Move the item at index I to the end,
7529 shifting all the others forward. */
7530 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7531 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7532 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7533 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7535 memmove (&AREF (menu_bar_items_vector
, i
),
7536 &AREF (menu_bar_items_vector
, i
+ 4),
7537 (end
- i
- 4) * sizeof (Lisp_Object
));
7538 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7539 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7540 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7541 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7546 /* Add nil, nil, nil, nil at the end. */
7548 int i
= menu_bar_items_index
;
7549 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7550 menu_bar_items_vector
=
7551 larger_vector (menu_bar_items_vector
, 4, -1);
7552 /* Add this item. */
7553 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7554 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7555 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7556 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7557 menu_bar_items_index
= i
;
7560 Vinhibit_quit
= oquit
;
7561 return menu_bar_items_vector
;
7564 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7565 If there's already an item for KEY, add this DEF to it. */
7567 Lisp_Object item_properties
;
7570 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7572 struct gcpro gcpro1
;
7576 if (EQ (item
, Qundefined
))
7578 /* If a map has an explicit `undefined' as definition,
7579 discard any previously made menu bar item. */
7581 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7582 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7584 if (menu_bar_items_index
> i
+ 4)
7585 memmove (&AREF (menu_bar_items_vector
, i
),
7586 &AREF (menu_bar_items_vector
, i
+ 4),
7587 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7588 menu_bar_items_index
-= 4;
7592 /* If this keymap has already contributed to this KEY,
7593 don't contribute to it a second time. */
7594 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7595 if (!NILP (tem
) || NILP (item
))
7598 menu_bar_one_keymap_changed_items
7599 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7601 /* We add to menu_bar_one_keymap_changed_items before doing the
7602 parse_menu_item, so that if it turns out it wasn't a menu item,
7603 it still correctly hides any further menu item. */
7605 i
= parse_menu_item (item
, 1);
7610 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7612 /* Find any existing item for this KEY. */
7613 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7614 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7617 /* If we did not find this KEY, add it at the end. */
7618 if (i
== menu_bar_items_index
)
7620 /* If vector is too small, get a bigger one. */
7621 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7622 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7623 /* Add this item. */
7624 ASET (menu_bar_items_vector
, i
, key
); i
++;
7625 ASET (menu_bar_items_vector
, i
,
7626 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7627 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7628 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7629 menu_bar_items_index
= i
;
7631 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7635 old
= AREF (menu_bar_items_vector
, i
+ 2);
7636 /* If the new and the old items are not both keymaps,
7637 the lookup will only find `item'. */
7638 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7639 ASET (menu_bar_items_vector
, i
+ 2, item
);
7643 /* This is used as the handler when calling menu_item_eval_property. */
7645 menu_item_eval_property_1 (Lisp_Object arg
)
7647 /* If we got a quit from within the menu computation,
7648 quit all the way out of it. This takes care of C-] in the debugger. */
7649 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7650 Fsignal (Qquit
, Qnil
);
7656 eval_dyn (Lisp_Object form
)
7658 return Feval (form
, Qnil
);
7661 /* Evaluate an expression and return the result (or nil if something
7662 went wrong). Used to evaluate dynamic parts of menu items. */
7664 menu_item_eval_property (Lisp_Object sexpr
)
7666 ptrdiff_t count
= SPECPDL_INDEX ();
7668 specbind (Qinhibit_redisplay
, Qt
);
7669 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7670 menu_item_eval_property_1
);
7671 return unbind_to (count
, val
);
7674 /* This function parses a menu item and leaves the result in the
7675 vector item_properties.
7676 ITEM is a key binding, a possible menu item.
7677 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7679 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7680 parse_menu_item returns true if the item is a menu item and false
7684 parse_menu_item (Lisp_Object item
, int inmenubar
)
7686 Lisp_Object def
, tem
, item_string
, start
;
7688 Lisp_Object keyhint
;
7697 /* Create item_properties vector if necessary. */
7698 if (NILP (item_properties
))
7700 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7702 /* Initialize optional entries. */
7703 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7704 ASET (item_properties
, i
, Qnil
);
7705 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7707 /* Save the item here to protect it from GC. */
7708 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7710 item_string
= XCAR (item
);
7714 if (STRINGP (item_string
))
7716 /* Old format menu item. */
7717 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7719 /* Maybe help string. */
7720 if (CONSP (item
) && STRINGP (XCAR (item
)))
7722 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7727 /* Maybe an obsolete key binding cache. */
7728 if (CONSP (item
) && CONSP (XCAR (item
))
7729 && (NILP (XCAR (XCAR (item
)))
7730 || VECTORP (XCAR (XCAR (item
)))))
7733 /* This is the real definition--the function to run. */
7734 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7736 /* Get enable property, if any. */
7739 tem
= Fget (item
, Qmenu_enable
);
7740 if (!NILP (Venable_disabled_menus_and_buttons
))
7741 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7742 else if (!NILP (tem
))
7743 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7746 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7748 /* New format menu item. */
7749 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7750 start
= XCDR (item
);
7753 /* We have a real binding. */
7754 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7756 item
= XCDR (start
);
7757 /* Is there an obsolete cache list with key equivalences. */
7758 if (CONSP (item
) && CONSP (XCAR (item
)))
7761 /* Parse properties. */
7762 while (CONSP (item
) && CONSP (XCDR (item
)))
7767 if (EQ (tem
, QCenable
))
7769 if (!NILP (Venable_disabled_menus_and_buttons
))
7770 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7772 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7774 else if (EQ (tem
, QCvisible
))
7776 /* If got a visible property and that evaluates to nil
7777 then ignore this item. */
7778 tem
= menu_item_eval_property (XCAR (item
));
7782 else if (EQ (tem
, QChelp
))
7783 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7784 else if (EQ (tem
, QCfilter
))
7786 else if (EQ (tem
, QCkey_sequence
))
7789 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7790 /* Be GC protected. Set keyhint to item instead of tem. */
7793 else if (EQ (tem
, QCkeys
))
7796 if (CONSP (tem
) || STRINGP (tem
))
7797 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7799 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7804 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7806 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7808 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7814 else if (inmenubar
|| !NILP (start
))
7818 return 0; /* not a menu item */
7820 /* If item string is not a string, evaluate it to get string.
7821 If we don't get a string, skip this item. */
7822 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7823 if (!(STRINGP (item_string
)))
7825 item_string
= menu_item_eval_property (item_string
);
7826 if (!STRINGP (item_string
))
7828 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7831 /* If got a filter apply it on definition. */
7832 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7835 def
= menu_item_eval_property (list2 (XCAR (filter
),
7836 list2 (Qquote
, def
)));
7838 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7841 /* Enable or disable selection of item. */
7842 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7845 tem
= menu_item_eval_property (tem
);
7846 if (inmenubar
&& NILP (tem
))
7847 return 0; /* Ignore disabled items in menu bar. */
7848 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7851 /* If we got no definition, this item is just unselectable text which
7852 is OK in a submenu but not in the menubar. */
7854 return (!inmenubar
);
7856 /* See if this is a separate pane or a submenu. */
7857 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7858 tem
= get_keymap (def
, 0, 1);
7859 /* For a subkeymap, just record its details and exit. */
7862 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7863 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7867 /* At the top level in the menu bar, do likewise for commands also.
7868 The menu bar does not display equivalent key bindings anyway.
7869 ITEM_PROPERTY_DEF is already set up properly. */
7873 { /* This is a command. See if there is an equivalent key binding. */
7874 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7876 /* The previous code preferred :key-sequence to :keys, so we
7877 preserve this behavior. */
7878 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7879 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7882 Lisp_Object prefix
= keyeq
;
7883 Lisp_Object keys
= Qnil
;
7887 def
= XCAR (prefix
);
7888 prefix
= XCDR (prefix
);
7891 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7893 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7895 keys
= XCAR (keyhint
);
7896 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7898 /* We have a suggested key. Is it bound to the command? */
7901 /* If the command is an alias for another
7902 (such as lmenu.el set it up), check if the
7903 original command matches the cached command. */
7904 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7909 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7913 tem
= Fkey_description (keys
, Qnil
);
7916 if (STRINGP (XCAR (prefix
)))
7917 tem
= concat2 (XCAR (prefix
), tem
);
7918 if (STRINGP (XCDR (prefix
)))
7919 tem
= concat2 (tem
, XCDR (prefix
));
7921 keyeq
= concat2 (build_string (" "), tem
);
7922 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7928 /* If we have an equivalent key binding, use that. */
7929 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7932 /* Include this when menu help is implemented.
7933 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7934 if (!(NILP (tem) || STRINGP (tem)))
7936 tem = menu_item_eval_property (tem);
7939 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7943 /* Handle radio buttons or toggle boxes. */
7944 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7946 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7947 menu_item_eval_property (tem
));
7954 /***********************************************************************
7956 ***********************************************************************/
7958 /* A vector holding tool bar items while they are parsed in function
7959 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7962 static Lisp_Object tool_bar_items_vector
;
7964 /* A vector holding the result of parse_tool_bar_item. Layout is like
7965 the one for a single item in tool_bar_items_vector. */
7967 static Lisp_Object tool_bar_item_properties
;
7969 /* Next free index in tool_bar_items_vector. */
7971 static int ntool_bar_items
;
7973 /* The symbols `:image' and `:rtl'. */
7975 static Lisp_Object QCimage
;
7976 static Lisp_Object QCrtl
;
7978 /* Function prototypes. */
7980 static void init_tool_bar_items (Lisp_Object
);
7981 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7982 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7983 static void append_tool_bar_item (void);
7986 /* Return a vector of tool bar items for keymaps currently in effect.
7987 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7988 tool bar items found. */
7991 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8000 /* In order to build the menus, we need to call the keymap
8001 accessors. They all call QUIT. But this function is called
8002 during redisplay, during which a quit is fatal. So inhibit
8003 quitting while building the menus. We do this instead of
8004 specbind because (1) errors will clear it anyway and (2) this
8005 avoids risk of specpdl overflow. */
8006 oquit
= Vinhibit_quit
;
8009 /* Initialize tool_bar_items_vector and protect it from GC. */
8010 init_tool_bar_items (reuse
);
8012 /* Build list of keymaps in maps. Set nmaps to the number of maps
8015 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8016 if (!NILP (Voverriding_local_map_menu_flag
))
8018 /* Yes, use them (if non-nil) as well as the global map. */
8019 maps
= alloca (3 * sizeof *maps
);
8021 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8022 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8023 if (!NILP (Voverriding_local_map
))
8024 maps
[nmaps
++] = Voverriding_local_map
;
8028 /* No, so use major and minor mode keymaps and keymap property.
8029 Note that tool-bar bindings in the local-map and keymap
8030 properties may not work reliable, as they are only
8031 recognized when the tool-bar (or mode-line) is updated,
8032 which does not normally happen after every command. */
8035 nminor
= current_minor_maps (NULL
, &tmaps
);
8036 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
8038 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8039 maps
[nmaps
++] = tem
;
8040 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8042 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8045 /* Add global keymap at the end. */
8046 maps
[nmaps
++] = current_global_map
;
8048 /* Process maps in reverse order and look up in each map the prefix
8050 for (i
= nmaps
- 1; i
>= 0; --i
)
8051 if (!NILP (maps
[i
]))
8055 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8057 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8060 Vinhibit_quit
= oquit
;
8061 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8062 return tool_bar_items_vector
;
8066 /* Process the definition of KEY which is DEF. */
8069 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8072 struct gcpro gcpro1
, gcpro2
;
8074 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8078 if (EQ (def
, Qundefined
))
8080 /* If a map has an explicit `undefined' as definition,
8081 discard any previously made item. */
8082 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8084 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8086 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8088 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8089 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8090 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8091 * sizeof (Lisp_Object
)));
8092 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8097 else if (parse_tool_bar_item (key
, def
))
8098 /* Append a new tool bar item to tool_bar_items_vector. Accept
8099 more than one definition for the same key. */
8100 append_tool_bar_item ();
8106 /* Parse a tool bar item specification ITEM for key KEY and return the
8107 result in tool_bar_item_properties. Value is zero if ITEM is
8110 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8112 CAPTION is the caption of the item, If it's not a string, it is
8113 evaluated to get a string.
8115 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8116 as binding are currently ignored.
8118 The following properties are recognized:
8122 FORM is evaluated and specifies whether the tool bar item is
8123 enabled or disabled.
8127 FORM is evaluated and specifies whether the tool bar item is visible.
8129 - `:filter FUNCTION'
8131 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8132 result is stored as the new binding.
8134 - `:button (TYPE SELECTED)'
8136 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8137 and specifies whether the button is selected (pressed) or not.
8141 IMAGES is either a single image specification or a vector of four
8142 image specifications. See enum tool_bar_item_images.
8144 - `:help HELP-STRING'.
8146 Gives a help string to display for the tool bar item.
8148 - `:label LABEL-STRING'.
8150 A text label to show with the tool bar button if labels are enabled. */
8153 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8155 /* Access slot with index IDX of vector tool_bar_item_properties. */
8156 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8158 Lisp_Object filter
= Qnil
;
8159 Lisp_Object caption
;
8160 int i
, have_label
= 0;
8162 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8163 Rule out items that aren't lists, don't start with
8164 `menu-item' or whose rest following `tool-bar-item' is not a
8169 /* As an exception, allow old-style menu separators. */
8170 if (STRINGP (XCAR (item
)))
8171 item
= Fcons (XCAR (item
), Qnil
);
8172 else if (!EQ (XCAR (item
), Qmenu_item
)
8173 || (item
= XCDR (item
), !CONSP (item
)))
8176 /* Create tool_bar_item_properties vector if necessary. Reset it to
8178 if (VECTORP (tool_bar_item_properties
))
8180 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8184 tool_bar_item_properties
8185 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8188 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8189 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8191 /* Get the caption of the item. If the caption is not a string,
8192 evaluate it to get a string. If we don't get a string, skip this
8194 caption
= XCAR (item
);
8195 if (!STRINGP (caption
))
8197 caption
= menu_item_eval_property (caption
);
8198 if (!STRINGP (caption
))
8201 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8203 /* If the rest following the caption is not a list, the menu item is
8204 either a separator, or invalid. */
8208 if (menu_separator_name_p (SSDATA (caption
)))
8210 PROP (TOOL_BAR_ITEM_TYPE
) = Qt
;
8211 #if !defined (USE_GTK) && !defined (HAVE_NS)
8212 /* If we use build_desired_tool_bar_string to render the
8213 tool bar, the separator is rendered as an image. */
8214 PROP (TOOL_BAR_ITEM_IMAGES
)
8215 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8216 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8217 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8218 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8225 /* Store the binding. */
8226 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8229 /* Ignore cached key binding, if any. */
8230 if (CONSP (item
) && CONSP (XCAR (item
)))
8233 /* Process the rest of the properties. */
8234 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8236 Lisp_Object ikey
, value
;
8239 value
= XCAR (XCDR (item
));
8241 if (EQ (ikey
, QCenable
))
8243 /* `:enable FORM'. */
8244 if (!NILP (Venable_disabled_menus_and_buttons
))
8245 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8247 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8249 else if (EQ (ikey
, QCvisible
))
8251 /* `:visible FORM'. If got a visible property and that
8252 evaluates to nil then ignore this item. */
8253 if (NILP (menu_item_eval_property (value
)))
8256 else if (EQ (ikey
, QChelp
))
8257 /* `:help HELP-STRING'. */
8258 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8259 else if (EQ (ikey
, QCvert_only
))
8260 /* `:vert-only t/nil'. */
8261 PROP (TOOL_BAR_ITEM_VERT_ONLY
) = value
;
8262 else if (EQ (ikey
, QClabel
))
8264 const char *bad_label
= "!!?GARBLED ITEM?!!";
8265 /* `:label LABEL-STRING'. */
8266 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8268 : build_string (bad_label
);
8271 else if (EQ (ikey
, QCfilter
))
8272 /* ':filter FORM'. */
8274 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8276 /* `:button (TYPE . SELECTED)'. */
8277 Lisp_Object type
, selected
;
8279 type
= XCAR (value
);
8280 selected
= XCDR (value
);
8281 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8283 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8284 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8287 else if (EQ (ikey
, QCimage
)
8289 || (VECTORP (value
) && ASIZE (value
) == 4)))
8290 /* Value is either a single image specification or a vector
8291 of 4 such specifications for the different button states. */
8292 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8293 else if (EQ (ikey
, QCrtl
))
8295 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8301 /* Try to make one from caption and key. */
8302 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8303 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8304 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8305 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8307 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8308 char *buf
= xmalloc (max_lbl
+ 1);
8309 Lisp_Object new_lbl
;
8310 ptrdiff_t caption_len
= strlen (capt
);
8312 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8315 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8317 buf
[caption_len
] = '\0';
8321 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8325 strcpy (buf
, label
);
8327 for (j
= 0; buf
[j
] != '\0'; ++j
)
8335 new_lbl
= Fupcase_initials (build_string (label
));
8336 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8337 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8339 PROP (TOOL_BAR_ITEM_LABEL
) = empty_unibyte_string
;
8343 /* If got a filter apply it on binding. */
8345 PROP (TOOL_BAR_ITEM_BINDING
)
8346 = menu_item_eval_property (list2 (filter
,
8348 PROP (TOOL_BAR_ITEM_BINDING
))));
8350 /* See if the binding is a keymap. Give up if it is. */
8351 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8354 /* Enable or disable selection of item. */
8355 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8356 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8357 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8359 /* Handle radio buttons or toggle boxes. */
8360 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8361 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8362 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8370 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8371 that can be reused. */
8374 init_tool_bar_items (Lisp_Object reuse
)
8376 if (VECTORP (reuse
))
8377 tool_bar_items_vector
= reuse
;
8379 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8380 ntool_bar_items
= 0;
8384 /* Append parsed tool bar item properties from
8385 tool_bar_item_properties */
8388 append_tool_bar_item (void)
8390 Lisp_Object
*to
, *from
;
8393 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8395 /* Enlarge tool_bar_items_vector if necessary. */
8397 tool_bar_items_vector
8398 = larger_vector (tool_bar_items_vector
, incr
, -1);
8400 /* Append entries from tool_bar_item_properties to the end of
8401 tool_bar_items_vector. */
8402 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8403 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8404 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8405 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8412 /* Read a character using menus based on maps in the array MAPS.
8413 NMAPS is the length of MAPS. 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, then we set *USED_MOUSE_MENU to 1
8420 if we used a mouse menu to read the input, or zero otherwise. If
8421 USED_MOUSE_MENU is null, we 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 (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8434 Lisp_Object prev_event
, int *used_mouse_menu
)
8438 if (used_mouse_menu
)
8439 *used_mouse_menu
= 0;
8441 /* Use local over global Menu maps */
8443 if (! menu_prompting
)
8446 /* Optionally disregard all but the global map. */
8447 if (inhibit_local_menu_bar_menus
)
8449 maps
+= (nmaps
- 1);
8454 /* If we got to this point via a mouse click,
8455 use a real menu for mouse selection. */
8456 if (EVENT_HAS_PARAMETERS (prev_event
)
8457 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8458 && !EQ (XCAR (prev_event
), Qtool_bar
))
8460 /* Display the menu and get the selection. */
8461 Lisp_Object
*realmaps
= alloca (nmaps
* sizeof *realmaps
);
8463 ptrdiff_t nmaps1
= 0;
8465 /* Use the maps that are not nil. */
8466 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8467 if (!NILP (maps
[mapno
]))
8468 realmaps
[nmaps1
++] = maps
[mapno
];
8470 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8475 record_menu_key (XCAR (value
));
8477 /* If we got multiple events, unread all but
8479 There is no way to prevent those unread events
8480 from showing up later in last_nonmenu_event.
8481 So turn symbol and integer events into lists,
8482 to indicate that they came from a mouse menu,
8483 so that when present in last_nonmenu_event
8484 they won't confuse things. */
8485 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8487 record_menu_key (XCAR (tem
));
8488 if (SYMBOLP (XCAR (tem
))
8489 || INTEGERP (XCAR (tem
)))
8490 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8493 /* If we got more than one event, put all but the first
8494 onto this list to be read later.
8495 Return just the first event now. */
8496 Vunread_command_events
8497 = nconc2 (XCDR (value
), Vunread_command_events
);
8498 value
= XCAR (value
);
8500 else if (NILP (value
))
8502 if (used_mouse_menu
)
8503 *used_mouse_menu
= 1;
8506 #endif /* HAVE_MENUS */
8510 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8511 We make this bigger when necessary, and never free it. */
8512 static char *read_char_minibuf_menu_text
;
8513 /* Size of that buffer. */
8514 static ptrdiff_t read_char_minibuf_menu_width
;
8517 read_char_minibuf_menu_prompt (int commandflag
,
8518 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8521 register Lisp_Object name
;
8523 /* FIXME: Use the minibuffer's frame width. */
8524 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8527 Lisp_Object rest
, vector
;
8533 if (! menu_prompting
)
8536 /* Get the menu name from the first map that has one (a prompt string). */
8537 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8539 name
= Fkeymap_prompt (maps
[mapno
]);
8544 /* If we don't have any menus, just read a character normally. */
8545 if (!STRINGP (name
))
8548 /* Make sure we have a big enough buffer for the menu text. */
8549 width
= max (width
, SBYTES (name
));
8550 if (STRING_BYTES_BOUND
- 4 < width
)
8551 memory_full (SIZE_MAX
);
8552 if (width
+ 4 > read_char_minibuf_menu_width
)
8554 read_char_minibuf_menu_text
8555 = xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8556 read_char_minibuf_menu_width
= width
+ 4;
8558 menu
= read_char_minibuf_menu_text
;
8560 /* Prompt string always starts with map's prompt, and a space. */
8561 strcpy (menu
, SSDATA (name
));
8562 nlength
= SBYTES (name
);
8563 menu
[nlength
++] = ':';
8564 menu
[nlength
++] = ' ';
8567 /* Start prompting at start of first map. */
8571 /* Present the documented bindings, a line at a time. */
8575 ptrdiff_t i
= nlength
;
8577 Lisp_Object orig_defn_macro
;
8579 /* Loop over elements of map. */
8584 /* If reached end of map, start at beginning of next map. */
8588 /* At end of last map, wrap around to first map if just starting,
8589 or end this line if already have something on it. */
8593 if (notfirst
|| nobindings
) break;
8598 /* Look at the next element of the map. */
8600 elt
= AREF (vector
, idx
);
8602 elt
= Fcar_safe (rest
);
8604 if (idx
< 0 && VECTORP (elt
))
8606 /* If we found a dense table in the keymap,
8607 advanced past it, but start scanning its contents. */
8608 rest
= Fcdr_safe (rest
);
8614 /* An ordinary element. */
8615 Lisp_Object event
, tem
;
8619 event
= Fcar_safe (elt
); /* alist */
8620 elt
= Fcdr_safe (elt
);
8624 XSETINT (event
, idx
); /* vector */
8627 /* Ignore the element if it has no prompt string. */
8628 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8630 /* 1 if the char to type matches the string. */
8632 Lisp_Object upcased_event
, downcased_event
;
8633 Lisp_Object desc
= Qnil
;
8635 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8637 upcased_event
= Fupcase (event
);
8638 downcased_event
= Fdowncase (event
);
8639 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8640 || XINT (downcased_event
) == SREF (s
, 0));
8642 desc
= Fsingle_key_description (event
, Qnil
);
8644 #if 0 /* It is redundant to list the equivalent key bindings because
8645 the prefix is what the user has already typed. */
8647 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8649 /* Insert equivalent keybinding. */
8650 s
= concat2 (s
, tem
);
8653 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8654 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8656 /* Insert button prefix. */
8657 Lisp_Object selected
8658 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8659 if (EQ (tem
, QCradio
))
8660 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8662 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8663 s
= concat2 (tem
, s
);
8667 /* If we have room for the prompt string, add it to this line.
8668 If this is the first on the line, always add it. */
8669 if ((SCHARS (s
) + i
+ 2
8670 + (char_matches
? 0 : SCHARS (desc
) + 3))
8674 ptrdiff_t thiswidth
;
8676 /* Punctuate between strings. */
8679 strcpy (menu
+ i
, ", ");
8685 /* If the char to type doesn't match the string's
8686 first char, explicitly show what char to type. */
8689 /* Add as much of string as fits. */
8690 thiswidth
= min (SCHARS (desc
), width
- i
);
8691 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8693 strcpy (menu
+ i
, " = ");
8697 /* Add as much of string as fits. */
8698 thiswidth
= min (SCHARS (s
), width
- i
);
8699 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8705 /* If this element does not fit, end the line now,
8706 and save the element for the next line. */
8707 strcpy (menu
+ i
, "...");
8712 /* Move past this element. */
8713 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8714 /* Handle reaching end of dense table. */
8719 rest
= Fcdr_safe (rest
);
8723 /* Prompt with that and read response. */
8724 message2_nolog (menu
, strlen (menu
),
8725 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8727 /* Make believe its not a keyboard macro in case the help char
8728 is pressed. Help characters are not recorded because menu prompting
8729 is not used on replay.
8731 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8732 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8734 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8735 while (BUFFERP (obj
));
8736 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8738 if (!INTEGERP (obj
))
8740 else if (XINT (obj
) == -2)
8743 if (! EQ (obj
, menu_prompt_more_char
)
8744 && (!INTEGERP (menu_prompt_more_char
)
8745 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8747 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8748 store_kbd_macro_char (obj
);
8751 /* Help char - go round again */
8755 /* Reading key sequences. */
8757 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8758 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8759 keymap, or nil otherwise. Return the index of the first keymap in
8760 which KEY has any binding, or NMAPS if no map has a binding.
8762 If KEY is a meta ASCII character, treat it like meta-prefix-char
8763 followed by the corresponding non-meta character. Keymaps in
8764 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8767 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8770 NEXT may be the same array as CURRENT. */
8773 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8774 Lisp_Object
*defs
, Lisp_Object
*next
)
8776 ptrdiff_t i
, first_binding
;
8778 first_binding
= nmaps
;
8779 for (i
= nmaps
- 1; i
>= 0; i
--)
8781 if (! NILP (current
[i
]))
8783 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8784 if (! NILP (defs
[i
]))
8791 /* Given the set of bindings we've found, produce the next set of maps. */
8792 if (first_binding
< nmaps
)
8793 for (i
= 0; i
< nmaps
; i
++)
8794 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8796 return first_binding
;
8799 /* Structure used to keep track of partial application of key remapping
8800 such as Vfunction_key_map and Vkey_translation_map. */
8801 typedef struct keyremap
8803 /* This is the map originally specified for this use. */
8805 /* This is a submap reached by looking up, in PARENT,
8806 the events from START to END. */
8808 /* Positions [START, END) in the key sequence buffer
8809 are the key that we have scanned so far.
8810 Those events are the ones that we will replace
8811 if PARENT maps them into a key sequence. */
8815 /* Lookup KEY in MAP.
8816 MAP is a keymap mapping keys to key vectors or functions.
8817 If the mapping is a function and DO_FUNCTION is non-zero, then
8818 the function is called with PROMPT as parameter and its return
8819 value is used as the return value of this function (after checking
8820 that it is indeed a vector). */
8823 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8828 next
= access_keymap (map
, key
, 1, 0, 1);
8830 /* Handle symbol with autoload definition. */
8831 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8832 && CONSP (XSYMBOL (next
)->function
)
8833 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8834 do_autoload (XSYMBOL (next
)->function
, next
);
8836 /* Handle a symbol whose function definition is a keymap
8838 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8839 && (ARRAYP (XSYMBOL (next
)->function
)
8840 || KEYMAPP (XSYMBOL (next
)->function
)))
8841 next
= XSYMBOL (next
)->function
;
8843 /* If the keymap gives a function, not an
8844 array, then call the function with one arg and use
8845 its value instead. */
8846 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8851 next
= call1 (next
, prompt
);
8852 /* If the function returned something invalid,
8853 barf--don't ignore it.
8854 (To ignore it safely, we would need to gcpro a bunch of
8855 other variables.) */
8856 if (! (VECTORP (next
) || STRINGP (next
)))
8857 error ("Function %s returns invalid key sequence",
8858 SSDATA (SYMBOL_NAME (tem
)));
8863 /* Do one step of the key remapping used for function-key-map and
8864 key-translation-map:
8865 KEYBUF is the buffer holding the input events.
8866 BUFSIZE is its maximum size.
8867 FKEY is a pointer to the keyremap structure to use.
8868 INPUT is the index of the last element in KEYBUF.
8869 DOIT if non-zero says that the remapping can actually take place.
8870 DIFF is used to return the number of keys added/removed by the remapping.
8871 PARENT is the root of the keymap.
8872 PROMPT is the prompt to use if the remapping happens through a function.
8873 The return value is non-zero if the remapping actually took place. */
8876 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8877 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8879 Lisp_Object next
, key
;
8881 key
= keybuf
[fkey
->end
++];
8883 if (KEYMAPP (fkey
->parent
))
8884 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8888 /* If keybuf[fkey->start..fkey->end] is bound in the
8889 map and we're in a position to do the key remapping, replace it with
8890 the binding and restart with fkey->start at the end. */
8891 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8893 int len
= XFASTINT (Flength (next
));
8896 *diff
= len
- (fkey
->end
- fkey
->start
);
8898 if (bufsize
- input
<= *diff
)
8899 error ("Key sequence too long");
8901 /* Shift the keys that follow fkey->end. */
8903 for (i
= fkey
->end
; i
< input
; i
++)
8904 keybuf
[i
+ *diff
] = keybuf
[i
];
8906 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8907 keybuf
[i
+ *diff
] = keybuf
[i
];
8908 /* Overwrite the old keys with the new ones. */
8909 for (i
= 0; i
< len
; i
++)
8910 keybuf
[fkey
->start
+ i
]
8911 = Faref (next
, make_number (i
));
8913 fkey
->start
= fkey
->end
+= *diff
;
8914 fkey
->map
= fkey
->parent
;
8919 fkey
->map
= get_keymap (next
, 0, 1);
8921 /* If we no longer have a bound suffix, try a new position for
8923 if (!CONSP (fkey
->map
))
8925 fkey
->end
= ++fkey
->start
;
8926 fkey
->map
= fkey
->parent
;
8932 test_undefined (Lisp_Object binding
)
8934 return (EQ (binding
, Qundefined
)
8935 || (!NILP (binding
) && SYMBOLP (binding
)
8936 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8939 /* Read a sequence of keys that ends with a non prefix character,
8940 storing it in KEYBUF, a buffer of size BUFSIZE.
8942 Return the length of the key sequence stored.
8943 Return -1 if the user rejected a command menu.
8945 Echo starting immediately unless `prompt' is 0.
8947 Where a key sequence ends depends on the currently active keymaps.
8948 These include any minor mode keymaps active in the current buffer,
8949 the current buffer's local map, and the global map.
8951 If a key sequence has no other bindings, we check Vfunction_key_map
8952 to see if some trailing subsequence might be the beginning of a
8953 function key's sequence. If so, we try to read the whole function
8954 key, and substitute its symbolic name into the key sequence.
8956 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8957 `double-' events into similar click events, if that would make them
8958 bound. We try to turn `triple-' events first into `double-' events,
8961 If we get a mouse click in a mode line, vertical divider, or other
8962 non-text area, we treat the click as if it were prefixed by the
8963 symbol denoting that area - `mode-line', `vertical-line', or
8966 If the sequence starts with a mouse click, we read the key sequence
8967 with respect to the buffer clicked on, not the current buffer.
8969 If the user switches frames in the midst of a key sequence, we put
8970 off the switch-frame event until later; the next call to
8971 read_char will return it.
8973 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8974 from the selected window's buffer. */
8977 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8978 int dont_downcase_last
, int can_return_switch_frame
,
8979 int fix_current_buffer
)
8981 Lisp_Object from_string
;
8982 ptrdiff_t count
= SPECPDL_INDEX ();
8984 /* How many keys there are in the current key sequence. */
8987 /* The length of the echo buffer when we started reading, and
8988 the length of this_command_keys when we started reading. */
8989 ptrdiff_t echo_start
IF_LINT (= 0);
8990 ptrdiff_t keys_start
;
8992 /* The number of keymaps we're scanning right now, and the number of
8993 keymaps we have allocated space for. */
8995 ptrdiff_t nmaps_allocated
= 0;
8997 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8998 the current keymaps. */
8999 Lisp_Object
*defs
= NULL
;
9001 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9002 in the current keymaps, or nil where it is not a prefix. */
9003 Lisp_Object
*submaps
= NULL
;
9005 /* The local map to start out with at start of key sequence. */
9006 Lisp_Object orig_local_map
;
9008 /* The map from the `keymap' property to start out with at start of
9010 Lisp_Object orig_keymap
;
9012 /* 1 if we have already considered switching to the local-map property
9013 of the place where a mouse click occurred. */
9014 int localized_local_map
= 0;
9016 /* The index in submaps[] of the first keymap that has a binding for
9017 this key sequence. In other words, the lowest i such that
9018 submaps[i] is non-nil. */
9019 ptrdiff_t first_binding
;
9020 /* Index of the first key that has no binding.
9021 It is useless to try fkey.start larger than that. */
9024 /* If t < mock_input, then KEYBUF[t] should be read as the next
9027 We use this to recover after recognizing a function key. Once we
9028 realize that a suffix of the current key sequence is actually a
9029 function key's escape sequence, we replace the suffix with the
9030 function key's binding from Vfunction_key_map. Now keybuf
9031 contains a new and different key sequence, so the echo area,
9032 this_command_keys, and the submaps and defs arrays are wrong. In
9033 this situation, we set mock_input to t, set t to 0, and jump to
9034 restart_sequence; the loop will read keys from keybuf up until
9035 mock_input, thus rebuilding the state; and then it will resume
9036 reading characters from the keyboard. */
9039 /* If the sequence is unbound in submaps[], then
9040 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9041 and fkey.map is its binding.
9043 These might be > t, indicating that all function key scanning
9044 should hold off until t reaches them. We do this when we've just
9045 recognized a function key, to avoid searching for the function
9046 key's again in Vfunction_key_map. */
9049 /* Likewise, for key_translation_map and input-decode-map. */
9050 keyremap keytran
, indec
;
9052 /* Non-zero if we are trying to map a key by changing an upper-case
9053 letter to lower case, or a shifted function key to an unshifted
9055 int shift_translated
= 0;
9057 /* If we receive a `switch-frame' or `select-window' event in the middle of
9058 a key sequence, we put it off for later.
9059 While we're reading, we keep the event here. */
9060 Lisp_Object delayed_switch_frame
;
9062 /* See the comment below... */
9063 #if defined (GOBBLE_FIRST_EVENT)
9064 Lisp_Object first_event
;
9067 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9068 int original_uppercase_position
= -1;
9070 /* Gets around Microsoft compiler limitations. */
9073 struct buffer
*starting_buffer
;
9075 /* List of events for which a fake prefix key has been generated. */
9076 Lisp_Object fake_prefixed_keys
= Qnil
;
9078 #if defined (GOBBLE_FIRST_EVENT)
9082 struct gcpro gcpro1
;
9084 GCPRO1 (fake_prefixed_keys
);
9085 raw_keybuf_count
= 0;
9087 last_nonmenu_event
= Qnil
;
9089 delayed_switch_frame
= Qnil
;
9095 /* Install the string STR as the beginning of the string of
9096 echoing, so that it serves as a prompt for the next
9098 KVAR (current_kboard
, echo_string
) = prompt
;
9099 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9102 else if (cursor_in_echo_area
9103 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9104 && NILP (Fzerop (Vecho_keystrokes
)))
9105 /* This doesn't put in a dash if the echo buffer is empty, so
9106 you don't always see a dash hanging out in the minibuffer. */
9110 /* Record the initial state of the echo area and this_command_keys;
9111 we will need to restore them if we replay a key sequence. */
9113 echo_start
= echo_length ();
9114 keys_start
= this_command_key_count
;
9115 this_single_command_key_start
= keys_start
;
9117 #if defined (GOBBLE_FIRST_EVENT)
9118 /* This doesn't quite work, because some of the things that read_char
9119 does cannot safely be bypassed. It seems too risky to try to make
9122 /* Read the first char of the sequence specially, before setting
9123 up any keymaps, in case a filter runs and switches buffers on us. */
9124 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9126 #endif /* GOBBLE_FIRST_EVENT */
9128 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9129 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9132 /* We jump here when we need to reinitialize fkey and keytran; this
9133 happens if we switch keyboards between rescans. */
9134 replay_entire_sequence
:
9136 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9137 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9138 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9139 indec
.start
= indec
.end
= 0;
9140 fkey
.start
= fkey
.end
= 0;
9141 keytran
.start
= keytran
.end
= 0;
9143 /* We jump here when the key sequence has been thoroughly changed, and
9144 we need to rescan it starting from the beginning. When we jump here,
9145 keybuf[0..mock_input] holds the sequence we should reread. */
9148 starting_buffer
= current_buffer
;
9149 first_unbound
= bufsize
+ 1;
9151 /* Build our list of keymaps.
9152 If we recognize a function key and replace its escape sequence in
9153 keybuf with its symbol, or if the sequence starts with a mouse
9154 click and we need to switch buffers, we jump back here to rebuild
9155 the initial keymaps from the current buffer. */
9158 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9160 if (2 > nmaps_allocated
)
9162 submaps
= alloca (2 * sizeof *submaps
);
9163 defs
= alloca (2 * sizeof *defs
);
9164 nmaps_allocated
= 2;
9166 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9168 else if (!NILP (Voverriding_local_map
))
9170 if (2 > nmaps_allocated
)
9172 submaps
= alloca (2 * sizeof *submaps
);
9173 defs
= alloca (2 * sizeof *defs
);
9174 nmaps_allocated
= 2;
9176 submaps
[nmaps
++] = Voverriding_local_map
;
9184 nminor
= current_minor_maps (0, &maps
);
9185 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9187 if (total
> nmaps_allocated
)
9189 submaps
= alloca (total
* sizeof *submaps
);
9190 defs
= alloca (total
* sizeof *defs
);
9191 nmaps_allocated
= total
;
9194 if (!NILP (orig_keymap
))
9195 submaps
[nmaps
++] = orig_keymap
;
9197 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9201 submaps
[nmaps
++] = orig_local_map
;
9203 submaps
[nmaps
++] = current_global_map
;
9205 /* Find an accurate initial value for first_binding. */
9206 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9207 if (! NILP (submaps
[first_binding
]))
9210 /* Start from the beginning in keybuf. */
9213 /* These are no-ops the first time through, but if we restart, they
9214 revert the echo area and this_command_keys to their original state. */
9215 this_command_key_count
= keys_start
;
9216 if (INTERACTIVE
&& t
< mock_input
)
9217 echo_truncate (echo_start
);
9219 /* If the best binding for the current key sequence is a keymap, or
9220 we may be looking at a function key's escape sequence, keep on
9222 while (first_binding
< nmaps
9223 /* Keep reading as long as there's a prefix binding. */
9224 ? !NILP (submaps
[first_binding
])
9225 /* Don't return in the middle of a possible function key sequence,
9226 if the only bindings we found were via case conversion.
9227 Thus, if ESC O a has a function-key-map translation
9228 and ESC o has a binding, don't return after ESC O,
9229 so that we can translate ESC O plus the next character. */
9230 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9233 int used_mouse_menu
= 0;
9235 /* Where the last real key started. If we need to throw away a
9236 key that has expanded into more than one element of keybuf
9237 (say, a mouse click on the mode line which is being treated
9238 as [mode-line (mouse-...)], then we backtrack to this point
9240 int last_real_key_start
;
9242 /* These variables are analogous to echo_start and keys_start;
9243 while those allow us to restart the entire key sequence,
9244 echo_local_start and keys_local_start allow us to throw away
9246 ptrdiff_t echo_local_start
IF_LINT (= 0);
9247 int keys_local_start
;
9248 ptrdiff_t local_first_binding
;
9250 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9251 eassert (indec
.start
<= indec
.end
);
9252 eassert (fkey
.start
<= fkey
.end
);
9253 eassert (keytran
.start
<= keytran
.end
);
9254 /* key-translation-map is applied *after* function-key-map
9255 which is itself applied *after* input-decode-map. */
9256 eassert (fkey
.end
<= indec
.start
);
9257 eassert (keytran
.end
<= fkey
.start
);
9259 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9260 first_unbound
< keytran
.start
)
9261 { /* The prefix upto first_unbound has no binding and has
9262 no translation left to do either, so we know it's unbound.
9263 If we don't stop now, we risk staying here indefinitely
9264 (if the user keeps entering fkey or keytran prefixes
9265 like C-c ESC ESC ESC ESC ...) */
9267 for (i
= first_unbound
+ 1; i
< t
; i
++)
9268 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9269 mock_input
= t
- first_unbound
- 1;
9270 indec
.end
= indec
.start
-= first_unbound
+ 1;
9271 indec
.map
= indec
.parent
;
9272 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9273 fkey
.map
= fkey
.parent
;
9274 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9275 keytran
.map
= keytran
.parent
;
9276 goto replay_sequence
;
9280 error ("Key sequence too long");
9283 echo_local_start
= echo_length ();
9284 keys_local_start
= this_command_key_count
;
9285 local_first_binding
= first_binding
;
9288 /* These are no-ops, unless we throw away a keystroke below and
9289 jumped back up to replay_key; in that case, these restore the
9290 variables to their original state, allowing us to replay the
9292 if (INTERACTIVE
&& t
< mock_input
)
9293 echo_truncate (echo_local_start
);
9294 this_command_key_count
= keys_local_start
;
9295 first_binding
= local_first_binding
;
9297 /* By default, assume each event is "real". */
9298 last_real_key_start
= t
;
9300 /* Does mock_input indicate that we are re-reading a key sequence? */
9304 add_command_key (key
);
9305 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9306 && NILP (Fzerop (Vecho_keystrokes
)))
9310 /* If not, we should actually read a character. */
9314 KBOARD
*interrupted_kboard
= current_kboard
;
9315 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9316 key
= read_char (NILP (prompt
), nmaps
,
9317 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9318 &used_mouse_menu
, NULL
);
9319 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9320 /* When switching to a new tty (with a new keyboard),
9321 read_char returns the new buffer, rather than -2
9322 (Bug#5095). This is because `terminal-init-xterm'
9323 calls read-char, which eats the wrong_kboard_jmpbuf
9324 return. Any better way to fix this? -- cyd */
9325 || (interrupted_kboard
!= current_kboard
))
9330 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9331 if (k
== interrupted_kboard
)
9336 /* Don't touch interrupted_kboard when it's been
9338 delayed_switch_frame
= Qnil
;
9339 goto replay_entire_sequence
;
9342 if (!NILP (delayed_switch_frame
))
9344 KVAR (interrupted_kboard
, kbd_queue
)
9345 = Fcons (delayed_switch_frame
,
9346 KVAR (interrupted_kboard
, kbd_queue
));
9347 delayed_switch_frame
= Qnil
;
9351 KVAR (interrupted_kboard
, kbd_queue
)
9352 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9354 /* If the side queue is non-empty, ensure it begins with a
9355 switch-frame, so we'll replay it in the right context. */
9356 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9357 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9358 !(EVENT_HAS_PARAMETERS (key
)
9359 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9363 XSETFRAME (frame
, interrupted_frame
);
9364 KVAR (interrupted_kboard
, kbd_queue
)
9365 = Fcons (make_lispy_switch_frame (frame
),
9366 KVAR (interrupted_kboard
, kbd_queue
));
9369 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9370 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9371 goto replay_entire_sequence
;
9375 /* read_char returns t when it shows a menu and the user rejects it.
9379 unbind_to (count
, Qnil
);
9384 /* read_char returns -1 at the end of a macro.
9385 Emacs 18 handles this by returning immediately with a
9386 zero, so that's what we'll do. */
9387 if (INTEGERP (key
) && XINT (key
) == -1)
9390 /* The Microsoft C compiler can't handle the goto that
9396 /* If the current buffer has been changed from under us, the
9397 keymap may have changed, so replay the sequence. */
9400 timer_resume_idle ();
9403 /* Reset the current buffer from the selected window
9404 in case something changed the former and not the latter.
9405 This is to be more consistent with the behavior
9406 of the command_loop_1. */
9407 if (fix_current_buffer
)
9409 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9411 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9412 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9415 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9416 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9417 goto replay_sequence
;
9420 /* If we have a quit that was typed in another frame, and
9421 quit_throw_to_read_char switched buffers,
9422 replay to get the right keymap. */
9424 && XINT (key
) == quit_char
9425 && current_buffer
!= starting_buffer
)
9428 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9433 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9434 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9435 goto replay_sequence
;
9440 if (EVENT_HAS_PARAMETERS (key
)
9441 /* Either a `switch-frame' or a `select-window' event. */
9442 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9444 /* If we're at the beginning of a key sequence, and the caller
9445 says it's okay, go ahead and return this event. If we're
9446 in the midst of a key sequence, delay it until the end. */
9447 if (t
> 0 || !can_return_switch_frame
)
9449 delayed_switch_frame
= key
;
9455 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9459 /* Clicks in non-text areas get prefixed by the symbol
9460 in their CHAR-ADDRESS field. For example, a click on
9461 the mode line is prefixed by the symbol `mode-line'.
9463 Furthermore, key sequences beginning with mouse clicks
9464 are read using the keymaps of the buffer clicked on, not
9465 the current buffer. So we may have to switch the buffer
9468 When we turn one event into two events, we must make sure
9469 that neither of the two looks like the original--so that,
9470 if we replay the events, they won't be expanded again.
9471 If not for this, such reexpansion could happen either here
9472 or when user programs play with this-command-keys. */
9473 if (EVENT_HAS_PARAMETERS (key
))
9478 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9479 if (EQ (kind
, Qmouse_click
))
9481 Lisp_Object window
, posn
;
9483 window
= POSN_WINDOW (EVENT_START (key
));
9484 posn
= POSN_POSN (EVENT_START (key
));
9487 || (!NILP (fake_prefixed_keys
)
9488 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9490 /* We're looking a second time at an event for which
9491 we generated a fake prefix key. Set
9492 last_real_key_start appropriately. */
9494 last_real_key_start
= t
- 1;
9497 if (last_real_key_start
== 0)
9499 /* Key sequences beginning with mouse clicks are
9500 read using the keymaps in the buffer clicked on,
9501 not the current buffer. If we're at the
9502 beginning of a key sequence, switch buffers. */
9503 if (WINDOWP (window
)
9504 && BUFFERP (XWINDOW (window
)->buffer
)
9505 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9507 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9512 /* Arrange to go back to the original buffer once we're
9513 done reading the key sequence. Note that we can't
9514 use save_excursion_{save,restore} here, because they
9515 save point as well as the current buffer; we don't
9516 want to save point, because redisplay may change it,
9517 to accommodate a Fset_window_start or something. We
9518 don't want to do this at the top of the function,
9519 because we may get input from a subprocess which
9520 wants to change the selected window and stuff (say,
9522 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9524 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9526 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9527 orig_local_map
= get_local_map (PT
, current_buffer
,
9529 orig_keymap
= get_local_map (PT
, current_buffer
,
9531 goto replay_sequence
;
9534 /* For a mouse click, get the local text-property keymap
9535 of the place clicked on, rather than point. */
9536 if (CONSP (XCDR (key
))
9537 && ! localized_local_map
)
9539 Lisp_Object map_here
, start
, pos
;
9541 localized_local_map
= 1;
9542 start
= EVENT_START (key
);
9544 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9546 pos
= POSN_BUFFER_POSN (start
);
9548 && XINT (pos
) >= BEGV
9549 && XINT (pos
) <= ZV
)
9551 map_here
= get_local_map (XINT (pos
),
9554 if (!EQ (map_here
, orig_local_map
))
9556 orig_local_map
= map_here
;
9557 ++localized_local_map
;
9560 map_here
= get_local_map (XINT (pos
),
9563 if (!EQ (map_here
, orig_keymap
))
9565 orig_keymap
= map_here
;
9566 ++localized_local_map
;
9569 if (localized_local_map
> 1)
9574 goto replay_sequence
;
9581 /* Expand mode-line and scroll-bar events into two events:
9582 use posn as a fake prefix key. */
9584 && (NILP (fake_prefixed_keys
)
9585 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9587 if (bufsize
- t
<= 1)
9588 error ("Key sequence too long");
9591 keybuf
[t
+ 1] = key
;
9594 /* Record that a fake prefix key has been generated
9595 for KEY. Don't modify the event; this would
9596 prevent proper action when the event is pushed
9597 back into unread-command-events. */
9598 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9600 /* If on a mode line string with a local keymap,
9601 reconsider the key sequence with that keymap. */
9602 if (string
= POSN_STRING (EVENT_START (key
)),
9603 (CONSP (string
) && STRINGP (XCAR (string
))))
9605 Lisp_Object pos
, map
, map2
;
9607 pos
= XCDR (string
);
9608 string
= XCAR (string
);
9610 && XINT (pos
) < SCHARS (string
))
9612 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9614 orig_local_map
= map
;
9615 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9618 if (!NILP (map
) || !NILP (map2
))
9619 goto replay_sequence
;
9625 else if (NILP (from_string
)
9626 && (string
= POSN_STRING (EVENT_START (key
)),
9627 (CONSP (string
) && STRINGP (XCAR (string
)))))
9629 /* For a click on a string, i.e. overlay string or a
9630 string displayed via the `display' property,
9631 consider `local-map' and `keymap' properties of
9633 Lisp_Object pos
, map
, map2
;
9635 pos
= XCDR (string
);
9636 string
= XCAR (string
);
9638 && XINT (pos
) < SCHARS (string
))
9640 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9642 orig_local_map
= map
;
9643 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9647 if (!NILP (map
) || !NILP (map2
))
9649 from_string
= string
;
9652 goto replay_sequence
;
9657 else if (CONSP (XCDR (key
))
9658 && CONSP (EVENT_START (key
))
9659 && CONSP (XCDR (EVENT_START (key
))))
9663 posn
= POSN_POSN (EVENT_START (key
));
9664 /* Handle menu-bar events:
9665 insert the dummy prefix event `menu-bar'. */
9666 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9668 if (bufsize
- t
<= 1)
9669 error ("Key sequence too long");
9673 /* Zap the position in key, so we know that we've
9674 expanded it, and don't try to do so again. */
9675 POSN_SET_POSN (EVENT_START (key
),
9676 Fcons (posn
, Qnil
));
9679 goto replay_sequence
;
9681 else if (CONSP (posn
))
9683 /* We're looking at the second event of a
9684 sequence which we expanded before. Set
9685 last_real_key_start appropriately. */
9686 if (last_real_key_start
== t
&& t
> 0)
9687 last_real_key_start
= t
- 1;
9692 /* We have finally decided that KEY is something we might want
9694 first_binding
= (follow_key (key
,
9695 nmaps
- first_binding
,
9696 submaps
+ first_binding
,
9697 defs
+ first_binding
,
9698 submaps
+ first_binding
)
9701 /* If KEY wasn't bound, we'll try some fallbacks. */
9702 if (first_binding
< nmaps
)
9703 /* This is needed for the following scenario:
9704 event 0: a down-event that gets dropped by calling replay_key.
9705 event 1: some normal prefix like C-h.
9706 After event 0, first_unbound is 0, after event 1 indec.start,
9707 fkey.start, and keytran.start are all 1, so when we see that
9708 C-h is bound, we need to update first_unbound. */
9709 first_unbound
= max (t
+ 1, first_unbound
);
9714 /* Remember the position to put an upper bound on indec.start. */
9715 first_unbound
= min (t
, first_unbound
);
9717 head
= EVENT_HEAD (key
);
9718 if (help_char_p (head
) && t
> 0)
9720 read_key_sequence_cmd
= Vprefix_help_command
;
9722 last_nonmenu_event
= key
;
9723 /* The Microsoft C compiler can't handle the goto that
9731 Lisp_Object breakdown
;
9734 breakdown
= parse_modifiers (head
);
9735 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9736 /* Attempt to reduce an unbound mouse event to a simpler
9737 event that is bound:
9738 Drags reduce to clicks.
9739 Double-clicks reduce to clicks.
9740 Triple-clicks reduce to double-clicks, then to clicks.
9741 Down-clicks are eliminated.
9742 Double-downs reduce to downs, then are eliminated.
9743 Triple-downs reduce to double-downs, then to downs,
9744 then are eliminated. */
9745 if (modifiers
& (down_modifier
| drag_modifier
9746 | double_modifier
| triple_modifier
))
9748 while (modifiers
& (down_modifier
| drag_modifier
9749 | double_modifier
| triple_modifier
))
9751 Lisp_Object new_head
, new_click
;
9752 if (modifiers
& triple_modifier
)
9753 modifiers
^= (double_modifier
| triple_modifier
);
9754 else if (modifiers
& double_modifier
)
9755 modifiers
&= ~double_modifier
;
9756 else if (modifiers
& drag_modifier
)
9757 modifiers
&= ~drag_modifier
;
9760 /* Dispose of this `down' event by simply jumping
9761 back to replay_key, to get another event.
9763 Note that if this event came from mock input,
9764 then just jumping back to replay_key will just
9765 hand it to us again. So we have to wipe out any
9768 We could delete keybuf[t] and shift everything
9769 after that to the left by one spot, but we'd also
9770 have to fix up any variable that points into
9771 keybuf, and shifting isn't really necessary
9774 Adding prefixes for non-textual mouse clicks
9775 creates two characters of mock input, and both
9776 must be thrown away. If we're only looking at
9777 the prefix now, we can just jump back to
9778 replay_key. On the other hand, if we've already
9779 processed the prefix, and now the actual click
9780 itself is giving us trouble, then we've lost the
9781 state of the keymaps we want to backtrack to, and
9782 we need to replay the whole sequence to rebuild
9785 Beyond that, only function key expansion could
9786 create more than two keys, but that should never
9787 generate mouse events, so it's okay to zero
9788 mock_input in that case too.
9790 FIXME: The above paragraph seems just plain
9791 wrong, if you consider things like
9792 xterm-mouse-mode. -stef
9794 Isn't this just the most wonderful code ever? */
9796 /* If mock_input > t + 1, the above simplification
9797 will actually end up dropping keys on the floor.
9798 This is probably OK for now, but even
9799 if mock_input <= t + 1, we need to adjust indec,
9801 Typical case [header-line down-mouse-N]:
9802 mock_input = 2, t = 1, fkey.end = 1,
9803 last_real_key_start = 0. */
9804 if (indec
.end
> last_real_key_start
)
9806 indec
.end
= indec
.start
9807 = min (last_real_key_start
, indec
.start
);
9808 indec
.map
= indec
.parent
;
9809 if (fkey
.end
> last_real_key_start
)
9811 fkey
.end
= fkey
.start
9812 = min (last_real_key_start
, fkey
.start
);
9813 fkey
.map
= fkey
.parent
;
9814 if (keytran
.end
> last_real_key_start
)
9816 keytran
.end
= keytran
.start
9817 = min (last_real_key_start
, keytran
.start
);
9818 keytran
.map
= keytran
.parent
;
9822 if (t
== last_real_key_start
)
9829 mock_input
= last_real_key_start
;
9830 goto replay_sequence
;
9835 = apply_modifiers (modifiers
, XCAR (breakdown
));
9837 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9839 /* Look for a binding for this new key. follow_key
9840 promises that it didn't munge submaps the
9841 last time we called it, since key was unbound. */
9843 = (follow_key (new_click
,
9844 nmaps
- local_first_binding
,
9845 submaps
+ local_first_binding
,
9846 defs
+ local_first_binding
,
9847 submaps
+ local_first_binding
)
9848 + local_first_binding
);
9850 /* If that click is bound, go for it. */
9851 if (first_binding
< nmaps
)
9856 /* Otherwise, we'll leave key set to the drag event. */
9863 /* Normally, last_nonmenu_event gets the previous key we read.
9864 But when a mouse popup menu is being used,
9865 we don't update last_nonmenu_event; it continues to hold the mouse
9866 event that preceded the first level of menu. */
9867 if (!used_mouse_menu
)
9868 last_nonmenu_event
= key
;
9870 /* Record what part of this_command_keys is the current key sequence. */
9871 this_single_command_key_start
= this_command_key_count
- t
;
9873 /* Look for this sequence in input-decode-map.
9874 Scan from indec.end until we find a bound suffix. */
9875 while (indec
.end
< t
)
9877 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9880 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9881 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9886 mock_input
= diff
+ max (t
, mock_input
);
9887 goto replay_sequence
;
9891 if (first_binding
< nmaps
9892 && NILP (submaps
[first_binding
])
9893 && !test_undefined (defs
[first_binding
])
9894 && indec
.start
>= t
)
9895 /* There is a binding and it's not a prefix.
9896 (and it doesn't have any input-decode-map translation pending).
9897 There is thus no function-key in this sequence.
9898 Moving fkey.start is important in this case to allow keytran.start
9899 to go over the sequence before we return (since we keep the
9900 invariant that keytran.end <= fkey.start). */
9903 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9906 /* If the sequence is unbound, see if we can hang a function key
9907 off the end of it. */
9908 /* Continue scan from fkey.end until we find a bound suffix. */
9909 while (fkey
.end
< indec
.start
)
9911 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9914 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9915 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9916 max (t
, mock_input
),
9917 /* If there's a binding (i.e.
9918 first_binding >= nmaps) we don't want
9919 to apply this function-key-mapping. */
9921 && (first_binding
>= nmaps
9922 || test_undefined (defs
[first_binding
])),
9927 mock_input
= diff
+ max (t
, mock_input
);
9928 /* Adjust the input-decode-map counters. */
9930 indec
.start
+= diff
;
9932 goto replay_sequence
;
9936 /* Look for this sequence in key-translation-map.
9937 Scan from keytran.end until we find a bound suffix. */
9938 while (keytran
.end
< fkey
.start
)
9940 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9943 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9944 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9949 mock_input
= diff
+ max (t
, mock_input
);
9950 /* Adjust the function-key-map and input-decode-map counters. */
9952 indec
.start
+= diff
;
9956 goto replay_sequence
;
9960 /* If KEY is not defined in any of the keymaps,
9961 and cannot be part of a function key or translation,
9962 and is an upper case letter
9963 use the corresponding lower-case letter instead. */
9964 if (first_binding
>= nmaps
9965 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9967 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9968 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9969 || (XINT (key
) & shift_modifier
)))
9971 Lisp_Object new_key
;
9973 original_uppercase
= key
;
9974 original_uppercase_position
= t
- 1;
9976 if (XINT (key
) & shift_modifier
)
9977 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9979 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9980 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9982 /* We have to do this unconditionally, regardless of whether
9983 the lower-case char is defined in the keymaps, because they
9984 might get translated through function-key-map. */
9985 keybuf
[t
- 1] = new_key
;
9986 mock_input
= max (t
, mock_input
);
9987 shift_translated
= 1;
9989 goto replay_sequence
;
9991 /* If KEY is not defined in any of the keymaps,
9992 and cannot be part of a function key or translation,
9993 and is a shifted function key,
9994 use the corresponding unshifted function key instead. */
9995 if (first_binding
>= nmaps
9996 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9998 Lisp_Object breakdown
= parse_modifiers (key
);
10000 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10002 if (modifiers
& shift_modifier
10003 /* Treat uppercase keys as shifted. */
10005 && (KEY_TO_CHAR (key
)
10006 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
10007 && uppercasep (KEY_TO_CHAR (key
))))
10009 Lisp_Object new_key
10010 = (modifiers
& shift_modifier
10011 ? apply_modifiers (modifiers
& ~shift_modifier
,
10013 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
10015 original_uppercase
= key
;
10016 original_uppercase_position
= t
- 1;
10018 /* We have to do this unconditionally, regardless of whether
10019 the lower-case char is defined in the keymaps, because they
10020 might get translated through function-key-map. */
10021 keybuf
[t
- 1] = new_key
;
10022 mock_input
= max (t
, mock_input
);
10023 /* Reset fkey (and consequently keytran) to apply
10024 function-key-map on the result, so that S-backspace is
10025 correctly mapped to DEL (via backspace). OTOH,
10026 input-decode-map doesn't need to go through it again. */
10027 fkey
.start
= fkey
.end
= 0;
10028 keytran
.start
= keytran
.end
= 0;
10029 shift_translated
= 1;
10031 goto replay_sequence
;
10036 read_key_sequence_cmd
= (first_binding
< nmaps
10037 ? defs
[first_binding
]
10039 read_key_sequence_remapped
10040 /* Remap command through active keymaps.
10041 Do the remapping here, before the unbind_to so it uses the keymaps
10042 of the appropriate buffer. */
10043 = SYMBOLP (read_key_sequence_cmd
)
10044 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
10047 unread_switch_frame
= delayed_switch_frame
;
10048 unbind_to (count
, Qnil
);
10050 /* Don't downcase the last character if the caller says don't.
10051 Don't downcase it if the result is undefined, either. */
10052 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10054 && t
- 1 == original_uppercase_position
)
10056 keybuf
[t
- 1] = original_uppercase
;
10057 shift_translated
= 0;
10060 if (shift_translated
)
10061 Vthis_command_keys_shift_translated
= Qt
;
10063 /* Occasionally we fabricate events, perhaps by expanding something
10064 according to function-key-map, or by adding a prefix symbol to a
10065 mouse click in the scroll bar or modeline. In this cases, return
10066 the entire generated key sequence, even if we hit an unbound
10067 prefix or a definition before the end. This means that you will
10068 be able to push back the event properly, and also means that
10069 read-key-sequence will always return a logical unit.
10072 for (; t
< mock_input
; t
++)
10074 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10075 && NILP (Fzerop (Vecho_keystrokes
)))
10076 echo_char (keybuf
[t
]);
10077 add_command_key (keybuf
[t
]);
10084 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10085 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10086 The sequence is sufficient to specify a non-prefix command in the
10087 current local and global maps.
10089 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10090 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10091 as a continuation of the previous key.
10093 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10094 convert the last event to lower case. (Normally any upper case event
10095 is converted to lower case if the original event is undefined and the lower
10096 case equivalent is defined.) A non-nil value is appropriate for reading
10097 a key sequence to be defined.
10099 A C-g typed while in this function is treated like any other character,
10100 and `quit-flag' is not set.
10102 If the key sequence starts with a mouse click, then the sequence is read
10103 using the keymaps of the buffer of the window clicked in, not the buffer
10104 of the selected window as normal.
10106 `read-key-sequence' drops unbound button-down events, since you normally
10107 only care about the click or drag events which follow them. If a drag
10108 or multi-click event is unbound, but the corresponding click event would
10109 be bound, `read-key-sequence' turns the event into a click event at the
10110 drag's starting position. This means that you don't have to distinguish
10111 between click and drag, double, or triple events unless you want to.
10113 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10114 lines separating windows, and scroll bars with imaginary keys
10115 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10117 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10118 function will process a switch-frame event if the user switches frames
10119 before typing anything. If the user switches frames in the middle of a
10120 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10121 is nil, then the event will be put off until after the current key sequence.
10123 `read-key-sequence' checks `function-key-map' for function key
10124 sequences, where they wouldn't conflict with ordinary bindings. See
10125 `function-key-map' for more details.
10127 The optional fifth argument CMD-LOOP, if non-nil, means
10128 that this key sequence is being read by something that will
10129 read commands one after another. It should be nil if the caller
10130 will read just one key sequence. */)
10131 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10133 Lisp_Object keybuf
[30];
10135 struct gcpro gcpro1
;
10136 ptrdiff_t count
= SPECPDL_INDEX ();
10138 if (!NILP (prompt
))
10139 CHECK_STRING (prompt
);
10142 specbind (Qinput_method_exit_on_first_char
,
10143 (NILP (cmd_loop
) ? Qt
: Qnil
));
10144 specbind (Qinput_method_use_echo_area
,
10145 (NILP (cmd_loop
) ? Qt
: Qnil
));
10147 memset (keybuf
, 0, sizeof keybuf
);
10148 GCPRO1 (keybuf
[0]);
10149 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10151 if (NILP (continue_echo
))
10153 this_command_key_count
= 0;
10154 this_command_key_count_reset
= 0;
10155 this_single_command_key_start
= 0;
10158 #ifdef HAVE_WINDOW_SYSTEM
10159 if (display_hourglass_p
)
10160 cancel_hourglass ();
10163 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10164 prompt
, ! NILP (dont_downcase_last
),
10165 ! NILP (can_return_switch_frame
), 0);
10167 #if 0 /* The following is fine for code reading a key sequence and
10168 then proceeding with a lengthy computation, but it's not good
10169 for code reading keys in a loop, like an input method. */
10170 #ifdef HAVE_WINDOW_SYSTEM
10171 if (display_hourglass_p
)
10172 start_hourglass ();
10182 return unbind_to (count
, make_event_array (i
, keybuf
));
10185 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10186 Sread_key_sequence_vector
, 1, 5, 0,
10187 doc
: /* Like `read-key-sequence' but always return a vector. */)
10188 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10190 Lisp_Object keybuf
[30];
10192 struct gcpro gcpro1
;
10193 ptrdiff_t count
= SPECPDL_INDEX ();
10195 if (!NILP (prompt
))
10196 CHECK_STRING (prompt
);
10199 specbind (Qinput_method_exit_on_first_char
,
10200 (NILP (cmd_loop
) ? Qt
: Qnil
));
10201 specbind (Qinput_method_use_echo_area
,
10202 (NILP (cmd_loop
) ? Qt
: Qnil
));
10204 memset (keybuf
, 0, sizeof keybuf
);
10205 GCPRO1 (keybuf
[0]);
10206 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10208 if (NILP (continue_echo
))
10210 this_command_key_count
= 0;
10211 this_command_key_count_reset
= 0;
10212 this_single_command_key_start
= 0;
10215 #ifdef HAVE_WINDOW_SYSTEM
10216 if (display_hourglass_p
)
10217 cancel_hourglass ();
10220 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10221 prompt
, ! NILP (dont_downcase_last
),
10222 ! NILP (can_return_switch_frame
), 0);
10224 #ifdef HAVE_WINDOW_SYSTEM
10225 if (display_hourglass_p
)
10226 start_hourglass ();
10235 return unbind_to (count
, Fvector (i
, keybuf
));
10238 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10239 doc
: /* Execute CMD as an editor command.
10240 CMD must be a symbol that satisfies the `commandp' predicate.
10241 Optional second arg RECORD-FLAG non-nil
10242 means unconditionally put this command in `command-history'.
10243 Otherwise, that is done only if an arg is read using the minibuffer.
10244 The argument KEYS specifies the value to use instead of (this-command-keys)
10245 when reading the arguments; if it is nil, (this-command-keys) is used.
10246 The argument SPECIAL, if non-nil, means that this command is executing
10247 a special event, so ignore the prefix argument and don't clear it. */)
10248 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10250 register Lisp_Object final
;
10251 register Lisp_Object tem
;
10252 Lisp_Object prefixarg
;
10254 debug_on_next_call
= 0;
10256 if (NILP (special
))
10258 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10259 Vcurrent_prefix_arg
= prefixarg
;
10260 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10267 tem
= Fget (cmd
, Qdisabled
);
10270 tem
= Fsymbol_value (Qdisabled_command_function
);
10272 return Frun_hooks (1, &Qdisabled_command_function
);
10278 final
= Findirect_function (cmd
, Qnil
);
10280 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10282 struct gcpro gcpro1
, gcpro2
;
10284 GCPRO2 (cmd
, prefixarg
);
10285 do_autoload (final
, cmd
);
10292 if (STRINGP (final
) || VECTORP (final
))
10294 /* If requested, place the macro in the command history. For
10295 other sorts of commands, call-interactively takes care of
10297 if (!NILP (record_flag
))
10300 = Fcons (Fcons (Qexecute_kbd_macro
,
10301 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10304 /* Don't keep command history around forever. */
10305 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10307 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10309 XSETCDR (tem
, Qnil
);
10313 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10316 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10317 /* Don't call Fcall_interactively directly because we want to make
10318 sure the backtrace has an entry for `call-interactively'.
10319 For the same reason, pass `cmd' rather than `final'. */
10320 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10327 /* Return nonzero if input events are pending. */
10330 detect_input_pending (void)
10332 if (!input_pending
)
10333 get_input_pending (&input_pending
, 0);
10335 return input_pending
;
10338 /* Return nonzero if input events other than mouse movements are
10342 detect_input_pending_ignore_squeezables (void)
10344 if (!input_pending
)
10345 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10347 return input_pending
;
10350 /* Return nonzero if input events are pending, and run any pending timers. */
10353 detect_input_pending_run_timers (int do_display
)
10355 int old_timers_run
= timers_run
;
10357 if (!input_pending
)
10358 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10360 if (old_timers_run
!= timers_run
&& do_display
)
10362 redisplay_preserve_echo_area (8);
10363 /* The following fixes a bug when using lazy-lock with
10364 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10365 from an idle timer function. The symptom of the bug is that
10366 the cursor sometimes doesn't become visible until the next X
10367 event is processed. --gerd. */
10369 Lisp_Object tail
, frame
;
10370 FOR_EACH_FRAME (tail
, frame
)
10371 if (FRAME_RIF (XFRAME (frame
)))
10372 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10376 return input_pending
;
10379 /* This is called in some cases before a possible quit.
10380 It cases the next call to detect_input_pending to recompute input_pending.
10381 So calling this function unnecessarily can't do any harm. */
10384 clear_input_pending (void)
10389 /* Return nonzero if there are pending requeued events.
10390 This isn't used yet. The hope is to make wait_reading_process_output
10391 call it, and return if it runs Lisp code that unreads something.
10392 The problem is, kbd_buffer_get_event needs to be fixed to know what
10393 to do in that case. It isn't trivial. */
10396 requeued_events_pending_p (void)
10398 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10402 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10403 doc
: /* Return t if command input is currently available with no wait.
10404 Actually, the value is nil only if we can be sure that no input is available;
10405 if there is a doubt, the value is t. */)
10408 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10409 || !NILP (Vunread_post_input_method_events
)
10410 || !NILP (Vunread_input_method_events
))
10413 /* Process non-user-visible events (Bug#10195). */
10414 process_special_events ();
10416 get_input_pending (&input_pending
,
10417 READABLE_EVENTS_DO_TIMERS_NOW
10418 | READABLE_EVENTS_FILTER_EVENTS
);
10419 return input_pending
> 0 ? Qt
: Qnil
;
10422 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10423 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10426 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10429 if (total_keys
< NUM_RECENT_KEYS
)
10430 return Fvector (total_keys
, keys
);
10433 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10434 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10435 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10436 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10437 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10442 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10443 doc
: /* Return the key sequence that invoked this command.
10444 However, if the command has called `read-key-sequence', it returns
10445 the last key sequence that has been read.
10446 The value is a string or a vector.
10448 See also `this-command-keys-vector'. */)
10451 return make_event_array (this_command_key_count
,
10452 XVECTOR (this_command_keys
)->contents
);
10455 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10456 doc
: /* Return the key sequence that invoked this command, as a vector.
10457 However, if the command has called `read-key-sequence', it returns
10458 the last key sequence that has been read.
10460 See also `this-command-keys'. */)
10463 return Fvector (this_command_key_count
,
10464 XVECTOR (this_command_keys
)->contents
);
10467 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10468 Sthis_single_command_keys
, 0, 0, 0,
10469 doc
: /* Return the key sequence that invoked this command.
10470 More generally, it returns the last key sequence read, either by
10471 the command loop or by `read-key-sequence'.
10472 Unlike `this-command-keys', this function's value
10473 does not include prefix arguments.
10474 The value is always a vector. */)
10477 return Fvector (this_command_key_count
10478 - this_single_command_key_start
,
10479 (XVECTOR (this_command_keys
)->contents
10480 + this_single_command_key_start
));
10483 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10484 Sthis_single_command_raw_keys
, 0, 0, 0,
10485 doc
: /* Return the raw events that were read for this command.
10486 More generally, it returns the last key sequence read, either by
10487 the command loop or by `read-key-sequence'.
10488 Unlike `this-single-command-keys', this function's value
10489 shows the events before all translations (except for input methods).
10490 The value is always a vector. */)
10493 return Fvector (raw_keybuf_count
,
10494 (XVECTOR (raw_keybuf
)->contents
));
10497 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10498 Sreset_this_command_lengths
, 0, 0, 0,
10499 doc
: /* Make the unread events replace the last command and echo.
10500 Used in `universal-argument-other-key'.
10502 `universal-argument-other-key' rereads the event just typed.
10503 It then gets translated through `function-key-map'.
10504 The translated event has to replace the real events,
10505 both in the value of (this-command-keys) and in echoing.
10506 To achieve this, `universal-argument-other-key' calls
10507 `reset-this-command-lengths', which discards the record of reading
10508 these events the first time. */)
10511 this_command_key_count
= before_command_key_count
;
10512 if (this_command_key_count
< this_single_command_key_start
)
10513 this_single_command_key_start
= this_command_key_count
;
10515 echo_truncate (before_command_echo_length
);
10517 /* Cause whatever we put into unread-command-events
10518 to echo as if it were being freshly read from the keyboard. */
10519 this_command_key_count_reset
= 1;
10524 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10525 Sclear_this_command_keys
, 0, 1, 0,
10526 doc
: /* Clear out the vector that `this-command-keys' returns.
10527 Also clear the record of the last 100 events, unless optional arg
10528 KEEP-RECORD is non-nil. */)
10529 (Lisp_Object keep_record
)
10533 this_command_key_count
= 0;
10534 this_command_key_count_reset
= 0;
10536 if (NILP (keep_record
))
10538 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10539 ASET (recent_keys
, i
, Qnil
);
10541 recent_keys_index
= 0;
10546 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10547 doc
: /* Return the current depth in recursive edits. */)
10551 /* Wrap around reliably on integer overflow. */
10552 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10553 XSETINT (temp
, sum
);
10557 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10558 "FOpen dribble file: ",
10559 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10560 If FILE is nil, close any open dribble file.
10561 The file will be closed when Emacs exits. */)
10573 file
= Fexpand_file_name (file
, Qnil
);
10574 dribble
= fopen (SSDATA (file
), "w");
10576 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10581 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10582 doc
: /* Discard the contents of the terminal input buffer.
10583 Also end any kbd macro being defined. */)
10586 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10588 /* Discard the last command from the macro. */
10589 Fcancel_kbd_macro_events ();
10593 update_mode_lines
++;
10595 Vunread_command_events
= Qnil
;
10596 unread_command_char
= -1;
10598 discard_tty_input ();
10600 kbd_fetch_ptr
= kbd_store_ptr
;
10606 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10607 doc
: /* Stop Emacs and return to superior process. You can resume later.
10608 If `cannot-suspend' is non-nil, or if the system doesn't support job
10609 control, run a subshell instead.
10611 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10612 to be read as terminal input by Emacs's parent, after suspension.
10614 Before suspending, run the normal hook `suspend-hook'.
10615 After resumption run the normal hook `suspend-resume-hook'.
10617 Some operating systems cannot stop the Emacs process and resume it later.
10618 On such systems, Emacs starts a subshell instead of suspending. */)
10619 (Lisp_Object stuffstring
)
10621 ptrdiff_t count
= SPECPDL_INDEX ();
10622 int old_height
, old_width
;
10624 struct gcpro gcpro1
;
10627 if (tty_list
&& tty_list
->next
)
10628 error ("There are other tty frames open; close them before suspending Emacs");
10630 if (!NILP (stuffstring
))
10631 CHECK_STRING (stuffstring
);
10633 /* Run the functions in suspend-hook. */
10634 hook
= intern ("suspend-hook");
10635 Frun_hooks (1, &hook
);
10637 GCPRO1 (stuffstring
);
10638 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10639 reset_all_sys_modes ();
10640 /* sys_suspend can get an error if it tries to fork a subshell
10641 and the system resources aren't available for that. */
10642 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10644 stuff_buffered_input (stuffstring
);
10645 if (cannot_suspend
)
10649 unbind_to (count
, Qnil
);
10651 /* Check if terminal/window size has changed.
10652 Note that this is not useful when we are running directly
10653 with a window system; but suspend should be disabled in that case. */
10654 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10655 if (width
!= old_width
|| height
!= old_height
)
10656 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10658 /* Run suspend-resume-hook. */
10659 hook
= intern ("suspend-resume-hook");
10660 Frun_hooks (1, &hook
);
10666 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10667 Then in any case stuff anything Emacs has read ahead and not used. */
10670 stuff_buffered_input (Lisp_Object stuffstring
)
10672 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10673 register unsigned char *p
;
10675 if (STRINGP (stuffstring
))
10677 register ptrdiff_t count
;
10679 p
= SDATA (stuffstring
);
10680 count
= SBYTES (stuffstring
);
10681 while (count
-- > 0)
10686 /* Anything we have read ahead, put back for the shell to read. */
10687 /* ?? What should this do when we have multiple keyboards??
10688 Should we ignore anything that was typed in at the "wrong" kboard?
10690 rms: we should stuff everything back into the kboard
10692 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10695 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10696 kbd_fetch_ptr
= kbd_buffer
;
10697 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10698 stuff_char (kbd_fetch_ptr
->code
);
10700 clear_event (kbd_fetch_ptr
);
10704 #endif /* SIGTSTP */
10708 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10710 input_available_clear_time
= time_to_clear
;
10712 /* Tell handle_interrupt to throw back to read_char, */
10713 waiting_for_input
= 1;
10715 /* If handle_interrupt was called before and buffered a C-g,
10716 make it run again now, to avoid timing error. */
10717 if (!NILP (Vquit_flag
))
10718 quit_throw_to_read_char (0);
10722 clear_waiting_for_input (void)
10724 /* Tell handle_interrupt not to throw back to read_char, */
10725 waiting_for_input
= 0;
10726 input_available_clear_time
= 0;
10729 /* The SIGINT handler.
10731 If we have a frame on the controlling tty, we assume that the
10732 SIGINT was generated by C-g, so we call handle_interrupt.
10733 Otherwise, tell QUIT to kill Emacs. */
10736 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10737 /* compilers complain in signal calls. */
10739 /* Must preserve main program's value of errno. */
10740 int old_errno
= errno
;
10741 struct terminal
*terminal
;
10743 SIGNAL_THREAD_CHECK (signalnum
);
10745 /* See if we have an active terminal on our controlling tty. */
10746 terminal
= get_named_tty ("/dev/tty");
10749 /* If there are no frames there, let's pretend that we are a
10750 well-behaving UN*X program and quit. We must not call Lisp
10751 in a signal handler, so tell QUIT to exit when it is
10753 Vquit_flag
= Qkill_emacs
;
10757 /* Otherwise, the SIGINT was probably generated by C-g. */
10759 /* Set internal_last_event_frame to the top frame of the
10760 controlling tty, if we have a frame there. We disable the
10761 interrupt key on secondary ttys, so the SIGINT must have come
10762 from the controlling tty. */
10763 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10765 handle_interrupt ();
10771 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10772 of the number of times C-g has been requested. If C-g is pressed
10773 enough times, then quit anyway. See bug#6585. */
10774 static int force_quit_count
;
10776 /* This routine is called at interrupt level in response to C-g.
10778 It is called from the SIGINT handler or kbd_buffer_store_event.
10780 If `waiting_for_input' is non zero, then unless `echoing' is
10781 nonzero, immediately throw back to read_char.
10783 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10784 eval to throw, when it gets a chance. If quit-flag is already
10785 non-nil, it stops the job right away. */
10788 handle_interrupt (void)
10794 /* XXX This code needs to be revised for multi-tty support. */
10795 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10797 /* If SIGINT isn't blocked, don't let us be interrupted by
10798 another SIGINT, it might be harmful due to non-reentrancy
10799 in I/O functions. */
10800 sigblock (sigmask (SIGINT
));
10803 reset_all_sys_modes ();
10805 #ifdef SIGTSTP /* Support possible in later USG versions */
10807 * On systems which can suspend the current process and return to the original
10808 * shell, this command causes the user to end up back at the shell.
10809 * The "Auto-save" and "Abort" questions are not asked until
10810 * the user elects to return to emacs, at which point he can save the current
10811 * job and either dump core or continue.
10815 /* Perhaps should really fork an inferior shell?
10816 But that would not provide any way to get back
10817 to the original shell, ever. */
10818 printf ("No support for stopping a process on this operating system;\n");
10819 printf ("you can continue or abort.\n");
10820 #endif /* not SIGTSTP */
10822 /* We must remain inside the screen area when the internal terminal
10823 is used. Note that [Enter] is not echoed by dos. */
10824 cursor_to (SELECTED_FRAME (), 0, 0);
10826 /* It doesn't work to autosave while GC is in progress;
10827 the code used for auto-saving doesn't cope with the mark bit. */
10828 if (!gc_in_progress
)
10830 printf ("Auto-save? (y or n) ");
10832 if (((c
= getchar ()) & ~040) == 'Y')
10834 Fdo_auto_save (Qt
, Qnil
);
10836 printf ("\r\nAuto-save done");
10837 #else /* not MSDOS */
10838 printf ("Auto-save done\n");
10839 #endif /* not MSDOS */
10841 while (c
!= '\n') c
= getchar ();
10845 /* During GC, it must be safe to reenable quitting again. */
10846 Vinhibit_quit
= Qnil
;
10849 #endif /* not MSDOS */
10850 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10851 printf ("but will instead do a real quit after garbage collection ends\r\n");
10856 printf ("\r\nAbort? (y or n) ");
10857 #else /* not MSDOS */
10858 printf ("Abort (and dump core)? (y or n) ");
10859 #endif /* not MSDOS */
10861 if (((c
= getchar ()) & ~040) == 'Y')
10863 while (c
!= '\n') c
= getchar ();
10865 printf ("\r\nContinuing...\r\n");
10866 #else /* not MSDOS */
10867 printf ("Continuing...\n");
10868 #endif /* not MSDOS */
10870 init_all_sys_modes ();
10875 /* If executing a function that wants to be interrupted out of
10876 and the user has not deferred quitting by binding `inhibit-quit'
10877 then quit right away. */
10878 if (immediate_quit
&& NILP (Vinhibit_quit
))
10880 struct gl_state_s saved
;
10881 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10883 immediate_quit
= 0;
10886 GCPRO4 (saved
.object
, saved
.global_code
,
10887 saved
.current_syntax_table
, saved
.old_prop
);
10888 Fsignal (Qquit
, Qnil
);
10889 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10894 { /* Else request quit when it's safe. */
10895 if (NILP (Vquit_flag
))
10896 force_quit_count
= 0;
10897 if (++force_quit_count
== 3)
10899 immediate_quit
= 1;
10900 Vinhibit_quit
= Qnil
;
10906 /* TODO: The longjmp in this call throws the NS event loop integration off,
10907 and it seems to do fine without this. Probably some attention
10908 needs to be paid to the setting of waiting_for_input in
10909 wait_reading_process_output() under HAVE_NS because of the call
10910 to ns_select there (needed because otherwise events aren't picked up
10911 outside of polling since we don't get SIGIO like X and we don't have a
10912 separate event loop thread like W32. */
10914 if (waiting_for_input
&& !echoing
)
10915 quit_throw_to_read_char (1);
10919 /* Handle a C-g by making read_char return C-g. */
10922 quit_throw_to_read_char (int from_signal
)
10924 /* When not called from a signal handler it is safe to call
10926 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10927 Fkill_emacs (Qnil
);
10930 /* Prevent another signal from doing this before we finish. */
10931 clear_waiting_for_input ();
10934 Vunread_command_events
= Qnil
;
10935 unread_command_char
= -1;
10937 #if 0 /* Currently, sit_for is called from read_char without turning
10938 off polling. And that can call set_waiting_for_input.
10939 It seems to be harmless. */
10940 #ifdef POLL_FOR_INPUT
10941 /* May be > 1 if in recursive minibuffer. */
10942 if (poll_suppress_count
== 0)
10946 if (FRAMEP (internal_last_event_frame
)
10947 && !EQ (internal_last_event_frame
, selected_frame
))
10948 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10951 _longjmp (getcjmp
, 1);
10954 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10955 Sset_input_interrupt_mode
, 1, 1, 0,
10956 doc
: /* Set interrupt mode of reading keyboard input.
10957 If INTERRUPT is non-nil, Emacs will use input interrupts;
10958 otherwise Emacs uses CBREAK mode.
10960 See also `current-input-mode'. */)
10961 (Lisp_Object interrupt
)
10963 int new_interrupt_input
;
10965 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10966 #ifdef HAVE_X_WINDOWS
10967 if (x_display_list
!= NULL
)
10969 /* When using X, don't give the user a real choice,
10970 because we haven't implemented the mechanisms to support it. */
10971 new_interrupt_input
= 1;
10974 #endif /* HAVE_X_WINDOWS */
10975 new_interrupt_input
= !NILP (interrupt
);
10976 #else /* not SIGIO */
10977 new_interrupt_input
= 0;
10978 #endif /* not SIGIO */
10980 if (new_interrupt_input
!= interrupt_input
)
10982 #ifdef POLL_FOR_INPUT
10986 /* this causes startup screen to be restored and messes with the mouse */
10987 reset_all_sys_modes ();
10988 interrupt_input
= new_interrupt_input
;
10989 init_all_sys_modes ();
10991 interrupt_input
= new_interrupt_input
;
10994 #ifdef POLL_FOR_INPUT
10995 poll_suppress_count
= 1;
11002 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11003 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11004 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11005 C-q in key sequences.
11007 This setting only has an effect on tty terminals and only when
11008 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11010 See also `current-input-mode'. */)
11011 (Lisp_Object flow
, Lisp_Object terminal
)
11013 struct terminal
*t
= get_terminal (terminal
, 1);
11014 struct tty_display_info
*tty
;
11015 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11017 tty
= t
->display_info
.tty
;
11019 if (tty
->flow_control
!= !NILP (flow
))
11022 /* this causes startup screen to be restored and messes with the mouse */
11023 reset_sys_modes (tty
);
11026 tty
->flow_control
= !NILP (flow
);
11029 init_sys_modes (tty
);
11035 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11036 doc
: /* Enable or disable 8-bit input on TERMINAL.
11037 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11038 bit as the Meta modifier.
11040 If META is nil, Emacs will ignore the top bit, on the assumption it is
11043 Otherwise, Emacs will accept and pass through 8-bit input without
11044 specially interpreting the top bit.
11046 This setting only has an effect on tty terminal devices.
11048 Optional parameter TERMINAL specifies the tty terminal device to use.
11049 It may be a terminal object, a frame, or nil for the terminal used by
11050 the currently selected frame.
11052 See also `current-input-mode'. */)
11053 (Lisp_Object meta
, Lisp_Object terminal
)
11055 struct terminal
*t
= get_terminal (terminal
, 1);
11056 struct tty_display_info
*tty
;
11059 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11061 tty
= t
->display_info
.tty
;
11065 else if (EQ (meta
, Qt
))
11070 if (tty
->meta_key
!= new_meta
)
11073 /* this causes startup screen to be restored and messes with the mouse */
11074 reset_sys_modes (tty
);
11077 tty
->meta_key
= new_meta
;
11080 init_sys_modes (tty
);
11086 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11087 doc
: /* Specify character used for quitting.
11088 QUIT must be an ASCII character.
11090 This function only has an effect on the controlling tty of the Emacs
11093 See also `current-input-mode'. */)
11096 struct terminal
*t
= get_named_tty ("/dev/tty");
11097 struct tty_display_info
*tty
;
11098 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11100 tty
= t
->display_info
.tty
;
11102 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11103 error ("QUIT must be an ASCII character");
11106 /* this causes startup screen to be restored and messes with the mouse */
11107 reset_sys_modes (tty
);
11110 /* Don't let this value be out of range. */
11111 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11114 init_sys_modes (tty
);
11120 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11121 doc
: /* Set mode of reading keyboard input.
11122 First arg INTERRUPT non-nil means use input interrupts;
11123 nil means use CBREAK mode.
11124 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11125 (no effect except in CBREAK mode).
11126 Third arg META t means accept 8-bit input (for a Meta key).
11127 META nil means ignore the top bit, on the assumption it is parity.
11128 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11129 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11130 See also `current-input-mode'. */)
11131 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11133 Fset_input_interrupt_mode (interrupt
);
11134 Fset_output_flow_control (flow
, Qnil
);
11135 Fset_input_meta_mode (meta
, Qnil
);
11137 Fset_quit_char (quit
);
11141 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11142 doc
: /* Return information about the way Emacs currently reads keyboard input.
11143 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11144 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11145 nil, Emacs is using CBREAK mode.
11146 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11147 terminal; this does not apply if Emacs uses interrupt-driven input.
11148 META is t if accepting 8-bit input with 8th bit as Meta flag.
11149 META nil means ignoring the top bit, on the assumption it is parity.
11150 META is neither t nor nil if accepting 8-bit input and using
11151 all 8 bits as the character code.
11152 QUIT is the character Emacs currently uses to quit.
11153 The elements of this list correspond to the arguments of
11154 `set-input-mode'. */)
11157 Lisp_Object val
[4];
11158 struct frame
*sf
= XFRAME (selected_frame
);
11160 val
[0] = interrupt_input
? Qt
: Qnil
;
11161 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11163 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11164 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11166 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11173 XSETFASTINT (val
[3], quit_char
);
11175 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11178 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11179 doc
: /* Return position information for pixel coordinates X and Y.
11180 By default, X and Y are relative to text area of the selected window.
11181 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11182 If optional fourth arg WHOLE is non-nil, X is relative to the left
11183 edge of the window.
11185 The return value is similar to a mouse click position:
11186 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11187 IMAGE (DX . DY) (WIDTH . HEIGHT))
11188 The `posn-' functions access elements of such lists. */)
11189 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11194 if (NILP (frame_or_window
))
11195 frame_or_window
= selected_window
;
11197 if (WINDOWP (frame_or_window
))
11201 CHECK_LIVE_WINDOW (frame_or_window
);
11203 w
= XWINDOW (frame_or_window
);
11204 XSETINT (x
, (XINT (x
)
11205 + WINDOW_LEFT_EDGE_X (w
)
11207 ? window_box_left_offset (w
, TEXT_AREA
)
11209 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11210 frame_or_window
= w
->frame
;
11213 CHECK_LIVE_FRAME (frame_or_window
);
11215 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11218 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11219 doc
: /* Return position information for buffer POS in WINDOW.
11220 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11222 Return nil if position is not visible in window. Otherwise,
11223 the return value is similar to that returned by `event-start' for
11224 a mouse click at the upper left corner of the glyph corresponding
11225 to the given buffer position:
11226 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11227 IMAGE (DX . DY) (WIDTH . HEIGHT))
11228 The `posn-' functions access elements of such lists. */)
11229 (Lisp_Object pos
, Lisp_Object window
)
11234 window
= selected_window
;
11236 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11239 Lisp_Object x
= XCAR (tem
);
11240 Lisp_Object y
= XCAR (XCDR (tem
));
11242 /* Point invisible due to hscrolling? */
11245 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11253 * Set up a new kboard object with reasonable initial values.
11256 init_kboard (KBOARD
*kb
)
11258 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11259 KVAR (kb
, Vlast_command
) = Qnil
;
11260 KVAR (kb
, Vreal_last_command
) = Qnil
;
11261 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11262 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11263 KVAR (kb
, Vprefix_arg
) = Qnil
;
11264 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11265 KVAR (kb
, kbd_queue
) = Qnil
;
11266 kb
->kbd_queue_has_data
= 0;
11267 kb
->immediate_echo
= 0;
11268 KVAR (kb
, echo_string
) = Qnil
;
11269 kb
->echo_after_prompt
= -1;
11270 kb
->kbd_macro_buffer
= 0;
11271 kb
->kbd_macro_bufsize
= 0;
11272 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11273 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11274 kb
->reference_count
= 0;
11275 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11276 KVAR (kb
, system_key_syms
) = Qnil
;
11277 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11278 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11279 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11280 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11281 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11285 * Destroy the contents of a kboard object, but not the object itself.
11286 * We use this just before deleting it, or if we're going to initialize
11287 * it a second time.
11290 wipe_kboard (KBOARD
*kb
)
11292 xfree (kb
->kbd_macro_buffer
);
11295 /* Free KB and memory referenced from it. */
11298 delete_kboard (KBOARD
*kb
)
11302 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11305 *kbp
= kb
->next_kboard
;
11307 /* Prevent a dangling reference to KB. */
11308 if (kb
== current_kboard
11309 && FRAMEP (selected_frame
)
11310 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11312 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11314 if (current_kboard
== kb
)
11323 init_keyboard (void)
11325 /* This is correct before outermost invocation of the editor loop */
11326 command_loop_level
= -1;
11327 immediate_quit
= 0;
11328 quit_char
= Ctl ('g');
11329 Vunread_command_events
= Qnil
;
11330 unread_command_char
= -1;
11331 timer_idleness_start_time
= invalid_emacs_time ();
11333 recent_keys_index
= 0;
11334 kbd_fetch_ptr
= kbd_buffer
;
11335 kbd_store_ptr
= kbd_buffer
;
11336 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11337 do_mouse_tracking
= Qnil
;
11340 interrupt_input_blocked
= 0;
11341 interrupt_input_pending
= 0;
11343 pending_signals
= 0;
11346 /* This means that command_loop_1 won't try to select anything the first
11348 internal_last_event_frame
= Qnil
;
11349 Vlast_event_frame
= internal_last_event_frame
;
11351 current_kboard
= initial_kboard
;
11352 /* Re-initialize the keyboard again. */
11353 wipe_kboard (current_kboard
);
11354 init_kboard (current_kboard
);
11355 /* A value of nil for Vwindow_system normally means a tty, but we also use
11356 it for the initial terminal since there is no window system there. */
11357 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11359 if (!noninteractive
)
11361 /* Before multi-tty support, these handlers used to be installed
11362 only if the current session was a tty session. Now an Emacs
11363 session may have multiple display types, so we always handle
11364 SIGINT. There is special code in interrupt_signal to exit
11365 Emacs on SIGINT when there are no termcap frames on the
11366 controlling terminal. */
11367 signal (SIGINT
, interrupt_signal
);
11369 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11370 SIGQUIT and we can't tell which one it will give us. */
11371 signal (SIGQUIT
, interrupt_signal
);
11372 #endif /* not DOS_NT */
11374 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11376 if (!noninteractive
)
11377 signal (SIGIO
, input_available_signal
);
11380 /* Use interrupt input by default, if it works and noninterrupt input
11381 has deficiencies. */
11383 #ifdef INTERRUPT_INPUT
11384 interrupt_input
= 1;
11386 interrupt_input
= 0;
11392 if (keyboard_init_hook
)
11393 (*keyboard_init_hook
) ();
11395 #ifdef POLL_FOR_INPUT
11397 poll_suppress_count
= 1;
11402 /* This type's only use is in syms_of_keyboard, to initialize the
11403 event header symbols and put properties on them. */
11404 struct event_head
{
11410 static const struct event_head head_table
[] = {
11411 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11412 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11413 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11414 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11415 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11416 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11417 /* `select-window' should be handled just like `switch-frame'
11418 in read_key_sequence. */
11419 {&Qselect_window
, "select-window", &Qswitch_frame
}
11423 syms_of_keyboard (void)
11425 pending_funcalls
= Qnil
;
11426 staticpro (&pending_funcalls
);
11428 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11429 staticpro (&Vlispy_mouse_stem
);
11432 DEFSYM (QCimage
, ":image");
11433 DEFSYM (Qhelp_echo
, "help-echo");
11434 DEFSYM (QCrtl
, ":rtl");
11436 staticpro (&item_properties
);
11437 item_properties
= Qnil
;
11439 staticpro (&tool_bar_item_properties
);
11440 tool_bar_item_properties
= Qnil
;
11441 staticpro (&tool_bar_items_vector
);
11442 tool_bar_items_vector
= Qnil
;
11444 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11445 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11446 DEFSYM (Qself_insert_command
, "self-insert-command");
11447 DEFSYM (Qforward_char
, "forward-char");
11448 DEFSYM (Qbackward_char
, "backward-char");
11449 DEFSYM (Qdisabled
, "disabled");
11450 DEFSYM (Qundefined
, "undefined");
11451 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11452 DEFSYM (Qpost_command_hook
, "post-command-hook");
11453 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11454 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11455 DEFSYM (Qfunction_key
, "function-key");
11456 DEFSYM (Qmouse_click
, "mouse-click");
11457 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11458 DEFSYM (Qsave_session
, "save-session");
11459 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11460 DEFSYM (Qmenu_enable
, "menu-enable");
11462 #if defined (WINDOWSNT)
11463 DEFSYM (Qlanguage_change
, "language-change");
11467 DEFSYM (Qdbus_event
, "dbus-event");
11470 DEFSYM (QCenable
, ":enable");
11471 DEFSYM (QCvisible
, ":visible");
11472 DEFSYM (QChelp
, ":help");
11473 DEFSYM (QCfilter
, ":filter");
11474 DEFSYM (QCbutton
, ":button");
11475 DEFSYM (QCkeys
, ":keys");
11476 DEFSYM (QCkey_sequence
, ":key-sequence");
11477 DEFSYM (QCtoggle
, ":toggle");
11478 DEFSYM (QCradio
, ":radio");
11479 DEFSYM (QClabel
, ":label");
11480 DEFSYM (QCvert_only
, ":vert-only");
11482 DEFSYM (Qmode_line
, "mode-line");
11483 DEFSYM (Qvertical_line
, "vertical-line");
11484 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11485 DEFSYM (Qmenu_bar
, "menu-bar");
11487 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11488 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11491 DEFSYM (Qabove_handle
, "above-handle");
11492 DEFSYM (Qhandle
, "handle");
11493 DEFSYM (Qbelow_handle
, "below-handle");
11494 DEFSYM (Qup
, "up");
11495 DEFSYM (Qdown
, "down");
11496 DEFSYM (Qtop
, "top");
11497 DEFSYM (Qbottom
, "bottom");
11498 DEFSYM (Qend_scroll
, "end-scroll");
11499 DEFSYM (Qratio
, "ratio");
11501 DEFSYM (Qevent_kind
, "event-kind");
11502 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11503 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11504 DEFSYM (Qmodifier_cache
, "modifier-cache");
11506 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11507 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11509 DEFSYM (Qpolling_period
, "polling-period");
11511 DEFSYM (Qx_set_selection
, "x-set-selection");
11512 DEFSYM (QPRIMARY
, "PRIMARY");
11513 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11514 DEFSYM (Qhandle_select_window
, "handle-select-window");
11516 DEFSYM (Qinput_method_function
, "input-method-function");
11517 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11518 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11520 DEFSYM (Qhelp_form_show
, "help-form-show");
11522 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11523 Fset (Qinput_method_use_echo_area
, Qnil
);
11525 last_point_position_buffer
= Qnil
;
11526 last_point_position_window
= Qnil
;
11530 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11532 for (i
= 0; i
< len
; i
++)
11534 const struct event_head
*p
= &head_table
[i
];
11535 *p
->var
= intern_c_string (p
->name
);
11536 staticpro (p
->var
);
11537 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11538 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11542 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11543 staticpro (&button_down_location
);
11544 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11545 staticpro (&mouse_syms
);
11546 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11547 / sizeof (lispy_wheel_names
[0])),
11549 staticpro (&wheel_syms
);
11553 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11555 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11556 for (i
= 0; i
< len
; i
++)
11557 if (modifier_names
[i
])
11558 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11559 staticpro (&modifier_symbols
);
11562 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11563 staticpro (&recent_keys
);
11565 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11566 staticpro (&this_command_keys
);
11568 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11569 staticpro (&raw_keybuf
);
11571 DEFSYM (Qextended_command_history
, "extended-command-history");
11572 Fset (Qextended_command_history
, Qnil
);
11574 accent_key_syms
= Qnil
;
11575 staticpro (&accent_key_syms
);
11577 func_key_syms
= Qnil
;
11578 staticpro (&func_key_syms
);
11580 drag_n_drop_syms
= Qnil
;
11581 staticpro (&drag_n_drop_syms
);
11583 unread_switch_frame
= Qnil
;
11584 staticpro (&unread_switch_frame
);
11586 internal_last_event_frame
= Qnil
;
11587 staticpro (&internal_last_event_frame
);
11589 read_key_sequence_cmd
= Qnil
;
11590 staticpro (&read_key_sequence_cmd
);
11591 read_key_sequence_remapped
= Qnil
;
11592 staticpro (&read_key_sequence_remapped
);
11594 menu_bar_one_keymap_changed_items
= Qnil
;
11595 staticpro (&menu_bar_one_keymap_changed_items
);
11597 menu_bar_items_vector
= Qnil
;
11598 staticpro (&menu_bar_items_vector
);
11600 help_form_saved_window_configs
= Qnil
;
11601 staticpro (&help_form_saved_window_configs
);
11603 defsubr (&Scurrent_idle_time
);
11604 defsubr (&Sevent_symbol_parse_modifiers
);
11605 defsubr (&Sevent_convert_list
);
11606 defsubr (&Sread_key_sequence
);
11607 defsubr (&Sread_key_sequence_vector
);
11608 defsubr (&Srecursive_edit
);
11609 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11610 defsubr (&Strack_mouse
);
11612 defsubr (&Sinput_pending_p
);
11613 defsubr (&Scommand_execute
);
11614 defsubr (&Srecent_keys
);
11615 defsubr (&Sthis_command_keys
);
11616 defsubr (&Sthis_command_keys_vector
);
11617 defsubr (&Sthis_single_command_keys
);
11618 defsubr (&Sthis_single_command_raw_keys
);
11619 defsubr (&Sreset_this_command_lengths
);
11620 defsubr (&Sclear_this_command_keys
);
11621 defsubr (&Ssuspend_emacs
);
11622 defsubr (&Sabort_recursive_edit
);
11623 defsubr (&Sexit_recursive_edit
);
11624 defsubr (&Srecursion_depth
);
11625 defsubr (&Stop_level
);
11626 defsubr (&Sdiscard_input
);
11627 defsubr (&Sopen_dribble_file
);
11628 defsubr (&Sset_input_interrupt_mode
);
11629 defsubr (&Sset_output_flow_control
);
11630 defsubr (&Sset_input_meta_mode
);
11631 defsubr (&Sset_quit_char
);
11632 defsubr (&Sset_input_mode
);
11633 defsubr (&Scurrent_input_mode
);
11634 defsubr (&Sposn_at_point
);
11635 defsubr (&Sposn_at_x_y
);
11637 DEFVAR_LISP ("last-command-event", last_command_event
,
11638 doc
: /* Last input event that was part of a command. */);
11640 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11641 doc
: /* Last input event in a command, except for mouse menu events.
11642 Mouse menus give back keys that don't look like mouse events;
11643 this variable holds the actual mouse event that led to the menu,
11644 so that you can determine whether the command was run by mouse or not. */);
11646 DEFVAR_LISP ("last-input-event", last_input_event
,
11647 doc
: /* Last input event. */);
11649 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11650 doc
: /* List of events to be read as the command input.
11651 These events are processed first, before actual keyboard input.
11652 Events read from this list are not normally added to `this-command-keys',
11653 as they will already have been added once as they were read for the first time.
11654 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11655 Vunread_command_events
= Qnil
;
11657 DEFVAR_INT ("unread-command-char", unread_command_char
,
11658 doc
: /* If not -1, an object to be read as next command input event. */);
11660 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11661 doc
: /* List of events to be processed as input by input methods.
11662 These events are processed before `unread-command-events'
11663 and actual keyboard input, but are not given to `input-method-function'. */);
11664 Vunread_post_input_method_events
= Qnil
;
11666 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11667 doc
: /* List of events to be processed as input by input methods.
11668 These events are processed after `unread-command-events', but
11669 before actual keyboard input.
11670 If there's an active input method, the events are given to
11671 `input-method-function'. */);
11672 Vunread_input_method_events
= Qnil
;
11674 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11675 doc
: /* Meta-prefix character code.
11676 Meta-foo as command input turns into this character followed by foo. */);
11677 XSETINT (meta_prefix_char
, 033);
11679 DEFVAR_KBOARD ("last-command", Vlast_command
,
11680 doc
: /* The last command executed.
11681 Normally a symbol with a function definition, but can be whatever was found
11682 in the keymap, or whatever the variable `this-command' was set to by that
11685 The value `mode-exit' is special; it means that the previous command
11686 read an event that told it to exit, and it did so and unread that event.
11687 In other words, the present command is the event that made the previous
11690 The value `kill-region' is special; it means that the previous command
11691 was a kill command.
11693 `last-command' has a separate binding for each terminal device.
11694 See Info node `(elisp)Multiple Terminals'. */);
11696 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11697 doc
: /* Same as `last-command', but never altered by Lisp code.
11698 Taken from the previous value of `real-this-command'. */);
11700 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11701 doc
: /* Last command that may be repeated.
11702 The last command executed that was not bound to an input event.
11703 This is the command `repeat' will try to repeat.
11704 Taken from a previous value of `real-this-command'. */);
11706 DEFVAR_LISP ("this-command", Vthis_command
,
11707 doc
: /* The command now being executed.
11708 The command can set this variable; whatever is put here
11709 will be in `last-command' during the following command. */);
11710 Vthis_command
= Qnil
;
11712 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11713 doc
: /* This is like `this-command', except that commands should never modify it. */);
11714 Vreal_this_command
= Qnil
;
11716 DEFVAR_LISP ("this-command-keys-shift-translated",
11717 Vthis_command_keys_shift_translated
,
11718 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11719 Shift-translation occurs when there is no binding for the key sequence
11720 as entered, but a binding was found by changing an upper-case letter
11721 to lower-case, or a shifted function key to an unshifted one. */);
11722 Vthis_command_keys_shift_translated
= Qnil
;
11724 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11725 doc
: /* The command bound to the current key sequence before remapping.
11726 It equals `this-command' if the original command was not remapped through
11727 any of the active keymaps. Otherwise, the value of `this-command' is the
11728 result of looking up the original command in the active keymaps. */);
11729 Vthis_original_command
= Qnil
;
11731 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11732 doc
: /* Number of input events between auto-saves.
11733 Zero means disable autosaving due to number of characters typed. */);
11734 auto_save_interval
= 300;
11736 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11737 doc
: /* Number of seconds idle time before auto-save.
11738 Zero or nil means disable auto-saving due to idleness.
11739 After auto-saving due to this many seconds of idle time,
11740 Emacs also does a garbage collection if that seems to be warranted. */);
11741 XSETFASTINT (Vauto_save_timeout
, 30);
11743 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11744 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11745 The value may be integer or floating point.
11746 If the value is zero, don't echo at all. */);
11747 Vecho_keystrokes
= make_number (1);
11749 DEFVAR_INT ("polling-period", polling_period
,
11750 doc
: /* Interval between polling for input during Lisp execution.
11751 The reason for polling is to make C-g work to stop a running program.
11752 Polling is needed only when using X windows and SIGIO does not work.
11753 Polling is automatically disabled in all other cases. */);
11754 polling_period
= 2;
11756 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11757 doc
: /* Maximum time between mouse clicks to make a double-click.
11758 Measured in milliseconds. The value nil means disable double-click
11759 recognition; t means double-clicks have no time limit and are detected
11760 by position only. */);
11761 Vdouble_click_time
= make_number (500);
11763 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11764 doc
: /* Maximum mouse movement between clicks to make a double-click.
11765 On window-system frames, value is the number of pixels the mouse may have
11766 moved horizontally or vertically between two clicks to make a double-click.
11767 On non window-system frames, value is interpreted in units of 1/8 characters
11770 This variable is also the threshold for motion of the mouse
11771 to count as a drag. */);
11772 double_click_fuzz
= 3;
11774 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11775 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11776 inhibit_local_menu_bar_menus
= 0;
11778 DEFVAR_INT ("num-input-keys", num_input_keys
,
11779 doc
: /* Number of complete key sequences read as input so far.
11780 This includes key sequences read from keyboard macros.
11781 The number is effectively the number of interactive command invocations. */);
11782 num_input_keys
= 0;
11784 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11785 doc
: /* Number of input events read from the keyboard so far.
11786 This does not include events generated by keyboard macros. */);
11787 num_nonmacro_input_events
= 0;
11789 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11790 doc
: /* The frame in which the most recently read event occurred.
11791 If the last event came from a keyboard macro, this is set to `macro'. */);
11792 Vlast_event_frame
= Qnil
;
11794 /* This variable is set up in sysdep.c. */
11795 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11796 doc
: /* The ERASE character as set by the user with stty. */);
11798 DEFVAR_LISP ("help-char", Vhelp_char
,
11799 doc
: /* Character to recognize as meaning Help.
11800 When it is read, do `(eval help-form)', and display result if it's a string.
11801 If the value of `help-form' is nil, this char can be read normally. */);
11802 XSETINT (Vhelp_char
, Ctl ('H'));
11804 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11805 doc
: /* List of input events to recognize as meaning Help.
11806 These work just like the value of `help-char' (see that). */);
11807 Vhelp_event_list
= Qnil
;
11809 DEFVAR_LISP ("help-form", Vhelp_form
,
11810 doc
: /* Form to execute when character `help-char' is read.
11811 If the form returns a string, that string is displayed.
11812 If `help-form' is nil, the help char is not recognized. */);
11815 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11816 doc
: /* Command to run when `help-char' character follows a prefix key.
11817 This command is used only when there is no actual binding
11818 for that character after that prefix key. */);
11819 Vprefix_help_command
= Qnil
;
11821 DEFVAR_LISP ("top-level", Vtop_level
,
11822 doc
: /* Form to evaluate when Emacs starts up.
11823 Useful to set before you dump a modified Emacs. */);
11826 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11827 doc
: /* Translate table for local keyboard input, or nil.
11828 If non-nil, the value should be a char-table. Each character read
11829 from the keyboard is looked up in this char-table. If the value found
11830 there is non-nil, then it is used instead of the actual input character.
11832 The value can also be a string or vector, but this is considered obsolete.
11833 If it is a string or vector of length N, character codes N and up are left
11834 untranslated. In a vector, an element which is nil means "no translation".
11836 This is applied to the characters supplied to input methods, not their
11837 output. See also `translation-table-for-input'.
11839 This variable has a separate binding for each terminal.
11840 See Info node `(elisp)Multiple Terminals'. */);
11842 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11843 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11844 \(Even if the operating system has support for stopping a process.\) */);
11845 cannot_suspend
= 0;
11847 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11848 doc
: /* Non-nil means prompt with menus when appropriate.
11849 This is done when reading from a keymap that has a prompt string,
11850 for elements that have prompt strings.
11851 The menu is displayed on the screen
11852 if X menus were enabled at configuration
11853 time and the previous event was a mouse click prefix key.
11854 Otherwise, menu prompting uses the echo area. */);
11855 menu_prompting
= 1;
11857 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11858 doc
: /* Character to see next line of menu prompt.
11859 Type this character while in a menu prompt to rotate around the lines of it. */);
11860 XSETINT (menu_prompt_more_char
, ' ');
11862 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11863 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11864 Emacs applies the modifiers of the character stored here to each keyboard
11865 character it reads. For example, after evaluating the expression
11866 (setq extra-keyboard-modifiers ?\\C-x)
11867 all input characters will have the control modifier applied to them.
11869 Note that the character ?\\C-@, equivalent to the integer zero, does
11870 not count as a control character; rather, it counts as a character
11871 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11872 cancels any modification. */);
11873 extra_keyboard_modifiers
= 0;
11875 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11876 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11877 The command loop sets this to nil before each command,
11878 and tests the value when the command returns.
11879 Buffer modification stores t in this variable. */);
11880 Vdeactivate_mark
= Qnil
;
11881 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11883 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11884 doc
: /* Normal hook run before each command is executed.
11885 If an unhandled error happens in running this hook,
11886 the function in which the error occurred is unconditionally removed, since
11887 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11888 Vpre_command_hook
= Qnil
;
11890 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11891 doc
: /* Normal hook run after each command is executed.
11892 If an unhandled error happens in running this hook,
11893 the function in which the error occurred is unconditionally removed, since
11894 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11895 Vpost_command_hook
= Qnil
;
11898 DEFVAR_LISP ("echo-area-clear-hook", ...,
11899 doc
: /* Normal hook run when clearing the echo area. */);
11901 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11902 Fset (Qecho_area_clear_hook
, Qnil
);
11904 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11905 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11906 Vlucid_menu_bar_dirty_flag
= Qnil
;
11908 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11909 doc
: /* List of menu bar items to move to the end of the menu bar.
11910 The elements of the list are event types that may have menu bar bindings. */);
11911 Vmenu_bar_final_items
= Qnil
;
11913 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11914 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11915 This is used internally by graphical displays that do not render
11916 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11917 Vtool_bar_separator_image_expression
= Qnil
;
11919 DEFVAR_KBOARD ("overriding-terminal-local-map",
11920 Voverriding_terminal_local_map
,
11921 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11922 If this variable is non-nil, it is used as a keymap instead of the
11923 buffer's local map, and the minor mode keymaps and text property keymaps.
11924 It also replaces `overriding-local-map'.
11926 This variable is intended to let commands such as `universal-argument'
11927 set up a different keymap for reading the next command.
11929 `overriding-terminal-local-map' has a separate binding for each
11931 See Info node `(elisp)Multiple Terminals'. */);
11933 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11934 doc
: /* Keymap that overrides all other local keymaps.
11935 If this variable is non-nil, it is used as a keymap--replacing the
11936 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11937 Voverriding_local_map
= Qnil
;
11939 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11940 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11941 Otherwise, the menu bar continues to reflect the buffer's local map
11942 and the minor mode maps regardless of `overriding-local-map'. */);
11943 Voverriding_local_map_menu_flag
= Qnil
;
11945 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11946 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11947 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11949 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11950 doc
: /* Non-nil means generate motion events for mouse motion. */);
11952 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11953 doc
: /* Alist of system-specific X windows key symbols.
11954 Each element should have the form (N . SYMBOL) where N is the
11955 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11956 and SYMBOL is its name.
11958 `system-key-alist' has a separate binding for each terminal device.
11959 See Info node `(elisp)Multiple Terminals'. */);
11961 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11962 doc
: /* Keymap that translates key sequences to key sequences during input.
11963 This is used mainly for mapping key sequences into some preferred
11964 key events (symbols).
11966 The `read-key-sequence' function replaces any subsequence bound by
11967 `local-function-key-map' with its binding. More precisely, when the
11968 active keymaps have no binding for the current key sequence but
11969 `local-function-key-map' binds a suffix of the sequence to a vector or
11970 string, `read-key-sequence' replaces the matching suffix with its
11971 binding, and continues with the new sequence.
11973 If the binding is a function, it is called with one argument (the prompt)
11974 and its return value (a key sequence) is used.
11976 The events that come from bindings in `local-function-key-map' are not
11977 themselves looked up in `local-function-key-map'.
11979 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11980 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11981 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11982 typing `ESC O P x' would return [f1 x].
11984 `local-function-key-map' has a separate binding for each terminal
11985 device. See Info node `(elisp)Multiple Terminals'. If you need to
11986 define a binding on all terminals, change `function-key-map'
11987 instead. Initially, `local-function-key-map' is an empty keymap that
11988 has `function-key-map' as its parent on all terminal devices. */);
11990 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11991 doc
: /* Keymap that decodes input escape sequences.
11992 This is used mainly for mapping ASCII function key sequences into
11993 real Emacs function key events (symbols).
11995 The `read-key-sequence' function replaces any subsequence bound by
11996 `input-decode-map' with its binding. Contrary to `function-key-map',
11997 this map applies its rebinding regardless of the presence of an ordinary
11998 binding. So it is more like `key-translation-map' except that it applies
11999 before `function-key-map' rather than after.
12001 If the binding is a function, it is called with one argument (the prompt)
12002 and its return value (a key sequence) is used.
12004 The events that come from bindings in `input-decode-map' are not
12005 themselves looked up in `input-decode-map'.
12007 This variable is keyboard-local. */);
12009 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12010 doc
: /* The parent keymap of all `local-function-key-map' instances.
12011 Function key definitions that apply to all terminal devices should go
12012 here. If a mapping is defined in both the current
12013 `local-function-key-map' binding and this variable, then the local
12014 definition will take precedence. */);
12015 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12017 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12018 doc
: /* Keymap of key translations that can override keymaps.
12019 This keymap works like `function-key-map', but comes after that,
12020 and its non-prefix bindings override ordinary bindings.
12021 Another difference is that it is global rather than keyboard-local. */);
12022 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12024 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12025 doc
: /* List of deferred actions to be performed at a later time.
12026 The precise format isn't relevant here; we just check whether it is nil. */);
12027 Vdeferred_action_list
= Qnil
;
12029 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12030 doc
: /* Function to call to handle deferred actions, after each command.
12031 This function is called with no arguments after each command
12032 whenever `deferred-action-list' is non-nil. */);
12033 Vdeferred_action_function
= Qnil
;
12035 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12036 doc
: /* List of warnings to be displayed after this command.
12037 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12038 as per the args of `display-warning' (which see).
12039 If this variable is non-nil, `delayed-warnings-hook' will be run
12040 immediately after running `post-command-hook'. */);
12041 Vdelayed_warnings_list
= Qnil
;
12043 DEFVAR_LISP ("timer-list", Vtimer_list
,
12044 doc
: /* List of active absolute time timers in order of increasing time. */);
12045 Vtimer_list
= Qnil
;
12047 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12048 doc
: /* List of active idle-time timers in order of increasing time. */);
12049 Vtimer_idle_list
= Qnil
;
12051 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12052 doc
: /* If non-nil, the function that implements the current input method.
12053 It's called with one argument, a printing character that was just read.
12054 \(That means a character with code 040...0176.)
12055 Typically this function uses `read-event' to read additional events.
12056 When it does so, it should first bind `input-method-function' to nil
12057 so it will not be called recursively.
12059 The function should return a list of zero or more events
12060 to be used as input. If it wants to put back some events
12061 to be reconsidered, separately, by the input method,
12062 it can add them to the beginning of `unread-command-events'.
12064 The input method function can find in `input-method-previous-message'
12065 the previous echo area message.
12067 The input method function should refer to the variables
12068 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12069 for guidance on what to do. */);
12070 Vinput_method_function
= Qnil
;
12072 DEFVAR_LISP ("input-method-previous-message",
12073 Vinput_method_previous_message
,
12074 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12075 This variable exists because `read-event' clears the echo area
12076 before running the input method. It is nil if there was no message. */);
12077 Vinput_method_previous_message
= Qnil
;
12079 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12080 doc
: /* If non-nil, the function that implements the display of help.
12081 It's called with one argument, the help string to display. */);
12082 Vshow_help_function
= Qnil
;
12084 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12085 doc
: /* If non-nil, suppress point adjustment after executing a command.
12087 After a command is executed, if point is moved into a region that has
12088 special properties (e.g. composition, display), we adjust point to
12089 the boundary of the region. But, when a command sets this variable to
12090 non-nil, we suppress the point adjustment.
12092 This variable is set to nil before reading a command, and is checked
12093 just after executing the command. */);
12094 Vdisable_point_adjustment
= Qnil
;
12096 DEFVAR_LISP ("global-disable-point-adjustment",
12097 Vglobal_disable_point_adjustment
,
12098 doc
: /* If non-nil, always suppress point adjustment.
12100 The default value is nil, in which case, point adjustment are
12101 suppressed only after special commands that set
12102 `disable-point-adjustment' (which see) to non-nil. */);
12103 Vglobal_disable_point_adjustment
= Qnil
;
12105 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12106 doc
: /* How long to display an echo-area message when the minibuffer is active.
12107 If the value is not a number, such messages don't time out. */);
12108 Vminibuffer_message_timeout
= make_number (2);
12110 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12111 doc
: /* If non-nil, any keyboard input throws to this symbol.
12112 The value of that variable is passed to `quit-flag' and later causes a
12113 peculiar kind of quitting. */);
12114 Vthrow_on_input
= Qnil
;
12116 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12117 doc
: /* If non-nil, function to output error messages.
12118 The arguments are the error data, a list of the form
12119 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12120 such as just as `condition-case' would bind its variable to,
12121 the context (a string which normally goes at the start of the message),
12122 and the Lisp function within which the error was signaled. */);
12123 Vcommand_error_function
= Qnil
;
12125 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12126 Venable_disabled_menus_and_buttons
,
12127 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12129 Help functions bind this to allow help on disabled menu items
12130 and tool-bar buttons. */);
12131 Venable_disabled_menus_and_buttons
= Qnil
;
12133 DEFVAR_LISP ("select-active-regions",
12134 Vselect_active_regions
,
12135 doc
: /* If non-nil, an active region automatically sets the primary selection.
12136 If the value is `only', only temporarily active regions (usually made
12137 by mouse-dragging or shift-selection) set the window selection.
12139 This takes effect only when Transient Mark mode is enabled. */);
12140 Vselect_active_regions
= Qt
;
12142 DEFVAR_LISP ("saved-region-selection",
12143 Vsaved_region_selection
,
12144 doc
: /* Contents of active region prior to buffer modification.
12145 If `select-active-regions' is non-nil, Emacs sets this to the
12146 text in the region before modifying the buffer. The next
12147 `deactivate-mark' call uses this to set the window selection. */);
12148 Vsaved_region_selection
= Qnil
;
12150 DEFVAR_LISP ("selection-inhibit-update-commands",
12151 Vselection_inhibit_update_commands
,
12152 doc
: /* List of commands which should not update the selection.
12153 Normally, if `select-active-regions' is non-nil and the mark remains
12154 active after a command (i.e. the mark was not deactivated), the Emacs
12155 command loop sets the selection to the text in the region. However,
12156 if the command is in this list, the selection is not updated. */);
12157 Vselection_inhibit_update_commands
12158 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12160 DEFVAR_LISP ("debug-on-event",
12162 doc
: /* Enter debugger on this event. When Emacs
12163 receives the special event specified by this variable, it will try to
12164 break into the debugger as soon as possible instead of processing the
12165 event normally through `special-event-map'.
12167 Currently, the only supported values for this
12168 variable are `sigusr1' and `sigusr2'. */);
12169 Vdebug_on_event
= intern_c_string ("sigusr2");
12171 /* Create the initial keyboard. */
12172 initial_kboard
= xmalloc (sizeof *initial_kboard
);
12173 init_kboard (initial_kboard
);
12174 /* Vwindow_system is left at t for now. */
12175 initial_kboard
->next_kboard
= all_kboards
;
12176 all_kboards
= initial_kboard
;
12180 keys_of_keyboard (void)
12182 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12183 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12184 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12185 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12186 initial_define_key (meta_map
, 'x', "execute-extended-command");
12188 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12189 "handle-delete-frame");
12190 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12191 "ns-put-working-text");
12192 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12193 "ns-unput-working-text");
12194 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12195 current-prefix-arg, as is done in `handle-switch-frame'.
12196 But `handle-switch-frame is not run from the special-map.
12197 Commands from that map are run in a special way that automatically
12198 preserves the prefix-arg. Restoring the prefix arg here is not just
12199 redundant but harmful:
12201 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12202 - after the first prompt, the exit-minibuffer-hook is run which may
12203 iconify a frame and thus push a `iconify-frame' event.
12204 - after running exit-minibuffer-hook, current-prefix-arg is
12205 restored to the non-nil value it had before the prompt.
12206 - we enter the second prompt.
12207 current-prefix-arg is non-nil, prefix-arg is nil.
12208 - before running the first real event, we run the special iconify-frame
12209 event, but we pass the `special' arg to execute-command so
12210 current-prefix-arg and prefix-arg are left untouched.
12211 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12212 - the next key event will have a spuriously non-nil current-prefix-arg. */
12213 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12215 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12217 /* Handling it at such a low-level causes read_key_sequence to get
12218 * confused because it doesn't realize that the current_buffer was
12219 * changed by read_char.
12221 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12222 * "handle-select-window"); */
12223 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12224 "handle-save-session");
12227 /* Define a special event which is raised for dbus callback
12229 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12230 "dbus-handle-event");
12233 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12235 #if defined (WINDOWSNT)
12236 initial_define_lispy_key (Vspecial_event_map
, "language-change",
12241 /* Mark the pointers in the kboard objects.
12242 Called by Fgarbage_collect. */
12244 mark_kboards (void)
12248 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12250 if (kb
->kbd_macro_buffer
)
12251 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12253 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12254 mark_object (KVAR (kb
, Vlast_command
));
12255 mark_object (KVAR (kb
, Vreal_last_command
));
12256 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12257 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12258 mark_object (KVAR (kb
, Vprefix_arg
));
12259 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12260 mark_object (KVAR (kb
, kbd_queue
));
12261 mark_object (KVAR (kb
, defining_kbd_macro
));
12262 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12263 mark_object (KVAR (kb
, Vsystem_key_alist
));
12264 mark_object (KVAR (kb
, system_key_syms
));
12265 mark_object (KVAR (kb
, Vwindow_system
));
12266 mark_object (KVAR (kb
, Vinput_decode_map
));
12267 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12268 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12269 mark_object (KVAR (kb
, echo_string
));
12272 struct input_event
*event
;
12273 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12275 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12276 event
= kbd_buffer
;
12277 if (event
->kind
!= SELECTION_REQUEST_EVENT
12278 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12280 mark_object (event
->x
);
12281 mark_object (event
->y
);
12283 mark_object (event
->frame_or_window
);
12284 mark_object (event
->arg
);