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 (WVAR (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 (WVAR (XWINDOW (selected_window
), buffer
)) != current_buffer
)
1386 set_buffer_internal (XBUFFER (WVAR (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 (WVAR (XWINDOW (selected_window
), buffer
)) != current_buffer
)
1456 set_buffer_internal (XBUFFER (WVAR (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 (WVAR (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
))
2188 help
= safe_call (4, help
, window
, object
, pos
);
2190 help
= safe_eval (help
);
2192 if (!STRINGP (help
))
2196 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2197 if (!noninteractive
&& STRINGP (help
))
2199 /* The mouse-fixup-help-message Lisp function can call
2200 mouse_position_hook, which resets the mouse_moved flags.
2201 This causes trouble if we are trying to read a mouse motion
2202 event (i.e., if we are inside a `track-mouse' form), so we
2203 restore the mouse_moved flag. */
2204 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2205 help
= call1 (Qmouse_fixup_help_message
, help
);
2211 if (STRINGP (help
) || NILP (help
))
2213 if (!NILP (Vshow_help_function
))
2214 call1 (Vshow_help_function
, help
);
2215 help_echo_showing_p
= STRINGP (help
);
2221 /* Input of single characters from keyboard */
2223 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2224 EMACS_TIME
*end_time
);
2225 static void record_char (Lisp_Object c
);
2227 static Lisp_Object help_form_saved_window_configs
;
2229 read_char_help_form_unwind (Lisp_Object arg
)
2231 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2232 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2233 if (!NILP (window_config
))
2234 Fset_window_configuration (window_config
);
2238 #define STOP_POLLING \
2239 do { if (! polling_stopped_here) stop_polling (); \
2240 polling_stopped_here = 1; } while (0)
2242 #define RESUME_POLLING \
2243 do { if (polling_stopped_here) start_polling (); \
2244 polling_stopped_here = 0; } while (0)
2246 /* read a character from the keyboard; call the redisplay if needed */
2247 /* commandflag 0 means do not autosave, but do redisplay.
2248 -1 means do not redisplay, but do autosave.
2251 /* The arguments MAPS and NMAPS are for menu prompting.
2252 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2254 PREV_EVENT is the previous input event, or nil if we are reading
2255 the first event of a key sequence (or not reading a key sequence).
2256 If PREV_EVENT is t, that is a "magic" value that says
2257 not to run input methods, but in other respects to act as if
2258 not reading a key sequence.
2260 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2261 if we used a mouse menu to read the input, or zero otherwise. If
2262 USED_MOUSE_MENU is null, we don't dereference it.
2264 Value is -2 when we find input on another keyboard. A second call
2265 to read_char will read it.
2267 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2268 specifying the maximum time to wait until. If no input arrives by
2269 that time, stop waiting and return nil.
2271 Value is t if we showed a menu and the user rejected it. */
2274 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2275 Lisp_Object prev_event
,
2276 int *used_mouse_menu
, EMACS_TIME
*end_time
)
2278 volatile Lisp_Object c
;
2280 jmp_buf local_getcjmp
;
2282 volatile int key_already_recorded
= 0;
2283 Lisp_Object tem
, save
;
2284 volatile Lisp_Object previous_echo_area_message
;
2285 volatile Lisp_Object also_record
;
2286 volatile int reread
;
2287 struct gcpro gcpro1
, gcpro2
;
2288 int volatile polling_stopped_here
= 0;
2289 struct kboard
*orig_kboard
= current_kboard
;
2293 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2294 before_command_key_count
= this_command_key_count
;
2295 before_command_echo_length
= echo_length ();
2298 previous_echo_area_message
= Qnil
;
2300 GCPRO2 (c
, previous_echo_area_message
);
2305 if (CONSP (Vunread_post_input_method_events
))
2307 c
= XCAR (Vunread_post_input_method_events
);
2308 Vunread_post_input_method_events
2309 = XCDR (Vunread_post_input_method_events
);
2311 /* Undo what read_char_x_menu_prompt did when it unread
2312 additional keys returned by Fx_popup_menu. */
2314 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2322 if (unread_command_char
!= -1)
2324 XSETINT (c
, unread_command_char
);
2325 unread_command_char
= -1;
2331 if (CONSP (Vunread_command_events
))
2333 int was_disabled
= 0;
2335 c
= XCAR (Vunread_command_events
);
2336 Vunread_command_events
= XCDR (Vunread_command_events
);
2340 /* Undo what sit-for did when it unread additional keys
2341 inside universal-argument. */
2344 && EQ (XCAR (c
), Qt
))
2350 /* Undo what read_char_x_menu_prompt did when it unread
2351 additional keys returned by Fx_popup_menu. */
2353 && EQ (XCDR (c
), Qdisabled
)
2354 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2360 /* If the queued event is something that used the mouse,
2361 set used_mouse_menu accordingly. */
2363 /* Also check was_disabled so last-nonmenu-event won't return
2364 a bad value when submenus are involved. (Bug#447) */
2365 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2366 *used_mouse_menu
= 1;
2368 goto reread_for_input_method
;
2371 if (CONSP (Vunread_input_method_events
))
2373 c
= XCAR (Vunread_input_method_events
);
2374 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2376 /* Undo what read_char_x_menu_prompt did when it unread
2377 additional keys returned by Fx_popup_menu. */
2379 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2383 goto reread_for_input_method
;
2386 this_command_key_count_reset
= 0;
2388 if (!NILP (Vexecuting_kbd_macro
))
2390 /* We set this to Qmacro; since that's not a frame, nobody will
2391 try to switch frames on us, and the selected window will
2394 Since this event came from a macro, it would be misleading to
2395 leave internal_last_event_frame set to wherever the last
2396 real event came from. Normally, a switch-frame event selects
2397 internal_last_event_frame after each command is read, but
2398 events read from a macro should never cause a new frame to be
2400 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2402 /* Exit the macro if we are at the end.
2403 Also, some things replace the macro with t
2404 to force an early exit. */
2405 if (EQ (Vexecuting_kbd_macro
, Qt
)
2406 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2412 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2413 if (STRINGP (Vexecuting_kbd_macro
)
2414 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2415 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2417 executing_kbd_macro_index
++;
2422 if (!NILP (unread_switch_frame
))
2424 c
= unread_switch_frame
;
2425 unread_switch_frame
= Qnil
;
2427 /* This event should make it into this_command_keys, and get echoed
2428 again, so we do not set `reread'. */
2432 /* if redisplay was requested */
2433 if (commandflag
>= 0)
2435 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2437 /* If there is pending input, process any events which are not
2438 user-visible, such as X selection_request events. */
2440 || detect_input_pending_run_timers (0))
2441 swallow_events (0); /* may clear input_pending */
2443 /* Redisplay if no pending input. */
2444 while (!input_pending
)
2446 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2447 redisplay_preserve_echo_area (5);
2452 /* Normal case: no input arrived during redisplay. */
2455 /* Input arrived and pre-empted redisplay.
2456 Process any events which are not user-visible. */
2458 /* If that cleared input_pending, try again to redisplay. */
2461 /* Prevent the redisplay we just did
2462 from messing up echoing of the input after the prompt. */
2463 if (commandflag
== 0 && echo_current
)
2464 echo_message_buffer
= echo_area_buffer
[0];
2468 /* Message turns off echoing unless more keystrokes turn it on again.
2470 The code in 20.x for the condition was
2472 1. echo_area_glyphs && *echo_area_glyphs
2473 2. && echo_area_glyphs != current_kboard->echobuf
2474 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2476 (1) means there's a current message displayed
2478 (2) means it's not the message from echoing from the current
2481 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2482 is set to a non-null value. This is done in read_char and it is
2483 set to echo_area_glyphs after a call to echo_char. That means
2484 ok_to_echo_at_next_pause is either null or
2485 current_kboard->echobuf with the appropriate current_kboard at
2488 So, condition (3) means in clear text ok_to_echo_at_next_pause
2489 must be either null, or the current message isn't from echoing at
2490 all, or it's from echoing from a different kboard than the
2493 if (/* There currently is something in the echo area. */
2494 !NILP (echo_area_buffer
[0])
2495 && (/* And it's either not from echoing. */
2496 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2497 /* Or it's an echo from a different kboard. */
2498 || echo_kboard
!= current_kboard
2499 /* Or we explicitly allow overwriting whatever there is. */
2500 || ok_to_echo_at_next_pause
== NULL
))
2505 /* Try reading a character via menu prompting in the minibuf.
2506 Try this before the sit-for, because the sit-for
2507 would do the wrong thing if we are supposed to do
2508 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2509 after a mouse event so don't try a minibuf menu. */
2511 if (nmaps
> 0 && INTERACTIVE
2512 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2513 /* Don't bring up a menu if we already have another event. */
2514 && NILP (Vunread_command_events
)
2515 && unread_command_char
< 0
2516 && !detect_input_pending_run_timers (0))
2518 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2520 if (INTEGERP (c
) && XINT (c
) == -2)
2521 return c
; /* wrong_kboard_jmpbuf */
2525 key_already_recorded
= 1;
2530 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2531 We will do that below, temporarily for short sections of code,
2532 when appropriate. local_getcjmp must be in effect
2533 around any call to sit_for or kbd_buffer_get_event;
2534 it *must not* be in effect when we call redisplay. */
2536 jmpcount
= SPECPDL_INDEX ();
2537 if (_setjmp (local_getcjmp
))
2539 /* Handle quits while reading the keyboard. */
2540 /* We must have saved the outer value of getcjmp here,
2541 so restore it now. */
2542 restore_getcjmp (save_jump
);
2543 unbind_to (jmpcount
, Qnil
);
2544 XSETINT (c
, quit_char
);
2545 internal_last_event_frame
= selected_frame
;
2546 Vlast_event_frame
= internal_last_event_frame
;
2547 /* If we report the quit char as an event,
2548 don't do so more than once. */
2549 if (!NILP (Vinhibit_quit
))
2553 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2554 if (kb
!= current_kboard
)
2556 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2557 /* We shouldn't get here if we were in single-kboard mode! */
2562 while (CONSP (XCDR (last
)))
2564 if (!NILP (XCDR (last
)))
2568 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2570 XSETCDR (last
, Fcons (c
, Qnil
));
2571 kb
->kbd_queue_has_data
= 1;
2572 current_kboard
= kb
;
2573 /* This is going to exit from read_char
2574 so we had better get rid of this frame's stuff. */
2576 return make_number (-2); /* wrong_kboard_jmpbuf */
2582 /* Start idle timers if no time limit is supplied. We don't do it
2583 if a time limit is supplied to avoid an infinite recursion in the
2584 situation where an idle timer calls `sit-for'. */
2587 timer_start_idle ();
2589 /* If in middle of key sequence and minibuffer not active,
2590 start echoing if enough time elapses. */
2592 if (minibuf_level
== 0
2594 && !current_kboard
->immediate_echo
2595 && this_command_key_count
> 0
2597 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2598 && NILP (Fzerop (Vecho_keystrokes
))
2599 && (/* No message. */
2600 NILP (echo_area_buffer
[0])
2601 /* Or empty message. */
2602 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2603 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2604 /* Or already echoing from same kboard. */
2605 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2606 /* Or not echoing before and echoing allowed. */
2607 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2609 /* After a mouse event, start echoing right away.
2610 This is because we are probably about to display a menu,
2611 and we don't want to delay before doing so. */
2612 if (EVENT_HAS_PARAMETERS (prev_event
))
2618 save_getcjmp (save_jump
);
2619 restore_getcjmp (local_getcjmp
);
2620 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2621 restore_getcjmp (save_jump
);
2623 && ! CONSP (Vunread_command_events
))
2628 /* Maybe auto save due to number of keystrokes. */
2630 if (commandflag
!= 0
2631 && auto_save_interval
> 0
2632 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2633 && !detect_input_pending_run_timers (0))
2635 Fdo_auto_save (Qnil
, Qnil
);
2636 /* Hooks can actually change some buffers in auto save. */
2640 /* Try reading using an X menu.
2641 This is never confused with reading using the minibuf
2642 because the recursive call of read_char in read_char_minibuf_menu_prompt
2643 does not pass on any keymaps. */
2645 if (nmaps
> 0 && INTERACTIVE
2646 && !NILP (prev_event
)
2647 && EVENT_HAS_PARAMETERS (prev_event
)
2648 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2649 && !EQ (XCAR (prev_event
), Qtool_bar
)
2650 /* Don't bring up a menu if we already have another event. */
2651 && NILP (Vunread_command_events
)
2652 && unread_command_char
< 0)
2654 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2656 /* Now that we have read an event, Emacs is not idle. */
2663 /* Maybe autosave and/or garbage collect due to idleness. */
2665 if (INTERACTIVE
&& NILP (c
))
2668 ptrdiff_t buffer_size
;
2670 /* Slow down auto saves logarithmically in size of current buffer,
2671 and garbage collect while we're at it. */
2672 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2673 last_non_minibuf_size
= Z
- BEG
;
2674 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2676 while (buffer_size
> 64)
2677 delay_level
++, buffer_size
-= buffer_size
>> 2;
2678 if (delay_level
< 4) delay_level
= 4;
2679 /* delay_level is 4 for files under around 50k, 7 at 100k,
2680 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2682 /* Auto save if enough time goes by without input. */
2683 if (commandflag
!= 0
2684 && num_nonmacro_input_events
> last_auto_save
2685 && INTEGERP (Vauto_save_timeout
)
2686 && XINT (Vauto_save_timeout
) > 0)
2689 EMACS_INT timeout
= (delay_level
2690 * min (XFASTINT (Vauto_save_timeout
) / 4,
2691 MOST_POSITIVE_FIXNUM
/ delay_level
));
2692 save_getcjmp (save_jump
);
2693 restore_getcjmp (local_getcjmp
);
2694 tem0
= sit_for (make_number (timeout
), 1, 1);
2695 restore_getcjmp (save_jump
);
2698 && ! CONSP (Vunread_command_events
))
2700 Fdo_auto_save (Qnil
, Qnil
);
2705 /* If there is still no input available, ask for GC. */
2706 if (!detect_input_pending_run_timers (0))
2710 /* Notify the caller if an autosave hook, or a timer, sentinel or
2711 filter in the sit_for calls above have changed the current
2712 kboard. This could happen if they use the minibuffer or start a
2713 recursive edit, like the fancy splash screen in server.el's
2714 filter. If this longjmp wasn't here, read_key_sequence would
2715 interpret the next key sequence using the wrong translation
2716 tables and function keymaps. */
2717 if (NILP (c
) && current_kboard
!= orig_kboard
)
2720 return make_number (-2); /* wrong_kboard_jmpbuf */
2723 /* If this has become non-nil here, it has been set by a timer
2724 or sentinel or filter. */
2725 if (CONSP (Vunread_command_events
))
2727 c
= XCAR (Vunread_command_events
);
2728 Vunread_command_events
= XCDR (Vunread_command_events
);
2731 /* Read something from current KBOARD's side queue, if possible. */
2735 if (current_kboard
->kbd_queue_has_data
)
2737 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2739 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2740 KVAR (current_kboard
, kbd_queue
)
2741 = XCDR (KVAR (current_kboard
, kbd_queue
));
2742 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2743 current_kboard
->kbd_queue_has_data
= 0;
2744 input_pending
= readable_events (0);
2745 if (EVENT_HAS_PARAMETERS (c
)
2746 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2747 internal_last_event_frame
= XCAR (XCDR (c
));
2748 Vlast_event_frame
= internal_last_event_frame
;
2752 /* If current_kboard's side queue is empty check the other kboards.
2753 If one of them has data that we have not yet seen here,
2754 switch to it and process the data waiting for it.
2756 Note: if the events queued up for another kboard
2757 have already been seen here, and therefore are not a complete command,
2758 the kbd_queue_has_data field is 0, so we skip that kboard here.
2759 That's to avoid an infinite loop switching between kboards here. */
2760 if (NILP (c
) && !single_kboard
)
2763 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2764 if (kb
->kbd_queue_has_data
)
2766 current_kboard
= kb
;
2767 /* This is going to exit from read_char
2768 so we had better get rid of this frame's stuff. */
2770 return make_number (-2); /* wrong_kboard_jmpbuf */
2778 /* Finally, we read from the main queue,
2779 and if that gives us something we can't use yet, we put it on the
2780 appropriate side queue and try again. */
2784 KBOARD
*kb
IF_LINT (= NULL
);
2786 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2789 /* Actually read a character, waiting if necessary. */
2790 save_getcjmp (save_jump
);
2791 restore_getcjmp (local_getcjmp
);
2793 timer_start_idle ();
2794 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2795 restore_getcjmp (save_jump
);
2797 if (! NILP (c
) && (kb
!= current_kboard
))
2799 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2802 while (CONSP (XCDR (last
)))
2804 if (!NILP (XCDR (last
)))
2808 KVAR (kb
, kbd_queue
) = Fcons (c
, Qnil
);
2810 XSETCDR (last
, Fcons (c
, Qnil
));
2811 kb
->kbd_queue_has_data
= 1;
2815 current_kboard
= kb
;
2816 /* This is going to exit from read_char
2817 so we had better get rid of this frame's stuff. */
2819 return make_number (-2);
2823 /* Terminate Emacs in batch mode if at eof. */
2824 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2825 Fkill_emacs (make_number (1));
2829 /* Add in any extra modifiers, where appropriate. */
2830 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2831 || ((extra_keyboard_modifiers
& 0177) < ' '
2832 && (extra_keyboard_modifiers
& 0177) != 0))
2833 XSETINT (c
, make_ctrl_char (XINT (c
)));
2835 /* Transfer any other modifier bits directly from
2836 extra_keyboard_modifiers to c. Ignore the actual character code
2837 in the low 16 bits of extra_keyboard_modifiers. */
2838 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2849 if (commandflag
>= 0
2850 && !input_pending
&& !detect_input_pending_run_timers (0))
2858 /* Buffer switch events are only for internal wakeups
2859 so don't show them to the user.
2860 Also, don't record a key if we already did. */
2861 if (BUFFERP (c
) || key_already_recorded
)
2864 /* Process special events within read_char
2865 and loop around to read another event. */
2868 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2873 struct buffer
*prev_buffer
= current_buffer
;
2874 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2875 int was_locked
= single_kboard
;
2876 ptrdiff_t count
= SPECPDL_INDEX ();
2877 record_single_kboard_state ();
2880 last_input_event
= c
;
2881 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2883 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2884 /* We stopped being idle for this event; undo that. This
2885 prevents automatic window selection (under
2886 mouse_autoselect_window from acting as a real input event, for
2887 example banishing the mouse under mouse-avoidance-mode. */
2888 timer_resume_idle ();
2890 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2891 /* Resume allowing input from any kboard, if that was true before. */
2893 any_kboard_state ();
2894 unbind_to (count
, Qnil
);
2897 if (current_buffer
!= prev_buffer
)
2899 /* The command may have changed the keymaps. Pretend there
2900 is input in another keyboard and return. This will
2901 recalculate keymaps. */
2902 c
= make_number (-2);
2909 /* Handle things that only apply to characters. */
2912 /* If kbd_buffer_get_event gave us an EOF, return that. */
2916 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2917 && UNSIGNED_CMP (XFASTINT (c
), <,
2918 SCHARS (KVAR (current_kboard
,
2919 Vkeyboard_translate_table
))))
2920 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2921 && UNSIGNED_CMP (XFASTINT (c
), <,
2922 ASIZE (KVAR (current_kboard
,
2923 Vkeyboard_translate_table
))))
2924 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2928 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2929 /* nil in keyboard-translate-table means no translation. */
2935 /* If this event is a mouse click in the menu bar,
2936 return just menu-bar for now. Modify the mouse click event
2937 so we won't do this twice, then queue it up. */
2938 if (EVENT_HAS_PARAMETERS (c
)
2940 && CONSP (EVENT_START (c
))
2941 && CONSP (XCDR (EVENT_START (c
))))
2945 posn
= POSN_POSN (EVENT_START (c
));
2946 /* Handle menu-bar events:
2947 insert the dummy prefix event `menu-bar'. */
2948 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2950 /* Change menu-bar to (menu-bar) as the event "position". */
2951 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2954 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2959 /* Store these characters into recent_keys, the dribble file if any,
2960 and the keyboard macro being defined, if any. */
2962 if (! NILP (also_record
))
2963 record_char (also_record
);
2965 /* Wipe the echo area.
2966 But first, if we are about to use an input method,
2967 save the echo area contents for it to refer to. */
2969 && ! NILP (Vinput_method_function
)
2970 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2972 previous_echo_area_message
= Fcurrent_message ();
2973 Vinput_method_previous_message
= previous_echo_area_message
;
2976 /* Now wipe the echo area, except for help events which do their
2977 own stuff with the echo area. */
2979 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2980 && !(EQ (Qswitch_frame
, XCAR (c
)))
2981 /* Don't wipe echo area for select window events: These might
2982 get delayed via `mouse-autoselect-window' (Bug#11304). */
2983 && !(EQ (Qselect_window
, XCAR (c
)))))
2985 if (!NILP (echo_area_buffer
[0]))
2987 safe_run_hooks (Qecho_area_clear_hook
);
2988 clear_message (1, 0);
2992 reread_for_input_method
:
2994 /* Pass this to the input method, if appropriate. */
2996 && ! NILP (Vinput_method_function
)
2997 /* Don't run the input method within a key sequence,
2998 after the first event of the key sequence. */
2999 && NILP (prev_event
)
3000 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3003 ptrdiff_t key_count
;
3004 int key_count_reset
;
3005 struct gcpro gcpro1
;
3006 ptrdiff_t count
= SPECPDL_INDEX ();
3008 /* Save the echo status. */
3009 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3010 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3011 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3012 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3015 if (before_command_restore_flag
)
3017 this_command_key_count
= before_command_key_count_1
;
3018 if (this_command_key_count
< this_single_command_key_start
)
3019 this_single_command_key_start
= this_command_key_count
;
3020 echo_truncate (before_command_echo_length_1
);
3021 before_command_restore_flag
= 0;
3025 /* Save the this_command_keys status. */
3026 key_count
= this_command_key_count
;
3027 key_count_reset
= this_command_key_count_reset
;
3030 keys
= Fcopy_sequence (this_command_keys
);
3035 /* Clear out this_command_keys. */
3036 this_command_key_count
= 0;
3037 this_command_key_count_reset
= 0;
3039 /* Now wipe the echo area. */
3040 if (!NILP (echo_area_buffer
[0]))
3041 safe_run_hooks (Qecho_area_clear_hook
);
3042 clear_message (1, 0);
3045 /* If we are not reading a key sequence,
3046 never use the echo area. */
3049 specbind (Qinput_method_use_echo_area
, Qt
);
3052 /* Call the input method. */
3053 tem
= call1 (Vinput_method_function
, c
);
3055 tem
= unbind_to (count
, tem
);
3057 /* Restore the saved echoing state
3058 and this_command_keys state. */
3059 this_command_key_count
= key_count
;
3060 this_command_key_count_reset
= key_count_reset
;
3062 this_command_keys
= keys
;
3065 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3066 KVAR (current_kboard
, echo_string
) = saved_echo_string
;
3067 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3068 if (saved_immediate_echo
)
3073 /* The input method can return no events. */
3076 /* Bring back the previous message, if any. */
3077 if (! NILP (previous_echo_area_message
))
3078 message_with_string ("%s", previous_echo_area_message
, 0);
3081 /* It returned one event or more. */
3083 Vunread_post_input_method_events
3084 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3089 /* Display help if not echoing. */
3090 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3092 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3093 Lisp_Object help
, object
, position
, window
, htem
;
3095 htem
= Fcdr (XCDR (c
));
3098 window
= Fcar (htem
);
3100 object
= Fcar (htem
);
3102 position
= Fcar (htem
);
3104 show_help_echo (help
, window
, object
, position
);
3106 /* We stopped being idle for this event; undo that. */
3108 timer_resume_idle ();
3112 if ((! reread
|| this_command_key_count
== 0
3113 || this_command_key_count_reset
)
3117 /* Don't echo mouse motion events. */
3118 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3119 && NILP (Fzerop (Vecho_keystrokes
))
3120 && ! (EVENT_HAS_PARAMETERS (c
)
3121 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3124 if (! NILP (also_record
))
3125 echo_char (also_record
);
3126 /* Once we reread a character, echoing can happen
3127 the next time we pause to read a new one. */
3128 ok_to_echo_at_next_pause
= current_kboard
;
3131 /* Record this character as part of the current key. */
3132 add_command_key (c
);
3133 if (! NILP (also_record
))
3134 add_command_key (also_record
);
3137 last_input_event
= c
;
3140 /* Process the help character specially if enabled */
3141 if (!NILP (Vhelp_form
) && help_char_p (c
))
3143 ptrdiff_t count
= SPECPDL_INDEX ();
3145 help_form_saved_window_configs
3146 = Fcons (Fcurrent_window_configuration (Qnil
),
3147 help_form_saved_window_configs
);
3148 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3149 call0 (Qhelp_form_show
);
3154 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3155 if (EVENT_HAS_PARAMETERS (c
)
3156 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3157 XSETCAR (help_form_saved_window_configs
, Qnil
);
3159 while (BUFFERP (c
));
3160 /* Remove the help from the frame */
3161 unbind_to (count
, Qnil
);
3164 if (EQ (c
, make_number (040)))
3168 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3169 while (BUFFERP (c
));
3178 /* Record a key that came from a mouse menu.
3179 Record it for echoing, for this-command-keys, and so on. */
3182 record_menu_key (Lisp_Object c
)
3184 /* Wipe the echo area. */
3185 clear_message (1, 0);
3190 before_command_key_count
= this_command_key_count
;
3191 before_command_echo_length
= echo_length ();
3194 /* Don't echo mouse motion events. */
3195 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3196 && NILP (Fzerop (Vecho_keystrokes
)))
3200 /* Once we reread a character, echoing can happen
3201 the next time we pause to read a new one. */
3202 ok_to_echo_at_next_pause
= 0;
3205 /* Record this character as part of the current key. */
3206 add_command_key (c
);
3208 /* Re-reading in the middle of a command */
3209 last_input_event
= c
;
3213 /* Return 1 if should recognize C as "the help character". */
3216 help_char_p (Lisp_Object c
)
3220 if (EQ (c
, Vhelp_char
))
3222 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3223 if (EQ (c
, XCAR (tail
)))
3228 /* Record the input event C in various ways. */
3231 record_char (Lisp_Object c
)
3235 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3237 /* To avoid filling recent_keys with help-echo and mouse-movement
3238 events, we filter out repeated help-echo events, only store the
3239 first and last in a series of mouse-movement events, and don't
3240 store repeated help-echo events which are only separated by
3241 mouse-movement events. */
3243 Lisp_Object ev1
, ev2
, ev3
;
3246 if ((ix1
= recent_keys_index
- 1) < 0)
3247 ix1
= NUM_RECENT_KEYS
- 1;
3248 ev1
= AREF (recent_keys
, ix1
);
3250 if ((ix2
= ix1
- 1) < 0)
3251 ix2
= NUM_RECENT_KEYS
- 1;
3252 ev2
= AREF (recent_keys
, ix2
);
3254 if ((ix3
= ix2
- 1) < 0)
3255 ix3
= NUM_RECENT_KEYS
- 1;
3256 ev3
= AREF (recent_keys
, ix3
);
3258 if (EQ (XCAR (c
), Qhelp_echo
))
3260 /* Don't record `help-echo' in recent_keys unless it shows some help
3261 message, and a different help than the previously recorded
3263 Lisp_Object help
, last_help
;
3265 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3266 if (!STRINGP (help
))
3268 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3269 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3271 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3272 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3273 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3275 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3276 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3277 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3278 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3281 else if (EQ (XCAR (c
), Qmouse_movement
))
3283 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3284 So additional mouse movement events replace the last element. */
3285 Lisp_Object last_window
, window
;
3287 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3288 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3289 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3290 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3291 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3293 ASET (recent_keys
, ix1
, c
);
3299 store_kbd_macro_char (c
);
3303 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3304 ASET (recent_keys
, recent_keys_index
, c
);
3305 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3306 recent_keys_index
= 0;
3308 else if (recorded
< 0)
3310 /* We need to remove one or two events from recent_keys.
3311 To do this, we simply put nil at those events and move the
3312 recent_keys_index backwards over those events. Usually,
3313 users will never see those nil events, as they will be
3314 overwritten by the command keys entered to see recent_keys
3317 while (recorded
++ < 0 && total_keys
> 0)
3319 if (total_keys
< NUM_RECENT_KEYS
)
3321 if (--recent_keys_index
< 0)
3322 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3323 ASET (recent_keys
, recent_keys_index
, Qnil
);
3327 num_nonmacro_input_events
++;
3329 /* Write c to the dribble file. If c is a lispy event, write
3330 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3331 If you, dear reader, have a better idea, you've got the source. :-) */
3337 if (XUINT (c
) < 0x100)
3338 putc (XUINT (c
), dribble
);
3340 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3344 Lisp_Object dribblee
;
3346 /* If it's a structured event, take the event header. */
3347 dribblee
= EVENT_HEAD (c
);
3349 if (SYMBOLP (dribblee
))
3351 putc ('<', dribble
);
3352 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3353 SBYTES (SYMBOL_NAME (dribblee
)),
3355 putc ('>', dribble
);
3364 /* Copy out or in the info on where C-g should throw to.
3365 This is used when running Lisp code from within get_char,
3366 in case get_char is called recursively.
3367 See read_process_output. */
3370 save_getcjmp (jmp_buf temp
)
3372 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3376 restore_getcjmp (jmp_buf temp
)
3378 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3381 /* Low level keyboard/mouse input.
3382 kbd_buffer_store_event places events in kbd_buffer, and
3383 kbd_buffer_get_event retrieves them. */
3385 /* Return true if there are any events in the queue that read-char
3386 would return. If this returns false, a read-char would block. */
3388 readable_events (int flags
)
3390 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3393 /* If the buffer contains only FOCUS_IN_EVENT events, and
3394 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3395 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3397 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3398 #ifdef USE_TOOLKIT_SCROLL_BARS
3399 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3403 struct input_event
*event
;
3405 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3412 #ifdef USE_TOOLKIT_SCROLL_BARS
3413 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3415 event
->kind
== FOCUS_IN_EVENT
)
3416 #ifdef USE_TOOLKIT_SCROLL_BARS
3417 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3418 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3419 && event
->part
== scroll_bar_handle
3420 && event
->modifiers
== 0)
3425 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3428 while (event
!= kbd_store_ptr
);
3434 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3435 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3436 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3441 if (current_kboard
->kbd_queue_has_data
)
3447 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3448 if (kb
->kbd_queue_has_data
)
3454 /* Set this for debugging, to have a way to get out */
3455 int stop_character EXTERNALLY_VISIBLE
;
3458 event_to_kboard (struct input_event
*event
)
3461 frame
= event
->frame_or_window
;
3463 frame
= XCAR (frame
);
3464 else if (WINDOWP (frame
))
3465 frame
= WINDOW_FRAME (XWINDOW (frame
));
3467 /* There are still some events that don't set this field.
3468 For now, just ignore the problem.
3469 Also ignore dead frames here. */
3470 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3473 return FRAME_KBOARD (XFRAME (frame
));
3477 /* Return the number of slots occupied in kbd_buffer. */
3480 kbd_buffer_nr_stored (void)
3482 return kbd_fetch_ptr
== kbd_store_ptr
3484 : (kbd_fetch_ptr
< kbd_store_ptr
3485 ? kbd_store_ptr
- kbd_fetch_ptr
3486 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3487 + (kbd_store_ptr
- kbd_buffer
)));
3489 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3492 kbd_buffer_store_event (register struct input_event
*event
)
3494 kbd_buffer_store_event_hold (event
, 0);
3497 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3499 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3500 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3501 Else, if EVENT is a quit event, store the quit event
3502 in HOLD_QUIT, and return (thus ignoring further events).
3504 This is used in read_avail_input to postpone the processing
3505 of the quit event until all subsequent input events have been
3506 parsed (and discarded).
3510 kbd_buffer_store_event_hold (register struct input_event
*event
,
3511 struct input_event
*hold_quit
)
3513 if (event
->kind
== NO_EVENT
)
3516 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3519 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3521 register int c
= event
->code
& 0377;
3523 if (event
->modifiers
& ctrl_modifier
)
3524 c
= make_ctrl_char (c
);
3526 c
|= (event
->modifiers
3527 & (meta_modifier
| alt_modifier
3528 | hyper_modifier
| super_modifier
));
3532 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3533 struct input_event
*sp
;
3535 if (single_kboard
&& kb
!= current_kboard
)
3537 KVAR (kb
, kbd_queue
)
3538 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3539 Fcons (make_number (c
), Qnil
));
3540 kb
->kbd_queue_has_data
= 1;
3541 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3543 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3546 if (event_to_kboard (sp
) == kb
)
3548 sp
->kind
= NO_EVENT
;
3549 sp
->frame_or_window
= Qnil
;
3558 memcpy (hold_quit
, event
, sizeof (*event
));
3562 /* If this results in a quit_char being returned to Emacs as
3563 input, set Vlast_event_frame properly. If this doesn't
3564 get returned to Emacs as an event, the next event read
3565 will set Vlast_event_frame again, so this is safe to do. */
3569 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3571 focus
= event
->frame_or_window
;
3572 internal_last_event_frame
= focus
;
3573 Vlast_event_frame
= focus
;
3576 last_event_timestamp
= event
->timestamp
;
3577 handle_interrupt ();
3581 if (c
&& c
== stop_character
)
3587 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3588 Just ignore the second one. */
3589 else if (event
->kind
== BUFFER_SWITCH_EVENT
3590 && kbd_fetch_ptr
!= kbd_store_ptr
3591 && ((kbd_store_ptr
== kbd_buffer
3592 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3593 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3596 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3597 kbd_store_ptr
= kbd_buffer
;
3599 /* Don't let the very last slot in the buffer become full,
3600 since that would make the two pointers equal,
3601 and that is indistinguishable from an empty buffer.
3602 Discard the event if it would fill the last slot. */
3603 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3605 *kbd_store_ptr
= *event
;
3608 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3610 /* Don't read keyboard input until we have processed kbd_buffer.
3611 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3612 hold_keyboard_input ();
3614 if (!noninteractive
)
3615 signal (SIGIO
, SIG_IGN
);
3619 #endif /* subprocesses */
3622 /* If we're inside while-no-input, and this event qualifies
3623 as input, set quit-flag to cause an interrupt. */
3624 if (!NILP (Vthrow_on_input
)
3625 && event
->kind
!= FOCUS_IN_EVENT
3626 && event
->kind
!= HELP_EVENT
3627 && event
->kind
!= DEICONIFY_EVENT
)
3629 Vquit_flag
= Vthrow_on_input
;
3630 /* If we're inside a function that wants immediate quits,
3632 if (immediate_quit
&& NILP (Vinhibit_quit
))
3642 /* Put an input event back in the head of the event queue. */
3645 kbd_buffer_unget_event (register struct input_event
*event
)
3647 if (kbd_fetch_ptr
== kbd_buffer
)
3648 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3650 /* Don't let the very last slot in the buffer become full, */
3651 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3654 *kbd_fetch_ptr
= *event
;
3659 /* Generate a HELP_EVENT input_event and store it in the keyboard
3662 HELP is the help form.
3664 FRAME and WINDOW are the frame and window where the help is
3665 generated. OBJECT is the Lisp object where the help was found (a
3666 buffer, a string, an overlay, or nil if neither from a string nor
3667 from a buffer). POS is the position within OBJECT where the help
3671 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3672 Lisp_Object object
, ptrdiff_t pos
)
3674 struct input_event event
;
3678 event
.kind
= HELP_EVENT
;
3679 event
.frame_or_window
= frame
;
3681 event
.x
= WINDOWP (window
) ? window
: frame
;
3684 kbd_buffer_store_event (&event
);
3688 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3691 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3693 struct input_event event
;
3695 event
.kind
= HELP_EVENT
;
3696 event
.frame_or_window
= frame
;
3701 kbd_buffer_store_event (&event
);
3705 /* Discard any mouse events in the event buffer by setting them to
3708 discard_mouse_events (void)
3710 struct input_event
*sp
;
3711 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3713 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3716 if (sp
->kind
== MOUSE_CLICK_EVENT
3717 || sp
->kind
== WHEEL_EVENT
3718 || sp
->kind
== HORIZ_WHEEL_EVENT
3720 || sp
->kind
== GPM_CLICK_EVENT
3722 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3724 sp
->kind
= NO_EVENT
;
3730 /* Return non-zero if there are any real events waiting in the event
3731 buffer, not counting `NO_EVENT's.
3733 If DISCARD is non-zero, discard NO_EVENT events at the front of
3734 the input queue, possibly leaving the input queue empty if there
3735 are no real input events. */
3738 kbd_buffer_events_waiting (int discard
)
3740 struct input_event
*sp
;
3742 for (sp
= kbd_fetch_ptr
;
3743 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3746 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3753 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3757 /* Clear input event EVENT. */
3760 clear_event (struct input_event
*event
)
3762 event
->kind
= NO_EVENT
;
3766 /* Read one event from the event buffer, waiting if necessary.
3767 The value is a Lisp object representing the event.
3768 The value is nil for an event that should be ignored,
3769 or that was handled here.
3770 We always read and discard one event. */
3773 kbd_buffer_get_event (KBOARD
**kbp
,
3774 int *used_mouse_menu
,
3775 EMACS_TIME
*end_time
)
3780 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3782 /* Start reading input again, we have processed enough so we can
3783 accept new events again. */
3784 unhold_keyboard_input ();
3786 if (!noninteractive
)
3787 signal (SIGIO
, input_available_signal
);
3791 #endif /* subprocesses */
3793 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3795 /* In case we are running as a daemon, only do this before
3796 detaching from the terminal. */
3797 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3801 *kbp
= current_kboard
;
3804 #endif /* ! HAVE_DBUS */
3806 /* Wait until there is input available. */
3809 /* Break loop if there's an unread command event. Needed in
3810 moused window autoselection which uses a timer to insert such
3812 if (CONSP (Vunread_command_events
))
3815 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3817 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3818 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3822 /* If the quit flag is set, then read_char will return
3823 quit_char, so that counts as "available input." */
3824 if (!NILP (Vquit_flag
))
3825 quit_throw_to_read_char (0);
3827 /* One way or another, wait until input is available; then, if
3828 interrupt handlers have not read it, read it now. */
3830 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3834 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3836 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3837 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3842 EMACS_TIME now
= current_emacs_time ();
3843 if (EMACS_TIME_LE (*end_time
, now
))
3844 return Qnil
; /* Finished waiting. */
3847 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3848 wait_reading_process_output (min (EMACS_SECS (duration
),
3850 EMACS_NSECS (duration
),
3851 -1, 1, Qnil
, NULL
, 0);
3855 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3857 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3858 /* Pass 1 for EXPECT since we just waited to have input. */
3859 read_avail_input (1);
3862 if (CONSP (Vunread_command_events
))
3865 first
= XCAR (Vunread_command_events
);
3866 Vunread_command_events
= XCDR (Vunread_command_events
);
3867 *kbp
= current_kboard
;
3871 /* At this point, we know that there is a readable event available
3872 somewhere. If the event queue is empty, then there must be a
3873 mouse movement enabled and available. */
3874 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3876 struct input_event
*event
;
3878 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3882 last_event_timestamp
= event
->timestamp
;
3884 *kbp
= event_to_kboard (event
);
3886 *kbp
= current_kboard
; /* Better than returning null ptr? */
3890 /* These two kinds of events get special handling
3891 and don't actually appear to the command loop.
3892 We return nil for them. */
3893 if (event
->kind
== SELECTION_REQUEST_EVENT
3894 || event
->kind
== SELECTION_CLEAR_EVENT
)
3897 struct input_event copy
;
3899 /* Remove it from the buffer before processing it,
3900 since otherwise swallow_events will see it
3901 and process it again. */
3903 kbd_fetch_ptr
= event
+ 1;
3904 input_pending
= readable_events (0);
3905 x_handle_selection_event (©
);
3907 /* We're getting selection request events, but we don't have
3913 #if defined (HAVE_NS)
3914 else if (event
->kind
== NS_TEXT_EVENT
)
3916 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3917 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3919 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3920 kbd_fetch_ptr
= event
+ 1;
3921 if (used_mouse_menu
)
3922 *used_mouse_menu
= 1;
3926 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3927 || defined (HAVE_NS)
3928 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3930 /* Make an event (delete-frame (FRAME)). */
3931 obj
= Fcons (event
->frame_or_window
, Qnil
);
3932 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3933 kbd_fetch_ptr
= event
+ 1;
3936 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3937 || defined (HAVE_NS)
3938 else if (event
->kind
== ICONIFY_EVENT
)
3940 /* Make an event (iconify-frame (FRAME)). */
3941 obj
= Fcons (event
->frame_or_window
, Qnil
);
3942 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3943 kbd_fetch_ptr
= event
+ 1;
3945 else if (event
->kind
== DEICONIFY_EVENT
)
3947 /* Make an event (make-frame-visible (FRAME)). */
3948 obj
= Fcons (event
->frame_or_window
, Qnil
);
3949 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3950 kbd_fetch_ptr
= event
+ 1;
3953 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3955 /* The value doesn't matter here; only the type is tested. */
3956 XSETBUFFER (obj
, current_buffer
);
3957 kbd_fetch_ptr
= event
+ 1;
3959 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3960 || defined (HAVE_NS) || defined (USE_GTK)
3961 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3963 kbd_fetch_ptr
= event
+ 1;
3964 input_pending
= readable_events (0);
3965 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3966 x_activate_menubar (XFRAME (event
->frame_or_window
));
3969 #if defined (WINDOWSNT)
3970 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3972 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
3973 obj
= Fcons (Qlanguage_change
,
3974 list3 (event
->frame_or_window
,
3975 make_number (event
->code
),
3976 make_number (event
->modifiers
)));
3977 kbd_fetch_ptr
= event
+ 1;
3980 else if (event
->kind
== SAVE_SESSION_EVENT
)
3982 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3983 kbd_fetch_ptr
= event
+ 1;
3985 /* Just discard these, by returning nil.
3986 With MULTI_KBOARD, these events are used as placeholders
3987 when we need to randomly delete events from the queue.
3988 (They shouldn't otherwise be found in the buffer,
3989 but on some machines it appears they do show up
3990 even without MULTI_KBOARD.) */
3991 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3992 mouse events during a popup-menu call. */
3993 else if (event
->kind
== NO_EVENT
)
3994 kbd_fetch_ptr
= event
+ 1;
3995 else if (event
->kind
== HELP_EVENT
)
3997 Lisp_Object object
, position
, help
, frame
, window
;
3999 frame
= event
->frame_or_window
;
4000 object
= event
->arg
;
4001 position
= make_number (event
->code
);
4004 clear_event (event
);
4006 kbd_fetch_ptr
= event
+ 1;
4007 if (!WINDOWP (window
))
4009 obj
= Fcons (Qhelp_echo
,
4010 list5 (frame
, help
, window
, object
, position
));
4012 else if (event
->kind
== FOCUS_IN_EVENT
)
4014 /* Notification of a FocusIn event. The frame receiving the
4015 focus is in event->frame_or_window. Generate a
4016 switch-frame event if necessary. */
4017 Lisp_Object frame
, focus
;
4019 frame
= event
->frame_or_window
;
4020 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4024 if (!EQ (frame
, internal_last_event_frame
)
4025 && !EQ (frame
, selected_frame
))
4026 obj
= make_lispy_switch_frame (frame
);
4027 internal_last_event_frame
= frame
;
4028 kbd_fetch_ptr
= event
+ 1;
4031 else if (event
->kind
== DBUS_EVENT
)
4033 obj
= make_lispy_event (event
);
4034 kbd_fetch_ptr
= event
+ 1;
4037 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4039 obj
= make_lispy_event (event
);
4040 kbd_fetch_ptr
= event
+ 1;
4044 /* If this event is on a different frame, return a switch-frame this
4045 time, and leave the event in the queue for next time. */
4049 frame
= event
->frame_or_window
;
4051 frame
= XCAR (frame
);
4052 else if (WINDOWP (frame
))
4053 frame
= WINDOW_FRAME (XWINDOW (frame
));
4055 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4059 if (! EQ (frame
, internal_last_event_frame
)
4060 && !EQ (frame
, selected_frame
))
4061 obj
= make_lispy_switch_frame (frame
);
4062 internal_last_event_frame
= frame
;
4064 /* If we didn't decide to make a switch-frame event, go ahead
4065 and build a real event from the queue entry. */
4069 obj
= make_lispy_event (event
);
4071 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4072 || defined (HAVE_NS) || defined (USE_GTK)
4073 /* If this was a menu selection, then set the flag to inhibit
4074 writing to last_nonmenu_event. Don't do this if the event
4075 we're returning is (menu-bar), though; that indicates the
4076 beginning of the menu sequence, and we might as well leave
4077 that as the `event with parameters' for this selection. */
4079 && !EQ (event
->frame_or_window
, event
->arg
)
4080 && (event
->kind
== MENU_BAR_EVENT
4081 || event
->kind
== TOOL_BAR_EVENT
))
4082 *used_mouse_menu
= 1;
4085 /* certain system events are non-key events */
4087 && event
->kind
== NS_NONKEY_EVENT
)
4088 *used_mouse_menu
= 1;
4091 /* Wipe out this event, to catch bugs. */
4092 clear_event (event
);
4093 kbd_fetch_ptr
= event
+ 1;
4097 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4098 /* Try generating a mouse motion event. */
4099 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4101 FRAME_PTR f
= some_mouse_moved ();
4102 Lisp_Object bar_window
;
4103 enum scroll_bar_part part
;
4107 *kbp
= current_kboard
;
4108 /* Note that this uses F to determine which terminal to look at.
4109 If there is no valid info, it does not store anything
4110 so x remains nil. */
4113 /* XXX Can f or mouse_position_hook be NULL here? */
4114 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4115 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4120 /* Decide if we should generate a switch-frame event. Don't
4121 generate switch-frame events for motion outside of all Emacs
4127 frame
= FRAME_FOCUS_FRAME (f
);
4129 XSETFRAME (frame
, f
);
4131 if (! EQ (frame
, internal_last_event_frame
)
4132 && !EQ (frame
, selected_frame
))
4133 obj
= make_lispy_switch_frame (frame
);
4134 internal_last_event_frame
= frame
;
4137 /* If we didn't decide to make a switch-frame event, go ahead and
4138 return a mouse-motion event. */
4139 if (!NILP (x
) && NILP (obj
))
4140 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4142 #endif /* HAVE_MOUSE || HAVE GPM */
4144 /* We were promised by the above while loop that there was
4145 something for us to read! */
4148 input_pending
= readable_events (0);
4150 Vlast_event_frame
= internal_last_event_frame
;
4155 /* Process any non-user-visible events (currently X selection events),
4156 without reading any user-visible events. */
4159 process_special_events (void)
4161 struct input_event
*event
;
4163 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4165 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4168 if (event
== kbd_store_ptr
)
4172 /* If we find a stored X selection request, handle it now. */
4173 if (event
->kind
== SELECTION_REQUEST_EVENT
4174 || event
->kind
== SELECTION_CLEAR_EVENT
)
4178 /* Remove the event from the fifo buffer before processing;
4179 otherwise swallow_events called recursively could see it
4180 and process it again. To do this, we move the events
4181 between kbd_fetch_ptr and EVENT one slot to the right,
4184 struct input_event copy
= *event
;
4185 struct input_event
*beg
4186 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4187 ? kbd_buffer
: kbd_fetch_ptr
;
4190 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4191 else if (event
< beg
)
4193 if (event
> kbd_buffer
)
4194 memmove (kbd_buffer
+ 1, kbd_buffer
,
4195 (event
- kbd_buffer
) * sizeof (struct input_event
));
4196 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4197 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4198 memmove (beg
+ 1, beg
,
4199 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4200 * sizeof (struct input_event
));
4203 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4204 kbd_fetch_ptr
= kbd_buffer
+ 1;
4208 /* X wants last_event_timestamp for selection ownership. */
4209 last_event_timestamp
= copy
.timestamp
;
4210 input_pending
= readable_events (0);
4211 x_handle_selection_event (©
);
4213 /* We're getting selection request events, but we don't have
4221 /* Process any events that are not user-visible, run timer events that
4222 are ripe, and return, without reading any user-visible events. */
4225 swallow_events (int do_display
)
4229 process_special_events ();
4231 old_timers_run
= timers_run
;
4232 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4234 if (timers_run
!= old_timers_run
&& do_display
)
4235 redisplay_preserve_echo_area (7);
4238 /* Record the start of when Emacs is idle,
4239 for the sake of running idle-time timers. */
4242 timer_start_idle (void)
4246 /* If we are already in the idle state, do nothing. */
4247 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4250 timer_idleness_start_time
= current_emacs_time ();
4251 timer_last_idleness_start_time
= timer_idleness_start_time
;
4253 /* Mark all idle-time timers as once again candidates for running. */
4254 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4258 timer
= XCAR (timers
);
4260 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4262 ASET (timer
, 0, Qnil
);
4266 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4269 timer_stop_idle (void)
4271 timer_idleness_start_time
= invalid_emacs_time ();
4274 /* Resume idle timer from last idle start time. */
4277 timer_resume_idle (void)
4279 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4282 timer_idleness_start_time
= timer_last_idleness_start_time
;
4285 /* This is only for debugging. */
4286 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4288 /* List of elisp functions to call, delayed because they were generated in
4289 a context where Elisp could not be safely run (e.g. redisplay, signal,
4290 ...). Each element has the form (FUN . ARGS). */
4291 Lisp_Object pending_funcalls
;
4293 /* If TIMER is a valid timer, return nonzero and place its value into
4294 *RESULT. Otherwise return zero. */
4296 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4298 Lisp_Object
*vector
;
4300 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4302 vector
= XVECTOR (timer
)->contents
;
4303 if (! NILP (vector
[0]))
4306 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[4],
4311 /* Check whether a timer has fired. To prevent larger problems we simply
4312 disregard elements that are not proper timers. Do not make a circular
4313 timer list for the time being.
4315 Returns the time to wait until the next timer fires. If a
4316 timer is triggering now, return zero.
4317 If no timer is active, return -1.
4319 If a timer is ripe, we run it, with quitting turned off.
4320 In that case we return 0 to indicate that a new timer_check_2 call
4324 timer_check_2 (void)
4326 EMACS_TIME nexttime
;
4328 EMACS_TIME idleness_now
;
4329 Lisp_Object timers
, idle_timers
, chosen_timer
;
4330 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4332 nexttime
= invalid_emacs_time ();
4334 /* Always consider the ordinary timers. */
4335 timers
= Vtimer_list
;
4336 /* Consider the idle timers only if Emacs is idle. */
4337 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4338 idle_timers
= Vtimer_idle_list
;
4341 chosen_timer
= Qnil
;
4342 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4344 /* First run the code that was delayed. */
4345 while (CONSP (pending_funcalls
))
4347 Lisp_Object funcall
= XCAR (pending_funcalls
);
4348 pending_funcalls
= XCDR (pending_funcalls
);
4349 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4352 if (CONSP (timers
) || CONSP (idle_timers
))
4354 now
= current_emacs_time ();
4355 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4356 ? sub_emacs_time (now
, timer_idleness_start_time
)
4357 : make_emacs_time (0, 0));
4360 while (CONSP (timers
) || CONSP (idle_timers
))
4362 Lisp_Object
*vector
;
4363 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4364 EMACS_TIME timer_time
, idle_timer_time
;
4365 EMACS_TIME difference
;
4366 EMACS_TIME timer_difference
= invalid_emacs_time ();
4367 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4368 int ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4370 /* Set TIMER and TIMER_DIFFERENCE
4371 based on the next ordinary timer.
4372 TIMER_DIFFERENCE is the distance in time from NOW to when
4373 this timer becomes ripe (negative if it's already ripe).
4374 Skip past invalid timers and timers already handled. */
4377 timer
= XCAR (timers
);
4378 if (! decode_timer (timer
, &timer_time
))
4380 timers
= XCDR (timers
);
4384 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4385 timer_difference
= (timer_ripe
4386 ? sub_emacs_time (now
, timer_time
)
4387 : sub_emacs_time (timer_time
, now
));
4390 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4391 based on the next idle timer. */
4392 if (CONSP (idle_timers
))
4394 idle_timer
= XCAR (idle_timers
);
4395 if (! decode_timer (idle_timer
, &idle_timer_time
))
4397 idle_timers
= XCDR (idle_timers
);
4401 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4402 idle_timer_difference
=
4404 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4405 : sub_emacs_time (idle_timer_time
, idleness_now
));
4408 /* Decide which timer is the next timer,
4409 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4410 Also step down the list where we found that timer. */
4412 if (EMACS_TIME_VALID_P (timer_difference
)
4413 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4414 || idle_timer_ripe
< timer_ripe
4415 || (idle_timer_ripe
== timer_ripe
4417 ? EMACS_TIME_LT (idle_timer_difference
,
4419 : EMACS_TIME_LT (timer_difference
,
4420 idle_timer_difference
)))))
4422 chosen_timer
= timer
;
4423 timers
= XCDR (timers
);
4424 difference
= timer_difference
;
4429 chosen_timer
= idle_timer
;
4430 idle_timers
= XCDR (idle_timers
);
4431 difference
= idle_timer_difference
;
4432 ripe
= idle_timer_ripe
;
4435 /* If timer is ripe, run it if it hasn't been run. */
4438 vector
= XVECTOR (chosen_timer
)->contents
;
4439 if (NILP (vector
[0]))
4441 ptrdiff_t count
= SPECPDL_INDEX ();
4442 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4444 /* Mark the timer as triggered to prevent problems if the lisp
4445 code fails to reschedule it right. */
4448 specbind (Qinhibit_quit
, Qt
);
4450 call1 (Qtimer_event_handler
, chosen_timer
);
4451 Vdeactivate_mark
= old_deactivate_mark
;
4453 unbind_to (count
, Qnil
);
4455 /* Since we have handled the event,
4456 we don't need to tell the caller to wake up and do it. */
4457 /* But the caller must still wait for the next timer, so
4458 return 0 to indicate that. */
4461 nexttime
= make_emacs_time (0, 0);
4464 /* When we encounter a timer that is still waiting,
4465 return the amount of time to wait before it is ripe. */
4472 /* No timers are pending in the future. */
4473 /* Return 0 if we generated an event, and -1 if not. */
4479 /* Check whether a timer has fired. To prevent larger problems we simply
4480 disregard elements that are not proper timers. Do not make a circular
4481 timer list for the time being.
4483 Returns the time to wait until the next timer fires.
4484 If no timer is active, return an invalid value.
4486 As long as any timer is ripe, we run it. */
4491 EMACS_TIME nexttime
;
4495 nexttime
= timer_check_2 ();
4497 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4502 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4503 doc
: /* Return the current length of Emacs idleness, or nil.
4504 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4505 in the same style as (current-time).
4507 The value when Emacs is not idle is nil.
4509 NSEC is a multiple of the system clock resolution. */)
4512 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4513 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4514 timer_idleness_start_time
));
4519 /* Caches for modify_event_symbol. */
4520 static Lisp_Object accent_key_syms
;
4521 static Lisp_Object func_key_syms
;
4522 static Lisp_Object mouse_syms
;
4523 static Lisp_Object wheel_syms
;
4524 static Lisp_Object drag_n_drop_syms
;
4526 /* This is a list of keysym codes for special "accent" characters.
4527 It parallels lispy_accent_keys. */
4529 static const int lispy_accent_codes
[] =
4531 #ifdef XK_dead_circumflex
4536 #ifdef XK_dead_grave
4541 #ifdef XK_dead_tilde
4546 #ifdef XK_dead_diaeresis
4551 #ifdef XK_dead_macron
4556 #ifdef XK_dead_degree
4561 #ifdef XK_dead_acute
4566 #ifdef XK_dead_cedilla
4571 #ifdef XK_dead_breve
4576 #ifdef XK_dead_ogonek
4581 #ifdef XK_dead_caron
4586 #ifdef XK_dead_doubleacute
4587 XK_dead_doubleacute
,
4591 #ifdef XK_dead_abovedot
4596 #ifdef XK_dead_abovering
4606 #ifdef XK_dead_belowdot
4611 #ifdef XK_dead_voiced_sound
4612 XK_dead_voiced_sound
,
4616 #ifdef XK_dead_semivoiced_sound
4617 XK_dead_semivoiced_sound
,
4633 /* This is a list of Lisp names for special "accent" characters.
4634 It parallels lispy_accent_codes. */
4636 static const char *const lispy_accent_keys
[] =
4654 "dead-voiced-sound",
4655 "dead-semivoiced-sound",
4661 #define FUNCTION_KEY_OFFSET 0x0
4663 const char *const lispy_function_keys
[] =
4667 0, /* VK_LBUTTON 0x01 */
4668 0, /* VK_RBUTTON 0x02 */
4669 "cancel", /* VK_CANCEL 0x03 */
4670 0, /* VK_MBUTTON 0x04 */
4672 0, 0, 0, /* 0x05 .. 0x07 */
4674 "backspace", /* VK_BACK 0x08 */
4675 "tab", /* VK_TAB 0x09 */
4677 0, 0, /* 0x0A .. 0x0B */
4679 "clear", /* VK_CLEAR 0x0C */
4680 "return", /* VK_RETURN 0x0D */
4682 0, 0, /* 0x0E .. 0x0F */
4684 0, /* VK_SHIFT 0x10 */
4685 0, /* VK_CONTROL 0x11 */
4686 0, /* VK_MENU 0x12 */
4687 "pause", /* VK_PAUSE 0x13 */
4688 "capslock", /* VK_CAPITAL 0x14 */
4689 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4691 "junja", /* VK_JUNJA 0x17 */
4692 "final", /* VK_FINAL 0x18 */
4693 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4695 "escape", /* VK_ESCAPE 0x1B */
4696 "convert", /* VK_CONVERT 0x1C */
4697 "non-convert", /* VK_NONCONVERT 0x1D */
4698 "accept", /* VK_ACCEPT 0x1E */
4699 "mode-change", /* VK_MODECHANGE 0x1F */
4700 0, /* VK_SPACE 0x20 */
4701 "prior", /* VK_PRIOR 0x21 */
4702 "next", /* VK_NEXT 0x22 */
4703 "end", /* VK_END 0x23 */
4704 "home", /* VK_HOME 0x24 */
4705 "left", /* VK_LEFT 0x25 */
4706 "up", /* VK_UP 0x26 */
4707 "right", /* VK_RIGHT 0x27 */
4708 "down", /* VK_DOWN 0x28 */
4709 "select", /* VK_SELECT 0x29 */
4710 "print", /* VK_PRINT 0x2A */
4711 "execute", /* VK_EXECUTE 0x2B */
4712 "snapshot", /* VK_SNAPSHOT 0x2C */
4713 "insert", /* VK_INSERT 0x2D */
4714 "delete", /* VK_DELETE 0x2E */
4715 "help", /* VK_HELP 0x2F */
4717 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4719 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4721 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4723 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4725 0, 0, 0, 0, 0, 0, 0, 0, 0,
4726 0, 0, 0, 0, 0, 0, 0, 0, 0,
4727 0, 0, 0, 0, 0, 0, 0, 0,
4729 "lwindow", /* VK_LWIN 0x5B */
4730 "rwindow", /* VK_RWIN 0x5C */
4731 "apps", /* VK_APPS 0x5D */
4734 "kp-0", /* VK_NUMPAD0 0x60 */
4735 "kp-1", /* VK_NUMPAD1 0x61 */
4736 "kp-2", /* VK_NUMPAD2 0x62 */
4737 "kp-3", /* VK_NUMPAD3 0x63 */
4738 "kp-4", /* VK_NUMPAD4 0x64 */
4739 "kp-5", /* VK_NUMPAD5 0x65 */
4740 "kp-6", /* VK_NUMPAD6 0x66 */
4741 "kp-7", /* VK_NUMPAD7 0x67 */
4742 "kp-8", /* VK_NUMPAD8 0x68 */
4743 "kp-9", /* VK_NUMPAD9 0x69 */
4744 "kp-multiply", /* VK_MULTIPLY 0x6A */
4745 "kp-add", /* VK_ADD 0x6B */
4746 "kp-separator", /* VK_SEPARATOR 0x6C */
4747 "kp-subtract", /* VK_SUBTRACT 0x6D */
4748 "kp-decimal", /* VK_DECIMAL 0x6E */
4749 "kp-divide", /* VK_DIVIDE 0x6F */
4750 "f1", /* VK_F1 0x70 */
4751 "f2", /* VK_F2 0x71 */
4752 "f3", /* VK_F3 0x72 */
4753 "f4", /* VK_F4 0x73 */
4754 "f5", /* VK_F5 0x74 */
4755 "f6", /* VK_F6 0x75 */
4756 "f7", /* VK_F7 0x76 */
4757 "f8", /* VK_F8 0x77 */
4758 "f9", /* VK_F9 0x78 */
4759 "f10", /* VK_F10 0x79 */
4760 "f11", /* VK_F11 0x7A */
4761 "f12", /* VK_F12 0x7B */
4762 "f13", /* VK_F13 0x7C */
4763 "f14", /* VK_F14 0x7D */
4764 "f15", /* VK_F15 0x7E */
4765 "f16", /* VK_F16 0x7F */
4766 "f17", /* VK_F17 0x80 */
4767 "f18", /* VK_F18 0x81 */
4768 "f19", /* VK_F19 0x82 */
4769 "f20", /* VK_F20 0x83 */
4770 "f21", /* VK_F21 0x84 */
4771 "f22", /* VK_F22 0x85 */
4772 "f23", /* VK_F23 0x86 */
4773 "f24", /* VK_F24 0x87 */
4775 0, 0, 0, 0, /* 0x88 .. 0x8B */
4776 0, 0, 0, 0, /* 0x8C .. 0x8F */
4778 "kp-numlock", /* VK_NUMLOCK 0x90 */
4779 "scroll", /* VK_SCROLL 0x91 */
4780 /* Not sure where the following block comes from.
4781 Windows headers have NEC and Fujitsu specific keys in
4782 this block, but nothing generic. */
4783 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4784 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4785 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4786 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4787 "kp-end", /* VK_NUMPAD_END 0x96 */
4788 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4789 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4790 "kp-up", /* VK_NUMPAD_UP 0x99 */
4791 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4792 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4793 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4794 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4796 0, 0, /* 0x9E .. 0x9F */
4799 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4800 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4801 * No other API or message will distinguish left and right keys this way.
4806 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4807 to enable them selectively, and gives access to a few more functions.
4808 See lispy_multimedia_keys below. */
4809 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4810 0, 0, 0, /* 0xAD .. 0xAF Volume */
4811 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4812 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4814 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4815 0, 0, 0, 0, 0, 0, 0, 0, 0,
4817 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4818 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4819 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4822 "ax", /* VK_OEM_AX 0xE1 */
4823 0, /* VK_OEM_102 0xE2 */
4824 "ico-help", /* VK_ICO_HELP 0xE3 */
4825 "ico-00", /* VK_ICO_00 0xE4 */
4826 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4827 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4828 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4830 "reset", /* VK_OEM_RESET 0xE9 */
4831 "jump", /* VK_OEM_JUMP 0xEA */
4832 "oem-pa1", /* VK_OEM_PA1 0xEB */
4833 "oem-pa2", /* VK_OEM_PA2 0xEC */
4834 "oem-pa3", /* VK_OEM_PA3 0xED */
4835 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4836 "cusel", /* VK_OEM_CUSEL 0xEF */
4837 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4838 "finish", /* VK_OEM_FINISH 0xF1 */
4839 "copy", /* VK_OEM_COPY 0xF2 */
4840 "auto", /* VK_OEM_AUTO 0xF3 */
4841 "enlw", /* VK_OEM_ENLW 0xF4 */
4842 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4843 "attn", /* VK_ATTN 0xF6 */
4844 "crsel", /* VK_CRSEL 0xF7 */
4845 "exsel", /* VK_EXSEL 0xF8 */
4846 "ereof", /* VK_EREOF 0xF9 */
4847 "play", /* VK_PLAY 0xFA */
4848 "zoom", /* VK_ZOOM 0xFB */
4849 "noname", /* VK_NONAME 0xFC */
4850 "pa1", /* VK_PA1 0xFD */
4851 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4855 /* Some of these duplicate the "Media keys" on newer keyboards,
4856 but they are delivered to the application in a different way. */
4857 static const char *const lispy_multimedia_keys
[] =
4865 "browser-favorites",
4902 "toggle-dictate-command",
4908 "media-fast-forward",
4911 "media-channel-down"
4914 #else /* not HAVE_NTGUI */
4916 /* This should be dealt with in XTread_socket now, and that doesn't
4917 depend on the client system having the Kana syms defined. See also
4918 the XK_kana_A case below. */
4921 static const char *const lispy_kana_keys
[] =
4923 /* X Keysym value */
4924 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4925 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4926 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4927 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4928 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4929 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4930 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4931 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4932 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4933 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4934 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4935 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4936 "kana-i", "kana-u", "kana-e", "kana-o",
4937 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4938 "prolongedsound", "kana-A", "kana-I", "kana-U",
4939 "kana-E", "kana-O", "kana-KA", "kana-KI",
4940 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4941 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4942 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4943 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4944 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4945 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4946 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4947 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4948 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4949 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4950 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4951 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4953 #endif /* XK_kana_A */
4956 #define FUNCTION_KEY_OFFSET 0xff00
4958 /* You'll notice that this table is arranged to be conveniently
4959 indexed by X Windows keysym values. */
4960 static const char *const lispy_function_keys
[] =
4962 /* X Keysym value */
4964 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4965 "backspace", "tab", "linefeed", "clear",
4967 0, 0, 0, "pause", /* 0xff10...1f */
4968 0, 0, 0, 0, 0, 0, 0, "escape",
4970 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4971 "romaji", "hiragana", "katakana", "hiragana-katakana",
4972 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4973 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4974 "eisu-toggle", /* 0xff30...3f */
4975 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4976 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4978 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4979 "down", "prior", "next", "end",
4980 "begin", 0, 0, 0, 0, 0, 0, 0,
4981 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4992 "break", /* 0xff6b */
4995 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4996 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4997 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4998 0, 0, 0, 0, 0, 0, 0, 0,
4999 "kp-tab", /* 0xff89 */
5001 "kp-enter", /* 0xff8d */
5003 "kp-f1", /* 0xff91 */
5007 "kp-home", /* 0xff95 */
5012 "kp-prior", /* kp-page-up */
5013 "kp-next", /* kp-page-down */
5019 0, 0, 0, 0, 0, 0, 0, 0, 0,
5020 "kp-multiply", /* 0xffaa */
5025 "kp-divide", /* 0xffaf */
5026 "kp-0", /* 0xffb0 */
5027 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5030 "kp-equal", /* 0xffbd */
5031 "f1", /* 0xffbe */ /* IsFunctionKey */
5033 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5034 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5035 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5036 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5037 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5038 0, 0, 0, 0, 0, 0, 0, 0,
5039 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5040 0, 0, 0, 0, 0, 0, 0, "delete"
5043 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5044 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5046 static const char *const iso_lispy_function_keys
[] =
5048 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5049 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5050 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5051 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5052 "iso-lefttab", /* 0xfe20 */
5053 "iso-move-line-up", "iso-move-line-down",
5054 "iso-partial-line-up", "iso-partial-line-down",
5055 "iso-partial-space-left", "iso-partial-space-right",
5056 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5057 "iso-release-margin-left", "iso-release-margin-right",
5058 "iso-release-both-margins",
5059 "iso-fast-cursor-left", "iso-fast-cursor-right",
5060 "iso-fast-cursor-up", "iso-fast-cursor-down",
5061 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5062 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5065 #endif /* not HAVE_NTGUI */
5067 static Lisp_Object Vlispy_mouse_stem
;
5069 static const char *const lispy_wheel_names
[] =
5071 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5074 /* drag-n-drop events are generated when a set of selected files are
5075 dragged from another application and dropped onto an Emacs window. */
5076 static const char *const lispy_drag_n_drop_names
[] =
5081 /* Scroll bar parts. */
5082 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5083 Lisp_Object Qup
, Qdown
, Qbottom
;
5084 static Lisp_Object Qend_scroll
;
5086 static Lisp_Object Qratio
;
5088 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5089 static Lisp_Object
*const scroll_bar_parts
[] = {
5090 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5091 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5094 /* A vector, indexed by button number, giving the down-going location
5095 of currently depressed buttons, both scroll bar and non-scroll bar.
5097 The elements have the form
5098 (BUTTON-NUMBER MODIFIER-MASK . REST)
5099 where REST is the cdr of a position as it would be reported in the event.
5101 The make_lispy_event function stores positions here to tell the
5102 difference between click and drag events, and to store the starting
5103 location to be included in drag events. */
5105 static Lisp_Object button_down_location
;
5107 /* Information about the most recent up-going button event: Which
5108 button, what location, and what time. */
5110 static int last_mouse_button
;
5111 static int last_mouse_x
;
5112 static int last_mouse_y
;
5113 static Time button_down_time
;
5115 /* The number of clicks in this multiple-click. */
5117 static int double_click_count
;
5119 /* X and Y are frame-relative coordinates for a click or wheel event.
5120 Return a Lisp-style event list. */
5123 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5126 enum window_part part
;
5127 Lisp_Object posn
= Qnil
;
5128 Lisp_Object extra_info
= Qnil
;
5129 /* Coordinate pixel positions to return. */
5130 int xret
= 0, yret
= 0;
5131 /* The window under frame pixel coordinates (x,y) */
5132 Lisp_Object window
= f
5133 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5136 if (WINDOWP (window
))
5138 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5139 struct window
*w
= XWINDOW (window
);
5140 Lisp_Object string_info
= Qnil
;
5141 ptrdiff_t textpos
= -1;
5142 int col
= -1, row
= -1;
5143 int dx
= -1, dy
= -1;
5144 int width
= -1, height
= -1;
5145 Lisp_Object object
= Qnil
;
5147 /* Pixel coordinates relative to the window corner. */
5148 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5149 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5151 /* For text area clicks, return X, Y relative to the corner of
5152 this text area. Note that dX, dY etc are set below, by
5153 buffer_posn_from_coords. */
5154 if (part
== ON_TEXT
)
5156 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5157 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5159 /* For mode line and header line clicks, return X, Y relative to
5160 the left window edge. Use mode_line_string to look for a
5161 string on the click position. */
5162 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5167 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5168 /* Note that mode_line_string takes COL, ROW as pixels and
5169 converts them to characters. */
5172 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5173 &object
, &dx
, &dy
, &width
, &height
);
5174 if (STRINGP (string
))
5175 string_info
= Fcons (string
, make_number (charpos
));
5176 textpos
= (w
== XWINDOW (selected_window
)
5177 && current_buffer
== XBUFFER (WVAR (w
, buffer
)))
5178 ? PT
: XMARKER (WVAR (w
, pointm
))->charpos
;
5183 /* For fringes and margins, Y is relative to the area's (and the
5184 window's) top edge, while X is meaningless. */
5185 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5190 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5193 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5194 &object
, &dx
, &dy
, &width
, &height
);
5195 if (STRINGP (string
))
5196 string_info
= Fcons (string
, make_number (charpos
));
5197 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5199 else if (part
== ON_LEFT_FRINGE
)
5201 posn
= Qleft_fringe
;
5204 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5205 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5206 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5208 else if (part
== ON_RIGHT_FRINGE
)
5210 posn
= Qright_fringe
;
5213 - window_box_width (w
, LEFT_MARGIN_AREA
)
5214 - window_box_width (w
, TEXT_AREA
)
5215 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5216 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5218 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5220 else if (part
== ON_VERTICAL_BORDER
)
5222 posn
= Qvertical_line
;
5227 /* Nothing special for part == ON_SCROLL_BAR. */
5229 /* For clicks in the text area, fringes, or margins, call
5230 buffer_posn_from_coords to extract TEXTPOS, the buffer
5231 position nearest to the click. */
5234 Lisp_Object string2
, object2
= Qnil
;
5235 struct display_pos p
;
5237 int width2
, height2
;
5238 /* The pixel X coordinate passed to buffer_posn_from_coords
5239 is the X coordinate relative to the text area for
5240 text-area and right-margin clicks, zero otherwise. */
5242 = (part
== ON_TEXT
) ? xret
5243 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5244 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5248 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5249 &object2
, &dx2
, &dy2
,
5251 textpos
= CHARPOS (p
.pos
);
5252 if (col
< 0) col
= x2
;
5253 if (row
< 0) row
= y2
;
5254 if (dx
< 0) dx
= dx2
;
5255 if (dy
< 0) dy
= dy2
;
5256 if (width
< 0) width
= width2
;
5257 if (height
< 0) height
= height2
;
5261 posn
= make_number (textpos
);
5262 if (STRINGP (string2
))
5263 string_info
= Fcons (string2
,
5264 make_number (CHARPOS (p
.string_pos
)));
5270 #ifdef HAVE_WINDOW_SYSTEM
5271 if (IMAGEP (object
))
5273 Lisp_Object image_map
, hotspot
;
5274 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5276 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5278 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5279 posn
= XCAR (hotspot
);
5286 Fcons (make_number (dx
), make_number (dy
)),
5287 Fcons (make_number (width
), make_number (height
)));
5290 extra_info
= Fcons (string_info
,
5291 Fcons (make_number (textpos
),
5292 Fcons (Fcons (make_number (col
),
5297 XSETFRAME (window
, f
);
5301 return Fcons (window
,
5303 Fcons (Fcons (make_number (xret
),
5304 make_number (yret
)),
5305 Fcons (make_number (t
),
5309 /* Given a struct input_event, build the lisp event which represents
5310 it. If EVENT is 0, build a mouse movement event from the mouse
5311 movement buffer, which should have a movement event in it.
5313 Note that events must be passed to this function in the order they
5314 are received; this function stores the location of button presses
5315 in order to build drag events when the button is released. */
5318 make_lispy_event (struct input_event
*event
)
5322 switch (event
->kind
)
5324 /* A simple keystroke. */
5325 case ASCII_KEYSTROKE_EVENT
:
5326 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5328 Lisp_Object lispy_c
;
5329 EMACS_INT c
= event
->code
;
5330 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5333 eassert (c
== event
->code
);
5334 /* Turn ASCII characters into control characters
5336 if (event
->modifiers
& ctrl_modifier
)
5338 c
= make_ctrl_char (c
);
5339 event
->modifiers
&= ~ctrl_modifier
;
5343 /* Add in the other modifier bits. The shift key was taken care
5344 of by the X code. */
5345 c
|= (event
->modifiers
5346 & (meta_modifier
| alt_modifier
5347 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5348 /* Distinguish Shift-SPC from SPC. */
5349 if ((event
->code
) == 040
5350 && event
->modifiers
& shift_modifier
)
5351 c
|= shift_modifier
;
5352 button_down_time
= 0;
5353 XSETFASTINT (lispy_c
, c
);
5358 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5359 except that they are non-key events (last-nonmenu-event is nil). */
5360 case NS_NONKEY_EVENT
:
5363 /* A function key. The symbol may need to have modifier prefixes
5365 case NON_ASCII_KEYSTROKE_EVENT
:
5366 button_down_time
= 0;
5368 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5369 if (event
->code
== lispy_accent_codes
[i
])
5370 return modify_event_symbol (i
,
5372 Qfunction_key
, Qnil
,
5373 lispy_accent_keys
, &accent_key_syms
,
5374 (sizeof (lispy_accent_keys
)
5375 / sizeof (lispy_accent_keys
[0])));
5379 if (event
->code
>= 0x400 && event
->code
< 0x500)
5380 return modify_event_symbol (event
->code
- 0x400,
5381 event
->modifiers
& ~shift_modifier
,
5382 Qfunction_key
, Qnil
,
5383 lispy_kana_keys
, &func_key_syms
,
5384 (sizeof (lispy_kana_keys
)
5385 / sizeof (lispy_kana_keys
[0])));
5386 #endif /* XK_kana_A */
5389 #ifdef ISO_FUNCTION_KEY_OFFSET
5390 if (event
->code
< FUNCTION_KEY_OFFSET
5391 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5392 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5394 Qfunction_key
, Qnil
,
5395 iso_lispy_function_keys
, &func_key_syms
,
5396 (sizeof (iso_lispy_function_keys
)
5397 / sizeof (iso_lispy_function_keys
[0])));
5400 /* Handle system-specific or unknown keysyms. */
5401 if (event
->code
& (1 << 28)
5402 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5403 || (event
->code
- FUNCTION_KEY_OFFSET
5404 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5405 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5407 /* We need to use an alist rather than a vector as the cache
5408 since we can't make a vector long enough. */
5409 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5410 KVAR (current_kboard
, system_key_syms
) = Fcons (Qnil
, Qnil
);
5411 return modify_event_symbol (event
->code
,
5414 KVAR (current_kboard
, Vsystem_key_alist
),
5415 0, &KVAR (current_kboard
, system_key_syms
),
5419 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5421 Qfunction_key
, Qnil
,
5422 lispy_function_keys
, &func_key_syms
,
5423 (sizeof (lispy_function_keys
)
5424 / sizeof (lispy_function_keys
[0])));
5427 case MULTIMEDIA_KEY_EVENT
:
5428 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5429 / sizeof (lispy_multimedia_keys
[0]))
5430 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5432 return modify_event_symbol (event
->code
, event
->modifiers
,
5433 Qfunction_key
, Qnil
,
5434 lispy_multimedia_keys
, &func_key_syms
,
5435 (sizeof (lispy_multimedia_keys
)
5436 / sizeof (lispy_multimedia_keys
[0])));
5442 /* A mouse click. Figure out where it is, decide whether it's
5443 a press, click or drag, and build the appropriate structure. */
5444 case MOUSE_CLICK_EVENT
:
5445 #ifndef USE_TOOLKIT_SCROLL_BARS
5446 case SCROLL_BAR_CLICK_EVENT
:
5449 int button
= event
->code
;
5451 Lisp_Object position
;
5452 Lisp_Object
*start_pos_ptr
;
5453 Lisp_Object start_pos
;
5457 /* Build the position as appropriate for this mouse click. */
5458 if (event
->kind
== MOUSE_CLICK_EVENT
)
5460 struct frame
*f
= XFRAME (event
->frame_or_window
);
5461 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5465 /* Ignore mouse events that were made on frame that
5466 have been deleted. */
5467 if (! FRAME_LIVE_P (f
))
5470 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5471 /* EVENT->x and EVENT->y are frame-relative pixel
5472 coordinates at this place. Under old redisplay, COLUMN
5473 and ROW are set to frame relative glyph coordinates
5474 which are then used to determine whether this click is
5475 in a menu (non-toolkit version). */
5476 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5477 &column
, &row
, NULL
, 1);
5479 /* In the non-toolkit version, clicks on the menu bar
5480 are ordinary button events in the event buffer.
5481 Distinguish them, and invoke the menu.
5483 (In the toolkit version, the toolkit handles the menu bar
5484 and Emacs doesn't know about it until after the user
5485 makes a selection.) */
5486 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5487 && (event
->modifiers
& down_modifier
))
5489 Lisp_Object items
, item
;
5491 /* Find the menu bar item under `column'. */
5493 items
= FRAME_MENU_BAR_ITEMS (f
);
5494 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5496 Lisp_Object pos
, string
;
5497 string
= AREF (items
, i
+ 1);
5498 pos
= AREF (items
, i
+ 3);
5501 if (column
>= XINT (pos
)
5502 && column
< XINT (pos
) + SCHARS (string
))
5504 item
= AREF (items
, i
);
5509 /* ELisp manual 2.4b says (x y) are window relative but
5510 code says they are frame-relative. */
5512 = Fcons (event
->frame_or_window
,
5514 Fcons (Fcons (event
->x
, event
->y
),
5515 Fcons (make_number (event
->timestamp
),
5518 return Fcons (item
, Fcons (position
, Qnil
));
5520 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5522 position
= make_lispy_position (f
, event
->x
, event
->y
,
5525 #ifndef USE_TOOLKIT_SCROLL_BARS
5528 /* It's a scrollbar click. */
5530 Lisp_Object portion_whole
;
5533 window
= event
->frame_or_window
;
5534 portion_whole
= Fcons (event
->x
, event
->y
);
5535 part
= *scroll_bar_parts
[(int) event
->part
];
5539 Fcons (Qvertical_scroll_bar
,
5540 Fcons (portion_whole
,
5541 Fcons (make_number (event
->timestamp
),
5542 Fcons (part
, Qnil
)))));
5544 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5546 if (button
>= ASIZE (button_down_location
))
5548 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5549 button_down_location
= larger_vector (button_down_location
,
5551 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5554 start_pos_ptr
= aref_addr (button_down_location
, button
);
5555 start_pos
= *start_pos_ptr
;
5556 *start_pos_ptr
= Qnil
;
5559 /* On window-system frames, use the value of
5560 double-click-fuzz as is. On other frames, interpret it
5561 as a multiple of 1/8 characters. */
5565 if (WINDOWP (event
->frame_or_window
))
5566 f
= XFRAME (WVAR (XWINDOW (event
->frame_or_window
), frame
));
5567 else if (FRAMEP (event
->frame_or_window
))
5568 f
= XFRAME (event
->frame_or_window
);
5572 if (FRAME_WINDOW_P (f
))
5573 fuzz
= double_click_fuzz
;
5575 fuzz
= double_click_fuzz
/ 8;
5577 is_double
= (button
== last_mouse_button
5578 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5579 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5580 && button_down_time
!= 0
5581 && (EQ (Vdouble_click_time
, Qt
)
5582 || (NATNUMP (Vdouble_click_time
)
5583 && (event
->timestamp
- button_down_time
5584 < XFASTINT (Vdouble_click_time
)))));
5587 last_mouse_button
= button
;
5588 last_mouse_x
= XINT (event
->x
);
5589 last_mouse_y
= XINT (event
->y
);
5591 /* If this is a button press, squirrel away the location, so
5592 we can decide later whether it was a click or a drag. */
5593 if (event
->modifiers
& down_modifier
)
5597 double_click_count
++;
5598 event
->modifiers
|= ((double_click_count
> 2)
5603 double_click_count
= 1;
5604 button_down_time
= event
->timestamp
;
5605 *start_pos_ptr
= Fcopy_alist (position
);
5606 ignore_mouse_drag_p
= 0;
5609 /* Now we're releasing a button - check the co-ordinates to
5610 see if this was a click or a drag. */
5611 else if (event
->modifiers
& up_modifier
)
5613 /* If we did not see a down before this up, ignore the up.
5614 Probably this happened because the down event chose a
5615 menu item. It would be an annoyance to treat the
5616 release of the button that chose the menu item as a
5619 if (!CONSP (start_pos
))
5622 event
->modifiers
&= ~up_modifier
;
5625 Lisp_Object new_down
, down
;
5626 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5628 /* The third element of every position
5629 should be the (x,y) pair. */
5630 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5631 new_down
= Fcar (Fcdr (Fcdr (position
)));
5634 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5636 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5637 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5640 if (ignore_mouse_drag_p
)
5642 event
->modifiers
|= click_modifier
;
5643 ignore_mouse_drag_p
= 0;
5645 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5646 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5647 /* Maybe the mouse has moved a lot, caused scrolling, and
5648 eventually ended up at the same screen position (but
5649 not buffer position) in which case it is a drag, not
5651 /* FIXME: OTOH if the buffer position has changed
5652 because of a timer or process filter rather than
5653 because of mouse movement, it should be considered as
5654 a click. But mouse-drag-region completely ignores
5655 this case and it hasn't caused any real problem, so
5656 it's probably OK to ignore it as well. */
5657 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5658 /* Mouse hasn't moved (much). */
5659 event
->modifiers
|= click_modifier
;
5662 button_down_time
= 0;
5663 event
->modifiers
|= drag_modifier
;
5666 /* Don't check is_double; treat this as multiple
5667 if the down-event was multiple. */
5668 if (double_click_count
> 1)
5669 event
->modifiers
|= ((double_click_count
> 2)
5675 /* Every mouse event should either have the down_modifier or
5676 the up_modifier set. */
5680 /* Get the symbol we should use for the mouse click. */
5683 head
= modify_event_symbol (button
,
5685 Qmouse_click
, Vlispy_mouse_stem
,
5688 ASIZE (mouse_syms
));
5689 if (event
->modifiers
& drag_modifier
)
5694 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5697 Fcons (make_number (double_click_count
),
5707 case HORIZ_WHEEL_EVENT
:
5709 Lisp_Object position
;
5712 /* Build the position as appropriate for this mouse click. */
5713 struct frame
*f
= XFRAME (event
->frame_or_window
);
5715 /* Ignore wheel events that were made on frame that have been
5717 if (! FRAME_LIVE_P (f
))
5720 position
= make_lispy_position (f
, event
->x
, event
->y
,
5723 /* Set double or triple modifiers to indicate the wheel speed. */
5725 /* On window-system frames, use the value of
5726 double-click-fuzz as is. On other frames, interpret it
5727 as a multiple of 1/8 characters. */
5733 if (WINDOWP (event
->frame_or_window
))
5734 fr
= XFRAME (WVAR (XWINDOW (event
->frame_or_window
), frame
));
5735 else if (FRAMEP (event
->frame_or_window
))
5736 fr
= XFRAME (event
->frame_or_window
);
5740 fuzz
= FRAME_WINDOW_P (fr
)
5741 ? double_click_fuzz
: double_click_fuzz
/ 8;
5743 if (event
->modifiers
& up_modifier
)
5745 /* Emit a wheel-up event. */
5746 event
->modifiers
&= ~up_modifier
;
5749 else if (event
->modifiers
& down_modifier
)
5751 /* Emit a wheel-down event. */
5752 event
->modifiers
&= ~down_modifier
;
5756 /* Every wheel event should either have the down_modifier or
5757 the up_modifier set. */
5760 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5763 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5764 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5765 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5766 && button_down_time
!= 0
5767 && (EQ (Vdouble_click_time
, Qt
)
5768 || (NATNUMP (Vdouble_click_time
)
5769 && (event
->timestamp
- button_down_time
5770 < XFASTINT (Vdouble_click_time
)))));
5773 double_click_count
++;
5774 event
->modifiers
|= ((double_click_count
> 2)
5780 double_click_count
= 1;
5781 event
->modifiers
|= click_modifier
;
5784 button_down_time
= event
->timestamp
;
5785 /* Use a negative value to distinguish wheel from mouse button. */
5786 last_mouse_button
= - (1 + symbol_num
);
5787 last_mouse_x
= XINT (event
->x
);
5788 last_mouse_y
= XINT (event
->y
);
5790 /* Get the symbol we should use for the wheel event. */
5791 head
= modify_event_symbol (symbol_num
,
5797 ASIZE (wheel_syms
));
5800 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5803 Fcons (make_number (double_click_count
),
5812 #ifdef USE_TOOLKIT_SCROLL_BARS
5814 /* We don't have down and up events if using toolkit scroll bars,
5815 so make this always a click event. Store in the `part' of
5816 the Lisp event a symbol which maps to the following actions:
5818 `above_handle' page up
5819 `below_handle' page down
5823 `bottom' bottom of buffer
5824 `handle' thumb has been dragged.
5825 `end-scroll' end of interaction with scroll bar
5827 The incoming input_event contains in its `part' member an
5828 index of type `enum scroll_bar_part' which we can use as an
5829 index in scroll_bar_parts to get the appropriate symbol. */
5831 case SCROLL_BAR_CLICK_EVENT
:
5833 Lisp_Object position
, head
, window
, portion_whole
, part
;
5835 window
= event
->frame_or_window
;
5836 portion_whole
= Fcons (event
->x
, event
->y
);
5837 part
= *scroll_bar_parts
[(int) event
->part
];
5841 Fcons (Qvertical_scroll_bar
,
5842 Fcons (portion_whole
,
5843 Fcons (make_number (event
->timestamp
),
5844 Fcons (part
, Qnil
)))));
5846 /* Always treat scroll bar events as clicks. */
5847 event
->modifiers
|= click_modifier
;
5848 event
->modifiers
&= ~up_modifier
;
5850 if (event
->code
>= ASIZE (mouse_syms
))
5851 mouse_syms
= larger_vector (mouse_syms
,
5852 event
->code
- ASIZE (mouse_syms
) + 1,
5855 /* Get the symbol we should use for the mouse click. */
5856 head
= modify_event_symbol (event
->code
,
5861 ASIZE (mouse_syms
));
5862 return Fcons (head
, Fcons (position
, Qnil
));
5865 #endif /* USE_TOOLKIT_SCROLL_BARS */
5867 case DRAG_N_DROP_EVENT
:
5870 Lisp_Object head
, position
;
5873 f
= XFRAME (event
->frame_or_window
);
5876 /* Ignore mouse events that were made on frames that
5877 have been deleted. */
5878 if (! FRAME_LIVE_P (f
))
5881 position
= make_lispy_position (f
, event
->x
, event
->y
,
5884 head
= modify_event_symbol (0, event
->modifiers
,
5886 lispy_drag_n_drop_names
,
5887 &drag_n_drop_syms
, 1);
5893 #endif /* HAVE_MOUSE */
5895 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5896 || defined (HAVE_NS) || defined (USE_GTK)
5897 case MENU_BAR_EVENT
:
5898 if (EQ (event
->arg
, event
->frame_or_window
))
5899 /* This is the prefix key. We translate this to
5900 `(menu_bar)' because the code in keyboard.c for menu
5901 events, which we use, relies on this. */
5902 return Fcons (Qmenu_bar
, Qnil
);
5906 case SELECT_WINDOW_EVENT
:
5907 /* Make an event (select-window (WINDOW)). */
5908 return Fcons (Qselect_window
,
5909 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5912 case TOOL_BAR_EVENT
:
5913 if (EQ (event
->arg
, event
->frame_or_window
))
5914 /* This is the prefix key. We translate this to
5915 `(tool_bar)' because the code in keyboard.c for tool bar
5916 events, which we use, relies on this. */
5917 return Fcons (Qtool_bar
, Qnil
);
5918 else if (SYMBOLP (event
->arg
))
5919 return apply_modifiers (event
->modifiers
, event
->arg
);
5922 case USER_SIGNAL_EVENT
:
5923 /* A user signal. */
5925 char *name
= find_user_signal_name (event
->code
);
5928 return intern (name
);
5931 case SAVE_SESSION_EVENT
:
5932 return Qsave_session
;
5937 return Fcons (Qdbus_event
, event
->arg
);
5939 #endif /* HAVE_DBUS */
5941 case CONFIG_CHANGED_EVENT
:
5942 return Fcons (Qconfig_changed_event
,
5944 Fcons (event
->frame_or_window
, Qnil
)));
5946 case GPM_CLICK_EVENT
:
5948 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5949 Lisp_Object head
, position
;
5950 Lisp_Object
*start_pos_ptr
;
5951 Lisp_Object start_pos
;
5952 int button
= event
->code
;
5954 if (button
>= ASIZE (button_down_location
))
5956 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5957 button_down_location
= larger_vector (button_down_location
,
5959 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5962 start_pos_ptr
= aref_addr (button_down_location
, button
);
5963 start_pos
= *start_pos_ptr
;
5965 position
= make_lispy_position (f
, event
->x
, event
->y
,
5968 if (event
->modifiers
& down_modifier
)
5969 *start_pos_ptr
= Fcopy_alist (position
);
5970 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5972 if (!CONSP (start_pos
))
5974 event
->modifiers
&= ~up_modifier
;
5977 head
= modify_event_symbol (button
,
5979 Qmouse_click
, Vlispy_mouse_stem
,
5982 ASIZE (mouse_syms
));
5984 if (event
->modifiers
& drag_modifier
)
5989 else if (event
->modifiers
& double_modifier
)
5992 Fcons (make_number (2),
5994 else if (event
->modifiers
& triple_modifier
)
5997 Fcons (make_number (3),
6004 #endif /* HAVE_GPM */
6006 /* The 'kind' field of the event is something we don't recognize. */
6012 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6015 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6016 Lisp_Object x
, Lisp_Object y
, Time t
)
6018 /* Is it a scroll bar movement? */
6019 if (frame
&& ! NILP (bar_window
))
6021 Lisp_Object part_sym
;
6023 part_sym
= *scroll_bar_parts
[(int) part
];
6024 return Fcons (Qscroll_bar_movement
,
6025 Fcons (list5 (bar_window
,
6026 Qvertical_scroll_bar
,
6032 /* Or is it an ordinary mouse movement? */
6035 Lisp_Object position
;
6036 position
= make_lispy_position (frame
, x
, y
, t
);
6037 return list2 (Qmouse_movement
, position
);
6041 #endif /* HAVE_MOUSE || HAVE GPM */
6043 /* Construct a switch frame event. */
6045 make_lispy_switch_frame (Lisp_Object frame
)
6047 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6050 /* Manipulating modifiers. */
6052 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6054 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6055 SYMBOL's name of the end of the modifiers; the string from this
6056 position is the unmodified symbol name.
6058 This doesn't use any caches. */
6061 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6067 CHECK_SYMBOL (symbol
);
6070 name
= SYMBOL_NAME (symbol
);
6072 for (i
= 0; i
< SBYTES (name
) - 1; )
6074 ptrdiff_t this_mod_end
= 0;
6077 /* See if the name continues with a modifier word.
6078 Check that the word appears, but don't check what follows it.
6079 Set this_mod and this_mod_end to record what we find. */
6081 switch (SREF (name
, i
))
6083 #define SINGLE_LETTER_MOD(BIT) \
6084 (this_mod_end = i + 1, this_mod = BIT)
6087 SINGLE_LETTER_MOD (alt_modifier
);
6091 SINGLE_LETTER_MOD (ctrl_modifier
);
6095 SINGLE_LETTER_MOD (hyper_modifier
);
6099 SINGLE_LETTER_MOD (meta_modifier
);
6103 SINGLE_LETTER_MOD (shift_modifier
);
6107 SINGLE_LETTER_MOD (super_modifier
);
6110 #undef SINGLE_LETTER_MOD
6112 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6113 if (i + LEN + 1 <= SBYTES (name) \
6114 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6116 this_mod_end = i + LEN; \
6121 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6122 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6123 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6127 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6129 #undef MULTI_LETTER_MOD
6133 /* If we found no modifier, stop looking for them. */
6134 if (this_mod_end
== 0)
6137 /* Check there is a dash after the modifier, so that it
6138 really is a modifier. */
6139 if (this_mod_end
>= SBYTES (name
)
6140 || SREF (name
, this_mod_end
) != '-')
6143 /* This modifier is real; look for another. */
6144 modifiers
|= this_mod
;
6145 i
= this_mod_end
+ 1;
6148 /* Should we include the `click' modifier? */
6149 if (! (modifiers
& (down_modifier
| drag_modifier
6150 | double_modifier
| triple_modifier
))
6151 && i
+ 7 == SBYTES (name
)
6152 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6153 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6154 modifiers
|= click_modifier
;
6156 if (! (modifiers
& (double_modifier
| triple_modifier
))
6157 && i
+ 6 < SBYTES (name
)
6158 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6159 modifiers
|= click_modifier
;
6167 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6168 prepended to the string BASE[0..BASE_LEN-1].
6169 This doesn't use any caches. */
6171 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6173 /* Since BASE could contain nulls, we can't use intern here; we have
6174 to use Fintern, which expects a genuine Lisp_String, and keeps a
6176 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6182 /* Only the event queue may use the `up' modifier; it should always
6183 be turned into a click or drag event before presented to lisp code. */
6184 if (modifiers
& up_modifier
)
6187 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6188 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6189 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6190 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6191 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6192 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6193 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6194 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6195 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6196 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6197 /* The click modifier is denoted by the absence of other modifiers. */
6201 mod_len
= p
- new_mods
;
6205 Lisp_Object new_name
;
6207 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6208 mod_len
+ base_len_byte
);
6209 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6210 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6212 return Fintern (new_name
, Qnil
);
6217 static const char *const modifier_names
[] =
6219 "up", "down", "drag", "click", "double", "triple", 0, 0,
6220 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6221 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6223 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6225 static Lisp_Object modifier_symbols
;
6227 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6229 lispy_modifier_list (int modifiers
)
6231 Lisp_Object modifier_list
;
6234 modifier_list
= Qnil
;
6235 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6236 if (modifiers
& (1<<i
))
6237 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6240 return modifier_list
;
6244 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6245 where UNMODIFIED is the unmodified form of SYMBOL,
6246 MASK is the set of modifiers present in SYMBOL's name.
6247 This is similar to parse_modifiers_uncached, but uses the cache in
6248 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6249 Qevent_symbol_elements property. */
6251 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6254 parse_modifiers (Lisp_Object symbol
)
6256 Lisp_Object elements
;
6258 if (INTEGERP (symbol
))
6259 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6260 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6262 else if (!SYMBOLP (symbol
))
6265 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6266 if (CONSP (elements
))
6271 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6272 Lisp_Object unmodified
;
6275 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6276 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6279 if (modifiers
& ~INTMASK
)
6281 XSETFASTINT (mask
, modifiers
);
6282 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6284 /* Cache the parsing results on SYMBOL. */
6285 Fput (symbol
, Qevent_symbol_element_mask
,
6287 Fput (symbol
, Qevent_symbol_elements
,
6288 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6290 /* Since we know that SYMBOL is modifiers applied to unmodified,
6291 it would be nice to put that in unmodified's cache.
6292 But we can't, since we're not sure that parse_modifiers is
6299 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6300 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6301 doc
: /* Parse the event symbol. For internal use. */)
6302 (Lisp_Object symbol
)
6304 /* Fill the cache if needed. */
6305 parse_modifiers (symbol
);
6306 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6307 and use the Lispier representation stored on Qevent_symbol_elements
6309 return Fget (symbol
, Qevent_symbol_elements
);
6312 /* Apply the modifiers MODIFIERS to the symbol BASE.
6313 BASE must be unmodified.
6315 This is like apply_modifiers_uncached, but uses BASE's
6316 Qmodifier_cache property, if present. It also builds
6317 Qevent_symbol_elements properties, since it has that info anyway.
6319 apply_modifiers copies the value of BASE's Qevent_kind property to
6320 the modified symbol. */
6322 apply_modifiers (int modifiers
, Lisp_Object base
)
6324 Lisp_Object cache
, idx
, entry
, new_symbol
;
6326 /* Mask out upper bits. We don't know where this value's been. */
6327 modifiers
&= INTMASK
;
6329 if (INTEGERP (base
))
6330 return make_number (XINT (base
) | modifiers
);
6332 /* The click modifier never figures into cache indices. */
6333 cache
= Fget (base
, Qmodifier_cache
);
6334 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6335 entry
= assq_no_quit (idx
, cache
);
6338 new_symbol
= XCDR (entry
);
6341 /* We have to create the symbol ourselves. */
6342 new_symbol
= apply_modifiers_uncached (modifiers
,
6343 SSDATA (SYMBOL_NAME (base
)),
6344 SCHARS (SYMBOL_NAME (base
)),
6345 SBYTES (SYMBOL_NAME (base
)));
6347 /* Add the new symbol to the base's cache. */
6348 entry
= Fcons (idx
, new_symbol
);
6349 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6351 /* We have the parsing info now for free, so we could add it to
6353 XSETFASTINT (idx, modifiers);
6354 Fput (new_symbol, Qevent_symbol_element_mask,
6355 Fcons (base, Fcons (idx, Qnil)));
6356 Fput (new_symbol, Qevent_symbol_elements,
6357 Fcons (base, lispy_modifier_list (modifiers)));
6358 Sadly, this is only correct if `base' is indeed a base event,
6359 which is not necessarily the case. -stef */
6362 /* Make sure this symbol is of the same kind as BASE.
6364 You'd think we could just set this once and for all when we
6365 intern the symbol above, but reorder_modifiers may call us when
6366 BASE's property isn't set right; we can't assume that just
6367 because it has a Qmodifier_cache property it must have its
6368 Qevent_kind set right as well. */
6369 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6373 kind
= Fget (base
, Qevent_kind
);
6375 Fput (new_symbol
, Qevent_kind
, kind
);
6382 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6383 return a symbol with the modifiers placed in the canonical order.
6384 Canonical order is alphabetical, except for down and drag, which
6385 always come last. The 'click' modifier is never written out.
6387 Fdefine_key calls this to make sure that (for example) C-M-foo
6388 and M-C-foo end up being equivalent in the keymap. */
6391 reorder_modifiers (Lisp_Object symbol
)
6393 /* It's hopefully okay to write the code this way, since everything
6394 will soon be in caches, and no consing will be done at all. */
6397 parsed
= parse_modifiers (symbol
);
6398 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6403 /* For handling events, we often want to produce a symbol whose name
6404 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6405 to some base, like the name of a function key or mouse button.
6406 modify_event_symbol produces symbols of this sort.
6408 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6409 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6412 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6413 into symbol names, or a string specifying a name stem used to
6414 construct a symbol name or the form `STEM-N', where N is the decimal
6415 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6416 non-nil; otherwise NAME_TABLE is used.
6418 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6419 persist between calls to modify_event_symbol that it can use to
6420 store a cache of the symbols it's generated for this NAME_TABLE
6421 before. The object stored there may be a vector or an alist.
6423 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6425 MODIFIERS is a set of modifier bits (as given in struct input_events)
6426 whose prefixes should be applied to the symbol name.
6428 SYMBOL_KIND is the value to be placed in the event_kind property of
6429 the returned symbol.
6431 The symbols we create are supposed to have an
6432 `event-symbol-elements' property, which lists the modifiers present
6433 in the symbol's name. */
6436 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6437 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6438 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6441 Lisp_Object symbol_int
;
6443 /* Get rid of the "vendor-specific" bit here. */
6444 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6446 /* Is this a request for a valid symbol? */
6447 if (symbol_num
< 0 || symbol_num
>= table_size
)
6450 if (CONSP (*symbol_table
))
6451 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6453 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6454 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6455 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6456 we've never used that symbol before. */
6459 if (! VECTORP (*symbol_table
)
6460 || ASIZE (*symbol_table
) != table_size
)
6464 XSETFASTINT (size
, table_size
);
6465 *symbol_table
= Fmake_vector (size
, Qnil
);
6468 value
= AREF (*symbol_table
, symbol_num
);
6471 /* Have we already used this symbol before? */
6474 /* No; let's create it. */
6475 if (CONSP (name_alist_or_stem
))
6476 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6477 else if (STRINGP (name_alist_or_stem
))
6480 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6481 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6483 SAFE_ALLOCA (buf
, char *, len
);
6484 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6485 XINT (symbol_int
) + 1);
6486 value
= intern (buf
);
6489 else if (name_table
!= 0 && name_table
[symbol_num
])
6490 value
= intern (name_table
[symbol_num
]);
6492 #ifdef HAVE_WINDOW_SYSTEM
6495 char *name
= x_get_keysym_name (symbol_num
);
6497 value
= intern (name
);
6503 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6504 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6505 value
= intern (buf
);
6508 if (CONSP (*symbol_table
))
6509 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6511 ASET (*symbol_table
, symbol_num
, value
);
6513 /* Fill in the cache entries for this symbol; this also
6514 builds the Qevent_symbol_elements property, which the user
6516 apply_modifiers (modifiers
& click_modifier
, value
);
6517 Fput (value
, Qevent_kind
, symbol_kind
);
6520 /* Apply modifiers to that symbol. */
6521 return apply_modifiers (modifiers
, value
);
6524 /* Convert a list that represents an event type,
6525 such as (ctrl meta backspace), into the usual representation of that
6526 event type as a number or a symbol. */
6528 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6529 doc
: /* Convert the event description list EVENT-DESC to an event type.
6530 EVENT-DESC should contain one base event type (a character or symbol)
6531 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6532 drag, down, double or triple). The base must be last.
6533 The return value is an event type (a character or symbol) which
6534 has the same base event type and all the specified modifiers. */)
6535 (Lisp_Object event_desc
)
6543 while (CONSP (rest
))
6551 /* Given a symbol, see if it is a modifier name. */
6552 if (SYMBOLP (elt
) && CONSP (rest
))
6553 this = parse_solitary_modifier (elt
);
6557 else if (!NILP (base
))
6558 error ("Two bases given in one event");
6564 /* Let the symbol A refer to the character A. */
6565 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6566 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6568 if (INTEGERP (base
))
6570 /* Turn (shift a) into A. */
6571 if ((modifiers
& shift_modifier
) != 0
6572 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6574 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6575 modifiers
&= ~shift_modifier
;
6578 /* Turn (control a) into C-a. */
6579 if (modifiers
& ctrl_modifier
)
6580 return make_number ((modifiers
& ~ctrl_modifier
)
6581 | make_ctrl_char (XINT (base
)));
6583 return make_number (modifiers
| XINT (base
));
6585 else if (SYMBOLP (base
))
6586 return apply_modifiers (modifiers
, base
);
6589 error ("Invalid base event");
6594 /* Try to recognize SYMBOL as a modifier name.
6595 Return the modifier flag bit, or 0 if not recognized. */
6598 parse_solitary_modifier (Lisp_Object symbol
)
6600 Lisp_Object name
= SYMBOL_NAME (symbol
);
6602 switch (SREF (name
, 0))
6604 #define SINGLE_LETTER_MOD(BIT) \
6605 if (SBYTES (name) == 1) \
6608 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6609 if (LEN == SBYTES (name) \
6610 && ! memcmp (SDATA (name), NAME, LEN)) \
6614 SINGLE_LETTER_MOD (alt_modifier
);
6618 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6622 SINGLE_LETTER_MOD (ctrl_modifier
);
6626 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6627 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6631 SINGLE_LETTER_MOD (hyper_modifier
);
6635 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6639 SINGLE_LETTER_MOD (meta_modifier
);
6643 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6647 SINGLE_LETTER_MOD (shift_modifier
);
6651 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6652 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6653 SINGLE_LETTER_MOD (super_modifier
);
6657 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6658 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6659 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6663 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6666 #undef SINGLE_LETTER_MOD
6667 #undef MULTI_LETTER_MOD
6673 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6674 Such a list is not valid as an event,
6675 but it can be a Lucid-style event type list. */
6678 lucid_event_type_list_p (Lisp_Object object
)
6682 if (! CONSP (object
))
6685 if (EQ (XCAR (object
), Qhelp_echo
)
6686 || EQ (XCAR (object
), Qvertical_line
)
6687 || EQ (XCAR (object
), Qmode_line
)
6688 || EQ (XCAR (object
), Qheader_line
))
6691 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6695 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6702 /* Store into *addr a value nonzero if terminal input chars are available.
6703 Serves the purpose of ioctl (0, FIONREAD, addr)
6704 but works even if FIONREAD does not exist.
6705 (In fact, this may actually read some input.)
6707 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6708 timer events that are ripe.
6709 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6710 events (FOCUS_IN_EVENT).
6711 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6712 movements and toolkit scroll bar thumb drags. */
6715 get_input_pending (int *addr
, int flags
)
6717 /* First of all, have we already counted some input? */
6718 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6720 /* If input is being read as it arrives, and we have none, there is none. */
6721 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6724 /* Try to read some input and see how much we get. */
6726 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6729 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6732 gobble_input (int expected
)
6735 if (interrupt_input
)
6738 mask
= sigblock (sigmask (SIGIO
));
6739 read_avail_input (expected
);
6743 #ifdef POLL_FOR_INPUT
6744 /* XXX This condition was (read_socket_hook && !interrupt_input),
6745 but read_socket_hook is not global anymore. Let's pretend that
6747 if (!interrupt_input
&& poll_suppress_count
== 0)
6750 mask
= sigblock (sigmask (SIGALRM
));
6751 read_avail_input (expected
);
6757 read_avail_input (expected
);
6760 /* Put a BUFFER_SWITCH_EVENT in the buffer
6761 so that read_key_sequence will notice the new current buffer. */
6764 record_asynch_buffer_change (void)
6766 struct input_event event
;
6770 event
.kind
= BUFFER_SWITCH_EVENT
;
6771 event
.frame_or_window
= Qnil
;
6774 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6775 The purpose of the event is to make read_key_sequence look up the
6776 keymaps again. If we aren't in read_key_sequence, we don't need one,
6777 and the event could cause trouble by messing up (input-pending-p).
6778 Note: Fwaiting_for_user_input_p always returns nil when async
6779 subprocesses aren't supported. */
6780 tem
= Fwaiting_for_user_input_p ();
6784 /* Make sure no interrupt happens while storing the event. */
6786 if (interrupt_input
)
6789 mask
= sigblock (sigmask (SIGIO
));
6790 kbd_buffer_store_event (&event
);
6797 kbd_buffer_store_event (&event
);
6802 /* Read any terminal input already buffered up by the system
6803 into the kbd_buffer, but do not wait.
6805 EXPECTED should be nonzero if the caller knows there is some input.
6807 Returns the number of keyboard chars read, or -1 meaning
6808 this is a bad time to try to read input. */
6811 read_avail_input (int expected
)
6817 /* Store pending user signal events, if any. */
6818 if (store_user_signal_events ())
6821 /* Loop through the available terminals, and call their input hooks. */
6825 struct terminal
*next
= t
->next_terminal
;
6827 if (t
->read_socket_hook
)
6830 struct input_event hold_quit
;
6832 EVENT_INIT (hold_quit
);
6833 hold_quit
.kind
= NO_EVENT
;
6835 /* No need for FIONREAD or fcntl; just say don't wait. */
6836 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6842 if (nr
== -1) /* Not OK to read input now. */
6846 else if (nr
== -2) /* Non-transient error. */
6848 /* The terminal device terminated; it should be closed. */
6850 /* Kill Emacs if this was our last terminal. */
6851 if (!terminal_list
->next_terminal
)
6852 /* Formerly simply reported no input, but that
6853 sometimes led to a failure of Emacs to terminate.
6854 SIGHUP seems appropriate if we can't reach the
6856 /* ??? Is it really right to send the signal just to
6857 this process rather than to the whole process
6858 group? Perhaps on systems with FIONREAD Emacs is
6859 alone in its group. */
6860 kill (getpid (), SIGHUP
);
6862 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6865 XSETTERMINAL (tmp
, t
);
6866 Fdelete_terminal (tmp
, Qnoelisp
);
6870 if (hold_quit
.kind
!= NO_EVENT
)
6871 kbd_buffer_store_event (&hold_quit
);
6880 frame_make_pointer_visible ();
6886 decode_keyboard_code (struct tty_display_info
*tty
,
6887 struct coding_system
*coding
,
6888 unsigned char *buf
, int nbytes
)
6890 unsigned char *src
= buf
;
6891 const unsigned char *p
;
6896 if (tty
->meta_key
!= 2)
6897 for (i
= 0; i
< nbytes
; i
++)
6899 if (coding
->carryover_bytes
> 0)
6901 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6902 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6903 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6904 nbytes
+= coding
->carryover_bytes
;
6906 coding
->destination
= alloca (nbytes
* 4);
6907 coding
->dst_bytes
= nbytes
* 4;
6908 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6909 if (coding
->produced_char
== 0)
6911 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6913 struct input_event event_buf
;
6915 EVENT_INIT (event_buf
);
6916 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6918 (ASCII_CHAR_P (event_buf
.code
)
6919 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6920 /* See the comment in tty_read_avail_input. */
6921 event_buf
.frame_or_window
= tty
->top_frame
;
6922 event_buf
.arg
= Qnil
;
6923 kbd_buffer_store_event (&event_buf
);
6927 /* This is the tty way of reading available input.
6929 Note that each terminal device has its own `struct terminal' object,
6930 and so this function is called once for each individual termcap
6931 terminal. The first parameter indicates which terminal to read from. */
6934 tty_read_avail_input (struct terminal
*terminal
,
6936 struct input_event
*hold_quit
)
6938 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6939 the kbd_buffer can really hold. That may prevent loss
6940 of characters on some systems when input is stuffed at us. */
6941 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6943 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6946 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6948 if (kbd_on_hold_p () || buffer_free
<= 0)
6950 #endif /* subprocesses */
6952 if (!terminal
->name
) /* Don't read from a dead terminal. */
6955 if (terminal
->type
!= output_termcap
6956 && terminal
->type
!= output_msdos_raw
)
6959 /* XXX I think the following code should be moved to separate hook
6960 functions in system-dependent files. */
6963 #else /* not WINDOWSNT */
6964 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6968 return 0; /* The terminal is suspended. */
6971 n_to_read
= dos_keysns ();
6975 cbuf
[0] = dos_keyread ();
6978 #else /* not MSDOS */
6983 struct input_event gpm_hold_quit
;
6984 int gpm
, fd
= gpm_fd
;
6986 EVENT_INIT (gpm_hold_quit
);
6987 gpm_hold_quit
.kind
= NO_EVENT
;
6989 /* gpm==1 if event received.
6990 gpm==0 if the GPM daemon has closed the connection, in which case
6991 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6992 we save it in `fd' so close_gpm can remove it from the
6994 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6995 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6996 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6999 /* Presumably the GPM daemon has closed the connection. */
7001 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7002 kbd_buffer_store_event (&gpm_hold_quit
);
7006 #endif /* HAVE_GPM */
7008 /* Determine how many characters we should *try* to read. */
7010 /* Find out how much input is available. */
7011 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7013 if (! noninteractive
)
7014 return -2; /* Close this terminal. */
7020 if (n_to_read
> sizeof cbuf
)
7021 n_to_read
= sizeof cbuf
;
7022 #else /* no FIONREAD */
7023 #if defined (USG) || defined (CYGWIN)
7024 /* Read some input if available, but don't wait. */
7025 n_to_read
= sizeof cbuf
;
7026 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7033 /* Don't read more than we can store. */
7034 if (n_to_read
> buffer_free
)
7035 n_to_read
= buffer_free
;
7036 #endif /* subprocesses */
7038 /* Now read; for one reason or another, this will not block.
7039 NREAD is set to the number of chars read. */
7042 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7043 /* POSIX infers that processes which are not in the session leader's
7044 process group won't get SIGHUP's at logout time. BSDI adheres to
7045 this part standard and returns -1 from read (0) with errno==EIO
7046 when the control tty is taken away.
7047 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7048 if (nread
== -1 && errno
== EIO
)
7049 return -2; /* Close this terminal. */
7050 #if defined (AIX) && defined (_BSD)
7051 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7052 This looks incorrect, but it isn't, because _BSD causes
7053 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7054 and that causes a value other than 0 when there is no input. */
7056 return -2; /* Close this terminal. */
7060 /* We used to retry the read if it was interrupted.
7061 But this does the wrong thing when O_NDELAY causes
7062 an EAGAIN error. Does anybody know of a situation
7063 where a retry is actually needed? */
7065 nread
< 0 && (errno
== EAGAIN
7079 #if defined (USG) || defined (CYGWIN)
7080 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7081 #endif /* USG or CYGWIN */
7082 #endif /* no FIONREAD */
7087 #endif /* not MSDOS */
7088 #endif /* not WINDOWSNT */
7090 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7091 & CODING_REQUIRE_DECODING_MASK
)
7093 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7096 /* Decode the key sequence except for those with meta
7098 for (i
= from
= 0; ; i
++)
7099 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7101 struct input_event buf
;
7103 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7108 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7109 buf
.modifiers
= meta_modifier
;
7110 buf
.code
= cbuf
[i
] & ~0x80;
7111 /* See the comment below. */
7112 buf
.frame_or_window
= tty
->top_frame
;
7114 kbd_buffer_store_event (&buf
);
7120 for (i
= 0; i
< nread
; i
++)
7122 struct input_event buf
;
7124 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7126 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7127 buf
.modifiers
= meta_modifier
;
7128 if (tty
->meta_key
!= 2)
7132 /* Set the frame corresponding to the active tty. Note that the
7133 value of selected_frame is not reliable here, redisplay tends
7134 to temporarily change it. */
7135 buf
.frame_or_window
= tty
->top_frame
;
7138 kbd_buffer_store_event (&buf
);
7139 /* Don't look at input that follows a C-g too closely.
7140 This reduces lossage due to autorepeat on C-g. */
7141 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7142 && buf
.code
== quit_char
)
7149 #if defined SYNC_INPUT || defined SIGIO
7151 handle_async_input (void)
7153 interrupt_input_pending
= 0;
7155 pending_signals
= pending_atimers
;
7157 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7158 doing anything dangerous. */
7165 nread
= read_avail_input (1);
7166 /* -1 means it's not ok to read the input now.
7167 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7168 0 means there was no keyboard input available. */
7176 #endif /* SYNC_INPUT || SIGIO */
7180 process_pending_signals (void)
7182 if (interrupt_input_pending
)
7183 handle_async_input ();
7184 do_pending_atimers ();
7188 #ifdef SIGIO /* for entire page */
7189 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7192 input_available_signal (int signo
)
7194 /* Must preserve main program's value of errno. */
7195 int old_errno
= errno
;
7196 SIGNAL_THREAD_CHECK (signo
);
7199 interrupt_input_pending
= 1;
7200 pending_signals
= 1;
7203 if (input_available_clear_time
)
7204 *input_available_clear_time
= make_emacs_time (0, 0);
7207 handle_async_input ();
7214 /* Send ourselves a SIGIO.
7216 This function exists so that the UNBLOCK_INPUT macro in
7217 blockinput.h can have some way to take care of input we put off
7218 dealing with, without assuming that every file which uses
7219 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7221 reinvoke_input_signal (void)
7224 handle_async_input ();
7230 /* User signal events. */
7232 struct user_signal_info
7234 /* Signal number. */
7237 /* Name of the signal. */
7240 /* Number of pending signals. */
7243 struct user_signal_info
*next
;
7246 /* List of user signals. */
7247 static struct user_signal_info
*user_signals
= NULL
;
7250 add_user_signal (int sig
, const char *name
)
7252 struct user_signal_info
*p
;
7254 for (p
= user_signals
; p
; p
= p
->next
)
7256 /* Already added. */
7259 p
= xmalloc (sizeof *p
);
7261 p
->name
= xstrdup (name
);
7263 p
->next
= user_signals
;
7266 signal (sig
, handle_user_signal
);
7270 handle_user_signal (int sig
)
7272 int old_errno
= errno
;
7273 struct user_signal_info
*p
;
7274 const char *special_event_name
= NULL
;
7276 SIGNAL_THREAD_CHECK (sig
);
7278 if (SYMBOLP (Vdebug_on_event
))
7279 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7281 for (p
= user_signals
; p
; p
= p
->next
)
7284 if (special_event_name
7285 && strcmp (special_event_name
, p
->name
) == 0)
7287 /* Enter the debugger in many ways. */
7288 debug_on_next_call
= 1;
7291 Vinhibit_quit
= Qnil
;
7293 /* Eat the event. */
7299 if (interrupt_input
)
7300 kill (getpid (), SIGIO
);
7304 /* Tell wait_reading_process_output that it needs to wake
7305 up and look around. */
7306 if (input_available_clear_time
)
7307 *input_available_clear_time
= make_emacs_time (0, 0);
7316 find_user_signal_name (int sig
)
7318 struct user_signal_info
*p
;
7320 for (p
= user_signals
; p
; p
= p
->next
)
7328 store_user_signal_events (void)
7330 struct user_signal_info
*p
;
7331 struct input_event buf
;
7334 for (p
= user_signals
; p
; p
= p
->next
)
7335 if (p
->npending
> 0)
7341 memset (&buf
, 0, sizeof buf
);
7342 buf
.kind
= USER_SIGNAL_EVENT
;
7343 buf
.frame_or_window
= selected_frame
;
7345 nstored
+= p
->npending
;
7347 mask
= sigblock (sigmask (p
->sig
));
7351 kbd_buffer_store_event (&buf
);
7354 while (p
->npending
> 0);
7362 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7363 static Lisp_Object menu_bar_one_keymap_changed_items
;
7365 /* These variables hold the vector under construction within
7366 menu_bar_items and its subroutines, and the current index
7367 for storing into that vector. */
7368 static Lisp_Object menu_bar_items_vector
;
7369 static int menu_bar_items_index
;
7372 static const char* separator_names
[] = {
7377 "single-dashed-line",
7378 "double-dashed-line",
7380 "shadow-etched-out",
7381 "shadow-etched-in-dash",
7382 "shadow-etched-out-dash",
7383 "shadow-double-etched-in",
7384 "shadow-double-etched-out",
7385 "shadow-double-etched-in-dash",
7386 "shadow-double-etched-out-dash",
7390 /* Return non-zero if LABEL specifies a separator. */
7393 menu_separator_name_p (const char *label
)
7397 else if (strlen (label
) > 3
7398 && memcmp (label
, "--", 2) == 0
7403 for (i
= 0; separator_names
[i
]; ++i
)
7404 if (strcmp (label
, separator_names
[i
]) == 0)
7409 /* It's a separator if it contains only dashes. */
7410 while (*label
== '-')
7412 return (*label
== 0);
7419 /* Return a vector of menu items for a menu bar, appropriate
7420 to the current buffer. Each item has three elements in the vector:
7423 OLD is an old vector we can optionally reuse, or nil. */
7426 menu_bar_items (Lisp_Object old
)
7428 /* The number of keymaps we're scanning right now, and the number of
7429 keymaps we have allocated space for. */
7432 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7433 in the current keymaps, or nil where it is not a prefix. */
7436 Lisp_Object def
, tail
;
7441 /* In order to build the menus, we need to call the keymap
7442 accessors. They all call QUIT. But this function is called
7443 during redisplay, during which a quit is fatal. So inhibit
7444 quitting while building the menus.
7445 We do this instead of specbind because (1) errors will clear it anyway
7446 and (2) this avoids risk of specpdl overflow. */
7447 oquit
= Vinhibit_quit
;
7451 menu_bar_items_vector
= old
;
7453 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7454 menu_bar_items_index
= 0;
7456 /* Build our list of keymaps.
7457 If we recognize a function key and replace its escape sequence in
7458 keybuf with its symbol, or if the sequence starts with a mouse
7459 click and we need to switch buffers, we jump back here to rebuild
7460 the initial keymaps from the current buffer. */
7464 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7465 if (!NILP (Voverriding_local_map_menu_flag
))
7467 /* Yes, use them (if non-nil) as well as the global map. */
7468 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7470 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7471 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7472 if (!NILP (Voverriding_local_map
))
7473 maps
[nmaps
++] = Voverriding_local_map
;
7477 /* No, so use major and minor mode keymaps and keymap property.
7478 Note that menu-bar bindings in the local-map and keymap
7479 properties may not work reliable, as they are only
7480 recognized when the menu-bar (or mode-line) is updated,
7481 which does not normally happen after every command. */
7484 nminor
= current_minor_maps (NULL
, &tmaps
);
7485 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7487 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7488 maps
[nmaps
++] = tem
;
7489 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7491 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7493 maps
[nmaps
++] = current_global_map
;
7496 /* Look up in each map the dummy prefix key `menu-bar'. */
7498 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7499 if (!NILP (maps
[mapno
]))
7501 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7505 menu_bar_one_keymap_changed_items
= Qnil
;
7506 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7510 /* Move to the end those items that should be at the end. */
7512 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7515 int end
= menu_bar_items_index
;
7517 for (i
= 0; i
< end
; i
+= 4)
7518 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7520 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7521 /* Move the item at index I to the end,
7522 shifting all the others forward. */
7523 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7524 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7525 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7526 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7528 memmove (aref_addr (menu_bar_items_vector
, i
),
7529 aref_addr (menu_bar_items_vector
, i
+ 4),
7530 (end
- i
- 4) * sizeof (Lisp_Object
));
7531 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7532 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7533 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7534 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7539 /* Add nil, nil, nil, nil at the end. */
7541 int i
= menu_bar_items_index
;
7542 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7543 menu_bar_items_vector
=
7544 larger_vector (menu_bar_items_vector
, 4, -1);
7545 /* Add this item. */
7546 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7547 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7548 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7549 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7550 menu_bar_items_index
= i
;
7553 Vinhibit_quit
= oquit
;
7554 return menu_bar_items_vector
;
7557 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7558 If there's already an item for KEY, add this DEF to it. */
7560 Lisp_Object item_properties
;
7563 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7565 struct gcpro gcpro1
;
7569 if (EQ (item
, Qundefined
))
7571 /* If a map has an explicit `undefined' as definition,
7572 discard any previously made menu bar item. */
7574 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7575 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7577 if (menu_bar_items_index
> i
+ 4)
7578 memmove (aref_addr (menu_bar_items_vector
, i
),
7579 aref_addr (menu_bar_items_vector
, i
+ 4),
7580 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7581 menu_bar_items_index
-= 4;
7585 /* If this keymap has already contributed to this KEY,
7586 don't contribute to it a second time. */
7587 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7588 if (!NILP (tem
) || NILP (item
))
7591 menu_bar_one_keymap_changed_items
7592 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7594 /* We add to menu_bar_one_keymap_changed_items before doing the
7595 parse_menu_item, so that if it turns out it wasn't a menu item,
7596 it still correctly hides any further menu item. */
7598 i
= parse_menu_item (item
, 1);
7603 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7605 /* Find any existing item for this KEY. */
7606 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7607 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7610 /* If we did not find this KEY, add it at the end. */
7611 if (i
== menu_bar_items_index
)
7613 /* If vector is too small, get a bigger one. */
7614 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7615 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7616 /* Add this item. */
7617 ASET (menu_bar_items_vector
, i
, key
); i
++;
7618 ASET (menu_bar_items_vector
, i
,
7619 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7620 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7621 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7622 menu_bar_items_index
= i
;
7624 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7628 old
= AREF (menu_bar_items_vector
, i
+ 2);
7629 /* If the new and the old items are not both keymaps,
7630 the lookup will only find `item'. */
7631 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7632 ASET (menu_bar_items_vector
, i
+ 2, item
);
7636 /* This is used as the handler when calling menu_item_eval_property. */
7638 menu_item_eval_property_1 (Lisp_Object arg
)
7640 /* If we got a quit from within the menu computation,
7641 quit all the way out of it. This takes care of C-] in the debugger. */
7642 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7643 Fsignal (Qquit
, Qnil
);
7649 eval_dyn (Lisp_Object form
)
7651 return Feval (form
, Qnil
);
7654 /* Evaluate an expression and return the result (or nil if something
7655 went wrong). Used to evaluate dynamic parts of menu items. */
7657 menu_item_eval_property (Lisp_Object sexpr
)
7659 ptrdiff_t count
= SPECPDL_INDEX ();
7661 specbind (Qinhibit_redisplay
, Qt
);
7662 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7663 menu_item_eval_property_1
);
7664 return unbind_to (count
, val
);
7667 /* This function parses a menu item and leaves the result in the
7668 vector item_properties.
7669 ITEM is a key binding, a possible menu item.
7670 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7672 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7673 parse_menu_item returns true if the item is a menu item and false
7677 parse_menu_item (Lisp_Object item
, int inmenubar
)
7679 Lisp_Object def
, tem
, item_string
, start
;
7681 Lisp_Object keyhint
;
7690 /* Create item_properties vector if necessary. */
7691 if (NILP (item_properties
))
7693 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7695 /* Initialize optional entries. */
7696 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7697 ASET (item_properties
, i
, Qnil
);
7698 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7700 /* Save the item here to protect it from GC. */
7701 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7703 item_string
= XCAR (item
);
7707 if (STRINGP (item_string
))
7709 /* Old format menu item. */
7710 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7712 /* Maybe help string. */
7713 if (CONSP (item
) && STRINGP (XCAR (item
)))
7715 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7720 /* Maybe an obsolete key binding cache. */
7721 if (CONSP (item
) && CONSP (XCAR (item
))
7722 && (NILP (XCAR (XCAR (item
)))
7723 || VECTORP (XCAR (XCAR (item
)))))
7726 /* This is the real definition--the function to run. */
7727 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7729 /* Get enable property, if any. */
7732 tem
= Fget (item
, Qmenu_enable
);
7733 if (!NILP (Venable_disabled_menus_and_buttons
))
7734 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7735 else if (!NILP (tem
))
7736 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7739 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7741 /* New format menu item. */
7742 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7743 start
= XCDR (item
);
7746 /* We have a real binding. */
7747 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7749 item
= XCDR (start
);
7750 /* Is there an obsolete cache list with key equivalences. */
7751 if (CONSP (item
) && CONSP (XCAR (item
)))
7754 /* Parse properties. */
7755 while (CONSP (item
) && CONSP (XCDR (item
)))
7760 if (EQ (tem
, QCenable
))
7762 if (!NILP (Venable_disabled_menus_and_buttons
))
7763 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7765 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7767 else if (EQ (tem
, QCvisible
))
7769 /* If got a visible property and that evaluates to nil
7770 then ignore this item. */
7771 tem
= menu_item_eval_property (XCAR (item
));
7775 else if (EQ (tem
, QChelp
))
7776 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7777 else if (EQ (tem
, QCfilter
))
7779 else if (EQ (tem
, QCkey_sequence
))
7782 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7783 /* Be GC protected. Set keyhint to item instead of tem. */
7786 else if (EQ (tem
, QCkeys
))
7789 if (CONSP (tem
) || STRINGP (tem
))
7790 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7792 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7797 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7799 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7801 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7807 else if (inmenubar
|| !NILP (start
))
7811 return 0; /* not a menu item */
7813 /* If item string is not a string, evaluate it to get string.
7814 If we don't get a string, skip this item. */
7815 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7816 if (!(STRINGP (item_string
)))
7818 item_string
= menu_item_eval_property (item_string
);
7819 if (!STRINGP (item_string
))
7821 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7824 /* If got a filter apply it on definition. */
7825 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7828 def
= menu_item_eval_property (list2 (XCAR (filter
),
7829 list2 (Qquote
, def
)));
7831 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7834 /* Enable or disable selection of item. */
7835 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7838 tem
= menu_item_eval_property (tem
);
7839 if (inmenubar
&& NILP (tem
))
7840 return 0; /* Ignore disabled items in menu bar. */
7841 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7844 /* If we got no definition, this item is just unselectable text which
7845 is OK in a submenu but not in the menubar. */
7847 return (!inmenubar
);
7849 /* See if this is a separate pane or a submenu. */
7850 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7851 tem
= get_keymap (def
, 0, 1);
7852 /* For a subkeymap, just record its details and exit. */
7855 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7856 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7860 /* At the top level in the menu bar, do likewise for commands also.
7861 The menu bar does not display equivalent key bindings anyway.
7862 ITEM_PROPERTY_DEF is already set up properly. */
7866 { /* This is a command. See if there is an equivalent key binding. */
7867 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7869 /* The previous code preferred :key-sequence to :keys, so we
7870 preserve this behavior. */
7871 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7872 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7875 Lisp_Object prefix
= keyeq
;
7876 Lisp_Object keys
= Qnil
;
7880 def
= XCAR (prefix
);
7881 prefix
= XCDR (prefix
);
7884 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7886 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7888 keys
= XCAR (keyhint
);
7889 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7891 /* We have a suggested key. Is it bound to the command? */
7894 /* If the command is an alias for another
7895 (such as lmenu.el set it up), check if the
7896 original command matches the cached command. */
7898 && EQ (tem
, SVAR (XSYMBOL (def
), function
)))))
7903 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7907 tem
= Fkey_description (keys
, Qnil
);
7910 if (STRINGP (XCAR (prefix
)))
7911 tem
= concat2 (XCAR (prefix
), tem
);
7912 if (STRINGP (XCDR (prefix
)))
7913 tem
= concat2 (tem
, XCDR (prefix
));
7915 keyeq
= concat2 (build_string (" "), tem
);
7916 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7922 /* If we have an equivalent key binding, use that. */
7923 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7926 /* Include this when menu help is implemented.
7927 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7928 if (!(NILP (tem) || STRINGP (tem)))
7930 tem = menu_item_eval_property (tem);
7933 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7937 /* Handle radio buttons or toggle boxes. */
7938 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7940 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7941 menu_item_eval_property (tem
));
7948 /***********************************************************************
7950 ***********************************************************************/
7952 /* A vector holding tool bar items while they are parsed in function
7953 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7956 static Lisp_Object tool_bar_items_vector
;
7958 /* A vector holding the result of parse_tool_bar_item. Layout is like
7959 the one for a single item in tool_bar_items_vector. */
7961 static Lisp_Object tool_bar_item_properties
;
7963 /* Next free index in tool_bar_items_vector. */
7965 static int ntool_bar_items
;
7967 /* The symbols `:image' and `:rtl'. */
7969 static Lisp_Object QCimage
;
7970 static Lisp_Object QCrtl
;
7972 /* Function prototypes. */
7974 static void init_tool_bar_items (Lisp_Object
);
7975 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7976 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7977 static void append_tool_bar_item (void);
7980 /* Return a vector of tool bar items for keymaps currently in effect.
7981 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7982 tool bar items found. */
7985 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7994 /* In order to build the menus, we need to call the keymap
7995 accessors. They all call QUIT. But this function is called
7996 during redisplay, during which a quit is fatal. So inhibit
7997 quitting while building the menus. We do this instead of
7998 specbind because (1) errors will clear it anyway and (2) this
7999 avoids risk of specpdl overflow. */
8000 oquit
= Vinhibit_quit
;
8003 /* Initialize tool_bar_items_vector and protect it from GC. */
8004 init_tool_bar_items (reuse
);
8006 /* Build list of keymaps in maps. Set nmaps to the number of maps
8009 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8010 if (!NILP (Voverriding_local_map_menu_flag
))
8012 /* Yes, use them (if non-nil) as well as the global map. */
8013 maps
= alloca (3 * sizeof *maps
);
8015 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8016 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8017 if (!NILP (Voverriding_local_map
))
8018 maps
[nmaps
++] = Voverriding_local_map
;
8022 /* No, so use major and minor mode keymaps and keymap property.
8023 Note that tool-bar bindings in the local-map and keymap
8024 properties may not work reliable, as they are only
8025 recognized when the tool-bar (or mode-line) is updated,
8026 which does not normally happen after every command. */
8029 nminor
= current_minor_maps (NULL
, &tmaps
);
8030 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
8032 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8033 maps
[nmaps
++] = tem
;
8034 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8036 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8039 /* Add global keymap at the end. */
8040 maps
[nmaps
++] = current_global_map
;
8042 /* Process maps in reverse order and look up in each map the prefix
8044 for (i
= nmaps
- 1; i
>= 0; --i
)
8045 if (!NILP (maps
[i
]))
8049 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8051 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8054 Vinhibit_quit
= oquit
;
8055 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8056 return tool_bar_items_vector
;
8060 /* Process the definition of KEY which is DEF. */
8063 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8066 struct gcpro gcpro1
, gcpro2
;
8068 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8072 if (EQ (def
, Qundefined
))
8074 /* If a map has an explicit `undefined' as definition,
8075 discard any previously made item. */
8076 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8078 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8080 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8082 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8083 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8084 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8085 * sizeof (Lisp_Object
)));
8086 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8091 else if (parse_tool_bar_item (key
, def
))
8092 /* Append a new tool bar item to tool_bar_items_vector. Accept
8093 more than one definition for the same key. */
8094 append_tool_bar_item ();
8099 /* Access slot with index IDX of vector tool_bar_item_properties. */
8100 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8102 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8104 ASET (tool_bar_item_properties
, idx
, val
);
8108 /* Parse a tool bar item specification ITEM for key KEY and return the
8109 result in tool_bar_item_properties. Value is zero if ITEM is
8112 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8114 CAPTION is the caption of the item, If it's not a string, it is
8115 evaluated to get a string.
8117 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8118 as binding are currently ignored.
8120 The following properties are recognized:
8124 FORM is evaluated and specifies whether the tool bar item is
8125 enabled or disabled.
8129 FORM is evaluated and specifies whether the tool bar item is visible.
8131 - `:filter FUNCTION'
8133 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8134 result is stored as the new binding.
8136 - `:button (TYPE SELECTED)'
8138 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8139 and specifies whether the button is selected (pressed) or not.
8143 IMAGES is either a single image specification or a vector of four
8144 image specifications. See enum tool_bar_item_images.
8146 - `:help HELP-STRING'.
8148 Gives a help string to display for the tool bar item.
8150 - `:label LABEL-STRING'.
8152 A text label to show with the tool bar button if labels are enabled. */
8155 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8157 Lisp_Object filter
= Qnil
;
8158 Lisp_Object caption
;
8159 int i
, have_label
= 0;
8161 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8162 Rule out items that aren't lists, don't start with
8163 `menu-item' or whose rest following `tool-bar-item' is not a
8168 /* As an exception, allow old-style menu separators. */
8169 if (STRINGP (XCAR (item
)))
8170 item
= Fcons (XCAR (item
), Qnil
);
8171 else if (!EQ (XCAR (item
), Qmenu_item
)
8172 || (item
= XCDR (item
), !CONSP (item
)))
8175 /* Create tool_bar_item_properties vector if necessary. Reset it to
8177 if (VECTORP (tool_bar_item_properties
))
8179 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8183 tool_bar_item_properties
8184 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8187 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8188 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8190 /* Get the caption of the item. If the caption is not a string,
8191 evaluate it to get a string. If we don't get a string, skip this
8193 caption
= XCAR (item
);
8194 if (!STRINGP (caption
))
8196 caption
= menu_item_eval_property (caption
);
8197 if (!STRINGP (caption
))
8200 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8202 /* If the rest following the caption is not a list, the menu item is
8203 either a separator, or invalid. */
8207 if (menu_separator_name_p (SSDATA (caption
)))
8209 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8210 #if !defined (USE_GTK) && !defined (HAVE_NS)
8211 /* If we use build_desired_tool_bar_string to render the
8212 tool bar, the separator is rendered as an image. */
8213 PROP (TOOL_BAR_ITEM_IMAGES
)
8214 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8215 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8216 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8217 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8224 /* Store the binding. */
8225 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8228 /* Ignore cached key binding, if any. */
8229 if (CONSP (item
) && CONSP (XCAR (item
)))
8232 /* Process the rest of the properties. */
8233 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8235 Lisp_Object ikey
, value
;
8238 value
= XCAR (XCDR (item
));
8240 if (EQ (ikey
, QCenable
))
8242 /* `:enable FORM'. */
8243 if (!NILP (Venable_disabled_menus_and_buttons
))
8244 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8246 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8248 else if (EQ (ikey
, QCvisible
))
8250 /* `:visible FORM'. If got a visible property and that
8251 evaluates to nil then ignore this item. */
8252 if (NILP (menu_item_eval_property (value
)))
8255 else if (EQ (ikey
, QChelp
))
8256 /* `:help HELP-STRING'. */
8257 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8258 else if (EQ (ikey
, QCvert_only
))
8259 /* `:vert-only t/nil'. */
8260 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8261 else if (EQ (ikey
, QClabel
))
8263 const char *bad_label
= "!!?GARBLED ITEM?!!";
8264 /* `:label LABEL-STRING'. */
8265 set_prop (TOOL_BAR_ITEM_LABEL
,
8266 STRINGP (value
) ? value
: build_string (bad_label
));
8269 else if (EQ (ikey
, QCfilter
))
8270 /* ':filter FORM'. */
8272 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8274 /* `:button (TYPE . SELECTED)'. */
8275 Lisp_Object type
, selected
;
8277 type
= XCAR (value
);
8278 selected
= XCDR (value
);
8279 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8281 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8282 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8285 else if (EQ (ikey
, QCimage
)
8287 || (VECTORP (value
) && ASIZE (value
) == 4)))
8288 /* Value is either a single image specification or a vector
8289 of 4 such specifications for the different button states. */
8290 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8291 else if (EQ (ikey
, QCrtl
))
8293 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8299 /* Try to make one from caption and key. */
8300 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8301 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8302 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8303 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8305 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8306 char *buf
= xmalloc (max_lbl
+ 1);
8307 Lisp_Object new_lbl
;
8308 ptrdiff_t caption_len
= strlen (capt
);
8310 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8313 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8315 buf
[caption_len
] = '\0';
8319 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8323 strcpy (buf
, label
);
8325 for (j
= 0; buf
[j
] != '\0'; ++j
)
8333 new_lbl
= Fupcase_initials (build_string (label
));
8334 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8335 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8337 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8341 /* If got a filter apply it on binding. */
8343 set_prop (TOOL_BAR_ITEM_BINDING
,
8344 (menu_item_eval_property
8347 PROP (TOOL_BAR_ITEM_BINDING
))))));
8349 /* See if the binding is a keymap. Give up if it is. */
8350 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8353 /* Enable or disable selection of item. */
8354 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8355 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8356 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8358 /* Handle radio buttons or toggle boxes. */
8359 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8360 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8361 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8369 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8370 that can be reused. */
8373 init_tool_bar_items (Lisp_Object reuse
)
8375 if (VECTORP (reuse
))
8376 tool_bar_items_vector
= reuse
;
8378 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8379 ntool_bar_items
= 0;
8383 /* Append parsed tool bar item properties from
8384 tool_bar_item_properties */
8387 append_tool_bar_item (void)
8389 Lisp_Object
*to
, *from
;
8392 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8394 /* Enlarge tool_bar_items_vector if necessary. */
8396 tool_bar_items_vector
8397 = larger_vector (tool_bar_items_vector
, incr
, -1);
8399 /* Append entries from tool_bar_item_properties to the end of
8400 tool_bar_items_vector. */
8401 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8402 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8403 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8404 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8411 /* Read a character using menus based on maps in the array MAPS.
8412 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8413 Return t if we displayed a menu but the user rejected it.
8415 PREV_EVENT is the previous input event, or nil if we are reading
8416 the first event of a key sequence.
8418 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8419 if we used a mouse menu to read the input, or zero otherwise. If
8420 USED_MOUSE_MENU is null, we don't dereference it.
8422 The prompting is done based on the prompt-string of the map
8423 and the strings associated with various map elements.
8425 This can be done with X menus or with menus put in the minibuf.
8426 These are done in different ways, depending on how the input will be read.
8427 Menus using X are done after auto-saving in read-char, getting the input
8428 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8429 and do auto-saving in the inner call of read_char. */
8432 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8433 Lisp_Object prev_event
, int *used_mouse_menu
)
8437 if (used_mouse_menu
)
8438 *used_mouse_menu
= 0;
8440 /* Use local over global Menu maps */
8442 if (! menu_prompting
)
8445 /* Optionally disregard all but the global map. */
8446 if (inhibit_local_menu_bar_menus
)
8448 maps
+= (nmaps
- 1);
8453 /* If we got to this point via a mouse click,
8454 use a real menu for mouse selection. */
8455 if (EVENT_HAS_PARAMETERS (prev_event
)
8456 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8457 && !EQ (XCAR (prev_event
), Qtool_bar
))
8459 /* Display the menu and get the selection. */
8460 Lisp_Object
*realmaps
= alloca (nmaps
* sizeof *realmaps
);
8462 ptrdiff_t nmaps1
= 0;
8464 /* Use the maps that are not nil. */
8465 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8466 if (!NILP (maps
[mapno
]))
8467 realmaps
[nmaps1
++] = maps
[mapno
];
8469 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8474 record_menu_key (XCAR (value
));
8476 /* If we got multiple events, unread all but
8478 There is no way to prevent those unread events
8479 from showing up later in last_nonmenu_event.
8480 So turn symbol and integer events into lists,
8481 to indicate that they came from a mouse menu,
8482 so that when present in last_nonmenu_event
8483 they won't confuse things. */
8484 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8486 record_menu_key (XCAR (tem
));
8487 if (SYMBOLP (XCAR (tem
))
8488 || INTEGERP (XCAR (tem
)))
8489 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8492 /* If we got more than one event, put all but the first
8493 onto this list to be read later.
8494 Return just the first event now. */
8495 Vunread_command_events
8496 = nconc2 (XCDR (value
), Vunread_command_events
);
8497 value
= XCAR (value
);
8499 else if (NILP (value
))
8501 if (used_mouse_menu
)
8502 *used_mouse_menu
= 1;
8505 #endif /* HAVE_MENUS */
8509 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8510 We make this bigger when necessary, and never free it. */
8511 static char *read_char_minibuf_menu_text
;
8512 /* Size of that buffer. */
8513 static ptrdiff_t read_char_minibuf_menu_width
;
8516 read_char_minibuf_menu_prompt (int commandflag
,
8517 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8520 register Lisp_Object name
;
8522 /* FIXME: Use the minibuffer's frame width. */
8523 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8526 Lisp_Object rest
, vector
;
8532 if (! menu_prompting
)
8535 /* Get the menu name from the first map that has one (a prompt string). */
8536 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8538 name
= Fkeymap_prompt (maps
[mapno
]);
8543 /* If we don't have any menus, just read a character normally. */
8544 if (!STRINGP (name
))
8547 /* Make sure we have a big enough buffer for the menu text. */
8548 width
= max (width
, SBYTES (name
));
8549 if (STRING_BYTES_BOUND
- 4 < width
)
8550 memory_full (SIZE_MAX
);
8551 if (width
+ 4 > read_char_minibuf_menu_width
)
8553 read_char_minibuf_menu_text
8554 = xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8555 read_char_minibuf_menu_width
= width
+ 4;
8557 menu
= read_char_minibuf_menu_text
;
8559 /* Prompt string always starts with map's prompt, and a space. */
8560 strcpy (menu
, SSDATA (name
));
8561 nlength
= SBYTES (name
);
8562 menu
[nlength
++] = ':';
8563 menu
[nlength
++] = ' ';
8566 /* Start prompting at start of first map. */
8570 /* Present the documented bindings, a line at a time. */
8574 ptrdiff_t i
= nlength
;
8576 Lisp_Object orig_defn_macro
;
8578 /* Loop over elements of map. */
8583 /* If reached end of map, start at beginning of next map. */
8587 /* At end of last map, wrap around to first map if just starting,
8588 or end this line if already have something on it. */
8592 if (notfirst
|| nobindings
) break;
8597 /* Look at the next element of the map. */
8599 elt
= AREF (vector
, idx
);
8601 elt
= Fcar_safe (rest
);
8603 if (idx
< 0 && VECTORP (elt
))
8605 /* If we found a dense table in the keymap,
8606 advanced past it, but start scanning its contents. */
8607 rest
= Fcdr_safe (rest
);
8613 /* An ordinary element. */
8614 Lisp_Object event
, tem
;
8618 event
= Fcar_safe (elt
); /* alist */
8619 elt
= Fcdr_safe (elt
);
8623 XSETINT (event
, idx
); /* vector */
8626 /* Ignore the element if it has no prompt string. */
8627 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8629 /* 1 if the char to type matches the string. */
8631 Lisp_Object upcased_event
, downcased_event
;
8632 Lisp_Object desc
= Qnil
;
8634 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8636 upcased_event
= Fupcase (event
);
8637 downcased_event
= Fdowncase (event
);
8638 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8639 || XINT (downcased_event
) == SREF (s
, 0));
8641 desc
= Fsingle_key_description (event
, Qnil
);
8643 #if 0 /* It is redundant to list the equivalent key bindings because
8644 the prefix is what the user has already typed. */
8646 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8648 /* Insert equivalent keybinding. */
8649 s
= concat2 (s
, tem
);
8652 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8653 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8655 /* Insert button prefix. */
8656 Lisp_Object selected
8657 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8658 if (EQ (tem
, QCradio
))
8659 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8661 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8662 s
= concat2 (tem
, s
);
8666 /* If we have room for the prompt string, add it to this line.
8667 If this is the first on the line, always add it. */
8668 if ((SCHARS (s
) + i
+ 2
8669 + (char_matches
? 0 : SCHARS (desc
) + 3))
8673 ptrdiff_t thiswidth
;
8675 /* Punctuate between strings. */
8678 strcpy (menu
+ i
, ", ");
8684 /* If the char to type doesn't match the string's
8685 first char, explicitly show what char to type. */
8688 /* Add as much of string as fits. */
8689 thiswidth
= min (SCHARS (desc
), width
- i
);
8690 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8692 strcpy (menu
+ i
, " = ");
8696 /* Add as much of string as fits. */
8697 thiswidth
= min (SCHARS (s
), width
- i
);
8698 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8704 /* If this element does not fit, end the line now,
8705 and save the element for the next line. */
8706 strcpy (menu
+ i
, "...");
8711 /* Move past this element. */
8712 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8713 /* Handle reaching end of dense table. */
8718 rest
= Fcdr_safe (rest
);
8722 /* Prompt with that and read response. */
8723 message2_nolog (menu
, strlen (menu
),
8724 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8726 /* Make believe its not a keyboard macro in case the help char
8727 is pressed. Help characters are not recorded because menu prompting
8728 is not used on replay.
8730 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8731 KVAR (current_kboard
, defining_kbd_macro
) = Qnil
;
8733 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8734 while (BUFFERP (obj
));
8735 KVAR (current_kboard
, defining_kbd_macro
) = orig_defn_macro
;
8737 if (!INTEGERP (obj
))
8739 else if (XINT (obj
) == -2)
8742 if (! EQ (obj
, menu_prompt_more_char
)
8743 && (!INTEGERP (menu_prompt_more_char
)
8744 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8746 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8747 store_kbd_macro_char (obj
);
8750 /* Help char - go round again */
8754 /* Reading key sequences. */
8756 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8757 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8758 keymap, or nil otherwise. Return the index of the first keymap in
8759 which KEY has any binding, or NMAPS if no map has a binding.
8761 If KEY is a meta ASCII character, treat it like meta-prefix-char
8762 followed by the corresponding non-meta character. Keymaps in
8763 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8766 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8769 NEXT may be the same array as CURRENT. */
8772 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8773 Lisp_Object
*defs
, Lisp_Object
*next
)
8775 ptrdiff_t i
, first_binding
;
8777 first_binding
= nmaps
;
8778 for (i
= nmaps
- 1; i
>= 0; i
--)
8780 if (! NILP (current
[i
]))
8782 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8783 if (! NILP (defs
[i
]))
8790 /* Given the set of bindings we've found, produce the next set of maps. */
8791 if (first_binding
< nmaps
)
8792 for (i
= 0; i
< nmaps
; i
++)
8793 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8795 return first_binding
;
8798 /* Structure used to keep track of partial application of key remapping
8799 such as Vfunction_key_map and Vkey_translation_map. */
8800 typedef struct keyremap
8802 /* This is the map originally specified for this use. */
8804 /* This is a submap reached by looking up, in PARENT,
8805 the events from START to END. */
8807 /* Positions [START, END) in the key sequence buffer
8808 are the key that we have scanned so far.
8809 Those events are the ones that we will replace
8810 if PARENT maps them into a key sequence. */
8814 /* Lookup KEY in MAP.
8815 MAP is a keymap mapping keys to key vectors or functions.
8816 If the mapping is a function and DO_FUNCTION is non-zero, then
8817 the function is called with PROMPT as parameter and its return
8818 value is used as the return value of this function (after checking
8819 that it is indeed a vector). */
8822 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8827 next
= access_keymap (map
, key
, 1, 0, 1);
8829 /* Handle a symbol whose function definition is a keymap
8831 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8832 && (ARRAYP (SVAR (XSYMBOL (next
), function
))
8833 || KEYMAPP (SVAR (XSYMBOL (next
), function
))))
8834 next
= Fautoload_do_load (SVAR (XSYMBOL (next
), function
), next
, Qnil
);
8836 /* If the keymap gives a function, not an
8837 array, then call the function with one arg and use
8838 its value instead. */
8839 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8844 next
= call1 (next
, prompt
);
8845 /* If the function returned something invalid,
8846 barf--don't ignore it.
8847 (To ignore it safely, we would need to gcpro a bunch of
8848 other variables.) */
8849 if (! (VECTORP (next
) || STRINGP (next
)))
8850 error ("Function %s returns invalid key sequence",
8851 SSDATA (SYMBOL_NAME (tem
)));
8856 /* Do one step of the key remapping used for function-key-map and
8857 key-translation-map:
8858 KEYBUF is the buffer holding the input events.
8859 BUFSIZE is its maximum size.
8860 FKEY is a pointer to the keyremap structure to use.
8861 INPUT is the index of the last element in KEYBUF.
8862 DOIT if non-zero says that the remapping can actually take place.
8863 DIFF is used to return the number of keys added/removed by the remapping.
8864 PARENT is the root of the keymap.
8865 PROMPT is the prompt to use if the remapping happens through a function.
8866 The return value is non-zero if the remapping actually took place. */
8869 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8870 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8872 Lisp_Object next
, key
;
8874 key
= keybuf
[fkey
->end
++];
8876 if (KEYMAPP (fkey
->parent
))
8877 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8881 /* If keybuf[fkey->start..fkey->end] is bound in the
8882 map and we're in a position to do the key remapping, replace it with
8883 the binding and restart with fkey->start at the end. */
8884 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8886 int len
= XFASTINT (Flength (next
));
8889 *diff
= len
- (fkey
->end
- fkey
->start
);
8891 if (bufsize
- input
<= *diff
)
8892 error ("Key sequence too long");
8894 /* Shift the keys that follow fkey->end. */
8896 for (i
= fkey
->end
; i
< input
; i
++)
8897 keybuf
[i
+ *diff
] = keybuf
[i
];
8899 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8900 keybuf
[i
+ *diff
] = keybuf
[i
];
8901 /* Overwrite the old keys with the new ones. */
8902 for (i
= 0; i
< len
; i
++)
8903 keybuf
[fkey
->start
+ i
]
8904 = Faref (next
, make_number (i
));
8906 fkey
->start
= fkey
->end
+= *diff
;
8907 fkey
->map
= fkey
->parent
;
8912 fkey
->map
= get_keymap (next
, 0, 1);
8914 /* If we no longer have a bound suffix, try a new position for
8916 if (!CONSP (fkey
->map
))
8918 fkey
->end
= ++fkey
->start
;
8919 fkey
->map
= fkey
->parent
;
8925 test_undefined (Lisp_Object binding
)
8927 return (EQ (binding
, Qundefined
)
8928 || (!NILP (binding
) && SYMBOLP (binding
)
8929 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8932 /* Read a sequence of keys that ends with a non prefix character,
8933 storing it in KEYBUF, a buffer of size BUFSIZE.
8935 Return the length of the key sequence stored.
8936 Return -1 if the user rejected a command menu.
8938 Echo starting immediately unless `prompt' is 0.
8940 Where a key sequence ends depends on the currently active keymaps.
8941 These include any minor mode keymaps active in the current buffer,
8942 the current buffer's local map, and the global map.
8944 If a key sequence has no other bindings, we check Vfunction_key_map
8945 to see if some trailing subsequence might be the beginning of a
8946 function key's sequence. If so, we try to read the whole function
8947 key, and substitute its symbolic name into the key sequence.
8949 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8950 `double-' events into similar click events, if that would make them
8951 bound. We try to turn `triple-' events first into `double-' events,
8954 If we get a mouse click in a mode line, vertical divider, or other
8955 non-text area, we treat the click as if it were prefixed by the
8956 symbol denoting that area - `mode-line', `vertical-line', or
8959 If the sequence starts with a mouse click, we read the key sequence
8960 with respect to the buffer clicked on, not the current buffer.
8962 If the user switches frames in the midst of a key sequence, we put
8963 off the switch-frame event until later; the next call to
8964 read_char will return it.
8966 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8967 from the selected window's buffer. */
8970 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8971 int dont_downcase_last
, int can_return_switch_frame
,
8972 int fix_current_buffer
)
8974 Lisp_Object from_string
;
8975 ptrdiff_t count
= SPECPDL_INDEX ();
8977 /* How many keys there are in the current key sequence. */
8980 /* The length of the echo buffer when we started reading, and
8981 the length of this_command_keys when we started reading. */
8982 ptrdiff_t echo_start
IF_LINT (= 0);
8983 ptrdiff_t keys_start
;
8985 /* The number of keymaps we're scanning right now, and the number of
8986 keymaps we have allocated space for. */
8988 ptrdiff_t nmaps_allocated
= 0;
8990 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8991 the current keymaps. */
8992 Lisp_Object
*defs
= NULL
;
8994 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8995 in the current keymaps, or nil where it is not a prefix. */
8996 Lisp_Object
*submaps
= NULL
;
8998 /* The local map to start out with at start of key sequence. */
8999 Lisp_Object orig_local_map
;
9001 /* The map from the `keymap' property to start out with at start of
9003 Lisp_Object orig_keymap
;
9005 /* 1 if we have already considered switching to the local-map property
9006 of the place where a mouse click occurred. */
9007 int localized_local_map
= 0;
9009 /* The index in submaps[] of the first keymap that has a binding for
9010 this key sequence. In other words, the lowest i such that
9011 submaps[i] is non-nil. */
9012 ptrdiff_t first_binding
;
9013 /* Index of the first key that has no binding.
9014 It is useless to try fkey.start larger than that. */
9017 /* If t < mock_input, then KEYBUF[t] should be read as the next
9020 We use this to recover after recognizing a function key. Once we
9021 realize that a suffix of the current key sequence is actually a
9022 function key's escape sequence, we replace the suffix with the
9023 function key's binding from Vfunction_key_map. Now keybuf
9024 contains a new and different key sequence, so the echo area,
9025 this_command_keys, and the submaps and defs arrays are wrong. In
9026 this situation, we set mock_input to t, set t to 0, and jump to
9027 restart_sequence; the loop will read keys from keybuf up until
9028 mock_input, thus rebuilding the state; and then it will resume
9029 reading characters from the keyboard. */
9032 /* If the sequence is unbound in submaps[], then
9033 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9034 and fkey.map is its binding.
9036 These might be > t, indicating that all function key scanning
9037 should hold off until t reaches them. We do this when we've just
9038 recognized a function key, to avoid searching for the function
9039 key's again in Vfunction_key_map. */
9042 /* Likewise, for key_translation_map and input-decode-map. */
9043 keyremap keytran
, indec
;
9045 /* Non-zero if we are trying to map a key by changing an upper-case
9046 letter to lower case, or a shifted function key to an unshifted
9048 int shift_translated
= 0;
9050 /* If we receive a `switch-frame' or `select-window' event in the middle of
9051 a key sequence, we put it off for later.
9052 While we're reading, we keep the event here. */
9053 Lisp_Object delayed_switch_frame
;
9055 /* See the comment below... */
9056 #if defined (GOBBLE_FIRST_EVENT)
9057 Lisp_Object first_event
;
9060 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9061 int original_uppercase_position
= -1;
9063 /* Gets around Microsoft compiler limitations. */
9066 struct buffer
*starting_buffer
;
9068 /* List of events for which a fake prefix key has been generated. */
9069 Lisp_Object fake_prefixed_keys
= Qnil
;
9071 #if defined (GOBBLE_FIRST_EVENT)
9075 struct gcpro gcpro1
;
9077 GCPRO1 (fake_prefixed_keys
);
9078 raw_keybuf_count
= 0;
9080 last_nonmenu_event
= Qnil
;
9082 delayed_switch_frame
= Qnil
;
9088 /* Install the string STR as the beginning of the string of
9089 echoing, so that it serves as a prompt for the next
9091 KVAR (current_kboard
, echo_string
) = prompt
;
9092 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9095 else if (cursor_in_echo_area
9096 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9097 && NILP (Fzerop (Vecho_keystrokes
)))
9098 /* This doesn't put in a dash if the echo buffer is empty, so
9099 you don't always see a dash hanging out in the minibuffer. */
9103 /* Record the initial state of the echo area and this_command_keys;
9104 we will need to restore them if we replay a key sequence. */
9106 echo_start
= echo_length ();
9107 keys_start
= this_command_key_count
;
9108 this_single_command_key_start
= keys_start
;
9110 #if defined (GOBBLE_FIRST_EVENT)
9111 /* This doesn't quite work, because some of the things that read_char
9112 does cannot safely be bypassed. It seems too risky to try to make
9115 /* Read the first char of the sequence specially, before setting
9116 up any keymaps, in case a filter runs and switches buffers on us. */
9117 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9119 #endif /* GOBBLE_FIRST_EVENT */
9121 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9122 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9125 /* We jump here when we need to reinitialize fkey and keytran; this
9126 happens if we switch keyboards between rescans. */
9127 replay_entire_sequence
:
9129 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9130 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9131 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9132 indec
.start
= indec
.end
= 0;
9133 fkey
.start
= fkey
.end
= 0;
9134 keytran
.start
= keytran
.end
= 0;
9136 /* We jump here when the key sequence has been thoroughly changed, and
9137 we need to rescan it starting from the beginning. When we jump here,
9138 keybuf[0..mock_input] holds the sequence we should reread. */
9141 starting_buffer
= current_buffer
;
9142 first_unbound
= bufsize
+ 1;
9144 /* Build our list of keymaps.
9145 If we recognize a function key and replace its escape sequence in
9146 keybuf with its symbol, or if the sequence starts with a mouse
9147 click and we need to switch buffers, we jump back here to rebuild
9148 the initial keymaps from the current buffer. */
9151 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9153 if (2 > nmaps_allocated
)
9155 submaps
= alloca (2 * sizeof *submaps
);
9156 defs
= alloca (2 * sizeof *defs
);
9157 nmaps_allocated
= 2;
9159 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9161 else if (!NILP (Voverriding_local_map
))
9163 if (2 > nmaps_allocated
)
9165 submaps
= alloca (2 * sizeof *submaps
);
9166 defs
= alloca (2 * sizeof *defs
);
9167 nmaps_allocated
= 2;
9169 submaps
[nmaps
++] = Voverriding_local_map
;
9177 nminor
= current_minor_maps (0, &maps
);
9178 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9180 if (total
> nmaps_allocated
)
9182 submaps
= alloca (total
* sizeof *submaps
);
9183 defs
= alloca (total
* sizeof *defs
);
9184 nmaps_allocated
= total
;
9187 if (!NILP (orig_keymap
))
9188 submaps
[nmaps
++] = orig_keymap
;
9190 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9194 submaps
[nmaps
++] = orig_local_map
;
9196 submaps
[nmaps
++] = current_global_map
;
9198 /* Find an accurate initial value for first_binding. */
9199 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9200 if (! NILP (submaps
[first_binding
]))
9203 /* Start from the beginning in keybuf. */
9206 /* These are no-ops the first time through, but if we restart, they
9207 revert the echo area and this_command_keys to their original state. */
9208 this_command_key_count
= keys_start
;
9209 if (INTERACTIVE
&& t
< mock_input
)
9210 echo_truncate (echo_start
);
9212 /* If the best binding for the current key sequence is a keymap, or
9213 we may be looking at a function key's escape sequence, keep on
9215 while (first_binding
< nmaps
9216 /* Keep reading as long as there's a prefix binding. */
9217 ? !NILP (submaps
[first_binding
])
9218 /* Don't return in the middle of a possible function key sequence,
9219 if the only bindings we found were via case conversion.
9220 Thus, if ESC O a has a function-key-map translation
9221 and ESC o has a binding, don't return after ESC O,
9222 so that we can translate ESC O plus the next character. */
9223 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9226 int used_mouse_menu
= 0;
9228 /* Where the last real key started. If we need to throw away a
9229 key that has expanded into more than one element of keybuf
9230 (say, a mouse click on the mode line which is being treated
9231 as [mode-line (mouse-...)], then we backtrack to this point
9233 int last_real_key_start
;
9235 /* These variables are analogous to echo_start and keys_start;
9236 while those allow us to restart the entire key sequence,
9237 echo_local_start and keys_local_start allow us to throw away
9239 ptrdiff_t echo_local_start
IF_LINT (= 0);
9240 int keys_local_start
;
9241 ptrdiff_t local_first_binding
;
9243 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9244 eassert (indec
.start
<= indec
.end
);
9245 eassert (fkey
.start
<= fkey
.end
);
9246 eassert (keytran
.start
<= keytran
.end
);
9247 /* key-translation-map is applied *after* function-key-map
9248 which is itself applied *after* input-decode-map. */
9249 eassert (fkey
.end
<= indec
.start
);
9250 eassert (keytran
.end
<= fkey
.start
);
9252 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9253 first_unbound
< keytran
.start
)
9254 { /* The prefix upto first_unbound has no binding and has
9255 no translation left to do either, so we know it's unbound.
9256 If we don't stop now, we risk staying here indefinitely
9257 (if the user keeps entering fkey or keytran prefixes
9258 like C-c ESC ESC ESC ESC ...) */
9260 for (i
= first_unbound
+ 1; i
< t
; i
++)
9261 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9262 mock_input
= t
- first_unbound
- 1;
9263 indec
.end
= indec
.start
-= first_unbound
+ 1;
9264 indec
.map
= indec
.parent
;
9265 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9266 fkey
.map
= fkey
.parent
;
9267 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9268 keytran
.map
= keytran
.parent
;
9269 goto replay_sequence
;
9273 error ("Key sequence too long");
9276 echo_local_start
= echo_length ();
9277 keys_local_start
= this_command_key_count
;
9278 local_first_binding
= first_binding
;
9281 /* These are no-ops, unless we throw away a keystroke below and
9282 jumped back up to replay_key; in that case, these restore the
9283 variables to their original state, allowing us to replay the
9285 if (INTERACTIVE
&& t
< mock_input
)
9286 echo_truncate (echo_local_start
);
9287 this_command_key_count
= keys_local_start
;
9288 first_binding
= local_first_binding
;
9290 /* By default, assume each event is "real". */
9291 last_real_key_start
= t
;
9293 /* Does mock_input indicate that we are re-reading a key sequence? */
9297 add_command_key (key
);
9298 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9299 && NILP (Fzerop (Vecho_keystrokes
)))
9303 /* If not, we should actually read a character. */
9307 KBOARD
*interrupted_kboard
= current_kboard
;
9308 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9309 key
= read_char (NILP (prompt
), nmaps
,
9310 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9311 &used_mouse_menu
, NULL
);
9312 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9313 /* When switching to a new tty (with a new keyboard),
9314 read_char returns the new buffer, rather than -2
9315 (Bug#5095). This is because `terminal-init-xterm'
9316 calls read-char, which eats the wrong_kboard_jmpbuf
9317 return. Any better way to fix this? -- cyd */
9318 || (interrupted_kboard
!= current_kboard
))
9323 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9324 if (k
== interrupted_kboard
)
9329 /* Don't touch interrupted_kboard when it's been
9331 delayed_switch_frame
= Qnil
;
9332 goto replay_entire_sequence
;
9335 if (!NILP (delayed_switch_frame
))
9337 KVAR (interrupted_kboard
, kbd_queue
)
9338 = Fcons (delayed_switch_frame
,
9339 KVAR (interrupted_kboard
, kbd_queue
));
9340 delayed_switch_frame
= Qnil
;
9344 KVAR (interrupted_kboard
, kbd_queue
)
9345 = Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
));
9347 /* If the side queue is non-empty, ensure it begins with a
9348 switch-frame, so we'll replay it in the right context. */
9349 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9350 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9351 !(EVENT_HAS_PARAMETERS (key
)
9352 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9356 XSETFRAME (frame
, interrupted_frame
);
9357 KVAR (interrupted_kboard
, kbd_queue
)
9358 = Fcons (make_lispy_switch_frame (frame
),
9359 KVAR (interrupted_kboard
, kbd_queue
));
9362 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9363 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9364 goto replay_entire_sequence
;
9368 /* read_char returns t when it shows a menu and the user rejects it.
9372 unbind_to (count
, Qnil
);
9377 /* read_char returns -1 at the end of a macro.
9378 Emacs 18 handles this by returning immediately with a
9379 zero, so that's what we'll do. */
9380 if (INTEGERP (key
) && XINT (key
) == -1)
9383 /* The Microsoft C compiler can't handle the goto that
9389 /* If the current buffer has been changed from under us, the
9390 keymap may have changed, so replay the sequence. */
9393 timer_resume_idle ();
9396 /* Reset the current buffer from the selected window
9397 in case something changed the former and not the latter.
9398 This is to be more consistent with the behavior
9399 of the command_loop_1. */
9400 if (fix_current_buffer
)
9402 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9404 if (XBUFFER (WVAR (XWINDOW (selected_window
), buffer
)) != current_buffer
)
9405 Fset_buffer (WVAR (XWINDOW (selected_window
), buffer
));
9408 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9409 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9410 goto replay_sequence
;
9413 /* If we have a quit that was typed in another frame, and
9414 quit_throw_to_read_char switched buffers,
9415 replay to get the right keymap. */
9417 && XINT (key
) == quit_char
9418 && current_buffer
!= starting_buffer
)
9421 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9426 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9427 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9428 goto replay_sequence
;
9433 if (EVENT_HAS_PARAMETERS (key
)
9434 /* Either a `switch-frame' or a `select-window' event. */
9435 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9437 /* If we're at the beginning of a key sequence, and the caller
9438 says it's okay, go ahead and return this event. If we're
9439 in the midst of a key sequence, delay it until the end. */
9440 if (t
> 0 || !can_return_switch_frame
)
9442 delayed_switch_frame
= key
;
9448 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9452 /* Clicks in non-text areas get prefixed by the symbol
9453 in their CHAR-ADDRESS field. For example, a click on
9454 the mode line is prefixed by the symbol `mode-line'.
9456 Furthermore, key sequences beginning with mouse clicks
9457 are read using the keymaps of the buffer clicked on, not
9458 the current buffer. So we may have to switch the buffer
9461 When we turn one event into two events, we must make sure
9462 that neither of the two looks like the original--so that,
9463 if we replay the events, they won't be expanded again.
9464 If not for this, such reexpansion could happen either here
9465 or when user programs play with this-command-keys. */
9466 if (EVENT_HAS_PARAMETERS (key
))
9471 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9472 if (EQ (kind
, Qmouse_click
))
9474 Lisp_Object window
, posn
;
9476 window
= POSN_WINDOW (EVENT_START (key
));
9477 posn
= POSN_POSN (EVENT_START (key
));
9480 || (!NILP (fake_prefixed_keys
)
9481 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9483 /* We're looking a second time at an event for which
9484 we generated a fake prefix key. Set
9485 last_real_key_start appropriately. */
9487 last_real_key_start
= t
- 1;
9490 if (last_real_key_start
== 0)
9492 /* Key sequences beginning with mouse clicks are
9493 read using the keymaps in the buffer clicked on,
9494 not the current buffer. If we're at the
9495 beginning of a key sequence, switch buffers. */
9496 if (WINDOWP (window
)
9497 && BUFFERP (WVAR (XWINDOW (window
), buffer
))
9498 && XBUFFER (WVAR (XWINDOW (window
), buffer
)) != current_buffer
)
9500 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9505 /* Arrange to go back to the original buffer once we're
9506 done reading the key sequence. Note that we can't
9507 use save_excursion_{save,restore} here, because they
9508 save point as well as the current buffer; we don't
9509 want to save point, because redisplay may change it,
9510 to accommodate a Fset_window_start or something. We
9511 don't want to do this at the top of the function,
9512 because we may get input from a subprocess which
9513 wants to change the selected window and stuff (say,
9515 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9517 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9519 set_buffer_internal (XBUFFER (WVAR (XWINDOW (window
), buffer
)));
9520 orig_local_map
= get_local_map (PT
, current_buffer
,
9522 orig_keymap
= get_local_map (PT
, current_buffer
,
9524 goto replay_sequence
;
9527 /* For a mouse click, get the local text-property keymap
9528 of the place clicked on, rather than point. */
9529 if (CONSP (XCDR (key
))
9530 && ! localized_local_map
)
9532 Lisp_Object map_here
, start
, pos
;
9534 localized_local_map
= 1;
9535 start
= EVENT_START (key
);
9537 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9539 pos
= POSN_BUFFER_POSN (start
);
9541 && XINT (pos
) >= BEGV
9542 && XINT (pos
) <= ZV
)
9544 map_here
= get_local_map (XINT (pos
),
9547 if (!EQ (map_here
, orig_local_map
))
9549 orig_local_map
= map_here
;
9550 ++localized_local_map
;
9553 map_here
= get_local_map (XINT (pos
),
9556 if (!EQ (map_here
, orig_keymap
))
9558 orig_keymap
= map_here
;
9559 ++localized_local_map
;
9562 if (localized_local_map
> 1)
9567 goto replay_sequence
;
9574 /* Expand mode-line and scroll-bar events into two events:
9575 use posn as a fake prefix key. */
9577 && (NILP (fake_prefixed_keys
)
9578 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9580 if (bufsize
- t
<= 1)
9581 error ("Key sequence too long");
9584 keybuf
[t
+ 1] = key
;
9587 /* Record that a fake prefix key has been generated
9588 for KEY. Don't modify the event; this would
9589 prevent proper action when the event is pushed
9590 back into unread-command-events. */
9591 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9593 /* If on a mode line string with a local keymap,
9594 reconsider the key sequence with that keymap. */
9595 if (string
= POSN_STRING (EVENT_START (key
)),
9596 (CONSP (string
) && STRINGP (XCAR (string
))))
9598 Lisp_Object pos
, map
, map2
;
9600 pos
= XCDR (string
);
9601 string
= XCAR (string
);
9603 && XINT (pos
) < SCHARS (string
))
9605 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9607 orig_local_map
= map
;
9608 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9611 if (!NILP (map
) || !NILP (map2
))
9612 goto replay_sequence
;
9618 else if (NILP (from_string
)
9619 && (string
= POSN_STRING (EVENT_START (key
)),
9620 (CONSP (string
) && STRINGP (XCAR (string
)))))
9622 /* For a click on a string, i.e. overlay string or a
9623 string displayed via the `display' property,
9624 consider `local-map' and `keymap' properties of
9626 Lisp_Object pos
, map
, map2
;
9628 pos
= XCDR (string
);
9629 string
= XCAR (string
);
9631 && XINT (pos
) < SCHARS (string
))
9633 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9635 orig_local_map
= map
;
9636 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9640 if (!NILP (map
) || !NILP (map2
))
9642 from_string
= string
;
9645 goto replay_sequence
;
9650 else if (CONSP (XCDR (key
))
9651 && CONSP (EVENT_START (key
))
9652 && CONSP (XCDR (EVENT_START (key
))))
9656 posn
= POSN_POSN (EVENT_START (key
));
9657 /* Handle menu-bar events:
9658 insert the dummy prefix event `menu-bar'. */
9659 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9661 if (bufsize
- t
<= 1)
9662 error ("Key sequence too long");
9666 /* Zap the position in key, so we know that we've
9667 expanded it, and don't try to do so again. */
9668 POSN_SET_POSN (EVENT_START (key
),
9669 Fcons (posn
, Qnil
));
9672 goto replay_sequence
;
9674 else if (CONSP (posn
))
9676 /* We're looking at the second event of a
9677 sequence which we expanded before. Set
9678 last_real_key_start appropriately. */
9679 if (last_real_key_start
== t
&& t
> 0)
9680 last_real_key_start
= t
- 1;
9685 /* We have finally decided that KEY is something we might want
9687 first_binding
= (follow_key (key
,
9688 nmaps
- first_binding
,
9689 submaps
+ first_binding
,
9690 defs
+ first_binding
,
9691 submaps
+ first_binding
)
9694 /* If KEY wasn't bound, we'll try some fallbacks. */
9695 if (first_binding
< nmaps
)
9696 /* This is needed for the following scenario:
9697 event 0: a down-event that gets dropped by calling replay_key.
9698 event 1: some normal prefix like C-h.
9699 After event 0, first_unbound is 0, after event 1 indec.start,
9700 fkey.start, and keytran.start are all 1, so when we see that
9701 C-h is bound, we need to update first_unbound. */
9702 first_unbound
= max (t
+ 1, first_unbound
);
9707 /* Remember the position to put an upper bound on indec.start. */
9708 first_unbound
= min (t
, first_unbound
);
9710 head
= EVENT_HEAD (key
);
9711 if (help_char_p (head
) && t
> 0)
9713 read_key_sequence_cmd
= Vprefix_help_command
;
9715 last_nonmenu_event
= key
;
9716 /* The Microsoft C compiler can't handle the goto that
9724 Lisp_Object breakdown
;
9727 breakdown
= parse_modifiers (head
);
9728 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9729 /* Attempt to reduce an unbound mouse event to a simpler
9730 event that is bound:
9731 Drags reduce to clicks.
9732 Double-clicks reduce to clicks.
9733 Triple-clicks reduce to double-clicks, then to clicks.
9734 Down-clicks are eliminated.
9735 Double-downs reduce to downs, then are eliminated.
9736 Triple-downs reduce to double-downs, then to downs,
9737 then are eliminated. */
9738 if (modifiers
& (down_modifier
| drag_modifier
9739 | double_modifier
| triple_modifier
))
9741 while (modifiers
& (down_modifier
| drag_modifier
9742 | double_modifier
| triple_modifier
))
9744 Lisp_Object new_head
, new_click
;
9745 if (modifiers
& triple_modifier
)
9746 modifiers
^= (double_modifier
| triple_modifier
);
9747 else if (modifiers
& double_modifier
)
9748 modifiers
&= ~double_modifier
;
9749 else if (modifiers
& drag_modifier
)
9750 modifiers
&= ~drag_modifier
;
9753 /* Dispose of this `down' event by simply jumping
9754 back to replay_key, to get another event.
9756 Note that if this event came from mock input,
9757 then just jumping back to replay_key will just
9758 hand it to us again. So we have to wipe out any
9761 We could delete keybuf[t] and shift everything
9762 after that to the left by one spot, but we'd also
9763 have to fix up any variable that points into
9764 keybuf, and shifting isn't really necessary
9767 Adding prefixes for non-textual mouse clicks
9768 creates two characters of mock input, and both
9769 must be thrown away. If we're only looking at
9770 the prefix now, we can just jump back to
9771 replay_key. On the other hand, if we've already
9772 processed the prefix, and now the actual click
9773 itself is giving us trouble, then we've lost the
9774 state of the keymaps we want to backtrack to, and
9775 we need to replay the whole sequence to rebuild
9778 Beyond that, only function key expansion could
9779 create more than two keys, but that should never
9780 generate mouse events, so it's okay to zero
9781 mock_input in that case too.
9783 FIXME: The above paragraph seems just plain
9784 wrong, if you consider things like
9785 xterm-mouse-mode. -stef
9787 Isn't this just the most wonderful code ever? */
9789 /* If mock_input > t + 1, the above simplification
9790 will actually end up dropping keys on the floor.
9791 This is probably OK for now, but even
9792 if mock_input <= t + 1, we need to adjust indec,
9794 Typical case [header-line down-mouse-N]:
9795 mock_input = 2, t = 1, fkey.end = 1,
9796 last_real_key_start = 0. */
9797 if (indec
.end
> last_real_key_start
)
9799 indec
.end
= indec
.start
9800 = min (last_real_key_start
, indec
.start
);
9801 indec
.map
= indec
.parent
;
9802 if (fkey
.end
> last_real_key_start
)
9804 fkey
.end
= fkey
.start
9805 = min (last_real_key_start
, fkey
.start
);
9806 fkey
.map
= fkey
.parent
;
9807 if (keytran
.end
> last_real_key_start
)
9809 keytran
.end
= keytran
.start
9810 = min (last_real_key_start
, keytran
.start
);
9811 keytran
.map
= keytran
.parent
;
9815 if (t
== last_real_key_start
)
9822 mock_input
= last_real_key_start
;
9823 goto replay_sequence
;
9828 = apply_modifiers (modifiers
, XCAR (breakdown
));
9830 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9832 /* Look for a binding for this new key. follow_key
9833 promises that it didn't munge submaps the
9834 last time we called it, since key was unbound. */
9836 = (follow_key (new_click
,
9837 nmaps
- local_first_binding
,
9838 submaps
+ local_first_binding
,
9839 defs
+ local_first_binding
,
9840 submaps
+ local_first_binding
)
9841 + local_first_binding
);
9843 /* If that click is bound, go for it. */
9844 if (first_binding
< nmaps
)
9849 /* Otherwise, we'll leave key set to the drag event. */
9856 /* Normally, last_nonmenu_event gets the previous key we read.
9857 But when a mouse popup menu is being used,
9858 we don't update last_nonmenu_event; it continues to hold the mouse
9859 event that preceded the first level of menu. */
9860 if (!used_mouse_menu
)
9861 last_nonmenu_event
= key
;
9863 /* Record what part of this_command_keys is the current key sequence. */
9864 this_single_command_key_start
= this_command_key_count
- t
;
9866 /* Look for this sequence in input-decode-map.
9867 Scan from indec.end until we find a bound suffix. */
9868 while (indec
.end
< t
)
9870 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9873 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9874 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9879 mock_input
= diff
+ max (t
, mock_input
);
9880 goto replay_sequence
;
9884 if (first_binding
< nmaps
9885 && NILP (submaps
[first_binding
])
9886 && !test_undefined (defs
[first_binding
])
9887 && indec
.start
>= t
)
9888 /* There is a binding and it's not a prefix.
9889 (and it doesn't have any input-decode-map translation pending).
9890 There is thus no function-key in this sequence.
9891 Moving fkey.start is important in this case to allow keytran.start
9892 to go over the sequence before we return (since we keep the
9893 invariant that keytran.end <= fkey.start). */
9896 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9899 /* If the sequence is unbound, see if we can hang a function key
9900 off the end of it. */
9901 /* Continue scan from fkey.end until we find a bound suffix. */
9902 while (fkey
.end
< indec
.start
)
9904 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9907 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9908 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9909 max (t
, mock_input
),
9910 /* If there's a binding (i.e.
9911 first_binding >= nmaps) we don't want
9912 to apply this function-key-mapping. */
9914 && (first_binding
>= nmaps
9915 || test_undefined (defs
[first_binding
])),
9920 mock_input
= diff
+ max (t
, mock_input
);
9921 /* Adjust the input-decode-map counters. */
9923 indec
.start
+= diff
;
9925 goto replay_sequence
;
9929 /* Look for this sequence in key-translation-map.
9930 Scan from keytran.end until we find a bound suffix. */
9931 while (keytran
.end
< fkey
.start
)
9933 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9936 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9937 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9942 mock_input
= diff
+ max (t
, mock_input
);
9943 /* Adjust the function-key-map and input-decode-map counters. */
9945 indec
.start
+= diff
;
9949 goto replay_sequence
;
9953 /* If KEY is not defined in any of the keymaps,
9954 and cannot be part of a function key or translation,
9955 and is an upper case letter
9956 use the corresponding lower-case letter instead. */
9957 if (first_binding
>= nmaps
9958 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9960 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9961 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9962 || (XINT (key
) & shift_modifier
)))
9964 Lisp_Object new_key
;
9966 original_uppercase
= key
;
9967 original_uppercase_position
= t
- 1;
9969 if (XINT (key
) & shift_modifier
)
9970 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9972 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9973 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9975 /* We have to do this unconditionally, regardless of whether
9976 the lower-case char is defined in the keymaps, because they
9977 might get translated through function-key-map. */
9978 keybuf
[t
- 1] = new_key
;
9979 mock_input
= max (t
, mock_input
);
9980 shift_translated
= 1;
9982 goto replay_sequence
;
9984 /* If KEY is not defined in any of the keymaps,
9985 and cannot be part of a function key or translation,
9986 and is a shifted function key,
9987 use the corresponding unshifted function key instead. */
9988 if (first_binding
>= nmaps
9989 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9991 Lisp_Object breakdown
= parse_modifiers (key
);
9993 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9995 if (modifiers
& shift_modifier
9996 /* Treat uppercase keys as shifted. */
9998 && (KEY_TO_CHAR (key
)
9999 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
10000 && uppercasep (KEY_TO_CHAR (key
))))
10002 Lisp_Object new_key
10003 = (modifiers
& shift_modifier
10004 ? apply_modifiers (modifiers
& ~shift_modifier
,
10006 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
10008 original_uppercase
= key
;
10009 original_uppercase_position
= t
- 1;
10011 /* We have to do this unconditionally, regardless of whether
10012 the lower-case char is defined in the keymaps, because they
10013 might get translated through function-key-map. */
10014 keybuf
[t
- 1] = new_key
;
10015 mock_input
= max (t
, mock_input
);
10016 /* Reset fkey (and consequently keytran) to apply
10017 function-key-map on the result, so that S-backspace is
10018 correctly mapped to DEL (via backspace). OTOH,
10019 input-decode-map doesn't need to go through it again. */
10020 fkey
.start
= fkey
.end
= 0;
10021 keytran
.start
= keytran
.end
= 0;
10022 shift_translated
= 1;
10024 goto replay_sequence
;
10029 read_key_sequence_cmd
= (first_binding
< nmaps
10030 ? defs
[first_binding
]
10032 read_key_sequence_remapped
10033 /* Remap command through active keymaps.
10034 Do the remapping here, before the unbind_to so it uses the keymaps
10035 of the appropriate buffer. */
10036 = SYMBOLP (read_key_sequence_cmd
)
10037 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
10040 unread_switch_frame
= delayed_switch_frame
;
10041 unbind_to (count
, Qnil
);
10043 /* Don't downcase the last character if the caller says don't.
10044 Don't downcase it if the result is undefined, either. */
10045 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10047 && t
- 1 == original_uppercase_position
)
10049 keybuf
[t
- 1] = original_uppercase
;
10050 shift_translated
= 0;
10053 if (shift_translated
)
10054 Vthis_command_keys_shift_translated
= Qt
;
10056 /* Occasionally we fabricate events, perhaps by expanding something
10057 according to function-key-map, or by adding a prefix symbol to a
10058 mouse click in the scroll bar or modeline. In this cases, return
10059 the entire generated key sequence, even if we hit an unbound
10060 prefix or a definition before the end. This means that you will
10061 be able to push back the event properly, and also means that
10062 read-key-sequence will always return a logical unit.
10065 for (; t
< mock_input
; t
++)
10067 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10068 && NILP (Fzerop (Vecho_keystrokes
)))
10069 echo_char (keybuf
[t
]);
10070 add_command_key (keybuf
[t
]);
10077 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10078 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10079 The sequence is sufficient to specify a non-prefix command in the
10080 current local and global maps.
10082 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10083 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10084 as a continuation of the previous key.
10086 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10087 convert the last event to lower case. (Normally any upper case event
10088 is converted to lower case if the original event is undefined and the lower
10089 case equivalent is defined.) A non-nil value is appropriate for reading
10090 a key sequence to be defined.
10092 A C-g typed while in this function is treated like any other character,
10093 and `quit-flag' is not set.
10095 If the key sequence starts with a mouse click, then the sequence is read
10096 using the keymaps of the buffer of the window clicked in, not the buffer
10097 of the selected window as normal.
10099 `read-key-sequence' drops unbound button-down events, since you normally
10100 only care about the click or drag events which follow them. If a drag
10101 or multi-click event is unbound, but the corresponding click event would
10102 be bound, `read-key-sequence' turns the event into a click event at the
10103 drag's starting position. This means that you don't have to distinguish
10104 between click and drag, double, or triple events unless you want to.
10106 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10107 lines separating windows, and scroll bars with imaginary keys
10108 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10110 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10111 function will process a switch-frame event if the user switches frames
10112 before typing anything. If the user switches frames in the middle of a
10113 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10114 is nil, then the event will be put off until after the current key sequence.
10116 `read-key-sequence' checks `function-key-map' for function key
10117 sequences, where they wouldn't conflict with ordinary bindings. See
10118 `function-key-map' for more details.
10120 The optional fifth argument CMD-LOOP, if non-nil, means
10121 that this key sequence is being read by something that will
10122 read commands one after another. It should be nil if the caller
10123 will read just one key sequence. */)
10124 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10126 Lisp_Object keybuf
[30];
10128 struct gcpro gcpro1
;
10129 ptrdiff_t count
= SPECPDL_INDEX ();
10131 if (!NILP (prompt
))
10132 CHECK_STRING (prompt
);
10135 specbind (Qinput_method_exit_on_first_char
,
10136 (NILP (cmd_loop
) ? Qt
: Qnil
));
10137 specbind (Qinput_method_use_echo_area
,
10138 (NILP (cmd_loop
) ? Qt
: Qnil
));
10140 memset (keybuf
, 0, sizeof keybuf
);
10141 GCPRO1 (keybuf
[0]);
10142 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10144 if (NILP (continue_echo
))
10146 this_command_key_count
= 0;
10147 this_command_key_count_reset
= 0;
10148 this_single_command_key_start
= 0;
10151 #ifdef HAVE_WINDOW_SYSTEM
10152 if (display_hourglass_p
)
10153 cancel_hourglass ();
10156 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10157 prompt
, ! NILP (dont_downcase_last
),
10158 ! NILP (can_return_switch_frame
), 0);
10160 #if 0 /* The following is fine for code reading a key sequence and
10161 then proceeding with a lengthy computation, but it's not good
10162 for code reading keys in a loop, like an input method. */
10163 #ifdef HAVE_WINDOW_SYSTEM
10164 if (display_hourglass_p
)
10165 start_hourglass ();
10175 return unbind_to (count
, make_event_array (i
, keybuf
));
10178 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10179 Sread_key_sequence_vector
, 1, 5, 0,
10180 doc
: /* Like `read-key-sequence' but always return a vector. */)
10181 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10183 Lisp_Object keybuf
[30];
10185 struct gcpro gcpro1
;
10186 ptrdiff_t count
= SPECPDL_INDEX ();
10188 if (!NILP (prompt
))
10189 CHECK_STRING (prompt
);
10192 specbind (Qinput_method_exit_on_first_char
,
10193 (NILP (cmd_loop
) ? Qt
: Qnil
));
10194 specbind (Qinput_method_use_echo_area
,
10195 (NILP (cmd_loop
) ? Qt
: Qnil
));
10197 memset (keybuf
, 0, sizeof keybuf
);
10198 GCPRO1 (keybuf
[0]);
10199 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10201 if (NILP (continue_echo
))
10203 this_command_key_count
= 0;
10204 this_command_key_count_reset
= 0;
10205 this_single_command_key_start
= 0;
10208 #ifdef HAVE_WINDOW_SYSTEM
10209 if (display_hourglass_p
)
10210 cancel_hourglass ();
10213 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10214 prompt
, ! NILP (dont_downcase_last
),
10215 ! NILP (can_return_switch_frame
), 0);
10217 #ifdef HAVE_WINDOW_SYSTEM
10218 if (display_hourglass_p
)
10219 start_hourglass ();
10228 return unbind_to (count
, Fvector (i
, keybuf
));
10231 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10232 doc
: /* Execute CMD as an editor command.
10233 CMD must be a symbol that satisfies the `commandp' predicate.
10234 Optional second arg RECORD-FLAG non-nil
10235 means unconditionally put this command in `command-history'.
10236 Otherwise, that is done only if an arg is read using the minibuffer.
10237 The argument KEYS specifies the value to use instead of (this-command-keys)
10238 when reading the arguments; if it is nil, (this-command-keys) is used.
10239 The argument SPECIAL, if non-nil, means that this command is executing
10240 a special event, so ignore the prefix argument and don't clear it. */)
10241 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10243 register Lisp_Object final
;
10244 register Lisp_Object tem
;
10245 Lisp_Object prefixarg
;
10247 debug_on_next_call
= 0;
10249 if (NILP (special
))
10251 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10252 Vcurrent_prefix_arg
= prefixarg
;
10253 KVAR (current_kboard
, Vprefix_arg
) = Qnil
;
10260 tem
= Fget (cmd
, Qdisabled
);
10263 tem
= Fsymbol_value (Qdisabled_command_function
);
10265 return Frun_hooks (1, &Qdisabled_command_function
);
10271 final
= Findirect_function (cmd
, Qnil
);
10273 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10275 struct gcpro gcpro1
, gcpro2
;
10277 GCPRO2 (cmd
, prefixarg
);
10278 Fautoload_do_load (final
, cmd
, Qnil
);
10285 if (STRINGP (final
) || VECTORP (final
))
10287 /* If requested, place the macro in the command history. For
10288 other sorts of commands, call-interactively takes care of
10290 if (!NILP (record_flag
))
10293 = Fcons (Fcons (Qexecute_kbd_macro
,
10294 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10297 /* Don't keep command history around forever. */
10298 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10300 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10302 XSETCDR (tem
, Qnil
);
10306 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10309 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10310 /* Don't call Fcall_interactively directly because we want to make
10311 sure the backtrace has an entry for `call-interactively'.
10312 For the same reason, pass `cmd' rather than `final'. */
10313 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10320 /* Return nonzero if input events are pending. */
10323 detect_input_pending (void)
10325 if (!input_pending
)
10326 get_input_pending (&input_pending
, 0);
10328 return input_pending
;
10331 /* Return nonzero if input events other than mouse movements are
10335 detect_input_pending_ignore_squeezables (void)
10337 if (!input_pending
)
10338 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10340 return input_pending
;
10343 /* Return nonzero if input events are pending, and run any pending timers. */
10346 detect_input_pending_run_timers (int do_display
)
10348 int old_timers_run
= timers_run
;
10350 if (!input_pending
)
10351 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10353 if (old_timers_run
!= timers_run
&& do_display
)
10355 redisplay_preserve_echo_area (8);
10356 /* The following fixes a bug when using lazy-lock with
10357 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10358 from an idle timer function. The symptom of the bug is that
10359 the cursor sometimes doesn't become visible until the next X
10360 event is processed. --gerd. */
10362 Lisp_Object tail
, frame
;
10363 FOR_EACH_FRAME (tail
, frame
)
10364 if (FRAME_RIF (XFRAME (frame
)))
10365 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10369 return input_pending
;
10372 /* This is called in some cases before a possible quit.
10373 It cases the next call to detect_input_pending to recompute input_pending.
10374 So calling this function unnecessarily can't do any harm. */
10377 clear_input_pending (void)
10382 /* Return nonzero if there are pending requeued events.
10383 This isn't used yet. The hope is to make wait_reading_process_output
10384 call it, and return if it runs Lisp code that unreads something.
10385 The problem is, kbd_buffer_get_event needs to be fixed to know what
10386 to do in that case. It isn't trivial. */
10389 requeued_events_pending_p (void)
10391 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10395 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10396 doc
: /* Return t if command input is currently available with no wait.
10397 Actually, the value is nil only if we can be sure that no input is available;
10398 if there is a doubt, the value is t. */)
10401 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10402 || !NILP (Vunread_post_input_method_events
)
10403 || !NILP (Vunread_input_method_events
))
10406 /* Process non-user-visible events (Bug#10195). */
10407 process_special_events ();
10409 get_input_pending (&input_pending
,
10410 READABLE_EVENTS_DO_TIMERS_NOW
10411 | READABLE_EVENTS_FILTER_EVENTS
);
10412 return input_pending
> 0 ? Qt
: Qnil
;
10415 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10416 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10419 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10422 if (total_keys
< NUM_RECENT_KEYS
)
10423 return Fvector (total_keys
, keys
);
10426 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10427 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10428 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10429 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10430 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10435 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10436 doc
: /* Return the key sequence that invoked this command.
10437 However, if the command has called `read-key-sequence', it returns
10438 the last key sequence that has been read.
10439 The value is a string or a vector.
10441 See also `this-command-keys-vector'. */)
10444 return make_event_array (this_command_key_count
,
10445 XVECTOR (this_command_keys
)->contents
);
10448 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10449 doc
: /* Return the key sequence that invoked this command, as a vector.
10450 However, if the command has called `read-key-sequence', it returns
10451 the last key sequence that has been read.
10453 See also `this-command-keys'. */)
10456 return Fvector (this_command_key_count
,
10457 XVECTOR (this_command_keys
)->contents
);
10460 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10461 Sthis_single_command_keys
, 0, 0, 0,
10462 doc
: /* Return the key sequence that invoked this command.
10463 More generally, it returns the last key sequence read, either by
10464 the command loop or by `read-key-sequence'.
10465 Unlike `this-command-keys', this function's value
10466 does not include prefix arguments.
10467 The value is always a vector. */)
10470 return Fvector (this_command_key_count
10471 - this_single_command_key_start
,
10472 (XVECTOR (this_command_keys
)->contents
10473 + this_single_command_key_start
));
10476 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10477 Sthis_single_command_raw_keys
, 0, 0, 0,
10478 doc
: /* Return the raw events that were read for this command.
10479 More generally, it returns the last key sequence read, either by
10480 the command loop or by `read-key-sequence'.
10481 Unlike `this-single-command-keys', this function's value
10482 shows the events before all translations (except for input methods).
10483 The value is always a vector. */)
10486 return Fvector (raw_keybuf_count
,
10487 (XVECTOR (raw_keybuf
)->contents
));
10490 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10491 Sreset_this_command_lengths
, 0, 0, 0,
10492 doc
: /* Make the unread events replace the last command and echo.
10493 Used in `universal-argument-other-key'.
10495 `universal-argument-other-key' rereads the event just typed.
10496 It then gets translated through `function-key-map'.
10497 The translated event has to replace the real events,
10498 both in the value of (this-command-keys) and in echoing.
10499 To achieve this, `universal-argument-other-key' calls
10500 `reset-this-command-lengths', which discards the record of reading
10501 these events the first time. */)
10504 this_command_key_count
= before_command_key_count
;
10505 if (this_command_key_count
< this_single_command_key_start
)
10506 this_single_command_key_start
= this_command_key_count
;
10508 echo_truncate (before_command_echo_length
);
10510 /* Cause whatever we put into unread-command-events
10511 to echo as if it were being freshly read from the keyboard. */
10512 this_command_key_count_reset
= 1;
10517 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10518 Sclear_this_command_keys
, 0, 1, 0,
10519 doc
: /* Clear out the vector that `this-command-keys' returns.
10520 Also clear the record of the last 100 events, unless optional arg
10521 KEEP-RECORD is non-nil. */)
10522 (Lisp_Object keep_record
)
10526 this_command_key_count
= 0;
10527 this_command_key_count_reset
= 0;
10529 if (NILP (keep_record
))
10531 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10532 ASET (recent_keys
, i
, Qnil
);
10534 recent_keys_index
= 0;
10539 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10540 doc
: /* Return the current depth in recursive edits. */)
10544 /* Wrap around reliably on integer overflow. */
10545 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10546 XSETINT (temp
, sum
);
10550 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10551 "FOpen dribble file: ",
10552 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10553 If FILE is nil, close any open dribble file.
10554 The file will be closed when Emacs exits. */)
10566 file
= Fexpand_file_name (file
, Qnil
);
10567 dribble
= fopen (SSDATA (file
), "w");
10569 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10574 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10575 doc
: /* Discard the contents of the terminal input buffer.
10576 Also end any kbd macro being defined. */)
10579 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10581 /* Discard the last command from the macro. */
10582 Fcancel_kbd_macro_events ();
10586 update_mode_lines
++;
10588 Vunread_command_events
= Qnil
;
10589 unread_command_char
= -1;
10591 discard_tty_input ();
10593 kbd_fetch_ptr
= kbd_store_ptr
;
10599 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10600 doc
: /* Stop Emacs and return to superior process. You can resume later.
10601 If `cannot-suspend' is non-nil, or if the system doesn't support job
10602 control, run a subshell instead.
10604 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10605 to be read as terminal input by Emacs's parent, after suspension.
10607 Before suspending, run the normal hook `suspend-hook'.
10608 After resumption run the normal hook `suspend-resume-hook'.
10610 Some operating systems cannot stop the Emacs process and resume it later.
10611 On such systems, Emacs starts a subshell instead of suspending. */)
10612 (Lisp_Object stuffstring
)
10614 ptrdiff_t count
= SPECPDL_INDEX ();
10615 int old_height
, old_width
;
10617 struct gcpro gcpro1
;
10620 if (tty_list
&& tty_list
->next
)
10621 error ("There are other tty frames open; close them before suspending Emacs");
10623 if (!NILP (stuffstring
))
10624 CHECK_STRING (stuffstring
);
10626 /* Run the functions in suspend-hook. */
10627 hook
= intern ("suspend-hook");
10628 Frun_hooks (1, &hook
);
10630 GCPRO1 (stuffstring
);
10631 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10632 reset_all_sys_modes ();
10633 /* sys_suspend can get an error if it tries to fork a subshell
10634 and the system resources aren't available for that. */
10635 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10637 stuff_buffered_input (stuffstring
);
10638 if (cannot_suspend
)
10642 unbind_to (count
, Qnil
);
10644 /* Check if terminal/window size has changed.
10645 Note that this is not useful when we are running directly
10646 with a window system; but suspend should be disabled in that case. */
10647 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10648 if (width
!= old_width
|| height
!= old_height
)
10649 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10651 /* Run suspend-resume-hook. */
10652 hook
= intern ("suspend-resume-hook");
10653 Frun_hooks (1, &hook
);
10659 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10660 Then in any case stuff anything Emacs has read ahead and not used. */
10663 stuff_buffered_input (Lisp_Object stuffstring
)
10665 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10666 register unsigned char *p
;
10668 if (STRINGP (stuffstring
))
10670 register ptrdiff_t count
;
10672 p
= SDATA (stuffstring
);
10673 count
= SBYTES (stuffstring
);
10674 while (count
-- > 0)
10679 /* Anything we have read ahead, put back for the shell to read. */
10680 /* ?? What should this do when we have multiple keyboards??
10681 Should we ignore anything that was typed in at the "wrong" kboard?
10683 rms: we should stuff everything back into the kboard
10685 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10688 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10689 kbd_fetch_ptr
= kbd_buffer
;
10690 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10691 stuff_char (kbd_fetch_ptr
->code
);
10693 clear_event (kbd_fetch_ptr
);
10697 #endif /* SIGTSTP */
10701 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10703 input_available_clear_time
= time_to_clear
;
10705 /* Tell handle_interrupt to throw back to read_char, */
10706 waiting_for_input
= 1;
10708 /* If handle_interrupt was called before and buffered a C-g,
10709 make it run again now, to avoid timing error. */
10710 if (!NILP (Vquit_flag
))
10711 quit_throw_to_read_char (0);
10715 clear_waiting_for_input (void)
10717 /* Tell handle_interrupt not to throw back to read_char, */
10718 waiting_for_input
= 0;
10719 input_available_clear_time
= 0;
10722 /* The SIGINT handler.
10724 If we have a frame on the controlling tty, we assume that the
10725 SIGINT was generated by C-g, so we call handle_interrupt.
10726 Otherwise, tell QUIT to kill Emacs. */
10729 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10730 /* compilers complain in signal calls. */
10732 /* Must preserve main program's value of errno. */
10733 int old_errno
= errno
;
10734 struct terminal
*terminal
;
10736 SIGNAL_THREAD_CHECK (signalnum
);
10738 /* See if we have an active terminal on our controlling tty. */
10739 terminal
= get_named_tty ("/dev/tty");
10742 /* If there are no frames there, let's pretend that we are a
10743 well-behaving UN*X program and quit. We must not call Lisp
10744 in a signal handler, so tell QUIT to exit when it is
10746 Vquit_flag
= Qkill_emacs
;
10750 /* Otherwise, the SIGINT was probably generated by C-g. */
10752 /* Set internal_last_event_frame to the top frame of the
10753 controlling tty, if we have a frame there. We disable the
10754 interrupt key on secondary ttys, so the SIGINT must have come
10755 from the controlling tty. */
10756 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10758 handle_interrupt ();
10764 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10765 of the number of times C-g has been requested. If C-g is pressed
10766 enough times, then quit anyway. See bug#6585. */
10767 static int force_quit_count
;
10769 /* This routine is called at interrupt level in response to C-g.
10771 It is called from the SIGINT handler or kbd_buffer_store_event.
10773 If `waiting_for_input' is non zero, then unless `echoing' is
10774 nonzero, immediately throw back to read_char.
10776 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10777 eval to throw, when it gets a chance. If quit-flag is already
10778 non-nil, it stops the job right away. */
10781 handle_interrupt (void)
10787 /* XXX This code needs to be revised for multi-tty support. */
10788 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10790 /* If SIGINT isn't blocked, don't let us be interrupted by
10791 another SIGINT, it might be harmful due to non-reentrancy
10792 in I/O functions. */
10793 sigblock (sigmask (SIGINT
));
10796 reset_all_sys_modes ();
10798 #ifdef SIGTSTP /* Support possible in later USG versions */
10800 * On systems which can suspend the current process and return to the original
10801 * shell, this command causes the user to end up back at the shell.
10802 * The "Auto-save" and "Abort" questions are not asked until
10803 * the user elects to return to emacs, at which point he can save the current
10804 * job and either dump core or continue.
10808 /* Perhaps should really fork an inferior shell?
10809 But that would not provide any way to get back
10810 to the original shell, ever. */
10811 printf ("No support for stopping a process on this operating system;\n");
10812 printf ("you can continue or abort.\n");
10813 #endif /* not SIGTSTP */
10815 /* We must remain inside the screen area when the internal terminal
10816 is used. Note that [Enter] is not echoed by dos. */
10817 cursor_to (SELECTED_FRAME (), 0, 0);
10819 /* It doesn't work to autosave while GC is in progress;
10820 the code used for auto-saving doesn't cope with the mark bit. */
10821 if (!gc_in_progress
)
10823 printf ("Auto-save? (y or n) ");
10825 if (((c
= getchar ()) & ~040) == 'Y')
10827 Fdo_auto_save (Qt
, Qnil
);
10829 printf ("\r\nAuto-save done");
10830 #else /* not MSDOS */
10831 printf ("Auto-save done\n");
10832 #endif /* not MSDOS */
10834 while (c
!= '\n') c
= getchar ();
10838 /* During GC, it must be safe to reenable quitting again. */
10839 Vinhibit_quit
= Qnil
;
10842 #endif /* not MSDOS */
10843 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10844 printf ("but will instead do a real quit after garbage collection ends\r\n");
10849 printf ("\r\nAbort? (y or n) ");
10850 #else /* not MSDOS */
10851 printf ("Abort (and dump core)? (y or n) ");
10852 #endif /* not MSDOS */
10854 if (((c
= getchar ()) & ~040) == 'Y')
10856 while (c
!= '\n') c
= getchar ();
10858 printf ("\r\nContinuing...\r\n");
10859 #else /* not MSDOS */
10860 printf ("Continuing...\n");
10861 #endif /* not MSDOS */
10863 init_all_sys_modes ();
10868 /* If executing a function that wants to be interrupted out of
10869 and the user has not deferred quitting by binding `inhibit-quit'
10870 then quit right away. */
10871 if (immediate_quit
&& NILP (Vinhibit_quit
))
10873 struct gl_state_s saved
;
10874 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10876 immediate_quit
= 0;
10879 GCPRO4 (saved
.object
, saved
.global_code
,
10880 saved
.current_syntax_table
, saved
.old_prop
);
10881 Fsignal (Qquit
, Qnil
);
10882 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10887 { /* Else request quit when it's safe. */
10888 if (NILP (Vquit_flag
))
10889 force_quit_count
= 0;
10890 if (++force_quit_count
== 3)
10892 immediate_quit
= 1;
10893 Vinhibit_quit
= Qnil
;
10899 /* TODO: The longjmp in this call throws the NS event loop integration off,
10900 and it seems to do fine without this. Probably some attention
10901 needs to be paid to the setting of waiting_for_input in
10902 wait_reading_process_output() under HAVE_NS because of the call
10903 to ns_select there (needed because otherwise events aren't picked up
10904 outside of polling since we don't get SIGIO like X and we don't have a
10905 separate event loop thread like W32. */
10907 if (waiting_for_input
&& !echoing
)
10908 quit_throw_to_read_char (1);
10912 /* Handle a C-g by making read_char return C-g. */
10915 quit_throw_to_read_char (int from_signal
)
10917 /* When not called from a signal handler it is safe to call
10919 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10920 Fkill_emacs (Qnil
);
10923 /* Prevent another signal from doing this before we finish. */
10924 clear_waiting_for_input ();
10927 Vunread_command_events
= Qnil
;
10928 unread_command_char
= -1;
10930 #if 0 /* Currently, sit_for is called from read_char without turning
10931 off polling. And that can call set_waiting_for_input.
10932 It seems to be harmless. */
10933 #ifdef POLL_FOR_INPUT
10934 /* May be > 1 if in recursive minibuffer. */
10935 if (poll_suppress_count
== 0)
10939 if (FRAMEP (internal_last_event_frame
)
10940 && !EQ (internal_last_event_frame
, selected_frame
))
10941 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10944 _longjmp (getcjmp
, 1);
10947 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10948 Sset_input_interrupt_mode
, 1, 1, 0,
10949 doc
: /* Set interrupt mode of reading keyboard input.
10950 If INTERRUPT is non-nil, Emacs will use input interrupts;
10951 otherwise Emacs uses CBREAK mode.
10953 See also `current-input-mode'. */)
10954 (Lisp_Object interrupt
)
10956 int new_interrupt_input
;
10958 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10959 #ifdef HAVE_X_WINDOWS
10960 if (x_display_list
!= NULL
)
10962 /* When using X, don't give the user a real choice,
10963 because we haven't implemented the mechanisms to support it. */
10964 new_interrupt_input
= 1;
10967 #endif /* HAVE_X_WINDOWS */
10968 new_interrupt_input
= !NILP (interrupt
);
10969 #else /* not SIGIO */
10970 new_interrupt_input
= 0;
10971 #endif /* not SIGIO */
10973 if (new_interrupt_input
!= interrupt_input
)
10975 #ifdef POLL_FOR_INPUT
10979 /* this causes startup screen to be restored and messes with the mouse */
10980 reset_all_sys_modes ();
10981 interrupt_input
= new_interrupt_input
;
10982 init_all_sys_modes ();
10984 interrupt_input
= new_interrupt_input
;
10987 #ifdef POLL_FOR_INPUT
10988 poll_suppress_count
= 1;
10995 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10996 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10997 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10998 C-q in key sequences.
11000 This setting only has an effect on tty terminals and only when
11001 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11003 See also `current-input-mode'. */)
11004 (Lisp_Object flow
, Lisp_Object terminal
)
11006 struct terminal
*t
= get_terminal (terminal
, 1);
11007 struct tty_display_info
*tty
;
11008 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11010 tty
= t
->display_info
.tty
;
11012 if (tty
->flow_control
!= !NILP (flow
))
11015 /* this causes startup screen to be restored and messes with the mouse */
11016 reset_sys_modes (tty
);
11019 tty
->flow_control
= !NILP (flow
);
11022 init_sys_modes (tty
);
11028 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11029 doc
: /* Enable or disable 8-bit input on TERMINAL.
11030 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11031 bit as the Meta modifier.
11033 If META is nil, Emacs will ignore the top bit, on the assumption it is
11036 Otherwise, Emacs will accept and pass through 8-bit input without
11037 specially interpreting the top bit.
11039 This setting only has an effect on tty terminal devices.
11041 Optional parameter TERMINAL specifies the tty terminal device to use.
11042 It may be a terminal object, a frame, or nil for the terminal used by
11043 the currently selected frame.
11045 See also `current-input-mode'. */)
11046 (Lisp_Object meta
, Lisp_Object terminal
)
11048 struct terminal
*t
= get_terminal (terminal
, 1);
11049 struct tty_display_info
*tty
;
11052 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11054 tty
= t
->display_info
.tty
;
11058 else if (EQ (meta
, Qt
))
11063 if (tty
->meta_key
!= new_meta
)
11066 /* this causes startup screen to be restored and messes with the mouse */
11067 reset_sys_modes (tty
);
11070 tty
->meta_key
= new_meta
;
11073 init_sys_modes (tty
);
11079 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11080 doc
: /* Specify character used for quitting.
11081 QUIT must be an ASCII character.
11083 This function only has an effect on the controlling tty of the Emacs
11086 See also `current-input-mode'. */)
11089 struct terminal
*t
= get_named_tty ("/dev/tty");
11090 struct tty_display_info
*tty
;
11091 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11093 tty
= t
->display_info
.tty
;
11095 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11096 error ("QUIT must be an ASCII character");
11099 /* this causes startup screen to be restored and messes with the mouse */
11100 reset_sys_modes (tty
);
11103 /* Don't let this value be out of range. */
11104 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11107 init_sys_modes (tty
);
11113 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11114 doc
: /* Set mode of reading keyboard input.
11115 First arg INTERRUPT non-nil means use input interrupts;
11116 nil means use CBREAK mode.
11117 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11118 (no effect except in CBREAK mode).
11119 Third arg META t means accept 8-bit input (for a Meta key).
11120 META nil means ignore the top bit, on the assumption it is parity.
11121 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11122 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11123 See also `current-input-mode'. */)
11124 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11126 Fset_input_interrupt_mode (interrupt
);
11127 Fset_output_flow_control (flow
, Qnil
);
11128 Fset_input_meta_mode (meta
, Qnil
);
11130 Fset_quit_char (quit
);
11134 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11135 doc
: /* Return information about the way Emacs currently reads keyboard input.
11136 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11137 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11138 nil, Emacs is using CBREAK mode.
11139 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11140 terminal; this does not apply if Emacs uses interrupt-driven input.
11141 META is t if accepting 8-bit input with 8th bit as Meta flag.
11142 META nil means ignoring the top bit, on the assumption it is parity.
11143 META is neither t nor nil if accepting 8-bit input and using
11144 all 8 bits as the character code.
11145 QUIT is the character Emacs currently uses to quit.
11146 The elements of this list correspond to the arguments of
11147 `set-input-mode'. */)
11150 Lisp_Object val
[4];
11151 struct frame
*sf
= XFRAME (selected_frame
);
11153 val
[0] = interrupt_input
? Qt
: Qnil
;
11154 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11156 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11157 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11159 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11166 XSETFASTINT (val
[3], quit_char
);
11168 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11171 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11172 doc
: /* Return position information for pixel coordinates X and Y.
11173 By default, X and Y are relative to text area of the selected window.
11174 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11175 If optional fourth arg WHOLE is non-nil, X is relative to the left
11176 edge of the window.
11178 The return value is similar to a mouse click position:
11179 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11180 IMAGE (DX . DY) (WIDTH . HEIGHT))
11181 The `posn-' functions access elements of such lists. */)
11182 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11187 if (NILP (frame_or_window
))
11188 frame_or_window
= selected_window
;
11190 if (WINDOWP (frame_or_window
))
11194 CHECK_LIVE_WINDOW (frame_or_window
);
11196 w
= XWINDOW (frame_or_window
);
11197 XSETINT (x
, (XINT (x
)
11198 + WINDOW_LEFT_EDGE_X (w
)
11200 ? window_box_left_offset (w
, TEXT_AREA
)
11202 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11203 frame_or_window
= WVAR (w
, frame
);
11206 CHECK_LIVE_FRAME (frame_or_window
);
11208 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11211 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11212 doc
: /* Return position information for buffer POS in WINDOW.
11213 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11215 Return nil if position is not visible in window. Otherwise,
11216 the return value is similar to that returned by `event-start' for
11217 a mouse click at the upper left corner of the glyph corresponding
11218 to the given buffer position:
11219 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11220 IMAGE (DX . DY) (WIDTH . HEIGHT))
11221 The `posn-' functions access elements of such lists. */)
11222 (Lisp_Object pos
, Lisp_Object window
)
11227 window
= selected_window
;
11229 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11232 Lisp_Object x
= XCAR (tem
);
11233 Lisp_Object y
= XCAR (XCDR (tem
));
11235 /* Point invisible due to hscrolling? */
11238 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11246 * Set up a new kboard object with reasonable initial values.
11249 init_kboard (KBOARD
*kb
)
11251 KVAR (kb
, Voverriding_terminal_local_map
) = Qnil
;
11252 KVAR (kb
, Vlast_command
) = Qnil
;
11253 KVAR (kb
, Vreal_last_command
) = Qnil
;
11254 KVAR (kb
, Vkeyboard_translate_table
) = Qnil
;
11255 KVAR (kb
, Vlast_repeatable_command
) = Qnil
;
11256 KVAR (kb
, Vprefix_arg
) = Qnil
;
11257 KVAR (kb
, Vlast_prefix_arg
) = Qnil
;
11258 KVAR (kb
, kbd_queue
) = Qnil
;
11259 kb
->kbd_queue_has_data
= 0;
11260 kb
->immediate_echo
= 0;
11261 KVAR (kb
, echo_string
) = Qnil
;
11262 kb
->echo_after_prompt
= -1;
11263 kb
->kbd_macro_buffer
= 0;
11264 kb
->kbd_macro_bufsize
= 0;
11265 KVAR (kb
, defining_kbd_macro
) = Qnil
;
11266 KVAR (kb
, Vlast_kbd_macro
) = Qnil
;
11267 kb
->reference_count
= 0;
11268 KVAR (kb
, Vsystem_key_alist
) = Qnil
;
11269 KVAR (kb
, system_key_syms
) = Qnil
;
11270 KVAR (kb
, Vwindow_system
) = Qt
; /* Unset. */
11271 KVAR (kb
, Vinput_decode_map
) = Fmake_sparse_keymap (Qnil
);
11272 KVAR (kb
, Vlocal_function_key_map
) = Fmake_sparse_keymap (Qnil
);
11273 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11274 KVAR (kb
, Vdefault_minibuffer_frame
) = Qnil
;
11278 * Destroy the contents of a kboard object, but not the object itself.
11279 * We use this just before deleting it, or if we're going to initialize
11280 * it a second time.
11283 wipe_kboard (KBOARD
*kb
)
11285 xfree (kb
->kbd_macro_buffer
);
11288 /* Free KB and memory referenced from it. */
11291 delete_kboard (KBOARD
*kb
)
11295 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11298 *kbp
= kb
->next_kboard
;
11300 /* Prevent a dangling reference to KB. */
11301 if (kb
== current_kboard
11302 && FRAMEP (selected_frame
)
11303 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11305 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11307 if (current_kboard
== kb
)
11316 init_keyboard (void)
11318 /* This is correct before outermost invocation of the editor loop */
11319 command_loop_level
= -1;
11320 immediate_quit
= 0;
11321 quit_char
= Ctl ('g');
11322 Vunread_command_events
= Qnil
;
11323 unread_command_char
= -1;
11324 timer_idleness_start_time
= invalid_emacs_time ();
11326 recent_keys_index
= 0;
11327 kbd_fetch_ptr
= kbd_buffer
;
11328 kbd_store_ptr
= kbd_buffer
;
11329 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11330 do_mouse_tracking
= Qnil
;
11333 interrupt_input_blocked
= 0;
11334 interrupt_input_pending
= 0;
11336 pending_signals
= 0;
11339 /* This means that command_loop_1 won't try to select anything the first
11341 internal_last_event_frame
= Qnil
;
11342 Vlast_event_frame
= internal_last_event_frame
;
11344 current_kboard
= initial_kboard
;
11345 /* Re-initialize the keyboard again. */
11346 wipe_kboard (current_kboard
);
11347 init_kboard (current_kboard
);
11348 /* A value of nil for Vwindow_system normally means a tty, but we also use
11349 it for the initial terminal since there is no window system there. */
11350 KVAR (current_kboard
, Vwindow_system
) = Qnil
;
11352 if (!noninteractive
)
11354 /* Before multi-tty support, these handlers used to be installed
11355 only if the current session was a tty session. Now an Emacs
11356 session may have multiple display types, so we always handle
11357 SIGINT. There is special code in interrupt_signal to exit
11358 Emacs on SIGINT when there are no termcap frames on the
11359 controlling terminal. */
11360 signal (SIGINT
, interrupt_signal
);
11362 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11363 SIGQUIT and we can't tell which one it will give us. */
11364 signal (SIGQUIT
, interrupt_signal
);
11365 #endif /* not DOS_NT */
11367 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11369 if (!noninteractive
)
11370 signal (SIGIO
, input_available_signal
);
11373 /* Use interrupt input by default, if it works and noninterrupt input
11374 has deficiencies. */
11376 #ifdef INTERRUPT_INPUT
11377 interrupt_input
= 1;
11379 interrupt_input
= 0;
11385 if (keyboard_init_hook
)
11386 (*keyboard_init_hook
) ();
11388 #ifdef POLL_FOR_INPUT
11390 poll_suppress_count
= 1;
11395 /* This type's only use is in syms_of_keyboard, to initialize the
11396 event header symbols and put properties on them. */
11397 struct event_head
{
11403 static const struct event_head head_table
[] = {
11404 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11405 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11406 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11407 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11408 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11409 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11410 /* `select-window' should be handled just like `switch-frame'
11411 in read_key_sequence. */
11412 {&Qselect_window
, "select-window", &Qswitch_frame
}
11416 syms_of_keyboard (void)
11418 pending_funcalls
= Qnil
;
11419 staticpro (&pending_funcalls
);
11421 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11422 staticpro (&Vlispy_mouse_stem
);
11425 DEFSYM (QCimage
, ":image");
11426 DEFSYM (Qhelp_echo
, "help-echo");
11427 DEFSYM (QCrtl
, ":rtl");
11429 staticpro (&item_properties
);
11430 item_properties
= Qnil
;
11432 staticpro (&tool_bar_item_properties
);
11433 tool_bar_item_properties
= Qnil
;
11434 staticpro (&tool_bar_items_vector
);
11435 tool_bar_items_vector
= Qnil
;
11437 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11438 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11439 DEFSYM (Qself_insert_command
, "self-insert-command");
11440 DEFSYM (Qforward_char
, "forward-char");
11441 DEFSYM (Qbackward_char
, "backward-char");
11442 DEFSYM (Qdisabled
, "disabled");
11443 DEFSYM (Qundefined
, "undefined");
11444 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11445 DEFSYM (Qpost_command_hook
, "post-command-hook");
11446 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11447 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11448 DEFSYM (Qfunction_key
, "function-key");
11449 DEFSYM (Qmouse_click
, "mouse-click");
11450 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11451 DEFSYM (Qsave_session
, "save-session");
11452 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11453 DEFSYM (Qmenu_enable
, "menu-enable");
11455 #if defined (WINDOWSNT)
11456 DEFSYM (Qlanguage_change
, "language-change");
11460 DEFSYM (Qdbus_event
, "dbus-event");
11463 DEFSYM (QCenable
, ":enable");
11464 DEFSYM (QCvisible
, ":visible");
11465 DEFSYM (QChelp
, ":help");
11466 DEFSYM (QCfilter
, ":filter");
11467 DEFSYM (QCbutton
, ":button");
11468 DEFSYM (QCkeys
, ":keys");
11469 DEFSYM (QCkey_sequence
, ":key-sequence");
11470 DEFSYM (QCtoggle
, ":toggle");
11471 DEFSYM (QCradio
, ":radio");
11472 DEFSYM (QClabel
, ":label");
11473 DEFSYM (QCvert_only
, ":vert-only");
11475 DEFSYM (Qmode_line
, "mode-line");
11476 DEFSYM (Qvertical_line
, "vertical-line");
11477 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11478 DEFSYM (Qmenu_bar
, "menu-bar");
11480 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11481 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11484 DEFSYM (Qabove_handle
, "above-handle");
11485 DEFSYM (Qhandle
, "handle");
11486 DEFSYM (Qbelow_handle
, "below-handle");
11487 DEFSYM (Qup
, "up");
11488 DEFSYM (Qdown
, "down");
11489 DEFSYM (Qtop
, "top");
11490 DEFSYM (Qbottom
, "bottom");
11491 DEFSYM (Qend_scroll
, "end-scroll");
11492 DEFSYM (Qratio
, "ratio");
11494 DEFSYM (Qevent_kind
, "event-kind");
11495 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11496 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11497 DEFSYM (Qmodifier_cache
, "modifier-cache");
11499 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11500 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11502 DEFSYM (Qpolling_period
, "polling-period");
11504 DEFSYM (Qx_set_selection
, "x-set-selection");
11505 DEFSYM (QPRIMARY
, "PRIMARY");
11506 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11507 DEFSYM (Qhandle_select_window
, "handle-select-window");
11509 DEFSYM (Qinput_method_function
, "input-method-function");
11510 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11511 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11513 DEFSYM (Qhelp_form_show
, "help-form-show");
11515 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11516 Fset (Qinput_method_use_echo_area
, Qnil
);
11518 last_point_position_buffer
= Qnil
;
11519 last_point_position_window
= Qnil
;
11523 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11525 for (i
= 0; i
< len
; i
++)
11527 const struct event_head
*p
= &head_table
[i
];
11528 *p
->var
= intern_c_string (p
->name
);
11529 staticpro (p
->var
);
11530 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11531 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11535 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11536 staticpro (&button_down_location
);
11537 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11538 staticpro (&mouse_syms
);
11539 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11540 / sizeof (lispy_wheel_names
[0])),
11542 staticpro (&wheel_syms
);
11546 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11548 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11549 for (i
= 0; i
< len
; i
++)
11550 if (modifier_names
[i
])
11551 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11552 staticpro (&modifier_symbols
);
11555 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11556 staticpro (&recent_keys
);
11558 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11559 staticpro (&this_command_keys
);
11561 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11562 staticpro (&raw_keybuf
);
11564 DEFSYM (Qextended_command_history
, "extended-command-history");
11565 Fset (Qextended_command_history
, Qnil
);
11567 accent_key_syms
= Qnil
;
11568 staticpro (&accent_key_syms
);
11570 func_key_syms
= Qnil
;
11571 staticpro (&func_key_syms
);
11573 drag_n_drop_syms
= Qnil
;
11574 staticpro (&drag_n_drop_syms
);
11576 unread_switch_frame
= Qnil
;
11577 staticpro (&unread_switch_frame
);
11579 internal_last_event_frame
= Qnil
;
11580 staticpro (&internal_last_event_frame
);
11582 read_key_sequence_cmd
= Qnil
;
11583 staticpro (&read_key_sequence_cmd
);
11584 read_key_sequence_remapped
= Qnil
;
11585 staticpro (&read_key_sequence_remapped
);
11587 menu_bar_one_keymap_changed_items
= Qnil
;
11588 staticpro (&menu_bar_one_keymap_changed_items
);
11590 menu_bar_items_vector
= Qnil
;
11591 staticpro (&menu_bar_items_vector
);
11593 help_form_saved_window_configs
= Qnil
;
11594 staticpro (&help_form_saved_window_configs
);
11596 defsubr (&Scurrent_idle_time
);
11597 defsubr (&Sevent_symbol_parse_modifiers
);
11598 defsubr (&Sevent_convert_list
);
11599 defsubr (&Sread_key_sequence
);
11600 defsubr (&Sread_key_sequence_vector
);
11601 defsubr (&Srecursive_edit
);
11602 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11603 defsubr (&Strack_mouse
);
11605 defsubr (&Sinput_pending_p
);
11606 defsubr (&Scommand_execute
);
11607 defsubr (&Srecent_keys
);
11608 defsubr (&Sthis_command_keys
);
11609 defsubr (&Sthis_command_keys_vector
);
11610 defsubr (&Sthis_single_command_keys
);
11611 defsubr (&Sthis_single_command_raw_keys
);
11612 defsubr (&Sreset_this_command_lengths
);
11613 defsubr (&Sclear_this_command_keys
);
11614 defsubr (&Ssuspend_emacs
);
11615 defsubr (&Sabort_recursive_edit
);
11616 defsubr (&Sexit_recursive_edit
);
11617 defsubr (&Srecursion_depth
);
11618 defsubr (&Stop_level
);
11619 defsubr (&Sdiscard_input
);
11620 defsubr (&Sopen_dribble_file
);
11621 defsubr (&Sset_input_interrupt_mode
);
11622 defsubr (&Sset_output_flow_control
);
11623 defsubr (&Sset_input_meta_mode
);
11624 defsubr (&Sset_quit_char
);
11625 defsubr (&Sset_input_mode
);
11626 defsubr (&Scurrent_input_mode
);
11627 defsubr (&Sposn_at_point
);
11628 defsubr (&Sposn_at_x_y
);
11630 DEFVAR_LISP ("last-command-event", last_command_event
,
11631 doc
: /* Last input event that was part of a command. */);
11633 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11634 doc
: /* Last input event in a command, except for mouse menu events.
11635 Mouse menus give back keys that don't look like mouse events;
11636 this variable holds the actual mouse event that led to the menu,
11637 so that you can determine whether the command was run by mouse or not. */);
11639 DEFVAR_LISP ("last-input-event", last_input_event
,
11640 doc
: /* Last input event. */);
11642 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11643 doc
: /* List of events to be read as the command input.
11644 These events are processed first, before actual keyboard input.
11645 Events read from this list are not normally added to `this-command-keys',
11646 as they will already have been added once as they were read for the first time.
11647 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11648 Vunread_command_events
= Qnil
;
11650 DEFVAR_INT ("unread-command-char", unread_command_char
,
11651 doc
: /* If not -1, an object to be read as next command input event. */);
11653 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11654 doc
: /* List of events to be processed as input by input methods.
11655 These events are processed before `unread-command-events'
11656 and actual keyboard input, but are not given to `input-method-function'. */);
11657 Vunread_post_input_method_events
= Qnil
;
11659 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11660 doc
: /* List of events to be processed as input by input methods.
11661 These events are processed after `unread-command-events', but
11662 before actual keyboard input.
11663 If there's an active input method, the events are given to
11664 `input-method-function'. */);
11665 Vunread_input_method_events
= Qnil
;
11667 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11668 doc
: /* Meta-prefix character code.
11669 Meta-foo as command input turns into this character followed by foo. */);
11670 XSETINT (meta_prefix_char
, 033);
11672 DEFVAR_KBOARD ("last-command", Vlast_command
,
11673 doc
: /* The last command executed.
11674 Normally a symbol with a function definition, but can be whatever was found
11675 in the keymap, or whatever the variable `this-command' was set to by that
11678 The value `mode-exit' is special; it means that the previous command
11679 read an event that told it to exit, and it did so and unread that event.
11680 In other words, the present command is the event that made the previous
11683 The value `kill-region' is special; it means that the previous command
11684 was a kill command.
11686 `last-command' has a separate binding for each terminal device.
11687 See Info node `(elisp)Multiple Terminals'. */);
11689 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11690 doc
: /* Same as `last-command', but never altered by Lisp code.
11691 Taken from the previous value of `real-this-command'. */);
11693 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11694 doc
: /* Last command that may be repeated.
11695 The last command executed that was not bound to an input event.
11696 This is the command `repeat' will try to repeat.
11697 Taken from a previous value of `real-this-command'. */);
11699 DEFVAR_LISP ("this-command", Vthis_command
,
11700 doc
: /* The command now being executed.
11701 The command can set this variable; whatever is put here
11702 will be in `last-command' during the following command. */);
11703 Vthis_command
= Qnil
;
11705 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11706 doc
: /* This is like `this-command', except that commands should never modify it. */);
11707 Vreal_this_command
= Qnil
;
11709 DEFVAR_LISP ("this-command-keys-shift-translated",
11710 Vthis_command_keys_shift_translated
,
11711 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11712 Shift-translation occurs when there is no binding for the key sequence
11713 as entered, but a binding was found by changing an upper-case letter
11714 to lower-case, or a shifted function key to an unshifted one. */);
11715 Vthis_command_keys_shift_translated
= Qnil
;
11717 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11718 doc
: /* The command bound to the current key sequence before remapping.
11719 It equals `this-command' if the original command was not remapped through
11720 any of the active keymaps. Otherwise, the value of `this-command' is the
11721 result of looking up the original command in the active keymaps. */);
11722 Vthis_original_command
= Qnil
;
11724 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11725 doc
: /* Number of input events between auto-saves.
11726 Zero means disable autosaving due to number of characters typed. */);
11727 auto_save_interval
= 300;
11729 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11730 doc
: /* Number of seconds idle time before auto-save.
11731 Zero or nil means disable auto-saving due to idleness.
11732 After auto-saving due to this many seconds of idle time,
11733 Emacs also does a garbage collection if that seems to be warranted. */);
11734 XSETFASTINT (Vauto_save_timeout
, 30);
11736 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11737 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11738 The value may be integer or floating point.
11739 If the value is zero, don't echo at all. */);
11740 Vecho_keystrokes
= make_number (1);
11742 DEFVAR_INT ("polling-period", polling_period
,
11743 doc
: /* Interval between polling for input during Lisp execution.
11744 The reason for polling is to make C-g work to stop a running program.
11745 Polling is needed only when using X windows and SIGIO does not work.
11746 Polling is automatically disabled in all other cases. */);
11747 polling_period
= 2;
11749 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11750 doc
: /* Maximum time between mouse clicks to make a double-click.
11751 Measured in milliseconds. The value nil means disable double-click
11752 recognition; t means double-clicks have no time limit and are detected
11753 by position only. */);
11754 Vdouble_click_time
= make_number (500);
11756 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11757 doc
: /* Maximum mouse movement between clicks to make a double-click.
11758 On window-system frames, value is the number of pixels the mouse may have
11759 moved horizontally or vertically between two clicks to make a double-click.
11760 On non window-system frames, value is interpreted in units of 1/8 characters
11763 This variable is also the threshold for motion of the mouse
11764 to count as a drag. */);
11765 double_click_fuzz
= 3;
11767 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11768 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11769 inhibit_local_menu_bar_menus
= 0;
11771 DEFVAR_INT ("num-input-keys", num_input_keys
,
11772 doc
: /* Number of complete key sequences read as input so far.
11773 This includes key sequences read from keyboard macros.
11774 The number is effectively the number of interactive command invocations. */);
11775 num_input_keys
= 0;
11777 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11778 doc
: /* Number of input events read from the keyboard so far.
11779 This does not include events generated by keyboard macros. */);
11780 num_nonmacro_input_events
= 0;
11782 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11783 doc
: /* The frame in which the most recently read event occurred.
11784 If the last event came from a keyboard macro, this is set to `macro'. */);
11785 Vlast_event_frame
= Qnil
;
11787 /* This variable is set up in sysdep.c. */
11788 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11789 doc
: /* The ERASE character as set by the user with stty. */);
11791 DEFVAR_LISP ("help-char", Vhelp_char
,
11792 doc
: /* Character to recognize as meaning Help.
11793 When it is read, do `(eval help-form)', and display result if it's a string.
11794 If the value of `help-form' is nil, this char can be read normally. */);
11795 XSETINT (Vhelp_char
, Ctl ('H'));
11797 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11798 doc
: /* List of input events to recognize as meaning Help.
11799 These work just like the value of `help-char' (see that). */);
11800 Vhelp_event_list
= Qnil
;
11802 DEFVAR_LISP ("help-form", Vhelp_form
,
11803 doc
: /* Form to execute when character `help-char' is read.
11804 If the form returns a string, that string is displayed.
11805 If `help-form' is nil, the help char is not recognized. */);
11808 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11809 doc
: /* Command to run when `help-char' character follows a prefix key.
11810 This command is used only when there is no actual binding
11811 for that character after that prefix key. */);
11812 Vprefix_help_command
= Qnil
;
11814 DEFVAR_LISP ("top-level", Vtop_level
,
11815 doc
: /* Form to evaluate when Emacs starts up.
11816 Useful to set before you dump a modified Emacs. */);
11819 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11820 doc
: /* Translate table for local keyboard input, or nil.
11821 If non-nil, the value should be a char-table. Each character read
11822 from the keyboard is looked up in this char-table. If the value found
11823 there is non-nil, then it is used instead of the actual input character.
11825 The value can also be a string or vector, but this is considered obsolete.
11826 If it is a string or vector of length N, character codes N and up are left
11827 untranslated. In a vector, an element which is nil means "no translation".
11829 This is applied to the characters supplied to input methods, not their
11830 output. See also `translation-table-for-input'.
11832 This variable has a separate binding for each terminal.
11833 See Info node `(elisp)Multiple Terminals'. */);
11835 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11836 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11837 \(Even if the operating system has support for stopping a process.\) */);
11838 cannot_suspend
= 0;
11840 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11841 doc
: /* Non-nil means prompt with menus when appropriate.
11842 This is done when reading from a keymap that has a prompt string,
11843 for elements that have prompt strings.
11844 The menu is displayed on the screen
11845 if X menus were enabled at configuration
11846 time and the previous event was a mouse click prefix key.
11847 Otherwise, menu prompting uses the echo area. */);
11848 menu_prompting
= 1;
11850 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11851 doc
: /* Character to see next line of menu prompt.
11852 Type this character while in a menu prompt to rotate around the lines of it. */);
11853 XSETINT (menu_prompt_more_char
, ' ');
11855 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11856 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11857 Emacs applies the modifiers of the character stored here to each keyboard
11858 character it reads. For example, after evaluating the expression
11859 (setq extra-keyboard-modifiers ?\\C-x)
11860 all input characters will have the control modifier applied to them.
11862 Note that the character ?\\C-@, equivalent to the integer zero, does
11863 not count as a control character; rather, it counts as a character
11864 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11865 cancels any modification. */);
11866 extra_keyboard_modifiers
= 0;
11868 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11869 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11870 The command loop sets this to nil before each command,
11871 and tests the value when the command returns.
11872 Buffer modification stores t in this variable. */);
11873 Vdeactivate_mark
= Qnil
;
11874 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11876 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11877 doc
: /* Normal hook run before each command is executed.
11878 If an unhandled error happens in running this hook,
11879 the function in which the error occurred is unconditionally removed, since
11880 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11881 Vpre_command_hook
= Qnil
;
11883 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11884 doc
: /* Normal hook run after 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 Vpost_command_hook
= Qnil
;
11891 DEFVAR_LISP ("echo-area-clear-hook", ...,
11892 doc
: /* Normal hook run when clearing the echo area. */);
11894 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11895 Fset (Qecho_area_clear_hook
, Qnil
);
11897 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11898 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11899 Vlucid_menu_bar_dirty_flag
= Qnil
;
11901 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11902 doc
: /* List of menu bar items to move to the end of the menu bar.
11903 The elements of the list are event types that may have menu bar bindings. */);
11904 Vmenu_bar_final_items
= Qnil
;
11906 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11907 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11908 This is used internally by graphical displays that do not render
11909 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11910 Vtool_bar_separator_image_expression
= Qnil
;
11912 DEFVAR_KBOARD ("overriding-terminal-local-map",
11913 Voverriding_terminal_local_map
,
11914 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11915 If this variable is non-nil, it is used as a keymap instead of the
11916 buffer's local map, and the minor mode keymaps and text property keymaps.
11917 It also replaces `overriding-local-map'.
11919 This variable is intended to let commands such as `universal-argument'
11920 set up a different keymap for reading the next command.
11922 `overriding-terminal-local-map' has a separate binding for each
11924 See Info node `(elisp)Multiple Terminals'. */);
11926 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11927 doc
: /* Keymap that overrides all other local keymaps.
11928 If this variable is non-nil, it is used as a keymap--replacing the
11929 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11930 Voverriding_local_map
= Qnil
;
11932 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11933 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11934 Otherwise, the menu bar continues to reflect the buffer's local map
11935 and the minor mode maps regardless of `overriding-local-map'. */);
11936 Voverriding_local_map_menu_flag
= Qnil
;
11938 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11939 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11940 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11942 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11943 doc
: /* Non-nil means generate motion events for mouse motion. */);
11945 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11946 doc
: /* Alist of system-specific X windows key symbols.
11947 Each element should have the form (N . SYMBOL) where N is the
11948 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11949 and SYMBOL is its name.
11951 `system-key-alist' has a separate binding for each terminal device.
11952 See Info node `(elisp)Multiple Terminals'. */);
11954 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11955 doc
: /* Keymap that translates key sequences to key sequences during input.
11956 This is used mainly for mapping key sequences into some preferred
11957 key events (symbols).
11959 The `read-key-sequence' function replaces any subsequence bound by
11960 `local-function-key-map' with its binding. More precisely, when the
11961 active keymaps have no binding for the current key sequence but
11962 `local-function-key-map' binds a suffix of the sequence to a vector or
11963 string, `read-key-sequence' replaces the matching suffix with its
11964 binding, and continues with the new sequence.
11966 If the binding is a function, it is called with one argument (the prompt)
11967 and its return value (a key sequence) is used.
11969 The events that come from bindings in `local-function-key-map' are not
11970 themselves looked up in `local-function-key-map'.
11972 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11973 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11974 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11975 typing `ESC O P x' would return [f1 x].
11977 `local-function-key-map' has a separate binding for each terminal
11978 device. See Info node `(elisp)Multiple Terminals'. If you need to
11979 define a binding on all terminals, change `function-key-map'
11980 instead. Initially, `local-function-key-map' is an empty keymap that
11981 has `function-key-map' as its parent on all terminal devices. */);
11983 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11984 doc
: /* Keymap that decodes input escape sequences.
11985 This is used mainly for mapping ASCII function key sequences into
11986 real Emacs function key events (symbols).
11988 The `read-key-sequence' function replaces any subsequence bound by
11989 `input-decode-map' with its binding. Contrary to `function-key-map',
11990 this map applies its rebinding regardless of the presence of an ordinary
11991 binding. So it is more like `key-translation-map' except that it applies
11992 before `function-key-map' rather than after.
11994 If the binding is a function, it is called with one argument (the prompt)
11995 and its return value (a key sequence) is used.
11997 The events that come from bindings in `input-decode-map' are not
11998 themselves looked up in `input-decode-map'.
12000 This variable is keyboard-local. */);
12002 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12003 doc
: /* The parent keymap of all `local-function-key-map' instances.
12004 Function key definitions that apply to all terminal devices should go
12005 here. If a mapping is defined in both the current
12006 `local-function-key-map' binding and this variable, then the local
12007 definition will take precedence. */);
12008 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12010 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12011 doc
: /* Keymap of key translations that can override keymaps.
12012 This keymap works like `function-key-map', but comes after that,
12013 and its non-prefix bindings override ordinary bindings.
12014 Another difference is that it is global rather than keyboard-local. */);
12015 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12017 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12018 doc
: /* List of deferred actions to be performed at a later time.
12019 The precise format isn't relevant here; we just check whether it is nil. */);
12020 Vdeferred_action_list
= Qnil
;
12022 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12023 doc
: /* Function to call to handle deferred actions, after each command.
12024 This function is called with no arguments after each command
12025 whenever `deferred-action-list' is non-nil. */);
12026 Vdeferred_action_function
= Qnil
;
12028 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12029 doc
: /* List of warnings to be displayed after this command.
12030 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12031 as per the args of `display-warning' (which see).
12032 If this variable is non-nil, `delayed-warnings-hook' will be run
12033 immediately after running `post-command-hook'. */);
12034 Vdelayed_warnings_list
= Qnil
;
12036 DEFVAR_LISP ("timer-list", Vtimer_list
,
12037 doc
: /* List of active absolute time timers in order of increasing time. */);
12038 Vtimer_list
= Qnil
;
12040 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12041 doc
: /* List of active idle-time timers in order of increasing time. */);
12042 Vtimer_idle_list
= Qnil
;
12044 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12045 doc
: /* If non-nil, the function that implements the current input method.
12046 It's called with one argument, a printing character that was just read.
12047 \(That means a character with code 040...0176.)
12048 Typically this function uses `read-event' to read additional events.
12049 When it does so, it should first bind `input-method-function' to nil
12050 so it will not be called recursively.
12052 The function should return a list of zero or more events
12053 to be used as input. If it wants to put back some events
12054 to be reconsidered, separately, by the input method,
12055 it can add them to the beginning of `unread-command-events'.
12057 The input method function can find in `input-method-previous-message'
12058 the previous echo area message.
12060 The input method function should refer to the variables
12061 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12062 for guidance on what to do. */);
12063 Vinput_method_function
= Qnil
;
12065 DEFVAR_LISP ("input-method-previous-message",
12066 Vinput_method_previous_message
,
12067 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12068 This variable exists because `read-event' clears the echo area
12069 before running the input method. It is nil if there was no message. */);
12070 Vinput_method_previous_message
= Qnil
;
12072 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12073 doc
: /* If non-nil, the function that implements the display of help.
12074 It's called with one argument, the help string to display. */);
12075 Vshow_help_function
= Qnil
;
12077 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12078 doc
: /* If non-nil, suppress point adjustment after executing a command.
12080 After a command is executed, if point is moved into a region that has
12081 special properties (e.g. composition, display), we adjust point to
12082 the boundary of the region. But, when a command sets this variable to
12083 non-nil, we suppress the point adjustment.
12085 This variable is set to nil before reading a command, and is checked
12086 just after executing the command. */);
12087 Vdisable_point_adjustment
= Qnil
;
12089 DEFVAR_LISP ("global-disable-point-adjustment",
12090 Vglobal_disable_point_adjustment
,
12091 doc
: /* If non-nil, always suppress point adjustment.
12093 The default value is nil, in which case, point adjustment are
12094 suppressed only after special commands that set
12095 `disable-point-adjustment' (which see) to non-nil. */);
12096 Vglobal_disable_point_adjustment
= Qnil
;
12098 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12099 doc
: /* How long to display an echo-area message when the minibuffer is active.
12100 If the value is not a number, such messages don't time out. */);
12101 Vminibuffer_message_timeout
= make_number (2);
12103 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12104 doc
: /* If non-nil, any keyboard input throws to this symbol.
12105 The value of that variable is passed to `quit-flag' and later causes a
12106 peculiar kind of quitting. */);
12107 Vthrow_on_input
= Qnil
;
12109 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12110 doc
: /* If non-nil, function to output error messages.
12111 The arguments are the error data, a list of the form
12112 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12113 such as just as `condition-case' would bind its variable to,
12114 the context (a string which normally goes at the start of the message),
12115 and the Lisp function within which the error was signaled. */);
12116 Vcommand_error_function
= Qnil
;
12118 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12119 Venable_disabled_menus_and_buttons
,
12120 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12122 Help functions bind this to allow help on disabled menu items
12123 and tool-bar buttons. */);
12124 Venable_disabled_menus_and_buttons
= Qnil
;
12126 DEFVAR_LISP ("select-active-regions",
12127 Vselect_active_regions
,
12128 doc
: /* If non-nil, an active region automatically sets the primary selection.
12129 If the value is `only', only temporarily active regions (usually made
12130 by mouse-dragging or shift-selection) set the window selection.
12132 This takes effect only when Transient Mark mode is enabled. */);
12133 Vselect_active_regions
= Qt
;
12135 DEFVAR_LISP ("saved-region-selection",
12136 Vsaved_region_selection
,
12137 doc
: /* Contents of active region prior to buffer modification.
12138 If `select-active-regions' is non-nil, Emacs sets this to the
12139 text in the region before modifying the buffer. The next
12140 `deactivate-mark' call uses this to set the window selection. */);
12141 Vsaved_region_selection
= Qnil
;
12143 DEFVAR_LISP ("selection-inhibit-update-commands",
12144 Vselection_inhibit_update_commands
,
12145 doc
: /* List of commands which should not update the selection.
12146 Normally, if `select-active-regions' is non-nil and the mark remains
12147 active after a command (i.e. the mark was not deactivated), the Emacs
12148 command loop sets the selection to the text in the region. However,
12149 if the command is in this list, the selection is not updated. */);
12150 Vselection_inhibit_update_commands
12151 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12153 DEFVAR_LISP ("debug-on-event",
12155 doc
: /* Enter debugger on this event. When Emacs
12156 receives the special event specified by this variable, it will try to
12157 break into the debugger as soon as possible instead of processing the
12158 event normally through `special-event-map'.
12160 Currently, the only supported values for this
12161 variable are `sigusr1' and `sigusr2'. */);
12162 Vdebug_on_event
= intern_c_string ("sigusr2");
12164 /* Create the initial keyboard. */
12165 initial_kboard
= xmalloc (sizeof *initial_kboard
);
12166 init_kboard (initial_kboard
);
12167 /* Vwindow_system is left at t for now. */
12168 initial_kboard
->next_kboard
= all_kboards
;
12169 all_kboards
= initial_kboard
;
12173 keys_of_keyboard (void)
12175 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12176 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12177 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12178 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12179 initial_define_key (meta_map
, 'x', "execute-extended-command");
12181 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12182 "handle-delete-frame");
12183 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12184 "ns-put-working-text");
12185 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12186 "ns-unput-working-text");
12187 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12188 current-prefix-arg, as is done in `handle-switch-frame'.
12189 But `handle-switch-frame is not run from the special-map.
12190 Commands from that map are run in a special way that automatically
12191 preserves the prefix-arg. Restoring the prefix arg here is not just
12192 redundant but harmful:
12194 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12195 - after the first prompt, the exit-minibuffer-hook is run which may
12196 iconify a frame and thus push a `iconify-frame' event.
12197 - after running exit-minibuffer-hook, current-prefix-arg is
12198 restored to the non-nil value it had before the prompt.
12199 - we enter the second prompt.
12200 current-prefix-arg is non-nil, prefix-arg is nil.
12201 - before running the first real event, we run the special iconify-frame
12202 event, but we pass the `special' arg to execute-command so
12203 current-prefix-arg and prefix-arg are left untouched.
12204 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12205 - the next key event will have a spuriously non-nil current-prefix-arg. */
12206 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12208 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12210 /* Handling it at such a low-level causes read_key_sequence to get
12211 * confused because it doesn't realize that the current_buffer was
12212 * changed by read_char.
12214 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12215 * "handle-select-window"); */
12216 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12217 "handle-save-session");
12220 /* Define a special event which is raised for dbus callback
12222 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12223 "dbus-handle-event");
12226 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12228 #if defined (WINDOWSNT)
12229 initial_define_lispy_key (Vspecial_event_map
, "language-change",
12234 /* Mark the pointers in the kboard objects.
12235 Called by Fgarbage_collect. */
12237 mark_kboards (void)
12241 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12243 if (kb
->kbd_macro_buffer
)
12244 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12246 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12247 mark_object (KVAR (kb
, Vlast_command
));
12248 mark_object (KVAR (kb
, Vreal_last_command
));
12249 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12250 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12251 mark_object (KVAR (kb
, Vprefix_arg
));
12252 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12253 mark_object (KVAR (kb
, kbd_queue
));
12254 mark_object (KVAR (kb
, defining_kbd_macro
));
12255 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12256 mark_object (KVAR (kb
, Vsystem_key_alist
));
12257 mark_object (KVAR (kb
, system_key_syms
));
12258 mark_object (KVAR (kb
, Vwindow_system
));
12259 mark_object (KVAR (kb
, Vinput_decode_map
));
12260 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12261 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12262 mark_object (KVAR (kb
, echo_string
));
12265 struct input_event
*event
;
12266 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12268 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12269 event
= kbd_buffer
;
12270 if (event
->kind
!= SELECTION_REQUEST_EVENT
12271 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12273 mark_object (event
->x
);
12274 mark_object (event
->y
);
12276 mark_object (event
->frame_or_window
);
12277 mark_object (event
->arg
);